Working with Flows
Open a Flow
Open in read-only mode
A Flow can be opened by browsing to the folder where it is stored and double-clicking it to open in read-only mode. To activate edit mode, simply click Edit in the top ribbon of the Flow.
By selecting one or more Flows in the Solution Explorer these can also be opened from the right-click mouse menu or by clicking the Open button in the top ribbon of Teneo Studio.
Open in edit mode
To open a Flow directly in edit mode, select the Flow and click the Edit button in the top ribbon or, alternatively, press Alt while double-clicking the Flow(s).
Save a Flow
Saving can be done by simply clicking Save in the top ribbon on the Home tab of a Flow. A dialogue box prompts the user to add a comment, next click Ok.
To save directly and bypass the comment, press Alt on the keyboard while clicking Save.
Teneo Studio, furthermore, provides the keyboard shortcut Ctrl+S to save with a comment and Ctrl+Alt+S to save without a comment.
Close a Flow
To close a Flow, simply click the X in the top, right corner of the Flow window or click the Close button available in the top ribbon of the Flow; if there are unsaved changes, Teneo Studio will prompt the user to save or close without saving any possible changes performed by the user.
Alternatively, click the Flow tab in the top left corner to go to the backstage of the Flow and choose Close in the options to the left.
Disable or Enable a Flow
In the top ribbon of a Flow it is possible to Disable or Enable the Flow. By default new Flows are enabled.
In the Solution Explorer view, it is possible to multi-select Flows to disable or enable several at the same time. Use the Disable/Enable buttons in the top ribbon of Teneo Studio and click Yes in the dialogue box.
When clicking Disable/Enable while having a folder selected, a dialogue box will be displayed for the user to confirm the action of all the selected objects in the selected folder and subfolders.
When disabling/enabling multiple objects at a time, clicking Run in background in the dialogue box permits the user to keep working while the actual disabling/enabling is carried out.
A dialogue box will be displayed when the disabling or enabling has finished successfully.
The Stable Version area in the top ribbon of a Flow allows to set the current version of the Flow as stable by clicking Set; and to unset a stable version by clicking Unset.
Setting a Flow's version to stable indicates that the Flow development is finished, that testing and quality assurance is done and that the Flow is ready to be published; setting the stable version allows the user to indicate that the Flow is ready for going live and afterwards improve the Flow further, but when publishing use the stable version of the Flow and hence have time to test and quality assure the new improvements before going live with the next version of the Flow.
In the backstage of the Flow (Flow tab > History) it is possible to set a previous version of the Flow as the stable version, to do so simply select the wanted version and click the Set Stable button which appears in the top of the list when selecting an item.
Note that it is not possible to set a new Flow to stable until a first version of the Flow has been saved.
Read more about Version Flags.
Include or Exclude from Branching
The Include and Exclude buttons available in the top ribbon of a Flow allows the user to include or exclude the Flow from branching when working in the Master solution of a Localization setup.
Read more about the Localization setup.
The Flow panel available in the left side of the Flow window provides a summary about the current Flow: available Variables, Listeners and Metadata; clicking any of the properties will take the user to the backstage of the Flow.
Flows in Teneo Studio contain an Errors panel available in the right side of the Flow window, where critical errors, warnings, and informative messages related to the Flow are listed.
Clicking the arrow button next to an error or warning takes the user to the location in the Flow graph where the error occurs.
Critical errors will, apart from being displayed in the Errors panel, prevent the user from saving the Flow until the error has been corrected.
The critical errors include:
- Duplicate names in
- Output parameters
- Flow not having an Intent Trigger nor being set to be a Sub-flow
- Match Requirement added, but properties not defined
- Entity or Language Object Data Action is added, but properties not defined
- Skip condition without a selected transition
The warning messages includes:
- Condition Match Requirement's condition is missing
- Flow link node cannot find the referenced Flow
- Script or Listener Data Action is added, but the script is not defined
- Listener Data Action is added, but the Listener's condition is missing
Information messages includes:
- A Flow node is not connected to the rest of the Flow in the graph or is un-reachable
- A Global element is missing (Global Variable, Metadata definition, Emotion, ...)
Learn more about error detection in Teneo Studio
The Properties in the backstage of a Flow (Flow tab > Properties) contains the following information related to the Flow:
- Document Number (read-only property)
- Resume Prompt
- Id (read-only property, available at the bottom of the window)
The History tab in the backstage of a Flow (Flow tab > History) contains the History of each time the Flow has been saved. If users have added comments when saving, these will be displayed here.
In the history list it is possible to click the version number to see a previous version of the Flow. If needed, a previous version available in the history can be restored by opening the Flow and clicking the Restore button available in the top ribbon. A new version of the Flow will be created, containing the data of the selected version.
When restoring a Flow, it is recommended to check that referenced elements are still available in the solution for correct functionality.
The History tab also allows the user to select a previous version of the Flow and set it as the stable version; read more here.
To set a Metadata value at Flow level, follow the below steps:
- Go to the Flow tab and select Metadata in the left-side menu
- Click the Add button in the top of the view
- Select the wanted definition by clicking the down-arrow to display all the available definitions
- Then, click the down-arrow below to select an appropriate value
- Alternatively, toggle between string value / script value to add a script expression (
</>button available next to the value field)
- To assign another metadata definition to the Flow, repeat the above steps
- Remember to Save the Flow to preserve the changes.
Note that semicolon
; is not supported in script expressions for composite metadata.
The Variables tab in the backstage of a Flow allows to add Flow Variables which are accessible only in the Flow in which they are declared. For more information, please visit the Listeners and Variables section.
The Listeners tab allows to add Flow Post-Listeners to the Flow which will listen only when the Flow is activated. For more information, please visit the Listeners and Variables section.
The Scripts tab in the backstage of a Flow provides the option to add a script to the Flow, the Flow will execute script code when they reach the top of the Flow stack or when they are dropped off the Flow stack. For more information, please see the Scripts section in the Knowledge Base.
The backstage of a Flow allows the user to run an Auto-test on the currently opened Flow; two test levels are available:
- Run Flow Test to test the Examples of the Current Flow's Intent Trigger(s) against all other Intent Triggers in the solution
- Run Test using Flow Scope to run a test ignoring the presence of any other Intent Trigger in the solution and test if the Examples in the current Flow matches the implemented Match Requirements.
Move and copy Flows
Teneo Studio allows to copy and move around objects within a solution and from another solution to the currently opened one; for more details, please see Moving and copying objects.
Delete a Flow
It is possible to delete one or more Flows from a solution, to learn how please check out the Delete objects section.