About the Application#

This application will be triggered by an incoming HTTP request. Once the application is triggered, it will subscribe to the Presence service and will update the App-Server of the status of a Presentity until it is not Unsubscribed from the Presence service.

Using this application one can subscribe to as well as unsubscribe from the Presence service.

Create the Application Project#

1. Open a Command Prompt window.

2. Navigate to the directory you want to use as your workspace. To use the CUAE command-line tool to create a new application, type the cuae create command and the name of the application project.

C:\> cd Wxp

C:\Wxp>cuae create PresenceMonitor}}}

The tool then prompts you for additional information.

Note: Once you are more familiar with the options, you can type the full command rather than answering the prompts by using the following syntax://

cuae create -l language -m namespace -t project type [options] projectname

cuae create -l java -m PresenceMonitor -t app PresenceMonitor

3. First the tool prompts you to choose between building an application or a plugin. In this example, the correct choice is application:

 Project type? [application or plugin] application

4. Next the tool prompts you to specify the programming language. In this example, the correct choice is java:

 Programming language? [java or csharp] java

5. The tool prompts you to choose the build format you prefer. In this example we are using ant.

 Build format? [ant or maven2] ant

6. The tool asks you for the namespace for the application. A Java program might want to use a fully qualified namespace like com.company.presencemonitor or something simple like presencemonitor. The tool offers you a simple namespace based on the project name. Let's accept the tool's suggestion for now and use presencemonitor:

 Project namespace? [default: presencemonitor] <return>

7. Finally, the tool asks if you would like to specify a triggering event. All applications need to register against at least one triggering event. You can specify the triggering event now or wait and specify the triggering event later. You can also change the triggering event during development. Again, since we know that this application needs to be triggered on an HTTP request, let's go ahead and specify the triggering event now. Select option 5:

 Available application triggering event:

0: Skip this step 1: cisco.uc.cuae.legacy.JTapi.JTapiIncomingCall 2: cisco.uc.cuae.legacy.JTapi.JTapiCallInitiated 3: cisco.uc.cuae.legacy.JTapi.JTapiCallEstablished 4: cisco.uc.cuae.legacy.CallControl.IncomingCall 5: cisco.uc.cuae.legacy.Http.GotRequest 6: cisco.uc.cuae.legacy.Presence.SubscriptionTerminated 7: cisco.uc.cuae.legacy.Presence.Notify 8: cisco.uc.cuae.legacy.TimerFacility.TimerFire Triggering event? [0-8] 5}}}

The tool now has enough information to generate the project template.

 Generating:

• application named "PresenceMonitor"
• with namespace "presencemonitor"
• with laguage "java"
• with trigger event "cisco.uc.cuae.legacy.Http.GotRequest"
• in location C:\Wxp\

Created project "PresenceMonitor" in directory "C:\Wxp\PresenceMonitor\"}}}

Here is the whole sequence again with all of the steps together:

C:\> cd Wxp

C:\Wxp>cuae create PresenceMonitor Project type? [application or plugin] application Programming language? [java or csharp] java Build format? [ant or maven2] ant Project namespace? [default: presencemonitor] <return> Available application triggering event: 0: Skip this step 1: cisco.uc.cuae.legacy.JTapi.JTapiIncomingCall 2: cisco.uc.cuae.legacy.JTapi.JTapiCallInitiated 3: cisco.uc.cuae.legacy.JTapi.JTapiCallEstablished 4: cisco.uc.cuae.legacy.CallControl.IncomingCall 5: cisco.uc.cuae.legacy.Http.GotRequest 6: cisco.uc.cuae.legacy.Presence.SubscriptionTerminated 7: cisco.uc.cuae.legacy.Presence.Notify 8: cisco.uc.cuae.legacy.TimerFacility.TimerFire Triggering event? [0-8] 5 Generating:

• application named "PresenceMonitor"
• with namespace "presencemonitor"
• with laguage "java"
• with trigger event "cisco.uc.cuae.legacy.Http.GotRequest"
• in location C:\Wxp\

Created project "PresenceMonitor" in directory "C:\Wxp\PresenceMonitor\"}}}

Inspecting the Generated Project#

Let's inspect the files that were generated by the CUAE command-line tool. It created a PresenceMonitor directory in the directory from which you ran the cuae create command. The PresenceMonitor directory contains the following files and directories:

