The Perspectium Spoke app uses ServiceNow's IntegrationHub and Flow Designer to allow users to share records out of their ServiceNow instance with minimal configuration. The app is available as a spoke in when the user creates a new flow and users have the ability to choose the table they want to share records from. Using the action in the spoke, the Perspectium Spoke will set up the XML of the record and set it out via REST post request.
NOTE: The flow_designer role is required for you to create and edit a Flow in Servicenow. Ensure that you have at least the flow_designer role before proceeding.
Procedure
To configure the Flow Designer provided with the Perspectium Spoke application, follow these steps:
Access Share Records Flow Designer
Go to Flow Designer. Under the Flows section, click on Share Records. This Flow is a skeleton with some basic logic for sharing out records.
Create a Trigger
Click Select to add a Trigger. Add a Trigger on Record Created, Record Updated, or Record Created or Updated.
Select the Table to share records from.
If applicable, for the Run Trigger option, select Only if not currently running. Then, click Done.
NOTE: This option performs the workaround for London+ releases where Flows are not triggered by Journal Entry updates. Only if not currently running ensures the Flow is triggered for every unique change, including the addition of comments and work notes. More information about the trigger types is available here.
Configure Post Message Action
The Post Message Action is the Flow Designer component that is responsible for sharing out a record to the Perspectium Integration Mesh. When a record triggers the custom Flow, Post Message Action builds a message containing the record to share out to the Perspectium Integration Mesh.
Click on the Action 1 in the Flow, the Post Message step.
Use the Data Pill Picker to fill in the Table Name, Sys ID, and Journal Fields slots.
For Table Name, click on the Data Pill Picker symbol to the right of the Table Name slot to open the flyout. Click on Trigger, then select the Table option, which will contain the name of the table that is being used to trigger the Flow.
For Sys ID, click on the Data Pill Picker symbol to the right of the Sys ID slot to open the flyout. Click on Trigger, then select the arrow on the Record option. From the list of record elements, select the Sys ID option.
(Optional) For Journal Fields, click on the Data Pill Picker symbol to the right of the Journal Fields slot to open the flyout. Click on Trigger, then select the Changed Fields option. This will allow comments and work notes to be shared out in the record payload.
(Optional) If the records need to be shared in Perspectium’s Common Document format, check the Share as Common Document box. Tables supported in Common Document format for the Perspectium Spoke are Change Request, Incident, Problem, Request, Requested Item, and Task.
(Optional) If work notes need to be shared out as well, check the Share Work Notes box.
(Optional) Set up Email Notifications
Save and activate Flow Designer
In the upper right corner of Flow Designer, click Save and then click Activate. Confirm Flow Activate if needed.
After the flow is activated, records should be sent out of the instance when the flow is triggered. To confirm records are being shared, check the Flow Executions.
- Using the Changed Fields pill will ensure that comments are shared out in the same payload as the base record.
- The Catalog Task (sc_task) table is not supported by Flow Designer and cannot be used to trigger flows.
- The Requested Item (sc_req_item) table is supported by Flow Designer for inserts only, and does not support sharing out comments and work notes. Flows triggered on Requested Items require the use of the Service Catalog trigger, which requires the Service Catalog plugin.