Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Excerpt

Base class from which GlobalCapture Nodes derive and define behavior.  A Node in GlobalCapture can be used anywhere in the workflow after a document has been imported and the Process has been created.  Inherit from this class to create Nodes that take actions or make decisions on processes in a GlobalCapture workflow.


Code Block
public abstract class CaptureNode : CustomNode

Example

The following example defines an ExampleCaptureNode class that implements a Run method which clears the GlobalCapture document pages.

Code Block
public class ExampleCaptureNode : CaptureNode
{
    public override void Run()
    {
        Process.Document.ClearPages();
    }
}

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 CustomNode 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

Insert excerpt
DEV:database classDEV:database classDatabase Class
Database Class
nopaneltrue

Insert excerpt
CN:ActionEngine ClassCN:
ActionEngine Class
nopaneltrue

Insert excerpt
CN:ActionProcess ClassCN:
ActionProcess Class
nopaneltrue

Insert excerpt
CN:Setting ClassCN:
Setting Class
nopaneltrue

Dictionary<string, string> Links 

List of available node links. You can move along these links by calling the SetNextNodeByLinkName function.

string NodeDirectory

Path to the directory containing files extracted from the custom node.

dynamic Workflow

Dynamic object containing the executing workflow. Changes made to this object will not be saved.

Methods

CreateProcessCN:Run Methodnopaneltrue Insert excerptCN:SetNextNodeByLinkName MethodCN:SetNextNodeByLinkName Methodnopaneltrue Insert excerptCN:SetNextNodeByNodeName MethodCN:SetNextNodeByNodeName Methodnopaneltrue Insert excerptCN:LoadConfig MethodCN:LoadConfig Methodnopaneltrue Insert excerptCN:LogHistory MethodCN:LogHistory Methodnopaneltrue

Filter by label (Content by label)

Insert excerptCN:CreateProcess MethodCN:CreateProcess Methodnopaneltrue Insert excerptCN:Run Method

showLabelsfalse
max25
showSpacefalse
sorttitle
cqllabel = "customnodemethod"