• PresenceMonitor.etch
• PresenceMonitor.properties
• build.xml
• cuae-resources/
• README.txt
• src/

The most important of which, for your purposes, are:

• PresenceMonitor.etch -- CUAE application Etch service definition. Edit this file to use additional CUAE services in your project.
• build.xml -- Ant build script file with predefined targets for managing the lifecycle of your CUAE project.
• cuae-resources/ -- CUAE application resource directory.
• src/ -- Generated application source files.

Declaring Services#

The first step in building an Etch-based application is identifying which Cisco Unified Application Environment hosted services the application requires and then editing the .etch file to declare the names of those services into the application.

Note: Once you identify the services you need, you can familiarize yourself with them by visiting the API reference for the version of the Unified Application Environment you are using.

The following snippet is the default content of the .etch file that the CUAE command-line tool generates. We use the mixin command to declare the appropriate services.

// CUAE Application Etch Service Definition

This service defines your application and the CUAE services that you use in your application.

The service module namespace, this will be translated to the namespace of the generated source code. module presencemonitor

The name of your service.service PresenceMonitor{ By default, you must always use the EtchBridge service. Do not remove this mixin, otherwise your application won't work.mixin cisco.uc.cuae.EtchBridge

You may add any additional service mixins that you require. For example, if you'd like to make and receive phone calls, add the following line: mixin cisco.uc.cuae.legacy.CallControl mixin cisco.uc.cuae.legacy.Http } }}}

Because this application will handle an incoming HTTP request and subscribe a user to the Presence service, we need to utilize the HTTP and Presence services. The default etch file already has a mixin for HTTP because of the triggering event you selected when creating the application project.

mixin cisco.uc.cuae.legacy.Http

We need to add a declaration for the Presence service, using the full namespace. Add the following line right after the mixin for HTTP but before the final "}":

mixin cisco.uc.cuae.legacy.Presence

The new PresenceMonitor.etch file should look like this:

// CUAE Application Etch Service Definition

This service defines your application and the CUAE services that you use in your application.

The service module namespace, this will be translated to the namespace of the generated source code. module presencemonitor

The name of your service.service PresenceMonitor{ By default, you must always use the EtchBridge service. Do not remove this mixin, otherwise your application won't work.mixin cisco.uc.cuae.EtchBridge

You may add any additional service mixins that you require. For example, if you'd like to make and receive phone calls, add the following line: mixin cisco.uc.cuae.legacy.CallControl mixin cisco.uc.cuae.legacy.Http mixin cisco.uc.cuae.legacy.Presence } }}}

Building the Application#

After declaring the services you need, you must build the application to generate source files.

1. Open a Command Prompt and navigate to the application directory.

2. Run the ant command to generate source files.

C:\Wxp>cd PresenceMonitor

C:\Wxp\PresenceMonitor>ant}}}

The following source file templates are then created in the directory src\presencemonitor:

• MainPresenceMonitorClient.java
• ImplPresenceMonitorClient.java

Creating Configuration Items#

YAML is the file format for Unified Application Environment application configuration (config.yaml) and metadata definitions project_name.yaml).

All application configuration items are written in the config.yaml file, which is located in the cuae-resources directory.

Configuration items follow a specific syntax, as follows.

-name:

[display name:] format: [description:] [minvalue:] [maxvalue:] [defaultvalue:] [readonly:] [required] }}}

• Items in square brackets [] are optional

The default config.yaml file contains the following information:

# CUAE Application Configuration Definition

2. You only need to edit this file if you want to expose configuration to
3. the administrator through cuaeadmin.
5. This file was auto-generated from a template but will never be
6. overwritten. You should edit this file directly if required.

configuration:

1. Indicates the name of your configuration item. It will be how you
2. reference this configuration item from code.
3. - name: myConfValue

1. Controls how the visible label of the configuration value. For
2. example, if 'name' was defined as: myConfValue, you may choose to
3. define 'displayName' as: My Config Value. Think of it as a friendly
4. name. This field is optional.
5. displayName: My Config Value

1. Defines the format of the configuration item's value. This will
2. control how cuaeadmin renders and validates the value. Possible
3. values for the 'format' field are: String, Bool, Number, IP_Address,
4. Array, HashTable, Password.
5. format: String

1. A description of the configuration item that will be displayed to
2. the administrator in cuadmin. This field is optional.
3. description: Some description here.

1. For configuration items that are formatted as numbers, the
2. 'minValue' and 'maxValue' configuration items define the acceptable
3. range of input for the item. These fields are optional.
4. minValue:
5. maxValue:

1. Defines the default value of the configuration. This field is
2. optional.
3. defaultValue:

1. Inidicates whether the configuration item is editable. If
2. 'readOnly' is set to true, the administrator will not be able to
3. edit it in cuaeadmin, but will be able to view it. The default is
4. false, and this field is optional.
5. readOnly:

1. Indicates whether the configuration item is required. If required,
2. the administrator will have to set a value before the application
3. will run. The default is false, and this field is optional.
4. required: false }}}

In this example, the application has four configuration items, the user to be subscribed, password for the user to be subscribed, the Request URI for which the Presence status is to be fetched and the type of action. Add the following block to the config.yaml file in the configuration section:

configuration:

- name: Subscriber displayName: Subscriber format: String defaultValue:

- name: Password displayName: Password format: String defaultValue:

- name: StringUri displayName: StringUri format: String defaultValue:

- name: Action displayName: Action[NTS|U] format: String defaultValue: }}}

Writing Application Code#

This section provides instructions and code samples for writing the application logic.

Import the Project into your IDE#

1. Open Eclipse (or another IDE of your preference). 2. Create a new Java project from an existing Ant buildfile by selecting File -> New -> Other -> Java Project from an existing Ant buildfile and selecting the build.xml file from the AnswerAndPlay directory. 3. Click Next. 4. Browse to C:\workspace\PresenceMonitor\ and select the build.xml file. 5. Click Open. 6. Select "javac" task found in target "build[default]".

Reading Application Configurations#

The CUAE application receives the current application configurations from CUAE server using method server.getConfig("partition name") in gotRequest event handler in the ImplPresenceMonitorClient.java file. The developer can iterate through the configurations array and parse the configuration item based on its type.

Handle the onGotRequest triggering event#

You should write a method to handle the event of the onGotRequest trigger to subscribe a user to the presence server and send a response back to the device which has initiated the HTTP request.

Code Sample#

Note: Insert the below given code sample in the ImplPresenceMonitorClient.java file below the

//TODO

line.

// TODO insert methods here to provide implementations of PresenceMonitorClient

messages from the server. Global variables to collect the configuration variablesprivate String subscriber = "";private String password = "";private String requestUri = "";private String action = "";

@Override public void gotRequest(String sessionId, GotRequestOptions options) { Getting the configuration items set by the usertry {ConfigEntry[] aConfigs = server.getConfig("Default");if (aConfigs != null && aConfigs.length > 0){for (int i=0; i<aConfigs.length; i++){if (aConfigs[i].name.matches("Subscriber")) {subscriber = aConfigs[i].configValue.toString();System.out.println("Subscriber : " + subscriber);}if (aConfigs[i].name.matches("Password")) {password = aConfigs[i].configValue.toString();System.out.println("Password : " + password);}if (aConfigs[i].name.matches("StringUri")) {requestUri = aConfigs[i].configValue.toString();System.out.println("String URI : " + requestUri);}if (aConfigs[i].name.matches("Action")) {action = aConfigs[i].configValue.toString();System.out.println("Action : " + action);}}}}catch (cisco.uc.cuae.EtchBridge.BridgeException err){System.out.println("Failed to retrieve configs: " + err.toString());server.removeCuaeSession(sessionId);return;} String actionStatus = "";

if (action.equalsIgnoreCase("NTS")) { System.out.println("NTS received"); actionStatus = server.nonTriggeringSubscribe(sessionId, requestUri, subscriber, password, null).resultCode.toString(); System.out.println("The NonTriggeringSubscribe executed successfully"); String response = "Action status: " + actionStatus + "received for action:" + action; server.sendResponse(sessionId, options.remoteHost, 200, "text/plain", response, "OK", null); }

else if (action.equalsIgnoreCase("U")) { System.out.println("U recieved"); actionStatus = server.unsubscribe(sessionId, requestUri, subscriber, password, true, null).resultCode.toString();

System.out.println("Unsubscribe executed successfully"); String response = "Action status: " + actionStatus + "received for action:" + action; server.sendResponse(sessionId, options.remoteHost, 200, "text/plain", response, "OK", null); server.removeCuaeSession(sessionId); } } }}}

