Configuring the Avaya Analytics deployment spreadsheet for Messaging

Last Updated : Jul 28, 2022 |

About this task

The deployment of Avaya Analytics™ is done through the Avaya_Oceana_Application_Deployment_<ReleaseNumber>.xlsm spreadsheet. To deploy Messaging, you must configure the values on the Messaging tab in the spreadsheet.

Procedure

  1. Open the Avaya_Oceana_Application_Deployment_<ReleaseNumber>.xlsm file.
  2. Click the Deployment Properties tab.
  3. Set the Install Async Messaging field to TRUE.
  4. On the Async tab, configure the following attributes for the Cloud Provider and Avaya Oceana®:

    Attribute

    Description

    config:async-aggregator-interface:tenantmapping:aggregator:applicationId

    The Application ID that is analogous with a Tenant ID. It is the Cloud Provider ID that is created with every new Messaging installation.

    The Avaya DevOps team provides this ID.

    config:async-aggregator-interface:tenantmapping:aggregator:jwt:keyid

    The Cloud Provider key.

    The Avaya DevOps team provides this key.

    config:async-aggregator-interface:tenantmapping:aggregator:jwt:security

    The Cloud security key.

    The Avaya DevOps team provides this key.

    config:async-aggregator-interface:tenantmapping:aggregator:uri

    The Cloud Provider API address zone.

    Using this attribute, you can determine at the time of installation whether the AWS instance is US data center or EU data center. You can select the data center in the deployment Excel file. Once you deploy it, you cannot change the data center. The default value is US data center.

    config:async-oceana-adapter:oceana:clientcontroller:host

    The FQDN of Avaya Oceana® cluster 3 where CustomerControllerService is installed.

    For example, your-cluster.async.oceana.com

    Note:
    • The FQDN must be all lowercase and must follow the valid FQDN guidelines.

    • You can explicitly specify a port number with the FQDN. For example, your-cluster.async.oceana.com:433. By default, the system uses the port number 443 for wss and port number 80 for ws.

    config:async-oceana-adapter:oceana:contactPriority

    The contact priority that you must set for every new contact in Async.

    Enter a value between 1 and 10, in which 1 is the highest priority and 10 the lowest.

    config:async-oceana-adapter:oceana:clientcontroller:protocol

    The CustomerControllerService API provides the following two types of protocols based on the setup:

    • Secure web socket (wss)

      This protocol requires manual steps to configure System Manager Certificate Authority (CA) and Identity Certificates.

    • Non-secure (ws)

    config:async-oceana-adapter:oceana:defaultAttributes

    Default routing attributes for Messaging interactions.

    config:async-oceana-adapter:service:reversedns:ip

    The IP address of Avaya Oceana® cluster 3.

    config:async-oceana-adapter:service:reversedns:hostnames[0]

    The FQDN of Avaya Oceana® cluster 3.

    Ensure that the entries consist of lower case alphanumeric characters and "-" or ".". Also ensure that the entries start and end with an alphanumeric character.

    config:async-file-transfer:filetransfer:oceana:storageEndpoint

    The FQDN of Avaya Oceana® cluster 3 where CustomerControllerService is installed.

    For example, your-cluster.async.oceana.com

    Note:
    • The FQDN must be all lowercase and follow the valid FQDN guidelines.

    • You can explicitly specify a port number with the FQDN. For example, your-cluster.async.oceana.com:433. By default, the system uses the port number 443 for wss and port number 80 for ws.

    config:async-file-transfer:filetransfer:oceana:user

    The user name of the default user that authenticates file transfer uploads into Avaya Oceana®. The user must able to login to Avaya Workspaces.

    Important:

    Ensure that this user is created before the installation and is not shared by any other application.

    config:async-file-transfer:filetransfer:oceana:password

    The password of the default user that authenticates file transfer uploads into Avaya Oceana®.

    config:async-file-transfer:filetransfer:oceana:publicStorageChannels

    The list of social media channels.

    config:async-aggregator-interface:tenantmapping:contactcenter:connectionLivelinessTimeout

    Optional. The time in seconds, which sets the liveliness connection threshold between Async messaging services. This is an optional attribute.

    config:async-aggregator-interface:tenantmapping:aggregator:deliveryFailure:message

    The status message displayed when the application is down. For example:

    Dear Customer, our services are currently unavailable. Please try again later.

    config:async-oceana-adapter:tryAgainLaterMessage

    The status message displayed when the application cannot create a WebSocket because of the "too many open files" error. For example:

    Dear Customer, our service is currently under a heavy load. Please try again later.

    config:async-oceana-adapter:profanityFilterService:endpoint

    Endpoint for the Profanity Filter server that validates messages using a REST API call.

    The default value is: http://localhost:8099/filter

    adapter:oceana:addIntegrationAttribute

    Optional. If enabled, additional routing attribute is added for Messaging Interactions. This attribute includes information about channel from which message is received with MessagingChannel prefix.

    For example, MessagingChannel.twitter or MessagingChannel.web. Channel values are: web - android - ios - messenger - whatsapp - twitter Switched off (false) by default.

    config:async-oceana-adapter:oceana:addIntegrationAttribute

    Default value is false, optional.

    *Optional.

    If enabled, additional routing attribute is added for Messaging Interactions. This attribute includes information about channel from which message was received with MessagingChannel prefix. For example, MessagingChannel.twitter, MessagingChannel.web.

    The channel values are:
    • web

    • android

    • ios

    • messenger

    • whatsapp

    • twitter

    Switched off (false) by default.

    config:async-oceana-adapter:Filter Service REST Url

    Default value is Blank.

    Path to a filtering service that may be used to remove offensive text from messages.

    This is an optional field.

    config:async-oceanaadapter:Filter Service Timeout

    Default value is 5.

    Value is in seconds for the async-oceana-adapter to wait for a response from the filtering service. If no response is received within the timeout period, the original unfiltered message is used.

    config:async-oceanaadapter: FilterEnabled flag

    Default value is FALSE.

    The flag indicates if the filtering service should be called. True indicates the filtering service (if a URL is set) will be called. False (or no URL set) will bypass the filtering service.

    config:async-oceanaadapter: SilentAlarms flag

    Default value is TRUE.

    The flag indicates if an SNMP alarm shall be raised when the filter is enabled and the timeout period is exceeded. If TRUE, no alarm is raised but a log entry is created. If FALSE, an alarm is raised for each message where the timeout occurs.

  5. In the Product to Install field, select async (Async Messaging).
  6. Continue with the installation steps of Avaya Analytics™.
  7. If the cluster is already deployed, run the following command to add Messaging:

    ccm upgrade spec “Avaya_Oceana_Application_Deployment_<ReleaseNumber>.xlsm” --products --force

    Note:

    Async pods start in a 0/1 Ready state by design. The force option skips this check and continues with the upgrade.