Before using the features in the sample application you will have to acquire configuration information from your administrator to allow the Sample App to connect to the network services you are interested in.
The worksheet below is provided to help you identify what services you will be using and correspondingly what configuration information you should request. It is not necessary to request everything in the table below. If, for example, you would only like to focus on the call service you only need to request the information corresponding to that service.
The Avaya Communications Package SDK can be used with either an on-premise Avaya Aura deployment as well as Avaya Collaboratory.
The same information is required to configure your Mac and begin using the sample app in both the on-premise and AvayaLive Collaboratory environments.
Whether you choose to use an on-premise Avaya Aura deployment or AvayaLive Collaboratory really only comes down to who you talk to as your administrator and where the Avaya servers are located.
The following worksheet can be used as a template to ensure that you retrieve all necessary information from your administrator for the services you plan to use.
Note: In the certificate column below there are references to a number of different servers. In a typical on-premise deployment it is common for most Avaya Aura services to share one or two Certificate Authorities (CA). Correspondingly your administrator may provide you only one or two CA certificates for all of the services below. Your administrator can use a commercial third party CA like Entrust or Verisign. In this case the CA certificates will already exist in the trust store of your Mac and no additional certificates will be necessary.
SDK API Interfaces | Information to request from your administrator | Other Information | |||||
---|---|---|---|---|---|---|---|
Service | Provider | Config Objects | Other Associated Services | Network Parameters | Certificate Requirements | Account Information | 46xx Settings Parameters |
CSCallService (CSCall) | SIP | CSSIPUserConfiguration |
CSSharedControlService, CSCallFeatureService |
SM IP/FQDN, port, Domain, TLS on/off | Certificate for TLS connections to SM for SIP and PPM (HTTPS) | Aura extension and PIN | SIPENABLED, SIP_CONTROLLER_LIST, SIPDOMAIN |
CSCallService (CSCall) | EC500 | CSEC500Configuration | EC500 access numbers for voicemail, idle appeance select, active appearance select, off PBX call enable/disable, CFWD all, CFQD cancel, SAC enable/disable | N/A | Aura Extension; If station security is enabled for EC500 by your administrator you must request your station security password. | EC500ENABLED, EC500VOICEMAILNUMBER, FNUIDLEAPPEARANCESELECT, FNUOFFPBXCALLENABLE, FNUOFFPBXCALLDISABLE, FNUCFWDALL, FNUCFWDCANCEL, FNUACTIVEAPPEARANCESELECT, FNUSACENABLE, FNUSACCANCEL | |
Conferencing Service (CSConference) | SIP | CSConferenceConfiguration | Conference Factory URI (for ad-hoc), moderator code, particpant code, virtual room id (scopia), particpant URL | Certificate for TLS connections to AAC, Scopia | N/A | N/A | |
CSContactService | LocalContact | CSLocalContactConfiguration | N/A | N/A | N/A | N/A | |
CSContactService | PPM | CSPPMConfiguration | N/A | N/A | N/A | N/A | |
CSContactService | AADS | CSACSConfiguration | AADS IP/FQDN, port, TLS on/off | Certificate for TLS connections to AADS | AADS username and password | ACSENABLED, ACSSRVR, ACSPORT, ACSSECURE | |
CSContactService | LDAP | CSLDAPConfiguration | LDAP IP/FQDN, port, TLS on/off, LDAP search base, Directory Type (AD, Domino, Novell) | Certificate for TLS connections to the LDAP server | LDAP username and password | DIRENABLED, DIRSRVR, DIRPORT, DIRTOPDN, DIRSECURE, DIRTYPE | |
CSPresenceService | SIP | CSPresenceConfiguration | N/A | N/A | N/A | N/A | |
CSMessagingService | AMM | CSAMMConfiguration | AMM IP/FQDN, port, TLS on/off | Certificate for TLS connections to the AMM server | AMM username and password | ESMENABED, ESMSRVR, ESMPORT, ESMSECURE | |
CSCollaborationService | WCS | CSWCSConfiguration | N/A | Certificate for TLS connections to WCS | N/A | N/A | |
CSCollaborationService | BFCP | CSBFCPConfiguration | Type of transport, port range | N/A | N/A | N/A |