Handle the onNotify triggering event#

Once the user is subscribed to the Presence server, the Presence server will start sending notification messages to the App-server. You need to write a method to handle the onNotify event.

Code Sample#

@Override

public void notify(String sessionId, NotifyOptions options) { String status = options.status;

String status1 = status.substring(status.indexOf("<presence"));

try { String current = status1.substring(status1.indexOf("id=") + 4);

String name = current.substring(0, current.indexOf("\""));

current = (current.substring(current.indexOf("<activities") + 1)); current = current.substring(current.indexOf("<") + 1);

extract activityString activity = current.substring(0, current.indexOf(" ")); check if away or busy as they end with "/>" instead of a " "if (activity.contains("/>"))activity = activity.substring(0, activity.indexOf("/")); System.out.println("The user: " + name + "is: " + activity);

} catch (Exception e) { System.out.println("The status of the contact for user could not be retrieved. Error message:" + e.toString()); } } }}}

Handle the onSubscriptionTerminated event#

Subscription for a particular user is terminated by the Presence server on the basis of the values configured in the Presence server and the Presence provider in the App-server for subscription termination. Once the subscription is terminated an event is triggered at the App-server. You need to handle this event.

Code Sample#

@Override

public void subscriptionTerminated(String sessionId, SubscriptionTerminatedOptions options) { server.logWrite(LogLevel.INFO, "Subscription terminated: " + options.requestUri + " - " + options.subscriber); server.removeCuaeSession(sessionId); } }}}

Handle the onSessionExpired event#

An HTTP session is terminated after a stipulated time. Once the HTTP session is expired you need to handle this event.

Code Sample#

@Override
public void sessionExpired(String sessionId, SessionExpiredOptions options)
{
	server.removeCuaeSession(sessionId);
}

Registering the Application#

The previous steps completed the core logic of the example applications, but before any Etch-based API actions can actually be used, we must register the application with the Cisco Unified Application Server. To register your application, follow these steps:

1. Open the MainPresenceMonitorClient file in the /src directory. It contains the following content by default:

// Generated by:

0.96.0 (ETCH-TRUNK-906) / java 0.96.0 (ETCH-TRUNK-906) Mon Aug 11 15:01:46 IST 2008

package presencemonitor;

/ Main program for PresenceMonitorClient. This program makes a connection to the listener created by MainPresenceMonitorListener./public class MainPresenceMonitorClient implements PresenceMonitorHelper.PresenceMonitorClientFactory{/

• Main program for PresenceMonitorClient.
• @param args command line arguments.
• @throws Exception
• /

public static void main( String[] args ) throws Exception { TODO Change to correct URIString uri = "tcp://localhost:4001"; RemotePresenceMonitorServer server = PresenceMonitorHelper.newServer( uri, null, new MainPresenceMonitorClient() );

Connect to the serviceserver._startAndWaitUp( 4000 );

TODO Insert Your Code Here

Disconnect from the serviceserver._stopAndWaitDown( 4000 );}

public PresenceMonitorClient newPresenceMonitorClient( RemotePresenceMonitorServer server ) throws Exception { return new ImplPresenceMonitorClient( server ); } } }}}

2. To make a connection to the listener, add a server.registerApplication() request.

// TODO Insert Your Code Here

String key = server.registerApplication("PresenceMonitor", "Default", "<user-id>", "<metreos>"); System.out.println("PresenceMonitor registered: " + key); System.in.read();}}}

3. Modify the String URI to match the IP address and port of the Cisco Unified Application Server.

URI settings vary slightly between 2.5(1) Beta 1 and more recent versions of 2.5(1), as follows:

2.5(1) and 2.5(1) Beta 2, Beta 3, Beta 4 & later releases#

// TODO Change to correct URI

String uri = "tls://appserver_ipaddress:9000?TlsConnection.authReqd=false&filter=KeepAlive &KeepAlive.Count=5&Packetizer.maxPktSize=102400&TcpTransport.reconnectDelay=4000";}}}

