• 3DEXPERIENCE in-app user training

  • The right instruction at the right time

  • App state sensitive

  • Complex / dynamic processes supported

• 3DEXPERIENCE in-app training creation

  • Create instruction by point and click

  • Relate instructions to app state (object type, UI components etc)

  • Best practices built in

• Up and running with 3DEXPERIENCE in a minute!

  • Cloud subscription (no infra structure required)

  • No server deployment or dependency to normal release cycle (cloud also supported)

  • No service required (pure software deal / instant value)

1. Open in Chrome or MS Edge

   1. Click open Author in chrome store

   2. Click open Consumer in chrome store

2. Click “Add to Chrome”

3. “Manage extensions” to control settings such as specific site limitations

1. Open In MS Edge

   1. Click open Author in Microsoft Edge Add-ons

   2. Click open Consumer in Microsoft Edge Add-ons

2. Click “Get”

3. “Manage extensions” to control settings such as specific site limitations

Connecting unmapped data service

It is possible to connect with unmapped server targets using the Server field in the web extension menu found at the top right of your browser. This could be useful for authors connecting to sandbox guide repositories etc that should not be used by the overall user community.

1. Click the extensions menu

2. Click “Light My Way“ icon

3. Enter server URL with domains and press TAB

4. “Connected successfully” should appear in green

Quick disable

If you for some reason want to disable all Light My Way evaluation and rendering there is a quick enable slider available in the web extension menu found at the top right of your browser.

Toggle panel

It is possible to toggle panel tabs to hide or show depending on preference. Toggle is available in the context menu accessed by right clicking somewhere in the target application. Toggle panel could be useful in case the panel is in the way or if you have set your preferred guides and you are only interested in the callouts.

Reposition

The user can move the panel tabs vertically. Reposition could be useful in case the tabs is in the way.

The new position is persisted so that the user preference is stored over sessions and the user do not have to repeat it.

Toggle on/off

The consumer can toggle guides to be displayed on/off. The toggle state is persisted over time (browser local storage) and allows the user to keep his favorite guides on so that the right instruction automatically appears as the application state is right.

Available now!

To make it easy for users to find help relevant to the current view the guides, with at least one instruction valid for the current view (app state) is displayed on top.

The user also get aware there is help to get in case the panel tab is minimized. If there is a guide available but it is disabled a shining indication appears on the panel tab.

Finding guides

Users can find instruction groups by a filtering functionality. The filter field opens by clicking the search icon. Entered text will filter down the guide matching the text in labels, description and instruction content. The filter function is cancelled by pressing the arrow and any entered text is cleared by pressing the x.

Description

A detailed description for each guide can be added by the author and is made available as a tooltip hovering the info icon to the right

Color

To easily differentiate between guides the author can assign different colors.

Just-in-time delivery

To ensure that the right instruction appear at the right time, all callouts reacts and validates as the application state change.

Instructions valid for the current view and application state automatically appears on screen. With the condition that its group is toggled active.

In case of multiple instructions appearing on top of each other. The hovered instruction would go on top.

Dismissing instructions

In case an instruction callout is in the way it can be dismissed by clicking it. Instruction dismissal is temporary and will appear next session as long as application state and group toggle state still say it should .

Links

Some instructions can contain links. When a link is clicked the content will open in a new browser tab.

Preferences

To increase usability the consumer can control some of the behavior through preferences found at the top right corner of the panel.

Tags

The tags are accessed under the preference icon at the top right corner. By enabling at least one tag all guides will be filtered down to only include those matching the selected tags. Tag filtering is a good way to hide the guides not of value to you and allow you to focus on the ones that are.

E.g. Tags can be used to filter instructions by role, experience level or language. Tags are set and maintained by the author.

UI Preferences

Under the preferences option the user can control callout layout and styling.

Flip LMW Panel

This is used to switch side of the panel

Listing Guides

In the authors tab all guides will be be listed.

Deleting Guides

To delete a guide click the trash icon next to it

Modifying Guides

Clicking the edit icon next to a group will open the create form an allows you to modify group definition.

Creating Guides

Click ‘Create Group’ button to open the create form, give the guide a label and click save.

