Chat now with support
Chat with Support

Identity Manager 8.2.1 - API Development Guide

Basic principles of API development Examples and help – Software Development Kit API configuration Implementing your own APIs API Designer Quick start – Creating an API with the API Designer 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 ImxClient command line program

Editing bookmarks

You can show all bookmarks, delete all bookmarks, or change the description of bookmarks at any time.

To open the bookmark window

  • In the menu bar, click View > Bookmarks.

To open a bookmark

  1. In the menu bar, click View > Bookmarks.

  2. Double-click a bookmark in the Bookmarks window.

To edit the bookmark description

  1. In the menu bar, click View > Bookmarks.

  2. Click a bookmark in the Bookmarks window.

  3. Click Edit bookmark description.

  4. Insert a description for the bookmark in the Bookmark description dialog.

  5. Click OK.

Related topics

Setting bookmarks

You can set a bookmark for database objects at any time. This allows you to do things such as quickly access frequently used nodes.

To set a bookmark

  1. In the menu bar, click View > Navigation.

  2. In the navigation, double-click the database object that contains the node you require.

  3. In the definition tree view, right-click the node for which you would like to set a bookmark.

  4. Click Set bookmark in the context menu.

  5. Insert a description for the bookmark in the Bookmark description dialog.
  6. Click OK.
Related topics

Deleting bookmarks

You can delete single bookmarks, all bookmarks within a module, or all bookmarks within a project at any time.

To delete a single bookmark

  1. In the menu bar, click View > Bookmarks.

  2. Click the bookmark that you would like to delete in the Bookmarks window.

  3. Click Delete current bookmark.

  4. Confirm the prompt with Yes in the dialog.

To delete all the bookmarks in a module/component

  1. In the menu bar, click View > Bookmarks.

  2. Click Group by modules/components in the Bookmarks window.

  3. Click the module whose bookmarks you would like to delete.

  4. Click Remove bookmarks from module/component.

  5. Confirm the prompt with Yes in the dialog.

To remove all bookmarks

  1. In the menu bar, click View > Bookmarks.

  2. In the window, click Delete all bookmarks (Bookmarks).

  3. Confirm the prompt with Yes in the dialog.

Related topics

Compiling an API

TIP: See additional configuration options for compilation directly on the API project (see Configuring the compilation and in the global settings).

Before you can use an API that has been created with the API Designer, the API must be compiled using the API Designer compiler.

The API Designer compiler can be opened from the API Designer, as well as from the Database Compiler. For more information about the Database Compiler, see the One Identity Manager Operational Guide.

A web project must be compiled in the following cases:

  • After changing a definition (API file or API project) in the API Designer

  • After changing certain system settings that require Database Compiler to be run

The API Designer compiler creates a set of DLL files from the project's XML definition and saves them in the database.

Methods of compiling

There are two ways to compile a web project:

  • Run a Release compilation to release a specific version of the project for use.

    NOTE: Changes within the API Designer do not affect the API as long as there is no release compilation.

  • Use a Debug compilation during the development phase for testing and debugging purposes. Debug compilation creates additional code to support the API Designer debugger. This means the DLL files are somewhat larger.

An API loads the latest compiled DLL files on startup. If these DLL files are updated, the web project reloads the new DLL files; however, only new sessions run with the code from the newly loaded DLLs.

Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating