Procedure Setup
Create Procedure Wizard
To create a new procedure, go to: WEAVR > Procedure > Create Procedure.
This wizard allows you to configure:
| Setting | Description |
|---|---|
| Procedure Details | The Name of the procedure (used to identify it across the whole project) and, under Saved to, the file name it is saved as inside the Procedures/ folder. |
| Template | The starting point of the procedure: Virtual Training (VT) or Operations Support (OpS). Each template preconfigures execution modes and defaults, and a short description explains the selected one. |
| Execution Modes | The ways trainees can run the procedure — Automatic, Guided and Assessment — each with a short description. You can enable more than one, and give each mode a custom display name. |
| Languages | Select every language the procedure content should be authored in. |
Once you have chosen the settings, press Create Procedure to create it.
Procedure Editor
After clicking on the Create button, you will be able to see the Procedure Editor screen. This editor lets you create and edit the procedure structure: adding nodes, manage events, variables, and other things.
You can also find it in: WEAVR > Procedures > Procedure Editor.
The procedure editor window consists of the following elements:
| Element | Description |
|---|---|
| Procedure Toolbar | Toolbar with the commands to create, load, build and manage a procedure |
| Procedure Graph | The main view of the procedure, where you can drag, connect, and edit procedure elements (Nodes, Groups, Transitions, etc.), as well as visually debug the procedure |
| Procedure Graph Toolbar | Useful tools for the management of the procedure |
| Procedure Footer | Contains various information about the current procedure |
No procedure loaded
When the Procedure Editor is open but no procedure is loaded, a panel appears in the middle of the graph to help you pick one:
- Recent procedures — cards for the procedures you last opened (with their preview, name, scene, last-edited date and configuration badge). Click a card to open it.
- Browse all procedures… — opens the Load Procedure window to search every procedure in the project.
- New procedure — starts the Create Procedure wizard.
Procedure Editor Toolbar
| Button | Function |
|---|---|
| New | Create a new procedure. |
| Load | Load a procedure (opens the Load Procedure window). |
| Build | Open the builder to build and upload the procedure to the WEAVR Manager (see Procedure Build). |
| Score | Open the Score System window. |
| Translate | Open the Translate Procedure window. |
| Daisy | Open the DAISY Context window to provide supporting documentation to the DAISY assistant. |
| AI | Open WEAVR AI, the in-editor AI assistant. |
| Search everything | Search by name, GameObject, actions or conditions inside the procedure. |
| Arrange | Automatically arranges the nodes in the graph. |
| Reset | Reset the procedure and all its nodes and transitions. |
| Frame | Frame (fit to view) the whole procedure graph. |
Load Procedure Window
By clicking on the Load button, a window appears listing the available procedures. You can Search by name and filter the list with Current Scene, All Scenes, or AI Assisted (procedures created with WEAVR AI).
Each item in the list shows the procedure name and file path, its languages, the last update date, the number of nodes and transitions, and its execution modes; the Open button loads it. Selecting a procedure shows a details panel on the right with its preview image, description, Statistics (Nodes, Transitions, Events, Variables, Groups), execution modes and languages.
Procedure File from Inspector
In the Procedure Footer, you can find some useful information:
- The location of the procedure asset (for example
Assets/Procedures/Procedure.asset). - Executed Steps and Errors during a test run.
- The totals for Groups, Nodes and Transitions in the procedure.
By clicking on the location of the procedure, a new window shows up:
The numbered areas in the image are:
- Procedure's Title — the procedure name and its configuration type. Use Change to convert it to another configuration.
- Procedure's Header — the name, description and preview image of the procedure.
- Execution Names — the custom display name shown for each execution mode (for example Feedback shown as Assessment). See Execution Names.
- Capabilities — the optional Player features and the per-execution-mode data collection, including Analytics Options (which analytics events are sent) and Data Tracker Options (what the Data Tracker captures). See Procedure Capabilities for the full list.
- Collaboration Settings — whether the procedure can be played in multiplayer, and the min/max number of players.
- Environment — the additive scenes used when the procedure spans multiple scenes.
- Languages Table — the languages available for the procedure; you can change the default one and add more.
- Assets — the list of assets referenced by the procedure. Do not modify this.
- References Table — all the GameObjects referenced by the procedure, with their targets. The Lock/Unlock button lets you replace a referenced GameObject for all its targets.
When opening a procedure, if actions or exit conditions have missing references, click the Force Restore button.
Procedure Capabilities
The Capabilities of a procedure enable optional Player features and decide, per execution mode, what data is collected during execution. They are edited from the Capabilities entry of the Procedure File inspector (and on the procedure asset itself).
The per-mode options use the execution-mode toggles (for example A Automatic, G Guided, F Feedback, and On for the Data Tracker): enable the modes for which the feature should apply.
| Capability | Description |
|---|---|
| Execution Environments | The environments the procedure targets: 2D Screen, VR, MR, AR. |
| Step Info | Shows the step information in the Player during the procedure run. Enabled by default. |
| Show All Buttons | If enabled, all procedure buttons are visible; otherwise they must be revealed manually in the Player. |
| Notes | Enables notes for the procedure. |
| Reset Camera | Restores the camera at the end of the procedure. |
| Change Execution Mode | Allows changing the execution mode at runtime during the procedure. |
| Replay Step | Allows replaying the current step. |
| Skip All Steps For | For the selected execution modes, a single skip command skips the current skippable step in every running flow at once; otherwise the skip affects only the main-flow step. See Skipping steps below. |
| Stateful For | For the selected execution modes, the procedure saves the self and world states during execution and restores them. |
Several capabilities — including Analytics and the Data Tracker below — are configured per execution mode: instead of a simple on/off, you select the set of execution modes for which the feature is active.
Skipping steps
Only a step whose exit condition has Can Skip enabled is skippable. A skip can be triggered with the Player skip button or by pressing the Space bar on the keyboard: WEAVR then completes the current skippable step as if its condition had been satisfied and moves the flow on.
A WEAVR procedure can run several flows in parallel (for example when the graph splits into branches), so more than one step can be active at the same time. The Skip All Steps For capability decides how the skip (the button or the Space bar) behaves in those modes:
- Enabled for the execution mode → one skip skips the current skippable step in all running flows simultaneously.
- Disabled (default) → the skip applies only to the main-flow step that is currently executing; steps in the other parallel branches keep running and must be skipped on their own.
In both cases, steps that are not marked as skippable are never affected.
Analytics
The Analytics options select, per execution mode, which categories of analytics events the procedure sends to the backend:
| Option | Events sent |
|---|---|
| Procedure Events | Procedure Started, Procedure Completed, Procedure Failed, Procedure Aborted. |
| Steps Events | Step Started, Step Ended. |
| Score and Errors Events | Score Updated, Error Committed. |
| Interaction Events | Interaction events such as object grabs, button presses, etc. |
By default Procedure Events apply to all execution modes, while Steps, Score/Errors and Interaction events default to the Assessment mode. Set the modes to an empty list to disable a category.
Data Tracker
The Data Tracker is the system that collects procedure data into a local cache during execution and sends it to a configured endpoint. Because it caches locally first, data can be captured even without a live connection and synchronized later. The destination paths and sampling parameters (CSV sampling frequency, batch size, document path) are set in the CSV Settings of the WEAVR Settings window; see Data Capture.
You choose for which execution modes the Data Tracker is active. When at least one mode is enabled, additional tracking options appear — each also selectable per execution mode, and limited to the modes enabled for the Data Tracker:
| Option | Description |
|---|---|
| Data Tracker | Enables data tracking for the selected execution modes (cache locally, then send to the endpoint). |
| Video Recording | Records the rendered session for the selected modes. See Video Recorder. |
| Track Mic Audio | When video recording is enabled, also captures the microphone audio. Enabled by default. |
| Speech Recognition | Saves the speech recognition audio files. See Speech Recognition. |
| Generic Data | Saves generic tracked data. |
The advanced trackers (Video Recording, Speech Recognition, Generic Data) can only use execution modes that are also enabled for the Data Tracker: removing a mode from the Data Tracker removes it from the sub-trackers as well.
Execution Names
The Execution Names let you customize the display name of each execution mode for this procedure. Each entry maps an Original mode name (read-only — for example Automatic, Guided, Feedback) to an Override name that is shown to the user. By default the override matches the original name.
This is useful to present friendlier or domain-specific labels in the Player (for example showing Training instead of Guided, or Assessment instead of Feedback) without changing the underlying execution mode. The list is kept in sync with the procedure's execution modes: modes that are added appear here automatically, and modes that are removed drop off the list.
The override names are also used on the WEAVR Manager: once the procedure is uploaded, its execution modes are shown there with these custom names.
Graph Elements Inspector Window
Back to the Procedure Editor Footer, if you click on the total number of steps and nodes, a new window pops up:
| Section | Description |
|---|---|
| Nodes Section | Contains the list of all the nodes inside the procedure. If you click on a node, this will be highlighted and selected within the graph |
| Transitions Section | Contains the list of all the transitions between nodes inside the procedure |
Procedure Graph Toolbar
The Procedure Graph Toolbar allows you to control and customize some of the features of your procedure.
Variables Tab
The Variables section allows you to create, check, and remove all the variables that you created inside your procedure.
There are 3 types of variables:
| Type | Description |
|---|---|
| Read-only Variables | These variables cannot be modified; they contain information such as the CurrentStep or the GrabbedObject. They can be used within the procedure in the conditions and actions, and furthermore, by dragging them into the graph, a node with the possible exit conditions for this variable will be automatically generated. You can do the same thing by dragging them inside an exit condition of any node |
| Persistent Variables | These variables remain for the entire duration of the procedure, can be added using the appropriate button and can be modified from within the procedure itself. You can set an initial value and you can see how many nodes are using it (References). You can drag and drop them like the Read-Only Variables |
| Volatile Variables | These variables are generated during the procedure and deleted at the end of it. These are all those variables created through actions such as: Set Variable, Set Variable from Object. You can make a volatile variable a persistent one by right-clicking on the variable and selecting Make Persistent |
The variables can be controlled through the WEAVR tool that you can find in WEAVR > Diagnostics > Variables.
When in Play Mode this tool allows you to see all the variables active during the procedure and see their changes through the steps.
Buttons Tab
The Buttons tab contains all the buttons and toggles present in the user interface during the OpS procedures. Some of these are present by default such as the next and back buttons.
To create a new one, click on the appropriate button and customize it as you like. You can drag and drop them inside the Procedure graph to generate an Event Node with the proper actions and conditions.
Navigation Tab
The Navigation Tab allows you to modify the steps that will be displayed in the side panel of your OpS procedure.
The default mode is the so-called Dynamic: the steps are automatically generated considering the various nodes present within the procedure.
The Static mode, on the other hand, generates all the steps of the procedure only once. In this case it is possible to modify each single step and add others, but if another node is added to the procedure, this will not be automatically inserted as a step of the Navigation.
Events Tab
The Events Tab contains all the procedure events. These events can be recalled via Event Nodes or via actions such as Manage Event and Raise Event.
Some events are already defined as Step Started and Step Finished; others can be generated by clicking on the appropriate button.
You can drag and drop any event inside the Procedure graph to generate the related Event Node.
Player Tab
The Player tab lists key components of the WEAVR Player UI. By dragging these items into the procedure editor or within a node you can control the visibility of the components during the procedure.
The Player View name indicates which view the UI Component belongs to. By clicking the Focus button you'll see a screenshot of the Player View with the component highlighted.
Text To Speech Tab
The Text To Speech tab manages the Speech Roles of the procedure. A role is a named voice configuration: every Text to Speech action is assigned a role, and the role decides which voice synthesizes the text — one voice per language. Centralizing the voice on a role means you can change the voice once and update every action that uses it, instead of editing each action individually.
To add a role, click the + button and give it a name. Click a role's name to rename it, and use the X button to delete it (the Text to Speech actions that used it are reassigned to another role). For each language available in the procedure, click Select voice… to choose a voice from the installed Text-to-Speech providers (for example Windows Voice, Amazon or Google), grouped by provider and language with gender/age information.
Each role row also offers:
| Element | Function |
|---|---|
| ▶ Test / ■ Stop | Preview the role's voice with a sample sentence in the procedure language. |
| References | A foldout listing every Text to Speech action that uses this role, ordered by step number. Each entry has play/stop buttons and a Fix button to regenerate its audio. |
| Completeness (multi-language) | For multi-language procedures, an indicator (for example 2/3) shows for how many languages the action has text. |
| Warning / bad actions | A warning appears when some voices are not set, or when referenced actions have missing or invalid audio; a Fix All button regenerates all of them. |
A role whose voice has not been generated yet shows the voices still to be set (and no usable references):
The same role after the voices have been chosen and the audio has been generated for its actions:
The audio for each Text to Speech action is generated from its text using the voice of its role. When you change a role's voice, WEAVR offers to regenerate the audio of all the actions that use that role.