Process Modeling

Axon.ivy Project Tree -> double click on the Deployment node inside the project tree ()

Refreshes the complete graph. Manually moved nodes will be re-arranged by the auto layout algorithm.

Selects the zoom level of the view.

Selects the layout algorithm that arranges the nodes and dependency edges in the view.

Automatically opens the Project Graph whenever a Library Descriptor Editor is opened.

Figure 2.24. Process Data selection with auto data Mapping

Callable Sub Processes often consume or return data from a high level process. The data which is passed to and given back to the caller process can be easily mapped within this page.

To open the editor menu right click anywhere on the editor area's canvas (i.e. background). The following actions are available:

To open the element menu right click on an process element. The following actions are available:

The visibility of the following menu entries are depending on the type of the process element:

To open the arrow menu right click on a an arrow. The following actions are available:

To open the selection menu right click on a selected element or a group of selected elements (i.e. selection frame is visible). The following actions are available:

Some of the entries in the context menus are available with shortcut keys. To use them, place the mouse over a process element and press the according key.

The following table shows all supported references between Axon.ivy project artifacts.

This dialog allows to edit the content language and the formatting language. The language settings are used at design time for displaying the Rich Dialogs in the Rich Dialog Editor. If option Use settings while simulating is checked the settings are also used while simulating.

Figure 2.37. Content and Formatting Language Settings Dialog

Press in the toolbar.

The following language settings can be configured:

To get or set the content or formatting language in IvyScript use ivy.session.contentLocale respectively ivy.session.formattingLocale.

Find out more about Axon.ivy's scripting language here.

A process element breakpoint is a breakpoint that can be set on a process element. The execution of the process will be interrupted before the process element is executed.

Add / Remove a breakpoint

You can add process element breakpoints in a Process editor or User Dialog Logic editor window by using the popup menu. Right-click on the process step on which you intend to set the breakpoint and go to the Breakpoint sub-menu.

Adding a conditional breakpoint allows you to define an expression in a input box which must evaluate to true in order to suspend the execution. In the expression you have access to the in variable and all other variables in the context of the process step. As you can see in the figure above, process element breakpoints are visualized in the Process editor as a small filled dot at the border of the process step .

A data class attribute value change breakpoint is a breakpoint that can be set on a data class attribute. The execution of the process will be interrupted before the value of the process data attribute is changed. Data class attribute value change breakpoints can be added or removed in the Data Class Editor or the Entity Class Editor. The current available variables and the current debug context is available in the Variables View. The old and new value of the debugging field is displayed in the variable debug.

This section explains the Runtime Log view, and how it works.

The Runtime Log view displays a list of events. This events occur during the simulation. When you start the Axon.ivy process engine, this log view is opened by default and all entries are cleared.

Figure 2.44. Runtime Log View: List of logged Events

Window > Show View > Runtime Log

Window > Show View > Other ... > Other... > Axon.ivy > Runtime Log

The following columns are displayed in the Runtime Log view:

When you double click on a log entry, a detail window will appear.

Figure 2.45. Runtime Log View Event Details

The following fields are displayed in this window:

On the right hand side the following buttons are located:

This chapter describes how you can log to the runtime log.

Open any process elements that contain IvyScript (like: Step, Web Service, etc.) and type a script like the one you find in the figure below:

Figure 2.46. IvyScript to log into Runtime Log

Find out more about Axon.ivy scripting language here.

The Process Performance View displays process performance statistics. This allows to analyse the performance and to detect long running and performance intensive process elements and processes. The view contains detailed information of each executed process element.

Figure 2.47. The Process Performance View

A case map is divided into stages. Each stage defines a certain phase in the life of a business process. A stage is a container for multiples processes that belong to each other in a logical order. Within a stage the processes are executed from top to bottom. If the last process of a stage has finished the execution continues on the stage to the right. Besides processes a stage can also contain Sidesteps, that are valid in the current stage. The actual stage of a Business Case is also displayed in the Workflow UI with it's name and icon.

A business process can programmatically switch to another stage by using the case map API (ivy.casemap).

The position of a Stage in a case map can be changed via the menu on the stage.

Figure 2.50. Case Map Element: Stage

A process in the Case Map references to a process start of an Axon.ivy process. If the business process enters a stage, the first process, which entry condition evaluates to true, will be started.

Processes and Sidesteps can be rearranged around by drag and drop.

Figure 2.51. Case Map Element: Process

Process Precondition

Preconditions can be set on a process and define whether a process should be skipped. The precondition on the first process in the case map is not evaluated. If a precondition is not met, the execution continues on the next process. For script features see “Case Map scripting”

Figure 2.52. Precondition symbol

