Remote Process Sync Outbound Flow Template - Basic

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 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 Outbound Flow Template - Basic

    The Remote Process Sync Outbound Flow Template allows ServiceNow customers to send outgoing payloads to a remote instance, creating a correlation between remote records and local incident records. This subflow can be customized by copying it and adjusting the input for the local record as needed.

    Show full answer Show less

    Key Features

    • Global Availability: This subflow is available as a Global Remote Process Sync subflow.
    • Integration Hub Requirement: Requires an Integration Hub subscription for activation.
    • Role Requirements: Users must have roles granted by delegated development for access.
    • Inputs:
      • Wait for Completion: Option to pause the parent flow until the subflow completes.
      • Local Record: Reference to the local instance record being synchronized.
      • Remote System: Reference to the Process Sync Remote System record for the remote instance.
      • CRUD Operation: Specifies the database operation (Create, Update, or Delete) that triggered the process event.
      • Trigger/Capture Definition: Reference to the Capture Definition record used for creating an outbound payload.
      • Process Event: String representing the name of the process event to execute across instances.
      • Payload: Object containing changes generated by the capture definition, transformed to a JSON string for transmission.

    Key Outcomes

    • Status Output: Indicates the synchronization state of records (Active or Inactive).
    • Error Message Output: Displays any error messages returned by the action.

    A sample Remote Process Sync subflow to send outgoing payloads to a remote instance. This subflow creates a correlation between a remote record and a local incident record. Copy this subflow and edit the input for the local record to the table of your choice.

    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 Flow Designer.

    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.

    Local Record
    Data type: Record

    Reference to a record on the local instance you are synchronizing with another instance. The data pill contains all the field values for the specified record. For example, a case record on the local instance.

    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.

    CRUD Operation
    Data type: Choice

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

    Trigger/Capture Definition
    Data type: Record

    Reference to the Capture Definition record that the system uses to create an outbound payload. The data pill contains all the field values for the specified record. For example, a capture definition for case records.

    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: Object

    Object containing changes generated by a capture definition. For example, a list of field changes for a case record on the local instance. The system transforms this object to a JSON string to send it to a remote instance.

    Outputs

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

    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.

    Error Message
    Data type: String

    Error returned by the action.