ServiceNow: Configuring Integration with XOps Stories

Create fields to be populated when a ticketed in the Cato Management Application (CMA).

To create custom fields:

1. Log in to the ServiceNow platform.

2. Open any Incident.

3. From the top banner, right-click and navigate to Configure > Form Builder.

4. If required, agree to try the Form Builder and select the Default view.

5. Click Add a new field in the Incident Table.

6. Add these fields:

   • CMA Account ID

     • Type: Integer

     • Properties: Read Only, Mandatory, Active

   • CMA Story ID

     • Type: String

     • Properties: Read Only, Mandatory, Active

Service API keys enable scalable integration with external tools and services and are created in this format: R=<...>|K=<...>. For more information and detailed information about how to create a Service API key, see Generating API Keys for the Cato API.

Once you have created the Service API key, copy and save it so it can be entered into the ServiceNow Platform.

In the ServiceNow Platform, create a secure system property to store the API key.

To create a secure system property:

1. Navigate to https://<your instance>.service-now.com/sys_properties_list.do

2. Click New.

3. In the System Properties New Record form, add these details:

   

   • Name: cma_prod_api_key

   • Type: Password2

   • Value: The Service API key you created in step 2

4. Click Submit.

Create a REST message to send details from ServiceNow incidents to Cato:

To create a REST message:

1. In your ServiceNow Platform, navigate to All>System Web Services > Outbound > REST Message.

2. Click New.

3. In the REST Message form, add these details:

   • Name: Add a name for the REST Message

   • Endpoint: https://<your Cato account name>.cc.catonetworks.com/api/v1/graphql2

   • Authentication type: No authentication

   • HTTP Methods: Click New and add these details:

     • Name: Add a name

     • HTTP method: POST

     • Endpoint: https://<your Cato account name>.cc.catonetworks.com/api/v1/graphql2

4. Click Submit.

Create a business rule to trigger the REST message.

To create a business rule:

1. In your ServiceNow Platform, navigate to All > System Definitions > Business Rule.

2. Click New.

3. In the Business Rule New Record form, add these details:

   

   • Name: Add a name for the Business Rule

   • Table: Incident

   • When: After

   • Update: True (Check the checkbox)

   • Filter Condition: Comments changes

4. On the Advanced tab, add this script:

   (function executeRule(current, previous) {
     try {
       var lastComment = current.comments.getJournalEntry(1) || '';
       lastComment = stripJournalHeader(lastComment);
       if (!lastComment) {
         gs.info("GraphQL webhook: Empty comment, skipping " + current.number);
         return;
       }
       var accountId = current.u_cma_account_id;
       var storyId = current.u_cma_story_id;
           gs.info("GraphQL webhook: accountId " + accountId + " story " + storyId);
       if (!accountId || !storyId) {
         gs.error("GraphQL webhook: Missing accountId/storyId for " + current.number);
         return;
       }
       var gqlQuery =
         "mutation CreateStoryComment($accountId: ID!, $input: AddStoryCommentInput!) {" +
         "  xdr(accountId: $accountId) {" +
         "    addStoryComment(input: $input) {" +
         "      comment { id type __typename }" +
         "      __typename" +
         "    }" +
         "    __typename" +
         "  }" +
         "}";
       var body = {
         query: gqlQuery,
         variables: {
           accountId: accountId.toString(),
           input: {
             type: "USER",
             storyId: storyId.toString(),
             text: lastComment
           }
         }
       };
           var apiKey = gs.getProperty('cma_prod_api_key');
       var r = new sn_ws.RESTMessageV2('Update XDR story comments CMA Prod', 'post');
       r.setRequestHeader('Content-Type', 'application/json');
       r.setRequestHeader('Accept', 'application/json');
           r.setRequestHeader('x-api-key', apiKey);
       r.setRequestBody(JSON.stringify(body));
       //var response = r.execute(); // can be changed to Async - only for debug purposes
           var eccSysId = r.executeAsync();
       gs.info("GraphQL webhook queued, ECC sys_id=" + eccSysId);
       var status = response.getStatusCode();
       var responseBody = response.getBody();
     // Safe logging (see next section for masking)
        gs.info("GraphQL webhook: status=" + status);
        gs.info("GraphQL webhook: responseBody=" + responseBody);
     } catch (ex) {
       gs.info("GraphQL webhook: Failed: " + ex.message);
     }
     function stripJournalHeader(text) {
       text = text || '';
       if (text.indexOf('\n') > -1) {
         return text.split('\n').slice(1).join('\n').trim();
       }
       return text.trim();
     }
   })(current, previous);

5. Click Submit.