Guides
Preview and run a Guide
Check a Guide before use and then complete it in the Guide player.
Use Preview while authoring to test a Guide without creating a Reports inbox record. Use Play when someone is completing the Guide for real. Both modes use the current Guide structure, media, Fields, and navigation, but they keep test activity separate from real session results.
Preview is available to people who can edit the Guide. Play appears when your current access allows you to run it.
Preview before use
- In Library, open the Guide and select Edit.
- Select Preview in the editor to start at the current page.
- Follow each path you expect someone to use. Check required Fields, buttons, page changes, media, speech, and the completion message.
- Return to the editor after testing and correct any problems.
The editor toolbar previews the current page. A full-preview link at
/preview/<guideId> with no preview target starts at the first page of the
Guide's configured start sequence, regardless of the last edited page.
Page-targeted links start at the specified page; sequence-targeted links start
at that sequence's first page.
Reset preview clears the test answers and activity and returns to the same launch target. If a targeted page or sequence is no longer available, both opening and resetting the preview fall back to the Guide's configured beginning. If the configured start sequence is missing, the first sequence is used instead.
CareMap saves pending inline edits before opening Preview. If an edit cannot be saved, Preview does not proceed and the latest draft remains available in the editor.
A Preview session is for testing only. Answers and completion activity in Preview do not create a Reports inbox record. Run a real Play session when you need to capture results.
Use Preview player to check Full or Simplified without changing your account's playback choice. Both interpret the same Guide. See Full and Simplified Guide players for one-block navigation and large input controls.
Play a Guide
- In Library, open the Guide's actions menu or details and select Play. A scheduled or assigned Guide can also be launched from Home, People, or Schedule so the session keeps that context.
- Complete the visible steps. A required Field must be answered before the player can continue past its page.
- Follow the Guide until its completion screen appears.
- On natural completion, CareMap captures the session Report automatically. Choose Home when finished or Replay to start again.
The completion screen may show Report capture pending, Report capture queued, or Report captured while session changes finish syncing. Do not repeat the session just because capture is still pending. See Guide completion and Reports for the reporting handoff.
Fix common problems
- If Preview is unavailable, add a start sequence and page first. An empty page may show that it has no playable content yet.
- If the player will not continue, answer every required Field on the current page and follow any visible validation message.
- If recent edits are missing, return to the editor, confirm they saved, and start a new Preview.
- If media does not work, reconnect if needed and see Troubleshoot media. For narration, see Troubleshoot Guide speech.
- For planned use without a connection, prepare the Guide for offline use and test the prepared content on that device.