Configuring CA Release Automation REST Notifications

To receive notifications about task executions from CA Release Automation for Run Process deployment tasks, you must configure REST notification properties in CA Release Automation.

This configuration step is not necessary to complete a task, because the task execution is also polling. If the notification properties are configured, the task will be completed depending on which completes first, the polling interval or the notification. See CA Release Automation Actions Configuration Details.

To do this, update the REST integration properties file as follows:

  1. Navigate to the <CA RA installation directory>\CA\ReleaseAutomationServer\conf directory.

  2. If the text file rest.integration.properties does not exist, create it.

  3. In the rest.integration.properties file, specify the target URL for the Release Control CA Release Automation notification URL (notification endpoint) according to the specifications:

    You must update the CA Release Automation REST integration properties to specify a notification URL for detecting a status change in CA Release Automation jobs.

    http(s)://<RLCServer>/rlc/notification/nolio?instance-name=<CARA_Instance_Name>&provider-uuid=<Execution Configuration UUID>&jobId=

    where:

    • http or https is used, depending on whether you are using a non-SSL or SSL connection, respectively
    • RLCServer is the Release Control server host name or IP address
    • instance-name is optional and should be used to avoid possible collisions when using multiple CA Release Automation servers simultaneously
      Note: The value of the instance-name parameter is limited by CA Release Automation to numerical characters and the Latin alphabet.
    • provider-uuid is optional and should be used to bypass automatic configuration detection
    • &jobId= is a query parameter that must be at the end of the notification URL if either instance-name or provider-uuid are included, because CA Release Automation automatically always adds a slash and jobId to the end of the URL.

    To find and copy the UUID, view the plugin configuration in Release Control Administration. See Release Control Administration Overview.

  4. Restart the CA Release Automation services.

Related Topics

CA Release Automation Actions Configuration Details

Release Control Administration Overview