Note: In Beta 2, the Etch Bridge was updated to use Transport Layer Security for encryption by default. For your applications to work, you must specify TLS as the protocol in the URI and set the authReqd parameter to false. In the example above, the KeepAlive filter and Max Packet Size and Reconnect Delay parameters have also been set.

2.5(1) Beta 1#

// TODO Change to correct URI

String uri = "tcp://appserver_ipaddress:9000?&TcpConnection.reconnect_delay=4000";}}}

Note: In addition to setting the correct IP address and port for the Cisco Unfied Application Server, the Reconnect Delay parameter should be set on all connection URIs.

Packaging The Test Application#

1. Execute a successful build request for your test application within your IDE.

2. To package the application, execute the "cuae package" command from a DOS command shell in the parent directory of the test application.

C:\Wxp\PresenceMonitor>cuae package

Created package file "C:\Wxp\PresenceMonitor\bin\PresenceMonitor.mca" }}}

The following files will be added to the "\bin" sub-directory:

• PresenceMonitor.mca (application bundle to be uploaded into the application server)
• INSTALLER.xml - (contains the config items in config.yaml)
• MANIFEST.xml - (bundle details for the package comamnd)

Installing The Test Application#

To install the test application on a CUAE server, execute the cuae install command from a DOS command shell in the parent directory of the test application. You will be prompted to enter an IP address, username, and password (to view the help, run the "cuae install -h" command). When prompted, enter Y or N to save management settings. This will save the answers to the above three questions in the properties file and remember them the next time you go to install.

2.5(1) Beta 2#

C:\Wxp\PresenceMonitor>cuae install

Enter the hostname or IP address of the management service (for example: localhost, 1.1.1.1): <App-server's IP Address> Protocol? [tcp or tls] tls Generated mgmt-service uri: tls://10.77.34.205:9001?TlsConnection.authReqd=false Enter management service login username: Enter management service login password: Save the management settings with the project? [yes or no] no Application : C:\Wxp\PresenceMonitor\bin\PresenceMonitor.mca Uploading : ================================> 100% Application has been installed successfully }}}

2.5(1) Beta 1#

C:\Wxp\PresenceMonitor>cuae install
Enter management service uri or host/IP <for example: localhost, tcp://1.1.1.1.:4001>:
Enter management service login username:
Entermanagement service login password: ********
Save the amanagement settings with the project? [YyNn] n
Application : C:\Wxp\PresenceMonitor\bin\PresenceMonitor.mca
Uploading :  ===========================> 100%
Application has been installed successfully

Configuring the Application in the Administration Interface#

Adding a trigger#

1. Log in to the Administration interface.

2. Click Applications>Find/List Triggers to generate a list of applications and their associated triggers.

3. Select the application PresenceMonitor in the list.

4. Enter "to" and the number that will be used to trigger the application.

5. Click Add Parameter.

Running the application#

• Before running the application, set up a CUPS server and client to communicate with the Cisco Unified Application Environment as described in Presence Configuration for Examples
• Login to the CUPC installed on the client machine as the user who is on the contact list of the username provided as a runtime parameter for the PresenceMonitor application. e.g. if User1 is provided as a runtime parameter in the below given step and User2 is on his contact list, then login to the CUPC as User2.
• Now set the following runtime parameters for the PresenceMonitor application
• Subscriber: <user associated with CUPS>@cisco.com
• Password: password of the user
• RequestUri: <user associated with CUPS>-contacts@cisco.com
• Action: NTS/U
• Apply the change

Where:

NTS = Non triggering subscribe

U = Unsubscribe

• Set a trigger parameter for the application at Applications->Triggers as shown in step 5 of Configuring the application. Since this application is designed to be triggered by an incoming HTTP request, so you need to add a parameter named url with a value /PresenceMonitor.
• Run the class PresenceMonitor.MainPresenceMonitorClient to register the application.
• Once the application is registered with the CUAE server, open a web-page and in the address bar type the following URL

  http://<App-server_IP_address>:8000/PresenceMonitor 

• This will trigger the application and it will start executing.The status of User2 will be printed on the console window.
• Login into CUPC client with a Username Where application's 'Subscriber' is added in the contact list
• If the status of the User2 is changed from Available to Busy in CUPC then it will be displayed on the console window.