Integrating with Rally

  • Release version: Yokohama
  • Updated January 30, 2025
  • 5 minutes to read

    • Integrating your Software Asset Management application with the Broadcom Rally application enables you to track your software subscriptions and to reclaim unused licenses.

    Important:
    Minimize security risks and protect information by granting access only to the necessary user or API permissions.
    Table 1. Minimal user permissions
    Process Required user role in the Rally application Authentication scopes
    Download subscriptions Workspace admin None
    Pull user activity Workspace admin None
    Reclaim subscription Workspace admin None

    Register a Rally OAuth application

    Register the Rally OAuth application to access the Rally API 2.0 and to receive a Client ID and Client secret.

    Before you begin

    The Rally Integration Hub spoke must be active. For more information, see Rally spoke.

    Rally Role required: Refer to the Minimal user permissions table.

    Procedure

    1. Log in to CA Agile Central by using your admin credentials.
    2. On the page header, select your profile and then select My Settings.
    3. Navigate to Access > OAUTH CLIENTS.
    4. Select Create.
    5. In the dialog box, fill in the fields.
      Table 2. Create Oauth Client dialog box
      Field Value
      Application Name Provide a name for the application.
      Callback URL Callback URL of the ServiceNow instance to which the application is to be integrated. For example, https://<instance_url>/oauth_redirect.do.
    6. Select Next.
    7. Copy the Client ID and Client secret for later use.

    Create a Rally integration profile

    Create a Rally integration profile to track software subscriptions and optimize licensing for your Rally solutions.

    Before you begin

    The Software Asset Management - SaaS License Management plugin (sn_sam_saas_int) must be installed from the ServiceNow Store.

    Role required: admin or sam_integrator

    Important:
    You must select the Rally Spoke check box for this integration while installing optional features on the Application Manager page. For more information about choosing the required SaaS applications, see Request SaaS License Management.

    About this task

    If you’re using Software Asset Workspace, the option to create the Rally integration profile in Core UI is inactive.

    Procedure

    1. Navigate to the integration profile.
      InterfaceAction
      Core UI
      1. Navigate to All > Software Asset > SaaS License > Direct Integration Profiles.
      2. Select New.
      3. Select Rally Integration Profile.
      Software Asset Workspace
      1. Navigate to License operations > User Subscriptions > Direct integration profiles.
      2. Select New.
      3. Select Rally from the drop-down list.
      4. Select Continue.
    2. On the form, fill in the fields.
      Table 3. Integration profile form
      Field Value
      Display name Name of the integration profile. For example, Rally integration.
      Status Status of the integration profile.
      • If you have not published the integration profile, this field is automatically set to  Draft.
      • If you have already published the integration profile, this field is automatically set to  Published.
      Profile type Type of integration profile. This field is automatically set to Rally Subscription.
    3. Review the required user roles or API permissions specified in the Vendor configuration field for each process to minimize security risks and optimize SaaS licenses.
      Note:
      For more information, see Minimal user permissions table.
      1. In the Download Subscription Subflow section, verify that the Subflow field is set to Rally Download Subscriptions.
        Note:
        The Download subscriptions check box is selected by default and you can't clear it.
      2. In the Reclaim Subscription Subflow section, verify that the Subflow field is set to Rally Reclaim Subscription.
        Note:
        The Reclaim subscriptions check box is selected by default. If you don't want to reclaim subscriptions, you can clear this check box. If you clear it, the removal candidates are created but the reclaim subscription subflow isn't triggered or the reclamation process isn't initiated.
    4. Select Save.
      A draft integration profile is created.

      The Connection & Credential field appears and is automatically set to sn_rally_spoke.Rally.

    5. Open the connection & credential aliases record by selecting the preview icon (Preview icon.) next to the Connection & Credential field and then selecting Open Record in the record preview.
    6. On the Connection & Credential Aliases form, select the Create New Connection & Credential related link.
    7. In the Create Connection and Credential dialog box, fill in the fields.
      Table 4. Create Connection and Credential
      Field Value
      Connection Information
      Connection Name Name of the Rally connection. This field populates automatically.
      Connection URL URL for the connection. This field is automatically set to https://rally1.rallydev.com/slm/webservice.
      Credential Information
      OAuth Client ID Client ID that you generated while configuring Rally API settings.
      OAuth Client Secret Client Secret that you generated while configuring Rally API settings.
      OAuth Redirect URL https://<instance_name>/oauth_redirect.do, where instance name is the name of your ServiceNow instance.
    8. Select Create and Get OAuth Token.
      Note:
      For the role required to perform this step, refer to the Minimal user permissions table.
    9. On the integration profile form, select Validate Connection to verify the connection and credential details of this integration.

      Validating the connection verifies the Download Subscriptions APIs, but not the Reclaim Subscriptions APIs.

    10. After the connection is verified, select Publish.
    11. In the Publish Confirmation dialog box, select OK.

    What to do next

    After the integration connects, your ServiceNow instance automatically creates software models, reclamation rules, and software subscriptions that are refreshed daily.

    If you want to set up multiple integration profiles with unique connections, create child aliases to manage different configurations and settings for each integration profile. For more information, see Create a child alias to set up multiple integration profiles.

    Review all automatically generated reclamation rules to reclaim user subscriptions. For more information, see Review a software reclamation rule.

    Create software entitlements for the automatically generated software models to track used software against owned software.
    Reconciliation also runs on your subscriptions as a scheduled job or on-demand. You can view your reconciliation results in the License Workbench (Software Asset Management classic application) or the License usage view (Software Asset Workspace). Use these results to determine your license compliance position and to remediate any non-compliance.