Public Site Setting Fields

These fields apply to the public_site_setting_added and public_site_setting_changed events.

Field Value Explanation

exit_survey:representative

1 or 0

1: Enable the representative survey for this public site.
0: Disable the representative survey for this public site.

public_site:customer_notice:display

1 or 0

1: Enable display of customer notice for this public site.
0: Disable display of customer notice for this public site.

public_site:front_end_survey

disabled
api
public_site

Whether the front-end survey is disabled, enabled for use by the API, or enabled for use on the public site and by the API.

public_site:front_end_survey:click_to_chat

1 or 0

1: Sessions started via front-end survey will begin with web-based chat.
0: Sessions started via front-end survey will begin with the full customer client download.

public_site:front_end_survey:company_code

1 or 0

1: Show a company code field on the front-end survey for this public site.
0: Do not show the company code field for this public site.

public_site:front_end_survey:help

1 or 0

1: Show a help option for the front-end survey on this public site.
0: Do not show help for the front-end survey on this public site.

public_site:front_end_survey:options

issues
reps

Whether to display a list of issues or a list of representatives on the front-end survey for this public site. An issue list places customers in a team queue; a representative lists places customers in the selected representative’s personal queue.

public_site:id

string

The unique identifier of the public site to which this settings is applied.

public_site:name

string

The name of the public site to which this setting is applied.

public_site:presentation_list

1 or 0

1: The presentation is enabled for use on the public site.
0: The presentation list is disabled.

public_site:presentation_list:help

1 or 0

1: Show a help option for the presentation list on this public site.
0: Do not show help for the presentation list on this public site.

public_site:rep_list

disabled
api
public_site

Whether the representative list is disabled, enabled for use by the API, or enabled for use on the public site and by the API.

public_site:rep_list:click_to_chat

1 or 0

1: Sessions started via representative list will begin with web-based chat.
0: Sessions started via representative list will begin with the full customer client download.

public_site:rep_list:help

1 or 0

1: Show a help option for the representative list on this public site.
0: Do not show help for the representative list on this public site.

public_site:session_keys

disabled
api
public_site

Whether session key submission is disabled, enabled for use by the API, or enabled for use on the public site and by the API.

public_site:session_keys:click_to_chat

1 or 0

1: Sessions started via session keys will begin with web-based chat.
0: Sessions started via session keys will begin with the full customer client download.

public_site:session_keys:confirm_prompt

1 or 0

1: Sessions started via session keys will prompt before downloading the customer client or presentation attendee client.
0: Sessions started via session keys will not prompt before downloading the customer client or presentation attendee client.

public_site:session_keys:help

1 or 0

1: Show a help option for session key submission on this public site.
0: Do not show help for session key submission on this public site.

rep:history:enabled

1 or 0

1: Enable Team chat history.
0: Team chat history is disabled.

rep:history:hours

integer from 1 to 24

Hours (1 to 24) of Team chat history to replay.

support:abandoned

1 or 0

1: Display an orphaned session message if no one is available to take a support session initiated from this public site.
0: Do not display an orphaned session message if no representatives are available for this public site.

support:abandoned:url

string

Redirect an orphaned session initiated from this public site to this URL. If blank, no redirect will occur.

support:agreement:timeout

integer

The number of seconds to wait for a response to the customer agreement before defaulting to deny.

support:allow_elevate_at_install

always
never
without_prompting

Always attempt to elevate the customer client on Windows® platforms, never attempt to elevate, or attempt to elevate only if doing so will not prompt the customer.

support:app_sharing

1 or 0

1: Allow customers to choose which applications to share at any point of a screen sharing session initiated from this public site.
0: Do not allow customers to choose which applications to share unless specifically requested by the representative.

support:chat:send_file

1 or 0

1: Allow the customer to offer files using the chat interface.
0: Do not allow the customer to offer files using the chat interface.

support:display_customer_notice

1 or 0

1: Enable display of customer notice for this public site.
0: Disable display of customer notice for this public site.

support:full_client:agreement

1 or 0

