Contents:

1. Workflow
   1. Overview
   2. API Documentation
      1. Model
      2. JavaScript Event Handlers
   3. Workflow Properties
   4. Notes

Workflow

For connectors with workflow support, you can write workflow scripts in JavaScript to control which fields are visible, required, etc. in response to user interaction with the task editor.

Overview

A workflow script consists of a set of event handlers which are automatically called in response to user interaction including opening or submitting a task and editing a field. The event handlers can call dom.getTask().getField(fieldId) where dom is an argument of type DOM passed to the handler by the framework, and fieldId is a String representing the ID of a field (e.g. “BG_STATUS”), to retrieve an IField object representing that field. The IField object has methods which the script can call to change the field’s value, visibility, and so on. See the API Documentation below for details.

API Documentation

Model

Workflow scripts are written in JavaScript but must use a Java API to access the task data model and task editor capabilities. See Model Documentation.

JavaScript Event Handlers

For documentation of the event handlers to be implemented by workflow scripts, see JavaScript Event Handlers.

Workflow Properties

Connectors that support workflow can use properties to make extra information available to workflow scripts. The properties can be accessed by calling ITask.getProperty().

Notes

• Workflow scripts must not rely on any state they maintain (i.e. global variables) for consistency. For example, when a user changes a field, a script may record the change in a global variable for convenience, but it must not count on that variable having the same value when the task is submitted, because the task could be saved offline and the editor closed and reopened (causing the script to be reloaded) before it is submitted. Scripts should use the changedFieldIds parameter of handleSubmit to determine what fields the user has changed.
• Fields that are set invisible by the server cannot be set visible by scripts. Unless a field should never be visible to the user under any circumstances, it should be set as visible on the server, and hidden by the workflow script when appropriate.
• Scripts should not assume that the DOM objects they are passed will always be the same object, but they should also not assume they will always be different. So, a script should not store a DOM object in a global variable.
• The method IField.isWorkflowField() returns true only if the field is visible on the server and appears in the attributes section of the task editor