Register applications with the Command Automation Interface

As shipped, Task Management System, Change Management, Incident Management, and Service Request Management are registered with Command Automation Interface (CAI). CAI allows users to integrate with applications that can be used to carry out tasks automatically. If you are integrating Task Management System with custom AR System applications, you must register the application in the Command Automation Interface Application Registry form. Use this form to register the applications that are used with the CAI, and to identify key elements of the backend application, such as template forms, interface forms, and instance forms.

The registry entry in the Application Registry form enables Task Management System to recognize the backend application; set the configuration settings, such as mode of connection (local or remote), server, and template information; and use this information to set the context for the remainder of the Task Management System 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 Task Management System with other external applications.

For more information, see Registering the application with the CAI  in the BMC Helix ITSM online documentation.

To configure a return code value

You can use the Return Code Configuration form to set up return code values between any application registered in CAI and the Task form. Configuring return codes allows you to specify the values a task's status and status reason should be when a particular return code is received from another application.

You map the status and status reason on the Task form when the application returns the specific return code value. For example, a return code value of Error could mean that the Task form has a status of Pending and a status reason of Error. The Return Code Value field is hidden on the Task form.

From the Task form, a task is initiated. After the task is complete, the task uses the TMS_TaskInterface web service to send a return code value to the Task form. This return code value causes the Task form to query the Return Code Configuration form to determine the specified Status and Status Reason values to use for the particular return code value.

1. On the IT Home page, click the Application Administration Console link.
2. On the Application Administration Console, click the Custom Configuration tab.
3. From the Application Settings list, select Task Management System > Integration > Return Code Configuration, and then click Open.
4. To view a list of preconfigured return codes on Return Code Configuration form, click the New Search toolbar button, enter any search parameters, and then click Search.
5. In the list of pre configured values. do any of the following steps:
   • Select an entry to view it and modify it, if necessary.
   • Click the New Request button on the toolbar, and configure new values.

6. Modify or enter values in the following fields:

   Field Name	Description
   Application Name	The application that returns the value.
   Return Code Value	A value in the Return Code Value field. For example, Success, Error, Failure.
   Form	This field is set to TMS:Task.
   Type	A runtime task type; for example, Manual, Automatic, or ALL. Select ALL if the return code applies to both types.
   Form Status	A value for the status of the Task form when the specified return code value is returned. For example, Closed.
   Form Status Reason	A value for the status reason of the Task form when the specified return code value is returned. For example, Success.
   Status	An overall status for this entry. The options are Active, Inactive, or Proposed.

7. Click Save.