Integrating DX Operational Intelligence

As a system administrator you install and configure all components relevant for the integration of DX Operational Intelligence and your Automic Automation system. This integration is available only for Automic Automation systems with PostgreSQL or Oracle databases.

This page includes the following:

Prerequisites

First, you have to install the DX Platform. For more information please refer to the official DX Platform documentation, see DX Platform on Premise.

Important! While setting up DX Operational Intelligence, make sure your TENANT_ID uses only uppercase, as the Automic Automation system requires it later on. If the TENANT_ID in DX Operational Intelligence and Automic Automation do not match, single sign-on fails.

Next, you have to install the Automic Automation. You can download it from our download center at https://downloads.automic.com/. For more information, see Installing Automic Automation.

Important!

Use a dedicated Automic Automation system for this integration and not the system you have in place.
For the integration with DX Operational Intelligence SaaS, the REST API must use port 443. Make sure you change the default port configuration for the REST process in the INI file of the Automation Engine to 443, see Automation Engine INI file.

Also, you can redirect the login from the Automic Automation login mask to the DX Operational Intelligence login page and vice versa by creating environment variables in your OS:

UC_AIOPS_LOGIN_ENABLED: This environment variable enables the login from DX Operational Intelligence to Automic Automation. It also allows you to display the AIOPS login type in the Automic Automation login mask, which is necessary for redirecting the login from Automic Automation to DX Operational Intelligence.

Value: Set the environment variable to Y or TRUE (not case sensitive) to enable the login type it in Automic Automation.
UC_AIOPS_LOGIN_URL: This environment variable stores the relevant path (URL) for the redirect functionality from the Automic Automation login mask to the DX Operational Intelligence login page.

Value: Path (URL) to the DX Operational Intelligence login page

Examples

URL for DX Operational Intelligence on-prem:

http(s)://adminui.<hostname or IP>.nip.io/sppclient/#/login

URL for DX Operational Intelligence SaaS:

https://axa.dxi-na1.saas.broadcom.com/sppclient/#/login

Note: You have to restart the Automic Web Interface when an environment variable is set or modified. For more information, see Login.

Configuring Automic Automation for the Integration

There are a number of files relevant for the integration:

UC_AIOPS_SETTINGS.xml
USRG_PU.xml
USRG_TA.xml
USRG_UZ.xml
WELCOME.DASHBOARD.AIOPS.xml

These files contain the UC_AIOPS_SETTINGS variable, which allows you to configure the integration, as well as the UserGroup definition required for mapping Users later on. The offering also includes the AIOps_SampleWorkflows.xml file which contains a number of pre-configured Workflows that solve some of the most common issues.

These files are located in the AiOps.Extensions folder delivered with the offering. You can import them from the Automic Web Interface.

More information:

Note: You need a dedicated Client and User for the integration. These credentials are used when configuring DX Operational Intelligence for the integration. In this section, Client 100 and User AUTOMIC are used as examples.

To Configure Automic Automation for the Integration

In Client 0, open the Process Assembly perspective, select the folder you want to use and import the files listed below, see Importing/Exporting Objects
- UC_AIOPS_SETTINGS.xml
- USRG_PU.xml
- USRG_TA.xml
- USRG_UZ.xml
The WELCOME.DASHBOARD.AIOPS.xml file cannot be imported into Client 0. You have to import it later on into the Client you use for the integration.
Open the UC_AIOPS_SETTINGS variable and enter the TENANT_ID of the DX Operational Intelligence tenant used for the integration, see UC_AIOPS_SETTINGS - Integrating DX Operational Intelligence.

Important! Make sure the TENANT_ID uses only uppercase.
Create Client 100, see Clients.

The imported variable and UserGroups are visible only in Client 0 but are used in Client 100. The system first checks if they are available in the current client. If not, the system checks in Client 0 and uses that definition.
Create a User for the integration in Client 100, see Users (USER).
Log into Client 100 with the User you just created.
Open the Process Assembly perspective and import the WELCOME.DASHBOARD.AIOPS.xml file, see Importing/Exporting Objects.
Still in the Process Assembly perspective, import the xml file with the sample remediation Workflows.

