Work with case definitions

You can modify, copy, delete, unlock, and debug a case. You can open a case version, delete a specific version, and compare between two versions of a case.

To work with case definitions, navigate to Workflow > Case definitions. The Case definitions list page appears. Locate the case definition.

Modify a case definition

You can open a case to modify.

  1. Click the case to modify.
    The case opens in a new tab.
  2. Make changes as needed.
  3. Save the case.

Copy a case definition

Create a copy of the case instead of creating it from scratch.

  1. In the case definitions list, on the context menu of the case definition to copy, click Copy.
    A copy of the case definition prefixed with "Copy 1 of" to the <case name> appears on the Case definitions page.
  2. Open the copy of the new case.
    The case opens in a new browser tab.
  3. Make changes, such as renaming the case.
  4. Click Save.

    Once a copy is created, you can modify it to customize it to your requirement.

Unlock a case definition

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

In the case definitions list, on the context menu of the case definition to unlock, click Unlock. On confirmation, the case definition is unlocked and is available for modification.

You can lock a case definition again. When you open an unlocked case definition, a message appears to confirm whether to lock the process. On confirmation, the case definition is locked.

Delete a case definition

In the case definitions list, on the context menu of the case definition to delete, click Delete. On confirmation, the case definition and all previous versions are deleted.

Open a case definition version

You can open a case 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 case definition version

  1. In the case definitions list, on the context menu of the case definition to view versions for, click Versions.
  2. On the list of versions, click the row for the version to view.

    The selected case definition version opens in a read-only mode.

Revert to a version

Revert a case map to create a new version of the map based on an earlier version. All the items including variables, activities, resources, properties, and skin rules of the selected version are available in the newer version. For example, in a management scenario, as part of the company's project plan, you might have altered the organization's hierarchical structure, resource managerial levels, their categories, and the process map design. Then saved and released to create a new version of the map and immediately put it to use. However, after a few days of implementation, management analyses the performance and opts to revert to the previous resource hierarchy and process flow. You might then want to pick the earlier map version and quickly replace the current version.

When you want to revert to a case definition version, make sure that the case definition is not open.

  1. In the case definitions list, on the context menu of the case to open the versions list for, click Versions.
  2. On the context menu of the version of the case to revert, click Revert.
  3. Once you confirm, the case version is reverted to the selected version.
  4. Release the case. A new version of the case map is created. The Versions list is updated to include the new version.

Delete a case definition version

You can delete a redundant version of a case. When you delete a version of a case, the selected version and all previous versions are deleted. For example, if you delete version 3, version 1 and version 2 are also deleted.

  1. In the case definitions list, on the context menu of the case to open the versions list for, click Versions.
  2. On the context menu of the version of the case to delete, click Delete.
    On confirmation, the selected version and all previous versions are deleted.

Debug a case

  1. In the case definitions list, on the context menu of the case to debug, click Debug. Alternatively, click Debug on the process modeling bar.

    The Debug page opens.

  2. Debugging a case is like debugging a process. For more information, see Debug a process.

Compare case 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 case definition.

You can also view and compare the case definition versions by clicking "Compare" option on the File tab.

  1. In the case definitions list, on the context menu of the case to compare the versions, click Compare.

    A new browser window opens with the case 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 case definition name, version, resource that last modified it, and the last modified date.

  3. Click the following tabs to see the comparison between the two case definition 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 comparison between the process properties which also includes document set.

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

    Document set is included only when the document set is turned on or off, that is when changed.

    Milestones

    Use this tab to view comparison between the milestones such as the name of the milestone and its associated state.

    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.

    Process events

    Use this tab to view the comparison between the process events such as the name, and the description.

    States

    Use this tab to view the comparison between the states such as the name of the state, and percentage complete.

    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.