Editing the tutorial properties file

Last Updated : Jan 21, 2024 |

About this task

Before you can run the sample application, you must edit the tutorial properties file (tutorial.properties) to provide information specific to your configuration.

Procedure

  1. Using the text editor of your choice, open tutorial.properties:

    /opt/mvap/cmapi/cmapijava-sdk/examples/resources/tutorial.properties

    In Release 8.1.1, the tutorial.properties file contains the following text:

    
    # tutorial.properties
    #
    # Copyright (c) 2002-2023 Avaya LLC. All rights reserved.
    . 
    . 
    . 
    # IP address of the call server ( i.e, PROCR/Gatekeeper), which AE Server would 
    # use to register the device (extension) to Communication Manager.callserver=nnn.nnn.nnn.nnn 
    extension=xxxx 
    password=yyyy 
    # codec choices: g711U, g711A, g729, g729A codec=g711U 
    # encryption choices: aes, none 
    encryption=none 
    cmapi1.server_ip=nnn.nnn.nnn.nnn 
    cmapi1.username=username 
    cmapi1.password=password 
    cmapi1.server_port=4722 
    # Legal values for cmapi1.secure are true and false. 
    cmapi1.secure=true 
    #cmapi.trust_store_location=sdk/build/mvsdk/cmapijava-sdk/examples/resources/avaya.jks 
    #if you do not know cmapi.trust_store_password, leave it default #cmapi.trust_store_password=nnnn 
    #cmapi.key_store_location=nnnn.jks 
    #cmapi.key_store_password=nnnn 
    #cmapi.certificate_validation=true 
    #pattern xxx-yyy,ppp-qqq,rrr-sss.... 
    #extensions=41400-41599,50001-50200,51000-51060 
    # by default getButtonInfo value is true. 
    #getButtonInfo=false
    
  2. Replace the variables in the first three fields with the following values:
    1. For callserver, type the IP address of the media server for Communication Manager.

      For Communication Manager S8300D, S8300E, and duplicated systems that use a Processor Ethernet (procr) this is the IP address of the media server.

    2. For extension, type the extension number of the station that you administered for this application.
    3. For password, type the security code you administered for that station.
  3. Add a user_id and user_password for the cmapi1.username and cmapi1.password properties.

    By default, these values are the username and password stored in the User Management database (local LDAP).

    Note:

    To see a list of these users, log in to the AE Services Management Console, and select User Management > User Admin > List All Users.

  4. Set the cmapi1.server_port=4721 and the cmapi1.secure=false.
  5. Save and close the tutorial.properties file.