Business Applications And Their Extensions; Business Application Extensions Web Service - Motorola CA50 Developer & User Manual

10 - 16 CA50/UCA Client & Server Developer & User Guide

Business Applications and their Extensions

During the execution of a Web based business application it may be necessary to interface with the UCA server to
query user information or status. This functionality is provided through the Business Application Extensions. This
Web service exposes methods that can be called from a Web application.

Business Application Extensions Web Service

In the default installation, the business application extensions are located at:
http://UCAInstallMachine/Motorola/UCA/Client/BAPExtensions.asmx.
Business Application Extensions Methods
UpdateUCAUserSession
This method is used to keep the user's UCA server session alive. The UCA server monitors user activity as it
applies to the UCA server. For example, the UCA server recognizes a UCA phone book lookup as user activity. A
phone book lookup updates the user's activity in the server and keeps the user's session alive. If the UCA server
does not see user activity for a period of time, it logs off the user.
A business application is a completely separate application that may not even reside on the UCA server. If a user
only accesses a business application, and never accesses the UCA server (after login), it is possible for the UCA
server to log off the user due to lack of activity. The UpdateUCAUserSession method, when called from a business
application, updates the user's session in the UCA database.
int UpdateUCAUserSession(string sStoreNumber, string sUser, ref UCAWebServiceStatus WSStatus)
Parameters
sStoreNumber
Store or location number.
sUser
User ID.
WSStatus
UCAWebServiceStatus class describes the status of the call.
Return Values
Returns 1 when successful.
Remarks
Any errors are logged to NT Event log.
GetDeviceUserFromIP
This method is used to lookup a CA50 device user User ID, using the device's IP address as the key.
int GetDeviceUserFromIP(string sStoreNumber, string sIpAddr, ref string sUser,
ref UCAWebServiceStatus WSStatus)