Console settings

What is the Console Settings page?

The Console Settings page allows administrators to configure and manage the settings for the representative console, including customizing behaviors related to user interactions, session management, and access control.

How is the Console Settings page useful to my organization?

This page is useful for tailoring the representative console to your organization's needs, allowing for adjustments to session handling, user interface preferences, and control over access to various features. It helps ensure the console operates efficiently and securely, improving both representative performance and customer support outcomes.

How do I access the Console Settings page?

1. Use a Chromium-based browser to sign in to your Privileged Remote Access URL.
   This URL is provided in the BeyondTrust welcome email and includes your site URL followed by /login.
2. From the left menu, click Console Settings.
   The Rep Console Settings page opens and displays by default.

Access console settings

You can configure the default access console settings for your entire user base, applying a consistent access console user experience and increasing team efficiency. You can force settings, allow settings to be overridden by the user, or leave settings unmanaged. If you select Unmanaged, the BeyondTrust default setting will be displayed alongside for your consideration.

Each Enable or Disable setting provides an administrative checkbox option to become a forced setting. Forced settings take effect on the user's next login and do not allow configuration in the console. A forced setting cannot be overridden unless an administrator deselects the Forced checkbox option for that setting in the /login administrative interface.

Choose the settings you want to be the default for your users, and click the Save button at the top of the page.

Note that saved settings take effect only upon login to the console. Even if you save and apply the changes by clicking the Apply Now button at the bottom of the page, detailed later, the user will not use the new settings until login.

If, for instance, you wish to set up default settings for new users but leave existing users' settings unchanged, save your managed settings but do not apply them. This will make it so all new access console logins will begin with your managed default settings. Existing users will have forced settings applied upon next login, but all other settings will remain unchanged.

Global settings

Enable spell checking

From the Global Settings section, you can choose to enable or disable spell check for chat. Currently, spell check is available for US English only.

Configurable session side bar

Choose if you want the session menu icon to display, if the sidebar can be detached, and if the widgets on the session sidebar can be rearranged and resized.

Alerts - chat alerts

Audible alerts - Play a sound when a chat message is received

Choose if a sound should be played when the user receives a chat message. If unmanaged or if enabled and not forced, the user may designate a custom sound in WAV format no larger than 1MB.

Visual alerts - Flash the application icon when a chat message is received

Choose if the application icon should flash when the user receives a chat message.

Show status messages in team chat windows

Choose if the team chat should include status messages, such as users logging in and out, or only chats sent between team members.

Pop-up notifications

Team chat

Choose if a user should receive a pop-up notification for chat messages received in a team chat.

Access sessions

Choose if a user should receive a pop-up notification for chat messages received in a access session

Alerts - queue alerts

Audible alerts - Play a sound when a session enters any queue

Choose if a sound should be played when a session enters any of a user's queues.

Pop-up notifications

Pop-up notifications appear independent of the access console and on top of other windows. If the pop-up notification is enabled and not forced or left unmanaged, the user will be able to choose how they receive pop-up notifications.

Personal queue - Shared sessions

Choose if a user should receive a pop-up notification for shared sessions in this queue.

Team chat - Shared sessions

Choose if a user should receive a pop-up notification for shared sessions in this queue.

Pop-up behavior - Location and duration

Set the default location and duration for pop-up notifications.

Access sessions

Automatically request screen sharing

Choose if you want your users' sessions to begin with screen sharing.

Automatically detach

Choose if you want to open sessions as tabs in the access console or to automatically detach sessions into new windows.

Default quality

Set the default quality for screen sharing sessions.

Default scaling

Set the default size for screen sharing sessions.

Automatically enter full screen mode when screen sharing starts

When screen sharing starts, the user can automatically enter full screen mode.

Automatically restrict endpoint visibility when screen sharing starts

When screen sharing starts, the remote system can automatically have its display, mouse, and keyboard input restricted, providing a privacy screen.

Command shell

Number of lines of available command history

You can set the number of lines to save in the command shell history. The default value is 500 lines.

Additional external tools

You can define specific external tools that your end-users can use to connect to endpoints. This allows them to work with the tools and applications that they're most familiar with, while taking advantage of the access and security of Privileged Remote Access.

Check Managed to add and use session external tools.

Click Add to make a new external tool in the access console.

For each new tool, complete the following information:

• Enter your desired Name for the tool. This is the name of the tool that appears to the end-user in the dropdown list for the Open Client button, when starting a session.
• Select a Platform. This is the Platform that the tool runs on. The options are Linux, macOS, and Windows.
• Select a Tunnel Type. The options are MSSQL, RDP, and SSH.
• Enter the Command. Click the i icon for example of commands that can be used.
• Enter the Arguments. Click the i icon for example of commands that can be used. Enter one argument per line. Parameters normally inside quotation marks are considered a single argument.

Select any external tool in the list to view and edit its information.

Save

Click Save, in the upper left, to save the profile settings you have configured. A message appears confirming settings saved or updated. Users who download the access console after you save a new profile receive the new settings as the default settings.

Apply access console settings

Apply now

To push the default settings to your users, click Apply Now. The page displays a confirmation message, Settings profile was successfully applied.

Users receive an alert dialog for confirmation when they first log in to the access console after you apply the settings. The dialog warns them that their settings have changed and prompts them with the option to acknowledge the dialog or to open their access console settings window and review the changes.