Userlane Assistant

What it is

The Userlane Assistant is your users' main navigation tool for your content, providing access to all of your Guides and Announcements.

When the Assistant is enabled for your users, an avatar is displayed in your application providing direct access to the Assistant menu:

Guides
Announcements
Search
Help

ℹ️ This navigation is not available if passive mode was activated for your account.

What it looks like

Enable relevant menu options

Menu Option	Functionality
Guides	organize your Guides into chapters structure your chapters If based in Europe ⇨ Start this Guide to learn how to manage your Guides. If based in the US ⇨ Start this Guide. use segmentation to define who sees what where If based in Europe ⇨ Start this Guide to learn more about segmentation. If based in the US ⇨ Start this Guide.
Announcements	communicate updates, share links, share Guides If based in Europe ⇨ Start this Guide to learn how. If based in the US ⇨ Start this Guide to learn how.
Search	enable search to find Guides and Announcements quicker If based in Europe ⇨ Start this Guide to learn how to enable Search for your users. If based in the US ⇨ Start this Guide. set up an integration to have additional resources connected, so users do not have to leave your application
Help	link users to additional resources such as a help center, support chat, or a communication platform channel such as Slack or MS Teams If based in Europe ⇨ Start this Guide to learn how to set up Help. If based in the US ⇨ Start this Guide.

Customize the Assistant Look

You can adjust

the avatar image
- If based in Europe ⇨ Start this Guide to learn how to change the avatar image.
- If based in the US ⇨ Start this Guide to learn how.
the default colours
- If based in Europe ⇨ Start this Guide to learn how to adjust the default colours.
- If based in the US ⇨ Start this Guide to learn how.
the default texts
- If based in Europe ⇨ Start this Guide to learn how to adjust the default texts.
- If based in the US ⇨ Start this Guide to learn how.
the Help image
- If based in Europe ⇨ Start this Guide to learn how to set up Help.
- If based in the US ⇨ Start this Guide.

ℹ️ View our Working with images article to learn more about image file recommendations.

Assistant Position

Fixed Position

You can position the Avatar in any corner of your application.

Choose the position that fits the underlying application best and doesn't hide anything.

Movable Avatar

Sometimes the Assistant avatar gets in the way of important UI elements. Thus, we also offer the option to have a movable avatar.

You can turn on the movable avatar under Customize > Assistant.

Users can move it by hovering over the Assistant avatar, click-hold, then dragging and dropping it from any of the six suggested spots.
The avatar position will remain in the selected position until the user drags it into another one, or until the feature is turned off.

⚠️ Limitations

If the underlying app has event listeners in place that target drag events, the event listener may block the avatar mobility from working.
If the Avatar Reposition toggle is turned off under Customize > Assistant, then the assistant will return for all users to the default position specified in the Portal.
If a user has enabled cookies to be deleted after each session, the assistant will go back to the default position specified in the Portal.

General Settings

The following options are available on your application's Settings page in the Portal.

Switch on the entire product for your end users

Application dropdown menu > General > Switch Userlane on/off

With this setting, you can deactivate Userlane Content for your end users. You will still be able to use the Editor.

Hide Userlane for your end users who signed up prior to this date (and time)

Application dropdown > Settings > General > Hide Userlane from users who signed up after a specified time

If you specify a date and time here, only end users who signed up for your service after this date and time will be able to see your Guides. This requires some changes in your code snippet. Read this article to learn about the required changes in the snippet.

Hide Userlane on screens smaller than a specific size

Application dropdown > Settings > General > Hide Userlane on screens smaller than a specified size

You can define the minimum width of screens in px. The recommended size for a mobile screen is 769px. On screens smaller than this width Userlane will not be available for your users. When left blank Userlane will be shown on all screen sizes.

Target specific application areas

Application dropdown > Settings > General > Target specific application areas

Specify where Userlane Suite content should be available in your application. Your users will see it in the areas indicated in the segment. Check this article to learn more about Page Segments and this article to explore User Segments.