{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":47049,"path":"servicenow-platform/configuration-management-database-cmdb/sgcc-configure-apigee-edge.md","title":"Configure API Service Graph Connector for Apigee Edge using SGC Central","bundle":null,"doc_type":null,"release":"australia","body":"\n# Configure API Service Graph Connector for Apigee Edge using SGC Central\n\nSet up scheduled import jobs to pull in Apigee Edge data into your CMDB.\n\n## Before you begin\n\nInstall API Service Graph Connector for Apigee Edge 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 API credentials from your Apigee Edge administrator. Make a note of the following details:\n\n-   Organization name: The Apigee Edge organization name from which data is imported.\n-   Authentication details: The OAuth 2.0 token URL for your Apigee Edge account, and the user name and password used to authorize the connection.\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|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 Apigee Edge 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 Apigee Edge 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_conn_form\"><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 Apigee Edge connection record.\n\n</td></tr><tr><td>\n\nConnection URL\n\n</td><td>\n\nBase URL to connect to the Apigee Edge service.**Note:** For a cloud setup, this field is prepopulated with the Apigee Edge cloud host value. Leave the field value as is. For an on-premises \\(custom\\) setup, replace the value with the host URL for your Apigee Edge instance.\n\n</td></tr><tr><td>\n\nOAuth Token URL\n\n</td><td>\n\nToken URL used to obtain the OAuth 2.0 access token for your Apigee Edge account, as noted in the [Before you begin](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/configuration-management-database-cmdb/sgcc-configure-apigee-edge.md) section.**Note:** For an on-premises \\(custom\\) setup, you must obtain and enter this value along with the Connection URL. For a cloud setup, only this field requires manual entry.\n\n</td></tr><tr><td>\n\nUse Mid Server\n\n</td><td>\n\nOption to connect to the Apigee Edge service using a MID Server.\n\n</td></tr><tr><td>\n\nMID Selection\n\n</td><td>\n\nSelect how the MID Server is chosen for the connection:-   **Auto-Select MID Server**: Optionally specify a MID application to select available MID Servers from.\n-   **Specific MID Server**: Select the MID Server to use.\n-   **Specific MID Cluster**: Select the MID Server cluster to use.\n\n\n</td></tr></tbody>\n</table>    3.  Select **Create and test connection**.\n\n    4.  In the **Enter Credentials** dialog box, enter the **User name** and **Password** for your Apigee Edge account, as noted in the [Before you begin](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/configuration-management-database-cmdb/sgcc-configure-apigee-edge.md) section, and then select **Proceed**.\n\n        **Note:** This connector uses the OAuth 2.0 password grant type, which requires these credentials to obtain an access token.\n\n        **Note:** Submitting these credentials also creates a second connection record with Basic Connection appended to your connection name. The connector uses this record internally for basic authentication, and no further action is required.\n\n    5.  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_config_props\"><thead><tr><th>\n\nSection\n\n</th><th>\n\nProperty\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td rowspan=\"3\">\n\nData retrieval configuration\n\n</td><td>\n\nApigee Edge organization name\n\n</td><td>\n\nComma-separated list of Apigee Edge organization names to import data from. If left empty, data is retrieved from all accessible organizations.\n\n</td></tr><tr><td>\n\nApp types to import\n\n</td><td>\n\nFilters which app records populate the API Consumer and API Consumer Subscription tables. Available options are **Company**, **Developer**, or **Both**. Defaults to **Both**.\n\n</td></tr><tr><td>\n\nInclude environments\n\n</td><td>\n\nComma-separated list of Apigee Edge environments to include in the connection. If left empty, data is imported from all environments.\n\n</td></tr><tr><td>\n\nSingle environment\n\n</td><td>\n\nInclude revision in key\n\n</td><td>\n\nOption to include the proxy revision in the correlation key to disambiguate proxies across organizations and environments. Selected by default.\n\n</td></tr><tr><td rowspan=\"3\">\n\nTags settings\n\n</td><td>\n\nImport tags\n\n</td><td>\n\nOption to enable ingestion of tags associated with imported CIs. Not selected by default.\n\n</td></tr><tr><td>\n\nTag key prefix\n\n</td><td>\n\nPrefix filter on tag keys. The prefix is stripped before the key is stored. For example, a tag key of **NOWtag=environment** is stored as **environment**.\n\n</td></tr><tr><td>\n\nTag key allow list\n\n</td><td>\n\nComma-separated list of exact-match tag keys to store in the Key Value \\[cmdb\\_key\\_value\\] table. Other tag keys are ignored.\n\n</td></tr><tr><td rowspan=\"2\">\n\nManaged API settings\n\n</td><td>\n\nInternet facing\n\n</td><td>\n\nOption to mark all ingested Managed API CIs as internet facing. Not selected by default.\n\n</td></tr><tr><td>\n\nManaged API type\n\n</td><td>\n\nForces a specific type on all ingested Managed API CIs. Available options include **REST**, **SOAP**, **WebSocket**, **gRPC**, **GraphQL**, and **HTTP**.\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 **Organization** 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    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 setup** 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"}}