Chat now with support
Chat with Support

Identity Manager 8.1.4 - 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 files API Server ImxClient command line program

Searching for a multilingual caption

You can search for multilingual captions at any time.

To search for a multilingual caption

  1. Click Captions on the menu bar.

  2. In the Multilingual captions dialog, enter a term into the Search form (such as the name of a key or parts of the caption).

  3. Use the options below the search bar to limit your search:

    • Search key and value: Searches for the term in the key and captions.

    • Search for key only: Only searches for the term in the key.

    • Search for value only: Only searches for the term in the captions.

    • Search in all available languages: Enable this option if you would like to search for the term across all languages. If you disable this option, the search will only be performed in the language that is current shown in the Language field in the Edit pane.

  4. Click Search.

    The search results are displayed in the Result list pane

    TIP: If one of the Search key and value or Search for key only options is set, the keys shown in the result list are labeled with an asterisk (*).

Related topics

Editing a multilingual caption

You can edit existing multilingual captions at any time.

To edit a multilingual caption

  1. Click Captions on the menu bar.

  2. In the Multilingual captions dialog, enter the search term in the Search form section.

  3. Use the options below the search bar to limit your search:

    • Search key and value: Searches for the term in the key and captions.

    • Search for key only: Only searches for the term in the key.

    • Search for value only: Only searches for the term in the captions.

    • Search in all available languages: Enable this option if you would like to search for the term across all languages. If you disable this option, the search will only be performed in the language that is current shown in the Language field in the Edit section.

  4. Click Search.

  5. In the Result list section, click the caption to be edited.

    TIP: If one of the Search key and value or Search for key only options is set, the keys shown in the result list are labeled with an asterisk (*).

  6. In the Edit section, change the unique value in the Key field that is used to reference the text.

    NOTE: If you have not added a translation for a language, the API will use the caption that has been saved under Key.

  7. Select the caption’s language in the Language list.

  8. Enter the caption to be shown for the selected language in the Text field.

  9. Repeat the last two steps for any languages that you would like to change or add.

  10. Click Save on the toolbar in the Multilingual captions dialog.

  11. Click Apply.

Related topics

Deleting a multilingual caption

You can delete existing multilingual captions at any time.

NOTE: You cannot delete multilingual captions that have been predefined by API Designer.

To delete a multilingual caption

  1. Click Captions on the menu bar.

  2. In the Multilingual captions dialog, enter a term into the Search parameters (such as the name of a key or parts of the caption).

  3. Use the options below the search bar to limit your search:

    • Search key and value: Searches for the term in the key and captions.

    • Search for key only: Only searches for the term in the key.

    • Search for value only: Only searches for the term in the captions.

    • Search in all available languages: Enable this option if you would like to search for the term across all languages. If you disable this option, the search will only be performed in the language that is current shown in the Language field in the Edit section.

  4. Click .

  5. In the Result list section, click the caption to be deleted.

    TIP: If one of the Search key and value or Search for key only options is set, the keys shown in the result list are labeled with an asterisk (*).

  6. Click Delete on the toolbar in the Multilingual captions dialog.

  7. Confirm the prompt by selecting Yes in the dialog.

  8. Click Apply.

Related topics

Managing database queries

Open the Edit database queries dialog over Edit | Edit database queries (see Displaying database queries).

In the Edit database queries dialog, you can display, create, edit, delete, and test database queries.

Database queries enable secure communication between your web application and your One Identity Manager database. The actual SQL code is saved in SQL snippets, to which only certain parameters can be added later. The database queries are referenced later in the code only based on their name.

The following table gives an overview of the various features within the Edit database queries dialog.

Table 15: Controls

Control

Description

Add

Creates a new database query. For more information, see Creating a database query.

Delete

Deletes the selected database query. For more information, see Deleting a database query.

Save

Saves changes to the selected database query. For more information, see Editing a database query.

Save all

Saves all changes. For more information, see Editing a database query.

Discard object changes

Undoes all changes to the selected database query.

Identifier

Is a unique database query ID.

Description

Gives a description of the database query that explains the query and its function.

SQL expression

Is the actual query in SQL code.

Dialog groups

Are dialog groups that are permitted to use this database query (labeled ) or forbidden from using it (labeled ).

Test statement

Opens the Test statement dialog. You can test the database query here. For more information, see Testing a database query.

Related topics
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating