{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":47056,"path":"servicenow-platform/configuration-management-database-cmdb/sgcc-configure-mulesoft.md","title":"Configure API Service Graph Connector for MuleSoft using SGC Central","bundle":null,"doc_type":null,"release":"australia","body":"\n# Configure API Service Graph Connector for MuleSoft using SGC Central\n\nSet up scheduled import jobs to pull in MuleSoft Anypoint Platform data into your CMDB.\n\n## Before you begin\n\nInstall 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-administration/installing-applications-in-application-manager.md).\n\nObtain the Connected App credentials from your MuleSoft Anypoint Platform administrator. Make a note of the following details:\n\n-   Client ID: The unique identifier for your Connected App.\n-   Client Secret: The secret key for authenticating your Connected App.\n-   Directory \\(tenant\\) ID: The MuleSoft organization identifier from which data is imported.\n\nFor more information on connector setup, see the [API Service Graph connector for MuleSoft - Setup Instructions \\[KB2560348\\]](https://support.servicenow.com/kb_view.do?sysparm_article=KB2560348) article in the Now Support Knowledge Base.\n\nRole required: The following table shows the roles required for each stage of the playbook.\n\n|Stage|Role|\n|-----|----|\n|Prerequisites|admin|\n|Setup|SGC-Admin \\(sn\\_cmdb\\_int\\_util.sgc\\_admin\\) or admin|\n\n**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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/configuration-management-database-cmdb/cmdb-sgc-intro.md).\n\n## About this task\n\nThe playbook experience for onboarding connectors is activated with SGC Central in the CMDB Workspace. To configure the SGC Central application, see [Configuring SGC Central](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/sgcc-configuring.md) and for more information on how to interact with a playbook, see Interact with Playbook.\n\n**Note:** Alternatively, you can configure a default connection already available from the installed or draft connections in SGC Central. Go to **All** &gt; **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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/sgcc-managing-connection.md).\n\n## Procedure\n\n1.  Navigate to **Workspaces** &gt; **CMDB Workspace**.\n\n2.  In the CMDB Workspace, select **SGC Central**.\n\n3.  On the Overview page, select **Create connection**.\n\n    **Tip:** Alternatively, you can select **Create connection** on the All connections page.\n\n4.  On the Create connection window, select the MuleSoft connector type, and then select **Create connection**.\n\n5.  Complete the initial prerequisites when setting up a connection for the first time using a connector.\n\n    **Note:** This step is required only during the first-time setup. See [Perform initial setup tasks when creating a connection in SGC Central](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/sgcc-first-time-setup.md).\n\n6.  Enter connection details and test the API connection for importing MuleSoft data.\n\n    1.  In the **Setup** stage of the playbook, select the **Create and test connection** activity.\n\n    2.  On the form, fill in the fields.\n\n<table id=\"table_l2g_zn4_nyb\"><thead><tr><th>\n\nField\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nConnection name\n\n</td><td>\n\nName to identify the MuleSoft connection record.For example, `MuleSoft connection`.\n\n</td></tr><tr><td>\n\nConnection URL\n\n</td><td>\n\nBase 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.\n\n</td></tr><tr><td>\n\nOAuth client ID\n\n</td><td>\n\nClient ID of your MuleSoft Connected App as noted in the [Before you begin](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/configuration-management-database-cmdb/sgcc-configure-mulesoft.md) section.\n\n</td></tr><tr><td>\n\nOAuth Client Secret\n\n</td><td>\n\nClient secret of the MuleSoft Connected App as noted in the [Before you begin](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/configuration-management-database-cmdb/sgcc-configure-mulesoft.md) section.\n\n</td></tr><tr><td>\n\nOAuth Token URL\n\n</td><td>\n\nToken endpoint URL used to securely authenticate your identity and authorize access to your MuleSoft Anypoint Platform API account via the API.\n\n</td></tr></tbody>\n</table>    3.  Select **Create and test connection**.\n\n    4.  Once the connection test is complete, select **Continue**.\n\n7.  Set the configuration properties for the connection.\n\n    1.  In the **Setup** stage of the playbook, select the **Set configuration properties** activity.\n\n    2.  Fill in the property details.\n\n<table id=\"table_nn3_31v_3cc\"><thead><tr><th>\n\nProperty\n\n</th><th>\n\nDescription\n\n</th></tr><tr><th class=\"sub-head\" colspan=\"2\">\n\nData retrieval configuration\n\n</th></tr></thead><tbody><tr><td>\n\nOrganization id\n\n</td><td>\n\nMuleSoft 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.\n\n</td></tr><tr><td>\n\nEnvironment filter\n\n</td><td>\n\nMuleSoft 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.\n\nIf you leave this field empty, the data sources within the connector import API proxies from all environments.\n\n</td></tr><tr><td>\n\nAPI Manager filter\n\n</td><td>\n\nAPI manager instance status filter.Accepts a single value: `active`, `inactive`, or `unregistered`. When specified, only APIs matching that status are imported.\n\nIf you leave this field empty, all APIs are imported regardless of status.\n\n</td></tr><tr><td>\n\nOnly deployed API managers\n\n</td><td>\n\nOption to import only APIs currently deployed to runtime instances.\n\n</td></tr><tr><td>\n\nImport deployed applications\n\n</td><td>\n\nOption to collect deployed applications from runtime manager as Data Service Instances.\n\n</td></tr><tr><td>\n\nCollection period \\(in days\\)\n\n</td><td>\n\nDuration in days for collecting API usage data.\n\n</td></tr><tr><td>\n\nCollect usage data\n\n</td><td>\n\nOption to enable usage data collection to retrieve API usage metrics over a specified duration.\n\n</td></tr><tr><td class=\"sub-head\" colspan=\"2\">\n\nTags settings\n\n</td></tr><tr><td>\n\nImport tags\n\n</td><td>\n\nOption to ingest tags from the MuleSoft API Manager.\n\n</td></tr><tr><td>\n\nTag key/value indicator\n\n</td><td>\n\nSeparator for key and value in tags.\n\n</td></tr></tbody>\n</table>    3.  Select **Continue**.\n\n8.  Configure the import schedule to import data at regular intervals.\n\n    1.  In the **Setup** stage of the playbook, select the **Configure import schedule** activity.\n\n    2.  Expand the Parent scheduled data import within the Import schedules list to select the **Gateway** import schedule associated with your connection.\n\n        **Note:** The connection name is prefixed to the schedule name.\n\n    3.  In the Configure import schedule dialog box, select the **Active** check box, and then fill in the run schedule and time details.\n\n        For more information, see [Schedule a data import](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/integrate-applications/t_ScheduleADataImport.md#table_r53_5hm_xp).\n\n    4.  Select **Save**.\n\n        Alternatively, select **Execute Now** to execute the import schedule immediately.\n\n    5.  Select **Continue**.\n\n9.  In the **Setup** stage of the playbook, select the **Confirm connection creation** activity to verify whether the connection was created.\n\n\n## What to do next\n\nSelect **View all connections** to review the connection details. The created connection appears in the Installed connections list.\n\nYou 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/sgcc-managing-connection.md).\n\n"}}