Configuring the CAIPluginRegistry form

The web service setup for the Command Automation Interface (CAI) is a complex web service that contains multiple components and is presented as a single interface. The two CAI components, CAI:Events and CAI:EventParameters, are defined as a single web service.

CAI plug-in permission model

The CAI has the Command Event Master role, which by default is mapped to the Command Event Master group and can be granted to users by using the People form.

Only users in this group and AR System administrators can access the CAI forms and update fields on those forms. For implementation of event error handling, integrating applications must have the same group and role mapping.

Perform the following procedure to configure the CAI:PluginRegistry form to define and configure thread pools for specific commands. Thread pools for different commands are configured in the CAI:Commands form. For more information about the CAI:Commands form, see Defining-command-parameters.

Configuring thread pools defines dedicated CAI threads for use by the specific command. This configuration ensures that requests from a command use only the dedicated threads, and performance of other command requests to the CAI is not affected.

Before you begin

Generate the private queue number as described in Generating-a-private-server-queue.

To configure the CAI:PluginRegistry form

1. In a browser, open the CAI:PluginRegistry form from Application Administration Console > Custom Configuration > Foundation > Advanced Options > Command Automation Interface -  PlugIn Registry.
2. In the Private Queue # field, type the private queue number that you have generated.
3. In the CAI Pool Configuration table, select any CAI pool and click View to edit the number of threads for the selected pool.

4. (Optional) To add a new pool, click Add, fill in the details, and click Save.
   The total number of threads is updated automatically. The pool that you created here is used to configure the outbound messages and commands for a specific pool.

   Important

   On the Commands form, you can configure one of the pool numbers that you defined in step 4. If the pool number is not defined, the default pool (#0) is used. For more information, see Defining-command-parameters.

5. Ensure that the maximum number of threads that you specified in Generating-a-private-server-queue is equal to or more than the computed threads in step 3.
6. In the Log Level list, select the desired level for the CAI plug-in log entries.
   The WARN level is the recommended default value.
7. Click Close to save the entry, and close the CAI:PluginRegistry form.
8. Restart AR System so that CAI picks up the new private queue information.