Connection-level Interface Management

You are looking at an older version of the documentation. The latest version is found here.

All currently available connection-level interface templates are listed in the CliTemplates system table. It has the following fields:

Column Name	Type	Description
`id`	biginteger	Template ID
`name`	string	Template name
`createScript`	string	CLI script which creates a data source/resource adapter
`dropScript`	string	CLI script which removes a data source/resource adapter
`hiddenProps`	string	Comma-separated list of properties that will be stored encrypted
`creationDate`	timestamp	Template creation date
`lastModifiedDate`	timestamp	Template last modification date
`creator`	string	Name of the user who created the template
`modifier`	string	Name of the user who last modified the template
`translator`	string	Translator name

SYSADMIN.addCliTemplate

This procedure adds a new CLI template with a specified name.

SQL

CREATE FOREIGN PROCEDURE addCliTemplate(IN name string NOT NULL, IN createScript string NOT NULL, IN dropScript string NOT NULL, IN hiddenProps string, OUT id biginteger NOT NULL RESULT)

SYSADMIN.editCliTemplate

This procedure edits a CLI template with a specified id assigning it a new name, createScript, and dropScript. name, createScript, and dropScript may be set to NULL. Properties that should be stored encrypted can be specified by providing them as a comma-separated list via hiddenProps.

Arguments set to NULL will not be changed during the call.

SQL

CREATE FOREIGN PROCEDURE editCliTemplate(IN id biginteger NOT NULL, IN name string, IN createScript string, IN dropScript string, IN hiddenProps string)

SYSADMIN.dropCliTemplate

This procedure drops a CLI template with the specified id.

SQL

CREATE FOREIGN PROCEDURE dropCliTemplate(IN id biginteger NOT NULL)

SYSADMIN.resetCliTemplates

This procedure restores default templates.

SQL

CREATE FOREIGN PROCEDURE resetCliTemplates()