misertalk - hsq technology · features standard modem, voice modem, email, and text messaging (sms)...

TECHNOLOGY

MISERtalkUser Manual

v6.16

Limited Rights Legend

©2017 HSQ Incorporated. All rights reserved.

Contractor: HSQ TECHNOLOGY, A Corporation.

The following data comprises software and/or hardware documentation relating to computer software and/or hardware furnished with restricted rights:

User ManualRevision: 04/2017Those portions of this technical data indicated as limited rights data shall not, without the written permission of the above Contractor, be either (a) used, released or disclosed in whole or in part outside the Government, (b) used in whole or in part by the Government for manufacture or, in the case of computer software documentation, for preparing the same or similar computer software, or (c) used by a party other than the Government, except for: (i) emergency repair or overhaul work only, by or for the Government, where the item or process concerned is not otherwise reasonably available to enable timely performance of the work, provided that the release or disclosure hereof outside the Government shall be made subject to a prohibition against further use, release or disclosure; or (ii) release to a foreign government, as the interest of the United States may require, only for emergency repair of overhaul work by or for such government under the conditions of (i) above. This legend, together with the indications of the portions of this data which are subject to such limitations shall be included on any reproduction hereof which includes any part of the portions subject to such limitations.

No part of this manual may be reproduced without prior written consent of HSQ Technology, A Corporation.

No responsibility is assumed for the use or reliability of software on equipment that is not supplied by HSQ Technology, A Corporation.

All other brand or product names may be trademarks or registered trademarks of their respective companies or organizations.

i i

v6.16

Contents

PrefaceGeneral MISERtalk Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vThe MISER Manuals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vi

The MISER Operator Manual. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .viThe MISER System Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .viThe MISER Technical Reference Manual. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .viMISERtalk User Manual. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiXView for Windows Installation Manual. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiXDraw User Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii

About This Manual. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiiConventions and Notations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .ixDocument Feedback. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .ixGraphics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .ixMargin Icons. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x

Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x

Section 1: MISERtext and Email Modes1.1—MISERtext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-21.2—Email Address Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4

Section 2: MISERtalk Mode2.1—Modem Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2

2.1.1—Telephone Keypad. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-22.1.2—Spoken Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2

2.2—MISERtalk Standard Dial-In. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-32.3—MISERtalk Standard Dial-Out. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5

Section 3: MISERtalk Setup3.1—MISERtalk Required Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-23.2—MISERtalk Optional Setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3

3.2.1—MISERtalk Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-33.2.2—Customized MISERtalk Menu File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3

i i iMISERtalk User Manual

Table of Contentsi v

Section 4: MISERtalk Startup4.1—MISERtalk Dial-Out Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2

4.1.1—Unacknowledged Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24.2—MISERtalk Dial-In Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-34.3—MISERtalk Phone Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4

4.3.1—MISERtalk Phone List Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-54.4—MISERtalk Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6

Section 5: MISER Commands5.1—MTKCMP — MISERtalk Compiler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

5.1.1—Action Verbs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-35.2—MTKON — Points On MISERtalk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7

5.2.1—Selection from a Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-75.2.2—From the Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-75.2.3—Xterm Prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-7

5.3—MTKOF — Points Off MISERtalk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-95.3.1—Selection from a Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-95.3.2—From the Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-95.3.3—Xterm Prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-9

5.4—MTKPWD — Manage MISERtalk Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-115.4.1—Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-115.4.2—Terminal Prompt Examples. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12

5.4.2.1—ADD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-125.4.2.2—SHOW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-125.4.2.3—REMOVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-125.4.2.4—MODIFY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12

5.4.3—Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-125.5—MTKRP — MISERtalk Points Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13

5.5.1—Selection from a Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-135.5.2—From the Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-135.5.3—Xterm Prompts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-13

Appendix A: TroubleshootingA.1—MISERtalk Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2

A.1.1—Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2A.1.2—Software and Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2

Appendix B: Sample MISERtalk Menu File

HSQ Technology v6.16

PREFACE

MISER is a Supervisory Control and Data Acquisition (SCADA) application designed by HSQ Technology for real-time supervisory control, data acquisition, energy management, and process control applications.

General MISERtalk InformationMISERtalk is an enterprise-wide telephony and messaging tool for SCADA systems. It features standard modem, voice modem, email, and text messaging (SMS) capabilities with dial-in and dial-out functionality. MISERtalk is available in two different configurations: a Windows-based application suite or a complete, turnkey hardware and software solution.

MISERtalk features the unique ability to run two complete, distinctive instances of the software simultaneously. This allows for multiple contact lists and the ability to operate two different modes at once. For instance, one process can be sending a text message while the other is synchronously dialing a phone number.

MISERtalk interfaces with the MISER system to provide secure communication with users; security features require codes or passwords before accessing the SCADA system. It maintains the MISER access levels, ensuring users connecting to the system have the proper authority to acknowledge alarms or access the system.

vv6.16 MISERtalk User Manual

General MISERtalk Informationv i

Adding Email in Coordination with Voice

It is possible to add email functionality together with standard modem, voice modem, and text messaging (SMS) capabilities. In this case the configuration is done without selecting “Email Mode”. In phone files, a phone number can be an email address (i.e., containing the @ symbol) which will generate an email message to be sent.

The configuration and operation of MISERtalk is generally covered throughout this manual. However, specific instructions for using MISERtalk to send text and email messages can be found in Section 1, “MISERtext and Email Modes”.


Preface v i i

The MISER ManualsThe MISER system is fully documented in three manuals:

The MISER Operator Manual

The MISER System Manual

The MISER Technical Reference Manual

Three other manuals cover ancillary aspects of MISER. They are:

MISERtalk User Manual (this manual)

XView for Windows Installation Manual

XDraw User Manual

The content and focus of each manual is different. However, some tasks and applications overlap and are therefore duplicated. For all manuals, it is assumed that the MISER system database is in place and that there is some familiarity with the computer.

All of the manuals have been designed so that they do not need to be read in their entirety. It is recommended that, at a minimum, you read the individual introductory sections of each manual.

MISER operates with a variety of field units. These may be HSQ Logic Processors, HSQ Remote Terminal Units (RTUs), non-HSQ RTUs, Programmable Logic Controllers (PLCs), and other equipment.

The MISER Operator Manual

The MISER Operator Manual (MOM) is intended for system operators and provides instructions on monitoring and controlling equipment and processes. It describes the MISER standard controls and reports and describes how to implement the controls and produce reports.

The MISER System Manual

The MISER System Manual (MSM) is intended for managers that are responsible for setting up and maintaining system databases including the points database, the alarms database, the history database, the reports database, the events database, and the slides database. It also describes programs that typically set the parameters required to perform monitoring and control operations.

The MISER Technical Reference Manual

The MISER Technical Reference Manual (MTRM) is intended for programmers. It describes the MISER software from a programmers perspective. However, operators may benefit from reading about internal program relationships and system configuration.

v6.16 MISERtalk User Manual

The MISER Manualsv i i i

MISERtalk User Manual

The MISERtalk User Manual is intended for those that have MISERtalk installed on their system. It is an enterprise-wide telephony and messaging tool for SCADA systems. It features standard modem, voice modem, email, and text messaging (SMS) capabilities with dial-in and dial-out functionality.

XView for Windows Installation Manual

The XView for Windows Installation Manual is intended to describe the process for installing XView on a MISER system. XView is the HSQ dynamic display interface. It operates in conjunction with MISER to provide a graphical interface.

XDraw User Manual

The XDraw User Manual describes the drawing program that creates the slides used by XView.


Preface i x

About This ManualThe MISERtalk User Manual is divided into sections that describe how to configure and operate MISERtalk on a MISER system.

Preface — This section. The Preface describes this manual, typographical conventions, and special symbols used throughout the text. It also includes general information about MISER and MISERtalk.

MISERtext and Email Modes — Details the process for using MISERtalk to send emails and text messages.

MISERtalk Mode — Describes how MISERtalk dial-in, dial-out, and paging are accessed.

MISERtalk Setup — Specifies the configuration and customizations for MISERtalk.

MISERtalk Startup — Details the configuration for dial-in, dial-out, and phone lists.

MISER Commands — Describes how to use MISER to compile MISERtalk and manage points, user lists, and reports.

Troubleshooting — Provides solutions for common MISERtalk problems.

Sample MISERtalk Menu File


About This Manualx

Conventions and Notations

Throughout this manual, certain typographical conventions are used.

Document Feedback

To assist us in making improvements to this manual, we welcome any and all comments and constructive criticism. Please send all such correspondence to:[email protected].

Graphics

In some cases the screens shown in this document may have been slightly altered after this manual was released.

All efforts have been made to ensure that the latest images are used. In all cases, the functionality described is current at the time of writing.

Convention Description

Italics Type This highlights the first use of terminology and unique information. It can also indicate checkboxes, tab names, or text that is important.

Bold Type This highlights the names of certain items or features. It can also indicate special note text.

Bold Italic Type This highlights the names of screens.

Fixed Width Type This highlights user entered text or computer code.

Fixed Width Italic Type

This highlights arguments or variables that are entered as part of a command.

Press Press a physical key on the keyboard.

Select Choose an item from a menu or selection list.

[Button] Indicates the name of an on-screen graphical button.

hyperlink This denotes a clickable link to another part of the document in the electronic version of the manual.


mailto:[email protected]



Preface x i

Margin Icons

The following text boxes and icons are used throughout the manual to bring to your attention important information.

FYI: The FYI icon indicates additional information that is good to know when you are using the product.

Related Docs: The Related Docs icon points you to other relevant documentation that is available.

Required: The Required icon represents information or steps that are necessary to perform a specific procedure.

Warning: The Warning icon denotes that failure to take proper precautions could cause harm to equipment and/or personnel or lead to permanent loss of data.

SupportTo request Technical Support, please email HSQ directly at [email protected]. Those interested in receiving information or literature from the HSQ Sales Department regarding software and hardware products that we produce and support, please email [email protected]. Those interested in budgetary or fixed price quotes for upgrades to existing installations, new equipment, spare parts, system expansion, HSQ RTUs, or software modules, may also contact our sales department ([email protected]).

HSQ Technology26227 Research RoadHayward, CA 94545-3725

Voice: 510.259.1334Fax: 510.259.1391

www.hsq.com









http://www.hsq.com

Supportx i i


S E C T I O N 1

MISERTEXT AND EMAIL MODES

MISERtalk may be configured to send text messages (SMS) or emails to remote users. In this configuration, MISERtext uses a local email system to send email based on the contents of the phone lists associated with each MISERtalk point. The process for emailing and text messaging is the same, only the delivery address is different.

FYI: Due to the limitations of email, MISERtext is unable to accept inputs (acknowledge alarms) in this mode.

Subjects covered in this section include:

MISERtext

Email Address Formats

1 - 1v6.16 MISERtalk User Manual

MISERtext1 - 2

1.1 | MISERtextMISERtalk may be configured to send text messages (SMS) or emails to remote users. In this configuration, MISERtext uses a local email system to send email based on the contents of the phone lists associated with each MISERtalk point. The process for emailing and text messaging is the same, only the delivery address is different.

FYI: Due to the limitations of email, MISERtext is unable to accept inputs (acknowledge alarms) in this mode.

The MISERtext configuration file has no PORT, MODEM, or SPEAK commands. If no PORT/MODEM device is defined, by default MISERtalk will send an email to report alarm information. For example:

In the example above, the PORT line has been “commented out” (preceded by an exclamation mark). Therefore, the line will be ignored and by default the message will be sent to an email address.

In Email/SMS Mode, the phone list file associated with the alarmed MISER point must contain the contact name and email information. Each phone list field can be up to thirty-two characters in length. For example:

DEMVSA$ type mnet$data:mtk_config.dat! Misertalk configuration file for DEM!! PORT SPECIFIED SERIAL LINE FOR MISERTALK! DEFAULT NAME FOLLOWS!PORT MTK_DEVICE

DEMVSA$ type mnet$data:mtk-hsq.dat! Sample MTK phone list for test points!Valentine Michael Smith #[email protected] Protagonist #[email protected] Dent #[email protected]$


MISERtext and Email Modes 1 - 3

The MTK menu is simple, for example:

Figure 1-1. MTK Menu example

DEMVSA$ type mnet$data:mtk_menu.dat! Simple menu file for Email system. No user input.!$menu 1

set_gross 1800 ! 30 minutesnext: label

getalarmpass goto talkfail goto endtalk: label

speak %%ACN%% %%ACV%% %%ACU%% %%ACA%%. %%ACT%%markgoto next

end: labelhangup


Email Address Formats1 - 4

1.2 | Email Address FormatsIn MISERtext mode, text messages are emails that are sent to a cellular carrier’s SMS gateway. For example, to send a text message to an AT&T cell phone, the email address would be:

[10-digit phone number]@txt.att.net

Other cell phone vendor email address formats:

FYI: Virtually every cellular carrier has the capability to receive emails and forward them as text messages. If your carrier is not listed above, please contact them to find the proper email address.

Table 1-1. SMS Gateways

Carrier Email to SMS Gateway

Alltel [10-digit phone number]@message.alltel.com

Boost Mobile [10-digit phone number]@myboostmobile.com

Sprint Nextel [10-digit phone number]@messaging.sprintpcs.com

T-Mobile [10-digit phone number]@tmomail.net

US Cellular [10-digit phone number]@email.uscc.net

Verizon [10-digit phone number]@vtext.com

Virgin Mobile USA [10-digit phone number]@vmobl.com


S E C T I O N 2

MISERTALK MODE

The MISERtalk utility can be used to create a phone voice link between site personnel and points in the MISER system using a DECtalk DTC01, an HSQ MISERtalk, or it can access a central paging system using a Hayes® compatible modem.

In MISERtalk mode, there are two functions that are supported, dial-out and dial-in, each with separate, customized operating parameters. As part of customization, MISERtalk can impose security restrictions that require callers to enter special codes and pass codes before accessing the system.

Related Docs: For more information on security restrictions, refer to the MISER System Manual, UAL — User Access Level.


Modem Mode

MISERtalk Standard Dial-In

MISERtalk Standard Dial-Out


Modem Mode2 - 2

2.1 | Modem ModeIn Modem mode, HSQ MISERtalk uses the Telocator Alphanumeric Protocol (TAP) to interface with a Central Paging Facility. In this configuration, HSQ MISERtalk uses a standard modem supporting the Hayes (AT) instruction set and the V.21 (300 bps) protocol. Due to the limitations of a paging system, MISERtalk is unable to accept input (and thus acknowledge alarms) in this mode.

2.1.1 | Telephone Keypad

FYI: This feature is only available in MISERtalk mode.

HSQ MISERtalk communicates to the user through speech and accepts input through the telephone keypad.

Single Key Input — This requires the user to press only one key, enter numbers 0 through 9, press <*> (star), or <#> (pound sign). If no user input is received, the status is FAIL.

Multiple Key Input — This consists of zero or more characters terminated (optionally) by pressing <#>. If no user input is received, the status is FAIL.

Alphanumeric Input — This requires that the user enter a two-keypad button sequence for each character. The telephone keypad was not really intended for spelling, since the letters overlap (i.e., keypad 2 = ABC). In order to access a broader set of characters, a two character sequence must be used for each character. If no user input is received, the status is FAIL.

2.1.2 | Spoken Text

FYI: This feature is only available in MISERtalk mode.

Text from a file, text points, or action lines may include special acronym access and spell functions. It may also include other MISERtalk sequences.

Some words are not always pronounced as expected. If this occurs, the MISERtalk speaking may have an alternate means of pronunciation built into the unit that is accessed by a different syntax or may require a special dictionary entry in the MISERtalk configuration file. Additionally, spelling can be altered to achieve the desired pronunciation (e.g., SCAYDA for SCADA).


MISERtalk Mode 2 - 3

