1. Modeler Overview

The modeler dashboard can be accessed by authorized users through the dashboard menu and is used to create and deploy workflow models for use within edoras one.

Before we look at the details of the modeler dashboard it will help to understand how models are related to the user dashboard.

Models are created edited in the modeler dashboard, and as long as they are only edited they are not visible in the user dashboard. When models are deployed, corresponding definitions are created. These definitions can be used in the user dashboard to create work objects of the new type.

1.1. Apps

An edoras one App contains a collection of different models that combine to define a specific workflow within edoras one.

An app can be created and then different models can be added and linked together as required. When the workflow is ready, it can be deployed to create the corresponding definitions which are used to execute the workflow, and it can then be tested.

Apps can be transferred between different edoras one installations using the Export and Import actions.

2. Model types

2.1. Form model

A form model defines a form that can be used by other workflow models to interact with the user. Each form contains a number of form fields arranged in a given layout. The fields in a form may contain predefined content, or may be bound to work object values at runtime, for example to allow the name and description of a document to be displayed and perhaps changed.

Typically two types of forms are used: init forms are used to initialize new work objects, and work forms are used to edit existing work objects.

Form models can be quickly checked by hovering over the form name, previewed within edoras one using the Preview action or edited in the edoras vis modeler using the Edit in modeler action. It is also possible to download the XML form definition using the Download action.

2.2. Task model

A task model is used to define a new type of user task. The init and work forms for a task are used to create and edit the task contents, and are set using the Edit Model action. The default candidate groups used for sharing can also be set, and the actions that will be allowed on this type of task can also be selected.

2.3. Document model

A document model is used to define a new type of document. As in the task model, the Edit Model action allows the init and work forms to be selected, as well as setting the candidate groups and allowed actions.

2.3.1. Skeleton documents

A skeleton document can be set using the Upload skeleton action. If a skeleton document is provided then whenever a new document of this type is created it will be initialized with its own copy of the skeleton document. Placeholders can also be defined to insert dynamic text into the document copy.

2.3.2. Placeholder expressions

Document models can define placeholder expressions that can be used to insert dynamic values into documents.

A placeholder definition consists of a key (which will be referenced from the document) and an expression that will be evaluated to give the corresponding value:

placeholders

The expression will be applied at the time that the placeholders are updated, i.e. either when the document is first created from the document model or when the Update placeholders action is used subsequently.

2.3.3. Referencing placeholders from a Microsoft Word document

In a Microsoft word document, placeholders may be referenced by inserting a form field into the document with a Bookmark name that corresponds to the placeholder key:

word placeholder

2.3.4. Referencing placeholders from an Adobe PDF document

In a PDF document, placeholders may be referenced by inserting a form field into the document with a name that corresponds to the placeholder key:

pdf placeholder
Note
A suitable PDF editing tool is required to create PDF documents with form fields.

2.4. Process model

A process model allows a full BPMN 2.0 process execution model to be defined. As for form models a process model can be previewed or edited in the modeler using the Edit in modeler action, and the process definition XML can also be downloaded.

2.5. Case model

A case model is used define a new type of case. A case serves as a container for other work objects and can be used to store shared context information for a given workflow.

When a new case is created, it is possible to start processes, create tasks or create documents and link these to the case automatically. This behaviour is defined using the Edit Model action.

2.6. Mail model

A mail model provides a template for mails that can be sent by a given workflow. The mail model contains the templates for mail subject and header, both of which can use edoras one backend expressions to fill in the template with dynamic information at the time that the mail is sent.

3. Working with Apps and models

3.1. Accessing the modeler dashboard

All users that are part of the modeler group will be able to access the modeler dashboard.

3.2. Importing Apps

An App can be imported into the system by creating a new App through the user interface, and then using the Import action within the app to upload and import a Zip file containing the models to be imported.

When models are imported, the model will be checked to see whether it is already present on the system. If it is not present, then it will be created in the current App. If it is already present within the current App then it will be updated from the import file. If it is already present but as part of a different App then an error will be shown.

If a new model is created from scratch it is assigned an unchangeable ID which is used to track the model across all systems where the model is installed, and it is this ID which is used to establish the relationship between the models on the system and the models in the import file.

If the Import as duplicate option is selected when an App is imported the models in the imported App will not be checked against the models already present. New models will be created that are unconnected with the originals. This can be useful for creating a completely new App, using an existing App as a starting point.

3.3. Model and App state

Both models and Apps have a state which changes as the models are edited and deployed. The available states are:

Table 1. Model states
State Applies to Description

active

Models, Apps

No pending changes. The model or App is currently deployed on the system.

inactive

Models

No pending changes. The model has been deactivated on the system.

pending

Models, Apps

The model or App contains changes that have not yet been deployed.

pending inactive

Models

The model will be deactivated on the system when it it next deployed.

3.4. Deploying an App

When an App is deployed, the models within that App will be checked for consistency. If a model has been deactivated but there are still references from other active models then it will not be possible to deploy the App. If the models are consistent then they will be deployed and corresponding definitions will be created. The users of the system will then be able to access the new workflow in the user dashboard.

Note that work objects and processes may already exist that were created using older versions of the model. These will not automatically be updated to use the new definitions: they will continue to use the definitions that were valid when they were created and will therefore not behave any differently after the new deployment.

3.5. Moving models between apps

All of the basic model types can be moved to another App as long as there are no outstanding references within the App that it is being moved from.

3.6. Duplicating apps

All basic model types can also be duplicated, making an exact copy with a new name. This can be very useful when several small variations of a complex model are required.

3.7. Sharing models

Models and apps may also be shared with different groups. By default all new models are shared with the modeler group, but in some circumstances it may be required for particular users to work on a particular set of models.

3.8. The System App

The administrator will also be able to see the System app in the modeler dashboard in addition to the Apps that can be seen by normal modeler users. This App contains a number of models that are required by the edoras one application and should normally not be changed.

4. Actions

Certain models are used to create user work items (e.g. Case, Task, Document). When created, the work item action toolbar (on the right hand side) will contain the actions that can be performed on the work item.

Which actions are available to the user depends on a number of factors:

  • the actions allowed by the model itself

  • the state of the work item

  • the user’s permissions

Some constraints are defined by edoras one itself and cannot be changed, but the model plays a large role in defining the available actions, and this should be considered carefully when designing a workflow.

To change the allowed actions, select the Edit model action and add or remove actions as required in the Allowed Actions field:

allowedActions
Table 2. Actions
Action Case Task Document Description

Activate

Yes

Yes

Yes

Re-activate an archived work item

Archive

Yes

Yes

Yes

Archived and active work item

Assign

Yes

Yes

Yes

Change the work item’s owner / responsible

Create variables

Yes

Yes

Yes

Allow new variables to be created in the work item admin view

Download

No

No

Yes

Download the work item content

Edit document

No

No

Yes

Edit the document

Move

No

No

Yes

Move the work item to another case

Preview

No

Yes

No

Show a work item preview

Share

Yes

Yes

Yes

Share the work item with specific groups

Start process

Yes

No

No

Start a new process instance

Update placeholders

No

No

Yes

Upload a new document

Upload document

No

No

Yes

Upload a new document

5. Form palette

This section describes the elements available in the form palette of edoras one. Each modeling element and it’s corresponding attributes are described in detail below.

5.1. Concepts

This section describes the form concepts in edoras one. It starts with a description of how the layout of forms and fields works in edoras one. Then it describes how a form and its fields are bound to the data model.

5.1.1. Form layout

A form is a graphical layout of fields that may be bound to a data model to allow this data model to be displayed to the user. The fields are arranged in rows.

formLayout
Figure 1. Form layout

Each row is made up of exactly twelve slots. All slots are equal in size, so the width of a slot is one twelfth the width of the whole form. A field can occupy exactly all slots or it can occupy only a part of the slots. With this it is possible to place more than one field in a row.

formLayoutWithSlots
Figure 2. Form layout with slots

Not every slot needs to be occupied by a field. It is allowed that single slots of a row are empty. These empty slots can be at the beginning, in the middle, or at the end of a row.

formLayoutWithEmptySlots
Figure 3. Form layout with empty slots

5.1.2. Field layout

A field is made up of several parts (all but the control part are optional):

Control

The control visualizes the data model. Most controls are interactive and let the user change the data model, however some controls are read-only. There are controls to manipulate strings, numbers, dates, rich text, selections, and many others. The control is located in the center of the field, all other parts are arranged around the control. The field configuration defines the concrete positioning of the field parts.

Label

The label tells the user to which part of the data model the control is bound. The label is located on the left side or on top of the control (depends on the field configuration).

Required indicator

The required indicator is displayed for required fields. Required means that the control cannot be empty. The required indicator is located on the right side of the control.

Description

The description gives additional information to the user. This can be formatting instructions or further description about how the App uses the entered value. The description is located on the bottom of the control.

fieldLayout
Figure 4. Field layout

5.1.3. Field alignment

To enhance the readability of a form, the field parts of all fields are aligned among themselves: the labels are aligned, the controls and descriptions are aligned, the required indicators are aligned.

The alignment is performed per slot. All fields that start in the same slot build a field group. Inside such a field group edoras one looks for the widest label which becomes the dominating label for that slot. All labels in the field group are then enlarged to the same width of the dominating label. This is done by adding empty space between the label and the control. This ensures that all controls and descriptions of a field group start in one line and all.

fieldAlignment
Figure 5. Field alignment

The only exception is with fields that have top label position. For these fields the label, the control and the description all start at the beginning of the slot.

fieldAlignmentTop
Figure 6. Field alignment with top label position

5.1.4. Binding

Binding is the process to connect the form fields to the data model. The binding in edoras one is always two-way. When the user changes the form fields then those changes are immediately propagated to the data model. On the other side changes in the data model are immediately propagated back to the form fields.

A binding expression defines to which part of the data model the form field is connected. The binding expression has to be a writable frontend expression, e.g. {{foo}}, {{case.bar}}.

5.2. Common attributes

There are several attributes that are available for all form components. These common attributes define the rendering and the layout of the form field, as well as the part of the data model to which the form field is bound.

Attribute name Description

Label

The label is a single word or term that describes the purpose of the form component. When the form is rendered, the label is located either on the left side or on top of the control (depends on the value of the Label position attribute).

Typical labels are: First name, Last name, Sex, Address, ZIP code, City.

Labels can be localized. See Localization to learn how to localize your Apps.

Label position

The label position relative to the control, can be either Left or Top.

Value

The value connects the form field to the data model. As such the value decides which part of the data model the form field visualizes and which part of the data model is updated when the user interacts with the control.

See Binding to learn how binding in edoras one works.

Default value

The default value is the value that is applied when the data model is undefined, i.e. not yet initialized. The default value can be expressed as a static value or as a frontend expression.

Typical default values are: Support (= string), false (= boolean), 42 (= number), Comment from {{role}} (= frontend expression).

See Frontend expressions to learn the frontend expression syntax.

Description

The description is a whole sentence that describes the purpose of the form component in more detail. When the form is rendered, the description is located below the control.

A typical description is: The ZIP file format is ##, e.g 4143. The ZIP is used to lookup the city.

Descriptions can be localized. See Localization to learn how to localize your Apps.

Visible

The visible flag decides if the form field is shown or hidden. If true, the form field is shown, if false the form field is hidden. The visible flag is a runtime value which means you can configure a frontend expression for it.

A typical frontend expression for the visible flag is: {{case.showDeliveryAddress}}

See Frontend expressions to learn the frontend expression syntax.

Editable

The editable flag decides i the form control is editable or read-only. If true, the user can manipulate the form control to change the data model, if false the user is not able to change the data model. The editable flag is a runtime value which means you can configure a frontend expression for it.

A typical frontend expression for the editable flag is: {{case.step1Completed}}

See Frontend expressions to learn the frontend expression syntax.

Style class

The style class allows to add additional CSS styles to the form field.

See [styling] to learn how to add custom styles to your form.

5.3. Validation attributes

A validation method checks if a control contains valid data, if not edoras one displays an error message that instructs the user how to fix his input. edoras one supports many different validation methods, not all are available for all form components.

Note
Validation is only done if the user is able to fix a potential validation error. This is not the case for hidden and read-only form fields, so such fields are not validated.

The following table lists the supported validation methods.

Attribute name Description

Required

The required flag defines if a form field can be empty or not. If true then the form field is not allowed to be empty, if false the form field might be empty.

A typical sample where the required flag is set to true is a name field that is mandatory.

The following form components support the required flag: text, text area, rich text area, password, number, date, checkbox, autocomplete, select, radio buttons.

Minimum length

The minimum length validation ensures that the text input is longer than a minimum length.

A typical sample is a password that has to be at least 4 characters long.

The following form components support the minimum length validation: text, text area, rich text area, password.

The Minimum length error message attribute holds the error message that is displayed when the text input is less than the configured number of characters.

Maximum length

The maximum length validation ensures that the text input has a smaller than a maximum length.

A typical sample is a password that has to be at most 8 characters long.

The following form components support the minimum length validation: text, text area, rich text area, password.

The Maximum length error message attribute holds the error message that is displayed when the text input is bigger than the configured number of characters.

Regular expression

The regular expression validation ensures that the text input matches a regular expression. See http://www.w3schools.com/jsref/jsref_obj_regexp.asp for more information on the supported regular expression syntax. Regular expression can be become quite complex and difficult to understand. http://www.regular-expressions.info/javascriptexample.html provides a good way to test your regular expressions.

A typical sample is the number of a credit card which matches: ^4[0-9]{11,12}(?:[0-9]{3})?$.

The following form components support the regular expression validation: text, text area, rich text area, password.

The Regular expression error message attribute holds the error message that is displayed when the text input does not match the regular expression.

Mask

The mask validation ensures that the text input adhere to a certain pattern. The mask can contain the following special characters: * a - Represents an alpha character (A-Z,a-z) * 9 - Represents a numeric character (0-9) * * - Represents an alphanumeric character (A-Z,a-z,0-9) * all other characters are treated as fixed input

A typical sample is the expiry date of a credit card which is the month followed by a dash followed by the year. The mask that adheres to this pattern is 99/9999.

The text form component supports mask validation.

The Mask error message attribute holds the error message that is displayed when the text input does not match the mask.

Minimum

The minimum validation ensures that the number input is equals to or bigger than a minimum.

A typical sample is an order quantity field which has to be equals to or bigger than 1.

The number form component supports the minimum validation.

The Minimum error message attribute holds the error message that is displayed when the number input is less than the configured minimum.

Maximum

The maximum validation ensures that the number input is equals to or less than a maximum.

A typical sample is an order quantity field which has to be equals to or lower than 100.

The number form component supports the minimum validation.

The Maximum error message attribute holds the error message that is displayed when the number input is bigger than the configured maximum.

Minimum date

The minimum date validation ensures that the date input is equals to or after a minimum date. The minimum date can be a fixed date, today, or a day relative to today.

A typical sample is an delivery date field which has to be equals to or after today.

The date form component supports the minimum date validation.

The Minimum date error message attribute holds the error message that is displayed when the date input is before the configured minimum date.

Maximum date

The maximum date validation ensures that the date input is equals to or before a maximum date. The maximum date can be a fixed date, today, or a day relative to today.

A typical sample is a birthday field which has to be equals to or before today.

The date form component supports the maximum date validation.

The Maximum date error message attribute holds the error message that is displayed when the date input is after the configured maximum.

Invalid selection error message

The displayed error message when the selection input is not available anymore.

The autocomplete and the select form components support the invalid selection validation.

Both form component lookup the selection in the available options to check if the selection is valid or not.

Minimum number of children

The minimum number of children validation ensures that the subform input contains at least a certain number of children.

A typical sample is an order subform which has to contain at least one order position.

The subform form component supports the minimum number of children validation.

The Minimum number of children error message attribute holds the error message that is displayed when the subform input contains less than the configured number of children.

Maximum number of children

The maximum number of children validation ensures that the subform input contains at most a certain number of children.

A typical sample is a wish list which can hold at most ten wishes.

The subform component supports the maximum number of children validation.

The Maximum number of children error message attribute holds the error message that is displayed when the subform input contains more than the configured number of children.

Minimum files

The minimum files validation ensures that not less than a certain number of files are attached.

A typical sample is a support incident attachment field where at lease one screenshot has to be attached.

The attachment form component supports the minimum files validation.

The Minimum files error message attribute holds the error message that is displayed when the attachment input has less files attached than the configured number.

Maximum files

The maximum files validation ensures that at not more than a certain number of files are attached.

A typical sample is a favorite images attachment field where not more than ten images can be attached.

The attachment component supports the maximum files validation.

The Maximum files error message attribute holds the error message that is displayed when the attachment input has more files attached than the configured number.

5.4. Text form components

The text form components allow the user to input text. To support different text input requirements edoras one provides different text form component variants. The following list explains the different text form component variants:

Form component Description
formComponentText

Used to input a single line of regular text.

formComponentTextRuntime
formComponentTextArea

Used to input multiple lines of regular text.

formComponentTextAreaRuntime
formComponentRichTextArea

Used to input multiple lines of rich text.

In contrast to regular text, rich text can be formatted in various ways: regular, bold, italic, ordered list, unordered list, headings, and much more.

formComponentRichTextAreaRuntime
formComponentPassword

Used to input a password.

The password form component is marked with a small key icon at the right border of the control. To hide the typed text from curious people all typed characters are visualized as dots.

formComponentPasswordRuntime
formComponentNumber

Used to input a number.

The number form component is marked with a small hash icon at the right border of the control.

All non number input is treated as invalid.

formComponentNumberRuntime
formComponentDate

Used to input a date.

The date form component is marked with a small calendar icon at the right border of the control. All non date input is treated as invalid.

The user can enter a date in two ways. First he can enter the date as date string, e.g. 1970-11-25. Second he can use a date picker to select a date with the mouse. The date picker pops up as soon as the date control receives focus.

formComponentDateRuntime

5.4.1. Text attributes

Attribute Description

Common

See [common-attributes] to learn more about the common attributes.

Validation

The text form component supports the required, the minimum length, the maximum length, the regular expression, and the mask validation.

See [validation-attributes] to learn more about validation.

5.4.2. Text area attributes

Attribute Description

Common

See [common-attributes] to learn more about the common attributes.

Validation

The text area form component supports the required, the minimum length, and the maximum length validation.

See [validation-attributes] to learn more about validation.

5.4.3. Rich text area attributes

Attribute Description

Common

See [common-attributes] to learn more about the common attributes.

The Default value attribute of a Rich text area form component is rich text which supports the following formatting options (see toolbar buttons on top of the default value editor):

  • bold, italic, and underline text style

  • font size

  • foreground and background color

  • left, center, and right text alignment

  • headline, sub-headline, and section headline style

  • ordered and unordered list

  • text indentation

  • horizontal line

  • links

formComponentRichTextAreaDefaultValue

Validation

The rich text area form component supports the required, the minimum length, and the maximum length validation.

See [validation-attributes] to learn more about validation.

5.4.4. Password attributes

Attribute Description

Common

See [common-attributes] to learn more about the common attributes.

Validation

The password form component supports the required, the minimum length, and the maximum length validation.

See [validation-attributes] to learn more about validation.

5.4.5. Number attributes

Attribute Description

Common

See [common-attributes] to learn more about the common attributes.

Validation

The number form component supports the required, the minimum, and the maximum validation.

See [validation-attributes] to learn more about validation.

5.4.6. Date attributes

Attribute Description

Common

See [common-attributes] to learn more about the common attributes.

The default value of a date field form field can be specified as absolute date, as relative date, or as frontend expression.

formComponentDateDefaultValue

Validation

The date form component supports the required, the minimum date, and the maximum date validation.

See [validation-attributes] to learn more about validation.

Format

Used to define the format in which the date is visualized to the user. If empty then the date is presented in the ISO 8601 format, e.g. 1970-11-25.

See [formatting-dates-in-frontend-expressions] to learn more about the possible format strings.

Number of visible years

Used to define the range of years displayed in the year drop-down.

formComponentDateRuntimeYearRange

5.5. Select form components

The select form components allow the user to select one or more options from a potential large set of options. The available options are presented in a list from which the user can select one or more options with help of the keyboard and the mouse.

Some select form component support the filtering of the available options. When the user starts typing then only the options that match the typed text are presented as available options. This makes it easy to locate a specific option in a large set of options.

The select form components are very powerful form components. To support different selection requirements edoras one provides different variants of select form components. The following list explains these variants:

Form component Selection Options Description
formComponentCheckbox

Single

Boolean true/false

Used to select a simple yes/no option.

When the checkbox is ticked then true is stored in the data model, otherwise false is stored in the data model.

formComponentCheckboxRuntime
formComponentRadioButtonGroup

Single

Static options

Used to select a single option from a static list of options.

At design time the modeler configures for each option a name and a value. The name is displayed to the user whereas the value is stored in the data model.

In the radio button form component all options are always visible. With this the user can always see all possible option, on the other side this uses a lot of form real estate and is therefore suited only it there are few options.

formComponentRadioButtonGroupRuntime
formComponentAutocompleteRest

Single or multiple

JSON options

Used to select one or more options from a dynamic list of options.

The dynamic list of options is build at runtime by calling a custom REST endpoint that the modeler has configured. Either a single attribute of the option or the complete option is stored in the data model.

formComponentAutocompleteRuntime
formComponentAutocomplete

Single or multiple

edoras one work items

Used to select one or more work items from a dynamic list of work items.

The dynamic list of work items is build at runtime by calling edoras one with a query that the modeler has configured. Either the work item id or the complete work item is stored in the data model.

formComponentAutocompleteStatic

