立即与支持人员聊天
与支持团队交流

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

Displaying object properties

You can display the properties of a database object at any time.

To display the properties of a database object

  1. On the menu bar, click View | Navigation.

  2. In the navigation, click the database object whose properties you would like to display.

  3. Click Properties .

    The Object properties dialog opens. This dialog contains several tabs displaying the properties of the selected database object. For more information, see Object properties.

Related topics

Managing objects in a project (solution)

Open the Solution view using View | Solution (see Opening the solution).

The solution can be used to display all the objects in the API Designer that can be opened from the navigation menu.

The solution view depends on your choice of project. If you select a solution project when starting the API Designer, the listed entries will be grouped according to their respective database modules and you will be able to disable the compilation of individual database modules. Database modules whose status has not changed, are shown as collapsed nodes. If you mark a subnode, you can run additional tasks.

You can also identify the objects whose status has changed in API Designer. Differences between changes in the API Designer and changes to resources in the database or on the hard disk are marked.

To open an object, double-click it in the solution.

The following table provides an overview of the various features available in the Solution window.

Table 8: Controls

Control

Description

Update list

Refreshes the list of database objects.

Reload selected objects

Reloads the selected objects.

Mark all modified objects to be reloaded

Any objects that you have modified will be reloaded after you click Reload selected objects.

Disable module compilation

Disables compilation of the selected module.

Only display modified objects

Only modified objects will be displayed in the list.

Table 9: Solution columns

Column

Description

Object identifier

Name of the object

DB status

Up to date is displayed when the database has been refreshed. Otherwise, the user who made the change is displayed.

Status drive

Up to date is displayed when the file has been updated. Otherwise, a time when the changes will be made is shown.

Status API Designer

Displays object modifications.

The status is shown as Changed if the object has been changed.

Reload

A check box is displayed for new objects. You can reload selected objects.

Path

Shows storage location of the file on the hard drive.

Related topics

Opening the solution

You can open the solution at any time.

To open the solution

  • Click View | Solution on the menu bar.

Related topics

Editing database objects (definition tree view)

Open the definition tree view over View | Navigation | Click the required database object (see Opening the definition tree view).

Use the definition tree view to display and edit different database objects in API Designer. A separate tab containing a unique definition tree view will be opened for each database object that you edit. A definition tree view opens when adding or editing database objects, for example.

A database object contains what are known as nodes, which you can display in a tree structure within the definition tree view and edit in the node editor view (see Node editor view). If you add a new database object to your project (for example, an API project), this database object is created with a predefined number of nodes and is shown in the object definition. The object definition is a type of view found within the definition tree view.

The predefined nodes contained in a database object form the basic structure of the database object. You cannot delete these nodes.
In addition to the predefined nodes, you can add extra nodes by right-clicking on the context menu. You can delete these nodes.

The following table gives an overview of the various features contained on the toolbar within the definition tree view.

Table 10: Definition tree view toolbar

Icon

Description

Object definition

An overview of nodes contained in a database object can be found here.

Generated code

You can view the code generated for a selected node here. For more information, see Viewing and saving generated code belonging to a node.

Find and replace

You can search for terms here and replace them where necessary. For more information, see Find and replace.

Related topics
相关文档

The document was helpful.

选择评级

I easily found the information I needed.

选择评级