Prev Next

Workflow Script Functions

Note: From Release 15.0 of Enterprise Architect, VBScript workflow scripts are available for use but deprecated. You can now use the Enterprise Architect Add-In model event EA_Connect to respond to Workflow Add-In events, which have a wider range of features and are not reliant on Visual Basic.

Workflow scripts are created in the Scripting window, under the Workflow group type as VBScripts. They are executed by the Enterprise Architect workflow engine, to manage user input.

You can make use of a range of functions and data structures to develop your scripts.

Access

Open the Scripting window using one of the methods outlined here, then click on the New Group button to create a new Workflow script group, before clicking on the New Script button to create a new script.

Ribbon

Specialize > Tools > Scripting

Workflow functions and data structures

Function

Description

See also

Script Implementation

When a model is launched, the Workflow Engine is initialized with the current user and group memberships; this information determines who can access and modify parts of a given model.

When a selected event occurs, the script engine is initialized with values including the author's name and access rights, and the element name and version details.

The workflow script implements rules governing change management, access control and model validation; if a user attempts to make changes in violation of company policy, the script denies the update.

The user is notified why the validation failed and the activity is logged.

These reminders help to reinforce company policy, reduce human error and provide management with valuable project feedback.

Functions for User Input

These are functions that Enterprise Architect calls to validate and control user input.

For each of the functions that Enterprise Architect calls, a set of objects are filled.

Functions - Validate and Control User Input Filled Workflow Data Structures

Functions to create a Search

These are functions that Enterprise Architect calls to create a search with user tasks.

Functions - Create a Search With User Tasks

Workflow Data Structures Enterprise Architect fills

These are workflow data structure objects that Enterprise Architect fills.

Filled Workflow Data Structures

Workflow Data Structures you fill

These are Workflow data structure objects that you can fill.

Workflow Data Structures You Fill

Functions you call

These are functions that Enterprise Architect provides for you to call.

Functions You Call

Notes

  • If you make changes to a workflow script listed in the Scripting window, click on the Refresh Scripts button in the Scripting window toolbar to reload the script with the changes
  • Workflow Scripting is available in the Corporate, Unified and Ultimate Editions of Enterprise Architect
  • Workflow Scripting requires User Security to be enabled in order to function
  • You need 'Admin Workflow' permission to develop and manage Workflow Scripts

Learn more