2.2 | MISERtalk Standard Dial-InIn MISERtalk mode, Dial-In operates when calls are made into the system. This function can be used to perform a variety of tasks. For example, to speak programmed data, to provide access to MISER controls, and to announce the status of certain points. Dial-in is an optional function that depends entirely on site specific customization. Dial-in communicates through speech and keypad responses. All keypad responses are made using the telephone keypad.

There are three different keypad response configurations that are used, depending on the site specific configuration. Keyboard responses are as follows:

Single-key response — This requires only a single button press. The buttons and functions are number 0 through 9, * (star), and # (pound sign).

Multiple-key responses — These require that several buttons be pressed followed by the “#” to end the response. This is used primarily for entering sequential groups of numbers (of varying length) and terminating with the “#”. You can also use “*” in this response.

Normally, multiple key input is terminated with “#”. However, if you fail to terminate the data stream with “#”, the program will accept the data stream after the user-defined timeout period has expired. Normally “#” is not part of the data stream unless only <#> was pressed.

Alphanumeric responses — This primarily requires two sequential keystrokes. The only response requiring a single button press is the termination/ending key <#>. To generate other characters, symbols, etc, see Figure 2-1 “Keystrokes for numeric values” on page 2-4.

Keystrokes required for numerical values are simply their number followed by a zero. For example:

To generate the number 1, use the telephone keypad and press <1> and then <0>. To generate the number 7, use the telephone keypad and press <7> and then <0>.

In the case of alpha-characters, two separate sequential keystrokes are required, one representing the alpha-character group and the second representing the letter in that group. With the exception of the letters “Q” and “Z”, this exactly follows the grouping of letters on the telephone keypad as shown in the following table.


MISERtalk Standard Dial-In2 - 4

Figure 2-1. Keystrokes for numeric values

The figure above shows both the alpha and numeric keystroke grouping (as on the telephone buttons) required to produce either a single letter or number. For example:

To generate a “Q”, press <1> twice (<1><1>) on the telephone keypad. The first time <1> is pressed tells MISER that the group selected is 1 (Q and Z). Pressing <1> again indicates the letter selected from that group is the first one (Q).

To generate an “A”, press <2> then <1>. When the first button is pressed (2) it tells MISER that the group selected is 2 (A, B, and C). Pressing <1> indicates that the letter selected from that group is the first one (A).

For example, to enter the password “CAT”, on the telephone keypad you would enter:<2><3><2><1><8><1><#> (232181#).

If a user would like to have “1575” as a password, the system administrator would enter:<q><p> (15=q and 75=p) as the password for that user in MISERtalk using UAL or MTKPWD.

Alphanumeric key input table for MISERtalk 2nd KEY 0 1 2 3 4 5 6 7 8 9------------------------------------------1st KEY 0 0 $ - . 0 $ - . 0 $ 1 1 Q Z % 1 Q Z % 1 Q 2 2 A B C 2 A B C 2 A 3 3 D E F 3 D E F 3 D 4 4 G H I 4 G H I 4 G 5 5 J K L 5 J K L 5 J 6 6 M N O 6 M N O 6 M 7 7 P R S 7 P R S 7 P 8 8 T U V 8 T U V 8 T 9 9 W X Y 9 W X Y 9 W * * * d c * * d c * * (d = delete, c = clear)

|||||||||||||


MISERtalk Mode 2 - 5

2.3 | MISERtalk Standard Dial-OutDial-out operates automatically. It is usually used during off hours or when the system is not attended, to announce that points have gone into alarm. HSQ MISERtalk dials the phone numbers associated with the alarms. Call recipients can do nothing, silence alarms, acknowledge alarms, or shut down HSQ MISERtalk.

In standard operation, HSQ MISERtalk speaks a greeting and asks to acknowledge receipt of the call. Press the acknowledgment key (default key = 8). Next, HSQ MISERtalk announces alarm information and associated custom messages. After each announcement, MISERtalk waits a timed period for a response. If a response is not received in a timely manner, it hangs up.

After hearing an alarm message, perform one of the following actions:

Press the key that silences the alarm — MISERtalk performs the equivalent of the MISER SIL command for the current point. The Default Key = 1.

Press the key that acknowledges the current alarm — MISERtalk performs the equivalent of the MISER ACK command for the current point.The Default Key = 8.

Press the key that acknowledges all alarms — MISERtalk performs the equivalent of the MISER ACK command for all alarms with the same phone filename or the same phone number (which matches the current one, character for character) as that to which it is currently connected. The Default Key = 2.

Press the key that commands a shutdown — MISERtalk then asks the user to verify the shutdown. If the same key is pressed again, MISERtalk reports that the shutdown has begun, logs the action, and turns off the MISERtalk control point.The Default Key = 3.

Do nothing — The response timeout period expires. MISERtalk disconnects the call and dials the next number on the phone list.

Related Docs: Detailed descriptions of Alarm Silence and Acknowledge Alarm are available in MISER Operator Manual, SIL — Silence Alarm and ACK — Acknowledge Alarm.

FYI: Defaults are defined in the MISER file, MNET$DATA:MTK_MENU.DAT


MISERtalk Standard Dial-Out2 - 6


S E C T I O N 3

MISERTALK SETUP

The minimum MISERtalk setup requires either an HSQ MISERtalk connected via a serial communications port or a Hayes compatible modem to access a central paging system. It is assumed that for each node where the MISERtalk database exists, the database keyword, MTKMAN, is included in MNET$DATA:CONFIG.DAT. When the required setup is in place, MISERtalk can both dial in and out.


MISERtalk Required Setup

MISERtalk Optional Setup


MISERtalk Required Setup3 - 2

3.1 | MISERtalk Required SetupThe following items are necessary:

MTK-CONTROL — A binary control point. When the control point is started (its status is changed to ON), MISERtalk is activated. When it is stopped, MISERtalk is de-activated.

Warning: Incomplete installation of MISERtalk will cause this binary control point to be turned OFF by MISERtalk.

Phone Lists — Each phone list is an ASCII file containing contact names and phone numbers. A phone list is associated with a point in MTKON when the point is put on MISERtalk (see “MTKON — Points On MISERtalk” on page 5-7).

Compiled MISERtalk Menu File — MNET$DATA:MTK_MENU.CMP is a compiled menu file that contains menus and commands for controlling dial in and dial out. A default file is provided for the dial-out operation. A customized menu file is read each time MISERtalk is started.

MISERtalk Database — $SITE:[DATA]MTKMAN.DAT lists points (and their associated phone lists) that have been put on MISERtalk (see “MTKOF — Points Off MISERtalk” on page 5-9). $SITE:[DATA]MTKMAN.DAT is created and modified by MTKON and MTKOF. It is updated dynamically each time either of these programs is run (i.e., whenever points are added to or taken off MISERtalk).


MISERtalk Setup 3 - 3

3.2 | MISERtalk Optional SetupThe following optional points and files can be added to the required setup to further customize MISERtalk. When the optional setup is in place, MISERtalk can perform dial-in and dial-out functions for the MISERtalk Configuration file and MISERtalk Menu file.

3.2.1 | MISERtalk Configuration File

The MISERtalk configuration file, MNET$DATA:MTK_CONFIG.DAT, is an ASCII file created with any system text editor. It contains the data that overrides the program’s default operating parameters. Operating parameters enable use with a paging system, dial-out or dial-in or both functions simultaneously, satisfy default values, and define messages. All operating parameters can be modified through this file.

In particular the following optional points are often defined:

An analog, alarm_delay point — The “alarm_delay” point can be used to vary the length of the time interval an alarm should remain unacknowledged before MISERtalk begins dialing. The value of the alarm delay is changed with the MISER CHV command. The acronym for the delay point must be referenced in the MISERtalk configuration file.

An analog, no answer delay point — The “no answer delay” point is an analog point that determines the length of the time interval (in minutes) that MISERtalk should wait before redialing the names on a particular list. A typical delay is fifteen minutes. The value of the delay is changed with the MISER CHV command.

An analog, user call delay point — The “user call delay” point determines the length of the time interval (in minutes) that MISERtalk should wait before redialing any telephone number that was just disabled. A typical delay is five minutes. The value of the delay is changed with the MISER CHV command.

A binary dial in control point — To turn On/Off dial-in capability without reconfiguring MISERtalk. The value can be changed with the MISER CHV command.

A binary dial out control point — To turn On/Off dial-out capability without reconfiguring MISERtalk. The value can be changed with the MISER CHV command.

3.2.2 | Customized MISERtalk Menu File

The MISERtalk menu file, MNET$DATA:MTK_MENU.CMP, is an ASCII file generated with a simple text editor and then compiled with MTKCMP. A site specific, customized file is required for dial-out operations.


MISERtalk Optional Setup3 - 4


S E C T I O N 4

MISERTALK STARTUP

MISERtalk starts automatically from within MISER. In systems with redundant Hosts, it starts on both computers but is idle on the standby Host until that computer goes online. MISERtalk operates according to the default, programmed parameters unless a MISERtalk configuration file has been created. If this file exists, the parameters in this file override the defaults.


MISERtalk Dial-Out Operation

MISERtalk Dial-In Operation

MISERtalk Phone Lists

MISERtalk Configuration File


MISERtalk Dial-Out Operation4 - 2

4.1 | MISERtalk Dial-Out OperationMISERtalk becomes active when the MISERtalk control point is ON. By default, the dial-out function is enabled. If there is a configuration file, MISERtalk checks the mode parameter setting for DIAL (out) or BOTH (dial-out and dial-in).

4.1.1 | Unacknowledged Alarms

To perform its dial-out function, MISERtalk continually looks for unacknowledged alarms. If one is detected, it verifies that the point is enabled for MISERtalk. In this context, enabled/disabled refers to the point being either ON or OFF MISERtalk. This is not the same as enabling/disabling an alarm point. See “MTKON — Points On MISERtalk” on page 5-7 and “MTKOF — Points Off MISERtalk” on page 5-9 for a more detailed description.

If the point is disabled, it is ignored. If it is MISERtalk enabled, it is placed on a dialing list and awaits expiration of the alarm delay interval. The alarm delay interval is set by a program default unless it is specified in a MISERtalk configuration file (see Figure 4-1 “MISERtalk Timing diagram” on page 4-6).

At the end of the alarm delay interval, MISERtalk checks the alarm. If it is still unacknowledged, MISERtalk sets this point (and any other points in alarm that use the same phone file) as ready to dial. Assuming the phone line is not in use, it begins dialing. How alarms are announced once a connection is made is determined by the default MISERtalk menu file, or if one exists, the custom MISERtalk menu file.

Based on the default menu file, MISERtalk speaks a standard greeting and then requires an initial entry to determine that there is a connection. It then announces all alarms associated with the name and phone number to which it is connected. The announcement consists of standard MISER alarm information and may include CAM messages.

Related Docs: CAM is described in detail in the MISER Operator Manual, CAM — Create Alarm Message.

After each alarm, MISERtalk waits a timed period for a response. If a response is not received within the period or within repeated retry periods, the call is terminated and MISERtalk progresses to the next phone number and the sequence is repeated. If a response is received, it takes the action requested and progresses to the next alarm.

After the person receiving the call hangs up, the phone number can not be redialed for any alarm or from any phone list for the time specified by the user call delay default, or user call delay point, if one has been defined and referenced in a MISERtalk configuration file. If MISERtalk has at least one outstanding alarm message to report and it has finished dialing all the numbers on its phone list, it waits for the default no answer delay interval (this parameter may be overridden in the MISERtalk configuration file). When the


MISERtalk Startup 4 - 3

interval has expired, MISERtalk verifies that its control point is still ON and if at least one alarm is still unacknowledged, begins dialing the first number on the phone list.

4.2 | MISERtalk Dial-In OperationFor its dial-in function, MISERtalk requires a custom configuration file and a custom menu file. In the configuration file, the mode must be set to ANSWER (dial-in) or BOTH (dial-out and dial-in). The custom menu file is required to tell MISERtalk what to do with the call.

When MISERtalk is not using the phone for other calls, it waits for incoming calls. When a call is received, the HSQ MISERtalk notifies MISERtalk and the custom MISERtalk menu file is initialized. Once the dial-in call is finished, MISERtalk waits for another incoming call or places an outgoing call.


MISERtalk Phone Lists4 - 4

4.3 | MISERtalk Phone ListsMISERtalk uses phone lists to determine who should be contacted and in what order. When a point is enabled for MISERtalk (see “MTKON — Points On MISERtalk” on page 5-7), it is associated with a phone list. Phone lists may be created with any text editor. Each phone list is a separate ASCII file consisting of comment lines and name/number lines.

