Flow Designer has a number of ways to help you see at a glance if there's a hiccup somewhere along the way. This can happen for a variety of reasons -- for example, a step is missing required configuration, another system isn't responding to a request from one of the steps, or an input can't consume the information it's fed at runtime.
There are a few visual indicators to help make sure you don't have any problems during runtime. If you don't see these indicators but your flow isn't doing what you expect, use the Activity panel to debug runtime issues.
|Missing configuration: When a step is missing configuration or information it's relying on, a warning badge appears in the corner.|
|No agents connected: When a step is configured to run on an xMatters Agent but no assigned agents are connected, the dot in the agent icon turns from green to red.|
|Unconnected trigger: Triggers only fire if there are steps connected to them. The exception is legacy Integration Builder triggers, which continue to execute whatever script is associated with them.|
|Disabled: You can enable and disable triggers (for example, you might disable a trigger if you're doing some troubleshooting or building out a new flow you don't want to fire just yet). Double-click the trigger and click the Enabled toggle to turn it on or off.|
Deprecated: A custom step or HTTP trigger might be deprecated if a new and improved version is available. In some cases, previously existing integrations built using the Integration Builder (such as the Notification Responses trigger for outbound integrations) are marked as deprecated because we've introduced an updated trigger in Flow Designer that you should use instead.
Withdrawn: The version of the step has been withdrawn from use. Double-click the step in the flow to open its configuration screen (or select it and click the pencil icon) and select a newer version. Also check other steps further down the flow for alert badges that indicate missing configuration, since changing the step version might remove outputs used by these steps.
|Orphans: When you disconnect steps from the previous step, they're orphaned. Since all steps are orphans until you connect them, and you may do this on purpose as you're refining your workflows, we don't warn you, but it's good to take a quick look around to see if you have any unconnected steps.
Flow Designer includes logic to detect and prevent flows from looping and unintentionally overwhelming system resources. Flow Designer considers it a loop when the same flow is triggered multiple times in a short period of time by a single sequence of system events or scripted actions. When it detects a loop at runtime, Flow Designer cancels flow execution and logs an error in the Activity Panel indicating that a loop or circular flow reference was detected. For example, Flow Designer cancels flows when it detects the following types of loops:
- An HTTP trigger executes a script that sends a request to the same HTTP trigger.
- An event status trigger fires when an event is created and the triggered flow creates another event using the same form.
Flow Designer includes an Activity panel that you can use to monitor the system requests for your flows. This is useful for determining if your flows completed successfully, or for troubleshooting and debugging flows that fail.
When you create a flow, xMatters temporarily logs all requests for the flow until it reaches an allowed maximum. It then automatically disables logging except for failed requests which continue to be logged to help with troubleshooting. For more information about re-enabling logging for a flow, see Enable or disable logging.
At the top of the screen, click Activity.
xMatters opens the Activity panel at the bottom of the screen, beneath the canvas and palette. By default, the Activity panel displays a high level view of all the flows on your canvas, including the following:
- Type: An icon that represents the trigger type of your flow.
- Name: The name assigned to your flow on the canvas.
- Logging: A toggle to enable or disable logging for a flow.
By default, logging is automatically enabled for the first 25 requests when a new flow is created. It then automatically switches to logging only failed requests. You can enable logging for a flow to reset the limit and resume logging for the next 25 requests, whether they succeed or fail.
To enable or disable logging:
- On the Activity panel, click View All to return to the list of all flows, if needed.
- In the Logging column, use the toggle to enable or disable logging for a flow.
To view the logged requests for a flow, do one of the following:
- From the high level list of all flows, click the name of a flow.
- Use the Flow drop-down menu at the top of the Activity panel to select a flow.
The left side of the Activity panel displays a list of recent requests for a flow, with the latest requests at the top. Each request is marked with a date and time, and indicates whether the flow completed or if it failed at any stage during runtime. Selecting a request in the list highlights the associated flow on the canvas and displays its details in the Activity panel under the following tabs:
- Steps: Each step in the flow and whether it completed successfully or failed. Select a step to view its input and output parameters, if applicable, and their values.
- For flows triggered by an HTTP request, the step details also contain the parameters, headers, and body of the incoming request.
- Logs: Details about the request and the request log.
- Request Details: The UUID of the request, where it was executed (for example, in the cloud), and the date and time at which the request was submitted. For HTTP triggers, this also includes the authenticating user (the credentials for this user are used to authenticate requests the flow makes to xMatters).
- Log: Specific information about the nature of the request and its contents, and any errors that occurred. If the flow contains steps running on an xMatters Agent, it also provides information on when the flow switched from running on the cloud to the agent and back, and which agent it ran on.
- Event: For flows triggered by an event activity, the event properties and their values.
To see new activity details for a flow, click the Refresh icon. If you're not seeing any activity for a trigger, check that it has steps attached to it — triggers only fire when they're connected to something (except for legacy Integration Builder triggers, which execute any script they have associated with them).