# Aviator-widget-on-boarding-tasks-for-UCMDB_688982982
## Introduction

This documents provides a sequence of tasks required for Aviator widget on-boarding on UCMDB as a reference for SaaS operations team. Follow the tasks one by one.

## Compatibility

| UCMDB | ESM SMAX | ITOM Aviator |
| --- | --- | --- |
| 25.1 | 25.1 | 25.1 |

## Task 1: Prepare ESM tenant

#### Scenario 1: Onboarding a New ESM Tenant

Steps:

1. Apply for an ESM Tenant:
- Contact the ESM Cloud Service Team to apply for an ESM tenant, which includes both SMAX and UCMDB.
3. Enable the Aviator Capability for the SMAX Tenant:
- Follow the instructions in the documentation to add the Aviator capability to the tenant([https://docs.microfocus.com/doc/SMAX/24.4/AddAviator](https://docs.microfocus.com/doc/SMAX/24.4/AddAviator))

#### Scenario 2: Existing ESM Tenant Without Aviator Capability Enabled

Steps:

1. Enable the Aviator Capability for the SMAX Tenant:
- Follow the instructions in the documentation to add the Aviator capability to the tenant([https://docs.microfocus.com/doc/SMAX/24.4/AddAviator](https://docs.microfocus.com/doc/SMAX/24.4/AddAviator))

#### Scenario 3: Existing ESM Tenant With Aviator Already Enabled, go to Task 2 directly

## Task 2: Add UCMDB AI content with SMAX Tenant Admin user (only required for 25.1)

Steps:

1. Log in SMAX agent page, go to "Administration -> Studio
2. In Dropdown list select “Aviator Models".
3. Select Tab “Import Data”, click “Browse” upload CSV file “AviatorModel\_UCMDB.csv”, import it.

[AviatorModel\_UCMDB.csv](attachments/688982982/688982971.csv)

## Task 3: Set CORS allow domain for UCMDB

Steps:

1. Log in SMAX agent page, go to "Administration -> AI Studio -> Configurations".
2. Set the base URL of UCMDB server to "Allowed origins for Aviator service", e.g. [https://cms.esmupg.itsma-ng.org](https://cms.esmupg.itsma-ng.org/))

## (Optional) Task 4: Apply to setup SSO for UCMDB and ESM

Refer to the following document to configure SAML authentication and setup SSO for UCMDB and SMAX.

[Associate SMAX tenants with UCMDB customers for Single Sign-On - Service Management Automation X](https://docs.microfocus.com/doc/SMAX/23.4/AssociateTenantCustomer)

If you skip this task, then the end users will get a popup window to enter the credentials when accessing the Aviator widget.

## Task 5: Aviator server integration with UCMDB

Add below settings for Aviator, they are all customer specific. And will take effect after re-login. Below are descriptions of settings added for Aviator.

- Mandatory:
	- aviator.host (Aviator Host Name or IP address)
		- aviator.tenant (Aviator Tenant ID)
- Optional:
	- aviator.port (Aviator Server Port, Default 443)
		- aviator.root.context (Aviator Server URL Root Context, Default ‘/’)
		- aviator.idm.auth.group (Aviator Authentication Configuration Group Name, it is required when using

Steps:

1. Use UCMDB sysadmin user login UCMDB URL: https://<UCMDB Domain Name>/jmx-console/
2. Use method setSettingValue to set "Aviator Host Name or IP address"
	1. customerID: <customer id of UCMDB> (example: 100000002)
		2. name: aviator.host
		3. value: <Aviator service host name of SMAX> (example: [eu3-smax-saas.microfocus.com](https://eu3-smax-saas.microfocus.com/))
3. Use method setSettingValue to set "Aviator Tenant ID"
	1. customerID: <customer id of UCMDB> (example: 100000002)
		2. name: aviator.tenant
		3. value: <Tenant ID of SMAX enabled aviator> (example: 1000002)

## Task6: Validate Aviator Widget in UCMDB

- The Aviator widget is shown after login to UCMDB web UI.
- User can login to Aviator widget.
- When drill down into CI detail from Inventory, CI explorer, Global Search, the CI Summary button is shown. Can summarize individual CI and its related CI
	- E.g. Go to CI explorer search for CI of node, Right click one CI and click properties, go to CI detail page. "Summarize this CI" button show and can summarize individual CI and its related CI
- User can ask ci related question using chat box, e.g. list this ci disk information

![](attachments/688982982/688982977.png)
