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

public class ActionProcess : Process

Example

The following example 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

Classes derived from ActionNode automatically have access to the executing process as an ActionProcess class. Additionally, ActionProcesses are potentially returned from methods that return a Process base class, such as GetProcessById or GetProcessesByProperty. This process may be casted to an ActionProcess like so:

var process = Database.GetProcessById(1);
if (process is ActionProcess actionProcess) 
{
    LogHistory($"Database ID: {actionProcess.Document.DatabaseId}");
    LogHistory($"Archive ID: {actionProcess.Document.ArchiveId}");
    LogHistory($"Document ID: {actionProcess.Document.DocumentId}");
}

Changes made to the Process class on CustomNode classes 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.