Manuals / Toshiba / Marine Equipment / Marine Radio

Toshiba Release 4.0 manual Client API

Models: Release 4.0

1 376

Download 376 pages 3.24 Kb

Page 276

The Client API

The Client API is an extensive collection of the COM objects used to write the Strata CS Client. It contains objects that are typically used to interact with the Strata CS Server database and the call-processing engine. Using the objects available in the Client API, your applications can use any function found in the Strata CS Client.

14-12

STRATA CS ADMINISTRATOR MANUAL

BETA DOCUMENT - PRELIMINARY & CONFIDENTIAL

Image 276

Toshiba Release 4.0 manual Client API

Contents

Administrator Manual Publication Information Contents Managing Trunks and Spans Managing Users and Stations Managing Workgroups Handling Inbound Calls System Prompts Extending Strata CS Appendix E. Using Performance Counters Overview of Upgrading and Configuring Strata CS Significant Strata CS features Welcome to Strata CSNew features in Toshiba Strata CS 4.0 include the following What’s New in Strata CSBeta Document Preliminary & Confidential Beta Document Preliminary & Confidential Miscellaneous new features What’s automatically upgradedBefore you begin Changes in Strata CS from version 2.1 to 3.0 or laterMore information Changes in Strata CS 3.0 or later Configuring Strata CS for the first time Where to get help Strata CS documentationStrata CS includes the following documentation Your Strata CS provider Document Printed Online BookPage Strata CS Administrator About the Strata CS Administrator Linking computers and phonesAdministrator interface Logging on to the AdministratorDialing Services UsersWorkgroups TrunksMaintenance Working in viewsIVR Plug-Ins IP GatewaysUsing commands in a view Using the Administrator toolbarNew Workgroup Create a new workgroup Create a new auto attendant Performing basic actions in the Administrator Creating itemsTo create a new item that is based on an existing item Deleting items Renaming itemsCopying and pasting items Customizing columnsUsing the audio controls Working with voice filesChanging the voice file format Importing and exporting voice files Changing audio outputPage Strata CS Licenses About Strata CS licenses Entering licensesTo enter your Strata CS Server license Removing licenses To enter all other license typesTo remove all licenses To remove the Server licenseVerify that you have removed all other licenses Page Defining System Settings About system settings Customizable settingsEmergency. Use to configure emergency dialing options Changing Windows NT/2000 registry settings Server ConfigurationGeneral tab Rerecording voice promptsNo events. This is the default. No notifications are sent Windows Event Log notificationsSelect one of the following from the drop-down list Defining business hours and holidays Business HoursTo define business hours and holidays Beta Document Preliminary & Confidential Call Log tab Logging internal callsArchiving the Call Log To log internal calls as well as external callsTo archive Call Log information Storage tab Disk usageAllocating disk space Moving voice filesDefining special access codes Dialing tabTo move voice message files Setting dialing timeouts Using standard 911 service with Strata CS Using extended 911 service with Strata CSEmergency tab How emergency numbers are handled To set emergency dialing optionsBeta Document Preliminary & Confidential Setting dial-by-name directory options Other tabSetting up Microsoft Exchange synchronization Presenting a confirmation menu before voice mailTo set up Microsoft Exchange synchronization for a user Exchange Server Mailbox PermissionsSetting the minimum password length Managing Trunks and Spans About trunks Trunk typesAdding trunks Naming trunksMonitoring trunks Deleting trunksConfiguring trunks Matching trunk settings with your phone companyInbound and outbound calls and hunt groups ANI/DID digit collection Routing inbound calls on a trunkPlacing outbound calls on a specific trunk Collecting ANI/DID digits Setting up fax routing Using did with Robbed Bit T1 linesUsing did with analog lines Trunks view Customizing fax routingAbout digital and Internet spans Adding an analog trunk Setting up digit collection on an analog trunk To collect digits on an analog trunk Trunks view, select the trunkConfiguring signaling using the Robbed Bit T1 Experimenter Adding a digital Robbed Bit T1 spanAdding the Robbed Bit T1 span in the Trunks view Beta Document Preliminary & Confidential Using a signaling template Entering trunk defaults for a span To enter trunk defaults for a spanAdding a digital Isdn or CAS span Adding a digital Isdn BRI span Optimizing your Isdn settings To set your Isdn parametersEnabling Isdn Megacom support Adding an Internet span Modifying Strata CS IP codecs GSM .0 kbs To modify Strata CS IP codecsFine-tuning your IP connection To change an IPLink board parameterBeta Document Preliminary & Confidential Page Managing Users and Stations Users view ExtensionStation Title Mail UsageGreeting Usage Disk UsageAdmin and Operator users Configuring a system without an OperatorAbout users and roles UsersSetting up workgroups for the Operator Understanding personal OperatorsHow callers are transferred to Operators Changing the Operator’s extension fromSetting user options Where to set user optionsRoles Described in detail in this chapterAbout adding a user Adding a user at the telephoneAdding a user in the User dialog box Adding a user by using a template Identifying the userAssigning an extension Assigning a station ID Linking users and phones Assigning a did number Creating a password Setting up a personal operatorEditing a user’s Client settings Choosing a language for telephone promptsRecordings tab Allocating space for voice messagesAllocating space for recorded greetings and voice titles Setting up call recording To enable synchronizationEnabling Microsoft Exchange Server synchronization Notifications tab Setting e-mail notification Setting pager notificationScheduling notifications Defining a schedule for e-mail and pager notification To add a schedule entry Setting up custom time rules To set up a custom time ruleClick OK to add the custom date Call Handling tab Setting up call forwarding To turn on call forwardingIssues with forwarded calls on Mobile phone issues with forwarded calls Call forwarding and voice mailForwarding calls over Centrex/PBX trunks Listing a user in the dial-by-name directoryActivating features for Class phones Phone tabSetting the number of seconds to ring the phone Padding extensions sent as caller ID on internal callsSending Dtmf digits to stations Activating features on Toshiba digital phone Hands free answering Secondary Directory Number parameters Dialing tab Global dialing permissions To set dialing permissionsSetting account code modes Other settings Permissions tab By default, Strata CS creates the following two roles Individual permissions and rolesNew Role To create a new roleOther tab contains user options for hands-free mode Other tabManaging users Recording the new user’s voice title and greetingHelping new users get started After you create a new user, do the followingUpdating users’ mail, greeting, and disk usage totals Moving a userDeleting a user Managing stations Adding a stationSupported phones Supporting different types of Class phonesVisual message waiting indicator information Viewing station activityManaging Workgroups About Workgroups Using the General tab Creating a WorkgroupWorkgroups view Using the Dialing tab Assigning a did number to a workgroup Adding a voice titleTransferring unanswered calls Listing workgroups in the dial-by-name directoryPage Managing Outbound Calls About dialing services Dialing service typesSee Adding an Internet-to-Phone Number service on Default dialing service Using routing services to manage other dialing servicesDialing Services view How you can use dialing services Deleting or disabling a dialing service Hiding dialing services in the ClientAccess codes Tips on access codes and names for servicesUsing dialing services to install and troubleshoot trunks Disabling dialing services while creating themHow Strata CS uses access codes Updating phone numbers after changing an access codeAvoiding dialing ambiguities Setting default access codes for ringbacks Creating a dialing service with access codeWhere the default access codes appear Adding a Phone Number dialing service Beta Document Preliminary & Confidential Adding a Centrex/PBX Extension service Beta Document Preliminary & Confidential Adding an Internet Address service Adding an Internet-to-Phone Number service Beta Document Preliminary & Confidential Adding an Internet-to-Centrex/PBX Extension service Trunks tab Beta Document Preliminary & Confidential Location Settings tab Codecs tab To change the codecs used by a dialing service Dialing Exceptions tabClick the Codecs tab Do not need to specify dialing exceptions Beta Document Preliminary & Confidential Exporting and importing dialing exceptions To import dialing exceptionsPermissions tab An example of how to set dialing service permissions To set dialing service permissionsBeta Document Preliminary & Confidential Routing services Following numbers are allowedHow you can use routing services An example of routing rules Processing phone numbers received from the Client Adding a routing service Applying permissions in routing servicesBeta Document Preliminary & Confidential Routing Rules tab Add a new routing rule Use this rule under the following conditionsExecute the following action Defining patterns to match the dialed digits Adding new routing variablesTo add a routing variable Click Variables on the Routing Rules tab seeClick Add. The Routing Variable dialog box opens Defining a new number for a routing rule Characters Digits placed in the new number1NxxNxxxxxx 16173540600 Nxx5-11 567891011 Page Handling Inbound Calls About call routing Route calls to an automatic call distribution ACD workgroupHandling Inbound Calls Using auto attendants About auto attendantsDefault Auto Attendant What callers hearAuto Attendants view DescriptionSetting up an auto attendant Creating a new auto attendantDefining menu choices Description. Information that describes the auto attendantUser login Transfer to userSend to voice mail Play messageTo add or modify a menu choice KeyBeta Document Preliminary & Confidential Click the Advanced tab These fields as follows Menu choice Variable Name Variable ValueScheduling transfers and greetings To schedule transfers or greetings Action Action that will be performedBeta Document Preliminary & Confidential Setting up hold music To set up hold music for an auto attendantDeleting auto attendants Auto Attendant dialog box, click the Hold tabRouting calls directly to a user Analog trunkRobbed Bit T1 Span Internet spanRouting calls to workgroups Page Using Account Codes About account codes Setting up account codes Setting general account code optionsSetting a user’s account code modes Creating a text file of valid account codes To set a user’s account code modesUsing wild card characters Formatting the text fileUsing a verbal account code prompt Setting general account code options onHow users enter account codes To use the verbal account code prompt instead of the beepViewing account codes in the Call Log Generating account code reportsIndicating the end of an account code Monitoring & Backing UP About monitoring and backing up your Strata CS system Using the Device Monitor Monitoring station activityMonitoring trunk activity Logged Name of the user currently logged in at the stationEnabling and disabling trunks StatusOut Restarting stations or trunks To restart a station or trunkDo one of the following Using the Call Log Starting a new Server logFrom Answered ByFrom Number To NumberResult Supervised transfer. a supervised transferMessage From DeviceDisplaying a specific number of Call Log entries Monitoring database and disk usage Exporting the Call LogBacking up Strata CS To perform an online backup of the Strata CS database To perform an offline backup of the Strata CS databaseTo perform an offline backup of the Strata CS voice files Restoring Strata CS dataTo restore the Strata CS database from an online backup To restore the Strata CS database from an offline backupTo restore voice files from an offline backup Shutting down the Strata CS Server Moving a Strata CS Server to another machineViewing the Windows Event Log Strata CS-related Windows Event Log messages Error Dssql Error Error No Voice Resource AvailableDevice # Restarted Inbound call detected on outbound trunk #Error Strata CS Server Restarted Informational Started Strata CS Mail ServerNo loop current detected on outbound trunk n Error Failed to Stop Device Handle ## ErrorError Unable to open device ## Error Unable to delete temporary message file for device ##T1 alarms Error Unable to start IVR Plugin License count exceededError Insufficient licenses ## Using the Maintenance Log view Reporting problemsProblem report package Using the Problem Report Wizard To e-mail a problem report packageReporting Strata CS Server problems Reporting a problem with a specific call or voice messageTo report a Strata CS Server problem Reporting workstation application problems Reporting distributed problemsTo report a workstation application problem To report a distributed problemCall record from the Call Log on the Server Page System Prompts About system prompts System Prompts viewFile name TextManaging system prompts Controlling the prompt displayPlaying system prompts CommentExporting system prompt text Importing system prompt textExporting and importing system prompt audio files Changing the encoding format of system promptsRecording system prompts Recording optionsAbout the sentence file About the .VAP and .VOX filesRecording system prompts professionally Recording processSelecting a voice American English .VAP and .VOX files are locatedUsing the standard Strata CS voices Testing the recorded promptsProviding a script for the vendor Default location is Recording over system prompts yourselfDeploying the new prompts Recording over .VOX filesTesting the new prompts Recording over the .VAP fileTo record over a prompt System Prompts view, double-click the prompt nameTesting system prompts To use the Sentence Tester12-11 Localizing the telephone commands Configuring Internet Telephony Support About IP telephony and Strata CS Placing calls to H.323 terminals such as NetMeetingInternet telephony requirements Placing calls to Net Meeting from the Strata CS Client Placing calls to Net Meeting from a Strata CS phoneIP address Calling Strata CS from H.323 terminals such as Net Meeting Calling a Strata CS Server from Net Meeting Calling a Strata CS did number from Net MeetingStart NetMeeting Using Windows 2000 Phone Dialer as an H.323 terminal Enhancing a Web page with a Call Us! buttonConnecting two Servers using IP Gateways Placing calls involving a remote Strata CS ServerUsing the IP Gateway Configuration Worksheet Overview of creating an IP Gateway connectionReceiving Internet calls from a remote Strata CS Server Codec use with IP Gateway connectionsIllustration of an IP Gateway Creating an IP GatewayIP Gateways view Password Creating an IP GatewayRemote Address RemoteTo set up an IP Gateway Add Comments to further identify the IP GatewayCreating IP Gateway dialing services Calling Strata CS extensions on the remote Server13-14 Immediately connecting to dial tone on the remote Server Placing phone calls through the remote ServerPlacing Centrex/PBX calls through the remote Server When you configure two Servers in this way, users can Creating Gateway users to unify two Strata CS ServersDial any user’s extension directly, without an access code Overview of IP Gateway usersBefore creating IP Gateway users To create an IP Gateway user Fine-tuning your IP connection Using Contact PINs with IP Gateway usersExtending Strata CS About extending Strata CS In-band signaling applications Extending Strata CS with off-the-shelf applicationsTapi applications Extending Strata CS with third-party devices Sending call type and extension number to a device Type of call Dtmf digits sent 14-7 Strata CS SDK Installing the Strata CS SDK To install the Strata CS SDKFollow the instructions in the Strata CS SDK Setup window Strata CS SDK Application Programming InterfacesIVR Plug-in sample programs Developing IVR Plug-ins with a telephony toolkitDevice Status API IVR Plug-in licensingDevice Status sample program Client API Strata CS Configuration Settings About Strata CS configuration settings Strata CS Server registry settings\Server\Settings\ Default path is empty string EmptySentItemsFolderDefault is 0 no time-out MailDefault is 10000 bytes NumLogsStrata CS Workstation applications registry settings TruncateRecordingsCurrent User Settings String value specifying the user’s extension Default isString value specifying the user’s station ID Default is Local Machine Settings \Client\Client\App\Client\TSP\Logon Strata CS Server language locale settings Locale definitionsStrata CS currently uses the following locale codes EnglishDefining custom tones Disabling Dialogic devices Example Defining a disconnect detection toneTo disable Dialogic devices in the Windows NT/2000 registry Create a string value under Settings named DisableDevicesTo connect a fractional T1 or E1 line to Strata CS Create the following key if it does not already existDialogic device names Dialogic voice board device namesSave the changes to the registry Board Board ID Channel Dialogic modular station interface MSI device names Dialogic Internet telephony board device namesDialogic voice board settings VoiceBoard settingsOff-hook Delay. Period after off-hook, during Make interval for valid loop pulse detectionMinimum DTI Off. Minimum time required Between ring-received eventsVoiceBoard channel settings Dword value for Dtmf detection edge select Default is DxchdtinitsetDxchmfmode E1 and T1 board settings \Server\DTIBoardn\GlobalCallIsdn Megacom service settings \Server\BRIBoardn\ISDNMSI station board settings Default is 1 Mdmf formatDefault is 20 1000 milliseconds Default is 6 300 millisecondsUsing the Strata CS Settings program To use TVSettingsLogging Viewing current values Modifying other supported Strata CS settings Changing key valuesDatabase\ConnectionTimeout Default value is 30 secondsServer\AllowGatewayUserLogin Default value isDefault value is 180000 milliseconds Default value is 60000 millisecondsDefault value is 12000 milliseconds Default value is 6000 millisecondsDefault value is 1800 milliseconds System\MinClientBuild Page Command Line Options Starting Strata CS from the command linePassword=password IP Gateway Configuration Worksheet IP Gateway Configuration Worksheet To ServerName Type From Server Access To Server IP Gateway Page Using Quicknet and E-TEL with Strata CS Using Quicknet hardware with Strata CS Using Quicknet with Internet SwitchboardSetting up Quicknet to dial Strata CS Appendix D. Using Quicknet and E-TEL with Strata CS Using a Preferred address to dial extensions directly Setting up the Strata CS IP address as a Hot Line To make a Gateway preferredSetting up Quicknet to connect to Strata CS Creating the Gateway Beta Document Preliminary & Confidential Eliminating access code conflicts Transferring and handling calls with a Quicknet phoneCalling a Quicknet card from Strata CS Forwarding your calls to a Quicknet phoneImportant note about Quicknet Hot Lines Using the Strata CS Client with a Quicknet card See , Configuring Internet Telephony Support in Strata CSFor More Information Contacting QuicknetUsing an E-tel FreeRide IP phone with Strata CS Setting up a FreeRide phone to connect to Strata CSClick Settings and Support My Phone Number, enter your Strata CS extension Beta Document Preliminary & Confidential Transferring and handling calls with a FreeRide phone Tel contact information Page Using Performance Counters Strata CS performance counters Viewing performance counters in Windows NT/2000Appendix E. Using Performance Counters Beta Document Preliminary & Confidential Glossary ActiveX Control Also called control TorAnalog Trunk Also called analog line Application Programming Interface API Also called APIAutomatic Number Identification ANI Also called ANI Business Communications Platform BCP Also called BCP Call Announcing Also called call screening, screening a callCall Pursuit Also called follow me service Call Center Agent Also called agentCall Control Also called call handling Call Detail Recording CDR Also called call accounting, CDRCall Routing Also called routing a call Central Office CO Also called COChannel Associated Signaling CAS Also called CAS Channel Service Unit CSU Also called CSUCompetitive Local Exchange Carrier Clec Also called Clec Computer Telephone Integration CTI Also called CTIComputer Telephony CT Also called CT Dialed Number Identification Service Dnis Also called Dnis See also T-1 p. G-24Digital Signal Processor Also called DSP Dialogic SCBus Device Also called SCBusDigital Trunk Also called digital line Direct Inward Dial did Also called did Dual Tone Multi-Frequency Dtmf Also called DtmfFax-On-Demand Also called fax-back Grab-and-Hold Greeting Also called hold greeting Graphical User Interface Also called GUI Hold Audio Also called hold musicIntegrated Services Digital Network Isdn Also called Isdn Recognition ASR, IVR, speech recognitionInternet Protocol Also called IP Internet Service Provider Also called ISP, service provider Phony, Voice Over IPLocal Exchange Carrier Also called ILEC, LEC Microsoft Windows NT Server Also called NT Server Modular Station Interface Also called MSIMulti-Frequency Also called MF Network Interface Card Also called NICPlain Old Telephone Service Also called Pots Parking a Call Also called call parkPersonal Information Number Also called contact PIN, PIN Public Switched Telephone Network Also called Pstn Primary Rate Interface Also called PRIPrivate Branch Exchange Also called PABX, PBX Remote Access Server Also called RAS Redundant Array of Inexpensive Disks Also called RAIDRegional Bell Operating Company Also called Rboc Remote Office/Branch Office Also called RoboGLOSS-22 Strata CS Administrator Manual Small Office/Home Office Also called Soho Tapi Service Provider Also called TSP Telephony Application Programming Interface Also called Tapi Unified Messaging Also called integrated messaging GLOSS-27 Page Index To an auto attendant, 9-2to an IVR Plug-in,9-2 For caller ID Types supportedDisabling Digital spansFolders, working with Follow me call forwarding, ??-6-27 Indicator, visual message waiting Integrating Internet-to-Phone Number dialing service, addingUsing command line arguments, C-1 IP Gateways view, 2-5IP network Codecs forCustomizing trunk disconnect tones, A-12permissions AddingDialing timeouts, 4-12disk space Permissions, dialing servicesAudio outpub over your computer speakers, 2-11audio output Shortcut menuSpanish language prompts, 4-4spans, digital Station IDDisconnect tones, customizing, A-12 DidMoving, 6-42Operator Converting, 12-3,12-4