Create a process

Create a new process

To create a new process:

Click the New Process button in the Project Explorer toolbar. The New Process wizard opens.
Select the parent folder for the process.
Enter a File Name for the process and then click Finish.
The process is created and the process editor opens.
Press Ctrl+S to save the process.

Add a mapping

To add a mapping to a process:

Drag and drop first the mapping from the Project Explorer into the process editor.
This mapping is added as a reference to the current process.
Right-click this mapping step and select Show Properties View.
In the Properties view, set the step parameters in the Standard section:
- Name: Name of the step.
- Enable: Select this option to have this step enabled. Disabled steps are not executed or generated for execution.
- Error Accepted: Select this option to have this step complete with a Success status even when it fails.
In the Description section, provide a detailed Description of the step.
Press Ctrl+S to save the process.

The mapping is used in the process as a reference. Any change performed in this mapping impacts all the processes referencing it.

Add an action

To add an action:

In the Palette, select the action that you want to add to the process. You can expand the accordions in the palette to access the appropriate action.
Click on the process diagram.
A step representing your action is added to the diagram.
Right-click this action and select Show Properties View.
In the Properties view, set the step parameters in the Standard section:
- Name: Name of the action. Use a naming convention for the action names as they are used in the variable path.
- Enable: Select this option to have this action enabled. Disabled actions are not executed or generated for execution.
- Error Accepted: Select this option to have this action complete with a Success status even when it fails.
Set the action parameters in the Standard section. Each action has its own set of parameters, detailed in the Actions reference.
- A mandatory parameter appears as an editable field. Enter or select the value for this parameter.
- An optional parameter appears as a non-editable field, possibly with a default value. Click the parameter name to unlock the field and then enter/select a value for the parameter.
In the Description section, provide a detailed Description of the step.
Press Ctrl+S to save the process.

Advanced step configuration

In the Advanced section of the Properties view, you can configure advanced step properties.

Dynamic name

Dynamic Name: Dynamic Name for this step. This name can change at run-time and is available in the CORE_DYNAMIC_NAME variable.

Begin step

By default, all steps with no preceding step start when the process begins.
The Is Begin Action option configures explicitly a step as a startup step.

Semaphore name

The Semaphore name ensures that multiple instances of a step do not run simultaneously.

When a step starts, it checks whether another step with the same semaphore name runs and waits for that step to finish before starting. Multiple steps with the same semaphore name always run sequentially, even if they start simultaneously.

This feature does not guarantee the execution order of these steps. It is preferable to use links to explicitly define the execution order.

Conditional step generation

In the Generation section of the Properties view, you can add an XPath query as a Generation Condition for conditional steps.

Step repetition

In the Generation section of the Properties view, you can also add an XPath query to configure step repetition.

Step logging

In the Meta-Inf section of the Properties view, you can configure in an XML payload how additional log messages are emitted for the step. A message may be emitted to the log file, to the console, and to the runtime log database.

The XML payload contains a series of <userLog> elements with the following elements and attributes:

Path attribute: The message name, and optionally the path to the process step it should be attached to.
Trigger attribute: Defines when the message should be logged, that is before (beforeExecution) or after (afterExecution) the step is executed.
Info element: Defines the message content.
Logger elements: Specify the logger that receives the message.
By default you can use:
- userConsole: logs to the runtime standard output.
- mainConsole: same as userConsole, prefixed with date/time.
- stambiaLog: logs to the runtime log database.

Example 1. User log example

<userLog
    path="../START/ScriptingWatcher"
    trigger="beforeExecution">
        <info>Before Scripting: param=${~/param}$</info>
        <logger>stambiaLog</logger>
        <logger>mainConsole</logger>
</userLog>
<userLog
    path="../START/ScriptingWatcher"
    trigger="afterExecution">
        <info>After Scripting: param=${~/param}$</info>
        <logger>stambiaLog</logger>
        <logger>mainConsole</logger>
</userLog>