Print

Verifying communication with the Application Interface web service

About this task

Use this procedure to verify the communication with the Application Interface web service and Avaya Experience Portal.

noteNote:

If FIPS is enabled on the system where VPAppIntfClient.sh is being launched, you need to specify the following additional command line arguments:

  • -K <Java Truststore>: The Java truststore file name including the path which contains all the trusted certificates. If the command is running on Primary EPM, the Primary EPM truststore can be specified using the value EPM_TRUSTSTORE.

  • -O <Java Truststore password>: The password for the Java truststore file. If the command is running on Primary EPM, the Primary EPM truststore password can be specified using the value EPM_TRUSTSTORE_PASS

Before you begin

Ensure that you configure Avaya Experience Portal for the Application Interface test client as described in the Configuring Avaya Experience Portal for the Application Interface test client topic in the Implementing Avaya Experience Portal on multiple servers.

Procedure

  1. Log on to Linux on the Experience Portal server.

    If you are an Avaya Services representative using Avaya Enterprise Linux, or if the Avaya Service accounts are installed on this server, do one of the following:

    • Log on to the local Linux console as sroot.

    • Log on remotely as a non-root user, and then change the user to sroot by entering the su - sroot command.

    Otherwise, log on to Linux locally as root, or log in remotely as a non-root user and then change the user to root by entering the su - command.

  2. Navigate to the Application Interface test client directory by entering the cd $AVAYA_HOME/Support/OutCallTest/VPAppIntfClient command.
  3. Use the following examples to know the calling Application Interface test client using different authentication schemes:
    1. Password Authentication

      Enter the ./VPAppIntfClient.sh —n <outcall-username> —p <outcall password> command to request the number of available outbound ports.

      • <outcall-username> is an Experience Portal user name configured with the Web services role on the Users page of the EPM web interface.

      • <outcall password> is the password assigned to the <outcall-username> above that is configured from on the Users page of the EPM web interface.

      noteNote:

      The user must have the Web Services user role.

    2. Certificate Authentication

      Enter the ./VPAppIntfClient.sh -y certificate -k <Java Keystore> —o <Java Keystore password> command to request the number of available outbound ports, where:

      • -y: <certificate> the authentication type is certificate.

      • -k: <Java Keystore> the Java keystore file name including the path. The Java keystore should contain the User identity certificate including the private key.

      • -o: <Java Keystore password> the password for the Java keystore file.

      noteNote:

      Import the User identity certificate to the EPM and ensure that the certificate is assigned to a user of Certificate type.

      The user must have the Web Services user role.

    3. Password and Certificate Authentication

      Enter the ./VPAppIntfClient.sh -n <outcall-username> -p <outcall password> -y password+certificate -k <Java Keystore> —o <Java Keystore password> command to request the number of available outbound ports.

      • <outcall-username> is an Experience Portaluser configured on the Users page of the EPM web interface..

      • <outcall password> is the password for <outcall-username> that is configured on the Users page of the EPM web interface..

      • -y: <password+certificate> the authentication type is password + certificate.

      • -k: <Java Keystore> the Java keystore file name including the path. The Java keystore should contain the User identity certificate including the private key.

      • -o: <Java Keystore password> the password for the Java keystore file.

      noteNote:

      Import the User identity certificate to the EPM and ensure that the certificate is assigned to the <outcall-username> and the user authentication type is Password and Certificate.

      The user must have the Web Services user role.

  4. Verify that the Application Interface test client displays a response that shows the total ports and unused ports available for outcalls.

    Fri Oct 17 15:21:02 PDT 2008: VPAppIntfServiceClient: : queryResources succeeded, TotalResources = 25, UnusedH323 = 15, UnusedSIP = 10

    Fri Oct 17 15:21:02 PDT 2008: VPAppIntfServiceClient: : exiting.

Comments on this document?
August 2025
© 2022-2025, Avaya LLC All Rights Reserved.