Single or multiple

Static options

Used to select one or more options from a static list of options.

At design time the modeler configures for each option a name and a value. The name is displayed to the user whereas the value is stored in the data model.

formComponentSelectStatic

Single

Static options

Used to select a single option from a static list of options.

At design time the modeler configures for each option a name and a value. The name is displayed to the user whereas the value is stored in the data model.

The select static form component is not able to filter the possible options. To select an option the user first has to navigate to the desired option by scrolling in the option list. Therefore this form component is not a good choice if there is a large number of options.

Note
The functionality of the Radio button group, the Autocomplete static and the Select static form components is similar. The only difference is the look and feel. The Radio button group form component always shows all options with the drawback that this requires a lot of form real estate. The Autocomplete static and the Select static form components need little form real estate with the drawback that the user first has to focus the field and open a popup to see the available options.
Note
the functionality of the REST autocomplete select and the Autocomplete select form components is similar. The only difference is that the REST autocomplete select form component uses a custom REST endpoint to load the possible options (which can be of any format) whereas the Autocomplete select form component uses edoras one to load the possible work items.

5.5.1. Checkbox attributes

Attribute name Description

Common

See [common-attributes] to learn more about the common attributes.

Validation

The checkbox form component supports the required validation.

See [validation-attributes] to learn more about validation.

5.5.2. Radio button group attributes

Attribute name Description

Common

See [common-attributes] to learn more about the common attributes.

Validation

The radio button group form component supports the required validation.

See [validation-attributes] to learn more about validation.

Options

Defines the options from which the user can choose. Each option has a name and a value: the name is shown to the user whereas the value is stored in the data model.

formComponentOptions

Orientation

Defines if the single radio buttons in the group are Horizontal or Vertical aligned.

formComponentRadioButtonGroupRuntimeVertical

5.5.3. REST autocomplete select attributes

Attribute name Description

Common

See [common-attributes] to learn more about the common attributes.

Validation

The REST autocomplete select form component supports the required and the invalid selection validation.

See [validation-attributes] to learn more about validation.

Query URL

Used to load the available options that are presented to the user from a URL.

The query URL attribute can be expressed as a static value or as a frontend expression. See [frontend-expressions] to learn the frontend expression syntax.

The autocomplete form component expects the options to be returned as list of JSON objects, e.g.

[ {
  "id" : "GEAR-a65c4a12-20b4-45d8-bb09-2105be7f0d1f",
  "title" : "edoras one Modeler",
  "value" : "GEAR-a65c4a12-20b4-45d8-bb09-2105be7f0d1f"
}, {
  "id" : "GEAR-c641f3bb-876e-45f4-9550-ef95ef5a2fac",
  "title" : "edoras one User",
  "value" : "GEAR-c641f3bb-876e-45f4-9550-ef95ef5a2fac"
} ]

The user typed text is added as a URL parameter to the query URL.

https://one.edorasware.com/rest/one-groups?typedText=edoras

Usually the REST endpoint uses the typed text to filter the available options. This way the user sees only the options that match the already typed text and can easily locate single options in a large set of options.

Note
The options are filtered in the REST endpoint and not in the autocomplete form component. If the REST endpoint does not do the filtering then independent of the typed text the autocomplete form component always presents the same options to the user.

Lookup URL

Used for two things:

  • first: to load the complete information of the selected options (only if they are stored in serialized form in the data model)

  • second: to validate if the selected options are still available, see [validation-attributes] to learn more about this validation

In both cases the serialized option is appended to the lookup URL, e.g.

https://one.edorasware.com/rest/one-groups/GEAR-a65c4a12-20b4-45d8-bb09-2105be7f0d1f

The option is serialized with help of the Serialization. So the Lookup URL and the Serialization attribute have to play together.

Serialization

Used to select the attribute in the JSON option that is stored in the data model.

The prefix to select an attribute from the JSON option is item.

So if the JSON option looks like

{
  "id" : "GEAR-c641f3bb-876e-45f4-9550-ef95ef5a2fac",
  "title" : "edoras one User",
  "value" : "GEAR-c641f3bb-876e-45f4-9550-ef95ef5a2fac"
}

then a Serialization of item.id results in GEAR-c641f3bb-876e-45f4-9550-ef95ef5a2fac being stored in the data model.

Note
Please note that the Serialization, the Query URL, and the Lookup URL attributes have to play together. The Serialization converts the JSON options returned by the Query URL REST endpoint into strings which then are stored in the data model. And the Lookup URL REST endpoint does the opposite: it takes the strings stored in the data model and converts them back into JSON options.

Format

Used to compose a user friendly string from the JSON option.

The prefix to select an attribute from the JSON option is item. Literals have to be enclosed in quotes, attributes and literals can be concatenated with +.

So if the JSON option looks like

{
  "id" : "GEAR-c641f3bb-876e-45f4-9550-ef95ef5a2fac",
  "title" : "edoras one User",
  "value" : "GEAR-c641f3bb-876e-45f4-9550-ef95ef5a2fac"
}

then a format of 'Group: ' + item.title results in Group: edoras one User being presented to the user for this JSON option.

Navigation URL

Used to set a link icon to the left of each option in the list and each selected option. The Navigation URL defines the URL to navigate to when the user clicks a link icon.

The navigation URL attribute can be expressed as a static value or as a frontend expression. See [frontend-expressions] to learn the frontend expression syntax.

The prefix to select an attribute from the JSON option is $item.

So if the JSON option looks like

{
  "id" : "GEAR-c641f3bb-876e-45f4-9550-ef95ef5a2fac",
  "title" : "edoras one User",
  "value" : "GEAR-c641f3bb-876e-45f4-9550-ef95ef5a2fac"
}

then a navigation URL of /GRP/{{$item.id}}/browse results in /GRP/GEAR-3456061f-4892-4ef4-b234-69217201cd09/browse being invoked when the user clicks the link icon.

formComponentAutocompleteRuntimeLink

Target

Used to define the tab where the linked option is loaded.

Possible values are:

  • _blank ⇒ Load in a new tab

  • _self ⇒ Load in the same tab as it was clicked

  • tabname ⇒ Load in a named tab, if there is no tab with that name then a new tab is created with that name

Multi selection

False if only one option can be selected, true if multiple options can be selected.

If true then the selected options are stored as a list in the data model.

formComponentAutocompleteRuntimeMultiple

5.5.4. Autocomplete select attributes

Attribute name Description

Common

See [common-attributes] to learn more about the common attributes.

Validation

The autocomplete select form component supports the required and the invalid selection validation.

See [validation-attributes] to learn more about validation.

Query

The edoras one query that is used to load the available work items that are presented to the user.

The user typed text is added as additional filter to the configured query.

Typical queries:

type:CAS for:me

all cases that are assigned to me

type:TSK for:me,unassigned

all tasks that are either directly assigned to me or are unassigned

type:CAS app:foo

all cases that belong to the foo App

See section Searches in the User guide to learn more about the search syntax and about all possible search terms.

Format

Used to compose a user friendly string from the work item.

The prefix to select an variable from the work item item. Literals have to be enclosed in quotes, attributes and literals can be concatenated with +.

So if the format is 'Group: ' + item.name then the work item is shown to the user as Group: edoras one User.

Navigation view

Used to set the target view for the link.

Possible values are:

  • Browse ⇒ The link points to the form view of the work item

  • Preview ⇒ The link points to the preview view of the work item

Target

Used to define the tab where the linked work item is loaded.

Possible values are:

  • _blank ⇒ Load in a new tab

  • _self ⇒ Load in the same tab as it was clicked

  • tabname ⇒ Load in a named tab, if there is no tab with that name then a new tab is created with that name

Multi selection

False if only one option can be selected, true if multiple options can be selected.

If true then the selected options are stored as a list in the data model.

formComponentAutocompleteRuntimeMultiple

5.5.5. Static autocomplete select attributes

Attribute name Description

Common

See [common-attributes] to learn more about the common attributes.

Validation

The static autocomplete select form component supports the required and the invalid selection validation.

See [validation-attributes] to learn more about validation.

Options

Defines the options from which the user can choose. Each option has a name and a value: the name is shown to the user whereas the value is stored in the data model.

formComponentOptions

Navigation URL

Used to set a link icon to the left of each option in the list and each selected option. The Navigation URL defines the URL to navigate to when the user clicks a link icon.

The navigation URL attribute can be expressed as a static value or as a frontend expression. See [frontend-expressions] to learn the frontend expression syntax.

The prefix to select an attribute from the option is $item. The following two option attributes are available:

name

the name that is shown to the user

value

the value that is stored in the data model

So if the navigation URL is https://www.google.ch/search?q={{$item.value}} then the link URL results in https://www.google.ch/search?q=edorasware.

formComponentAutocompleteRuntimeLink

Multi selection

False if only one option can be selected, true if multiple options can be selected.

If true then the selected options are stored as a list in the data model.

formComponentAutocompleteRuntimeMultiple

5.5.6. Static select attributes

Attribute name Description

Common

See [common-attributes] to learn more about the common attributes.

Validation

The static select form component supports the required and the invalid selection validation.

See [validation-attributes] to learn more about validation.

Options

Defines the options from which the user can choose. Each option has a name and a value: the name is shown to the user whereas the value is stored in the data model.

formComponentOptions

5.6. Read only form components

The read only form components allow to present information, to add navigation functionality, and to split a form into section.

Form component Description
formComponentOutputTextArea

Used to show static rich text.

The rich text can be formatted in various ways: regular, bold, italic, ordered list, unordered list, headings, and much more.

formComponentOutputTextAreaRuntime
formComponentListRest

Used to show a list of options that are returned by a custom REST endpoint.

The dynamic list of options is build at runtime by calling a custom REST endpoint that the modeler has configured. The rest list form component can be used to enable simple navigation inside your App. For this the modeler can configure the links that are followed when the user clicks one of the options in the list.

formComponentListRestRuntime
formComponentList

Used to show a list of work items that are returned by edoras one.

The dynamic list of work items is build at runtime by calling calling edoras one with a query that the modeler has configured. The rest list form component can be used to enable simple navigation inside your App. For this the modeler can configure the links that are followed when the user clicks one of the options in the list.

formComponentImage

Used to show an image.

formComponentImageRuntime
formComponentLink

Used to show a generic link.

formComponentLinkRuntime
formComponentLinkQueryRest

Used to show a link that points to a configurable REST query.

The link text can be configured to show the number of elements returned by the REST query. Clicking the link navigates to the result of the REST query.

formComponentLinkQueryRestRuntime
formComponentLinkQuery

Used to show a link that points to a configurable query.

The link text can be configured to show the number of elements returned by the query. Clicking the link navigates to the result of the query.

formComponentLinkButton

Used to show a button that points to a generic URL.

formComponentLinkButtonRuntime
formComponentLinkButtonQuery

Used to show a button that points to a configurable query.

