OceanaConfiguration attributes

Last Updated : Jun 20, 2022 |

Deployment

Name

Description

Deployment Type

The type that determines the deployment size for the installation.

  • For an Avaya Oceana® deployment that supports up to 4500 active agents, select 3X Large.

  • For an Avaya Oceana® deployment that supports up to 2000 active agents, select Extra Large.

  • For an Avaya Oceana® deployment that supports up to 1000, 500, or 250 active agents, select Large.

  • For an Avaya Oceana® deployment that supports up to 100 active agents, select Small.

Locale

The locale or language for the installation.

Secure Communications

The attribute that enables or disables the secure communications across the clusters in the installation.

For Https-only and wss-only connections across the clusters, select Enabled.

Allow Tokenless Access

This is used to allow requests to access resource end-points, even if there is no Authorization token. Set to false if all clients must have an Authorization Token

Clusters

Name

Description

Common Cluster

To set this attribute, select Avaya Oceana® Cluster 1.

Context Store Cluster

The cluster that hosts Context Store services.

To set this attribute, select Avaya Oceana® Cluster 1.

Co-Browse Cluster

The cluster that hosts the CoBrowse service.

To set this attribute, select Avaya Oceana® Cluster 4.

OCP Cluster

The cluster that hosts Omnichannel Provider services.

To set this attribute, select Avaya Oceana® Cluster 3.

Customer Management Cluster

The cluster that hosts the CustomerManagement service.

To set this attribute, select Avaya Oceana® Cluster 1.

Chatbot Cluster

The cluster that hosts the BotConnector service.

  • For an Avaya Oceana® deployment that supports up to 100 active agents, select Avaya Oceana® Cluster 1.

  • For an Avaya Oceana® deployment that supports up to 4500, 2000, 1000, 500, or 250 active agents, select Avaya Oceana® Cluster 2.

Unified Agent Cluster

The cluster that hosts Unified Agent services.

  • For an Avaya Oceana® deployment that supports up to 100 active agents, select Avaya Oceana® Cluster 1.

  • For an Avaya Oceana® deployment that supports up to 4500, 2000, 1000, 500, or 250 active agents, select Avaya Oceana® Cluster 2.

Authorization Services Address

The Fully Qualified Domain Name or IP of the cluster where Authorization Service is installed.

Note:

This is a mandatory attribute.

Monitoring

Name

Description

Cluster Monitor 1

The first cluster that you want to monitor through OceanaMonitorService.

To set this attribute, select Avaya Oceana® Cluster 1.

Cluster Monitor 2

The second cluster that you want to monitor through OceanaMonitorService.

To set this attribute, select Avaya Oceana® Cluster 2.

Cluster Monitor 3

The third cluster that you want to monitor through OceanaMonitorService.

To set this attribute, select Avaya Oceana® Cluster 3.

Cluster Monitor 4

The fourth cluster that you want to monitor through OceanaMonitorService.

To set this attribute, select Avaya Oceana® Cluster 4.

Cluster Monitor 5

The fifth cluster that you want to monitor through OceanaMonitorService.

Do not select any value for this attribute.

EASG authorization enabled in Oceana Monitor

The attribute that enables or disables EASG authorization for the Oceana Monitor.

  • To enable EASG authentication, keep the default value true.

  • To disable EASG authentication, select false.

Restart the snap-in for the changes to reflect.

Voice Channel

If the Avaya Oceana® deployment has the Voice Channel feature, select true.

Video Channel

If the Avaya Oceana® deployment has the Video Channel feature, select true.

Chat Channel

If the Avaya Oceana® deployment has the Chat Channel feature, select true.

Email Channel

If the Avaya Oceana® deployment has the Email Channel feature, select true.

SMS Channel

If the Avaya Oceana® deployment has the SMS Channel feature, select true.

Social Channel

If the Avaya Oceana® deployment has the Social Channel feature, select true.

Generic Channel

If the Avaya Oceana® deployment has the Generic Channel feature, select true.

Asynchronous Messaging Channel

If the Avaya Oceana® deployment has the Asynchronous Messaging Channel feature, select true.

Customer Journey

If the Avaya Oceana® deployment has the Customer Journey feature, select true.

Reporting