Sidesteps are optionally executable processes. Sidesteps like processes belong to a stage. They can be started at any time manually during the ongoing business process. A typical Sidestep could be a process which is used to involve a supervisor to ask for clarification.

Sidestep Precondition

Decides whether that Sidestep can be currently started or not. For script features see “Case Map scripting”

Figure 2.53. Sidestep Precondition symbol

Within Case Map scripts the running Business Case is always accessible trough the variable businessCase.

Any class that is annotated with @BusinessCaseData is accessible by its simple name (e.g. if the full-qualified name of the class is com.axonivy.CreditDossier the simple name is: creditDossier). The variable value will be loaded from the Business Data Repository.

Figure 2.54. Sample DataClass with @BusinessCaseData annotation

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

The start tab defines the name and the parameters to start the process. The signature is a definition of the name with the parameter types and its order. Elements like Call Sub or Trigger referenced to this signature.

This tab contains the configuration for the HTTP-Request start. Name and description which is displayed on the start list. The required permissions to start the process, and the workflow mode.

This tab holds definitions for starting this workflow with a Trigger Element.

This tab defines information relevant to the task. Only tasks created with the Trigger Element (see Trigger Tab) will appear in the task list as suspended tasks. Tasks started with a HTTP request (see Request Tab) normally do not appear in the task list.

On this tab you can configure the Case created by this Start Request. See “Case Tab” in the Task Switch Gateway element.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

On this tab you define the Java class to execute.

Figure 2.63. The Start tab

This tab displays the editor, that can be integrated in the external Java bean of the process element. The editor is implemented as an inner public static class of the Java bean class and must have the name Editor. Additionally the editor class must implement the IProcessExtensionConfigurationEditorEx interface. The common way to implement the editor class is to extend the abstract base class AbstractProcessExtensionConfigurationEditor and to override the methods createEditorPanelContent, loadUiDataFromConfiguration and saveUiDataToConfiguration. The method createEditorPanelContent can be used to build the UI components of the editor. You can add any AWT/Swing component to the given editorPanel parameter. With the given editorEnvironment parameter, which is of the type IProcessExtensionConfigurationEditorEnvironment, you can create text fields that support ivyScript and has smart buttons which provide access to the process data, environment functions and Java classes.

Here is an example of such an editor:

As you can see, the editor provides you access to any process relevant data, which can be used by your own process elements. For instance, you can easily transfer process data to your legacy system.

The following part shows the implementation of the editor shown above. As mentioned above Axon.ivy provides the IIvyScriptEditor which represents a text field with ivyScript support and smart buttons. Inside createEditorPanelContent use the method createIvyScriptEditor from the editorEnvironment parameter to create an instance of such an editor. Use the loadUiDataFromConfiguration method to read the bean configuration and set them to the UI components. Inside this method you can use the methods getBeanConfiguration or getBeanConfigurationProperty to read the bean configuration. Use the method saveUiDataToConfiguration to save the data in the UI components to the bean configuration. Inside this method you can use the methods setBeanConfiguration or setBeanConfigurationProperty to save the bean configuration.

  public static class Editor extends AbstractProcessExtensionConfigurationEditor
  {
    private IIvyScriptEditor editorUser;
    private IIvyScriptEditor editorEventTyp;
    private IIvyScriptEditor editorLinkId;
    private IIvyScriptEditor editorFieldValue;
    
    @Override
    protected void createEditorPanelContent(Container editorPanel,
            IProcessExtensionConfigurationEditorEnvironment editorEnvironment)
    {
      editorPanel.setLayout(new GridLayout(4,2));
      editorUser = editorEnvironment.createIvyScriptEditor(null,null, "String");
      editorEventTyp = editorEnvironment.createIvyScriptEditor(null,null, "String");
      editorLinkId = editorEnvironment.createIvyScriptEditor(null, null, "String");
      editorFieldValue = editorEnvironment.createIvyScriptEditor(null, null);
      
      editorPanel.add(new JLabel("User"));
      editorPanel.add(editorUser.getComponent());
      editorPanel.add(new JLabel("Event Typ"));
      editorPanel.add(editorEventTyp.getComponent());
      editorPanel.add(new JLabel("Link-Id"));
      editorPanel.add(editorLinkId.getComponent());
      editorPanel.add(new JLabel("Feldwert"));
      editorPanel.add(editorFieldValue.getComponent());        
    }

    @Override
    protected void loadUiDataFromConfiguration()
    {
      editorUser.setText(getBeanConfigurationProperty("User"));
      editorEventTyp.setText(getBeanConfigurationProperty("EventTyp"));
      editorLinkId.setText(getBeanConfigurationProperty("LinkId"));
      editorFieldValue.setText(getBeanConfigurationProperty("Feldwert"));
    }

    @Override
    protected boolean saveUiDataToConfiguration()
    {
      setBeanConfigurationProperty("User", editorUser.getText());
      setBeanConfigurationProperty("EventTyp", editorEventTyp.getText());
      setBeanConfigurationProperty("LinkId", editorLinkId.getText());
      setBeanConfigurationProperty("Feldwert", editorFieldValue.getText());
      return true;
    }
  }    

