Conventions used in this book

This section covers the conventions used in this book.

Typographic Conventions

Constant width

Used to indicate source code, e.g. Java or IvyScript class names, properties or methods.


Used to

  • introduce terms

  • for URLs

  • for email addresses

  • for filenames and directory paths

  • define the navigation within Axon.ivy application menus

  • for referencing GUI elements (e.g. Open the Code tab for editing the properties).


Used to highlight important terms in a text.

{replacable text}

Names or parts of strings that are dependent on the user environment, are marked with brackets. See the following example:

Navigate to {Designer Install Directory}/configuration/demo.lic



The note designates a note relating to the surrounding text.


The tip designates a helpful tip relating to the surrounding text.


The warning designates a warning relating to the surrounding text.


A screen is used to show keybord input. e.g. script samples




This chapter provides a linked reference of the Axon.ivy application parts.


See also the Perspectives section in the Introduction chapter.

  • Process Model Perspective

  • Process Development Perspective

  • Rich Dialog Perspective


See IvyScript section for more information


This chapter provides an alphabetized glossary for specialized expressions and terms that are employed in this book.


On the Axon.ivy Engine one or more Applications can exist. The Application defines the container wherein the Process Models can be deployed.

Also Users and Roles are defined and Tasks and Cases are stored in an Application.

See also section Application in chapter Deployment.


A Case is one concrete instance of a Process. It must not necessarily run through all Steps of a Process. A Process may define a different handling for different Cases depending on the information of a Case. For example by using the Alternative Element .

A Case holds the information used to carry out the Process. This is on the one hand information about the Case like the current position in the Process. On the other hand this is information collected during the Case, which is passed from one Step to the next in the form of the Process Data


A Connector connects two Steps of a Process. This defines the sequence of these two steps.

Form Field

A Form Field is a JSF code snippet which serves content for a specific data class field type (e.g. a Label and a Datepicker for a Date). The New User Dialog Wizard create forms with Form Fields.

Html Dialog

A Html Dialog is an implementation of a User Dialog. The Html Dialog is implemented with (HTML/JSF).


A Layout contains the main structure of a Html page (e.g. a header, content and footer section). For Web Pages the layouts are defined in the CMS. For Html Dialogs the layouts are defined in the webContent folder.


A Process is an abstract description how a group of Cases will be handled. It consists of Process Elements connected with each other. Every time a Process is started, a Case and a Task is created.

Process Data

The Process Data is the data passed from one Step to the next. Its represented by a data class used for the whole process. Even though every Step can create a new instance of this data class to be passed to the next Step it will always be an instance of the same data class.

Process Element

Process Elements are the bricks a process is built of. Ordered with Connectors they become the Steps of a Process.

There are 3 groups of process elements.

  • Activities do something. Like running a script or let somebody else do something for example by showing a User Dialog.

  • Gateways structure a Process. For example a Alternative decides which way a Case runs through the Process.

  • Events are notifications of things that happen outside the process.

The chapter Process Elements describes all the Process Elements available in Axon.ivy

Process Model

A Process Model on the Engine corresponds to an Axon.ivy project on the Designer. The difference is that a Process Model may hold multiple different versions of the same Axon.ivy project. These are called Process Model Version.

See also section Process Model in chapter Deployment.

Process Model Version

A Process Model can have multiple versions called Process Model Versions. These versions allow to change an Axon.ivy project without worrying about the compatibility of currently running Cases on the Engine.

See also section Process Model Version in chapter Deployment.

Rich Dialog

A Rich Dialog is an implementation of a User Dialog. The Html Dialog is implemented with (Java/ULC).


A User has one or multiple Roles which define what the user is allowed to do.


In computer programming, especially object-oriented programming, a method is commonly identified by its unique method signature. This usually includes the method name, and the number, types and order of its parameters, but usually excludes the return type(s) of the method.

Within Axon.ivy, signatures act as unique identifiers for specific start elements (e.g. method starts, request starts, trigger starts, call sub starts), within the same process, only one element with the same signature may exist. The same holds true for signatures of start methods and events on a User/Rich Dialog interface.


A Process Element placed in a Process becomes a Step of this Process. The Connectors define the order of the Steps in a Process.


A Task is a unit of work which is indivisible. It has to be carried out by one user in one piece. If anything goes wrong during the execution of a task, we must return to the beginning of the task.

It's not possible to work on a Case without a Task. Every time a new Case is started a Task will be created. While working on a Case / Task new Tasks can be created. This allows to interrupt the work on a Case and to hand it over to another user if necessary.

A Task consists of one or multiple Steps. It begins for example with a Request Start or a Task Switch Element. And ends for example with the next Task Switch Element or at the Process End.

Task can be assigned to a specific User, a Role or to Everybody.


A User is a person interacting with a Case. The user is identified by a unique user name.

If a User is not identified, we speak of an anonymous User.

User Dialog

A User Dialog is a concept of an User Interface. User Dialogs can be implemented as Html Dialog (HTML/JSF) or as Rich Dialog (Java/ULC).

View Type

A View Type defines the default content of a User Dialog View. Axon.ivy has predefined View Types, i.e. Page and Component.