Administrator Help

Open topic with navigation

User Module

The User Module implements user sign-in and sign-out to sites that are secured using Essentials Security.

Depending on your security configuration, users may be prompted to sign in when they launch a viewer. For information about Essentials Security, see Security.

In addition, the HTML5 Viewer has links and tools that users can use at any time to sign in or sign out:

• Hyperlinks in the Banner: In the Desktop and Tablet interfaces, the viewer's banner has links that the user can click to sign in or sign out. You can hide one or both of the links using the settings on Manager's Permissions page. The Handheld interface does not have sign-in and sign-out links in the banner.
• Menu Items in the I Want To Menu: The Handheld interface has sign-in and sign-out options in the I Want To menu. If you want, you can remove one or both of these options. See I Want To Menu for instructions.
• Tools in the I Want To Menu: The Global menu, which is contained within the I Want To menu, has tools for signing in and out. The Desktop. Tablet, and Handheld interfaces all show the Global menu by default. You can remove one or both tools from the Global menu if you want. See GlobalMenu Module for information.

If you prefer to customize how users sign in and sign out, you can create hyperlinks, toolbar tools, menu items, and workflows that invoke the User Module's SignIn and SignOut commands.

The Desktop and Tablet interfaces have two views and two view models. SignInView and SignInViewModel control sign-in. UserInfoView and UserInfoViewModel control sign-out. By default, the sign-in and sign-out hyperlinks are in the viewer's BannerContentRegion. The Handheld interface does not have any views or view models.

Configuration Properties

Module

No configuration properties

Views

No views

View Models

• SignInViewModel:

  • linkColor: The color to use for the sign-in hyperlink's text. The color can be an HTML color name or a hexadecimal color, for example, green or #00FF00. The default color is #1B7DBF (blue). If the default color does not show up well against the background color, change linkColor to a color that contrasts better.

• UserInfoViewModel:

  • linkColor: The color to use for the sign-out hyperlink's text. The color can be an HTML color name or a hexadecimal color, for example, green or #00FF00. The default color is #1B7DBF (blue). If the default color does not show up well against the background color, change linkColor to a color that contrasts better.

  • textColor: The color to use for the text in the panel that opens when the user clicks the down arrow  beside the sign-out hyperlink. The color can be an HTML color name or a hexadecimal color, for example, green or #00FF00. The default color is #333333 (gray). Configure textColor and backgroundColor so the panel's text is easy to read.

  • backgroundColor: The color to use for the background of the panel that opens when the user clicks the down arrow   beside the sign-out hyperlink. The color can be an HTML color name or a hexadecimal color, for example, green or #00FF00. The default color is #FFFFFF (white). Configure textColor and backgroundColor so the panel's text is easy to read.