Registering the application with the CAI
Registering the application with the CAI in the Application Registry makes it available for selection when configuring CAI components, for example, the commands and the command parameters for each integrated component.
The Application Registry form is used to register the applications and to identify key elements of the back-office application, such as template forms, and interface forms.
A registry entry is used to recognize the back end application, set the configuration settings such as mode of connection (local or remote), set server and template information, and set the context for the remainder of the entities. Use the Application Registry form to modify any of the preconfigured information or create new application registries if your organization is going to use other applications.
To register an application
- From the Application Administration Console, click the Custom Configuration tab.
- From the Application Settings list, choose Foundation> Advanced Options > Command Automation Interface - Application Registry, and then click Open. The Application Registry form appears.
Enter the following required information in the top pane:
Enter a unique name for the application that you are registering.
Enter a description of the application that you are registering.
Select a status for this entry.
On the General tab, enter the following information:
Select the application that you are registering.
This drop-down selection menu is a menu named "SYS:MNU:AppNamesFromSHRAppProperties-Q" which searches the SHARE:Application_Properties form and lists the Property Values when ( 'Status' = "Active") AND ( 'Property Name' = "Name" ). If you do not see your new application listed here, go back to the SHARE:Application_Properties form and verify your work.
Select the form that identifies the template.
Template View Form
Select the form that is the front end or view form (the form that the back end application's user see) for the template form you selected.
The view form should already exist in the back end application.
Enter the form that identifies the application instance.
The application instance is the request entry that is created when the service request is submitted, based on the template, if a template is used. Some back end applications might choose not to use a template structure. The form identifier (or Template Form field) identifies the back end request form that is used to create the entry.
Designate a form identifier.
New Request Activation
Select Yes to indicate that the request needs to be activated after submission; otherwise, select No.
- Click the Connection tab. The Connection tab is used to define login information and the type of protocol to use when integrating the registered application.
Enter or modify the following information:
Specify whether the registered back end application is on a remote or local server.
Enter the server name where the application you are registering is installed.
For a server group environment, enter the name of the load balancer.
Specify the communication format for data exchange (AR, URL, Web service, Command Line, Plug-in, Other).
Fill in this field if you set the Access Mode to Remote. Enter your login name to access the remote back end application used for requests.
Fill in this field if you set the Access Mode to Remote. Enter your password to access the remote back end application used for requests.
Fill in this field if you set the Access Mode to Remote. Enter the port number of the remote back end application used for requests.
- Click Save.