wfm.SaveEvent

This job sets up an event for an activity. If the parameter EventId is set, the values Params and Description are reset for an existing event.

1. Input Parameters

Name Type Required Description

EventId

STRING

Yes

ID of an event. Must be empty if this is a new event.

WorkflowId

STRING

Yes

ID of a workflow model.

ActivityId

STRING

Yes

ID of an activity.

EventType

INT

Yes

Type of an event (see note).

Params

STRING

Yes

For event type ButtonClick, the ID of the button is passed here.

Description

STRING

Yes

Description of the event.

OrganisationId

STRING

Yes

ID of the organization.

ClientTypeId

STRING

Yes

ID of the client type used.

2. Output Parameters

Name Type Dependency Description

EventId

STRING

—

ID of the created or updated event.

3. Return Value

(INT): 0 = Job successful, otherwise error code.

4. Note

Valid values for EventType:

  • 1 = BeforeForward

  • 2 = AfterForward

  • 3 = BeforeForwardTo

  • 4 = ButtonClick

  • 5 = BeforeOpen

  • 6 = AfterSignature

  • 7 = BeforeCancel

  • 8 = SimulateMaskEdit

  • 10000 = StartActivity

  • 10001 = EndActivity

  • 10002 = BeforeStartSubProc

  • 10003 = PersonalizeWorkItem

  • 10004 = GetWorkItemParams

5. See Also

wfm.GetEvents, wfm.DeleteEvent, wfm.SaveScript, wfm.SetEventScriptRelation