Database Search Group Editor

Basic Preferences

Name	Defines the name of the search group.
Use custom handler	Select this option to use an external data source maintained by an add-in script.

Data Source Preferences

Server	Location of the external data source. Value given in the Server box represents name of the external data source link. Type here the name of the link you have defined in the External Databases options in the ATR CustomTools Administration.
Catalog	Name of the external database table the desired data is available in.
Schema	Database schema to which the desired table belongs in the external database.
Table	Database table that contains the data that is expected to be found from the external database by the Database Search Group.
Apply	Applies the preferences defined in the boxes above.
Select key columns	Determines the search group key columns. Key columns are unique identifiers of the rows in database table. NOTE: When the Use custom handler option is selected, you need to add at least one column into the list manually to make a working Database Search Group that is being managed by a script add-in.
Add column to the list	Use the Add column to the list box to add the desired table column into the key columns list. This operation is needed mostly in cases when the user permissions in the external data source limits visibility of the columns by default.
	Click this button to add the key column defined in the Add column to the list box into the Select key columns list.

Advanced Preferences

Quoting identifier

Select the type of character used by the database to mark strings. The type of quotation identifier depends on the type of external data source.

[ ]

Square brackets ([ ]) are used with the Microsoft SQL Server and also when the external data source is Microsoft Excel.

" "

Quotation marks (" ") are used with the Oracle SQL Server.

Microsoft SQL Server databases do require Quoting identifier. However, the Quoting identifier setting is required also for the Microsoft SQL Server if empty spaces are used in the database name (value in the Catalog box).

Additional search condition

Advanced conditions to search data from the external source. You can define one or more special conditions to your Database Search Group using the Additional search condition box. To see how the Additional search conditions may be defined, see the usage examples below.

Use unicode character set

Uses Unicode character when executing a query in the database.

Examples

Example 1 - One Additional Search Condition

Use an SQL query in the Additional search condition box to define special conditions.

Example: Name = 'John'
Output: The example condition above returns all the rows from the database which have the value John in the Name column.

Example 2 - Several Additional Search Conditions

Use the boolean operators such as AND or OR to define several Additional search condition.

Example: Name = 'John' OR Name = 'Marcus'
Output: The example condition above returns all the rows from the database which have the value John or Marcus in the Name column.

Service Preferences

Enable updating of linked custom properties when value in the linked database has changed	Synchronizes the custom property value linked with an item in the external datasource. The Update Conflict dialog box appears if the Property value has been modified manually and does not correspond to the value of the linked item in the external datasource.
Enable automatic linking of custom properties against corresponding database items	Automatic linking of properties. Select this option to automatically link Properties that have a corresponding value available in the external data source.

NOTE: ServerService is a server side component of ATR CustomTools which also requires its own license module. Contact your ATR CustomTools reseller to request a license for the ServerService.