Configure API Service Graph Connector for MuleSoft using SGC Central

Set up scheduled import jobs to pull in MuleSoft Anypoint Platform data into your CMDB.

Before you begin

Install API Service Graph Connector for MuleSoft version 1.0.0 or later from the ServiceNow Store. For ServiceNow Store installation steps, see Install a ServiceNow Store application.

Obtain the Connected App credentials from your MuleSoft Anypoint Platform administrator. Make a note of the following details:

• Client ID: The unique identifier for your Connected App.
• Client Secret: The secret key for authenticating your Connected App.
• Directory (tenant) ID: The MuleSoft organization identifier from which data is imported.

For more information on connector setup, see the API Service Graph connector for MuleSoft - Setup Instructions [KB2560348] article in the Now Support Knowledge Base.

Role required: The following table shows the roles required for each stage of the playbook.

Table 1. Role required for each playbook stage

Stage	Role
Prerequisites	admin
Setup	SGC-Admin (sn_cmdb_int_util.sgc_admin) or admin

Note:

The admin user role is required to run background scripts and to provide access to global tables to the SGC-Admin user. For information about the user roles for Service Graph Connectors, see Service Graph Connector user roles.

About this task

The playbook experience for onboarding connectors is activated with SGC Central in the CMDB Workspace. To configure the SGC Central application, see Configuring SGC Central and for more information on how to interact with a playbook, see Interact with Playbook.

Note:

Alternatively, you can configure a default connection already available from the installed or draft connections in SGC Central. Go to All > Service Graph Connectors, then select Setup for the connector from the menu. To learn about installed and draft connections, see Managing connections added for Service Graph Connectors in SGC Central.

Procedure

1. Navigate to Workspaces > CMDB Workspace.
2. In the CMDB Workspace, select SGC Central.
3. On the Overview page, select Create connection.
   Tip:

   Alternatively, you can select Create connection on the All connections page.
4. On the Create connection window, select the MuleSoft connector type, and then select Create connection.
5. Complete the initial prerequisites when setting up a connection for the first time using a connector.
   Note:

   This step is required only during the first-time setup. See Perform initial setup tasks when creating a connection in SGC Central.
6. Enter connection details and test the API connection for importing MuleSoft data.
   1. In the Setup stage of the playbook, select the Create and test connection activity.
   2. On the form, fill in the fields.

      Table 2. Create and test connection form

      Field	Description
      Connection name	Name to identify the MuleSoft connection record. For example, MuleSoft connection.
      Connection URL	Base URL to connect to the MuleSoft Anypoint Platform API service. Note: This field is automatically set to the URL to connect to the application. Leave the field value as is.
      OAuth client ID	Client ID of your MuleSoft Connected App as noted in the Before you begin section.
      OAuth Client Secret	Client secret of the MuleSoft Connected App as noted in the Before you begin section.
      OAuth Token URL	Token endpoint URL used to securely authenticate your identity and authorize access to your MuleSoft Anypoint Platform API account via the API.

   3. Select Create and test connection.
   4. Once the connection test is complete, select Continue.
7. Set the configuration properties for the connection.
   1. In the Setup stage of the playbook, select the Set configuration properties activity.
   2. Fill in the property details.

      Table 3. MuleSoft configuration properties

      Property	Description
      Data retrieval configuration
      Organization id	MuleSoft organization identifier from which API data is imported. If you have multiple organizations, create separate connections for each. For multiple organizations, create separate connections for each.
      Environment filter	MuleSoft environments to include in the connection. For multiple environments, separate them with commas. Only API proxies in the environments listed in the Environment filter property are imported. If you leave this field empty, the data sources within the connector import API proxies from all environments.
      API Manager filter	API manager instance status filter. Accepts a single value: active, inactive, or unregistered. When specified, only APIs matching that status are imported. If you leave this field empty, all APIs are imported regardless of status.
      Only deployed API managers	Option to import only APIs currently deployed to runtime instances.
      Import deployed applications	Option to collect deployed applications from runtime manager as Data Service Instances.
      Collection period (in days)	Duration in days for collecting API usage data.
      Collect usage data	Option to enable usage data collection to retrieve API usage metrics over a specified duration.
      Tags settings
      Import tags	Option to ingest tags from the MuleSoft API Manager.
      Tag key/value indicator	Separator for key and value in tags.

   3. Select Continue.
8. Configure the import schedule to import data at regular intervals.
   1. In the Setup stage of the playbook, select the Configure import schedule activity.
   2. Expand the Parent scheduled data import within the Import schedules list to select the Gateway import schedule associated with your connection.
      Note:

      The connection name is prefixed to the schedule name.
   3. In the Configure import schedule dialog box, select the Active check box, and then fill in the run schedule and time details.

      For more information, see Schedule a data import.

   4. Select Save.
      Alternatively, select Execute Now to execute the import schedule immediately.
   5. Select Continue.
9. In the Setup stage of the playbook, select the Confirm connection creation activity to verify whether the connection was created.

What to do next

Select View all connections to review the connection details. The created connection appears in the Installed connections list.

You can then manage connections from the SGC Central view of the CMDB Workspace. For more information, see Managing connections added for Service Graph Connectors in SGC Central.