PDAutomationProvider - Scoped, Global

The PDAutomationProvider API enables inserting an optional activity into a process while it's executing.

This API is part of the Playbooks plugin (com.glide.pad.core) and runs in the sn_pad namespace.

Calling scripts with this API requires at least one of the following:

• The caller must be in the same scope in which the optional activity trigger was created.
• Admin privileges.

A process is a series of activities ordered by lanes. An optional activity is predefined during process design. The activities aren't scheduled to run at a precise time. An activity can be assigned to a lane and made available to run during lane execution. An activity can be assigned to a process and made available to run during lane execution.

To create an optional activity, it must have the Start rule set to Manual in the Activities [sys_pd_activity] table. Playbooks doesn't currently support creating manual activities.

An agent adds the optional activity to a lane or activity relative to another activity. The process must be running to insert an optional activity.

See also:

• Design an automated process
• Process Automation Designer lanes and activities

Parent Topic:Server API reference

PDAutomationProvider – activateProcess(String processDefinitionSysId)

Activates a playbook.

{
  "errors": [Array]
  "process_definition": {Object},
  "state": "String"
}

"process_definition":
{
  "active": Boolean,
  "snapshot": {Object},
  "status": "String"
}

{
  "snapshot":
    {
      "created": "String",
      "processDefinitionSysId": "String"
    }
}

The following example shows how to activate a playbook.

var myPlaybook = sn_pad.PDAutomationProvider.activateProcess('cdd1b85e43000210d96e29c28ab8f275');
gs.info(JSON.stringify(myPlaybook));

Output:

{
  "process_definition": {
    "active": true,
    "snapshot": {
      "processDefinitionId": "cdd1b85e43000210d96e29c28ab8f275",
      "created": "2024-02-19 22:58:12"
    },
    "status": "published"
  },
  "state": "SUCCESS",
  "errors": []
}

PDAutomationProvider – addOptionalActivityRelativeToActivityContext(String contextID, String activityId, String where, String relativeToId)

Adds a specified optional activity to a process to be run relative to another activity during process execution.

An activity context is created for each activity when a process executes. The context also handles how the activity handles execution. For information, see Process Automation Designer lanes and activities.

The following example shows how to run an optional activity simultaneously with the relative activity context.

var contextId = '<context_id>';
var optionalActivityId = '<optional_activity_id>';
var where = 'WITH'; // options AFTER, WITH
var relativeToId = '<relative_activity_context_id>'; // relative activity context ID

var response = sn_pad.PDAutomationProvider.addOptionalActivityRelativeToActivityContext(contextId, optionalActivityId, where, relativeToId);

gs.info(JSUtil.describeObject(response));

Output (success):

success: boolean = true
errors: Array of 0 elements

PDAutomationProvider – addOptionalActivityRelativeToLaneContext(String contextID, String activityId, String where, String relativeToId)

Assigns an optional activity to a lane to run during that lane's execution context.

A lane context is created for each lane when a process executes. The context also handles how the lane handles execution. For information, see Process Automation Designer lanes and activities.

The following example shows how to run an optional activity as the final activity in a lane context.

var contextId = '<context_id>';
var optionalActivityId = '<optional_activity_id>';
var where = 'LAST'; // options LAST, NEXT
var relativeToId = '<relative_lane_context_id>'; // relative lane context ID

var response = sn_pad.PDAutomationProvider.addOptionalActivityRelativeToLaneContext(contextId, optionalActivityId, where, relativeToId);

gs.info(JSUtil.describeObject(response));

Output (success):

success: boolean = true
errors: Array of 0 elements

PDAutomationProvider – deactivateProcess(String processDefinitionSysId)

Deactivates a playbook.

{
  "errors": [Array]
  "process_definition": {Object},
  "state": "String"
}

"process_definition":
{
  "active": Boolean,
  "snapshot": {Object},
  "status": "String"
}

Deactivate the playbook.

sn_pad.PDAutomationProvider.deactivateProcess('cdd1b85e43000210d96e29c28ab8f275')

Outputs:

{"process_definition":{"scope":"global","name":"test","active":true,"description":"","label":"test","status":"draft"},"state":"SUCCESS"}

PDAutomationProvider – duplicateProcess(String processDefinitionSysId, String label, String description, String scopeId, String triggerTypeId)

Duplicates a playbook.

{
  "errors": [Array]
  "processDefinitionSysId": "String",
  "state": "String"
}

This example shows how to duplicate a playbook with the sys_id f8ca6192ec210210f8772cbd595eab20. The new playbook is named Playbook 2.0, has an application scope of Global, and is triggered when a record is created. The Record Create trigger type has a sys_id of ab6951170f1200108c87f4f0ff767e4f.

sn_pad.PDAutomationProvider.duplicateProcess('f8ca6192ec210210f8772cbd595eab20', 'Playbook 2.0', '', 'global', 'ab6951170f1200108c87f4f0ff767e4f');

Output:

{"processDefinitionSysId":"6e4f0b8fece9c210f8772cbd595eabda","state":"SUCCESS"}