Standard Workflow Handler

Method / Usage

Description

Expected Args

(Required Args are marked with a * )

Object getProperty(WorkflowContext wfc)

Returns value of the named system property.

name*

public Object isProperty(WorkflowContext wfc)

Returns true if the named system property has a value.

name*

public Object getMessage(WorkflowContext wfc)

Returns localized message for use in task results

  • message*

  • type (severity)

  • arg1-arg4 (up to 4 parameters for the message)

public Object addMessage(WorkflowContext wfc)

Adds message to the workflow case.

  • message*

  • type (optional severity)

  • arg1-arg4 (up to 4 parameters for the message)

public Object addLaunchMessage(WorkflowContext wfc)

Adds message to workflow case that is displayed in the user interface. Not kept in task result. For example, Request was submitted.

  • message*

  • type (optional severity)

  • arg1-arg4 (up to 4 parameters for the message)

public Object setLaunchMessage(WorkflowContext wfc)

Replaces previously added launch message with a new message based on new state.

  • message*

  • type (optional severity)

  • arg1-arg4 (up to 4 parameters for the message)

public Object log(WorkflowContext wfc)

Sends something to log4j.

  • message*

  • level*

public Object print(WorkflowContext wfc)

Prints text to the console.

message*

public Object audit(WorkflowContext wfc)

Creates an audit event. Enables workflows to put custom entries in audit log, which displays in the user interface.

  • source*

  • action*

  • target

  • string1 - string4

public Object sendEmail(WorkflowContext wfc)

Sends an email message.

  • to*

  • cc

  • bcc

  • from

  • subject

  • body

  • template*

  • templateVariables

  • sendImmediate

  • exceptionOnFailure

public Object launchTask(WorkflowContext wfc)

Launches a defined task.

  • taskDefinition*

  • taskResult

  • sync (true=synchronous execution)

public Object scheduleRequest(WorkflowContext wfc)

Launches a generic event request.

  • requestDefinition*

  • requestName (name to assign to request)

  • scheduleDate

  • scheduleDelaySeconds

  • owner

public Object scheduleWorkflowEvent(WorkflowContext wfc)

Launches a workflow event request.

  • requestName (name to assign to request)

  • scheduleDate

  • scheduleDelaySeconds

  • owner

  • workflow* (name of workflow to launch)

  • caseName (optional case name to override default)

public Object commit(WorkflowContext wfc)

Commits a transaction. Not commonly needed in workflows. Most commonly used for role approvals.

  • creator

  • archive

public Object rollback(WorkflowContext wfc)

Rolls back a transaction. Not commonly needed in workflows. Most commonly used for role approvals.

none