Represents a process in memory, containing properties, methods and classes for use in process manipulation.

public class Process

Example

The following example sets the ProcessStatus of an executing process to validation.

public class SetToValidation : CustomNode
{
    public override void Run()
	{
		Process.SetStatus(ProcessStatus.Validation);
	}
}

Remarks

Classes derived from CustomNode automatically have access to the executing process as a Process class. Additionally, Processes are returned from methods such as GetProcessById or GetProcessesByProperty.

This class is a base type from which the ActionProcess and CaptureProcess derive. It holds only the methods and properties that can be shared between the two products. The base class of Process can be casted to its derived types like so:

var process = Database.GetProcessById(1);
if (process is CaptureProcess captureProcess) 
{
    captureProcess.Document.AddPage(pagePath);
}

Changes made to the Process class on the derived CustomNode class are saved automatically at the conclusion of the node.

Processes returned from methods are held in memory unless inserted or updated in the database using Database methods.

Properties

Methods

• Page:
  AddHistory Method — 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.
  
  
• Page:
  GetMultiValue Method — Gets the values of a multi-value process property.
  
  
• Page:
  GetProcessDynamic Method — Gets the currently executing process from the engine in dynamic object form.
  
  
• Page:
  SaveProcessDynamic Method — Overwrites the current process with the provided dynamic process object.
  
  
• Page:
  SetCurrentNodeByNodeName Method — Sets the current node of a process to a new node by name.
  
  
• Page:
  SetStatus Method — Sets the ProcessStatus of the process.