Make sure that the folder you use to import the sample Workflows is the one you define in the location parameter when configuring DX Operational Intelligence for the integration, see Configuring DX Operational Intelligence for the Integration. For example, if you define "location": "/AIOPS", use the AIOPS folder in the Explorer (Process Assembly).
In Client 0, set the GENERATE_UNDEFINED_SCRIPT_VARS parameter in the UC_SYSTEM_SETTINGS to YES, see GENERATE_UNDEFINED_SCRIPT_VARS.

This allows the system to process the sample remediation Workflows. If the parameter is not set to YES, the sample Workflows fail and an error message is returned.
Open the UC_AIOPS_SETTINGS variable and make sure all parameters are defined correctly:
- CLIENT: 100
- ESS_REST_URL: DX Operational Intelligence security endpoint
  
  Examples
  
  Security endpoint for DX Operational Intelligence on-prem:
  
  http://adminui.<hostname>.nip.io/ess/security/v1/me
  
  Security endpoint for DX Operational Intelligence SaaS:
  
  https://axa.dxi-na1.saas.broadcom.com/ess/security/v1/me
- ROLE_PU: USRG_PU
- ROLE_TA: USRG_TA
- ROLE_UZ: USRG_UZ
- TENANT_ID: ID of the tenant used for the integration
  
  Important! Make sure the TENANT_ID definition in DX Operational Intelligence uses only uppercase.
For more information, see UC_AIOPS_SETTINGS - Integrating DX Operational Intelligence.

Configuring DX Operational Intelligence for the Integration

You have to be a Tenant Administrator to configure DX Operational Intelligence for the integration with Automic Automation.

DX Operational Intelligence must be able to call the REST endpoint of the Automic Automation. The REST server process must be running in your Automic Automation system. For more information, see Types of Server Processes.

Important! Once DX Operational Intelligence and Automic Automation can communicate through the REST API, you can use this connection and the remediation Workflows without having to log into Automic Automation. However, you do require an Automic Automation User with the relevant rights to define the UC_AIOPS_SETTINGS variable and the folder location used for the remediation Workflows in Automic Automation. Otherwise, the integration does not work properly.

To Configure DX Operational Intelligence for the Integration

Access Automic Intelligent Remediation, see Accessing Automic Intelligent Remediation.
Open the Settings page and select Automation in the External connections / integrations section.
Make sure the integration is enabled and define the following parameters:
- Name: AUTOMIC
- Automation platform type: AUTOMIC
- API URL: AE REST API URL
  
  Points to the URL of the Automation Engine REST API
- Console URL: AWI URL
  
  Point to the URL of the Automic Web Interface
- Username: AUTOMIC
  
  Name of the Automic Automation/REST API User (Client 100 credentials)
- Password: Enter the password
  
  Password of the Automic Automation/REST API User (Client 100 credentials)
- Client ID: 100
Select the Restrict Scope checkbox to restrict the scope of the Workflows exposed as Remediation Workflows in DX Operational Intelligence.
Activate the Advanced function and enter the relevant filter criteria to specify which payloads you want to be exposed.

Example

The following filter criteria exposes the sample remediation Workflows included for the integration:
```
{
    "filters": [
        {
            "location": "/AIOPS",
            "include_links": false,
            "include_subfolders": true,
            "filter_identifier": "location"
        },
        {
            "filter_identifier": "object_type",
            "object_types": [
                "JOBP"
            ]
        }
    ],
    "max_results": "1000"
}
```
The folder you define in the location parameter is the folder you should use when importing the sample remediation Workflows in Automic Automation. For example, if you define "location": "/AIOPS", use the AIOPS folder in the Explorer (Process Assembly).
Test your connection and once it is successful, click Save.

For more information please refer to the official DX Platform documentation, see DX Platform on Premise.