Skip to main content

Exchange Framework 1.6.1 upgrade guide

Disable Journey Analytics milestones​

By default, Exchange services that extend the FluentFunction base class fire Journey Analytics milestone events on starting and completing a request. Based on feedback from the Client Services team, we have added the ability to disable milestone events inside Exchange services in client projects in order to have a simplified view in Journey Analytics.

In Exchange Framework 1.6.1, this feature has been added in the FluentFunction base class. This allows milestone events to be turned on/off based on a service parameter called disableMilestones. By default, disableMilestones is false for backwards compatibility.

tip

If you need to fire custom milestone events in your fluent function, the FluentFunction base class includes a handy void addMilestone(String name, String subTypeName) method that considers disableMilestones before firing the milestone events.

In the FluentFunction base class, the milestoneStart() and milestoneComplete() methods trigger the start and complete milestones using addMilestone().

Follow these steps to enable Journey Analytics milestone events to be turned on/off.

  1. Extend the FluentFunction base class.

  2. Add the following service parameter in the service-def.json configuration file.

    {
        "name": "disableMilestones",
        "description": "Whether to disable Journey Analytics milestone event for this service.",
        "value": "false",
        "type": "Boolean",
        "bind": false,
        "required": false,
        "clearOnExport": false,
        "readOnly": false
    }

    To disable milestone events, set "value" to true.