If the Avaya Oceana® deployment has the Reporting feature, select true.

Outbound

If the Avaya Oceana® deployment has the Outbound Channel feature, select true.

Automation

If the Avaya Oceana® deployment has the Automation feature, select true.

Geo-Redundancy

Name

Description

Disaster Recovery Mode

The geo-redundancy mode for this system. For a standalone deployment, set this to Standalone. For a geographical disaster recovery deployment, set this attribute to Geo Primary on the primary site, and Geo Secondary on the secondary site.

Geo-Redundant Common Cluster

A mandatory attribute configured on a geographical disaster recovery deployment.

Keystore file name

Certificate name of the geo-redundancy keystore.

Keystore password

The password of the geo-redundancy keystore.

Voice

Name

Description

Voice Provider Id

The name of the Voice provider (Type:CM) that you plan to configure in Avaya Control Manager.

Application Enablement Services' IP addresses

The IP address of the Application Enablement Services server that you plan to connect to Communication Manager through a TSAPI link.

If two instances of Application Enablement Services are used for HA, click the plus sign (+) and add the second instance of Application Enablement Services.

Communication Manager Connection Name on Application Enablement Services

The name of the Communication Manager switch connection that you plan to configure on Application Enablement Services.

If two instances of Application Enablement Services are used for HA, the same name must be configured for both instances.

AES user

The user name of the Application Enablement Services account.

If two instances of Application Enablement Services are used for HA, the same user name must be configured for both instances.

AES user password

The password of the Application Enablement Services account.

If two instances of Application Enablement Services are used for HA, the same password must be configured for both instances.

Multimedia

Name

Description

Omnichannel Database Address

The FQDN or IP address of Omnichannel Database.

Username for the Omnichannel Database

The user name for Omnichannel Database.

The default user name for Omnichannel Database is mmJava.

Password for the Omnichannel Database

The password for Omnichannel Database.

The default password for Omnichannel Database is mmJav.

Important:

If you change the password for Omnichannel Database through Cache Management Portal, you must also enter the same password in the field.

Secure Connections to Omnichannel Database

The attribute that toggles a secure connection to Omnichannel Database.

To set this attribute, select true.

Public OCP FQDN/IP Address

The Fully Qualified Domain Name or IP address of the Omnichannel Provider (OCP).

Video

Name

Description

Default Web Voice SIP address

The number that you plan to configure in Engagement Designer Event Mapper to trigger the Web Voice workflow.

Default Video SIP address

The number that you plan to configure in Engagement Designer Event Mapper to trigger the Web Video workflow.

Fully Qualified Domain Name (FQDN) for the Avaya Aura Web Gateway

The FQDN of Avaya Aura® Web Gateway.

Important:

Do not enter an IP address in this field.

Unified Agent Client

Name

Description

Log Upload Location

The location of the shared network folder that all Unified Agent clients can access to upload the logs when the agents select the Upload option.

Unified Agent clients are the clients that are running remotely on the agent’s computer.

AADS FQDN

The Avaya Aura® Device Services (AADS) FQDN, which the Avaya Workspaces address book uses to search for enterprise directory contacts using LDAP.

External Data Mart

Name

Description

External Data Mart Persistence Type

The attribute that specifies how the Context Store data is stored in the EDM.

For more information, see the External Data Mart persistence section in the Avaya Context Store Snap-in Reference guide.

The options are:

  • Audit: Enables persistence of Audit context data to EDM.

  • Journey: Enables persistence of Customer Journey and Context Resurrection related data to EDM.

Important:

Avaya Oceana® deployments must use a persistence type of Journey.

External Data Mart Database Type

The type of the EDM database.

The available value for both upgrading to Avaya Oceana® Release 3.8 and new Avaya Oceana® Release 3.8 deployment is Microsoft SQL Server.

External Data Mart FQDN

The FQDN of the EDM database.

Important:

For MS SQL Always On HA, use the FQDN of the Availability Group listener.

External Data Mart Port

The port number of the EDM database.

External Data Mart Database Name

The name of the EDM database.

External Data Mart Username

The user name of the EDM database.

External Data Mart Password

The password for the user specified in the External Data Mart Username attribute.

Secure Connections to EDM

Specifies if communications between the Context Store and the EDM should use a secure connection.

