gfk1494a - cimplicity hmi pager operation manual

of 78 /78
GE Fanuc Automation CIMPLICITY ® Monitoring and Control Products CIMPLICITY HMI Pager Operation Manual GFK-1494A November 1998

Author: eduardo-nascimento

Post on 13-Apr-2016

248 views

Category:

Documents


5 download

Embed Size (px)

DESCRIPTION

CIMPLICITY HMI Pager Operation Manual

TRANSCRIPT

  • GE Fanuc Automation

    CIMPLICITY Monitoring and Control Products

    CIMPLICITY HMI

    PagerOperation Manual

    GFK-1494A November 1998

  • GFL-002

    Warning notices are used in this publication to emphasize that hazardous voltages, currents, temperatures, or otherconditions that could cause personal injury exist in the equipment or may be associated with its use.In situations where inattention could cause either personal injury or damage to equipment, a Warning notice is used.

    Caution notices are used where equipment might be damaged if care is not taken.

    NoteNotes merely call attention to information that is especially significant to understanding and operating the equipment.

    This document is based on information available at the time of publication. While efforts have been made to be accurate,the information contained herein does not purport to cover all details or variations in hardware or software, not toprovide for every possible contingency in connection with installation, operation, or maintenance. Features may bedescribed herein which are not present in all hardware and software systems. GE Fanuc Automation assumes noobligation of notice to holders of this document with respect to changes subsequently made.

    GE Fanuc Automation makes no representation of warranty, expressed, implied, or statutory with respect to, andassumes no responsibility for the accuracy, completeness, sufficiency, or usefulness of the information contained herein.No warranties of merchantability or fitness for purpose shall apply.

    CIMPLICITY is a registered trademark of GE Fanuc Automation North America, Inc.Windows, Windows NT, and Windows 95 are registered trademarks of Microsoft CorporationPentium is a registered trademark of Intel CorporationDEC, AlphaServer and AlphaStation are trademarks of Digital Equipment CorporationFirstPAGE is a trademark of NETCON Technologies Inc.Other brand and product names are trademarks or registered trademarks of their respective holders.

    This manual was produced using Doc-To-Help, by WexTech Systems, Inc.

    Copyright 1997 GE Fanuc Automation North America, Inc.All rights reserved

  • GFK-1494 iii

    Preface

    Contents of this ManualThis manual is composed of the sections described below.Chapter 1. Introduction to CIMPLICITY Pager: Describes the CIMPLICITYpager functions.

    Chapter 2. Using the Pager Administrator: Discusses the functions of the PagerAdministrator.

    Chapter 3. FirstPAGE Client: Discusses the program groups and configurationcabinets used by CIMPLICITY software, and how to manage projects.Chapter 4. CIMPLICITY Pager Configuration: Describes how to use theBrowser utilities.

    Chapter 5. Pager Basic Extensions: Documents the Basic extensions that can beused with the CIMPLICITY Pager.Appendix A. Modem Configuration: Documents modem configurations forCIMPLICITY Pager.

    Appendix B. Environment Variables: Shows the environment variables for theCIMPLICITY Pager.Appendix C. Troubleshooting: Documents the log and audit files fortroubleshooting the CIMPLICITY Pager.

    Appendix D. Network Configuration: Shows you how to configureCIMPLICITY Pager in a network environment.

    Appendix E. Server Redundancy: Shows you how to use the CIMPLICITY Pagerin a Server Redundancy configuration.

    Appendix F. Viewer Configuration: Documents the changes needed to useCIMPLICITY Pager on a CIMPLICITY Viewer Development computer.

  • iv CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1180

    Related Publications

    For more information about CIMPLICITY software, refer to these publications:

    CIMPLICITY HMI for Windows NT and Windows 95 Base System Users Manual(GFK-1180). This book describes all the basic features of the CIMPLICITY HMIfor Windows NT and Windows 95 product.

  • GFK-1494 v

    ContentsIntroduction to CIMPLICITY Pager 1-1

    About CIMPLICITY Pager.................................................................................................... 1-1CIMPLICITY Pager Features .................................................................................. 1-2Supported Platforms ................................................................................................ 1-2About Paging Delays ............................................................................................... 1-2

    Overview of Pager Functions................................................................................................. 1-3Conceptual Overview............................................................................................................. 1-4

    Paging Concepts ...................................................................................................... 1-4Preparing to Configure the Pager ........................................................................................... 1-5Testing the Pager Installation................................................................................................. 1-6

    Testing on Windows NT.......................................................................................... 1-6Testing on Windows 95 ........................................................................................... 1-6

    Using the Paging Administrator 2-1Introduction to Pager Administrator....................................................................................... 2-1Starting the Pager Administrator............................................................................................ 2-2Managing the CENTRAL Database....................................................................................... 2-3

    Central Properties Fields.......................................................................................... 2-3Adding a Central ...................................................................................................... 2-7Modifying a Central................................................................................................. 2-7Deleting a Central .................................................................................................... 2-7Printing the CENTRAL Database............................................................................ 2-7

    Managing the PAGER Database ............................................................................................ 2-8Pager Properties Fields ............................................................................................ 2-8Adding a Pager....................................................................................................... 2-10Modifying a Pager ................................................................................................. 2-10Deleting a Pager..................................................................................................... 2-10Printing the Pager Database ................................................................................... 2-10

    FirstPAGE Client 3-1About FirstPAGE Client ........................................................................................................ 3-1Starting FirstPAGE Client...................................................................................................... 3-1Sending a Page ....................................................................................................................... 3-2Exiting FirstPAGE................................................................................................................. 3-3FirstPAGE Options ................................................................................................................ 3-3

    Auto-Sign................................................................................................................. 3-3Modifying Setup .................................................................................................................... 3-4PAGER Command Line Interface.......................................................................................... 3-5

    Command Format .................................................................................................... 3-5Sending a Page......................................................................................................... 3-5

  • vi CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    CIMPLICITY Pager Configuration 4-1About CIMPLICITY Pager .................................................................................................... 4-1Configuring Pagers................................................................................................................. 4-1

    CIMPLICITY Pager Configuration Menus.............................................................. 4-2CIMPLICITY Pager Configuration Toolbar Buttons .............................................. 4-3CIMPLICITY Pager Configuration Shortcut Keys.................................................. 4-3

    Creating A New Pager Action Definition............................................................................... 4-4Edit Pager Entries .................................................................................................... 4-5

    Deleting a Pager Action ......................................................................................................... 4-7Modifying a Pager Action ...................................................................................................... 4-7Using Escalation Schemes...................................................................................................... 4-8

    Creating a New Escalation Scheme ......................................................................... 4-8Modifying an Escalation Scheme............................................................................. 4-9

    Viewing Alarms by Recipient .............................................................................................. 4-10Viewing Distribution Lists ................................................................................................... 4-11

    Creating a Distribution List.................................................................................... 4-11Modifying a Distribution List ................................................................................ 4-12

    Pager Basic Extensions 5-1About Pager Methods............................................................................................................. 5-1GetPagerID(method) .............................................................................................................. 5-2GetPagerStatus(method)......................................................................................................... 5-2LastError(method).................................................................................................................. 5-3NCTI_Page_Send(function) ................................................................................................... 5-3SetPagerID(method)............................................................................................................... 5-4SetPagerStatus(method) ......................................................................................................... 5-5UpdateNow(method) .............................................................................................................. 5-5

    Appendix A - Modem Configuration A-1About Modem Configuration ................................................................................................ A-1

    Hayes V-series ULTRA Smartmodem.................................................................... A-1Intel SatisFAXtion Series........................................................................................ A-2Motorola Power 28.8 Series.................................................................................... A-2UDS FasTalk V.32/42b........................................................................................... A-2UDS FasTalk II ....................................................................................................... A-2US Robotics Sportster............................................................................................. A-3Xircom Creditcard PCMCIA Series........................................................................ A-3

    Appendix B - Environment Variables B-1About Environment Variables............................................................................................... B-1

    FP_PAGE................................................................................................................ B-2FP_PAGE_AUDFILE............................................................................................. B-2FP_PAGE_DATA................................................................................................... B-2FP_PAGE_EXE...................................................................................................... B-2FP_PAGE_HOST ................................................................................................... B-2FP_PAGE_INCOMING ......................................................................................... B-2FP_PAGE_INTERVAL.......................................................................................... B-2FP_PAGE_LOGFILE ............................................................................................. B-2FP_PAGE_LOGS ................................................................................................... B-3FP_PAGE_OUTGOING......................................................................................... B-3FP_PAGE_REJECTED .......................................................................................... B-3FP_PAGE_SLOGFILE........................................................................................... B-3

  • GFK-1494 Contents vii

    Appendix C - Troubleshooting Guide C-1About Troubleshooting ..........................................................................................................C-1Log and Audit Files................................................................................................................C-1

    FPSENDER.LOG ....................................................................................................C-1FPSENDER.AUD....................................................................................................C-4

    Appendix D Network Configuration D-1About Network Configuration .............................................................................................. D-1Creating the Shared Directory............................................................................................... D-2Directory Permissions ........................................................................................................... D-3

    H ............................................................................................................................. D-3Pager Directory Tree............................................................................................... D-5Pager Data Directory............................................................................................... D-5Pager EXE Directory .............................................................................................. D-5P .............................................................................................................................. D-5Pager Logs Directory .............................................................................................. D-6P .............................................................................................................................. D-6P .............................................................................................................................. D-6

    Registry Entries..................................................................................................................... D-7Paging Client Configuration.................................................................................................. D-8

    Appendix E - Server Redundancy E-1About Server Redundancy and the Pager...............................................................................E-1

    Operational Note......................................................................................................E-1

    Appendix F - Viewer Development F-1Viewer Development ............................................................................................................. F-1

    Glossary of Terms Glossary-Error! Bookmark not defined.

    Index Index-Error! Bookmark not defined.

  • GFK-1494 Glossary- i

    Glossary of Terms

    centralThe name of a paging service provider, who in turn, provides the Pager ID andcoverage information for each pager. During entry, PADMIN checks the CENTRALdatabase and will not allow pager entries that do not have corresponding serviceentries in the CENTRAL database. If you are entering pagers for a new serviceprovider or a new coverage category for an existing service provider, be sure to makethe CENTRAL entry first.

    coverageThe type of geographic area in which an individual pager can receive messages.Coverage types can be National, Regional or Local. The type of coverage for anindividual pager is determined by subscription arrangements made with the serviceprovider.

    hostnameThe name used to designate the computer that hosts the page server. Its primaryfunction is for routing pages in systems installed on networks.

    pager IDThe ID number of the pager, provided by the paging service provider.

    port nameThe name of the communications port (for example, COM1, LTA1) to which themodem is connected.

  • GFK-1494 1-1

    Introduction to CIMPLICITY Pager

    About CIMPLICITY Pager

    Tank 36Low Level Alarm

    You can use CIMPLICITY Pager to send process alarms to standardalphanumeric or numeric pagers carried by your mobile workforce. Theonly additional hardware that is required is a modem and youralphanumeric pager.

    CIMPLICITY Pager is based on NETCONs FirstPAGE technology.NETCON possesses over 15 years of experience in the paging industry.

    The client / server architecture of CIMPLICITY Pager avoidsduplication of configuration information, which is required bycompetitive paging products based on DDE. Following GE Fanucscommitment to open standards, this option provides for the completeintegration of your CIMPLICITY HMI alarms with internal and externalpaging systems. This is accomplished by adopting the standardIXO/TAP protocols used by the most common paging systems. YourCIMPLICITY Alarms can be routed to the alphanumeric pagers. Yes,even to the one you are currently wearing on your belt. Within yourplant, or around the world, you are now always up to date with the lateststatus of your operations.

    CIMPLICITY Pager helps you address these types of concerns:

    What is the current production count?

    How can I be alerted if a critical process is trending out of spec beforeits too late?

    Has a process shut down?

    Do I need to call the plant to check up on a condition?

  • 1-2 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    CIMPLICITY Pager FeaturesCIMPLICITY Pager Features include:

    Routing of alarm messages to any standard alphanumeric pagers such asSky-Tel, local city paging systems, or internal plant systems utilizingthe standard IXO/TAP Serial Protocols.

    On line configuration of users and paging numbers.

    Enable or disable users from receiving pages.

    Escalation of pages

    Filtering of pages based on CIMPLICITY resources, alarm classes, oralarm IDs.

    Dynamic on-line configuration changes.

    CIMPLICITY Basic Control Engine interface for automatically sendingpages, changing a users pager number, or disabling a page.

    Customizable pager messages.

    Configuration templates for fast setups.

    Support of distribution lists.

    Supported PlatformsYou can use the CIMPLICITY Pager option on Intel Windows NT and IntelWindows 95 computers.

    You currently cannot use the CIMPLICITY Pager on DEC Alpha computers.

    About Paging DelaysWhen you send out a page, there is a delay. This delay varies from system to systemand is based on two main factors:

    The pager service interval, which you define in the PagingAdministrator, determines how often the Pager Server connects to yourpager service provider and uploads the queued pages. This may inducesome delay.

    The pager service may induce some delay as the page request movesthrough the service's internal networks.

  • GFK-1494 Introduction to CIMPLICITY Pager 1-3

    Overview of Pager FunctionsThe following diagram shows you how the Pager functions work with one another.

    The Paging Server receives CIMPLICITY Alarms and uses the information in theCENTRAL Database, the PAGER Database, the Routing Lists and the EscalationSchemes to route the CIMPLICITY Alarms to pagers via the Pager modem.

    You use the Paging Administrator to configure the CENTRAL and PAGERDatabases. For more information on the Paging Administrator and the databases, seeChapter 2.

    You can use the FirstPAGE Client to interactively send a page to a pager. For moreinformation on the FirstPage Client, see Chapter 3.

    You use the CIMPLICITY Pager Configuration to configure the Alarm Routing Listsand Escalation Schemes for each CIMPLICITY HMI alarm. Routing Lists determinewho receives notification of an alarm. Escalation Schemes determine who elsereceives notification of an alarm after a configurable amount of time. For moreinformation on the CIMPLICITY Pager Configuration, see Chapter 4.

  • 1-4 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    Conceptual OverviewCIMPLICITY Pager uses two databases to determine how to send pages to yourpeople who carry pagers. These databases are the CENTRAL database and thePAGER database.

    The CENTRAL Database contains information regarding which Centraland Coverage combinations are supported from each server in yourPager network.

    The PAGER Database contains the list of people who carry pagers andinformation about them, including who provides their paging serviceand what coverage they have subscribed to.

    This database also contains information on how to move pages betweenthe Pager servers in your network.

    Paging ConceptsThe CENTRAL and PAGER Databases, maintained via the Pager Administrator, areused to configure Pager for your paging requirements. These configuration files areshared by all projects running on your computer.To demonstrate how these files are used, we will use a sample scenario. MIS Inc. hasbeen using a company called NCTI to provide paging to its employees. NCTI hasoffices located across the country in the provinces of Alberta, Ontario and Quebec.NCTI lets you subscribe to either National Coverage or coverage in a particularprovince only. Coverage is the geographical area in which your pages will transmit.For example, if you subscribe to Alberta Coverage and take a trip to Ontario, youwill not receive any pages. In each province, there is a different telephone number tobe called to submit pages for pager-users subscribing to coverage within thatprovince. In Alberta, another telephone number needs to be called for pager-userssubscribing to National Coverage (these users can receive pages across the country).MIS Inc. has the following four entries in the CENTRAL database:

    Central Name Coverage Name Phone NumberNCTI NATIONAL 555-0000

    NCTI Alberta 555-1111

    NCTI Ontario 555-2222

    NCTI Quebec 555-3333A person who works in Ontario and has a pager would be assigned to the CentralNCTI with the Coverage Ontario. Since the head office of MIS Inc. is located in theprovince Alberta, there will probably be a few people there with the Central of NCTIand the Coverage of NATIONAL so that they will get their pages if they are visitinga regional office in another province.

  • GFK-1494 Introduction to CIMPLICITY Pager 1-5

    Since NCTI has become very successful, there is a new competitor to NCTI calledCHEAPBEEP. CHEAPBEEP has started to offer coverage in Ontario. A cost-conscious employee discovered that Ontario coverage from CHEAPBEEP is muchless expensive than with NCTI. Therefore, the sales office has decided to useCHEAPBEEP for its sales force. Now, another entry would be required in theCENTRAL Database in that office:

    Central Name Coverage Name Phone NumberCHEAPBEEP Ontario 333-4444

    You will now use the preceding Central information to make entries into the pagerdatabase for each users pager.

    MIS Inc. has the following four entries in the PAGER Database:

    User Central CoverageALBERTA_SALESMAN NCTI ALBERTA

    MR_EXECUTIVE NCTI NATIONAL

    QUEBEC_SALESMAN NCTI QUEBECONTARIO_SALESMAN CHEAPBEEP ONTARIO

    Preparing to Configure the PagerBefore you start to configure your Pager system, you need to:

    Contact your pager provider (Central) and ask them what the dial-intelephone numbers are for all coverages in which you have pager users.

    Contact your pager provider (Central) and ask them what the IXO pagerIDs or CAP Codes are for each pager you are going to use with Pager.

    Configure your modem(s) to function with standard communicationssoftware for the platform you are using. Your modem must also haveerror correction and compression protocols disabled. See "Appendix B- Modem Configuration" for details.

  • 1-6 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    Testing the Pager InstallationAfter you install the CIMPLICITY HMI Pager option, you should verify that thePager service has started correctly. The verification procedure you use depends onyour computers operating system.

    After you verify that the Pager service is started, you can start the PagerAdministrator and configure your paging system.

    Testing on Windows NTOn a Windows NT computer:

    1. Reboot the computer.

    2. From the Start menu, select Control Panel.3. In the Control Panel, open the Services window.

    4. In the Services window, confirm that the Pager service has a status ofStarted and a startup of Automatic.

    If the Pager service is not started, verify that you have licensed the CIMPLICITYHMI Pager option.

    After you license the option, reboot the computer and repeat the steps above to verifythat the Pager service is now started.

    Testing on Windows 95On a Windows 95 computer:

    1. Reboot the computer.

    2. Verify that the FirstPage process displays a splash screen on startup.

    If the Pager service is not started, verify that you have licensed the CIMPLICITYHMI Pager option.

    After you license the option, reboot the computer and repeat the steps above to verifythat the Pager service is now started.

  • GFK-1494 2-1

    Using the Paging Administrator

    Introduction to Pager AdministratorWhen a user creates a page through the pager client software module, the pagingserver:

    Supplies the list of available pagers from the PAGER Database.

    Ensures that the message being composed is compatible with thecharacteristics of the pager selected.

    Queues messages for transmission to the pager service provider.During transmission, the paging server

    Uses the CENTRAL database to look up the telephone number neededto contact each pager,

    Connects to the pager service provider,

    Transmits the pages, monitors the status of transmitted pages, and

    Maintains a log of all activities.

    In addition to maintaining the PAGER and CENTRAL databases, you need tounderstand and set environment variables that adapt the paging system to operatingconditions unique to each installation. All databases are controlled through thePager Administrator program, which provides a simple, menu-driven interface forviewing, printing, adding, deleting and modifying information in these files.

  • 2-2 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    Starting the Pager AdministratorTo administrate your paging system, select the Pager Administrator icon from theCIMPLICITY program group.

    The Pager Administrator window opens.

    You can use the Tab key to navigate down fields and the Shift + Tab keys tonavigate up fields.The Pager Administrator window contains two property pages, Pager and Central.

    The Pager property page lets you maintain pagers used with thesystem. You can perform standard database manipulations on thePAGER Database, as well as display and print the pagers currently inthe database.

    The Central property page lets you maintain pager service providersused with the system. You can perform standard databasemanipulations on the CENTRAL Database, as well as display and printthe service providers currently defined in the system.

    The About option in the Help menu displays the version of Pager Administratorthat you are running.

  • GFK-1494 Using the Paging Administrator 2-3

    Managing the CENTRAL DatabaseThe CENTRAL database contains dispatch information, for use by the page server,to transmit pages. You can use the Central property page to:

    Display records in the CENTRAL Database.

    Add records to the CENTRAL Database.

    List, print, modify and delete an existing record in the CENTRALDatabase.

    Central Properties FieldsThe fields in the Central property page are:

    CentralThe Central field contains the abbreviated name of paging service provider for thisentry. The Central and Coverage fields provide the look-up field that joins theCENTRAL Database and the PAGER Database. This field must contain a minimumof 5 characters. It is recommended the name selected relate to the service providername.

    Examples:CANTELBELLSKYPAGE

  • 2-4 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    CoverageThe Coverage field contains an abbreviated name indicating the paging coverageassociated with this entry. This field must contain a minimum of 5 characters. It isrecommended the name selected relate to the service providers coverage option.The Central field is used in combination with the Coverage field to relate Centralentries to the PAGER Databases.Examples:

    NATIONALLONDONCALIFORNIA

    Host NameThe Host Name field contains the name of the computer that hosts the Pagingserver. Its primary function is for routing pages in systems installed on networks.For this version of the software, the host name should be the same as your computername.

    Port NameThe Port Name field contains the name of the communications port on which themodem is connected. See "Appendix B - Modem Configuration for details.

    Examples:COM1

    Port SpeedThe Port Speed field contains the speed of the port/modem. Set this field to themaximum connection speed that your provider supports. If this is unknown, try 300or 1200. The default value is 1200.

    Examples:12002400

    Modem TypeThe Modem Type field contains the type of modem connected. It will be HAYESfor any Hayes compatible modem or DIRECT for a direct connection. Pleasecontact GE Fanuc for additional information when using a direct connection.

    Setup StringThe Setup String field contains the setup string needed to initialize the modem. Itshould include the commands required to disable compression and error correction.See "Appendix B - Modem Configuration" for details.

  • GFK-1494 Using the Paging Administrator 2-5

    Phone #The Phone # field contains the telephone number of the modem the paging serviceprovider uses to accept IXO pages.

    For Touch-Tone dialing, put a T in front of the telephone number.

    For Pulse dialing, put a P in front of the telephone numberConsult your modem manual for additional special characters.

    Examples:T9,5551212P14165551212

    IXO PasswordThe IXO Password field contains the password required by the paging serviceprovider to gain access to the paging coverage. If you havent been given apassword by your service provider, enter "0" in this field.

    Examples:00000112

    Alpha LengthThe Alpha Length field contains the maximum number of digits allowed, by theservice provider, for an alphanumeric pager. The default value is 80.

    Numeric LengthThe Numeric Length field contains the maximum number of digits allowed, by theservice provider, for a numeric pager. The default value is 20.

    Max ConnectThe Max Connect field contains the maximum connect time, in seconds, allowedby the paging service provider for the modem connection. This field controls howmany pages the server will attempt to transmit at a time. The value set in this fieldshould be slightly less than the actual maximum set by the service provider in orderto avoid being disconnected during transmission of a page message. The defaultvalue is 90 seconds.

    ProtocolThe Protocol field contains the language used for communicating with the pagingservice provider. The default value is IXO.

    VersionThe Version field contains the version number of the language listed in the Protocolfield.

  • 2-6 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    NoteThe Note field contains notes for the system managers use.The following examples of Central entries illustrate how these parameters canchange with different choices of service provider.

    The following is an example:

    Central BELLMOB Service provided by Bell Mobility.Coverage LONDON Local coverage.Host Name NCTI1 Server name, in this case a Windows

    NT PC.Port Name COM2 Port name where the modem is

    connected (do not enter a colonfollowing the port name).

    Port Speed 2400 Speed of the port/modem.Modem Type HAYES Denotes a Hayes compatible modem

    connected to the port.Setup String AT AT command sent to modem at each

    central call.Phone # T5552345 Telephone number to dial on the

    modem(Touch-Tone dialing).

    IXO Password 1 The IXO password.Alpha Length 80 Max. 80 characters per page. Longer

    pages will be broken into 80 charactersegments.

    Numeric Length 20 Max. 20 characters per page. Longerpages will be broken into 20 charactersegments.

    Max. Connect Time 90 Maximum of 90 seconds allowed onIXO modem.

    Protocol IXO Protocol to be used to connect to theservice provider.

    Version V1.0 Version of the protocol to be used.Note Plant floor pagers The manager noted here that the pagers

    used on the plant floor use thiscoverage.

  • GFK-1494 Using the Paging Administrator 2-7

    Adding a CentralTo add a record in the CENTRAL Database, select Add, and then enter informationin the fields on the right-had side of the property page. When you are done, selectSave to add the record to the CENTRAL Database. The new records Central andCoverage fields also now appear in the Centrals Table on the property page.

    Modifying a CentralTo modify a record in the CENTRAL Database, select the Central name from theCentrals Table, and then modify the fields on the right-hand side of the propertypage. When you are done, select Save to update the record in the CENTRALDatabase.

    Deleting a CentralSelect the name of the Central that you want to delete from the Centrals Table andselect Delete. You will be prompted with the following message:

    Are you sure you want to delete this record?

    Select Yes to delete the record. Select No to cancel the delete request and return tothe property page.

    Printing the CENTRAL DatabaseSelect Print Central File from the File menu. This will print details for all Centralentries to the Windows default printer.

  • 2-8 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    Managing the PAGER DatabaseThe PAGER Database contains information about individual pagers. You can usethe Pager property page to:

    Display records in the PAGER Database.

    Add records to the PAGER Database.

    List, print, modify and delete an existing record in the PAGERDatabase.

    Pager Properties FieldsThe fields in the Pager property page are:

    UserThe User field contains the name to be associated with the pager.Examples:

    BURNS,HEATHERONCALLNETMANAGER

    TitleThe Title field contains the title associated with the user of the pager.Examples:

    Sales RepresentativeTechnicianNetwork Manager

  • GFK-1494 Using the Paging Administrator 2-9

    CentralThe Central field contains the abbreviated name of the pager service provider. Thisfield is combined with the Coverage field to link the pager with the appropriateentry in the CENTRAL database. During entry, Page Administrator checks theCENTRAL database and will not allow pager entries that do not have correspondingservice entries in the CENTRAL database. If you are entering pagers for a newservice provider or a new coverage category for an existing service provider, be sureto make the CENTRAL entry first.

    Examples:CANTELBELL_MOBILSKYPAGE

    CoverageThe Coverage field contains the abbreviated name of the type of coverage (forexample, National vs. Regional) for the pager. During entry of this field, PADMINalso checks the CENTRAL database to verify that the coverage specified is listed forthe CENTRAL you have specified. The Central and Coverage specified for eachpager in the PAGER database must match the service actually subscribed for thatpager.

    Examples:NATIONALLONDONCALIFORNIA

    IDThe ID field contains the ID number of the pager, provided by the paging serviceprovider.Examples:

    50167261032451456

    TypeThe Type field contains a single letter (N or A) to indicate the type of message (thatis, numeric or alphanumeric) that the pager can accept.

    NoteThe Note field contains notes for the system managers reference.Examples:

    Voice Mail # 519-555-1212The pager of the network technician

  • 2-10 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    Adding a PagerTo add a record in the PAGER Database, select Add, and then enter information inthe fields on the right-had side of the property page. When you are done, selectSave to add the record to the PAGER Database. The new records Central andCoverage fields also now appear in the Pager Table on the property page.

    Modifying a PagerTo modify a record in the PAGER Database, select the Pager name from the PagerTable, and then modify the fields on the right-hand side of the property page. Whenyou are done, select Save to update the record in the PAGER Database.

    Deleting a PagerSelect the user name of the pager that you want to delete from the Pager Table andthen select Delete. You will be prompted with the following message:

    Are you sure you want to delete this record?

    Select Yes to delete the record. Select No to cancel the delete request and return tothe Pager property sheet.

    Printing the Pager DatabaseSelect Print Pager File from the File menu. This will print details of all pagerentries to the Windows default printer.

  • GFK-1494 3-1

    FirstPAGE Client

    About FirstPAGE ClientYou can use the FirstPAGE Client to send interactive ad-hoc messages to pagers.You can send a message to a single pager or a set of pagers. You can also user thePager command line interface to send ad-hoc messages.

    Starting FirstPAGE ClientTo interactively send a page to a pager, select the FirstPAGE Client icon from theCIMPLICITY program group.The FirstPAGE for Windows dialog box opens.

  • 3-2 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    Sending a PageTo send a page in FirstPAGE client:

    1. Select a pager user in the Name field from the list of names in thedrop-down list.

    2. Enter your message in the Message field.If the user you have chosen has a numeric pager, you will be limited totyping numeric characters (that is, the numbers 0,1,2...9).You cannot send an empty message.

    3. Press Enter or click Send to send the message.If you have typed a message longer than is supported by the serviceprovider, FirstPAGE will break up the message into multiple pages.

  • GFK-1494 FirstPAGE Client 3-3

    Exiting FirstPAGETo exit FirstPAGE, select Exit from the File menu or click the Exit button locatedon the FirstPAGE button bar.

    FirstPAGE Options

    Auto-SignAuto-Sign appends a signature to every message you send (with the exception ofmessages to numeric users). To create an automatic signature:

    1. Choose Signature from the Options menu to set your signature. TheAutomatic Signature dialog box opens.

    2. In the Automatic Signature dialog box, type your signature in theAutomatic Signature text box.

    3. To have FirstPAGE append your signature, select the On / Off checkbox.

    4. Click OK to save your changes or click Cancel to close the dialog boxwithout saving your changes.

  • 3-4 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    Modifying SetupIf you change the location of the data files, you must tell FirstPAGE where they are.To do this:

    1. Select Setup from the Options menu. The FirstPAGE Setup dialogbox opens.

    2. In the FirstPAGE Root Directory text box, type in the path of thedirectory where the FirstPAGE directories can be found or select thedirectory from the Select Drive and Select Directory list boxes.

    3. Click OK to save your changes or click Cancel close the dialog boxwithout saving your changes.

  • GFK-1494 FirstPAGE Client 3-5

    PAGER Command Line InterfacePager is the end-user command line interface to the page server. You can use it tosend pages to users.

    Command FormatThe format for the utility is as follows:

    C:\> PAGER pagename "Message to send to pager"

    The pagename portion of the above commands can be replaced with a distributionlist file which is a normal text file with one pager name per line. For example, thePAGELIST.TXT file contains:

    BURNS,SCOTTMCRAE,MIKEBERARD,MANON

    To page all of these people at the same time, use the following format:C:\> PAGER @pagelist.txt Message to send to pager

    The pagelist.txt file name is only an example. You can use any valid operatingsystem file name. Directory specifications can be specified with the file name aswell.

    If you are unsure of the exact spelling of a persons name, you may look up the pagerentry with the following format:

    C:\> PAGER -L BURN

    In order to display the version number type:C:\> PAGER -V

    Sending a PageThe following examples demonstrate how to send a page to a user calledSMITH,DOUG. You, SCOTT, wished to page him with the message "Meet me forlunch at 2:00". To do this, use the following command:

    C:\> PAGER SMITH,DOUG "Meet me for lunch at 2:00"

    Now Doug will receive a page saying:

    Meet me for lunch at 2:00There is only one problem with this message; Doug doesnt know who you are. It issuggested that you sign your pages with either your initials or some other word thatlets the page-receiver associate this page with you. For example:

    C:\> PAGER SMITH,DOUG "Meet me for lunch at 2:00 -Scott"

  • GFK-1494 4-1

    CIMPLICITY Pager Configuration

    About CIMPLICITY PagerUse CIMPLICITY Pager Configuration to configure pager actions for alarmsgenerated by CIMPLICTIY HMI software. The CIMPLICITY Alarm message canbe routed to your users alphanumeric pagers after the alarm has been active for aconfigurable amount of time.

    Configuring PagersTo configure pager actions, double-click the Pager icon from your projectsConfiguration Cabinet.When the CIMPLICITY Pager Configuration window opens it displays a list of thealarms that currently have pager actions associated with them.

    The CIMPLICITY Pager - Configuration window always displays the following foreach alarm:

    Alarm ID The Alarm ID of the alarm which has pager actionsdefined

    Alarm Class The Alarm Class to be matched for that alarm.

  • 4-2 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    Resource ID The Resource ID to be matched for that Alarm ID andAlarm Class

    Escalation Scheme The escalation scheme assigned to this pager action.Recipients A + separated list of recipients and their escalation

    levels in [].The list of pager actions is initially sorted by Alarm ID. You may click on any ofthe other title buttons at the top of the list to sort the list by that attribute.

    CIMPLICITY Pager Configuration MenusYou can use the menus on the Menu Bar to create new entries, modify, copy, ordelete existing entries, and access Help. The View menu option will allow you tochange which tab is currently active on the main form.

    The File MenuWhen you select the File menu, the following drop-down list displays:

    The File menu functions are:

    New Entry Creates a new pager definition.Update Now Forces the pager process to be updated dynamically with your

    latest changes

    Exit Exits the CIMPLICITY Pager - Configuration function andforces the pager process to be updated with your latest changes

    The Edit MenuWhen you select the Edit menu, the following drop-down list displays:

    The Edit menu functions are:Delete Deletes the currently selected item.Modify Modifies the currently selected item.

    The View MenuWhen you select the View menu, the following drop-down list displays:

    The View menu functions are:Alarm Pager Entries Activates the Alarm Pager Entries tab.Alarms by Recipients Activates the Alarms by Recipients tab.

  • GFK-1494 CIMPLICITY Pager Configuration 4-3

    Distribution Lists Activates the Distribution Lists tab.

    The Help MenuWhen you select the Help menu, the following drop-down list displays:

    The Help menu functions are:About CIMPLICITY Pager Displays the Pager About form.

    CIMPLICITY Pager Configuration Toolbar ButtonsThe Toolbar buttons available to you are:

    New Item Creates a new pager action.

    Delete Deletes the selected pager action.

    Modify Displays and modifies the properties for the selectedpager action.

    CIMPLICITY Pager Configuration Shortcut KeysYou can use various combinations of keystrokes in CIMPLICITY Pager -Configuration to perform commonly used functions. The following are the morecommonly used functions available for your use:

    Ctrl+N Creates a new pager action.Ctrl+M Modifies the selected pager action.

  • 4-4 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    Creating A New Pager Action DefinitionTo create a new pager action definition, you can do one of the following:

    Click New Entry from the File menu. Click New Entry on the Toolbar. Press Ctrl+N.

    After you initiate the request, the Add Alarm Pager Entries dialog box opens.

    Enter the name of the Alarm ID, Alarm Class, and Resource ID you wish tocreate an alarm action for and click OK. Alternatively, you may click the Browsebutton to populate the list boxes on the bottom of the form. You may then use theselist boxes to select the Alarm ID, Alarm Class and Resource ID you wish tomonitor.

    You can use the following wildcards in any of the three fields:

    * Use this wildcard to search for any number of characters at this point in thestring. For example, if you want to create an entry for all Alarm IDs startingwith "M" and ending with "X", enter M*X in the Alarm ID field.

    ? Use this wildcard to search for any character in this place in the string. Forexample, if you want to create an entry for any Resource IDs that are threecharacters long, and whose first character is "M" and third character is "X",enter M?X in the Alarm ID field.

    Note

    There are no implied wildcards. If you do not include or terminate your search stringwith an asterisk, only those items that match your request exactly will be returned.

  • GFK-1494 CIMPLICITY Pager Configuration 4-5

    Edit Pager Entries

    Once these entries are complete, the Edit Pager Entries dialog box for the new pageraction opens. You need to enter information in the following categories:

    Pager DisplayEnter information in the following fields:

    Message for Escalation LevelThe Pager message can be customized for any of the escalation levels.

    For more on escalation levels, see "About Escalation Schemes".

    Same display for every escalation levelSelect this check box to indicate that the same display options will beused for each escalation level.

    Message PrefixEnter an optional prefix to be added to the start of the message.

    Display alarm text on pagerSelect this check box to send the text of the alarm message to the pager.In most cases, you will want to send the alarm text to the pager.In the case of a numerical pager, the alarm text can be omitted from themessage and the message prefix can be used to indicate the numericalmessage to route.

    Message SuffixEnter an optional suffix to be added at the end of the message.

  • 4-6 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    Clear StatesThe Clear States specify when the alarm should no longer be sent to pagers. Forexample, once the alarm is acknowledged routing the message to the pager may notbe appropriate. When any of the conditions checked occur, the alarm will no longerbe paged.

    Acknowledge Select this check box to stop paging if the alarm becomesacknowledged.

    Reset Select this check box to stop paging if the alarm becomesreset.

    Delete This check box is always selected. Once the alarm isdeleted, paging is no longer possible.

    Escalation queue timingUse this group to select the escalation queue to be used for this event.

    Scheme Select a scheme from the combo box to be used for this pagingevent. You can also:

    Click Edit to edit the selected escalation scheme. Click New to add a new escalation scheme.

    Pager recipientsUse this section to add and remove recipients for this paging event and to assign arecipient to an escalation queue.

    Add After selecting one or more recipients from the Availablerecipients list box, press the Add button to add them.

    Remove After selecting one or more recipients, press the Removebutton to remove them from this paging event.

    Escalation Level After selecting a paging recipient in the right list box, youcan press the + and - buttons to increase or decrease theescalation queue associated with the recipient.In the above example, @QUE_SUPPORT is associatedwith escalation queue one, [email protected]_SUPPORT is associated with escalationqueue two.

  • GFK-1494 CIMPLICITY Pager Configuration 4-7

    Deleting a Pager ActionTo delete a pager action, click the Alarm ID of the pager action you want to delete,then do one of the following:

    Click Delete from the Edit menu. Click Delete Item on the Toolbar.

    Press Del.After you initiate the request, the Delete Selected Records dialog box opens.

    Click Yes to close the dialog box and delete the selected pager action. The list ofalarms on the CIMPLICITY Pager - Configuration window is automatically updated.Click No to close the dialog box without deleting the selected pager actionClick Cancel to close the dialog box without deleting the selected pager action.

    Modifying a Pager ActionTo modify a pager action, you can do one of the following:

    Double-click the Alarm ID of the pager action you want to modify.

    Click Modify from the Edit menu. Click Modify Item on the Toolbar. Press Ctrl+M.

    After you initiate the request, the Edit Pager Entries dialog box opens. Theproperties contain the current configuration information for the selected alarm. Youcan modify any of these properties.

    Click OK to close the Edit Pager Entries dialog box and modify the information forthe selected alarm.

    Click Cancel to close the Edit Pager Entries dialog box without modifying thealarm.

  • 4-8 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    Using Escalation SchemesEscalation schemes allow an alarm to be escalated to a new group of pagers after aconfigurable amount of time. You can define up to five levels in an escalationscheme. This provides flexibility in notifying the right group of people at the righttime.

    The first level is addressed first. If the alarm persists, escalation proceeds to the nextlevel. In the Edit Pager Entries dialog box you can specify which list of recipientsreceive the alarm at each of the five levels.

    Creating a New Escalation SchemeTo create a new escalation scheme, select New in the Edit Page Entries dialog boxunder the Escalation Queue Timing area of the form.After you initiate the request, the Edit Escalation Queue dialog box opens.

    Enter the name of the escalation scheme in the Escalation scheme field.Select each Escalation level, from 1 to 5, and set the attributes for each level. Thescreen above shows the screen layout when configuring escalation level 1. Use thefirst radio button to set an initial delay before starting to send pages once an alarmbecomes active.

    Use No. of pages to send to define how many pages will be sent to the pagersassigned to this escalation level. Enter 0 (zero) in this field to send pages to thislevel until the alarm is cleared.

    Use Time between pages (min) to define the delay between these pages.

  • GFK-1494 CIMPLICITY Pager Configuration 4-9

    After you configure level 1, and then select a higher level, the screen changes to thefollowing format if the No. of pages to send is not set to 0:

    At this point, you can select to have this level activate after the previous levelcompletes, or you can control the absolute time at which this level will start. Thenumber of minutes shown in brackets after the first radio button, is the number ofminutes until the previous levels have all exhausted their entire escalationparameters. All other screen items are the same as the items displayed whenconfiguring a first level escalation.

    There is a default escalation scheme, called DEFAULT, which provides thefollowing escalation:

    Level Initial Delay Page Count Page Delay1 0 5 52 25 (After Level 1) 5 53 50 (After Level 2) 5 54 75 (After Level 3) 5 55 100 (After Level 4) 5 5

    You may alter the default scheme if you desire. Schemes are unique to each project,so modifying a schemes parameters in one project will not modify a scheme of thesame name, in another project.

    Modifying an Escalation SchemeTo modify an escalation scheme:

    1. Click the Edit button on the Edit Pager Entries screen under theEscalation Queue Timing area of the form.After you initiate the request, the Edit Escalation Queue dialog boxopens. The properties contain the current configuration information forthe selected scheme. You can modify any of these properties.

    2. Click OK to close the Edit Escalation Queue dialog box and modifythe information for the selected scheme.

    3. Click Cancel to close the Edit Escalation Queue dialog box withoutmodifying the scheme.

  • 4-10 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    Viewing Alarms by RecipientTo view Alarms by Recipient you may:

    Select Alarms by Recipient from the View menu. Click the tab entitled Alarms by Recipient.

    After you make the selection, the Alarms by Recipient property page opens.

    When you select a User or Distribution List entry from the User / DL pull-down list,you will see the list of associated alarms for which this pager is configured. Whenyou select a user, all alarms associated with distribution lists for which the user is amember will also be displayed.

    Set the Disable pages to user check box to disable any pages associated with thisuser. The association will not be broken but no pages will be sent if these alarmsbecoming active.

  • GFK-1494 CIMPLICITY Pager Configuration 4-11

    Viewing Distribution ListsTo view Distribution Lists you may:

    Select Distribution Lists from the View menu. Click the tab entitled Distribution Lists.

    After you make the selection, the Distribution Lists property page opens.

    You can use the Distribution Lists tab to:

    Display a selected distribution list

    Create a new distribution list

    Add pagers to or remove pagers from a distribution list.

    Note that all distribution lists begin with the @ character.

    Creating a Distribution ListTo create a new distribution list:

    1. Click New button on the Distribution Lists tab.After you initiate the request, the Add New Distribution List dialog box

    2. Enter the name of the distribution list you wish to create and select OK.The Distribution Lists tab redisplays with the new distribution list.

    3. Use the Add and Remove buttons to add or remove pagers to/fromthe distribution list.

  • 4-12 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    Modifying a Distribution ListTo modify a distribution list

    1. Enter the distribution list name in the Distribution List input field.You can use the pull-down tab to the right of the field to display thecurrent distribution lists and select one.

    2. Use the Add and Remove buttons to add or remove pagers to/fromthe distribution list.

    All changes that you make are immediate.

  • GFK-1494 5-1

    Pager Basic Extensions

    About Pager MethodsThe pager basic extensions are available only from a server with the Paging softwareinstalled. The extensions are not available, for example, on a viewer since theviewer does not run the Paging Software. However, using standard CIMPLICITYinterfaces a user can easily have a viewer send a page. Two methods are:

    Have the viewer generate an alarm on the server that is routed to apager.

    Have the viewer set a text point and have the event manager run ascript in response to the text point to send a page.

    There are six methods in the CimPagerInterface:

    GetPagerID Obtains a Pagers Numerical IDGetPagerStatus Returns the Status of a pager. (0 = disabled, 1 = enabled)LastError Returns a string describing the last errorNCTI_Page_Send Sends a page to a user.SetPagerID Sets a Pagers Numerical IDSetPagerStatus Sets the status of a pagerUpdateNow Saves the changes to the data, and signals the paging

    engine

  • 5-2 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    GetPagerID(method)Syntax GetPagerID ( name, id )Description Obtains a Pagers Numerical ID. Returns an Integer containing the status of the

    request. The return code will be one of the following:

    0 (False) = Success-1 (True) = Error

    Comments The GetPagerID method accepts the following parameter:Parameter Descriptionname String containing the name of the Pager.

    id String that returns the Pager IDExample

    Dim o AS Object, iResult as integer, sID as stringSet o = CreateObject("FPageCimAPI.CimPagerInterface")iResult = o.GetPagerID("SMITH,JOE",sID)

    GetPagerStatus(method)Syntax GetPagerStatus ( name )Description Gets the status of a pager. Returns an Integer containing the status of the

    specified pager. The return code will be one of the following:

    0 = pager is disabled1 = pager is enabled-1 = error

    Comments The GetPagerStatus method accepts the following parameter:Parameter Descriptionname String containing the name of the pager.

    ExampleDim o AS Object, iResult as integerSet o = CreateObject("FpageCimAPI.CimPagerInterface")iResult = o.GetPagerStatus("SMITH,JOE")

  • GFK-1494 Pager Basic Extensions 5-3

    LastError(method)Syntax LastErrorDescription Returns a String describing the last error.

    Reading LastError clears the error message.

    ExampleDim o AS Object, sResult as stringSet o = CreateObject("FPageCimAPI.CimPagerInterface")sResult = o.LastErrorif sResult "" then msgbox sResult

    NCTI_Page_Send(function)Syntax NCTI_Page_Send ( user, mess, actualuser )Description Queues a page for sending to the specified user and the Paging Server.Comments The NCTI_Page_Send function accepts the following parameter:

    Parameter Descriptionuser String specifying the name of the user to page

    mess String containing the message to send.

    actualuser A minimum of 100 bytes of writable space. Contains thecomplete username if user uniquely identifies a user but wasnot the complete name.

    ExampleDeclare Function NCTI_Page_Send Lib "nctipg32.dll"_ ( ByVal user As String,_ ByVal mess As String,_ ByVal actualUser As String) As Long

    Sub Main() Dim status As Long Dim realuser As String Allocate some space to store the name realuser = Space(100) status = NCTI_Page_Send("BURNS", "Process temperature out ofrange",realuser)

    End Sub

  • 5-4 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    SetPagerID(method)Syntax SetPagerID ( name, id )Description Sets a Pagers Numerical ID. Returns a Boolean containing the status of the

    request. The return code will be one of the following:

    0 (False) = Success-1 (True) = Error

    Comments The SetPagerID method accepts the following parameter:Parameter Descriptionname String containing the name of the Pager.

    id String containinf the new Pager IDNotes id must contain only numeric characters, and must be no longer than 10 characters

    It is not necessary to perform an UpdateNow after a SetPagerID. Pager IDsare resolved immediately before a page is sent.

    A SetPagerID can affect more than the current project. Changes made withSetPagerID will affect every process using the same FirstPAGE Server.

    ExampleDim o AS Object, iResult as booleanSet o = CreateObject("FPageCimAPI.CimPagerInterface")iResult = o.SetPagerID("SMITH,JOE","1234")

  • GFK-1494 Pager Basic Extensions 5-5

    SetPagerStatus(method)Syntax SetPagerStatus ( name, status )Description Sets the status of a pager. Returns an Integer containing the status of the

    specified pager. The return code will be one of the following:

    0 (False) = Success-1 (True) = Error

    Comments The SetPagerStatus method accepts the following parameter:Parameter Descriptionname String containing the name of the pager.

    status Boolean containing the new status of the pager.

    Notes There are two different files that must be changed in order to properly enable ordisable a pager.

    The file that stores the status of each pager

    The file that the paging engine reads.

    The SetPagerStatus method only changes the status file. In order for thechange in status to take effect, you must invoke the UpdateNow method, whichsignals the paging engine to re-analyze the paging rules. An UpdateNow can bepreformed at any time through the .dll, or from the Pager Configuration icon in theproject cabinet.

    ExampleDim o AS Object, iResult as booleanSet o = CreateObject(FPageCimAPI.CimPagerInterface)iResult = o.SetPagerStatus(SMITH,JOE,false)...

    iResult = o.UpdateNow

    UpdateNow(method)Syntax UpdateNowDescription Saves the changes to the data, and signals the paging engine. Returns an Integer

    containing the status of the update request. The return code will be one of thefollowing:

    0 (False) = Success-1 (True) = Error

    ExampleDim o AS Object, iResult as booleanSet o = CreateObject("FPageCimAPI.CimPagerInterface")iResult = o.setPagerStatus("SMITH,JOE",false)...

    iResult = o.UpdateNow

  • GFK-1494 A-1

    Appendix A - ModemConfiguration

    About Modem ConfigurationIXO/TAP-based paging switches, installed at your paging service provider, typicallydo not use error correction or compression modems. Since most Hayes compatiblemodems today ship with these protocols enabled, they must first be disabled beforebeing used for paging purposes.This appendix will list the command(s) required for certain supported modems.These are provided for your information only and may change if the manufacturer ofthe modem decides to change their AT command set.

    You may also wish to enter these commands in your Setup String under theCentral database for each paging central that will be using these modems. Thisfeature allows other functions to utilize the paging modem and change AT settings.The paging software will automatically set the modem back to its required pagingconfiguration. It is not recommended that the modem be shared with functions otherthan paging.

    If your modem is not included in the list of supported modems, refer to yourmodems documentation on the commands related to compression and errorcorrection. Use the commands listed to disable both of these features and finish withan AT&W command to write this new setup to the modems permanent memory.

    These commands can be executed while the modem is connected to your computeror with a straight-through cable while connected to a terminal such as a VT100.

    Hayes V-series ULTRA SmartmodemDisabling Error Correction and Compression:

    &Q0Hardware Flow Control:

    &K3

    Software Flow Control:&K5

  • A-2 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    Intel SatisFAXtion SeriesDisabling Error Correction and Compression:

    \N0%C0

    Hardware Flow Control:\Q3

    Software Flow Control:\Q1

    Motorola Power 28.8 SeriesDisabling Error Correction and Compression:

    \N%C0

    Hardware Flow Control:\Q3

    Software Flow Control:\Q1

    UDS FasTalk V.32/42bDisabling Error Correction and Compression:

    \N0%C0

    Hardware Flow Control:\Q3

    Software Flow Control:\Q1

    UDS FasTalk IIDisabling Error Correction and Compression:

    \N0%C0

    Hardware Flow Control:\Q3

    Software Flow Control:\Q1

  • GFK-1494 Appendix A - Modem Configuration A-3

    US Robotics SportsterDisabling Error Correction and Compression:

    &K0&M0

    Hardware Flow Control:&H1

    Software Flow Control:&H2

    Xircom Creditcard PCMCIA SeriesDisabling Error Correction and Compression:

    \N0%C0

    Hardware Flow Control:\Q3

    Software Flow Control:\Q1

  • GFK-1494 B-1

    Appendix B - EnvironmentVariables

    About Environment VariablesThe Pager server uses numerous environment variables to control its operation.These variables can be found in the fpconfig.xxx file found in the Pager com sub-directory on most operating systems.

    On Windows NT, these variables are found under the Control Panel -System - System Environment Variables option.

    On Windows 95, these variables are found in the fpvars.bat file inthe Windows directory.

    The following table lists the Pager environment variables:

    Environment Variable ContentsFP_PAGE Points to the root of the Pager directory structure, less

    the terminator.

    FP_PAGE_AUDFILE Points to the Pager sender audit file.FP_PAGE_DATA Points to the Pager data file directory.

    FP_PAGE_EXE Points to the Pager executables directory.

    FP_PAGE_HOST Indicates the host name of the server machine.

    FP_PAGE_INCOMING Points directly to the Pager incoming queue directory.FP_PAGE_INTERVAL Indicates the number of seconds the server should

    pause before checking for incoming pages or pagesrequiring routing.

    FP_PAGE_LOGFILE Points to the Pager server log file.

    FP_PAGE_LOGS Points to the Pager log file directory.FP_PAGE_OUTGOING Points directly to the Pager outgoing queue directory.

    FP_PAGE_REJECTED Points directly to the Pager rejected queue directory.FP_PAGE_SLOGFILE Points to the Pager sender log file.

  • B-2 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    FP_PAGEThis variable contains a pointer to the root directory that contains the Pager softwareand data. It does not contain the trailing terminator for your platform. Samplevalues include:

    C:\CIMPLICITY\HMI\PAGER

    FP_PAGE_AUDFILEThis variable contains a pointer to the file that will contain the audit records for allpages sent from this server. This file is updated each time the FPSERVER processpicks up and sends pages. Sample values include:

    C:\CIMPLICITY\HMI\PAGER\LOGS\FPSENDER.AUD

    FP_PAGE_DATAThis variable contains a pointer to the directory that contains the Pager data files.Sample values include:

    C:\CIMPLICITY\HMI\PAGER\DATA\

    FP_PAGE_EXEThis variable contains a pointer to the directory that contains the Pager programs.Sample values include:

    C:\CIMPLICITY\HMI\EXE\

    FP_PAGE_HOSTThis variable contains the local servers host name. Sample values include:

    PCFILES

    FP_PAGE_INCOMINGThis variable contains a pointer to the directory that contains the incoming pagesfrom the Pager client applications. Sample values include:

    C:\CIMPLICITY\HMI\PAGER\INCOMING\

    FP_PAGE_INTERVALThis variable indicates the number of seconds to wait between checking for pagesthat are ready for processing. Sample values include:

    30

    FP_PAGE_LOGFILEThis variable contains a pointer to the file that contains a record of the FPSERVERbackground process. This file is updated each time the FPSERVER process looksfor pages to be sent. Sample values include:

    C:\CIMPLICITY\HMI\PAGER\LOGS\FPSERVER.LOG

  • GFK-1494 Appendix B - Environment Variables B-3

    FP_PAGE_LOGSThis variable contains a pointer to the directory that contains the log and audit files.Sample values include:

    C:\CIMPLICITY\HMI\PAGER\LOGS\

    FP_PAGE_OUTGOINGThis variable contains a pointer to the directory that contains the outgoing pagesfrom the Pager client applications. Sample values include:

    C:\CIMPLICITY\HMI\PAGER\OUTGOING\

    FP_PAGE_REJECTEDThis variable contains a pointer to the directory that contains the rejected pages fromthe Pager sender. Sample values include:

    C:\CIMPLICITY\HMI\PAGER\REJECTED\

    FP_PAGE_SLOGFILEThis variable contains a pointer to the file that contains a record of the FPSENDERbackground process. This file is updated each time the FPSENDER process looksfor pages to be sent to a Central. Sample values include:

    C:\CIMPLICITY\HMI\PAGER\LOGS\FPSENDER.LOG

  • GFK-1494 C-1

    Appendix C - TroubleshootingGuide

    About TroubleshootingNumerous troubleshooting tools are provided with the Pager server software toenable you to trace why the server is unable to send pages.

    Log and Audit FilesVarious log and audit files are maintained by the system. These files can be referredto, by the system manager, in case of difficulties with the paging process. Thesefiles may be found in the logs sub-directory under the Pager directory structure.The files and their contents are described below, along with a sample files contents.

    FPSENDER.LOGThis file contains a record for each time the page sending process connects to apaging central. The file records the date and time of the connection, as well as thelogon and logoff message from the paging central. This file is current for today.Previous days files may be found in FPSENDER.SLG. The following is a sample ofthe contents of the FPSENDER.LOG file.

    ===============================================================

    Date: 19 Jan 1995 Time: 22:15:41Central: Coverage: Logon Message: ------------------------------------------------ Welcome to NCTI Paging...Disconnect Message: ------------------------------------------- 1 Page Sent Thank you.---------------------------------------------------------------

    Status Code:

  • C-2 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    The above example shows the contents of an FPSENDER.LOG file for a server whichhas connected to only one central so far today.

    The first line shows the date and time of the connection.

    The second and third lines show the Central/Coverage combination thisconnection was for.

    The Logon Message section shows the logon message sent by theCentral during the connection and

    The Disconnect Message shows the logout message received from theCentral upon disconnect.

    The status code indicates the reason why a central connection hasfailed.

    The Logon and Disconnect messages may provide some insight into why paging isnot working with a particular Central/Coverage combination.The following errors are traced and identified by Pager in the Status Code:

    StatusCode

    Description Possible Causes

    1 Central connection was successful No problem.50 FPDRIVER out of rev Problem with installation, call GE

    Fanuc.

    51 Failed to set modem type Check this Central/Coveragesmodem type. It should be set toHAYES or DIRECT.

    52 No ID= prompt from Central Check that the modem has errorcorrection and compressiondisabled.

    53 Failed to login to Central Check that you are calling thecorrect phone number for the IXOprotocol.

    54 Initialization check failed Central refuses IXO connectionson this port.

    55 Service check failed Central refuses IXO connectionson this port.

    56 Disconnect check failed Central did not respond to IXOdisconnect request.

    57 Failed to obtain port The port specified for thisCentral/Coverage is invalid or inuse by another process.

    58 Failed to open protocol library Check installation or call GEFanuc.

    1xx Dial failure code Check the Dial Status section inAppendix D TroubleshootingGuide.

  • GFK-1494 Appendix C - Troubleshooting Guide C-3

    Dial Status CodesThe following are the dial status codes which may be reported in the Status Codefield of FPSENDER.LOG.

    StatusCode

    Description Possible Causes

    101 Modem type not specified Check the entry for this Central. It mustcontain the Modem Type of HAYES.

    102 Port not specified Check the entry for this Central. It mustcontain the name of the communicationsport on which the modem is connected.

    103 Port cannot be opened Check that the communications portspecified exists and is not in use byanother process.

    104 Speed not specified Check that the entry for this Central has aspeed entered.

    105 Hang-up failure Check that the modem is properlyconfigured for the port on which it isconnected.

    106 Internal error Call GE Fanuc.107 I/O error Check that the modem is properly

    configured for the port on which it isconnected.

    108 Dial time-out expired Check that the phone number specifiedfor this Central is correct.

    109 Dialing interrupted by user Someone attempted to kill the Pagerprocess.

    110 Modem not ready Check that the modem is powered on.120 Modem command error Call GE Fanuc.121 Failure to initialize modem Check that the modem is powered on.122 Phone busy The Centrals dial-in number is busy.123 No Carrier Check that the phone number specified

    for this Central is correct.124 No Dial-Tone Check that the phone line is plugged into

    the modem.

    125 Ring, incoming call Someone is dialing into the phone lineyou are using for Pager.

    126 No answer The modem at the Central does notanswer.

    127 Disconnected Check that the phone cabling is secure.128 Answered by voice Check that the phone number specified

    for this Central is correct.129 Access denied Check that the protection on the port

    specified for this modem is correct.198 Unknown error Call GE Fanuc.199 Unspecified modem error Call GE Fanuc.

  • C-4 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    FPSENDER.AUDThis file contains a record for each page the page-sending process sends to a pagingcentral. The file records the date, time of the page, central, coverage, actual messagesent to the user, status message from the central and any informational message fromthe central. The status codes that will be recorded in this file are listed in the tablebelow. This file is current for pages sent today only; consult the FPSENDER.SAD filefor previous days. The following is a sample of the contents of the FPSENDER.AUDfile.

    Consult this file when there are problems with one or more pagers not associatedwith a particular Central/Coverage.---------------------------------------------------------------

    Date: 19 Jan 1995 Time: 22:15:47Central: Coverage: Pager ID: 34567Message: Please meet me for lunch at 1PM - MikeStatus Code: Status Message: Page sent successfully

    The following errors are traced and identified by Pager in the Status Code:

    StatusCode

    Description Possible Causes

    1 Page sent successfully No problem.

    51 Checksum Failed Data corruption during modemtransmission.

    52 System Failure Invalid id, pager user has cancelledservice, data corruption duringmodem transmission.

    53 Failure, Begin Disconnect now Central is having problems. Pleasedisconnect and try again later.

    100 Failure, Unknown response Call GE Fanuc.

  • GFK-1494 D-1

    Appendix D - NetworkConfiguration

    About Network ConfigurationThis document describes the configuration to be done to allow CIMPLICITY HMIProjects to queue pages to a page server on a remote computer. It is recommendedthat the remote server use a NTFS formatted drive to allow selective permissions onthe directories.

    HMIServersWith Pager Software

    Modem

    Phone Line

    Alarmsto bePaged

    External Pages

    In the above diagram, four CIMPLICITY HMI Servers are running on the network.Each project is using paging and has the software licensed. Each server could haveits own separate modem, however, in this example, the modem is only attached to thelast computer on the right (lets call this one the Paging Server.) The three otherservers route their pages to the paging server. The following example describes theconfiguration necessary to accomplish this architecture.

    To execute the instructions in this document, you will need Administrator or Serverprivileges on the Paging Server. All file/directory properties are configured in File /Properties / Security / Permissions menu of Windows NT Explorer.

  • D-2 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    Creating the Shared DirectoryOn the Paging Server, the disk drive containing the pager directory must be sharedsince other servers will be placing pages there. To construct the share to be used bythe remote CIMPLICITY projects:

    1. Select the c:\cimplicity\hmi\pager directory in the Explorer.

    2. Click the right mouse button and select Sharing from the pop-up menu.

    The pager Properties dialog box opens with the Sharing property page.

    3. Enter a name for the share in the Shared Name field (in this examplepager)

    4. Select OK.

  • GFK-1494 Appendix D - Network Configuration D-3

    Directory PermissionsDirectory permissions need to be set on the Paging Server because other servers willbe placing files on the Paging Server. This section describes the configurationneeded.

    How to Set Directory and File PermissionsTo set directory and file permissions for a directory:

    1. Select the Pager directory whose permissions you want to change (forexample, C:\cimplicity\hmi\pager) in File Manager or Explorer

    2. Click the right mouse button and select Sharing from the pop-up menu.

    3. In the Properties dialog box, select the Security property page.

    4. On the Security property page, select Permissions.The Directory Permissions dialog box opens and you are ready to selecta group to associate with these access permissions for this example.

    5. In the Type of Access combo box, select Special DirectoryAccess.The Special Directory Access dialog box opens.

  • D-4 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    A. Select the Other radio button.B. Select the Read, Write and Execute check boxes as appropriate.C. Select OK to accept the changes and close the dialog box.

    6. In the Type of Access combo box, select Special File Access.The Special File Access dialog box opens.

    A. Select the Other radio button.B. Select the Read, Write and Execute check boxes as appropriateC. Press OK to accept the changes and close the dialog box.

    7. Press OK to close the Directory Permissions dialog box.8. Press OK to close the Properties dialog box.

  • GFK-1494 Appendix D - Network Configuration D-5

    Pager Directory TreeStart by assigning new standard access permissions to the Pager directory structure.To do this:

    1. Select the root directory of the Pager directory structure (for example,C:\cimplicity\hmi\pager) in File Manager or Explorer.

    2. Set the directory permissions to Read and Execute.3. Set the file permissions to Read and Execute.

    Pager Data DirectoryTo let users send pages from their desktop or to let applications connect and properlyqueue pages, while maintaining a secure Pager directory, you have to set the datadirectory to allow Read/Execute access. To do this:

    1. Select the data directory of the Pager directory structure (for example,C:\cimplicity\hmi\pager\data)

    2. Set the directory permissions to Read and Execute.3. Set the file permissions to Read and Execute.

    Pager EXE DirectoryTo let users execute the Pager software while maintaining a secure Pager directory,you have to set the exe directory to allow Read/Execute access. To do this:

    1. Select the exe directory of the Pager directory structure (for example,C:\cimplicity\hmi\pager\exe)

    2. Set the directory permissions to Read and Execute.3. Set the file permissions to Read and Execute.

    Pager Incoming DirectoryTo allow queuing of pages, while maintaining a secure Pager directory, you need toset the Pager Incoming directory to allow Write access. To do this:

    1. Select the incoming directory of the Pager tree (for example,C:\cimplicity\hmi\pager\incoming).

    2. Set the directory permissions to Read, Write and Execute.3. Set the file permissions to Read, Write and Execute.

  • D-6 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    Pager Logs DirectoryTo allow logging while maintaining a secure Pager directory, you need to modifypermissions for the logs directory of the Pager tree. To do this:

    1. Select the logs directory of the Pager tree (for example,C:\cimplicity\hmi\pager\logs).

    2. Set the directory permissions to Read, Write and Execute.3. Set the file permissions to Write and Execute.

    Pager Outgoing DirectoryTo allow queuing of outgoing pages while maintaining a secure Pager directory, youneed to set the Pager Outgoing directory to allow Write and Execute access. To dothis:

    1. Select the outgoing directory of the Pager tree (for example,C:\cimplicity\hmi\pager\outgoing).

    2. Set the directory permissions to Write and Execute.3. Set the file permissions to Write and Execute.

    Pager Rejected DirectoryTo allow queuing of rejected messages while maintaining a secure Pager directory,you need to set the Pager Rejected directory to allow Read, Write and Executeaccess. To do this:

    1. Select the rejected directory of the Pager tree (for example,C:\cimplicity\hmi\pager\rejected).

    2. Set the directory permissions to Read, Write and Execute.3. Set the file permissions to Write and Execute.

  • GFK-1494 Appendix D - Network Configuration D-7

    Registry EntriesA registry modification is required for Paging servers that receive page requests fromremote CIMPLICITY HMI servers. The NullSessionsShares key must be eithercreated or appended with the name of the "Share" associated with the Pagingdirectory (if you constructed the share as in our example the name would be Pager.)This modification is only performed on the Paging Server. To run the registry editor,select Run from the Start menu and enter regedt32 in the Open field.

    Note

    NullSessionsShares is type REG_MULTI_SZ

    Open the NT Registry Editor and select the following key.

    HKEY_LOCAL_MACHINE\SYSTEM

    \CURRENTCONTROLSET\SERVICES\LANMANSERVER

    \PARAMETERS\NULLSESSIONSHARES

    Create a new line within the NULLSESSIONSHARES key

    Type the Share name associated with the Paging server.

    You Registry Editor window should look like this:

  • D-8 CIMPLICITY HMI CIMPLICITY Pager Operation Manual GFK-1494

    Next, stop and restart the Pager service from the Service Control Manager (Servicesicon) in the Control Panel.

    Paging Client ConfigurationThe final configuration step is performed on each CIMPLICITY Server that is aclient of the Paging Server. Edit the firstpge.ini file in the Windows directory(for example, c:\winnt40.)Change the paths so that they point to the share on the Paging Server. In thisexample, the path is \\alnt61\pager\.

    [padminw]DataPath=\\alnt61\pager\data\

    [FirstPAGE Client]DataPath=\\alnt61\pager\data\IncPath=\\alnt61\pager\incoming\

    Since the Pager Server process on the Paging Server will send out the Pages, you donot need to run the Pager Server locally on each client computer. To disable theservice,

    1. Open the Control Panel,

    2. Select Services,

    3. Stop the Pager Server process.

    4. Select Startup

    5. Change the startup to manual.

    The computer will need to be restarted after making these changes.

  • GFK-1494 E-1

    Appendix E - Server Redundancy

    About Server Redundancy and the PagerPlease see CIMPLICITY HMI for Windows NT and Windows 95 Server RedundancyOperation Manual (GFK-1353) for more information on CIMPLICITY ServerRedundancy

    In a redundant environment, pages are sent from the Pager on the computer acting asmaster. The Pager on the slave computer monitors alarms and tracks the escalationqueue, but it does not send pages out the modem. When the master computer fails,the Pager on the slave computer starts sending pages.

    Operational NoteThe Update Now capability is used to make changes dynamically in a runningsystem without shutting a CIMPLICITY HMI project down. This functionality ofCIMPLICTY Pager configuration is not supported on the slave computer inCIMPLICITY Server Redundancy. Do the following instead.

    After completing the configuration changes on the master:

    1. Select Update Now to dynamically update the Pager configuration onthe master computer.

    2. Copy the following files from the projects data directory on themaster computer to the projects data directory on the slave computer:

    cimpager.datpagerdl.datpagerdis.datfpagecim.csv

    3. Run CIMPLICITY Process control on the master computer and do thefollowing:

    A. Connect to the slave computer.

    B. Stop and restart the FPAGECIM process.

    When FPAGECIM restarts, it will re-read its configuration.

  • GFK-1494 F-1

    Appendix F - Viewer Development

    Viewer DevelopmentIn order to properly use the viewer development option with paging configuration,you must do the following:

    1. On the server that contains the Paging Database, you need to follow theinstructions in the Directory Permissions section of Appendix D Network Configuration to set the directory and file permissions of allthe paging files.

    2. On the computer that contains the CIMPLICITY Viewer DevelopmentSystem, you need to follow the instructions in the Paging ClientConfiguration section of Appendix D Network Configuration toupdate the firstpge.ini file.

    The Viewer can now access the PAGER and CENTRAL databases used by thePaging Server. Hence, these Pager entries will be available to use with CIMPLICTYPager Configuration.

  • GFK-1180 Index -i

    Index

    AAbout

    CIMPLICITY Pager 1-1, 4-1CIMPLICITY Pager methods 5-1Environment variables, CIMPLICITY Pager B-1FirstPAGE client 3-1

    Alarms by recipientViewing 4-10

    Alpha lengthCentral properties, Pager administration 2-5

    AutosignFirstPAGE client option 3-3

    CCentral

    Central properties, Pager administration 2-3Pager properties, Pager administration 2-9

    CENTRAL Database 1-4, 2-1, 2-3, 2-9, A-1Central properties

    Pager administrator 2-3CIMLICITY Pager

    Configuring 4-1CIMPLCITY pager configuration

    Toolbar buttons 4-3CIMPLICITY Pager

    About 1-1, 4-1Conceptual overview 1-4Distribution list, Creating 4-11Distribution list, Modifying 4-12Features 1-2FPSENDER.AUD file C-4FPSENDER.LOG file C-1Functional overview 1-3Log and audit files C-1Methods, About 5-1Modem configuration A-1Network configuation

    Pager client configuration D-8

    Pager data directory permissions D-5Pager directory tree permissions D-5Pager exe directory permissions D-5Pager incoming directory permissions D-5Pager logs directory permissions D-6Pager outgoing directory permissions D-6Pager rejected directory permissions D-6Registry entries D-7

    Network configuration D-1Network configuration, Creating the shared directory

    D-2Network configuration, Directory permiss