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


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.


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


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().