Chat now with support
Chat mit 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

Database objects

API projects, and API files are defined as database objects in API Designer. Here you can learn how to work with these database objects in API Designer.

Related topics

Object properties

Right-click on an object to open the Object properties dialog (see Displaying object properties)

The Object properties dialog displays the properties of objects in the API Designer. The dialog is divided into five tabs, which are explained below.

General

Under the General tab, the general properties of the object such as ID, status, or primary key are displayed.

Properties

Under the Properties tab, all columns in the database object are displayed in a table alongside their values. You can choose between a simple column view or the advanced view with additional data for column definitions.

Entitlements

On the Permissions tab, the database object permissions are displayed. The first entry shows the basic permissions for the table. The permissions for this particular object are displayed beneath it. The other entries show the column permissions.

TIP: Double-click the table entry, the object entry, or a column entry to display the permissions group from which the permissions were determined.

Table 7: Icon used for permissions
Icon Meaning
Permissions exist.
Permissions have been removed by the object layer.
Permissions limited by conditions.
Label

Under the Change labels tab, all the change labels assigned to the database object are displayed. You can also assign a change label to the object.

Export

Under the Export tab, you can export the database object:

  • To the clipboard
  • As a file
  • Using drag-and-drop
  • As a SQL INSERT statement or SQL UPDATE statement
Related topics

Displaying object properties

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

To display the properties of a database object

  1. In 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
Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen