Page of 542
Download Table of ContentsContents
TroubleshootingTroublesh..
Print This PagePrint
ShareShare
Bookmark
   
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
CA50 / UCA Client & Server
Developer & User Guide

   Related Manuals for Motorola CA50

   Summary of Contents for Motorola CA50

  • Page 1

    CA50 / UCA Client & Server Developer & User Guide...

  • Page 3

    CA50/UCA Client & Server Developer & User Guide 72E-93914-02 Revision A November 2009...

  • Page 4

    Motorola. No right to copy a licensed program in whole or in part is granted, except as permitted under copyright law. The user shall not modify, merge, or incorporate any form or portion of a licensed program with other program material, create a derivative work from a licensed program, or use a licensed program in a network without written permission from Motorola.

  • Page 5

    Accessories CA50 accessories, such as cables and power supplies, carry a warranty term of ninety (90) days from the date of shipment. CA50 Server Software The CA50 Server Software ships with Motorola’s standard 90-day software warranty.

  • Page 6: Revision History

    CA50 Client/UCA Server Developer Guide Revision History Changes to the original manual are listed below: Change Date Description 72E-93914-01 Rev. A 3/2008 Initial release 72E-93914-02 Rev. A 11/2009 Updates: UCA Server and test applications PBX support Profile Wizard Localization Scanning support Appendix H, UCA Server Backup and Restore.

  • Page 7: Table Of Contents

    Bar Code Scanning Functionality ................1-2 Messaging/Paging Functionality ................1-3 Walkie-Talkie (Multicast) Functionality ..............1-3 Voice Call (Unicast) Functionality ................1-3 Components in the CA50 Solution ................1-4 Quick Startup Guide Overview ..................1-4 Quick Startup Guide ..................... 1-5 Chapter 2: Development and Deployment Checklist Overview ........................

  • Page 8: Table Of Contents

    CA50/UCA Client & Server Developer & User Guide Step 2. Business Application for CA50 - Generate ............2-2 Step 3. CA50 Device Settings - Optimize Settings ............2-2 Step 4. UCA Server Files and Databases - Populate with Site/User Specific Information ......................2-3 Step 5.

  • Page 9: Table Of Contents

    Launching the Sample Business Application While in a Voice (Unicast) Call ..4-56 Accessing Communication Options from a Business Application ......4-57 Chapter 5: UCA Client Application on the CA50 UCA Client Application Overview ................. 5-1 Chapter 6: UCA Server Overview ........................

  • Page 10: Table Of Contents

    Validate Successful Server Installation and Proper Performance ........ 6-45 Validate Proper Launch and Login to the UCA Server Web Console ..... 6-45 Validate a CA50 Can Log In to the UCA Server ............. 6-46 Configuring Firewalls ....................6-47 System Settings ......................6-48 UCA Server Security .....................

  • Page 11: Table Of Contents

    Table of Contents Phone Settings ......................8-6 Walkie-Talkie Settings .................... 8-7 Download Files Settings ..................8-10 Desktop Settings ..................... 8-11 Volume Settings ...................... 8-12 Metrics & Logging ....................8-13 Device Settings ....................... 8-14 Client Settings ......................8-15 Alert Settings ......................8-16 Create Menus .......................

  • Page 12: Table Of Contents

    Request Format ...................... 10-4 Response Format ....................10-4 HTML Elements ...................... 10-5 Best Practices and Considerations for CA50 Development ......... 10-12 Data Collection ......................10-12 Access to Communication Options and the Web Application ......... 10-12 Business Applications and their Extensions ..............10-16 Business Application Extensions Web Service ............

  • Page 13: Table Of Contents

    Staging and Deploying CA50s ..................12-2 Rapid Deployment Bar Codes ................12-2 UCA.settings.xml File for Configuring the UCA Client Application ......12-2 Staging Process for a CA50 ..................12-4 Auto-launching the UCA Client Application ............. 12-6 Staging and Localization ....................12-6 OS/UCA Client Application Upgrades Pushed from MSP Provision ......

  • Page 14: Table Of Contents

    Setup ........................B-3 Battery Charging Indications ................... B-4 Charging Temperature .................... B-4 RF Connectivity ....................... B-4 Single-Slot CA50 Charging Cradle with Spare Battery Charger ........B-5 Setup ........................B-5 Charging the Battery ....................B-6 Charging the Spare Battery ................... B-6 Battery Charging Indications ...................

  • Page 15: Table Of Contents

    Step 7. Generate Employee Login Bar Codes .............. D-15 Step 8. RF Network ...................... D-16 Step 9. Use MSP 3.1 to Prepare CA50 Devices for Use ..........D-16 Create RD Bar Codes for the CA50 ................ D-17 Step 10. Deploy CA50s ....................D-18 Deploy CA50s at the Site Location .................

  • Page 16: Table Of Contents

    CA50/UCA Client & Server Developer & User Guide Step 8: Ready to Demonstrate the CA50 Voice and Scanning Functionality ....E-17 Price Lookup SKUs for the Demo Solution ............. E-17 Step 9. Modifying the Demo Solution: Creating New Users ......... E-18 Appendix F: Rapid Deployment Overview ........................

  • Page 17

    Table of Contents LED Settings (HTML Business Application) ............I-13 Appendix J: Commands and Command Usage Introduction ........................J-1 Commands Usage in Profiles ..................J-2 Commands Usage in Business Applications (HTML Pages) ........J-4 Commands Usage in Notification Messages ..............J-14 Index Tell Us What You Think...

  • Page 18

    CA50/UCA Client & Server Developer & User Guide...

  • Page 19: About This Guide

    NOTE NOTE 1. For a complete checklist outlining all the development and deployment activities required to implement a CA50 solution, see the Development and Deployment Checklist on page 2-1. 2. For a table listing the most commonly requested topics within this manual, see the...

  • Page 20: Chapter Descriptions

    Model Features CA5090-0U0LF5KV11R 1-pack 802.11b/g/a radio Note: Upon initial release, the CA50 hardware is WMM compatible but not software enabled/supported. A future software release will enable WMM support. CA5090-0U0LF5KV18R 8-pack 802.11b/g/a radio Note: Upon initial release, the CA50 hardware is WMM compatible but not software enabled/supported.

  • Page 21: Technical Specifications

    Chapter 10, CA50 Business Application Development Provides guidance for developing Web applications that reside on a Web server and are accessed by the CA50 UCA client application. Chapter 11, UCA Server Optional APIs Outlines how to use the optional APIs that are installed with the UCA server.

  • Page 22

    Notational Conventions The following conventions are used in this document: • The terms client, device and terminal refer to the CA50 hand-held device. • Italics are used to highlight the following: • chapters and sections in this and related documents •...

  • Page 23

    Software type and version number Motorola responds to calls by e-mail, telephone or fax within the time limits set forth in service agreements. If your problem cannot be solved by Motorola Enterprise Mobility Support, you may need to return your equipment for servicing and will be given specific directions.

  • Page 24

    CA50/UCA Client & Server Developer & User Guide (Page intentionally blank.)

  • Page 25: Overview

    - mobile workers are never more than a phone call away. The built-in bar code scanner and display, allow the CA50 to be used for a virtually unlimited number of business applications such as price lookup.

  • Page 26: Ca50 Features

    NOTE CA5090-0U0LF5KV11R 1-pack 802.11b/g/a and CA5090-0U0LF5KV18R 8-pack 802.11b/g/a radios Bar Code Scanning Functionality Third party business applications can utilize the CA50 1-Dimensional bar code scanner to scan bar codes such as UPC. An example of a third party business application is price lookup.

  • Page 27: Messaging/paging Functionality

    For example, an associate carrying a CA50 can select another associate to call from a phone book and carry on a full duplex, two way conversation with the second associate.

  • Page 28: Components In The Ca50 Solution

    1 - 4 CA50/UCA Client & Server Developer & User Guide Components in the CA50 Solution The following components are required to implement the CA50 solution: • Mobile device: CA5090 • UCA client application (for more details see page 5-1) •...

  • Page 29: Quick Startup Guide

    Reboot Device/Access the CA Menu............................3-12, 4-17, 4-18 Device Staging and Deployment using MSP ....................3-12, 4-19, 12-1, 12-2, D-16, XML Profile Configures CA50 when Downloaded from Server ......................7-1, Battery Management Recommendations ......................3-6, 3-9, 4-4, A-1, B-8, B-12 Determining Version Information (OS, Client, etc.)..........................

  • Page 30

    1 - 6 CA50/UCA Client & Server Developer & User Guide (Page intentionally blank.)

  • Page 31

    The Development and Deployment Checklist identifies all the significant steps required to generate and deploy a CA50 solution in a production environment. To enable easy demonstration of the CA50, a self-contained pre-build Demo Solution is included on the UCA server Installshield. For details seepage E-1.

  • Page 32: Overview Of The Ca50 Solution

    ......• Components in the CA50 Solution ... . . •...

  • Page 33: Step 4. Uca Server Files And Databases - Populate With Site/user Specific Information

    Generate Rapid Deployment Bar Codes ..12-1 • Charge CA50 Device ..... . . 3-4, • Deploy CA50s at Store Location •...

  • Page 34

    2 - 4 CA50/UCA Client & Server Developer & User Guide (Page intentionally blank.)

  • Page 35

    2. For a table listing the most commonly requested topics within this manual, see the Quick Startup Guide on the last page of the manual. Unpacking the CA50 Carefully remove all protective material from the CA50 and save the shipping container for later storage and shipping. Verify that you received the following equipment: •...

  • Page 36: Ca50 - Front/back Views

    3 - 2 CA50/UCA Client & Server Developer & User Guide CA50 - Front/Back Views Back View Front View Receiver Regulatory Writing Label Area Main 10:56 Rapid Deploy Admin Scroll Bar Programs Display Channel 2 Settings Floor Speaker System info...

  • Page 37: Ca50 - Side Views

    Getting Started 3 - 3 CA50 - Side Views Left Side Right Side Application Key (Walkie-Talkie “Talk” Volume Key default) Down Audio Jack Mute/Quiet Mode Key CA50 - Side Views Figure 3-2...

  • Page 38: Preparing The Ca50 For Use

    UCA server through an On Demand server function of MSP. To completely update a CA50 device, up to three sets of Rapid Deployment bar codes may need scanning. When Rapid Development is complete, cold boot the CA50 to boot up into the UCA client application at which time the device communicates to the server and receives the login screen.

  • Page 39

    Getting Started 3 - 5 Removing the Battery Hold the device on its side and lift the release latch to disengage the battery from the device. Release Latch Lift Release Latch Figure 3-4 Insert a finger nail into the indent on the bottom of the battery and push downward. The battery should eject. Battery Indent Push Battery Indent...

  • Page 40: Battery Information

    Replace the battery when a significant loss of run time is detected. Standard warranty period for all Motorola batteries is 30 days, regardless if the battery was purchased separately or included as part of the mobile computer.

  • Page 41: Charging Temperature

    In the event of a battery leak, do not allow the liquid to come in contact with the skin or eyes. If contact has been made, wash the affected area with large amounts of water and seek medical advice. • If you suspect damage to your equipment or battery, contact Motorola Enterprise Mobility support to arrange for inspection. Charging Temperature IMPORTANT: Charge batteries in temperatures from 0°C to 35°C (32°F to 95°F).

  • Page 42: Charging Batteries

    CA50/UCA Client & Server Developer & User Guide Charging Batteries Before using the CA50 for the first time, charge the battery using a cradle until the green charge status LED lights. Table 4-3 on page 4-10 for charge status indications. For information about the accessories available for the...

  • Page 43: Battery Management Recommendations

    Suspend the CA50 by putting it into sleep mode. Note:When in sleep mode, CA50 power consumption is significantly reduced but not eliminated. In this mode the CA50 can remain out of a charger for approximately 48 hours before requiring a recharge.

  • Page 44

    1, 6 and 11 to minimize inter-channel interference (which decreases run time). NOTE Standard mobile suspend (sleep mode), resume and auto suspend modes used in Motorola mobile devices do not apply to the CA50 voice device because the radio must stay active to transmit walkie-talkie conversations and receive incoming voice calls.

  • Page 45: Powering On The Ca50 - Pre-deployment

    NOTE If the device does not power on, the battery charge may be depleted. See Charging Batteries on page 3-8. Upon initial use, first time out-of-box, the Motorola splash screen displays briefly and then the device boots up to the CA Menu. For additional information about the CA Menu see CA Menu on page 3-12.

  • Page 46

    • Rebooting the device and manually pushing override keys that allow access to the CA Menu. NOTE The CA Menu displays out-of-box and when reconfiguring the device, essentially whenever the CA50 is not running its UCA client application. From the CA Menu use the Up and Down arrow keys to highlight a menu option. Press the Scan/Select (S) key to launch an option.

  • Page 47: Sleep Mode

    Getting Started 3 - 13 Sleep Mode NOTE When in sleep mode, CA50 power consumption is significantly reduced but not eliminated. The CA50 can remain out of a charger for approximately 48 hours before requiring a recharge. Placing the CA50 into sleep mode prevents the occurrence of communications (e.g., OS upgrades, phone book updates, etc.).

  • Page 48

    3 - 14 CA50/UCA Client & Server Developer & User Guide (Page intentionally blank.)

  • Page 49

    Chapter 4 CA50 Modes of Operation Overview This chapter covers various information about using the CA50, post-deployment. Valuable topics in this chapter include: • Logging in and logging out (beginning on CA50 Login - Post-deployment on page 4-2) • Employee identity validation...

  • Page 50: Ca50 Login - Post-deployment

    There are two login options for a store location. Only one method can be used at a single location. • Scan bar codes login:CA50 users scan a bar code to log into the device. User accounts are created on the server application. The login bar code sheet must be generated by a third party application.

  • Page 51

    CA50 Modes of Operation 4 - 3 The device connects to the UCA server. On this screen, press the right soft key to Cancel the connection and to put the device into sleep mode. UCA client application version Server Connection Screen Figure 4-3 Upon successful login, the UCA client application can display a login prompt.

  • Page 52: Logoff Options

    Cradle logoff: Put the device into the charge cradle to logoff. Logoff is triggered by detecting an AC power connection. Upon initial use, initial boot or after a reboot, the Motorola splash screen displays for approximately 10 seconds and the device boots up to a text-based interface to CA Menu that displays the Start menu.

  • Page 53: Display Status Icons

    Option Bar Menu Phn Bk CA50 Display Screen Figure 4-7 CA50 Display Icons CA50/UCA Client & Server Developer & User Guide Table 4-1 Icon Description Wireless Signal Strength Excellent wireless network signal (100%-75% signal). Fair wireless network signal (50%-25% signal).

  • Page 54

    4 - 6 CA50/UCA Client & Server Developer & User Guide CA50 Display Icons CA50/UCA Client & Server Developer & User Guide (Continued) Table 4-1 Icon Description Battery Strength Battery Strengths (from left): • Battery is fully charged (100% - 75% charge remains) •...

  • Page 55: Ca50 Keys, Actions And Features

    CA50 Modes of Operation 4 - 7 CA50 Keys, Actions and Features CA50 Key Functionality, Device Actions and Features Table 4-2 Key/Action/Feature Description KEYS Soft Keys Left and right soft key functions are identified by the screen display. Scan/Select (S) key A Select key when a menu is activated;...

  • Page 56

    Note: Menu items are configurable via the server application. The sleep mode feature may not apply to all environments. Note: When in sleep mode, CA50 power consumption is significantly reduced and can remain out of a charger for approximately 48 hours before requiring a recharge.

  • Page 57

    CA50 Modes of Operation 4 - 9 CA50 Key Functionality, Device Actions and Features (Continued) Table 4-2 Key/Action/Feature Description Mute speaker Press the Mute key. Note: The speaker can only be muted when the user is not on a voice call.

  • Page 58: Ca50 Indications

    No AC power LED Indications Notification Indications The device LED indications on the notification message are configurable through profile as well as from the messaging API. SendNotification on page 11-26. Note: All LED indications are on the CA50 device unless otherwise noted.

  • Page 59: Audio Indications

    CA50 Modes of Operation 4 - 11 Audio Indications CA50 Audio Indications Table 4-4 Event Audio Status Walkie-Talkie Indications Start Walkie-Talkie Start walkie-talkie communication transmit tone communication transmit Start Walkie-Talkie Start walkie-talkie communication transmit tone communication receive Voice (Unicast) Call Indications...

  • Page 60: Screen Indications

    4 - 12 CA50/UCA Client & Server Developer & User Guide Screen Indications CA50 Display Screen Indications Table 4-5 Event Display Status Walkie-Talkie Indications Start walkie-talkie No display communication transmit Start walkie-talkie No display communication receive Voice (Unicast) Call Indications...

  • Page 61: Using An Earbud

    You can use a mono earbud for audio communication when using an audio-enabled application. To use an earbud, plug the earbud (2.5mm jack) into the mono audio connector on the side of the CA50. Plugging an earbud into the jack mutes the speaker.

  • Page 62: Wireless Security Protocols For The Ca50

    4 - 14 CA50/UCA Client & Server Developer & User Guide Wireless Security Protocols for the CA50 CA50 wireless security is based on underlying Fusion support. At each CA50 release, a subset of voice-friendly security modes are validated for use with CA50 voice.

  • Page 63: Data Capture

    Hold the CA50 farther away for larger symbols. • Move the CA50 closer for symbols with bars that are close together. NOTE Scanning procedures depend on the application and CA50 configuration. An application may use different scanning procedures from the one listed above.

  • Page 64: Scanning

    4 - 16 CA50/UCA Client & Server Developer & User Guide Scanning Ensure that a scan enabled application is loaded on the CA50. Aim the scan window at the bar code. 4“ 4“ Laser Scanning Figure 4-10 Press the Scan key. Ensure the red scan beam covers the entire bar code. A single green LED blink, by default, to indicate the bar code was decoded successfully.

  • Page 65: Resetting The Ca50

    CA50 Modes of Operation 4 - 17 Resetting the CA50 There are two reset functions, warm boot and cold boot. Perform a warm boot first. If the device still does not respond, perform a cold boot. Neither a warm nor cold boot clears deployment settings such as network login and UCA server IP address.

  • Page 66: Waking The Ca50

    When the device is in sleep mode (suspended), wake the device by pressing any key. Accessing the CA Menu To access the CA Menu when an application and/or network settings are already loaded on a CA50, for example after the CA50 is deployed in a store environment:...

  • Page 67: Out-of-box Ca Menu Options

    Appendix F, Rapid Deployment. Programs Note: There are several out-of-box programs on the CA50 when the device is powered on. The programs listed below are highlights. UCA Client Application Invokes the UCA client application which attempts to connect to the UCA server.

  • Page 68

    4 - 20 CA50/UCA Client & Server Developer & User Guide CA Menu Options (Continued) Table 4-6 Menu Description Audio Test App Audio Test allows the user to play and record sounds and select the output type (speaker or handset). This application can also be used to test the audio play logic for the speaker and the receiver and can also test the audio record using the microphone.

  • Page 69

    Scan/Select to display the AudSamp Record screen (below). Scroll down to Record... and press Scan/Select. Recording begins. Play a sound into the CA50 receiver. The recording sound saves to the test.wav file. At any time, press the right soft key to stop recording.

  • Page 70

    • IMPORTANT Note: The CA50 must be used for RF site surveys that require optimization of CA50 voice communications. For these sites the CA50 is the only acceptable survey tool. Other mobile devices (such as an MC50) do not produce an equivalent signal strength indication as displayed on the CA50.

  • Page 71

    CA50 Modes of Operation 4 - 23 CA Menu Options (Continued) Table 4-6 Menu Description UCA Sys Info To access UCA Sys Info screens: (continued) On the CA Menu, scroll to select Programs > UCA Sys Info. The application executes and displays the Mem screen.

  • Page 72

    4 - 24 CA50/UCA Client & Server Developer & User Guide CA Menu Options (Continued) Table 4-6 Menu Description UCA KeyCheck This application can be used to test the keys on the device. To ensure all CA50 keys are functioning properly: On the CA Menu, scroll to select Programs >...

  • Page 73

    This application can be used to test the green and red LEDs and the vibrator motor on the device. To test the LEDs and vibrator motor on the CA50 device: On the CA Menu, scroll to select Programs > UCA NLedTest.

  • Page 74

    4 - 26 CA50/UCA Client & Server Developer & User Guide CA Menu Options (Continued) Table 4-6 Menu Description UCA NLedTest On the main NLed screen scroll to VIBRATOR and press Scan/Select to display the VIBRATOR screen. (continued) Scroll to ON and press Scan/Select. The vibrator motor turns on.

  • Page 75

    This application can be used to verify that the device can reach another device and record the response time. To ping another device from your CA50 device: On the CA Menu, scroll to select Programs > UCAPing. The application executes •...

  • Page 76

    4 - 28 CA50/UCA Client & Server Developer & User Guide CA Menu Options (Continued) Table 4-6 Menu Description Scanner Press Scan/Select to modify the setting below; press Up/Down keys to scroll options list. • Scnr Name: Displays the name given to the device.

  • Page 77

    • Delete - Delete profile from registry. Note: If profile was scanned in or exported, a reg key is created on the CA50. If this reg key is not deleted, the profile remains on the device and appears in the list after a cold boot.

  • Page 78

    Sleep Mode on page 3-13). Note: When in sleep mode, CA50 power consumption is significantly reduced and can remain out of a charger for approximately 48 hours before requiring a recharge. Placing the CA50 into sleep mode prevents the occurrence of communications (e.g., OS upgrades, phone book updates, etc.).

  • Page 79: Walkie-talkie (multicast) Communication

    CA50 at which time the device sounds a tone to prompt the user that voice communication can begin. The user is also prompted with an alert tone indicating an incoming communication. Speaker and...

  • Page 80: Walkie-talkie Functions

    4 - 32 CA50/UCA Client & Server Developer & User Guide Walkie-Talkie Functions Channel Settings There are three walkie-talkie channel settings: • Listen/Talk Channel • Users can listen and talk on Listen/Talk channels. • A channel can be set to Listen/Talk by setting the type to 'T'; in the user profile under the WTT >...

  • Page 81: Naming Walkie-talkie Channels

    CA50 Modes of Operation 4 - 33 Device Modes There are four walkie-talkie communication modes (for additional information, see page 7-5). These different modes tell the device how to handle the channels to which it has access. The modes are: •...

  • Page 82: Operating Walkie-talkie

    Changing the Transmit Channel Using the CA50 Menu The CA50 desktop displays the default transmit channel. To change the channel, users can access the walkie-talkie channel menu directly from a business application, or the desktop. Default Transmit...

  • Page 83

    CA50 Modes of Operation 4 - 35 Press the Up or Down keys to scroll and Select walkie-talkie communication channels. The WT Channels menu displays. My WT settings Channel 1 Channel 2 Back WT Channel Menu Figure 4-15 The Channels menu lists an option to access walkie-talkie settings (My WT settings), all available transmit channels and possibly additional server configurable options, such as Scan mode.

  • Page 84: Voice (unicast) Calls

    Voice (Unicast) Calls Voice (unicast) calls are initiated and controlled from the UCA client application running on the CA50 device. The VoIP capabilities provide a means for initiating the call via an IP address or extension, depending on the protocol chosen, and if the system set up requires PBX support.

  • Page 85: Standard (non-pbx) Calls

    CA50-to-CA50 IP based calls. The UCA server is required to place a call from a CA50. In order to place a call, the CA50 must use a dynamically accessed phone book located on the UCA server. The UCA server dynamically managed phone book downloaded at the initiation of each voice call displays only logged-on users.

  • Page 86

    PBX based call can be routed to a CA50. • The UCA server is required to place a call from a CA50. In order to place a call, the CA50 must access and use a dynamically accessed phone book located on the UCA server.

  • Page 87

    • No free extension is available to be assigned. Typically when the contact list returns to the CA50, the extension number displays along with the user name. For users with no phone extensions, only the user name displays. Importing and Creating Extensions...

  • Page 88: Voice (unicast) Call Functionality - Pbx Calls Vs Direct Ca50-to-ca50 Ip Based Calls

    4 - 40 CA50/UCA Client & Server Developer & User Guide Voice (Unicast) Call Functionality - PBX Calls vs. Direct CA50-to-CA50 IP Based Calls PBX Calls versus Standard Non-PBSX Calls Table 4-7 Function H.323 H.3232:P2P SIP:PBX SIP:P2P Cisco Call Manager Place •...

  • Page 89

    CA50 Modes of Operation 4 - 41 PBX Calls versus Standard Non-PBSX Calls (Continued) Table 4-7 Function H.323 H.3232:P2P SIP:PBX SIP:P2P Cisco Call Manager Calling a • • • • • Caller gets a call Caller hears a Caller gets a call...

  • Page 90: Browsing The Phone Book

    The phone book is divided into static and dynamic sections. Each dynamic section downloads to the device from the server each time the CA50 is used. Dynamic sections are small and do not take a significant amount of time to download (no more than a typical screen download).

  • Page 91

    Departments Floor Back Menu Phn bk CA50 Desktop (A) / Phone Book Menu (B) Figure 4-17 By Extensions To view extensions in the phone book, press the Up or Down keys to scroll the Phone Book menu (Figure 4-17 B), highlight Extensions and press Select to pick an extension.

  • Page 92

    4 - 44 CA50/UCA Client & Server Developer & User Guide Press the Up or Down keys to scroll and Select a range of letters. The Last Names menu displays the names of logged in users, alphabetically, in the range selected.

  • Page 93: Making A Voice (unicast) Call

    The CA50 displays the name of the person called throughout the active call. When the call connects, the caller hears a ringing sound through the receiver. While the call is in progress, the CA50 displays the caller ID and a call timer.

  • Page 94: Transferring A Call

    4 - 46 CA50/UCA Client & Server Developer & User Guide Transferring a Call When a user is on a voice (unicast) call and needs to transfer the call to another extension, use the phone book to look up extensions and transfer the call as shown below.

  • Page 95: Parking A Call

    Parking a Call When the CA50 receives a voice (unicast) call, the call can be parked for retrieval by another CA50 device. There are two Call Park options: •...

  • Page 96

    4 - 48 CA50/UCA Client & Server Developer & User Guide The system selects an available extension on which to park the call and the Park window displays the extension. Press the right soft key (Ok) to accept the extension and park the call.

  • Page 97

    CA50 Modes of Operation 4 - 49 The system selects an available extension on which to park the call and the Park window displays the extension. Press the right soft key (Ok) to accept the extension and park the call.

  • Page 98: Retrieving A Parked Call

    4 - 50 CA50/UCA Client & Server Developer & User Guide Retrieving a Parked Call Retrieving a Parked Call from any Extension To retrieve a parked voice (unicast) call from the desktop: Desktop Display Figure 4-41 On the Desktop (Figure 4-41) press the left soft key (Menu) to display the Desktop menu.

  • Page 99

    CA50 Modes of Operation 4 - 51 Retrieving a Parked Call from an Extension Within a Group/Department To retrieve a parked voice (unicast) call from the desktop: Desktop Display Figure 4-45 On the Desktop (Figure 4-45) press the left soft key (Menu > Options) to display the Call Options menu.

  • Page 100: Park/retrieve Troubleshooting

    Description Caller Terminates Parked Call If a caller terminates a parked call, the UCA server and the CA50 device still treat the call as a parked call. When the user navigates to pick up the call a fast busy tone sounds on the device from the PBX. The fast busy tone terminates the call on the CA50 and signals the UCA server that the call was picked up.

  • Page 101: Voice (unicast) Call States

    When a call ends when either party presses the right soft key to end the call, the timer stops incrementing. 10:52 When the call ends the CA50 returns to the desktop or prior business application screen (see Sample Business Application on page 4-54).

  • Page 102: Sample Business Application

    4 - 54 CA50/UCA Client & Server Developer & User Guide Sample Business Application Appendix I, Business Applications Supplement NOTE For additional sample business applications see By default, pressing the Scan key at the desktop launches the scanner and delivers decoded data to the sample item look up application.

  • Page 103: Answering An Incoming Voice (unicast)

    CA50 Modes of Operation 4 - 55 Answering an Incoming Voice (Unicast) Call in a Business Application NOTE The following steps include instructions to answer a voice (unicast) call from an items detail screen that is part of the sample item lookup application. These instructions apply to any business application screen.

  • Page 104: Launching The Sample Business Application While In A Voice (unicast) Call

    4 - 56 CA50/UCA Client & Server Developer & User Guide Launching the Sample Business Application While in a Voice (Unicast) Call While on an active voice (unicast) call, a user may be required to access a business application to acquire information for the call.

  • Page 105: Accessing Communication Options From A Business Application

    CA50 Modes of Operation 4 - 57 Accessing Communication Options from a Business Application Initiating Walkie-Talkie Communication By default, walkie-talkie communication can be initiated at any time while in a business application by pressing the Walkie-Talkie key(s). NOTE If the application developer changes the function of the Walkie-Talkie key(s), this option may not be available.

  • Page 106

    4 - 58 CA50/UCA Client & Server Developer & User Guide (Page intentionally blank.)

  • Page 107: Uca Client Application Overview

    UCA Client Application Overview The UCA client application which resides and runs on the CA50 is the ONLY interface from the CA50 to the UCA server. The UCA client application is an integral part of the CA50 solution and provides all the following functionality on the CA50: •...

  • Page 108

    Language. This staging information is loaded into the CA50 by scanning MSP generated Rapid Deployment bar codes. The UCA client application uses these values to connect the CA50 to the UCA server and go through the logon process. When the user is logged in, the server sends the client profile data containing the user's device configuration, any personal settings and the menus that user can access.

  • Page 109

    UCA Client Application on the CA50 5 - 3 (Page intentionally blank.)

  • Page 110

    5 - 4 CA50/UCA Client & Server Developer & User Guide...

  • Page 111

    • Uninstalling UCA server software (page 6-42) • Validating successful server installation and performance (page 6-45) • Configuring firewalls (page 6-47) • System settings (page 6-48) • UCA server security (page 6-54) • CA50 capabilities with an offline UCA server (page 6-58).

  • Page 112: Uca Server Overview

    Delivery of text and command to a device • Metrics collection • Console for server setup and maintenance. The CA50 Demo Solution allows a user to easily showcase all major CA50 / UCA server functionality: • Walkie-talkie communication • Voice (unicast) calls without a PBX •...

  • Page 113

    Motorola will replace damaged or defective media. Telephone and e-mail access are also provided for the sole purpose of reporting a non-conformance issue, and for Motorola to verify the existence of the issue and determination of the conditions under which the issue may recur.

  • Page 114: Server Functionality

    CA50 devices to communicate with the server and receive communications from the server. Device Registration The CA50 client registers with the UCA server and receives the initial commands required to begin the login process. Login Process An associate identifies him/herself to the UCA server by scanning a user identification bar code and is authenticated by the server for CA50 use within a given role and group.

  • Page 115: Demo Solution

    UCA Server 6 - 5 Demo Solution The CA50 demo solution allows a user to easily showcase all the major CA50/UCA server functionality: • Walkie-talkie communication • Voice (unicast) calls without a PBX • Price lookup (business application) • HRA (business application) •...

  • Page 116: Theory Of Operation

    CA50 Login - Post-deployment on page 4-2). The following sequential steps are an overview of the events that occur when a CA50 powers on, runs the UCA client application and a user logs in: The client calls the DeviceRegistration Web Service method (page 6-4) to let the server know that it is present.

  • Page 117: Uca Server Requirements And Setup

    UCA Server Requirements and Setup Minimum Server Hardware Requirements NOTE Server hardware is not available from Motorola and must be purchased separately. Recommended UCA server hardware configuration to support up to a 50 device (CA50) deployment: • CPU: 3 GHz Pentium 4 Processor •...

  • Page 118

    6 - 8 CA50/UCA Client & Server Developer & User Guide Operating System Components That Must Be Enabled • Internet Information Services (IIS) • Common Files • World Wide Web Service • IIS - IIS Snap-In (Windows XP Pro) - IIS Manager (Windows 2003) NOTE IIS must be installed and running before the installation software runs.

  • Page 119: Uca Server Installation

    Sets up eight Web applications: Client, UCAConsole, ServerManagement, UCASampleAuth, UCASampleApp, UCASampleApp2, UCAMessaging and UCAPhoneExtensions. Installs Windows services (Motorola UCA Maintenance Service, Medial Relay Service). Installs support utilities: DBExport, Start UCA Services, Stop UCA Services, UDT, Encrypt and Decrypt. Installs sample profile templates files used by the UCA login process as specified in the sample data.

  • Page 120: Installing Uca Server Software

    6 - 10 CA50/UCA Client & Server Developer & User Guide Installing UCA Server Software There are three different versions of the UCA server software installation. • Production version - Basic UCA server software version without Demo data. Production version is meant to be installed on a unit where there was no prior version of UCA installed. If an...

  • Page 121

    Start the UCA Server Software for the CA50 CD. From the CD main menu, click Install UCA Server Software for the CA50.If Microsoft .Net 2.0 Framework is not installed on the host machine the following window displays Install Microsoft .Net 2.0 Framework Click Yes to install the UCA Server Software.

  • Page 122

    6 - 12 CA50/UCA Client & Server Developer & User Guide Click Next on the Welcome window. The License Agreement displays. License Agreement Figure 6-3 Read the license agreement and click Yes to accept and continue the installation. The Customer Information window displays with the current user name and company. Change if necessary.

  • Page 123

    This is used as part of URLs delivered to the CA50 to be used to access different services on the server. The default value that the installer presents should be changed if a CA50 would not be able to resolve the address via DNS.

  • Page 124

    UCA Client Language Window Figure 6-6 Select a language from the Language ID drop-down list. This is the language to display on the CA50 device at login. Click Next to continue. The UCA Client Language window displays. Installation Destination Window Figure 6-7 Choose the destination directory in which to install the UCA server software.

  • Page 125

    UCA Server 6 - 15 Click Next to continue. The Start Copying Files window displays. Start Copying Files Window Figure 6-8 NOTE Ensure that the settings match the summary and client. The installation process may take some time to complete. Command windows flashing is typical during the installation process. Click Back to change settings, or click Next to proceed with the installation.

  • Page 126

    6 - 16 CA50/UCA Client & Server Developer & User Guide Installing Prerequisites Figure 6-10 SQL Server Setup Figure 6-11 Adding ACL Figure 6-12...

  • Page 127

    UCA Server 6 - 17 Media Relay Figure 6-13 UCA Diagnostics Figure 6-14 UCA Server Backup & Restore Figure 6-15 UCA Server Profile Builder Figure 6-16 Click Yes to start the console, or click No. Start Web Console Figure 6-17...

  • Page 128

    6 - 18 CA50/UCA Client & Server Developer & User Guide If Yes is clicked to start the Web Console now the following Web Console window displays. See Login to the UCA Server System on page 9-3 for login information.

  • Page 129

    UCA Server 6 - 19 To view the Readme document, leave the box checked and click Finish. To end the installation without viewing the Readme document, uncheck the box and click Finish. After installing and launching the UCA server software, it is strongly recommended to validate that the server was successfully installed and is performing properly.

  • Page 130

    6 - 20 CA50/UCA Client & Server Developer & User Guide Installing Demo Version To install the Demo version of the UCA server software: Start the UCA Server Software from the CA50 CD. UCA Server Demo Figure 6-21 From the CD main menu, double-click the UCA_Server_2.0.5_demo.exe. The Welcome window displays.

  • Page 131

    This is used as part of URLs delivered to the CA50 to be used to access different services on the server. The default value that the installer presents should be changed if a CA50 would not be able to resolve the address via DNS.

  • Page 132

    6 - 22 CA50/UCA Client & Server Developer & User Guide Enter a strong password for SQL database access. SQL Server 2005 Information Figure 6-24 Enter the user name (Login ID) and the password for SQL database access. SQL Database Server Login...

  • Page 133

    UCA Client Language Window Figure 6-26 Select a language from the Language ID drop-down list. This is the language to display on the CA50 device at login. Click Next to continue. The UCA Client Language window displays. Installation Destination Window Figure 6-27 Choose the destination directory in which to install the UCA server software.

  • Page 134

    6 - 24 CA50/UCA Client & Server Developer & User Guide Click Next to continue. The Start Copying Files window displays. Start Copying Files Window Figure 6-28 NOTE Ensure that the settings match the summary and client. The installation process may take some time to complete.

  • Page 135

    UCA Server 6 - 25 Installing Prerequisites Figure 6-30 SQL Server Setup Figure 6-31...

  • Page 136

    6 - 26 CA50/UCA Client & Server Developer & User Guide SQL Server Setup Status Figure 6-32 Adding ACL Figure 6-33 ASP.NET 2.0 Ajax Extensions 1.0 Figure 6-34...

  • Page 137

    UCA Server 6 - 27 Media Relay Figure 6-35 UCA Diagnostics Figure 6-36 UCA Server Backup & Restore Figure 6-37 UCA Server Profile Builder Figure 6-38 Click Yes to start the console, or click No. Start Web Console Figure 6-39...

  • Page 138

    6 - 28 CA50/UCA Client & Server Developer & User Guide The final dialog of the installation displays. InstallShield Wizard Complete Figure 6-40 To view the Readme document, leave the box checked and click Finish. To end the installation without viewing the Readme document, uncheck the box and click Finish.

  • Page 139

    UCA Server 6 - 29 If Yes is clicked to start the Web Console now the following Web Console window displays. See Login to the UCA Server System on page 9-3 for login information. UCA Login Figure 6-42 IMPORTANT At the initial login to the Web Console (for details see page 9-3), it is required to use the default Web Console administrator Username and Password:...

  • Page 140

    6 - 30 CA50/UCA Client & Server Developer & User Guide Upgrading the Demo Version to Production To upgrade the Demo version of the UCA server software to the Production version: Start the UCA Server Software for the CA50 CD.

  • Page 141

    Extract the zipped contents of the backed up UCA database to any local folder on the PC hard drive (e.g., C:\Temp). Uninstall the old version of UCA server software from the computer (see Uninstalling UCA Server Software on page 6-42). Start the UCA Server Software for the CA50 CD.

  • Page 142

    6 - 32 CA50/UCA Client & Server Developer & User Guide From the CD main menu, double-click the "Motorola_UCA_Server_2.0.5_upgrade.exe" to begin the upgrade. Install UCA Server Software Figure 6-46 This may take several minutes, before the Welcome window displays. Welcome...

  • Page 143

    UCA Server 6 - 33 Click Next on the Welcome window. The License Agreement displays. License Agreement Figure 6-48 Read the license agreement and click Yes to accept and continue the installation. The Customer Information window displays with the current user name and company. Change if necessary. Customer Information Figure 6-49 Enter the serial number that appears on the back of the UCA installation CD sleeve.

  • Page 144

    This is used as part of URLs delivered to the CA50 to be used to access different services on the server. The default value that the installer presents should be changed if a CA50 would not be able to resolve the address via DNS.

  • Page 145

    UCA Server 6 - 35 Enter the user name (Login ID) and a strong password for SQL database access. SQL Database Server Login Figure 6-51 IMPORTANT Microsoft Strong Password Guidelines for SQL Server 2005 authentication: Strong passwords are not readily guessed by a person, and are not easily hacked using a computer program.

  • Page 146

    6 - 36 CA50/UCA Client & Server Developer & User Guide Browse to the folder to which backup zip file has been extracted. Backup Folder Figure 6-53 Click Next to continue. The UCA Client Language window displays. UCA Client Language Window...

  • Page 147

    UCA Server 6 - 37 Select a language from the Language ID drop-down list. This is the language to display on the CA50 device at login. Click Next to continue. The UCA Client Language window displays. Installation Destination Window Figure 6-55 Choose the destination directory in which to install the UCA server software.

  • Page 148

    6 - 38 CA50/UCA Client & Server Developer & User Guide Installing Prerequisites Figure 6-57 SQL Server Setup Figure 6-58...

  • Page 149

    UCA Server 6 - 39 SQL Server Setup Status Figure 6-59 Media Relay Figure 6-60 UCA Diagnostics Figure 6-61 UCA Server Backup & Restore Figure 6-62...

  • Page 150

    6 - 40 CA50/UCA Client & Server Developer & User Guide UCA Server Profile Builder Figure 6-63 Click Yes to start the console, or click No. Start Web Console Figure 6-64 If Yes is clicked to start the Web Console now the following Web Console window displays. See...

  • Page 151

    UCA Server 6 - 41 The final dialog of the installation displays. InstallShield Wizard Complete Figure 6-66 To view the Readme document, leave the box checked and click Finish. To end the installation without viewing the Readme document, uncheck the box and click Finish. After installing and launching the UCA server software, it is strongly recommended to validate that the server was successfully installed and is performing properly.

  • Page 152: Uninstalling Uca Server Software

    6 - 42 CA50/UCA Client & Server Developer & User Guide Uninstalling UCA Server Software Two options exist for uninstalling the UCA server: • Option A: Reload the same version of the UCA server software on a machine. This requires a complete uninstall.

  • Page 153

    UCA Server 6 - 43 Upon a successful uninstall, you are returned to the Add or Remove Programs screen. IMPORTANT Option A: If you are reloading the same version of the UCA server, continue to Actions 2 and 3. Option B: If you are upgrading the UCA server to a newer version STOP HERE! the uninstall process is complete.

  • Page 154

    6 - 44 CA50/UCA Client & Server Developer & User Guide Click Finish. A Microsoft SQL Server 2005 dialog box displays as the instance of the UCA database engine uninstalls. Upon its successful removal, the Add or Remove Programs window displays.

  • Page 155: Validate Successful Server Installation And Proper Performance

    <server IP address> URL shown below. For example replace <server IP address> with 192.168.0.253 (use your relevant server IP address). http://<server IP Address>/Motorola/UCA/Client/DeviceManagement.asmx?op=DeviceRegistration Login to the UCA server and Web Console as the administrator (use the short cut ';UCA Server Web Console' on the desktop).

  • Page 156: Validate A Ca50 Can Log In To The Uca Server

    6 - 46 CA50/UCA Client & Server Developer & User Guide Validate a CA50 Can Log In to the UCA Server Simulate a CA50 login to the UCA server. Internet Explorer can be used to simulate a CA50 login, verifying that the system is set up properly for CA50 access.

  • Page 157: Configuring Firewalls

    This link is in bold type in this and the previous step to illustrate its location within the URL. This link is passed back to the CA50 during device registration to tell the device the URL used for login.

  • Page 158: System Settings

    Phone.Gateway.FAC.CallPick Feature Access Code for Call Pick on the PBX. Phone.Gateway.IPAddress IP address for the phone gateway used for PBX communications. The Motorola UCA Maintenance Service must be restarted for changes to the System.Maintenance.DB.* and System.Maintenance.Session.* variables to take effect.

  • Page 159

    They should be used with caution and only in cases where an issue was reported and is being monitored and investigated by Motorola. The Motorola UCA Maintenance Service must be restarted for changes to the System.Maintenance.DB.* and System.Maintenance.Session.* variables to take effect.

  • Page 160

    They should be used with caution and only in cases where an issue was reported and is being monitored and investigated by Motorola. The Motorola UCA Maintenance Service must be restarted for changes to the System.Maintenance.DB.* and System.Maintenance.Session.* variables to take effect.

  • Page 161

    They should be used with caution and only in cases where an issue was reported and is being monitored and investigated by Motorola. The Motorola UCA Maintenance Service must be restarted for changes to the System.Maintenance.DB.* and System.Maintenance.Session.* variables to take effect.

  • Page 162

    Number of exported metrics log files to leave on the disk. System.Maintenance.DB.Metrics.FileAging Number of days to allow metrics records to remain in the DB. System.Maintenance.DB.Metrics.RecordAging The Motorola UCA Maintenance Service must be restarted for changes to the System.Maintenance.DB.* and System.Maintenance.Session.* variables to take effect.

  • Page 163

    Base port address used for walkie-talkie audio. WT.ChannelIncrementMethod Describes the method used for changing walkie-talkie channels. Values are: • Port • IP address The Motorola UCA Maintenance Service must be restarted for changes to the System.Maintenance.DB.* and System.Maintenance.Session.* variables to take effect.

  • Page 164: Uca Server Security

    6 - 54 CA50/UCA Client & Server Developer & User Guide UCA Server Security The UCA server supports the following security related features: • SSL Encryption • Directory level password protection of sensitive Web services • Encryption of server configuration files •...

  • Page 165

    UCA Server 6 - 55 Make this Certificate Trusted by the Server By default, this certificate is not trusted. To enable trust, install the certificate in the Trusted Root Certification Authorities Store. Export the certificate to a file: • In IIS Manager, right click on the default Web site. •...

  • Page 166

    6 - 56 CA50/UCA Client & Server Developer & User Guide Modify the Web.configs and App.configs Some of the UCA server config files contain Web references that must be modified to reflect the change when using SSL. If the web.config files are encrypted, they must be unencrypted before editing. See Encryption/Decryption of the UCA Server Configuration Files on page 6-57 for details.

  • Page 167: Directory Level Password Protection For Sensitive Web Services

    To ease in the decryption of the files for maintenance purposes, a few batch files are provided. They are found in C:\Program Files\Motorola\UCA Server\Utilities. Decrypt.bat and Encrypt.bat encrypts and decrypts the various config files associated with the UCA server. Decrypt.bat should not be deployed to a production environment for obvious reasons.

  • Page 168: Ca50 Capabilities With An Offline Uca Server

    • Wireless bar code scanning: Not supported until the server is online. For the CA50 to make voice calls while the server is down or offline, one phone book request from the NOTE CA50 to the UCA server had to be accessed from the server prior to the server going down. The CA50 reverts to the phone data provided by the last phone book request.

  • Page 169

    Chapter 7 XML Profile for Configuration Overview This chapter defines what a profile is and what settings are included in the profile. Valuable topics in this chapter include: • XML Profile Overview (page 7-2) • Delivery of the XML profile (page 7-2) •...

  • Page 170: Xml Profile Overview

    XML Profile Overview The XML profile is a file used to configure the CA50. The XML profile can be modified by a developer to reflect a customer's desired CA50 device settings. Generally, the XML profile is loaded from the UCA server to the CA50.

  • Page 171: Xml Profile Layout

    XML Profile for Configuration 7 - 3 XML Profile Layout The XML profile contains a root element of <XMLProfile> which is comprised of two elements: <Profile> and <Menus>. <Profile> Section of the XML Profile The <Profile> portion of the XML profile contains several User Profile Elements that set the UCA client configuration settings.

  • Page 172: User Profile Section

    7 - 4 CA50/UCA Client & Server Developer & User Guide User Profile Section NOTE See page 7-25 page 7-27 for a sample Base XML Profile and Completed User XML Profile, respectively. User Profile Elements NOTE Several User Profile Elements values, such as server.somecompany.com and various values defined in this section come from the UCA Server System Settings database.

  • Page 173

    XML Profile for Configuration 7 - 5 • Listen/Talk Channel • Users can listen and talk on Listen/Talk channels. • A channel can be set to Listen/Talk by setting the type to 'T'; in the user profile under the WTT > Chlist > Ch element. •...

  • Page 174

    (base port). DownloadFiles The UCAClient has the capability to download files from an http server to the CA50 device. This is useful when downloading custom .wav files to be used with notification or business applications.

  • Page 175

    DeviceConfig values: • CA50 Backlight - ACBacklightTimeout is the number of seconds the backlight stays on while the device is in the cradle. Set BatteryBacklightOnKeyPress to 1 if the backlight should turn on when a key is pressed while on •...

  • Page 176

    • Parameters that affect connectivity over an RF network. The XML profile parameters below establish the CA50's set points for quantifying an acceptable/unacceptable RF connection for communicating with the UCA server based on RF signal strength and recheck intervals. When these conditions are not met, the UCA client application un-registers the extension associated with making/receiving voice calls, disables the scanner, locks the keys and displays a Network Connection Lost message.

  • Page 177

    XML Profile for Configuration 7 - 9 • BatteryIconBeepEnable is the parameter used to enable or disable the low battery indicator tone. Value '0' = disable Value '1' = enable. • DefaultLowBattWavFile is used to indicate what sound (.wav file) to play when the battery goes below threshold level.

  • Page 178

    7 - 10 CA50/UCA Client & Server Developer & User Guide • NotifNoCall Defines the alert behavior when receiving a notification message while not on a phone call. There are three alert resources: Tone: A tone plays based on information from either the data within the notification message or from the profile data.

  • Page 179

    XML Profile for Configuration 7 - 11 • AppAlertCallActive, alert has three configurable options: • AllowTone • AllowVisibleIndicator • AllowVibrateIndicator • All three attributes are Boolean. Permissible values are "Y" or "N". Attributes defined for NotifNoCall, NotifCallActive, and AppAlertCallActive apply only when the NOTE client setting Enable Notification is set to Yes.

  • Page 180

    MenuStates The MenuStates element controls what default soft key labels should be displayed and what their default actions should be for various states of the CA50. The values for the State attributes are discussed in Static Menus Section on page 7-13...

  • Page 181: Static Menus Section

    <entry ID="2" value="PhoneBook:M:L:PhoneBook"/> <entry ID="3" value="Parked calls:M:L:CallPick"/> <entry ID="4" value="Do Not Disturb:S:L:QuietMode:Y"/> <entry ID="5" value="Log Off:S:L:LogOffConfirm"/> <entry ID="6" value="Power Off:S:L:PowerOff"/> </Menu> <Menu ID="3" name="PhoneBook" title="Phn Bk"> <entry ID="1" value="Extensions:M:S:Range022.xml:http://server.somecompany.com/Motorola/UCA/Client/PhoneBook.asm x/GetMenuExtRanges?sMenuType=Call&amp;sStoreNumber=%Location.ID%&amp;sListType=UCA&amp;sSortType=N umber"/> <entry ID="2" value="Last Names:M:S:Range024.xml:http://server.somecompany.com/Motorola/UCA/Client/PhoneBook.asmx/GetMenuExt Ranges?sMenuType=Call&amp;sStoreNumber=%Location.ID%&amp;sListType=UCA&amp;sSortType=LastName"/> <entry ID="3" value="Departments:M:S:Depts.xml:http://server.somecompany.com/Motorola/UCA/Client/phonebook.asmx/ GetMenuGroupList?sMenuType=Call&amp;sStoreNumber=%Location.ID%&amp;sListType=All&amp;sSortType=Nam e"/>...

  • Page 182

    7 - 14 CA50/UCA Client & Server Developer & User Guide <entry ID="3" value="Ring tone:M:L:RingTone"/> <entry ID="4" value="AEC for Headset:M:L:AECForHeadset"/> </Menu> <Menu ID="7" name="RingTone" title="Ring Tone"> <entry ID="1" value="Basic:S:L:SetRing:\Application\Wav\ringtone basic.wav"/> <entry ID="2" value="Steeldrum:S:L:SetRing:\Application\Wav\Ringtone steeldrum.wav"/> <entry ID="3" value="Atmosphere:S:L:SetRing:\Application\Wav\Ringtone atmosphere.wav"/> </Menu> <Menu ID="8" name="DeskCallActive" title="Options">...

  • Page 183: Menu Elements

    The title is the display name in the title bar at the top of the CA50 display. Menu entries should be listed in the order they are to display; their IDs should also be sequential. The value is...

  • Page 184: Changing The Ring Tone For The Ucaclient Application

    A customer could add more ring tones to this menu using the same format and providing the ring tone wave file is on the device. Step 2: Changing the Ring tone on the CA50 via the UCAClient application The ring tone selection can be seen via the Menu > Settings > Ring tone menu selection.

  • Page 185: Modifying Phone Book Menu Behavior

    XML Profile for Configuration 7 - 17 Modifying Phone Book Menu Behavior The sample phone book menu as it appears in the PhoneBook menu (ID="3") and TransferPhoneBook menu (ID="13"), show the basic capabilities of the built-in phone book Web service. These phone book menus are for placing new calls and transferring existing calls, respectively.

  • Page 186

    7 - 18 CA50/UCA Client & Server Developer & User Guide Phone Book Web Service The behavior of each of the phone book entry points can be modified by changing the parameters included in the URL for each menu entry. The phone book Web service methods and their parameters are summarized in Table 7-1.

  • Page 187: Descriptions Of Phone Book Web Service Methods

    XML Profile for Configuration 7 - 19 Descriptions of Phone Book Web Service Methods GetMenuGroupList This method returns a list of all groups that have phone book entries in them. The entries in the returned menu will retrieve a list of all the extensions in the selected group. All of the parameters are propagated to the entries. The URL used for the entries is derived from the system setting: System.Webservice.CallManager.URI.

  • Page 188

    7 - 20 CA50/UCA Client & Server Developer & User Guide GetMenuExtRanges This method returns a list of extension ranges according to the parameters. The type of range is based on whether the sort order is by number or by a name. If the sort order is by number, then the ranges will be based on the actual phone extensions.

  • Page 189

    XML Profile for Configuration 7 - 21 GetRecentCallList This method returns a list of the user's recent calls, both incoming and outgoing. The entries in the returned menu will either place a new call or transfer an existing call. Parameters sListType sSortType MostRecent...

  • Page 190: Menu States

    As mentioned earlier, keys defined by the Web application take precedence over keys defined in the <MenuStates> area of the profile. The CA50 is a dual purpose device (communication and Web browser). The UCA Web developer must consider the <MenuStates> key assignments when designing a Web application for the CA50.

  • Page 191: Key Attribute Definitions

    XML Profile for Configuration 7 - 23 Key Attribute Definitions The key attribute definitions are listed below. See Figure 3-1 on page 3-2 for key callouts. • LSKey - Left soft key • RSKey - Right soft key • LPHKey - Left soft key push and hold (not implemented) •...

  • Page 192: Setting Up Walkie-talkie Channels In The Base Profile

    When “Front End” is chosen from the menu, the CA50 client instructs the VoIP subsystem to se the WT channel to channel 3 (mote match to CH ID=”3” in the WTT section). When “My WT Settings” is chosen by the user, the CA50...

  • Page 193: Base Xml Profile Sample

    XML Profile for Configuration 7 - 25 Base XML Profile Sample A sample user profile portion is shown in the following example: <Profile> <User ID="from DB" Name="from DB" StoreID="from DB"> <Role ID="0" Name="from DB"/> <Group ID="0" Name="from DB"/> </User> <Audio> <Volume type="Speaker"...

  • Page 194

    7 - 26 CA50/UCA Client & Server Developer & User Guide <cfg type="LogoutBarcode" value="UcaLogout"/> <cfg type="UcaExitBarcode" value="UcaClientExit"/> <cfg type="BadRFSampleThreshhold" value="3"/> <cfg type="GoodRFSampleThreshhold" value="3"/> <cfg type="RFSampleTime" value="10"/> <cfg type="MinSignalStrength" value="-77"/> <cfg type="ACPowerCheckInterval" value="5"/> <cfg type="NotifMsgTimeout" value="60"/> <cfg type="BatteryIconBeepEnable" value="1"/> <cfg type="DefaultLowBattWavFile" value="\\Application\\Wav\\AFFIRMATIVEFEEDBACK.WAV"/>...

  • Page 195: Completed User Xml Profile Sample

    XML Profile for Configuration 7 - 27 Completed User XML Profile Sample <?xml version="1.0" encoding="utf-8"?> <XMLProfile> <Profile> <User ID="from DB" Name="from DB" StoreID="from DB"> <Role ID="0" Name="from DB"/> <Group ID="0" Name="from DB"/> </User> <Audio> <Volume type="Speaker" Value="0"/> <Volume type="Receiver" Value="0"/> <Volume type="Mic"...

  • Page 196

    7 - 28 CA50/UCA Client & Server Developer & User Guide <cfg type="NotifAllowOnCallActive" value="Y"/> <cfg type="CacheTimeToLive" value="60"/> <cfg type="LogoutBarcode" value="UcaLogout"/> <cfg type="UcaExitBarcode" value="UcaClientExit"/> <cfg type="BadRFSampleThreshhold" value="3"/> <cfg type="GoodRFSampleThreshhold" value="3"/> <cfg type="RFSampleTime" value="10"/> <cfg type="MinSignalStrength" value="-77"/> <cfg type="ACPowerCheckInterval" value="5"/> <cfg type="NotifMsgTimeout" value="60"/>...

  • Page 197

    <entry ID="2" value="PhoneBook:M:L:PhoneBook"/> <entry ID="3" value="Parked calls:M:L:CallPick"/> <entry ID="4" value="Do Not Disturb:S:L:QuietMode:Y"/> <entry ID="5" value="Log Off:S:L:LogOffConfirm"/> <entry ID="6" value="Power Off:S:L:PowerOff"/> </Menu> <Menu ID="3" name="PhoneBook" title="Phn Bk"> <entry ID="1" value="Extensions:M:S:Range022.xml:http://server.somecompany.com/Motorola/UCA/Client/PhoneBook.asm x/GetMenuExtRanges?sMenuType=Call&amp;sStoreNumber=%Location.ID%&amp;sListType=UCA&amp;sSortType=N umber"/> <entry ID="2" value="Last Names:M:S:Range024.xml:http://server.somecompany.com/Motorola/UCA/Client/PhoneBook.asmx/GetMenuExt Ranges?sMenuType=Call&amp;sStoreNumber=%Location.ID%&amp;sListType=UCA&amp;sSortType=LastName"/> <entry ID="3" value="Departments:M:S:Depts.xml:http://server.somecompany.com/Motorola/UCA/Client/phonebook.asmx/ GetMenuGroupList?sMenuType=Call&amp;sStoreNumber=%Location.ID%&amp;sListType=All&amp;sSortType=Nam e"/>...

  • Page 198

    7 - 30 CA50/UCA Client & Server Developer & User Guide </Menu> <Menu ID="4" name="Applications" title="Applns"> <entry ID="1" value="Price Check:S:S:http://server.somecompany.com/Motorola/UCA/Samples/UCASampleApp/Sample.aspx"/> <entry ID="2" value="PriceCheck2:S:S:http://server.somecompany.com/Motorola/UCA/Samples/UCASampleApp2/Default.as px"/> </Menu> <Menu ID="5" name="FrontWTChannels" title="WT Channels"> <entry ID="1" value="My WT Settings:S:L:SetChannel:5:Normal"/> <entry ID="2" value="Sales:S:L:SetChannel:3:Single"/> </Menu> <Menu ID="6" name="Settings" title="Settings">...

  • Page 199

    XML Profile for Configuration 7 - 31 <entry ID="1" value="Extensions:M:S:Range022.xml:http://server.somecompany.com/Motorola/UCA/Client/PhoneBook.asm x/GetMenuExtRanges?sMenuType=Transfer&amp;sStoreNumber=%Location.ID%&amp;sListType=UCA&amp;sSortTy pe=Number"/> <entry ID="2" value="Last Names:M:S:Range024.xml:http://server.somecompany.com/Motorola/UCA/Client/PhoneBook.asmx/GetMenuExt Ranges?sMenuType=Transfer&amp;sStoreNumber=%Location.ID%&amp;sListType=UCA&amp;sSortType=LastName" /> <entry ID="3" value="Departments:M:S:Depts.xml:http://server.somecompany.com/Motorola/UCA/Client/phonebook.asmx/ GetMenuGroupList?sMenuType=Transfer&amp;sStoreNumber=%Location.ID%&amp;sListType=All&amp;sSortType =Name"/> <entry ID="4" value="First Names:M:S:Range023.xml:http://server.somecompany.com/Motorola/UCA/Client/PhoneBook.asmx/GetMenuExt Ranges?sMenuType=Transfer&amp;sStoreNumber=%Location.ID%&amp;sListType=UCA&amp;sSortType=FirstName "/> </Menu> <Menu ID="14" name="DeskCallOnHold" title="Options"> <entry ID="1" value="HangUp:S:L:PhoneHangUp"/> <entry ID="2" value="Transfer:M:L:TransferPhoneBook"/>...

  • Page 200

    7 - 32 CA50/UCA Client & Server Developer & User Guide (Page intentionally blank.)

  • Page 201

    UCA client. In addition, this section contains a Menu States section which defines the menu options in each operational state of the UCA client. The Menus section contains the list of menu options that display on the CA50 device when the user logs in to the device.

  • Page 202

    Profile Builder as Auto values. The profiles created in Profile Builder are used by the UCA server. Upon user login to the CA50 device, the UCA server transfers the appropriate profile for the user to the CA50 device. Before transferring the profile to the device,...

  • Page 203

    XML Profile Builder for Device Configuration 8 - 3 XML Profile Layout The XMLProfile has two components: • Profile • Menus. XML Profile, Profile Section The Profile portion contains User Profile Elements for UCA client configuration settings. The Profile portion is organized into the following categories/elements: •...

  • Page 204: Xml Profile, Profile Section

    8 - 4 CA50/UCA Client & Server Developer & User Guide XML Profile, Profile Section Create New Profile To create a new UCA XML profile, specify the new settings and save the profile. Specify the profile information, such as the profile name and the language:...

  • Page 205

    XML Profile Builder for Device Configuration 8 - 5 Enter the profile name and select the language. Input Profile Basic Details Figure 8-3 NOTE English is the default language.The language list consists of English, French, Italian, Japanese, Korean, German and Spanish Click Next.

  • Page 206: Phone Settings

    8 - 6 CA50/UCA Client & Server Developer & User Guide The Default Menu option appears initially. To choose an existing menu, click the Choose Menu radio button. Click Browse to select an existing menu (an XML file containing menu information).

  • Page 207: Walkie-talkie Settings

    XML Profile Builder for Device Configuration 8 - 7 Walkie-Talkie Settings The Walkie-Talkie settings specifies the settings required to set up the default Walkie-Talkie communication. To enable the Walkie-Talkie and Scan mode: Enable Walkie-Talkie Figure 8-7 Check the Enable Walkie-Talkie mode to enable the Walkie-Talkie communication. Un-check the Enable Walkie-Talkie mode to disable the Walkie-Talkie communication.

  • Page 208

    8 - 8 CA50/UCA Client & Server Developer & User Guide Multicast settings specify the multicast address which must be used to receive Walkie-Talkie (WT) messages. Walkie-Talkie Multicast Settings Table 8-1 Field Description IP Address The multicast IP address is used to send/receive the WT messages to all the devices in the same subnet.

  • Page 209

    XML Profile Builder for Device Configuration 8 - 9 SCO (Single Channel Only) By default, users cannot hear anything on this channel. This is a reserve channel for single channel mode. A user must select this channel manually to access it. Selecting this channel puts a user in Single Channel mode.

  • Page 210: Download Files Settings

    Download Files Settings The Download File settings provides files to select from an HTTP server to download to the CA50 device. This feature is useful when downloading files that can be used with notification or business applications. Download Files Settings...

  • Page 211: Desktop Settings

    XML Profile Builder for Device Configuration 8 - 11 Desktop Settings When there are no active calls and there is no business application running on the device, the device state is Desktop. In this state actions occur from the desktop. However, overriding is allowed for some actions when the device is in Desktop mode.

  • Page 212: Volume Settings

    8 - 12 CA50/UCA Client & Server Developer & User Guide Volume Settings The volume settings define the default values for the audio paths (headset, microphone, speaker and receiver). The default values are used for the first time login, however once the settings are changed, the new values are saved and are used with the next time log-on.

  • Page 213: Metrics & Logging

    XML Profile Builder for Device Configuration 8 - 13 Metrics & Logging Metrics The metrics section specifies the required device metrics, what is sent to the server and defines the interval. Metrics Figure 8-15 Metrics Settings Table 8-5 Field Description Collection Interval Specifies the send interval for sending the metrics data to the server.

  • Page 214: Device Settings

    8 - 14 CA50/UCA Client & Server Developer & User Guide Logging Settings Table 8-6 Field Description No logging. Info Logs high level information such as device and server IP addresses. Error Logs all error messages along with information messages.

  • Page 215: Client Settings

    XML Profile Builder for Device Configuration 8 - 15 Device Settings (Continued) Table 8-7 Field Description Notif Msg Visible Cycle Count The number of times the device should show visible indication on receipt of notification message. Enable Backlight Check the check box to enable the device backlight on the device. Uncheck the check box to disable the backlight on the device (when on battery power) regardless of the values of other parameters such as Enable Backlight On Key Press.

  • Page 216: Alert Settings

    8 - 16 CA50/UCA Client & Server Developer & User Guide Client Settings (Continued) Table 8-8 Field Description DND Timeout The amount of time in seconds that the UCA client application stays in Do not disturb mode. WebService Response Timeout The amount of time a Web service call stays connected waiting for a response.

  • Page 217

    XML Profile Builder for Device Configuration 8 - 17 Choose the setting and select the options in the corresponding alert details section of the window. Click Help for detailed descriptions of each alert type. RcvCallNoCall: The setting defines the alert behavior when a phone call is received. These attributes are applied as-is, for visible and vibrate indicators.

  • Page 218

    8 - 18 CA50/UCA Client & Server Developer & User Guide PTTNoCall: The setting defines the alert behavior when either Walkie-Talkie key is pressed when not on an active call. The only applicable attribute is tone. PTTNoCall Figure 8-22 NotifNoCall: The setting defines the alert behavior when a notification message is received (not on a phone call).

  • Page 219

    XML Profile Builder for Device Configuration 8 - 19 LED: The LED flashes based on information from either the data within the notification message or from the user profile. The device checks if the notification message has the visible indicator data. If data is available, the LED flashes.

  • Page 220

    8 - 20 CA50/UCA Client & Server Developer & User Guide whether the alerts are allowed or not in that state. If the tone, visible and/or vibrate indicator is allowed, the behavior of these alerts follows the same rules as that of NotifCallActive.

  • Page 221: Create Menus

    XML Profile Builder for Device Configuration 8 - 21 Create Menus Click Help for detailed descriptions of menus and menu states. To create the main menu: Run the Profile Builder application and select Menus > New. The Menus & Menu States window appears. Menus &...

  • Page 222: Add Menu Elements

    8 - 22 CA50/UCA Client & Server Developer & User Guide Select the newly added menu item under Menus (Menu11) to display Main Menu. New Added Menu Figure 8-28 Type a menu title (e.g., Options) in the text box under Main Menu.

  • Page 223: Add A Static Menu Element

    XML Profile Builder for Device Configuration 8 - 23 Server action: Refers to a special action taken by executing the URI specified on the UCA server. Menu Elements Figure 8-30 Add a Static Menu Element To delete any menu, select the menu to delete, right-click and select Remove. Right-click the main menu - Options (AppCallActive) - and select Add Static Menu Element.

  • Page 224: Add A Dynamic Menu Element

    8 - 24 CA50/UCA Client & Server Developer & User Guide Enter a Menu Name (e.g., TransferPhoneBook) in the text box under Static Menu Element. Enter Menu Name Figure 8-32 Add a Dynamic Menu Element Right-click the main menu - Options (AppCallActive) - and select Add Dynamic Menu Element.

  • Page 225: Add A Client Command Menu Element

    XML Profile Builder for Device Configuration 8 - 25 Add a Client Command Menu Element Right-click the main menu - Options (AppCallActive) - and select Add Client Command. Select the new Client Command item (Client Command4). Add a Client Command Menu Element Figure 8-35 Enter a Menu Title (e.g., About) in the text box under Client Command.

  • Page 226: Add A Server Action Menu Element

    Type a valid URI in the text box under Server Action. Enter Menu Title Figure 8-38 Click Save and proceed to Add Menu States, when finished adding menus. NOTE Use the sample profile provided under C:\Program files\Motorola\UCA Server\Profiles\ and modify it to suit requirements rather than creating a new menu.

  • Page 227: Add Menu States

    XML Profile Builder for Device Configuration 8 - 27 Add Menu States Menu states define the operational state of the UCA client and the left and right soft key actions in that state. The actions can be either a reference to a menu or an execution of a command. There are eight menu states: AppCallActive: Call is active and an application is running.

  • Page 228

    8 - 28 CA50/UCA Client & Server Developer & User Guide Click the plus sign to the left of Menu States to expand the tree. Select the newly added menu item under Menu States (AppCallActive) to display the details for the menu state.

  • Page 229

    Chapter 9 UCA Server WebConsole Graphical User Interface Overview This chapter provides information about the UCA server WebConsole GUI and how to use it for UCA server configuration and setup. Valuable topics in this chapter include: • UCA Server WebConsole Interface Overview (page 9-2) •...

  • Page 230: Uca Server Webconsole Interface Overview

    9 - 2 CA50/UCA Client & Server Developer & User Guide UCA Server WebConsole Interface Overview The UCA server WebConsole Interface is a Graphical User Interface (GUI) for UCA server configuration and setup. The GUI allows an administrator to view, create, edit and delete settings and entries in the UCA server.

  • Page 231: Login To The Uca Server System

    For remote login to the UCA server software, use the following URL and substitute the server IP address into the portion of the <server IP address> URL shown below. For example replace <server IP address> with 192.168.0.253 (use your relevant server IP address). http://<server IP address>/Motorola/UCA/UCAConsole/Login.aspx. The following window displays. WebConsole GUI Login...

  • Page 232

    9 - 4 CA50/UCA Client & Server Developer & User Guide Enter the Username and Password set for you by the UCA Administrator. IMPORTANT At the initial login to the Web Console (for details see page 9-3), it is required to use the default Web Console administrator Username and Password: •...

  • Page 233: System Status Tab View

    (Figure 9-4). To toggle between views, click on a tab: Server Status and/or Devices. Server Status Server Status view displays the status of all UCA Users, CA50 Devices, Database Maintenance, Software Versions and Miscellaneous entries. Server Status View Figure 9-3...

  • Page 234: Devices

    9 - 6 CA50/UCA Client & Server Developer & User Guide Devices Devices view displays a list of devices recently seen by the UCA server. Displayed information includes: Device ID, Serial Number, Device model, Last Known User ID, Last Known User Name, User Status, Assigned Phone Extension, Last Login and Activity Time.

  • Page 235: Phone And Walkie-talkie Tab View

    Phone Extension Status The Phone Extension Status view displays the status of all phone extensions that can be assigned to a CA50. It also lists any phone extensions that failed when attempting to register with the PBX. This view shows Extension, Group, Extension Status, Current Owner External ID and Current Owner IP Address of all active users in the UCA server.

  • Page 236: Phone Extension Pool

    The Phone Extension Pool view displays the pool of extensions defined in the UCA server that are assignable to a CA50. The view includes: phone Extension, Group, Static Owner External ID, Extension Type and Phonebook Description of all phone extensions in the UCA server. For SCCP protocol, the phone extension pool view see Figure 9-6.

  • Page 237

    UCA Server WebConsole Graphical User Interface 9 - 9 Creating a UCA Phone Extension To create a phone extension in the UCA server: Click the Phone and Walkie-Talkie tab > Phone Extension Pool tab > Create. The Create Phone Extension window displays. Create Phone Extension Window Figure 9-8 For SCCP, (only) an additional parameter is required, the SCCP MAC address.

  • Page 238

    9 - 10 CA50/UCA Client & Server Developer & User Guide Enter a Phone Extension and PBX Password and in the appropriate text boxes. The PBX password option is at the discretion of the UCA server Administrator. NOTE The PBX password depends on PBX configuration. Some PBXs are configured to require a password during the phone extension assignment process.

  • Page 239

    UCA Server WebConsole Graphical User Interface 9 - 11 Editing the Properties Connected to a UCA Phone Extension To edit the properties connected to a UCA phone extension in the UCA server: Click the Phone and Walkie-Talkie tab > Phone Extension Pool tab. Click the phone extension to edit from the list of UCA extensions in the Extension column (see Figure 9-6 on page...

  • Page 240

    9 - 12 CA50/UCA Client & Server Developer & User Guide Click Edit. The Edit Phone Extension window displays. Edit Phone Extension Window Figure 9-12 Click Edit. The SCCP Edit Phone Extension window displays. SCCP Edit Phone Extension Window Figure 9-13 Any field, except Phone Extension, can be updated in this window.

  • Page 241: Phone Extension Import File Format

    Use this option to load data in bulk instead of creating users and phone extensions one at a time via the UCA server's Web Console. Bulk loading of phone extensions and CA50 users into the UCA database is enabled. To create and import user data, see page 9-25.

  • Page 242: Additional Phonebook Entries

    • S = Statically assigned UCA extensions (in the Phone Extension Pool). • The single import option imports extensions for the Phone Extension Pool and the Additional Phonebook Entries. NOTE For information on how to import CA50 users into the UCA database, see page 9-25. Additional Phonebook Entries The Additional Phonebook Entries view displays the Phone Extension, Group and Description of all additional phone extensions created in the UCA server.

  • Page 243

    UCA Server WebConsole Graphical User Interface 9 - 15 Creating an Additional Phone Extension To create an additional phone extension in the UCA server: Click the Phone and Walkie-Talkie tab > Additional Phonebook Entries tab > Create. The Additional Phonebook Entry Create window displays. Additional Phonebook Entry Create Window Figure 9-15 Enter a Phone Extension and Phonebook Description in the appropriate text boxes.

  • Page 244

    9 - 16 CA50/UCA Client & Server Developer & User Guide Editing an Additional Phone Extension To edit an additional phone extension in the UCA server: Click the Phone and Walkie-Talkie tab > Additional Phonebook Entries tab. Click the phone extension to edit from the list of phone numbers in the Phone Number column (see...

  • Page 245: Deleting Phone Extensions

    UCA Server WebConsole Graphical User Interface 9 - 17 Click Edit. The Edit Additional Phonebook Entry window displays. Edit Additional Phonebook Entry Window Figure 9-17 Any field, except Phone Extension, can be updated in this window. Enter changes as needed. Click Save to save the edits or Cancel to terminate the session.

  • Page 246: Device User Accounts Tab View

    9 - 18 CA50/UCA Client & Server Developer & User Guide Device User Accounts Tab View Click the Device User Accounts tab on the UCA server WebConsole GUI window to display the view. The Device User Accounts tab has two views: •...

  • Page 247: All Users

    UCA Server WebConsole Graphical User Interface 9 - 19 All Users All Users view displays the First/Last Name, Common Name, External User ID, Role, and Status of all device users configured to use the UCA server. In this view create, edit and delete users. All Users View Figure 9-19...

  • Page 248

    9 - 20 CA50/UCA Client & Server Developer & User Guide Creating a New User To create a user in the UCA server: Click the Device User Accounts tab > All Users tab > Create. The Create User window displays.

  • Page 249

    UCA Server WebConsole Graphical User Interface 9 - 21 Editing User Information To edit user information in the UCA server: Click the Device User Accounts tab > All Users tab. Click the external user ID to edit from the list of users in the External UserID column (see Figure 9-19 on page 9-19).

  • Page 250

    9 - 22 CA50/UCA Client & Server Developer & User Guide Click Edit. The Edit Phone Extension window displays. Edit User Information Window Figure 9-22 Enter the user information to change in the appropriate text boxes; add and/or delete Selectable and Permanent assignments.

  • Page 251: Editing User Password

    UCA Server WebConsole Graphical User Interface 9 - 23 Editing User Password A password is used during a user login to the UCA server. Password requirements are at the discretion of the UCA server Administrator. If a password is not assigned to a user, the user is not prompted to enter a password during the login process on a device.

  • Page 252: Deleting A User

    9 - 24 CA50/UCA Client & Server Developer & User Guide Click Edit Password. The Edit UCA User Password window displays. Edit UCA User Password Window Figure 9-24 Enter the new password in the Password: text box. Confirm the new password in the Confirm Password: text box.

  • Page 253: Device User Import File Format

    Web Console. Bulk loading of phone extensions and CA50 users into the UCA database is enabled. To create and import phone extensions, see page 9-13. The CA50 user import feature uses a comma separated value (CSV) format that must include a header line as follows: locExtID,ExtUsrID,firstName,lastName,userName,PIN,RoleToken,userStatus,Selectable Group List,Permanent Group List...

  • Page 254: Profile Management Tab View

    9 - 26 CA50/UCA Client & Server Developer & User Guide Profile Management Tab View Click the Profile Management tab on the UCA server WebConsole GUI window to display the view. Profile Management provides the ability to associate a base XML profile template to a Role and/or Group entity.

  • Page 255: Create An Associated Base Profile

    UCA Server WebConsole Graphical User Interface 9 - 27 Create an Associated Base Profile To create an associated base profile to a Role entry in the UCA server: Click the Profile Management tab > Profile Associations tab > Create. The Profile Association Create window displays. Profile Association Create Window Figure 9-26 Select a template from the Template File: drop down list menu.

  • Page 256: Editing An Associated Base Profile

    9 - 28 CA50/UCA Client & Server Developer & User Guide Editing an Associated Base Profile To edit an associated base profile to a Role entry in the UCA server: Click the Profile Management tab. Select an ID (base profile association number) in the list under the ID column.

  • Page 257: Deleting Associated Base Profiles

    UCA Server WebConsole Graphical User Interface 9 - 29 Enter a new description in the Description: text box; select a role and group from the drop down list menus as needed. Click Save to change the associated base profile or Cancel to terminate the session. Deleting Associated Base Profiles Delete Utility on page 9-52 for information about deleting entries in the UCA server.

  • Page 258: Roles And Groups Tab View

    9 - 30 CA50/UCA Client & Server Developer & User Guide Roles and Groups Tab View Click the Roles and Groups tab on the UCA server WebConsole GUI window to display the view. The Roles and Groups tab has two views: •...

  • Page 259

    UCA Server WebConsole Graphical User Interface 9 - 31 Creating Groups To create a group in the UCA server: Click the Roles and Groups tab > Groups tab > Create. The Group Create window displays. Group Create Window Figure 9-30 Enter a unique Group ID in the Group ID (must be unique): text box.

  • Page 260

    9 - 32 CA50/UCA Client & Server Developer & User Guide Editing a Group To edit a group in the UCA server: Click the Roles and Groups tab > Groups tab. Click the group to edit from the list of UCA groups in the Group ID column (see Figure 9-29 on page 9-30).

  • Page 261: Roles

    UCA Server WebConsole Graphical User Interface 9 - 33 Enter the group information to change in the appropriate text boxes. Any field, except Group ID, can be updated in this window. Click Save to save the edits or Cancel to terminate the session. Deleting Groups Delete Utility on page 9-52 for information about deleting entries in the UCA server.

  • Page 262

    9 - 34 CA50/UCA Client & Server Developer & User Guide Creating Roles To create a role in the UCA server: Click the Roles and Groups tab > Roles tab > Create. The Role Create window displays. Role Create Window Figure 9-34 Enter a unique Role ID in the Role ID (must be unique): text box.

  • Page 263

    UCA Server WebConsole Graphical User Interface 9 - 35 Editing a Role To edit a role in the UCA server: Click the Roles and Groups tab > Role tab. Click the role to edit from the list of UCA roles in the Role ID column (see Figure 9-33 on page 9-33).

  • Page 264

    9 - 36 CA50/UCA Client & Server Developer & User Guide Enter the role information to change in the appropriate text boxes. Any field, except Role ID, can be updated in this window. Click Save to save the edits or Cancel to terminate the session.

  • Page 265: System Management Tab View

    UCA Server WebConsole Graphical User Interface 9 - 37 System Management Tab View Click the System Management tab on the UCA server WebConsole GUI window to display the view. The System Management tab has three views: • System Settings (Figure 9-37) •...

  • Page 266

    9 - 38 CA50/UCA Client & Server Developer & User Guide To view/configure System Settings: • Click the System Settings tab on the UCA server WebConsole GUI window to display the tab view. System Settings View Figure 9-37...

  • Page 267

    UCA Server WebConsole Graphical User Interface 9 - 39 • Click to view System Settings in a tree structure. System Settings - Tree Structure View Figure 9-38 Configure System Settings on page 9-42 for details about configuring system settings. NOTE...

  • Page 268

    Client Settings Client settings are default CA50 device settings used to help build the XML profile for a user. The user can modify certain settings on the device such as backlight, phone ring and volume settings as personal preferences. These preferences are recorded and applied when the user logs into the UCA server.

  • Page 269

    UCA Server WebConsole Graphical User Interface 9 - 41 Phone Settings Phone settings are used for PBX and phone system settings used with the UCA server. Settings like Phone Gateway IP, Port, Type, etc. can also be viewed and configured. Phone Settings View Figure 9-40 Phonebook Settings...

  • Page 270

    9 - 42 CA50/UCA Client & Server Developer & User Guide High Level System Settings High level UCA server operational settings can be modified by a UCA Administrator who can view and set many system options for Profiles, IP addresses, Logins, Timeouts, Web Page allocation, Database Maintenance and Media Relay values.

  • Page 271: Console Users

    Click Save or Cancel to terminate the session. NOTE See System Settings on page 6-48 for a detailed list of the system settings for CA50 Client/Server software. Console Users Console Users provides the ability to create, edit and delete UCA System users.

  • Page 272

    NOTE The UCA server supports two roles: Administrator and Manager. Administrator has full permissions and can perform all actions available through the UCA Console. Manager has limited permissions and can only view System Status and add, edit and remove CA50 device users.

  • Page 273

    UCA Server WebConsole Graphical User Interface 9 - 45 Editing Console User Information To edit console user information in the UCA server: Click the System Management tab > Console Users tab. Click the User ID to edit from the list of users in the User ID column. The Console User Detail window displays.

  • Page 274

    9 - 46 CA50/UCA Client & Server Developer & User Guide Click Save to save the edits Click Cancel to terminate the session. Editing a Console User Password To edit a console user's password in the UCA server: Click the System Management tab > Console Users tab.

  • Page 275: Tools

    • MSP Staging: This is a link to MSP Stage. After setting the system setting System.Tools.Stage to point to MSP stage in your environment, this link can be used for quick access to the Motorola MSP Stage product. • Debug Trace Log Utilities: Through the Tools tab the console user can export, purge, and export/purge the debug trace log found in the UCA database.

  • Page 276

    9 - 48 CA50/UCA Client & Server Developer & User Guide To access Tools: Click the System Management tab > Tools tab. The Tools window displays. Tools Window Figure 9-50 Profile builder is installed on the UCA server by default. This link is provided so that Profile builder can be installed on another system.

  • Page 277

    UCA Server WebConsole Graphical User Interface 9 - 49 Click the System Management tab > Tools tab > Export. The Export Debug Trace Log window displays. Export Debug Trace Log Window Figure 9-51 Select Continue to export the trace log. Select Cancel to return to the Tools tab.

  • Page 278

    9 - 50 CA50/UCA Client & Server Developer & User Guide Click the System Management tab > Tools tab > Purge. The Purge Debug Trace Log window displays. Purge Debug Trace Log Window Figure 9-52 Select Continue to purge the trace log.

  • Page 279

    UCA Server WebConsole Graphical User Interface 9 - 51 Exporting and Purging the Debug Trace Log To export and purge the debug trace logs found in the UCA server: Click the System Management tab > Tools tab > Export/Purge. The Export/Purge Debug Trace Log window displays. Export/Purge Debug Trace Log Window Figure 9-53 Select Continue to export and purge the trace log.

  • Page 280: Uca Server Webconsole Gui Utilities

    9 - 52 CA50/UCA Client & Server Developer & User Guide UCA Server WebConsole GUI Utilities Find Utility All tab views on the UCA server WebConsole GUI, except System Status, provide a Find Utility to help locate specific entries. Find Utility Tool Bar...

  • Page 281

    UCA Server WebConsole Graphical User Interface 9 - 53 On the Detail window, click Delete. Detail Window Figure 9-55 Click OK in the Are you sure you want to delete this? message box to delete the entry from the database. Deleting Multiple Entries This method includes an Add to List for Delete Utility that allows entries in a tab view to be added to a list of entries to delete.

  • Page 282

    9 - 54 CA50/UCA Client & Server Developer & User Guide Click the check boxes to the left of each entry to delete. Selections to Delete Figure 9-57 Click Add to List For Delete. Each entry checked for deletion displays in the Selected Item List box on the bottom of the tab view.

  • Page 283: Import Utility

    UCA Server WebConsole Graphical User Interface 9 - 55 Import Utility The Import Utility allows some of the lists to be imported via CSV files instead of manually entering the data. To import from a CSV file: On the Device User Accounts tab, click Import. Device User Accounts tab Figure 9-59 The Import screen displays.

  • Page 284

    9 - 56 CA50/UCA Client & Server Developer & User Guide (Page intentionally blank.)

  • Page 285

    Request format (page 10-4) • Response format (page 10-4) • HTML elements (page 10-5) • Best practices and considerations for CA50 development (page 10-12) • Data collection (page 10-12) • Access to communication options and the Web application (page 10-12) •...

  • Page 286: Business Application Overview

    UCA server or other addressable Web servers in the enterprise. Multiple business applications can be accessed by a CA50. From the menu, a user selects one of the business applications for operation. Only one business application can be run at a time on the CA50.

  • Page 287: Ca50 Web Application Developer Guide

    To work with the UCA client application browser, the responses generated by the Web server adhere to the HTML specification to the greatest extent possible. Due to the small display on the CA50 client, many HTML tags are not applicable. For example, a graphical submit button would use most of the rendering window for the browser. In addition, the UCA client application does not have a pointing device and has limited physical buttons or keys.

  • Page 288: Request Format

    NOTE The SerialNo name value pair is not fully implemented at this time and the SerialNo value is invalid. Motorola's additional HTTP headers provided by the UCA client application browser are defined as follows. IPAddress - IP address of the device.

  • Page 289: Html Elements

    Standard HTML Elements As mentioned earlier, given the display size of the CA50 device, most standard HTML elements are not applicable for business applications being run by the CA50 device. For the most part, graphical controls (buttons, drop down lists, scrolling lists, visible input fields, etc.), hyperlinks, frames, tables, style sheets, and formatting tags should...

  • Page 290

    10 - 6 CA50/UCA Client & Server Developer & User Guide HTML Elements Contained in the Head Element HTML Elements Contained in the Head Element Table 10-1 Element Description This meta tag causes the business application to exit and the UCA <meta http-equiv = "ExitBusApp"...

  • Page 291

    CA50 Business Application Development 10 - 7 HTML Elements Contained in the Head Element (Continued) Table 10-1 Element Description This custom tag causes the device to reboot once the business <meta http-equiv ="reboot" content="warm"> application page is received and parsed. The content value can either be "warm"...

  • Page 292

    /> left soft key on the CA50 device. The id attribute's value must be "LeftSoftKey" and the type attribute must be "submit" or "button". The value for the "value" attribute is the label for the left soft key on the device. Keep in mind that keys defined by the Web application take precedence over the keys defined in the <MenuStates>...

  • Page 293

    CA50 Business Application Development 10 - 9 HTML Elements Contained in the Body Element (Continued) Table 10-2 Element Description The spin box element allows the user to select a series of digits to <input type="submit" id="spinbox" name="USERID" SpinBoxLabel="User ID" enter numeric information and submit this information to the server.

  • Page 294

    "#" character if this attribute is not detected in the spin box input element. Value The contents of this attribute represents what displays on the CA50 device except the mask characters are replaced by "0" when the spin box is rendered on the browser window.

  • Page 295

    CA50 Business Application Development 10 - 11 HTML Elements Contained in the Body Element (Continued) Table 10-2 Element Description This input element allows business application developers to define a soft <input type=”Command” name =”PHNPLACECALL” key for users to press to place a phone call based on the attributes for the options=”1:192.168.0.22:1720:012345”...

  • Page 296: Best Practices And Considerations For Ca50 Development

    10 - 12 CA50/UCA Client & Server Developer & User Guide Best Practices and Considerations for CA50 Development There are special considerations to take into account when designing Web pages for the CA50 that might not occur when developing Web pages for desktops or other Motorola mobile devices.

  • Page 297

    CA50 Business Application Development 10 - 13 Example 1 - No Soft Keys Defined by the Web Application The simplest screen is one in which the Web application defines no keys. An example of this is shown below in Figure 10-1 with the HTML for that page following.

  • Page 298

    10 - 14 CA50/UCA Client & Server Developer & User Guide Example 2 - One Soft Key Defined by the Web Application Figure 10-2 and the HTML that follows for a Web page that defines the right soft key as an Exit key. This allows the Web application to quit and the UCA client application displays the desktop screen.

  • Page 299

    CA50 Business Application Development 10 - 15 Example 3 - Both Soft Keys Defined by the Web Application Figure 10-3 and the HTML that follows shows a Web page where both keys are defined by the Web application. In most cases this would not be a good idea. If the user wanted to change walkie-talkie channels at this moment, he or she could not.

  • Page 300: Business Applications And Their Extensions

    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)

  • Page 301

    CA50 Business Application Development 10 - 17 Parameters sStoreNumber Store or location number. sIpAddr IP address of the CA50 device. sUser A reference to string that contains the UCA User ID, when successful. WSStatus UCAWebServiceStatus class describes the status of the call.

  • Page 302

    10 - 18 CA50/UCA Client & Server Developer & User Guide (Page intentionally blank.)

  • Page 303

    This chapter outlines how to use the optional APIs that are installed with the UCA server. Valuable topics in this chapter include: • UCA server optional APIs overview (page 11-2) • CA50 device user authentication process (page 11-5) • Device user authentication Web service (page 11-8) •...

  • Page 304: Uca Server Optional Apis Overview

    The Application Programming Interfaces (APIs) in this chapter can be utilized to extend the standard UCA server functionality provided from Motorola. These APIs enable integration of the UCA server into existing store processes. The use of these APIs is optional.

  • Page 305: Location Of Optional Apis And Web Messaging Service

    AddExtension() function found in the Phone Extension Management Web service. The messaging Web services are located in the /Motorola/UCA/ServerManagement directory under IIS. This Web service can be used by external programs to send asynchronous messages to logged on CA50 users. Alternate Mechanism for Login and Authentication Device user authentication is based on the user information on the UCA server.

  • Page 306: Alternative Mechanism For Server Management And Maintenance Of Customer Data

    API used by the Web Console to interface to the UCA server's databases. Mechanism for Sending Text Messages to the Device You must use a Web service to send text messages from the UCA server to the CA50 (Asynchronous Messaging Mechanism). See CA50 Features on page 1-2 for an overview of the CA50 text messaging capabilities.

  • Page 307: Ca50 Device User Authentication Process

    UCA Server Optional APIs 11 - 5 CA50 Device User Authentication Process The UCA server uses a combination of .NET Web services and .NET aspx pages for the CA50 device user Authentication Process. Process Flow Upon startup, the CA50 client calls the DeviceRegistration method in the DeviceManagement Web Service to register with the UCA system.

  • Page 308

    Modify the system settings login tokens to point to the new aspx pages. Motorola provides an example Authentication Web Service with method stubs that can be used as a starting point for a customer or integrator who wishes create their own.

  • Page 309: Uca Authentication Process Diagram

    UCA Server Optional APIs 11 - 7 UCA Authentication Process Diagram Client/Server UCA Authentication Process Flow Figure 11-1...

  • Page 310: Device User Authentication Web Service

    Device User Authentication Web Service In the default installation, the Device User Authentication Web Service is located at: http://UCAInstallMachine/Motorola/UCA/Client/Authentication/Authentication.asmx. This Web service is used in the authentication process of a CA50 device user. Authentication Web Service Methods GetUserData This method retrieves user information from the UCA system. The user’s information is updated in the UserInfo class passed to the method.

  • Page 311

    UCA Server Optional APIs 11 - 9 Related Classes public class UserInfo public UserInfo(){} public string ExtUsrID; public string firstName; public string lastName; public string userName; public string RoleToken; public string locExtID; public string userStatus; public string userPhExtn; //Groups are listed by Rank public UserGroupInfo[] aUserGroups;...

  • Page 312

    11 - 10 CA50/UCA Client & Server Developer & User Guide UserGroupInfo Class Members UserGroupInfo Class Members Table 11-2 Class Member Description GroupToken Token for the department. This data is found in the B_Groups table. Rank Group rank. Used for presenting multiple groups to a user. A rank of 1 displays first in a list.

  • Page 313

    IP address of source machine (optional - used for logging). Pass "" when address logging is not required. AuthResp Result of authentication attempt. (See CA50 Device User Authentication Process on page 11-5.) WSStatus UCAWebServiceStatus class describes the status of the call.

  • Page 314

    11 - 12 CA50/UCA Client & Server Developer & User Guide AuthenticateUser This function attempts to authenticate a CA50 device user. int AuthenticateUser(string sStoreNumber, string sUser, string ipAddr, ref AuthenticateResponse AuthResp, ref UCAWebServiceStatus WSStatus) Parameters sStoreNumber User’s store number. sUser User’s login ID.

  • Page 315

    UCA Server Optional APIs 11 - 13 AuthenticateUserPassword This function attempts to authenticate a CA50 device user and password. int AuthenticateUserPassword(string sStoreNumber, string sUser, string sPassword, string ipAddr, ref AuthenticateResponse AuthResp, ref UCAWebServiceStatus WSStatus) Parameters sStoreNumber User store number. sUser User login ID.

  • Page 316: Phone Extension Web Service

    This Web service can be used by external programs to modify the phone extension data in the UCA database. Phone Extension Web Service Methods This function adds a phone extension that can be used by a CA50 device. the extensions are added to the B_PhoneExt table.

  • Page 317

    UCA Server Optional APIs 11 - 15 phoneExtInfo Class Members phoneExtInfo Class Members Table 11-5 Class Member Description phnExtPhoneNumber Phone extension number. phnDesc Textual description of the phone extension. phnOwnerID UserID or MAC for static UCA assignment. phnRangeToken Token for department. Found in the B_Groups table. locExtID Store number.

  • Page 318

    11 - 16 CA50/UCA Client & Server Developer & User Guide Returns 1 when successful. Remarks Any errors are logged to the NT Event log. UpdateExtension This method updates phone extension information in the UCA system. The extension information is updated in the the B_PhoneExt table in the UCA database.

  • Page 319

    UCA Server Optional APIs 11 - 17 GetExtensionInfo This method retrieves phone extension information from the UCA system. The extension information is populated into the PhoneExtInfo class passed to the method. public int GetExtensionInfo(string locExtID, string sPhnExt, string ipAddr, string sUser, ref PhoneExtInfo phExtInfo, ref UCAWebServiceStatus WSStatus) Parameters locExtID...

  • Page 320: Group Management Web Service Methods

    11 - 18 CA50/UCA Client & Server Developer & User Guide Group Management Web Service Methods In the default installation the Group Management Web Service is located at: http://UCAInstallMachine/Motorola/UCA/ServerManagement/GroupManagement.asmx. This Web service can be used by external programs to modify the UCA group data in the UCA database.

  • Page 321

    UCA Server Optional APIs 11 - 19 GroupInfo Class Members GroupInfo Class Members Table 11-6 Class Member Description GroupToken Group ID. Must be unique. GroupName Group name for display purposes. GroupExtID Group number IsSelectable Is this group selectable by the user at login? RemoveGroup This method removes a group from the UCA system.

  • Page 322

    11 - 20 CA50/UCA Client & Server Developer & User Guide UpdateGroup This method updates a Group's information in the UCA system. The Group's information is updated in the B_Groups table in the UCA database. int UpdateGroup(string sStoreNumber, GroupInfo groupInfo, string ipAddr, string sUser,...

  • Page 323

    UCA Server Optional APIs 11 - 21 GetGroupInfo This method retrieves group information from the UCA system. public int GetGroupInfo(string sStoreNumber, string sGroupToken, string ipAddr, string sUser, ref PhoneExtInfo groupInfo, ref UCAWebServiceStatus WSStatus) Parameters sStoreNumber Store number. sGroupToken Group ID. Identifier for the Group. ipAddr IP address of source machine (optional - used for logging).

  • Page 324: Role Management Web Service Methods

    11 - 22 CA50/UCA Client & Server Developer & User Guide Role Management Web Service Methods In the default installation the Role Management Web Service is located at: http://UCAInstallMachine/Motorola/UCA/ServerManagement/RoleManagement.asmx. This Web service can be used by external programs to modify the UCA role data in the UCA database.

  • Page 325

    UCA Server Optional APIs 11 - 23 RoleInfo Class Members RoleInfo Class Members Table 11-7 Class Member Description RoleToken Role ID. Must be unique. RoleName Role name for display purpos.es RoleExtID Role number. RemoveRole This method removes a role from the UCA system. The roles are removed from the B_Roles table. int RemoveRole(string sStoreNumber, string sRoleToken, string ipAddr, string sUser, ref UCAWebServiceStatus WSStatus) Parameters...

  • Page 326

    11 - 24 CA50/UCA Client & Server Developer & User Guide UpdateRole This method updates a role's information in the UCA system. The role's information is updated in the B_Roles table in the UCA database. int UpdateRole(string sStoreNumber, RoleInfo roleInfo, string ipAddr, string sUser,...

  • Page 327

    UCA Server Optional APIs 11 - 25 GetRoleInfo This method retrieves role information from the UCA system. public int GetRoleInfo(string sStoreNumber, string sRoleToken, string ipAddr, string sUser, ref RoleInfo roleInfo, ref UCAWebServiceStatus WSStatus) Parameters sStoreNumber Store number. sRoleToken Role ID. Identifier for the Role. ipAddr IP address of source machine (optional - used for logging).

  • Page 328: Device Messaging Web Service

    Device Messaging Web Service In the default installation the Device Messaging Web Service is located at: http://UCAInstallMachine/Motorola/UCA/ServerManagement/DeviceMessaging.asmx. This Web service can be used by external programs to send an asynchronous message to a logged in CA50 device user. Device Messaging Web Service Methods SendNotification This method sends an asynchronous message to a CA50 device.

  • Page 329

    UCA Server Optional APIs 11 - 27 NotifDest Class Members NotifDest Class Members Table 11-8 Class Member Description sDestID Destination ID: UserID, IP address and group. This works with DestinationType. If eDestType is User, this param should be set to the UserID of the person to which the message is sent.

  • Page 330

    11 - 28 CA50/UCA Client & Server Developer & User Guide DynamicNotifParams Class Members DynamicNotifParams Class Members Table 11-9 Class Member Description Text Text to be displayed on the device. tone Path on the device for the tone to be played.

  • Page 331: User Management Web Service

    UCA Server Optional APIs 11 - 29 User Management Web Service In the default installation the UserManagement Web Service is located at: http://UCAInstallMachine/Motorola/UCA/ServerManagement/UserManagement.asmx. This Web service can be used by external programs to modify UCA user records in the UCA database. User Management Web Service Methods AddDeviceUser This method adds a device user to the UCA system.

  • Page 332

    11 - 30 CA50/UCA Client & Server Developer & User Guide Related Classes public class UserInfo public UserInfo(){} public string ExtUsrID; public string firstName; public string lastName; public string userName; public string RoleToken; public string locExtID; public string userStatus; public string userPhExtn;...

  • Page 333

    UCA Server Optional APIs 11 - 31 UserGroupInfo Class Members UserGroupInfo Class Members Table 11-11 Class Member Description GroupToken Token for the department. This data is found in the B_Groups table. Rank Group rank. Used for presenting multiple groups to a user. A rank of 1 displays first in a list.

  • Page 334

    11 - 32 CA50/UCA Client & Server Developer & User Guide RemoveDeviceUser This method removes a device user from the UCA system. The user is removed from the B_USER table in the UCA database. int RemoveDeviceUser(string sStoreNumber, string sUser, string ipAddr, ref UCAWebServiceStatus...

  • Page 335

    UCA Server Optional APIs 11 - 33 UpdateDeviceUser This method updates device user information in the UCA server system. The user’s information is updated in the B_USER table in the UCA database. int UpdateDeviceUser(UserInfo newUserInfo, string ipAddr, ref UCAWebServiceStatus WSStatus) Parameters UserInfo UserInfo class that describes the user (described above).

  • Page 336

    11 - 34 CA50/UCA Client & Server Developer & User Guide SetDeviceUserPIN This method sets a device user PIN in the UCA system. The user’s information is updated in the B_USER table in the UCA database. int SetDeviceUserPIN(string sStoreNumber, string sUser, string sPIN, string ipAddr,...

  • Page 337

    UCA Server Optional APIs 11 - 35 GetDeviceUserData This method retrieves user information from the UCA system. The user's information is updated in the UserInfo class passed to the method. int GetDeviceUserData(string sStoreNumber, string sUser, string ipAddr, ref UserInfo userInfo, ref UCAWebServiceStatus WSStatus) Parameters sStoreNumber...

  • Page 338

    11 - 36 CA50/UCA Client & Server Developer & User Guide AddConsoleUser This method adds a UCA Management Console user to the UCA system. The user is added into the B_USER table in the UCA database. int AddConsoleUser(ConsoleUserInfo userInfo, string sPassword, string ipAddr,...

  • Page 339

    UCA Server Optional APIs 11 - 37 ConsoleUserInfo Class Members ConsoleUserInfo Class Members Table 11-13 Class Member Description ExtUsrID User login ID. firstName User first name. lastName User last name. RoleToken Token representing user role (Admin, Manager). This data is found in the B_Roles table. userStatus User status (e.g., Active, Suspended, Disabled).

  • Page 340

    11 - 38 CA50/UCA Client & Server Developer & User Guide UpdateConsoleUser This method updates a console user's information in the UCA server system. int UpdateConsoleUser(ConsoleUserInfo newUserInfo, string ipAddr, ref UCAWebServiceStatus WSStatus) Parameters newUserInfo ConsoleUserInfo class that describes the user (see Table 11-13 on page 11-37).

  • Page 341

    UCA Server Optional APIs 11 - 39 SetConsoleUserPassword This method sets a console user's password in the UCA server system. Int SetConsoleUserPassword(string sUser, string sPassword, string ipAddr, ref UCAWebServiceStatus WSStatus) Parameters sUser Reference to a user's login ID. sPassword User password. ipAddr IP address of the source machine (optional - used for logging).

  • Page 342: Console User Authentication Web Service

    11 - 40 CA50/UCA Client & Server Developer & User Guide Console User Authentication Web Service In the default installation, the Console User Authentication Web Service is located at: http://UCAInstallMachine/Motorola/UCA/ServerManagement/Authentication/ManagementAuthentication.asmx. Console User Authentication Web Service Methods GetUserData This method retrieves user information from the UCA system. The user’s information is updated in the ConsoleUserInfo class passed to the method.

  • Page 343

    UCA Server Optional APIs 11 - 41 AuthenticateUserPassword This function attempts to authenticate a UCA console user and password. It only checks the validity of the username and password pair. int AuthenticateUserPassword(string sUser, string sPassword, string ipAddr, ref UCAWebServiceStatus WSStatus) Parameters sUser User login ID.

  • Page 344

    11 - 42 CA50/UCA Client & Server Developer & User Guide LoginConsoleUser This function attempts to authenticate a UCA console user and password. If authenticated, the console user's records in the UCA database are updated. int LoginConsoleUser(string sUser, string sPassword, string ipAddr, ref UCAWebServiceStatus WSStatus)

  • Page 345: Customizing The Console Login Process

    Change the UCAConsole Web.config Web reference to point to the new Console User Authentication Web Service. Motorola provides an example Console User Authentication Web Service (SampleConsoleAuth) with method stubs that can be used as a starting point for a customer or integrator creating a customized version.

  • Page 346: Uca Server Optional Api Samples

    11 - 44 CA50/UCA Client & Server Developer & User Guide UCA Server Optional API Samples Two sample programs that demonstrate using the UCA server optional APIs are provided: • UCA Messaging Sample - Uses the optional API to send asynchronous messages to all or individual users.

  • Page 347

    Description Store Number The default store number is "0002." User User ID of a logged in CA50 device user. This field can be blank if sending the message to all users. Message Message text to display on the device. Audio File Path of the .wav file to play on the device.

  • Page 348: Uca Phone Extension Sample

    11 - 46 CA50/UCA Client & Server Developer & User Guide UCA Messaging Sample Application - Screen Fields (Continued) Table 11-14 Field Description Visible Indicator Lights, color and blink rate to display. Vibrate Indicator Vibrate type. UCA Phone Extension Sample The compiled application is installed when Developer Install is selected at installation.

  • Page 349

    UCA Server Optional APIs 11 - 47 UCA Phone Extension Screen UCA Phone Extension Screen Sample. Figure 11-3 UCA Messaging Sample Application - Screen Fields Table 11-15 Field Description Store Number The default store number is "0002." Phone Extension Extension number to add. Group Organizational group to which the extension should be assigned.

  • Page 350

    11 - 48 CA50/UCA Client & Server Developer & User Guide (Page intentionally blank.)

  • Page 351

    UCA server. To upgrade the CA50 OS, UCA client application or other software components use MSP Provision functionality. One copy of the MSP 3.x server software (stage and provision functionality only) and its license certificate is provided free with the purchase of a UCA server software license.

  • Page 352: Staging And Deploying Ca50s

    UCA.settings.xml is an MSP settings profile that allows the user to configure the UCA client application on the CA50. Its settings consist of the server IP address, the store number, SSL configuration and a few Web service settings. The user can use these settings to generate RD bar codes so the UCA client application is able to communicate with the UCA server.

  • Page 353

    Web service name changes for the "ServerCheckIn" operation. The CA50 client application checks in with the UCA server if it is determined that the CA50 device went out of range and then back in range. This entry resides in UCAPlugInPersist.reg.

  • Page 354: Staging Process For A Ca50

    Staging Process for a CA50 The following steps explain how to stage the CA50 so that it enables the MSP, allows universal conditions, contains persistent network settings, relay server settings, UCA client settings and warm boot the device. Upon reboot the UCAClient application launches since its UCA settings are stored in the registry.

  • Page 355

    • Click the Finish button. • This UCA settings definition only applies to the UCA client application running on the CA50. • If the MSP server version is earlier than 3.1.1, the settings definition file should be downloaded from: http://support.symbol.com/support/product/softwaredownloads.do.

  • Page 356: Auto-launching The Uca Client Application

    Staging and Localization If the CA50 device is staged using MSP versions prior to MSP 3.2.1, the language option does not appear in the UCA settings and the CA50 device does not receive language information during the staging process. The CA50 login screen displays in English only.

  • Page 357: Os/uca Client Application Upgrades Pushed From Msp Provision

    By default, from the factory, the CA50 MSP agent is not enabled. The MSP agent running on the CA50 provides a means to automate the updating of CA50 software among other features.To enable the MSP agent running on the CA50 generate the appropriate Rapid Deployment bar code(s).

  • Page 358

    12 - 8 CA50/UCA Client & Server Developer & User Guide (Page intentionally blank.)

  • Page 359

    Chapter 13 Site Installation Guidelines Overview This chapter provides information for planning and preparing the UCA server and CA50 client for proper customer deployment. Valuable topics in this chapter include: • UCA server requirements (page 13-7) • Stages of planning and preparation...

  • Page 360: Site Installation Guidelines Overview

    The planning and preparation for customer deployment is a critical step in optimizing the implementation and utilizing details of the UCA server and the UCA client application on the CA50. It involves setting up the server to meet the exact needs of the customer. A server set up can range from basic configurations that include required customer settings and options to developing various custom business applications, a customer specific user authentication Web service and a PBX integration service.

  • Page 361: Decrease Roam Times Through A Channel Mask

    To decrease roam times the CA50 ships from the factory with a channel mask implemented. The channel mask, limits the scanned RF channels to a subset of the total available channels. By default, the CA50 ships with a channel mask enabling the use of only channels 1, 6 and 11. Total Available Channels Table 13-1 lists the available 802.11 a/b/g channels and the frequencies, not limited by regional constraints.

  • Page 362

    13 - 4 CA50/UCA Client & Server Developer & User Guide Allowable Channels, Users and Maximum Power Levels* Table 13-2 United Japan** China Israel Korea Frequency States Europe Singapore Channel (MHz) 20 MHz 20 MHz [10] 5035 5040 5045 5055...

  • Page 363

    Site Installation Guidelines 13 - 5 Allowable Channels, Users and Maximum Power Levels* (Continued) Table 13-2 United Japan** China Israel Korea Frequency States Europe Singapore Channel (MHz) 20 MHz 20 MHz [10] 5680 5700 5745 5765 5785 5805 5825 4915 4920 4925 4935...

  • Page 364: Battery Management

    To change the channel mask: Create a new reg key with the desired frequencies of the channels to scan. Name the reg key, channelmask.reg. Put this reg key into the CA50 \Application folder. For information about doing this in a deployment, see page 12-1.

  • Page 365: Uca Server Requirements

    The information below is required to present a phone book on the device that contains UCA users and callable non-UCA phones and phone services. • Phone extensions at a site that are available for assignment to a CA50. • Group (Departments) to which each UCA phone extension belongs.

  • Page 366: Stages Of Planning And Preparation

    13 - 8 CA50/UCA Client & Server Developer & User Guide Stages of Planning and Preparation Pre-deployment Activities - First Site There are several integration steps to take before deploying the first site. Develop a company-wide list of all Roles.

  • Page 367: Planning And Preparation Activities

    Install. Because they are separate authentication Web Services, the Device Users and Console Users can be independently redirected. For detailed information about the these optional APIs, see the following sections: • CA50 Device User Authentication Process on page 11-5 • Device User Authentication Web Service on page 11-8 •...

  • Page 368: Planning Pbx Integration

    Planning PBX Integration The CA50 must be assigned a phone extension. This requires the UCA server to be seeded with extensions that can be assigned to users at login time. In addition, the UCA server must be seeded with all phone numbers that an associate would need to call from a CA50.

  • Page 369

    NOTE 1. For a complete checklist outlining all the development and deployment activities required to implement a CA50 solution, see the Development and Deployment Checklist on page 2. For a table listing the most commonly requested topics within this manual, see the Quick Startup Guide...

  • Page 370: Maintaining The Uca Server

    14 - 2 CA50/UCA Client & Server Developer & User Guide Maintaining the UCA Server Maintaining an installed UCA server requires: • Scheduled data maintenance • Keeping system data and configuration up to date. Scheduled Data Maintenance There are some data maintenance tasks that the UCA server periodically performs. It exports and purges debug trace data and metrics data.

  • Page 371: Keeping System Data And Configuration Up To Date

    Maintaining the CA50 The degree of protection for the CA50 is specified by an ingress protection rating of IP 40 which is sufficient for retail applications but does not allow for the unit to be immersed in or soaked with liquid.

  • Page 372: Troubleshooting

    14 - 4 CA50/UCA Client & Server Developer & User Guide Troubleshooting UCA Server Installation/Uninstall Troubleshooting: UCA Server Install/Uninstall Table 14-1 Operating Symptom Cause Solution System Cannot load server software. Server 2003 Cannot load server software on a UCA Server Requirements and...

  • Page 373

    Maintenance, Troubleshooting and Error Messages 14 - 5 Troubleshooting: UCA Server Install/Uninstall (Continued) Table 14-1 Operating Symptom Cause Solution System Reinstalling on a target XP Pro SP2 The database files Uninstall the UCA instance of SQL machine that had a previous and Server SampleLookup.mdf and Server 2005 from Add/Remove...

  • Page 374: Ca50 Client

    14 - 6 CA50/UCA Client & Server Developer & User Guide CA50 Client Troubleshooting the CA50 Client Table 14-2 Problem Cause Solution Error logging in. Invalid bar code scanned. Scan another bar code to attempt log in again. An error screen displays...

  • Page 375

    Note: If the scanner is still not reading symbols, contact the distributor or the Motorola Global Customer Interaction Center. Removing Invalid Entries from Add/Remove Programs. If a program is uninstalled and the corresponding entry in the Add or Remove Programs listing was not removed.

  • Page 376

    The UCAClient application provides the means to generate a log file called UCAClient.txt in case there ever is a need to resolve an issue on the CA50 or on the UCA server. The contents of this log file are derived from two sources.

  • Page 377

    Maintenance, Troubleshooting and Error Messages 14 - 9 The AgentDebugLevel is the logging level for logic that is exercised to interface with the Agent part of the UCAClient application. Basically, the Agent part is logic that controls the desktop window, menus, the user profile, and logic that communicates with each module that is responsible for interfacing to a particular subsystem component.

  • Page 378

    NOTE The only way to disable the UCAClient application from generating a log file is to make the LoggingEnabled parameter a value of zero in the UCAClient.reg file and then reboot the CA50. Log settings contained in the XML profile override log settings in the UCAClient.reg file when a user profile is received from the UCA server.

  • Page 379: Ca50 Device

    05-03-2007, 05:44:51.26730 (000011ms), read cancelled 05-03-2007, 05:44:52.27831 (001101ms), cancel readnotify requestID= -1 notifpending=0 cancelpending=0 CA50 Device The CA50 contains several diagnostic applications that can be used to troubleshoot the CA50 device. Table 14-5 includes possible problems and the applications to use to help troubleshoot.

  • Page 380

    AP with a different country code or with no country code. Keys pressed on the CA50 do not operate. From the CA Menu, use the Up and Down arrow keys and press Scan/Select to select Programs > UCA KeyCheck. Press the keys on the CA50 to see if a key code is generated by every key press.

  • Page 381: Uca Server System Error Code Number Index

    The phone subsystem is not registered to a PBX server or for "Not registered" direct CA50-to-CA50 IP based call functionality. Check UCA server and PBX Server settings. If problem persists, report problem to help desk or to technical support.

  • Page 382

    14 - 14 CA50/UCA Client & Server Developer & User Guide Client Generated Error Messages (Continued) Table 14-6 Error Set Error Message Description Phone Related Errors This error indicates that an attempt was made to perform an “Not Implemented" operation with the phone subsystem but the operation is not (continued) implemented.

  • Page 383

    Maintenance, Troubleshooting and Error Messages 14 - 15 Client Generated Error Messages (Continued) Table 14-6 Error Set Error Message Description Server This message displays when a server request call was made “Waiting for Server Communication Response” and a programmable timeout occurred. The client is still active Related Error but it is waiting for a response from the server before continuing.

  • Page 384: Uca Server System Error Code Number Ranges

    14 - 16 CA50/UCA Client & Server Developer & User Guide UCA Server System Error Code Number Ranges General Errors General Error Ranges Table 14-7 Error Code Range Error Type Page 30000 - 30999 Phone Book 14-18 31000 - 31999...

  • Page 385: Uca Database Errors

    Maintenance, Troubleshooting and Error Messages 14 - 17 UCA Database Errors UCA Database Error Ranges Table 14-8 Error Code Range Error Type Page 70000 - 70499 Phone Book 14-34 70500 - 70999 Criteria Selection 71000 - 71499 Data Provider 71500 - 71999 DB Test 72000 -72499 Device...

  • Page 386: General Errors

    14 - 18 CA50/UCA Client & Server Developer & User Guide General Errors Phone Book Phone Book Errors Table 14-9 Error Code Description 50032 Exception occurred while getting the list of groups to be used for the phone book. Refer to the NT Event Log for more details.

  • Page 387

    Maintenance, Troubleshooting and Error Messages 14 - 19 Device Management Errors (Continued) Table 14-10 Error Code Description 51131 A data layer exception occurred while attempting to get the assigned store number for a given MAC address 51162 Could not retrieve the minimum client version for this version of UCA server from the database 51163 An Exception occurred.

  • Page 388

    14 - 20 CA50/UCA Client & Server Developer & User Guide XML Profile Errors (Continued) Table 14-11 Error Code Description 32036 No matching profile template found for given user login parameters. Refer to the NT Event Log for more detail.

  • Page 389

    Maintenance, Troubleshooting and Error Messages 14 - 21 XML Profile Errors (Continued) Table 14-11 Error Code Description 57205 An exception occurred while attempting to remove a profile. Refer to the NT Event Log for more details. 57234 A data layer exception occurred while attempting to get a list of all profile associations. Refer to the NT Event Log for more details.

  • Page 390

    14 - 22 CA50/UCA Client & Server Developer & User Guide DB Maintenance DB Maintenance Errors Table 14-13 Error Code Description 35031 Database level exception generated while purging Debug Trace. 35032 Exception occurred while exporting the Debug Trace. Refer to the NT Event Log for more details.

  • Page 391

    Maintenance, Troubleshooting and Error Messages 14 - 23 Phone Extension Management Phone Extension Management Errors Table 14-15 Error Code Description 53031 The specified phone extension already exists in the database. 53032 SCCP MAC cannot be NULL. 53034 A data layer exception occurred while attempting to add a phone extension. Refer to the NT Event Log for more details.

  • Page 392

    14 - 24 CA50/UCA Client & Server Developer & User Guide Phone Extension Management Errors (Continued) Table 14-15 Error Code Description 53165 An exception occurred while attempting to update a phone extension assignment. Refer to the NT Event Log for more details.

  • Page 393

    Maintenance, Troubleshooting and Error Messages 14 - 25 Phone Extension Management Errors (Continued) Table 14-15 Error Code Description 53332 An exception occurred while cleaning phone extension assignment Records. Refer to the NT Event Log for more details. 53333 Error occurred while getting the list of all phone extension assignments during phone extension maintenance.

  • Page 394

    14 - 26 CA50/UCA Client & Server Developer & User Guide User Authentication User Authentication Errors Table 14-16 Error Code Description 55031 A data layer exception occurred during user authentication 55033 The specified user was not found in the UCA database.

  • Page 395

    Maintenance, Troubleshooting and Error Messages 14 - 27 User Authentication Errors (Continued) Table 14-16 Error Code Description 55231 An error occurred while attempting to get information about the user. 55232 An exception occurred during the login process. Refer to the NT Event Log for more details. 55234 An error occurred while reading the login system variable.

  • Page 396

    14 - 28 CA50/UCA Client & Server Developer & User Guide Notification Errors (Continued) Table 14-17 Error Code Description 58138 An exception occurred while sending an asynchronous message. Refer to the NT Event Log for more details. 58163 An Argument exception occurred while processing notification fields for an asynchronous message.

  • Page 397

    Maintenance, Troubleshooting and Error Messages 14 - 29 Notification Errors (Continued) Table 14-17 Error Code Description 58366 An exception occurred while getting parameter info for an asynchronous message. Refer to the NT Event Log for more details. 58391 Unsupported route Type for Sending asynchronous message. Refer to the NT Event Log for more details.

  • Page 398

    14 - 30 CA50/UCA Client & Server Developer & User Guide Metrics Errors (Continued) Table 14-18 Error Code Description 59163 Error occurred while updating a user's login status. Could not add a metrics entry. Refer to the NT Event Log for more details.

  • Page 399

    Maintenance, Troubleshooting and Error Messages 14 - 31 Roles Roles Errors Table 14-20 Error Code Description 61031 The specified role already exists in the database. 61034 A data layer exception occurred while attempting to add a role. Refer to the NT Event Log for more details.

  • Page 400

    14 - 32 CA50/UCA Client & Server Developer & User Guide Server Logging Errors (Continued) Table 14-21 Error Code Description 61561 Database level exception generated while purging Debug Trace. 61591 Database level exception generated while purging the Debug Trace. 61592 Exception occurred while purging the Debug Trace.

  • Page 401

    Maintenance, Troubleshooting and Error Messages 14 - 33 Console Users Errors (Continued) Table 14-22 Error Code Description 62331 An exception occurred while attempting to update console user info. Refer to the NT Event log for more details. 62361 A data layer exception occurred while setting a console user's pin. 62362 The specified user was not found in the database.

  • Page 402

    14 - 34 CA50/UCA Client & Server Developer & User Guide UCA Database Errors Phone Book Phone Book Errors Table 14-24 Error Code Description 70011 Exception occurred while getting PB Group List. Refer to the NT Event Log for more details.

  • Page 403

    Maintenance, Troubleshooting and Error Messages 14 - 35 Phone Extension Errors Table 14-26 Error Code Description 73081 Exception occurred while removing an extension assignment. Refer to the NT Event Log for more details. 73091 Exception occurred while updating an extension assignment. Refer to the NT Event Log for more details.

  • Page 404

    14 - 36 CA50/UCA Client & Server Developer & User Guide User Authentication User Authentication Errors Table 14-28 Error Code Description 74521 Exception occurred while adding a device user. Refer to the NT Event Log for more details. 74531 Exception occurred while getting a device user. Refer to the NT Event Log for more details.

  • Page 405

    Maintenance, Troubleshooting and Error Messages 14 - 37 User Management Errors (Continued) Table 14-29 Error Code Description 75111 Exception occurred while updating a device user's activity timestamp in the cache. Refer to the NT Event Log for more details. 75121 Exception occurred while getting device user ID from cache by IP address.

  • Page 406

    14 - 38 CA50/UCA Client & Server Developer & User Guide XML Profile Errors (Continued) Table 14-31 Error Code Description 76041 Exception occurred while updating a base profile association by its ID. Refer to the NT Event Log for more details.

  • Page 407

    Maintenance, Troubleshooting and Error Messages 14 - 39 Groups Group Errors Table 14-35 Error Code Description 78511 Exception occurred while adding a group. Refer to the NT Event Log for more details. 78521 Exception occurred while getting a group. Refer to the NT Event Log for more details. 78531 Exception occurred while updating a group.

  • Page 408

    14 - 40 CA50/UCA Client & Server Developer & User Guide Server Files Server Files Errors Table 14-38 Error Code Description 89501 Exception occurred while configuring DB Maintenance. Refer to the NT Event Log for more details. 89502 Input file specified for CSV import was not found. Refer to the NT Event Log for more details.

  • Page 409

    Chapter 15 Localization Overview This chapter includes a description of the functionality of localized versions of the UCA client software on the CA50 device. Localization applies only to the UCA client. The UCA server continues to display the User Interface in English. The language setting is selected by the administrator during UCA server software installation.

  • Page 410: Uca Server Localization

    • First, last and common name • Groups • Roles. When installing UCA server software, the administrator chooses the appropriate language to display on CA50 devices from the Language ID drop-down list. UCA Server Installation - Language ID Figure 15-1...

  • Page 411: Ca50 Device Localization

    Localization of business applications is the responsibility of the integrator and/or developer. The Web pages in business applications should include UTF-8 encoding to support European languages supported by the CA50 device. The following meta tag should be included in all Web pages to ensure UTF-8 encoding.

  • Page 412: Installation

    English Staging Staging is the installation step for the CA50 device. There are separate BSP images for each locale with all the necessary font and culture settings. See Staging and Localization on page 12-6 for more information about staging.

  • Page 413: Appendix A Specifications

    Server: Microsoft Windows 2003 with .NET Framework 2.0 ® Symbol CA50: Microsoft Windows CE 5.0 Core (not accessible to developer or end-user) Memory 64MB SDRAM/32MB Strata Flash Interface/Communications Server: Symbol MSP, RD Client, Airbeam Symbol CA50: Full-Speed USB 1.1 Client...

  • Page 414

    A - 2 CA50/UCA Client & Server Developer & User Guide CA50 Client Specifications (Continued) Table A-1 Item Description User Environment Operating Temperature 14° F to 104° F / -10° C to +40° C Storage Temperature -40° F to 158° F / -40°C to +70°C...

  • Page 415

    Specifications A - 3 CA50 Client Specifications (Continued) Table A-1 Item Description Skew Tolerance Condition: 100% UPC at 5 in. ± 50° from normal Ambient Light Sunlight:10,000 ft. candles (107,640 lux) Artificial Light: 450 ft. candles (4,844 lux) Scan Repetition Rate 104 (±...

  • Page 416: Ca50 Accessory Specifications

    A - 4 CA50/UCA Client & Server Developer & User Guide CA50 Accessory Specifications Single-Slot Cradle Specifications Table A-2 Feature Description Dimensions 3.9 in. L x 3.2 in. W x 1.9 in. H (9.85 cm L x 8.23 cm W x 4.95 cm H) Weight 4.1 oz (115 g)

  • Page 417

    Specifications A - 5 Eight-Slot Spare Battery Charger Specifications Table A-4 Feature Description Dimensions 4.95 in. L x 5.50 in. W x 2.36 in. H (12.56 cm L x 13.96 cm W x 5.99 cm H) Weight 10.2 oz (286 g) Power 12 V Typical Wall Power...

  • Page 418

    A - 6 CA50/UCA Client & Server Developer & User Guide (Page intentionally blank.)

  • Page 419

    Appendix B Accessories Overview CA50 accessories provide a variety of product support capabilities. Accessories include USB cable, cradles, spare battery charger, wall mounts, lanyard, soft case and earbud. See Table B-1 for a full list of accessories and descriptions. NOTE 1.

  • Page 420: Accessories Summary

    CA50 for telephony, VoIP or audio playback applications. Upon insertion of an earbud jack, the CA50 automatically disables its internal speaker, microphone and receiver. The CA50 is compatible with standard off the shelf earbuds. Lanyard (with clip) Used to wear the CA50 around user’s neck.

  • Page 421: Eight-slot Ca50 Charging Cradle

    Eight-Slot CA50 Charging Cradle This section describes how to set up and use an eight-slot cradle with the device. NOTE 1. Only genuine Motorola batteries (p/n 82-83172-01) should be used with CA50 devices and charging accessories. 2. Use only an approved power supply KT-14000-148R output rated 12 Vdc and minimum 3.3 A with AC line cord 23844-00-00.

  • Page 422: Battery Charging Indications

    Batteries nominally take three hours to charge at ambient temperatures of 30° C or below. Charging Temperature Charging Temperature on page 3-7 for detailed information. RF Connectivity When a CA50 is inserted into a charging cradle, it maintains RF communication over the wireless network. NOTE CA50 cradles do not support wired ethernet communication.

  • Page 423: Single-slot Ca50 Charging Cradle With Spare Battery Charger

    Single-Slot CA50 Charging Cradle with Spare Battery Charger This section describes how to set up and use a single-slot cradle with the device. NOTE 1. Only genuine Motorola batteries (p/n 82-83172-01) should be used with CA50 devices and charging accessories.

  • Page 424: Charging The Battery

    B - 6 CA50/UCA Client & Server Developer & User Guide Charging the Battery Connect the cradle to power. Insert the CA50 into the device slot to begin charging. Charge Status LED Cradle Power Battery Charging Figure B-3 Charging the Spare Battery...

  • Page 425

    Power off. Charging Temperature Charging Temperature on page 3-7 for detailed information. RF Connectivity When a CA50 is inserted into a charging cradle, it maintains RF communication over the wireless network. NOTE CA50 cradles do not support wired ethernet communication.

  • Page 426: Eight-slot Spare Battery Charger

    Eight-Slot Spare Battery Charger This section describes how to use the eight-slot spare battery charger to charge up to eight spare batteries. NOTE 1. Only genuine Motorola batteries (p/n 82-83172-01) should be used with CA50 devices and charging accessories. 2. Use only an approved power supply KT-14000-148R output rated 12 Vdc and minimum 3.3 A with AC line cord 23844-00-00.

  • Page 427

    Accessories B - 9 Battery Charging Indications An LED is provided for each battery charging well. See Table B-3 for charging status indications. The battery fully charges in approximately three hours. Charging Temperature Charging Temperature on page 3-7 for detailed information. LED Indications LED Indications Table B-3...

  • Page 428: Earbud

    You can use a mono earbud for audio communication when using an audio-enabled application. To use an earbud, plug the earbud (2.5mm jack) into the mono audio connector on the side of the CA50. Plugging an earbud into the jack disables the internal speaker, microphone and receiver.

  • Page 429: Lanyard With Clip

    Accessories B - 11 Lanyard with Clip For ease of use, the CA50 can be attached to the lanyard with clip enabling the device to be worn around the neck as shown in Figure B-7. Wearing Lanyard Figure B-7 Attaching and Removing the Lanyard...

  • Page 430: Usb Cable

    USB Cable This section describes how to set up and use the cable. The USB cable is available to use for communication between the CA50 and a PC. It cannot be used to charge the battery in the CA50. Communication Setup To connect a device communication cable to a USB device: Connect the USB A end of the device communication cable to the communication port of the PC.

  • Page 431: Wall Mount Brackets

    Accessories B - 13 Wall Mount Brackets Two optional wall mount brackets are available for mounting a CA50 battery charger and/or a spare battery charger to a wall. • The KT-102376-01R wall mount bracket is used to mount one SAC5000-8000CR (eight-slot) battery charger.

  • Page 432

    B - 14 CA50/UCA Client & Server Developer & User Guide Mounting Instructions NOTE Connect an approved power supply to the cradle prior to attaching the cradle to the wall mount bracket. Eight-Slot Spare Battery Charger on page B-8 for power supply information.

  • Page 433: Kt-102375-01r Bracket

    Figure B-13 KT-102375-01R Bracket The KT-102375-01R bracket mounts one CHS5000-8000CR (eight-slot) CA50 charger, or two SAC5000-8000CR (eight-slot) spare battery chargers to a wall. Use the wall mount brackets as a template to mark the locations of the four mounting screws.

  • Page 434

    Eight-Slot CA50 Charging Cradle on page B-3 for power supply information. When mounting one eight-slot CA50 battery charger (CHS5000-8000CR), slide the four bracket mounting tabs into the receptacles on the bottom of the charger as shown in Figure B-14. Ensure the screw holes in the bracket flanges align with the screw holes in the cradle.

  • Page 435

    Accessories B - 17 Screw the bracket to the cradle(s). CHS5000-8000CR: Screw the two supplied .5” Phillips screws into the two bracket flanges and tighten until the cradle is securely attached to the bracket (as shown in drawing A, Figure B-16).

  • Page 436

    B - 18 CA50/UCA Client & Server Developer & User Guide (Page intentionally blank.)

  • Page 437

    Appendix C Enabling/Disabling Scanner Symbologies Overview This chapter describes the 1-dimensional symbologies supported by the SE950 scan engine in the CA50, and how to enable and change the parameters of the scanner symbologies. Enabling/Disabling Symbologies The CA50 has several symbologies enabled by default (page C-2).

  • Page 438: Supported Code Types

    Chinese 2 of 5 • Decode_Pointer • GS1 DataBar-14 GS1 DataBar Limited • • GS1 DataBar Expanded. Enabled Code Types The CA50 has the following code types enabled by default: UPC-E0 • • UPC-A • • EAN-8 • EAN-13 •...

  • Page 439: Configuring Symbologies

    Enabling/Disabling Scanner Symbologies C - 3 Configuring Symbologies Proprietary HTML elements allow business application developers to configure symbologies based on the application requirement. The UCA client supports proprietary HTML elements to enable the scanner, disable the scanner, and scan and read bar code data.UCA client also supports configuring the scanner symbologies and their parameters.

  • Page 440

    C - 4 CA50/UCA Client & Server Developer & User Guide Custom Meta Tags (Continued) Table C-1 Symbology Property Description Custom Tags Parameters Example: Code 128 Code128 The Code128 META Tag <META Enabled - enables <META is an action tag used to HTTP-Equiv="code128"...

  • Page 441

    Enabling/Disabling Scanner Symbologies C - 5 Custom Meta Tags (Continued) Table C-1 Symbology Property Description Custom Tags Parameters Example: Code39-VerifyCheckDigit <META True - enables <META Code39-VerifyCheckDigi HTTP-Equiv="code39-verifyc verifying of the HTTP-Equiv="code39-verifyc t META Tag is an action heckdigit" check digit heckdigit"...

  • Page 442

    C - 6 CA50/UCA Client & Server Developer & User Guide Custom Meta Tags (Continued) Table C-1 Symbology Property Description Custom Tags Parameters Example: Code39-Code32Prefix <META True - enables <META Code39-Code32Prefix HTTP-Equiv="code39-code3 reporting the Code HTTP-Equiv="code39-code3 META Tag is an action 2prefix"...

  • Page 443

    Enabling/Disabling Scanner Symbologies C - 7 Custom Meta Tags (Continued) Table C-1 Symbology Property Description Custom Tags Parameters Example: I2of5-Redundancy The I2of5-Redundancy <META True - enables the <META META Tag is an action HTTP-Equiv="i2of5-redundan property HTTP-Equiv="i2of5-redundan tag used to set the cy"...

  • Page 444

    C - 8 CA50/UCA Client & Server Developer & User Guide Custom Meta Tags (Continued) Table C-1 Symbology Property Description Custom Tags Parameters Example: Codabar-Redundancy <META True - enables the <META Codabar-Redundancy HTTP-Equiv="Codabar-redun property HTTP-Equiv="Codabar-redun META Tag is an action dancy"...

  • Page 445

    Enabling/Disabling Scanner Symbologies C - 9 Custom Meta Tags (Continued) Table C-1 Symbology Property Description Custom Tags Parameters Example: upce0-ConvertToupca <META True - enables <META upce0-ConvertToupca HTTP-Equiv="upce0-convertt conversion of HTTP-Equiv="upce0-convertt META Tag is an action oupca" UPC-E0 bar codes oupca" Content="true"> tag used to set the content="[parameter]">...

  • Page 446

    C - 10 CA50/UCA Client & Server Developer & User Guide Custom Meta Tags (Continued) Table C-1 Symbology Property Description Custom Tags Parameters Example: upca-preamble The upca-preamble <META PREAMBLE_NON <META META Tag is an action HTTP-Equiv="upca-preamble E no preamble. HTTP-Equiv="upca-preamble tag used to set the "...

  • Page 447

    Enabling/Disabling Scanner Symbologies C - 11 Custom Meta Tags (Continued) Table C-1 Symbology Property Description Custom Tags Parameters Example: Code11-CheckDigitCount <META code11_no_check <META Code11-CheckDigitCou HTTP-Equiv="code11-checkd _digit - verify no HTTP-Equiv="code11-checkd nt META Tag is an action igitcount" check digits igitcount" tag used to set the content="[parameter]">...

  • Page 448: Configuring Symbologies During The Login Process

    C - 12 CA50/UCA Client & Server Developer & User Guide Configuring Symbologies During the Login Process If the default login process of the UCA server is used, symbologies can be configured by embedding the appropriate META tags in the file scanner_symbologies.config located in C:\Inetpub\wwwroot\Motorola\UCA\Client\.

  • Page 449

    • Logging an employee into the UCA server. Upon completing this exercise, the user can use the CA50 to communicate via voice calls and walkie-talkie communication. This exercise does not enable price lookup. For a self contained pre-built demo that enables price lookup, voice...

  • Page 450: Outline Of Steps To Perform

    D - 2 CA50/UCA Client & Server Developer & User Guide Outline of Steps to Perform To get the CA50 Demo Solution running, perform the following steps: Review the required settings for this exercise ( page D-3). Set up the static IP on the server hardware ( page D-4).

  • Page 451: Step 1. Required Site Settings For This Exercise

    D - 3 Step 1. Required Site Settings for this Exercise Wireless Network Site Settings • Wireless ESSID: • Wireless Encryption: None (open) CA50 and UCA Server Settings • UCA Server Static IP Address: 192.168.0.253 • Store #ID: 0002 •...

  • Page 452: Step 2. Setup Static Ip On Server Hardware

    For this to occur, set the UCA server hardware to the UCA server static IP address above (192.168.0.253). • Ensure this IP address can be pinged through the wireless network using the CA50 for the ping testing (see UCAPing on page 4-27).

  • Page 453: Step 4. Validate Successful Server Installation On Laptop

    Deployment Example - UCA Server Install & Basic User Setup D - 5 Step 4. Validate Successful Server Installation on Laptop To verify the installation and configuration of the UCA server software follow the process documented in Validate Successful Server Installation and Proper Performance on page 6-45.

  • Page 454: Step 5. Create An Xml Profile Called "footwear.xml"

    Step 5. Create an XML Profile Called "Footwear.xml" A base XML profile is needed to build the baseline settings for CA50 users. When a CA50 user logs in to the UCA server, the UCA server searches the database for the user Role and/or Group information and selects which base XML profile to use.

  • Page 455

    Deployment Example - UCA Server Install & Basic User Setup D - 7 Save bpaSales.xml as Footwear.xml. Keep Footwear.xml in the same directory as bpaSales.xml. Do not delete bpaSales.xml. It is used by other applications.l UCA Server Profile Save Figure D-2 Go to the Walkie-Talkie Settings tab, select the check box for channel number 3 and click Remove to delete.l Channel Number Check Figure D-3...

  • Page 456

    D - 8 CA50/UCA Client & Server Developer & User Guide Click Add, to add the channel details. Enter the information. Channel Number: 3 Channel type : Default Channel Name : Footwear.l Add Channel Details Figure D-4 Click Apply to save the channel settings.

  • Page 457

    Deployment Example - UCA Server Install & Basic User Setup D - 9 Go to the Menus and Sub-menus tab and expand the menus tree. Right click on Applns (Applications) menu and select Add Server Action.l Add Server Action Figure D-5 A new sub-menu ServerAction1 appears under the Applns menu.

  • Page 458

    D - 10 CA50/UCA Client & Server Developer & User Guide Expand the WT Channels (SalesWTChannel) menu. Select My WT Settings and change the menu title to Footwear.l WT Settings Figure D-7...

  • Page 459: Step 6. Populate The Uca Server Database With 2 Users

    ExternalUser ID Barcode Login are added to the UCA server databases in the UCA server Web Console GUI. To add user information: Login to the UCA server Web Console GUI. • Go to: http://localhost/Motorola/UCA/UCAConsole/Login.aspx • Enter Username: admin • Enter Password: admin.

  • Page 460

    Create a Base XML profile association with the Role and Group. When the CA50 user logs into the UCA server, their role and/or group must be associated to a base XML profile. For this exercise, Footwear.xml was created for the association. (See Step 5.

  • Page 461

    Deployment Example - UCA Server Install & Basic User Setup D - 13 • Enter the field information shown in Figure D-10 and click Save. Profile Association Figure D-10 Create Phone Book Extensions based on Group. Create four phone extensions (extensions 10,11,12 and 13) for the Footwear Group. When the users in the Footwear Group login, they get one of these extensions.

  • Page 462

    D - 14 CA50/UCA Client & Server Developer & User Guide Create two users, User1 and User2, each with a Shoe Sales Role in the Footwear Group. • User1 is using the External UserID 1001. • User2 is using the External UserID 1002.

  • Page 463: Step 7. Generate Employee Login Bar Codes

    Deployment Example - UCA Server Install & Basic User Setup D - 15 Step 7. Generate Employee Login Bar Codes Generate a login bar code(s) using the newly created external User ID. Bar codes can be generated using off-the-shelf third party bar code generating software. This bar code is scanned in Step 8. For additional details on scanning a login bar code, see page 4-3.

  • Page 464: Step 8. Rf Network

    Pre-Built Demo (Step 5. Configure the RF Hardware on page E-5). The CA50 scans for access point transmissions on the RF channels specified for the country in which it is used. In the Americas, when the 802.11b/g radio is enabled the CA50 defaults to scanning the three non-overlapping radio channels 1, 6 and 11, which correspond to frequencies 2412 Mhz, 2437 Mhz and 2462 Mhz respectively.

  • Page 465: Create Rd Bar Codes For The Ca50

    Creating an MSP staging profile on page 12-5. Create RD Bar Codes for the CA50 To create RD bar codes for the CA50 in the Staging Profiles window: Click the Staging tab. Click Staging Profiles. Under Profile ID, on the CA50.Stage line, click Create under Barcode.

  • Page 466: Step 10. Deploy Ca50s

    Validate that the CA50 was Deployed Properly • From the CA Menu use the Up and Down keys to scroll and select Warm Boot to boot the CA50. NOTE To automate the warm boot of the device and automatically launch the UCA client application, see page 12-2.

  • Page 467

    Appendix E Self Contained Pre-Built Demo Overview The CA50 Demo is a self-contained pre-built solution that allows a user to quickly and easily demonstrate all major CA50 and UCA server functionality, such as: • Walkie-talkie communication • Voice calls •...

  • Page 468

    Optional - Modify the Demo Solution by adding a user (page E-18). Step 1. Hardware Required to Run the Demo Solution The following hardware is recommended for implementing the CA50 Demo Solution setup: • Computer to load UCA server software (not available from Motorola) •...

  • Page 469: Demo Solution System Diagram

    Self Contained Pre-Built Demo E - 3 Demo Solution System Diagram IMPORTANT For this setup, the static IP address of the laptop should be set to 192.168.0.253 before installing the UCA server software. The Demo Solution includes all the bar codes to set up and demonstrate three CA50s working with the hardware called out in Figure E-1 below.

  • Page 470

    Select the Use the following IP address button and enter the values above. Important Notes: The CA50 device must know where the UCA server IP address is for configuration via Rapid Deployment • bar codes. For this to occur, set the UCA server hardware to the UCA server static IP address above (192.168.0.253).

  • Page 471

    Self Contained Pre-Built Demo E - 5 Step 4. Validate Successful Server Installation on Laptop To verify the installation and configuration of the UCA server software follow the process documented in Validate Successful Server Installation and Proper Performance on page 6-45.

  • Page 472

    E - 6 CA50/UCA Client & Server Developer & User Guide For step-by-step instructions on how to configure the WS2000 and its AP follow the steps below. Connect the CAT 5 cable from the network port in the laptop to the WS2000 port 5 or 6, and provide power to the WS2000.

  • Page 473

    Self Contained Pre-Built Demo E - 7 On the left side of the window under [Network Configuration], click LAN > Subnet1 to configure the WS2000 LAN. Subnet1 Settings Figure E-3 Ensure the static IP address is set to 192.168.0.1 (factory default WS2000 setting). Ensure Ports 1 through 6 and WLAN1 are assigned to Subnet 1.

  • Page 474

    E - 8 CA50/UCA Client & Server Developer & User Guide On the left side of the window under [Network Configuration], select Wireless > WLAN1 to configure ESSID. WLAN1 - ESSID Figure E-4 In the ESSID field, change 101 to UCA.

  • Page 475

    Self Contained Pre-Built Demo E - 9 On the left side of the window under [Network Configuration], select [Access Ports] > 802.11 a/b/g Defaults > Beacon Settings to set DTIM values of 2. Beacon Settings Figure E-6 Change DTIM Per BSSID to 2. •...

  • Page 476

    E - 10 CA50/UCA Client & Server Developer & User Guide • Check Use Voice Prioritization for WLAN1. • Click Apply. The RF hardware is now configured for the Demo Solution. Close the browser. Before continuing, validate: • the laptop's static IP address is set to 192.168.0.253 •...

  • Page 477: Step 6: Scan Rapid Deployment Bar Codes To Deploy Ca50s

    Launch the Rapid Deployment client from the CA Menu. For step-by-step instructions, see Rapid Deployment on page F-1. Scan the 16 Rapid Deployment bar codes for the CA50 Demo Solution listed below. Scan these bar codes in the order they are listed.

  • Page 478

    E - 12 CA50/UCA Client & Server Developer & User Guide...

  • Page 479

    Self Contained Pre-Built Demo E - 13 When all bar codes have been scanned, the “Your Device is Ready to Use” message displays on the CA50. Press the right soft key to select OK. Staging Your Device is Ready to Use...

  • Page 480: Step 7: Scan Employee Login Bar Code

    E - 14 CA50/UCA Client & Server Developer & User Guide From the CA Menu use the Up and Down keys to scroll and select Warm Boot to boot the CA50. page NOTE To automate the warm boot of the device and automatically launch the UCA client application, see 12-2 The device CA50 is ready to use when the Scan bar code to log in displays.

  • Page 481

    Self Contained Pre-Built Demo E - 15 1 0 0 1 7 3 1 9 Anna Carter - Garden, Seasonal Sales (New Hire) Pin Code: None required 1 0 0 2 7 3 1 8 Kevin Smith - Bath, Electrical Sales (Dept.

  • Page 482: Front End Associates

    E - 16 CA50/UCA Client & Server Developer & User Guide Front End Associates 1 0 0 6 7 3 1 4 Joan Walker - Cashier Front End (Dept. Head) Pin Code: None required 1 0 0 7 7 3 1 3...

  • Page 483: Step 8: Ready To Demonstrate The Ca50 Voice And Scanning Functionality

    Step 8: Ready to Demonstrate the CA50 Voice and Scanning Functionality Upon scanning the log in bar code, the CA50 is ready to be used to demonstrate any of the following functionality. Employee Identity Validation: Scanning Employee Login Bar Code and entering PIN - for details see page •...

  • Page 484: Step 9. Modifying The Demo Solution: Creating New Users

    E - 18 CA50/UCA Client & Server Developer & User Guide Step 9. Modifying the Demo Solution: Creating New Users To create a new user for the Demo Solution using the UCA server Web Console GUI, see Step 6. Populate the UCA Server Database with 2 Users on page D-11.

  • Page 485

    Appendix F Rapid Deployment Overview The Rapid Deployment (RD) client on the CA50 client is used to scan staging bar codes. For details about the parameters contained within the RD bar codes, see Staging and Deploying CA50s on page 12-2.

  • Page 486

    Scanning on page 4-16). Upon a successful decode, a beep sounds and the CA50 LED blinks green. RD bar codes must be scanned in the appropriate order. After scanning all the Rapid Deployment bar codes the Processing windows display the status, such as device registration or network connection.

  • Page 487: Rapid Deployment Window Options

    About RD - Displays information about Rapid Deployment. Search network About RD Back Press the CA50 right soft key to go back to the previous window. Reset Cancels an operation or window and return to the start window. UCA floor...

  • Page 488

    F - 4 CA50/UCA Client & Server Developer & User Guide (Page intentionally blank.)

  • Page 489

    To communicate with host computer devices install Microsoft ActiveSync on the host computer. Use ActiveSync to manually update data on the CA50 client and synchronize information on the client with information on the host computer. Changes made on the client or host computer appear in both places after synchronization.

  • Page 490: Installing Activesync

    G - 2 CA50/UCA Client & Server Developer & User Guide Installing ActiveSync If ActiveSync is not already installed on the host computer, download the latest version of the software from the Microsoft Web site at http://www.microsoft.com. Refer to the installation and RAS instructions included with the ActiveSync software.

  • Page 491: Connecting To The Ca50

    To create a connection between the CA50 and host computer: Connect the small end of the USB cable to the CA50 client and the large end of the USB cable to the appropriate USB client port on the host computer.

  • Page 492

    G - 4 CA50/UCA Client & Server Developer & User Guide (Page intentionally blank.)

  • Page 493: Uca Backup & Restore

    Appendix H UCA Server Backup and Restore UCA Backup & Restore The UCA server backup and restore process allows an administrator to restore the UCA server configuration in the event of a system failure. It also allows an administrator to duplicate the configuration of a UCA server in production to use as a quick setup for other servers.

  • Page 494: Provide Database Credentials

    H - 2 CA50/UCA Client & Server Developer & User Guide Provide Database Credentials For all three operations (Backup, Restore and Reconfigure) provide the details of the database server IP address and SA password. • IP address: IP address of the database server. Since backup and restore runs on the same host as the UCA server, the default value of local host need not be changed.

  • Page 495: Restore The Uca Server

    H-2). Provide the UCA Database login credentials provided during the installation. Refer to section 6-12 of CA50/UCA Client & Server Developer & User Guide. Choose the backup archive by clicking Browse. Click Restore to begin restoring the UCA database and profiles.

  • Page 496: Reconfigure The Uca Server

    H - 4 CA50/UCA Client & Server Developer & User Guide Reconfigure the UCA Server The reconfiguration updates the UCA Server IP Address, Store ID, PBX IP Address, PBX Port Number, IIS Port Number and cleans the transient information present in database tables along with the UCA Users and Phone Extension table.

  • Page 497: Introduction

    Appendix I Business Applications Supplement Introduction This chapter provides examples and tips for writing business applications for the CA50 device.

  • Page 498: Adding A Menu Option

    In this example, the developer can provide an option to exit the UCAClient on the device and return to the CA50 menu (shell). To accomplish this, the developer must add an additional menu in the profile. To add a menu to the profile, use the following code structure: <Menu ID="1"...

  • Page 499: Launching A Business Application On Ucaclient Startup

    Sample Business Applications I - 3 Launching a Business Application on UCAClient Startup In this example, the developer can provide an option to launch a business application when the user logs into the UCAClient. No user action is needed. When the user logs in, the business application displays. To allow the developer to customize the URL to launch, an entry is provided in the profile xml called "AutoLaunchHotLink"...

  • Page 500: Setting The Html Page Title

    Setting the HTML Page Title Each business application page can display its own title on the first line of the display on the CA50 device. In this example, the developer must include the following meta tag in the business application.

  • Page 501: Enabling The Backlight For Html Pages

    I - 5 Enabling the BackLight for HTML Pages To enable a backlight on the CA50 device, the following meta tag must be added to the HTML page. By default, the backlight is disabled on all HTML pages. <meta http-equiv="bklight" content="ON"/>...

  • Page 502: Download Files To The Ca50 Device After User Login

    Download Files to the CA50 Device After User Login The UCAClient has the capability to download files from an HTTP server, to the CA50 device, at a point in time after user login. A menu option can be provided to allow the user to download files any time.

  • Page 503: Assigning A Default Value To The Spinboxcontrol

    I - 7 Assigning a Default Value to the SpinBoxControl To specify a default value for the SpinBoxControl displayed on the CA50 device, an additional attribute must be included in the HTML element for SpinBoxControl. (Also see Sample HTML Code - Add Spin Boxes/Post Quantity...

  • Page 504: Entering A Date In The Spin Box (html)

    I - 8 CA50/UCA Client & Server Developer & User Guide Sample HTML Code <body> <form method ="get" action="http://192.168.7.138/motorola/uca/samples/UCASampleApp/exitapplication.aspx" > <select type="select" style="font:14px Verdana; width:88px; border:0px" name="menu" id="menu" runat="server" size="3" autofocus> <option selected="selected" value="1">Work Stock</option> <option value="2">Move Cages</option> <option value="3">Manage Cage</option>...

  • Page 505: Scanning Item/enter Quantity Using Spin Boxes

    Sample HTML Code - Add Spin Boxes/Post Quantity to Server Enter a Quantity Using Spin Boxes Figure I-5 <body> <form method ="get" action="http://192.168.7.138/motorola/uca/samples/UCASampleApp/exitapplication.aspx" > <input type="submit" id="spinbox" name="USERID" SpinBoxLabel="Pepsi Cartons" SpinBoxLabelPos="beforespinbox" ShowArrows="no" SpinBoxLine="2" SpinBoxMaskDigit ="?" value="??"LeftBtnLbl ="Next#" RightBtnLbl ="Cancel"/> </form>...

  • Page 506: Adding And Enlarging Images/fonts

    I - 10 CA50/UCA Client & Server Developer & User Guide The code below includes a default value for the Spin box. <input type="submit" id="spinbox" name="USERID" SpinBoxLabel="Pepsi Cartons" SpinBoxLabelPos="beforespinbox" ShowArrows="no" SpinBoxLine="2" SpinBoxMaskDigit ="?" value="??" SpinBoxDefault="15" LeftBtnLbl ="Next#" RightBtnLbl ="Cancel"/> Adding and Enlarging Images/Fonts...

  • Page 507

    Sample Business Applications I - 11 Sample HTML Code - Add Image Add Image Figure I-7 <body> <form name="form1" method="get" action="http://192.168.7.138/motorola/uca/samples/UCASampleApp/exitapplication.aspx" id="form1"> <text align="center"><img src="tick2.jpg"> <br> <b>SCAN NEXT</b> </text> <input name="LeftSoftKey" type="submit" id="LeftSoftKey" value="Exit" /> <input name="RightSoftKey" type="button" id="RightSoftKey" value="" />...

  • Page 508: Enlarging Special Characters

    <input name="LeftSoftKey" type="submit" id="LeftSoftKey" value="Exit" /> <input name="RightSoftKey" type="button" id="RightSoftKey" value="" /> </form> </body> NOTE The HTML code used for the CA50 device screen displays supports many special characters/symbols, such as the currency pound symbol shown in Figure I-9. Note: Like pound, we can have other symbols as well.

  • Page 509: Led Settings (html Business Application)

    Sample Business Applications I - 13 LED Settings (HTML Business Application) Sample HTML Tag <meta http-equiv="visibleindicator" content="GreenFastBlink" /> LED Values Business Application LEDs Table I-2 Value Description RedSlowBlink Red LED blinks once every second. RedMedBlink Red LED blinks once every 1/2 second. RedFastBlink Red LED blinks once every 1/10 second.

  • Page 510

    I - 14 CA50/UCA Client & Server Developer & User Guide (Page intentionally blank.)

  • Page 511

    Appendix J Commands and Command Usage Introduction This chapter describes the commands available to developers and integrators which can be executed on the CA50 device. The chapter explains how the commands can be used in the profile, business applications and notification...

  • Page 512: Commands Usage In Profiles

    J - 2 CA50/UCA Client & Server Developer & User Guide Commands Usage in Profiles Profiles can be modified to customize menus displayed on the device. This section describes the commands and how to use them on CA50 menus. Profile Commands and Usage...

  • Page 513

    Commands and Uses J - 3 Profile Commands and Usage (Continued) Table J-1 Command Name Description Usage in Profile As Part of Menus QUIETMODE Put the device in Do not disturb mode. QuietMode:<Y/N> Example: Device Modes on page 4-33 <entry ID="5" value="Do Not details about Do not disturb mode.

  • Page 514: Commands Usage In Business Applications (html Pages)

    J - 4 CA50/UCA Client & Server Developer & User Guide Commands Usage in Business Applications (HTML Pages) Commands can be used in HTML based business applications to perform various user based functions. For example, a user can make a phone call from the business application.

  • Page 515

    Commands and Uses J - 5 Commands and HTML Usage (Continued) Table J-2 Element Description <input type="Command" This input element allows business application developers to define a name="SETCHANNEL" soft key for users to set the walkie-talkie channel. options="3:Normal" id="RightSoftKey" value="WTSetCh"/> input type="Command"...

  • Page 516

    J - 6 CA50/UCA Client & Server Developer & User Guide Commands and HTML Usage (Continued) Table J-2 Element Description <input type="Command" id="RightSoftKey" This input element allows business application developers to define a name="PHNPLACECALL" soft key for users to make a phone call.

  • Page 517

    Commands and Uses J - 7 Commands and HTML Usage (Continued) Table J-2 Element Description <input type="Command" This input element allows business application developers to define a name="PHONEHOLD" options="" soft key for users to put an active call on hold. id="RightSoftKey"...

  • Page 518

    J - 8 CA50/UCA Client & Server Developer & User Guide Commands and HTML Usage (Continued) Table J-2 Element Description <input type="Command" id="RightSoftKey" This input element allows business application developers to define a name="PHNTRANSFERCALL" soft key for users to transfer an active call to another user.

  • Page 519

    Commands and Uses J - 9 Commands and HTML Usage (Continued) Table J-2 Element Description <input type="Command" id="RightSoftKey" This input element allows business application developers to define a name="QUIETMODE" options="" soft key for users to put the device in Do not disturb mode. value="DND"/>...

  • Page 520

    J - 10 CA50/UCA Client & Server Developer & User Guide Commands and HTML Usage (Continued) Table J-2 Element Description <input type="Command" id="RightSoftKey" This input element allows business application developers to define a name="REBOOT" options="" soft key for users to cold boot the device.

  • Page 521

    Commands and Uses J - 11 Commands and HTML Usage (Continued) Table J-2 Element Description <input type="Command" id="RightSoftKey" This input element allows business application developers to define a name="SETBKLTLVL" options="4" soft key for users to set the backlight level on the device. Values range value="Set Bklt"/>...

  • Page 522

    J - 12 CA50/UCA Client & Server Developer & User Guide Commands and HTML Usage (Continued) Table J-2 Element Description <input type="Command" id="RightSoftKey" This input element allows business application developers to define a name="EXITCLIENT" options="1" soft key for users to exit the UCAClient and go to Shell menu.

  • Page 523

    Commands and Uses J - 13 Commands and HTML Usage (Continued) Table J-2 Element Description <input type="Command" id="RightSoftKey" This input element allows business application developers to define a name="DELETEALLDOWNLOADEDFILES soft key for users to delete all the files downloaded previously to the "...

  • Page 524: Commands Usage In Notification Messages

    Commands Usage in Notification Messages The SendNotification API is used to notify the CA50 device user of any information in text format. This can also be extended to a complex work flow application. In this context, commands can be used in the notification to execute a command on the device.

  • Page 525

    Commands and Uses J - 15 Commands Usage in Notification Messages Table J-3 Command Name Description Usage with Left and Right Soft Keys SETSCANMODE Set walkie-talkie into Scan mode. WTScan:S:L:SETSCANMODE Device Modes on page 4-33 for more information about WT channels and modes.

  • Page 526

    J - 16 CA50/UCA Client & Server Developer & User Guide Commands Usage in Notification Messages (Continued) Table J-3 Command Name Description Usage with Left and Right Soft Keys EXITCLIENT Exit the UCAClient and go to the Exit:S:L:ExitClient Shell Menu.

  • Page 527

    B_ConsoleUser table ..... . 11-37 single-slot CA50 charging cradle ... . B-5 B_Groups table .

  • Page 528

    ....10-6, 10-8 battery in CA50 ..... . . 3-8 vibrate device .

  • Page 529

    2 users ....D-11 single-slot CA50 charger ....B-5 required settings .

  • Page 530

    ..... . 14-3 disinfecting the CA50 ......14-3 inserting battery .

  • Page 531

    ..... . . 11-16 CA50 registry ......14-8 metricslog profile elements .

  • Page 532

    ....9-17 CA50 client ......5-1 editing additional extensions .

  • Page 533

    Index - 7 debuglog ......7-12 roles desktop ......7-7 creating .

  • Page 534

    ....... 6-47 starting CA50 ......3-11, 4-2...

  • Page 535

    System.Maintenance.DB.DebugTrace.DaysBetween CA50 client ......14-6 ....... 6-52 CA50 device diagnostic apps .

  • Page 536

    ......4-36 CA50 device ......iii parking .

  • Page 537

    Index - 11 System Status ......9-5 tools ....... . . 9-47 utilities delete .

  • Page 538

    Index - 12 CA50/UCA Client & Server Developer & User Guide...

  • Page 539: Tell Us What You Think

    We’d like to know what you think about this Manual. Please take a moment to fill out this questionnaire and fax this form to: (631) 627-7184, or mail to: Motorola One Motorola Plaza M/S B-10 Holtsville, NY 11742-1300 Attention: Technical Publications Manager IMPORTANT: If you need product support, please call the appropriate customer support number provided.

  • Page 542

    1-800-927-9626 http://www.motorola.com/enterprisemobility MOTOROLA and the Stylized M Logo and Symbol and the Symbol logo are registered in the U.S. Patent and Trademark Office. All other product or service names are the property of their registered owners. © Motorola, Inc. 2009...

Comments to this Manuals

Symbols: 0
Latest comments: