Digital integration form in EA Workspace

  • Release version: Xanadu
  • Updated August 1, 2024
  • 4 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Digital Integration Form in EA Workspace

    The Digital Integration form in EA Workspace allows ServiceNow customers to manage and update digital integrations between business applications or between a business application and an external company. This form facilitates defining and tracking the technical and business aspects of integrations that use digital interfaces (APIs) for data exchange or process interactions.

    Show full answer Show less

    Key Features

    • Identification Fields: Includes unique integration name and auto-generated number (DINTG prefix) for easy reference.
    • Provider and Subscriber Details: Defines the provider and subscriber business applications along with their digital interfaces. These fields clarify ownership and responsibilities but do not dictate data flow direction.
    • Integration Type and Subtype: Supports categorizing integrations as Data Integration, Process Integration, or User Interface Integration, with further subtypes available for Data Integration to specify the nature of exchanged data.
    • Version and Life Cycle: Enables versioning and life cycle tracking of integrations, aiding application owners and architects in managing changes and states over time.
    • Business Context: Includes fields for Business Unit ownership and a detailed description explaining the purpose and business value of the integration.

    Functional Configuration

    • Data Flow Direction: Specify whether data flows outgoing (provider to subscriber), incoming (subscriber to provider), or bidirectional.
    • Trigger and Frequency: Defines how and when the integration is initiated, including manual, scheduled, event-driven triggers, and interval options from seconds to years or real-time.
    • Response and Interaction Types: Indicates synchronous or asynchronous responses and interaction models such as Guaranteed Message, Pub-Sub, Pull, Push.
    • Middleware: Records any middleware used to facilitate the integration.

    Business Impact Assessment

    • Allows classification of the integration’s criticality, confidentiality, integrity, and availability using standardized levels from Low to Critical. This helps in risk assessment and prioritization.

    Ownership and Support

    • Identifies business and IT owners responsible for the integration, support groups, and subject matter experts (SMEs) who provide ongoing support and maintenance.

    Additional Details

    • Work Notes: A section for comments and notes regarding the integration for documentation and collaboration purposes.

    Practical Benefits for ServiceNow Customers

    This form centralizes critical information about digital integrations, enabling effective governance, lifecycle management, and impact analysis. By using standardized fields and tracking mechanisms, customers can ensure clarity around responsibilities, data flows, and integration health. This supports better decision-making, risk mitigation, and alignment between business and IT teams managing integrations in their ServiceNow environments.

    Use the digital integration form to update the digital integration between two business applications and between a business application and an external company.

    Table 1. Digital Integration form
    Field Description
    Name Unique and meaningful name of the digital integration.
    Number Number of the digital integration. This field is automatically generated with the DINTG prefix and can’t be edited.
    Provider Digital Interface Name of the digital interface. Because a digital integration between two business applications or services uses a digital interface (API), you must select an interface related to the provider business application or service. This field is automatically generated and can’t be edited.
    Provider Business Application Name of the business application that provides the digital interface and enables to consume or ingest data. Changes, ownership, and responsibilities of the interface are often connected to the provider.
    Note:
    Being a provider or subscriber business application doesn’t refer to the data flow direction (incoming, outgoing, bidirectional). The data flow direction is managed by the Data Flow Direction attribute.
    This field is automatically generated and can’t be edited.
    Subscriber Digital Interface Name of the digital interface that subscribes for the integration.
    Subscriber Business Application Name of the business application that uses the provided interface to consume, exchange, or ingest data to support a business capability. The subscriber business application is affected by the changes or an outage face connection or data loss.
    Note:
    Being a provider or subscriber business application doesn’t refer to the data flow direction (incoming, outgoing, bidirectional). The data flow direction is managed by the Data Flow Direction attribute.
    Subscriber company Reference to the (external) company subscribing to this integration.
    Type Type of the integration.
    Use the following options:
    • Data Integration: Use this option when the integration must mainly focus on the exchange of data such as users, groups, locations, configuration items, and departments.
    • Process Integration: Use this option when the integration is about an interaction of transactional data to support a specific process.
    • User interface Integration: Use this option when the integration opens a connection with another application and sends app data via a URL to query the application.
    Subtype Subtype of the integration.
    This field appears only when Data Integration is selected from the Type field. Use the following options:
    • Process configuration
    • Foundation data
    • Configuration items
    • Events
    • Reporting
    • Sys log
    Version Version of the integration. You can apply a practice of designing, planning, and managing changes to an Integration. You can describe the different changes and capabilities according to version in the Description field. This field helps Application Owners and Architects to look up which version of an integration is in use. This also helps to decide whether to change the life cycle.
    Life Cycle Stage Life cycle stage of the integration.

    Helps to track the life cycles for products, assets, contracts, CIs, locations, and other objects. Using the standard CSDM life-cycle values helps you to track objects through their transitions over time. Reporting can therefore accurately reflect the actual states of CIs: usage, availability, end of support, and so on.
    Life Cycle Stage Status Life cycle stage status of the integration. The state transition of a Digital Integration guides you through the different stages of its life cycle. A life-cycle state is the combination life-cycle stage and life-cycle status of a Digital Integration during the life cycle.
    Business Unit Name of the business unit that the integration belongs to.
    Description Description of the digital integration. Describe in detail why the integration is being created between two business applications or between an external service provided interface and a business application and what business value it adds.
    Table 2. Functional section fields
    Field Description
    Data flow direction Direction of the data flow in the integration.
    Use the following options:
    • Outgoing: Provider to Subscriber: Data flow from the Provider business application to the Subscriber business application.
    • Incoming: Subscriber to Provider: Data flow from the Subscriber business application to the Provider business application.
    • Bidirectional: Flow of data in both directions: Data flows in both the directions between the Provider and Subscriber business applications.
    Initiating application Name of the application, which initiates the data flow. It can be a Provider or a Subscriber business application.
    Trigger How to trigger the integration.
    Use the following options:
    • Manual
    • Scheduled
    • Process Driven
    • Event
    Interval Frequency to trigger the integration.
    Options for the interval are as follows:
    • Seconds
    • Minutes
    • Hours
    • Days
    • Weeks
    • Months
    • Quarters
    • Years
    • On Demand
    • Real Time.
    Response Type of the response received by the subscriber.
    Use the following options:
    • Synchronous
    • Asynchronous
    Interaction type Type of the interaction between the provider business application and the subscriber business application.
    Use the following options:
    • Guaranteed Message
    • Pub-Sub
    • Pull
    • Push
    Middleware Name of the middleware used in the integration.
    Table 3. Business Impact section fields
    Field Description
    Criticality Level of the business impact criticality. Use the following options:
    • Low
    • Medium
    • High
    • Critical
    Confidentiality Confidentiality level of the integration. Use the following options:
    • Low
    • Medium
    • High
    • Critical
    Integrity Integrity level of the integration. Use the following options:
    • Low
    • Medium
    • High
    • Critical
    Availability Availability of the integration. Use the following options:
    • Low
    • Medium
    • High
    • Critical
    Table 4. Owners section fields
    Field Description
    Business owner The owner of the business function who owns the digital integration. It can be the same person who owns the parent subscriber business application.
    IT owner The owner within the IT organization who owns the digital integration. It can be the same person who owns the parent subscriber business application.
    Supported by Name of the Subject Matter Expert (SME) or individual who provides support to the digital interface.
    Support group Name of the group that provides support to the digital interface.
    Table 5. Activities section fields
    Field Description
    Work notes Comments about the integration.