|
| 1 | +--- |
| 2 | +sidebar_position: 20 |
| 3 | +title: User guides |
| 4 | +--- |
| 5 | + |
| 6 | +# User Guides |
| 7 | + |
| 8 | +## What is a User Guide? |
| 9 | +In Simplicité [version 6.3](/versions/release-notes/v6-3), a **User Guide** is an interactive tour designed to onboard users and help them understand how to use the application. |
| 10 | +A guide can walk the user through various parts of the UI, highlighting steps, actions, and interactions. |
| 11 | + |
| 12 | +User Guides can be: |
| 13 | +- Launched from any **view**, **home page**, **business object**, **dahboard**, **Domain home** or **external object**. |
| 14 | +- Restricted to a **limited period of availability**. |
| 15 | +- Made visible only to **specific user groups**. |
| 16 | +- Composed of multiple **steps**: |
| 17 | + - On a single page. |
| 18 | + - Across several asynchronous pages or dialogs. |
| 19 | + - With required user interactions (clicking a button, completing a field, etc.). |
| 20 | + |
| 21 | +With User Guides, Simplicité provides a structured, interactive way to onboard users and support application adoption. |
| 22 | + |
| 23 | +## How to Create a User Guide? |
| 24 | + |
| 25 | +### Accessing Guides |
| 26 | +Users with the `GUIDE_MAKER` responsibility gain access to the **Guides** menu, which includes: |
| 27 | + |
| 28 | +1. **User guides** – full definitions of guides with step settings and permissions. |
| 29 | +2. **Guides usage** – tracking information (who used a guide and when). |
| 30 | +3. **Guide recorder** – a helper tool to build a guide skeleton directly while navigating the UI. |
| 31 | + |
| 32 | +### Creating a Guide |
| 33 | +1. Go to **User Interaction > User guides**. |
| 34 | +2. Click **Create** a new Guide. |
| 35 | +3. Define the following properties: |
| 36 | + - **Name** – unique key for the guide. |
| 37 | + - **Module name** – the [module](/make/project/module) to which the guide belongs. |
| 38 | + - **Target object** – Simple view, home page, business object, dashboard, domain home or external object. |
| 39 | + - **Availability period** – optional start/end dates. |
| 40 | + - **Order** - defines the order of display when multiple guides are available. |
| 41 | + - **Auto launch** – automatically launches the guide when the user first accesses the target object. |
| 42 | + - **Tour settings** – advanced options such as display style, navigation controls, or steps. |
| 43 | + |
| 44 | +4. Define **steps** for the guide: |
| 45 | + - Page or dialog context. |
| 46 | + - Target element in the UI. |
| 47 | + - Step description/instruction. |
| 48 | + - Expected user interaction (click, input, validate, etc.). |
| 49 | + |
| 50 | +5. Save the guide and test it in the UI. |
| 51 | + |
| 52 | + |
| 53 | +### Creating a Tour |
| 54 | +A **Tour** is a structured JSON object that defines a guide with **steps**, **conditions**, and **exit behavior**. |
| 55 | + |
| 56 | +#### Structure of a Tour |
| 57 | +```js |
| 58 | +{ |
| 59 | + name: "GuideName", |
| 60 | + condition: { ... }, // Launch conditions and access rules |
| 61 | + steps: [ { ... }, ... ], // List of guide steps |
| 62 | + exitToast: { ... } // Optional message at the end of the tour |
| 63 | +} |
| 64 | +``` |
| 65 | +#### Launch Conditions |
| 66 | +The condition defines when and how the tour can be launched: |
| 67 | +- context - location in which the tour is launched. |
| 68 | +- inst - instance name of the target object/view. |
| 69 | +- access - function to check user permissions. |
| 70 | +- init - optional logic to verify the page or elements are ready. |
| 71 | +```js |
| 72 | +condition: { |
| 73 | + context: "list", // Launch context: "list", "form", etc. |
| 74 | + inst: "the_ajax_Object", // Technical instance name of the target object |
| 75 | + access: function(ctn) { // Optional access control function |
| 76 | + return $grant.accessCreate("ObjectName") && $grant.accessUpdate("ObjectName"); |
| 77 | + }, |
| 78 | + init: function(ctn, tour) { // Optional initialization logic |
| 79 | + // Example: check if a button exists before starting |
| 80 | + let btn = $(".objlist.object-MyObject button[data-action='create']", ctn); |
| 81 | + if (!btn.length) return null; // stop playing |
| 82 | + return true; // ready to go |
| 83 | + } |
| 84 | +} |
| 85 | +``` |
| 86 | +#### Defining Steps |
| 87 | +Each step guides the user through an action or element: |
| 88 | +- step - identifier for the step. |
| 89 | +- title - multilingual step title. |
| 90 | +- info - optional description text. |
| 91 | +- attach - tooltip positioning and target element. |
| 92 | +- next - how to proceed to the next step (event or condition). |
| 93 | +```js |
| 94 | +{ |
| 95 | + step: "step-id", |
| 96 | + title: { FRA: "Titre", ENU: "Title" }, |
| 97 | + info: { FRA: "Description", ENU: "Description" }, |
| 98 | + attach: { pos: "bottom", align: "center", sel: "CSS selector" }, |
| 99 | + next: { event: "click", condition: function(ctn, obj, tour){ return true; } } |
| 100 | +} |
| 101 | +``` |
| 102 | +#### Exit Message |
| 103 | +At the end of a tour, you can display an optional message: |
| 104 | +```js |
| 105 | +{ |
| 106 | +exitToast: { FRA: "Merci et à bientôt !", ENU: "Thank you and see you soon!" } |
| 107 | +} |
| 108 | +``` |
| 109 | + |
| 110 | +### Using the Guide Recorder |
| 111 | +The **Guide Recorder** (experimental feature) helps create a guide quickly: |
| 112 | +1. Run through the desired journey in the UI. |
| 113 | +2. Right-click on elements you want to include as guide steps. |
| 114 | +3. Simplicité generates a **guide skeleton** with generic DOM selectors. |
| 115 | +4. Refine the guide: |
| 116 | + - Adjust selectors for stability. |
| 117 | + - Add missing steps. |
| 118 | + - Define permissions. |
| 119 | + |
| 120 | +The recorder provides a starting point; the guide designer must complete the setup for a functional onboarding tour. |
| 121 | + |
| 122 | +## How Users Access Guides |
| 123 | + |
| 124 | +### GUIDE_USER Responsibility |
| 125 | +End-users need the `GUIDE_USER` responsibility to access guides. |
| 126 | + |
| 127 | +Guides can be: |
| 128 | +- **Automatically launched** (once per user). |
| 129 | +- **Replayed** at any time with a button in the UI. |
| 130 | + |
| 131 | + |
| 132 | + |
| 133 | + |
0 commit comments