The default value is true.

Note:

For unsecured connections from Avaya Oceana® to EDM, you must set the value to false. Unsecured EDM connections are for lab use only. They are not intended for Avaya Oceana® instances that conform to security policies.

EDM: TLS version

The version of TLS to use when connecting to EDM.

The supported versions are:

  • TLSv1.2

  • TLSv1.1

  • TLSv1.0

Disable persistence of personally identifiable data

When you set this attribute to true, External Data Mart (EDM) stops storing the following types of data:

  • Any digits collected during self-service

  • Custom data entered in the in the Data field.

EDM stops storing these types of personally identifiable data to comply with data privacy laws.

Engagement Designer

Name

Description

Delete instances on completion

The attribute that enables or disables the deletion of completed instances.

For Avaya Oceana®, select true.

Media Server Inclusion

The attribute that enables or disables the inclusion of Avaya Aura® Media Server.

To configure Avaya Oceana® for Web Voice/Video, select true.

Chatbot Site Identifier

A comma separated string of BotConnector Site IDs in the Site Id:Friendly Name format.

Messaging Connection Service

Name

Description

Snap-in Service 1 Name

The name of the first MessagingConnector snap-in service.

Snap-in 1 Key

The database key for the first snap-in account, which is obtained after setting up data in Omnichannel Database. For example, if you set this attribute for SMS, you must enter the name of the snap-in that you create while configuring the SMS gateway.

Snap-in 1 Cluster

The cluster that hosts the first MessagingConnector snap-in service.

Snap-in Service 2 Name

The name of the second MessagingConnector snap-in service.

Snap-in 2 Key

The database key for the second snap-in account, which is obtained after setting up data in Omnichannel Database.

Snap-in 2 Cluster

The cluster that hosts the second MessagingConnector snap-in service.

Snap-in Service 3 Name

The name of the third MessagingConnector snap-in service.

Snap-in 3 Key

The database key for the third snap-in account, which is obtained after setting up data in Omnichannel Database.

Snap-in 3 Cluster

The cluster that hosts the third MessagingConnector snap-in service.

SMS Vendor

Name

Description

Oceana Messaging Service IP or FQDN

The URL of the cluster where the MessagingService is installed.

Oceana Messaging Service key

The Snap-in field configured in Omnichannel Database Administration client.

Co Browse

Name

Description

Multimedia CoBrowse Database Username

The user name for the Co-Browse database.

To set this attribute, type the user name as Cobrowse.

Multimedia CoBrowse Database Password

The password for the Co-Browse database.

To set this attribute, type the password as Oceana16.

Multimedia CoBrowse Database Name

The name of the Co-Browse database.

Oceana Event Reporting

Name

Description

Oceana Eventing

The attribute that enables or disables event notifications to be sent out to subscribed services. You must enable this attribute if you use Avaya Analytics™.

Important:

For Work Assignment and Engagement Designer attributes, administrators must examine the individual attributes in Service attributes overview.

OBCService

Name

Description

POM Server

The FQDN or IP address of the POM server that is to be serviced by Outbound Connector.

POM Server Port

The port number that the POM server uses to connect to Outbound Connector.

Zang SMS Connector

Name

Description

Enable Zang SMS Connector Tokenless Access

The attribute that enables the requests to access resource end-points without any authorization token.

To enable tokenless access, retain the default value true.

This feature is available for Avaya Oceana® mode only.

Maintenance Mode

The attribute to enable the maintenance mode.

The supported values are true and false. The default value is false.

This feature is available for Avaya Oceana® mode only.

Oceana Mode

The attribute to enable or disable Avaya Oceana® support for ZangSmsConnector.

Key for Oceana Messaging Service

The attribute used for polling the Avaya Oceana® SMS snap-in for accounts information.

This attribute is mandatory to support the Oceana mode.

Oceana Messaging Service IP

The Avaya Oceana® cluster that hosts the MessagingService snap-in.

This option is mandatory for the Oceana mode.

Oceana Messaging Service Name

The name of the MessagingService snap-in.

This option is mandatory to support the Avaya Oceana® mode.

Oceana Data Viewer

Name

Description

CustomerControllerService Cluster

The cluster that hosts the CustomerControllerService.