Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 Release: 7.0 Document Revision: 02.01 www.nortel.com NN43120-301 .
Nortel Communication Server 1000 Release: 7.0 Publication: NN43120-301 Document release date: 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved. While the information in this document is believed to be accurate and reliable, except as otherwise expressly agreed to in writing NORTEL PROVIDES THIS DOCUMENT "AS IS" WITHOUT WARRANTY OR CONDITION OF ANY KIND, EITHER EXPRESS OR IMPLIED. The information and/or products described in this document are subject to change without notice.
. Contents Module - eSMTP 13 Initialization 13 Output program activity 15 Logging 18 Relaying and Routing 21 Windows SMTP server 23 Domino (Lotus Notes) 24 Module - eSMTP_server 25 27 Keyword processing 27 Initialization 27 Activity of eSMTP_server 29 Logging 34 Module - eSNMP Architecture Send SNMP Send SNMP Send SNMP 39 39 Message for Win32 45 Message for Web 46 Message for iSeries 47 Module - eTM 49 63 Shutting down eTM_HA 63 Module - eTM_HA Overview 65 Publisher and Subscriber 67 Registr
Publisher 87 Recommendation XML image 90 SQL script 91 Switch back 92 Conclusion 93 88 Module - eVBVOICE 95 Introduction 95 Inbound calls 97 Outbound calls 104 VBV4.
Module - Web Administrator User Guide 153 Authorization level 154 Log in 159 Log out 161 Send a message 161 Change password 177 Reports of active alarms 178 Reports of ended alarms 181 Reports on alarms 183 Configuration of basic group members 184 Configuration of basic alternative devices 188 Configuration basic overview 192 Supervisor 194 Work with scripts - activate script 195 Work with Scripts - End Script 198 Reporting active scripts 200 Reporting ended scripts 202 Administrator 204 Send an SNMP t
Table: eDMSAPI_INBOUND_EVENT 263 263 Table: eDMSAPI_INBOUND_RESULT eDMSAPI _inbound_result parameters 267 Table: eESPA eESPA parameters 271 271 271 Table: eESPA_OUTBOUND_CFG eESPA_outbond_cfg parameters 285 eIO_modules parameters 289 289 289 Table: eIO_AI 293 293 Table: eIO_DI eIO_DI parameters 305 305 305 Table: eIO_DO eIO_DO parameters 309 285 285 Table: eIO_MODULE eIO_AI parameters 293 267 267 309 309 Table: eKERNEL_AREA eKERNEL_area parameters 313 313 313 Table: eKERNEL_ALARM e
FMT_OUTPGM_Facility_str 337 FMT_Bytes_line1_n 338 FMT_Bytes_line2_n 338 FMT_Bytes_line3_n 339 FMT_Page_ind_n 339 FMT_Page_more_ind_n 339 FMT_Concatination_b 340 FMT_Scroll_depth_n 340 FMT_AllowEmergency_b 340 FMT_Descr_str 341 FMT_Comments_str 341 Table: eKERNEL_GROUP eKERNEL_GROUP parameters GRP_id_str 343 GRP_InPGM_id_n 344 GRP_Name_str 344 GRP_Descr_str 345 GRP_Comments_str 345 343 343 Table: eKERNEL_GROUP_AUTH eKERNEL_GROUP_AUTH parameters GRPA_GRP_id_str 347 GRPA_UserID_str 347 GRPA_Comments_str 3
GRP_Comments_str 355 Table: eKERNEL_GUARDING eKERNEL_GUARDING parameters GUA_INPPGM_id_n 357 GUA_From_str 357 GUA_To_str 358 GUA_Mon_b 358 GUA_Tue_b 358 GUA_Wed_b 359 GUA_Thu_b 359 GUA_Fri_b 359 GUA_Sat_b 359 GUA_Sun_b 359 GUA_Timeout_n 359 GUA_msg_str 360 GUA_GRP_Name_str 360 GUA_ALA_id_n 360 GUA_Comments_str 361 357 357 Table: eKERNEL_HOLIDAY eKERNEL_HOLIDAY parameters Holiday_str 363 Holiday_Comments_str 364 363 363 Table: eKERNEL_INPGM eKERNEL_INPGM parameters 365 INPGM_id_n 365 INPGM_Site_id_n
Table: eKERNEL_SITE eKERNEL_SITE parameters 377 377 377 Table: eKERNEL_TCPCLIENT 385 eKERNEL-TCPCLIENT parameters 385 385 Table: eLOCATION 391 eLOCATION parameters 391 eLOC_Site_id_n 391 eLOC_Area_id_n 391 eLOC_LA_address_str 391 eLOC_LA_port_str 392 eLOC_GeneralTimeOut_n 392 eLOC_Retry_count_n 392 eLOC_Retry_intv_n 392 eLOC_Polling_intv_n 393 eLOC_Comments_str 393 Table: eLOCATION INBOUND RESULT 395 eLOCATION_INBOUND_RESULT parameters 395 eLOCIR_Inpgm_id_n 395 eLOCIR_Called_dev_str 395 eLOCIR_
eOAI_Silence_intv_n 402 eOAI_Comments_str 402 Table: eOAP 403 eOAP parameters 403 eOAP_Site_id_n 403 eOAP_Area_id_n 403 eOAP_Framework_Address_str 403 eOAP_Framework_Port_n 403 eOAP_ALA_Prty_DTMF_Confirm_n 404 eOAP_Silence_intv_n 404 eOAP_Comments_str 404 Table: eSMTP_CLIENT eSMTP_CLIENT parameters 405 405 405 Table: eSMTP_SERVER eSMTP_SERVER parameters 409 409 409 Table: eWEB 413 eWEB parameters 413 413 Table: eWEB_SCRIPT 415 eWEB parameters 415 415 Table: eWEB_SCRIPT_SET_AUTH eWEB_SCRIPT_
Table: eWEB_TOC eWEB_TOC parameters 433 433 433 Table: eWEB_USER_AUTH 439 Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Module - eSMTP The eSMTP module is an output program that receives message requests from the eKERNEL module. The eSMTP connects to an SMTP server, and delivers mail requests to the mail server according to the RFC821 specifications. This involves a sockets connection between eSMTP and the SMTP server of choice. For such a connection, eSMTP is TCP client and the SMTP server is TCP server, listening on port 25. Initialization The eSMTP module is started by means of a shortcut.
Module - eSMTP On startup, the eSMTP application attempts to connect to the eKERNEL. This is performed based upon the address and port information obtained from the shortcut. At connection, the eSMTP requests the eKERNEL to provide additional configuration settings. This is known as a configuration request. The eKERNEL in turn authenticates the client and responds with a configuration reply. Figure 2 "eSMTP configuration request" (page 14) shows the configuration request.
Output program activity 15 Figure 3 Configuration information Output program activity The eSMTP module is now ready to receive message requests from eKERNEL. These requests are handled on a first-in first-out basis. The requests are received in the format shown in Figure 4 "Message request format" (page 15). Figure 4 Message request format The message requests are executed one at a time, by means of a TCP sockets connection to the SMTP server of choice.
Module - eSMTP Figure 5 eSMTP tab The eSMTP tab provides an overview of the requests that are waiting to be processed. This is visible in the top area (referred to as the job queue). Requests are handled as follows: Procedure 1 Request handling Step Action 1 The request is analyzed and the required keywords are extracted and shown to the right. The left-hand side of the window shows the actual dialog with the SMTP server.
Output program activity 17 Figure 6 Request queue with extracted keywords 2 The eSMTP module sends the status of the request back to the eKERNEL. This status can either indicate a positive acknowledge or a negative acknowledge. The format of the message reply is shown in Figure 7 "Message reply format" (page 17). Figure 7 Message reply format 3 The e-mail message is delivered to the mailbox of the destination user.
Module - eSMTP Figure 8 Example of mail produced by eSMTP module Figure 8 "Example of mail produced by eSMTP module" (page 18) shows an example of the raw data of the mail that is produced by the eSMTP module. Figure 9 Raw data of mail produced by eSMTP module --End-- Logging The eSMTP application provides logging both on-screen and on disk. Figure 10 "eSMTP on-screen logging" (page 19) shows the on-screen logging, displayed on the Logging tab.
Logging 19 Figure 10 eSMTP on-screen logging Figure 11 "Log files on hard disk" (page 20) shows an example of a log file on disk, as viewed with a text editor. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Module - eSMTP Figure 11 Log files on hard disk Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Relaying and Routing 21 Relaying and Routing ATTENTION A common configuration error, related to relaying and routing settings, occurs when eSMTP tries to deliver a message to a mail destination user that is not residing in the same domain, as shown in Figure 12 "Relaying and Routing error on-screen" (page 22). Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Module - eSMTP Figure 12 Relaying and Routing error on-screen The error is usually recorded in the log files with a message similar to the one shown in Figure 13 "Relaying error log (relay failed)" (page 22). Figure 13 Relaying error log (relay failed) Other messages can be shown instead, for example, 550 - prohibited, 550 - Unable to relay, and so on. To correct this issue, consult with the system administrator regarding the rights granted for routing and relaying in the module.
Relaying and Routing 23 Windows SMTP server In Windows SMTP Server (part of the Internet Information Server), you can for instance grant access by clicking Start on the Windows task-bar, and choosing Settings > Control Panel > Administrative Tools > Properties > Internet Service Manager. Figure 14 "Setting SMTP relay" (page 23) illustrates the settings needed to grant the SMTP server access to relay from both 127.0.0.1 and 10.110.50.138. These addresses are the addresses where eSMTP modules reside.
Module - eSMTP Domino (Lotus Notes) The same techniques discussed for “Windows SMTP server” (page 23) can be implemented on other SMTP servers. For example, in Domino (Lotus Notes), you can allow inbound SMTP requests from other parties (eSMTP).
. Module - eSMTP_server The eSMTP_server module is a member of the input program family. Therefore, the eSMTP_server is capable of generating alarms to eKERNEL. The name eSMTP_server can be rather confusing. In fact, there is no SMTP server functionality implemented in the module. This means the application is not acting as an SMTP server, and is not listening on port 25 for inbound SMTP requests.
Module - eSMTP_server Figure 17 Example of inbound e-mail ATTENTION There are many competing specifications for mail formatting. A basic implementation is specified in RFC821. Many other specifications were added, for example, RFC1251 described the MIME format. The current release of eSMTP_server is not designed to be fully compatible with all available functionality embedded in e-mail messages.
Initialization 27 Keyword processing For the purpose of illustration, examples in this chapter ignore all mail contents, and process only the following keywords: • • • x-sender. The value of the x-sender tag is stored x-receiver. The value of the x-receiver tag is stored Subject. The value of the Subject: tag is stored Because the x-sender and x-receiver tags are Microsoft proprietary, the module eSMTP_server also looks for From and To keywords, if the x-sender and x-receiver tags are missing.
Module - eSMTP_server The eKernel address keyword denotes the IP address that is assigned to the eKERNEL module. The eSMTP_server contacts this IP address to connect to the eKERNEL. • eKERNEL Port The eKernel Port keyword denotes the port number that is assigned in the configuration for the eSMTP_server instance. On startup, the eSMTP_server application attempts to connect to the eKERNEL, as shown in Figure 20 "eKERNEL connection attempt" (page 28).
Activity of eSMTP_server Figure 22 Configuration reply When the configuration is received, the Connections tab of the eSMTP_server module is updated with information similar to what is shown the panel shown in Figure 23 "Updated eSMTP Connection information" (page 29). Figure 23 Updated eSMTP Connection information Activity of eSMTP_server The eSMTP_server module is now ready to send message requests to eKERNEL. These requests are sent on a first-in first-out basis.
Module - eSMTP_server Figure 24 Request processing shown on the eSMTP_server tab As specified in the configuration reply, the eSMTP_server polls the specified directory for new inbound mail messages at fixed intervals. This interval is usually 10 seconds. The default directory is C:\Inetpub\mailroot\Drop, as shown in Figure 25 "Default inbound mail (drop) directory" (page 30). Figure 25 Default inbound mail (drop) directory Inbound mail messages are processed one by one.
Activity of eSMTP_server 31 Figure 26 Mail processing The Mail processing window shows: • Request identifier This is a long filename and refers to the filename of the e-mail message that is being processed. These names were generated by the Microsoft SMTP Server component. • From field Isolated from the tag. • To field Isolated from the tag. • Subject field Isolated from the Subject: tag.
Module - eSMTP_server The eKERNEL then validates the message request, and either accepts or refuses the request. During the validation process, the eSMTP_server is considered as an input program, so all configuration settings must be defined correctly. One major criterion is whether for this input program the auto-create group is activated. Without auto creation of groups, both From and To must be known in the database.
Activity of eSMTP_server • 33 Message Rejected If the message is not accepted in eKERNEL, a negative reply is sent, as shown in Figure 30 "Message reply: rejected" (page 33). Figure 30 Message reply: rejected Refer to the log files of eKERNEL (see the eKERNEL > Logging tab) to find out why the message was not accepted. Following is an example of the informational message that is shown: S: Alarm not processed. Unknown group in eKERNEL_GROUP table! Auto create group for eSMTP_server is set to False.
Module - eSMTP_server Figure 31 Specifying the error target directory Note: Because these rejected inbound mail messages are still available online, you can let the administrator determine the cause of the problem, and if necessary adjust the configuration settings. In many cases the problems are related to wrong configuration, or processing of unexpected mail messages (spawn mail, hackers, and so on).
Logging Figure 32 On-screen logging Figure 33 "Log file on disk" (page 36) shows the log file stored on disk. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Module - eSMTP_server Figure 33 Log file on disk Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Logging Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Module - eSMTP_server Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Module - eSNMP ATTENTION Due to the ongoing development of the DECT Messenger product suite, some modules that provide additional functionality may become available after the initial release of DECT Messenger 4.0. The following modules are described in this NTP but are not available at initial General Availability. • • • • • • eFR eLICENSE eLOCATION eSMS eSNMP eVBVOICE The eFR module is an add-on module and is licensed separately through the eLICENSE module.
Module - eSNMP Figure 34 eSNMP parameters missing The module eKERNEL responds to the with . This configuration is taken from the Messenger_CFG database table eSNMP. The Messenger_CFG database table contains, for example the port number 162 that is used to receive SNMPv1 and SNMPv2 traps. See the following figure. Figure 35 Messenger_CFG database table Figure 36 eSNMP connections Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.
Architecture 41 The SNMP traps are shown under the eSNMP tab. SNMP traps are ASN.1 BER-encoded. In the eSNMP the received data is represented in an XML-style way to improve readability. See the following figure. Figure 37 eSNMP traps The eSNMP module can determine the originator of the SNMP trap. For example in Figure 37 "eSNMP traps" (page 41), an SNMPv1 trap was received from 10.128.84.22. The SNMP trap also contains some “header” information, such as the following.
Module - eSNMP Figure 38 Parameters used by eKERNEL to generate a message The eKERNEL module has two configuration tables to support the eSNMP module. The table eSNMP provides configuration items for an instance of eSNMP, and provides the information in and parameter exchange. The eSNMP table can also define automatic creation of trap definitions in the eSNMP_TRAPS table, and provides default values for those automatically created definitions in eSNMP_TRAPS.
Architecture Figure 40 eSNMP The other configuration table the eKERNEL module has to support the eSNMP module is eSNMP_TRAPS. This module defines the traps that are processed by the eSNMP module. When the eSNMP table specifies auto configuration, the eSNMP_TRAPS are automatically populated with definitions as new traps are received. This allows system administrators to gradually optimize configurations by updating the definitions, and associating alarm identifiers, groups and message.
Module - eSNMP Figure 42 eSNMP_TRAPS The eSNMP module is designed to handle the parameters available in SNMPv1 traps, such as community, enterprise OID, generic trap, and specific trap. These fields are considered key-fields, and allow the eSNMP module to associate. • • • Action (*SET or *RESET) • Message Alarm identifier (as specified in eKERNEL_ALARM table) Group (as specified in eKERNEL_GROUP and eKERNEL_GROUP_ MEMBER) The message can be a combination of fixed text and replacement values.
Send SNMP Message for Win32 45 Figure 44 Supported replacement values When the SNMPv2 syntax is used, the parameters enterprise OID, generic trap, specific trap, and timestamp are not available. These missing parameters are provided as value 0 so the existing implementation can also handle SNMPv2 traps. You must specify 0 in the corresponding fields to preserve the unique key. The definitions are related to site and area. This means every instance of eSNMP can have an appropriate definitions.
Module - eSNMP When the program is launched, a window appears and defaults to IP address 127.0.0.1 and port 162. If Send SNMP Message is installed on the same PC as the eSNMP module, the default value should not be changed. If Send SNMP Message is installed on a different PC, adjust the IP address and port to match the PC where eSNMP runs. The window contains several input-capable fields that allow you to set every parameter. When pressing the Send button, an SNMPv1 trap is sent to eSNMP.
Send SNMP Message for iSeries 47 Figure 47 Send an SNMP trap Send SNMP Message for iSeries A similar program called Send SNMP Message is available for the IBM eServer iSeries platform. This program is also referred to as IBM AS/400 or IBM i5. This Send SNMP Message for iSeries features a command line interface, and is easily embedded in existing legacy code written on CLP, RPG, RPG/LE an so on. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.
Module - eSNMP Figure 48 Send SNMP message (SNDSNMPMSG) Contact Nortel product support to obtain more details. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Module - eTM The module eTM is an application that is represented as a small icon in the system tray on the bottom right-hand side of the desktop. This tray is usually populated with other applications, as shown in Figure 49 "System Tray" (page 49), where the eTM icon is shown to the immediate left of the clock. Figure 49 System Tray When the mouse is moved over the icon in the system tray, right-click to open the menu shown in Figure 50 "Open Task Manager" (page 49).
Module - eTM Figure 51 eTM Task Manager Note: The window contents vary according to your configuration settings. The window is composed of the following sections: • The upper section presents a tree-view of the environment, and contains a hierarchical overview of all configured tasks. Every task has the following keywords and values: — The keyword PID denotes the process identifier of the task. This identifier is formatted as a 10-digit numeric value.
Send SNMP Message for iSeries 51 Table 1 Supported window styles (cont’d.) Value Description 1 Window has focus and is restored to its original size and position. 2 Window is displayed as an icon with focus. 3 Window is maximized with focus. 4 Window is restored to its most recent size and position. The currently active window remains active. 6 Window is displayed as an icon. The currently active window remains active.
Module - eTM Figure 52 Specify the eTM environment (when more than one is configured) If there is more than one environment configured, you can choose to automatically select a startup environment. This can be accomplished by extending the launch command with the keyword /Site:xxxxx, where xxxxx is to be replaced by the configured environment name. For example, the following command automatically launches the eTM for environment GNTN1SFMI. Table 3 Launch ETM command C:\SOPHO Messenger@Net\Exe\eTM.
Send SNMP Message for iSeries Figure 54 "Sample eTM configuration" (page 53) shows a sample configuration for the eTM module that defines the following: • • One instance of CSTA_Service.exe One instance of eKERNEL.exe The text file represented in Figure 54 "Sample eTM configuration" (page 53) has a filename with extension .reg and can be created with a text editor (for example, Notepad). Figure 54 Sample eTM configuration Files with .reg extension can be merged to the registry. Procedure 2 Merging .
Module - eTM 2 Confirm that you wish to merge the registry. Click Yes to continue. 3 Confirm completion of the registry merge. Click OK. --End-- The command RegEdit or RegEdt32 can be used to verify the configuration, or to apply changes to an existing configuration. A future release of DECT Messengerwill provide automatic procedures for configuring the Task Manager from the Configurator module. In current release the eGRID module features a command button Generate registry files for eTM.
Send SNMP Message for iSeries Procedure 3 Generate shortcuts Step Action 1 Use eGRID to generate registry files for eTM. Launch eGRID and click Generate registry files for eTM. 2 Review the information provided, and acknowledge completion of the process. Click OK to continue. --End-- Figure 55 "Example of configuration of four environments" (page 56) shows a configuration of four environments. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.
Module - eTM Figure 55 Example of configuration of four environments • Site 1 — Environment GNTN1SFMI — Environment GNTN1SKDS • Site 2 — Environment *LOCAL • Site 3 — Environment *LOCAL The first two environments reside on site 1, the other environments reside on other sites. In this example, the modules of site 1 are distributed across two environments (two separate PC platforms).
Send SNMP Message for iSeries Figure 56 eTM - Site 1 - Environment GNTN1SFMI.reg Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Module - eTM Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Send SNMP Message for iSeries Figure 57 eTM - Site 1 - Environment GNTN1SKDS.reg Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Module - eTM Figure 58 eTM - Site 2 - Environment LOCAL.reg Figure 59 eTM - Site 3 - Environment LOCAL.reg Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Send SNMP Message for iSeries 61 At startup, the eTM retrieves the configuration, and launches all tasks that are defined in the environment according to the configuration. As shown in the example in Figure 59 "eTM - Site 3 - Environment LOCAL.reg" (page 60), the environment GNTN1SCTI launches the DECT Messengermodules CSTA Server, and the module eKERNEL.
Module - eTM A system administrator can also terminate a task from within the eTM_HA environment using a Terminate process API-call. Note: Using the Terminate process API-call can cause data loss, as this does not provide any graceful cleanup or shutdown of the associated program. To terminate a process, use the menu Kill task option, as shown in Figure 63 "Kill Task" (page 62).
Figure 64 A task is terminated Note: When the eTM is running, the system relaunches the terminated tasks within 10 seconds. When the eTM form is closed through the control box on the right top of the form, the application does not shut down, but is instead minimized to an icon in the system tray. This function is designed to prevent the user from accidentally closing the eTM and associated tasks.
Module - eTM 1 Open the eTM_HA pop-up menu. Right-click the eTM_HA icon in the system tray. 2 Stop the eTM_HA. • • Choose the menu item Task Manager - Stop. Choose the menu item Exit. The following confirmation prompt is shown; do not click OK or Cancel yet: Note: The application also responds to a system Log off or Shut down event. 3 Shut down the applications. Close down all programs using the program specific instructions.
. Module - eTM_HA ATTENTION Setting up the eTM_HA module in a networked environment is a complex task, and requires training to set up, maintain, and use in the DECT Messengerenvironment. Read the following documentation closely, and refer to the training session on eTM_HA for more details. Overview The module eTM_HA is the high-availability implementation of the eTM module. If you wish to migrate your system from eTM to eTM_HA, you must update the system registry.
Module - eTM_HA The menu option Open Task Manager restores the main menu, and can be opened to monitor the tasks in detail. This menu also provides options to Start, Stop, or Pause processing. Use the Exit menu option to terminate the eTM_HA module and all associated tasks. When the Open Task Manager menu option of the pop-up menu is selected, a window similar to Figure 67 "eTM-HA Task Manager - Overview tab" (page 66) opens. The Overview tab shows the configuration, which is fetched from the registry.
Publisher and Subscriber 67 Figure 68 eTM-HA Logging tab Note: The information shown in Figure 66 "Open Task Manager" (page 65) is intended as an example. The exact information for your system differs according to your configuration settings. Publisher and Subscriber A typical eTM_HA environment involves one system configured be Publisher, and one or more system configured as Subscribers.
Module - eTM_HA The eTM_HA software must be installed on both the Publisher and the Subscriber site. Based upon configuration settings in the registry, the instance behaves as Publisher or as Subscriber.
Registry settings eTM 69 ATTENTION If the environment names for eTM_HA are not defined with a name containing the local IP address, rename the registry structure generated by eGRID or eCONFIG, so that the IP address is available in the name. The eTM structure can contain one or multiple environments. If you launch the eTM_HA.exe without additional parameters, the program analyzes the available environments of the registry, and prompt for an initial environment at startup.
Module - eTM_HA "C:\SOPHO Messenger@Net\Exe\eTM_HA.exe" / Environment:Site 1 – Environment 10.110.50.138 Note: In eTM.exe a similar function existed, but the keyword was called /Site. In eTM_HA the keyword is renamed to /Environment. eTM registry entries accept the following parameters: • PID The keyword PID denotes the process identifier of the task. This identifier is formatted as a 10-digit numeric value. The PID is also shown when Microsoft Task Manager is used to represent the processes.
Registry settings eTM 71 Figure 71 Sample registry file of the eTM, illustrating a Publisher site Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Module - eTM_HA Figure 72 "Sample registry file, illustrating a Subscriber section in production mode" (page 72) shows another example, illustrating a Subscriber section in production mode. There is no eKERNEL reference in this example, as all modules refer to the eKERNEL on the publisher system. Figure 72 Sample registry file, illustrating a Subscriber section in production mode Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.
Registry settings eTM_HA 73 Figure 73 "Sample registry file, illustrating a Subscriber section in backup mode" (page 73) shows another example, illustrating a Subscriber section in backup mode. Here an eKERNEL reference is shown, as the environment runs when the publisher is unavailable. All modules refer to the local eKERNEL on the subscriber system.
Module - eTM_HA [HKEY_CURRENT_USER\Software\Philips\SOPHO Messenger@Net\eTM_HA] This section contains additional configuration settings that are needed for configuring the high-availability functionality that is added in eTM_HA.
Registry settings eTM_HA 75 The Publisher section contains a structure as shown Figure 75 "Registry settings: Publisher section" (page 75): Figure 75 Registry settings: Publisher section The same information is represented in the eTM_HA Overview tab, as illustrated in Figure 76 "Registry settings: Publisher overview in eTM_HA" (page 76). Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks.
Module - eTM_HA Figure 76 Registry settings: Publisher overview in eTM_HA The Subscribers section contains a structure as illustrated in Figure 77 "Registry settings: Subscribers (0) section" (page 77) and Figure 78 "Registry settings: Subscribers (1) section" (page 77). Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Registry settings eTM_HA Figure 77 Registry settings: Subscribers (0) section Figure 78 Registry settings: Subscribers (1) section The same information is represented in the eTM_HA Overview tab, as illustrated in Figure 79 "Registry settings: Subscribers overview in eTM_HA" (page 78). Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Module - eTM_HA Figure 79 Registry settings: Subscribers overview in eTM_HA The General section contains a structure as illustrated in Figure 80 "Registry settings: General" (page 78). Figure 80 Registry settings: General The same information is shown in the eTM_HA Overview tab, as shown in Figure 81 "Registry settings: General in eTM_HA" (page 79). Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.
Merging registry files Figure 81 Registry settings: General in eTM_HA Merging registry files Use the steps in Procedure 5 “Merging .reg files” (page 79) to merge registry files. Procedure 5 Merging .reg files Step Action 1 Select the Merge command. In Windows Explorer: • • • Locate the file you wish to merge. Right-click the file. choose Merge from the pop-up menu, as follows: Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.
Module - eTM_HA 2 Confirm that you wish to merge the registry. Choose Yes to continue. 3 Confirm completion of the registry merge. Click OK. --End-- The command RegEdit or RegEdt32 can be used to verify the configuration, or to apply changes to an existing configuration. Future releases of DECT Messengerwill provide automatic procedures for configuring the Task Manager from the Configurator module. The eGRID module features a command button Generate registry files for eTM.
Check tasks 81 Procedure 6 Generate shortcuts Step Action 1 Use eGRID to generate registry files for eTM. Launch eGRID and click Generate registry files for eTM. 2 Review the information provided, and acknowledge completion of the process. Click OK to continue. --End-- Note: Do not forget to verify that the names of the environments in the eTM registry keys contain the IP address; if not, rename the key to include the IP address.
Module - eTM_HA This usually occurs during maintenance of one of more of the programs that are guarded by the eTM_HA. This temporary condition is shown in the logging. A system administrator can also terminate a task from within the eTM_HA environment using a Terminate process API-call. Note: Using the Terminate process API-call can cause data loss, as this does not provide any graceful cleanup or shutdown of the associated program.
Check tasks 83 ATTENTION Nortel recommends that you close applications using shut down or exit/close options in the applications, to ensure a clean shutdown. This helps to protect volatile data, properly close down serial and sockets communications, free resources, clean up garbage, and so on. To stop the processes gracefully, follow the steps in Procedure 7 “Shutting down eTM_HA” (page 83). Procedure 7 Shutting down eTM_HA Step Action 1 Open the eTM_HA pop-up menu.
Module - eTM_HA Because all associated tasks were already manually ended gracefully, no more processing is involved. Any associated tasks still running are terminated through a Terminate process API-call for each task that is launched from within the eTM and finally shuts down the eTM module as well. --End-- Publisher The publisher instance of eTM_HA features a TCP Server listing on a port specified in the registry. Typically, port 7000 is used as the default port.
Publisher 85 ATTENTION The TCP Server is used for internal processing only. Do not attempt to access the server unless instructed to do so. The TCP Server is to be accessed from the Subscribers only. You can test this connection (from the subscriber PCs only) with Internet Explorer. An HTTP request to port 7000 must reply with the error code shown in Figure 84 "TCP Server Error response" (page 85).
Module - eTM_HA Messenger_CFG database. Figure 86 "TCP Server Get Image response" (page 86) shows an example. Figure 86 TCP Server Get Image response The XML image file provided by the GetImage request can be expanded and collapsed with the plus (+) and minus (-) signs, as shown in Figure 87 "Expanded information" (page 86). For more information on the XML image, see “XML image” (page 90).
Keeping track of states 87 tests with Internet Explorer, you must disable the proxy server for local addresses or specify the IP address of the publisher in the bypass list. Keeping track of states Both publisher and subscriber keep track of the state of the other party. This leads to a so-called "image" of Boolean settings of publisher and subscriber. Subscriber On the subscriber level, there is a state represented by P:0 and P:1, indicating whether the publisher can be reached.
Module - eTM_HA Figure 89 "Example of an image at the publisher level" (page 88) shows a network where one Publisher and two Subscribers lead to eight images, and depend on each Boolean state of available (1) or unavailable (0). The syntax for images on publisher level are similar to P:1:S0:1-S1:1. Each section is separated by a minus sign (-).
Keeping track of states Figure 90 Example: Site 1 - Environment 147.93.169.130 Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Module - eTM_HA Figure 91 Example: Site 1 - Environment 147.93.169.130 (backup) XML image The Subscriber receives the result of the GetImage in a flat-file repository, located in the following directory: C:\SOPHO Messenger@Net\Xml Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Keeping track of states 91 ATTENTION This directory must be created manually on Subscriber systems. Also a copy of the Messenger_CFG.mdb with the exact layout of the database of the publisher must be created in this directory. If the database is missing or has incorrect layout, system malfunction results. An update of eKERNEL on the Publisher site must always be synchronized with the same update on subscribers systems, and the eKERNEL can automatically add changes to the database at startup.
Module - eTM_HA C:\SOPHO Messenger@Net\Xml\Messenger_CFG.xmlat subscriber • (converted into MDB on subscriber) C:\SOPHO Messenger@Net\Xml\Messenger_CFG.mdbat subscriber • (processed through optional SQL script, described in Figure 92 "Sample SQL script" (page 92)) C:\SOPHO Messenger@Net\Xml\Messenger_CFG.mdbat subscriber • (activated on subscriber) C:\SOPHO Messenger@Net\Mdb\Messenger_CFG.
Conclusion 93 Conclusion Careful planning and testing is required. Nortel recommends you simulate every configured scenario, and analyze in detail the possible impact of every scenario. An off-site testing procedure in a lab environment is usually appropriate, to prevent loss of alarms (during change in image, eKERNEL and other modules are stopped and all alarms can be lost). Also, take into account that having a high-availability solution in place affects change management.
Module - eTM_HA Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Module - eVBVOICE ATTENTION Due to the ongoing development of the DECT Messenger product suite, some modules that provide additional functionality may become available after the initial release of DECT Messenger 4.0. The following modules are described in this NTP but are not available at initial General Availability. • • • • • • eFR eLICENSE eLOCATION eSMS eSNMP eVBVOICE The eFR module is an add-on module and is licensed separately through the eLICENSE module.
Module - eVBVOICE Figure 93 eVBVOICE inbound call Figure 94 eVBVOICE outbound call Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Introduction 97 Inbound calls General configuration parameters General parameters for each eVBVOICE application are specified in the eVBVOICE table. Figure 95 General configuration parameters An eVBVOICE application must be unique for every site + area. Functionality The telephone number when a user calls eVBVOICE can be a group number, or a direct number, as defined in the telephone switch. The users hears the Welcome message, eVBV_Welcome_str and then can select specific menu options.
Module - eVBVOICE Figure 97 Menu option level 1 - General tab eVBVOICE menu option level 1 Depending on the data entered in the configuration table for the first menu, eVBVOICE_MENU_L1, the user can select an option by pressing the corresponding keystroke or dtmf tone. The users hears the wave file linked with that option. When a user hears the Welcome message, and presses 1 and #, for example, the users hears the wave file AlarmConfirmation.wav.
Introduction 99 If a message that is sent contains a message that must be confirmed, the user can make a call to the eVBVOICE application to confirm the alarm. The user hears a welcome message when connected and must select the menu option for confirmation of alarms (*CONFIRM). The user is prompted to enter his pincode (eVBVM_L1_Menu_Wavfile_str ). This pincode is related to a device configured in the DEVICE table in the configuration database (DEV_PinCode_str in eKernel_device table).
Module - eVBVOICE Figure 98 eVBVOICE option level 2 Figure 99 Menu options level 2 - General tab All possible alarms that can be set (*SET) or reset (*RESET) with a dtmf keystroke must be entered in this table. Although there is no password access protection, you can secure the activation of an emergency by choosing a very large menu option. Choosing a large menu option is very difficult to guess by an unauthorized person.
Introduction 101 When a message is set or reset, and accepted by the eKernel (remote system), the user hears the message on the menu option level 2 (eVBVM_L2_Menu_Wavfile_str). Otherwise, the Error message (eVBV_Error_str) plays. Through a specific option specified in the Menu Level 1 table, some users can record the wave files linked to the different options.
Module - eVBVOICE Figure 101 eVBVOICE_Menu_L2 Example site 1: • To make a call to the eVBVOICE application, enter: 1# to record AlarmConfirmation.wav file • 2# to record AlarmSET.wav file • 2*1# to record EvacuationSET.wav file For recording the general wave files specified in the eVBVOICE table, the wave files must be specified in the eVBVOICE_MENU_L2. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.
Introduction 103 Figure 102 eVBVOICE MENU Options table Also wave files specified in the eKernel_Message_format table can be entered in the eVBVOICE_MENU_L2 table. These wave files can be then be recorded by the eVBVOICE application. A wave file can also be recorded by another infrastructure, but it is very important to be aware that the format must be compatible (Audio Format : CCITT u-Law 8,000 kHz; 8 bit; Mono). Figure 103 Properties for AlarmConfirmation.
Module - eVBVOICE Outbound calls An alarm that is linked with a wave file, if the wave file exists, can be sent to a device with the eVBVOICE module. Once all the wave files for a specific call are played, you enter a keystroke to ensure messages are delivered. This functionality is necessary to be sure the user hears the messages. Answering machines and voice mails perform in the same manner.
Introduction 105 table), the alarm is reset or set for an alternative device (only if DEV_Retry_count_ALT_DEV_id_n > 0). Note: Remark : in the current release you cannot configure alternative devices with an outputpgm (ALT_Alt_OUTPGM_Appl_str in eKErnel_device _alt) for eVBVOICE devices (ALT_OUTPGM_Appl_str = eVBVOICE), because the alternative device otherwise receives the name of the wave file specified in the eKernel_Message_format table, instead of the original message. VBV4.INI.
Module - eVBVOICE Figure 107 Ini settings - Directories [Languages] [Languages] controls which rules are used for each language. Settings are made by adding any combination of flag values, for example English = 0x1 + 0x20000 =0x20001. The following are the flags available.
Introduction 107 Figure 108 Ini settings - Languages Figure 109 Languages - Default settings [Layout] A value of 0 means do not show the name/type. A value of 1 means show the name/type. Figure 110 Ini settings - Layout [Logs] Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Module - eVBVOICE Figure 111 Ini settings - Logs [PBX] Figure 112 Ini settings - PBX [PlayMsgs] Figure 113 Ini settings - PlayMsgs [Record] Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Introduction Figure 114 Ini settings - Record [Rhetorex] Refer to “VBV4.INI Hardware-specific settings” (page 111). [SAPI_TTS] Figure 115 Ini settings - SAPI_TTS [SAPI_ASR] Figure 116 Ini settings - SAPI_ASR [System] Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Module - eVBVOICE Figure 117 Ini settings - System [VoiceCard] “VBV4.INI Hardware-specific settings” (page 111) Figure 118 Ini settings - VoiceCard Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Introduction VBV4.INI Hardware-specific settings Note: Ini settings use both upper and lower case for readability, however the entry in the file is not case-sensitive. [AccuCall] Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Module - eVBVOICE Figure 119 Ini settings - AccuCall [Dialogic] Figure 120 Ini settings - Dialogic [Rhetorex] Figure 121 Ini settings - Rhetorex [Voicecard] - (ACULAB specific settings) Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Introduction 113 Figure 122 Ini settings - [Voicecard] (ACULAB specific settings) [Voicecard] - (Dialogic specific settings) Figure 123 Ini settings - [Voicecard] (Dialogic specific settings) [Voicecard] - (Dialogic T1 specific settings) T1 bit pattern settings are used to configure the T1 bit patterns for the A & B bits for non-standard T1 configurations. The first digit is the value for ’A’ bit, the second is the value for ’B’ bit.
Module - eVBVOICE • • • 0 = set the bit specified in t1hookflash, clear any others 1 = set the bit specified in t1hookflash, leave others unchanged 2 = clear the bit specified in t1hookflash, leave others unchanged The difference between t1answer and t1hangup settings is used to test for hangup notification from the switch. For example, if t1answer is 11 and t1hangup is 10, the B bit going to 0 is used to detect hangup.
Introduction 115 Figure 126 Ini settings - [Voicecard] (Rhetorex specific settings) [Voicecard] - (Rhetorex T1 specific settings) When the first seizure attempt fails, a random back-off is performed followed by another seizure attempt. If this second attempt fails, a failure is reported. Most T1 settings for Brooktrout/Rhetorex cards are now set in the RealCTdrivers. Figure 127 Ini settings - [Voicecard] (Rhetorex T1 specific settings) From VBVOICE4.
Module - eVBVOICE Figure 128 vbvConfig tool - Voicecard Figure 129 vbvConfig - System Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Module - eVBVOICE AHVR ATTENTION Due to the ongoing development of the DECT Messenger product suite, some modules that provide additional functionality may become available after the initial release of DECT Messenger 4.0. The following modules are described in this NTP but are not available at initial General Availability. • • • • • • eFR eLICENSE eLOCATION eSMS eSNMP eVBVOICE The eFR module is an add-on module and is licensed separately through the eLICENSE module.
Module - eVBVOICE AHVR receive the level 2 prompt. The recording stops when you press a dtmf key, or when the connection is broken. The recorded message is then distributed in the same way as pre-recorded messages. Configuration In eConfig you define the menu structure. One of the options on level 1 is to ‘SET’ an alarm. See the following figure. Figure 130 Level 1 - Set alarm On level 2, you define the alarm ID and the group.
Configuration Figure 131 Level 2 - Define alarm ID and group You need to set the only visible deviation from normal alarm handling. Instead of identifying the prerecorded message, use the keyword *RECORD. See the following figure. Figure 132 RECORD Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Module - eVBVOICE AHVR The following figure shows how *RECORD looks In the Access tables. Figure 133 RECORD in the access tables Example 1 Consider the customer site shown in the following figure. For the example, assume there are 3 types of alarms: fire, reanimation and security. Also assume that the alarm recipients are located in all of the iS3070 locations. Figure 134 Example 1 - Customer site Also assume for Example 1 that there is one eVBVoice module on site.
Configuration 121 Figure 135 Example 1 - IVR menu Example 2 for Example 2, assume the location is the same site as in Example 1. In Example 2, however, a reanimation alarm is set for a specific node or group. The IVR menu could look like the one shown in the following figure. Figure 136 Example 2 - IVR menu Voice messages are stored on the system where the eVBVoice module is located. This means that voice messages can only be distributed by the eVBVOICE module on the same system as the voice messages.
Module - eVBVOICE AHVR Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Module - eWEB When you start your web browser application and navigate to the DECT Messengersystem that has the eWEB module operational, a window opens similar to the one shown in Figure 137 "eWEB module Sign-on" (page 123). Contact the system administrator to obtain the URL address assigned to the system. Figure 137 eWEB module Sign-on Sign-on procedure A sign-on is required; because you are not yet authenticated to the application, this window is presented in English.
Module - eWEB Figure 138 Sign on information On the lower left-hand side of the window, user status is displayed, indicating that you are not logged in at this time, similar to the following: To start working, you must log in with a valid user and password combination. The password is displayed as a series of asterisks (*) during entry. The user and password is checked against the eWEB_USER_AUTH table. Refer to the documentation for “Table: eWEB_USER_AUTH” (page 439) for more information.
Sign-on procedure 125 In the illustrations on the following pages, the user shown has a language code that refers to English forms, and a security level that gives access to all available options. The information displayed varies depending on your security level and language code. When you sign on, a window similar to the one shown in Figure 139 "eWEB main window" (page 125) is displayed.
Module - eWEB Figure 140 Expired login Send DMS-API Message The Send DMS-API Message window is shown in Figure 141 "Send DMS-API Message" (page 126). Figure 141 Send DMS-API Message Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Send DMS-API Message 127 This function allows you to send an E2-data message to a peripheral that is capable of receiving messages through this technology. The web interface presents all DECT extensions that are defined in the eKERNEL_DEVICE table for the local site and area and the output program eDMSAPI. ATTENTION The eWEB application is configured in the eWEB table, and identifies its site and area based upon the IP address of the Apache Web Server.
Module - eWEB The user can enter a message and the message type (normal or urgent) and click Enter to transmit the message. The application waits for message delivery or failure. In the case of urgent messages, this delay can sometimes be quite long because the application waits for the user to acknowledge receipt of the message by pressing OK on the DECT handset. Send SMTP Message The Send SMTP Message window is shown in Figure 144 "Send SMTP Message" (page 128).
Send Server Message 129 Figure 145 Sending messages to remote addresses As a result, the SMTP server is contacted, and a message is sent. The IP address and port number is retrieved for the server defined in the eSMTP_CLIENT table, with a matching site and area as used by the Apache Web Server. The mail is sent following the specs of RFC821. In the composed mail, the MAIL FROM: keyword is automatically retrieved from the definition in the eWEB_USER_AUTH table.
Module - eWEB This is the opposite of the Send DMS-API Message and Send SMTP Message, both of which directly access the underlying services and ignore the eKERNEL module for processing. A major advantage of using Send Server Message is that it utilizes more product features, including: logging, sending to a group of users, assigning alarm types, priorities, addressing any kind of peripherals, implementing confirmation procedures, implementing alternatives devices, and so on.
Send Group Message 131 The web user is able only to select from the list of groups that are configured for that input program. Note: The web user can submit a message to the eKERNEL, but is not able to verify that the message actually arrives at the destination address. One potential issue is that a message can be sent to a group that is empty (it has no peripherals defined as group members).
Module - eWEB Figure 149 Send Group Message In step 1, shown in Figure 150 "Select a group" (page 132), you can choose from a list of groups. These groups are retrieved from the eKERNEL_GROUP and eKERNEL_GROUP_MEMBER tables. All the groups that use a matching input program with the appropriate eWEB module (site/area) are shown to the user. Collapse or expand the group to see the group members. Click the arrow to select the group.
Send Group Message 133 The next step offers an overview of the group messages that are preconfigured for the selected group. As shown in Figure 151 "Select a message" (page 133), the eWEB_SNDGRPMSG table can define private messages per group, shared messages for all groups and also user messages.
Module - eWEB Send User Message The Send User Message window is shown in Figure 153 "Send user message" (page 134). Figure 153 Send user message In step 1, a list of groups is presented, as shown in Figure 154 "Select the group" (page 135). These groups are retrieved from the eKERNEL_GROUP and eKERNEL_GROUP_MEMBER tables. All the groups that use a matching input program with the appropriate eWEB module (site/area) are shown to the user. Collapse or expand the group to see the group members.
Send User Message 135 Figure 154 Select the group Step 2 provides an overview of the user messages that are preconfigured for your current user profiles, which is used during the login procedure in the initial window of eWEB. As shown in Figure 155 "Select a message" (page 135), the eWEB_SNDUSRMSG table can define private messages per user, shared messages for all users, or user-defined entered messages.
Module - eWEB Figure 156 Confirm your choices When the message is submitted to eKERNEL, the message "Send User Message completed normally" is displayed. Final message delivery depends on a number of factors and are beyond control of the eWEB user. Send Script Message The Work with Script Messages window is shown in Figure 157 "Send script message" (page 136).
Send Script Message • Set Script is used to activate a script. The scripts are defined the eWEB_SCRIPT table. • Trace Active Script is used to see an overview of activated scripts. These scripts are still running. • • Cancel Script is used to abort a script that has been activated. 137 Trace ended Script is used to see an overview of these scripts that are completed.
Module - eWEB In Figure 159 "Script details" (page 138), the third script has been activated, and more detailed information on the script is provided (only one such script can be activated at a time). The window shows us that one device is a member of the group, and the device is configured to be available 24/24 hours and 7/7 days. A minimum of one device must confirm the alarm, therefore you must not clear the device selection.
Alarm Inquiry 139 Cancelled scripts are removed from the list, as shown in Figure 162 "Cancelled script removed from the list" (page 139). Figure 162 Cancelled script removed from the list Trace Ended Script Trace Ended Script, shown in Figure 163 "Trace Ended Script" (page 139), allows you to monitor the event handling of scripts that are finished.
Module - eWEB Figure 164 Alarm inquiry Device Inquiry The device inquiry allows you to see all relevant parameters for the eKERNEL_DEVICE file, as shown in Figure 165 "Device inquiry" (page 141). Only those records are shown that refer to the site where the current eWEB instance resides. The information is retrieved from one table: eKERNEL_DEVICE. You can either display data for all output programs (by specifying *ALL) or select one output program.
Group Inquiry 141 Figure 165 Device inquiry Group Inquiry The group inquiry allows you to see all relevant parameters for the eKERNEL_GROUP and eKERNEL_GROUP_MEMBER files, as shown in Figure 166 "Group Inquiry" (page 142). Only those records are shown that refer to the site where the current eWEB instance resides. The information is retrieved from multiple tables: eKERNEL_GROUP, eKERNEL_GROUP_MEMBER, eKERNEL_INPGM, eKERNEL_DEVICE, eKERNEL_SITE and eKERNEL_AREA. You can select the data for each area.
Module - eWEB Figure 166 Group Inquiry Table View The Table View function allows you to perform inquiry functions of all tables available in Messenger_CFG database. Only users with security administrator special authority rights can access the eWEB_USER_AUTH file. Users who lack security administrator special authority rights cannot access this table, which contains sensitive information such as passwords. An example of a table is shown in Figure 167 "Table View" (page 143).
Work with Groups 143 Figure 167 Table View Work with Groups Click Work with Groups to access group maintenance functions. Users with all object special authority can access all groups, while users without these rights can access only groups specified in eKERNEL_GROUP_AUTH. Note: If no groups are shown, the user has no all object special authority, or no access to any group. You must grant if necessary access to one or more groups through the eKERNEL_GROUP_AUTH table.
Module - eWEB Next, you can either maintain an existing device or add a new device. The example shown in Figure 169 "Select a device" (page 144) demonstrates selecting an existing device for maintenance (update or delete). Figure 169 Select a device The values displayed when you choose Work with Groups refer to the fields in the eKERNEL_GROUP_MEMBER table. Refer to “Table: eKERNEL_GROUP_MEMBER” (page 349) for details.
Change Password 145 Figure 170 Confirm changes If you select to add a new device, a window similar to the one in Figure 171 "Select new device" (page 145) is shown. Select one of the configured devices and specify the additional parameters prior to adding the device. Figure 171 Select new device Note: You can access only the devices that belong to the same site as used by the eWEB module.
Module - eWEB • • your new password your new password (for verification) This option eliminates the need for an eGRID-based administration of passwords of existing user profiles. Figure 172 Change password Note: More advanced security settings or resetting passwords of users that forgot their password, still must be performed through eGRID in the eWEB_USER_AUTH table. Some additional tables (with extension _AUTH) are available for more detailed security implementation.
Plug-in Support 147 Figure 173 Info: more documentation Sign off The sign-off link logs you out of the system. You must always sign off if you leave your browser unattended, to prevent other users from accessing eWEB functions. ATTENTION Due to the users’ ability to activate disaster scenarios, evacuation scenarios, and others, you must clearly inform all users of the risk they run by leaving their browser unattended.
Module - eWEB Figure 174 Plug-ins added to eWEB Plug-in module MyPortal@Net An example of a plug-in module is MyPortal@Net. The interface is shown in Figure 175 "MyPortal@Net plug-in" (page 148). This module is not part of the base product, and is sold separately. The application provides a web interface for outbound voice-calls integrated in the eWEB module. This allows data retrieval from any data repository, including Sigma PhoneWare BTS_DIR directory.
. Module - Web Administrator The module Web Administrator provides a new web-based user interface. Web Administrator builds on the infrastructure of eWEB and depends on the same prerequisites, such as the Apache HTTP Server, PHP scriping engine, and ODBC DSN for Messenger_CFG and Messenger_DATA database.
Module - Web Administrator Figure 176 Web Administrator login page 2 To log in to Web Administrator, a user name and password combination is needed. Enter the default user name admin and the default password admin. --End-- Authentication Authentication is based on eWEB configuration. The eCONFIG can be used to maintain users, as shown in Figure 177 "eWEB user authority" (page 151). Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.
Work with Users 151 Figure 177 eWEB user authority Work with Users When you login with the default user name and password, you have the default administrative rights and full access to the Web Administrator. One of the features is Work with Users. Use this feature to maintain the users, as shown in Figure 178 "Work with Users in Web Administrator" (page 152). Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.
Module - Web Administrator Figure 178 Work with Users in Web Administrator Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Module - Web Administrator User Guide The Web Administrator provides a web based user interface. Ensure that you have a compatible web browser, such as Internet Explorer 6.0 or Mozilla Firefox 2.0. In the web browser’s Address field, enter the URL where Web Administrator is installed, for example http://messenger/ez_index.php. When you enter this URL in your web browser, the Login page appears, as shown in Figure 179 "DECT Messenger Login screen" (page 154).
Module - Web Administrator User Guide Figure 179 DECT Messenger Login screen Authorization level The contents of the navigation pane in the Web Administrator varies depending on the authorization granted to the user account that is used to log on. Figure 180 "Navigation pane for Administrator user" (page 155) shows an example of a navigation pane for a user with Administrator rights. Users with less authorization see a reduced number of links, restricting access to certain functions.
Authorization level Figure 180 Navigation pane for Administrator user DECT Messenger offers five levels of user authority, as described in . Table 5 User authorization levels Authorization level Functionality User (basic) • Send a Message — DECT handset — Mobile phone — Email — Windows • • Security Logout Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Module - Web Administrator User Guide Authorization level Functionality User (advanced) • Send a Message — DECT handset — Mobile phone — Email — Windows — Group Message — User Message • • Security Logout Authorization level Functionality User (expert) • Send a Message — DECT handset — Mobile phone — Email — Windows — Group Message — User Message • Reporting — Alarms • – Active alarms – Ended alarms – Report Configuration — Basic • – Group members – Alternative devices – Ove
Authorization level Authorization level Functionality Supervisor • Send a Message — DECT handset — Mobile phone — Email — Windows — Group Message — User Message • Work with scripts — Activate script — End script • Reporting — Alarms – Active alarms – Ended alarms – Report — Scripts • – Active alarms – Ended alarms Configuration — Basic • – Group members – Alternative devices – Overview Security — Change password • Logout Nortel Communication Server 1000 DECT Messenger Install
Module - Web Administrator User Guide Authorization level Functionality Administrator • Send a Message — DECT handset — Mobile phone — Email — Windows — Group Message — User Message • Work with scripts — Activate script — End script • Reporting — Alarms – Active alarms – Ended alarms – Report — Scripts • – Active alarms – Ended alarms Configuration — Basic – Group members – Alternative devices – Overview — Advanced – Devices – Facilities – Groups – Users — Expert •
Authorization level 159 — Change password • Logout The following section describes the functionality of accounts that have User authorization levels. Other accounts are described in “Supervisor” (page 194) and “Administrator” (page 204). Log in Your system administrator provides your user name and password. Keep your user name and password confidential; do not exchange this information with others, unless you are instructed to do so by your system administrator.
Module - Web Administrator User Guide 2 In the User field, enter the user name provided by your administrator. 3 In the Password field, enter the password provided by your administrator. The password appears as a series of asterisks (*). 4 Click Submit. If you enter an incorrect user name or password, an error message appears: Invalid user and password combination. Try again; if you still cannot log in, contact your system administrator.
Authorization level 161 The middle of the left pane is a navigation menu that provides a hierarchical representation of the available functions. The available links depend on the authorization level of the user, and on what modules and infrastructure are installed or available. The bottom part of the left pane contains a menu that allows you to change the language of the user interface. The default language is English; you can choose other languages, if they are installed on the system.
Module - Web Administrator User Guide peripherals are logically split into four different areas. The administrator defines the name for each area, such as campus, address, building, and so on. When you send a message, you must first select the area. Figure 181 A multi-site environment Send a message to a DECT handset Use the following procedure to send a message to a DECT handset. You can only send messages to DECT Handsets that are configured on the system by the administrator.
Authorization level 163 The Send a Message page appears, on which appears a list of all DECT handsets to which you can send a message. There is room to display 14 devices on the screen at any one time -- if there are more than 14 handsets listed, click [pgdn] or [pgup] to navigate to the next page or previous page. To return to the first page, click [home]. In order to speed up the process of finding the destination, you can use the search field. If the search field is empty, all records are retrieved.
Module - Web Administrator User Guide The Send a Message > Please enter message information page appears. 4 Enter the text of your message in the Message field. The length of the message you can enter is displayed in the field to the right of the Message field. 5 Use the Priority menu to assign a priority to the message, where the priority is one of Normal, Urgent, or Emergency. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.
Authorization level 6 165 Click Submit. Web Administrator indicates whether the message delivery succeeded or failed. --End-- Table 6 Job aid: maximum message length System Maximum length of message traditional DECT up to 48 characters SIP DECT up to 160 characters Table 7 Job aid: message priorities Priority Behavior Normal The system verifies delivery of the message without requesting confirmation from the recipient.
Module - Web Administrator User Guide Send a message to a mobile phone You can send messages to a mobile phone only if the eSMS module is installed and licensed, and configured on the system. Use the following procedure to send an SMS message to a mobile GSM phone. You can only send messages to mobile phones that are configured on the system by the administrator. Procedure 11 Sending a message to a mobile phone Step Action 1 Log in to Web Administrator.
Authorization level 167 [pgup] to navigate to the next page or previous page. To return to the first page, click [home]. 3 Select a recipient by clicking the green arrow at the left of the entry. The Send a Message > Please enter message information page appears. 4 Enter the text of your message in the Message field. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Module - Web Administrator User Guide The length of the message you can enter is displayed in the field to the right of the Message field. 5 Click Submit. Web Administrator indicates whether the message delivery succeeded or failed. --End-- Web Administrator reports that the message was successfully delivered when the mobile provider accepted the message. If the mobile phone is powered off, the mobile phone user can receive the message only when the when the mobile phone is later switched on.
Authorization level 169 There is room to display 14 devices on the screen at any one time -- if there are more than 14 address listed, click [pgdn] or [pgup] to navigate to the next page or previous page. To return to the first page, click [home]. 3 Select a recipient by clicking the green arrow at the left of the entry. The Send a Message > Please enter message information page appears. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.
Module - Web Administrator User Guide 4 Enter the text of your message in the Message field. The length of the message you can enter is displayed in the field to the right of the Message field. 5 Click Submit. Web Administrator indicates whether the message delivery succeeded or failed. ATTENTION The e-mail is sent on behalf of the e-mail account that was configured by the administrator. Therefore, you have no record of this message, and any responses are not delivered to you.
Authorization level 171 Send a message using Group message Group messages are messages you can send to previously configured groups of recipients. Group messaging is only available if the administrator has configured it, and has populated the eWEB_SNDGRPMSG table. Procedure 13 Sending a message using Group message Step Action 1 Log in to Web Administrator. 2 In the navigation menu, click Group message. OR If multiple areas are defined, click the name of the area, then click Group message.
Module - Web Administrator User Guide If you select the wrong group, click back to select a different group. 4 Click continue to confirm the group selection. The Send Group Message > Please select message page appears. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Authorization level 173 Up to three types of messages are supported, depending on your system configuration: • • • Private messages Shared messages Free messages 5 Select the message to send by clicking the green arrow next to it. If you select Free message, type the text of your message. 6 Click Submit. Web Administrator indicates whether the message delivery succeeded or failed.
Module - Web Administrator User Guide Type Description Shared messages Are messages, defined by your system administrator, that you can send to any group. Free messages Are custom messages you type yourself. Send a message using User message User messages are messages you can send to previously configured groups of recipients. User messaging is only available if the administrator has configured it, and has populated the eWEB_SNDGRPMSG table.
Authorization level 3 175 Select the group to which to send a message. The Send User Message > Please confirm group page appears. This page lists the group members. If you select the wrong group, back to select a different group. 4 Click continue to confirm the group selection. The Send User Message > Please select message page appears. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks.
Module - Web Administrator User Guide Up to three types of messages are supported, depending on your system configuration: • • • Private messages Shared messages Free messages 5 Select the message to send by clicking the green arrow next to it. If you select Free message, type the text of your message. 6 Click Submit. Web Administrator indicates whether the message delivery succeeded or failed.
Authorization level Type Description Shared messages Are messages, defined by your system administrator, that you can send to any group. Free messages Are custom messages you type yourself. Change password Use the information in this section to change your password. Nortel recommends that you change your password whenever you suspect someone else may have access to it. Procedure 15 Changing your password Step Action 1 Log in to Web Administrator. 2 In the navigation menu, click Change password.
Module - Web Administrator User Guide If you do not know your existing password, contact your system administrator. 4 In the New password field, enter your new password. 5 In the New password (confirm) field, reenter your new password. --End-- Reports of active alarms The system generates reports of active alarms that are processed through eKERNEL, and makes them available to users with User (expert), Supervisor, and Administrator privilege.
Authorization level 179 Figure 182 Work with Active Alarms page The report provides a snapshot of an instant in time, and is not updated in real-time. Click refresh to update the information in the report. Click on a Module to see the details of active alarms for that program, as shown in Figure 183 "Module details" (page 180). Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Module - Web Administrator User Guide Figure 183 Module details When you select a module in the Work with Active Alarms page, the active alarms associated with the selected output module appear, and for each alarm the system displays the destination device Identifier, Output program, Message, and Next call timestamp. The search field can be used to subset the view to selected subset criteria. The navigation keys [home] and [pgup] and [pgdn] allow navigating through the list.
Authorization level 181 Reports of ended alarms The system generates reports of ended alarms that are processed through eLOG, and makes them available to users with User (expert), Supervisor, and Administrator privilege. You are provided access to the internal repository that is maintained through the eLOG module through Work with Ended Alarms. Work with Ended alarms writes information into a comma separated file for every input request, output request, and output response.
Module - Web Administrator User Guide You choose between Input request and Output request in the second selection screen. Figure 185 Work with Ended alarms - Second selection screen The example in the following figure shows a number of input requests. Click the green arrow to view additional details. You can also perform optional filtering, for example upon Message. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.
Authorization level 183 Figure 186 Work with Ended alarms - Input requests Reports on alarms Reports on alarms is available to User (expert) and Supervisor and Administrator. Work with Report provides an easy web-based reporting function to combine the available information gathered by eLOG module. Work with Report also exposes the data available in comma separated files.
Module - Web Administrator User Guide Figure 187 Work with Report - Selection box Configuration of basic group members Users (expert), Supervisors, and Administrators can use the configuration function Work with Group Members for web-based maintenance of group members. The function also internally maintains the content of the eKERNEL_GROUP_MEMBER table. Follow the steps in the next procedure to configure Work with Group Members.
Authorization level 185 The following figure shows an example of a selected module. In the example, the configuration contains two areas. The eAPI input module on area 1 is selected. 2 Select a group for the chosen input module. In the example shown in the following figure, group 00001 is chosen. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Module - Web Administrator User Guide The next figure shows the current group member for the example. The left-hand section provides the current group members The right-hand section provides a list of all available peripherals. The bottom area provides space to show details. 3 Click on an existing group member to see details. The following figure shows the details after clicking on 865 – Francis Missiaen. The bottom area shows details such as the start hour, end hour, and weekly presence.
Authorization level 4 187 To update the details, change the start hour and end hour and click the [update] link. In the example shown in the next figure, an update is done by changing From into 08:00 and To into 12:00 and clicking the [update] link. 5 Click the [remove] link to remove a group member. See the example in the following figure. 6 Select a destination device in the right-hand area to insert a new group member.
Module - Web Administrator User Guide default details showing membership from 00:00 to 23:59 on all days is presented. 7 Optionally, adjust the default settings and click [insert]. In the example shown in the following figure, the default settings Sat, Sun, and Hol are changed to No. --End-- Configuration of basic alternative devices User (expert), Supervisor and Administrator can use the function Work with Alternative Devices.
Authorization level 189 Procedure 17 Configuring basic alternative devices Step Action 1 Log in to Web Administrator. 2 In the navigation menu, click Work with Alternative Devices. The Work with alternative devices page appears. 3 Under Configuration > Basic, click Alternative devices. The page Please select output module appears. 4 Select an output program.
Module - Web Administrator User Guide After you select an output module, you are presented with an overview of the available devices for that output module. In the same example presented previously, the only available device listed for the output module eNET is a single PC named BENB121027 that belongs to user Francis Missiaen. See the following figure. 5 Select a device. A page appears that presents you with a number of options. See the next figure for an example.
Authorization level 6 191 Click on the device listed on the right of the page to add an alternative device. See the previous figure. In the example in the previous figure, no alternative devices are present. To add the mobile phone of Francis Missiaen as an alternative device, Francis is typed into the subset field under Click on devices to add alternative device, and [subset] is clicked.
Module - Web Administrator User Guide Then Device: 32473897171 – Francis Missiaen is clicked and the details shown in the next figure appear. When [insert] is clicked, the mobile phone is added as an alternative device. As a result, the mobile phone is defined as alternative device for the device BENB121027, as shown in the following figure. --End-- Configuration basic overview The Configuration basic overview function is available to User (expert), Supervisor, and Administrator.
Authorization level Procedure 18 Configuring basic overview Step Action 1 Navigate to Site 1 – NEC Philips > Area 1 – Hilversum > Module eWeb – Manufacturer eWEB – Model *BASE > Group: ENET – Test from eWEB to eNET. --End-- The following figure shows an example of analyzing what happens to alarms that originate in the eWEB input module, addressed to group ENET.
Module - Web Administrator User Guide If that attempt is unsuccessful, the alternative device 1.1.eSMS.324728971 71 is used. One attempt (1x) is made to notify the alternative device. Figure 189 Contents of the selected group Click on the group member to see the details on From, To, and Daily presence. Figure 190 Group member details Supervisor A user with Supervisor authority is granted addition access to Work with Scripts. This function is accessed through the links Activate script and End script.
Authorization level 195 Figure 191 Supervisor access to Work with Scripts Work with scripts - activate script The Activate script function in Work with Scripts is available to Supervisor and Administrator. Follow the steps in the next procedure to use activate script. Procedure 19 Using activate script Step Action 1 Open Work with Scripts and click Active script.
Module - Web Administrator User Guide Note: The Web Administrator no longer implements the tables eWEB_SCRIPT_SET, eWEB_SCRIPT_TRACE, and eWEB_SCRIPT_END. If you want to implement details script authority, provide the original eWEB interface to your users through http://messenger/index.php. The previous figure shows the configured scripts. 2 Click on one of the configured scripts to select that script. The next window shows a preview of the script.
Authorization level 197 Your ability to check or un-check the check boxes in front of groups members depends on the configuration of the script. In some configurations, you cannot un-check group members as the check boxes are disabled. If you deselect too many members, the error below appears. A script defines the minimum amount of group members that are part of the script. 3 Click [submit] to activate the script. You then return to the main window.
Module - Web Administrator User Guide --End-- Work with Scripts - End Script The function Work with End Script is available to Supervisor and Administrator. Follow the steps in the next procedure to use Work with End Script. Procedure 20 Ending Scripts Step Action 1 Open the Work with Scripts window and click End script. An empty screen indicates that no active scripts are present and so no active scripts are available to end.
Authorization level 199 2 Ensure that the script you end is the correct active script. Verify the date and time and description. 3 Click on the Script to end the script. When you end the script, the following window appears. This window shows an overview of the scripts that are ended. The repository of scripts is automatically cleaned up according to the configuration settings. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.
Module - Web Administrator User Guide --End-- Reporting active scripts The Reporting active scripts function is available to Supervisor and Administrator. Follow the steps in the next procedure to report active scripts. Procedure 21 Reporting active scripts Step Action 1 From the Reporting window, click Scripts. 2 Click Active scripts. When no scripts are active, the window in the next figure appears.
Authorization level 3 201 When one or more active scripts are available, highlight the script identifier to see details. The window in the next figure shows the progress of an example of an active script. In the example, the script is just started, but as yet there is no notification. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Module - Web Administrator User Guide There is a subset box near the top of the window. The subset box has the options *ALL, *PENDING, *ACK, and *NACK. In the example in the previous figure, the subset selection is *ALL. When you select *ALL, you get a list of all active scripts. When you want to narrow the results of your search, choose *PENDING, *ACK, or *NACK.
Authorization level 203 Follow the steps in the next procedure to report ended scripts. Procedure 22 Reporting ended scripts Step Action 1 Open the Reporting window and click Scripts. 2 Click Ended scripts. When no ended scripts are available, an empty screen is shown. In the following example, multiple ended scripts are available in the repository. 3 Use the date and time criteria to identify the script.
Module - Web Administrator User Guide --End-- Administrator A user with Administrator rights has full access to all capabilities of the Web Administrator. Send an SNMP trap The function Send an SNMP trap is available to Administrator. SNMP trap is shown in the Send a Message window when the system has the eSNMP module installed, licensed and configured. SNMP trap provides a web-based basic implementation of an SNMPv1 trap sender.
Authorization level 205 Figure 192 SNMP trap For details on the capabilities of SNMP trap, refer to “Module - eSNMP” (page 39). To send an SNMP trap, enter the fields as shown in the following paragraph and the example. In the following example, an SNMPv1 trap is sent to 127.0.0.1 with community public and enterprise OID 1.3.6.1.4.1.28088.32.1. The enterprise OID 1.3.6.1.4.1.28088.32.1 is registered by NEC Philips (HQ) by Francis Missiaen. The OID range starting with 1.3.6.1.4.1.28088.32.
Module - Web Administrator User Guide Figure 193 SNMPv1 trap example In the example one varbind parameters is given. A resulting action depends on the Messenger configuration settings. For example, in Figure 194 "eSNMP module receives SNMP trap" (page 206) the eSNMP module receives the SNMP trap in Figure 193 "SNMPv1 trap example" (page 206). Figure 194 eSNMP module receives SNMP trap Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.
Authorization level 207 In this example, the result is that a Windows popup message is sent through eNET. Note: The resulting popup message contains the varbind parameter from the data entered through Web Administrator. Figure 195 Popup message sent through eNET Advanced configuration The advanced configuration is reserved for users with Administrator rights, and provides maintenance of Devices, Facilities, Groups, and Users.
Module - Web Administrator User Guide Note: The Work with facilities function maintains the table eKERNEL_DEVICE_FORMAT in Messenger_CFG database. The following figure shows an overview of sample definitions, as seen in eGRID interface. 3 Select an output module in the first window that opens in Work with facilities. This action must take place before you configure Facilities and before you create Devices in the system.
Authorization level 209 The following figure contains an example where the module eDMSAPI is selected as the module that sends LRMS messages to DECT handsets. The next figure provides an overview of the existing Facilities. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Module - Web Administrator User Guide When no definitions are available, an empty screen appears. 4 Use the [home], [pgup], and [pgdn] links to navigate through the list of definitions. 5 Click the [insert] link to add a new definition. 6 Click the green arrow to change an existing definition. Note: A Facility is considered an unique key. If, for example, you have defined C944 once, you cannot add a second C944 definition. The next figure shows the details of the selected definition C944.
Authorization level 7 211 To return from the detailed screen, click the [cancel] link. When you click the [delete] link, clicked, the facility is removed. ATTENTION In the current release of Web Administrator, no validation is to see if the definition is in use. This means you must verify if a facility is used before you delete the facility. For example, if devices exist with facility C944, you must not delete the facility.
Module - Web Administrator User Guide 9 Click [apply] to adjust the values. 10 Click [cancel] if you want your changes to be ignored. --End-- Configuration of advanced devices The Configuration of advanced devices function is to Administrator. Follow the steps in the next procedure to configure advanced devices. Procedure 24 Configuring advanced devices Step Action 1 Open the Configuration window and click Advanced. 2 Click Devices.
Authorization level 213 eDMSAPI device, at least one Facility needs to be defined prior to creating a Device. Note: This function maintains the internal configuration table eKERNEL_DEVICE in the Messenger_CFG database. In the example in the next figure, a DECT handset is added. 4 In the first window, select the Output module. In the example, the DECT handsets handled by the eDMSAPI module covering Site 1 and Area 1 are maintained. An overview of the existing Devices is shown.
Module - Web Administrator User Guide 8 In the next window, verify the input capable fields and add missing information. When adding devices, you need to select an existing Facility. In the following window, the C944 facility is selected. Note that in cases that no facilities are as yet created yet, you must define them first, and then return to the Work with Devices entry. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.
Authorization level 215 When adding a DECT handset, the field Monitor refers to the ability to trace the voice-call divert. This typically requires an additional eCSTA module and sufficient channel licenses. Leave this field set to No unless you receive instructions from the administrator. Set the IO register field to No unless instructed otherwise by the administrator. A value of Yes is used when the configuration implements inbound LRMS messaging.
Module - Web Administrator User Guide 9 Type [apply] to insert the definition. 10 To return from the detailed screen, click [cancel]. Note: Nortel highly recommended that you add a meaningful Description, as this is represented to the Web Administrator during further maintenance. Nortel also strongly recommends that you specify first name and last name, or any other unique reference, to define the owner of the peripheral.
Authorization level 217 When the [delete] link is clicked, the device is removed. Note: The current release of Web Administrator allows deleting a device without checking if it is in use by other configuration tables. Many configuration tables can be involved, for example, eKERNEL_GROUP_MEMBER, and eKERNEL_DEVICE_ALT, but also the tables related to inbound eCSTA, eDMSAPI and eLOCATION definition. Carefully verify if a device is used prior to deleting it.
Module - Web Administrator User Guide Configuration of advanced groups The Configuration of advanced groups function is available to Administrator. Follow the steps in the next procedure to configure advanced groups. Procedure 25 Configuring advanced groups Step Action 1 Open the Configuration window and click Advanced. 2 To access Work with Groups, click Groups. Groups are associated to input capable modules. Therefore, on the first screen a selection is requested on the Input module.
Authorization level 219 Next an overview of existing groups for the chosen input module is shown. 3 Use [home], [pgup], and [pgdn] to navigate through the list of definitions. 4 To add a new definition, click [insert]. 5 Click the green arrow to change an existing definition. Note: A Group is considered a unique key, so for example if you have defined 00001 once, you cannot add a second 00001 definition.
Module - Web Administrator User Guide The next figure has the details of group 00002. Nortel highly recommends that you add a meaningful Description, as this is represented to the Web Administrator during further maintenance. 6 Click the green arrow in front of a definition to maintain an existing entry. For example in the next figure, the group 00002 is maintained. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.
Authorization level The detailed screen shows the selected definition. 7 Click [edit] to alter a number of input capable fields. 8 Enter changes, then click [apply]. 9 To delete an existing definition, select the group and click [delete]. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Module - Web Administrator User Guide Note: In current release of Web Administrator, no check is performed to verify if the group is in use. • There can be group members but they are not removed automatically when a group is deleted. You should verify of group members exist and remove them prior to deleting the group.
Authorization level 223 The Work with Users page opens. Note: The Work with Users function maintains the eWEB_USER_AUTH configuration table of the Messenger_CFG database. The eWEB_USER_AUTH configuration table defines access to eWEB and Web Administrator modules. Do not delete the *ALL or admin definitions. When you delete these definitions, you are no longer able to authenticate for future maintenance through eWEB or Web Administrator.
Module - Web Administrator User Guide Figure 196 Add a new definition In the entry screen, the Administrator enters the input capable fields. • • Identifier refers to the user field that is assigned to the user Password refers to the password field that is assigned to the user The Administrator needs to provide both the Identifier and Password to the end-user, as these fields are needed to authenticate on Web Administrator.
Authorization level 225 Figure 197 Web Administrator security level The language can be selected from the list, as shown in Figure 198 "Available languages" (page 225). The languages available depends on languages installed on the system. The following figure shows that the languages available are English, French, German, and Spanish. Figure 198 Available languages The remaining fields in the Work with Users window are available for backwards compatibility with eWEB.
Module - Web Administrator User Guide Figure 199 Backward compatibility Expert The Expert function is available to Administrator. A number of additional links can be available in Web Administrator. Expert tasks The Expert tasks function is available to Administrator. Work with Tasks provides a list of active tasks that are detected in a TASKLIST command line output. The list of active tasks function is available when you run a U.S. version of the Windows XP operating system.
Authorization level 227 The Task Manager (eTM.exe) features a similar overview, shown in the following figure. However the eTM can also be used to launch processes that are not related to Messenger. As well, you can launch Messenger-related tasks that are not registered in eTM. For these reasons, the content between both interfaces can vary. Figure 200 Task Manager (eTM.exe) Note: eKERNEL also features an overview of modules.
Module - Web Administrator User Guide Figure 201 eKERNEL overview of modules Expert configuration The Expert configuration function is available to Administrator. To access this function, open the Configuration window, click Expert, and then click Configuration. Expert configuration provides an overview of the available configuration tables in Messenger_CFG database. In the example shown in the following figure, the eDMSAPI table is selected.
Authorization level 229 Figure 202 Expert configuration Expert PHP information The Expert PHP information function is available to Administrator. To access the Expert PHP information function, open the Configuration window, click Expert, then click PHP info. Expert PHP information provides the result of the phpinfo() embedded function of the PHP server site scripting engine used by the Apache HTTP Server. For further information, refer to www.php.net.
Module - Web Administrator User Guide Figure 203 Expert PHP information Export import The function Export import is available to Administrator. Note: The Import link is shown only when the Template databases are installed on the Messenger system. The Template databases reside in the path C:\SOPHO Messenger@Net\Mdb\Templates and are typically installed as part of the installation process step 02.02. SOPHO Messenger@Net – Templates. The administrator can decide to not install these templates.
Authorization level 231 Procedure 27 Installing and configuring Export import Step Action 1 Open the Configuration window and click Expert. 2 Click Import link. A window similar to the window in the following figure appears. The contents and available databases can vary. 3 Verify the conditions before you import a configuration. If you do not verify the conditions, all configuration data is lost. The system attempts to verify if eKERNEL eGRID, or eCONFIG are still active.
Module - Web Administrator User Guide After import the following message appears. The message indicates that the import was successful and the Messenger_CFG.MDB from C:\SOPHO Messenger@Net\Mdb directory is overwritten. 5 Click [continue] to log off. To log on again, enter admin password and the default password admin from the template configuration database.
. Table: eASYNC eASYNC parameters Figure 204 eASYNC parameters eASYNC_Site_id_n This field specifies the site, as defined in eKERNEL_SITE table. In most cases the value is 1. An example of an entry typically found in this field is as follows: 1 eASYNC_Area_id_n This field specifies the area, as defined in eKERNEL_AREA table. In most cases the value is 1.
Table: eASYNC eASYNC_Type_str This field specifies the provider type, which can be either PAGING or SMS. Currently there is support for PAGING with provider BELGACOM, and SMS with provider PROXIMUS or KPN. Support for other providers and types can be added in future releases, or can be built on request.
eASYNC parameters 235 Example of initialization string for provider KPN: 01/00084/O/01/0620032328///3/ 456D657267656E637920534F5320312045766163756174696F6E/E2 An example of an entry typically found in this field is as follows: *NONE eASYNC_COM_Port_str This field specifies the COM port that handles the asynchronous communication. Usually an asynchronous modem is attached to port COM02. In this case, specify COM02.
Table: eASYNC Table 10 eASYNC_Telnr_str (cont’d.) PAG ING BELGACOM *NONE 9600,N,8,1 0045250000 1 SMS KPN *NONE 9600,N,8,1 0065314141 4 SMS PROXIMUS proximus 9600,N,8,1 0047516162 2 Note: Nortel recommends that you specify 9600,N,8,1 for PAGING/BELGACOM service provider. An example of an entry typically found in this field is as follows: 00475161622 eASYNC_Init_str This field allows you to specify a modem initialization string command.
eASYNC parameters 237 eASYNC_Send_depth_n This value specifies – in combination with eASYNC_Send_time_n – when eASYNC starts processing. A value of 1 denotes immediate processing; a larger value specifies the number of messages that must be in the queue before processing starts. This value is supported only for PROXIMUS – SMS and KPN – SMS.
Table: eASYNC An example of an entry typically found in this field is as follows: 2 eASYNC_Silence_intv_n This value specifies how frequently users are informed of remaining active messages. The default value is 600 seconds, which reduces unnecessary calling traffic to the provider. Note that a similar value is implemented in eKERNEL_ALARM table. The value here overrides the value in the eKERNEL_ALARM table due to bandwidth constraints.
. Table: eBACKUP eBACKUP parameters BU_Site_id_n This field specifies the site identifier, as defined in the eKERNEL_SITE table. Usually, there is only one site defined, and the value 1 is used. An example of an entry typically found in this field is as follows: 1 BU_From_Path_str This field specifies the path of the file that must be saved.
Table: eBACKUP You do not need to manually build the directory tree structure, as the nested directory path is built automatically step-by-step during the backup procedure. In most cases, Nortel recommends that you not overwrite a previous backup. System administrators typically want to make a copy of the environment both before and after making maintenance updates, and in some cases want to store a history online.
Sample Data 241 An example of an entry typically found in this field is as follows: Messenger_CFG.mdb BU_Comments_str This field can be filled with reminder information for an administrator, for example the usage of the file. You can leave the field blank. An example of an entry typically found in this field is as follows: Configuration Database Sample Data Table 11 Sample data S i t e From path From file To path To file 3 C:\Php php.ini C:\Temp\[weekday]\php php.
Table: eBACKUP Table 11 Sample data (cont’d.) 3 C:\SOPHO Messenger@Net\E xe omnithread _rt.dll C:\Temp\[weekday]\SOPHO Messenger@Net\Exe omnithread _rt.dll 3 C:\SOPHO Messenger@Net\M db Messenger _CFG.mdb C:\Temp\[weekday]\SOPHO Messenger@Net\Mdb Messenger _CFG.mdb 3 C:\SOPHO Messenger@Net\M db Messenger _Data.mdb C:\Temp\[weekday]\SOPHO Messenger@Net\Mdb Messenger _Data.mdb Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.
. Table: eCAP_generic eCAP_generic parameters eCAPG_Inpgm_id_n This field refers to the input program identifier, as defined in eKERNEL_INPGM table. An example of an entry typically found in this field is as follows: 11101 eCAPG_Line_Sep_str This field specifies the character sequence that is used to separate input lines that are processed through the generic eCAP interface. This value must be formatted using one or more 2-byte hexadecimal ASCII values.
Table: eCAP_generic For example, the carriage return (with ASCII 13 value) is represented by 0D, because 0D is the hexadecimal value of decimal 13. Usually, this field specifies the value 0D0A, which places one carriage return, and one line feed between individual lines. Note that the indicated value must be 2-bytes or a multiple of 2-bytes; therefore the leading 0 or trailing 0 must not be omitted.
eCAP_generic parameters 245 eCAPG_Line_Select_str This value, together with eCAPG_Line_Select_start_n and eCAPG_Line_Select_len_n, is used to optionally define selection criteria, which are used to select only those records in a asynchronous datastream that are defined. This value N/A must be used if the select functionality is not used, indicated by eCAPG_Line_Select_start_n and eCAPG_Line_Select_len_n equal to 0.
Table: eCAP_generic eCAPG_Line_Omit_str This value, together with eCAPG_Line_Omit_start_n and eCAPG_Line_O mit_len_n, is used to optionally define omit criteria, which are used to omit specific records in a asynchronous datastream. This value N/A must be used if the omit functionality is not used, indicated by eCAPG_Line_Omit_start_n and eCAPG_Line_Omit_len_n equal to 0.
eCAP_generic parameters 247 The value 0 denotes this field is not available in the datastream. The remaining values in field eCAPG_GRP_Name_str must be set to 0 and eCAPG_GRP_NAME_Field_n to 0. In this case, the field eCAPG_Dft_GRP_Name_str must be used to define a default group. A group indication can be defined based either upon string position (through eCAPG_GRP_Name_start_n and eCAPG_GRP_Name_len_n) or based upon field occurrence (through eCAPG_GRP_Name_field_n).
Table: eCAP_generic As explained for the group name, the field can be either defined on position (through eCAPG_Msg_start_n and eCAPG_Msg_len_n) or occurrence (through eCAPG_Msg_field_n). The value 0 denotes this field is not available in the datastream. The remaining values in field eCAPG_Msg_len_n must be set to 0 and eCAPG_Msg_field_n to 0. In this case, the field eCAPG_Dft_Msg_str must be used to define a default message.
eCAP_generic parameters 249 The alarm description refers to the definitions in the eKERNEL_ALARM table. The value 0 denotes this field is not available in the datastream. The remaining values in field eCAPG_Ala_Descr_str must be set to 0 and eCAPG_Ala_Descr_Field_n to 0. In this case, the field eCAPG_Dft_Ala__Descr_str must be used to define a default alarm description.
Table: eCAP_generic eCAPG_Dft_GRP_Name_str This field is used to provide a default group name, in the event that no value can be retrieved from the available datastream. In this case, the same value is used for all alarms generated through this eCAP generic interface instance. The value N/A must be specified if this field is not used.
eCAP_generic parameters 251 In such environments, the default value 0 must be used for both the fields eCAPG_Reset_start_n and eCAPG_Reset_len_n, and the default value N/A must be used for the parameter eCAPG_Reset_str. In some environments, all alarms must remain active in eKERNEL, unless a specific reset signal is encountered. This reset indication typically indicates a complete reset of all alarms of this interface (for example, resetting a fire detection infrastructure after some warning alarms).
Table: eCAP_generic In most cases the eCAP generic interfaces is used to capture alarms from an asynchronous serial line (for example, printer port), and received data contains alarm information. In this situation, messages are transmitted to eKERNEL immediately upon arrival, and these alarms are processed within DECT Messenger. In most environments, the remote peripherals cannot indicate that all pending alarms are reset, and therefore the eKERNEL handles the alarms.
. Table: eDMSAPI eDMSAPI parameters eDMSAPI_site_id_n This field specifies the site identifier, as defined in eKERNEL_SITE table. This value is set to 1 in most environments. An example of an entry typically found in this field is as follows: 1 eDMSAPI_Area_id_n This field specifies the area identifier, as defined in eKERNEL_AREA table. This value is set to 1 in most environments.
Table: eDMSAPI eDMSAPI_Seats_count_n This field specifies the total number of seats available for E2 messaging (aCsOpenStream). Sending an E2 message to a DECT extension consumes one seat (one seat is allocated between the StartDataPath and the StopDatPath). For receiving E2 messages (generation of an alarm), DECT extensions that are configured to generate alarms (table eKERNEL_DEVICE field DEV_IoRegister_b) must be IoRegistered.
eDMSAPI parameters 255 An example of an entry typically found in this field is as follows: 10.110.50.138 eDMSAPI_External_Port_str This field specifies the port reserved for requests from the External clients. This port can accept eDMSAPI_External_Seats_count_n simultaneously requests.
Table: eDMSAPI For example, if 1 is specified, alarms with alarm priority of 1 are handled as emergency messages, whereas alarms with priority of 2, 3, 4, and so on are handled as urgent or normal messages. Nortel recommends that you carefully evaluate the consequences of changes to this field, for two reasons: • Emergency messages impact the DECT C4060 user (different tone, user intervention required for acknowledge).
eDMSAPI parameters 257 default value for DMC is still 2555, and the recommended default value for DAP controller and Nortel is 28001; however, depending on the configuration settings, other values (for example, 2001) are appropriate. An example of an entry typically found in this field is as follows: 2555 eDMSAPI_PBX_type_str This field specifies the PBX type used to handle the DMSAPI functionality. The value is introduced in R3.0. Supported values are DMC, DAP, and Nortel.
Table: eDMSAPI An example of an entry typically found in this field is as follows: 3 eDMSAPI_GeneralTimeOut_n This field specifies the Time, in seconds, the eDMSAPI program waits for an event from the CSTA service. This value is by default 10 seconds, and must be greater than 5. When no event is received within this time, a negative acknowledge is sent to the eKERNEL application or External clients for outbound calls.
. Table: eDMSAPI_INBOUND eDMSAPI_inbound parameters eDMSAPII_Site_id_n This field specifies the site identifier, as defined in eKERNEL_SITE table. In most environments, this value is 1. An example of an entry typically found in this field is as follows: 1 eDMSAPII_Area_id_n This field specifies the area identifier, as defined in eKERNEL_AREA table. In most environments, this value is 1.
Table: eDMSAPI_INBOUND *IC When a call is made, the calling line identifier of the calling party (also known as CLID) is used to confirm outstanding messages for those devices in DEVICE table with the DEV_Pincode_str equal to the CLID. This technique is known as incoming confirmation, and is typically used in environments where urgent messages must be confirmed when sent to devices such as SMS, PAGING, and SMTP, without implicit bidirectional confirmation techniques embedded.
eDMSAPI_inbound parameters Table 12 Sample data (cont’d.) eDMSAPII _Site_id_n eDMSAPII_ Area_id_n eDMSAPII_ Called_dev_str eDMSAPII _ Type_str eDMSAPII_Comments_str 1 1 860 *IA REA 1 1 861 *IA User to User message 1 1 865 *IA User to User message 1 1 888 *IA NOOD 1 1 999 *IA REA Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Table: eDMSAPI_INBOUND Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eDMSAPI_INBOUND_EVENT eDMSAPI_inbound_event parameters eDMSAPIIE_Site_id_n This field specifies the site, as defined in eKERNEL_SITE table. Is most environments, the value is 1. An authorized of an entry typically found in this field is as follows: 1 eDMSAPIIE_Area_id_n This field specifies the area, as defined in eKERNEL_AREA table. Is most environments the value is 1.
Table: eDMSAPI_INBOUND_EVENT The Calling device specified here defines those extensions that can generate an alarm by sending a message to the related called device. 1. Define an extension by number, for authorized, 866. 2. Define a generic value *ALL. 3. Define a generic number starting with some characters 85*.
eDMSAPI_inbound_event parameters 265 Table 13 Sample Data (cont’d.
Table: eDMSAPI_INBOUND_EVENT Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eDMSAPI_INBOUND_RESULT eDMSAPI _inbound_result parameters eDMSAPIIR_Site_id_n This field specifies the site, as defined in eKERNEL_SITE table. In most environments, this value is 1. An authorized of an entry typically found in this field is as follows: 1 eDMSAPIIR_Area_id_n This field specifies the site, as defined in eKERNEL_AREA table. In most environments, this value is 1.
Table: eDMSAPI_INBOUND_RESULT eDMSAPIIR_Calling_dev_str This field specified a descriptor of the calling device. As described in eDMSAPI documentation section, incoming E2 messages are notified within eDMSAPI through calling device and called device. When an incoming message (to a device that is defined in eDMSAPI_INBOUND table as type *IA – incoming call alarm generation) is detected by eDMSAPI, the result action depends on the Called and Calling device.
eDMSAPI _inbound_result parameters • • 269 [msg] special value some combination of the three preceding values that are replaced by the actual value of the request A format REA [Calling number] translates into REA 865 when the calling number is 865. In release 3.0 and later, you can use a visual DNR to a device in the Messenger (new field DEV_Visual_dnr_str in table eKERNEL_DEVICE).
Table: eDMSAPI_INBOUND_RESULT Table 14 Sample Data (cont’d.) Site Area Called device Calling device Group Message 1 1 860 865 REA REA [msg] from [Calling number] to [Called number]. 1 1 860 866 REA REA [msg] from [Calling number] to [Called number]. 1 1 860 867 REA REA [msg] from [Calling number] to [Called number]. 1 1 860 868 REA REA [msg] from [Calling number] to [Called number].
. Table: eESPA eESPA parameters eESPA_Site_id_n This field specifies the site identifier, as defined in eKERNEL_SITE. This value is, in most environments, equal to 1. An authorized of an entry typically found in this field is as follows: 1 eESPA_Area_id_n This field specifies the area identifier, as defined in eKERNEL_AREA. This value is, in most environments, equal to 1.
Table: eESPA eESPA_Link_Type_str This field specifies the type of physical link between the controlling and the controlled system. The only supported value that can be entered in this field is RS232. An authorized of an entry typically found in this field is as follows: RS232 eESPA_ControlStation_b This value specifies whether the station is a control (master) station, or a slave.
eESPA parameters 273 If more than one address must be polled, the addresses must be separated with a ^ sign. In this release, only a point to point link is supported, so only one address can be specified. An authorized of an entry typically found in this field is as follows: 2 eESPA_LocalAddress_n This field specifies the address of the local espa interface.
Table: eESPA Table 15 Espa record: SOH1STX1US12345RS2USThe messageRS3US9RS4US3RS6U S3ETXBCC (cont’d.) RS Record separator BCC Checksum The incoming alarm/message, must be translated to a valid message request and sent to the eKERNEL, as shown in Figure 205 "Example: eESPA module acts as input program" (page 274).
eESPA parameters 275 Figure 206 Example: eESPA module acts as output program Note: An eESPA module can act as input and output program simultaneously, so can receive alarms from the espa infrastructure and sends a message request to the eKERNEL, and can receive on message requests from the eKERNEL and sends the alarms to the espa infrastructure.
Table: eESPA This parameter is only relevant if eESPA acts as an input program (so receives external data from the espa infrastructure. If the specified data identifier is not present in the available datastream record, than the field eESPA_Msg_default_str must be used to define a default message. If the eESPA module acts as input program: The received espa record must be translated to a valid message request, and sent to the eKERNEL application.
eESPA parameters 277 If this eESPA module acts as an output program: in the current release, the data identifiers for the espa records are fixed. Therefore, when a message request is sent by the eKERNEL to the eESPA module, the data in the tag is put in data identifier 2 (display message). In the following authorized, the data in the tag from the message request, must be translated to data identifier 2 (display message) in the espa record.
Table: eESPA eESPA_DataId_Ala_descr_str This field specifies the Data Identifier of the espa record that specifies the alarm description. This parameter is only relevant if eESPA acts as an input program (so receives external data from the espa infrastructure. This field refers to the definitions of eKERNEL_ALARM table, and must be appropriately configured (for authorized, message length, and so on).
eESPA parameters 279 Figure 209 Example: eESPA module acts as input program If this eESPA module acts as an output program: In the current release, the data identifiers for the espa records are fixed. Therefore, when a message request is sent by the eKERNEL to the eESPA module, the data in the tag is put in data identifier 3 (beep coding).
Table: eESPA An authorized of an entry typically found in this field is as follows: 2:3^3. This indicates that the first 3 characters of the display message, a ^ and the values of data identifier 3 is equal to the alarm description. The value NUR^1, NUR^2, SAN^1, and so on, must be configured in the eKERNEL_ALARM table.) eESPA_Ala_descr_default_str This field is used to provide a default alarm description, in the event that no value can be retrieved from the available datastream.
eESPA parameters 281 If the value *CALC is specified, some alarms receive a reset, and other alarms not. Therefore the eKERNEL application checks to determine if the alarm description with remove after *SENT exists. If so, this alarm type is processed, otherwise the alarm is processed as if remove after *RESET is specified. If the alarm description is not configured in the eKERNEL_ALARM table, the alarm is not processed.
Table: eESPA eESPA_OUT_Call_type_default_str This field is only relevant if the eESPA module acts as output program, so for message sent from the eKERNEL to the eESPA interface. A request from the eKERNEL to the espa interface, contains a tag that defines the value for data identifier 4 (call type). If *NONE is specified, data identifier 4 is not a part of the espa record.
eESPA parameters 283 In the following authorized, the data in the tag from the message request, must be translated to data identifier 5 (number of transmissions) in the espa record. Figure 212 Example: eESPA module acts as output program An authorized of an entry typically found in this field is as follows: 1 eESPA_Comments_str This field can be filled with comments, to allow administrators to add some remarks to the configuration record.
Table: eESPA Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eESPA_OUTBOUND_CFG eESPA_outbond_cfg parameters eESPAO_Site_id This field specifies the site identifier, as defined in eKERNEL_SITE. This value is, in most environments, equal to 1. An authorized of an entry typically found in this field is as follows: 1 eESPAO_Area_id_n This field specifies the site identifier, as defined in eKERNEL_AREA. This value is, in most environments, equal to 1.
Table: eESPA_OUTBOUND_CFG The Data identifier for the priority record type is 6. Table 18 Example eESPAO_ALA_Prty_from/to_n values Site Area Alarm from Alarm to Beepcode Priority 1 1 0 2 1 2 1 1 3 5 3 1 1 1 6 999 9 3 When a is sent to the eESPA with an alarm priority equal to 2 for pager 4567, a datablock is created with a beepcode 1 (data identifier 3) and a priority 2 (High) (data identifier 6).
eESPA_outbond_cfg parameters An authorized of an entry typically found in this field is as follows: 3 eESPAO_Comments_str This field can be used to store comments, enabling administrators to add remarks to the configuration record. See Table 19 "Sample eESPAO_Comments_str values" (page 287) for authorized eESPAO_Comments_str values.
Table: eESPA_OUTBOUND_CFG Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eIO_MODULE eIO_modules parameters eIOM_Site_id_n This field specifies the site identifier, as defined in eKERNEL_SITE table. In most environments, this value is 1. An authorized of an entry typically found in this field is as follows: 1 eIOM_Area_id_n This field specifies the area identifier, as defined in eKERNEL_AREA table. In most environments, this value is 1.
Table: eIO_MODULE The current implementation of eIO is limited to configurations of up to eight modules attached to one FP-1000 controller module. Nortel recommends starting the first module with number 01 and incrementing by 1 for the other modules. Note: Specify the leading 0 in the numbering (enter the value 01, not 1).
eIO_modules parameters 291 An authorized of an entry typically found in this field is as follows: 8 eIOM_Comments_str This field can be entered with remarks from an administrator, and is informational only. You can use this filed to document the physical connection here too, to ease later configuration. An authorized of an entry typically found in this field is as follows: OR 004 – fire detection. Table 21 "eIO_module sample data" (page 291) provides sample eIO module table data.
Table: eIO_MODULE Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eIO_AI eIO_AI parameters eIOAI_Site_id_n This field refers to the site identifier, as defined in the eKERNEL_SITE table. In most environments, this value is 1. An authorized of an entry typically found in this field is as follows: 1 eIOAI_Area_id_n This field refers to the area identifier, as defined in the eKERNEL_AREA table. In most environments, this value is 1.
Table: eIO_AI Current implementation of eIO is limited to configurations of up to 8 modules attached to one FP-1000 controller module. Nortel recommends starting the first module with number 01 and incrementing by one for the other modules. Specify the leading 0 in the numbering (do not specify 1, but specify instead 01).
eIO_AI parameters 295 An authorized of an entry typically found in this field is as follows: 03,000000 eIOAI_Min_R_str The value specifies the analogue level measured on a contact to reset a minus-level alarm. If minus-level alarms are to be disabled a 00,000000 value can be specified. Note: All values must be specified in format 00,000000 with 2 digits before the decimal separator and 6 digits after the decimal separator.
Table: eIO_AI measurement en the measured input range. Nortel recommends that you first test the peripherals with the FieldPoint Explorer prior to configuring and taking eIO into production. Note: Check your operating system settings to find out which decimal separator is in use. Nortel recommends that you set the operating system to the country specific values, thus the locale Belgium (Dutch) in Belgium, even when an English operating system is installed.
eIO_AI parameters 297 eIOAI_ALA_Descr_str The alarm description field is a description defined in the eKERNEL_ALARM table for the associated eIO module. In the authorized shown in Table 22 "eIOAS_ALA_Descr_str authorized" (page 297), an alarm description A-INPUT is defined with matching records in the eKERNEL_ALARM table.
Table: eIO_AI Table 23 eIO_AI sample data S I T e A R E a M o d C o n t 1 1 0 1 1 1 1 ALA_d escr Gr ou p MSG Min_S Min_R Max_R Max_S 0 1 00,000000 00,000000 00,000400 00,000400 A-INP UT AI Analog Input 01 0 1 0 2 00,000000 00,000000 12,000000 20,000000 A-INP UT AI Analog Input 02 1 0 1 0 3 00,000000 00,000000 12,000000 20,000000 A-INP UT AI Analog Input 03 1 1 0 1 0 4 00,000000 00,000000 12,000000 20,000000 A-INP UT AI Analog Input 04 1 1 0 1 0
eIO_AI parameters 299 Table 23 eIO_AI sample data (cont’d.
Table: eIO_AI Table 23 eIO_AI sample data (cont’d.) S I T e A R E a 2 2 M o d C o n t 0 1 0 5 Min_S Min_R Max_R Max_S 00,000000 00,000000 12,000000 20,000000 ALA_d escr Gr ou p A-INP UT 00 001 Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
eIO_AI parameters 301 Table 23 eIO_AI sample data (cont’d.) S I T e A R E a 2 2 M o d C o n t 0 1 0 6 Min_S Min_R Max_R Max_S 00,000000 00,000000 12,000000 20,000000 ALA_d escr Gr ou p A-INP UT 00 001 Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Table: eIO_AI Table 23 eIO_AI sample data (cont’d.) S I T e A R E a 2 2 M o d C o n t 0 1 0 7 Min_S Min_R Max_R Max_S 00,000000 00,000000 12,000000 20,000000 ALA_d escr Gr ou p A-INP UT 00 001 Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
eIO_AI parameters 303 Table 23 eIO_AI sample data (cont’d.) S I T e A R E a 2 2 M o d C o n t 0 1 0 8 Min_S Min_R Max_R Max_S 00,000000 00,000000 12,000000 20,000000 ALA_d escr Gr ou p A-INP UT 00 001 Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Table: eIO_AI Table 23 eIO_AI sample data (cont’d.) S I T e A R E a M o d C o n t Min_S Min_R Max_R Max_S ALA_d escr Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eIO_DI eIO_DI parameters eIODI_Site_id_n This field refers to the site identifier, as defined in the eKERNEL_SITE table. In most environments, this value is 1. An authorized of an entry typically found in this field is as follows: 1 eIODI_Area_id_n This field refers to the area identifier, as defined in the eKERNEL_AREA table. In most environments, this value is 1.
Table: eIO_DI Current implementation of eIO is limited to configurations of up to eight modules attached to one FP-1000 controller module. Nortel recommends starting the first module with number 01 and incrementing by one for the other modules. Specify the leading 0 in the numbering (do not specify 1, but specify instead 01).
eIO_DI parameters 307 eIODI_ALA_Descr_str The alarm description field is a description defined in the eKERNEL_ALAR M table for the associated eIO module. In the authorized shown in Table 24 "eIO alarm description" (page 307), an alarm description D-INPUT is defined with matching records in the ALARM table, as shown in Table 24 "eIO alarm description" (page 307).
Table: eIO_DI Table 25 eIO_DI sample data S i t e A R e a M o d Contact Type ALA_Descr GRP_ Name Message 1 1 01 01 OD D-INPUT DI Digital Input 01 1 1 01 02 OS D-INPUT DI Digital Input 02 1 1 01 03 GS D-INPUT DI Digital Input 03 1 1 01 04 GD D-INPUT DI Digital Input 04 1 1 01 05 OD D-INPUT DI Digital Input 05 1 1 01 06 OD D-INPUT DI Digital Input 06 1 1 01 07 OD D-INPUT DI Digital Input 07 1 1 01 08 OS D-INPUT DI Digital Input 08
. Table: eIO_DO eIO_DO parameters eIODO_Site_id_n This field specifies the site identifier, as defined in the eKERNEL_SITE table. In most environments, this field has value 1. An authorized of an entry typically found in this field is as follows: 1 eIODO_Area_id_n This field specifies the area identifier, as defined in the eKERNEL_AREA table. In most environments, this field has value 1.
Table: eIO_DO An authorized of an entry typically found in this field is as follows: 01 eIODO_Contact_str This value refers to each individual contact, and is specified in the FieldPoint Explorer. Valid values are in the range between 01 and 16 for the currently supported FP-DO-401. Note contact numbers start with 01 and are incremented by one. You must specify the leading 0 in the numbering (do not specify 1, but specify instead 01).
eIO_DO parameters Table 26 eIO_DO sample data (cont’d.
Table: eIO_DO Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eKERNEL_AREA eKERNEL_area parameters AREA_Site_id_n This field refers to the site identifier, as defined in the eKERNEL_SITE table. In most cases only one site is configured. A typical value is 1. An authorized of an entry typically found in this field is as follows: 1 AREA_Area_id_n This field indicates the area identifier. The combination site and area must be unique in the database. In most cases the configuration consists of 1 site and 1 area.
Table: eKERNEL_AREA result is the ability to support two or more eIO modules, with the immediate advantage that analogue input and discrete input modules can now be installed in a distributed location (near the contacts). The most significant focus is however on output program level. With the area concept, you can now configure, for authorized, more than one instance of eDMSAPI.
. Table: eKERNEL_ALARM eKERNEL_alarm parameters ALA_id_n This field specifies the unique identifier of the alarm. Although you can to enter a numeric value of choice, Nortel recommends developing a logical naming convention for alarms. A common approach is to base the numbering scheme upon input program identifier (that in turn is built upon site and area of the input program and a input program sequence number). A two-byte sequence number is the appended. This brings the length to seven bytes.
Table: eKERNEL_ALARM Table 27 Alarm identifiers (cont’d.) Byte 3 Byte 4-5 Byte 6-7 1 eCAP or eAPI or eESPA 2 eSNMP 4 eVBVOICE 5 eCSTA 6 eIO 7 eWEB 8 eSMTP_server 9 eDMSAPI 01-99 Input program sequence number Alarm sequence number As shown in Table 27 "Alarm identifiers" (page 315), the first bytes denote the site identifier. The second byte denotes the area identifier. The third byte denotes the input application type. The fourth and fifth byte indicates a sequence number.
eKERNEL_alarm parameters 317 Table 28 Alarm input program identifiers (cont’d.) Byte 3-5 Input program identifier Byte 3 Byte 4-5 1 eCAP or eAPI or eESPA 2 eSNMP 4 eVBVOICE 5 eCSTA 6 eIO 7 eWEB 8 eSMTP_server 9 eDMSAPI 01-99 Input program sequence number Nortel recommends using five digits to uniquely identify an input program. With the guidelines above, the identifier implies the site, area, input program application and sequence number.
Table: eKERNEL_ALARM A special value *OTHER can be defined. If specified, the *OTHER description is used to handle alarms that were not identified by a qualified description. Alarms with descriptions that do not either match a qualified description or the value *OTHER, are ignored. Refer to other reference material for detailed instructions for each alarm system.
eKERNEL_alarm parameters 319 through an alarm identifier, but Nortel recommends specifying GUARDING in the alarm description field. An authorized of an entry typically found in this field is as follows: GUARDING ALA_Remove_after_str This field can have the value *SENT or *RESET. If the field value is *SENT, the message is removed after successfully sending the message. If the field value is *RESET, the message remains in the database until an explicit reset signal is received from the alarm system.
Table: eKERNEL_ALARM An authorized of an entry typically found in this field is as follows: 5 ALA_to_ringing_n This field specifies the number of seconds a peripheral is kept in ringing state before taking further action. This parameter is ignored for most peripherals. Currently this value impacts only the “eCSTA” module for voice-call based user-to-user messaging.
eKERNEL_alarm parameters 321 On the other hand, when no changes occur, the outstanding messages are repeated at the specified interval. An authorized of an entry typically found in this field is as follows: 120 (denotes 2 minutes) ALA_Scroll_state_str This field specifies the state in which a device must be to receive messages. Valid values are *CONNECT and *RINGING. Scrolling starts at connect event when *CONNECT is specified, and starts at ringing event when *RINGING is specified.
Table: eKERNEL_ALARM An authorized of an entry typically found in this field is as follows: *ALL ALA_Confirm_action_str This value defines the confirm action. Valid entries are YES or NO. If *NO is specified, message delivery confirmation is not required. If of *YES, message delivery confirmation is mandatory. This parameter is related to the ALA_Group_delivery_str parameter specified above.
eKERNEL_alarm parameters 323 ALA_Length_n This field specifies the length of the alarm that is considered as relevant. Nortel recommends that you set the length to correspond to the length of the received alarm signal, although this is not always necessary. You can just as easily change messages in the alarm systems, so the length fits your environment and peripherals. For instance, if you keep message length to 16 bytes or less, the messages fit on a single line on a DECT C4040 or DECT C4050 extension.
Table: eKERNEL_ALARM An authorized of an entry typically found in this field is as follows: Reanimation through TELEVIC. Table 29 "eKERNEL_alarm sample data" (page 324) provides sample eKERNEL_alarm module table data. Table 29 eKERNEL_alarm sample data Alarm Inpgm Descr Remove after Priority ... 1110101 11101 0 *SENT 3 ... 1110102 11101 1 *SENT 1 ... 1110103 11101 2 *RESET 2 ... 1110104 11101 3 *SENT 3 ... 1110105 11101 GUARDING *SENT 10 ...
eKERNEL_alarm parameters Table 29 eKERNEL_alarm sample data (cont’d.) Alarm Inpgm Descr Remove after Priority ... 1160101 11601 A-INPUT *RESET 999 ... 1160102 11601 A-INPUT *SENT 999 ... 1160103 11601 D-INPUT *RESET 999 ... 1160104 11601 D-INPUT *SENT 999 ... 1170101 11701 Short *SENT 1 ... 1170102 11701 Medium *SENT 999 ... 1170103 11701 Long *SENT 999 ... 1170104 11701 SCRIPT Message *SENT 1 ... 1170105 11701 SCRIPT Message *RESET 1 ...
Table: eKERNEL_ALARM Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eKERNEL_DEVICE eKERNEL_DEVICE parameters DEV_site_id_n This field refers to the site as specified in eKERNEL_SITE table. Usually this field has value 1. In most environments, this value is 1. An authorized of an entry typically found in this field is as follows: 1 DEV_Area_id_n This field refers to the area identifier, as defined in the eKERNEL_AREA table. In most environments, this value is 1.
Table: eKERNEL_DEVICE address (for authorized, francis.missiaen@1s.be). As such the next field GRP_OUTPGM_Appl_str further identifies the device for a specific site and area. GRP_Dev_id_str, GRP_OUTPGM_Appl_str, DEV_Site_id_n and DEV_Area_id_n must be handled to uniquely identify a device. An authorized of an entry typically found in this field is as follows: 1 – 1 – 865 – eDMSAPI or 1 – 2 – francis.missiaen@1s.
eKERNEL_DEVICE parameters 329 DEV_OUTPGM_facility_str The indicated application handles the message using the capabilities of the infrastructure. The supported values are specified in the field FMT_OUTPGM_Facility_str of the eKERNEL_DEVICE_FORMAT table for the corresponding output program.
Table: eKERNEL_DEVICE DEV_Prty_n This field is currently not implemented, but is foreseen for future enhancements. DEV_Retry_count_ALT_DEV_id_n This field is implemented in a different fashion after eKERNEL version 2.1.0: • Before eKERNEL Version 2.1.0: The number of retries before switching to an alternative device, if device (site + area + device + output program is unique) is defined in the eKERNEL_device_alt table.
eKERNEL_DEVICE parameters 331 DEV_Monitor_b All devices with the value True (-1) are sent to the eCSTA application and must be monitored for there divert behavior. Those devices that are diverted are sent to the eKernel application. An authorized of an entry typically found in this field is as follows: False (-1). DEV_IoRegister_b Set this field to “false for all devices that are not assigned to eDMSAPI module.
Table: eKERNEL_DEVICE DEV_Div_OUTPGM_Facility_str This field specifies the output program of the diverted device. See DEV_Div_Site_id_n An authorized of an entry typically found in this field is as follows: eDMSAPI DEV_Ras_Site_b This field is a Boolean value and can be either True (-1) or False (0). The default value is False (0). This field is currently not implemented, but is reserved for future enhancements when multi-site facilities are implemented.
. Table: eKERNEL_DEVICE_ALT eKERNEL_DEVICE_ALT parameters ALT_Dev_Site_id_n This field refers to the site as specified in eKERNEL_SITE table. Usually this field has value 1. In most environments, this value is 1. An authorized of an entry typically found in this field is as follows: 1 ALT_Dev_Area_id_n This field refers to the area identifier, as defined in the eKERNEL_AREA table. In most environments, this value is 1.
Table: eKERNEL_DEVICE_ALT Define the device (site, area, device and outpgm) as a valid device in eKERNEL_DEVICE table. An authorized of an entry typically found in this field is as follows: 865 ALT_OUTPGM_Appl_str The field is associated with the previous field and defines the device. An authorized of an entry typically found in this field is as follows: eDMSAPI ALT_Sequence_n This field is a sequence number to make a record definitions in eKERNEL_DEVICE_ALT unique.
eKERNEL_DEVICE_ALT parameters 335 An authorized of an entry typically found in this field is as follows: eDMSAPI ALT_Alt_OUTPGM_Facility_str This field defines, in combination with ALT_Alt_DEV_Site_id_n, ALT_Alt _DEV_area_id_, ALT_Alt_dev_id_str and ALT_Alt_OUTPGM_Appl_str the alternate device. Check for possible loop conditions when setting up this table.
Table: eKERNEL_DEVICE_ALT Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eKERNEL_DEVICE_FORMAT eKERNEL_DEVICE_FORMAT parameters Figure 213 eKERNEL_DEVICE_FORMAT parameters listing FMT_OUTPGM_Appl_str This field identifies the output program. The following options are supported: eASYNC, eCSTA, eDMSAPI, eESPA, eIO, eSMS, eSMTP and eVBVOICE. An authorized of an entry typically found in this field is as follows: eDMSAPI FMT_OUTPGM_Facility_str This field specifies the supported facility or facilities for a specified output program.
Table: eKERNEL_DEVICE_FORMAT Table 31 Application-Facility associations (cont’d.) Application Facility eASYNC KPN eCSTA C311 eCSTA C322 eCSTA C911 eCSTA C922 eCSTA C933 eCSTA D330 eCSTA D340 eCSTA P375D eDMSAPI C922 eDMSAPI C933 eDMSAPI C944 eDMSAPI I600 eESPA ESPA eIO DO eSMS SMS eSMTP SMTP FMT_Bytes_line1_n This field specifies the number of bytes available on the first line. In general, the maximum length is to be used.
eKERNEL_DEVICE_FORMAT parameters 339 FMT_Bytes_line3_n This field specifies the number of bytes available on the third line. In general, the value is smaller than the actual available size to reserve room for page indication and more indication. When a customer has infrastructure with extensions capable of displaying three lines of 16 bytes, alarm lengths up to 48 bytes can be displayed (without page indication and more indication).
Table: eKERNEL_DEVICE_FORMAT Table 33 More indication syntax 0 (no more indication) 1 + 2 + Note: This value is only implemented on eDMSAPI and eCSTA output programs. An authorized of an entry typically found in this field is as follows: 2 FMT_Concatination_b This field defines whether small messages that fit on one display are merged to one page. If, for authorized, a DECT C933 extension is defined as 16/16/0/5/2 and messages are a maximum 16 bytes, you can show two messages on a single page.
eKERNEL_DEVICE_FORMAT parameters 341 An authorized of an entry typically found in this field is as follows: 0 (false) FMT_Descr_str An administrator can enter a description of the template in this field. This value is informational only. An authorized of an entry typically found in this field is as follows: template for C933 extensions for nurse-calls FMT_Comments_str An administrator can enter remarks in this field. This value is informational only.
Table: eKERNEL_DEVICE_FORMAT Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eKERNEL_GROUP eKERNEL_GROUP parameters Figure 214 eKERNEL_GROUP parameters listing GRP_id_str The field defines a unique identifier for a group. The field is a unique key in the database.
Table: eKERNEL_GROUP Example: 31101_00001 denotes site 3, area 1, input program type eCAP or eAPI, input program sequence 01, group name 00001. For each defined group, one or more group member must be defined in the eKERNEL_GROUP_MEMBER table. You can assign authority to the groups by means of the eKERNEL_GROU P_AUTH table.
eKERNEL_GROUP parameters 345 The group name field is the group indication that is typically received from the external alarm system. In many environments, alarm systems are capable of sending some kind of destination information in the alarm string. This can, for authorized, be referred to with terms such as paging number, group, or destination. Note that the above-described design allows sharing the same group name between multiple input programs.
Table: eKERNEL_GROUP Table 37 eKERNEL_GROUP sample data (cont’d.) Group id Input program Group name Description 31701_eIO 31701 eIO Test to eIO 31701_eSMTP 31701 eSMTP Test to eSMTP 31801_00001 31801 00001 Test from eSMTP Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eKERNEL_GROUP_AUTH eKERNEL_GROUP_AUTH parameters Figure 215 eKERNEL_GROUP_AUTH parameters listing GRPA_GRP_id_str This field refers to the unique group identifier, as described in the eKERNEL_GROUP table. Each group identifier must be defined in the eKERNEL_GROUP table. The member of each group identifier must be defined in the eKERNEL_GROUP_MEMBER table. At least one group member per group identifier must be defined, because empty groups result in loss of alarms.
Table: eKERNEL_GROUP_AUTH A special value *ALL is implemented. If you specify this special value, all users have access to this group. With *ALL you do not need to enter all individual users, but as a result you have no granular authority definition because all users are granted access. Note that eWEB only allows maintenance of the groups that are assigned to input programs of the same site as the eWEB. This means a eWEB instance of site 1 only allows maintenance of groups of site 1.
. Table: eKERNEL_GROUP_MEMBER eKERNEL_GROUP_MEMBER parameters Figure 216 eKERNEL_GROUP_MEMBER parameters listing GRPM_GRP_id_str The field defines a unique identifier for a group. The field is a unique key in the database.
Table: eKERNEL_GROUP_MEMBER Table 39 Recommended Group identifier naming convention (cont’d.) 1 - eCAP or eAPI or eESPA 6 - eIO 7 - eWEB 8 - eSMTP_server 9 - eDMSAPI Byte 4-5 Input program sequence number Byte 6 (Underscore character) Byte 7-... Group name Example: 31101_00001 denotes site 3, area 1, input program type eCAP or eAPI, input program sequence 01, group name 00001. Each group must be defined in the eKERNEL_GROUP table.
eKERNEL_GROUP_MEMBER parameters 351 Table 40 GRPM_Dev_id_str sample records (cont’d.) Site Area Output program Device Facility 1 1 DO_03_01 eIO DO 1 1 DO_03_02 eIO DO 1 1 DO_03_03 eIO DO 1 1 DO_03_04 eIO DO 1 1 DO_03_05 eIO DO 1 1 DO_03_06 eIO DO 1 1 DO_03_07 eIO DO 1 1 DO_03_08 eIO DO 1 1 francis.missiaen@1s.be eSMTP SMTP 1 1 kristien.daneels@1s.
Table: eKERNEL_GROUP_MEMBER Table 41 Supported output applications GRP_From_str This value specifies an hour and time in the format xx:xx. The valid range is 00:00 to 23:59; values outside this range produce unpredictable results. GRP_From_str denotes the start of the time interval where the defined device is an active member of the specified group GRP_Name_str. For authorized, 00:00 indicates the group-member is active at midnight, and 12:00 indicates the group-member starts at noon.
eKERNEL_GROUP_MEMBER parameters 353 Table 42 Group member schedule authorizeds: GRP_Mon_b This value specifies whether the group-member record is active on Mondays. Accepted values are True (-1) or False (0). When -1 is specified, the group-member record is active on Mondays. When 0 is specified, the record is not active on this day. An authorized of an entry typically found in this field is as follows:-1 GRP_Tue_b This value specifies whether the group-member record is active on Tuesdays.
Table: eKERNEL_GROUP_MEMBER An authorized of an entry typically found in this field is as follows:-1 GRP_Sat_b This value specifies whether the group-member record is active on Saturdays. Accepted values are True (-1) or False (0). When -1 is specified, the group-member record is active on Saturdays. When 0 is specified, the record is not active on this day.
eKERNEL_GROUP_MEMBER parameters 355 GRPM_Desactivate_timestamp_str This field specifies the timestamp when the record becomes deactivated. The format is YYYYMMDDHHMMSS. The GRPM_Activate_timestamp_str and GRPM_Desactivate_timestamp_ str fields can be used to define a time interval, where records are active.
Table: eKERNEL_GROUP_MEMBER Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eKERNEL_GUARDING eKERNEL_GUARDING parameters Figure 217 eKERNEL_GUARDING parameters listing GUA_INPPGM_id_n This field specifies the unique identifier of the input program. Note that this identifier is defined in the eKERNEL_TCPCLIENT table (field TCPCLIENT_INPGM_id_n). Refer to “Table: eKERNEL_TCPCLIENT” (page 385) for more information on how to set up these input programs.
Table: eKERNEL_GUARDING GUA_To_str This value specifies an hour and time in the format xx:xx. The valid range is 00:00 to 23:59; values outside this range produce unpredictable results. The value denotes the end of the time period during which the guarding facility is active. The active time period begins at the time specified in GUA_From_str. Note 1: GUA_From_str can be larger than GUA_To_str, resulting, for authorized, in a job that starts at 21:00 and ends at 06:00.
eKERNEL_GUARDING parameters 359 GUA_Wed_b This value specifies whether the group-member record is active on Wednesdays. Accepted values are True (-1) or False (0). When -1 is specified, the group-member record is active on Wednesdays. When 0 is specified, the record is not active on this day. An authorized of an entry typically found in this field is as follows:-1 GUA_Thu_b This value specifies whether the group-member record is active on Thursdays. Accepted values are True (-1) or False (0).
Table: eKERNEL_GUARDING If for instance a timeout of 900 seconds is defined, a guarding alarm is generated if the input program (eCAP, eAPI, and so on) does not send any request within fifteen minutes. Note that some manufacturers (for authorized, Honeywell) have the possibility to send with a fix interval a Still alive request to the eCap program. The absence of this request can result in a guarding alarm.
eKERNEL_GUARDING parameters Table 44 Examples of alarm characteristics GUA_Comments_str This field can optionally be used by an administrator to store reminder information, describing, for authorized, the usage of the file. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Table: eKERNEL_GUARDING Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eKERNEL_HOLIDAY eKERNEL_HOLIDAY parameters Figure 218 eKERNEL_HOLIDAY parameters listing Holiday_str This field defines a date that is to be considered as a holiday. Days that are entered here as holidays are important when eKERNEL processes the group members that are defined in the eKERNEL_GROUP_MEMBER table. Holidays must always be formatted as 8 bytes numeric values in format YYYYMMDD; for authorized, Christmas 2001 is defined as 20011225.
Table: eKERNEL_HOLIDAY Table 45 Holiday definition authorizeds (cont’d.) GRP_Name_str GRP_Holiday GRP GRP_Holiday_b 00001 3 867 -1 00001 4 868 -1 An authorized of an entry typically found in this field is as follows: 20050815 (denotes a fictional national holiday, August 15th, 2005). Holiday_Comments_str This field can contain remarks from an administrator and is used only for informational purpose.
. Table: eKERNEL_INPGM eKERNEL_INPGM parameters Figure 219 eKERNEL_INPGM parameters listing INPGM_id_n This field specifies the unique identifier of an input capable program. For each input program, a record must be entered in the eKERN EL_INPGM table. You must also define a matching record in the eKERNEL_TCPCLIENT table (field TCPCLIENT_INPGM_id_n). Nortel recommends that you develop a naming strategy in assigning values for this identifier.
Table: eKERNEL_INPGM Table 47 Recommended naming strategy for input programs (cont’d.) Byte 3 Byte 4-5 1 eCAP or eAPI or eESPA 2 eSNMP 4 eVBVOICE 5 eCSTA 6 eIO 7 eWEB 8 eSMTP_server 9 eDMSAPI 01-9 9 Input program sequence number Nortel recommends using five digits to uniquely identify an input program. Using this method, the identifier indicates the site, area, input program application, and sequence number.
eKERNEL_INPGM parameters 367 INPGM_Manufacturer_str The behavior of different input program modules depends to the external alarm system, and is therefore manufacturer-related. You must always enter a valid value in this field. Refer to Table 48 "Valid model values" (page 367) for a complete list of valid values in current release.
Table: eKERNEL_INPGM Table 48 Valid model values (cont’d.) eCAP WORMALD G:EIPM eESPA ESPA *BASE eESPA ESPA VSK (see PSI for details) eESPA ESPA ASCOM (see PSI for details) eDMSAPI DMSAPI *BASE eIO NATIONALINSTRUMENTS *BASE eSNMP SNMP *BASE eSMTP_server SMTP *BASE eDMSAPI DMSAPI *BASE eVBVOICE VBVOICE *BASE eWEB eWEB *BASE INPGM_Bidir_b This field defines when the protocol is bidirectional to eKERNEL or not.
eKERNEL_INPGM parameters 369 The value must be set to the so-called COM-setting for the module eCAP (RS-232 interfaces). The settings must be a supported combination of baud-rate, parity, data-bits, and stop bits. The value must off-course match the settings of the attached alarm system. An authorized of an entry typically found in this field is as follows: 9600,N,8,1 INPGM_AutoCreateGRP_b This value is an important value for relation to eKERNEL_GROUP and eKERNEL_GROUP_MEMBER and eKERNEL_DEVICE.
Table: eKERNEL_INPGM INPGM_Default_DEV_OUTPGM_str The field INPGM_AutoCreateGRP_b allows you to indicate whether auto-create is enabled or disabled. If O is specified, the value INPGM_Default_DEV_OUTPGM_str is ignored. If -1 is specified, the value INPGM_Default_DEV_OUTPGM_str is used to indicate the output program that is associated with the device that is created automatically in the eKERNEL_DEVICE.
eKERNEL_INPGM parameters 371 INPGM_Comments_str This field can contain remarks from the administrator and is informational only. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Table: eKERNEL_INPGM Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eKERNEL_MESSAGE_FORMAT eKERNEL_MESSAGE_FORMAT parameters Msg_Ala_id_n This field refers to the unique alarm identifiers as specified in the eKERNEL_ALARM table. See “Table: eKERNEL_ALARM” (page 315) for more information on alarm identifies. In a typical environment, input programs (for authorized, 11101) have a number of alarm identifiers (for authorized, 1110101 up to 1110107) each of them defining characteristics (alarm priority, length, and so on).
Table: eKERNEL_MESSAGE_FORMAT Table 49 Alarm identifiers (cont’d.) Byte 4-5 Byte 6-7 9 eDMSAPI 01-9 9 Input program sequence number Alarm sequence number An authorized of an entry typically found in this field is as follows: 1110101 Msg_Msg_str This field describes the format of the result message after internal processing through eKERNEL. When no records are specified, received messages are transmitted as is to the destination party.
eKERNEL_MESSAGE_FORMAT parameters 375 Msg_Comments_str This field can be updated with remarks of the system administrator. The value is informational only. Table 50 "eKERNEL_MESSAGE_FORMAT sample data" (page 375) show s authorizeds of data found in the eKERNEL_MESSAGE_FORMAT table.
Table: eKERNEL_MESSAGE_FORMAT Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eKERNEL_SITE eKERNEL_SITE parameters CFG_site_id_n This field specifies the site ID. In DECT Messenger, a site is the place where the eKERNEL module runs. Each eKERNEL instance has an appropriate database Messenger_CFG and Messenger_DATA. Note that a site can span multiple physical areas spread over multiple locations, and still being considered as one single site, because there is only one eKERNEL running. Note: The field is numeric.
Table: eKERNEL_SITE Current release does not foresee eKERNEL to eKERNEL communication. The concept of inter-eKERNEL communications can however be implemented in a future release, adding advanced functionality such as database-synchronization, database-replication, load-balancing, high-availability, and so on.
eKERNEL_SITE parameters 379 is not within the range of the DHCP server. Although there are techniques to extend the lease period to a high value, obtaining an IP address from a DHCP server is not supported and can result in system malfunction. An authorized of an entry typically found in this field is as follows: 10.110.50.138 CFG_Site_eKERNEL_port_str This field specifies a port number. Valid port numbers are in the range between 0 and 65535.
Table: eKERNEL_SITE There are six possible connection strings supported for the DECT Messengerapplication: 1. for Ms Access: For authorized, Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\SOPHO Messenger@Net\Mdb\Messenger_DATA.MDB 2. for SQL 2005 Express (residing on Messenger PC): For authorized, Provider=SQLOLEDB.1;Persist Security Info=Fals e;User ID=sa;Password=sa;Initial Catalog=Messenger_DATA;Data Source=127.0.0.1; 3.
eKERNEL_SITE parameters 381 Messenger@Net\eLOG. These files must not be confused with logging files located in the directory C:\SOPHO Messenger@Net\Log, and contain logging of eKERNEL and other modules. Special value 0 indicates no cleanup occurs. This means eLOG files remain on the system until manual cleanup takes place. Note: On systems with a high workload the eLOG-files can consume a lot of disk space. To correct this, specify a small value for this parameter.
Table: eKERNEL_SITE CFG_GarbageCollection This field specifies the rate of garbage collection (internal use only). CFG_GarbageCollection refers to the number of seconds when alarms are considered expired when a does not receive a . This helps establishing internal recovery for non-responding devices and peripherals. Nortel recommends that you specify 600 for this value.
eKERNEL_SITE parameters 383 For more information, see the user manual of the internal serial watchdog page 9 till 13. An authorized of an entry typically found in this field is as follows: 0x21 CFG_INRQS_id_n This field specifies a value that is used internally by eKERNEL, and you must not change the value unless explicitly instructed to do so. The value stored in CFG_INRQS_id_n is used to generate unique numbers to incoming message requests. Manipulation of this value can result in system malfunction.
Table: eKERNEL_SITE An authorized of an entry typically found in this field is as follows: "Development site of Number One System". Table 51 "eKERNEL_SITE sample data" (page 384) shows authorizeds of data found in the eKERNEL_SITE table (authorized data is split to improve readability) Table 51 eKERNEL_SITE sample data S i t e Description Admin 3 Sample Site 3 Francis Missiaen Mail Address francis.missiaen@ 1s.be 10.110.50.
. Table: eKERNEL_TCPCLIENT eKERNEL-TCPCLIENT parameters TCPCLIENT_site_id_n This field refers to the site ID specified in the eKERNEL_SITE table. Usually this field has value 1. An authorized of an entry typically found in this field is as follows: 1 TCPCLIENT_kernel_port_str This field specifies the port that is reserved for the specified module. A client/server connection is established between eKERNEL and all adjacent modules.
Table: eKERNEL_TCPCLIENT Each module must have a dedicated TCP/IP port. Through this port, a socket connection is established between the module and the eKERNEL. The eKERNEL_TCPCLIENT table defines for the eKERNEL module an overview of all defined modules, and starts a socket server for each module.
eKERNEL-TCPCLIENT parameters 387 Table 53 Recommended input program identifiers naming convention (cont’d.) Byte 3-5 Input program identifier Byte 3 Byte 4-5 1 eCAP or eAPI or eESPA 2 eSNMP 4 eVBVOICE 5 eCSTA 6 eIO 7 eWEB 8 eSMTP_server 9 eDMSAPI 01-99 Input program sequence number Nortel recommends using five digits to uniquely identify an input program. With the guidelines above, the identifier implies the site, area, input program application, and sequence number.
Table: eKERNEL_TCPCLIENT The majority of modules must be defined with Keep socket open. This means a permanent socket connection remains active. Nortel recommends using Keep socket open for all modules, unless specified otherwise. Note 1: For the eWEB module the value Close after receive must be specified if no script messages are used. If the Send Script Message functionality is implemented in eWEB, the value Close after send must be specified.
eKERNEL-TCPCLIENT parameters 389 TCPCLIENT_Comments_str This field can be used by an administrator to enter reminder information, describing, for authorized, usage of the module. An authorized of an entry typically found in this field is as follows: This module handles input of ELDAD. Table 54 "eKERNEL_TCPClient sample data" (page 389) shows authorizeds of data found in the eKERNEL_TCPClient table.
Table: eKERNEL_TCPCLIENT Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eLOCATION eLOCATION parameters eLOC_Site_id_n This parameter refers to the site identifier, as defined in eKERNEL_SITE table. The eMODULE instance is uniquely defined through a site and an area, so eLOC_Site_id_n and eLOC_Area_id_n form a unique key in the table. An authorized of an entry typically found in this field is as follows: 1 eLOC_Area_id_n This parameter refers to the area identifier, as defined in eKERNEL_AREA table.
Table: eLOCATION An authorized of an entry typically found in this field is as follows: 10.110.49.169 eLOC_LA_port_str This parameter refers to the port number that is TCP Server on the DAP Controller is listening to. This value for a SIP DECT system should be 28008. eLOC_GeneralTimeOut_n This parameters specifies the timeout in seconds that is eLOCATION is allowed to resolve location requests to the DAP Controller. This value is typically set to 10 seconds.
eLOCATION parameters 393 eLOC_Polling_intv_n This parameter is not implemented in current release. Specify value “0” here. An authorized of an entry typically found in this field is as follows: 0 eLOC_Comments_str Use this field to add descriptive text on the instance of the eLOCATION module. For authorized, identify the physical location of the DCC board in the switch. An authorized of an entry typically found in this field is as follows: Default configuration.
Table: eLOCATION Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eLOCATION INBOUND RESULT eLOCATION_INBOUND_RESULT parameters eLOCIR_Inpgm_id_n This field defines an input program identifier, as defined in the table eKERNEL_INPGM. The identifier refers to the input program that generates the alarm. In the case of location detection, the detection of the location detection alarms are identified through inbound message on special extension that are defined in eDMSAPI_INBOUND table as type *LA (location alarm).
Table: eLOCATION INBOUND RESULT qualified definitions have a higher priority than generic definitions. For authorized entries, a call from number 860 uses the 860 definition and not the generic 86* definition. An example of an authorized entry typically found in this field is 860. eLOCIR_eLOC_Site_id_n The fields eLOCIR_eLOC_Site_id_n and eLOCID_eLOC_Area_id_n correspond to the eLOCATION instance (site and area identifier) that responds to the location request.
eLOCATION_INBOUND_RESULT parameters • • 397 [Calling number]: extension or ’Visual dnr’ description of calling device [Called number]: extension of called device The replacement values are parsed by their corresponding value, and SOS from [calling number] on location [location] at [Location Date] [location time] can result in for authorized, SOS from 865 on location elevator 2 at 2004.01.27 14:57. Since release 3.
Table: eLOCATION INBOUND RESULT Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eLOCATION RPN eLOCATION_RPN parameters eLOCRPN_Site_id_n This parameter refers to the site identifier, as defined in eKERNEL_SITE table. Each eLOCATION instance is uniquely defined through a site and an area. The eLOCATION_RPN table defines the relation between the RPNs and the associated text that describes the physical location on the RPN. For authorized, the DAP Controller with IP address 10.110.49.
Table: eLOCATION RPN representation. For authorized, 1 should be formatted as 01. A special value “?” can be used as a catch-call to handle the RPNs that are not qualified. It is however recommended to specify all associated RPNs in the definition. A catch-all definition “?” could however be handy to detect missing definitions. Note that the value is hexadecimal, so 10 is represented as 01, 16 is represented as 0F, 17 is represented as 10.
. Table: eOAI eOAI parameters eOAI_Site_id_n This field describes the site identifier, as defined in eKERNEL_SITE table. An instance of eOAI is uniquely defined by means of a site and area identifier. An authorized of an entry typically found in this field is as follows: 1 eOAI_Area_id_n This field describes the area identifier, as defined in the eKERNEL_AREA table. An instance of eOAI is uniquely defined by means of a site and area identifier.
Table: eOAI eOAI_ALA_Prty_DTMF_Confirm_n This value refers to the priority of the alarm as specified in eKERNEL_ALARM table. Alarms distributed to eOAI with a priority above the defined value are automatically considered acknowledged when the destination receives the message. For most cases this is suitable. However, eOAI could deliver messages to infrastructure that are unable to respond. In some circumstances the message needs to remain active until a manual confirmation takes place.
. Table: eOAP eOAP parameters eOAP_Site_id_n This field describes the site identifier, as defined in eKERNEL_SITE table. An instance of eOAP is uniquely defined by means of a site and area identifier. An authorized of an entry typically found in this field is as follows: 1 eOAP_Area_id_n This field describes the area identifier, as defined in eKERNEL_AREA table. An instance of eOAP is uniquely defined by means of a site and area identifier.
Table: eOAP eOAP_ALA_Prty_DTMF_Confirm_n This value refers to the priority of the alarm as specified in eKERNEL_ALARM table. Alarms distributed to eOAP with a priority above the defined value are automatically considered acknowledged when the destination receives the message. For most cases this is suitable. However, eOAP could deliver messages to infrastructure that are unable to respond. In some circumstances the message needs to remain active until a manual confirmation takes place.
. Table: eSMTP_CLIENT eSMTP_CLIENT parameters eSMTP_Site_id_n This field specifies the site identifier, as defined in eKERNEL_SITE table. In most environments, the value is 1. An authorized of an entry typically found in this field is as follows: 1 eSMTP_Area_id_n This field specifies the area identifier, as defined in eKERNEL_AREA table. In most environments, the value is 1.
Table: eSMTP_CLIENT An authorized of an entry typically found in this field is as follows: 10.110.17.6 eSMTP_srv_port_str This field specifies the port number used for SMTP access. In most environments, this is value 25. An authorized of an entry typically found in this field is as follows: 25 eSMTP_srv_domain_str This field refers to the domain name used in the SMTP connection. Refer to the RFC821 specifications on the process involved in message delivery through SMTP.
eSMTP_CLIENT parameters 407 A value of, for authorized, 2 indicates alarms with priority 0,1 and 2 are considered to be confirmed using this callback procedure. An authorized of an entry typically found in this field is as follows: 2 eSMTP_Silence_intv_n This field specifies the silence interval, the time between repeating outstanding messages that need confirmation. The parameter corresponds with the parameter available in the eKERNEL_ALARM table, but overrules the latter value.
Table: eSMTP_CLIENT Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eSMTP_SERVER eSMTP_SERVER parameters eSMTP_Site_id_n This field denotes the site identifier, as defined in eKERNEL_SITE table. In most environments, this field has a value of 1. An authorized of an entry typically found in this field is as follows: 1 eSMTPS_Area_id_n This field denotes the area identifier, as defined in eKERNEL_AREA table. In most environments, this field has a value of 1.
Table: eSMTP_SERVER This directory contains e-mail files (with the extension .EML) that are processed by DECT MessengereSMTP_server module, which analyzes the inbound e-mail files and handles them as alarm input. An authorized of an entry typically found in this field is as follows: c:\inetpub\mailroot\drop eSMTPS_Poll_intv_n This parameter defines the interval between individual poll operations the eSMTP_server module handles to look for inbound mail.
eSMTP_SERVER parameters 411 eSMTPS_Email_keep_processed_n This field specifies the number of days the archive of processed e-mail messages is kept on the hard disk. The value is expressed in days, and has typically a value of 5 days. Adjust this value to accommodate for the number of inbound e-mail messages, the requested archive period, and the available disk space.
Table: eSMTP_SERVER eSMTPS_Delivery_text_str When an inbound e-mail message is accepted by eKERNEL, the sender receives a delivery report. This delivery report is sent through eSMTP client. (The eSMTP module is a prerequisite.) The message text for the delivery messages is defined in the eSMTPS_Delivery_text_str field.
. Table: eWEB eWEB parameters eWEB_Address_str This field specifies the IP address of the system where the Apache Web Server is running. You can obtain the address with the IPCONFIG command. The eWEB module uses this address to obtain its site, area number, and the address of the eKERNEL (based upon eWEB table) and to obtain the port number at which eKERNEL listens (based upon eKERNEL_TCPCLIENT table). This process is carried out in the PHP-scripts that run on the Apache Web Server.
Table: eWEB eWEB_Area_id_n This field specifies the area number associated to the eWEB instance obtained by the IP address of the Web Server. In most cases this value is 1, as defined in eKERNEL_AREA. An authorized of an entry typically found in this field is as follows: 1 eWEB_eKERNEL_address_str This field specifies the IP address of the eKERNEL. In the current release, this value is the same as the eWEB_Address_str field.
. Table: eWEB_SCRIPT eWEB parameters WSC_Site_id_n This field specifies the site, as defined in eKERNEL_SITE table. In most environments, the value is 1. An authorized of an entry typically found in this field is as follows: 1 WSC_Area_id_n This field specifies the area, as defined in eKERNEL_AREA table. In most cases the value is 1.
Table: eWEB_SCRIPT In the field ALA_Trace_b of the eKernel_alarm table, the administrator can activate this field (note that this feature is supported only for script messages in the current release), which means that the whole call flow is logged in the data database. An authorized of an entry typically found in this field is as follows: 1 WSC_Script_Descr_str This field is a description of the script message.
eWEB parameters 417 technical specification. Nortel recommends that you keep the message length less than or equal to the maximum length defined in the associated eKERNEL_ALARM table. *FREE is the only other valid entry. This keyword enables the end user to enter a message.
Table: eWEB_SCRIPT Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eWEB_SCRIPT_SET_AUTH eWEB_SCRIPT_SET_AUTH parameters WSSA_Site_id_n This field specifies the site, as defined in eKERNEL_SITE table. In most environments, the value is 1. An authorized of an entry typically found in this field is as follows: 1 WSSA_Area_id_n This field specifies the area, as defined in eKERNEL_AREA table. In most cases the value is 1.
Table: eWEB_SCRIPT_SET_AUTH If nothing configured in this table for a specific script message, no one can activate this script message. An authorized of an entry typically found in this field is as follows: KDS WSSA_Comments_str This field can be used by an administrator to enter remarks. The field is informational only. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eWEB_SCRIPT_TRACE_AUTH Note 1: An alarm is only traceable for script message if the ALA_Trace_b alarm ID related to the script message has the field ALA_Trace_b in the eKERNEL_ALARM table set to True. Note 2: In the current release, traceable alarms are only supported for script messages. eWEB_SCRIPT_TRACE_AUTH parameters Figure 220 eWEB_SCRIPT_TRACE_AUTH parameters WSTA_Site_id_n This field specifies the site, as defined in eKERNEL_SITE table. In most environments, the value is 1.
Table: eWEB_SCRIPT_TRACE_AUTH WSTA_UserID_str This field must have a username that corresponds with the USERA_UserID_str field of the eWeb_user_auth table or can be the keyword *ALL. If the value *ALL is entered, any user can trace this script message. If one or more users are defined, only those users can trace the related script message. If nothing configured in this table for a specific script message, no one can trace this script message.
. Table: eWEB_SCRIPT_CANCEL_AUTH eWEB_SCRIPT_CANCEL_AUTH parameters WSCA_Site_id_n This field specifies the site, as defined in eKERNEL_SITE table. In most environments, the value is 1. An authorized of an entry typically found in this field is as follows: 1 WSCA_Area_id_n This field specifies the area, as defined in eKERNEL_AREA table. In most cases, the value is 1.
Table: eWEB_SCRIPT_CANCEL_AUTH If nothing configured in this table for a specific script message, no one can cancel this script message. An authorized of an entry typically found in this field is as follows: Admin WSCA_Comments_str This field can be used by an administrator to enter remarks. The field is informational only. Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eWEB_SNDGRPMSG eWEB_SNDGRPMSG parameters WGM_Site_id_n This field specifies the site identifier, as described in table eKERNEL_SITE. In most cases this value is 1. An authorized of an entry typically found in this field is as follows: 1 WGM_Area_id_n This field specifies the area identifier, as described in table eKERNEL_AREA. In most cases this value is 1.
Table: eWEB_SNDGRPMSG When entering a value in this field, ensure that the specified group name exists in the eKERNEL_GROUP table, and that the eKERNEL_GROUP_MEMBER contains at least one member. An authorized of an entry typically found in this field is as follows: 00001 (qualified group) or *ALL (generic group) WGM_Sequence_n This field is a sequence number and makes the records unique in the database.
eWEB_SNDGRPMSG parameters 427 Table 57 eWEB_SNDGRPMSG sample data Site Area Group Sequence Message Alarm id 3 1 *ALL 1 Emergency evacuation 3170103 3 1 *ALL 2 *FREE 3170102 3 1 1 1 AS400 failure 3170102 3 1 1 2 NT failure 3170102 3 1 1 3 Domino failure 3170102 3 1 1 4 Firewall failure 3170102 3 1 2 1 Check invoice 3170102 3 1 2 2 Check mailbox 3170102 3 1 2 3 Check quotations 3170102 3 1 2 4 Check received goods 3170102 3 1 RAMPENPLAN 1
Table: eWEB_SNDGRPMSG Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eWEB_SNDUSRMSG eWEB_SNDUSRMSG parameters WUM_User_id_str This field specifies the user, as defined in eWEB_USER_AUTH table. The user is defined at the login process, where the web user enters a valid user and password. This user name is stored in the Web browser and reused as needed when authentication is needed for Web requests.
Table: eWEB_SNDUSRMSG WUM_Message_str This field specifies the message that is shown to the eWEB user in the Send User Message functionality, and finally is sent to the destination users. Note the length of the message must be smaller than or equal to the maximum length associated with the WUM_AlA_id_n definition in eKERNEL_ALARM table. For authorized, when an alarm identifier defines maximum length in eKERNEL_ALARM table of 48 bytes, the specified message must not be longer that 48 bytes.
eWEB_SNDUSRMSG parameters 431 Table 58 eWEB_SNDUSRMSG sample data (cont’d.) User Sequence Message Alarm id FMI 4 Private message 4 for FMI 3170103 KDS 1 Private message 1 (Medium) 3170102 KDS 2 Private message 2 (Short) 3170101 KDS 3 Private message 3 (Long) 3170103 Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Table: eWEB_SNDUSRMSG Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eWEB_TOC eWEB_TOC parameters WTC_Site_id_n This field specifies the site identifier, as defined in eKERNEL_SITE table. The site is in most cases equal to 1. The Web Server determines its site and area based upon its own IP address, as defined in the eWEB table. An authorized of an entry typically found in this field is as follows: 1. WTC_Group_n This field contains a numeric sequence number, which is combined with WTC_Item_n and WTC_Language_str to generate a key.
Table: eWEB_TOC WTC_Item_n This field contains a numeric sequence number, which is combined with WTC_Group_n, and WTC_Language_str to generate a key. The key is unique within the site. WTC_Item_n is used to logically sort table of contents in groups and items. Nortel recommends starting the first item in a group at 1 and incrementing by 1. An authorized of an entry typically found in this field is as follows: 1. WTC_Language_str This field contains a 4-byte language code.
eWEB_TOC parameters 435 WTC_Link_str This field specifies the hyperlink associated with the table of contents. If blank, the hyperlink is inactive. This is typically used to logically group menu options in different sections, and define such empty link for the header of each section. See the sample in Table 59 "Valid WTC_Link_str values" (page 435) for more information.
Table: eWEB_TOC An authorized of an entry typically found in this field is as follows: 20 WTC_Comments_str This field can be used by an administrator to enter remarks. The field is informational only. Table 60 "eWEB_TOC sample configuration" (page 436) shows authorizeds of data found in the eWEB_TOC table. Figure 221 "eWEB_TOC sample result (language 2909 and language 2963)" (page 438) shows an authorized of the eWEB_TOC result for language 2909 and language 2963.
eWEB_TOC parameters 437 Table 60 eWEB_TOC sample configuration (cont’d.) S i t e G r o u p I t e m 3 4 2 2909 Device Inquiry eWEB_device_inquiry.php 20 3 4 2 2963 Device overzicht eWEB_device_inquiry.php 20 3 4 3 2909 Group Inquiry eWEB_group_inquiry.php 20 3 4 3 2963 Groeps overzicht eWEB_group_inquiry.php 20 3 4 4 2909 Table View eWEB_table_view.php 20 3 4 4 2963 Tabel bekijken eWEB_table_view.
Table: eWEB_TOC Figure 221 eWEB_TOC sample result (language 2909 and language 2963) Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
. Table: eWEB_USER_AUTH EWEB_USER_AUTH parameters USERA_UserID_str This field contains a User ID. The eWEB module must define at least one user profile for authentication purposes. Nortel recommends that you create a user profile for each user that has access to the eWEB interface, to avoid alarms generated by unauthenticated users.
Table: eWEB_USER_AUTH USERA_Password_str This field contains a 10-byte password. The eWEB interface allows users to change their own password. Therefore you can create new users with default passwords (for authorized, the same as the User ID), and ask users to change their password when they log in for the first time. Note: eWEB stores passwords without encryption in the Access 2000 database, and are therefore available to anyone who can access the DECT Messengersystem.
EWEB_USER_AUTH parameters 441 of the user is retrieved based on the User ID, and is used in the MAIL FROM tag of the mail composition process, as defined in the RFC821 specifications. An authorized of an entry typically found in this field is as follows: francis.missiaen@1s.be. USERA_Allobj_b This field specifies whether a user has the authority to access all objects. In most cases the value False (0) is used. This means the user does not have authority to access all objects.
Table: eWEB_USER_AUTH USERA_Service_b This value is not implemented in the current release. Nortel recommends using the value False (0). This feature is used in future releases to grant access to service functions that can be implemented in eWEB at a later stage. An authorized of an entry typically found in this field is as follows: 0 (denotes False). USERA_Language_str This field contains a 4-byte identifier that denotes the language used for eWEB-access and eGRID-access.
EWEB_USER_AUTH parameters Table 62 Language values reserved for future implementation (cont’d.
Table: eWEB_USER_AUTH Table 62 Language values reserved for future implementation (cont’d.
. Index A AccuCall 111 Activate scripts 195 Active alarms 178 Active scripts 200 Activity of eSMTP_server 29 Administrator 204 Advanced configuration 207 Advanced devices 212 Advanced facilities 207 Advanced groups 218 Advanced users 222 ALA_Comments_str 323 ALA_Confirm_action_str 322 ALA_Descr_str 317 ALA_Group_delivery_str 321 ALA_id_n 315 ALA_INPGM_id_n 316 ALA_Length_n 323 ALA_Prty_n 319 ALA_Remove_after_str 319 ALA_Repeat_intv_n 322 ALA_Scroll_intv_n 321 ALA_Scroll_state_str 321 ALA_Silence_intv_
CFG_OUTRQS_id_n 383 CFG_Site_Admin_e-mail_str 378 CFG_Site_Admin_name_str 378 CFG_Site_Descr_str 378 CFG_Site_eKERNEL_ip_str 378 CFG_Site_eKERNEL_port_str 379 CFG_Site_eKERNEL_socket_str 379 CFG_site_id_n 377 CFG_Watchdog_cmd_str 382 CFG_Watchdog_com_port_str 382 CFG_Watchdog_interval_n 382 Change password 145, 177 Conference 105 Configuration basic overview 192 Configuration of advanced devices 212 Configuration of advanced facilities 207 Configuration of advanced groups 218 Configuration of advanced
eCAPG_Msg_len_n 248 eCAPG_Msg_start_n 247 eCAPG_Remove_after_str 251 eCAPG_Reset_len_n 251 eCAPG_Reset_start_n 250 eCAPG_Reset_str 251 eConfig 118 eDMSAPI _API_port_str 256 eDMSAPI _inbound_result parameters 267 eDMSAPI _PBX_address_str 256 eDMSAPI parameters 253 eDMSAPI table 253 eDMSAPI_Ack2TimeOut_n 258 eDMSAPI_ALA_Prty_EMSG_n 255 eDMSAPI_ALA_Prty_UMSG_n 255 eDMSAPI_api_address_str 256 eDMSAPI_Area_id_n 253 eDMSAPI_Comments_str 258 eDMSAPI_DataPathDelay_n 258 eDMSAPI_eKERNEL_Seats_count_n 254 eDMSAP
eIOAI_GRP_Name_str 297 eIOAI_Max_R_str 295 eIOAI_Max_S_str 296 eIOAI_Min_R_str 295 eIOAI_Min_S_str 294 eIOAI_Module_str 293 eIOAI_MSG_str 297 eIOAI_Site_id_n 293 eIODI_ALA_Descr_str 307 eIODI_Area_id_n 305 eIODI_Comments_str 307 eIODI_Contact_str 306 eIODI_ContactType_str 306 eIODI_GRP_Name_str 307 eIODI_Module_str 305 eIODI_MSG_str 307 eIODI_Site_id_n 305 eIODO_Area_id_n 309 eIODO_Comments_str 310 eIODO_Contact_str 310 eIODO_Module_str 309 eIODO_Seconds_n 310 eIODO_Site_id_n 309 eIOM_Area_id_n 289 eIO
eOAI table 401 eOAI_ALA_Prty_DTMF_Confirm_n 402 eOAI_Area_id_n 401 eOAI_Comments_str 402 eOAI_Framework_Address_str 401 eOAI_Framework_Port_n 401 eOAI_Silence_intv_n 402 eOAI_Site_id_n 401 eOAP parameters 403 eOAP table 403 eOAP_ALA_Prty_DTMF_Confirm_n 404 eOAP_Area_id_n 403 eOAP_Comments_str 404 eOAP_Framework_Address_str 403 eOAP_Framework_Port_n 403 eOAP_Silence_intv_n 404 eOAP_Site_id_n 403 eSMTP 13 eSMTP logging 18 eSMTP_ALA_Prty_DTMF_Confirm_n 406 eSMTP_Area_id_n 405 eSMTP_CLIENT parameters 405 e
FMT_Comments_str 341 FMT_Concatination_b 340 FMT_Descr_str 341 FMT_OUTPGM_Appl_str 337 FMT_OUTPGM_Facility_str 337 FMT_Page_ind_n 339 FMT_Page_more_ind_n 339 FMT_Scroll_depth_n 340 Functionality of eVBVOICE 97 G General configuration parameters for eVBVOICE 97 General section 73 Generate alarms 117 Generating alarms 25 Getimage 90 Group inquiry 141 Group maintenance functions 143 Group message 131, 161, 171 GRP_Comments_str 345, 355 GRP_Descr_str 345 GRP_Fri_b 353 GRP_From_str 352 GRP_Holiday_b 354 GR
Log in to Web administrator 159 Log off 125 Log out of Web administrator 161 Logging 18 Logging eSMTP_server 34 Logging on to Web Administrator 149 Logs 105 PHP 229 PlayMsgs 105 Plug-in modules 147 Plug-in support 147 Publisher 87, 92 Publisher and subscriber model Publisher section 73 M R Main site 67 Maintain users 151 Maintenance of devices, facilities, groups, and users 207 Menu option RECORD 101 Menu type CONFIRM 98 Menu type SET and RESET 99 Merging registry files 79 Messages from eKERNEL 15
Sign-off eWEB 147 SMTP message 128 SNMP trap 46, 204 SNMPv1 trap sender 204 SNMPv1 traps 39 SNMPv2 traps 39 SQL script 91 State of the other party 87 Subject tag 27 Subscriber 87, 90 Subscribers 92 Subscribers section 73 Supervisor authority 194 Switch back to original environment System 105 Table Table Table Table Table Table 92 T Table eASYNC 233 eBACKUP 239 Table eCAP_generic 243 Table eDMSAPI 253 Table eDMSAPI_INBOUND 259 Table eDMSAPI_INBOUND_EVENT 263 Table eDMSAPI_INBOUND_RESULT 267 Table eES
Web administrator 151, 154, 204, 226 Web Administrator module 149 Web administrator page 160 Web administrator user guide 153 Web based user interface 153 Web-based user interface 149 WGM_AlA_id_n 426 WGM_Area_id_n 425 WGM_Comments_str 426, 430 WGM_GRP_Name_str 425 WGM_Message_str 426 WGM_Sequence_n 426 WGM_Site_id_n 425 Windows 161 Windows SMTP server 23 Work with alternative devices 188 Work with Group members 184 Work with groups 143 Work with scripts 195, 198 Work with Scripts 194 Work with tasks 2
Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 NN43120-301 02.01 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved.
Nortel Communication Server 1000 DECT Messenger Installation and Commissioning — Book 2 Release: 7.0 Publication: NN43120-301 Document revision: 02.01 Document release date: 4 June 2010 Copyright © 2003-2010 Nortel Networks. All Rights Reserved. While the information in this document is believed to be accurate and reliable, except as otherwise expressly agreed to in writing NORTEL PROVIDES THIS DOCUMENT "AS IS" WITHOUT WARRANTY OR CONDITION OF ANY KIND, EITHER EXPRESS OR IMPLIED.