At runtime you have to evaluate the IvyScript the user have entered into the ivy script editors. If you implement for example the AbstractUserProcessExtension class there is a perform method which is executed at runtime. At this point you want to access the configured data in the editor. The following code snippet show how you can evaluate the value of an IIvyScriptEditor. If you use the IIvyScriptEditor you only get the value by calling the executeIvyScript method of the AbstractUserProcessExtension.

  public CompositeObject perform(IRequestId requestId, CompositeObject in,
     IIvyScriptContext context) throws Exception
  {
    IIvyScriptContext ownContext;
    CompositeObject out;
    out = in.clone();
    ownContext = createOwnContext(context);

    String eventtyp = "";
    String linkId = "";
    String fieldValue = "";
    String user= "";

    user = (String)executeIvyScript(ownContext, getConfigurationProperty("User"));
    eventtyp = (String)executeIvyScript(ownContext, getConfigurationProperty("Event Typ"));
    linkId = (String)executeIvyScript(ownContext, getConfigurationProperty("Link-Id"));
    fieldValue = (String)executeIvyScript(ownContext, getConfigurationProperty("Feldwert"));
    
    // add your call here
    
    return out;
  }           

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

On this tab you can configure the Error Code that the Boundary Event will catch.

On this tab you can configure the output of the element (i.e. the data that leaves the element). See Output Tab for a more detailed description.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

On this tab you can configure the Error Code that the Error Start Event will catch.

On this tab you can configure the output of the element (i.e. the data that leaves the element). See Output Tab for a more detailed description.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

On this tab you configure the pattern that the Boundary Event will listen to.

On this tab you can configure the output of the element (i.e. the data that leaves the element). See Output Tab for a more detailed description.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

On this tab you configure the Signal Code that the Signal Start Event will listen to.

On this tab you can configure the output of the element (i.e. the data that leaves the element). See Output Tab for a more detailed description.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

On this tab you can configure the output of the element (i.e. the data that leaves the element). See Output Tab for a more detailed description.

On this tab you can execute any IvyScript, e.g. define output data of this element. See code tab for a more detailed description.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

On this tab you can configure the output of the element (i.e. the data that leaves the element). See Output Tab for a more detailed description.

On this tab you can execute any IvyScript, e.g. define output data of this element. See Code Tab for a more detailed description.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

On this tab you can configure the output of the element (i.e. the data that leaves the element). See Output Tab for a more detailed description.

This tab defines the parameters for the tasks created by the Task Switch.

Defines the name, the description and category of the task that appear in the task list of the addressed role or user.

Custom fields Tab

This Tab allows to set additional information for the task created. The values set on this tab are only informational and have no effect on how this task is treated by Axon.ivy.

Every time a process is started a case is created. This tab allows you to define additional information for the cases. The information defined on this tab has no effect how Axon.ivy treats the cases. But they can be accessed through the Public API, which allows you to use them for example to filter the task list.

You can define the name, the description and the catgegory for the corresponding case.

Figure 2.65. Custom Fields Tab

Custom Fields Tab

Here you can set the values for at most 5 user defined fields for each of the three data types String, Number and DateTime. You can reuse these fields in IvyScript over its API.

Business Information Tab

Warning

This feature is deprecated. This tab only appears if you activate it in Deprecation Preferences or if there are already values inscribed on this tab. Instead use Business Data to define custom fields, which are searchable.

On this tab it is possible to edit further information about the process such as contact and business data.

Figure 2.66. Business Information Tab

Main Contact

Here you can set the information about the company your process deals with.

Correspondent Contact

Here you can set the information about the contact person in the company your process deals with.

Business Object

Here you can set the information about the business object your process deals with.

Other

You can set here additional information about time constraint and further things.

Business calendar

You can set the name of the business calendar that should be used for this case. In the context of this case ivy.cal will return this business calendar instead of the default business calendar. It is also possible to set a business calendar for a task.

For more information about business calendar administration see the engine guide.

For more information about business calendar usage see the Public API of ch.ivyteam.ivy.application.calendar.IDefaultBusinessCalendar.

Tags Tab (Deprecated)

Warning

This feature is deprecated. This tab only appears if you activate it in Deprecation Preferences or if there are already values inscribed on this tab. Instead use the category field to categorize your cases.

