Implementation Guide for the Integration Assistant - Support and Troubleshooting

Implementation Guide for the Integration Assistant Automate the creation of an integration using the Vulnerability Response (VR) integration framework. Use the Integration Assistant to create these integrations, by ingesting data from a REST endpoint.

Automating the implementation process Create an integration assistant record with the vendor details, REST endpoint, and the number of required data sources. Update the instance parameter with a REST endpoint. Update the scanner integration script with the REST message implementation to enable pagination and delta support. Update the import processor script to populate your data model with the required data received through the REST endpoint. Advantages of creating an integration using the Integration Assistant Creating an integration can be a complex process that takes a significant amount of time. The following components must be created for a VR integration:

New vendor integration record Integration instance Defined integration parameters and instance parameters REST message and REST method Integration record Integration script associated with the integration record Data sources associated with the integration record Transform map to transform the data retrieved Processing script to populate the VR data model Using the integration assistant creates all these components automatically. It also ensures that the optimal implementation process using the VR framework is followed to create an integration. You must perform the following steps:

Create an integration assistant record with the vendor details and the REST endpoint. Update the integration script created earlier to handle pagination and delta support. Update the processing script to populate the VR data model. Prerequisites The user must have admin access. Update sets must be committed on the instance. The latest versions of the following applications must be installed: Vulnerability Response Security Support Common Security Integration Framework Implementing an integration You can create an integration with a new vendor using the integration assistant.

Before you begin: Download the following zip file that contains the update sets: Integration Assistant - April 2023 Version.zip

The following update sets have been included:

Integration Generator - Update Set 1 [Security Support Common application] Integration Generator - Update Set 2 [Global] Integration Generator - Update Set 3 [Security Integration Framework application] To avoid cross-scope access policy issues:

Navigate to System Definition > Tables , and select the REST Integration table. Select the Application Access tab and ensure that the Can Read , Can Create , and Can Update options are selected. Save the changes.

To create an integration with a new vendor:

1. Commit the included update sets on the required instance.

2. Navigate to the Integration Assistance Guided Setup using the left-hand menu and select the Get Started option in the Integration Assistant module.

3. Create Application : Create an application scope that includes the integration. Skip this step if the integration must be a part of the existing scope. Before moving to the next step, ensure you are in the correct scope.

4. Vendor Setup : Create a vendor record for the third-party integration with Vulnerability Response. Skip this step if the integration must be a part of the existing vendor.

5. Configure Integration Details : To configure integration details, select Configure . For details, select the More Information option.

The Configure Integration Details page opens.

a. Select the vendor and provide the API Name (Base URL or the REST endpoint for the integration).

Note: Each vendor can be associated with a single API name. For details on creating multiple REST methods for an API, see the next step.

b. Select Next .

c. Fill in the field details as explained in the below table.

Field Description Integration Name Type of data being ingested, such as vulnerabilities and assets, through the integration. This data is appended to the vendor name during the component generation process. Number of Datasources Number of data sources created for the integration. Response Type Type of payload received as a part of the REST call for this integration, to process the same accordingly. XML/JSON Path Path for each row used to handle the rows in the import set table. Integration Type Type of integration. API Key Exists Select this option if the configuration key is required for the integration as part of the authentication process.

d. After updating the form, select the Create Integration option. You can create multiple integrations under a single vendor by refilling and submitting the Configure Integration(s) page multiple times.

e. Select Close and then select Mark as Complete .

6. Configure Rest Message : To configure REST messages and the REST methods, select Configure . For details, select the More Information option.

7. Review and configure integration script(s) : To configure the integration scripts, select Configure . For details, select the More Information option.

8. Review Data Source : To review the data source, select Configure .

9. Configure Transform Map : To configure the transform maps, select Configure . For details, select the More Information option.

10. Configure Integration Parameter : To configure the integration parameters, select Configure .

11. Configure Integration Instance : To configure the integration instance, select Configure .

12. Configure Tables : To configure the tables related to the integration, select Configure .

Your VR integrations are created.

Before executing the integration make sure you have selected the correct REST method for the integration. Navigate to Vulnerability Response > Administration > Integrations , Open the integration you have created and switch to the REST Details page and select the required REST method.

Execute the integration.

13. Navigate to Integration Assistant guided setup home page as shown in step 2 and select the Get Started option in the Integration Audit Report module.

14. Generate integration audit report : Enter the integration name and performance testing status to generate the integration audit report. Use this report to verify the components. In case of an error in the integration, you can download this report, attach it to the error logs, and send the information to the ServiceNow support team for further investigation.

Note: To view the results of running the integration, go to the Vulnerability Integration Runs tab.

To create a new integration mark the following steps as incomplete and perform all the above steps again for the new integration:

Create Application Vendor Setup Configure Integration Details