Methods

Adds a history entry to the Process.  Use the history to notate import events in the process lifecycle that users or admins might need for troubleshooting or audit history.

Adds a file page to the process.

Clears all pages from the process.

Creates a new Process based on a workflow and a file.

Creates a new Process based on a provided workflow and file.

Deletes a process from the process database by process ID.

Gets a bool value from the NodeSettings dictionary by setting name.

Gets an HttpClient object configured to make calls to the CaptureApi associated with the executing engine.

Gets a value from the engine app.config file by key name.

Gets an int value from the NodeSettings dictionary by setting name.

Gets a list value from the NodeSettings dictionary by setting name.

Gets the values of a multi-value process property.

Gets a page file path from the process at a specified index.

Gets the full list of page file paths from the process.

Gets a Process from the process database by process ID.

Gets the currently executing process from the engine in dynamic object form.

Queries the MongoDB database for a list of Processes that satisfy a property match.

Queries the MongoDB database for a list of Processes based on a query of combined ProcessFilters.

Queries the MongoDB database for a list of Processes of a specific status.

Queries the MongoDB database for a list of Processes from a specific workflow.

Gets a property object by property name.

Gets a list of of property names on the current process.

Gets a Setting from the NodeSettings dictionary by setting name.

Gets the value of a single value process property.

Gets an HttpClient object configured to make calls to a Square9Api.

Gets a string value from the NodeSettings dictionary by setting name.

Gets the table field values of a table field process property.

The method that will run when an ActionImporter is picked up by the engine.

The method that will run when a <see cref="CaptureImporter"/> is picked up by the engine.

Inserts a file page to the process at a specific index.

Inserts a new Process into the process database.

Returns a strongly typed object deserialized from the JSON data in the node.config file included in the custom node .s9n file.

Logs a message to the process history.

Merges a separated document into a single file on the process.

Moves a page from one index in the page array to another.

Removes a page from the process at a specified index and deletes it from the file system.

Replaces a page at a specific index on the process with another page.

The method that will run when a CustomNode is called by the engine.

Overwrites the current process with the provided dynamic process object.

Saves a property back to the process.

Sets the current node of a process to a new node by name.

Sets the value of a multi-value process property.

Sets the next node by link name.

Sets the next node by name.

Sets the value of a single value process property.

Sets the ProcessStatus of the process.

Sets the value of a table field process property.

Updates an existing Process in the process database.