Product documentation Docs
    • English
    • Deutsch
    • 日本語
    • 한국어
    • Français
  • More Sites
    • Now Community
    • Developer Site
    • Knowledge Base
    • Product Information
    • ServiceNow.com
    • Training
    • Customer Success Center
    • ServiceNow Support Videos
  • Log in

Product documentation

  • Home
How search works:
  • Punctuation and capital letters are ignored
  • Special characters like underscores (_) are removed
  • Known synonyms are applied
  • The most relevant topics (based on weighting and matching to search terms) are listed first in search results
Topics are ranked in search results by how closely they match your search terms
  • A match on the entire phrase you typed
  • A match on part of the phrase you typed
  • A match on ALL of the terms in the phrase you typed
  • A match on ANY of the terms in the phrase you typed

Note: Matches in titles are always highly ranked.

  • Release version
    Table of Contents
    • Software Asset Management
Table of Contents
Choose your release version
    Home Orlando Software Asset Management Software Asset Management Software Asset Management SaaS License Management Integrate with SaaS applications SaaS License Connections Create a subflow to get users

    Create a subflow to get users

    • Save as PDF Selected topic Topic & subtopics All topics in contents
    • Unsubscribe Log in to subscribe to topics and get notified when content changes.
    • Share this page

    Create a subflow to get users

    Create a subflow to add a list of users to the Software Subscription table.

    Before you begin

    Role required: flow_designer or admin

    This subflow requires a data stream action to get users. For more information, see Create a data stream action to get users.

    About this task

    Note: For examples of subflows to get users, search for the Jira Download Subscriptions and Webex Download Subscriptions subflows in Flow Designer. To view these subflows, request the Cisco Webex Meetings spoke and Jira spoke apps on the ServiceNow Store.

    Procedure

    1. Navigate to Flow Designer > Designer.
    2. Click New and then select Subflow.
    3. On the form, fill in the fields.
      Field Value
      Name Name of your choice. For example, Application Download Subscriptions, where Application is the name of the SaaS application you are integrating with.
      Application Software Asset Management - SaaS License Management Integrations.
      Note: If you save the subflow in the Software Asset Management - SaaS License Management Integrations application, it is included with your Software Asset Management subscription. If you save the subflow in any other application, you may be charged for IntegrationHub transactions. If you are publishing your custom spoke application on the ServiceNow Store, select your custom app instead.
      Accessible From All application scopes.
      Category Leave this field empty.
      Protection None.
      In-Flow Annotation Leave this field empty.
      Description Description of your choice.
      Run As User who initiates session.
    4. Add an integration profile input.
      Table 1. Inputs
      Label Name Type Mandatory
      Integration profile integration_profile Reference.Integration Profile Yes
    5. In the Actions section, click the plus icon and then click Action to add a new action.
    6. Select the spoke for the SaaS application you want to integrate with from the list of installed spokes.
      Note: To add additional spokes to your list of installed spokes, request them on the ServiceNow Store. For a complete list of available spokes, see IntegrationHub available spokes. If there is no existing spoke for the SaaS application you want to integrate with, you can create a new spoke.
    7. Select a data stream action to get users.
    8. Define the values to pass for any user authentication inputs for the data stream action.
    9. The data stream action may return users that you do not want to include in your list of user subscriptions. If you need to perform filtering to exclude some users, add an If flow logic as a child of the get users data stream action.
      The amount of required filtering, if any, depends on the specific application you are integrating with. For example, if the user targetObject has an active property, you could add a condition to check that the value is true to ensure that the subflow does not download deactivated users. An example of filtering used by the Jira Download Subscriptions subflow is that the account type cannot be app to prevent the subflow from returning accounts that are not actual users.
      1. Add conditions to the If flow logic for any required filtering.
    10. If you are using an If flow logic to filter users, add the Upsert User Subscription action from the Software Asset Management spoke as a child of the flow logic. If you are not filtering users, add the Upsert User Subscription action as a child of the get users data stream action.
      This action adds the SaaS application user subscription to the Software Subscription table [samp_sw_subscription]. If the subscription is already in the table, the action updates the subscription record.
    11. Use values from the Data panel to fill in the action inputs. Your request to the SaaS API may not return data for all the inputs. Fill in the inputs that are applicable to your integration.
      Table 2. Upsert User Subscription action
      Field Value
      External user id User id or account id from the user targetObject. This is generally a numeric, non human-readable value.
      User principal name Email address from the user targetObject. If email address is not available, use another value such as user name plus user id. This value must be unique and should be human readable.
      Integration profile [Integration Profile] Integration profile input you created for the subflow.
      Product [Software Product] Software product you are connecting to with the integration. This value must be a reference to the Software Product table [samp_sw_product]. If the product does not exist in the table, add a custom software product.
      Version Version of the SaaS application.
      Edition Edition of the SaaS application, such as Standard or Enterprise.
      Last activity Date of most recent activity from the user targetObject. For example, last login time.
      External created

      Account creation date from the user targetObject.

      This value helps create better reclamation candidates. A new user may not have any activity yet. If the record shows that the user account was just created, a reclamation candidate won't be created for that user because it is a new account rather than an unused account.

    12. Click Test to test your subflow.
      1. View the test results and system logs for details about any errors.
        To view system logs, navigate to System Logs > System Log > All.
      Note: The data stream action to get users should retrieve multiple pages of users successfully. Don't write to the Software Subscription table [samp_sw_subscription] until you verify that the data stream action retrieves all users. To verify, you can make a subflow that consumes the data stream and log the results.
    13. After verifying that the subflow is working as expected, click Publish.
      Tip: You can still edit the subflow after it is published.
    Previous topic
    • Create a data stream action to get users
    Next topic
    • Create a data stream action to get user activity

    Tags:

    Feedback
    On this page

    Previous topic

    Next topic

    • Contact Us
    • Careers
    • Terms of Use
    • Privacy Statement
    • Sitemap
    • © ServiceNow. All rights reserved.

    Release version
    Choose your release version

      Create a subflow to get users

      • Save as PDF Selected topic Topic & subtopics All topics in contents
      • Unsubscribe Log in to subscribe to topics and get notified when content changes.
      • Share this page

      Create a subflow to get users

      Create a subflow to add a list of users to the Software Subscription table.

      Before you begin

      Role required: flow_designer or admin

      This subflow requires a data stream action to get users. For more information, see Create a data stream action to get users.

      About this task

      Note: For examples of subflows to get users, search for the Jira Download Subscriptions and Webex Download Subscriptions subflows in Flow Designer. To view these subflows, request the Cisco Webex Meetings spoke and Jira spoke apps on the ServiceNow Store.

      Procedure

      1. Navigate to Flow Designer > Designer.
      2. Click New and then select Subflow.
      3. On the form, fill in the fields.
        Field Value
        Name Name of your choice. For example, Application Download Subscriptions, where Application is the name of the SaaS application you are integrating with.
        Application Software Asset Management - SaaS License Management Integrations.
        Note: If you save the subflow in the Software Asset Management - SaaS License Management Integrations application, it is included with your Software Asset Management subscription. If you save the subflow in any other application, you may be charged for IntegrationHub transactions. If you are publishing your custom spoke application on the ServiceNow Store, select your custom app instead.
        Accessible From All application scopes.
        Category Leave this field empty.
        Protection None.
        In-Flow Annotation Leave this field empty.
        Description Description of your choice.
        Run As User who initiates session.
      4. Add an integration profile input.
        Table 1. Inputs
        Label Name Type Mandatory
        Integration profile integration_profile Reference.Integration Profile Yes
      5. In the Actions section, click the plus icon and then click Action to add a new action.
      6. Select the spoke for the SaaS application you want to integrate with from the list of installed spokes.
        Note: To add additional spokes to your list of installed spokes, request them on the ServiceNow Store. For a complete list of available spokes, see IntegrationHub available spokes. If there is no existing spoke for the SaaS application you want to integrate with, you can create a new spoke.
      7. Select a data stream action to get users.
      8. Define the values to pass for any user authentication inputs for the data stream action.
      9. The data stream action may return users that you do not want to include in your list of user subscriptions. If you need to perform filtering to exclude some users, add an If flow logic as a child of the get users data stream action.
        The amount of required filtering, if any, depends on the specific application you are integrating with. For example, if the user targetObject has an active property, you could add a condition to check that the value is true to ensure that the subflow does not download deactivated users. An example of filtering used by the Jira Download Subscriptions subflow is that the account type cannot be app to prevent the subflow from returning accounts that are not actual users.
        1. Add conditions to the If flow logic for any required filtering.
      10. If you are using an If flow logic to filter users, add the Upsert User Subscription action from the Software Asset Management spoke as a child of the flow logic. If you are not filtering users, add the Upsert User Subscription action as a child of the get users data stream action.
        This action adds the SaaS application user subscription to the Software Subscription table [samp_sw_subscription]. If the subscription is already in the table, the action updates the subscription record.
      11. Use values from the Data panel to fill in the action inputs. Your request to the SaaS API may not return data for all the inputs. Fill in the inputs that are applicable to your integration.
        Table 2. Upsert User Subscription action
        Field Value
        External user id User id or account id from the user targetObject. This is generally a numeric, non human-readable value.
        User principal name Email address from the user targetObject. If email address is not available, use another value such as user name plus user id. This value must be unique and should be human readable.
        Integration profile [Integration Profile] Integration profile input you created for the subflow.
        Product [Software Product] Software product you are connecting to with the integration. This value must be a reference to the Software Product table [samp_sw_product]. If the product does not exist in the table, add a custom software product.
        Version Version of the SaaS application.
        Edition Edition of the SaaS application, such as Standard or Enterprise.
        Last activity Date of most recent activity from the user targetObject. For example, last login time.
        External created

        Account creation date from the user targetObject.

        This value helps create better reclamation candidates. A new user may not have any activity yet. If the record shows that the user account was just created, a reclamation candidate won't be created for that user because it is a new account rather than an unused account.

      12. Click Test to test your subflow.
        1. View the test results and system logs for details about any errors.
          To view system logs, navigate to System Logs > System Log > All.
        Note: The data stream action to get users should retrieve multiple pages of users successfully. Don't write to the Software Subscription table [samp_sw_subscription] until you verify that the data stream action retrieves all users. To verify, you can make a subflow that consumes the data stream and log the results.
      13. After verifying that the subflow is working as expected, click Publish.
        Tip: You can still edit the subflow after it is published.
      Previous topic
      • Create a data stream action to get users
      Next topic
      • Create a data stream action to get user activity

      Tags:

      Feedback

          Share this page

          Got it! Feel free to add a comment
          To share your product suggestions, visit the Idea Portal.
          Please let us know how to improve this content

          Check any that apply

          To share your product suggestions, visit the Idea Portal.
          Confirm

          We were unable to find "Coaching" in Jakarta. Would you like to search instead?

          No Yes
          • Contact Us
          • Careers
          • Terms of Use
          • Privacy Statement
          • Sitemap
          • © ServiceNow. All rights reserved.

          Subscribe Subscribed Unsubscribe Last updated: Tags: January February March April May June July August September October November December No Results Found Versions Search preferences successfully updated My release version successfully updated My release version successfully deleted An error has occurred. Please try again later. You have been unsubscribed from all topics. You are now subscribed to and will receive notifications if any changes are made to this page. You have been unsubscribed from this content Thank you for your feedback. Form temporarily unavailable. Please try again or contact  docfeedback@servicenow.com  to submit your comments. The topic you requested does not exist in the release. You were redirected to a related topic instead. The available release versions for this topic are listed There is no specific version for this documentation. Explore products Click to go to the page. Release notes and upgrades Click to open the dropdown menu. Delete Remove No selected version Reset This field is required You are already subscribed to this topic Attach screenshot The file you uploaded exceeds the allowed file size of 20MB. Please try again with a smaller file. Please complete the reCAPTCHA step to attach a screenshot
          Log in to personalize your search results and subscribe to topics
          No, thanks Login