Create Application page field descriptions

Last Updated : Dec 04, 2020 |

Prolog information

Metadata

Keywords:

Note:

Before you add an application or a data source application to your Avaya OneCloud™ Subscription system, ensure that you read the instructions mentioned in the checklist for adding applications and perform the prerequisites for adding applications and data source applications.

For example, prerequisites for adding certain data source application can involve the following:

Installing certificates.
Creating a new user account in the data source application. You need to use the access credentials of the new user account when adding the data source application to your Avaya OneCloud™ Subscription system. Usage Metering Collector uses these credentials to connect to the data source application for collecting usage data.

For more information, see Checklist for adding applications to an Avaya OneCloud Subscription system.

Common fields on the Create Application page

Field name	Description
Application Type	Click the application that you want to add to the Avaya OneCloud™ Subscription system. The applications that are displayed in the Application Type field depend on the service bundle that you have ordered for this Avaya OneCloud™ Subscription system.
Application Description	Type a description for the application.
Primary IP	Type the IP address of the primary application. Note: If you are adding a Session Manager, type the Management Interface IP address of the Session Manager. If you are adding applications of the same application type to one or more Avaya OneCloud™ Subscription systems that are configured on the same Usage Metering Collector, ensure that the IP address that you specify is different for each such application. Otherwise, Usage Metering Collector shows an error message. An example of applications of the same application type is two or more CMS. Usage Metering Collector performs this verification on the IP addresses that you specify in both Primary IP and Secondary IP fields when you are adding these applications. However, if you want to share an application, for example, a CMS, between two or more Avaya OneCloud™ Subscription systems, see Application sharing between two or more Avaya OneCloud Subscription systems.
Version	Click the version number of the application. Ensure that the application is of either the minimum version that is supported by Avaya OneCloud™ Subscription or of a later version. For more information, see Avaya UC and CC applications supported by Avaya OneCloud Subscription.
Deployment Type	Click the deployment type of the application.
FL/Sold-To	Type the Functional Location number (FL) or Sold To number (ST) of your location.
SAL Gateway SEID	Type the Solution Element ID (SEID) of the SAL gateway.

If you are adding a data source application to your Avaya OneCloud™ Subscription system, Usage Metering displays additional data source application-specific fields.

For information about the data source application-specific fields, refer to the data source application-specific sections in this topic.

Application Enablement Services-specific fields

The following additional fields are available when you are adding Application Enablement Services to your Avaya OneCloud™ Subscription system.

Ensure that you have performed the prerequisites before adding Application Enablement Services to your Avaya OneCloud™ Subscription system.

For more information, see Prerequisites and process for adding Application Enablement Services.

Field name	Description
Hostname	Type the FQDN of the Application Enablement Services server.
Port	Type the SSH port number to access Application Enablement Services. If you do not specify a port number, Usage Metering uses the default SSH port number 22 to access Application Enablement Services.
Username	Type the user name of the user account that you created in the susers Linux group in Application Enablement Services. For more information, see Create a new user account in Application Enablement Services.
Password	Type the password of the user account.
TEST	Click to verify if Usage Metering successfully connects to the Application Enablement Services server.

Experience Portal Manager-specific fields

The following additional fields are available when you are adding Avaya Aura® Experience Portal - Experience Portal Manager (EPM) (also known as Voice Portal EPM) to the Avaya OneCloud™ Subscription system.

These fields are not available when you are adding an auxiliary EPM to your Avaya OneCloud™ Subscription system.

Ensure that you have performed the prerequisites before adding EPM to your Avaya OneCloud™ Subscription system.

For more information, see Prerequisites and process for adding Experience Portal Manager.

Field name	Description
Database IP	Type the IP address of the Experience Portal database server that Usage Metering must connect to for collecting usage data.
Port	Type the port number to access the Experience Portal database. If you do not specify a port number, Usage Metering uses the default port number 1433 to access the Experience Portal database.
Username	Do one of the following: If Experience Portal uses the local Postgres database, type the user name of the read-only (report) user that you created for the local Postgres database. For more information, see Creating a read-only user account for Experience Portal local Postgres database. If Experience Portal uses an external database, that is, an external Postgres or Microsoft SQL database, type the user name of the read-only user that you created for the external database. For more information, see Create a read-only user account for the Experience Portal database.
Password	Type the password to access the Experience Portal database.
Socket Timeout	Type the time, in seconds, till which Usage Metering must attempt to connect to the Experience Portal database. If you do not specify a time-out period, Usage Metering uses the default time-out period, which is 120 seconds.
Database Name	Type the name of the Experience Portal database. If Experience Portal uses the local Postgres database, type VoicePortal.
SSL	Select the SSL check box if you want to use SSL secure connection to connect to the Experience Portal Postgres database. Ensure that you have performed the prerequisite for enabling SSL connection to the Experience Portal Postgres database. For more information, see Enabling SSL connection between Experience Portal Postgres database and Usage Metering. Currently, Avaya OneCloud™ Subscription supports SSL connection only for the Experience Portal local Postgres and external Postgres databases. Do not select this check box if Experience Portal uses a Microsoft SQL database. Note: If you enable SSL for the primary EPM, Avaya recommends you to enable SSL for the secondary EPM.
TEST	Click to verify if Usage Metering successfully connects to the Experience Portal database.

Avaya Aura® Messaging-specific fields

The following additional fields are available when you are adding Avaya Aura® Messaging to your Avaya OneCloud™ Subscription system.

Ensure that you have performed the prerequisites before adding Avaya Aura® Messaging to your Avaya OneCloud™ Subscription system.

For more information, see Prerequisites and process for adding Avaya Aura Messaging.

Field name	Description
Hostname	Type the FQDN of the Avaya Aura® Messaging server. Ensure that the FQDN matches the following: Avaya Aura® Messaging server CN present in the identity certificate of the Avaya Aura® Messaging server. Avaya Aura® Messaging server FQDN to IP address mapping entry that is present in the DNS server or /etc/hosts file. For more information, see Identifying the root CA certificate installed in Avaya Aura Messaging and installing it in Usage Metering Collector.
Port	Type the LDAP SSL port number that you specified in Avaya Aura® Messaging. For more information, see Enabling LDAP SSL port in Avaya Aura Messaging and Add Usage Metering Collector as a trusted server in Avaya Aura Messaging. If you do not specify a port number, Usage Metering uses the default port number 636 to access Avaya Aura® Messaging.
Username	Type the trusted server name that you specified for the Usage Metering Collector when adding it as a trusted server in Avaya Aura® Messaging. For more information, see Add Usage Metering Collector as a trusted server in Avaya Aura Messaging.
Password	Type the password that you specified when adding the Usage Metering Collector as a trusted server in Avaya Aura® Messaging.
TEST	Click to verify if Usage Metering successfully connects to the Avaya Aura® Messaging server.

Avaya Aura® System Manager-specific fields

The following additional fields are available when you are adding System Manager to your Avaya OneCloud™ Subscription system.

Ensure that you have performed the prerequisites before adding System Manager to your Avaya OneCloud™ Subscription system.

For more information, see Prerequisites and process for adding System Manager.

Field name	Description
Port	Type 5432. Ensure that you have performed the prerequisite that opens port 5432 and enables SSL connection. Usage Metering Collector uses port 5432 to access the System Manager Postgres Server. For more information, see Creating a Postgres user and enabling SSL connection between Usage Metering and System Manager Postgres database.
User name	Type the user name of the read-only user that you created for the Postgres database. For more information, see Creating a Postgres user and enabling SSL connection between Usage Metering and System Manager Postgres database.
Password	Type the password of the read-only user that you created for the Postgres database.
Database Name	Type avmgmt, which is the name of the System Manager Postgres database.
Socket Timeout	Type the time, in seconds, till which Usage Metering must attempt to connect to the Postgres database. If you do not specify a time-out period, Usage Metering uses the default time-out period, which is 120 seconds.
TEST	Click to verify if Usage Metering successfully connects to the System Manager Postgres database.

Avaya Callback Assist Application Server-specific fields

The following additional fields are available when you are adding Avaya Callback Assist Application Server to your Avaya OneCloud™ Subscription system.

Ensure that you have performed the prerequisites before adding Avaya Callback Assist Application Server to your Avaya OneCloud™ Subscription system.

For more information, see Prerequisites and process for adding Avaya Callback Assist Application Server.

