Page 2 - CounterPath eyeBeam 1.5; logo are trademarks of CounterPath Solutions Inc.
CounterPath eyeBeam 1.5 CounterPath Solutions, Inc.Floor 8, 100 West Pender St.Vancouver, BC Canada V6B 1R8Tel: [email protected] www.counterpath.com © April, 2006 This document contains information proprietary to Counterpath Solutions, Inc., and shall not be used for engineering, ...
Page 3 - Contents
CounterPath eyeBeam 1.5 i Contents Introduction ............................................................................................................................... 1 What is eyeBeam? ............................................................................................................
Page 4 - Introduction; Standard Telephone Features; • Support for the following video codecs:
CounterPath eyeBeam 1.5 1 1 Introduction 1.1 What is eyeBeam? CounterPath’s next generation telephony client, eyeBeam 1.5 lets you integrate your telephony experience with your desktop and mobile computer solutions. With the click of a button or the tap on the keyboard you can dial, answer, or choos...
Page 5 - Installation and Setup; Obtaining Information from your Service Provider; * value not used by all VoIP service providers; System Requirements
CounterPath eyeBeam 1.5 2 2 Installation and Setup 2.1 Getting Ready Obtaining Information from your Service Provider After choosing a VoIP service provider, you will need information regarding specific account information to populate eyeBeam settings: • User name• Password• Authorization Name• Doma...
Page 6 - Optimized Devices; eyeBeam is optimized to work with the following:; Video Cameras; Installing eyeBeam; At the final step of the wizard, select; Launch eyeBeam; to start using the softphone.; Uninstalling eyeBeam; Add or Remove Programs
CounterPath eyeBeam 1.5 3 Optimized Devices eyeBeam is optimized to work with the following: • Actiontec Internet Phone Wizard• Clarisys Claritel i750• GN Netcom GN 8120 USB and GN Netcom 8110 USBXP• Plantronics CS50-USB Wireless Office Headset System• TigerJet RJ11 to USB Phone Adaptor (incorporati...
Page 7 - Configuring eyeBeam; Windows Start; Initializing; Setting up Accounts
CounterPath eyeBeam 1.5 4 2.3 Configuring eyeBeam 1. Start eyeBeam as you would any other program: Use the Windows Start menu or double-click the desktop icon. The softphone appears. 2. When starting eyeBeam for the first time, you will be prompted for the license key. Type in the license key or cop...
Page 8 - Setting up for Voicemail; • If you want to be able to connect to voicemail by clicking; Number to dial for checking voicemail; on the Call; Number for sending calls to voicemail; Setting up a Contacts List; For general information on contacts, see “Contacts Tab” on page 17.
CounterPath eyeBeam 1.5 5 2.4 Setting up for Voicemail Your VoIP service provider may offer voicemail. If it does, then you can set up some voicemail features in eyeBeam. See “Account Properties – Voicemail” on page 46. In particularly: • If you want to be able to connect to voicemail by clicking on...
Page 9 - Using the Softphone; The Onscreen Phone
CounterPath eyeBeam 1.5 6 3 Using the Softphone 3.1 The Onscreen Phone Menu Close Availability Auto Answer, Auto ConferenceDo Not Disturb, Conference Hang up Speaker Control Microphone Control Dial Minimize Display and Dialpad Calls & Contacts Drawer Video Drawer Adjust Camera
Page 10 - to display the standard window for setting camera; Calls & Contacts Drawer
CounterPath eyeBeam 1.5 7 Display The following information and icons may appear on the Call display: Video Drawer This drawer appears only on versions of eyeBeam that include video functionality. To display this drawer, click the black button toward the extreme left edge of the softphone applicatio...
Page 11 - Ready. Your user name is; Showing and Hiding the Softphone
CounterPath eyeBeam 1.5 8 3.2 Starting eyeBeam 1. Start eyeBeam as you would any other program: Use the Windows Start menu or double-click the desktop icon. The softphone appears. 2. If you are prompted for a license key, then you have not yet set up eyeBeam. See “Configuring eyeBeam” on page 4. 3. ...
Page 12 - You can contact someone using:; Encryption; • If an encrypted call is established, the; Ending a Call; How; Microsoft® Outlook®
CounterPath eyeBeam 1.5 9 3.3 Placing a Call You can contact someone using: • The SIP address ([email protected])• A traditonal phone number, if supported by your VoIP service provider If you have turned on Call Alerts, the Call Alert box appears at the bottom of the screen. For information on tur...
Page 14 - While the Call Is in Progress; Start; Options; XFER
CounterPath eyeBeam 1.5 11 3.5 Handling a Call While the Call Is in Progress Video If your version of eyeBeam includes video, click Start on the Video drawer to send video to the other party. You will see the other party in the top video panel if they have enabled video at their end. Adjusting Volum...
Page 15 - Placing a Call on Hold; Send to Voicemail
CounterPath eyeBeam 1.5 12 4. Select the original line (the line that is red). The transfer is made and the lines on your softphone are now free (black). Placing a Call on Hold Click Hold or click the line or click another line. To resume a call that is on hold, click the line. AA – Auto Answer Clic...
Page 16 - Manual Setup: AA Off and AC Off; Starting a Conference Call
CounterPath eyeBeam 1.5 13 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 14• “Conference Server Mode: AA on and AC On” on page 14 Manual Setup: AA Off and AC Off You can host a conference by calling the o...
Page 17 - AA Off and AC On; AC; Conference Server Mode: AA on and AC On; “eyeBeam acts as a fully-automated conference server”; Changing the Mode; AA
CounterPath eyeBeam 1.5 14 AA Off and AC On “You answer calls manually and eyeBeam adds each to the conference automatically” 1. Click AC on. 2. Manually answer the first call. There is no need to put the call on hold. 3. When the next call comes in, on another line, answer the call. As soon as you ...
Page 18 - At any time during a call, you can click; Multiple Conference Hosts
CounterPath eyeBeam 1.5 15 Call Information To view information such as the current codecs, hover over the line button (for example, line 1) that the call is being made on. Information appears in the tool tip. Add to the Contacts List At any time during a call, you can click on the Call display to a...
Page 19 - Managing Calls and Contacts
CounterPath eyeBeam 1.5 16 4 Managing Calls and Contacts 4.1 Calls & Contacts Drawer To display the eyeBeam Calls & Contacts drawer, click the black button toward the extreme right edge of the softphone application. You can open (display) and close (hide) this drawer at any time. Your availa...
Page 20 - Changing the Contacts List View; Show Categorized; and choose; Show only contacts with availability
CounterPath eyeBeam 1.5 17 4.2 Contacts Tab The Contacts tab displays your contacts and lets you specify multiple contact methods for them, including: • SIP address (softphone)• Home phone number• Cellphone number• E-mail. You can identify one of these contacts as the primary contact method. You can...
Page 21 - Using Contacts; Adding, Deleting or Renaming Groups; Call
CounterPath eyeBeam 1.5 18 Using Contacts Managing Contacts Adding, Deleting or Renaming Groups Click the Contacts menu and choose Manage Groups .The Manage Groups dialog box appears. • To create a new group, click New Group , type a name, and press Enter. • To rename, click on the group so that onl...
Page 22 - Enter the desired information on the two tabs.; Select More
CounterPath eyeBeam 1.5 19 Contact Properties Dialog Box 1. Enter the desired information on the two tabs. 2. When you click OK, the contact is added to the specified group or groups, with the specified primary contact method displayed in the list. Table 1: Contact Properties Dialog Box Field Descri...
Page 23 - You can import a contacts list from:
CounterPath eyeBeam 1.5 20 Importing Contacts You can import a contacts list from: • A comma-separated file. Use this method to import from a Microsoft® Excel ® file. You will first have to set up the file; see below. • A Microsoft® Outlook® or Microsoft® Exchange contacts list (a *.pst file).• A vC...
Page 24 - There are three lists that show calls you have made and received:; Managing the Lists of Calls; You can open and close each list to show or hide its contents.; Calls; • Delete all entries from the list.; Icon
CounterPath eyeBeam 1.5 21 4.3 Calls Tab There are three lists that show calls you have made and received: • Missed Calls: incoming calls that you missed. • Received Calls: incoming calls, both answered and missed.• Dialed Calls: outgoing calls, both answered, unanswered and hung up.• Blocked: an in...
Page 25 - You can right-click on an entry in the Received or Dialed list to:
CounterPath eyeBeam 1.5 22 You can right-click on an entry in the Received or Dialed list to:
Page 26 - Sharing Availability; Watching Others’ Availability; Show this
CounterPath eyeBeam 1.5 23 4.4 Availability Availability refers to the ability to see whether a person is available or not: online, on phone, busy, and so on. Availability information is displayed in the Calls & Contacts drawer. You can publish your availability to contacts who have SIP addresse...
Page 27 - Respond to the request:; Button
CounterPath eyeBeam 1.5 24 Respond to the request: Button Next Action Result Allow The other person will be able to see your availability. The other person will be added to your privacy rules with “Show my Status” set to Yes. Allow and add This button appears only if the other person is not already ...
Page 29 - Setting your Availability; Changing your Availability; Availability Settings; Indicator; availability
CounterPath eyeBeam 1.5 26 Setting your Availability Changing your Availability Click the down arrow beside the status indicator, and select the desired availability. See Table 2, below. When your availability changes, the new availability is sent to everyone who has permission to see your availabil...
Page 30 - Privacy Rules Window; Adding a Name or Domain
CounterPath eyeBeam 1.5 27 4.5 Privacy Rules You can allow or ban another person from contacting you. There are separate rules for incoming phone calls, incoming instant messages, and availability detection. You can ban or allow an individual person, or an entire domain. You can also ban a person in...
Page 32 - Sending and Receiving an IM; Instant Message; You can press Ctrl-F to search for text in the large message area.; Adding the Remote Party to your Contacts List; You can click
CounterPath eyeBeam 1.5 29 5 Instant Messaging (IM) Sending and Receiving an IM To display the IM window, right-click any entry in the Calls & Contacts drawer and select Instant Message . 1. Type the message. Include emoticons and formatting, as desired. 2. Press Send. You can press Ctrl-F to se...
Page 33 - The eyeBeam Menu; Access the eyeBeam menu by clicking
CounterPath eyeBeam 1.5 30 6 The eyeBeam Menu Access the eyeBeam menu by clicking at the top of the phone. The menu items are: • Options. Options control the way that you work with eyeBeam and apply to all accounts. See “Options – General – Application” on page 31. • SIP Account Settings. These sett...
Page 34 - Options are settings and preferences that apply to all accounts.; Options – General – Application
CounterPath eyeBeam 1.5 31 6.1 Options Options are settings and preferences that apply to all accounts. Options – General – Application Table 3: Options – General – Application Field Description Always on top of other applications Click on or off, to suit your preference. Launch when Windows starts ...
Page 36 - Options – General – Alerts and Sounds; • Set up eyeBeam to bring the softphone to the front automatically
CounterPath eyeBeam 1.5 33 Options – General – Alerts and Sounds On this page you can:• Work with ringtones. You can import a ringtone (a . WAV file). You can play to try it out. You can activate one ringtone. You can delete a ringtone. • Set up eyeBeam to bring the softphone to the front automatica...
Page 37 - Options – General – Status; • You can edit or delete a custom indicator.
CounterPath eyeBeam 1.5 34 Options – General – Status This screen lets you add status indicators to the standard Availability indicators built into eyeBeam. For more information on availability, see page 23. • You can set the Idle timer. This is the time since you last moved or clicked the mouse or ...
Page 38 - Options – General – Device
CounterPath eyeBeam 1.5 35 Options – General – Device T Table 4: Options – General – Device Field Description Headset Speaker device Microphone device Change these fields only if you want to override the device selected by zero-touch device configuration (see page 31). In both these fields, select t...
Page 39 - Speakerphone
CounterPath eyeBeam 1.5 36 Speakerphone Speaker device Change this field only if you want to override the device selected by zero-touch device configuration (see page 31). Make the appropriate choice: • Select the device that you want to use for audio out (the sound you hear) when the Speaker Phone ...
Page 40 - Options – Advanced – Audio Codecs; You cannot change the properties of any codecs.; About Codecs; sampling rate of 8 KHz.; Supported Codecs
CounterPath eyeBeam 1.5 37 Options – Advanced – Audio Codecs This pane shows all the codecs that are included in the retail version of eyeBeam. You 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, eyeBeam auto...
Page 42 - Options – Advanced – Video Codecs
CounterPath eyeBeam 1.5 39 Options – Advanced – Video Codecs This pane appears only on versions of eyeBeam that include video functionality. Video codecs describe the format by which video streams are compressed for transmission over networks. Some codecs require less bandwidth than others, but may ...
Page 43 - Options – Advanced – Network
CounterPath eyeBeam 1.5 40 Options – Advanced – Network Table 6: Options – Advanced – Network Field Description Network connection speed Complete this field only if you have disabled zero-touch bandwidth detection (see page 31). Select the type of network connection for your computer. Preserve bandw...
Page 44 - Options – Advanced – Quality of Service; Second Edition
CounterPath eyeBeam 1.5 41 Options – Advanced – Quality of Service The Quality of Service pane lets you request a specific transport service for audio, video and signaling traffic. There are two types of services. The service to use depends on what your VoIP service provider supports: • GQoS, which ...
Page 45 - Options – Advanced – Diagnostics; Enable logging
CounterPath eyeBeam 1.5 42 Options – Advanced – Diagnostics This screen lets you enable logging to files. Logging uses computer resources, so you should only enable it when instructed by a customer support representative. To set up logging: 1. Click Enable logging . 2. Set the logging level. 3. Spec...
Page 46 - SIP Account Settings; To work with accounts, click; Properties; button, then see the following pages for; Enabling Accounts; Enable; box beside each account.; Setting the Default Account; Make Default; Rules for Enabled Accounts and Default Account; The rules for enabled and default accounts are:
CounterPath eyeBeam 1.5 43 6.2 SIP Account Settings SIP Accounts To work with accounts, click at the top of the phone and choose SIP Account Settings. The SIP Account window appears, showing all the accounts set up. Each account is automatically assigned a number: the first account in the list is 0,...
Page 47 - Account Properties – Account; VoIP; Domain Proxy
CounterPath eyeBeam 1.5 44 Account Properties – Account Table 8: Account Properties – Account Field Description User Details Display name This name is displayed in the eyeBeam display. Other parties will see this name they are when connnected to you. User name Typically the account number for the SI...
Page 49 - Account Properties – Voicemail
CounterPath eyeBeam 1.5 46 Account Properties – Voicemail These settings let you set up eyeBeam to forward calls in several situations. Your service provider may also provide the ability to set up for voicemail outside of eyeBeam, for example, by phoning a SIP address and following the voice prompts...
Page 51 - Account Properties – Topology
CounterPath eyeBeam 1.5 48 Account Properties – Topology
Page 53 - Account Properties – Presence
CounterPath eyeBeam 1.5 50 Account Properties – Presence This tab appears only for the default account. However, the values set on that tab apply to all accounts. In other words, presence as set up on this tab applies to all accounts, not just the default account. If you change the default account, ...
Page 54 - Account Properties – Storage
CounterPath eyeBeam 1.5 51 Account Properties – Storage This tab appears only for the default account. However, the values set on that tab apply to all accounts. In other words, storage as set up on this tab applies to all accounts, not just the default account. If you change the default account, th...
Page 55 - Account Properties – Security; Setting up for Security outside of eyeBeam
CounterPath eyeBeam 1.5 52 Account Properties – Security You can set up eyeBeam for the type of security (encryption) you want for incoming and outgoing calls. eyeBeam supports: • Signaling encryption using TLS • Media encryption using SRTP. Setting up for Security outside of eyeBeam When using TLS,...
Page 56 - may or may not be secure for other hops.; Setting up for Security within eyeBeam; Option; s for
CounterPath eyeBeam 1.5 53 Setting up the root certificate on your computer ensures that the connection to the proxy is TLS secure (the first hop). Any proxy in the chain (between you and the caller) that does not support TLS may cause an insecure link in the chain. Therefore, if the other party is ...
Page 59 - For information on privacy rules, see page 27.; Open Diagnostic Log and Folder
CounterPath eyeBeam 1.5 56 6.3 Privacy Rules For information on privacy rules, see page 27. 6.4 Open Diagnostic Log and Folder For information on these menu items, see “Options – Advanced – Diagnostics” on page 42.
Page 60 - Appendix A: Application Hot Keys; Function
CounterPath eyeBeam 1.5 57 Appendix A: Application Hot Keys Table 16: Application Hot Keys Function Keyboard Shortcut Select Line 1 F1 or Ctrl + 1 Select Line 2 F2 or Ctrl + 2 Select Line 3 F3 or Ctrl + 3 Select Line 4 F4 or Ctrl + 4 Select Line 5 F5 or Ctrl + 5 Select Line 6 F6 or Ctrl + 6 Options ...
Page 61 - Appendix B: Dialing Plan; The input is processed as follows:
CounterPath eyeBeam 1.5 58 Appendix B: Dialing Plan When a call attempt is made, the call input (what you type, select or drag onto the Call display) is processed to select the account to use and to modify the input if that is required to ensure that the call gets placed successfully. This ability t...
Page 62 - Pattern; Valid Content; There are two timers:
CounterPath eyeBeam 1.5 59 Pattern Valid Content The content for a pattern follows the digit map rules of RFC 2705, supplemented by the rules for regular expressions. Where there is an overlap between the digit map and regular expression rules, the digit map rules apply. For this reason, there are s...
Page 63 - B.2 How the Input Is Processed; Comparing Input to the Dialing Plan Patterns; in one of the types of matches described in the table below.
CounterPath eyeBeam 1.5 60 Transformation Keywords Order of Transformations These transformations are always performed in the following order (the order in which the transformations are entered in the dialing plan is not significant): prestrip > poststrip > pre > post > replace B.2 How t...
Page 64 - Results of the Comparison
CounterPath eyeBeam 1.5 61 Results of the Comparison B.3 Examples Example 1 \a\a.T|xxxxxxx.T;match=2;pre="9" This simple example shows how to differentiate between a PSTN number and a SIP address, and how to add a “9” dialing prefix only to the PSTN number. Example 2 3xxT|1xxxxxxxxxx|[2-9]xx...
Page 65 - Example 3; However, the example does illustrate two ideas:
CounterPath eyeBeam 1.5 62 Example 3 #1xxxxxxxT|#19xxxxxxx|xxxxxxxT|9xxxxxxx|;match=1;prestrip=2;pre=9;match=2; prestrip=2;match=3;pre=9; This example assumes that the dialing plan belongs to the first account. The dialing plan is slightly trivial, because it does not cover all the situations that a...
Page 66 - Appendix C: Contact List Headings
CounterPath eyeBeam 1.5 63 Appendix C: Contact List Headings Following is a list of all the headings that are used in the eyeBeam contacts list. This list can be useful when formatting a contacts list in order to import it into eyeBeam. For details, see “Importing Contacts” on page 20 uri business_n...
Page 67 - Appendix D: Location of Files; The directory contains:
CounterPath eyeBeam 1.5 64 Appendix D: Location of Files System files are copied to the install directory you specified when installing. The default install directory is: C:\Program Files\CounterPath\eyeBeam 1.5\ The directory contains: • the executable (eyeBeam.exe)• emoticons\*.*• eyeCall.dll, use...
Page 68 - Appendix E: Alternative Ways of Running eyeBeam; E.2 From the Command Line
CounterPath eyeBeam 1.5 65 Appendix E: Alternative Ways of Running eyeBeam E.1 From a Hyperlink You can attach a hyperlink to a phone number or SIP address that, when clicked, starts eyeBeam and dials the number. Attach a hyperlink with this format: <a href="sip:<address or number>"...