Remote Process Sync Inbound Flow Template - Basic

  • Release version: Yokohama
  • Updated January 30, 2025
  • 2 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 Remote Process Sync Inbound Flow Template - Basic

    This Remote Process Sync subflow template enables ServiceNow customers to process incoming synchronization payloads from a remote instance. It establishes a correlation between remote records and local incident records, facilitating seamless data synchronization across instances. Customers can customize this template by copying and modifying actions, especially those related to the Incident table, to fit their specific use cases.

    Show full answer Show less

    Key Features

    • Global Availability: Provided as a global Remote Process Sync subflow accessible across instances.
    • Subscription Requirements: Requires an Integration Hub subscription to use this action.
    • Role Requirements: Requires delegated development roles or user-assigned roles to access and modify the flow.
    • Input Parameters:
      • Wait for Completion: Boolean option to make the parent flow wait until the subflow finishes processing.
      • Remote System: Reference to the remote instance's Process Sync Remote System record, identifying the source or target instance.
      • Remote Correlation ID: Unique ID representing the correlation on the remote instance for outbound synchronization.
      • Local Correlation ID: Unique ID for the local instance’s inbound correlation.
      • Process Event: Name of the synchronization event common to all synchronized instances (e.g., case-to-incident).
      • Payload: JSON string containing the remote instance’s record changes, which the system parses into an object locally.
      • CRUD Operation: Specifies the database operation triggering the event (Create, Update, or Delete).
    • Outputs:
      • Error Message: Returns any error encountered during processing.
      • Status: Indicates whether the synchronized record is Active (being synchronized) or Inactive (not synchronized).

    Practical Considerations

    This template is designed to streamline the inbound synchronization process between ServiceNow instances, ensuring data consistency and enabling automated incident management workflows. By configuring the input parameters appropriately, customers can control synchronization behavior, handle errors, and monitor synchronization status effectively. Customizing the template allows tailoring to specific table structures beyond incidents.

    A sample Remote Process Sync subflow to process incoming payloads received from a remote instance. This subflow creates a correlation between a remote record and a local incident record. Copy this subflow and edit the actions that refer to the Incident table.

    Roles and availability

    Available as a Global Remote Process Sync subflow.

    Subscription requirements
    This action requires an Integration Hub subscription. For more information, see Request Integration Hub and Legal schedules - IntegrationHub overview.
    Role requirements
    This action requires roles granted by delegated development or assigned to the user. For more information, see User access to Workflow Studio flows.

    Inputs

    Provide a value for each input that your action needs. To add dynamic values, you can also drag pills from the Data panel or select them from the pill picker.

    Wait for Completion
    Data type: True/False

    Option to require the parent flow to wait for the subflow to complete. If enabled, the parent flow cannot proceed to the next action until the subflow completes.

    Remote System
    Data type: Record

    Reference to the Process Sync Remote System record for the remote instance you are synchronizing processes with. This record identifies the instance that receives outbound synchronization changes or that sent inbound synchronization changes.

    Remote Correlation ID
    Data type: String

    Globally unique ID of a correlation on a remote instance you are synchronizing processes with. This ID uniquely identifies the correlation for outbound transactions.

    Local Correlation ID
    Data type: String

    Globally unique ID of a correlation on the local instance you are synchronizing processes with. This ID uniquely identifies the correlation for inbound transactions.

    Process Event
    Data type: String

    Name of the process event to run. The name is the same on each instance that participates in process synchronization. For example, case-to-incident.

    Payload
    Data type: String

    JSON string containing changes generated on a remote instance. For example, a list of field changes for a case record from a remote instance. The system transforms this JSON string to an object on the local instance.

    CRUD Operation
    Data type: Choice

    Database operation that triggered the process event. The available options are Create, Update, or Delete.

    Outputs

    These outputs appear in the Data panel. You can use them as inputs elsewhere in your flow.

    Error Message
    Data type: String

    Error returned by the action.

    Status
    Data type: Choice

    Synchronization state of records. The available options are Active or Inactive. Active records are being synchronized. Inactive records are not synchronized.