Chat now with support
Chat with Support

Identity Manager 8.2 - API Designer User and Development Guide

API Designer Basic principles of API development Examples and help – Software Development Kit Quick start – Creating an API Working with the API Designer
Starting the API Designer Project types User interface Global settings Database objects Labeling changes Find and replace Multilingual captions Managing database queries Managing tabs Managing layouts Displaying the change history (command list) Bookmarks Compiling an API Managing versions (compilation branches) Testing an API Linking C# projects to the API Designer
API projects API methods API Server ImxClient command line program

Using change labels

In order to also be able to assign a change label to changes, you need to select a change label for further use.

To use a change label

  • On the toolbar, select the required change label in the Change label list.

    Any changes stored in the project during this session will be assigned to the selected change label.

    TIP: If you always use the same change label and do not want to select it every time you start the API Designer, click Use the current change label as default in the toolbar.

Related topics

Creating a change label

You can create as many change labels as you wish and use them to track your changes.

To edit a change label

  1. In the toolbar, click (Manage change label).

  2. Click Create a new change label in the Change label dialog.

  3. Specify the properties of the change label in the right-hand column in the list:

    • Change label: Enter a name for the change label.

    • Description: (Optional) Enter a description for the change label.

    • Locked: (Optional) Select whether you would like to block the change label from further use. If a change label is locked, no further changes can be booked to this label.

    • Comment: (Optional) Enter a comment to monitor changes to the change label.

    • Status: (Optional) Select a status from the list.

    • Status comments: (Optional) Enter a comment in relation to the status.

    • Parent change label: (Optional) Select a change label from the list to be the parent.

  4. Click Save change label above the list.

  5. Click OK.

Related topics

Change management

You can edit existing change labels at any time.

To edit a change label

  1. In the toolbar, click (Manage change label).

  2. In the Change label dialog, click the label to be edited.

  3. Click Show / hide edit view.

  4. Change the properties of the change label in the right-hand column in the list:

    • Change label: Enter a name for the change label.

    • Description: (Optional) Enter a description for the change label.

    • Locked: (Optional) Select whether you would like to block the change label from further use. If a change label is locked, no further changes can be booked to this label.

    • Comment: (Optional) Enter a comment to monitor changes to the change label.

    • Status: (Optional) Select a status from the list.

    • Status comments: (Optional) Enter a comment in relation to the status.

    • Parent change label: (Optional) Select a change label from the list to be the parent.

  5. Click Save change label above the list.

  6. Click OK.

Related topics

Deleting change labels

You can delete existing change labels at any time.

To edit a change label

  1. In the toolbar, click (Manage change label).

  2. In the Change label dialog, click the change label you would like to delete.

  3. Click Delete the selected change label.

  4. Confirm the prompt with Yes in the dialog.

  5. Click Cancel.

Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating