BTS Product Marketing Guidelines for Installing PhoneWare PhoneBook Manager Contents

PhoneWare Suite Overview ............................................................................................................................ 2 Introduction ...................................................................................................................................................... 3 Pre-requisites ................................................................................................................................................... 3 Installing PhoneBook Manager ...................................................................................................................... 3 Configuring the Installation ......................................................................................................................... 3 Express Option ........................................................................................................................................... 4 Custom Option ............................................................................................................................................ 5 Installation Process..................................................................................................................................... 7 Cancelling Setup .............................................................................................................................................. 8 Uninstalling PhoneBook Manager.................................................................................................................. 8 PhoneBook Manager Data Files ..................................................................................................................... 9 Configuring the POPI.INI File....................................................................................................................... 10 Config Items ................................................................................................................................................. 10 Shared Application Environment .................................................................................................................. 13 Log File ..................................................................................................................................................... 13 ATT.PBA ................................................................................................................................................... 13 PWADMIN.PBR ........................................................................................................................................ 13 Language...................................................................................................................................................... 14 More Details.................................................................................................................................................... 14 Version Control .............................................................................................................................................. 16

PhoneWare Suite Overview

PRODUCT NAME PhoneWare Operator Directory DESCRIPTION Search and browse facilities used by switchboard operators to locate personnel and improve the service given to incoming calls. Can be used in conjunction for call by name using BTS software drivers. PhoneWare Web Directory Search facilities from an Industry Standard Web Browser and designed to be used on a corporate (i.e. company-wide) basis. Based on a number of phonebooks, allows management of SQL Server data (additions, updates, deletions) used by Operator Directory or Corporate Directory applications. Not available to all PhoneWare users since access is by a different login. PhoneWare Web Layout Manager Provides system administrators with the ability to maintain the configuration of PhoneWare Web and manage screen layouts. The Import facility is a System Administrator function and provides the ability to insert data into a phonebook from a set of comma separated files. The Export facility provides the ability to export data from a phonebook to a file, which can then be used in another application.

PhoneWare Phonebook Manager

PhoneWare Import / Export Tool

Introduction
These guidelines assume that you have a client machine with Windows 2000 / Windows XP and MDAC 2.7 installed. N.B. Except where explicitly mentioned it is assumed that a SQL Server phonebook is being used.

Pre-requisites
You will need access to the PhoneWare PhoneBook Manager setup files and you should have read the "PhoneWare System Files" document.

Installing PhoneBook Manager

If using floppy disks containing the setup files, copy all setup files to an appropriate directory such as C:\PWINSTALL\PBM. Using File Manager, locate the directory where the setup.exe file is held Double click on setup.exe

Configuring the Installation

The user is asked to choose Express or Custom Set-up:

Unless you have a specific reason for using the custom option, you should always take the Express Option.

Express Option
Select the directory for PhoneWare data files. (NB This option will only appear if the directory has not been configured on the system previously.)

Express Set-up will automatically install PhoneWare PhoneBook Manager taking the default settings. Item Installation directory Start Menu Program Group Value <program files>\pbm PhoneWare

Click next on the opening screen to begin the express installation.

Custom Option
Custom Set-up prompts the user to accept or configure the default values as given in the last section. Select the directory for PhoneWare data files. (NB This option will only appear if the directory has not been configured on the system previously.)

Select the Installation Directory for the PhoneWare PhoneBook Manager Software:

Select the program group to install a shortcut to:

Click Next to begin the installation of the software:

Installation Process
A window showing the progress of the installation will appear:

After copying the files to the specified directory, set-up will display the message shown below:

You may also receive the following screen:

NB. You can choose to Restart the system at a later date if you are installing additional PhoneWare software, but you must restart before using the software.

Cancelling Setup
At any stage of the setup, the user can choose to exit. The files copied at the beginning of the setup process will be removed.

Uninstalling PhoneBook Manager

To remove the software installation on Windows 95/98 or NT 4.0, click on 'Start' and go to Settings/Control Panel. Double click on 'Add/Remove Programs', select the PhoneBook Manager software, and click on 'Remove'. The "uninstall" program will then run. In Windows 2000 or XP, go to Settings/Control Panel, select "Sigma PhoneWare PhoneBook Manager" and then click "Change and Remove". The "uninstall" program will then run.

You should choose Automatic when prompted for the uninstall method:

PhoneBook Manager Data Files