The button text can be configured to show the number of elements returned by the query. Clicking the button navigates to the result of the query.

formComponentHorizontalLine

Used to show a horizontal line.

The Horizontal line form component is useful to structure large forms by splitting the form into sections, e.g. basic information, detail information, address, …

formComponentHorizontalLineRuntime
Note
the functionality of the REST list and the List form components is similar. The only difference is that the REST list form component uses a custom REST endpoint to load the displayed items (which can be of any format) whereas the List form component uses edoras one to load the displayed work items.
Note
the functionality of the REST query link and the Query link form component is similar. The only difference is that the REST query link form component uses a custom REST endpoint to load the number of found elements whereas the Query link form component uses edoras one to load the number of found elements.
Note
the functionality of the Link and the Link button as well as the Query link and the Query link button is similar. The only difference is that the Link and the Query link form components are rendered as links whereas the Link button and the Query link button form components are rendered as buttons.

5.6.1. Output text area attributes

Attribute name Description

Common

See [common-attributes] to learn more about the common attributes.

The Output text area form component does not support the Default value and the Editable attribute, as these do not make sense for read only components.

The Value attribute of a Output text area form component is rich text which supports the following formatting options (see toolbar buttons in the image below): bold, italic, and underline text style, font size, foreground and background color, left, center, and right text alignment, headline, sub-headline, and section headline style, ordered and unordered list, text indentation, horizontal line, links.

formComponentOutputTextAreaValue

5.6.2. REST list attributes

Attribute name Description

Common

See [common-attributes] to learn more about the common attributes.

The REST list form component does not support the Value, the Default value and the Editable attribute, as these do not make sense for read only components.

Query URL

Used to load the items that are presented to the user from a URL.

The query URL attribute can be expressed as a static value or as a frontend expression. See [frontend-expressions] to learn the frontend expression syntax.

The list form component expects the items to be returned as list of JSON objects, e.g.

----
[ {
  "id" : "GEAR-a65c4a12-20b4-45d8-bb09-2105be7f0d1f",
  "title" : "edoras one Modeler",
  "value" : "GEAR-a65c4a12-20b4-45d8-bb09-2105be7f0d1f"
}, {
  "id" : "GEAR-c641f3bb-876e-45f4-9550-ef95ef5a2fac",
  "title" : "edoras one User",
  "value" : "GEAR-c641f3bb-876e-45f4-9550-ef95ef5a2fac"
} ]
----

List title

Used to define the title that is shown in the header of the list.

The list title attribute can be expressed as a static value or as a frontend expression. See [frontend-expressions] to learn the frontend expression syntax.

Format

Used to compose a user friendly string from the JSON item.

The prefix to select an attribute from the JSON item is item. Literals have to be enclosed in quotes, attributes and literals can be concatenated with +.

So if the JSON item looks like

{
  "id" : "GEAR-c641f3bb-876e-45f4-9550-ef95ef5a2fac",
  "title" : "edoras one User",
  "value" : "GEAR-c641f3bb-876e-45f4-9550-ef95ef5a2fac"
}

then a format of 'Group: ' + item.title results in Group: edoras one User being presented to the user for this JSON item.

Minimum number of visible items

Used to define the minimum height of the list.

The list height is forced to a height that can show at least a certain number of items. If the concrete list has less items then the missing space is filled with empty items. For example if there are 5 items to show and the minimum height is 10 then the list height is forced to a height that can show 10 items.

formComponentListRestRuntimeMinimumHeight

Maximum number of visible items

Used to define the maximum height of the list.

The list height is forced to a height that can show at most a certain number of items. If the concrete list has more items then the list shows a scroll with which the user can scroll in the list. For example if there are 15 items to show and the minimum height is 10 then the list height is forced to a height that can show 10 items.

formComponentListRestRuntime

Navigation URL

Used to define the URL to navigate to when the user clicks an item in the list.

The navigation URL attribute can be expressed as a static value or as a frontend expression. See [frontend-expressions] to learn the frontend expression syntax.

The prefix to select an attribute from the JSON option is $item.

So if the JSON item looks like

{
  "id" : "GEAR-c641f3bb-876e-45f4-9550-ef95ef5a2fac",
  "title" : "edoras one User",
  "value" : "GEAR-c641f3bb-876e-45f4-9550-ef95ef5a2fac"
}

then a navigation URL of /GRP/{{$item.id}}/browse results in /GRP/GEAR-3456061f-4892-4ef4-b234-69217201cd09/browse being invoked when the user clicks the item in the list.

Target

Used to define the tab where the linked item is loaded.

Possible values are:

  • _blank ⇒ Load in a new tab

  • _self ⇒ Load in the same tab as it was clicked

  • tabname ⇒ Load in a named tab, if there is no tab with that name then a new tab is created with that name

5.6.3. List attributes

Attribute name Description

Common

See [common-attributes] to learn more about the common attributes.

The List form component does not support the Value, the Default value and the Editable attribute, as these do not make sense for read only components.

Query

The edoras one query that is used to load the work items for the list.

Typical queries:

type:CAS for:me

all cases that are assigned to me

type:TSK for:me,unassigned

all tasks that are either directly assigned to me or are unassigned

type:CAS app:foo

all cases that belong to the foo App

See section Searches in the User guide to learn more about the search syntax and about all possible search terms.

List title

Used to define the title that is shown in the header of the list.

The list title attribute can be expressed as a static value or as a frontend expression. See [frontend-expressions] to learn the frontend expression syntax.

Format

Used to compose a user friendly string from the work item.

The prefix to select an variable from the work item item. Literals have to be enclosed in quotes, attributes and literals can be concatenated with +.

So if the format is 'Group: ' + item.name then the work item is shown to the user as Group: edoras one User.

Minimum number of visible items

Used to define the minimum height of the list.

The list height is forced to a height that can show at least a certain number of items. If the concrete list has less items then the missing space is filled with empty items. For example if there are 5 items to show and the minimum height is 10 then the list height is forced to a height that can show 10 items.

formComponentListRestRuntimeMinimumHeight

Maximum number of visible items

Used to define the maximum height of the list.

The list height is forced to a height that can show at most a certain number of items. If the concrete list has more items then the list shows a scroll with which the user can scroll in the list. For example if there are 15 items to show and the minimum height is 10 then the list height is forced to a height that can show 10 items.

formComponentListRestRuntime

Navigation view

Used to set the target view for the link.

Possible values are:

  • Browse ⇒ The link points to the form view of the work item

  • Preview ⇒ The link points to the preview view of the work item

Target

Used to define the tab where the linked work item is loaded.

Possible values are:

  • _blank ⇒ Load in a new tab

  • _self ⇒ Load in the same tab as it was clicked

  • tabname ⇒ Load in a named tab, if there is no tab with that name then a new tab is created with that name

5.6.4. Image attributes

Attribute name Description

Common

See [common-attributes] to learn more about the common attributes.

The Image form component does not support the Value, Default value and the Editable attribute, as these do not make sense for read only components.

Source URL

Used to define the URL from which the image is loaded.

The source URL attribute can be expressed as a static value or as a frontend expression. See [frontend-expressions] to learn the frontend expression syntax.

This can be an absolute URL like http://www.activiti.org/images/edorasware_logo.png or a relative URL that points to the content of a document work item, for example rest/workobjects/GEAR-faded1c0-a147-4fb1-9875-e13b185b0abe/content.

Maximum height

Used to define the maximum height of the image.

If set then the height of the Image form component is forced to that height, which means the contained image is scaled down to that height. If not set then the height of the Image form component is equals to the height of the contained image.

Refresh time (seconds)

Used to define a refresh internal in seconds.

The image is reloaded every x seconds, where x is the defined refresh time. This is useful if the Source URL attribute point to a dynamic image that can change over time.

Navigation URL

Used to define the URL to navigate to when the user clicks the image.

The navigation URL attribute can be expressed as a static value or as a frontend expression. See [frontend-expressions] to learn the frontend expression syntax.

Target

Used to define the tab where the linked item is loaded.

Possible values are:

  • _blank ⇒ Load in a new tab

  • _self ⇒ Load in the same tab as it was clicked

  • tabname ⇒ Load in a named tab, if there is no tab with that name then a new tab is created with that name

Attribute name Description

Common

See [common-attributes] to learn more about the common attributes.

The Link form component does not support the Default value and the Editable attribute, as these do not make sense for read only components.

The Value attribute is used to define the link text.

Navigation URL

Used to define the URL to navigate to when the user clicks the link.

The navigation URL attribute can be expressed as a static value or as a frontend expression. See [frontend-expressions] to learn the frontend expression syntax.

Target

Used to define the tab where the linked item is loaded.

Possible values are:

  • _blank ⇒ Load in a new tab

  • _self ⇒ Load in the same tab as it was clicked

  • tabname ⇒ Load in a named tab, if there is no tab with that name then a new tab is created with that name

Attribute name Description

Common

See [common-attributes] to learn more about the common attributes.

The Link form component does not support the Default value and the Editable attribute, as these do not make sense for read only components.

The Value attribute is used to define the link text.

The value attribute can be expressed as a static value or as a frontend expression. See [frontend-expressions] to learn the frontend expression syntax. The value attribute supports the special $count frontend expression which represents the result count of the REST query. The value attribute as well supports different texts for singular and plural depending on the result count. The syntax for this is [singular text|plural text].

So a value of $count user [|s] results in 1 user or 21 users depending on the result count.

Count URL

Used to define the URL that returns the result count of the REST query.

The count URL attribute can be expressed as a static value or as a frontend expression. See [frontend-expressions] to learn the frontend expression syntax.

Navigation URL

Used to define the URL to navigate to when the user clicks the link.

The navigation URL attribute can be expressed as a static value or as a frontend expression. See [frontend-expressions] to learn the frontend expression syntax.

Target

Used to define the tab where the linked item is loaded.

Possible values are:

  • _blank ⇒ Load in a new tab

  • _self ⇒ Load in the same tab as it was clicked

  • tabname ⇒ Load in a named tab, if there is no tab with that name then a new tab is created with that name

Attribute name Description

Common

See [common-attributes] to learn more about the common attributes.

The Link form component does not support the Default value and the Editable attribute, as these do not make sense for read only components.

The Value attribute is used to define the link text.

The value attribute can be expressed as a static value or as a frontend expression. See [frontend-expressions] to learn the frontend expression syntax. The value attribute supports the special $count frontend expression which represents the result count of the REST query. The value attribute as well supports different texts for singular and plural depending on the result counts. The syntax for this is [singular text|plural text].

So a value of $count user [|s] results in 1 user or 21 users depending on the result count.

Query

The edoras one query that is used to load the work items for the list.

Typical queries:

type:CAS for:me

all cases that are assigned to me

type:TSK for:me,unassigned

all tasks that are either directly assigned to me or are unassigned

type:CAS app:foo

all cases that belong to the foo App

See section Searches in the User guide to learn more about the search syntax and about all possible search terms.

Target

Used to define the tab where the linked item is loaded.

Possible values are:

  • _blank ⇒ Load in a new tab

  • _self ⇒ Load in the same tab as it was clicked

  • tabname ⇒ Load in a named tab, if there is no tab with that name then a new tab is created with that name

Attribute name Description

Common

See [common-attributes] to learn more about the common attributes.

The Link form component does not support the Default value and the Editable attribute, as these do not make sense for read only components.

The Value attribute is used to define the button text.

Navigation URL

Used to define the URL to navigate to when the user clicks the button.

The navigation URL attribute can be expressed as a static value or as a frontend expression. See [frontend-expressions] to learn the frontend expression syntax.

Target

Used to define the tab where the linked item is loaded.

Possible values are:

  • _blank ⇒ Load in a new tab

  • _self ⇒ Load in the same tab as it was clicked

  • tabname ⇒ Load in a named tab, if there is no tab with that name then a new tab is created with that name

Tooltip

Used to define the tooltip for the button.

The tooltip attribute can be expressed as a static value or as a frontend expression. See [frontend-expressions] to learn the frontend expression syntax.

Attribute name Description

Common

See [common-attributes] to learn more about the common attributes.

The Link form component does not support the Default value and the Editable attribute, as these do not make sense for read only components.

The Value attribute is used to define the button text.

The value attribute can be expressed as a static value or as a frontend expression. See [frontend-expressions] to learn the frontend expression syntax.

Query

The edoras one query that is used to load the work items for the list.

Typical queries:

type:CAS for:me

all cases that are assigned to me

type:TSK for:me,unassigned

all tasks that are either directly assigned to me or are unassigned

type:CAS app:foo

all cases that belong to the foo App

See section Searches in the User guide to learn more about the search syntax and about all possible search terms.

Target

Used to define the tab where the linked item is loaded.

Possible values are:

  • _blank ⇒ Load in a new tab

  • _self ⇒ Load in the same tab as it was clicked

  • tabname ⇒ Load in a named tab, if there is no tab with that name then a new tab is created with that name

Tooltip

Used to define the tooltip for the button.

The tooltip attribute can be expressed as a static value or as a frontend expression. See [frontend-expressions] to learn the frontend expression syntax.

5.6.10. Horizontal line attributes

Attribute name Description

Common

See [common-attributes] to learn more about the common attributes.

The Label attribute is used to define the title that is displayed inside the horizontal line.

The Horizontal line form component does not support the Default value and the Editable attribute, as these do not make sense for read only components.

5.7. Nesting form components

The nesting form components allow to nest components.

The data model of a nested form is usually stored in a nested data context. If configured that way the forms and the data model nest in a corresponding way: A field in a nested form then becomes a attribute in the nested data context.

Nested forms can be repeated. This way it is possible to define lists in the data model.

Usually nested forms are rendered in a way that the user can clearly see that the form fields belong to a nested form. But if desired nested forms can be rendered in a transparent way. The user can then not tell if a field comes from the main form or from a nested form.

Form component Description
formComponentSingleTypeSubform

Used to nest forms of a single type.

formComponentSingleTypeSubformRuntime
formComponentMultiTypeSubform

Used to nest forms of mutiple types.

formComponentMultiTypeSubformRuntime

5.7.1. Single-type subform attributes

Attribute Description

Common

See [common-attributes] to learn more about the common attributes.

The Value attribute is used to define the nested data context. This means if the Value is set to foo then all data inside the subform is stored in the foo attribute of the data model.

The Single-type subform form component does not support the Label position, the Default value, and the Description attribute, as these do not make sense for nesting components.

Validation

The single-type subform form component supports the minimum number of children and the maximum number of children validation.

See [validation-attributes] to learn more about validation.

Form reference

Used to define the form that is rendered in place of the subform.

The editor for this attribute allows to pick an existing form or to create a new one.

formComponentFormRef

Is dynamic

Used to define if the user can repeat the form or not.

If true, additional buttons are rendered to let the user add new forms and remove existing ones.

formComponentSingleTypeSubformRuntimeRepeating

Entity display name

Used to define the text for the add button.

Show as child entity

Used to define if the form inside the subform form component is rendered nested or not.

If true the form is rendered in a nested way and the user can clearly see that this is a nested form. If false the form is rendered in a transparent way and the user cannot distinguish if a field comes form the main form or from the nested form.

formComponentSingleTypeSubformRuntimeTransparent

5.7.2. Multi-type subform attributes

Attribute Description

Common

See [common-attributes] to learn more about the common attributes.

The Value attribute is used to define the nested data context. This means if the Value is set to foo then all data inside the subform is stored in the foo attribute of the data model.

The Multi-type subform form component does not support the Label position, the Default value, and the Description attribute, as these do not make sense for nesting components.

Validation

The multi-type subform form component supports the minimum number of children and the maximum number of children validation.

See [validation-attributes] to learn more about validation.

Discriminator

Used to define the discriminator attribute inside the sub data context.

The value stored in the discriminator attribute decides which form is used to display the data in the sub data context.

Form references

Used to define the forms that are rendered in place of the subform.

The editor to define the form references asks for pairs of discriminator value and form references. The discriminator value identifies the form reference and hence the form to be used inside the data model.

formComponentFormRefs

Is dynamic

Used to define if the user can repeat the forms or not.

If true, additional buttons are rendered to let the user add new forms and remove existing ones.

Entity display names

Used to define the texts for the add button.

The editor to define the entity display names asks for pairs of discriminator value and display names. The discriminator value identifies the entity name to be used in the add button.

formComponentEntityDisplayNames

Show as child entity

Used to define if the form inside the subform form component is rendered nested or not.

If true the form is rendered in a nested way and the user can clearly see that this is a nested form. If false the form is rendered in a transparent way and the user cannot distinguish if a field comes form the main form or from the nested form.

formComponentSingleTypeSubformRuntimeTransparent

5.8. Attachment form component

formComponentAttachment

The attachment form component allows to attach files.

formComponentAttachmentRuntime
Attribute Description

Common

See [common-attributes] to learn more about the common attributes.

Validation

The attachment form component supports the minimum files and the maximum files validation.

See [validation-attributes] to learn more about validation.

Preview type

Used to define the preview type.

The following values are allowed:

None

display no preview

Icon

display an icon that identifies the file type as preview

Thumbnail

display a thumbnail of the attached file as preview, the thumbnail is generated in the backend

Thumbnail maximum height

Used to define the maximum height of the thumbnail.

This attribute is only available when the preview type is Thumbnail.

Select file message

Used to define the message that is shown to the user inside the attachment form component.

By default the attachment form component shows Please select file to the user.

6. Process Palette

This section describes the elements available in the process modelling palette of edoras one. Each modeling element and it’s corresponding attributes are described in detail below. Since edoras one is based on BPMN 2.0 huge parts of the modelling capabilities come from there. Currently, edoras one does not support the full BPMN 2.0 standard for execution. The process palette contains only the BPMN2.0 elements that are currently supported by the engine. Besides the BPMN 2.0 standard elements, edoras one provides some dedicated process activities that can be used within the processes. These edoras one specific activities are dedicated implementations of BPMN 2.0s generic service task. They are implemented using the custom extensions hook of BPMN 2.0 so if you import a process model to another system that supports BPMN 2.0 these activities are considered as generic service tasks.

There are several attributes, that are available for all modelling elements:

Table 3. Common attributes
Attribute Name Description

Name

The name of the element, displayed on the diagram. This attribute is not equal to the id of the element.

Documentation

Use this attribute to add any documentation / description to the element. The content of the element can not be displayed on the model graphics, but is exported to the BPMN 2.0 XML.

Custom Properties

Define arbitrary properties as key value pairs. The attribute is exported to the BPMN 2.0 XML and can be accessed at runtime.

Background Color

Specify the background color of the element in the diagram.

6.1. Start Event

A none start event technically means that the trigger for starting the process instance is unspecified. This means that the engine cannot anticipate when the process instance must be started.

startEvent
Figure 7. Graphical Representation
Table 4. Specific attributes
Attribute Name Attribute Type

Description

none

Any sub-process has always to start with a none start event.

6.2. Message start event

A message start event can be used to start a process instance using a named message. This effectively allows us to select the right start event from a set of alternative start events using the message name.

When deploying a process definition with one or more message start events, the following considerations apply:

  • The name of the message start event must be unique across a given process definition. A process definition must not have multiple message start events with the same name. edoras one throws an exception upon deployment of a process definition such that two or more message start events reference the same message of if two or more message start events reference messages with the same message name.

  • The name of the message start event must be unique across all deployed process definitions. edoras one throws an exception upon deployment of a process definition such that one or more message start events reference a message with the same name as a message start event already deployed by a different process definition.

  • Process versioning: Upon deployment of a new version of a process definition, the message subscriptions of the previous version are cancelled. This is also true for message events that are not present in the new version.

messageStartEvent
Figure 8. Graphical Representation
Table 5. Specific attributes
Attribute Name Description

none

6.3. Error start event

An error start event can be used to trigger an Event Sub-Process. An error start event cannot be used for starting a process instance.

An error start event is always interrupting.

errorStartEvent
Figure 9. Graphical Representation
Table 6. Specific attributes
Attribute Name Description

Error code

The error code associated to the event.

6.4. Timer start event

A timer start event is used to create process instance at given time. It can be used both for processes which should start only once and for processes that should start in specific time intervals.

Note

A subprocess cannot have a timer start event.

Note

Start timer event is scheduled as soon as process is deployed. There is no need to to start an instance explicitly, although starting a process is not restricted and will cause one more starting of the process at the time invocation.

Note

When a new version of a process with a start timer event is deployed, the job corresponding with the previous timer will be removed. The reasoning is that normally it is not wanted to keep automatically starting new process instances of this old version of the process.

timerStartEvent
Figure 10. Graphical Representation
Table 7. Specific attributes
Attribute Name Description

Timer properties

Opens a dialog to specify when the timer should fire.

6.5. Message intermediate catching event

Message Intermediate Catching Events are used to model wait state for particular message event with a specified name. After message catching process instance continues in its execution.

Message Intermediate Catching Event style rules: * By convention, message intermediate catching events are named after the event they are waiting for. (e.g. "Additional data received")

messageIntermediateCatchingEvent
Figure 11. Graphical Representation
Table 8. Specific attributes
Attribute Name Description

Message name

The name of the message that the event is waiting for

Operation name

6.6. Timer intermediate catching event

Timer Intermediate Catching Events are used to model wait state driven by a time.

Timer Intermediate Catching Event style rules: * By convention, timer intermediate catching events are named after the event they are waiting for. (e.g. "Delivery deadline reached")

timerIntermediateCatchingEvent
Figure 12. Graphical Representation
Table 9. Specific attributes
Attribute Name Description

Timer properties

A wizard to configure the timer

6.7. End event

A none end event means that the result thrown when the event is reached is unspecified. As such, the engine will not do anything extra besides ending the current path of execution.

