Integrating with Roadmunk

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

重要:

Minimize security risks and protect information by granting access only to the necessary user or API permissions.

表 : 1. Minimal user permissions

Process	Required user role in the Roadmunk application	Authentication scopes
Download subscriptions	Account Admin	No scopes
Pull user activity	Account Admin	No scopes
Reclaim subscription	Account Admin	No scopes

Generate a Roadmunk API access token

Generate an API access token that authorizes access to the Roadmunk GraphQL API.

始める前に

Roadmunk Role required: Account Admin

手順

1. From a web browser, open Roadmunk.
2. Log in using your account admin credentials.
3. On the left navigation menu of the Roadmunk dashboard, select your profile icon and then select Account Settings.
4. On the page header of your account settings, select the Integrations tab.
5. Under Existing Integrations, select Add an integration.
6. When prompted to select an integration to configure, select API Tokens.
7. On the Roadmunk API Tokens form, enter a name for your API access token in the Application Name field.
8. Select Create API Token.
   The API access token is generated and then the API Token Created dialog box opens.
9. On the API Token Created dialog box, copy your API access token by selecting Copy To Clipboard.
   Save it in a secure location for later use.

Create a Roadmunk integration profile

Create a Roadmunk integration profile to track software subscriptions and optimize licensing for your Roadmunk applications.

始める前に

To create a Roadmunk integration profile, request the Software Asset Management - SaaS License Management plugin (sn_sam_saas_int) from the ServiceNow Store.

ServiceNow Role required: sam_integrator

重要:

You must select the Roadmunk 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.

このタスクについて

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

手順

1. Navigate to the integration profile.

   Interface	Action
   Core UI	Navigate to All > Software Asset > SaaS License > Direct Integration Profiles. Select New. Select Roadmunk Integration Profile.
   Software Asset Workspace	Navigate to License operations > User Subscriptions > Direct integration profiles. Select New. Select Roadmunk from the drop-down list. Select Continue.

2. On the form, fill in the fields.

   表 : 2. Integration Profile form

   Field	Description
   Display Name	Name of the integration profile. For example, Roadmunk 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 Roadmunk 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.
   注:

   For more information, see Minimal user permissions table.
   1. In the Download Subscription Subflow section, verify that the Subflow field is set to Roadmunk Download Subscriptions.
      注:

      The Download subscriptions check box is selected by default and you can't clear it.
   2. In the Calculate Activity Subflow section, verify that the Subflow field is set to Roadmunk Update User Activity.
      注:

      The Download Activity check box is selected by default. If you clear it, the activity scheduled job SAM - Refresh <displayname> Activity isn't created.

      In the Analyze user activity field, you can also select the date and time starting from when you want to analyze the user activity. By default, you can analyze user activity up to 60 days prior to the current date and view events performed by individual users from the time you create this profile.

      注:

      Software Asset Management pulls the events from the time that you start analyzing user activity irrespective of the profile creation date.

      You can modify this value in the Last activity threshold field of your software reclamation rules. For more information, see Review a software reclamation rule.
   3. In the Reclaim Subscription Subflow section, verify that the Subflow field is set to Roadmunk Reclaim Subscription.
      注:

      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.

   Your ServiceNow instance creates a draft integration profile.

   The Connection & Credential field appears and is automatically set to sn_roadmunk_spoke.Roadmunk.

5. オプション: To avoid your integration profile from including inactive users in your list of Roadmunk subscriptions, enable the Roadmunk Download Subscriptions subflow to download only the active users in your Roadmunk account.
   By default, the Roadmunk Download Subscriptions subflow downloads all users in your Roadmunk account, including both active and inactive users.
   1. In a new tab or window, open Roadmunk.
   2. Log in using your Account Admin credentials.
      The Roadmunk dashboard opens.
   3. On the left navigation menu of the Roadmunk dashboard, select your profile icon and then select Account Settings.
      Your account settings open.
   4. On the page header of your account settings, select the Reports tab.
   5. From the list of available Roadmunk reports, select Download User CSV.
      The Roadmunk User Report downloads in .csv format.
   6. Return to the Integration Profile form.
   7. On the form header, select the Manage Attachments icon ().
   8. In the Attachments dialog box, select Choose file to locate and select the Roadmunk User Report that you downloaded in step e.
   9. After the report uploads successfully, close the dialog box to return to the Integration Profile form.
   ヒント:

   For continuously removing inactive users from your list of Roadmunk subscriptions, download and attach the latest version of the Roadmunk User Report periodically.
6. Open the connection & credential aliases record by selecting the preview icon () next to the Connection & Credential field and then selecting Open Record in the record preview.
7. On the Connection & Credential Aliases form, select the Create New Connection & Credential related link.
8. In the Create Connection and Credential dialog box, fill in the fields.

   表 : 3. Create Connection dialog box

   Field	Description
   Connection Information
   Connection Name	Name of the Roadmunk connection. This field populates automatically.
   Connection URL	URL for the connection. This field is automatically set to https://app-gateway.roadmunk.com, where app is the default geographic region (North America) in which the connection is being created. If you’re creating the connection outside of the default app (North America) region, you can change the value of the region to either eu (Europe) or apac (Asia-Pacific Region).
   Credential Information
   API Token	API access token that authorizes access to the Roadmunk GraphQL API. Enter the same API access token that you generated in Generate a Roadmunk API access token.

9. Select Create.
10. 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 and Calculate Activity APIs, but not the Reclaim Subscriptions APIs.

11. After the connection is verified, select Publish.
12. Select Publish.
13. In the Publish Confirmation dialog box, select OK.
    注:

    If you clear the Download Activity check box after the integration profile is published, you must revalidate the connections and then republish the integration profile because the following events occur:

    • The Status field on the integration profile form changes to Draft.
    • The Validate connection button shows up on the form.
    • The current SAM - Refresh <displayname> Activity job gets deleted.

次のタスク

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

After creating an integration profile, view information about the profile in the Software Asset Workspace by navigating to License operations > User subscription > Direct integration profiles. You can select an integration profile to view the following related lists. If all of the following related lists aren't visible for an integration profile in the default view, you can select the custom integration view from the Details tab:

• Software Models
• Unrecognized Subscription Identifiers
• Scheduled Jobs
• Scheduled Job Results
• Software Subscriptions
• Subscription Identifier Exclusion Rule
• Subscription User Exclusion Rule

After creating an integration profile, you can define subscription exclusion rules to keep certain subscriptions from license cost calculations. For more information, see Subscription exclusions for SaaS and SSO applications.

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.

• For more information on creating software entitlements in the Software Asset Management Core UI, see Create entitlements in Software Asset Management classic.
• For more information on creating software entitlements in the Software Asset Workspace, see Create entitlements in workspace.
• For more information on creating software entitlements using the Software Asset Management Playbook, see Create entitlements using the guided walk-through.

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.

• For more information on running reconciliation in the Software Asset Management classic application, see Run software reconciliation in Software Asset Management classic.
• For more information on running reconciliation in the Software Asset Workspace, see Run software reconciliation in the workspace.