Configure API Service Graph Connector for Apigee X using the guided setup
Set up scheduled import jobs to pull in Apigee X data into your CMDB.
Antes de Iniciar
- The Integration Commons for CMDB store app, which is automatically installed. See Integration Commons for CMDB.
- The CMDB CI class models store app, which is automatically installed. See CMDB CI Class Models app.
- The ITOM Discovery License plugin (com.snc.itom.discovery.license). You must activate this plugin.
- ITOM Licensing plugin (com.snc.itom.license). See Request Discovery.
Role required: admin
Procedimento
-
Verify that the application scope is set to the API Service Graph Connector for Apigee X application by using the application picker.
For more information, see Application picker.
- Navigate to All > Service Graph Connectors > Apigee X > Setup.
- On the API Service Graph Connector for Apigee X page, select Continue.
-
Configure the authentication credentials to send requests to the Apigee X application.
- In the Configure the Connection and Credentials section of the API Service Graph Connector for Apigee X page, select Start.
-
Grant the attachment update permission so that the API Frontend Backend data source can retrieve files from Apigee X and attach them to records.
- Select the Update Attachment Access task.
- Select the Global application scope from the application picker.
- On the Application Access related list of the Attachment subpage, select the Can update check box, and then select Update.
- Select the API Service Graph Connector for Apigee X application scope from the application picker.
- Set the Update Attachment Access task to complete by selecting the Mark as complete check box and then select Continue.
-
Set up the Apigee X environment and create a Java KeyStore (JKS) certificate to encrypt the security certificates obtained from an Apigee X application.
- Select the Apigee X Setup Instructions task.
- Review and complete the setup instructions on the API Service Graph connector for Apigee X - Setup Instructions [KBB0010364] article in the Now Support Knowledge Base.
Make a note of the destination keystore password. You need to specify this password while importing the JKS certificate into the API Service Graph Connector for Apigee X application.
- Set the Apigee X Setup Instructions task to complete by selecting the Mark as complete check box and then select Continue.
-
Create an X.509 certificate to associate the Java KeyStore (JKS) certificate for the Apigee X application with the connector.
- Select the Create X.509 certificate task.
- Select New.
- On the form, fill in the fields.
Tabela 1. X.509 Certificate form Field Description Name Name of the X.509 certificate. For example, SGA-ApigeeX-509Certificate.Notify on expiration Users to be notified when the certificate expires. If no users are selected, the logged-in user is added by default, along with the last two logged-in users with the administrator role. Warn in days to expire Number of days to send a notification before the certificate expires. Active Option to activate the certificate. Type Certificate container that is automatically set to Java Key Store. Leave the field value set to Java Key Store. Expires in days Number of days until the certificate expires. Key store password Password to access the JKS certificate as noted down in the previous step. Short description Description of the X.509 certificate. - Select the manage attachments icon (
).
- Select Choose file to browse and upload the keystore.p12 file for the JKS certificate you created in step 4.c.
- Close the dialog box.
- Select the Validate Stores/Certificates related link.
- On successful validation, select Update to return to the guided setup page.
- Set the Create X.509 certificate task to complete by selecting the Mark as complete check box and then select Continue.
-
Configure the connection.
- Verify that the application scope is set to the API Service Graph Connector for Apigee X application by using the application picker.
- Select the Configure the Connection task.
- Select Click Here to open the Connections page in a separate browser tab.
- Search for and select Edit for SGA Apigee X Connection.
- In the Connection Information section of the Edit Connection window, fill in the fields.
Tabela 2. Connection Information Field Description Connection name Name to identify the Apigee X connection record. SGA Apigee X Connectionis the default credential alias name. You can add multiple Apigee X instances. However, try not to modify the default connection name. - In the Credential Information section of the Edit Connection window, fill in the fields.
Tabela 3. Credential Information Field Description Service account email Email address associated with the ServiceNow service account used for authentication with Apigee X as noted in the Before you begin section. X.509 certificate X.509 certificate created in step 4.d. Keystore Password Password associated with the keystore as noted in the Before you begin section. - In the Additional Information section of the Edit Connection window, fill in the fields.
Tabela 4. Additional Information Project ID Project identifier within the Apigee X environment that the connection will be linked to Organization ID Organization within the Apigee X system to which the project belongs. - Select Edit and Get OAuth Token.
- Select Update.
- When the OAuth token flow is successfully completed, return to the guided setup page and set the Configure the Connection task to complete by selecting the Mark as complete check box and then select Continue.
-
Configure properties of the connector to access resources.
- Select the Add configuration properties task.
- In the Service Graph Connection Properties related list, enter the values for the properties.
Tabela 5. Service Graph Connection Properties Property Description Collect usage data Enable usage data collection to retrieve API usage data over a specified duration. CollectionPeriod (in days) Duration in days for collecting API usage data. Discovery scope Discovery scope of the Apigee X application. The available options are: - Organization
- Select Organization when the ServiceNow service account has access to data within the Apigee X organization.
- Projects
- Select Projects when the ServiceNow service account has access to data within Apigee X projects only.
Expand HTTP method types Method types to consider for routes that allow all HTTP methods ( GET,POST,PUT,PATCH,DELETE,OPTIONS,HEAD,CONNECT,TRACE).For multiple methods, separate them with commas. If left blank, results in a single API Frontend being created with the
ALLmethod, indicating support for all standard HTTP methods.Exclude Environments Apigee X environments that should be excluded from the connection. For multiple environments, separate them with commas. All gateways except those listed in the Exclude Environments property are fetched.
Include Environments Apigee X environments to include in the connection. For multiple environments, separate them with commas. Only API proxies in the environments listed in the Include environments property are imported.
If you leave this field empty, the data sources within the connector import API proxies from all environments.
Organization ID Organization within the Apigee X system to which the project belongs. Page size Number of records per page. Default is 100, minimum is2.Partition size Partition size for Apigee X managed APIs if parallel loading is enabled. Accepts a numeric value greater than zero. If left empty, the value is automatically calculated.
Project ID Project identifier within the Apigee X environment that the connection will be linked to. For multiple project IDs, separate them with commas.
Dica:To enter a property value, double-click (or use the keyboard shortcut) to enter a value in the Value cell for the property. - Set the Add configuration properties task to complete by selecting the Mark as complete check box and then select Continue.
-
Test the connection.
- Select the Test Connection task.
- Test the connection by selecting the Test Connection related link.
Testing the connection might take a few moments. The page is refreshed to show the test results.
- When the Status field is set to Success, select Update.
If any of the tests have errors, follow the suggestions for remediation.
- Set the Test Connection task to complete by selecting the Mark as complete check box and then select Continue.
- Opcional:
Integrate with multiple Apigee X instances.
- In the Add Multiple Instances section of the API Service Graph Connector for Apigee X page, select Start.
-
Enable creating data sources for the new Apigee X connection.
- Verify that you have edit permissions for the Datasource [sys_data_source] table.
- Select the Update Data Source Access task.
- To edit the record, select the Global application scope from the application picker.
- In the Application Access related list of the Data Source form that opens in another tab, select the Can create, Can update, and Can delete check boxes.
- Select Update.
- From the application picker, select the API Service Graph Connector for Apigee X application scope.
- Set the Update Data Source Access task to complete by selecting the Mark as complete check box and then select Continue.
-
Enable creating a scheduled import job for the new Apigee X connection.
- Ensure that you have edit permissions for the Scheduled data import [scheduled_import_set] table.
- Select the Update Scheduled Data Import Access task.
- To edit the record, select the Global application scope from the application picker.
- In the Application Access related list of the Scheduled Data Import form, select the Can create, Can update, and Can delete check boxes.
- Select Update.
- From the application picker, select the API Service Graph Connector for Apigee X application scope.
- Set the Update Scheduled Data Import Access task to complete by selecting the Mark as complete check box and then select Continue.
-
Clear the cache on the Data Source [sys_data_source] and Scheduled Data Imports [scheduled_import_set] tables.
- Select the Clear Cache for Data Source and Scheduled Data Imports tables task.
- In the Run script text box of the background script page, enter the following script:
GlideTableManager.invalidateTable("sys_data_source"); GlideCacheManager.flushTable("sys_data_source"); GlideTableManager.invalidateTable("scheduled_import_set"); GlideCacheManager.flushTable("scheduled_import_set"); GlideTableManager.invalidateTable("sys_db_object"); GlideCacheManager.flushTable("sys_db_object"); GlideTableManager.invalidateTable("sys_attachment"); GlideCacheManager.flushTable("sys_attachment"); - Select Run Script to run the background script in the global scope.
The script may take several minutes to execute.
- After the script is executed, select Close.
- From the application picker, select the API Service Graph Connector for Apigee X application scope.
- Set the Clear Cache for Data Source and Scheduled Data Imports tables task to complete by selecting Mark as complete.
- To create an X.509 certificate for the new Apigee X instance, repeat step 4.d, and then mark the Create X.509 certificate task to complete by selecting Mark as complete.
-
Add another connection for the new Apigee X instance.
- Verify that the application scope is set to the API Service Graph Connector for Apigee X application by using the application picker.
- Select the Add Another Connection task and then select Click Here.
- On the Connections page that opens in another browser tab, select Add Connection.
- In the Create Connection window, fill in the connection, service account, and keystore details including keystore password.
You created the keystore in step 5.e.
- Select Create and Get OAuth Token.
- Close the Connections page and return to the guided setup page tab.
- Set the Add Another Connection task to complete by selecting the Mark as complete check box and then select Continue.
-
Add properties for the new connection.
- Verify that the application scope is set to the API Service Graph Connector for Apigee X application by using the application picker.
- Select the Add configuration properties task.
- From the Name column, select the connection name you created in step 5.f.
- In the Service Graph Connection Properties related list, enter the values for the properties.
For more information on properties, see 4.f.ii.
Dica:To enter a property value, double-click (or use the keyboard shortcut) to enter a value in the Value cell for the property. - Set the Add configuration properties task to complete by selecting the Mark as complete check box and then select Continue.
-
Test the new connection.
- Select the Test New Connections task.
- From the Name column, select the connection name you created in step 5.f.
- Test the connection by selecting the Test Connection related link.
Testing the connection might take a few moments. The page is refreshed to show the test results.
- When the Status field is set to Success, select Update.
If any of the tests have errors, follow the suggestions for remediation.
- Set the Test New Connections task to complete by selecting the Mark as complete check box and then select Continue.
-
Configure the scheduled job for the import of Apigee X data.
- In the Set up Scheduled Import Jobs section of the API Service Graph Connector for Apigee X page, select Start.
-
Select the Organization scheduled job.
For a multiple instance setup, select the scheduled import created with the connection in step 5.f.
-
On the Scheduled Data Import form, verify the field values.
For more information, see Schedule a data import.
- Select the Active check box to activate the scheduled job.
- In the Run field, select Periodically to specify how often the job will run.
- Select Update.
- Set the Set up Scheduled Import Jobs task to complete by selecting the Mark as complete check box and then select Continue.
- On the API Service Graph Connector for Apigee X page, select Complete to save your changes.
- In the Complete setup dialog box, select Complete to complete the setup.
- In the message box that appears, select Done.