Runtime service configuration attributes

Last Updated : Jun 26, 2025 |

In Avaya Co-Browsing Snap-in, you can set the default group attributes as follows:

Name

Description

Enable Centralized Logging

Indicates that centralized logging is required for the snap-in after it is installed.

This attribute is not editable.

Note:

This feature is available only when Avaya Co-Browsing Snap-in is used with Avaya Oceana®.

Inactive Timeout (Minutes)

Displays the value in minutes. The session ends if the owner of the co-browse session is idle for the time, configured in Inactive time out (minutes). The minimum value is 2 minutes, and the maximum value is 29 minutes.

The default value is 2 minutes.

Inactive Timeout (Message)

Displays the message after the session ends. You can add your custom message.

Session Timeout (Minutes)

Displays the value in minutes. The session ends during a regular clean-up activity, which runs every 30 minutes if the session does not end properly. The minimum value is 30 minutes, and maximum value is 1440 minutes.

The default value is 60 minutes.

Supported Locale

Displays the supported locales by Collaborative Browsing Server. The default values are en_US, de, es, fr, it, ja, ko, ru, zh_CN, pt_BR, zh_TW, and ar_SA co-browse session server can support the following locales:

  • en_US: English

  • de: German

  • es: Spanish

  • fr: French

  • it: Italian

  • ja: Japanese

  • ko: Korean

  • ru: Russian

  • zh_CN: Chinese

  • pt_BR: Portuguese (Brazilian)

  • zh_TW: Traditional Chinese

  • ar_SA: Arabic

Server Default Locale

Displays the default locale. You can configure the locale based on your requirements. For the co-browse session to support English only, you can set the default locale as en_US, or you can change the preference of the language.

Enable Tokenless Access

Setting the value to true enables the client to request access to the resource endpoints without any authorization token.

The following are the attribute options:

  • true: This is the default value.

  • false: Need authorization token to access resource end-points.

Oceana Serviceability Feature Enable

Displays the snap-in heartbeat and life cycle messages on Avaya Aura® System Manager by enabling the monitor service when you set this value to true.

The following are the attribute options:

  • true: Select this value while deploying Avaya Co-Browsing Snap-in with Avaya Oceana®.

  • false: This is the default value.

Use Security IP for Multi-node

If you do not want to use the security IP as the value of parameter Affinity, then set this parameter value to False. The default token name Route is used instead of the IP. You can change the token name by changing the attribute Collaborative Browsing Breeze Node Token name.

The following are the attribute options:

  • true: This is the default value. It indicates that the security IP address is used for the request redirection as the URL parameter Affinity.

  • false: When you set the value to false, the Breeze Node token name value is used in the request redirection REST calls instead of Breeze node IP, then enter a unique collaborative browsing Breeze node token name in the Collaborative Browsing Breeze Node Token name attribute. The default token name used is Route.

Collaborative Browsing Breeze Node Token name

If the customer and the agent are created on different nodes, you can use a unique collaborative browsing Breeze node token name to redirect requests while joining the agent and customer for a co-browsing session.

Important:

You must use this option only when you are not using the security IP address.

The default value is Route. However, you can create a unique name as a unique identifier.