Work with custom services

You can lock and unlock, open, modify, copy, delete and tag a custom service. You can also view custom service versions, revert to a previous version, delete versions of a custom service, and compare versions of a custom service.

To work with custom services, navigate to Workflow > Custom services. The Custom services list page appears. Locate the custom service.

Unlock a custom service

Whenever a custom service is released, it is locked by default so that other resources cannot modify it. You can unlock a custom service to allow modification.

In the custom services list, on the context menu of the custom service to unlock, click Unlock. The custom service is unlocked and is available for modification.

You can lock a custom service again.

Modify a custom service

You can modify and delete a custom service. When you delete a custom service, all the versions are also deleted.

  1. On the list of custom services, click the custom service to modify.
    The custom service opens in a new browser tab.
  2. Make changes as needed.
  3. Save or release the custom service.

Delete a custom service

In the custom services list, on the context menu of the custom service to delete, click Delete. On confirmation, the selected custom service and all its versions are deleted.

You cannot delete a custom service that is in use.

Copy a custom service

Create a copy of custom service instead of creating it from scratch. Once a copy is created, you can modify and customize it to suit your requirement.

  1. On the context menu of the custom service to copy, click Copy.
    A copy of the custom service prefixed with "Copy 1 of" to the <custom service name> appears on the Custom service list page.
  2. Click to open the copy of the new custom service.
    The custom service opens in a new browser tab.
  3. Make changes as needed, such as rename the custom service or change the properties.
  4. Click Save.

Open a custom service version

You can open a custom service version in a read-only mode. For each version you can view the resource that modified it, the last modified date, and comments (if any). You can also revert to a previous version if it is not the latest version, and delete a version.

View a custom service version

  1. In the custom services list, on the context menu of the custom service to view versions for, click Versions.
  2. On the list of versions, click the row for the version to view.

    The selected custom service version opens in a read-only mode.

Revert to a custom service version

You can revert a custom service to create a new version based on an earlier version. All the items including variables, activities, resources, and properties of the selected version are available in the newer version.

  1. On the context menu of the custom service to view versions for, click Versions.
    The list of versions available for the selected custom service appear.
  2. On the context menu of the custom service version to revert, click Revert.
    On confirmation (save or release), the custom service version is reverted to the selected version.

    On saving the custom service, a minor version is created. For example, if you revert to on version 4 and choose to save, a minor version 4.01 is created. If you revert to on version 4 and choose to release, version 5 is created.

Delete a custom service version

  1. On the context menu of the custom service to view versions for, click Versions.
    The list of versions available for the selected custom service appear.
  2. On the context menu of the custom service to delete, click Delete.
    On confirmation, the selected version and all its lower versions are deleted. For example, if you delete version 3, version 2 and version 1 are also deleted.

Compare custom service versions

You can visually compare the workflow along with details of various items that have been added, deleted, or updated between the two selected versions of the same custom service.

  1. On the context menu of the custom services to compare the versions, click Compare.

    A new browser window opens with the custom service name.

  2. On the Compare versions lists, select the version that you want to compare in both the boxes.

    By default, the current version appears in the first list and the previous version appears in the second list. You can also view the details such as custom service name, version, resource that last modified it, and the last modified date.

  3. Click the following tabs to see the comparison between the two custom service versions. The newly added items appear in green, updated items in blue, deleted in red, and matching (that is, no changes) appear as is.

    Tabs

    Description

    Design

    Use this tab to visually compare the workflow. You can zoom the workflow in and out if needed (default: 100%) and view the color legend.

    You can also compare the properties of a node.

    1. Double-click a node on any side of the map.

      The Node properties window appears displaying the properties updated for the two selected versions.

    2. Click to close the pop-up window.

    Properties updated

    Use this tab to view the comparison between the process properties.

    If there is more than one change or any complex changes such as SLA, the updated property is displayed as "(Value updated)".

    Variables

    Use this tab to view the comparison between the variables such as the ID, name, type, value, and the initialization of the variables.

    The total count and the count of changed, new, removed, and unchanged variables is displayed in the footer.

    Data models

    Use this tab to view the comparison between the data models such as the name, and the last modified date.

  4. Click Close.

    The browser window is closed.