Tags

A guide can be tagged with one or more tags allowing the consumer to filter out the guides that matters to him. Simply type the desired tags in the tags field to tie the guide with it.

Tags can be maintained in the preference menu later on.

Color

The color of the callouts can be defined. Blue is the default color.

Creating instructions

To create an instruction go to the authoring tab and click the plus icon next to a guide directly.

Modifying instructions

Find the instruction in the group tree list and click the edit icon next to it.

Ordering instructions

To change the order of instructions simply move the mouse over an instruction until you see the movement cursor. You can now use drag and drop to move the instruction up or down in the list.

Selecting target elements

When adding an instruction the user is automatically in target selection mode.

Re-selecting target elements (Advanced)

To re-select the target element click the ‘SELECT’ button below the ‘Target element’ label found under the ‘Advanced’ section.

Coloured rectangle

During selection a coloured rectangle will appear to indicate:

• The element that is targeted for selection

• The status of the selection

Highlight all supported (green) targets

All supported (green) select targets can be highlighted by pressing ctrl + alt

Submitting your selection

To complete selection hold control key and left click mouse or press space (ctrl + space).

Callout positioning (anchors)

A callout positioning choice could be done during selection by clicking one of the anchor points (grey small circles) at the edge of the rectangle. For some targets the anchor points are disabled by the administrator.

Preview instructions

While creating or modifying instruction an instant preview is made available. The preview instantly reacts and displays changes in text just as the consumer would see it.

Instruction Type

You can change type of the instruction to ‘Info’ to render instructions more compact. Then the user will have to actively click the small info symbol to render the full callout.

Instruction text

Instructions has two fields. The title renders in bold and the description renders as paragraph and is suitable for longer texts.
The description field features a rich text editor which allows you to apply basic formatting with links, lists.

Links

To add a link to an instruction simply enter the link text and then click on the link icon in the editor to add the URL.

Controlling when instructions are shown

There are various ways to control when an instruction should show.

Conditions

To control when an instruction should be shown, an instruction can be tied with application state. This is achieved by selecting among a set of built in conditions valid for the current view. The administrator can provide more conditions to choose from if needed.

E.g. an instruction could be tied to a specific type or state so it only appears, when it should, as these conditions are met.

Target element conditions

Some target elements could have different states. Such elements can be configured with a condition that controls instruction visibility based on its state.

E.g. tabs can be configured with a target element condition so that the author can control instruction visibility depending on if it is active or not.

Conditional elements (Advanced)

If the built in standard conditions is not sufficient to control when an instruction should appear one or more elements could be used as conditions.

E.g. To control that an instruction should only appear when logged in user text is not ‘Tom Waits’ you could log in as that user and click that element holding that text. Conditions can be inverted using the NOT option.

Move to other guide (Advanced)

You can select the guide an instruction should belong to. By creating instructions from the guide it will be pre-filled.

Callout positioning (Advanced)

A callout is possible to position in a number of ways. To select the position, use the drop down. Default position is bottom.

Note that the anchor point could be assigned during target selection (see ‘Selecting Target Elements’).

Validation

To ensure proper data some validation is applied to the instruction create / edit form.

• At least 1 condition is needed otherwise a warning is displayed (can be overridden by author)

• Title and instruction is mandatory

• Recorded XPATH have to be valid (details found when expanding target element)

Password

To ensure unauthorized authoring a password is required the first time the author tab is used. The password will be stored in local storage so you don't have to enter it the next time authoring using the same machine.

JSON Format

Background

Since the release of Light My Way 2021.3 the former JSON based configuration is now stored in the same database as the instructions.

Import & export

To allow managing configuration and data in SCM tools or to bulk change efficiently using IDE features, it is still possible to edit the configurations JSON data as in previous releases. To do this

1. export the database content to the json format

2. change the files manually

3. delete the database

4. import the json data into a new database

Configuration export

Configurations could be exported from targets. Export could be useful to back up configurations, bulk modifications or storing it in SCM.

Data import / export

Data can be exported and imported from and to targets. This could be useful when moving data from one target to another or if there is a need to bulk modify data in an editor etc. The data export and import commands are available under the ‘Data’ tab found in the top bar.