Field name	Description
Hostname	Type the FQDN or IP address of the Avaya Callback Assist Application Server.
Port	Type the port number to access Kafka broker in Avaya Callback Assist. If you do not specify a port number, Usage Metering uses the following default ports: Port 9092 to connect to Kafka broker by using unsecure connection. Port 9093 to connect to Kafka broker by using SSL.
User name	Type the user name of Kafka broker that is configured in Avaya Callback Assist. If you do not specify the user name, Usage Metering uses the default user name that is displayed in this field. The User name field is unavailable if you are adding Avaya Callback Assist version 4.7.x to your Avaya OneCloud™ Subscription system.
Password	Type the password of Kafka broker that is configured in Avaya Callback Assist. If you do not specify the password, Usage Metering uses the default password that is displayed in an encrypted format in this field. The Password field is unavailable if you are adding Avaya Callback Assist version 4.7.x to your Avaya OneCloud™ Subscription system.
Kafka Topic Name	Retain the default value, that is, callback-requests, in this field. This is the name of the Avaya Callback Assist Kafka topic from which Usage Metering collects usage data.
SSL	Select the SSL check box if you want to use SSL secure connection to connect to Avaya Callback Assist Kafka broker. Ensure that you have performed the prerequisites for enabling SSL connection between Usage Metering and Avaya Callback Assist. For more information, see Enabling SSL connection between Usage Metering and Avaya Callback Assist. Note: If you enable SSL for the primary Avaya Callback Assist Application Server, Avaya recommends you to enable SSL for the secondary Avaya Callback Assist Application Server.
TEST	Click to verify if Usage Metering successfully connects to Avaya Callback Assist Kafka broker.

Avaya Call Management System-specific fields

The following additional fields are available when you are adding Avaya Call Management System to your Avaya OneCloud™ Subscription system.

Ensure that you have performed the prerequisites before adding Avaya Call Management System (CMS) to your Avaya OneCloud™ Subscription system.

For more information, see Prerequisites and process for adding Avaya Call Management System.

Field name	Description
Port	Type the port number to access Avaya Call Management System. If you do not specify a port number, Usage Metering uses the default port number 50001 to access Avaya Call Management System.
User name	Type the user name, with secure access permissions to the CMS database, that you created in CMS. For more information, see Creating a new user account in CMS with secure access permission to the CMS database.
Password	Type the password to access the CMS database.
Socket Timeout	Type the time, in seconds, till which Usage Metering must attempt to connect to the CMS database. If you do not specify a time-out period, Usage Metering uses the default time-out period, which is 120 seconds.
SSL	Select the SSL check box if you want to use SSL secure connection to connect to the CMS database. Ensure that you have performed the prerequisite for enabling SSL connection to the CMS database. For more information, see Enabling SSL secure connection to the CMS database. Note: If you enable SSL for the primary CMS, Avaya recommends you to enable SSL for the secondary CMS.
TEST	Click to verify if Usage Metering successfully connects to Avaya Call Management System.

Avaya IX™ Messaging-specific fields

The following additional fields are available when you are adding Avaya IX™ Messaging (Office Linx) to your Avaya OneCloud™ Subscription system.

Ensure that you have performed the prerequisites before adding Avaya IX™ Messaging to your Avaya OneCloud™ Subscription system.

For more information, see Prerequisites and process for adding Avaya IX Messaging.

Field name	Description
Hostname	Type the FQDN of the Avaya IX™ Messaging server. Ensure that the FQDN matches the following: Avaya IX™ Messaging server CN present in identity certificate of the Avaya IX™ Messaging server. Avaya IX™ Messaging server FQDN to IP address mapping entry that is present in the DNS server or /etc/hosts file. For more information, see Installing the root certificate used by Avaya IX Messaging for authentication in Usage Metering Collector.
Username	Type the user name of the administrative user that you created in Avaya IX™ Messaging. For more information, see Create a new administrative user account in Avaya IX Messaging.
Password	Type the password of the administrative user that you created in Avaya IX™ Messaging.
Port	Type the port number to access Avaya IX™ Messaging. If you do not specify a port number, Usage Metering uses the default port number 443 to access Avaya IX™ Messaging.
Auth Type	Click OL_JWT. Usage Metering uses JSON Web Token to authenticate with and connect to Avaya IX™ Messaging.
TEST	Click to verify if Usage Metering successfully connects to Avaya IX™ Messaging.

Send Feedback

AVAYA DOCUMENTATION CENTER

No results found