endEvent
Figure 13. Graphical Representation
Table 10. Specific attributes
Attribute Name Description

none

6.8. Error end event

When process execution arrives in an error end event, the current path of execution is ended and an error is thrown. This error can caught by a matching intermediate boundary error event. In case no matching boundary error event is found, an exception will be thrown.

errorEndEvent
Figure 14. Graphical Representation
Table 11. Specific attributes
Attribute Name Description

Error code

The error code associated to the event.

6.9. User Task

A user task is used to model work that needs to be done by a human actor. When the process execution arrives at such a user task, a new task is created in the task list of the user(s) or group(s) assigned to that task.

userTask
Figure 15. Graphical Representation
Table 12. Specific attributes
Attribute Name Description

Categories

attribute not recognized

LoopType

not yet supported

Owner

Set the owner of the task by selecting an existing user statically

Owner (RT)

Use a backend expression to evaluate the owner dynamically at runtime

Assignee

Set the assignee of the task by selecting an existing user statically

Assignee (RT)

Use a backend expression to evaluate the assignee dynamically at runtime

Candidate Users

Set the candidate users of the task by selecting existing users statically

Candidate Users (RT)

Use a backend expression to evaluate the candidate users dynamically at runtime

Candidate Groups

Set the candidate users of the task by selecting existing groups statically

Candidate Groups (RT)

Use a backend expression to evaluate the candidate groups dynamically at runtime

Priority

Set the priority of the task by using a literal or a backend expression. The priority is not currently not supported at runtime

Due Date

Set the due date of the task. The due date is currently not supported at runtime

FormRef

Select a form to be attached to the current task. You can also directly create a new form from here

Mail Attributes

Refer to Send Mail Service Task for the usage of these attributes. By using this attribute section, you cause the engine to additionally send an email when the task is created

6.10. Manual task

A Manual task defines a task that is external to the BPM engine. It is used to model work that is done by somebody, which the engine does not need to know of, nor is there a system or UI interface. For the engine, a manual task is handled as a pass-through activity, automatically continuing the process from the moment process execution arrives into it.

manualTask
Figure 16. Graphical Representation
Table 13. Specific attributes
Attribute Name Description

none

6.11. Create Case Service Task

The Create Case Service Task can be used to create a new case from within a process. Input data for the new case can be mapped and the newly created case can be referenced form the current case if needed.

createCaseServiceTask
Figure 17. Graphical Representation
Table 14. Specific attributes
Attribute Name Description

Case Model

Select a case model for the new case to be created

Init Variables

Specify additional variables that should be initialized during the creation of the new case

Case Name

Set the name of the new case using literals or backend expressions

CaseId Variable

specify a variable name where the id of the newly created case should be stored in the current case. This is optional

Categories

attribute not recognized

LoopType

not yet supported

6.12. Create case from subform service task

The create case from subform service Task is an itemization of the create case service task. Here you can specify a variable (subform) of the current workitem hierarchy as the input values for the new case instead of binding all input parameters manually.

createCaseServiceTask
Figure 18. Graphical Representation
Table 15. Specific attributes
Attribute Name Description

Case Model

Select a case model for the new case to be created

Init Variables

Specify additional variables that should be initialized during the creation of the new case

Case Name

Set the name of the new case using literals or backend expressions

CaseId Variable

specify a variable name where the id of the newly created case should be stored in the current case. This is optional

Subform Variable

Specify the variable name where the subform to create the new case from is bound to

Remove Subform Variable

If set to true, the variable of the subform will be removed from the data model after creating the case

Categories

attribute not recognized

LoopType

not yet supported

6.13. Create document service task

edoras one allows to enhance business processes with document creation service tasks. The create document service task creates a copy of the specified document template insid the current case. In case the document template is either a MS Word or Adobe PDF form, form fields will automatically be populated with execution data. Refer to Document Placeholders for more information.

createDocumentServiceTask
Figure 19. Graphical Representation
Table 16. Specific attributes
Attribute Name Description

Document Model

Select a document model for the new document to be created

Document Id Variable

specify a variable name where the id of the newly created document should be stored in the current case. This is optional

Categories

attribute not recognized

LoopType

not yet supported

6.14. Send Mail Service Task

edoras one allows to enhance business processes with automatic mail service tasks that send e-mails to one or more recipients, including support for cc, bcc, mail templates, … etc.

Note

See section Mail Server in the Operators Guide for information on configuring the mail server in an on-premise environment

sendMailServiceTask
Figure 20. Graphical Representation
Table 17. Specific attributes
Attribute Name Description

Categories

attribute not recognized

LoopType

not yet supported

Mail Model

This is a reference to a mail model in the current App. This model defines rich-text templates for the mail subject and body. Backend expressions in the mail model templates will be replaced when the mail is sent

Mail Recipient

The mail recipient is a required expression or literal that defines the email recipient (or multiple recipients)

Mail Reply-To

The mail reply-to is an optional expression that specify an explicit reply address. If no reply address is defined then the global system default will be used (which will vary from installation to installation)

Mail CC

Specify one or multiple CC recipients using literals or backend expressions. This attribute is optional

Mail Bcc

Specify one or multiple BCC recipients using literals or backend expressions. This attribute is optional

Mail Priority

An optional expression or literal that specifies the mail priority (usually an integer in the range 1 - 5)

Mail Headers

Specify additional mail headers. They will be applied before the message is sent

6.15. Invoke REST endpoint service task

The Invoke REST endpoint service task provides a generic client to call arbitrary REST endpoints. The task supports all HTTP operations, Basic Authentication, custom headers and different mime-types.

invokeRESTEndpointServiceTask
Figure 21. Graphical Representation
Table 18. Specific attributes
Attribute Name Description

Categories

attribute not recognized

LoopType

not yet supported

Protocol

Specify the protocol to use for the request. HTTP and HTTPS are supported

Request Type

Specify the type of the HTTP Request. GET, POST, PUT and DELETE are supported

Headers

Add additional HTTP message headers to your request

Request Body

Specify the message body that will be sent with the request. You can use backend expressions to include data from the data model within your message body structure. This can only be used with POST and PUT requests

Content Type

Define the content type header to be set within the request. This value will be overwritten if you have set a content type in the Header attribute

Host Name