1: Show a customer agreement message before full client support sessions initiated from this public site.
0: Do not display a customer agreement before full client support sessions for this public site.

support:greeting

1 or 0

1: Display a customer greeting message before support sessions initiated from this public site.
0: Do not display a customer greeting for this public site.

support:initial_interface_mode

chat
mini

Start the customer client in chat mode or in mini mode.

support:invite:email:from_address string The email address from which server-side invitation emails are sent.

support:ios:config_page_enabled

1 or 0

1: The iOS configuration profiles page is enabled.
0: The iOS configuration profiles page is disabled.

support:jump_client:minimize_ui

1 or 0

1: Start Jump Client minimized.
0
: Do not start Jump Client minimized.

support:landing_page:chat:download

1 or 0

1: Allow customers to view and download chat transcripts at the end of support sessions from this public site.
0: Do not allow customers to view chat transcripts on this public site.

support:landing_page:custom_url

string

The URL to which to direct the customer at the end of the session if post-session customer redirect is enabled.

support:landing_page:exit_survey


0, 1, or 2

0: Disable the customer exit survey for this public site.
1: Enable the BeyondTrust customer exit survey for this public site.
2: Redirect the customer to the URL specified for this public site.

support:landing_page:recordings:download

1 or 0

1: Allow customers to view and download session recordings at the end of support sessions from this public site.
0: Do not allow customers to view recordings on this public site.

support:minimize_ui

1 or 0

1: Start customer client minimized for attended sessions.
0
: Do not start customer client minimized for attended sessions.

support:on_hold

1 or 0

1: Display a hold message before support sessions initiated from this public site.
0: Do not display a hold message for this public site.

support:on_hold:interval

integer

The number of seconds to wait between each time the hold message is sent from this public site.

support:prompt_mode links
pop-ups
Whether customer client prompts should be shown as links or as pop-ups.

support:prompts:session_recording

1 or 0

1: Display a prompt to allow or deny session recording before full client support sessions initiated from this public site.
0: Do not display a prompt to allow or deny session recording.

support:reconnect_interval

integer

The number of seconds a customer client should attempt to reconnect if the connection is lost from this public site.

support:recordings:command_shell

always
never
use_site_wide_setting

Always record Flash videos of command shell sessions, never record command shell sessions, or follow the site-wide setting.

support:recordings:screen_sharing

always
never
use_site_wide_setting

Always record Flash videos of screen sharing sessions, never record screen sharing sessions, or follow the site-wide setting.

support:rep_presence_indicator

1 or 0

1: Show an on-screen indicator when a representative is in session with the customer (Windows® only).
0: Do not show an on-screen indicator.

support:show_hostname_in_window_title

1 or 0

1: Show the public site hostname in the customer client window title.
0: Do not show the hostname in the window title.

support:system_info:auto_log disable
enable
use_site_wide_setting
For sessions run through this public site, disable automatic logging of session information, enable automatic logging, or use the site-wide setting.

support:termination_behavior:rep_override

1 or 0

1: Enable reps to override the administratively set session termination setting from the representative console.
0: Disable allowing reps to override the administratively set session termination setting from the representative console.

support:termination_behavior:restrict_access

1 or 0

1: Enable the restriction of your customer's access to their system in the event of a session disruption.
0: Disable the restriction of your customer's access to their system in the event of a session disruption.

support:wait_time integer The maximum estimated wait time to display in the customer greeting or on-hold message.

support:web_client:agreement

1 or 0

1: Show a customer agreement message before click-to-chat sessions initiated from this public site.
0: Do not display a customer agreement before click-to-chat sessions for this public site.

support:windows:prompts :
secure_attention_sequence_override

1 or 0

1: When supporting Windows Vista or later, the Secure Attention Sequence injection policy can be attempted to be overridden.
0: The Secure Attention Sequence injection policy should not be attempted to be overridden.

support:system_info:auto_log

always
never
use_site_wide_setting

Always log the remote computer's system information at the beginning of session, never log system information, or follow the site-wide setting.