PhoneBook Manager uses the following files: File POPI.INI PWADMIN.PBR POPIEN32.LOG *.PBA *.ATI Default Location C:\bts\phoneware\ini\ C:\bts\phoneware\admin\wlm\ C:\bts\phoneware\logs\ C:\bts\phoneware\attach\ C:\bts\phoneware\attach\ Usage Configuration file PhoneBook List Log file Used to connect to a SQL Server Database Index of *.PBA files

The PhoneBook List can be changed by editing the configuration file, podo.ini as follows: [ConfigItems] PhoneBookList=c:\bts\phoneware\admin\pbm\pwadmin.pbr

Configuring the POPI.INI File

When PhoneBook Manager is run up, it references the POPI.INI file in the Windows directory. This file holds details of the PhoneBook to connect to and other configuration information. This INI file contains two sections: Config Items and Language. The Config Items determine how PhoneBook Manager is to work and the language is used to determine which language PhoneBook Manager will run in. Edit this file by using Config Chain Editor or by using a text editor.

Config Items
The following config items are available: Config Item
ApplicationTimeoutinMinutes CLIPopupEnabled

Description
This allows a value to be set which indicates the number of minutes of user inactivity before the application initiates a shutdown. Carrying out a search at the user interface resets the timeout value. This determines if the lines editor should show the salutation configuration dialogue and whether the group/hierarchy editor should show the colourset configuration controls. This is equivalent to Operator Directory's CLIPOPUP Permission Display all (True) rows or no (False) rows when search performed with no criteria for an MDB directory. Search field indices for an MDB directory. Sort index for an MDB directory. A negative value denotes a descending sort order. View fields for an MDB directory. Column widths for an MDB directory. Display all (True) rows or no (False) rows when search performed with no criteria for an SQL directory. Search field indices for an SQL directory. Sort index for an SQL directory. A negative value denotes a descending sort order. View fields for an SQL directory. Column widths for an SQL directory. This config item determines if PBM should show the alternate view configuration dialogue. This flag is equivalent to the ALTVIEW permission for the Operator Directory. Display all (True) rows or no (False) rows when search performed with no criteria for the Extensions tab. Search field indices for the Extensions tab. Sort index for the Extensions tab. A negative value denotes a descending sort order. View fields for the Extensions tab. Column widths for the Extensions tab. Display all (True) rows or no (False) rows when search performed with no criteria for field mappings. Search field indices for field mappings. Sort index for the field mappings. A negative value denotes a descending sort order. View fields for the field mappings. Column widths for the field mappings. Display all (True) rows or no (False) rows when search performed with no criteria for Groups. Search field indices for Groups. Sort index for Groups. A negative value denotes a descending sort order. View fields for Groups. Column widths for Groups. Display all (True) rows or no (False) rows when search performed with no criteria for Hierarchies. Search field indices for Hierarchies. Sort index for Hierarchies. A negative value denotes a descending sort order.

Permitted Values
1 - 2000000 TRUE/FALSE

DirMDBAll DirMDBSearch DirMDBSort DirMDBView DirMDBWidth DirSQLAll DirSQLSearch DirSQLSort DirSQLView DirSQLWidth EnableAlternateView ExtnAll ExtnSearch ExtnSort ExtnView ExtnWidth FieldMapAll FieldMapSearch FieldMapSort FieldMapView FieldMapWidth GroupAll GroupSearch GroupSort GroupView GroupWidth HierAll HierSearch HierSort

TRUE/FALSE Text Text Text Text TRUE/FALSE Text Text Text Text TRUE/FALSE TRUE/FALSE Text Text Text Text TRUE/FALSE Text Text Text Text TRUE/FALSE Text Text Text Text TRUE/FALSE Text Text

10

HierView HierWidth LinesAll LinesSearch LinesSort LinesView LinesWidth LinkAll LinkSearch LinkSort LinkView LinkWidth MapAll MapSearch MapSort MapView MapWidth PhoneBookList PokingSearchField

View fields for Hierarchies. Column widths for Hierarchies. Display all (True) rows or no (False) rows when search performed with no criteria for the Lines tab. Search field indices for the Lines tab. Sort index for the Lines tab. A negative value denotes a descending sort order. View fields for the Lines tab. Column widths for the Lines tab. Display all (True) rows or no (False) rows when search performed with no criteria for the Access Codes tab. Search field indices for the Access Codes tab. Sort index for the Access Codes tab. A negative value denotes a descending sort order. View fields for the Access Codes tab. Column widths for the Access Codes tab. Display all (True) rows or no (False) rows when search performed with no criteria for the Mappings tab. Search field indices for the Mappings tab. Sort index for the Mappings tab. A negative value denotes a descending sort order. View fields for the Mappings tab. Column widths for the Mappings tab. Directory path for the admin file PWADMIN.PBR Nominates a string field which will be set with program determined data when the shortcut CmdPokeData is triggered. Default: 66

Text Text TRUE/FALSE Text Text Text Text TRUE/FALSE Text Text Text Text TRUE/FALSE Text Text Text Text Text 59 Group1 61 Group2 63 Group3 65 Hierarchy1 66 Hierarchy2 67 Hierarchy3 68 Hierarchy4 69 Hierarchy5 Text 0 - Separate fields with Tab character. 1 - Use the database field widths. 2 - Use fixed width for all fields. 0 100000 Text 0 - Use the long field mapping name. 1 - Use the short field mapping name. 2 - Use the database field name. -1 - No headings 0 - Single heading at the start of the file >0 [n] < 1,000,000 - Print a heading every [n] lines. 0 - 1000000 0 - 1000000 Text TRUE/FALSE TRUE/FALSE Text Text Text Text Text Text Text Text Text Text

PrimaryViewName PrintFieldSeparate

Used to set the first view name of the Alternate Views Determines how each of the fields on a single printed line will be separated.

PrintFieldWidth PrintFileName PrintHeadFormat

Field width (only used when PrintFieldSeparate is set to a value of 2). Name of file used for the Print to file function. How to name the fields in the heading.

PrintHeadFrequency

How often the header is printed

PrintHeadGap PrintRecordGap SecondaryViewName SiteAll SiteGroupAll SiteGroupSearch SiteGroupSort SiteGroupView SiteGroupWidth SiteSearch SiteSort SiteView SiteWidth ViewFields ViewFieldWidths

The number of blank lines printed before each heading. The number of blank lines printed before each record. Used to set the second view name of the Alternate Views All or nothing flag for the Sites tab. All or nothing flag for the Site Groups tab. Search field indices for the Site Groups tab. Sort index for the Site Groups tab. A negative value denotes a descending sort order. View fields for the Site Groups tab. Column widths for the Site Groups tab. Search field indices for the Sites tab. Sort index for the Sites tab. A negative value denotes a descending sort order. View fields for the Sites tab. Column widths for the Sites tab. A comma delimited list of field indexes for the fields shown in the grid. This item is only used when either the LAYOUT or LAYOUTGEN permission is denied. A comma delimited list of field widths for the fields shown in the grid, expressed in the multiples of the width of a lower case 'y' character in the

11

VoiceDivisionAll VoiceDivisionSearch VoiceDivisionSort VoiceDivisionView VoiceDivisionWidth VoiceMDBAll VoiceMDBSearch VoiceMDBSort VoiceMDBView VoiceMDBWidth VoiceSQLAll VoiceSQLSearch VoiceSQLSort VoiceSQLView VoiceSQLWidth

current font. This item is only used when either the LAYOUT or LAYOUTGEN permission is denied. Display all (True) rows or no (False) rows when search performed with no criteria for the VoiceDivision tab. Search field indices for the VoiceDivision tab. Sort index for the VoiceDivision tab. A negative value denotes a descending sort order. View fields for the VoiceDivision tab. Column widths for the VoiceDivision tab. Display all (True) rows or no (False) rows when search performed with no criteria for an MDB directory with voice data. Search field indices for an MDB directory with voice data. Sort index for an MDB directory with voice data. A negative value denotes a descending sort order. View fields for an MDB directory with voice data. Column widths for an MDB directory with voice data. Display all (True) rows or no (False) rows when search performed with no criteria for an SQL directory with voice data. Search field indices for an SQL directory with voice data. Sort index for an SQL directory with voice data. A negative value denotes a descending sort order. View fields for an SQL directory with voice data. Column widths for an SQL directory with voice data.

TRUE/FALSE Text Text Text Text TRUE/FALSE Text Text Text Text TRUE/FALSE Text Text Text Text

12

Shared Application Environment

Note that the shared application environment settings will override the PhoneWare data file settings.

Log File
To specify a different Log File to the default one, add the following section to POPI.INI [Log] LogFileName=f:\shared\machine1.log This means (e.g.) that several operators may use the same copy of the executable (stored on the server) and still each maintain a separate unique log file. Alternatively, if individual executables are being run on the client machines the log files may be written to the server machine. This feature is especially useful where dial-up access is only available on a single machine. All the log files may be written to this machine, so that service/support may gain easy access to help fault-find any problems.

ATT.PBA
To specify a different attached database file to the default one, add the following section to POPI.INI [AttDBPath] AttDBPath=f:\shared\att.pba This will be required if you are setting up PhoneBook Manager in a shared application environment

PWADMIN.PBR
This is configured using the configitem PhoneBookList as described in a previous section.

13

Language
The full list of options is: Danish Dutch English French German Italian Portuguese Spanish Swedish DA NL EN FR DE IT PT ES SV

A default language can be set by adding the following section to the POPI.INI file: [Language] Display=EN NB. The language can be subsequently changed in PhoneBook Manager by selecting the appropriate language from the Tools Menu -> Change Language Option.

Common PhoneBook Manager Options Alternate Views

Alternate View is a feature of PhoneWare allows the user to switch between 2 sets of results fields in PhoneWare. This feature can be particularly useful if the user wants more results fields than can physically be located on the screen. In this case a second set of view fields could be configured and the user could hot-key between the 2 views. The Alternate View can also be configured to allow a search to be performed automatically an incoming CLI event is received. This feature is used in conjunction with the CLI Popup functionality. These features could be used for an organisation that wants to answer calls for each of its offices at a central point but to only search for people at a particular office. In this example when a call is answered a CLI event would be generated and a search would be performed for entries that relate to that particular office. The EnableAlternateView configitem should be set. This is done by inserting the following into the configuration file [configitems] EnableAlternateView=True The Alternate View model has two views. These are PrimaryViewName and SecondaryViewName. The default values are "Staff" and "Service". If the customer wishes to use values other than these, entries must also be added to the configuration file: [configitems] PrimaryViewName=Standard SecondaryViewName=Enhanced A note should be made of the Shortcut for CmdToggleResultsView (Default is CTRL+Q) that appears in the mappings tab. This is then used in Operator Directory to toggle between the Primary and Secondary Views when not using CLI Popup.

14

CLI Popup
CLI Popup is a feature of PhoneWare that presents additional information about incoming callers. It is an optional component of PhoneWare and is not enabled for all customers. The principle of CLI Popup is that when an Operator answers a call a Window is presented which shows the number presented, a description and a sometimes a salutation. It is an optional component of PhoneWare and is not enabled for all customers. To edit the CLI Popup Salutations and formatting in PhoneBook Manager set the CLIPopupEnabled configitem to True. You will also need to configure the PhoneBook for CLIPopup: CLI Popup has a number of configuration options which determine how it will operate. The first thing that needs to be decided is which PhoneBook will be used for CLI Lookups. When this has be selected the following PhoneBook Properties must be set. PhoneBook Property CLIPopupPresentationGroupTable Values Group1 Group2* Group3 Hier1 Hier2 Hier3 Hier4 Hier5 (*default) Person Line* (*default) CLIPopupRetainFocus True* False (*default) Desciption The colours which are used for the CLI Popup window are defined on a per group/hierarchy entry basis. This PhoneBook Property allows you to select which group/hierarchy should be used to store this information.

CLILineDescriptionType

The information presented for the CLI is looked up in both the directory and lines tables. In the event that there are matches in both tables this ConfigItem defines which one should be used. When a CLI Window is displayed it will retain focus i.e. you will not be able to key anything into PhoneWare Operator until it is closed. If the user requires the CLI to be displayed and be able to use PhoneWare Operator for searching at the same time then this Config Item must be set to False. Note. If the Focus is returned to Operator then the CLI Popup Window needs to be configured so that it does not appear over the operator screen.

See the PhoneBook Manager Getting Started Guide and Operator Directory documentation for more details on CLI Popup

Application Timeout
This allows a value to be set which indicates the number of minutes of user inactivity before the application initiates a shutdown. Carrying out a search at the user interface resets the timeout value. It is an optional component of PhoneWare and is not enabled for all customers. To configure, add the configitem ApplicationTimeout to the PhoneBook Manager Configuration file.

15

More Details
For details on the operation of PhoneWare PhoneBook Manager please refer to the PhoneWare PhoneBook Manager Getting Started Guide

Version Control
When 6/8/98 8/9/99 11/11/99 9/6/00 14/8/00 17/10/00 15/02/01 10/04/01 30/10/02 Who ABM ABM ABM ABM ABM ABM ABM ABM ABM What Existing Version numbered Formatted and updated Updated for version 169 Updated for version 172 Updated for Windows 2000 Updated for version 173 Updated for version 174 Further updates for PhoneWare Options Updated for version 175 Version 0-1-0 1-0-0 1-1-0 1-2-0 1-3-0 1-7-3 1-7-4 1-7-4a 1-7-5

16