Admin UI

General

To edit the configurations there us an Admin UI where you can easily create, edit and remove configuration items (e.g. conditions) directly in your browser without the need of any special software (IDE).

To access the Admin UI go to <server path>/admin/
e.g. https://lmw.technia.cloud/admin

The Admin UI is protected by login authentication using your username and password (that you get with your subscription).

Edit & Delete

To edit or remove a configuration item simply choose the target platform in the tree list and the configuration item you want to edit or remove.

Add

To add a new configuration item either click on the add button in the tree list under the chosen configuration type or click “+ Add” in the top bar.

Instruction Targets

Targets are the html elements that an instruction is tied with. The instruction callout is positioned relative to the target and is displayed if the target html element is present only. To identify a target elements XPATH is used. How XPATH’s are built up is controlled by configurations in the Admin UI. Multiple configuration types are related to target configuration.

The generated XPATH is controlled using starting elements and exclusion patterns and can be scoped by parent element so that e.g. tables have its own ignore pattern.

Target elements

Target elements are used to indicate supported target elements in the current view. This to rely the recording is cleaned off version dependent and unnecessary attributes etc to work well over time. The indication of a good supported target is a green rectangle and if ctrl+alt is used a highlight is used to indicate all target elements in the current view.

Administrators could extend the list of target elements to indicate good target selections to their users.

To create a new target ether clone an existing one or add a new one by clicking on the “+ Add” in the top bar and choose “Create New Target”.

Target elements are defined using CSS or XPATH selectors.

Fields

Starting Elements

Starting elements are used to truncate all XPATH before the matching starting element. This to make the stored XPATH nice, clean and less sensitive to context, changes or version.

Starting elements are defined using XPATH.

Fields

Ignore Lists

Ignore lists are used to define the class or attribute names to exclude from the recorded XPATH. This to make the stored XPATH nice, clean and less sensitive to context, session, changes over time or version.

Fields

Ignore By Parent

Ignore by parent is used as ignore lists but will make the configuration valid within the scope of a specific parent only. This would be useful if you like to exclude common attributes like name in a specific scope only but retain it in other places. The name and details fields are used to identify parent elements. Attribute, Classes and Inner text to control ignore behavior in scope of that parent.

Fields

Ignore Anchors

Ignoring anchors points during target selection could be useful for cases when it does not work well. Anchor points could be problematic for very small targets or if the target by script automation disappear as you hover an anchor point and then it makes sense to inactivate it. In these cases you could instead define a default and the author could always control this in the next step using the advanced settings for the instruction.

Fields

Conditions

The list of conditions are used by authors to control when an instruction is shown/evaluated. The list of conditions are controlled in the Admin UI and is only presented to the author if available for inclusion with the current target selection.

The conditions are configured using CSS selectors.

Fields

Target conditions

Conditions specific to the selected target element is used to control when a callout should display when the target itself carries state.

The target element conditions are configured using CSS selectors the same way as Conditions but you simply check only for target checkbox.

Focus conditions

Focus conditions are used to limit evaluation within the focused element if present. Very useful to make all other callouts not in the focus group automatically hide as long as the focus condition is fulfilled (e.g. hide background callouts when search is open). Focus is a silent feature and the author is not aware this actually happens behind the scenes.

Focus conditions are configured using CSS selectors.

Fields

Overriding the built-in default configuration

Light My Way comes with a rich set of built-in and supported configurations for target platforms. If for some reason like to override behaviour of a built-in configuration it is possible to clone it into your target configuration.

Data management

Administrators can view and edit all guide and instruction data from within the Admin UI. Accessing data could be useful in collaboration with Authors, troubleshooting etc. The Data view is accessed from the Data tab found in the top bar.

Password

The author keys prompted to authors are controlled in the Admin UI. To modify, add or remove author keys click the data service target edit icon.

Server Mappings

Server mappings are used to match each service target with a number of environment URL’s. This to allow web extensions to automatically connect with the correct service target. To add a mapping select “Server Mappings” under the chosen target or click “+ Add” in the top bar.

Fields