Comments begin with an exclamation point (!) character. Name/phone number entries use a maximum of thirty-two characters for the name and thirty-two characters for the phone number. The phone number must begin with the pound symbol (#). To force a delay when dialing, as is sometimes required when dialing an outside line, insert a comma. A comma forces an approximate one second delay.

For paging systems, the telephone number must contain an at sign (@) followed by the USERID and preceded by the Central Paging telephone number if a Central Paging number is not specified in MTK_CONFIG.DAT file. Otherwise, the telephone number represents the USERID. The Central Paging telephone number specified in MTK_CONFIG.DAT may be overridden for a particular entry by using the @ format.

Other punctuation allowed in the phone number (spaces, dashes, parentheses) is optional and ignored by the program.

An optional post-call delay can be specified after a number is called by indicating the delay in minutes, enclosed in square brackets, following the number. The default is no delay.

In addition, a plus sign (+) preceded by a space as the last character in a line instructs MISERtalk to mark the point in the dial list. If the mark option is used as an action verb in the MISERtalk menu file (MTK_MENU.DAT), the phone list entry MUST end with a plus sign (+) for the mark option to be effective. This option is only relevant to paging systems. By using this option, the operator can control which users receive a page and when the paging should stop.

In MISERtalk mode, MISERtalk speaks each phone number before it is dialed. Putting a space between digits causes it to speak each character (one, two, three). Without the spaces, MISERtalk reads the number (one hundred twenty-three). In either case, the numbers dialed are 1, 2, then 3.

To take advantage of the acknowledge all option, the contact name and phone number must match, character for character, including spaces, from one phone list to the next.

FYI: An alarm will not cross-reference if the mark state of the phone list entries do not have the same mark state (see “MISERtalk Configuration File” on page 4-6). Cross-referencing is not effected by post-call delay parameters.



4.3.1 | MISERtalk Phone List Examples

In the example above, R. Mclintoc is paged at USERID #769769 (the pager central number is specified in MTK_CONFIG.DAT). After his page, MISERtalk will wait 2.5 minutes until it pages M. Renalds. Since the first entry did not end with a “+”, M. Renalds will always be called. M. Renalds uses a different paging central (555-6141) and her USERID is 123456. If she is successfully paged, S. Jones will not be paged (due to the “+”).

However, if M. Renalds page could not be successfully delivered to the Central Paging Facility, S. Jones will be paged at USERID 421235. If the page to S. Jones is unsuccessful, MISERtalk will wait the time specified by the No_Answer configuration parameter and will then start dialing again, beginning at the top of the list.

! phone list for MISERtalk!! Name/Location Phone Number!___________________________________!Smith/building 1 #1 2 3J. Smith/hdqtrs #9, 1 1 1 - 2 2 2 2J. Smith/car phone #9, 1 2 3 4 5 6 7S. Jones/building1 #1 2 5 [5.0]S. Jones/home #9, (4 1 5) 2 2 2 - 3 3 3 3Jones/cottage #9, (2 0 8) 3 3 3 4 4 4 4Smith/home #9, 4 4 4 5 6 5 6

! phone list for Paging System!! Name/Location Phone Number!__________________________________!R. Mclintoc #769769 [2.5]M. Renalds #9, 5546141@123456 +S. Jones #421235 +


MISERtalk Configuration File4 - 6

4.4 | MISERtalk Configuration FileMISERtalk includes a set of default configuration parameters that can be overridden through the use of a custom configuration file. This file, MNET$data:MTK_CONFIG.DAT, contains ASCII text with the following restrictions:

Each line in the file must contain only one parameter and its setting or comments.

A parameter and its setting are separated by white space characters (space bar or tab).

Comment lines begin with an exclamation point (!).

With the exception of those specifically noted, parameter lines can include comments after the setting. The acronym and/or n are user-defined points to toggle parameter values as necessary.

Figure 4-1. MISERtalk Timing diagram

Phone Lists

t2 = No_Answer

If Status = PASSt3 = User_Call

Alarm(s)

t1 = Alarm_Delay

name 1 / number 1

name 2 / number 2

name 3 / number 3

Alarm 1

name 2 / number 2

name 4 / number 4

Alarm 2

t1, t2 , t3 are time intervals in minutes

Alarm(s) must be enabled for MISERtalk with MTKON

Alarm_Delay, No_Answer, and User_Call are Configuration Parameters

t2



Table 4-1. MISERtalk Configuration File Arguments

Argument Description

Alarm_Delay nAlarm_Delay acronym

(n = minutes, acronym = Alarm_Delay point) Time interval, in minutes, that alarm must remain active and unacknowledged before MISERtalk can begin dialing. Alarm delay can be a numeric value (n) between 0 -32767 or can reference the alarm_delay point. The alarm_delay point is used when the time interval will vary and must be a calculated point with two decimal places, a low limit of zero, and high limit of the acceptable maximum time for this value.

The length of the time interval (the value of the point) can be changed with the MISER CHV command. The default value is one minute.

Allocate nAllocate 0Allocate -1

This is used with a modem only. A value of zero instructs MISERtalk to allocate a modem port when MISERtalk starts running. A non-zero value of n instructs MISERtalk to deallocate the communication port when not required, making it available to other processes. If the port is initially unavailable, MISERtalk will try n times to allocate the port. If n = -1, MISERtalk will try to allocate the port and will never timeout. The default value is zero and is also the preferred mode of operation.

APLOG YesAPLOG No

Enables (Yes) or disables (No) printing (or logging) of all MISERtalk messages on the alarm printer. The default is Yes.

Control acronym

(acronym = Control point) This identifies the MISERtalk control point. MISERtalk is enabled when the control point is ON and is enabled when the control point is OFF. Each time the control point is set to ON, MISERtalk reads the compiled menu file, MNET$DATA:TK_MENU.CMP. The control point must be a binary point with input subtype, NONE and an output subtype, NORMAL. The point can then be started and stopped. The default acronym is MTK-CONTROL.

Cross_Reference acronymCross_Reference n

The argument is either an acronym, 0 (OFF), or 1 (ON). If ON, phone lists entries are cross-referenced to minimize the number of calls.

This configuration parameter must be turned OFF when using a Central Paging Facility that cannot accept multiple blocks per paging event. The default is 1 (ON).

Debug YesDebug No

Enables (Yes) or disables (No) logging of debug messages to SYS$OUTPUT. The default is NO.

Dial ToneDial Pulse

Enables tone or pulse dialing for outbound calls. When pulse dialing is used, responses must come from phones that support tones. The default is Tone.

Dial_In_Control nDial_In_Control acronym

(n = 0 (OFF) or 1 (ON), acronym = dial_in_control point) This enables or disables dial-in functionality. For the parameter to take effect, the MODE parameter for dial-in must be enabled. The default is 0

(OFF).


MISERtalk Configuration File4 - 8

Dial_In_Root n

(n = number) This identifies the menu used to process incoming calls.

Menus are listed by number in the MISERtalk menu file. If dial-in is enabled, this menu must be defined in the MISERtalk menu file. Menus are numbered 1 to 32767. The default is 100.

Dial_Out_Control nDial_Out_Control acronym

(n = 0 (OFF) or 1 (ON), acronym = dial_out_control point) This enables or disables the dial-out function. For this parameter to take effect, the MODE parameter for dial-out must be enabled. The dial_out_control point is used when the status of this function should vary. The default is 1 (ON).

When using an acronym for the dial_out_control point, any alarm received while the dial_out_control point is disabled will be reported by MISERtalk after the dial_out_control point is re-enabled (this assumes that the point has not been acknowledged). The alarm delay will begin when the dial_out_control point is re-enabled. The dial_out_control point has no effect if it is disabled and re-enabled during the alarm delay period.

Dial_Out_Root n(MISERtalk mode only)

(n = number) This identifies the menu used to process outgoing calls. Menus are listed by number in the MISERtalk menu file. If dial out is enabled, this menu must be defined in the MISERtalk menu file. Menus are numbered 1 to 32767. The default is 1.

DICT word sub(MISERtalk mode only)

(word = standard spelling, sub = phonetic spelling) This defines an alternate pronunciation of a word. The sub is a phonetic spelling.

Gross_Timeout nGross_Timeout acronym

(n = number, acronym = gross_timeout point) This is the time interval, in seconds, that dial-in and dial-out users have to complete the call. Gross_timeout is used to limit the amount of time the phone line is in use.

If the gross_timeout value is exceeded, MISERtalk terminates the call. The menu file may override the Gross_Timeout value once. The gross_timeout value can be a numeric value (n) between one and 1800 seconds (thirty minutes) or can reference the gross_timeout point. The gross_timeout point is used when time interval will vary. The gross_timeout point must be a calculated point with zero decimal places, a low limit of zero and a high limit of the acceptable maximum time for this value. You can change the time interval length (point value) with the MISER CHV command. The default is 1800 seconds (thirty minutes).

Table 4-1. MISERtalk Configuration File Arguments (continued)




Input_Timeout nInput_Timeout acronym

(n = number, acronym = input_timeout point) The time interval, in seconds, must have to enter input. Expiration of time-out causes the menu action to use any input from the user. The menu file may override the input_timeout value. The input_timeout value can be a numeric value (n) between one and 1800 seconds (thirty minutes) or it can reference the input_timeout point.

The input_timeout point is used when the time interval will vary. The input_timeout point must be a calculated point with zero decimal places. The length of the time interval (the value of the point) can be changed with the MISER CHV command. The default is twenty seconds.

M_Disabled text(MISERtalk mode only)

(text = a custom message) This message is spoken when the MISERtalk control point is disabled. Comments cannot be appended to this parameter line. If they are, they will be spoken. A text point is used when the text will vary. The text point is accessed through the %%ACV acronym%% function. See the MISERtalk Menu File. The default text is: MISERtalk IS DISABLED.

M_Enabled text(MISERtalk mode only)

(text = a custom message) This message is spoken when the MISERtalk control point is enabled. Comments cannot be appended to this parameter line. If they are, they will be spoken. A text point is used when the text will vary. The text point is accessed through the %%ACV acronym%% function. See the MISERtalk Menu File. The default text is: MISERtalk IS ENABLED.

Mode acronymMode DIALMode ANSWER(MISERtalk mode)Mode BOTH(MISERtalk mode)

(acronym = mode point, DIAL = dial-out, ANSWER = dial-in,BOTH = dial-out and dial-in) This indicates whether dial-out, dial-in, or both functions will be used. The mode parameter can use dial, answer, both, or it can reference the mode point. The mode point is used when the mode will vary. The mode point must be a three state binary point. The three states should be DIAL, ANSWER, and BOTH coded, respectively, 0, 1, and 2. The default is DIAL.

Modem device name(Modem mode)

(device name = communications port name). This is the device name for MISERtalk communication port when used with a modem. The device name may be that of a physical device or a logical name. This parameter is incompatible with the Port parameter.

Modem_Connect_Timeout n Modem_Connect_Timeout acronym(Modem mode)

(n = number, acronym = modem_control_timeout_point). The time interval in seconds before modem times out after dialing a telephone number. This parameter can be very critical and will depend on the modem, the telephone system, and the Paging Control Facility. The default is twenty-five seconds.

No_Ans_Point acronym The associated acronym is turned ON if a phone file has been exhausted and some alarms have not been acknowledged or marked.




MISERtalk Configuration File4 - 1 0

No_Answer nNo_Answer acronym

(n = minutes, acronym = no_answer point) The time interval, in minutes, that MISERtalk waits before re-dialing the numbers on the phone list. The no_answer delay starts after all of the phone numbers on the list have gone unanswered. The no_answer delay can be a numeric value (n) between 0 and 32767 or reference the no_answer point. The no_answer delay point is used when the time interval will vary. The no_answer delay point must be a calculated point with two decimal places, a low limit of zero, and a high limit of the acceptable maximum time for this value. The length of the time interval (the value of the point) can be changed with the MISER CHV command. The default value is fifteen minutes.

No_Answer_Point

This point is started or stopped to indicate the success or failure of an outbound call. This can be used to notify the operator when a phone line is inoperative or if alarms are unable to be reported due to no answer.

Pager_Central text

This is the phone number for the Central Paging Facility.

This is required if the MODEM option is used, unless the pager central number is delineated for each phone number in the phone lists. See phone list for details.

Port device name(MISERtalk mode only)

(device name = communications port name) This is the device name for MISERtalk communications port. The device name may be that of a physical device, or it may be a logical name. This parameter is incompatible with Modem parameter. The default is MTK_DEVICE (logical name).

Rate n (n = number) This is the rate of speech in words per minute. The rate must fall between 120 and 180 words per minute. The default is 180.

Rings nRings acronym(MISERtalk mode only)

(n = number, acronym = rings point) The number of rings before MISERtalk answers the phone (number between 1 and 32767). The Rings point is used when the number of rings will vary. The Rings point must be a calculated point with no decimal places. The number of rings (the value of the point) can be changed using the MISER CHV command. The default is 1.

Test acronymTest n

An argument can be either an acronym or 0 (OFF) 1 (ON). For internal HSQ use only.




MISERtalk Startup 4 - 1 1

Unacknowledged_Only nUnacknowledged_Only acronym

The argument can either be an acronym, 0 (OFF), or 1 (ON). If Unacknowledeged_Only is ON, then only alarms that are unacknowledged will trigger MISERtalk. If it is OFF, then ALL alarms (unacknowledged or not) will trigger MISERtalk. This parameter may be useful if dialing to a device that cannot acknowledge alarms. Use the mark action verb to disable reporting of an alarm that has been successfully reported. The alarms that are marked, depend on the entry in the phone list to make the call. See “MISERtalk Phone Lists” on page 4-4 for details. The default is 1 (ON).

User_Call nUser_Call acronym

(n = number, acronym = user_call_delay point) The time interval, in minutes that MISERtalk should wait before dialing any number on the current or any other phone list containing the exact phone number of the contact that just hung up. The time interval can be a number between 0 and 32767. The user_call_delay point is used when the time interval will vary. The user_call_delay acronym must be an analog point. The length of time interval (the value of the point) can be changed with the MISER CHV command. The user delay is only activated if the exit status is pass (i.e., a point was acknowledged or marked). The default is 5 minutes.

Verbose YESVerbose NO

This determines whether MISERtalk speaks what it is going to do in the control room (MISERtalk mode) or makes a log in the AP log (modem mode). These informational announcements are not spoken on the phone (MISERtalk mode). The default is YES.

Voice n(MISERtalk mode only)

(n = voice number identifier) This selects a MISERtalk voice. Voice Select and Speech Rate customizes how MISERtalk sounds. The rate and voice are reset for each dial-in or dial-out call to eliminate any changes requested in the menu file. Voice numbering corresponds to MISERtalk selections. The default is 1.




MISERtalk Configuration File4 - 1 2


S E C T I O N 5

MISER COMMANDS

There are five MISER programs that provide valuable tools for managing and configuring the MISERtalk installation. They are:

MTKCMP — MISERtalk Compiler

MTKON — Points On MISERtalk

MTKOF — Points Off MISERtalk

MTKPWD — Manage MISERtalk Users

MTKRP — MISERtalk Points Report


MTKCMP — MISERtalk Compiler5 - 2

5.1 | MTKCMP — MISERtalk CompilerThe menu commands are originally written to an ASCII file, MNET$DATA:MTK_MENU.DAT. This source file is then compiled to create the required file, MNET$DATA:MTK_MENU.CMP.

The default compiled menu file contains entries for the MISERtalk dial-out function. To use the MISERtalk dial-in function, a customized menu file must be written. The customized menu file is written as an ASCII file and contains one or more menu definitions, MISER commands, action, and comments. The default menu file provided with MISERtalk is suitable for creating a custom file.

Comments are delimited by an exclamation point (!). Comments cannot be included in text lines as they will be spoken.

Menu definitions consist of the keyword $MENU. The keyword must start in the first column and be followed by white space and the menu number (1-32767).

Actions are the commands that control the operation of the menu file. Actions consist of a filter field in the first column(s), white space, and action verb, and action argument(s).

A filter field controls the execution of the action based on previous results or user input. The filter field may be a label (up to eight characters terminated with a colon), PASS or FAIL for checking the status of previous operations, or a list of one or more values to be matched with user input (i.e., 1,2,3). Values may be specified as ranges for the single key inputs (0-9) and the qualifier may include # for a single # as input. Note that single key and multiple key input may include the * key.

The action verbs are a set of functions that can be programmed. Some of these functions set the action status value to PASS or FAIL for use in executing other actions.

Included as part of menu file execution is a set of fifteen counters, initialized to zero at the start of the dial-out or dial-in sequence. The counters are global and may control the execution of menu options via zero, count, and compare actions.

For acronym searches, the user may set the acronym to be used through direct actions or from acronym input from the user (see getacr in “Action Verbs” on page 5-3). Text used in commands may include one of four special functions for acronym parameter access and one special function to return the current date and time:

%%ACN acronym%% – Acronym Name

%%ACU acronym%% – Acronym Units

%%ACV acronym%% – Acronym Value

%%ACA acronym%% – Acronym Alarm Status

%%ACT%% – Inserts current date and time


MISER Commands 5 - 3

These functions may include acronym name or may operate on the currently selected acronym (set up by menu file commands). The acronym, when specified, need only be specified in the first function and applies to subsequent functions until changed (i.e., %%ACN TEST%%, %%ACV%%, %%ACU%%, %%ACA%%). The terminating %% is required in order to recognize the function reference.

In addition to the above functions, the result of an acronym function or other text may be spelled out instead of being spoken. This is accomplished with the %%SPELL text%% function, where text may be one of the acronym functions as well (i.e., %%SPELL %%ACN%%%%). The %%ACx function references are replaced in the spoken message with the text of the required value.

The MISERtalk script can include the string %%USER%% in spoken text, which is replaced with the user name information from the phone file and subsequently spoken as part of the script.

5.1.1 | Action VerbsTable 5-1. MISERtalk Action Verbs

Function Description

ack(MISERtalk mode)

Acknowledge current alarm defined in acronym (see getacr and getalarm functions below). Status is PASS if the alarm was acknowledged and FAIL if unacknowledged, no acronym has been selected, or the user lacks authority.

ackall(MISERtalk mode)

Acknowledge all alarms for this user, always returns PASS.

authority(MISERtalk mode)

Test authority of user to acknowledge or confirm alarms. Status is PASS if the user has authority.

compare n v Compare counter n to value v. Status is PASS if the counter value n is less than v. The value of n is in the range 1 to 1.

count n Increment counter n (n is 1 to 15).

execute text

Execute command file with text as the argument list. This executes command file MNET$COM:MISER_COMMAND_INTERFACE.COM. This is a site-specific file, with no default provided. It provides an extension to MISERtalk for more sophisticated controls.

getacr

Get acronym from user (alphanumeric input, up to fourteen characters). Text spoken is stopped when the input is complete. Status is PASS if a valid acronym was entered. Acronyms may include wildcards. Spell acronyms with the telephone keypad using two key sequences for each letter, number, or special character. Each letter entered will be spoken. Refer to “MISERtalk Standard Dial-In” on page 2-3 for telephone keypad usage.



getalarm

Get alarm to report from dial-out list for dial-out use or any alarm for dial-in usage. Status is PASS if an alarm is found. The acronym for the alarm is saved in ack (see above) and may be used with the %%ACx acronym function.

getinputGet input from the user (keypad input, up to eight characters). Text being spoken will be stopped when the input is complete. Status is PASS if any input is received.

getitemGet single key input (0-9, *, #). Text being spoken will be stopped when the input is complete. Status is PASS if any input is received.

getnameGet user name (keypad input, up to eight characters). Status is pass if any input is received.

getpassGet user pass code (keypad input, up to eight characters). Status is PASS if any input is received.

gotolabel Go to specified label, forward or backward.

hangupHang-up the phone. This action assures all text has been spoken before sending the hang-up command.

label: labelDefine a label. Label actions are preceded by a label of up to eight characters alphanumeric text terminated with a colon (:).

lookup

Lookup entered acronym. This is used with getacr or set_acronym for looking up matching acronyms. The status is PASS if an acronym is found. The resultant acronym may then be used in conjunction with %%ACx acronym access functions.

mark

Used to set a flag in the current dial list (internal to MISERtalk) when the state of an alarm has been successfully delivered. A corresponding flag (i.e., + sign) in the current phone list must be present for the alarm to be marked. Mark will be ignored if MISERtalk is not configured to use a modem.

menu n Executes menu n. This places the current menu on a menu stack for use with the prev command.

prev Returns to the previous menu, starting at the first action.

repeat Repeat current menu from the top.

restore Restore the PASS/FAIL state (see save action).

rootReturn to the root menu. This removes all entries from the menu call stack set by previous menu commands and restarts the menu file from the root menu. Counters are not reinitialized.

Table 5-1. MISERtalk Action Verbs (continued)




saveSave PASS/FAIL state. This may be restored by the restore action. Its use is to allow the status of a comparison or other action to be saved for later use, while using actions which change the status.

set_acronym aSet acronym for lookups (may include wildcards). This sets the acronym for the lookup command to use as a template for matching. The acronym may be up to fourteen characters and may include wildcards.

set_gross n

Set gross time-out for connection, in seconds (1 to 1800). This starts a timer that terminates the call when it expires. The command may be used in dial-in or dial-out menu files and may be specified many times, but executes only the first time. The setting is limited to ensure that menu files are timed-out.

set_segment s, s, …

Set the segments of interest, limited by login. This allows sequences to look up alarm information or acronyms by selected segments. The segments that may be accessed are limited by the user login information (getname, getpass, validate). If no user is validated, all segments are accessible, but the user has no authority to do any alarm control. Segments are 0 to 31, and may include all for all segments.

set_status status

Sets the exit status to PASS or FAIL. When a dial-out call is completed, this status is checked to see if the user satisfied the dial-out requirements. If the status is not set, it will be FAIL and the next number in the phone list is called. The status is set to PASS if the user acknowledges the call or acknowledges/confirms one or more alarms.

set_timeout n

Set the input time-out value. This sets the amount of time a user can make inputs. The value should be based upon the complexity of the input required. For single number inputs, the value should be small (e.g., five seconds). For complex inputs such as acronyms, it should be larger (e.g., one minute). The value may be tuned according to actual usage. Note that the time-out may begin prior to completion of spoken text. This condition may cause a time-out to occur before messages are spoken, resulting in truncated spoken messages and erratic operation. A long time-out should be spoken if this occurs.

shutdownShutdown MISERtalk. Shutdown disables MISERtalk and hangs up the phone. It stops the MISERtalk control point.

silence (MISERtalk mode)

Silence (confirm) alarm. The status is set to PASS if the alarm is confirmed or FAIL if the user lacks authority or this command fails.

speak text/@file

Speak text from menu file or from a file (may include multiple lines). Text points may be accessed in text with %%ACV text point acronym%%. See “Spoken Text” on page 2-2 for additional information about text usage.





sync(MISERtalk mode)

Synchronizes the menu file and MISERtalk speech. This is necessary since speech may lag behind the commands to the MISERtalk device. The user query for input may precede the speaking of associated text, causing menu time-out problems. Sync forces the menu to wait till the last text is spoken before continuing. This is typically not used for selection queries as it overrides the ability to get an input option and terminate the spoken text.

validate(MISERtalk mode)

Validates user name/pass code. Validate looks up the user name and pass code (from getname and getpass) and returns PASS if the entries match in the pass code database maintained by the MISER UAL program.

wait n Wait n seconds, delays menu execution. Where n is a number from 1 to 32767

zero n Zero counter n. Where n is a number from 1 to 15.





5.2 | MTKON — Points On MISERtalkMTKON puts a point on MISERtalk and links it to a phone list. Once a point is on MISERtalk, MTKON can change the phone list association. A phone list is an ASCII file that contains the names and phone numbers of the personnel who should be contacted when alarms go unacknowledged. Phone lists are created and can be modified using any text editor. Refer to “MTKOF — Points Off MISERtalk” on page 5-9 for information on taking points off of MISERtalk and breaking phone list associations.

5.2.1 | Selection from a Target

Select the point target from the XView Slide Window and then type MTKON in the Quick Menu box. An Xterm window opens and prompts you for additional information.

5.2.2 | From the Command Line

Type MTKON and press <Return>. An Xterm window opens and prompts you for additional information.

5.2.3 | Xterm Prompts

(Does not appear when selected from a target.) Type an acronym or an acronym with qualifiers. Pressing <Return> (twice) without entering any characters, ends the program.

If there are no matches, “No points found” is displayed. Press <Return> to exit the program and close the Xterm window.

Enter Acronym:


MTKON — Points On MISERtalk5 - 8

Figure 5-1. Put Point On MISERtalk screen

Enter one of the following:

<Y> — (Yes) Puts the point on MISERtalk. The “Enter Phone filename” prompt displays.

<N> — (No) Skips to the next point (if applicable). This is the default.

<Q> — (Quit) Exits the program.

<G> — (Go) Puts this and all subsequent points found on MISERtalk. The “Enter Phone filename” prompt displays. The remaining points will be associated with the same phone list.

FYI: If using the Go option, the filename entered for the first point will be used for all subsequent points found. A confirmation message displays for each point.

Enter the name of the ASCII file that contains the phone list MISERtalk should use when alarms for this point go unacknowledged (by default the file extension is .DAT). The name of the ASCII file may include its directory location. The default directory is MNET$DATA. After the entry MTKON displays the prompt:

Enter the desired process (MTKMAN or MTK2). A confirmation message displays. See “MISERtalk Configuration File” on page 4-6 for more information.

Put (acronym) on MISERtalk [Y/N/Q/G] ?

Enter Phone filename :

Which Processes?



5.3 | MTKOF — Points Off MISERtalkMTKOF takes a point off MISERtalk and breaks the phone list association.


Select the point target from the XView Slide Window and then type MTKOF in the Quick Menu box. An Xterm window opens and prompts you for additional information.


Type MTKOF and press <Return>. An Xterm window opens and prompts you for additional information.




Figure 5-2. Take Point Off MISERtalk screen

Enter Acronym:


MTKOF — Points Off MISERtalk5 - 1 0

Enter one of the following:

<Y> — (Yes) Takes the point off MISERtalk.

<N> — (No) Skips to the next point (if applicable). This is the default.

<Q> — (Quit) Exits the program.

<G> — (Go) Takes this and all subsequent found points off MISERtalk, with no verificaiton. For each point, a confirmation message is displayed and prints.

Take (acronym) off MISERtalk [Y/N/Q/G] ?


MISER Commands 5 - 1 1

5.4 | MTKPWD — Manage MISERtalk UsersThis utility is used to add, modify, or remove users from the MISERtalk dial-in database. It must be run from the terminal (not XView). To run the utility, type MTKPWD at the <node>$ prompt in a MISER terminal and press <Return>. This returns the prompt: MTKPWD>.

This method allows for typing the alias name at the prompt, as long as the symbol MTKPWD has been defined in MNET$COM:MISER_COMMANDS.COM. The symbol is defined by the following MISER command:

Required: MNET$COM:MISER_COMMANDS.COM must be executed for the symbol to be defined.

Alternatively, MTKPWD can be run by typing the following at the MISER terminal prompt:

5.4.1 | Commands ADD — This keyword is used to add a new user to the MISERtalk database.

Required arguments are the Username, MISERtalk Login String (MISER Login Username), and the MISERtalk Passcode (Password). The specified Username must have sufficient UAL authority to acknowledge alarms. MTKPWD will prompt the user for any unspecified arguments.

Related Docs: UAL — User Access Level is described in detail in MISER System Manual, System Management.

SHOW — This keyword displays the MKTPWD entry for the user specified by the required arguments. The argument may contain asterisk wildcards. Use the optional /output qualifier to redirect the output from the SHOW command to a file. MTKPWD will prompt the user for unspecified arguments.

REMOVE — This keyword is used to delete the MTKPWD entry for the user-specified by the required argument. Wildcards are not allowed.

FYI: MTKPWD does not prompt you to confirm the removal of a database entry. However, it will prompt you for unspecified arguments.

$ MTKPWD:==$MNET$EXE:MTKPWD

$ run MNET$EXE:MTKPWD


MTKPWD — Manage MISERtalk Users5 - 1 2

MODIFY — This keyword is used to modify the MTKPWD entry for the user specified. Required arguments are the Username, MISERtalk Login String (MISER Login Username), and the MISERtalk Passcode (Password). MTKPWD will prompt you for any specified arguments.

EXIT/QUIT — This is used to end the MTKPWD program.

5.4.2 | Terminal Prompt Examples

5.4.2.1 | ADD

5.4.2.2 | SHOW

5.4.2.3 | REMOVE

5.4.2.4 | MODIFY

5.4.3 | Error Handling

MTKPWD will return the error “SYSTEM-F-DUPLAM, duplicate name” if a duplicate Username or MISERtalk Login String is encountered. The error “%RMS-E-RNF, record not found” will be returned if the Username is not found.

ADD_Username:_MISERTalk Login String:_MISERTalk Passcode:

SHOW_Username/output=filespec

REMOVE_Username:

MODIFY_Username:_MISERtalk Login String:_MISERtalk Passcode:


MISER Commands 5 - 1 3

5.5 | MTKRP — MISERtalk Points ReportMTKRP displays a list of the points currently on MISERtalk. The list is organized by acronym and includes the ASCII filename containing the phone list associated with the point.


Select the point target from the XView Slide Window and then type MTKRP in the Quick Menu box. An Xterm window opens and displays the report.


Type MTKRP and press <Return>. By adding search, continuation, and output qualifiers, the report can be displayed and printed for a number of points more directly. After the entry, an Xterm window opens and prompts you for additional information.




Figure 5-3. Points On MISERtalk screen

Enter Acronym:


MTKRP — MISERtalk Points Report5 - 1 4

MTKRP displays twenty points per screen. When there are more points than can display on one screen, a question mark appears at the bottom. To display the next point(s), press <Return>. To exit, enter Q. Then, press <Return> to close the Xterm window and return control to XView.


A P P E N D I X A

TROUBLESHOOTING

A - 1v6.13 Manual

MISERtalk TroubleshootingA - 2

A.1 | MISERtalk Troubleshooting

A.1.1 | Hardware

If MISERtalk is not working properly, check the following hardware items:

Is the port allocated to another user?

If the device is represented by a logical name, is the logical name defined?

MISERtalk only — Is the MISERtalk unit connected properly? Does the MISERtalk unit speak when a text file is copied to the unit with the copy command?

Modems only — Is the MODEM connected properly? Does KERMIT or SET HOST/DTE work?

MISERtalk only — Though MTKMAN should change the device characteristics, the MISERtalk unit should be set to 1200 baud, no parity, eight bit, pasthru, ttsync, modem, no broadcast.

Modems only — Though MTKMAN should change the device characteristics, the modem should be set to 300 baud, even parity, no eight bit, pasthru, ttsync, modem, no broadcast.

A.1.2 | Software and Setup

If MISERtalk is not working properly, check the following software configuration items:

Is MTKMAN defined in the MNET$DATA:START_NODENAME.DAT file?Does WATCH return the status of MTKMAN?

Was MTK_MENU.DAT recompiled to generate MTK_MENU.CMP?If MTK_CONFIG.DAT is set for dial-in or dial-out, then MTK_MENU.DAT must have the corresponding sections and the $MENU sections must properly be defined.

Were there any compiler errors?

Does MNET$DATA:MTK_CONFIG.DAT contain MISER points that have not been defined? (All points in the configuration file must be defined.)

Are all the configuration parameters spelled correctly?MISERtalk will shut down and turn off the MISERtalk control point if it encounters an unknown (or misspelled) configuration parameter.

Is the control point defined in MTK_CONFIG.DAT enabled?It may have been turned off by MTKMAN if a previous initialization failed.

Have the alarms been enabled for MISERtalk using MTKON?

Do the phone files exist and are they properly formatted?


A P P E N D I X B

SAMPLE MISERTALK MENU FILE

B - 1v6.16 MISERtalk User Manual

B - 2

In the sample above, the menu will zero a retry counter, speak the prompt information, get a user selected item input (1-9) through getitem, and act on the input. Inputs 1-3 will cause another level of menus to be executed. A pound key (#) entry will cause the line to be hung up. Any other entry will cause an error message to be spoken, a retry counter to be tested and will cause a hangup to occur if the retry count is exhausted. If the retry count is not exhausted, the menu will be executed again, from the top, by the goto command. Each of the secondary menus (101, 102, 103) will return to the top level menu

$MENU 100! Top level menu #1(comment) zero 1 ! zero retry countera: label speak Please select one of the following options. speak Press 1 for a report of river levels. speak Press 2 for alarm information. speak Press 3 for status of a specific point. speak Press the # key to exit. getitem ! get user selection1 menu 101 ! selection 12 menu 102 ! selection 23 menu 103 ! selection 3# speak Thank you for calling, Goodbye.# hangup ! hangup the line speak Incorrect menu item selected. count 1 ! bump retry counter compare 1 10! max retry count exceeded?Passgoto a! no, try again speak Too many incorrect entries have been made, speak please try another time. Goodbye hangup! hangup the phone$MENU 101 speak The river levels are speak Blanco River %%ACV BLNCO-LEV%% %%ACU%% speak Verde River %%ACV VERDE-LEV%% %%ACU%% speak Colorado River %%ACV CLRDO-LEV%% %%ACU%% wait 2 ! delay 2 seconds prev ! return to previous menu$MENU 102 getalarm ! check for any alarms to reportfail speak there are no alarms at this timefail prev ! return to previous menualarm: speak %%SPELL%%ACN%%%% %%ACV%% %%ACV%% %%ACA%%getalarm ! get alarm informationpass goto alarm! more to reportfail prev ! all done, return to previous menu$MENU 103speak Enter the acronym name using the keypad, # to end.getacr ! get acronym from userfail prev ! Invalid or no acronymlook: labellookup ! look it uppass speak %%SPELL%%ACN%%%% %%ACV%% %%ACU%% %%ACA%%pass goto lookprev


Sample MISERtalk Menu File B - 3

with a previous action, restarting the process. Since the previous menu is executed from the top, the retry counter is zeroed as well.

All of the menus in the example above could be contained in a single menu definition as well, with additional labels and goto actions instead of the menu actions. Note the use of the acronym access functions (%%ACx). These report the information retrieved by the getalarm or lookup actions. The status from these actions is used to determine whether there is information to be reported. Menu files that do not hangup the phone will cause the execution of a hangup command after the last menu action.

In the example above, a gross time of thirty minutes is initially set. Alarms are obtained sequentially until getalarm returns a status of fail. The menu file then jumps to label end to hangup. If getalarm return a pass, the menu jumps to label talk and send the message given by speak. Mark is used to signify that the message was delivered.

! Simple menu file for Paging system. No user input.!$Menu 1 set_gross 1800! 30 minutesnext:label getalarmpassgoto talkfailgoto endtalk:label speak %%CAN%% %%ACV%% %%ACU%% %%ACA%%. %%ACT%% mark gotonextend:label hangup


B - 4


misertalk - hsq technology · features standard modem, voice modem, email, and text messaging (sms)...

Documents