Here you can structure processes in more depth and categorize them into a user-defined hierarchy. These categorization attributes may be accessed later over an API to filter and structure the task overview of users. The structure always consists of 4 levels, the process category, the process, the process type and process sub type, e.g. myProcessCategory/myProcess/myProcessType/myProcessSubtype.

Tip

Create your specific hierarchy in the CMS so you can ensure its consistent use.

Figure 2.67. Tags Tab

Process Category

Sets the category code and name of the category this process belongs to.

Process

Sets the process code and name.

Type

Sets the process type code and name.

Sub Type

Sets the sub type code and name of this process.

Note

The code is always used for internal reference (caching, searching, sorting and the like) and never shown to the actual user. Therefore, the codes should be unique within its level. The name on the other side is human-readable and always shown to the user when the element is referenced.

This Tab defines the page, which will be displayed in the web browser for each task which ends at this Task Switch Element.

If no page is defined the task list will be shown.

If no task is created because skip task list is enabled (see Task Tab) the case will continue without displaying a page or the task list.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

On this tab you define the Java class that the IntermediateEvent should instantiate, the identifier of the event to wait for and the timeout behaviour.

This tab displays the editor, that can be integrated in the external Java bean of the process element. The editor is implemented as an inner public static class of the Java bean class and must have the name Editor. Additionally the editor class must implement the IProcessExtensionConfigurationEditorEx interface. The common way to implement the editor class is to extend the abstract base class AbstractProcessExtensionConfigurationEditor and to override the methods createEditorPanelContent, loadUiDataFromConfiguration and saveUiDataToConfiguration. The method createEditorPanelContent can be used to build the UI components of the editor. You can add any AWT/Swing component to the given editorPanel parameter. With the given editorEnvironment parameter, which is of the type IProcessExtensionConfigurationEditorEnvironment, you can create text fields that support ivyScript and has smart buttons which provide access to the process data, environment functions and Java classes.

Here is an example of such an editor:

As you can see, the editor provides you access to any process relevant data, which can be used by your own process elements. For instance, you can easily transfer process data to your legacy system.

The following part shows the implementation of the editor shown above. As mentioned above Axon.ivy provides the IIvyScriptEditor which represents a text field with ivyScript support and smart buttons. Inside createEditorPanelContent use the method createIvyScriptEditor from the editorEnvironment parameter to create an instance of such an editor. Use the loadUiDataFromConfiguration method to read the bean configuration and set them to the UI components. Inside this method you can use the methods getBeanConfiguration or getBeanConfigurationProperty to read the bean configuration. Use the method saveUiDataToConfiguration to save the data in the UI components to the bean configuration. Inside this method you can use the methods setBeanConfiguration or setBeanConfigurationProperty to save the bean configuration.

  public static class Editor extends AbstractProcessExtensionConfigurationEditor
  {
    private IIvyScriptEditor editorUser;
    private IIvyScriptEditor editorEventTyp;
    private IIvyScriptEditor editorLinkId;
    private IIvyScriptEditor editorFieldValue;
    
    @Override
    protected void createEditorPanelContent(Container editorPanel,
            IProcessExtensionConfigurationEditorEnvironment editorEnvironment)
    {
      editorPanel.setLayout(new GridLayout(4,2));
      editorUser = editorEnvironment.createIvyScriptEditor(null,null, "String");
      editorEventTyp = editorEnvironment.createIvyScriptEditor(null,null, "String");
      editorLinkId = editorEnvironment.createIvyScriptEditor(null, null, "String");
      editorFieldValue = editorEnvironment.createIvyScriptEditor(null, null);
      
      editorPanel.add(new JLabel("User"));
      editorPanel.add(editorUser.getComponent());
      editorPanel.add(new JLabel("Event Typ"));
      editorPanel.add(editorEventTyp.getComponent());
      editorPanel.add(new JLabel("Link-Id"));
      editorPanel.add(editorLinkId.getComponent());
      editorPanel.add(new JLabel("Feldwert"));
      editorPanel.add(editorFieldValue.getComponent());        
    }

    @Override
    protected void loadUiDataFromConfiguration()
    {
      editorUser.setText(getBeanConfigurationProperty("User"));
      editorEventTyp.setText(getBeanConfigurationProperty("EventTyp"));
      editorLinkId.setText(getBeanConfigurationProperty("LinkId"));
      editorFieldValue.setText(getBeanConfigurationProperty("Feldwert"));
    }

    @Override
    protected boolean saveUiDataToConfiguration()
    {
      setBeanConfigurationProperty("User", editorUser.getText());
      setBeanConfigurationProperty("EventTyp", editorEventTyp.getText());
      setBeanConfigurationProperty("LinkId", editorLinkId.getText());
      setBeanConfigurationProperty("Feldwert", editorFieldValue.getText());
      return true;
    }
  }    

