Enabling and handling rules that call URL scripts

You can define rules that call scripts at URLs to trigger a third party script embodied in an endpoint URL.  This supports advanced workflow use case scenarios and enables integration with external applications.

Follow these instructions before activating rules with the Call URL action.

  1. Prepare your script

    When processing a rule with the Call URL action, when the submission mode of an entity is created, updated, or deleted, ALM Octane performs a REST API post to the URL with the following json: 

    {
        "entityType": "entityName",
        "entityId": "id",
        "userName": "userName",
        "workspaceId": workSpaceIdAsNumber,
        "submissionMode": "businessRuleEventType",
        "serverUrl": "serverUrl",
        // if a change has been made
        "changes" : {
            // for each field that has been changed
           "fieldNameThatHasBeenChanged": {
           "originalValue": "originalValue",
           "newValue": "newValue"
           }
        }
    }
    

    The serverUrl is the URL of the ALM Octane server.

    Make sure your script receives this information and processes as needed.

  2. If needed, install an Integration Bridge to give ALM Octane access to the endpoint URL

    You may need to install an Integration Bridge to enable ALM Octane to integrate with the endpoint URL, as described in the following table:

    On-premise:

    Your site admin needs to check if the URL is accessible.

    • If the URL can be accessed from your network, no bridge is needed.

    • If the URL cannot be accessed from your network, install a bridge as described in Set up the Integration Bridge.

    SaaS:
    • If the URL is publicly visible, contact your SaaS administrator and request that SaaS enable a call to the URL.

    • If the URL is inside your private network and not publicly visible, install a bridge as described in Set up the Integration Bridge.

  3. At the endpoint: Set up a server

    Set up and run a server at the endpoint that listens to the URL, and processes the information POSTed.

Next steps: