Robotic Process Automation (RPA) Spoke

  • Release version: Washingtondc
  • Updated February 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 Robotic Process Automation (RPA) Spoke Build workflows

    The RPA Spoke provides a two-way integration between Flow Designer and RPA Hub, allowing for seamless execution of robotic processes. This integration enhances automation capabilities, enabling users to manage and execute bots more efficiently.

    Show full answer Show less

    Key Features

    • Add WorkItem to Queue: Adds a work item to a designated queue in RPA Hub and returns its ID. Supports encryption for sensitive data.
    • Assign User Actions: Assigns users to attended automation processes and robots, with the ability to unassign them as needed.
    • Change Lifecycle Stage: Updates the lifecycle status of a bot process, such as transitioning between Build and Published states.
    • Fetch Job and Execution Status: Retrieves job details and execution status for specific processes, aiding in monitoring and management.
    • Start/Stop Process: Initiates or halts bot processes, with options for graceful stopping to ensure clean termination.
    • Update WorkItem: Modifies details of work queue items, including content and priority, while allowing for sensitive data handling.
    • Verify Package Version: Validates the HashCode of a package version for security and compliance during automation deployments.

    Key Outcomes

    By leveraging the RPA Spoke, ServiceNow customers can expect enhanced control over their robotic processes, improved integration with existing workflows, and efficient management of automation tasks. This results in increased productivity and streamlined operations across various business functions.

    Two-way integration of Flow Designer and RPA Hub for a seamless robot execution.

    Table 1. RPA actions
    Action Description Action inputs Action outputs
    Add WorkItem to Queue Action Adds WorkItem in a specified queue in the RPA Hub application and returns the WorkItem ID.
    • Queue Name: Record
    • Name: String
    • Content: String
    • Type: String
    • Priority: String.Choice
    • Stage: String
    • SLA: Date/Time

    The maximum limit for Content field (Request Content and Response Content) is 8000 characters.

    If the Is Work Item Name Sensitive check box on the associated work queue form is selected, the data in the Request Content field is encrypted. Sensitive data with encryption is stored in the work item, so that it can be passed to the RPA Desktop Design Studio or robots.
    • Action Status: Object
    • WorkItemID: GUID
    • IsNameExists: Boolean
    • status: String
    • message: String
    Assign User to Attended Automation Process Action Assigns a user to the attended automation process.
    • Process Name: Record
    • Username: Record
    • Action Status: Object
    • status: String
    • Message: String
    Assign User to Attended Robot Action Assigns a user to the attended robot. Username: Record
    • Action Status: Object
    • status: String
    • Message: String
    Change Life Cycle Stage Status of a Bot Process Action Changes the life cycle stage status of a bot process that is not retired.

    If a bot process is in Build life cycle stage status, if you have the required role, you can update it to Published state, but you cannot update it to In Maintenance.

    If a bot process is in Published life cycle stage status, if you have the required role, you can update it to In Maintenance state, and vice versa.
    • Process name: Record
    • Life cycle stage status: Choice
    • result: String
    • message: String
    • Action Status: Object
    Fetch Created Jobs Action Fetches the process jobs in RPA Hub.
    • Process Number: String
    • Robots: Array[String]
    • Action Status: Object
    • Result: String
    • Jobs: Array[String]
    • startedRobots: Array[String]
    • pendingRobots: Array[String]
    Fetch Execution Status Action Fetches the execution status of a specific process job in RPA Hub. Process Job Number: String
    • Action Status: Object
    • ProcessJob: Object
      • Process Name: String
      • Robot Name: String
      • State: String
      • Started At: Date/Time
      • Completed At: Date/Time
      • Message: String
    • status: String
    • message: String
    Fetch Work Item Status Action Fetches the status of specific work queue items, asynchronously. Work Queue Item ID: GUID
    • Action Status: Object
      • Code: Integer
      • Message: String
    • WorkItem: Object
      • sysId: String
      • name: String
      • type: String
      • priority: String
      • status: String
      • lockedBy: String
      • additionalComments: String
      • requestContent: String
      • responseContent: String
      • deferredTill: Date/Time
      • sla: Date/Time
      • created: Date/Time
      • startedOn: Date/Time
      • completedOn: Date/Time
      • lastStartedTime: Date/Time
    • status: String
    • message: String
    Start Process Action Triggers a specific bot process in RPA Hub and returns the status.
    • Process Name: Record
    • Robots: Array[String]

      Ignore an entry in this field if a robot pool is assigned to the bot process.
    • Action Status: Object
    • Result: String
    • Robots: Array[String]
    • Process: String
    Stop Process Action Stops a bot process. If Graceful Stop is enabled, this action gracefully stops the bot process.
    • Result: String
    • Action Status: Object
    • Robots: Array[String]
    • Process: String
    • Failed Robots: Array[Object]
    Unassign User from Attended Automation Process Action Unassigns the user from the attended automation process.
    • Process Name: Record
    • Username: Record
    • status: String
    • message: String
    • Action Status: Object
    Unassign User from Attended Robot Action Unassigns the user from the attended robot and retires the attended robot. Username: Record
    • Action Status: Object
    • Status: String
    • Message: String
    Update Process Parameter Action Updates the Value field for the process parameter.
    • Process: Record
    • Parameter Name: String
    • Value: String
    • status: String
    • Action Status: Object
    • message: String
    Update WorkItem Action Updates work queue items.
    • Queue Name: Record
    • WorkItemID: String
    • Stage: String
    • DefferedTill: Date/Time
    • Name: String
    • Priority: Choice
    • Status: Choice
    • Request Content: String
    • Type: String
    • Remarks: String
    • SLA: Date/Time
    • Response Content: String

    The maximum limit for Request Content and Response Content fields is 8000 characters.

    If the Is Work Item Name Sensitive check box on the associated work queue form is selected, the data in the Request Content field is encrypted. Sensitive data with encryption is stored in the work item, so that it can be passed to the RPA Desktop Design Studio or robots.
    • IsNameExist: True/False
    • Status: String
    • Message: String
    • Action Status: Object
    Verify HashCode of a Package Version Verifies the HashCode of a package version in RPA Hub to validate the HashCode of the manually uploaded automation zip file with the associated package version record.

    For more information about verifying the HashCode of a package version, see .

    		 Package Version: Record
    • Action Status: Object
    • Message: String
    • isAttachmentValid: True/False
    Table 2. RPA subflow
    Subflow Description Subflow inputs Subflow outputs
    Import Package Version Attachment Subflow Imports the package version attachments automatically for a package version. To automatically migrate the package attachment (automation zip file) from a lower (non-production) to a higher (production) environment.

    For more information about importing a package version attachment in RPA Hub, see .
    • Email: Email
    • Package Version: Record

    After the attachment is uploaded successfully or if an error occurs while uploading the attachment, an email notification (if email is provided as an input) is sent to the user who performs this import attachment action.
    Start Process Subflow Triggers a specific bot process in RPA Hub. Returns process job details.
    • Process Name: Record
    • Robots: Array[String]

      Ignore an entry in this field if a robot pool is assigned to the bot process.
    • Process Jobs: Array[String]
    • Result: String
    • Message: String
    Stop Process Subflow Triggers a specific bot process to stop in RPA Hub. Returns robots details and process job status. If Graceful Stop is enabled, this subflow gracefully stops the bot process.
    • Graceful Stop: True/False
    • Process Name: Record
    • Robots: Array[String]
    • Failed Robots: Array[Object]
    • Stopped Robots: Array[String]
    • Pending Robots: Array[String]
    • Process Jobs: Array[String]
    • Message: String
    • Result: String