Defining a Configuration for the AE Connection

As a CA service delivery administrator, you need to define a configuration for the connection to the Automation Engine (AE) in CA Service Catalog. This connection will be used by the Java API that sends service requests to the AE to be processed in a automated Workflow.

This page includes the following:

Important to Know

To help you prepare the configuration, you should know the following about it:

Sample to import: The plug‑in package contains a sample configuration form with all the required fields. Import this file as a starting point rather than creating a configuring from scratch.
Configuration contents: The configuration includes the connection parameters to the AE, for example, the AE authentication details. You just have to provide the specific values.
One per AE instance and Client: You need one connection definition for each AE instance and Client that your service requests will be sent to.
For example, you might have different instances for different environments (Development, testing, production). On some instance, you might have more than one AE Client that different types of service requests are sent to.
Restrict from end users: You must restrict this configuration form to ensure that end users cannot change the parameter values.

Importing the Sample Configuration Form

You do not have to configure the connection form from scratch. Just import the sample form that is provided with the plug‑in package. Then modify the values in the fields. This saves you time and avoids errors.

Use the following steps to import the sample configuration form:

Login to CA Service Catalog as an Administrator.
Go to Administration, Tools.
From the Menu in the left sidebar, click Import Export Utility.
In the main part of the screen, define your import action:
- Action: Import
- Object Type: Form
- Quick Import: selected
- For File, click the Browse button and locate the connection_configuration_form_template.xml file to import.
  This is in the folder where you downloaded and unzipped the plug‑in package. For more information, see Installing and Configuring the CA Service Catalog Plug‑in.
Click the Start Import button.

After the import completes, update the connection values. For instructions, see Configuring the AE Connection.

Configuring the AE Connection

You need to do this once for every AE instance and Client that you will send service requests to.

Prerequisites:

You have imported the sample form that is provided with the plug‑in package as described in Importing the Sample Configuration Form.
You have the configuration values for the AEinstance and client. Get these from the AE team.

For full details about working with forms in CA Service Catalog, see the section "Create and Customize a Form" under "Service Catalog Management" in the "Using" part of the documentation for CA Service Management. You can find all CA documentation over https://docops.ca.com/home.

Login to CA Service Catalog as an administrator.
Open the connection form.
1. Go to Catalog, then Configuration.
2. In the left sidebar, click Content Configuration and then the AE Connection Details form.
  The form fields appear in the main area of the screen and the form attributes in the right sidebar.
3. Ensure that the _id attribute for the form is unique in your business unit. If it is not, change it. Otherwise, you will get unpredictable results. The default _id is ae_connection_config.
Update the values in the fields for the AE instance and your connection.
- Base URL: The location of the AE instance
- Client ID, Username, Department, Password: The authentication details for the AE login
- API Version: The version number of the REST API component on the AE
- CASC Username, CASC Password: The authentication information that the AE can use to update the request with notes and update the request status.
  Note: If the request cannot be processed, a note is added to the request with an error message about the problem. This can be, for example, because the host is not available or parameter values are invalid.
Warning: Do not change the attribute definitions for any of the fields. These contain essential information for the connection API.
Click Save in the menu bar.
(Recommended) Restrict the form so end users cannot edit the values.
1. Go to Catalog, then Service Offerings.
2. In the right sidebar on the Offerings tab, click the AE Connection Details form.
3. In the main part of the screen, go to the Permissions tab.
4. Select the Roles and/or Groups that are allowed to edit this form.

Adding Another AE Connection

If your service requests need to be processed on different AE instances or different Clients, for example, for different environments (development, testing, production), you need to configure multiple AE connections. Use the steps that follow to copy and existing configuration and modify it as needed.

Prerequisite: You have defined one AE Connection Details form as described above in Configuring the AE Connection.

Log into CA Service Catalog as an administrator.
Go to Catalog, then Forms.
In the left sidebar, click Forms and then find an existing connection configuration form, such as AE Connection Details.
Right click the form name and select Copy from the context menu.
Right click the folder where you want to put the new form, for example, the Forms folder, and select Paste from the context menu.
Right click the copy of the form, select Rename from the context menu, and enter a new name for the form.
The form fields appear in the main area of the screen and the form attributes in the right sidebar.
Change the _id attribute for the copied form to a value that is unique within your business unit. Otherwise, you will have unpredictable results.
Update the values in the fields with the values for the AE instance and your environment. For more information, see the steps above in Configuring the AE Connection.
Click Save in the menu bar.