|Table of Contents|
Copyright 2021 by TECHNIA AB
All rights reserved.
PROPRIETARY RIGHTS NOTICE: This documentation is proprietary property of TECHNIA AB. In accordance with the terms and conditions of the Software License Agreement between the Customer and TECHNIA AB, the Customer is allowed to print as many copies as necessary of documentation copyrighted by TECHNIA relating to the software being used. This documentation shall be treated as confidential information and should be used only by employees or contractors with the Customer in accordance with the Agreement.
Light My Way is a software installed client side in browser as a web extension with the purpose of boosting user PRODUCTIVITY and ADOPTION to a low COST, this by providing VISUAL GUIDANCE and USER TRAINING directly IN-APP. To display the right instruction at the right time each instruction is bound to application state using html identifiers such as XPATH & CSS selectors. New instructions are also recorded through the web extension. Data is stored and retrieved in external service using http(s) and web sockets called from the extension background script.
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)
Light My Way is a generic software that works with all html based applications with the right configurations (described in the administration chapter).
An extra effort has been put into making it work well with 3DEXPERIENCE platform. Configurations to identify UI elements of 3DSPACE, 3DDASHBOARD and Value Components are built in.
3DEXPERIENCE (3DSPACE & 3DDASHBAORD)
2013x until latest
Value Components (TVC & Helium)
Configurations making the Consumer and Author roles work well are built in for the supported platforms. No project specific administration required to get started recording standard use cases using a rich set of built in conditions and configs.
This release still require R&D collaboration (to ensure the product works well for you and so we fully understand common need). Product development has mainly been driven with 3DSPACE 2018x - 2021x Create Part and Change Process use cases so far. A long detailed list of supported targets, conditions and focus elements can be shared on request.
The server will be hosted as a cloud service sometime 2021. Meanwhile the server can be installed in private networks or external servers. The server is based on https://nodejs.org and nodejs system requirements applies.
Chrome (85 or later)
Microsoft Edge (85 or later)
The extension architecture allows to provide user guidance without dependency to normal release cycles. No access to the server of the target application is required and guides recorded and distributed for CLOUD hosted solutions is supported. Light My Way has no footprint on the target server application what so ever and no server side deployment is required.
As CLOUD service
The normal setup is that TECHNIA will host the data service in the CLOUD and all you have to do is to connect to the account you get with your subscription.
Server on premises
If you for some reason unable to use the CLOUD service there is also the option to install and host the server locally on premises.
Install latest (LTS) https://nodejs.org/en/download/
Expand lmw-server-VERSION.zip into desired directory
Server is started by default using the port 8080 - http://localhost:8080
The port can be configured the following ways:
by setting the Environment Variable PORT=1234
starting the server with an argument -p or --port e.g. node server/src/index.js --port 1234
Note that a web socket connection is opened on the configured port ws://localhost:<port>/lmw/socket.io
As a windows service
Light My Way (and other nodejs apps) can be set up as a service using https://www.npmjs.com/package/qckwinsvc
Setting up a space
The server can hold multiple spaces (domains). Each space has its own data and configuration files. This way multiple platforms and environments can be hosted on the same server. To add a new space add data and configuration files to the space domain under the config folder.
The client extension comes in 2 versions: The consumer and the author application. The Author extension also includes the consumer app.
In this release concurrent authoring is disabled to prevent transactional issues.
Installation Option 1 - Installer (.msi)
For IT teams to be able to distribute the extension to large user groups and prevent excessive support an .msi file is provided.
The .msi installer adds registry entries for automatic side loading of the chrome store hosted extension.
Installation Option 2 - Chrome web store
The web extensions are hosted on chrome store and is actually what the .msi file side loads into the browser. One option is to manually install the extension directly from chrome store. The result will be the same.
Connecting to the server space
Click the extensions menu
Click “Light My Way“ icon
Enter server URL with domains and press TAB
“Connected successfully” should appear in green
Light My Way supports 3 different roles or types of users. The ‘User guide’ covers the Consumer and Author roles while the ‘Administration guide’ covers the Administrator role.
Needs guidance using a web application
(user, engineer or similar)
Knows how to use a web application
(process owner, teacher or support)
(developer / system administration)
Finding the application
The Light My Way layer is added to the right side in the target application. Depending on role one or two tabs will be visible. The tabs are rendered on top and will not interfere with the UI. If the tabs for some reason are in the way you can move them by drag and drop. Clicking a tab will expand and display its content so that you can access its features. By clicking the tab again it will collapse to its original state.
The consumer will find the ‘LIGHT MY WAY’ tab at the right of the application. This tab will be used to access all content and control preference.
All instructions belongs to a group. A group allows you to manage multiple instructions in one go and is often equal to a use case.
The author will find the ‘LIGHT MY WAY’ tab at the right of the application so he can see how the consumer view would be.
On top of that the ‘AUTHOR’ tab is available for content management.
Light My Way uses open source libraries. All used software licenses are listed in the attached markdown file.
Update nodejs to 14.15 LTS
Support for 3DX 2014X
Updated configuration schema files
Add configuration option to ignore anchors for specific elements
Improved callout layout control - positioning of the callout
More callout colors are available
Add Context Menu to enable/disable Light My Way UI
Callouts will be rendered behind the Light My Way UI
Hide Callouts while in select mode
Reposition on scroll
Callout Display preferences
Make non-hovered Callouts transparent
Hide Group Label in Callouts
Truncate non-hovered Callout description
Emphasize available instructions
Server and WebExtension Version compatibility check