Manual Installation

Manually install the Cloudaware CMDB application in ServiceNow using the XML update set provided by Cloudaware, then configure ServiceNow to import Cloudaware CMDB data from the Cloudaware-provided Google BigQuery export.

Use this installation path when the Cloudaware CMDB application is not installed from the ServiceNow Store.

High-Level Setup Flow

To complete the manual installation:

1. Get the ServiceNow-to-Google credentials from Cloudaware Support.
2. Get the Cloudaware CMDB application XML installation file from Cloudaware Support.
3. Configure JWT-based authorization in ServiceNow.
4. Import and commit the XML update set.
5. Configure and activate the Workflow Studio import flow.
6. Verify that Cloudaware data is loaded into ServiceNow.

Prerequisites

Before you begin, make sure you have:

• ServiceNow administrator access.
• ServiceNow IntegrationHub Enterprise Pack activated.
• ServiceNow Workflow Studio installed.
• Permission to import and commit retrieved update sets.
• Cloudaware CMDB application XML installation file.
• Cloudaware-provided credentials:
  • Service account email address
  • Service account private key
  • .p12 certificate file
  • Project ID
  • Dataset ID

To request the credentials and XML installation file, contact Cloudaware Support at support@cloudaware.com.

Configure ServiceNow-to-Google Authorization

Cloudaware provides the credentials required for ServiceNow to authenticate to Google and read Cloudaware export data. Configure the connection before setting up the import workflow.

Create a JWT Key and Certificate

1. In ServiceNow, go to All → System OAuth → JWT Keys.
2. Click New.
3. Fill out the JWT key form:
   • Name: Enter a meaningful name, for example, Google JWT Key.
   • Signing Key: Enter notasecret.
   • Signing Keystore: Click the lookup icon to create a signing keystore.
4. In the keystore pop-up, click New.
5. Fill out the JWT certificate form:
   • Name: Enter a meaningful name, for example, Google JWT Certificate.
   • Type: Select Java Key Store.
   • Key store password: Enter notasecret.
6. Click the paperclip icon and attach the .p12 certificate file provided by Cloudaware.
7. Click Submit.
8. Return to the JWT key form.
9. For Signing Keystore, select the certificate you created.
10. Click Submit.

Configure the JWT Provider

1. Go to All → System OAuth → JWT Providers.
2. Click New.
3. Fill out the JWT provider form:
   • Name: Enter a meaningful name, for example, Google JWT Provider.
   • Signing Configuration: Select the JWT key you created.
4. Save the provider.
5. Open the provider record.
6. Select the Standard Claims tab.
7. Add the following claims:

Claim	Type	Value
iss	String	Service account email address provided by Cloudaware
sub	String	Service account email address provided by Cloudaware
aud	String	https://oauth2.googleapis.com/token

1. Click Update.

Configure the OAuth Application Registry

1. Go to All → System OAuth → Application Registry.
2. Click New.
3. Select Connect to a third party OAuth Provider.
4. Fill out the form:

Field	Value
Name	A meaningful name, for example, Google JWT
Client ID	notneeded
Client secret	notneeded
Default grant type	JWT Bearer
Token	https://oauth2.googleapis.com/token
Refresh Token Lifespan	10

1. Click Submit.
2. Open the generated OAuth entity profile, for example, Google JWT default_profile.
3. For JWT Provider, select the JWT provider you created.
4. Click Update.

Add the BigQuery OAuth Scope

1. Go back to All → System OAuth → JWT Providers.
2. Open the JWT provider you created.
3. Select the Custom Claims tab.
4. Add the following claim:

Claim	Type	Value
scope	String	https://www.googleapis.com/auth/bigquery.readonly

1. Click Update.

Configure Credentials and Connection Alias

1. Go to All → Connections & Credentials → Credentials.

2. Click New.

3. Select Auth 2.0 Credentials.

4. Fill out the form:

   • Name: Enter a meaningful name, for example, Google JWT Credentials.
   • OAuth Entity Profile: Select the OAuth entity profile created earlier.

5. Click Update.

6. Click Get OAuth Token to test the connection.

7. Go to All → Connections & Credentials Aliases.

8. Click New.

9. Set the alias to Google JWT.

10. Save the alias.

11. In the alias record, create a new HTTP(S) connection.

12. Fill out the connection form:

    • Name: Enter a meaningful name, for example, Google JWT Connection.
    • Credential: Select Google JWT Credentials.
    • URL builder: Select this checkbox.
    • Host: Enter bigquery.googleapis.com.

13. Click Submit.

Install the Cloudaware CMDB Application

Import the Cloudaware XML update set into ServiceNow and commit it to install the application.

1. In ServiceNow, go to All → Retrieved Update Sets.
2. Click Import Update Set from XML.
3. Choose the Cloudaware CMDB application .xml file provided by Cloudaware.
4. Click Upload.
5. Open the created update set.
6. Click Preview Update Set.
7. Review the preview results and resolve any preview issues required by ServiceNow.
8. Click Commit Update Set to install the application.
9. Allow time for ServiceNow to create the application and related tables.

