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
    • DevOps
Table of Contents
Choose your release version
    Home Orlando DevOps DevOps DevOps User-created DevOps integrations Create a DevOps tool integration

    Create a DevOps tool integration

    • 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 DevOps tool integration

    To create a DevOps tool integration, your integration developer configures DevOps tool integration settings, and a Flow Designer subflow to collect and transform data from the source tool. Then your DevOps admin configures your DevOps tool connections.

    Before you begin

    Note: When creating an integration as a scoped app, the system admin must assign these roles to the integration developer so the integration developer is able to create tool integration and integration capability records for the specific scope.
    • Developer role for the scoped app
    • DevOps admin role

    Role required: sn_devops.admin

    About this task

    Creating a DevOps tool integration procedure involves configuration by both your integration developer and your DevOps admin.
    • Your integration developer creates a tool integration record in DevOps, a Flow Designer subflow, a tool capability mapping, and an integration capability record in DevOps to map the capabilities and actions together.
      Note: Notification, connect, and discover capabilities are supported.
    • Your DevOps admin sets up DevOps connections (planning or coding tool), and configures the source tool with the webhook and credentials.

    This procedure provides detailed steps to create your DevOps tool integration.

    Procedure

    1. Integration developer:
      Configure the source tool integration capabilities and actions, and a subflow.
      1. Navigate to DevOps > Integrations > Tool Integrations and create a record to define the tool you are integrating (source tool).
        Note: Do not edit the tool integration records provided with the DevOps application.
        Table 1. DevOps tool integration
        Tool label Sample Code Tool
        Table Code Tool [sn_devops_tool]
        Use packageable integrations Selected
        Integration version 1.0
        Active Selected
      2. Navigate to Flow Designer > Designer and create a subflow to collect and transform data from the tool you are integrating (source tool).
        Note: The Run As field must be set to System User, and the Inputs label must be set to current variable.
        Table 2. Notification subflow properties
        Name Code Tool Notification
        Application Sample Integration App
        Accessible From All application scopes
        Description Code tool for integration app
        Run As System User

        The subflow must contain Get More Data via API calls, and/or transform the original payload. Copy the transformed payload into the inbound events record.

        Note: Do not edit the DevOps main flow.
      3. Navigate to DevOps > Integrations > Tool Capability Mappings and create a record to map the tool integration record to the tool type capability.
        Table 3. DevOps tool capability mapping
        Tool integration Sample tool
        Tool type capability Code
      4. Navigate to DevOps > Integrations > Integration Capabilities and create a record to specify the action for the tool capability mapping.
        Note: Do not edit the integration capability records provided with the DevOps application.
        Table 4. DevOps integration capability
        Tool integration Sample Code Tool
        Capability mapping

        Sample Code Tool-Code

        Note: Do not edit tool type capability records.
        Action

        Notification

        Note: Do not edit tool action records.
        Active Selected
        Timeout (ms)
        Note: Starting with version 1.10.

        Timeout for the corresponding subflow. If execution of the subflow exceeds this value, a timeout exception occurs.

        Value is in milliseconds (ms). Default is 45,000 (45 seconds).

        Subflow name

        x_snc_sample_integ.code_tool_notification

        The name is prefixed by the scope name and a dot (.) before the actual subflow name.

        For example, given:
        • connect_code_tool subflow
        • my_app_scope scope
        The value for this field is my_app_scope.connect_code_tool.
        Note: Starting with version 1.11, if the Subflow name field is left blank for a Notification capability, default handling of notifications occurs.

        See Notification tool capability action.

        Domain global
    2. DevOps admin:

      Configure the connection from DevOps to the source tool.

      Refer to Setting up DevOps tools for more details on completing this step.

      1. The tool record must contain:
        • Reference to the tool integration record created by the integration developer (in the Tool field)
        • Tool label
        • Connection alias (connection and credential)
      2. Copy the notification (webhook) created on the DevOps planning tool to the source tool service hook of the notification endpoint and set the credentials to devops.integration.user.
      You can view the state of integration events in the Inbound Event list (DevOps > Administration > Inbound Events).

      The inbound event record state is set to Processed once the object has been inserted into the DevOps Core table. Event states include New, In Progress, Processed, Unmatched, and Error.

    3. If the tool integration record and the subflow are created in a different scope, the DevOps admin must create two new Cross scope privileges records to allow the app to access the inbound events table.
      Navigate to System Applications > Application Cross-Scope Access and create read and write cross scope privileges records to allow your app to access the inbound events table.
      Field Read Write
      Source Scope Auto populated based on the current application
      Target Scope DevOps
      Target Name sn_devops_inbound_event
      Target Type Table
      Operation Read Write
      Status Allowed

    Example

    Figure 1. DevOps tool integration
    DevOpsToolIntegration
    Figure 2. Flow Designer subflow properties
    SubflowProperties
    Figure 3. Flow Designer subflow
    Subflow
    Figure 4. Flow Designer DevOps Integration - Notification flow
    NotificationFlow
    Figure 5. DevOps tool capability mapping
    DevOps User Integration Mapping
    Figure 6. Integration capability
    IntegrationCapability
    Figure 7. Planning tool
    IntegrationPlanningTool
    Figure 8. Cross scope access records (read and write)
    CrossScopeAccess

    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 DevOps tool integration

      • 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 DevOps tool integration

      To create a DevOps tool integration, your integration developer configures DevOps tool integration settings, and a Flow Designer subflow to collect and transform data from the source tool. Then your DevOps admin configures your DevOps tool connections.

      Before you begin

      Note: When creating an integration as a scoped app, the system admin must assign these roles to the integration developer so the integration developer is able to create tool integration and integration capability records for the specific scope.
      • Developer role for the scoped app
      • DevOps admin role

      Role required: sn_devops.admin

      About this task

      Creating a DevOps tool integration procedure involves configuration by both your integration developer and your DevOps admin.
      • Your integration developer creates a tool integration record in DevOps, a Flow Designer subflow, a tool capability mapping, and an integration capability record in DevOps to map the capabilities and actions together.
        Note: Notification, connect, and discover capabilities are supported.
      • Your DevOps admin sets up DevOps connections (planning or coding tool), and configures the source tool with the webhook and credentials.

      This procedure provides detailed steps to create your DevOps tool integration.

      Procedure

      1. Integration developer:
        Configure the source tool integration capabilities and actions, and a subflow.
        1. Navigate to DevOps > Integrations > Tool Integrations and create a record to define the tool you are integrating (source tool).
          Note: Do not edit the tool integration records provided with the DevOps application.
          Table 1. DevOps tool integration
          Tool label Sample Code Tool
          Table Code Tool [sn_devops_tool]
          Use packageable integrations Selected
          Integration version 1.0
          Active Selected
        2. Navigate to Flow Designer > Designer and create a subflow to collect and transform data from the tool you are integrating (source tool).
          Note: The Run As field must be set to System User, and the Inputs label must be set to current variable.
          Table 2. Notification subflow properties
          Name Code Tool Notification
          Application Sample Integration App
          Accessible From All application scopes
          Description Code tool for integration app
          Run As System User

          The subflow must contain Get More Data via API calls, and/or transform the original payload. Copy the transformed payload into the inbound events record.

          Note: Do not edit the DevOps main flow.
        3. Navigate to DevOps > Integrations > Tool Capability Mappings and create a record to map the tool integration record to the tool type capability.
          Table 3. DevOps tool capability mapping
          Tool integration Sample tool
          Tool type capability Code
        4. Navigate to DevOps > Integrations > Integration Capabilities and create a record to specify the action for the tool capability mapping.
          Note: Do not edit the integration capability records provided with the DevOps application.
          Table 4. DevOps integration capability
          Tool integration Sample Code Tool
          Capability mapping

          Sample Code Tool-Code

          Note: Do not edit tool type capability records.
          Action

          Notification

          Note: Do not edit tool action records.
          Active Selected
          Timeout (ms)
          Note: Starting with version 1.10.

          Timeout for the corresponding subflow. If execution of the subflow exceeds this value, a timeout exception occurs.

          Value is in milliseconds (ms). Default is 45,000 (45 seconds).

          Subflow name

          x_snc_sample_integ.code_tool_notification

          The name is prefixed by the scope name and a dot (.) before the actual subflow name.

          For example, given:
          • connect_code_tool subflow
          • my_app_scope scope
          The value for this field is my_app_scope.connect_code_tool.
          Note: Starting with version 1.11, if the Subflow name field is left blank for a Notification capability, default handling of notifications occurs.

          See Notification tool capability action.

          Domain global
      2. DevOps admin:

        Configure the connection from DevOps to the source tool.

        Refer to Setting up DevOps tools for more details on completing this step.

        1. The tool record must contain:
          • Reference to the tool integration record created by the integration developer (in the Tool field)
          • Tool label
          • Connection alias (connection and credential)
        2. Copy the notification (webhook) created on the DevOps planning tool to the source tool service hook of the notification endpoint and set the credentials to devops.integration.user.
        You can view the state of integration events in the Inbound Event list (DevOps > Administration > Inbound Events).

        The inbound event record state is set to Processed once the object has been inserted into the DevOps Core table. Event states include New, In Progress, Processed, Unmatched, and Error.

      3. If the tool integration record and the subflow are created in a different scope, the DevOps admin must create two new Cross scope privileges records to allow the app to access the inbound events table.
        Navigate to System Applications > Application Cross-Scope Access and create read and write cross scope privileges records to allow your app to access the inbound events table.
        Field Read Write
        Source Scope Auto populated based on the current application
        Target Scope DevOps
        Target Name sn_devops_inbound_event
        Target Type Table
        Operation Read Write
        Status Allowed

      Example

      Figure 1. DevOps tool integration
      DevOpsToolIntegration
      Figure 2. Flow Designer subflow properties
      SubflowProperties
      Figure 3. Flow Designer subflow
      Subflow
      Figure 4. Flow Designer DevOps Integration - Notification flow
      NotificationFlow
      Figure 5. DevOps tool capability mapping
      DevOps User Integration Mapping
      Figure 6. Integration capability
      IntegrationCapability
      Figure 7. Planning tool
      IntegrationPlanningTool
      Figure 8. Cross scope access records (read and write)
      CrossScopeAccess

      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