Stage Configuration
  • 07 Dec 2022
  • 3 Minutes to read
  • Contributors
  • Dark
  • PDF

Stage Configuration

  • Dark
  • PDF


Users must specify the milestones that occur in a specific transaction during business process configuration. These milestones are defined as Stages.

Users may add one or more stages to each of the selected transactions.

Creating a Stage

  • Transaction stages can be created by following the necessary steps by editing the Transaction flow in any of the transactions.

  • Add a stage to the flow by clicking the Add stage option while editing the transaction flow. Also, provide a Tracking name and a Friendly name to the transaction stage.

  • Tracking name for a stage is a name given to the transaction stage to track the status of the relevant stage during the tracking process.

  • Users can also make use of the Optional settings if necessary. Choose any of the available options from the Executed at dropdown to specify the resource in which the stage is to be performed.

  • Users can add Stage property as well as Global property by selecting the relevant option from the Add Property button. Click the Add button to complete creating a stage.

  • Once the stage is added, users can configure properties for the added stage by using Configure properties (Custom Properties that need to be tracked) available in the context menu of the stage. The transaction stage can be connected in the transaction flow as per the users' needs.

Optional settings

Optional settings.png

1. Is Conditional Stage - Enabling this feature will make the stage look like a decision-making box in the transaction diagram.

2. Mark transaction instance as completed - Enabling this option in a stage will make the transaction completed whenever that stage gets executed, irrespective of the IsTransactionComplete parameter passed to the stage. This setting will be applied only when the IsTransactionComplete parameter is not enabled in the checkpoint connector.

3. Mark transaction instance as failed - Enabling this option in a stage will make the transaction fail whenever that stage gets executed. This setting will be applied only when the StageStatus parameter is not enabled in the checkpoint connector.

Configure properties

  • The stage properties can be configured by right-clicking the desired stage and selecting Configure properties option while editing the business transaction flow.

  • In order to create a Stage / Global property, press the Add Property button and choose either Stage property or Global property option from the dropdown to proceed further.

  • Provide the property with a Property Name, Property DataType, Property Source which can be Xpath, JSON, constant or an HTTP Header, Property Path of the property that needs to be tracked, and Extract value using regular expression data to extract values from the configured property that matches the given regular expression which is optional.

  • Press the Add button to complete adding a new property to the respective stage.

Property configuration.png

Property source

There are four types of property sources for Stage property:

  • XPath
  • JSON
  • Constant
  • HttpHeader


Users must provide a valid XPath in order to track the XPath property.


  • //Landmark

The provided XPath is used to select all Landmark elements.

  • PickUpLocation/Landmark

The given XPath picks all Landmark elements that are present under the parent element, PickUpLocation.


Users must provide a valid JSON path in order to track the JSON property.


  • $['PickUpLocation']

PickUpLocation is the root element that is selected by using this JSON path.

  • $['PickUpLocation'] ['Landmark']

The provided path selects the child element Landmark from the parent element PickUpLocation.


  • Dot notation can be used .PickupLocation.Landmark


Users can enter a constant value that will be displayed in addition to the other property sources while it is being tracked.

The constant value does not have to match any data in order to be triggered.


  • New York

The specified property name will appear alongside the provided constant value.



Users must specify a header name that matches the value next to messageHeader when triggering the data in order to display its data while tracking the relevant Stage.


  • BookingStatus

The provided header will be used to extract the data available within it.


Extract value using regular expression

Users must provide a valid regular expression in order to extract values from the configured property.


  • [^\/:*?"<>|\r\n]+$

The provided expression extracts the file name.

  • ^[a-zA-Z]+$

The provided expression accepts only letters.

Key features

  • Zoom in/Zoom out option is available in the Transaction Diagram section in order to perform zooming operation in the transaction flow.

  • Undo/Redo actions can be performed while editing the transaction flow.

Transaction flow.png

Was this article helpful?