X–Lite 3.
CounterPath X-Lite 3.0 Copyright © 2006 CounterPath Solutions, Inc. CounterPath Solutions, Inc. Floor 8, 100 West Pender St. Vancouver, BC Canada V6B 1R8 Tel: 1.604.878.0440 www.counterpath.com sales@counterpath.com This document contains information proprietary to CounterPath Solutions, Inc., and shall not be used for engineering, design, procurement, or manufacture, in whole or in part, without the consent of CounterPath Solutions, Inc.
CounterPath X-Lite 3.0 1 Introduction 1.1 What is X-Lite? X–Lite 3.0 is CounterPath’s next-generation softphone client, offering users all the productivity of a traditional telephone with desktop and mobile computer enhancements. From a simple click of a mouse button or tap on the keyboard users can dial, answer, or otherwise manage calls and personal availability.
CounterPath X-Lite 3.0 2 Installation and Setup 2.
CounterPath X-Lite 3.
CounterPath X-Lite 3.0 Auto Update Upon startup, X-Lite will check for updates and—if found—will prompt users for authorization to install them. Uninstalling X-Lite Uninstall X-Lite like any other program: launch the Windows Control Panel from the Start menu, then select Add or Remove Programs. Follow the prompts. 2.3 Configuring X-Lite 1. Start X-Lite by using the Windows Start menu or by double-clicking the desktop icon. 2.
CounterPath X-Lite 3.0 1. Create the account: click at the top of the softphone and choose SIP Account Settings. Click Add. The Properties of Account window appears. 2. Under the Account tab, complete the fields within the User Details area. 3. For the remaining tabs, default settings are acceptable, or users can change them to suit a particular setup. Settings that may need immediate changes include: • Under the Account tab, fields within the Domain Proxy area.
CounterPath X-Lite 3.0 3 Using the Softphone 3.
CounterPath X-Lite 3.0 Display The following information and icons may appear on the Call display: When the phone is ringing with an incoming call, click here to ignore. X-Lite stops ringing, and a message appears to the remote caller advising that the call could not be established. When the phone is ringing with an incoming call, click here to send the call to voicemail. VoIP service providers have details about their voicemail options (i.e. voicemail is not part of X-Lite’s inherent functionality).
CounterPath X-Lite 3.0 Calls & Contacts Drawer To display the Contacts drawer, click the black button toward the extreme right edge of the softphone application. This drawer displays a user’s Contacts lists, lists of recent calls, and availability information (i.e. presence) for both the user and contacts. For more information, see page 15. 3.2 Starting X-Lite 1. Start X-Lite by using the Windows Start menu or by double-clicking the desktop icon.
CounterPath X-Lite 3.0 3.3 Placing a Call Users can place calls to a remote party using: • A SIP address (e.g. kpereira@domainabc.com) • A traditional phone number (if the VoIP service provider for the account supports PSTN gateways) Method Keying Description 1. Enter the SIP address or number in the Call display using the softphone keypad or the computer keyboard. • Enter the entire SIP username (kpereira@domainabc.com) or just the name (kpereira).
CounterPath X-Lite 3.0 X-Lite displays the SIP address of the person calling. If the SIP address for this person is also in the user’s Contacts list, X-Lite converts the SIP address into the display name associated with that address. Users can answer calls in any of three ways: • Click on the softphone or on the Call Alert box. • Click the appropriate line number on the softphone. • If X-Lite is the active application, press Enter on the keyboard.
CounterPath X-Lite 3.0 Call Record Click REC at any time to record a call. Click REC again to stop recording. X-Lite saves recordings as .wav files for audio and .avi files for video, placing them in the location specified under Options → Application. Call Information To view information such as the current codecs in use, hover over the line button (e.g. Line 1) on which the call is being made. Information appears as a tool tip.
CounterPath X-Lite 3.0 3.6 Conference Calls There are three ways to set up a conference call: • “Manual Setup: AA Off and AC Off”, below • “AA Off and AC On” on page 13 • “Conference Server Mode: AA on and AC On” on page 13. Manual Setup: AA Off and AC Off Users can host a conference by calling the other parties involved, or by allowing them to call in to the local softphone. Starting a Conference Call To host a conference between several callers: 1.
CounterPath X-Lite 3.0 Manual Answering & Automatic Conferencing: AA Off and AC On “Users answer calls manually and X-Lite adds each to the conference automatically.” 1. Click AC to enable auto-conferencing. 2. Answer the first call. There is no need to put the call on hold. 3. Answer the next call that comes in on the second line. X-Lite will create an automatic conference for the local user and both remote parties. • The conference gets established even if one line was on hold.
CounterPath X-Lite 3.0 Add to Contacts List At any time during a call, users can click on the Call display to add the remote party to their Contacts list. For information about the fields within the dialog box and about the Contacts list in general, see page 17. Multiple Conference Hosts An X-Lite conference call may include up to three individuals—the conference host plus a participant on each of the two available lines.
CounterPath X-Lite 3.0 4 Managing Calls and Contacts 4.1 Calls & Contacts Drawer To display the X-Lite Calls & Contacts drawer, click the black button toward the extreme right edge of the softphone application. Users can open (display) and close (hide) this drawer at any time using the same button. User availability. See page 22 Contacts. See page 16 Calls: received, dialed and blocked calls. See page 20.
CounterPath X-Lite 3.0 4.2 Contacts Tab Availability of the local user. See page 22. The Contacts menu The search field Availability of remote parties (color-coded). See page 25. The Contacts tab displays a user’s contacts and allows multiple contact methods for them, including: • • • • SIP address (softphone) Home phone number Cellphone number E-mail. Users can identify one of these contacts as the primary contact method. Users can phone any contact.
CounterPath X-Lite 3.0 Using Contacts Call a contact E-mail a contact for whom the user has designated a valid email address To use the person’s primary number, double-click or drag the contact to the Call display. To choose a specific number to use, right-click the contact and select Call, then click the desired number. Right-click and select Send E-mail. Send an IM to a contact who has a SIP address Right-click and select Instant Message.
CounterPath X-Lite 3.0 Contact Properties Dialog Box 1. Enter the desired information under the two tabs. 2. After clicking OK, X-Lite adds the contact to the group or groups specified and displays the designated primary contact method in the list. Table 1: Contact Properties Dialog Box Field Description Name Complete as desired. Display as Required. This is the name that will appear in the Call display and the Call Alert when this person phones. Group(s) Either: • Choose one group.
CounterPath X-Lite 3.0 Table 1: Contact Properties Dialog Box Field Contact Methods Description Enter as many contact methods as desired. E-mail and SIP entries must follow the format: @ If desired, change the primary contact method within the Contact Methods area. Show this contact’s Availability Check this box to obtain the contact’s availability for display within the Contacts list. This field is enabled only when at least one SIP address is specified for the contact.
CounterPath X-Lite 3.0 X-Lite exports all information from the Contacts list to Microsoft® Outlook®. Only information that can be displayed in Outlook® actually appears in the Outlook® contacts window. Typically, this means that X-Lite exports SIP addresses (stored in custom fields) but Outlook® does not display them all. • For other formats, X-Lite creates a new file of the specified type. 4.
CounterPath X-Lite 3.0 Managing Calls Lists Users can open and close each list to show or hide the contents. Icon Meaning The list is empty. There are calls in the list. There are calls in the list, at least one of which is an unanswered call. The list is expanded to show the contents. The list is expanded to show the contents, at least one of which is an unanswered call. The user answered the call. The user missed the call (i..e. the user was unavailable for or chose to ignore the call).
CounterPath X-Lite 3.0 4.4 Availability Availability refers to a user’s ability to see whether a remote contact is available or not (online, on phone, busy, etc.). X-Lite displays availability information within in the Calls & Contacts drawer. Users can publish their availability to contacts who have SIP addresses, and can configure X-Lite to view the availability of other contacts.
CounterPath X-Lite 3.0 Respond to the request: Button Next Action Allow Allow and add Result The remote party will be able to view local availability. X-Lite will add the remote party to the local user’s privacy rules with Show my Status set to “Yes. “ Users can change this rule later (see page 27). This button appears only if the remote party is The remote party will be able to view local availability.
CounterPath X-Lite 3.0 The following diagram illustrates how the sharing of availability occurs.
CounterPath X-Lite 3.0 Table 2: Availability Indicators Indicator Auto-detect Meaning for local Availability X-Lite will set the availability as appropriate, one of: Meaning for remote Availability Not applicable • Available — The user is logged in but is either not on the phone or idle. • On the phone — Appears as soon as the user places a call or answers a call. • Idle — The user has not moved/clicked the mouse or pressed a keyboard key for the Idle period.
CounterPath X-Lite 3.0 Privacy Rules Window Click at the top of the phone and select Privacy Rules. The window may show rules added during availability exchanges (see “Sharing Availability on page 22). Adding a Name or Domain 1. Click Add. 2. Complete the dialog box. If adding an individual (“Add rule for a person”), enter a SIP address. X-Lite fills in any omitted domains with the domain of the local user. If adding an entire domain (“Add rule for a domain”), enter the domain only.
CounterPath X-Lite 3.0 Changing Rules To change the settings for an existing name, click the cell to be changed. X-Lite changes the value (e.g. from “No” to “Yes”). Deleting an Entry Highlight the desired entry and click Delete. X-Lite deletes the entry. • If the rule was for a person who is either in the user’s Contacts list or has a contact list of their own that contains the user, X-Lite will display a New Contact Request for that person.
CounterPath X-Lite 3.0 5 Instant Messaging (IM) 5.1 Sending and Receiving an IM To display the IM window, right-click any entry in the Calls & Contacts drawer and select Instant Message. Type a message, including formatting as desired, then click Send. Conversation area Note: users can press Ctrl-F to search for specific text within a lengthy conversation.
CounterPath X-Lite 3.0 6 The X-Lite Menu Access the X-Lite menu by clicking at the top of the phone. The menu items include: • Options — options control the way users can work with X-Lite, and apply to all potential accounts (see “Options – General – Application” on page 30). • SIP Account Settings — these settings control how X-Lite interacts with a VoIP service provider (see page 42). • Privacy Rules — allows a user to control who may and who may not communicate with them (see page 25).
CounterPath X-Lite 3.0 6.1 Options Options are settings and preferences that apply to all potential accounts that a user might create.
CounterPath X-Lite 3.0 Table 3: Options – General – Application Field Description Always on top of other applications Check or uncheck to suit individual preferences. Launch when Windows starts Check or uncheck to suit individual preferences. Prompt when shutdown Check or uncheck to suit individual preferences. Turn letters into digits when typing into the phone Check or uncheck to suit individual preferences. Number of calls in each list Enter a number to suit individual preferences.
CounterPath X-Lite 3.0 Options – General – Alerts and Sounds On this page users can: • Manage custom ringtones. Users can import a ringtone (a .wav file), then play it to assess its worthiness. Users can activate one ringtone, and can delete any ringtone no longer desired. • Set up X-Lite to bring the softphone to the front automatically whenever a call comes in. • Set up X-Lite to display the Call Alert box (see right) when a call comes in (either always or only when the softphone is not visible).
CounterPath X-Lite 3.0 Options – General – Availability This screen lets users add status indicators to X-Lite’s standard Availability indicators. For more information about Availability, see page 22. • Users can set the Idle timer, which represents the time since the user last moved the mouse, clicked the mouse, or pressed a keyboard key. After the timer expires, X-Lite changes the user’s availability to “Idle.
CounterPath X-Lite 3.0 Options – General – Devices T Table 4: Options – General – Devices Headset Field Speaker device Microphone device Description Change these fields only to override the device that X-Lite’s zero touch device configuration selected (see Table 3 on page 31). In both these fields, select the appropriate headset device. The headset is the device that is usually used for audio out (sounds heard) and audio in (voice input).
CounterPath X-Lite 3.0 Table 4: Options – General – Devices Headset Field Use auto gain control (AGC) Description Adjusts the microphone volume level so that the remote party does not hear any distortions that may occur when a user sets their microphone input too high or their volume too low (due to too low input level). Typically on. Use noise reduction Attempts to remove background noise. Speakerphone Typically off for the headset.
CounterPath X-Lite 3.0 Options – Advanced – Audio Codecs This pane shows all the codecs that are available with X-Lite. Users can enable or disable codecs as desired. With only one codec enabled, all calls made will use that codec. With more than one codec enabled, X-Lite will choose the best codec to use based on the remote party’s capability, the available bandwidth, and current network conditions. Users cannot change the properties of any audio codecs.
CounterPath X-Lite 3.0 Supported Codecs X-Lite supports a wide range of codecs. See Table 5, below. Table 5: Audio Codecs Supported in X-Lite Codec Narrowband Wideband Broadvoice-32 3 Broadvoice-32 FEC 3 G.711aLaw * 3 G.711uLaw * 3 GSM 3 iLBC 3 L16 PCM Wideband 3 * Generally, one of these codecs must be enabled to place a PSTN (land line) call.
CounterPath X-Lite 3.0 Video codecs describe the format by which video streams are compressed for transmission over networks. Some codecs require less bandwidth than others, but may result in lower video quality. Users can enable or disable codecs as desired, even if a particular VoIP service provider supports the codec. With only one codec enabled, all calls made will use that particular compression format.
CounterPath X-Lite 3.0 Table 6: Options – Advanced – Network Field Network Connection Speed Description Complete this field only after disabling zero touch bandwidth detection (see Table 3 on page 31). Select the network connection type for the computer on which X-Lite is running. Preserve bandwidth during silence periods When this feature is enabled, X-Lite stops transmitting audio whenever the user stops talking.
CounterPath X-Lite 3.0 Options – Advanced – Quality of Service . The Quality of Service pane lets users request a specific transport service for audio, video and signaling traffic. There are two types of services: the proper service depends on what a user’s VoIP service provider supports: • GQoS, which is available for audio and video. • DSCP (also known as ToS), which is available for audio, video and signaling.
CounterPath X-Lite 3.0 X-Lite supports 802.1p QoS packet tagging. If users set up X-Lite for QoS, the client will include the specified information within packets that it sends to the network provider. Whether the packet is delivered using the specified service depends on whether or not the user’s broadband router and the network provider between the local and remote parties support multiple transport services (i.e.
CounterPath X-Lite 3.0 not remain logged in indefinitely while logging is enabled. Users should occasionally exit and restart X-Lite when logging application activity. If requested by a customer support representative, users can: • Open the logging folder and then open a log file using a standard text editor (e.g. Notepad). • E-mail the logs in the specified folder to customer support by clicking Send diagnostic logs. A dialog box appears showing all logs.
CounterPath X-Lite 3.0 Rules for Enabled Accounts and Default Account The following rules apply for enabled and default accounts: • With only one account enabled, that account becomes the default, by default. Users will be able to place and receive calls only on that account. • Users can never place calls on a disabled account. Placing a call that is only reachable through the service provider of a disabled account will fail with a “Not found” message.
CounterPath X-Lite 3.0 Table 8: Account Properties – Account User Details Field Display name Description This name shown in the X-Lite Call display. Remote parties in a call see this name in their phone’s display. User name Typically, this is the account number for the user’s SIP account (e.g. for kpereira@domainabc.com the user name is “kpereira”). VoIP service providers disclose this information to their customers.
CounterPath X-Lite 3.0 Account Properties – Voicemail These settings let users set up X-Lite to forward incoming calls. Service providers may offer voicemail support (e.g. they may offer customers a special number to dial or website to visit for retrieving voicemail messages). Check with the appropriate service provider to determine if they employ a different mechanism for forwarding incoming calls to voicemail. If so, check what their settings are and enter compatible information in X-Lite.
CounterPath X-Lite 3.0 Table 9: Account Properties – Voicemail Field Check for voicemail Description If a VoIP service offers voicemail, choose the setting they specify: • Checked: X-Lite will subscribe to be notified when there is voicemail. • Unchecked: the service provider may be set up to advise X-Lite when there is voicemail; check with the service provider for details. If a particular VoIP account does not include voicemail, uncheck this option.
CounterPath X-Lite 3.
CounterPath X-Lite 3.0 Table 10: Account Properties – Topology Firewall Traversal Field IP Address Description This setting controls how X-Lite presents IP addresses. • Discover global address: lets X-Lite determine the user’s public IP address. This is the recommended setting unless a VoIP service provider advises otherwise. • Use local IP address: uses the internal IP address of the computer running X-Lite. STUN Discovery This setting specifies the STUN server that X-Lite should use.
CounterPath X-Lite 3.0 Table 11: Account Properties – Presence Field Presence Mode Description Select the setting that the account’s service provider specified: • Disabled: Presence is not supported • Presence Agent • Peer-to-Peer. When selecting Presence Agent, users must also set the Storage method field (under the Storage tab) to XCAP. Poll Time Enter the value that the account’s service provider specified. The factory setting is 300.
CounterPath X-Lite 3.
CounterPath X-Lite 3.0 Account Properties – Advanced Table 12: Account Properties – Advanced Field Reregister every Description The time interval between X-Lite’s attempts to reregister (i.e. attempts to refresh the account registration with the VoIP service provider for the account). A value of zero means X-Lite should not attempt to reregister after the initial registration. This value is inserted into the “Expires” header field of X-Lite’s REGISTER message to the server. The factory setting is 3600.
CounterPath X-Lite 3.0 Table 12: Account Properties – Advanced Field Max. time Description This is the maximum wait time between attempts to reregister. Once this maximum is reached, X-Lite will wait this specified time before all subsequent attempts.
CounterPath X-Lite 3.0 6.3 Privacy Rules For information about privacy rules, see page 25. 6.4 Open Diagnostic Log and Folder For information about these menu items, see “Options – Advanced – Diagnostics” on page 41.
CounterPath X-Lite 3.
CounterPath X-Lite 3.0 Appendix B: Dialing Plans When a user places a call, X-Lite processes the input—what the user types, selects or drags onto the Call display—to modify the input as required for ensuring that the call succeeds. This ability to modify user input depends on the existence of a valid dialing plan for the account. X-Lite processes user input as follows: • Cleanup — X-Lite cleans up user input by removing spaces, dashes, and brackets.
CounterPath X-Lite 3.0 The dialing plan has the following syntax: pattern[|pattern];match=1;=;[match=2; =;] ...where: • Items contained within [] brackets are optional. • pattern — represents the pattern that X-Lite will match to user input. A dialing plan can have one or more patterns, with each pattern separated by a “|” (pipe character). The pipe is optional after the last pattern.
CounterPath X-Lite 3.0 To Specify a... Timer Enter the following... T Comment Indicates that a pause should take place before any further automatic dialing starts. Typical timer values are four seconds (4000 milliseconds). Dialing plan composers should use timers in at least the following situations: Any pattern that uses the “.” wildcard. For a pattern of “xxxx.
CounterPath X-Lite 3.0 Results of the Comparison Table 14: Comparing User Input With Dialing Plan Patterns Type of Match Conditions Result Partial match Digits and characters typed so far match a pattern If the user clicks or presses Enter, X-Lite performs no but there are not yet enough of them to verify a transformation. pending or complete match. If the user stops typing for the long timer length (twenty seconds), X-Lite performs no transformation on the characters typed so far.
CounterPath X-Lite 3.0 match=2;pre="9"; This portion of the dialing plan pattern specifies that X-Lite should prefix “9” to the user input whenever the input matches the second pattern (see above). match=3;pre="91"; This portion of the dialing plan pattern specifies that X-Lite should prefix a “9” and a “1” to the user input whenever the input matches the third pattern (see above).
CounterPath X-Lite 3.0 Appendix C: Contact List Headings Following is a list of all the headings that are used in the X-Lite contacts list. This list can be useful when formatting a contacts list for import into X-Lite.
CounterPath X-Lite 3.0 Appendix D: Location of Files System files get copied to the installation directory specified when installing X-Lite. The default installation directory is: C:\Program Files\CounterPath\X-Lite 3.0\ The installation directory contains: • the executable (x-lite.exe) • the folder emoticons\*.* • dll files, including those for supported codecs and devices. • unins000.exe for uninstalling X-Lite. • unins000.dat, which contains information about uninstalls of X-Lite. •uninstall.
CounterPath X-Lite 3.0 Appendix E: Alternative Ways to Run X-Lite From a Hyperlink People can create hyperlinks that reference a phone number or SIP address which, when an X-Lite user clicks the link, will start the softphone client and dial the number. Format such hyperlinks as follows: Click here to dial address or number For example: Click here to dial mgr@domainabc.
CounterPath X-Lite 3.0 Appendix F: Glossary AEC AGC AVI Broadband Codec Dialing plan DTMF IM IP IP address Media MWI Narrowband Presence Proxy PSTN Acoustic echo cancellation. Processing of audio data to reduce the echo effect that can arise if the sound from a speakerphone or headphone leaks into the microphone input device. Automatic gain control.
CounterPath X-Lite 3.0 RFC RTP Signaling SIMPLE protocol SIP SIP account SIP address TCP UDP URI URL USB device VAD vCard VoIP VoIP service provider WAV Request for Comment. A document that describes a particular internet technology. RFCs may be a proposals, drafts or full internet standards (IETF standards). Real-time Transport Protocol. A protocol for delivering the media portion of a data transmission over an IP network. SRTP is another media protocol.
