Workflow Events

This section describes the events associated with workflow, and lists the events and related event attributes in the following tables.

Generic Plug-In Invoked Event

A notification event is triggered by ActivID CMS after a generic plug-in—either server or client—is invoked.

Attributes

The following table describes the related attributes.

Generic Plug-In Invoked Event Attributes

Field

Value

Description

EventID

40006

Unique event identifier.

Description

<InvokePlugins>

Describes the event taking place.

Status

<Status>

Status indicating whether the operation was successful, with the following possible values:

  • 0 = Success

  • 1 = Failure

StatusDescription

<ErrorMessage>

The operation status reflected one of the following states:

  • Failed, a detailed error message.

  • Null, if no errors occur.

ClientID

null

Not used.

OperatorID

<OperatorID> or <UserId>

The value can be either of the following choices:

  • When the workflow is driven from the ActivID CMS administrator console, this attribute contains the subject name of the operator’s certificate used to authenticate to ActivID CMS;

  • If the user caused synchronization to occur in the ActivID CMS User Portal, the value of the attribute uniquely identifies the user in the directory.

AdditionalInfoNum1

0

Not used.

AdditionalInfoNum2

<LogicalStepType>

The type of logical step that is processed can be either of the following values:

  • 0 = server-side logical step

  • 1 = client-side logical step

AdditionalInfoChar1

<UserID>

Uniquely identifies the user in the directory.

AdditionalInfoChar2

<LogicalStepID>

The ID of the logical step that was processed (see Logical Step IDs Returned by Event Object).

AdditionalInfoChar3

<Plug-InID>

If no error occurred, value is null. Otherwise, the value is the ID of the plug-in that failed during execution.

Attributes Specific to Server Generic Plug-Ins

The attributes of the generic plug-in invoked notification event are set after a server generic plug-in has been invoked, and include the following:

  • AdditionalInfoNum2: this value is 0 (server-side).

  • AdditionalInfoChar3: this value is null if no error occurred; otherwise, this value is the ID of the server plug-in that failed during execution.

Attributes Specific to Client Generic Plug-Ins

The attributes of the generic plug-in invoked notification event are set after a client generic plug-in has been invoked, and include the following:

  • AdditionalInfoNum2: this value is 1 (client-side).

  • AdditionalInfoChar3: this value is null if no error occurred; otherwise, this value is the ID of the client plug-in that failed during execution.