warning

Commit the update set only after previewing it and confirming that any required preview actions are resolved according to your ServiceNow change process.

Configure the Import Workflow

Configure Workflow Studio to populate the Cloudaware import settings and run the scheduled CI import.

1. Go to All → Workflow Studio.
2. Open Flows.
3. Select Update Import Settings and Fields Mapping.
4. Click Test → Run test.

note

Run Update Import Settings and Fields Mapping once after installation. This prepares the import settings and field mapping records used by the data import workflow.

1. Return to the list of flows.
2. Sort the list by Updated in descending order.
3. Open Import All CI Data from Cloudaware.
4. In Trigger, configure a scheduled trigger.
5. Select Scheduled.
6. Set the schedule to run daily at the preferred time.

tip

The recommended import frequency is once per day unless Cloudaware Support provides different guidance for your environment.

1. In Actions, open Set Flow Variables.
2. Set the required variables:

Variable	Value
Connection Alias	The connection alias configured earlier, for example, Google JWT
Cloudaware Import Settings Table	Use the auto-populated system table value
Cloudaware Import Fields Mapping Table	Use the auto-populated system table value
Project Id	Import Project ID provided by Cloudaware
Dataset Id	Import Dataset ID provided by Cloudaware

1. Click Done.
2. Save and activate the workflow.
3. Allow time for the first import to complete.

Created Tables

The application creates system tables for import configuration and application tables for Cloudaware CI data.

System Tables

Label	Table name
Cloudaware CI	x_ca_cmdb_ci
Cloudaware CMDB Schema	x_ca_cmdb_schema
CI Class Import	x_ca_cmdb_ci_class_import
Cloudaware Import Settings	x_ca_cmdb_ci_class_import_settings
Cloudaware Import Fields Mapping	x_ca_cmdb_import_fields_mapping

Application Tables

Label	Table name
AWS Account	x_ca_cmdb_aws_account
AWS DynamoDB Backup	x_ca_cmdb_aws_dynamo_db_backup
AWS DynamoDB Table	x_ca_cmdb_aws_dynamo_db_table
AWS EBS Snapshot	x_ca_cmdb_aws_snapshot
AWS EBS Volume	x_ca_cmdb_aws_volume
AWS EC2 Image	x_ca_cmdb_aws_image
AWS EC2 Instance	x_ca_cmdb_aws_instance
AWS EC2 Security Group	x_ca_cmdb_aws_security_group
AWS ELB Load Balancer	x_ca_cmdb_aws_load_balancer
AWS ElastiCache Cluster	x_ca_cmdb_aws_cache_cluster
AWS ElastiCache Node	x_ca_cmdb_aws_cache_node
AWS Lambda Function	x_ca_cmdb_aws_lambda_function
AWS RDS Cluster	x_ca_cmdb_aws_db_cluster
AWS RDS Instance	x_ca_cmdb_aws_db_instance
AWS Redshift Cluster	x_ca_cmdb_aws_redshift_cluster
AWS S3 Bucket	x_ca_cmdb_aws_bucket

note

To disable imports for a specific application table, open Cloudaware Import Settings (x_ca_cmdb_ci_class_import_settings) and set Active to False for the corresponding class. Data for inactive tables is not imported.

Verify Data Upload Status

After the workflow runs, verify the import status in the Cloudaware Import Settings table.

Open the following URL in the ServiceNow instance:

https://YOURINSTANCE.service-now.com/x_ca_cmdb_ci_class_import_settings.do

Replace YOURINSTANCE with the ServiceNow instance ID.

Troubleshooting

Update Set Preview Fails

• Review the preview problems listed by ServiceNow before committing the update set.
• Confirm that the XML file is the Cloudaware CMDB application installation file provided by Cloudaware.
• Confirm that the ServiceNow user has permission to import and commit retrieved update sets.

OAuth Token Cannot Be Retrieved

• Confirm that the .p12 certificate from Cloudaware is attached to the JWT certificate record.
• Confirm that the JWT key uses the certificate as the signing keystore.
• Confirm that the iss and sub standard claims use the service account email address provided by Cloudaware.
• Confirm that the aud claim and OAuth token endpoint are set to https://oauth2.googleapis.com/token.
• Confirm that the custom scope claim is set to https://www.googleapis.com/auth/bigquery.readonly.

Workflow Runs but No Data Is Imported

• Confirm that the Import All CI Data from Cloudaware flow is active.
• Confirm that the flow variables use the correct connection alias, Project ID, and Dataset ID.
• Confirm that the Update Import Settings and Fields Mapping flow was tested once after installation.
• Review Cloudaware Import Settings and confirm that the target CI classes are active.

Still stuck? Contact Cloudaware Support at support@cloudaware.com with the ServiceNow instance name, update set name, connection alias name, Project ID, Dataset ID, and the latest workflow execution details.

Related

• Cloudaware CMDB Application
• Installation from ServiceNow Store