At runtime you have to evaluate the IvyScript the user have entered into the ivy script editors. If you implement for example the AbstractUserProcessExtension class there is a perform method which is executed at runtime. At this point you want to access the configured data in the editor. The following code snippet show how you can evaluate the value of an IIvyScriptEditor. If you use the IIvyScriptEditor you only get the value by calling the executeIvyScript method of the AbstractUserProcessExtension.

  public CompositeObject perform(IRequestId requestId, CompositeObject in,
     IIvyScriptContext context) throws Exception
  {
    IIvyScriptContext ownContext;
    CompositeObject out;
    out = in.clone();
    ownContext = createOwnContext(context);

    String eventtyp = "";
    String linkId = "";
    String fieldValue = "";
    String user= "";

    user = (String)executeIvyScript(ownContext, getConfigurationProperty("User"));
    eventtyp = (String)executeIvyScript(ownContext, getConfigurationProperty("Event Typ"));
    linkId = (String)executeIvyScript(ownContext, getConfigurationProperty("Link-Id"));
    fieldValue = (String)executeIvyScript(ownContext, getConfigurationProperty("Feldwert"));
    
    // add your call here
    
    return out;
  }           

On this tab you configure the parameters of the awaited event which is handled as an Intermediate Event Task. The Business milestone usually sets the current DateTime for process activity analysis and reports.

You can set the name of the business calendar that should be used for the task. In the context of the task ivy.cal will return this business calendar regardless of what you've set for the case.

For more information about business calendar administration see the engine guide.

For more information about business calendar usage see the Public API of ch.ivyteam.ivy.application.calendar.IDefaultBusinessCalendar.

On this tab you can configure the output of the element (i.e. the data that leaves the element). You can use the variable result that holds additional information about the event received by the Java class.

See Output Tab for a more detailed description.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

On this tab you set the Java class which implements the interface IUserAsynchronousProcessExtension and defines a public static inner class called IntermediateEvent that implements the interface IProcessIntermediateEventBean. This class is called when the Call & Wait step is executed. Furthermore, you can define exception handlers to react on errors such as not reachable systems, insufficient privileges and many more.

Figure 2.68. The Call tab

On this tab you define the timeout behaviour during the Wait part of the element.

Figure 2.69. The Wait tab

This tab displays the editor, that can be integrated in the external Java bean of the process element. The editor is implemented as an inner public static class of the Java bean class and must have the name Editor. Additionally the editor class must implement the IProcessExtensionConfigurationEditorEx interface. The common way to implement the editor class is to extend the abstract base class AbstractProcessExtensionConfigurationEditor and to override the methods createEditorPanelContent, loadUiDataFromConfiguration and saveUiDataToConfiguration. The method createEditorPanelContent can be used to build the UI components of the editor. You can add any AWT/Swing component to the given editorPanel parameter. With the given editorEnvironment parameter, which is of the type IProcessExtensionConfigurationEditorEnvironment, you can create text fields that support ivyScript and has smart buttons which provide access to the process data, environment functions and Java classes.

Here is an example of such an editor:

As you can see, the editor provides you access to any process relevant data, which can be used by your own process elements. For instance, you can easily transfer process data to your legacy system.

The following part shows the implementation of the editor shown above. As mentioned above Axon.ivy provides the IIvyScriptEditor which represents a text field with ivyScript support and smart buttons. Inside createEditorPanelContent use the method createIvyScriptEditor from the editorEnvironment parameter to create an instance of such an editor. Use the loadUiDataFromConfiguration method to read the bean configuration and set them to the UI components. Inside this method you can use the methods getBeanConfiguration or getBeanConfigurationProperty to read the bean configuration. Use the method saveUiDataToConfiguration to save the data in the UI components to the bean configuration. Inside this method you can use the methods setBeanConfiguration or setBeanConfigurationProperty to save the bean configuration.

  public static class Editor extends AbstractProcessExtensionConfigurationEditor
  {
    private IIvyScriptEditor editorUser;
    private IIvyScriptEditor editorEventTyp;
    private IIvyScriptEditor editorLinkId;
    private IIvyScriptEditor editorFieldValue;
    
    @Override
    protected void createEditorPanelContent(Container editorPanel,
            IProcessExtensionConfigurationEditorEnvironment editorEnvironment)
    {
      editorPanel.setLayout(new GridLayout(4,2));
      editorUser = editorEnvironment.createIvyScriptEditor(null,null, "String");
      editorEventTyp = editorEnvironment.createIvyScriptEditor(null,null, "String");
      editorLinkId = editorEnvironment.createIvyScriptEditor(null, null, "String");
      editorFieldValue = editorEnvironment.createIvyScriptEditor(null, null);
      
      editorPanel.add(new JLabel("User"));
      editorPanel.add(editorUser.getComponent());
      editorPanel.add(new JLabel("Event Typ"));
      editorPanel.add(editorEventTyp.getComponent());
      editorPanel.add(new JLabel("Link-Id"));
      editorPanel.add(editorLinkId.getComponent());
      editorPanel.add(new JLabel("Feldwert"));
      editorPanel.add(editorFieldValue.getComponent());        
    }

    @Override
    protected void loadUiDataFromConfiguration()
    {
      editorUser.setText(getBeanConfigurationProperty("User"));
      editorEventTyp.setText(getBeanConfigurationProperty("EventTyp"));
      editorLinkId.setText(getBeanConfigurationProperty("LinkId"));
      editorFieldValue.setText(getBeanConfigurationProperty("Feldwert"));
    }

    @Override
    protected boolean saveUiDataToConfiguration()
    {
      setBeanConfigurationProperty("User", editorUser.getText());
      setBeanConfigurationProperty("EventTyp", editorEventTyp.getText());
      setBeanConfigurationProperty("LinkId", editorLinkId.getText());
      setBeanConfigurationProperty("Feldwert", editorFieldValue.getText());
      return true;
    }
  }    

At runtime you have to evaluate the IvyScript the user have entered into the ivy script editors. If you implement for example the AbstractUserProcessExtension class there is a perform method which is executed at runtime. At this point you want to access the configured data in the editor. The following code snippet show how you can evaluate the value of an IIvyScriptEditor. If you use the IIvyScriptEditor you only get the value by calling the executeIvyScript method of the AbstractUserProcessExtension.

  public CompositeObject perform(IRequestId requestId, CompositeObject in,
     IIvyScriptContext context) throws Exception
  {
    IIvyScriptContext ownContext;
    CompositeObject out;
    out = in.clone();
    ownContext = createOwnContext(context);

    String eventtyp = "";
    String linkId = "";
    String fieldValue = "";
    String user= "";

    user = (String)executeIvyScript(ownContext, getConfigurationProperty("User"));
    eventtyp = (String)executeIvyScript(ownContext, getConfigurationProperty("Event Typ"));
    linkId = (String)executeIvyScript(ownContext, getConfigurationProperty("Link-Id"));
    fieldValue = (String)executeIvyScript(ownContext, getConfigurationProperty("Feldwert"));
    
    // add your call here
    
    return out;
  }           

On this tab you configure the parameters of the awaited event which is handled as an Intermediate Event Task. The Business milestone usually sets the current DateTime for process activity analysis and reports.

You can set the name of the business calendar that should be used for the task. In the context of the task ivy.cal will return this business calendar regardless of what you've set for the case.

For more information about business calendar administration see the engine guide.

For more information about business calendar usage see the Public API of ch.ivyteam.ivy.application.calendar.IDefaultBusinessCalendar.

On this tab you can configure the output of the element (i.e. the data that leaves the element). You can use the variable result that holds additional information about the event received by the Wait part Java class.

See Output Tab for a more detailed description.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

On this tab you could define the web page displayed when a case ends with this End Page Element.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

On this tab you can configure the Error Code of the error that will be thrown or the error object that should be re-thrown.

On this tab you can execute additional scripts after the error has been created. See Code Tab for a more detailed description.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

The Call tab defines what User Dialog component should be called and how it should be started. The input parameters for the selected start method can be mapped here.

Figure 2.70. The Call tab

On this tab you can configure the Task of this User Task. See “Task Tab” in the Task Switch Gateway element.

On this tab you can configure the Case of this User Task. See “Case Tab” in the Task Switch Gateway element.

On this tab you can configure the output of the element (i.e. the data that leaves the element). See Output Tab for a more detailed description.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

On this tab you set the dialog page and its properties. In addition, you are able to create the Web Page from scratch and store it in the CMS.

Figure 2.71. The Dialog tab

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

The Call tab defines what User Dialog component should be called and how it should be started. The input parameters for the selected start method can be mapped here.

Figure 2.72. The Call tab

The Display tab defines where the Rich Dialog is opened. If you want to open the Rich Dialog in a new Window you can ignore this tab.

On this tab you can configure the output of the element (i.e. the data that leaves the element). See Output Tab for a more detailed description.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

On this tab you can configure the output of the element (i.e. the data that leaves the element). See Output Tab for a more detailed description.

On this tab you can execute any script, e.g. define output data of this element. See Code Tab for a more detailed description.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

Here you define which SQL command you want to execute on which database. Depending on the kind of SQL command you are supported during the construction of your command.

