Introduction

This document describes the database interface fields and the interface template maintenance for IP1 API’s. The APIs allow the standard database operations to either add, update, inquire or delete a database record. These operations and the interface files determine the input mode for each of the API methods. See Database operations & modes.

Aperio interface template

Aperio Interface Template allows you to do the following.

Search for the template by Company and User group (User group set by CRM contact attribute in TMSDS/UA-ACT)
Add new templates by Company and User group.
Preset parameter values using templates

Access Aperio Interface Template option from menu Other Options > Data Interfaces > Aperio > Management > Aperio Interface Management. XAW350 Work with Database Interface panel appears, listing all the database files. The following options are available on this panel.

Option	Description
Controls	Provides the option to view and maintain the templates and their values. Templates can be setup by Company and User group. The following controls are pre setup to define how the system treats the input parameters for the API. Allow input for add Allow input for update Mandatory flag System default values in add mode Allow user to override default value If the control is setup to allow users to override default values, then the template values can be maintained.
Fields	Displays all the existing fields in the database file along with the list of field IDs for the API interface. Interface fields are used for mapping database or parameters (in the form of workfile) to a globally unique field ID. Each field ID can have customized external name (JSON element name). Each interface field ID can be tied to any of the following. Value set (validation rule) Format or Control number file User access Group fields Group fields Database fields can be grouped to form a single field ID. These can be fields that require the same validation, for example the address fields. The following applies to the group fields. Naming convention is group name for interface field ID and External suffix is added to the External Name e.g. postalAddressLine0. Group ID allows validation & listing in group (PADDR group as in the example above) Interface field names must be the exact database file field names as shown above. Important: All the interface field ID’s across all the databases must be unique.
Import	Allows you to import the current fields.

Setup template values

In the previous panel, select an API method and enter option 1=Controls. Work with Interface Controls panel appears.
Select option 1=Template.
Press <Enter>. All the existing templates are displayed. Different templates can be setup for different Companies and User groups.
Use option 2=Change to maintain the template values. Any defaults and mandatory flags that are setup in the controls will display. If the field values can be overridden, then maintain as required.
Page down.
Once all the defaults are maintained, press <Enter> to confirm.