ActionNode Class
Base class from which GlobalAction Nodes derive and define behavior. Inherit from this class when building any GlobalAction node that will operate on a process after a document has entered a workflow.
public abstract class ActionNode : CustomNode
Example
The following example defines an ExampleActionNode class that implements a Run method which logs the Database ID, Archive ID, and Document ID of the GlobalSearch document associated with the ActionProcess.
public class ExampleActionNode : ActionNode
{
public override void Run()
{
LogHistory($"Database ID: {Process.Document.DatabaseId}");
LogHistory($"Archive ID: {Process.Document.ArchiveId}");
LogHistory($"Document ID: {Process.Document.DocumentId}");
}
}
Remarks
In order for your custom node to execute code during engine runtime, a class must be created that successfully inherits and implements either the 162169038 class, or the ActionNode or CaptureNode class that corresponds with the workflow type in which your node is placed.
If you are designing a custom import node that defines a CaptureImporter or ActionImporter class, defining a node class within your assembly is optional, and will run on the processes created from your custom import methods.
The NodeDirectory field refers to a folder containing the files within the .s9n file executing on the process. This folder exists only as long as the specific process is executing the custom node, and is deleted when the Custom Node is finished.
If a CustomNode class is defined and a Run method is implemented on a Custom Import node, the code within the Run method will execute independently on every process spawned as a result of the Import Method (ActionImporter) or Import Method (CaptureImporter). Utilize this pattern to save space when a custom importer must perform actions specific to the processes it creates.
Properties
Methods
- CreateProcess Method
Creates a new Process based on a workflow and a file.
- LoadConfig Method
Returns a strongly typed object deserialized from the JSON data in the node.config file included in the custom node .s9n file.
- LogHistory Method
Logs a message to the process history.
- Run Method
The method that will run when a CustomNode is called by the engine.
- SetNextNodeByLinkName Method
Sets the next node by link name.
- SetNextNodeByNodeName Method
Sets the next node by name.