Figure 2.73. The DB Tab

On this tab you can configure the settings for data cache access or invalidation. See Data Cache Tab for a more detailed description.

On this tab you can configure the output of the element (i.e. the data that leaves the element). See Output Tab for a more detailed description.

On this tab you can execute any script, e.g. define output data of this element. See Code Tab for a more detailed description.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

Figure 2.74. The Web Service tab

The tab WS is included in the mask of Web Service Call Step element. It features the following entries:

Figure 2.75. The Web Service Config tab

The tab Config is included in the mask of Web Service Call Step process element. It features the following entries:

Figure 2.76. The Web Service Test tab

The tab Web Service Test is included in the mask of a Web Service call element. It features the following entries:

On this tab you can configure the settings for data cache access or invalidation. See Data Cache Tab for a more detailed description.

On this tab you can configure the output of the element (i.e. the data that leaves the element). See Output Tab for a more detailed description.

On this tab you can execute any script, e.g. define output data of this element. See Code Tab for a more detailed description.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

On this tab you can configure the call to the REST service.

Figure 2.77. The REST Client Request tab

On this tab you can consume response from the REST service.

Figure 2.78. The REST Client Response tab

Rest Client calls can also be executed via Public API without using the Rest Client Activity.

The entry point to access Rest Clients is Ivy.rest(). The returned object is an instance of a javax.ws.rs.client.WebTarget which is pre-configured as defined in the “REST Clients Configuration”. It provides fluent API to call the remote REST service.

Sample

// retrieve pre-configured rest service client
WebTarget client = Ivy.rest().client("myServiceName"):

// GET request to receive a simple string
String token = Ivy.rest().client(UUID.fromString("e00c9735-7733-4da8-85c8-6413c6fb2cd3")).request().get(String.class);

// POST request to send a complex object
Ivy.rest().client("crmService").request().post(javax.ws.rs.client.Entity.json(myPerson));

If you notice that you configure precisely the same thing on multiple Rest Client Activities you can reduce this duplication.

Instead of applying the configuration multiple times, it can be set globally on the “REST Clients Configuration”. Almost any aspect of a Rest Client call can be configured by implementing a custom feature (javax.ws.rs.core.Feature). Our authorization feature can be taken as an example: ch.ivyteam.ivy.rest.client.authentication.HttpBasicAuthenticationFeature.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

In this tab the e-mail header is defined. You can use the CMS and the process data (the In variable) to compose the header fields.

Figure 2.79. The Header Tab

In this tab the e-mail content is defined.

Figure 2.80. The Content Tab

In this tab you can attach files to your e-mail. Each attachment line below on the screenshot represents one file. You can choose a file directly, take a process attribute with the type File, select a CMS entry or even build up the filename using script(s). The provided reference will be searched as CMS entry first, if no CMS entries found then the system will search the name as file in your Axon.ivy file area.

Figure 2.81. The Attachment Tab

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

In this tab you choose the process to be called and map process data attributes to the input parameters of the called process. You can use any IvyScript expression in the parameter mapping.

On this tab you can configure the output of the element (i.e. the data that leaves the element). See Output Tab for a more detailed description.

The variable result contains the output parameters that are returned by the called sub process (according to it's interface definition).

E.g. if the called process returns a String errorMessage and an Employee object employee then the variable result will have two fields: errorMessage and employee, respectively. You can map those fields to the attributes of the outgoing process data:

				out.msg = result.errorMessage is initialized 
					? ("An error occurred during selection: " 
						+ result.errorMessage) 
					: "";
				out.selectedEmployee = result.employee;
			

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

On this tab you can configure the Start Signature and the mapping of input parameter to the process data. The Start Signature is defined by its name and its parameter type and order.

On this tab you can configure the output of the element (i.e. the data that leaves the element). See Output Tab for a more detailed description.

The variable result contains the created task that are returned by the triggered Request Start.

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

On this tab you set the Java class which implements the interface IUserProcessExtension which is called when the PI step is executed. Furthermore, you can define exception handlers to react on errors such as not reachable systems, insufficient privileges and many more.

Figure 2.82. The PI tab

This tab displays the editor, that can be integrated in the external Java bean of the process element. The editor is implemented as an inner public static class of the Java bean class and must have the name Editor. Additionally the editor class must implement the IProcessExtensionConfigurationEditorEx interface. The common way to implement the editor class is to extend the abstract base class AbstractProcessExtensionConfigurationEditor and to override the methods createEditorPanelContent, loadUiDataFromConfiguration and saveUiDataToConfiguration. The method createEditorPanelContent can be used to build the UI components of the editor. You can add any AWT/Swing component to the given editorPanel parameter. With the given editorEnvironment parameter, which is of the type IProcessExtensionConfigurationEditorEnvironment, you can create text fields that support ivyScript and has smart buttons which provide access to the process data, environment functions and Java classes.

Here is an example of such an editor:

As you can see, the editor provides you access to any process relevant data, which can be used by your own process elements. For instance, you can easily transfer process data to your legacy system.

The following part shows the implementation of the editor shown above. As mentioned above Axon.ivy provides the IIvyScriptEditor which represents a text field with ivyScript support and smart buttons. Inside createEditorPanelContent use the method createIvyScriptEditor from the editorEnvironment parameter to create an instance of such an editor. Use the loadUiDataFromConfiguration method to read the bean configuration and set them to the UI components. Inside this method you can use the methods getBeanConfiguration or getBeanConfigurationProperty to read the bean configuration. Use the method saveUiDataToConfiguration to save the data in the UI components to the bean configuration. Inside this method you can use the methods setBeanConfiguration or setBeanConfigurationProperty to save the bean configuration.

  public static class Editor extends AbstractProcessExtensionConfigurationEditor
  {
    private IIvyScriptEditor editorUser;
    private IIvyScriptEditor editorEventTyp;
    private IIvyScriptEditor editorLinkId;
    private IIvyScriptEditor editorFieldValue;
    
    @Override
    protected void createEditorPanelContent(Container editorPanel,
            IProcessExtensionConfigurationEditorEnvironment editorEnvironment)
    {
      editorPanel.setLayout(new GridLayout(4,2));
      editorUser = editorEnvironment.createIvyScriptEditor(null,null, "String");
      editorEventTyp = editorEnvironment.createIvyScriptEditor(null,null, "String");
      editorLinkId = editorEnvironment.createIvyScriptEditor(null, null, "String");
      editorFieldValue = editorEnvironment.createIvyScriptEditor(null, null);
      
      editorPanel.add(new JLabel("User"));
      editorPanel.add(editorUser.getComponent());
      editorPanel.add(new JLabel("Event Typ"));
      editorPanel.add(editorEventTyp.getComponent());
      editorPanel.add(new JLabel("Link-Id"));
      editorPanel.add(editorLinkId.getComponent());
      editorPanel.add(new JLabel("Feldwert"));
      editorPanel.add(editorFieldValue.getComponent());        
    }

    @Override
    protected void loadUiDataFromConfiguration()
    {
      editorUser.setText(getBeanConfigurationProperty("User"));
      editorEventTyp.setText(getBeanConfigurationProperty("EventTyp"));
      editorLinkId.setText(getBeanConfigurationProperty("LinkId"));
      editorFieldValue.setText(getBeanConfigurationProperty("Feldwert"));
    }

    @Override
    protected boolean saveUiDataToConfiguration()
    {
      setBeanConfigurationProperty("User", editorUser.getText());
      setBeanConfigurationProperty("EventTyp", editorEventTyp.getText());
      setBeanConfigurationProperty("LinkId", editorLinkId.getText());
      setBeanConfigurationProperty("Feldwert", editorFieldValue.getText());
      return true;
    }
  }    

At runtime you have to evaluate the IvyScript the user have entered into the ivy script editors. If you implement for example the AbstractUserProcessExtension class there is a perform method which is executed at runtime. At this point you want to access the configured data in the editor. The following code snippet show how you can evaluate the value of an IIvyScriptEditor. If you use the IIvyScriptEditor you only get the value by calling the executeIvyScript method of the AbstractUserProcessExtension.

  public CompositeObject perform(IRequestId requestId, CompositeObject in,
     IIvyScriptContext context) throws Exception
  {
    IIvyScriptContext ownContext;
    CompositeObject out;
    out = in.clone();
    ownContext = createOwnContext(context);

    String eventtyp = "";
    String linkId = "";
    String fieldValue = "";
    String user= "";

    user = (String)executeIvyScript(ownContext, getConfigurationProperty("User"));
    eventtyp = (String)executeIvyScript(ownContext, getConfigurationProperty("Event Typ"));
    linkId = (String)executeIvyScript(ownContext, getConfigurationProperty("Link-Id"));
    fieldValue = (String)executeIvyScript(ownContext, getConfigurationProperty("Feldwert"));
    
    // add your call here
    
    return out;
  }           

An Annotation enables comments to be inserted anywhere within a model for documentation purposes

Figure 2.83. The Name Tab

This tab is included in the mask of all process elements and contains the name and a description of the element. See Name Tab for a more detailed description.

This tab is used to define the signature of the web service operation.

Figure 2.84. The Start Tab

This tab is used to define the return parameters of the operation.

Figure 2.85. The Result Tab