The host name of the remote server (e.g. service.edorasware.com

Port Number

The port number of the remote server. If not specified, 80 is used

Request Path

Specify the path to the endpoint on the remote server. The path must start with a leading / You can use backend expressions to set the path dynamically at runtime based on values from the data model

Request Parameters

Specify the parameters that are passed as part of the request URL. Multiple parameters can be defined using the editor provided

Username

If the remote server requires basic authentication specify the username of the user you want to use for the request

Password

If the remote server requires basic authentication specify the password of the user you want to use for the request

Response Type

Select the format of the response of the REST call. Currently JSON and XML are supported

Set Variables

Map the response data to your data model. specify the variable name and use X-Path expressions to select the respecting value from the response

Overwrite if existing

Set to true if you want to overwrite the values of existing variables with the values from the REST calls response

6.15.1. JSON to XML mapping

The JSON to XML mapping used to prepare data for the XPath expression evaluation is mainly intuitive, but for completeness here is a quick summary of how different JSON content is mapped:

Table 19. JSON to XML mapping
JSON XML XPath example Result
{ 'node': 'value' }
<root>
  <node original-type="string">value</node>
</root>

//node

value

{ 'node': [ 'value1', 'value2' ] }
<root>
  <node1 original-type="string">value1</node1>
  <node2 original-type="string">value2</node2>
</root>

//node[2]

value2

{ 'node': { 'child':'cValue' } }
<root>
  <node>
    <child original-type="string">cValue</child>
  </node>
</root>

//child

cValue

'single value'
<root original-type="string">single value</root>

/root

single value

[ 'one', 'two', 'three' ]
<json>
  <root original-type="string">one</root>
  <root original-type="string">two</root>
  <root original-type="string">three</root>
</json>

/json/root[2]

two

Note

Note that in the case where multiple values are in the top-level JSON content, an additional root node (json) will be created as XML may only have a single root node.

6.16. Initialize variables service task

Use the initialize variables service task to initialize arbitrary variables in the current workitem hierarchy. You can use Expressions or literals to set the values of the variables.

initializeVariablesServiceTask
Figure 22. Graphical Representation
Table 20. Specific attributes
Attribute Name Description

Init Variables

Specify variable name and target workitem of the variable you want to initialize using literals. Use literals or backend expressions to specify the value of the variable

Overwirte if existing

If set to true, the values of already defined variables will be overwritten. Otherwise, already initialized variables are skipped

Categories

attribute not recognized

LoopType

not yet supported

6.17. Comment service task

Use the comment service task to add a comment to an arbitrary workitem reachable by the expression resolver. You can use templates similar to the ones in the send mail service Task to add formatted, structured comments.

commentServiceTask
Figure 23. Graphical Representation
Table 21. Specific attributes
Attribute Name Description

Comment Target Object

Use an expression that resolves to the workitem where the comment should be added to the comment-stream

Comment User

Specify a the user in whos name the comment is created using an expression

Comment Template

Select the template for the comment

Categories

attribute not recognized

LoopType

not yet supported

6.18. Sequence Flow

A sequence flow is the connector between two elements of a process. After an element is visited during process execution, all outgoing sequence flow will be followed. This means that the default nature of BPMN 2.0 is to be parallel: two outgoing sequence flow will create two separate, parallel paths of execution.

A sequence flow can have a condition defined on it. When a BPMN 2.0 activity is left, the default behavior is to evaluate the conditions on the outgoing sequence flow. When a condition evaluates to true, that outgoing sequence flow is selected. When multiple sequence flow are selected that way, multiple executions will be generated and the process will be continued in a parallel way.

Note

The above holds for BPMN 2.0 activities (and events), but not for gateways. Gateways will handle sequence flow with conditions in specific ways, depending on the gateway type.

Currently conditionalExpressions can only be used with Backend Expressions, detailed info about these can be found in section Expressions. The expression used should resolve to a boolean value, otherwise an exception is thrown while evaluating the condition.

All BPMN 2.0 tasks and gateways can have a default sequence flow. This sequence flow is only selected as the outgoing sequence flow for that activity if and only if none of the other sequence flow could be selected. Conditions on a default sequence flow are always ignored.

sequenceFlow
Figure 24. Graphical Representation
Table 22. Specific attributes
Attribute Name Description

Condition Type

Specify the condition type of the message flow. standard an conditional flow behave the same, but are displayed differently. Use a backend expression in the Condidtion Expression Attribute to specify the condition. If you set the condition type to Default, this flow is executed when no other flow condition evaluates to true

Condition Expression

A backend expression that must evaluate to a boolean value

6.19. Exclusive Gateway

An exclusive gateway (also called the XOR gateway or more technical the exclusive data-based gateway), is used to model a decision in the process. When the execution arrives at this gateway, all outgoing sequence flow are evaluated in the order in which they are defined. The sequence flow which condition evaluates to true (or which doesn’t have a condition set, conceptually having a true defined on the sequence flow) is selected for continuing the process.

Note

Note that the semantics of outgoing sequence flow is different to that of the general case in BPMN 2.0. While in general all sequence flow which condition evaluates to true are selected to continue in a parallel way, only one sequence flow is selected when using the exclusive gateway. In case multiple sequence flow have a condition that evaluates to true, the first one defined in the XML (and only that one!) is selected for continuing the process. If no sequence flow can be selected, an exception will be thrown.

exclusiveGateway
Figure 25. Graphical Representation
Table 23. Specific attributes
Attribute Name Description

none

6.20. Inclusive gateway

The inclusive gateway can be seen as a combination of an exclusive and a parallel gateway. Like an exclusive gateway you can define conditions on outgoing sequence flows and the inclusive gateway will evaluate them. But the main difference is that the inclusive gateway can take more than one sequence flow, like the parallel gateway. The functionality of the inclusive gateway is based on the incoming and outgoing sequence flow:

  • fork: all outgoing sequence flow conditions are evaluated and for the sequence flow conditions that evaluate to true the flows are followed in parallel, creating one concurrent execution for each sequence flow.

  • join: all concurrent executions arriving at the inclusive gateway wait in the gateway until an execution has arrived for each of the incoming sequence flows that have a process token. This is an important difference with the parallel gateway. So in other words, the inclusive gateway will only wait for the incoming sequence flows that will be executed. After the join, the process continues past the joining inclusive gateway.

Note that an inclusive gateway can have both fork and join behavior, if there are multiple incoming and outgoing sequence flow for the same inclusive gateway. In that case, the gateway will first join all incoming sequence flows that have a process token, before splitting into multiple concurrent paths of executions for the outgoing sequence flows that have a condition that evaluates to true.

inclusiveGateway
Figure 26. Graphical Representation
Table 24. Specific attributes
Attribute Name Description

none

6.21. Parallel gateway

Gateways can also be used to model concurrency in a process. The most straightforward gateway to introduce concurrency in a process model, is the Parallel Gateway, which allows to fork into multiple paths of execution or join multiple incoming paths of execution. The functionality of the parallel gateway is based on the incoming and outgoing sequence flow:

  • fork: all outgoing sequence flow are followed in parallel, creating one concurrent execution for each sequence flow.

  • join: all concurrent executions arriving at the parallel gateway wait in the gateway until an execution has arrived for each of the incoming sequence flow. Then the process continues past the joining gateway.

Note that a parallel gateway can have both fork and join behavior, if there are multiple incoming and outgoing sequence flow for the same parallel gateway. In that case, the gateway will first join all incoming sequence flow, before splitting into multiple concurrent paths of executions.

Note

An important difference with other gateway types is that the parallel gateway does not evaluate conditions. If conditions are defined on the sequence flow connected with the parallel gateway, they are simply neglected.

parallelGateway
Figure 27. Graphical Representation
Table 25. Specific attributes
Attribute Name Description

none

6.22. Call activity (subprocess)

BPMN 2.0 makes a distinction between a regular subprocess, often also called embedded subprocess, and the call activity, which looks very similar. From a conceptual point of view, both will call a subprocess when process execution arrives at the activity.

The difference is that the call activity references a process that is external to the process definition, whereas the subprocess is embedded within the original process definition. The main use case for the call activity is to have a reusable process definition that can be called from multiple other process definitions.

When process execution arrives in the call activity, a new execution is created that is a sub-execution of the execution that arrives in the call activity. This sub-execution is then used to execute the subprocess, potentially creating parallel child execution as within a regular process. The super-execution waits until the subprocess is completely ended, and continues the original process afterwards.

callActivity
Figure 28. Graphical Representation
Table 26. Specific attributes
Attribute Name Description

Categories

attribute not recognized

SubProcessRef

Select the subprocess to be called within the call activity

LoopType

not yet supported

In

Map input data to be passed from the parent (current) process to the subprocess while starting the subprocess

Out

Map output data to be passed form the subprocess to the parent process after the subprocess has finished

6.23. Subprocess

BPMN 2.0 makes a distinction between a regular subprocess, often also called embedded subprocess, and the call activity, which looks very similar. From a conceptual point of view, both will call a subprocess when process execution arrives at the activity.

The difference is that the call activity references a process that is external to the process definition, whereas the subprocess is embedded within the original process definition. The main use case for the call activity is to have a reusable process definition that can be called from multiple other process definitions.

A subprocess is executed within the scope of the parent process.

subprocess
Figure 29. Graphical Representation
Table 27. Specific attributes
Attribute Name Description

Categories

attribute not recognized

LoopType

not yet supported

6.24. Text Annotation

The Text Annotation is for documentation purpose only, it’s not evaluated by the engine. Use it to add textual explanations to an element of the process model. In contrast to the Documentation property of an element, the text annotation is also visible on the graphical representation of the process model.

textAnnotation
Figure 30. Graphical Representation
Table 28. Specific attributes
Attribute Name Description

none

6.25. Association

An association is represented with a dotted line. It is used to associate an artifact or text to a flow object, and can indicate some directionality using an open arrowhead (toward the artifact to represent a result, from the artifact to represent an input, and both to indicate it is read and updated). No directionality is used when the artifact or text is associated with a sequence or message flow (as that flow already shows the direction).

Note

edoras one currently only supports undirected associations

association
Figure 31. Graphical Representation
Table 29. Specific attributes
Attribute Name Description

none

6.26. Pool

Represents the organizational boundaries of a process, typically separating different organisations. A pool contains one or more lanes (like a real swimming pool). One process has to be executed within a pool. If the end-to-end process includes multiple pools, each pool has it’s own process flow. Communication between pools is handled by Message Flows. The pool in edoras one represents the system boundaries of edoras one.

pool
Figure 32. Graphical Representation
Table 30. Specific attributes
Attribute Name Description

isExecutable

Indicates if this pool is executable.

6.27. Collapsed pool

A collapsed pool hides internal detail from the viewer. It’s used to visulaize communication between the mail pool and an external system / organization that is not in the scope of the current project. The collapsed pool has no impact at execution time.

collapsedPool
Figure 33. Graphical Representation
Table 31. Specific attributes
Attribute Name Attribute Type

Description

none

6.28. Lane

Used to organise and categorise activities within a pool according to function or role, and depicted as a rectangle stretching the width or height of the pool. A lane contains the flow objects, connecting objects and artifacts.

lane
Figure 34. Graphical Representation
Table 32. Specific attributes
Attribute Name Description

none

6.29. Message Flow

A Message Flow is represented with a dashed line, an open circle at the start, and an open arrowhead at the end. It tells us what messages flow across organizational boundaries (i.e., between pools). A message flow can never be used to connect activities or events within the same pool.

messageFlow
Figure 35. Graphical Representation
Table 33. Specific attributes
Attribute Name Description

none

6.30. Multi Instance

edoras one supports the creation of multiple instances of several BPMN 2.0 elements (Human Task, Call Activity, Embedded Subprocess and all Activities in the section Service Tasks of the edoras one palette). Multi-instancy is configured within the process model.

To specify multi-instancy select the correspondig type parallel or seqential.

If you chose parallel, all instances of the element are created at once, when the execution arrives at the activity. If you choose sequential, the next instance of the activity ist created, when the previous activity was completed.

Table 34. Multi-instance attributes
Attribute Name Description

Loop collection

A varialbe from the variable hierarchy that holds a list of elements. All elements of the list are processed, that means, the platform will generate one instance per list element

Loop element variable

a copy of the current list element. If you want to modify the variable, write the new value to the original list element since the loop element variable is not merged with the original one, once the execution is terminated.

Loop element index variable

The name of the variable where the current list index is stored.

Anzahl Schleifen

An expression that evaluates to an integer which determines the number of instances to be created if you do not use a list for iteration.

Beendigungsbedingung

A boolean expression do define a condition, to terminate the multi-instancy. As long as the expression evaluates to true, a new instance will be created.

7. Designer Usability hints

The designer provides various usability hints.

7.1. Alignment of shapes

Using Middle shape_align_middle and Center shape_align_center toolbar buttons we can align shapes horizontally or vertically.

Click the link to see demo.

7.2. Resizing of shapes to same size

Using Same size shape_align_size toolbar button we can resize all selected shapes to the same size.

Click the link to see demo.

7.3. Creating dockers and removing dockers

We can create and remove dockers in 2 ways:

  • By using Add Docker vector_add and Delete Docker vector_delete toolbar buttons

  • By using mouse pointer directly on connecting shapes.

Click the link to see demo.

7.4. Changing the position of shapes

Using Change the position of shapes shape_translate toolbar button we can move the shapes horizontally or vertically.

Click the link to see demo.

7.5. Transform shape

Using Transform shape feature we can transform a shape to another type belonging to same group.

Click the link to see demo.

7.6. Validating a process

Using Validate Process checker_syntax toolbar button we can find if there are any errors in the process.

Click the link to see demo.

7.7. Deleting of shapes

Using Delete all selected shapes cross toolbar button we can delete all selected shapes. We can also delete selected shapes using Del key.

Click the link to see demo.

7.8. Drop shape on connectors / remove shape from connector

When we drop a new shape on a connector which is already connecting 2 other shapes, the connector automatically splits to accomodate the new shape.

Similarly, if we delete a shape which is already connected to two other shapes, the connectors automatically rejoin.

Click the link to see demo.

7.9. Quick shape menu

We can quickly add and connect shapes to existing shapes using the quick shape menu.

Click the link to see demo.

7.10. Editing shape property in process/from designer

We can directly edit some of the shape properties like name in the process editor, and label, description and value in the form editor.

Click the link to see demo.

7.11. Using label expression in process designer

We can define a custom label expression for shapes, so that corresponding values are displayed as label on the shapes

Click the link to see demo.

7.12. Resizing of shapes using mouse

Using mouse pointer, we can resize the shapes.

Click the link to see demo.

8. Expressions

edoras one can evaluate expressions in both the frontend (i.e. in the browser) and in the backend (i.e. in the server). Expressions can be used in a number of ways in the edoras one application, for example:

  • to create a binding between a form field and work object data

  • to modify the state of form fields dynamically in response to user input (e.g. field visibility)

  • to populate a mail template before the mail is sent

  • to control the execution flow in a process execution

  • to execute method calls on the server

8.1. Frontend expressions

8.1.1. Form binding expressions

Forms are used to display and edit the data of underlying work objects. The work object data and the form definition are fetched from the server, and the expressions used within the form definition are then used to link the form fields with corresponding data. For editable fields, any changes made are reflected in the underlying work object data, which is sent back to the server to be persisted when the form is submitted:

formbinding

Form data binding expressions are placed between two sets of curly braces, e.g. {{expression}}, and are set using a form field’s Value attribute:

formeditor
Tip

The Value attribute of most form fields may only be bound to a single expression, and this may not be preceded or followed by other text.

The only exception to this rule is the output field, which doesn’t bind to a single value, but instead uses form expressions embedded within a rich text template to create dynamic textual output.

Simple variable bindings

A simple value name in double curly braces (e.g. {{value}}) is used to link to the corresponding variable in the current work object. If the work object variable doesn’t exist when the form is opened then it will be created automatically.

Bindings to other work objects

A work object in edoras one is typically part of a hierarchy, where work objects are linked together in a tree of parent/child relationships. For example a case typically serves as a container for other work objects (tasks, running processes, documents etc.). Form binding expressions can also be used to access the values from related work objects in the work object hierarchy. This is done be preceding the variable to be accessed by a qualifier (e.g. {{root.value}}):

The following qualifier keywords are currently supported:

parent

the parent of the current work item

root

the root of the current work item hierarchy

self

the current work item

$this

the current work item deprecated: use self instead

As an example, if we start a process within a case then the process’s parent work object will be the case. A form task created by that process will have the process work object as its parent:

hierarchybinding
Figure 36. Example work object hierarchy

In this case {{root.name}} will bind to "Example case", {{parent.name}} will bind to "Example process" and {{name}} will bind to "Example task".

8.1.2. Formatting dates in frontend expressions

When not being used to create a binding between a form field and a work item attribute (e.g. when used in the output form component), frontend expression that resolve into a date can have an additional format string that defines how the date is formatted. To do so append the format string to the binding expression, for example:

{{anyBoundDate | date:'MMM/dd/yyyy'}}
{{anyBoundDate | date:'dd-MM-yyyy'}}

If no format string is explicitly specified then yyyy-MM-dd is used.

The following tokens are allowed:

Token Description

yyyy

4 digit representation of year, e.g. 0001, 2010

yy

2 digit representation of year, padded (00-99), e.g. 01, 10

MMMM

month name long (always in English): January-December

MMM

month name short (always in English): Jan-Dec

MM

month of year (two digit): 01-12

M

month of year (no leading zero): 1-12

dd

day of month (two digit): 01-31

d

day of month (no leading zero): 1-31

EEEE

day name long (always in English): Sunday-Saturday

EEE

day name short (always in English): Sun-Sat

The format string can contain literal values which need to be quoted with single quotes. Make sure that you escape the single quotes that denote a literal value. In order to output a single quote, use two single quotes in a sequence:

{{anyBoundDate | date: '\'day\' d \'of\' MMMM \'in the year\' yyyy'}}
{{anyBoundDate | date: '\'Today it\'\'s\' dd/MM/yyyy'}}

8.1.3. More complex frontend expressions

When not being used to create a binding between a form field and a work object attribute (e.g. when used as Visible (RT) form component attribute), frontend expressions can also be combined using binary operators and parentheses, for example:

{{foo}} && {{bar}}
!{{foo}}
(!{{foo}} || {{bar}}) && {{foobar}}

8.2. Backend Expressions

Expressions can also be executed on the server, for example within the process models. Server-side expressions are called backend expressions. A much wider range of expressions is possible than in frontend expressions the expressions may also have side-effects within the system (for example causing an e-mail to be sent). As well as accessing data from the work object hierarchy, backend expressions support additional functionality such as accessing work objects outside of the immediate hierarchy, predefined function calls and bean method calls.

There are two basic expression types:

value expressions

have the form #{value.property} and resolve to a value

method expressions

have the form #{bean.method(value)} and result in a method invocation

Tip
The full backend expression language is part of the EE6 specification and only an brief overview will be provided here. For a full description of the expression language syntax please refer to the EE6 specification.

8.2.1. Accessing work objects

As in the frontend, qualifiers can be used to traverse the work object hierarchy, although there are more options available in backend expressions. qualifiers can also be chained (e.g. #{process.parent.name}):

The following qualifier keywords are currently supported:

self

the current work item (the default if no work object is explicitly specified)

case

the case to which the current work object belongs

parentCase

the nearest parent case to which the current work object belongs

process

the top-most parent process to which the current work object belongs

parentProcess

the nearest parent process to which the current work object belongs

root

the root of the current work object hierarchy

parent

the direct parent of the current work object

8.2.2. Backend attribute values

Simple attribute names can be used to access work object attributes in backend expressions in the same way as in frontend expressions (see Frontend expressions).

To access attributes, simply use the attribute name: #{case.name}

Tip

One significant difference between frontend expressions and backend expressions is that the work object attributes accessible in the frontend may have been pre-processed by the server so that the attribute values are in a form that makes more sense in the client’s context. With backend expressions this processing is not performed so you will be working with raw work attributes.

As an example, state is represented in a work object by an instance of the State class. In the frontend , the expression {{state}} will be bound to the name field of this object (e.g. "ACTIVE"). The conversion from a State object to the state name string has already been performed by the server.

The corresponding process binding, {state} resolves to the underlying State object, which if it is used in a string context will be converted to a string literal, e.g. "[State@51d838d9 name = 'ACTIVE']". To access the plain name ("ACTIVE") we can use a java bean property expression: {state.name}.

For a description of common work object attributes, refer to Common attributes.

8.2.3. Automatic work object ID conversion

Work objects are referenced using IDs, and in a backend expressions it is often useful to access not the ID itself but the referenced work object. To support this use case, an expression that resolves to a work object ID will automatically be converted to the corresponding work object instance as needed.

For example the expression {ownerid} will resolve to the owner ID, but if we then extend the expression (e.g. {ownerId.name} then the ID will be converted to the corresponding work object, and the name attribute from this work object will be returned.

As access to other work objects linked from a work object using IDs is so common there are also some shortcut expressions to access this information directly:

Table 35. Predefined work object expressions
Expression Type Description

{{owner}}

User work object

the work object’s owner

{{assignee}}

User work object

the work object’s assignee

{{initialassignee}}

User work object

the work object’s initial assignee

{{previousassignee}}

User work object

the work object’s previous assignee

{{candidateusers}}

List of user work object

the work object’s candidate user list

8.2.4. Resolving hierarchy variables

A major difference between frontend expressions and backend expressions is the visibility of work object variables within the work object hierarchy. With frontend expressions, accessing parent or root variables requires explicit use of the appropriate qualifier (e.g. parent.attribute).

With backend expressions, however, this is not always required. In the server, variables from parent work objects in the hierarchy are also visible in the child work objects. If a parent and child both have variables with the same name then only the child variable will be visible in the child work object.

For example, take the following work object hierarchy:

variablehierarchy

If we are resolving variables in the task context, then the expression #{case.message} will resolve to "Case message".

The expression #{process.message} will also resolve to "Case message" the process work object will inherit the message value from its parent (the case).

The expression #{message} will resolve to "Task message", however, as the variable inherited from the case has been hidden by a more local value.

8.2.5. Bean resolution

Backend expressions can also be used to access java beans, either to make method calls ({beanName.method()}) or to access bean properties ({beanName.property}).

For security reasons it is obviously not a good idea to allow access to all beans within the server, and so edoras one only allows access to a specific set of approved bean names.

8.2.6. Predefined functions

Backend expressions also support a number of predefined functions. As with bean resolution, the functions provided by a given edoras one installation can be configured, so the list of available functions may vary from system to system.

The following functions are provided by default:

now()

returns the current date and time

formatDate(Date date, String pattern)

returns the provided date formatted according to the provided pattern

formatType(Type type, boolean lowerCase)

returns the provided type formatted as a String

anyOf(Boolean… operands)

returns true if any of the provided booleans is true, false otherwise

allOf(Boolean… operands)

returns true if all of the provided operands are true, false otherwise

concatenateListWithList(List<T> base, List<T> toAppend)

returns a list that is the concatenation of the given two lists

concatenateListWithElements(List<T> base, T… toAppend)

returns a list that is the concatenation of the given lists and the given elements

extractValuesFromCollectionOfMaps(Collection<Map<String, T>> maps, String mapKey, boolean skipNullValues)

returns a collection of map values for the given key from the given collection of maps

8.3. Common attributes

8.3.1. Work object attributes

A number of predefined attributes are available on every work object:

Table 36. Predefined work object attributes
Expression Type Description

name

String

the work object’s name

description

String

the work object’s description

state

String

the work object’s state

type

String

the work object’s type

ownerId

User ID

the work object’s owner

assigneeId

User ID

the work object’s assignee

candidateGroupIds

List of group IDs

the work object’s candidate groups

creationTime

Date

the work object’s creation time

updateTime

Date

the work object’s last update time

dueTime

Date

the work object’s last due time

8.3.2. User attributes

The following attributes are defined in user work objects:

Table 37. Predefined user attributes
Expression Type Description

userLogin

String

the user’s login name

name

String

the user’s display name (full name)

userFirstName

String

the user’s first name

userName

String

the user’s surname

userAddress

String

the user’s address

userPhone

String

the user’s telephone number

userMobile

String

the user’s mobile telephone number

userEmail

String

the user’s email address

language

String

the user’s language

9. Localization

TODO complete this section

10. Glossary

app

an app is a container for a collection of models that define a specific workflow.

backend expression

a backend expression will be evaluated in the server, for example to populate a mail template before it is sent.

dashboard

a page in the edoras one application where work objects can be found, displayed and manipulated. Each dashboard manages related work object types that play a given role within the system.

definition

when a model is deployed, a definition is created in the system. Definitions describe the behaviour of the system as seen by a normal user.

deployment

the process of converting the models into definitions to create an executable workflow.

document placeholder

a backend expression identified by a key in a document model. Used to insert dynamic content into documents.

expression

an expression can be used to access content or trigger specific behaviour at runtime. Two types of expressions are used: frontend expressions and backend expressions.

form

a form is a graphical layout of fields that may be bound to work object data to allow this data to be displayed or modified within the edoras one application.

form component

a form component is a type of form field, e.g. text form component, date form component, number form component. The form field represents the single element on the form whereas the form component represents the type of these single elements. As such the form component defines the look and behaviour of the corresponding form fields.

form field

a form field is a single element on a form. The user interacts with the form field, most of them are interactive but some of them are read-only.

form field part

a form field is composed of different graphical parts: a label, a control, a description, a required indicator. The user interacts with the control part only.

frontend expression

a frontend expression will be evaluated in the browser, for example to bind form fields to work object data.

model

a description of a workflow component which can be deployed together with other models to create a executable workflow in edoras one

process

a process is a workflow definition, described using a BPMN 2.0 model and executed within edoras one. It typically defines the automated and manual tasks that must be performed to complete the workflow.

system app

a special App that can only be seen by the administrator. It contains the models that are required for the correct operation of edoras one.

task

a task is a single action within a workflow, and may be either automated (a service task) or manual (a user task).

work object

an item that can be created or manipulated in edoras one. Different types of work object are supported. The work object types are typically grouped according to their role within the system and accessed through dashboards.