¶ Plug-in installation
The main interface for the business administrator is the Google Chrome browser extension, which interacts with all the subsystems of the Hinted software suite. The user application is designed so that the authorised user has access to the main functions of the system immediately after start-up.
¶ Installation from the official Google Chrome store
The easiest and safest way to install the HintEd extension is to download it from Google's official extension store.
The plugin is available at the link:
https://chrome.google.com/webstore/detail/hinted-editor/pomgnikapieeibhibecdjghdjnnianik
The plug-in is regularly updated in the official store.
¶ Manual installation from developer mode
- Download the extension. We usually send the extension over in an archive.
- Extract the extension with the archiver to a convenient folder.
- Launch the Google Chrome browser.
- Open the browser menu. The three vertical dots in the top right corner.
- Go to More Tools > Extensions.
- Toggle the "Developer Mode" toggle switch in the top right corner to the "Extensions" page.
- Activate developer mode
- Click on the "Download unpacked extension" button.
- Loading the unpacked extension
Locate the unpacked folder with the extension and select it. That’s it! You can now use our plugin.
¶ Plug-in menu
¶ Install
In this window you can copy the code to integrate the widget, configure the display on a single-page application and adjust the colour of the widget.
¶ Triggers
A trigger is a condition for starting a scenario.
Existing triggers can be deleted or changed here:
¶ Settings
The following settings are available to the user:
- Server address. Here you can change the current server address used by the extension.
- Number of attempts. This parameter is responsible for how often an item is checked to see if it exists on the page.
- Time of search attempt. Controls the waiting time before moving to next tooltip in case of an element is.
- Link to widget. Indicates the location of the widget.
- Show Scenario ID. Activates viewing of scenario IDs.
After changing the parameters in any of the fields, press the "Save" button.
¶ Account
In this window you can change the user name, surname and password.
The "Ask support question" button will redirect the user to the mail client installed in the system with a ready header and email address.
The "Logout" button will end the current user session.
¶ Working with scenarios
¶ Scenarios list
The scenarios list page gives users access to the list of scenarios published by the business administrator and available to them:
The filter field performs search for scenarios by matching a part of the name or address where the scenario was created.
You can upload or download scenarios.
The scenario list provides access to scenarios in the form of cards. Hovering over the left side of the card enables the scenario playback button. Clicking on the card opens the scenario steps page.
¶ Creating a scenario
To create interactive prompts go to the page where you would like to start a training scenario, open the HintEd Editor extension, click the "Add" button (plus button) and select "Scenario" from the list that opens. Enter a title for the scenario and a description (optional). Click the "Create" button.
- When activating the "Create and fill in steps automatically" setting, the user needs to click on the elements for which a prompt will be created. The title and description of the step will be filled in automatically.
- When activating the "Create simulation" settings, a screenshots of the screen of each step are taken. After that, it will be possible to watch this simulation in the admin panel as a slideshow for training.
- When activating the "Evaluate the quality of the script after it has passes" setting, the user can user can rate (maximum 5) the completed scenario and write a comment.
An item selection frame will appear on the screen. The plugin allows you to select any object on the page and create a tooltip for it.
After selecting an element the tooltip editor window will open.
1. Enter the tooltip title and its description.
In the description, the editor allows the use of:
- formatted text
- lists
- images
- import of video from third-party sources
- links to other scenarios
2. Select the conditions for showing the next prompt (or the end of if you are creating the last step of the scenario).
Possible options:
- Pressing the Next button. The tooltip is visible until the user clicks Next. The tooltip will disappear when you move to another page.
- Clicking on an element. The prompt will disappear after clicking on the element, the next prompt will be shown on a different web page, if the scenario allows for such transition, or on the same page if no transition is happening.
- Hovering over the element. The tooltip will disappear when you hover over the selected element.
- Entering text or data. The tooltip disappears when text is entered and the focus is removed from the item (click on an empty area, press Tab, or select another item).
3. Select the location of the tooltip in relation to the item:
- Above.
- Below
- Right
- Left
4. Select the prompt type
There are 2 types of prompts available
- Frame. A frame appears around the selected item.
- Tooltip. Standard tooltip with text and description.
5. Additional step options can be set, when needed
In addition to the title, tooltip text, its location and the condition for showing the next step, additional parameters can be set:
- Skip step if the element not found
- Scroll to the element
- Waiting for redirect or history change. Used if the step is not shown after navigating to another page. This may mean that the browser refreshes the page several times before it is fully loaded.
- Highlight the element. Only the selected selector is made active, the rest of the screen is dimmed.
Once you have filled in the required fields, press "Next" to go to the next step. In this way you can create as many steps with prompts as you need.
After a scenario is created, you must save it by pressing the corresponding button in the scenario operation menu.
Saved scenarios will appear in the HintEd Editor plugin in the "Scenarios" tab.
The created scenario can be played back and tested by clicking on the corresponding icon:
¶ Editing a scenario
You can edit an already created scenario at any time. To do so, select the desired scenario from the list, click on the menu button on the right and select "edit".
On the scenario steps page, you can add new steps to the page or edit the scenario parameters.
In the script settings, you can change:
- Scenario title and description
- Publication status. It is responsible for scenario’s visibility for the users when embedded players are used
- Scenario page address. It gives the address of the page where the published scenario will be displayed in the widget (a floating button with a list of tooltips). When specifying an address, all dynamic parts in URL can be replaced with '*'.
For example: https://*.test.com/ , https://test.com/*/help , https://test.com/?user=* etc.
To edit the step press on its card:
In addition to the parameters described above, the following options can be set for the step:
- Using text to search for an item. Applies when the location of the originally selected item may change. In this case, it can be found by the text it contains.
- Time for finding a step (ms). Under development
¶ Scenario publication
If the scenario has worked well, it needs to be published to make it visible in the script widget. This can be done in the scenario settings by activating the "Show scenario under the Help button" option:
¶ Scenario duplication
You can easily duplicate the scenario, if needed.
¶ Download the scenario
You can download the script to share with colleagues
¶ Delete the scenario
If you no longer need a previously created scenario, delete it from the scenario menu:
¶ Setting up triggers for scenarios playback.
To set the triggering conditions for the created scenario, click on the "Add" button and select "Triggers".
Select the scenario for which you would like to add a trigger.
You can then select appropriate trigger conditions to launch scenario playback (triggers).
¶ Conditions for running the scenario
There are currently 9 events available in the HintEd plugin that can be used to trigger prompts:
- When the page loads
- Hovering over the element
- Clicking on the element
- Scrolling down to the element
- When the user is inactive
- When the page address has changed to …
- Specified input
- The element contains text
- Browser store contains the required value
Let's look at examples of how each event can be used:
- When the page loads – the scenario is played back after the page is loaded:
- Hovering over the element - the scenario will run when the user hovers the mouse over the specified element. When using “Element hover” you need to specify the element selector that will trigger the scenario once the mouse hovers over it:
- Clicking on the element - the scenario is launched when the user clicks on the element you want. When using “Element click” you need to specify the element selector that will trigger the scenario once you click on it:
- Scrolling down to the element – the scenario is launched once the user has scrolled to the specified element:
- When the user is inactive – the scenario is launched when the user is inactive. The waiting time is given in seconds.
- Specified data input - the scenario will be launched when a specific text is entered into the specified element.
- Element contains text - the scenario is launched if the HTML element text is equal to the specified value.
- The browser storage contains a value - the scenario is launched if the session, cookie or Local Storage contains specified values
- The page address is changed - under development
¶ Additional options
Contains additional settings for launching scenarios.
- Forced start of a scenario - an option to run the scenario even if another scenario is already being played.
- Page address - address of a page that will trigger scenario playback. By default, the scenario will be launched on all pages. If the address is specified, all dynamic parts in the URL can be replaced with a '*'.
For example: https://*.test.com/ , https://test.com/*/help , https://test.com/?user=* etc .
- Number of playbacks - he number of times the scenario is played back for the user. Available values: from -1 to 1000. If the value is "-1", the scenario will run an unlimited number of times.
- Priority - under development.