Use replay mode to troubleshoot an Architect flow
In replay mode, you can see what happened when a flow ran to troubleshoot and debug it.
- Architect > Flow Instance > View permission
- Architect > Flow Instance > Search permission
- When a flow is in replay mode, you cannot edit it.
- For more information about the flow types that replay mode is supported for, see Historical flow execution data overview.
To open a flow in replay mode, follow these steps:
- From the Architect Home page, click or hover over the Flows menu and select the desired flow type.
- Open the flow that you previously executed to debug and troubleshoot it. The flow’s configuration page opens.
- If the flow is in read-only mode, click Execution History.
- If the flow is in edit mode, click the down arrow next to Save and perform one of the following steps:
- To view the execution history of previous versions of the flow, select Execution History from the drop-down.
- To enter read-only mode, choose one of the following options:
- Click Check In to save your work in progress as a new version of the flow, and then click Execution History.
- Click Revert to revert to the previous version of the flow, and then click Execution History.
- From the Flow Execution History Results list, click a flow instance that you want to replay. The flow instance opens in replay mode.
View the following sections to learn about features in replay mode.
To debug a flow instance, use the replay controls to navigate across flow execution items (actions, tasks, or menus) in the replay timeline at the bottom of the page. The controls allow you to go back to any point in the flow execution history by stepping backwards and forwards. Replay actions are available from the toolbar and via customizable keyboard shortcuts. To change the default keyboard shortcuts, click Preferences.
|Play or pause
Replay the flow instance from start to end or pause the replay. To select the playback speed, click and select the appropriate speed. You can choose between Fast, Default, and Slow.
If you have already stepped through several items, the play command plays forward from the flow execution item you are currently on until the end or the next breakpoint if a breakpoint exists.
|Control + F7
|Step forward to the next flow execution item and enter into it to follow its execution step by step.
|Step forward to the next flow execution item and follow its execution without showing any component steps.
|When inside a flow execution item, complete any remaining component steps as a single step to step forward to the next flow execution item.
|Step Back In
|Step backward to the previous flow execution item and enter into it to follow its execution step by step.
|Control + F11
|Step Back Over
|Step backward to the previous flow execution item and follow its execution without showing any component steps. Execution replay stops when it encounters a breakpoint.
|Control + F10
|Step Back Out
|Step backward to the previous flow execution item from inside a flow execution item.
|Control + F9
|Play to End
|Resume flow execution replay up to the next breakpoint or until the end.
|Control + F6
Play backwards to Start
|Play backwards to the start of the flow or a previous breakpoint if a breakpoint exists.
|Control + F4
|Set or clear a breakpoint
|Insert a breakpoint where you want the flow execution replay to stop. Remove a breakpoint you previously set.
|Use the up and down arrows to navigate between execution items.
In replay mode’s timeline tab at the bottom of the page, you can inspect and debug all flow execution items, and navigate across them. The following replay actions are available:
- Click the flow execution item (flow start, action, task, menu, or flow end) that you want to inspect. Architect displays the flow execution item in replay mode and highlights it in purple in the editor or design area. You can also use the replay controls to navigate between the items. For more information, see Use the replay controls.
- Hover over the flow execution item that you want to inspect. Architect displays various information depending on the execution item you want to inspect:
- Flow Started: Architect displays the flow execution ID, the flow’s starting language as well as the flow’s start time. Flow Execution ID is the unique identifier that Architect uses to identify an instance of a flow that ran.
- Flow Ended: Architect displays the flow’s end time and the exit reason.
- For any other execution item, Architect displays the name and type of the action that the flow executed, the time of execution and the execution ID, the stack execution ID, the output path the flow followed, and the action ID. The stack execution ID is a unique identifier for where the execution item is in the flow’s execution stack. You can copy most of this information to the clipboard. Click to copy.
Click the image to enlarge.
- Click Execution History to open the Flow Execution History dialog box. The dialog box gives you access to the Query Builder and, by default, to the list of flow instances whose Flow Id matches the Flow Id of the flow instance you are currently viewing. You can run a query based on other flow criteria such as Flow Error Code, Flow Warning Code, Invoking Flow Object Execution Id, or Flow Invoked Error. You can also query the historical data by Conversation Id, which is particularly useful when there are many instances of the same conversation-based flow. For more information about building a flow execution query, see Build a flow execution history query.
- Click to show or hide the Stack Graph.
- Click the Zoom drop-down to adjust the timeline’s zoom level from no zoom to small, medium, and full zoom.
- Click Preferences to change keyboard shortcuts or customize the replay mode view.
- Architect GUIDs
- specific actions, menus, states or tasks
You can use various operators to narrow down your search. To select a search operator, click and select one of the following operators:
- Contains = Architect returns all search results that contain all the characters that you specify.
- Exact = Architect returns all search results that match the characters that you specify exactly.
- Starts with = Architect returns all search results that start with the characters that you specify.
To switch between the flow’s default language and supported languages, click the down arrow next to the language filter and select the preferred language to view.
To work with element IDs, follow one of these steps:
- To show or hide element identification numbers, click Show or hide action, menu, task, and state IDs.
- To jump to a specific element, click the down menu, select Go To, and select the appropriate ID.
To find flows that reference and use the current flow, click Find consuming flows.
To export flow execution or configuration data, click Export and click one of these options:
- Export execution data
- Export as .i3xxx
- Export as .yaml
- Click Preferences. The Preferences dialog box appears.
- Select Keyboard Shortcuts.
- Use the Search field to search for existing shortcuts.
- Use the Filter By field to narrow the list of displayed keyboard shortcuts:
- Select Flow to display the keyboard shortcuts that you can use to perform actions within the flow.
- Select Global to display the keyboard shortcuts that you can use to open the Keyboard Shortcuts view or toggle the Expression Help view.
- Select Replay to display the keyboard shortcuts that you can use for the Replay commands.
- Click to import shortcuts.
- Click to export shortcuts.
- Click Reset to Defaults to restore the default keyboard shortcuts.
- (Optional) You can define primary and secondary keystrokes for any shortcut.
- Click Save to save your changes or click Cancel to discard them.
To customize the replay mode view, complete the following steps:
- Click Preferences. The Preferences dialog box appears.
- Select Replay Mode.
- Click Show All Communication Frames to show all communication data in the Communications panel.
- Click Show Values in Local to use the display format for values that the local language in which the flow ran standardly uses. For example, show decimal values with the comma as the decimal separator if the local language was German, or use a local date and time display format instead of ISO-8601 to communicate date- and time-related data.
- Click Show Stack Graph to show a graph that indicates the levels of the stack the flow executed through.
- Select the desired Timeline Zoom Level from the drop-down. The possible values are Zoom Off, Zoom Small, Zoom Medium, Zoom Full.
- From the Stack drop-down, select whether to show the panel and if so, whether to show it on the bottom or on the side.
- From the Frame Details drop-down, select whether to show the panel and if so, whether to show it on the bottom or on the side.
For more information, see Use the replay controls.