Running the Application Interface test client VPAppIntfClient.sh

Last Updated : May 05, 2021 |
Prolog information
Metadata
Keywords:
Use this procedure to run the Application Interface test client VPAppIntfClient.sh, and verify if the Application Interface test client shows the total and unused ports available for outcalls, and the result of the LaunchVXML operation.
Note:
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 Configuring Experience Portal for outcall.
  1. Log on to Linux on the Experience Portal server.
    ADDITIONAL INFORMATION:
    If you are an Avaya Services representative, and use Avaya Enterprise Linux, the Avaya Service accounts will not be available after the Avaya Enterprise Linux upgrade. The Avaya Service accounts will be available through EASG configuration during the Experience Portal upgrade.
    • Log on to the local Linux console as root.
    • Or log on remotely as a non-root user and then change the user to root by entering the su - root 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 show calling Application Interface test client using different authentication schemes:
    1. Password Authentication
      ADDITIONAL INFORMATION:
      Enter the ./VPAppIntfClient.sh —n <outcall-username> —p <outcall password> command to request the number of available outbound ports.
      ADDITIONAL INFORMATION:
      • <outcall-username> is an Experience Portal user 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.
      Note:
      The user must have the Web Services user role.
    2. Certificate Authentication
      ADDITIONAL INFORMATION:
      Enter the ./VPAppIntfClient.sh -y certificate -k <Java Keystore> —o <Java Keystore password> command to request the number of available outbound ports.
      ADDITIONAL INFORMATION:
      • -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.
      Note:
      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
      ADDITIONAL INFORMATION:
      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.
      ADDITIONAL INFORMATION:
      • <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 and 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.
      Note:
      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.
    For example:
    Mon Jun 03 16:55:26 PDT 2017:VPAppIntfServiceClient: queryResources succeeded, Total Resources = 0, Unused H323 = 0, Unused SIP = 0
    Mon Jun 03 16:55:26 PDT 2017: VPAppIntfServiceClient: exiting
  5. Use the following examples to show calling Application Interface test client using different authentication schemes.
    1. Password Authentication
      ADDITIONAL INFORMATION:
      Enter the ./VPAppIntfClient.sh -R 1 -A <application-name> -T <number-to-dial> -n <outcall-username> -p <outcall password>  command to initiate an outcall and launch a VoiceXML application.
      • <application-name> is the name of the application that you specify on the application page.
      • <number-to-dial> is the phone number to place the outcall to.
      • <outcall-username> is the Experience Portal username 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 was configured on the Users page of the EPM web interface.
      Note:
      The user must have the Web Services user role.
    2. Certificate Authentication
      ADDITIONAL INFORMATION:
      Enter the ./VPAppIntfClient.sh -R 1 -A <application-name> -T <number-to-dial> -y certificate -k <Java Keystore> —o <Java Keystore password> command to initiate an outcall and launch a VoiceXML application.
      • <application-name> is the name of the application that you specify on the application page.
      • <number-to-dial> is the phone number to place the outcall to.
      • -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.
      Note:
      Import the User identity certificate to the EPM. Ensure that the certificate is assigned to the user of Certificate type.
      The user must have the Web Services user role.
    3. Password and Certificate Authentication
      ADDITIONAL INFORMATION:
      Enter the ./VPAppIntfClient.sh -R 1 -A <application-name> -T <number-to-dial> -n <outcall-username> -p <outcall password> -y password+certificate -k <Java Keystore> —o <Java Keystore password>command to initiate an outcall and launch a VoiceXML application, where:
      • <application-name> is the name of the application that you specify on the application page.
      • <number-to-dial> is the phone number to place the outcall to.
      • <outcall-username> is the Experience Portal user name configured from EPM Web interface.
      • <outcall password> is the password for <outcall-username> that is configured from 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.
      Note:
      Import the User identity certificate to the EPM, ensure that the certificate is assigned <outcall-username>, and the user authentication type is Password and Certificate.
      The user must have the Web Services user role.
  6. Verify that the dialed phone number rings.
  7. Answer the phone and verify that the specified application handles the call.
    ADDITIONAL INFORMATION:
    Note:
    The application handles the call in the same way as when an actual user calls into the system.
  8. Verify that the Application Interface test client displays the following:
    • A response that shows the result of the LaunchVXML operation.
    • The total ports and the unused ports available for outcalls.
    For example:
    Mon Jun 03 17:00:31 PDT 2017: VPAppIntfServiceClient: launchVXML succeeded, SessionID = scaaep134-2013155001030-5, TotalRes = 100, UnusedH323 = 0, UnusedSIP = 99
    Mon Jun 03 17:00:31 PDT 2017: VPAppIntfServiceClient: exiting