Idoc Script Functions and Variables

4-24 Application Administrators Guide for Content Server

4.5 Customizing Workflows

Tokens and jumps can be used to customize your workflows to accommodate different business scenarios. A token defines variable users in a workflow and a jump can be used to branch a workflow to a different side effect. This section describes how to set up and use tokens and jumps. It discusses the following topics: ■ About Tokens on page 4-25 ■ About Jumps on page 4-28 ■ Jump Variables and Steps on page 4-30 ■ Creating a Token on page 4-26 ■ Changing a Token on page 4-26 ■ Deleting a Token on page 4-27 ■ Setting Up Jumps on page 4-31 ■ Changing a Jump on page 4-33 ■ Token Examples on page 4-27 ■ Jump Examples on page 4-34

4.5.1 Idoc Script Functions and Variables

Jumps and tokens are created using Idoc script. The interfaces create the correct syntax and usage for you when you create tokens and jumps. However, you may wish to customize your scripts using the following Idoc Script functions. See the Oracle Fusion Middleware Idoc Script Reference Guide for complete details about usage. Idoc Script Functions: ■ wfAdditionalExitCondition: retrieves the exit condition that has been defined for the current step. ■ wfAddUser: adds a user, alias, or workflow token to the list of reviewers for a workflow. This can only be used inside a token. ■ wfCurrentGet: retrieves a local state value from the companion file. ■ wfCurrentSet: sets the local state value of a key in the companion file. ■ wfCurrentStep: retrieves the name of a step relative to the current step. ■ wfDisplayCondition: retrieves the exit condition for a workflow step. ■ wfExit: exits a workflow step. Can be used to exit the workflow. ■ wfGet: retrieves a state value from the companion file. ■ wfGetStepTypeLabel: takes an internal workflow step value and turns it into a human-readable label. ■ wfIsReleasable: indicates if the document is released as far as the workflow is concerned. ■ wfJumpMessage: defines a message that will be included in the notification e-mail that is issued when a jump is entered. ■ wfLoadDesign: used to retrieve information about the existing steps in a workflow or about the exit conditions in a workflow. Managing Workflows 4-25 ■ wfNotify: sends an e-mail to a specified user, alias, or workflow token. ■ wfReleaseDocument: causes a workflow to release all outstanding document revisions for a document that are currently being locked by the workflow. ■ wfSet: sets a key with a particular value in the companion file. ■ wfUpdateMetaData: defines a metadata value for the current content item revision in a workflow. Idoc Script Variables: ■ wfAction: the action currently being performed on the revision. ■ wfJumpEntryNotifyOff: turns onoff the jump notification. ■ wfJumpName: the name of the current jump. ■ wfJumpReturnStep: the name of the step in the parent workflow that the revision returns to when exiting a workflow after the current jump. ■ wfJumpTargetStep: the name of the step where the revision will jump if the conditions are met. ■ wfMailSubject: defines the subject line of a workflow e-mail notification. ■ wfMessage: defines a message that will be included in a workflow e-mail notification. ■ wfParentList: list of the workflow steps that the revision has visited. ■ wfStart: sends the revision to the first step in the current workflow.

4.5.2 About Tokens