You can edit all existing database queries at any time.
To show all database queries
-
Click Edit | Edit database queries on the menu bar.
API Designer
Basic principles of API development
Guidelines and conventions
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
API projects
Object properties
Managing objects in a project (solution)
Editing database objects (definition tree view)
Labeling changes
Find and replace
Multilingual captions
Creating multilingual captions
Searching for a multilingual caption
Editing a multilingual caption
Deleting a multilingual caption
Managing database queries
Displaying database queries
Creating a database query
Editing a database query
Testing a database query
Deleting a database query
Managing tabs
Managing layouts
Displaying the change history (command list)
Bookmarks
Compiling an API
Testing a compilation
Starting a compilation
Managing compilation errors and warnings (task window)
Opening the compiling log
Managing versions (compilation branches)
Selecting and using compilation branches
Creating compilation branches
Editing compilation branches
Deleting compilation branches
Testing an API
Linking C# projects to the API Designer
Creating API projects
Editing API projects
Deleting API projects
Configuring authentication
Configuring the compilation
Assigning API files to an API project
Importing API projects
API files
Creating API files
Editing API files
Deleting API files
Assigning API files to an API project
Importing API files
API Server
ImxClient command line program
Displaying database queries
Creating a database query
You can create new database queries at any time.
To create a database query
-
Click Edit | Edit database queries on the menu bar.
-
Click
Add in the Edit database queries dialog.
-
Enter a unique name for the database query in the Identifier field.
-
(Optional) In the Description field, enter a description for the database query that describes the database query and its function.
-
Enter the query as a SQL code in the SQL expression field.
-
Double-click the dialog groups that may use the database query in the Dialog groups pane.
TIP: Click Select all or Deselect all to quickly select or deselect all dialog groups.
-
(Optional) Click Test statement to test the SQL statement with different values. For more information, see Testing a database query.
-
Click
Save.
-
Click Close.
Related topics
Editing a database query
NOTE: You cannot edit any database queries that have been predefined by the API Designer.
You can edit existing database queries at any time.
To edit a database query
-
Click Edit | Edit database queries on the menu bar.
-
Click the database query you would like to edit in the Edit database queries dialog.
-
Enter a unique name for the database query in the Identifier field.
-
(Optional) In the Description field, enter a description for the database query that describes the database query and its function.
-
Enter the query as a SQL code in the SQL expression field.
-
In the Dialog groups section, double-click the dialog groups for which access permissions are to be changed.
TIP: Click Select all or Deselect all to quickly select or deselect all dialog groups.
-
(Optional) Click Test statement to test the SQL statement with different values. For more information, see Testing a database query.
-
Click
-
Click Close.
Related topics
Testing a database query
You can test database queries at any time.
To test a database query
-
Click Edit | Edit database queries on the menu bar.
-
In the Edit database queries dialog, click the database query you would like to test.
-
Click Test statement.
-
In the Test statement dialog, enable the check box next to the SQL statement parameters that you would like to include in the test.
-
Enter the values for each parameter in the Value column.
-
Click Test statement.
-
Click Close.
-
Click Close in the Edit database queries dialog.