NEC Sentry Installation Guide
Have a look at the manual NEC Sentry Installation Guide online for free. It’s possible to download the document as PDF or print. UserManuals.tech offer 1168 NEC manuals and user’s guides for free. Share the user manual or guide on Facebook, Twitter or Google+.
NDA-30080 Revision 1.0Page 41 Sentry Installation Guide Annoyance Trap Primary Configuration ParametersThese parameters are defined automatically if you answered “yes” to the autoconfig prompt during installation. On the APM Configuration Entry screen, make the entries indicated below for each Annoyance Trap parameter. Entries for parameters marked by an asterisk (*) must be made exactly as shown. Other entries are examples and are site-dependent. Note: Use the instructions provided for this option in the APM Operations Manual. ParameterEntryDescription NameAnnoyance_Trap The application name to be displayed in the APM menus. This name is displayed exactly as you enter it here, including case. Exec Filename*/oai/app/sentry/bin/ annoyTrapIndicates the path name of the executable file. Group* SENTRYNames the group to which Annoyance Trap is associated. Response Mode*I(gnore)Indicates the action that the APM is to take with Annoyance Trap should a member of the group terminate. Initialization BatchN(o)Indicates whether or not (Yes or No) Annoyance Trap is to be initialized automatically when the OAI system is initialized. Termination Mode*MessageIndicates how the APM is to notify Annoyance Trap to terminate. Standard Output/dev/nullDesignates the file into which Annoyance Trap output is redirected. Number of Restarts0Indicates how many times the APM may restart Annoyance Trap after it terminates erroneously.
Page 42NDA-30080 Revision 1.0 Annoyance Trap Sentry Installation Guide OAI FacilitiesThese NEAX 2400 facilities are set up automatically if you answered “yes” to the autoconfig prompt during installation. To manually set up the facilities, use the Facilities command on the APM Configuration Entry screen and follow the instructions in the APM Operations Manual. ParameterEntryDescription FacilitiesSCF SMFR SMFN The OAI facilities required by Annoyance Trap.
NDA-30080 Revision 1.0Page 43 Sentry Installation Guide Annoyance Trap Secondary OAI Configuration ParametersThese parameters are defined automatically if you answered “yes” to the autoconfig prompt during installation. Use the OAI-Conf command on the APM Configuration Entry screen to make the entries indicated below for each parameter. Entries for parameters marked by an asterisk (*) must be made exactly as shown. Other entries are examples and are site-dependent. Note: Use the instructions provided for this option in the APM Operations Manual. ParameterEntryDescription Database Name #1* /oai/db/cur/blding The name of the building database. If this parameter is blank or invalid, the Annoyance Trap program terminates. Database Name #2* /oai/db/cur/tenants The name of the tenant number database. If this parameter is blank, the Annoyance Trap program sends a warning message to the APM and the tenant number supplied by the OAI configuration is used by default for all extensions. If an invalid name is entered, an error message is sent to the APM and the Annoyance Trap program terminates. For more information about databases, see Database Requirements on page 45 Timeout Value #1 (blank) Not used. Timeout Value #2 (blank) Not used. Tenant Number 1 Specifies the number of the tenant that Annoyance Trap serves. Source Link Name OAI1TCP Identifies the port on the source side of the communication link. Destination Link NamePBX1TCP Identifies the port on the destination side of the communication link. Association Recovery30 Designates the number of seconds Annoyance Trap waits before trying to re-establish an association with the NEAX that has been released.
Page 44NDA-30080 Revision 1.0 Annoyance Trap Sentry Installation Guide User-Defined Parameters Note:The following parameters contain configuration pairs consisting of a keyword, at least one blank space, and an option. Multiple configuration pairs may be specified in a single parameter if space permits. Case is ignored for keywords, but options must match exactly. The configuration pairs may occur in any order, and the following keywords and options are supported ParameterEntryDescription User Defined #1 /oai/app/sentry/cfg/history/ Mannoy.cfgThe name of the history logging master configuration file (See Appendix A). If this parameter is blank, the Annoyance Trap program sends a warning message to the APM. If an invalid file name is entered, an error message is sent to the APM and the Annoyance Trap program terminates. User Defined #2 trapPilot nnnnnSpecifies the pilot number used to trigger Annoyance Trap. Valid syntax is trapPilot where “nnnnn” specifies the pilot number, which can be no more than five digits. If an invalid option is specified, the Annoyance Trap program sends an error message to the APM and terminates. User Defined #3trapContact nnnnn Specifies the optional Annoyance Trap security operator. Valid syntax is trapContact where “nnnnn” specifies the security operator’s extension number, which can be no more than five digits. If this option is blank or invalid, the Annoyance Trap program sends a warning message to the APM. User Defined #4audioDevice nnnnn Specifies the optional audio device extension. Valid syntax is audioDevice where “nnnnn” specifies the audio device extension number, which can be no more than five digits. If this option is blank or invalid, the Annoyance Trap program sends a warning message to the APM. User Defined #5dummyPhone nnnnn Specifies the dummy phone extension. The dummy phone is used to activate the audio device, and is required if an audio device extension has been specified. Valid syntax is dummyPhone where “nnnnn” specifies the dummy phone extension, which can be no more than five digits. If an audio device has been specified and this option is blank or invalid, the Annoyance Trap program sends an error message to the APM and terminates. User Defined #6debug stdout, debug stderr, debug Specifies debug logging to stdout, stderr, or another UNIX filename. Valid syntax for specifying a UNIX filename is debug where “filename” is the UNIX filename. If this parameter is omitted, debug logging is disabled (the default setting after autoconfig). If an invalid option is specified, the Annoyance Trap program sends an error message to the APM and terminates.
NDA-30080 Revision 1.0Page 45 Sentry Installation Guide Annoyance Trap Database Requirements Annoyance Trap requires two databases: the Building database and the Tenant database. This section contains needed to create Emergency Conference databases. Use this information with the procedural instructions in the APM Operations Manual. If you encounter messages during this process, refer to the “Process” and “Error Messages” chapters of the APM Operations Manual. Database CreationThe following steps are done automatically during installation: 1. Create a Master Definition File Create the master definition file that defines the fields in the master database file. 2. Create an Application Definition File Create a definition file for the Annoyance Trap database. This file defines the formats by which data from the master file is to be converted to meet the needs of Annoyance Trap. Database RecordsAfter database is created, perform the following steps to add, modify, or delete records: 1. Build a Master Database File Enter data (such as phone extension numbers) into the master database fields that were defined in the master definition file. 2. Process the Application Database Use the Process Application Databases option on the APM Database Administration menu to create the file that will be used by Annoyance Trap. When the Process option is activated, data is drawn from the master database and converted to the formats specified in the application definition file. 3. Install the Application Database Use the Install Application Databases option on the APM Database Administration menu to enable Annoyance Trap to copy its database. 4. Reboot the Annoyance Trap application
Page 46NDA-30080 Revision 1.0 Annoyance Trap Sentry Installation Guide Building DatabaseThe Building database is shared with other Sentry applications, so you might not have to build it for Annoyance Trap. You will receive a message from the APM if you try to create the Building database and it already exists. The Building database contains a list of extensions and the location of each extension. A building location can be associated with an individual numeric extension or a range of numeric extensions. A given building can have more than one record if all of the extensions located in it are not consecutive. Each building database record contains the following fields: First Phone - The first extension in the range of extensions. Last Phone - The last extension in the range of extensions. Building ID - An ASCII string containing the building location. The Building master database is named “blding_m” by default and contains the following fields. Table 3-1 Building Master Database Fields The Building application database is named “blding” by default and contains the following fields. Table 3-2 Building Application Database Fields Field Description Type SizeMinimum Va l u eMaximum Va l u e First Phone Numeric 5 0 99999 Last Phone Numeric 5 0 99999 Building ID ASCII 24 Field Description Data Type First Phone Long Integer Last Phone Long Integer Building ID ASCII
NDA-30080 Revision 1.0Page 47 Sentry Installation Guide Annoyance Trap Tenant Number DatabaseThe Tenant Number database is shared with other Sentry applications, so you might not have to build it for Annoyance Trap. You will receive a message from the APM if you try to build the Tenant database and it already exists. The Tenant Number database contains a list of extensions and associated tenant numbers used by the PBX. A tenant number can be associated with an individual numeric extension or a range of numeric extensions. A given tenant number can have more than one record if all of the extensions associated with it are not consecutive. Tenant numbers can also be associated with individual extensions that contain non- numeric characters such as ‘*’ or ‘#’. If all extensions have the same tenant number, then this database is not required and the tenant number provided by the OAI configuration may be used by default. Each tenant number database record contains the following fields: First Extension - The first extension in the range of extensions. Last Extension - The last extension in the range of extensions. Te n a n t N u m b e r - This field contains the associated tenant number. The Tenant Number master database is named “tenant_m” by default and contains the following fields: Table 3-3 Tenant Master Database Fields The Tenant Number application database is named “tenants” by default and contain the following fields: Table 3-4 Tenant Number Application Database Fields Field Description Type SizeMinimum Va l u eMaximum Va l u e First Extension ASCII 10 Last Extension ASCII 10 Tenant Number Numeric 3 1 255 Field Description Data Type First Extension ASCII Last Extension ASCII Tenant Number Short Integer
Annoyance Trap Sentry Installation Guide Page 48NDA-30080 Revision 1.0 This Page Left Blank.
NDA-30080 Revision 1.0Page 49 Sentry Installation Guide Emergency Conference Chapter 4 Emergency Conference This chapter describes the field entries to make during the installation and configuration of the Emergency Conference software. For information on using Emergency Conference, see the Emergency Conference User Guide. Overview The Emergency Conference program is an OAI application that allows a user to call a designated emergency conference number and to connect to a set of predefined destination extensions in a conference call. Additional callers can be added, up to the predefined limited for the conference. Once the conference is full, additional callers are queued. All parties (both calling and destination) are fully connected in the conversation. By default, any caller may initiate or join a conference; however, each emergency conference can restrict access using an optional list of authorized callers. Each multiple party conference is created using OAI to connect all of the extensions to one or more NEC 8 party conference cards. Each emergency conference has at least one destination extension designated. Every time a caller connects to the emergency conference, any destination extension that is not already connected to the conference will be reconnected. If the destination extension is busy, it will not be connected unless the emergency conference has been configured to “override” all non-conference calls. If “override” is in effect, the busy destination extension will hear an audible tone, the prior connect will be released and the extension will be connected to the emergency conference. The calling extension will be joined to the emergency conference if the conference is not already full. If the conference is full, then the calling extensions will be queued up and serviced in the order in which they have called. The Emergency Conference program provides support for one or more display terminal applications through an event message protocol. Terminal applications that want to receive messages send a request to the Emergency Conference program, which will then send event messages to the terminal application as they occur. The Emergency Conference program does not require any terminal applications to perform the conferencing tasks, and can be run alone if there is no requirement for a display terminal. Events may also be saved in a history log file. The installation and configuration of Emergency Conference includes the following procedures: Software Installation Application Configuration Database Requirements
Page 50NDA-30080 Revision 1.0 Emergency Conference Sentry Installation Guide Additional Manuals In addition to this guide, use instructions in the following manuals for this installation: Applications Manager (APM) Installation Manual - Contains step-by-step instructions for installing the software from the release media. Applications Manager (APM) Operations Manual - Explains how applications like Emergency Conference are configured in the APM environment and how the Emergency Conference databases are created, using the entries and values provided in this chapter. Software Installation The Emergency Conference software must first be loaded from the release media. Remember to use the Applications Manager (APM) Installation Manual if you need further instructions for installing software using the APM. Note:You will be prompted for several values when you install the software. For more information about these and other parameters, refer to the next section, Configuration on page 61. 1. To begin the Emergency Conference software installation, log in to the APM Platform Management Menu by typing apmadm at the UNIX login prompt, then press Enter. The login and password prompts are shown below. If your “apmadm” account requires a password, enter the appropriate password at the subsequent password prompt. login: apmadm password: