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

Changing the project type

You can save your project as a database project or as a solution project. For more information, see Project types.

To save the project as a database project

  1. In the menu bar, click Edit > Set project type.

  2. In the Select the project type dialog, click Database project.

  3. (Optional) To save the selection and use it the next time you start the API Designer, enable the option Use selected project as default.

    TIP: To undo this setting:

    1. In the menu bar, click Connection > Settings.

    2. Expand the Editor pane in the Global settings dialog.

    3. In the Editor pane, select the Ask for project type at each start option.

      The next time the program is started, the Select the project type dialog is displayed.

  4. Click OK.

To save the project as a solution project

  1. In the menu bar, click Edit > Set project type.

  2. In the Select the project type dialog, click Solution project.

  3. Perform one of the following actions:

    • Click Create solution and use the wizard to create a new solution.

    • Click Load solution and enter the path to an existing solution.

    • Click the solution most recently used.

  4. (Optional) To save the selection and use it the next time you start the API Designer, enable the option Use selected project as default.

    TIP: To undo this setting:

    1. In the menu bar, click Connection > Settings.

    2. Expand the Editor pane in the Global settings dialog.

    3. In the Editor pane, select the Ask for project type at each start option.

      The next time the program is started, the Select the project type dialog is displayed.

  5. Click OK.

Related topics

Solution projects

API Designer allows for custom objects to be edited locally in a file-based format on your own computer. To do this you will need to export any custom objects stored within the database to the API Designer. In other words, you must use the "solution project" project type (see Changing the project type).

To import the changes made to the solution project back into the database, follow the instructions in Importing solution project changes into a database.

After exporting these objects from the database, you can edit and remove them on your computer, or supplement them with additional objects. Local object editing is no different than editing within the database project.

During export, any objects contained in the selected module are copied to the hard drive:

  • API projects

  • API files

Related topics

Importing solution project changes into a database

Changes that have been run within a solution project must be transferred into the One Identity Manager database.

To import object into the One Identity Manager database

  1. In the menu bar, click Edit > Import objects into database.

  2. In the Import objects into database dialog, enable the option Remove deleted objects from database. Objects that you have deleted from your solution project are now also deleted from the database.

  3. Go to Solution objects to select the objects that you want to change and export into the database.

    TIP: To select or deselect listed objects quickly, enable the Select all/deselect all option.

  4. Click Continue.

  5. Click Finished.

Related topics

User interface

This section gives you an overview of the graphical user interface of the API Designer.

Use the mouse and keyboard to interact with the API Designer‘s graphical user interface. Use a screen resolution of at least 1280 x 1024 pixels and a minimum color depth of 16 bits for optimum display.

TIP: The API Designer view can be customized at any time to suit your needs by moving, closing, or hiding items.

Main user interface components
  • Top – Title bar

    The title bar shows the program icon, program name, and connected database (including the current user).

  • Top – Menu bar

    You can use the menus on the menu bar to access submenus and to access and run many functions in API Designer quickly. For more information, see Menu bar.

  • Top – Toolbar

    The toolbar contains different icons that you can click to access other functions. For more information, see Toolbar.

  • Left – Navigation

    Use the navigation to manage (create, open, delete) API configurations, API files, and API projects. You can also access the most recently edited file here. For more information, see Navigation.

  • Center – Work pane

    The center pane is where other work panes for editing are shown, such as the Definition tree view. When you open objects, they are shown in the work pane in separate Tabs.

  • Bottom – Status bar

    The status bar shows information such as database activity, project information, the connected database, and the current user. For more information, see Status bar.

Start page

The home page is displayed when the API Designer starts up.

On the home page, you can:

For more information, see Start page.

Detailed information about this topic
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating