Avaya CS1000 User's Manual

Nortel Communication Server 1000

DECT Messenger Installation and Commissioning — Book 2

Release: 7.0

Document Revision: 02.01

www.nortel.com

.

NN43120-301

.


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.

Nortel, Nortel Networks, the Nortel logo, and the Globemark are trademarks of Nortel Networks.

All other trademarks are the property of their respective owners.

.

.

Contents

Module - eSMTP

Initialization 13

Output program activity 15

Logging 18

Relaying and Routing 21

Windows SMTP server 23

Domino (Lotus Notes) 24

Module - eSMTP_server

27

Keyword processing 27

Initialization 27

Activity of eSMTP_server 29

Logging 34

Module - eSNMP

Architecture 39

Send SNMP Message for Win32 45

Send SNMP Message for Web 46

Send SNMP Message for iSeries 47

Module - eTM

63

Shutting down eTM_HA 63

Module - eTM_HA

Overview 65

Publisher and Subscriber 67

Registry settings eTM 68

Registry settings eTM_HA 73

Merging registry files 79

Check tasks 81


Publisher 84

Keeping track of states 87

Subscriber 87



NN43120-301 02.01

4 June 2010


3

13

25

39

49

65

.

4

Publisher 87

Recommendation 88

XML image 90

SQL script 91

Switch back 92

Conclusion 93

Module - eVBVOICE

Introduction 95

Inbound calls 97

Outbound calls 104

VBV4.INI Hardware-specific settings 111

Module - eVBVOICE AHVR

Introduction 117

Configuration 118

Module - eWEB

Sign-on procedure 123

Sign-off procedure 125

Send DMS-API Message 126

Send SMTP Message 128

Send Server Message 129

Send Group Message 131

Send User Message 134

Send Script Message 136

Set Script 137

Trace Active Script 138

Cancel Script 138

Trace Ended Script 139

Alarm Inquiry 139

Device Inquiry 140

Group Inquiry 141

Table View 142

Work with Groups 143

Change Password 145

Info 146

Sign off 147

Plug-in Support 147

Plug-in module MyPortal@Net 148

Module - Web Administrator

Authentication 150

Work with Users 151



NN43120-301 02.01

4 June 2010


149

95

117

123

.

Module - Web Administrator User Guide

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 trap 204

Advanced configuration 207

Configuration of advanced facilities 207

Configuration of advanced devices 212

Configuration of advanced groups 218

Configuration of advanced users 222

Expert 226

Table: eASYNC

eASYNC parameters 233

233

Table: eBACKUP

eBACKUP parameters 239

239

Table: eCAP_generic

eCAP_generic parameters 243

243

Table: eDMSAPI

eDMSAPI parameters 253

253

Table: eDMSAPI_INBOUND

eDMSAPI_inbound parameters 259

259



NN43120-301 02.01

4 June 2010


5

153

233

239

243

253

259

6

.

Table: eDMSAPI_INBOUND_EVENT

263

Table: eDMSAPI_INBOUND_RESULT

eDMSAPI _inbound_result parameters 267

267

Table: eESPA

eESPA parameters 271

271

Table: eESPA_OUTBOUND_CFG

eESPA_outbond_cfg parameters 285

285

Table: eIO_MODULE

eIO_modules parameters 289

289

Table: eIO_AI

eIO_AI parameters 293

293

Table: eIO_DI

eIO_DI parameters 305

305

Table: eIO_DO

eIO_DO parameters 309

309

Table: eKERNEL_AREA

eKERNEL_area parameters 313

313

Table: eKERNEL_ALARM

eKERNEL_alarm parameters 315

315

Table: eKERNEL_DEVICE

eKERNEL_DEVICE parameters 327

327

Table: eKERNEL_DEVICE_ALT

eKERNEL_DEVICE_ALT parameters 333

333

Table: eKERNEL_DEVICE_FORMAT

eKERNEL_DEVICE_FORMAT parameters 337

FMT_OUTPGM_Appl_str 337



NN43120-301 02.01

4 June 2010


315

327

333

337

305

309

313

263

267

271

285

289

293

.

7

FMT_OUTPGM_Facility_str 337

FMT_Bytes_line1_n 338



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 343

GRP_id_str 343

GRP_InPGM_id_n 344

GRP_Name_str 344

GRP_Descr_str 345

GRP_Comments_str 345

Table: eKERNEL_GROUP_AUTH

eKERNEL_GROUP_AUTH parameters 347

GRPA_GRP_id_str 347

GRPA_UserID_str 347

GRPA_Comments_str 348

Table: eKERNEL_GROUP_MEMBER

eKERNEL_GROUP_MEMBER parameters 349

GRPM_GRP_id_str 349

GRPM_Dev_id_str 350

GRPM_Dev_Site_id_n 351

GRPM_Dev_Area_id_n 351

GRP_OUTPGM_Appl_str 351

GRP_From_str 352

GRP_To_str 352

GRP_Mon_b 353

GRP_Tue_b 353

GRP_Wed_b 353

GRP_Thu_b 353

GRP_Fri_b 353

GRP_Sat_b 354

GRP_Sun_b 354

GRP_Holiday_b 354

GRPM_Activate_timestamp_str 354

GRPM_Desactivate_timestamp_str 355



NN43120-301 02.01

4 June 2010


343

347

349

.

8

GRP_Comments_str 355

Table: eKERNEL_GUARDING

eKERNEL_GUARDING parameters 357

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

Table: eKERNEL_HOLIDAY

eKERNEL_HOLIDAY parameters 363

Holiday_str 363

Holiday_Comments_str 364

Table: eKERNEL_INPGM

eKERNEL_INPGM parameters 365

INPGM_id_n 365

INPGM_Site_id_n 366

INPGM_Area_id_n 366

INPGM_Appl_str 366

INPGM_Manufacturer_str 367

INPGM_Model_str 367

INPGM_Bidir_b 368

INPGM_Resource_str 368

INPGM_Settings_str 368

INPGM_AutoCreateGRP_b 369

INPGM_Default_DEV_OUTPGM_str 370

INPGM_Default_DEV_OUTPGM_facility_str 370

INPGM_Descr_str 370

INPGM_Comments_str 371

Table: eKERNEL_MESSAGE_FORMAT

eKERNEL_MESSAGE_FORMAT parameters 373

373



NN43120-301 02.01

4 June 2010


357

373

363

365

.

Table: eKERNEL_SITE

eKERNEL_SITE parameters 377

377

Table: eKERNEL_TCPCLIENT

eKERNEL-TCPCLIENT parameters 385

385

Table: eLOCATION

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

eLOCATION_INBOUND_RESULT parameters 395 eLOCIR_Inpgm_id_n 395 eLOCIR_Called_dev_str 395 eLOCIR_Calling_dev_str 395

eLOCIR_eLOC_Site_id_n 396 eLOCIR_eLOC_Area_id_n 396 eLOCIR_GRP_Name_str 396 eLOCIR_Msg_str 396

eLOCIR_Comments_str 397

Table: eLOCATION RPN

eLOCATION_RPN parameters 399 eLOCRPN_Site_id_n 399 eLOCRPN_Area_id_n 399 eLOCRPN_RPN_str 399

eLOCRPN_Message_str 400 eLOCRPN_Comments_str 400

Table: eOAI

eOAI parameters 401 eOAI_Site_id_n 401 eOAI_Area_id_n 401 eOAI_Framework_Address_str 401 eOAI_Framework_Port_n 401

eOAI_ALA_Prty_DTMF_Confirm_n 402



NN43120-301 02.01

4 June 2010


395

399

401

9

377

385

391

.

10

eOAI_Silence_intv_n 402 eOAI_Comments_str 402

Table: eOAP

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

Table: eSMTP_SERVER

eSMTP_SERVER parameters 409

409

Table: eWEB

eWEB parameters 413

413

Table: eWEB_SCRIPT

eWEB parameters 415

415

Table: eWEB_SCRIPT_SET_AUTH

eWEB_SCRIPT_SET_AUTH parameters 419

419

Table: eWEB_SCRIPT_TRACE_AUTH

eWEB_SCRIPT_TRACE_AUTH parameters 421

421

Table: eWEB_SCRIPT_CANCEL_AUTH

eWEB_SCRIPT_CANCEL_AUTH parameters 423

423

Table: eWEB_SNDGRPMSG

eWEB_SNDGRPMSG parameters 425

425

Table: eWEB_SNDUSRMSG

eWEB_SNDUSRMSG parameters 429

429



NN43120-301 02.01

4 June 2010


403

419

421

423

425

429

405

409

413

415

Table: eWEB_TOC

eWEB_TOC parameters 433

433

Table: eWEB_USER_AUTH

439

11

433

439

.



NN43120-301 02.01

4 June 2010


12

.



NN43120-301 02.01

4 June 2010


.

.

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.

Figure 1 "Example of required keywords" (page 13)

shows an example of the required keywords:

Figure 1

Example of required keywords

13

The following keywords are used:

• Site

The Site keyword denotes the site that is assigned to the eSMTP module.

• eKERNEL address

The eKERNEL address keyword denotes the IP address that is assigned to the eKERNEL module. The eSMTP 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 client instance.



NN43120-301 02.01

4 June 2010


14 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.

Figure 2 eSMTP configuration request

.

When the configuration is received, a window similar to the one shown

Figure 3 "Configuration information" (page 15)

opens. The configuration can be viewed in the Connections tab.



NN43120-301 02.01

4 June 2010


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. The actual dialog box with the SMTP server can be monitored through the eSMTP tab, as shown in

Figure 5 "eSMTP tab" (page 16) .



NN43120-301 02.01

4 June 2010


16 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

Action Step

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. See

Figure 6 "Request queue with extracted keywords" (page 17)

for an example of an active message.

.



NN43120-301 02.01

4 June 2010


Figure 6

Request queue with extracted keywords

Output program activity 17

.

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.

Note that intermediate processing on the external SMTP server or servers is responsible for message delivery. This process is completely out of the control of the eSMTP application.

Figure 8 "Example of mail produced by eSMTP module" (page

18)

shows an example of the mail that is produced by the eSMTP module, when viewed using Microsoft Outlook Express.



NN43120-301 02.01

4 June 2010


18 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.



NN43120-301 02.01

4 June 2010


Figure 10 eSMTP on-screen logging

Logging 19

Figure 11 "Log files on hard disk" (page 20)

shows an example of a log file on disk, as viewed with a text editor.

.



NN43120-301 02.01

4 June 2010


20 Module - eSMTP

Figure 11

Log files on hard disk

.



NN43120-301 02.01

4 June 2010


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) .

.



NN43120-301 02.01

4 June 2010


22 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. Nortel recommends that the IP address of eSMTP be defined in the SMTP server of the mail platform, so that eSMTP is allowed to send mail to destinations that are not in the local domain.

The related configuration issues are beyond the scope of this document. In the following pages, configuration information is shown for illustration only.

Look for a more detailed discussion of relaying and routing issues in the official documentation for your SMTP server (Windows 2000, Exchange,

Domino, iSeries 400, and so on).



NN43120-301 02.01

4 June 2010


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.

Figure 14

Setting SMTP relay eSMTP can send mail to users that do not reside in the local domain. This is indicated in the log as shown in

Figure 15 "Relaying successful" (page

23)

.

Figure 15

Relaying successful

.



NN43120-301 02.01

4 June 2010


24 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).

To configure inbound SMTP options, click Router/SMTP > Restrictions and Controls > SMTP Inbound Controls > Allows messages only from

Figure 16 "Enable messages from external hosts to be sent to external

Internet domains" (page 24)

illustrates the settings needed to allow messages from external hosts to be sent to external Internet domains.

Figure 16

Enable messages from external hosts to be sent to external Internet domains

.

Consult with your network administrator for more information on configuration aspects and network design.



NN43120-301 02.01

4 June 2010


25

.

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.

The module eSMTP_server must always be seen in conjunction with the

SMTP Server component that is shipped with Windows, as part of the

Internet Information Server software. Refer to

“Module - eSMTP_server”

(page 25)

for more information.

The actual role of SMTP server (handling inbound sockets connections on port 25) is played by the Microsoft component. This component stores inbound mails in a directory structure, as specified during configuration of the Microsoft component.

A typical configuration sends inbound mails to the directory c:\inetpub\mailroot\drop.

These e-mail files are in fact readable text-files that can be opened with a text editor, such as Notepad.

Figure 17 "Example of inbound e-mail" (page

26)

shown an example of an inbound e-mail:

.



NN43120-301 02.01

4 June 2010


26 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. Future releases of the eSMTP_server can be enhanced with, for instance, functionality that is capable of detaching media streams (for example, BASE64 encoded audio/wave contents).



NN43120-301 02.01

4 June 2010


.

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. Although not officially supported, it is possible to use the eSMTP_server in environments that work with other SMTP Servers than the one officially supported (Microsoft Internet

Information Server).

The information in

Figure 18 "Keyword processing of selected e-mail tags"

(page 27)

is stored for further processing.

Figure 18

Keyword processing of selected e-mail tags

Initialization

The eSMTP_server is started by means of a shortcut. This shortcut contains required parameters illustrated in

Figure 19 "Shortcut parameters"

(page 27)

.

Figure 19

Shortcut parameters

The following keywords are used:

•

Site

The Site keyword denotes the site that is assigned to the eSMTP_server module.

• eKERNEL



NN43120-301 02.01

4 June 2010



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)

. This is performed based upon the address and port information obtained from the Shortcut.

Figure 20 eKERNEL connection attempt

At connection, the eSMTP_server requests the eKERNEL to provide additional configuration settings, as shown in

Figure 21 "Configuration request" (page 28) . The eKERNEL authenticates the client and responds

with a configuration reply, as shown in

Figure 22 "Configuration reply"

(page 29)

.

Figure 21

Configuration request

.



NN43120-301 02.01

4 June 2010


Activity of eSMTP_server 29

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.

Click the eSMTP_server tab to view request processing, as shown in

Figure 24 "Request processing shown on the eSMTP_server tab" (page

30)

.



NN43120-301 02.01

4 June 2010



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. During processing, a window opens similar to the one shown in

Figure 26 "Mail processing"

(page 31)

.



NN43120-301 02.01

4 June 2010



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 <x-receiver> tag.

• To field

Isolated from the <x-sender> tag.

• Subject field

Isolated from the Subject: tag.

With these values, the eSMTP_server produces a message request for eKERNEL, as shown in

Figure 27 "eSMTP message request for eKERNEL" (page 31) .

Figure 27 eSMTP message request for eKERNEL

.



NN43120-301 02.01

4 June 2010



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.

• Message Accepted

If the message is accepted, a reply is sent, as shown in

Figure 28

"Message reply: accepted" (page 32) .

Figure 28

Message reply: accepted

Upon receiving this acknowledgement, the eSMTP_server moves the original mail message to a processed location, unless the target directory is set to a value of *NONE.

Figure 29 "Specifying the location to file accepted messages" (page 32)

shows the target folder for accepted messages.

Figure 29

Specifying the location to file accepted messages

.



NN43120-301 02.01

4 June 2010



• 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.

Upon reception of this negative acknowledge (NACK), the eSMTP_server moves the original mail message to an error location, unless the target directory is set to a value of *NONE.

Figure 31 "Specifying the error target directory" (page 34)

shows the target folder for rejected messages.

.



NN43120-301 02.01

4 June 2010



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). After the configuration is fixed, the messages in error can be either deleted or moved back to the Dropped directory for reprocessing.

Logging

The eSMTP_server application provides logging both on-screen and on disk.

Figure 32 "On-screen logging" (page 35)

shows the on-screen logging that can be found in the Logging tab.

.



NN43120-301 02.01

4 June 2010


Logging 35

Figure 32

On-screen logging

Figure 33 "Log file on disk" (page 36)

shows the log file stored on disk.

.



NN43120-301 02.01

4 June 2010



Figure 33

Log file on disk

.



NN43120-301 02.01

4 June 2010


.



NN43120-301 02.01

4 June 2010


Logging 37


.



NN43120-301 02.01

4 June 2010


.

.

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. Some of the modules listed in this attention box are available only on a site-specific basis.

Architecture

The eSNMP module is able to receive SNMPv1 and SNMPv2 traps sent from an external SNMP trap sender to DECT Messenger. The eSNMP module uses an SNMP trap receiver. As a result of a received SNMP trap, an alarm is activated or deactivated on the Messenger platform.

At startup, eSNMP contacts eKERNEL to request the configuration of eKERNEL. The IP address and port of eSNMP is configured in the shortcut. When parameters are absent, the startup values are prompted, as shown in the following figure.

39



NN43120-301 02.01

4 June 2010


40 Module - eSNMP

Figure 34 eSNMP parameters missing

The module eKERNEL responds to the <cfgrqs> with <cfgrpy>. 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

.



NN43120-301 02.01

4 June 2010


Figure 37 eSNMP traps

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.

.

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.

• community, for example public

• enterprise oid, for example 1.3.6.1.4.1.28088.32.1

• generic trap (value between 0 and 6)

• specific trap (0 or >0)

• a timestamp

Optionally additional parameters can be received. The eSNMP module can handle up to 9 additional parameters, or varbind parameters. Each varbind parameter is up to 32 characters long.

When an SNMPv1 or SNMPv2 trap is received, a message is sent to eKERNEL. eKERNEL considers the eSNMP modules as an input program, and requires the typical parameters needed for generating a message.

See the following figure.



NN43120-301 02.01

4 June 2010


42 Module - eSNMP

Figure 38

Parameters used by eKERNEL to generate a message

Figure 39 eSNMP table

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 <cfgrqs> and <crgryp> 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. These parameters include action, alarm identifier, group, message text, and so on. See the following figure.

.



NN43120-301 02.01

4 June 2010


Architecture 43

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. See the following figure.

Figure 41 eSNMP_TRAPS table

.



NN43120-301 02.01

4 June 2010


44 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)

• Alarm identifier (as specified in eKERNEL_ALARM table)

• Group (as specified in eKERNEL_GROUP and eKERNEL_GROUP_

MEMBER)

• Message

The message can be a combination of fixed text and replacement values.

In many cases, SNMP traps provide a list of variable binding parameters.

The eSNMP module supports up to 9 varbind parameters. The value of those parameters can be embedded in the resulting message. The following figure shows a sample of such a definition.

Figure 43

Message with varbind parameters

Supported replacement values are listed in the following figure.



NN43120-301 02.01

4 June 2010


Send SNMP Message for Win32 45

Figure 44

Supported replacement values

Figure 45

Generic traps

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. The IP address of the sender is included in the key.

When no GenericTrap field is available, the value 0 is used. The use of the value 0 allows a flexible filtering of alarms, for example ignore one or more traps by not specifying the corresponding alarm and, for example assigning priorities.

Note that generic traps are reserved values in SNMP protocol, as shown in the following figure.

.

Send SNMP Message for Win32

A sample program of Send SNMP Message is available on the DECT

Messenger CD in the directory 09-Add-ons\Send SNMP Message.

When you install the program, it resides in the directory C:\Program

Files\Send SNMP Message\Exe and is called Send SNMP Message.



NN43120-301 02.01

4 June 2010


46 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.

Figure 46

Send SNMP Message

.

The Send SNMP Message program is provided on “as-is” basis.

Send SNMP Message for Web

The Web Administrator provides a web-based interface to send SNMPv1 traps from the Web Administrator to the module eSNMP.

The implementation is based upon PHP script and hosted in the Apache

HTTP Server on the Messenger platform.

Since sending SNMPv1 traps is reserved for system administrators, the

SNMP trap is reserved for Web Administrator users with a security level equal to administrator. Security level equal to administrator refers to users in the eWEB_AUTH table defined with USERA_Sec_level of 50 or above.



NN43120-301 02.01

4 June 2010


Figure 47

Send an SNMP trap

Send SNMP Message for iSeries 47

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.

.



NN43120-301 02.01

4 June 2010


48 Module - eSNMP

Figure 48

Send SNMP message (SNDSNMPMSG)

Contact Nortel product support to obtain more details.

.



NN43120-301 02.01

4 June 2010


.

.

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

49

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) .

Figure 50

Open Task Manager

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 module and all associated tasks.

Select the Open Task Manager menu option in the pop-up menu, to open the Task Manager, as shown in

Figure 51 "eTM Task Manager" (page 50) .



NN43120-301 02.01

4 June 2010


50 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. The PID is the value that is also shown when the system supplied Task Manager of Microsoft is used to represent the processes. A special value

0000000000 is shown when the task is not running.

— The keyword Window style denotes the style of the window of the task. Supported values are described in

Table 1 "Supported window styles" (page 50) .

Table 1

Supported window styles

Value

0

Description

Window is hidden and focus is passed to the hidden window.



NN43120-301 02.01

4 June 2010



Table 1

Supported window styles (cont’d.)

Value

1

2

3

4

6

Description

Window has focus and is restored to its original size and position.

Window is displayed as an icon with focus.

Window is maximized with focus.

Window is restored to its most recent size and position. The currently active window remains active.

Window is displayed as an icon. The currently active window remains active.

— The keyword Shortcut denotes the command line parameter that is used to launch the process.

• The second section shows a log of the changes in the state of the tasks.

• The third section shows some additional logging information, and is updated when, for instance, a task is terminated from within the eTM application.

• The bottom section shows on the left a small icon that denotes the current state of the eTM. This application can be started, paused or stopped.

The eTM is launched by means of the following command:

Table 2

Launch eTM Command

C:\SOPHO Messenger@Net\Exe\eTM.exe

In most cases there is only one environment configured, and the eTM uses this default configuration. When there is more than one environment configured, a selection window opens that allows you to specify the environment that must be started, as shown in

Figure 52 "Specify the eTM environment (when more than one is configured)" (page 52) .

.



NN43120-301 02.01

4 June 2010


52 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.exe /Site:GNTN1SFMI

The Windows Registry Editor (regedit or regedt32) can be used to maintain the configuration of the eTM.

Figure 53 "Sample eTM configuration registry entry" (page 52)

shows a sample configuration, as represented in the system registry as a result of the configuration process.

Figure 53

Sample eTM configuration registry entry

.



NN43120-301 02.01

4 June 2010



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 .reg files

Action Step

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:



NN43120-301 02.01

4 June 2010


54 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. Click this button to read the eKERNEL_TCPCLIENT table and automatically generate the required shortcuts for each site and environment, as shown in

Procedure 3

“Generate shortcuts” (page 55)

.



NN43120-301 02.01

4 June 2010



Procedure 3

Generate shortcuts

Action Step

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.

.



NN43120-301 02.01

4 June 2010


56 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). The PC with environment

GNTN1SFMI contains a full-featured installation with one or more instances of each module; the second environment GNTN1SKDS contains a subset of the modules only.

Figure 56 "eTM - Site 1 - Environment

GNTN1SFMI.reg" (page 57)

shows the registry file corresponding to the foregoing example.



NN43120-301 02.01

4 June 2010


Figure 56 eTM - Site 1 - Environment GNTN1SFMI.reg


.



NN43120-301 02.01

4 June 2010


58 Module - eTM

.



NN43120-301 02.01

4 June 2010


Figure 57 eTM - Site 1 - Environment GNTN1SKDS.reg


.



NN43120-301 02.01

4 June 2010


60 Module - eTM

Figure 58 eTM - Site 2 - Environment LOCAL.reg

Figure 59 eTM - Site 3 - Environment LOCAL.reg

.



NN43120-301 02.01

4 June 2010


.


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.

When a task is successfully launched, the logging section features a green icon indicating a normal condition, as shown in

Figure 60 "Green icon indicates Normal Condition" (page 61)

.

Figure 60

Green icon indicates Normal Condition

When the tasks is ended — for example, by means of the Alt-F4 keystroke combination — the eTM detects this and relaunches the missing task. This is indicated in the log as shown in

Figure 61 "Red icon indicates a task that is no longer running" (page 61) .

Figure 61

Red icon indicates a task that is no longer running eTM checks every five seconds to ensure that each task is still running.

When the eTM is paused or stopped, the routine that verifies and restarts the process is temporarily interrupted.

This interruption usually occurs during maintenance of one of more of the programs that are guarded by the eTM. Such a temporary condition is shown in the log as illustrated in

Figure 62 "Yellow icon indicates a task that is paused" (page 61)

.

Figure 62

Yellow icon indicates a task that is paused



NN43120-301 02.01

4 June 2010


62 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)

. The Kill task option is available only when the tree-view is expanded and the mouse is right-clicked on the

PID:xxxxxxxxxx line.

Figure 63

Kill Task

When Kill task is clicked, the running task is terminated, as shown in

Figure 64 "A task is terminated" (page 63)

.

.



NN43120-301 02.01

4 June 2010


63

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. This approach is similar to monitoring applications of other vendors, such as the Apache

Monitor or the SQL Server Service Manager.

Shutting down eTM_HA

The eTM can be shut down by opening the pop-up menu shown in

Figure

50 "Open Task Manager" (page 49) , and choosing the Exit menu option.

ATTENTION

Nortel recommends that you close applications using shut down, exit or close options in the applications themselves, 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 processes gracefully, follow the steps described in

Procedure 4 “Shutting down eTM” (page 63)

.

Procedure 4

Shutting down eTM

Step Action



NN43120-301 02.01

4 June 2010


.

64 Module - eTM

1

2

Open the eTM_HA pop-up menu.

Right-click the eTM_HA icon in the system tray.

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:

3

4

Note: The application also responds to a system Log off or

Shut down event.

Shut down the applications.

Close down all programs using the program specific instructions.

In most cases this means closing the main form of each application by clicking the Close box on the top right of each form. However, some applications require specific shutdown procedures.

Confirm the eTM termination warning dialog box.

Click OK.

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 too.

--End--



NN43120-301 02.01

4 June 2010


.

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.

65

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.

The module eTM_HA 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 65

"Windows System Tray" (page 65)

, where the eTM_HA icon is shown to the immediate left of the clock.

Figure 65

Windows System Tray

Move the mouse over the icon in the system tray, then right-click to open the menu shown in

Figure 66 "Open Task Manager" (page 65)

.

Figure 66

Open Task Manager

.



NN43120-301 02.01

4 June 2010


66 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.

Figure 67 eTM-HA Task Manager - Overview tab

The Logging tab provides data as shown in

Figure 68 "eTM-HA Logging tab" (page 67) .

.



NN43120-301 02.01

4 June 2010


Figure 68 eTM-HA Logging tab

Publisher and Subscriber 67

.

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. Although eTM_HA can run stand-alone (just one publisher), there is no value in activating an eTM_HA when there are no Subscribers. If there are no

Subscribers, use eTM instead of eTM_HA.

In the Publisher and Subscriber model, the Publisher is the site where the

Messenger_CFG configuration database is centralized. This is often called the main site. All configuration must reside on this centralized database only, so eCONFIG maintenance and eKERNEL must all reside on this same site.

The eTM_HA software can also be installed on distributed systems, intended to launch tasks on the distributed system. These systems launch, for instance, eCAP and eDMSAPI modules, all of them referring to the central eKERNEL residing on the Publisher site.



NN43120-301 02.01

4 June 2010


.

68 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.

The following functionality is available:

• eTM functionality

— Launch tasks associated with an environment

— Keep track of running processes of an environment

— Restart tasks that are missing

• eTM_HA specific functionality on Publisher

— TCP server, listening on an administration port (default 7000)

— Handling KeepAlive requests from Subscriber

— Handling GetImage requests from Subscriber

— Keeping track of state of Publisher and Subscriber

— Changing the environment depending on the Publisher and

Subscriber states

• eTM_HA specific functionality on Subscriber

— TCP client, connecting to Publisher administration port

— Sending KeepAlive requests to Publisher

— Sending GetImage requests to Publisher

— Keeping track of state of Publisher and Subscriber

— Changing the environment depending on the Publisher and

Subscriber states

During a change of environment, all running tasks of a previous environment are ended, and new tasks of the new environment are launched. During such an event, the Subscriber applies the last database image received from the Publisher and optionally applies changes defined in an SQL Script.

Registry settings eTM

The configuration of environments and tasks is stored in the following section:

[HKEY_CURRENT_USER\Software\Philips\SOPHO

Messenger@Net\eTM]

This section contains definitions of environments and tasks, as described in the documentation of module eTM,

“Module - eTM” (page 49)

. These settings can be entered manually of can be generated by the eCONFIG or eGRID modules.



NN43120-301 02.01

4 June 2010


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.

Figure 69 "Example of two environments" (page 69)

shows an example, with two environments defined. One environment is called Site 1 –

Environment 10.110.50.138, the other is called Site 1 – Environment

10.110050.138 (backup).

Figure 69

Example of two environments

.

If eTM_HA.exe is launched without additional parameters on a system with local IP address 10.110.50.138, then a prompt appears as follows:

"C:\SOPHO Messenger@Net\Exe\eTM_HA.exe"

Figure 70

Selecting an environment when more than one is defined

Note: Because the objective of this module is to provide high availability, Nortel recommends that you suppress this prompt. This can be accomplished by adding a parameter on the command line of the shortcut, specifying the initial environment to select. This is performed by means of the optional keyword /Environment.

Create a shortcut for eTM_HA in the startup group specifying the initial environment, as follows:



NN43120-301 02.01

4 June 2010


.

70 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. A special value 0000000000 is shown when the task is not running.

• Windowstyle

The keyword Windowstyle denotes the style of the window of the task.

The supported values are shown in

Table 4 "Supported window styles"

(page 70)

.

2

3

4

Table 4

Supported window styles

Value

0

1

6

Description

Window is hidden and focus is passed to the hidden window.

Window has focus and is restored to its original size and position.

Window is displayed as an icon with focus.

Window is maximized with focus.

Window is restored to its most recent size and position. The currently active window remains active.

Window is displayed as an icon. The currently active window remains active.

• Shortcut

The keyword Shortcut denotes the command line parameter that is used to launch the process.

Figure 71 "Sample registry file of the eTM, illustrating a Publisher site"

(page 71)

shows a sample (exported) registry file of the eTM section, and refers to a Publisher site, usually containing an eKERNEL reference.



NN43120-301 02.01

4 June 2010


Figure 71

Sample registry file of the eTM, illustrating a Publisher site

Registry settings eTM 71

.



NN43120-301 02.01

4 June 2010


72 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

.



NN43120-301 02.01

4 June 2010


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.

Figure 73

Sample registry file, illustrating a Subscriber section in backup mode

.

Registry settings eTM_HA

The configuration of environments and tasks is stored in the following section:



NN43120-301 02.01

4 June 2010


74 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.

Figure 74

Registry settings: General section

.

The General section defines the following parameters:

• Interval CheckAvailability

•

Interval CheckTasks

• Interval KeepAlive

• Interval GetImage

•

Timeout KeepAlive

• Timeout GetImage

• Timeout Task

• Log days

• Publisher database

• Subscriber database

• Subscriber workspace

• Subscriber image



NN43120-301 02.01

4 June 2010



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)

.

.



NN43120-301 02.01

4 June 2010


76 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) .

.



NN43120-301 02.01

4 June 2010


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) .



NN43120-301 02.01

4 June 2010


78 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)

.



NN43120-301 02.01

4 June 2010


Figure 81

Registry settings: General in eTM_HA

Merging registry files 79

.

Merging registry files

Use the steps in

Procedure 5 “Merging .reg files” (page 79)

to merge registry files.

Procedure 5

Merging .reg files

Action Step

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:



NN43120-301 02.01

4 June 2010


80 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. Click this button to read the eKERNEL_TCPCLIENT table and automatically generate the required shortcuts for each site and environment, as shown in

Procedure 6 “Generate shortcuts” (page 81) .



NN43120-301 02.01

4 June 2010


Check tasks 81

Procedure 6

Generate shortcuts

Action Step

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. Nortel recommends that you use the following naming conventions in the registry: Site n - Environment x.x.x.x and Site n - Environment x.x.x.x - backup

Check tasks

The program verifies all tasks with a time interval specified in the registry

(usually 5 seconds).

When the eTM_HA is paused or stopped, the routine that verifies and restarts the process is temporarily interrupted.



NN43120-301 02.01

4 June 2010


82 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.

To terminate a process in the Task Manager, use the Kill task menu option as shown in

Figure 82 "Kill Task" (page 82)

. The Kill task option is available only when the tree-view is expanded and the mouse is right-clicked on the PID:xxxxxxxxxx line.

Figure 82

Kill Task

.

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. This approach is similar to monitoring applications of other vendors, such as the Apache

Monitor or the SQL Server Service Manager.


The eTM can be shut down by means of the pop-up menu shown in

Figure

66 "Open Task Manager" (page 65) , using the Exit menu option.



NN43120-301 02.01

4 June 2010


.

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


Action Step

1

2

Open the eTM_HA pop-up menu.

Right-click the eTM_HA icon in the system tray.

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:

3

4

Note: The application also responds to a system Log off or

Shut down event.

Shut down the applications.

Close down all programs using the program specific instructions.

In most cases this means closing the main form of each application by clicking the close box on the top right of each form. However, some applications require specific shutdown procedures.

Confirm the eTM termination warning dialog box.

Click OK.



NN43120-301 02.01

4 June 2010


84 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. The TCP Server is a multiple-accept model, so multiple clients can connect at the same time. The number of simultaneous connections is also defined in the registry. Specify a number at least as great as the number of subscribers. Nortel recommends specifying a value that equals the number of subscribers multiplied by three, to provide room for recovery in case of bad connection attempts.

The netstat command can be used on the Publisher to verify that the TCP

Server is listening (sample data is shown in

Figure 83 "Sample netstat command and returned data" (page 84) ).

Figure 83

Sample netstat command and returned data

.



NN43120-301 02.01

4 June 2010


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)

.

Figure 84

TCP Server Error response

In an operational environment, the eTM_HA instances of the Subscribers send these two requests to the publisher on a regular basis: KeepAlive, and GetImage.

• KeepAlive

A KeepAlive request is exchanged between subscriber and publisher, and allows both parties to verify the presence of the other. Interval and timeout between attempts are defined in the registry.

Figure 85 "TCP Server Keep Alive response" (page 85)

shows an example of what is sent during this exchange. To test this response,

Nortel recommends using Internet Explorer on the Subscriber.

Figure 85

TCP Server Keep Alive response

.

• GetImage

The GetImage request is sent from each Subscriber to the Publisher on a regular time interval, as specified in the registry. The publishing system responds to such a request with an XML image of the



NN43120-301 02.01

4 June 2010


86 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)

.

Figure 87

Expanded information

.

Note 1: Messenger_CFG contains sensitive data, and is exchanged as plain text in XML format. To prevent security exposure, HTTP requests from external systems are rejected with an authentication error. This test is performed based upon the IP address of the requester.

Note 2: In a WAN environment, a test with a Browser can lead to rejection, even from the subscriber system. The most common cause is a proxy server that masks the IP address of the subscriber. During



NN43120-301 02.01

4 June 2010


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. P:1 denotes the publisher is available, P:0 denotes the publisher is unavailable.

Appropriate registry settings associate an environment to each image.

Optionally an SQL script can be defined to run during switching environments.

The registry definitions are shown in

Figure 88 "Registry definitions" (page

87)

.

Figure 88

Registry definitions

.

In

Figure 88 "Registry definitions" (page 87)

, an example is shown with one Publisher and two Subscribers; Subscriber 0 has an image for handling P:0 and P:1. This example shows the settings when the subscriber cannot connect to the publisher. The environment Site 1

– Environment 10.110.50.140 (backup) is associated and SQL script

Messenger_CFG_sql is defined.

Publisher

On the publisher level, a similar registry image is used. However, as a

Publisher is often in contact with multiple subscribers, the available images grow exponentially, as the state of publisher and every subscriber forms a number of combinations for each Boolean state.



NN43120-301 02.01

4 June 2010


88 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 (-).

• The P:1 or P:0 denotes the state of the publisher

•

The S0:1 or S0:1 denotes the state of first subscriber

• The S1:1 or S1:1 denotes the state of second subscriber

Figure 89

Example of an image at the publisher level

.

The registry keys are to be entered manually.

Recommendation

Nortel recommends that you begin with a definition on the Publisher level that refers to the same environment for each image, and with a definition on the Subscriber level that refers to the same environment for each image.

In this initial setup no environment changes occur, and initial testing can take place.

In a later stage you can modify environments. A copy of the production environment is usually made at the Subscriber sites, for example, Site 1

– Environment 10.110.50.140 and Site 1 – Environment 10.110.50.140

(backup). In this backup environment, the tasks can be altered, for example, an eKERNEL instance can be added, and eKERNEL_address refers to a local instance of eKERNEL.



NN43120-301 02.01

4 June 2010


Figure 90

Example: Site 1 - Environment 147.93.169.130

Keeping track of states 89

.



NN43120-301 02.01

4 June 2010


90 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



NN43120-301 02.01

4 June 2010


.

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.

Therefore, after applying a new version of eKERNEL, you must first start eKERNEL, and then copy the Messenger_CFG.mdb database.

If you install new versions of eKERNEL, you must synchronize the eKERNEL modules on all systems. Also the latest layout of

Messenger_CFG of publisher (after automatic upgrade changes at first run) must be manually placed in the directory of the Subscribers.

GetImage puts a file Messenger_CFG.xml in the same directory, and replaces this file on receipt of a GetImage result.

If you want to review this file, make a copy in another location before doing so, for example, C:\Temp. You can, for example, launch the Internet

Explorer and associate XML files to this program, as Internet Explorer has built-in functionality to parse XML documents.

WARNING

Do not open the file in the C:\SOPHO Messenger@Net\Xml, because the file can be allocated by the viewer, and must be replaced when the next KeepAlive result is received.

SQL script

When a Subscriber detects a change between P:1 and P:0:

1.

The Subscriber ends all running tasks associated with the current environment.

At this time, Messenger functionality is disrupted, and pending and new alarms can be lost.

2.

The SQL image in C:\SOPHO Messenger@Net\Xml repository

Messenger_CFG.xml is imported to the workspace C:\SOPHO

Messenger@Net\Xml access database Messenger_CFG.mdb. For this reason, the Messenger_CFG.mdb on Publisher and Subscriber sites must always use the same layout.

Thus the following repositories exist:

•

(original database on publisher)

C:\SOPHO Messenger@Net\Mdb\Messenger_CFG.mdbat publisher

• (transferred as XML images through HTTP)



NN43120-301 02.01

4 June 2010


92 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.mdbat

subscriber

Figure 92

Sample SQL script

.

Use this (optional) SQL script to modify the contents of the database, as arrived from the operational publisher system. In some environments no changes are required; in more demanding customer environments complex scenarios can be set up to allow applying changes to the database. This can include changing .COM ports, IP address, group members, and so on.

Review your SQL changes carefully.

Switch back

When Publisher or Subscribers detect a change in the availability image, a switch to another environment – or switch-back to the original environment

– can be appropriate.



NN43120-301 02.01

4 June 2010


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. Changes applied to eKERNEL must be synchronized, and (automatic) database upgrade changes to Messenger_CFG.MDB must be handled manually by the system administrator.

Finally, note that configuration changes with eCONFIG, eGRID, eWEB, or another configuration tool can affect the total environment. For example, a divert to another device does not work in a backup environment if the destination device in not available, or the module is unavailable.

Therefore, due to the nature of such an architecture, and maintenance issues and customer specific factors that are beyond our control, the authors of eTH_HA cannot accept responsibility for malfunction of the software.

.



NN43120-301 02.01

4 June 2010


94 Module - eTM_HA

.



NN43120-301 02.01

4 June 2010


.

.

Module - eVBVOICE

ATTENTION




• eFR

• eLICENSE

• eLOCATION

• eSMS

• eSNMP

• eVBVOICE


Introduction

Within every eVBVOICE application there are two different call types.

• Inbound calls

In an inbound call where the user dials a specific number related to the eVBVOICE application, messages can be set (*SET), reset (*RESET), and confirmed (*CONFIRM). You can also record (*RECORD) wave files related on a specific menu option or recording general wave files.

• Outbound calls

The eVBVOICE application can set up a call to a device and play a wave file linked to a specific alarm. The eVBVOICE application is used to inform the device of a user that a specific alarm is activated. The alarm is audio and not visual.

95



NN43120-301 02.01

4 June 2010


96 Module - eVBVOICE

Figure 93 eVBVOICE inbound call

Figure 94 eVBVOICE outbound call

.



NN43120-301 02.01

4 June 2010


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. The menu options are described in the following configuration tables. All menu selections are generated with

DTMF keystrokes, and every option must be terminated by the pound (#) key.

Figure 96

Menu option level 1

.



NN43120-301 02.01

4 June 2010



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.

There are 4 different types of menu options possible for eVBVM_L1_M enu_Type_str =

•

*CONFIRM

• *SET

• *RESET

•

*RECORD

CONFIRM For menu type = *CONFIRM for confirmation of alarms, there are no entries possible in the eVBVOICE_MENU_L2 table.

With the eVBVOICE application, users can confirm messages with a personal pincode (DEV_PinCode_str in eKernel_device).



NN43120-301 02.01

4 June 2010


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).

The eKernel application checks the database for the devices related to this pincode, and informs the eVBVOICE application of the number of devices.

If the pincode is unknown in the database, the "WrongPincode message"

(eVBV_WrongPincode_str) plays.

If there are no alarms active for this pincode, the user hears a message that no messages are active for this pincode (VBV_Nomess_str).

If the confirmation is successful, all the active alarms for all the devices related to this pincode are cleared. The wave file entered in the eVBV_Confirm_str field plays.

If a wave file entered in the configuration tables does not exist, the wave file entered in the eVBV_NoWavFile_str field plays.

It is not possible to confirm an alarm during an outbound call in the current release. When a person receives a message through eVBVOICE, for example a call at home, the user cannot confirm the alarm or alarms during the same call. In the current release you must make a new call, particularly to confirm alarms.

SET and RESET For menu type (eVBVM_L1_Menu_Type_str) = *SET and *RESET (set and reset of alarms), a link to the eVBVOICE_MENU_L2 table is necessary.

Menu option level 2

SET and RESET For menu types *SET and *RESET, the related alarms must be specified in the eVBVOICE_MENU_L2 table.

.



NN43120-301 02.01

4 June 2010



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.



NN43120-301 02.01

4 June 2010


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. For example, when a user selects option 9 (see configuration in the Menu L1 table), the user who records the wave file enters the menu option L1 and terminates with the # key. For recording wave files specified in menu L2 table, the user enters option L1, enters a * (as a separator between menu Level 1 and menu Level 2), enters option L2, and terminates by #.

Figure 100 eVBVOICE_Menu_L1

.



NN43120-301 02.01

4 June 2010



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.

.



NN43120-301 02.01

4 June 2010



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.wav

.



NN43120-301 02.01

4 June 2010



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.

Figure 104 eVBVOICE Outbound calls

.

Note: The keystroke you enter to ensure messages are delivered does not confirm an alarm. If you want to confirm an alarm, you must call the eVBVOICE application and enter your pincode to confirm the active alarms.

ATTENTION

It is very important that you link all possible alarms with a wave file in the eKernel_Message_format table. If there is an alarm which must be sent to a eVBVOICE device, a wave file related to this alarm id must be defined in the eKernel_Message_Format table. If you do not define the wave file, the alarm is not processed.

If the wave file defined in the eKernel_message_format table does not exist, the eVBVOICE application always returns a ‘NACK^NOWAV’ return code to the eKernel application. A ‘NACK^NOWAV’ return code means that the end user never receives the alarm or alarms. After x retries (see DEV_Retry_count_ALT_DEV_id_n field in the eKernel_device



NN43120-301 02.01

4 June 2010


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.File Settings

The vbv4.ini file is by default located in the c:\winnt directory.

Note: Ini Settings use both upper and lower case for readability.

However the entry in the file is not case-sensitive. Voicecard-related settings are documented in the Hardware Installation manual, and in the online help.

[Conference]

Figure 105

Ini settings - Conference

.

[DataFind]

Figure 106

Ini settings - DataFind

[Dialogic]

Voicecard-related settings are documented in the Hardware Installation manual and in the online help.

[Directories]



NN43120-301 02.01

4 June 2010


.


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.

• english 0x1

• usegender 0x4

• useordinalforfirstofmonthonly 0x100

• singularpluralhundred 0x102 - special version of "hundred" singular hundred and plural hundreds

• useitaliangender 0x40 - always use male one if saying 81 or 101 or something

• usethouforyear 0x80 - french say one thou, nine hundred, and so on, for year

• useofyear 0x200 - spanish say of between month and year

• dontuseordinalsfordays 0x400 - spanish

• usehundredgender 0x800 - not used

• usehoursandminutes 0x1000 - spanish - say 12 and 30 for 12.30

• fullordinal 0x2000

• usegenderhundreds 0x4000 - spanish - only works if full or fullordinal, or full and fullordinal

• usegender_twentyonethirtyone 0x8000 - spanish

• femalemoney 0x10000

• sayzeroinminslessthan10 0x20000

• japaneseflag 0x40000

• polishflag 0x80000



NN43120-301 02.01

4 June 2010



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]



NN43120-301 02.01

4 June 2010



Figure 111

Ini settings - Logs

Figure 112

Ini settings - PBX

[PBX]

.

[PlayMsgs]

Figure 113

Ini settings - PlayMsgs

[Record]



NN43120-301 02.01

4 June 2010


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]



NN43120-301 02.01

4 June 2010




Figure 117

Ini settings - System

[VoiceCard]

“VBV4.INI Hardware-specific settings” (page 111)

Figure 118

Ini settings - VoiceCard

.



NN43120-301 02.01

4 June 2010



.

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]



NN43120-301 02.01

4 June 2010



Figure 119

Ini settings - AccuCall

[Dialogic]

Figure 120

Ini settings - Dialogic

[Rhetorex]

Figure 121

Ini settings - Rhetorex

[Voicecard] - (ACULAB specific settings)

.



NN43120-301 02.01

4 June 2010


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. The values can be "00", "01", "10" or

"11", where 00 means look for both A and B bits off, 01 means look for A bit off, B bit on, and so on.

Valid values for t1hookflash_start and t1hookflash_end are as follows:



NN43120-301 02.01

4 June 2010



• 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.

The difference between t1ringing and t1idle is used to test for incoming ring indication in the same way. Loopstart overrides the t1answer settings to monitor B-bit changes only, and forces the other settings to use the following values.

• t1idle = 01

• t1ringing = 00

• t1hangup = 00 (no change)

• t1hookflash = 01

Figure 124

Ini settings - [Voicecard] (Dialogic T1 specific settings)

.

VBVoice uses the following events to determine start and end of an incoming call.

Figure 125

VBVoice events to start and end an incoming call

[Voicecard] - Rhetorex specific settings



NN43120-301 02.01

4 June 2010



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.4 a Pronexus VbvConfig tool is installed for maintenance of the VBV4.ini file. See the following figure.

.



NN43120-301 02.01

4 June 2010



Figure 128 vbvConfig tool - Voicecard

Figure 129 vbvConfig - System

.



NN43120-301 02.01

4 June 2010


.

117

.

Module - eVBVOICE AHVR

ATTENTION




• eFR

• eLICENSE

• eLOCATION

• eSMS

• eSNMP

• eVBVOICE


Introduction

With the current eVBVoice module, you can generate, confirm, and reset an alarm.

When an alarm is set, a pre-recorded message can be distributed to a number of recipients using Ad Hoc Voice Recording (AHVR).

You can use eVBVOICE AHVR to perform the following actions.

• Generate an alarm

•

Record a specific alarm message

• Distribute the ad hoc recorded message

The eVBVoice module operates basically as before the addition of AVHR.

You SET an alarm in the same way as before AVHR,, using the 2 level menu structure. However, you can only record a message after you



NN43120-301 02.01

4 June 2010


118 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. See the following figure

.



NN43120-301 02.01

4 June 2010


Figure 131

Level 2 - Define alarm ID and group

Configuration 119

Figure 132

RECORD

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.

.



NN43120-301 02.01

4 June 2010


120 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.

Your goal is to add ad hoc voice messages to the reanimation alarms.

The IVR menu could look like the following figure.



NN43120-301 02.01

4 June 2010


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. The voice messages are not automatically removed. For this reason Nortel suggests that you manually remove old and handled message from time to time.

.



NN43120-301 02.01

4 June 2010


122 Module - eVBVOICE AHVR

.



NN43120-301 02.01

4 June 2010


.

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

123

.

Sign-on procedure

A sign-on is required; because you are not yet authenticated to the application, this window is presented in English.



NN43120-301 02.01

4 June 2010


124 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)


When a valid user and password is found, you are able to continue working in the eWEB module.

It is important to know that during the sign on procedure, two additional parameters are fetched: the language code and the security level.

The language code determines the language of the forms that are presented to the user. If for example the language code is 2909 – Belgian

English, the panels are in English. If the language code is 2963 – Belgian

Dutch, the panels are in Dutch.

The security level determines the table-of-contents options that are presented to the user. A user with a limited security level has only a small number of options available, whereas a user with a high security level has many options available. Refer to the documentation of

“Table: eWEB_TOC” (page 433)

for more information on the table-of-contents mechanism.



NN43120-301 02.01

4 June 2010


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.

Figure 139 eWEB main window

.

Sign-off procedure

To log off, choose the last option in the list on the left side of the window,

Sign off. You are also automatically logged off when either of the following occurs:

•

Twelve hours elapse after initial sign-on.

• You leave the eWEB web site, for instance by selecting another URL in the address field of your browser or selecting another web site through

Favorites, Home, Back, and so on.

Figure 140 "Expired login" (page 126)

shows an expired state, requiring a new logon.



NN43120-301 02.01

4 June 2010


126 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

.



NN43120-301 02.01

4 June 2010


.

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.

Therefore, it lists only those devices that are defined for that same site and area. In a multi-area environment, you can access the devices that belong to another area. You can assign these remote area devices on device level in the eKERNEL_DEVICE table, where the DEV_Ras_Area_b value must be set to True.

Figure 142 "Local extensions" (page 127)

shows the list of extensions that all reside locally on the same site and area.

Figure 142

Local extensions

Figure 143 "Local and remote extensions" (page 127)

shows the list of extensions that all reside locally on the same site and area, but also displays an extension that resides on another area, which is made available through the DEC_Ras_Area_b value in the eKERNEL_DEVICE table.

Figure 143

Local and remote extensions

Note: The Send DMS-API Message form always contacts that local

DMS-API Service of the same site and area as the Apache Web Server.

In a multi-area environment, where there are possible multiple eDMSAPI applications defined, the local DMS-API service contacts all peripherals.



NN43120-301 02.01

4 June 2010


128 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) .

Figure 144

Send SMTP Message

.

This function allows the user to send a message to a mail address destination, by means of an SMTP connection between the Apache

Web Server and the SMTP server of the mail server. In this process, no eKERNEL activity takes place, because the transaction is executed directly.

The list of available addresses is limited to the devices that are defined in eKERNEL_DEVICE table, and defined for the same site and area as the eWEB application, and with output program eSMTP.

You can also make devices that are allocated to a remote area available through the DEV_Ras_Area_b value in the eKERNEL_DEVICE table. An example is shown in

Figure 145 "Sending messages to remote addresses"

(page 129)

:



NN43120-301 02.01

4 June 2010


Figure 145

Sending messages to remote addresses

Send Server Message 129

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. As a result, when the destination user replies to the mail, the reply arrives in the correct mailbox of the sender.

Send Server Message

The Send Server Message window is shown in

Figure 146 "Send Server

Message" (page 129) .

Figure 146

Send Server Message

.

Send Server Message is a function that communicates to the eKERNEL module.



NN43120-301 02.01

4 June 2010


130 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.

Because Send Server Message communicates with eKERNEL, a number of configuration actions are required. One of them is specifying alarm identifiers in the eKERNEL_ALARM table, for the input program that is assigned to the eWEB instance. At this time, you can define for instance alarm types with different lengths (for example, short messages of 8 bytes, medium messages of 16 bytes and long messages of 32 bytes).

ATTENTION

Because the Send Server Message is designed only to set a message, and cannot reset a message, you must always specify remove after *SENT in the eKERNEL_ALARM table, otherwise the message remains active forever.

In the example shown in

Figure 147 "Alarm types" (page 130) , you

can choose between three alarm types, which are defined in the eKERNEL_ALARM table.

Figure 147

Alarm types

.

ATTENTION

You can only access alarm types in the eKERNEL_ALARM table with field

ALA_Trace_b equal to False. While assigning alarm types, always make a distinction between alarms for Send Server Message (False) and Send Script

Message (True).

The destination of the message is also defined in the database. The eWEB module has an input program identifier, and one or more alarm definitions. For the same input program, you also must predefine the group, group members and group authorities in the corresponding tables eKERNEL_GROUP, eKERNEL_GROUP_MEMBER and eKERNEL_GROUP_AUTH.



NN43120-301 02.01

4 June 2010


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). Another issue can arise if a group is configured in such way that, due to the definitions in eKERNEL_GROUP_MEMBER, no one is active in the group, based upon hour, day, holiday and activation interval issues.

eWEB users must be aware of these possibilities.

In the sample shown in

Figure 148 "Group list" (page 131)

, six groups are defined (it is advisable to use more descriptive group names than those shown in the example).

Figure 148

Group list

Send Group Message

The Send Group Message window is shown in

Figure 149 "Send Group

Message" (page 132) :

.



NN43120-301 02.01

4 June 2010


132 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.

Figure 150

Select a group

.



NN43120-301 02.01

4 June 2010


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.


Figure 151 "Select a message" (page 133) , the

administrator has configured four private messages, one fixed message and one user-specified message:

Figure 151

Select a message

Finally, you can send the request to eKERNEL and submit the request for further processing. The example shown in

Figure 152 "Confirm and send message" (page 133)

shows a situation in which a user-defined message has been selected, so you must enter the message text manually.

Figure 152

Confirm and send message

.

The Send Group Message completed normally message indicates the message has been submitted to eKERNEL. Final message delivery depends on a number of factors and are beyond control of the eWEB user.



NN43120-301 02.01

4 June 2010


134 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.

Click the arrow to select the group.

.



NN43120-301 02.01

4 June 2010


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.


Figure 155 "Select a message" (page 135) , the

administrator has configured four private messages, six fixed messages, and a user-defined message.

Figure 155

Select a message

Finally you can send the request to eKERNEL and submit the request for further processing. Note that the example in

Figure 156 "Confirm your choices" (page 136)

shows a fixed message and therefore message text need not be entered.

.



NN43120-301 02.01

4 June 2010


136 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)

.

Figure 157

Send script message

.

You can choose from the following sub-functions:



NN43120-301 02.01

4 June 2010


Send Script Message 137

• 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.

•

Trace ended Script is used to see an overview of these scripts that are completed.

For more information, refer to:

•

“Table: eWEB_SCRIPT” (page 415)

•

“Table: eWEB_SCRIPT_SET_AUTH” (page 419)

•

“Table: eWEB_SCRIPT_TRACE_AUTH” (page 421)

•

“Table: eWEB_SCRIPT_CANCEL_AUTH” (page 423)

Set Script

Choose Set Script to browse an overview of defined scripts, as shown in

Figure 158 "Overview of defined scripts" (page 137)

. A green or red icon indicates if the eWEB user is authorized to activate the script. The window also shows additional information; as follows:

• The identifier of the group.

• The message that is sent to the group members.

•

The current number of instances of the script currently active.

• The maximum number of instances of the script that can be active.

The illustration in

Figure 158 "Overview of defined scripts" (page

137)

shows that the current user is authorized to set the first seven scripts, but not authorized for the last script. No script is currently active.

Figure 158

Overview of defined scripts

.



NN43120-301 02.01

4 June 2010


138 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.

Figure 159

Script details

Trace Active Script

Use Trace Active Script, shown in

Figure 160 "Trace active script" (page

138)

, to monitor the event handling of scripts that are active.

Figure 160

Trace active script

.

Cancel Script

Use Cancel Script to abort an active script.

Figure 161 "Cancel script"

(page 138)

shows one active script.

Figure 161

Cancel script



NN43120-301 02.01

4 June 2010


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.

Figure 163

Trace Ended Script

Alarm Inquiry

Alarm Inquiry allows you to see all relevant parameters for the eKERNEL_ALARM file as shown in

Figure 164 "Alarm inquiry" (page 140)

.

Only those records are shown that refer to the site where the current eWEB instance resides.

The information is retrieved from two tables: eKERNEL_ALARM and eKERNEL_INPGM. You can either display data for all input programs (by specifying *ALL) or select one input program.

.



NN43120-301 02.01

4 June 2010


140 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.

.



NN43120-301 02.01

4 June 2010


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.

.



NN43120-301 02.01

4 June 2010


142 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) .

.



NN43120-301 02.01

4 June 2010


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.

In step 1, shown in

Figure 168 "Select a group" (page 143) , select a

group. You can collapse or expand a group to preview the group member information.

Figure 168

Select a group

.



NN43120-301 02.01

4 June 2010


144 Module - eWEB

Figure 169

Select a device

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).

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. The example shown in

Figure 170 "Confirm changes" (page 145)

defines the extension

865 to be available on working days only between 8:30 and 12:00. Note that the record is disabled on Saturdays, Sundays and holidays.

ATTENTION

The last two fields (Activate definition and Deactivate definition) allow you to specify an interval during which the record is active. In the example shown in

Figure 170 "Confirm changes" (page 145) , the record is active from January 1,

2001 at 00:00 until December 31, 23:59. This functionality allows administrators and power users with group maintenance rights to predefine schedules that are activated and deactivated automatically. This functionality can add flexibility in your group maintenance in handling holiday planning, staff schedules, and so on.

.



NN43120-301 02.01

4 June 2010


Change Password 145

Figure 170

Confirm changes

Figure 171

Select new device

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.

.

Note: You can access only the devices that belong to the same site as used by the eWEB module.

Figure 171 "Select new device" (page

145)

shows devices of site 3 because, in this example, eWEB is running in site 3 – area 1.

Change Password

Change Password allows you to enter a new password. You must enter:

• your User ID

• your old password



NN43120-301 02.01

4 June 2010


146 Module - eWEB

Figure 172

Change password

• your new password

• your new password (for verification)

This option eliminates the need for an eGRID-based administration of passwords of existing user profiles.

.

Info

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.

The Info page provides web-based access to Adobe Portable Document

Format (.PDF) files. The eWEB user must install on their desktop PC a suitable Adobe Acrobat Reader to open the .PDF files.

A .PDF reader is shipped on the CD-ROM, but if you can access the

Internet, Nortel recommends you download the software from the Adobe web site.

There are .PDF files that handle installation issues, others that provide information on table configuration issues, and others that are more module functional.



NN43120-301 02.01

4 June 2010


Figure 173

Info: more documentation

Plug-in Support 147

.

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. In many situations, users who leave their browser unattended can be held personally responsible for actions that are taken with their authenticated session.

Plug-in Support

The DECT MessengereWEB module allows embedding plug-in modules that add additional functionality to the web interface. The plug-in modules can be integrated easily through the standard eWEB_TOC table. This is illustrated in

Figure 174 "Plug-ins added to eWEB" (page 148) ,

where additional table-of-contents entries are added for the plug-in

MyPortal@Net.



NN43120-301 02.01

4 June 2010


148 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. Other databases can be accessed as well through OLE/DB, ADO or sockets.

Figure 175

MyPortal@Net plug-in

.

The module uses native CSTA.DLL interfacing to handle voice-calls.

This option is currently not supported. Contact Nortel for to find out if plug-in models are available.



NN43120-301 02.01

4 June 2010


149

.

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.

To log on to Web Administrator, refer to

Procedure 8 “Logging on to Web

Administrator” (page 149)

Procedure 8

Logging on to Web Administrator

Action Step

1 To start the web interface, enter the URL: http://messenger/ez_i ndex.php in Internet Explorer.

The login page is shown in

Figure 176 "Web Administrator login page" (page 150)

.



NN43120-301 02.01

4 June 2010


150 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)

.

.



NN43120-301 02.01

4 June 2010


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)

.

.



NN43120-301 02.01

4 June 2010


152 Module - Web Administrator

Figure 178

Work with Users in Web Administrator

.



NN43120-301 02.01

4 June 2010


.

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) .

This example URL applies to a Messenger@Net system that has the name messenger, and the host name messenger is a known host name in the network (such as through a DNS Server). Your administrator can optionally provide you a different URL, which can contain another host name or can consist of an IP address instead of a host name. Nortel recommends adding the URL to your favorites.

153

.



NN43120-301 02.01

4 June 2010


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.

.



NN43120-301 02.01

4 June 2010


Figure 180

Navigation pane for Administrator user

Authorization level 155

DECT Messenger offers five levels of user authority, as described in

<CR>.

Table 5

User authorization levels

Functionality Authorization level

User (basic)

•

Send a Message

— DECT handset

— Mobile phone

— Email

— Windows

•

Security

•

Logout

.



NN43120-301 02.01

4 June 2010


.



User (advanced)


User (expert)

Functionality

•

Send a Message

— DECT handset

— Mobile phone

— Email

— Windows

— Group Message

— User Message

•

Security

•

Logout

Functionality

•

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

– Overview

•

Security

— Change password

•

Logout



NN43120-301 02.01

4 June 2010



Supervisor


Functionality

•

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


– Overview

•

Security

— Change password

•

Logout

.



NN43120-301 02.01

4 June 2010


.



Administrator

Functionality

•

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


– Overview

— Advanced

– Devices

– Facilities

– Groups

– Users

— Expert

– Tasks

– Configuration

– PHP Info

– Import

•

Security



NN43120-301 02.01

4 June 2010


— 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.

Procedure 9

Logging in to Web Administrator

Action Step

1 Open the your web browser, and in the Address field, enter the URL where Web Administrator is installed, for example: http://messenger/ez_index.php

The Login page appears.

.



NN43120-301 02.01

4 June 2010



.

2

3

4

In the User field, enter the user name provided by your administrator.

In the Password field, enter the password provided by your administrator.

The password appears as a series of asterisks (*).

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.

--End--

The Web Administrator page

The top part of the left pane of the Web Administrator page shows graphics or images that are related to the environment or the functionality that appears on the page. When you select an option in Web Administrator the graphic changes to represent the selected function.



NN43120-301 02.01

4 June 2010


.


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.

The contents of the right pane vary depending on the function you select in the navigation pane.

Log out

To log out of Web Administrator, click Logout in the navigation pane.

Nortel recommends that you log out whenever you leave your computer unattended.

Send a message

When the Send a Message section appears in the navigation pane, you can send a message to one or more of the following, depending on what modules are available, and how the system is configured:

• DECT handset

•

Mobile phone

• Email

• Windows

•

Group Message

• User Message

When all DECT peripherals are considered one logical group, links are organized into a tree that is two levels deep: Send a Message > DECT

handset.

In some larger environments with more than one PBX, DECT peripherals are organized depending on the PBX they are registered too. In such an environment, links are organized into a tree that is two levels deep: Send

a Message > DECT handset > Area.

This would be the case in a environment with two areas; the DECT handsets from one campus can be logically assigned in one area, and the

DECT handsets from another campus can be logically assigned in another area. An example of such a multi-area environment is shown in

Figure 181

"A multi-site environment" (page 162)

. In this example, the DECT handset



NN43120-301 02.01

4 June 2010


162 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.

1

2

Procedure 10

Sending a message to a DECT handset

Step Action

Log in to Web Administrator.

In the navigation menu, click DECT handset.

OR

If multiple areas are defined, click the name of the area, then click DECT handset.



NN43120-301 02.01

4 June 2010



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. If you enter subset criteria, only matching records are retrieved. You can click [clear] to clear the subset criteria.

3 Select a recipient by clicking the green arrow at the left of the entry.



NN43120-301 02.01

4 June 2010



The Send a Message > Please enter message information page appears.

.

4 Enter the text of your message in the Message field.

5

The length of the message you can enter is displayed in the field to the right of the Message field.

Use the Priority menu to assign a priority to the message, where the priority is one of Normal, Urgent, or Emergency.



NN43120-301 02.01

4 June 2010


.


6 Click Submit.

Web Administrator indicates whether the message delivery succeeded or failed.

--End--

Table 6

Job aid: maximum message length

System traditional DECT

SIP DECT

Maximum length of message up to 48 characters up to 160 characters

Table 7

Job aid: message priorities

Priority

Normal

Behavior

The system verifies delivery of the message without requesting confirmation from the recipient. If the message is successfully delivered,

Web Administrator displays the result within a few seconds. If the message cannot be delivered, a longer delay occurs before Web

Administrator displays the result.

Urgent

Emergency

The system waits until the message is delivered, and confirmed by the recipient before Web Administrator displays the result. The recipient has 30 seconds in which to confirm receipt. During this time, the Web

Administrator page is nonresponsive.

The Emergency option is not available in some system configurations, and in some configurations where it is available, Emergency messages are handled in the same way as Urgent messages. Consult you system administrator for more information about the priorities that are available for your use.

Web Administrator reports whether the message was delivered successfully. If a Normal message cannot be delivered, or if an Urgent or Emergency message either cannot be delivered, or is not confirmed by the recipient, the following message appears: Error. Send message ended

abnormally.



NN43120-301 02.01

4 June 2010



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.

1

2

Procedure 11

Sending a message to a mobile phone

Step Action


In the navigation menu, click Mobile phone.

OR

If multiple areas are defined, click the name of the area, then click Mobile phone.

The Send a Message page appears, appears, on which appears a list of mobile phones 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 phones listed, click [pgdn] or



NN43120-301 02.01

4 June 2010




3 Select a recipient by clicking the green arrow at the left of the entry.



.



NN43120-301 02.01

4 June 2010



5


Click Submit.


--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.

Send a message to an e-mail address

You can send messages to e-mail addresses only if the eSMTP module is installed, licensed, and configured on the system, and can send e-mail messages only to e-mail addresses that are configured in the system by the administrator.

1

2

Procedure 12

Sending a message to an e-mail address

Step Action


In the navigation menu, click Email ,

OR

If multiple areas are defined, click the name of the area, then click Email.

The Send a Message page appears.

.



NN43120-301 02.01

4 June 2010



3

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


Select a recipient by clicking the green arrow at the left of the entry.


.



NN43120-301 02.01

4 June 2010



.


5


Click Submit.


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.

--End--



NN43120-301 02.01

4 June 2010



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.

1

2

Procedure 13

Sending a message using Group message

Step Action


In the navigation menu, click Group message.

OR

If multiple areas are defined, click the name of the area, then click Group message.

The Send Group Message > Please select group page appears.

.

3 Select the group to which to send a message.

The Send Group Message > Please confirm group page appears. This page lists the group members.



NN43120-301 02.01

4 June 2010



4

If you select the wrong group, click back to select a different group.

Click continue to confirm the group selection.

The Send Group Message > Please select message page appears.

.



NN43120-301 02.01

4 June 2010



.

5

6

Up to three types of messages are supported, depending on your system configuration:

• Private messages

• Shared messages

• Free messages

Select the message to send by clicking the green arrow next to it. If you select Free message, type the text of your message.

Click Submit.


--End--

Table 8

Job aid: Group message types

Type Description

Private messages Are messages, defined by your system administrator, that you can send only to the selected group.



NN43120-301 02.01

4 June 2010




Shared messages

Free messages

Are messages, defined by your system administrator, that you can send to any group.

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.

1

2

Procedure 14

Sending a message using User message

Step Action


In the navigation menu, click User message.

OR

If multiple areas are defined, click the name of the area, then click User message.

The Send User Message > Please select group page appears.

.



NN43120-301 02.01

4 June 2010


3


Select the group to which to send a message.

The Send User Message > Please confirm group page appears.

This page lists the group members.

4

If you select the wrong group, back to select a different group.

Click continue to confirm the group selection.

The Send User Message > Please select message page appears.

.



NN43120-301 02.01

4 June 2010



.

5

6

Up to three types of messages are supported, depending on your system configuration:

• Private messages

• Shared messages

• Free messages

Select the message to send by clicking the green arrow next to it. If you select Free message, type the text of your message.

Click Submit.


--End--

Table 9

Job aid: User message types


Private messages Are messages, defined by your system administrator, that you can send only to the selected group.



NN43120-301 02.01

4 June 2010




Shared messages

Free messages

Are messages, defined by your system administrator, that you can send to any group.

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.

1

2

Procedure 15

Changing your password

Step Action


In the navigation menu, click Change password.

The Change password page appears.

.

3 In the Old password field, enter your existing password.



NN43120-301 02.01

4 June 2010



4

5

If you do not know your existing password, contact your system administrator.

In the New password field, enter your new password.

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.

Reports are generated from the information that is stored in the

Messenger_DATA database, which is an internal repository that temporarily stores active alarms.

Figure 182 "Work with Active Alarms page" (page 179)

shows an overview of the Messenger structure, and enumerates the site, underlying areas and all output modules. Alarms are organized according to output program, and the number of active alarms appears next to each output program.

In the example shown in the figure, eDMSAPI has 2 active alarms and eESPA has 1 active alarm.

.



NN43120-301 02.01

4 June 2010


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)

.

.



NN43120-301 02.01

4 June 2010



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. The [refresh] allows you to take a new snapshot.

Click the green arrow to get additional details on the selected active alarm.

Note: The [reset] link in

Figure 183 "Module details" (page 180)

should only be used by Expert users to provide them with the ability to selectively set an alarm. Alarms are normally set automatically following normal call flow. Prior to release 4.0, removing an alarm can be done only through general Reset all alarms in eKERNEL or through low level database maintenance tools, such as SQL Server 2000 Enterprise

Manager.



NN43120-301 02.01

4 June 2010



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.

You can use the optional eLOG module to access the information provided by Work with Ended alarms.

Note: eLOG is a an add-on module, which you can purchase separately as part of a Premium Package.

The eLOG repository is stored for a configurable number of days.

You choose a date in the first selection screen. The default is the current day.

Figure 184

Work with Ended alarms - First selection screen

.



NN43120-301 02.01

4 June 2010



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.

.



NN43120-301 02.01

4 June 2010


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.

Unlike the functions discussed earlier in this chapter, the Input request,

Output request, and Output response are automatically consolidated.

To access this information, you need the eLOG.

The first page of Work with Report shows a selection box with available dates. The current day is the default.

The following figure shows the second selection box. This selection box shows the available messages for that day, sorted alphabetically. Click a message twice to obtain the requested data.

The message shown in the report is the consolidated result of *INPUT,

*OUTPUT, and *RESPONSE in order of date and time. Expert Users that need to answer inquiries on message arrival and notification can use the report to provide the answers.



NN43120-301 02.01

4 June 2010



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.

Procedure 16

Configuring Work with Group Members

Action Step

1 Select the input module you want to maintain on the first page.

The first page, shown in the following figure, provides a hierarchical overview of the available input modules.



NN43120-301 02.01

4 June 2010



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.



NN43120-301 02.01

4 June 2010



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.



NN43120-301 02.01

4 June 2010



.

4 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.

In the example shown in the next figure, the eSMS peripheral

32473897171 belonging to Francis Missiaen is selected. The



NN43120-301 02.01

4 June 2010


188 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.

Work with Alternative Devices provide a web-based user interface to maintain the internal configuration table eKERNEL_DEVICE_ALT.

Follow the steps in the next procedure to configure alternative devices.



NN43120-301 02.01

4 June 2010



1

2

Procedure 17

Configuring basic alternative devices

Step Action


In the navigation menu, click Work with Alternative Devices.

The Work with alternative devices page appears.

.

3

4

Under Configuration > Basic, click Alternative devices.

The page Please select output module appears.

Select an output program.

Peripherals are associated to output programs and therefore,

Mobile phones resides under an instance of the eSMS module, and DECT handsets resides under an instance of eDMSAPI.

In the example shown in the following figure, an alternative device for a Windows PC is required. The output module eNET is selected.

The objective in the example is to define an alternative device so that if a message cannot be delivered using eNET, if for example portable PC is not online, the message is rerouted to a mobile

GSM phone.



NN43120-301 02.01

4 June 2010



.

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.

The top-left-hand area of the page gives details on the selected device are shown as well as the available alternative devices.

When no alternative devices are present, (none) is shown.

The top-right-hand area shows all available devices. You can use the subset criteria to limit the list according to selection criteria.

The bottom of the page shows details that vary according to the options you choose in the other areas of the page.



NN43120-301 02.01

4 June 2010



.

7

8

6 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.

If you want to add the name of an alternative device, type the name you want to add in the [subset] field under the section on the right called Click on device to add alternative device.

Click on [subset].

In the example shown in the following figure, another option is illustrated; restricting the available devices. In the right hand section of the page, under [subset], Francis is typed and then

[subset] is clicked. The mobile phone of Francis Missiaen appears after clicking on eSMS.



NN43120-301 02.01

4 June 2010



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.

You can select a group, check the group members, and check the alternative devices with Overview. Overview basically responds to the question: "What happens to my alarms?"

Follow the steps in the next procedure to configure basic overview.



NN43120-301 02.01

4 June 2010



Procedure 18

Configuring basic overview

Action Step

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.

Figure 188

Alarms that originate on eWEB addressed to group ENET

.

The contents of the selected group appear as a result of alarms that originate in the eWEB input module and addressed to group ENET.

In the example, there appears to be one group member, the Device

1.1.eNET.BENB121027. One attempt (1x) is made to notify the device.



NN43120-301 02.01

4 June 2010



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.

Reporting is extended with Scripts, with access to link Active scripts and

Ended scripts.

.



NN43120-301 02.01

4 June 2010


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

Action Step

1 Open Work with Scripts and click Active script.

You can only access Activate Script in this manner and it is only available if the administrator defined scripts in the internal table eWEB_SCRIPT.

.



NN43120-301 02.01

4 June 2010



.

2

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.

Click on one of the configured scripts to select that script.

The next window shows a preview of the script.

In the top section, details are visible on the script, such as message and group and current user.

The bottom section shows the group members belonging to the selected group.



NN43120-301 02.01

4 June 2010



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

4

Click [submit] to activate the script.

You then return to the main window.

Click [refresh] to see an update of the available scripts.

In the example in the following figure, the script is activated once. In the example configuration, the script can be activated ten time, as shown in the 1x/10x indicator.

.



NN43120-301 02.01

4 June 2010



--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.

In the example shown in the figure below, one active script is available.

.



NN43120-301 02.01

4 June 2010



.

2

3

Ensure that the script you end is the correct active script. Verify the date and time and description.

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.



NN43120-301 02.01

4 June 2010



.

--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.

1

2

Procedure 21

Reporting active scripts

Step Action

From the Reporting window, click Scripts.

Click Active scripts.

When no scripts are active, the window in the next figure appears.



NN43120-301 02.01

4 June 2010



3 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.



NN43120-301 02.01

4 June 2010



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. *PENDING indicates where notification is still in progress, *ACK indicates those who have responded, and *NACK indicates those who failed to respond.

.

--End--

Reporting ended scripts

The function Reporting ended scripts is available to Supervisor and

Administrator.



NN43120-301 02.01

4 June 2010



Follow the steps in the next procedure to report ended scripts.

Procedure 22

Reporting ended scripts

Step

1

2

Action

Open the Reporting window and click Scripts.

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

4

Use the date and time criteria to identify the script.

Click on the Script of your choice from the list presented to narrow down the details of the ended script.



NN43120-301 02.01

4 June 2010



--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.

.



NN43120-301 02.01

4 June 2010


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.1 is reserved by UCPS division.

.



NN43120-301 02.01

4 June 2010



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

.



NN43120-301 02.01

4 June 2010



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.

Configuration of advanced facilities

The configuration of advance facilities function is available to

Administrator.

Follow the steps in the next procedure to configure advanced facilities.

1

2

Procedure 23

Configuring advanced facilities

Step Action

Open the Configuration window and click on Advanced.

Click on Facilities.

.



NN43120-301 02.01

4 June 2010



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.



NN43120-301 02.01

4 June 2010



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.

.



NN43120-301 02.01

4 June 2010



4

5

6

When no definitions are available, an empty screen appears.

Use the [home], [pgup], and [pgdn] links to navigate through the list of definitions.

Click the [insert] link to add a new definition.

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.

.



NN43120-301 02.01

4 June 2010



.

7

8

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. Future releases may implement a disabled [delete] link when a definition is in use.

Click the [edit] to alter some (non-key) fields. .

Note: The name of the definition cannot be changed. You need to [insert] a new definition if you want another Facility name.

In the example in the following figure, the [edit] link was clicked for definition C944.



NN43120-301 02.01

4 June 2010



.

9

10

Click [apply] to adjust the values.

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.

1

2

3

Procedure 24

Configuring advanced devices

Step Action

Open the Configuration window and click Advanced.

Click Devices.

Define at least one Facility before you create a device.

In order to create Devices for an output module, you need definitions of Facilities. For example, if you want to add an



NN43120-301 02.01

4 June 2010


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.

.

4

5

6

7

In the example in the next figure, a DECT handset is added.

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. When no definitions are available, an empty screen is shown.

Use the [home], [pgup], and [pgdn] links to navigate through the list of definitions.

To add a new definition, click the [insert] link.

To change an existing definition, click the green arrow.

Note that a Device is considered a unique key, so for example, if you define 865 once, you cannot add a second 865 definition.

The next figure illustrates the addition of a new device. To add a new device, you click on [insert].



NN43120-301 02.01

4 June 2010



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.

.



NN43120-301 02.01

4 June 2010



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. A value of Yes is used, for example, in combination with the eLOCATION module to generate location alarms. This also requires additional licenses.

The Remote access support site and Remote access support

(area) are available for backwards compatibility with eWEB module, but are not implemented in Web Administrator. Nortel recommends that you leave the default setting of No.

.



NN43120-301 02.01

4 June 2010



.

9

10

11

Type [apply] to insert the definition.

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.

To maintain an existing device, click the green arrow in front of an existing definition.

12

13

Click [edit] to maintain the record.

Click [delete] to remove a record.

In the example in the following figure, [edit] is clicked to maintain details of selected device 865. Note that some fields cannot be altered. If you want to alter some fields, you must recreate the device.



NN43120-301 02.01

4 June 2010



.

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. In future release additional in use checks are to be implemented to prevent deleting devices that are defined on another level.

When you click [edit], some (non-key) fields can be altered.

Note: The name of the definition cannot be changed. You need to [insert] a new definition if you want another Device name.

In the example in the following figure, [edit] is clicked for definition 865. You can adjust the values and click [apply]. If you click [cancel] any changed are ignored.

--End--



NN43120-301 02.01

4 June 2010



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.

1

2

Procedure 25

Configuring advanced groups

Step Action

Open the Configuration window and click Advanced.

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.

In the example in the following figure, several input modules are available. In the example, groups are maintained for the input module eAPI residing in site 1 and area 1. This instance of the input module is selected.



NN43120-301 02.01

4 June 2010



3

4

5

Next an overview of existing groups for the chosen input module is shown.

Use [home], [pgup], and [pgdn] to navigate through the list of definitions.

To add a new definition, click [insert].


Note: A Group is considered a unique key, so for example if you have defined 00001 once, you cannot add a second

00001 definition.

In the next figure, there is an existing group 00001 and a new group to be added, 00002 by clicking [insert].

.



NN43120-301 02.01

4 June 2010



The next figure has the details of group 00002.

.

6

Nortel highly recommends that you add a meaningful

Description, as this is represented to the Web Administrator during further maintenance.

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.



NN43120-301 02.01

4 June 2010



The detailed screen shows the selected definition.

7

8

Click [edit] to alter a number of input capable fields.

Enter changes, then click [apply].

9 To delete an existing definition, select the group and click

[delete].

.



NN43120-301 02.01

4 June 2010



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.

•

The group can be defined elsewhere in the business logic of the Messenger configuration, for example, associated with definitions such as tables related to eIO (eIO_DI, eIO_DO, eIO_AI, and so on), related to eLOCATION, inbound eCSTA, eDMSAPI, and so on.

The verification of usage of a group is the responsibility of the administrator.

--End--

Configuration of advanced users

The Configuration of advanced users function is available to Administrator.

Follow the steps in the next procedure to configure advanced users.

1

2

Procedure 26

Configuring advanced users

Step Action

Open the Configuration menu and click Advanced.

Click Users.

.



NN43120-301 02.01

4 June 2010


3

4

5


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.

On the Work with Users main page, an overview of existing users is shown.

Click the [home], [pgup], and [pgdn] links to navigate through the list of definitions.

Click the [insert] link to add a new definition.


Note: A User is considered a unique key, so for example if you define admin once, you cannot add a second admin definition.

--End--

In the example shown in the next figure, the Administrator wants to add a new user supervisor. The Administrator clicks [insert].

.



NN43120-301 02.01

4 June 2010



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.

You should consider sharing this chapter Module_Web_Administrator

– User Guide with the end-user, as well as providing the end-user with further information.

Note: Nortel highly recommends that you enter the first name and last name in the field description.

The security level is in Web Administrator catalogued into 5 different levels, User (basic), User (advanced), User (expert), Supervisor, and

Administrator.



NN43120-301 02.01

4 June 2010



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. However, these fields are not implemented in Web Administrator. You can leave the default values.

.



NN43120-301 02.01

4 June 2010



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. An empty screen is returned in other environments.

The contents of this view is comparable to what you see in eTM. The list of tasks enumerates the processes that are known in the system and registers as Messenger related tasks.



NN43120-301 02.01

4 June 2010



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. In the overview of modules, there is more focus on the TCP/IP connection status between eKERNEL and clients. As a result, eKERNEL can show more modules than are available in Web Administrator, since, for example eKERNEL can also connect modules that run distributed on a remote

PC. For this reason, the task does not run on the CPU of the Web

Administrator and is not seen in Work with Tasks.

.



NN43120-301 02.01

4 June 2010



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.

.



NN43120-301 02.01

4 June 2010


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

.

.



NN43120-301 02.01

4 June 2010



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.

WARNING

Warning: The Import function replaces the active

Messenger_CFG.MDB configuration database, so all configuration is lost. Only use the Import as part of an initial system setup. When you customize Messenger_CFG.MDB no longer use the Import capabilities, as this results in the loss of all entered configuration data.

Follow the steps in the next procedure to install and configure Export import.



NN43120-301 02.01

4 June 2010



1

2

Procedure 27

Installing and configuring Export import

Step Action

Open the Configuration window and click Expert.

Click Import link.

A window similar to the window in the following figure appears.

The contents and available databases can vary.

.

3

4

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. An error appears if a running instance is detected.

Note: End all Messenger activities and tasks before you import a configuration from the templates repository.

The template 99 is highlighted in the window shown in the following figure.

Click the green arrow in front of the selected configuration to import the configuration.



NN43120-301 02.01

4 June 2010



5

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.

Click [continue] to log off.

To log on again, enter admin password and the default password admin from the template configuration database.

6

7

Change the default password for admin as soon as possible to prevent intrusion by users that attempt to authenticate with admin and admin defaults.

Refer to the chapter DECT Messenger – Templates in volume

1 of this document for further information, such as information related to creating shortcuts.

--End--

Any further configuration is beyond the scope of Web Administrator. Refer to the other documentation for further details on additional configuration steps, using eGRID or eCONFIG.

.



NN43120-301 02.01

4 June 2010


233

.

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.




NN43120-301 02.01

4 June 2010


.

234 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.

For example:

• PAGING (requires the field eASYNC_Provider_str to equal

BELGACOM)

• SMS (requires the field eASYNC_Provider_str to equal PROXIMUS)

•

SMS (requires the field eASYNC_Provider_str to equal KPN)

eASYNC_Provider_str

This field specifies the provider, which is related to the type specified in the eASYNC_Type_str field, which can be either PAGING or SMS. Currently there is support for PAGING with provider BELGACOM and SMS with provider PROXIMUS and KPN. Support for other providers and types can be added in future releases, or can be built on request.

For example:

•

BELGACOM (required when eASYNC_Type_str is PAGING)

• PROXIMUS or KPN (required when eASYNC_Type_str is SMS)

eASYNC_Password_str

This field specifies the password to access the service provider. This field is only relevant when eASYNC_Type_str is SMS.

For the provider PROXIMUS, you must enter a password (proximus) in the initialization string. In this field, you can enter the password.

For KPN, no password is required (eASYNC_Password_str = *NONE).

The default value is *NONE, and means that no password is required.

Note: Password is case-sensitive.

Example of initialization string for provider PROXIMUS, password proximus:

01/00121/O/01/32475353215//proximus/3/

534D5320746F2050726F78696D

7573207769746820534F50484F204D657373656E676572404E6574/A3



NN43120-301 02.01

4 June 2010


.

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.

ATTENTION

Verify that the resource is available, and that the modem is attached to the correct resource. There are environments where many COM ports are available, which can lead to confusion during configuration. As well, resources such as

National Instruments or Watchdog adapters, can also occupy a COM port.

For example: COM02

eASYNC_Settings_str

This value specifies a valid setting string, defining baud rate, parity, data bits and stop bits. Valid values are modem- and provider-specific.

ATTENTION

The eASYNC module performs some handshaking during the initialization phase. The eASYNC module expects an OK response to these initialization steps. Some modems do not reply with OK in these steps, when the initial baud rate is set to a different value than 9600,N,8,1. Therefore, Nortel recommends that you specify 9600,N,8,1 for PAGING/BELGACOM, SMS/PROXIMUS and

SMS/KPN, and not to specify the 14400,N,8,1 value that BELGACOM suggests for their paging application. The baud rate is negotiated during the CONNECT phase, so that is when the modems synchronize.

An example of an entry typically found in this field is as follows: 9600,N,8,1

eASYNC_Telnr_str

This field specifies the dial-in number of the service provider (currently limited to PROXIMUS, KPN, and BELGACOM). Contact your service provider to get the correct number, and enter the number in this field.

Check whether leading 0 or other PSTN access digits are required in your environment.

Table 10 eASYNC_Telnr_str

Type Provider Password Settings Telnr



NN43120-301 02.01

4 June 2010


.

236 Table: eASYNC

Table 10 eASYNC_Telnr_str (cont’d.)

PAG

ING

BELGACOM *NONE

SMS KPN *NONE

SMS PROXIMUS proximus

9600,N,8,1

9600,N,8,1

9600,N,8,1

0045250000

1

0065314141

4

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.

This is useful in situations where a clean start is required. Refer to the instructions of your modem for valid AT-commands that must be specified in your environment. An OK reply is expected on this initialization string, which can require a specific baud rate with some modems.

You can start with the setting AT&C0S0=3. Refer to your modem manual for more information on AT-commands that are supported for your specific modem type.


AT&C0S0=3

eASYNC_Retry_intv_n

This value specifies, in combination with eASYNC_retry_count_n, the interval in seconds between retries if a failure occurs in message delivery.

Time can be lost while waiting for recovery (for example, 3 x 1 minutes = 3 minutes lost time). The value is processed in eKERNEL.


eASYNC_Retry_count_n

This value specifies, in combination with eASYNC_retry_intv_n, the number of times recovery is performed if a message cannot be delivered to the provider. Note that valuable time can be spent while waiting for recovery (for example, 3 times 1 minutes leads to 3 minutes lost time).

The value is processed in eKERNEL.




NN43120-301 02.01

4 June 2010


.

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. This is the only provider that allows the delivery of more than one message in a single dial-out request, thus potentially reducing communication costs at the expense of speed. Nortel recommends a value of 1 for most environments, because processing is usually executed as soon as possible, and any related call setup costs are therefore less important.


eASYNC_Send_time_n

This value specifies (in seconds and in combination with eASYNC_Se nd_Depth_n) the moment when actual message delivery is triggered in eASYNC module. When 1 is specified, immediate processing is triggered when a message request is received from eKERNEL. A larger value causes the system to wait until the specified number of messages is queued before processing begins. Note that processing starts due to either Send Depth or Send time, whichever occurs first. Time can be lost if values larger than 1 are specified.


eASYNC_ALA_Prty_DTMF_Confirm_n

This field specifies the priority of the alarm, as defined in ALARM table.

Alarms distributed to eASYNC with priority higher than the defined value are automatically considered acknowledged, when the provider receives the message. This is usually acceptable; however, eASYNC typically delivers messages to devices (such as Pagers, GSM, and so on) that cannot respond with a confirmation. In some circumstances, the message must be active until a manual confirmation takes place. This can be performed through eASYNC (dial-in and confirm using CLID).

If the priority of the alarm is lower than or equal to the eASYNC_ALA_Pr ty_DTMF_Confirm_n priority, the message reply (<msgrpy>) sent by the eASYNC module to the eKERNEL is treated as a NACK reply (even if an

ACK was sent).

As a result, when alarms that require confirmation are sent using eASYNC and successfully delivered (status = ACK), they continue to behave as if the status is NACK. The alarm is repeated every eASYNC_Silence_intv_n seconds until confirmation is received. If the alarm is not confirmed within

DEV_Retry_count_ALT_DEV_id_n (eKERNEL_device) retries, it is sent to the alternative devices (if configured).



NN43120-301 02.01

4 June 2010


238 Table: eASYNC


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.


(seconds)

eASYNC_Comments_str

This field can contain remarks from the administrator, and is informational only.

.



NN43120-301 02.01

4 June 2010


239

.

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.


BU_From_Path_str

This field specifies the path of the file that must be saved.

An example of an entry typically found in this field is as follows: C:\SOPHO

Messenger@Net\Mdb

BU_From_File_str

This field specifies the filename of the file that must be saved.


Messenger_CFG.mdb

BU_To_Path_str

This field specifies the target path in which to store the copied file. This path must be different from the source path. The target location must also be available when the eBACKUP runs.



NN43120-301 02.01

4 June 2010


.

240 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.

To establish flexibility in the backup approach, a number of special values are supported in the eCAB module. These special values are valid only in the BU_To_Path_str field

•

The special value [timestamp] is used at the beginning of the backup to calculate the current time stamp, formatted in a 14-character string containing both date and time indication (YYYYMMDDHHNNSS). The path is dynamically recalculated, and provides a new unique directory path:

— C:\Temp\[timestamp]\SOPHO Messenger@Net\Mdb becomes

C:\Temp\20011009190312\SOPHO Messenger@Net\Mdb

•

The special value [weekday] is used at the beginning of the backup to calculate the current time stamp, formatted in a one-character string containing the day of week indication (1=Monday, 2=Tuesday,

3=Wednesday, and so on. The path is dynamically recalculated, and provides a new unique directory path:

— C:\Temp\[weekday]\SOPHO Messenger@Net\Mdb becomes

C:\Temp\3\SOPHO Messenger@Net\Mdb

•

The special value [weekdayname] is used at the beginning of the backup to calculate the current time stamp, formatted in a character string containing the name of the day of week (Monday, Tuesday,

Wednesday, and so on). The path is dynamically recalculated, and provides a new unique directory path. The day of week is in the language identified in the regional settings of the Windows environment:

— C:\Temp\[weekdayname]\SOPHO Messenger@Net\Mdb becomes

C:\Temp\Wednesday\SOPHO Messenger@Net\Mdb


C:\Temp\[weekday]\SOPHO Messenger@Net\Mdb

BU_To_File_str

This field specifies the file name of the destination file, which is, in most cases, the same as the source file. Therefore, Nortel recommends that you specify the same value as in BY_From_File field.



NN43120-301 02.01

4 June 2010


.

Sample Data 241


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.


Configuration Database

Sample Data

Table 11

Sample data i

S t e From path

3 C:\Php

3

C:\Program Files\Apache group\Apache\conf

3

3

3

3

C:\SOPHO Messenger@Net\E xe




3

3

3

3

3

3

3








From file php.ini

httpd.conf

eAPI.exe

CSTA_servi ce.exe

eASYNC.ex

e eBACKUP.

exe eCAP.exe

eDMSAPI.e

xe eGRID.exe

eIO.exe

eKERNEL.e

xe eSMTP.exe

eSMTP_ser ver.exe

To path

C:\Temp\[weekday]\php

To file php.ini

C:\Temp\[weekday]\Program Fi les\Apache Group\Apache\conf httpd.conf

C:\Temp\[weekday]\SOPHO

Messenger@Net\Exe eAPI.exe


Messenger@Net\Exe


Messenger@Net\Exe


Messenger@Net\Exe

CSTA_servi ce.exe

eASYNC.ex

e eBACKUP.

exe


Messenger@Net\Exe


Messenger@Net\Exe


Messenger@Net\Exe


Messenger@Net\Exe


Messenger@Net\Exe


Messenger@Net\Exe


Messenger@Net\Exe eCAP.exe

eDMSAPI.e

xe eGRID.exe

eIO.exe

eKERNEL.e

xe eSMTP.exe

eSMTP_ser ver.exe



NN43120-301 02.01

4 June 2010


242 Table: eBACKUP

Table 11

Sample data (cont’d.)

3

3

3


C:\SOPHO Messenger@Net\M db

C:\SOPHO Messenger@Net\M db omnithread

_rt.dll

Messenger

_CFG.mdb

Messenger

_Data.mdb


Messenger@Net\Exe


Messenger@Net\Mdb


Messenger@Net\Mdb omnithread

_rt.dll

Messenger

_CFG.mdb

Messenger

_Data.mdb

.



NN43120-301 02.01

4 June 2010


.

Table: eCAP_generic eCAP_generic parameters

243

.

eCAPG_Inpgm_id_n

This field refers to the input program identifier, as defined in eKERNEL_INPGM table.


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.



NN43120-301 02.01

4 June 2010


.

244 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.

Although the separator us used to isolate logical blocks, a number of hard-coded routines are active within eCAP module. 0A0D and 0C0D blocks are always ignored.

An example of an entry typically found in this field is as follows: 0D0A

eCAPG_Line_Select_start_n

This value, together with eCAPG_Line_Select_len_n and eCAPG_Line_S elect_str, is used to optionally define selection criteria, which are used to select only those records in a asynchronous datastream that are defined.

The value 0 denotes the select capabilities are not in use. As a result, the corresponding values are ignored, and all records are processed.

In this case, the field eCAP_Line_Select_len_n must be 0, and the field eCAP_Line_Select_str must be N/A.

A value larger than 0 indicates select capabilities are used. The value refers to the start position of the select pattern. In this case, the field eCAP_Line_Select_len_n must be larger than 0, and the field eCAP_Line_Select_str must contain the select character or characters.


eCAPG_Line_Select_len_n

This value, together with eCAPG_Line_Select_start_n and eCAPG_Line_Select_str, are used to optionally define selection criteria, which are used to select only those records in an asynchronous datastream that are defined.

This value must be 0 if no select functionality is in use, which is specified through eCAPG_Line_Select_start_n equal to 0.

A value larger than 0 denotes select criteria are active, and the field defines the character length of the selection characters defined in eCAPG_Line_Select_str.




NN43120-301 02.01

4 June 2010


.

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.

The field contains the characters that are used in the select pattern test, which must be a string with length equal to the length defined in eCAPG_Line_Select_len_n.

An example of an entry typically found in this field is as follows: colon (:)

eCAPG_Line_Omit_start_n

This value, together with eCAPG_Line_Omit_len_n and eCAPG_Line_O mit_str, are used to optionally define omit criteria, which are used to omit specific records in a asynchronous datastream.

The value 0 denotes the omit capabilities are not in use. As a result, the corresponding values are ignored, and no records are omitted. In this case, the field eCAP_Line_Omit_len_n must be 0 and the field eCAPG_Line_Omit_str must be N/A.

A value larger than 0 indicates select capabilities are used. The value refers to the start position of the select pattern. In this case, the field eCAP_Line_Select_len_n must be larger than 0 and the field eCAP_Line_Select_str must contain the select character or characters.


eCAPG_Line_Omit_len_n

This value, together with eCAPG_Line_Omit_start_n and eCAPG_Line_O mit_str, is used to optionally define omit criteria, which are used to omit specific records in a asynchronous datastream.

This value must be 0 if no omit functionality is in use, which is specified through eCAPG_Line_Omit_start_n equal to 0.

A value larger than 0 denotes omit criteria are active, and the field defines the character length of the omit characters defined in eCAPG_Line_Omit_str.




NN43120-301 02.01

4 June 2010


.


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.

This field specifies the characters that are used in the omit pattern test, which must be a string with length equal to the length defined in eCAPG_Line_Omit_len_n.

An example of an entry typically found in this field is as follows: /

eCAPG_Field_Sep_str

This field can optionally define field separators. Field separators can be used when no fixed format of datastreams is available, and individual fields are to be retrieved from a variable-length datastream.

In most cases, this field is not used, and the special value N/A is specified.

The generic eCAP module is targeted to handle only datastreams that use a fixed format layout (for example, printer ports typically produce such formatted data).

When a different value is specified, the characters specified are used as a field delimiter. For example, the value / can be used to define a datastream 001/02/ABC. The field separator can later be used to identify field numbers. In this example, field number 1 is 001, field number 2 is 02, and field number 3 is ABC.

Note that support for such field-separated datastreams is somewhat limited in current release, and does not support offsets. For example,

<001/02/ABC> with field separators / fails to handle the < and > characters, and generates field 1 as <001, field 2 as 02 and field 3 as

ABC>.

An example of an entry typically found in this field is as follows: /

eCAPG_GRP_Name_start_n

This value, together with eCAPG_GRP_Name_len_n and eCAPG_GRP_Name_field_n, defines the criteria to isolate the group name parameter in the datastream.

This field refers to the definitions of eKERNEL_GROUP table.



NN43120-301 02.01

4 June 2010


.


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).

A positive value in eCAPG_GRP_Name_start_n indicates a positional definition is available, and denotes the start position of the group name.


eCAPG_GRP_Name_len_n

This field specifies the length of the group name description.

If the field eCAPG_GRP_Name_start_n equals 0, the eCAPG_GRP_Nam e_len_n must be 0 as well.

If the field eCAPG_GRP_Name_start_n is not set to 0, the eCAPG_GRP_Name_len_n must be non-0 as well, and define the length of the group name.


eCAPG_GRP_Name_field_n

This field specifies the occurrence number of the field that denotes group name, and only applies when a field separator is defined. In this case, no positional definition is active.

The field must be 0 when no such definition is active.

A positive value indicates the field number. For example, when the field separator is / and the datastream is 001/02/ABC, the value of 1 returns

001 as group name, a value 2 would return 02 as group name, and 3 would return ABC as group name.


eCAPG_Msg_start_n

This value, together with eCAPG_Msg_len_n and eCAPG_Msg_field_n, refers to the message contents in the datastream.

This field refers to the definitions of eKERNEL_ALARM table, and must be appropriately configured (for example, message length).



NN43120-301 02.01

4 June 2010


.


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.

A message indication can be defined based either upon string position

(through eCAPG_Msg_start_n and eCAPG_Msg_len_n) or based upon field occurrence (through eCAPG_Msg_field_n).

A positive value in eCAPG_Msg_start_n indicates a positional definition is available, and denotes the start position of the message.


eCAPG_Msg_len_n

This field specifies the length of the message.

If the field eCAPG_Msg_start_n equals 0, the eCAPG_Msg_len_n must be

0. If the field eCAPG_Msg_start_n is non-0, the eCAPG_Msg_len_n must be non-0, and define the length of the message.

Note the length specified in eKERNEL_ALARM table.


eCAPG_Msg_field_n

This field specifies the occurrence number of the field that denotes message, and only applies when a field separator is defined. In this case, no positional definition is active.



001 as message, a value 2 would return 02 as message, and 3 would return ABC as message.


eCAPG_Ala_Descr_start_n

This value specifies, together with eCAPG_Ala_Descr_len_n and eCAPG_Ala_Descr_field_n, the alarm description contents in the datastream.



NN43120-301 02.01

4 June 2010


.


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.

An alarm description indication can be defined based either upon string position (through eCAPG_Ala_Descr_start_n and eCAPG_Ala_Descr_len_n) or based upon field occurrence (through eCAPG_Ala_Descr_field_n).

A positive value in eCAPG_Ala_Descr_start_n indicates a positional definition is available, and denotes the start position of the alarm description.


eCAPG_Ala_Descr_len_n

This field specifies the length of the alarm description.

If the field eCAPG_Ala_Descr_start_n equals 0, the eCAPG_Ala_Desc r_len_n must be 0 as well.

If the field eCAPG_Ala_Descr_start_n is non-0, the eCAPG_Ala_Descr_le n_n must be non-0 as well.


eCAPG_Ala_Descr_field_n

This field specifies the occurrence number of the field that denotes alarm description, and only applies when a field separator is defined. In this case, no positional definition is active.



001 as alarm description, a value 2 would return 02 as alarm description and 3 would return ABC as alarm description.




NN43120-301 02.01

4 June 2010


.


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.

An example of an entry typically found in this field is as follows: N/A

eCAPG_Dft_Msg_str

This field is used to provide a default message, 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.



eCAPG_Dft_Ala_Descr_str

This field is used to provide a default alarm description, 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.



eCAPG_Reset_start_n

This value, together with eCAPG_Reset_len_n and eCAPG_Reset_str, refers to the optional reset functionality that can be deployed in the eCAP generic module.

In most cases, a eCAP generic is implemented in environments, where alarms are detected through an asynchronous serial interface, such as a printer port.

The eCAP generic is targeted to environments, where each alarm indication results in sending an alarm request to the eKERNEL interface.

Due to the nature of such requests, and the scope of the current eCAP implementation, these alarms results in setting an alarm, a so-called

<msgrqs>-transaction that contains a *set request. In most cases you define these alarm types in eKERNEL_ALARM table as alarms that are removed after *sent. Therefore, the parameter eCAPG_Remove_after_str is, in most cases, set to *set.



NN43120-301 02.01

4 June 2010


.


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).

In this case, the field eCAPG_Reset_start_n must be set to the start position of the reset character pattern.


eCAPG_Reset_len_n

This parameter is related to the eCAPG_Reset_start_n parameter. If the reset functionality is not used, both parameters are set to 0.

If an eCAPG_Reset_start_n value is specified (for example, 35), the parameter eCAPG_Reset_len_n and eCAPG_Reset_str are to be defined.

The eCAPG_Reset_len_n indicates the length of the string that must be compared to activate a reset condition. If, for example, the text GENERAL

RESET must be encountered in position 35, then eCAP_Reset_len_n must be set to 13 (the length of the string) and eCAP_Reset_str must be set to the text GENERAL RESET


eCAPG_Reset_str

This parameter also refers to the optional reset capabilities, and contains the string that must be found in the starting position eCAP_Reset_start_n with length eCAP_Reset_len_n.

In most cases the reset functionality is not used, and the default value

N/A is defined.

An example of an entry typically found in this field is as follows: GENERAL

RESET

eCAPG_Remove_after_str

This parameter accepts the value *SENT or *RESET.



NN43120-301 02.01

4 June 2010



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.

Use this field to configure the eKERNEL_ALARM table handling of alarm requests, and prevent endless-loop conditions. Alarms are typically *set with the option remove after sent. The eCAPG_Remove_after_str must then be set to *SENT.

In some exceptional environments, the attached peripherals are capable of sending a general reset to clear all pending alarms. This is performed through the eCAPG_Reset_start_n, eCAPG_Reset_len_n and eCAPG_Reset_str parameters. In such case, alarms must be set using the remove after *RESET value, indicating all pending alarms remain in the eKERNEL database unless the reset condition is met.

Due to the scope of the eCAP generic implementation, no granular method of resetting individual alarms is currently available, and reset functionality must only be activated when the required prerequisite conditions are met.

An example of an entry typically found in this field is as follows: *RESET

eCAPG_Commentrs_str

Use this field to store comments or remarks pertaining to the configuration record.

An example of an entry typically found in this field is as follows: Serial link to the fire detection system.

.



NN43120-301 02.01

4 June 2010


.

Table: eDMSAPI eDMSAPI parameters

253

.

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.


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.




NN43120-301 02.01

4 June 2010


.

254 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.

The number of possible IoRegisters is related to the number of seats available.

If eDMSAPI is configured with a larger value than available, too many simultaneous E2-data requests are initiated simultaneously, which leads to a large number of failed requests.


eDMSAPI_eKERNEL_Seats_count_n

This field specifies the number of seats reserved for message requests

(<msgrqs>) from eKERNEL.


eDMSAPI_External_Seats_count_n

This field specifies the number of seats reserved for applications with direct access to the eDMSAPI. For example, the eWeb module. The number of seats specified in the field is part of the number of seats defined in the eDMSAPI_Seats_count_n field.


eDMSAPI_External_Address_str

This field specifies the IP address of the PC where the eDMSAPI module runs.

This value is necessary for external clients such as eWeb, which directly access the eDMSAPI module.

When sending a normal message, the following format is used:

SNDNMSG|ID|DNR|Message<cr><lf>

When sending an urgent message, the following format is used:

SNDUMSG|ID|DNR|Message<cr><lf>.



NN43120-301 02.01

4 June 2010


.

eDMSAPI parameters 255


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.

The only valid format of the requests are:

SNDNMSG|ID|DNR|message<CR><LF>

SNDUMSG|ID|DNR|message<CR><LF>


eDMSAPI_ALA_Prty_UMSG_n

This field specifies the priority an alarm message must have, to be handled as an urgent message. The priority refers to the alarm priority as defined in the eKERNEL_ALARM table. Alarms that do not meet the requirement of being urgent are treated as normal messages. Refer to the DMS-API related documentation for more information.

If, for example, 2 is specified, alarms with alarm priority of 1 and 2 are handled as urgent messages, whereas alarms with priority of 3, 4, and so on are handled as 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).

• Emergency messages impact throughput, because normal message allocates a datapath a few seconds, while urgent messages can allocate more than 30 seconds, depending on the timeout value specified for user confirmation.


eDMSAPI_ALA_Prty_EMSG_n

This field specifies the required priority of an alarm message to be handled as an emergency message. Introduced in R3.0, this field refers to the support of C4060 handsets that allow emergency message levels. The priority refers to the alarm priority as defined in the eKERNEL_ALARM table. Alarms that do not meet the requirement of being urgent are treated as urgent or normal message. Refer to the DMS-API related documentation for more information.



NN43120-301 02.01

4 June 2010


.

256 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).

• Emergency messages impact throughput, because normal message allocates a datapath a few seconds, while urgent messages can allocate more than 30 seconds, depending on the timeout value specified for user confirmation.


eDMSAPI_api_address_str

This field specifies the IP address of the CSTA Service.exe module. In most cases this is the same value as the local IP address of eKERNEL, and can be obtained with IPCONFIG.exe.


10.110.50.138

eDMSAPI _API_port_str

This field specifies the port to which CSTA Service.exe listens, and (in the current release) must always be set to 59000.


eDMSAPI _PBX_address_str

This field specifies the IP address of the PBX. The information is distributed to CSTA Service.exe, which handles the sockets connection between DECT Messengerand the PBX. Contact the switch administrator to obtain the IP address of the switch. If a different addressing scheme or subnet mask is in use, appropriate TCP/IP network configuration must be performed on both platforms (default gateway, additional interface, and so on).


10.110.49.171

eDMSAPI_PBX_port_str

This field specifies the port to which the PBX listens, and depends on the

PBX type. In previous releases, the recommended value was 2555, which is the default port to which a SOPHO DMC listens. Starting from R3.0, there is also support for DAP controller and Nortel. The recommended



NN43120-301 02.01

4 June 2010


.

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.


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. Note that the eDMSAPI_PBX_port_str must also be set according to the recommendations of the PBX type.

An example of an entry typically found in this field is as follows: DMC

eDMSAPI_PBX_licence_str

This keyword specifies the Licence that is used to connect to the PBS.

For DECT Messenger, the licence = Messenger (Licence number = 61) is used.

Note that you can also use the external licence (external licence number).


Messenger

eDMSAPI_Guarding_Polling_intv_n

This field specifies the polling interval for testing the iSLink in seconds.

The PBX sends a System Status request, with a frequency equal to eDMSAPI_Guarding_Polling_intv_n seconds.

The guarding process in the eDMSAPI module, which continuously checks the iSLink connection, automatically re-establishes the connection when the eDMSAPI_Guarding_Polling_intv_n + eDMSAPI_Guarding_Retry_intv_n Time is the value in this field.


eDMSAPI_Guarding_Retry_intv_n

This field specifies the time to wait in seconds, before retrying to establish an iSLink after a failed link setup is detected.


eDMSAPI_Msg_dly_n

This field specifies the delay in seconds between sending the individual requests: send normal message and send urgent message.



NN43120-301 02.01

4 June 2010


258 Table: eDMSAPI


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.


eDMSAPI_Ack2TimeOut_n

Time in seconds the eDMSAPI program waits for an ACK message request from the iSPBS, signaling that an URGENT message has been read by the DECT user (outbound calls).


eDMSAPI_DataPathDelay_n

This keyword specifies the time in seconds to wait between receiving a StopDataResult event form a device and before sending a new

StartDataPathRequest for the same device.

The default value is 2 seconds.

This parameter is implemented because the eDMSAPI module receives

Universal failure events (reason = INVALID_CALLING_DEVICE) when sending a StartDataPathRequest directly after receiving a StopDataResult for the same device.


eDMSAPI_Comments_str

This field contains remarks from the administrator and is informational only.

.



NN43120-301 02.01

4 June 2010


.

Table: eDMSAPI_INBOUND eDMSAPI_inbound parameters

.

eDMSAPII_Site_id_n


In most environments, this value is 1.


eDMSAPII_Area_id_n

This field specifies the area identifier, as defined in eKERNEL_AREA table. In most environments, this value is 1.


eDMSAPII_Called_dev_str

This field identifies the called device. This is the number of the extension to which the message was sent.


eDMSAPII_Type_str

This value can be *IC or *IA.

These values are interpreted by eKERNEL module of DECT Messenger.



NN43120-301 02.01

4 June 2010


259

.

260 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. A callback from a predefined number

(for example, GSM, home subscriber, and so on) can be used to call-off and confirm messages.

An incoming confirmation is only valid if the called device is defined in the eDMSAPI_INBOUND table with eDMSAPI_Type_str = *IC. Therefore, the calling device receives a Ö indication before the message to confirm the called device is valid, and an X for an invalid destination.

*IA When a E2 message is sent by an extension that is IoRegistered (field

DEV_IoRegister_b in table eKERNEL_DEVICE is true), an incoming alarm action is triggered, providing eKERNEL with four pieces of information: the calling device, called device, message, and priority.

When the eKERNEL application receives a request, the request is valid when the called device is defined in the eDMSAPI_INBOUND table with Type = *IA, and if the called and calling device is defined in the eDMSAPI_INBOUND_EVENT table. Therefore, valid requests are indicated with a Ö symbol before the message sent, invalid requests with a

X indication.

An example of an entry typically found in this field is as follows: *IA

eDMSAPII_Comments_str

This field can optionally be used by an administrator to store reminder information, describing, for example, usage of the extension.

An example of an entry typically found in this field is as follows: "this port is used for outbound user-to-user messaging".

Table 12

Sample data eDMSAPII

_Site_id_n

1

1

1

1 eDMSAPII_

Area_id_n

1

1

1

1 eDMSAPII_

Called_dev_str

12345

222

333

56789 eDMSAPII

_

Type_str

*IC

*IA

*IC

*IA eDMSAPII_Comments_str

TEST Incoming confirmation

TEST Incoming alarm

Incoming confirmation

TEST



NN43120-301 02.01

4 June 2010


Table 12

Sample data (cont’d.) eDMSAPII

_Site_id_n

1

1

1

1

1 eDMSAPII_

Area_id_n

1

1

1

1

1 eDMSAPII_

Called_dev_str

860

861

865

888

999 eDMSAPII

_

Type_str

*IA

*IA

*IA

*IA

*IA eDMSAPI_inbound parameters 261 eDMSAPII_Comments_str

REA

User to User message

User to User message

NOOD

REA

.



NN43120-301 02.01

4 June 2010


262 Table: eDMSAPI_INBOUND

.



NN43120-301 02.01

4 June 2010


.

Table: eDMSAPI_INBOUND_EVENT eDMSAPI_inbound_event parameters

263

.

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.


eDMSAPIIE_Called_dev_str

This field specifies the Called device in an incoming call alarm generation situation, handled by eDMSAPI. This field specifies the number to which the message was sent.


eDMSAPIIE_Calling_dev_str

This field specifies the Calling device in an incoming call alarm generation situation, handled by eDMSAPI.



NN43120-301 02.01

4 June 2010


.

264 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*.

An authorized of an entry typically found in this field is as follows: *ALL

eDMSAPIIE_Ala_id_Normal_n

This field defines (based upon appropriate record selection through CLID detection) the alarm characteristics of the alarm that are initiated as a result of the incoming message process with a priority = Normal.

The alarm identifier must match a definition in eKERNEL_ALARM table, and defines properties such as alarm priority, length, and so on.

The remainder of the action is defined in the eDMSAPI_INBOUND_R

ESULT table, where a message is defined, and a destination group is assigned, based on calling and called device.


eDMSAPIIE_Ala_id_Urgent_n

This field defines (based upon appropriate record selection through CLID detection) the alarm characteristics of the alarm that are initiated as a result of the incoming message process with a priority = Urgent.

The alarm identifier must match a definition in eKERNEL_ALARM table, and defines properties such as alarm priority, length, and so on.

The remainder of the action is defined in the eDMSAPI_INBOUND_R

ESULT table, where a message is defined, and a destination group is assigned, based on calling and called device.


eDMSAPIIE_Comments_str

This field can contain remarks from the administrator and is informational only.

Table 13

Sample Data

Site Area

1 1

Called device

222

Calling device

8*

Alarm ID

Normal

1190105

Alarm ID

Urgent

1190106

Comments

TEST



NN43120-301 02.01

4 June 2010


eDMSAPI_inbound_event parameters 265

Table 13

Sample Data (cont’d.)

Site Area

1

1

1

1

1

1

1

1

1

1

1

1

1

1

1

1

Called device

333

56789

56789

56789

56789

56789

860

861

1 1

1

1

1

1

865

888

999

Calling device

*ALL

850

851

852

853

86*

85*

*ALL

*ALL

*ALL

*ALL

Alarm ID

Normal

1190105

1190105

1190105

1190105

1190105

1190104

1190101

1190101

1190103

1190104

Alarm ID

Urgent

Comments

1190106

1190106

1190106

1190106

1190106

1190104

1190102

1190102

1190103

1190104

TEST

TEST

TEST

TEST

TEST

REA

User to User msg allowed for device

861

User to User msg allowed for device

865

NOODOPROEP

REANIMATIE

.



NN43120-301 02.01

4 June 2010


266 Table: eDMSAPI_INBOUND_EVENT

.



NN43120-301 02.01

4 June 2010


.

Table: eDMSAPI_INBOUND_RESULT

267

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.


eDMSAPIIR_Area_id_n

This field specifies the site, as defined in eKERNEL_AREA table. In most environments, this value is 1.


eDMSAPIIR_IC_Called_dev_str

This field specified a descriptor of the called device.

When a message is sent to a device that is defined in eDMSAPI_INBOUN

D table as type *IA, the resulting action depends on the called and calling devices.

The value must be the extension number of the device where the message is sent. In most situations each device defined in eDMSAPI_INBOUND table as *IA has at least one record in this table.




NN43120-301 02.01

4 June 2010


.

268 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.

The value must be the extension number to which the message was sent.

Possible values are:

Define an extension by number, for authorized, 866.

Define a generic value *ALL.

Define a generic number starting with some characters 85.


eDMSAPIIR_GRP_Name_str

This field specifies the group of users that is notified as a result of the *IA

(incoming alarm generation) process through eDMSAPI. The group must be defined in eKERNEL_GROUP and eKERNEL_GROUP_MEMBER. A message is created for that group, with alarm identification (and attributes) specified in eDMSAPI_INBOUND_EVENT table. The corresponding attributes are defined in eKERNEL_ALARM table.

An authorized of an entry typically found in this field is as follows: REA

eDMSAPIIR_Msg_str

This field specifies the message that is sent as a result of the *IA

(incoming alarm generation) process through eDMSAPI. The group receives a message defined in this field, with alarm attributes specified in eDMSAPI_INBOUND_EVENT table and eDMSAPI_INBOUND_RESULT table.

Refer to the sample data in

Table 14 "Sample Data" (page 269)

for authorizeds of message definitions. As illustrated in the authorizeds in

Table 14 "Sample Data" (page 269) , messages are built based upon fixed

characters, plus the following:

• [Calling number]

•

[Called number]



NN43120-301 02.01

4 June 2010


.

1

1

1

1

1

Table 14

Sample Data

1

Site

1

Area 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).

Now when the system configuration configures a device with a visual DNR, this DNR is used to format a message when the message contains [Calling number]. The end user is confronted with the visual DNR instead of the device id.

An authorized of an entry typically found in this field is as follows: (see

Table 14 "Sample Data" (page 269) )

eDMSAPIIR_Descr_str

This field is informational only.

eDMSAPIIR_Comments_str

This field is used by administrators to add some remarks. The value is informational only.

Called device

222 8*

Calling device

1

1

1

1

1

56789

56789

56789

56789

860

86*

861

865

866

86*

Group

E2TESTGR

P

Message

TEST : [msg] from [Calling number] to [Called number].

TEST 86* [msg] E2TESTGR

P

E2TESTGR

P

E2TESTGR

P

E2TESTGR

P

REA

TEST 861 [msg]

TEST 865 [msg]

TEST 866 [msg]

REA : [msg] from [Calling number] to [Called number].



NN43120-301 02.01

4 June 2010


270 Table: eDMSAPI_INBOUND_RESULT

1

1

1

1

1

1

Table 14

Sample Data (cont’d.)

1

Site

1

Area

Called device

860

Calling device

865

Group

REA

1

1

1

1

1

1

1

1

860

860

860

861

865

888

999

866

867

868

*ALL

*ALL

*ALL

*ALL

REA

REA

REA

861

865

NOOD

REA

Message

REA [msg] from [Calling number] to [Called number].




[msg]

[msg]

NOOD [msg] from [Calling number] to [Called number].


.



NN43120-301 02.01

4 June 2010


271

.

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.


eESPA_Area_id_n

This field specifies the area identifier, as defined in eKERNEL_AREA. This value is, in most environments, equal to 1.




NN43120-301 02.01

4 June 2010


.

272 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. The protocol used conforms to International Standard ISO

1745 Information processing – Basic mode control procedures for data communication systems. It is a multidrop protocol utilizing a Control

Station.

Because the physical interface is only RS232, it can only support a point to point interface to the external espa infrastructure. If more than one system must be integrated, multiple eESPA modules must be configured on multiple areas.

There is on each RS-232 interface only one system that can act as Control

Station.

If the eESPA module for this site and area must act as Control Station

(master), the value must be True or -1, otherwise, the value must be False or 0 (slave).

An authorized of an entry typically found in this field is as follows: False

eESPA_Polling_intv_n

This field specifies the polling interval in milliseconds, and is only relevant if eESPA_ControlStation_b is set to True (only the Control Station is polling).


eESPA_Polling_address_list_str

This field is only relevant if the module acts as Control Station

(eESPA_ControlStation_b is set to True).

The Control Station must poll a device or devices on the communication line with the sequence <address> ENQ.

The characters 0 to 9 can be specified as addresses.



NN43120-301 02.01

4 June 2010


.

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.


eESPA_LocalAddress_n

This field specifies the address of the local espa interface.


eESPA_ExternalAddress_n

This field specifies the address of the remote station.

One eESPA interface is linked with one area, so is linked to only one remote station. If more than one station can receive are sent espa alarms, more areas must be configured in the configuration database.


eESPA_DataId_Group_str

Use this field to set the relationship between the DECT MessengerDevice or Group and the data identifier of the espa record that specifies the call address if eESPA acts as input program, so only relevant if eESPA receives external data from the espa infrastructure.

If the eESPA module acts as input program: The eESPA module receives espa records. Each espa record received must be translated to a valid message request, and sent to the eKERNEL application.

The eESPA_DataId_Group_str field specifies the Data Identifier (normally

1) of the espa record that specifies the group. This group refers to the field

GRP_Descr_str of eKERNEL_GROUP table.

In the following authorized, data identifier 1 (call address) is defined as eESPA_DataId_Group_str.

Table 15

Espa record: SOH1STX1US12345RS2USThe messageRS3US9RS4US3RS6U

S3ETXBCC

(SOH)

STX

ETX

US

Start of header

Start of text

End of text

Unit separator



NN43120-301 02.01

4 June 2010


274 Table: eESPA

Table 15


S3ETXBCC (cont’d.)

RS

BCC

Record separator

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)

.

Figure 205

Example: eESPA module acts as input program

If the specified data identifier is not present in the available datastream record, than the field eESPA_Group_default_str must be used to define a group in the message request.

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 <group> tag is put in data identifier 1 (call address).

In the following authorized, the data in the <group> tag from the message request, must be translated to data identifier 1 (call address) in the espa record.

.



NN43120-301 02.01

4 June 2010


Figure 206

Example: eESPA module acts as output program eESPA parameters 275

.

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.


eESPA_Group_default_str

This field is used to provide a default group name, in the event that no value can be retrieved from the available espa datastream. In this case, the same value is used for all alarms generated through this eESPA interface instance.

This group refers to the definitions of eKERNEL_GROUP table.

This parameter is only relevant if eESPA acts as an input program (so receives external data from the espa infrastructure).

An authorized of an entry typically found in this field is as follows: ESPA

GROUP

eESPA_DataId_Msg_str

This field specifies the Data Identifier of the espa record that specifies the message. Mostly this values is 2.



NN43120-301 02.01

4 June 2010


276 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.

This field specifies the Data Identifier (normally 2) of the espa record that specifies the message.

In this authorized, data identifier 2 (display message) is defined as eESPA_DataId_Msg_str.

Table 16


S3ETXBCC

(SOH)

STX

ETX

US

RS

Start of header

Start of text

End of text

Unit separator

Record separator

BCC Checksum

The incoming alarm/message, must be translated to a valid message request and sent to the eKERNEL:

Figure 207

Example: eESPA module acts as input program

.



NN43120-301 02.01

4 June 2010



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 <message_xx> tag is put in data identifier 2 (display message).

In the following authorized, the data in the <message_xx> tag from the message request, must be translated to data identifier 2 (display message) in the espa record.

Figure 208

Example: eESPA module acts as output program

.


eESPA_Msg_default_str

This field is used to provide a default message, 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 eESPA interface instance.


An authorized of an entry typically found in this field is as follows: ESPA alarm



NN43120-301 02.01

4 June 2010


.

278 Table: eESPA

eESPA_DataId_Ala_descr_str

This field specifies the Data Identifier of the espa record that specifies the alarm description.


This field refers to the definitions of eKERNEL_ALARM table, and must be appropriately configured (for authorized, message length, and so on).

If the specified data identifier is not present in the available datastream record, than the field eESPA_Ala_descr_default_str must be used to define a default message.

This field can also be a combination of more than one data identifier.

Than the data identifiers must be separated by a ^ sign. If for instance the beep code (data identifier 3) in combination with the priority (data identifier

6) must result in the alarm description, this value must be 3^6.

If the display message (data identifier 2) is a part of the alarm description, you can specify the first x characters of the message as the alarm description. For authorized the value 2:3, results in an alarm description equal to the first 3 characters of the display message (data identifier

2). If the message is, for authorized, NURSE CALL ROOM 02, the alarm description is NUR, so the alarm NUR must be configured in the eKERNEL_ALARM table.

If this eESPA module acts as an input program: In this authorized, data identifier 3 (beep coding) is defined as eESPA_DataId_Ala_descr_str.

Table 17


S3ETXBCC

(SOH)

STX

ETX

US

RS

Start of header

Start of text

End of text

Unit separator

Record separator

BCC Checksum

The incoming alarm/message must be translated to a valid message request and sent to the eKERNEL:



NN43120-301 02.01

4 June 2010


Figure 209

Example: eESPA module acts as input program eESPA parameters 279

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 <beep_code_xx> tag is put in data identifier 3 (beep coding).

In the following authorized, the data in the <beep_code_xx> tag from the message request, must be translated to data identifier 3 (beep coding) in the espa record.

Figure 210


.



NN43120-301 02.01

4 June 2010


.

280 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. In this case, the same value is used for all alarms generated through this eESPA interface instance. This alarm description refers to the definitions of eKERNEL_ALARM table.


An authorized of an entry typically found in this field is as follows: ESPA

eESPA_Remove_after_str

This parameter accepts values *SENT, *RESET, or *CALC.

This parameter is only relevant if eESPA acts as an input program (so it receives external data from the espa infrastructure).

In most cases the eESPA interfaces is used to capture alarms and received data contains alarm information (acts as input program). In this situation messages are transmitted to eKERNEL immediately upon arrival and these alarms are processed within DECT Messenger.

In some environments, the remote peripherals cannot indicate that pending alarms are reset, and therefore the eKERNEL must handle the alarms. Use this field to configure eKERNEL_ALARM table to correctly handle the alarm requests and refrain from endless-loop conditions. As such alarms are typically *set with the option remove after sent. The eESPA_Remove_after_str are then set to *SENT.

In some environments, the attached peripherals are capable of sending a reset to clear all pending alarms. In such case, alarms must be set using the remove after *RESET value, indicating all pending alarms remain in the eKERNEL database unless the reset condition is met.

This parameter refers to all alarms, so that means that every alarm must receive a reset (a reset occurs if data identifier 4 (call type) is equal to value 1).



NN43120-301 02.01

4 June 2010


.


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.

An authorized of an entry typically found in this field is as follows: *SENT

eESPA_NAK_retry_cnt_n

This field specifies the number of retries to re-transmit a message after receiving a NAK.

A device that has control of the communication line can transfer data to the other devices. When unable to accept the message, the receiving device sends a negative acknowledge with a (1 or 2 or 3) NAK sequence, and the sending device can then retransmit the block. If, after eESPA_NAK_retry_cnt_n attempts, the transmission still fails, and the sending device terminates transmission with the EOT character.


eESPA_Timeout_n

This values specifies in seconds how long the station waits, if no valid transactions are detect on the communication line, before sending a EOT and terminate the communication and regain control.


eESPA_Handshaking_n

This field sets and returns the hardware handshaking protocol.

The possible values are:

0 No handshaking. (comNone)

1 XOn/XOff handshaking. (ComXonXoff)

2 Request-to-send/clear-to-send handshaking (comRTS)

3 Both request-to-send and XOn/XOff handshaking. (comRTSXonXoff)

The default value is 0.




NN43120-301 02.01

4 June 2010


282 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 <msgrqs> request from the eKERNEL to the espa interface, contains a tag <call_type> 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.

The possible values are: 0, 1, 2, 3, *NONE

In the following authorized, the data in the <call_type> tag from the message request, must be translated to data identifier 4 (call type) in the espa record.

Figure 211


.


eESPA_OUT_Nmbr_transm_default_str

This field is only relevant if the eEPSA module acts as an output program, so for message sent from the eKERNEL to the eESPA interface.

A <msgrqs> request from the eKERNEL to the espa interface, contains a tag <transmission_nmbr> that defines the value for data identifier 5

(transmission number). If *NONE is specified, data identifier 5 is not a part of the espa record.



NN43120-301 02.01

4 June 2010



In the following authorized, the data in the <transmission_nmbr> tag from the message request, must be translated to data identifier 5 (number of transmissions) in the espa record.

Figure 212



eESPA_Comments_str

This field can be filled with comments, to allow administrators to add some remarks to the configuration record.

.



NN43120-301 02.01

4 June 2010


284 Table: eESPA

.



NN43120-301 02.01

4 June 2010


.

Table: eESPA_OUTBOUND_CFG eESPA_outbond_cfg parameters

285

.

eESPAO_Site_id

This field specifies the site identifier, as defined in eKERNEL_SITE. This value is, in most environments, equal to 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.


eESPAO_ALA_Prty_from_n

This field refers to the ALA_Prty_n field of the table eKERNEL_ALARM, and defines the priority of an alarm.

A low value indicates an important alarm, a high value a less important alarm.

With the fields eESPAO_ALA_Prty_from_n and eESPAO_ALA_Prty_to_n you can specify a range of alarm priorities and set a relationship to the beepcode record type and the priority record type of the espa datablock.

The Data identifier for the beepcode record type is 3.



NN43120-301 02.01

4 June 2010


.

286 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

1 1

1

1

1

1

Alarm from

0

3

6

Alarm to

2

5

999

Beepcode

1

3

9

Priority

2

1

3

When a <msgrqs> 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). Therefore, all alarms with a priority between 0 and 2 have these specifications.

Example datablock:

(RS: record separator, US: Unit separator

* Alarm priority equal to or between 0 and 2

1US4567RS2USExampleRS3US1RS6US2

* Alarm priority equal to or between 3 and 5


* Alarm priority equal to or between 6 and 999 (highest possible value)



eESPAO_ALA_Prty_to_n

See eESPAO_ALA_Prty_from_n


eESPAO_BeepCode_str

This field specifies the data that must be entered in the espa datablock for record type beepcode (data identifier 3).


eESPAO_Priority_str

This field specifies the data that must be entered in de espa datablock for record type priority (data identifier 6).



NN43120-301 02.01

4 June 2010


eESPA_outbond_cfg parameters 287


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 19

Sample eESPAO_Comments_str values

Site

1

1

1

1

1

1

Area

1

1

1

2

2

3

Alarm from

0

3

6

0

6

0

Alarm to

2

5

999

5

999

999

Beepcode

1

3

9

1

*NONE

1

Priority

2

1

3

3

3

*NONE

.



NN43120-301 02.01

4 June 2010


288 Table: eESPA_OUTBOUND_CFG

.



NN43120-301 02.01

4 June 2010


289

.

Table: eIO_MODULE eIO_modules parameters

.

eIOM_Site_id_n


In most environments, this value is 1.


eIOM_Area_id_n

This field specifies the area identifier, as defined in eKERNEL_AREA table. In most environments, this value is 1.


eIOM_Module_str

This value refers to the 2-byte module identifier, specified in the FieldPoint

Explorer and in eIO_MODULE table. A typical value is between 01 and 08.

Ensure that the table eIO_DO defines only digital output-contacts (those with a matching digital output module). The current release supports up to eight modules per eIO instance, including one FP-1000 controlling module, and can refer to FP-AI-100, DP-DI-300, FP-DI-301, FP-DI-330 and FP-DO-401.



NN43120-301 02.01

4 June 2010


.

290 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).


eIOM_Type_str

The current release supports the following modules:

Table 20 eIOM supported modules

FP-AI-100

FP-DI-300

FP-DI-301

FP-DI-330

FP-DI-401

Analogue input

Digital input

Digital input

Digital input

Digital output

8 contacts

8 contacts

16 contacts

8 contacts

8 contacts

Refer to the corresponding chapter in this document for technical specifications on the modules.

An authorized of an entry typically found in this field is as follows:

FP-DI-330

eIOM_Url_str

This field denotes the URL string associated with the module. Refer to the FieldPoint Explorer and other National Instrument distributed I/O documentation resources for more information on the URL defined OPC server binding mechanism.

The FieldPoint Explorer is a recommended way to determine naming conventions. Take note of the ending characters specified in

Table 21

"eIO_module sample data" (page 291)

. Using an incorrect URL prevents binding contacts to the OPC Server, resulting in system malfunction.

An authorized of an entry typically found in this field is as follows: opc:/National Instruments.OPCFieldPoint/FP Res\FP-AI-100 @1\Channel

eIOM_Contact_cnt_n

The field defines the number of contacts that are associated to the module.

This field can specify a smaller number than the maximum number of physical available contacts on a module, in which case the remaining contacts are not bound to the OPC Server and remain non-operational.



NN43120-301 02.01

4 June 2010


.

eIO_modules parameters 291


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 21 eIO_module sample data

Site

1

Area

1

Module

01

Count

16

2

2

2

2

2

2

2

1

1

1

2

2

2

3

01

02

03

01

02

03

02

Type URL

FP-DI-300 opc:/National

Instruments.OPCFieldPoint/FP

Res\FP-DI-330 @2\Channel

FP-AI-100 opc:/National


Res\FP-AI-100 @1\Channel




FP-DO-401 opc:/National


Res\FP-DO-401 @3\Channel

FP-AI-100 opc:/National


Res\FP-AI-100 @1\Channel




FP-DO-401 opc:/National


Res\FP-DO-401 @3\Channel




8

8

16

8

8

16

8



NN43120-301 02.01

4 June 2010


292 Table: eIO_MODULE

.



NN43120-301 02.01

4 June 2010


293

.

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.


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.


eIOAI_Module_str


Explorer and in eIO_MODULE table. A typical value is between 01 and

08. Verify that the table eIO_AI only defines analogue input-contacts

(the contacts with a matching analogue input module). Current release supports FP-AI-100 modules.



NN43120-301 02.01

4 June 2010


.

294 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).


eIOAI_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 08 for the currently supported FP-AI-100. Note that 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). Note that some peripherals of National Instruments include labels and documentations where contacts start numbering at 0 up to 7, whereas eIO starts at 01 up to 08.


eIOAI_Min_S_str

The value specifies the analogue level measured on a contact to set 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.

The decimal separator must be set according to the operating system regional settings.

Refer to the FieldPoint Explorer documentation on how to configure the

FP-AI-100 module. Each channel can individually be set according to the attached input, and allow specifying the unit of 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. These regional settings result in internal usage of decimal separator symbols in the form of period (.) or comma (,). If your system is set up with comma

(,) as decimal separator, a comma (,) must also be specified when values are entered in the database.



NN43120-301 02.01

4 June 2010


.

eIO_AI parameters 295


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.



Refer to the FieldPoint Explorer documentation for more information the configuration of the FP-AI-100 module. Each channel can individually be set according to the attached input, and allow to specify the unit of 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




06,000000

eIOAI_Max_R_str

The value specifies the analogue level measured on a contact to set a plus-level alarm.

If plus-level alarms are to be disabled a 99,999999 value can be specified.



Refer to the FieldPoint Explorer documentation for more information on the configuration of the FP-AI-100 module. Each channel can individually be set according to the attached input, and allow specifying the unit of



NN43120-301 02.01

4 June 2010


.

296 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.





20,000000

eIOAI_Max_S_str

The value specifies the analogue level measured on a contact to reset a plus-level alarm.

If plus-level alarms are to be disabled a 99,999999 value can be specified.



Refer to the FieldPoint Explorer documentation for more information on the configuration of the FP-AI-100 module. Each channel can individually be set according to the attached input, and allow specifying the unit of 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.




When values are entered in the database.

An authorized of an entry typically found in this field is as follows:15,000

000.



NN43120-301 02.01

4 June 2010


.


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 22 eIOAS_ALA_Descr_str authorized

ALA_id_n

1160101

1160102

ALA_INPGM_id

11601

11601

ALA_Descr_str

A-INPUT

A-INPUT

ALA_Remove_

*SENT

*RESET

ALA_Prty_n

5

5

An authorized of an entry typically found in this field is as follows: A-INPUT

eIOAI_GRP_Name_str

The group name describes what group is informed on the error condition, and refers to a group defined in eKERNEL_GROUP and eKERNEL_GROUP_MEMBER tables.


eIOAI_MSG_str

This field describes the message that is sent to the group members. Nortel recommends that you enter descriptive text that provides the recipient sufficient information to handle the alarm condition. Mobile users often lack immediate access to other information resources such as plans, technical specs, and so on. Nortel recommends that you select an appropriate message that is short and descriptive enough, and keep text length less than, or equal to, the maximum length defined in the associated eKERNEL_ALARM table.


TEMPERATURE OR 002

eIOAI_Comments_str

This field is available for an administrator to enter some descriptive text that allows location and identification of the attached input device and its usage.

Table 23 "eIO_AI sample data" (page 298)

provides sample eIO_AI module table data.



NN43120-301 02.01

4 June 2010


.

298 Table: eIO_AI

Table 23 eIO_AI sample data

S

I

T e

A

R

E a

1 1 0

1

M o d

C o n t

0

1

Min_S Min_R Max_R Max_S

00,000000 00,000000 00,000400 00,000400

1 1 0

1

1 1 0

1

1 1 0

1

1 1 0

1

1 1 0

1

1 1 0

1

1 1 0

1

2 1 0

1

2 1 0

1

2 1 0

1

2 1 0

1

0

2

0

3

0

4

0

5

0

6

0

7

0

8

0

1

0

2

0

3

0

4

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

12,000000

12,000000

12,000000

12,000000

12,000000

12,000000

12,000000

12,000000

12,000000

12,000000

12,000000

20,000000

20,000000

20,000000

20,000000

20,000000

20,000000

20,000000

20,000000

20,000000

20,000000

20,000000

ALA_d escr

A-INP

UT

Gr ou p

AI

A-INP

UT

A-INP

UT

A-INP

UT

A-INP

UT

A-INP

UT

A-INP

UT

A-INP

UT

A-INP

UT

A-INP

UT

A-INP

UT

A-INP

UT

AI

AI

AI

AI

AI

AI

AI

AI

AI

AI

AI

Analog

Input

05

Analog

Input

06

Analog

Input

07

Analog

Input

08

MSG

Analog

Input

01

Analog

Input

02

Analog

Input

03

Analog

Input

04

Analog

Input

01

Analog

Input

02

Analog

Input

03

Analog

Input

04



NN43120-301 02.01

4 June 2010



Table 23 eIO_AI sample data (cont’d.)

S

I

T e

A

R

E a

2 1 0

1

M o d

C o n t

0

5

Min_S Min_R Max_R Max_S

00,000000 00,000000 12,000000 20,000000

2 1 0

1

2 1 0

1

2 1 0

1

2 2 0

1

2 2 0

1

2 2 0

1

2 2 0

1

0

6

0

7

0

8

0

1

0

2

0

3

0

4

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

00,000000

12,000000

12,000000

12,000000

12,000000

12,000000

12,000000

12,000000

20,000000

20,000000

20,000000

20,000000

20,000000

20,000000

20,000000

ALA_d escr

A-INP

UT

A-INP

UT

A-INP

UT

A-INP

UT

A-INP

UT

A-INP

UT

A-INP

UT

A-INP

UT

Gr ou p

AI

AI

AI

AI

000

01

000

01

000

01

00

001

MSG

Analog

Input

05

Analog

Input

06

Analog

Input

07

Analog

Input

08

Analog

Input

01

Analog

Input

02

Analog

Input

03

Analog

Input

04

.



NN43120-301 02.01

4 June 2010


300 Table: eIO_AI


S

I

T e

A

R

E a

M o d

C o n t Min_S Min_R Max_R Max_S

2 2 0

1

0

5

00,000000 00,000000 12,000000 20,000000

ALA_d escr

Gr ou p MSG

A-INP

UT

00

001

Analog

Input

05

.



NN43120-301 02.01

4 June 2010




S

I

T e

A

R

E a

M o d


2 2 0

1

0

6

00,000000 00,000000 12,000000 20,000000

ALA_d escr

Gr ou p MSG

A-INP

UT

00

001

Analog

Input

06

.



NN43120-301 02.01

4 June 2010


302 Table: eIO_AI


S

I

T e

A

R

E a

M o d


2 2 0

1

0

7

00,000000 00,000000 12,000000 20,000000

ALA_d escr

Gr ou p MSG

A-INP

UT

00

001

Analog

Input

07

.



NN43120-301 02.01

4 June 2010




S

I

T e

A

R

E a

M o d


2 2 0

1

0

8

00,000000 00,000000 12,000000 20,000000

ALA_d escr

Gr ou p MSG

A-INP

UT

00

001

Analog

Input

08

.



NN43120-301 02.01

4 June 2010


304 Table: eIO_AI


S

I

T e

A

R

E a

M o d


ALA_d escr

Gr ou p MSG

.



NN43120-301 02.01

4 June 2010


305

.

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.


eIODI_Area_id_n



eIODI_Module_str


Explorer and in eIO_MODULE table. A typical value is between 01 and 08.

Ensure that the table eIO_DI only defines digital input-contacts, thus only the contacts with a matching digital input module. Current release supports

FP-DI-300, FP-DI-301 and FP-DI-330.



NN43120-301 02.01

4 June 2010


.

306 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).


eIODI_Contact_str

Valid values are in the range between 01 and 08 for the modules with

8 contacts and between 01 and 16 for the modules with 16 contacts.

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). Note that some peripherals of National Instruments include labels and documentations where contacts start numbering at 0 up to 7 (or

0 up to 15), whereas eIO starts at 01 up to 08 (or 01 up tot 16).


FieldPoint Explorer. Range of values are 01 to 16 for FP-DI-301 module and 01 to 08 for the other digital input modules.


eIODI_ContactType_str

This parameter accepts the following values:

OS (in Dutch open schakelaar – open switch) meaning the contact is, in the base state, open and can be switched on at set and remains on until switched off at reset

OD (in Dutch open drukknop – open push button) meaning the contact is in base state open and can be switched on for a very short time and immediately fall back to the base state. Typically used for push buttons that generate alarm.

GS (in Dutch gesloten schakelaar – closed switch) meaning the contact is in base state closed and can be switched off at set and remains off until switched back on at reset.

GD (in Dutch gesloten drukknop – closed push button) meaning the contact is in base state closed and can be switched off for a very short time and immediately fall back to the base state.

An authorized of an entry typically found in this field is as follows: GD



NN43120-301 02.01

4 June 2010


.

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 24 eIO alarm description

Alarm ID

1160101

1160101

Input program

11601

Alarm description

D-INPUT

Remove after

*SENT

Priority

5

11601 D-INPUT *RESET


D-INPUT

5

eIODI_GRP_Name_str

The group name describes what group is informed on the error condition, and refers to a group defined in eKERNEL_GROUP and eKERNEL_GROUP_MEMBER table.


eIODI_MSG_str

This field describes the message that is sent to the group members. Nortel recommends that you enter descriptive text that provides the recipient sufficient information to handle the alarm condition. When selecting a message, Nortel recommends that you take into account that mobile users often lack immediate access to other information resources, such as a site map or technical specs, and keep the message length less than, or equal to, the maximum length defined in the associated eKERNEL_ALARM table.

An authorized of an entry typically found in this field is as follows: FIRE

IN ELEVATOR

eIODI_Comments_str

This field is available for an administrator to enter some descriptive text that allows location and identification of the attached input device and its usage.

Table 25 "eIO_DI sample data" (page 308)

provides sample eIO_DI module table data.



NN43120-301 02.01

4 June 2010


308 Table: eIO_DI

Table 25 eIO_DI sample data t e

S i

A

R e a

1 1 01

M o d

1 1 01

1 1 01

1 1 01

1 1 01

1 1 01

1 1 01

1 1 01

1 1 01

1 1 01

1 1 01

1 1 01

1 1 01

1 1 01

1 1 01

1 1 01

14

15

16

10

11

12

13

Contact

01

02

03

04

05

06

07

08

09

Type

OD

OS

GS

GD

OD

OD

OD

OS

OD

OS

GS

GD

OD

OD

OD

OS

ALA_Descr

D-INPUT

D-INPUT

D-INPUT

D-INPUT

D-INPUT

D-INPUT

D-INPUT

D-INPUT

D-INPUT

D-INPUT

D-INPUT

D-INPUT

D-INPUT

D-INPUT

D-INPUT

D-INPUT

DI

DI

DI

DI

DI

DI

DI

DI

DI

DI

DI

GRP_

Name

DI

DI

DI

DI

DI

Message

Digital Input 01

Digital Input 02

Digital Input 03

Digital Input 04

Digital Input 05

Digital Input 06

Digital Input 07

Digital Input 08

Digital Input 09

Digital Input 10

Digital Input 11

Digital Input 12

Digital Input 13

Digital Input 14

Digital Input 15

Digital Input 16

.



NN43120-301 02.01

4 June 2010


.

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.


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.


eIODO_Module_str

This value refers to the two-byte module identifier, specified in the

FieldPoint Explorer and in eIO_MODULE table. A typical value is between 01 and 08. Ensure that the table eIO_DO only defines digital output-contacts, thus only the contacts with a matching digital output module. Current release supports FP-DO-401 modules.

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).



NN43120-301 02.01

4 June 2010


309

.

310 Table: eIO_DO


eIODO_Contact_str


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). Note that some peripherals of National Instruments include labels and documentations where contacts start numbering at 0 up to 15, whereas eIO starts at 01 up to 16.


eIODO_Seconds_n

When the eKERNEL sends a <msgrqs> to change the state of the contact, the eIO performs the requested operation.

The state of the discrete output changes from 0 to 1.

The value eIODO_Seconds_n specifies the number of seconds a digital output remains activated. For instance, if the value 5 is specified, the signal remains 1 for 5 seconds, then the signal drops again to 0.

The special value triggers the contact for a very small amount of time. The value immediately returns to 0. In many environments the signal is too short to steer an external peripheral.

A typical value is 5 so that the discrete contact is activated for 5 seconds and then returns to an idle state.


eIODO_Comments_str

This field can contain remarks from the administrator. The value is informational only, and does not affect processing.

Table 26 "eIO_DO sample data" (page 310)

provides sample eIO_DO module table data.

Table 26 eIO_DO sample data

Site

1

1

Area

1

1

Module

03

03

Contact

01

02

Seconds

5

5

Comments



NN43120-301 02.01

4 June 2010


2

2

2

2

2

2

2

1

2

1

1

Site

1

1

1

2

2

2

2

2

2

2

2

Table 26 eIO_DO sample data (cont’d.)

1

1

1

1

1

1

1

1

1

Area

1

1

1

1

1

2

2

2

2

2

2

2

2

03

03

03

03

03

03

03

03

03

Module

03

03

03

03

03

03

03

03

03

03

03

03

03

02

03

04

05

06

07

08

Contact

03

04

05

06

07

08

01

05

06

07

08

01

02

03

04

5

5

5

5

5

5

5

5

Seconds

5

5

5

5

5

5

5

5

5

5

5

5

5

5 eIO_DO parameters 311

Comments

.



NN43120-301 02.01

4 June 2010


312 Table: eIO_DO

.



NN43120-301 02.01

4 June 2010


.

313

.

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.


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. As explained in the eKERNEL_SITE table, the term site is referred to an environment that is handled by one single eKERNEL instance.

The concept of area is introduced in DECT Messengerin release 2. Prior to this release, there were a number of constraints, for authorized there could only be one instance be defined for several modules. This limitation affected both input programs and output programs.

With the introduction of the area concept, a site can now cover several divisions. These divisions can be geographically distributed to multiple locations, or they can all be in the same location.

One advantage of the area concept is that some configuration limitations are no longer active. For instance, you can now define multiple instances of both input programs and output programs. For authorized, an immediate



NN43120-301 02.01

4 June 2010


314 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. This is most useful in larger environments (for authorized, 3 high-range iS-3090 switches covering 3 locations in an IMP network), where you can now install one eDMSAPI per area (location).

Because communication to the central eKERNEL (one per site) is now on sockets basis on the WAN, this dramatically reduces IMP network traffic, because calls can be processed locally on each location.

As a result of this design, the area field is found in many other tables.

Peripherals (better known as devices) are now identified by site, area, output program and device.


AREA_Area_Descr_str

This field allows you to enter a small description of the area. This description is for instance visualized on several windows on the eWEB interface.

An authorized of an entry typically found in this field is as follows: Campus

Sint-Jan

AREA_Area_Comments_str

This field can be used to add some additional comments and is informational only.

An authorized of an entry typically found in this field is as follows: Main area with iS-3090 switch

.



NN43120-301 02.01

4 June 2010


.

Table: eKERNEL_ALARM eKERNEL_alarm parameters

315

.

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 27

Alarm identifiers

Byte 1

Byte 2

Site identifier

Area identifier

Byte 3-5 Input program identifier



NN43120-301 02.01

4 June 2010


.

316 Table: eKERNEL_ALARM

Table 27

Alarm identifiers (cont’d.)

Byte 3 1

2

4

5

6

7

8

9 eCAP or eAPI or eESPA eSNMP eVBVOICE eCSTA eIO eWEB eSMTP_server eDMSAPI

Byte 4-5 01-99 Input program sequence number

Byte 6-7 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. These five first bytes refer to the input-program identifier.

The two remaining bytes (byte 6 and 7) are a sequence number that specified the alarm for that input program.

The first five digits match the value of the field ALA_INPGM_id_n. This helps to keep track of alarms in the complex definitions that occur in some configurations.


(denotes site 1, area 1, eCAP 01, alarm 01)

ALA_INPGM_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 the section of eKERNEL_TCPCLIENT on how to set up these input programs.

Nortel recommends that you develop a naming convention to assign values for these identifiers.

Table 28

Alarm input program identifiers

Byte 1

Byte 2

Site identifier

Area identifier



NN43120-301 02.01

4 June 2010


.

eKERNEL_alarm parameters 317

Table 28

Alarm input program identifiers (cont’d.)


Byte 3 1 eCAP or eAPI or eESPA

Byte 4-5

2

4

5 eSNMP eVBVOICE

6

7 eCSTA eIO

8

9 eWEB eSMTP_server 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.

The ALA_id_n and ALA_INPGM_id_n both form a unique key, thus one input program with ALA_INPGM_id_n value 11101 cannot have two records with the same ALA_id_n value 1110101.


ALA_Descr_str

This field is a very important parameter in the DECT Messengeralarm handling.

ATTENTION

Do not confuse this value with the ALA_Comments_str field for giving a description to the alarm.

The ALA_Descr_str contains a string of one or more characters. The eCAP alarm capture programs use these characters to find an appropriate alarm definition for a received alarm string.

The proper usage of this field is highly depending on the proprietary protocol implementation in eCAP and other input programs, such as eWEB. In many cases, some rules are defined for handling alarms from external systems.

The alarm generates some kind of string with information, and DECT

Messengermust find out how to handle the string. The retrieval of the alarm definition from the eKERNEL_ALARM table is performed using the

ALA_Descr_str field.



NN43120-301 02.01

4 June 2010


.


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. The following authorizeds are provided to clarify the usage:

Example 1: ELDAD If the alarm is described as ELDAD, alarms are sent where behavior depends on a tone code. Alarms with tone code 1,

2, 3 and 4 each have different characteristics, and need different alarm handling. In the case of ELDAD define the ALA_Descr_str values 1, 2, 3 and 4 for the 4 corresponding records.

Example 2: TELEVIC TELEVIC sends alarms where behavior depends on tone code or message contents.

If the alarm is described as TELEVIC, the system looks first for a string pattern (first blank or first xx characters as specified in the L:xx description of the INPGM_Model_str field of the eKERNEL_INPGM table (PROTOCOL

CONVERTOR – L:03). If no length (L:xx) is specified, the default value is

3. Characters of message or search until first blank character: NUR, SAN,

ASS, REA, MUG, and so on.

See documentation Table eKERNEL_inpgm.pdf.

If no such definition is found; the system looks for a matching tone code pattern (for authorized, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 or 0).

If again no definition is found, the system looks for an *OTHER definition.

Example 3 - National Instruments The National Instruments distributed

I/O modules FP-DI-300, FP-DI-301 and FP-DI-330 generate discrete input alarms, the I/O module FP-AI-100 generates analogue input alarms. Both modules are configured in eIO_MODULE, eIO_AI and eIO_DI tables. In the latter two files the alarm type can be defined, default is D-INPUT and

A-INPUT. If these defaults are used, ALA_Descr_id_str must have records for D-INPUT and A-INPUT.

Example 4 - Guarding A special feature in the eCAP input program consists of a method to verify the amount of time between two requests. If a specific type has elapsed, this can be caused by a failure in the external alarm system or the physical interface. In such case, GUARDING can be implemented. This is configured in the eKERNEL_GUARDING table. The link between eKERNEL_GUARDING and eKERNEL_ALARM is performed



NN43120-301 02.01

4 June 2010


.

eKERNEL_alarm parameters 319 through an alarm identifier, but Nortel recommends specifying GUARDING in the alarm description field.


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.

Again, this value is generally depending of the proprietary implementation of the alarm system and the attached peripherals. Some devices can send a SET and RESET indication (for authorized, a switch button van be set to on or off); others cannot generate a RESET (for authorized, a push button can only generate a push signal while pressing the contact).

In some cases you can have difficulty determining whether alarms have reset or not. In fact, some third-party alarm system vendors are not aware of the signals provided. In these cases, you must specify *SENT, to prevent alarms that do not receive a *RESET from remaining active in the system.

An authorized of an entry typically found in this field is as follows: *SENT

ALA_Prty_n

This field specifies the priority of an alarm. A low value indicates an important alarm, a high value a less important alarm. Nortel recommends that you exercise caution when assigning priorities to alarms. For some output devices, high-important alarms are shown first and low-priority alarms are shown last.

Other output programs (such as eSMTP and eASYNC) allow you to automatically confirm arrival of messages when distributed, while others require confirmation procedures based upon a call back procedure (using

CLID on eCSTA of DTMF pincode on eVBVOICE).

Nortel recommends that you begin by assigning all alarms to default priority 5 (for authorized, nurse calls, and so on) and assigning more important alarms to a lower value (1 for MUG, 2 for REA, 3 for ASS, and so on) and less important alarms to a higher value (6 for SAN, and so on). In most cases, alarm priorities are subject to discussion with those in authority on-site.



NN43120-301 02.01

4 June 2010


.



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. The value determines the allotted time for a destination party to answer the phone (which is currently required before the first user-to-user messages can be sent to the extension). Nortel recommends a value between 10 and 20 seconds.


ALA_to_Connect_n

This field specifies the number of seconds a peripheral is kept in connect state before taking further action. This parameter is ignored for all peripherals and is provided for backwards compatibility issues.


ALA_to_Queued_n

This field specifies the number of seconds a peripheral is kept in camp-on-busy state before taking further action. This parameter is ignored for all peripherals and is provided for backwards compatibility issues.


ALA_Silence_intv_n

This field specifies the number of seconds a peripheral is left quiet (idle) before repeating any outstanding messages (also referred to as pace interval).

In many cases DECT users want to have a pace interval greater than zero, so that repeated messages do not pose an interruption. Therefore the DECT Messengerkeeps track of all active alarms, stores them in an internal database, and distributes them as the image of active alarms for a device is changing.

When no changes occur, the remaining alarms are repeated every

ALA_Silence_intv_n specified number of seconds.

When a new alarm is generated and the image changes, the user is informed immediately.



NN43120-301 02.01

4 June 2010


.


On the other hand, when no changes occur, the outstanding messages are repeated at the specified interval.


(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.

This parameter is however, due to architectural reasons, currently ignored for most peripherals.

The value is used in eCSTA module release 2.8, where user-to-user messaging is also supported in alerting phase. Most other technologies of messaging are not call-oriented and do not have such requirements.


*CONNECT

ALA_Scroll_intv_n

This field specifies the number of seconds that is used as scroll interval, when peripherals allow scrolling. This parameter is, due to architectural reasons, ignored for most peripherals and is provided for backwards compatibility issues.


ALA_Group_delivery_str

This value defines the degree of message delivery that is required on delivery of a message to a group. Values can be *ALL or *ANY and is only relevant if the field ALA_Remove_after_str is set to *SENT.

If the field ALA_Repeat_intv_n is set (value is greater than 0), than this field is only relevant if ALA_Confirm_action_str is set to *YES.

If the field value is *ALL, each individual recipient handles their messages on individual basis.

If the field value is *ANY, the message is only distributed to (at least) one group member. When the first user confirms, the message is considered delivered. This can result in removal of the message for all group members. This can mean some group members do not see the message at all.



NN43120-301 02.01

4 June 2010


.



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.

Note that confirm delivery depends on a number of criteria, for authorized, alarm priority can have impact in defining whether an alarm required confirmation or not. Some other peripherals provide intrinsic message delivery (sending a normal E2 message through DMS-API) while others require use intervention (sending an urgent E2 message through DMS-API required user acknowledge). In some circumstances, special procedures apply to the confirmation action. This is defined in the corresponding eASYNC table and eSMTP table.

An authorized of an entry typically found in this field is as follows: *NO

ALA_Repeat_intv_n

This value defines the number of seconds between repeating alarm. Be careful not to confuse this entry with ALA_Silence_intv_n discussed above.

The ALA_Repeat_intv_n is in most cases 0, meaning the alarm system does not repeat active alarms. ALA_Repeat_intv_n is kept to 0 in situations where the alarm systems can set a SET and RESET, or when the alarm system sends an alarm once at SET.

The ALA_Repeat_intv_n is set to a value larger than 0 if the alarm system is incapable of sending a RESET indication, and repeats active alarms on frequent basis. When the appropriate alarms are no longer repeated, the situation is interpreted as a RESET condition. You can use this option to provide a steady repeat interval (for authorized, active alarms are repeated every 20 seconds) and a continuously repetition (repeat is not stopped after 10 repeats). When repeat interval is known, you can add a small safety factor (for authorized, add 5 to 10 seconds) and define the

ALA_Repeat_intv_n as such.




NN43120-301 02.01

4 June 2010


.


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. This demand can result is instructions to the alarm vendor to properly align relevant information in the received alarm messages, so all needed text is left-adjusted and processed in DECT Messenger.

In some environments, longer messages are relevant. In such cases, you can specify, for authorized, message lengths of 100 bytes, if input comes from, for authorized, WEB interface and output goes to peripherals that are capable of handling long messages (eSMTP, eASYNC, and so on).


ALA_Trace_b

This parameter is a Boolean value and can be either True (-1) or False (0).

Specify the value True only for those alarms that are related to eWEB input program and generated using the Send Script Message function.

These alarms are defined in the eWEB_SCRIPT table.

For all other alarms, set this value to False.


(-1)

ALA_Trace_dayToKeep_n

This value also refers to the trace function described in the ALA_Trace_b field.

Set this value to 0, unless the value ALA_Trace_b is set to True (-1). In this case, tracing is activated for the alarm, and the number of days to keep the trace data must be entered. A typical value is 14 days.

For all other alarms, set this value to 0.


ALA_Comments_str

This field can optionally be used by an administrator to store reminder information, describing, for authorized, the usage of the alarm.



NN43120-301 02.01

4 June 2010


.



Reanimation through TELEVIC.

Table 29 "eKERNEL_alarm sample data" (page 324)

provides sample eKERNEL_alarm module table data.

Table 29 eKERNEL_alarm sample data

1110208

1110209

1110210

1110211

1110212

1110213

1110301

1110302

1110401

1110501

1110502

1140101

1140102

1140103

1150101

1150102

Alarm

1110101

1110102

1110103

1110104

1110105

1110201

1110202

1110203

1110204

1110205

1110206

1110207

11105

11401

11401

11401

11501

11501

11102

11102

11102

11102

11102

11102

11103

11103

11104

11105

Inpgm

11101

11101

11101

11101

11101

11102

11102

11102

11102

11102

11102

11102

Descr

0

1

2

3

GUARDING

NUR

NUR

ASS

ASS

SAN

SAN

REA

REA

1

1

*OTHER

*OTHER

GUARDING

API SENT

API RESET

GENERIC

1

2

EVACUATION

FIRE

TEST

REA

MUG

10

10

10

10

2

2

5

1

10

10

20

20

10

10

10

1

20

999

999

Priority

3

10

10

1

2

3

10

7

7

*SENT

*RESET

*SENT

*SENT

*SENT

*RESET

*SENT

*SENT

*SENT

*RESET

*SENT

*SENT

*SENT

*SENT

Remove after

*SENT

*SENT

*RESET

*SENT

*SENT

*SENT

*RESET

*SENT

*RESET

*SENT

*RESET

*SENT

*RESET

*RESET

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...



NN43120-301 02.01

4 June 2010



Alarm

1160101

1160102

1160103

1160104

1170101

1170102

1170103

1170104

1170105

1170106

1170107

1170108

1180101

1190101

1190102

1190103

1190104

1190105

1190106

1210501

1210502

1210503

1310501

1310502

1310503

1310504

Inpgm

11601

11601

11601

11601

11701

11701

11701

11701

11701

11701

11701

11701

11801

11901

11901

11901

11901

11901

11901

12105

12105

12105

13105

13105

13105

13105

Table 29 eKERNEL_alarm sample data (cont’d.)

Descr

A-INPUT

A-INPUT

D-INPUT

D-INPUT

Short

Medium

Long

SCRIPT Message

SCRIPT Message

Short script

Medium script

Long script

SMTP

E2_MSG_N

E2_MSG_U

E2_NOODOPROEP

E2_REANIMATIE

E2_TEST_N

E2_TEST_U

1

2

3

1

2^9

NUR

NUR

Priority

999

999

999

999

10

10

10

10

1

999

999

1

1

10

2

10

999

5

2

1

1

5

999

2

10

10

Remove after

*RESET

*SENT

*RESET

*SENT

*SENT

*SENT

*SENT

*SENT

*RESET

*SENT

*SENT

*SENT

*SENT

*SENT

*SENT

*SENT

*SENT

*SENT

*SENT

*SENT

*SENT

*SENT

*SENT

*RESET

*SENT

*RESET

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

.



NN43120-301 02.01

4 June 2010



.



NN43120-301 02.01

4 June 2010


.

Table: eKERNEL_DEVICE eKERNEL_DEVICE parameters

327

.

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.


DEV_Area_id_n



DEV_id_str

This field contains a reference to the destination device as known in our internal infrastructure. When a device is, for instance, a DECT extension, this field specifies the extension number (for authorized,

865). When a mail destination is defined, this field contains a mail



NN43120-301 02.01

4 June 2010


.

328 Table: eKERNEL_DEVICE address (for authorized, [email protected]). 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 – [email protected] - eSMTP

DEV_OUTPGM_str

This field identifies the application that processes the request.

A device can be defined more than once. For authorized DECT extension 865 can be defined for eDMSAPI, eCSTA or eVBVOICE.

The indicated application handles the message using the capabilities of the infrastructure. eDMSAPI can for instance send LRMS data profile messages (non-voice-call) to extensions such as DECT C944 and i600).

eCSTA can for instance send user-to-user messages to voice-call based peripherals, such as ErgoLine D330, ErgoLine D340, Dect C311, Dect

C911, Dect C322, Dect C922, Dect C933... and eVBVOICE can inform the user with an audible message. The list of output devices can be extended in time. The supported values are currently:

• eASYNC for sending SMS to PROXIMUS or KPN and PAGING to BELGACOM

• eDMSAPI for sending E2 messages

• eCSTA for sending voice-call related user-to-user messages

• eESPA for sending messages to ESPA 4.4.4 interface

• eIO for enabling/disabling discrete output contacts

• eSMS for sending SMS message to mobile GSM phones

• eSMTP for sending mail to SMTP-compliant infrastructure

• eVBVOICE for sending audible messages



NN43120-301 02.01

4 June 2010


.

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.

An authorized of an entry typically found in this field is as follows: C4050 for eDMSAPI

DEV_Visual_dnr_str

When this field is entered for a device, the ’Visual DNR’ is used to format a message when it contains [Calling number], so the end-user is confronted with the visual DNR. The default value for this field is empty. (This field is new in release 3.0.)

Nortel recommends using this field in Nortel environments only.

An authorized of an entry typically found in this field is as follows: 2000 for

DECT handset with DNR 2000 and hardware ID 00300 (DMC)

DEV_Descr_str

This description is used to show information on devices in the eWeb module. Nortel recommends adding the name of the owner of the device.

An authorized of an entry typically found in this field is as follows: DECT:

Kristien Daneels

DEV_PinCode_str

Some business processes need a confirmation of end-user. Some technologies provide this during alarm notification, such as LRMS messaging on eDMSAPI allow using “OK” to confirm message delivery.

However, some notification technologies do not offer immediate end-user confirmation during notification: eASYNC, eSMTP, eSMS and so on.

Some modules provide inbound confirmation: eCSTA by means of inbound voice call (based upon CLIP), eVBVOICE by means of inbound voice call

(based on DTMF entered pincode) and eSMS my means of inbound SMS message (based on CLIP of mobile phone or pincode in SMS message).

With these pincodes, all messages for all devices with a matching pincode can be cleared. For authorized, pincode 12345 clears the alarms for those devices that specify 12345 in the DEV_PinCode_str field.

An authorized of an entry typically found in this field is as follows: 12345.



NN43120-301 02.01

4 June 2010


.

330 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.

The default value is 30, which means that if an alarm has a silence interval of for instance 120 seconds; the alarm is removed for this device after one hour (and set for the alternative device if defined).

For authorized, 1 => after the second retry, the alternative devices is set.

• eKERNEL Version 2.1.1 and later:

This keyword defines how many times the application tries to deliver the message before switching to an alternative device if defined in the eKERNEL_device_alt table.

The default value is 30, which means that if an alarm has a silence interval of for instance 120 seconds; the alarm is removed for this device after one hour (and set for the alternative device if defined).

The value = 0 means that the application never tries to send the message to an alternative device, and that the alarm is sent to the device every silence interval (ALA_Silence_intv_n in eKERNEL_Alarm) until the alarm is reset by, for authorized, the input program.

The value = 1 means that after 1 try, the application clears the message for this device, and sends the message to the alternative device if defined in the eKERNEL_Device_alt table.

ATTENTION

In this case, the switch to the alternative device is immediate, which means that there is no silence interval between those two calls. Therefore, be very careful that there are no loop conditions defined in the eKERNEL_device_alt table.

The value = 2 means that after the second try, the alternative device is contacted.

For authorized, 2 => after 2 times trying to send the message, the alternative devices is set.



NN43120-301 02.01

4 June 2010


.

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.


(-1).

DEV_IoRegister_b

Set this field to “false for all devices that are not assigned to eDMSAPI module.

For devices assigned to eDMSAPI module, specify True for devices that generate action using eDMSAPI module, for *IA (inbound alarm), *IC

(inbound confirm) or *LA (location alarm).

This forces a IORegistration in eDMSAPI, allowing the application to be able to monitor inbound LRMS activities on the monitored DECT handset.

An authorized of an entry typically found in this field is as follows: -1

DEV_Div_Site_id_n

This field specifies the site of the diverted device.

When a device is diverted to another device (eCSTA), the system ignores the divert in cases where the destination device is not configured in the eKERNEL_DEVICE table. When more than one device is defined the eDMSAPI device type is selected, and the corresponding site is entered in this field. If no eDMSAPI capable device is defined, the first available matching device is used, and the corresponding site is entered in this field.

An authorized of an entry typically found in this field is as follows: -1

DEV_Div_Area_id_n

This field specifies the area of the diverted device.

See DEV_Div_Site_id_n


DEV_Div_OUTPGM_Appl_str

This field specifies the output program of the diverted device.





NN43120-301 02.01

4 June 2010


.

332 Table: eKERNEL_DEVICE

DEV_Div_OUTPGM_Facility_str

This field specifies the output program of the diverted device.


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.

In future versions, eKERNEL-to-eKERNEL communications will be implemented, so alarms for devices located on another site can be sent to the remote eKernel.

An authorized of an entry typically found in this field is as follows: False (0)

DEV_Ras_Area_b

This field is a Boolean value and can be either True (-1) or False (0). The default value is False (0).

This field specifies the behavior of the eWEB-based function Send

DMS-API Message. The Send DMS-API message default only presents those devices that are defined in the eKERNEL_DEVICE table, and have output program eDMSAPI and reside on the same site and area as the eWEB input program. For authorized, if the eWEB application is defined on site 1 and area 1, the Send DMS-API Message presents the eDMSAPI devices of site 1 area 1.

Some multi-area environments require that you present devices that are configured for a remote area. You can select for each device whether the remote device is available to the local eWEB area or not.

An authorized of an entry typically found in this field is as follows: False (0)

DEV_Comments_str

This field can contain remarks from the administrator, and is informational only.



NN43120-301 02.01

4 June 2010


.

Table: eKERNEL_DEVICE_ALT eKERNEL_DEVICE_ALT parameters

333

.

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.


ALT_Dev_Area_id_n



ALT_Dev_id_str

This field defines – in combination with ALT_Dev_Site_id_n,

ALT_Dev_Area_id_n and ALT_OUTPGM_Appl_str – a device in the system. The record specifies one or more alternate devices that are to be used in case an unrecoverable error occurs when sending a message to a specified device. In case of a failure, a list of alternate devices can be processed upon successful message delivery.



NN43120-301 02.01

4 June 2010


.

334 Table: eKERNEL_DEVICE_ALT

Define the device (site, area, device and outpgm) as a valid device in eKERNEL_DEVICE table.


ALT_OUTPGM_Appl_str

The field is associated with the previous field and defines the device.


ALT_Sequence_n

This field is a sequence number to make a record definitions in eKERNEL_DEVICE_ALT unique. Nortel recommends starting with a value of 1 and incrementing by 1s.


ALT_Alt_DEV_Site_id_n

This field defines, in combination with ALT_Alt_DEV_area_id_, ALT_Alt_de v_id_str, ALT_Alt_OUTPGM_Appl_str and ALT_Alt_OUTPGM_Facility_str the alternate device.


ALT_Alt_DEV_area_id_n

This field defines, in combination with ALT_Alt_DEV_site_id_, ALT_Alt_de v_id_str, ALT_Alt_OUTPGM_Appl_str and ALT_Alt_OUTPGM_Facility_str the alternate device.


ALT_Alt_dev_id_str

This field defines, in combination with ALT_Alt_DEV_Site_id_n,

ALT_Alt_DEV_area_id_, ALT_Alt_OUTPGM_Appl_str and

ALT_Alt_OUTPGM_Facility_str the alternate device.

Check for possible loop conditions when setting up this table.


ALT_Alt_OUTPGM_Appl_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_Facility_str the alternate device.




NN43120-301 02.01

4 June 2010


eKERNEL_DEVICE_ALT parameters 335


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.


An authorized of an entry typically found in this field is as follows: C4050

ALT_descr_str

This informational field can contain some remarks (informational only)

ALT_Comments_str

This field is used for an administrator to add remarks and is used informational only.

Table 30 "eKERNEL_DEVICE_ALT parameters" (page 335)

provides sample eKERNEL_DEVICE_ALT table data.

Table 30 eKERNEL_DEVICE_ALT parameters

.



NN43120-301 02.01

4 June 2010


336 Table: eKERNEL_DEVICE_ALT

.



NN43120-301 02.01

4 June 2010


.

Table: eKERNEL_DEVICE_FORMAT eKERNEL_DEVICE_FORMAT parameters

Figure 213 eKERNEL_DEVICE_FORMAT parameters listing

337

.

FMT_OUTPGM_Appl_str

This field identifies the output program. The following options are supported: eASYNC, eCSTA, eDMSAPI, eESPA, eIO, eSMS, eSMTP and eVBVOICE.


FMT_OUTPGM_Facility_str

This field specifies the supported facility or facilities for a specified output program. See

Table 31 "Application-Facility associations" (page 337)

for supported entries. The administrator can create new facilities.

Table 31

Application-Facility associations

Application eASYNC eASYNC

Facility

PAGING

PROXIMUS



NN43120-301 02.01

4 June 2010


.

338 Table: eKERNEL_DEVICE_FORMAT

Table 31

Application-Facility associations (cont’d.)

Application eASYNC eCSTA eCSTA eCSTA eCSTA eCSTA eCSTA eCSTA eCSTA eDMSAPI eDMSAPI eDMSAPI eDMSAPI eESPA eIO eSMS eSMTP

D340

P375D

C922

C933

C944

I600

ESPA

DO

SMS

SMTP

Facility

KPN

C311

C322

C911

C922

C933

D330

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. Refer to the sample data in

Table 34 "eKERNEL_DEVICE_FORMAT sample data" (page 341)

for authorizeds.



This field specifies the number of bytes available on the second line.

In general, this value is 0 for devices with no second line and the maximum length, in case a second line is available. If only two lines are available, a smaller number of bytes is appropriate to reserve room for page indication and so on. Refer to the sample data in

Table 34

"eKERNEL_DEVICE_FORMAT sample data" (page 341)

for authorizeds.




NN43120-301 02.01

4 June 2010


.

eKERNEL_DEVICE_FORMAT parameters 339


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). In most cases, Nortel recommends that you reserve the third line for page indication and more indication, thus specifying 0 for the third line.


FMT_Page_ind_n

This field specifies the number of bytes reserved for page indication.

Recommended value is five bytes, which allows the XX/XX syntax. A lower number of characters can be used if space is limited. See

Table 32 "Page identification syntax" (page 339)

for authorized values.

Table 32

Page identification syntax

0 (no page indication)

1 +

2 +

3 X/X

4 X/X

5 XX/XX

6 XX/XX

Note: This value is only implemented on the eDMSAPI and eCSTA output programs.


FMT_Page_more_ind_n

This field specifies the number of bytes reserved for more indication.

Recommended value is 2 bytes, which allows a + syntax. A lower number of characters can be used in space is limited. See

Table 33 "More indication syntax" (page 340)

for authorized values.



NN43120-301 02.01

4 June 2010


.


0

1

2

Table 33

More indication syntax

(no more indication)

+

+

Note: This value is only implemented on eDMSAPI and eCSTA output programs.


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.

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: -1 (true)

FMT_Scroll_depth_n

This field specifies the maximum number of pages that is shown to a user.

If scroll depth is 4 and there are seven pages available, the user is only informed on the first four pages. A more indication is shown to indicate more pages, unless this is suppressed.

Note: Do not specify any value larger than 4 for the eCSTA output program, due to limitations in internal resources.


FMT_AllowEmergency_b

This field is introduced in R3.0 and defines whether the peripheral supports

Emergency LRMS Messaging. Currently this feature is only supported on

DECT C944 devices. Sending an emergency message through eDMSAPI module to a peripheral that does not support this feature, resulting in a system malfunction. Administrators must carefully assign the device facility that enables emergency calls only to peripherals that support it. Assign the facility only to peripherals that support it. To prevent problems, the default equals false, so enabling emergency calls on supported devices is performed only on demand.

Note: This value is only implemented on C944 devices.



NN43120-301 02.01

4 June 2010


.

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.

An authorized of an entry typically found in this field is as follows: two lines and indicators.

Table 34 "eKERNEL_DEVICE_FORMAT sample data" (page

341)

provides sample eKERNEL_DEVICE_FORMAT table data.

Table 34 eKERNEL_DEVICE_FORMAT sample data

Application eASYNC eASYNC

Page

5

0

More Concat

2 0

0 0

Scroll depth

999

999 eCSTA eCSTA eCSTA eCSTA eCSTA eCSTA eCSTA eCSTA eDMSAPI eDMSAPI eIO eSMTP eVBVOICE eESPA

Facility

PAGING

PROXIM

US

C311

C322

C911

C922

C933

D330

D340

P375D

C4040

C4050

DO

SMTP

VBVOIC

E

ESPA

Line 1 Line 2 Line 3

160 0 0

120 0 0

10

10

16

16

16

12

20

19

16

16

1024

32

1024

128

0

0

16

16

16

0

0

0

16

16

0

0

0

0 0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

0

5

5

0

0

0

5

5

5

0

0

0

4

4

4

4

4

4

4

4

999

999

999

999

999

-1

0

0

0

-1

-1

0

0

0

0

-1

-1

0

2

2

0

0

0

2

0

0

0

0

2

2

0

0 0 999



NN43120-301 02.01

4 June 2010



.



NN43120-301 02.01

4 June 2010


.

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.

Nortel recommends defining group identifiers using the following naming convention:

Table 35

Recommended Group identifier naming convention

Byte 1-5 Input program

Byte 1 Site of input program

Byte 2

Byte 3

Area of input program

Input program type

1 - eCAP or eAPI or eESPA

6 - eIO

7 - eWEB

8 - eSMTP_server

Byte 4-5 Input program sequence number

Byte 6 (Underscore character)

Byte 7-...

Group name



NN43120-301 02.01

4 June 2010


343

.

344 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.


31101_00001

GRP_InPGM_id_n

As described above, group identifiers are uniquely defined by combining input program identifier and group name.

The input program is the value specified in the eKERNEL_INPGM table.

Nortel recommends following the naming convention set out in

Table 36

"Recommended Group identifier naming convention" (page 344)

.

Table 36


Byte 1-5 Input program

Byte 1 Site of input program

Byte 2

Byte 3


Input program type


6 - eIO

7 - eWEB

8 - eSMTP_server

Example: 31101 denotes site 3, area 1, input program type eCAP or eAPI and input program sequence 01.


GRP_Name_str

As described above, group identifiers are uniquely defined by combining input program identifier and group name.

The input program is the value specified in the eKERNEL_INPGM table.



NN43120-301 02.01

4 June 2010


.

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. A first eCAP instance can have a different understanding for group 00001 than a second eCAP instance. In most cases the group names are determined by third-party vendors, and in many environments cannot be changed.

With this approach, you can logically link any group name and assign our internally known group members (peripherals) to them.


GRP_Descr_str

This field can have a descriptive text, to allow administrators to easily recognize the group.

An authorized of an entry typically found in this field is as follows: Intensive

Care

GRP_Comments_str

This field can also contain additional information.


"Warning: minimum 3 DECT extensions required"

Table 37 "eKERNEL_GROUP sample data" (page 345)

provides sample eKERNEL_GROUP table data.

Table 37 eKERNEL_GROUP sample data

Group id

31101_00001

31102_00001

31102_24960

31103_00001

31601_00001

31701_eASYNC

31701_eDMSAPI

Input program

31101

31102

31102

31103

31601

31701

31701

Group name

00001

00001

24960

00001

00001 eASYNC eDMSAPI

Description

Test from eCAP

Test from eCAP

Test Televic

Test from eAPI

Test from eIO

Test to eASYNC

Test to eDMSAPI

Comments



NN43120-301 02.01

4 June 2010


346 Table: eKERNEL_GROUP

Table 37 eKERNEL_GROUP sample data (cont’d.)

Group id

31701_eIO

31701_eSMTP

31801_00001

Input program

31701

31701

31801 eIO

Group name eSMTP

00001

Description

Test to eIO

Test to eSMTP

Test from eSMTP

Comments

.



NN43120-301 02.01

4 June 2010


.

Table: eKERNEL_GROUP_AUTH eKERNEL_GROUP_AUTH parameters

Figure 215 eKERNEL_GROUP_AUTH parameters listing

347

.

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.

The table eKERNEL_GROUP_AUTH allows an administrator to grant access to eWEB users. In eWEB, there is a group maintenance function: Work with Groups. User without all object authority in their eWEB_USER_AUTH table definition can see only those groups that are defined in the eKERNEL_GROUP_AUTH table.

A typical authorized is a hospital, where the person responsible for a department is allowed to maintain only their own departmental groups, and not the groups of other departments.


31101_00001

GRPA_UserID_str

This field specifies the username that is granted access to the group. This value must match the definition of the users in eWEB_USER_AUTH table.



NN43120-301 02.01

4 June 2010


348 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.

An authorized of an entry typically found in this field is as follows: FMI

GRPA_Comments_str

This field can contains remarks of an administrator, and is informational only.

“eKERNEL_GROUP_AUTH parameters” (page 347)

provides sample eKERNEL_GROUP_AUTH table data.

Table 38 eKERNEL_GROUP_AUTH sample data

Group id

31101_00001

31102_00001

31102_24960

FMI

KDS

*ALL

User id Comments

.



NN43120-301 02.01

4 June 2010


.

Table: eKERNEL_GROUP_MEMBER eKERNEL_GROUP_MEMBER parameters

Figure 216 eKERNEL_GROUP_MEMBER parameters listing

349

.

GRPM_GRP_id_str

The field defines a unique identifier for a group. The field is a unique key in the database.

Nortel recommends defining group identifiers using the following naming convention:

Table 39


Byte 1-5 Input program

Byte 1

Byte 2

Byte 3

Site of input program


Input program type



NN43120-301 02.01

4 June 2010


.

350 Table: eKERNEL_GROUP_MEMBER

Table 39

Recommended Group identifier naming convention (cont’d.)

Byte 6

Byte 7-...


6 - eIO

7 - eWEB

8 - eSMTP_server

Byte 4-5

9 - eDMSAPI

Input program sequence number

(Underscore character)

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.

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. See documentation Table_eKERNEL_GROUP_AUTH.pdf.


31101_00001

GRPM_Dev_id_str

This field contains a reference to the destination peripheral as it is known in the internal infrastructure. The site, area, output program application, and device identifier identify peripherals. These four values define a peripheral unambiguously.

A number of sample records are shown in

Table 40 "GRPM_Dev_id_str sample records" (page 350) .

Table 40

GRPM_Dev_id_str sample records

1

1

1

1

1

Site

1

1

1

1

1

Area Device

32479638338

865

9789074

475353215 [email protected]

Output program eASYNC eDMSAPI eASYNC eASYNC eSMTP

Facility

PROXIMUS

C4050

PAGING

PROXIMUS

SMTP



NN43120-301 02.01

4 June 2010


.

eKERNEL_GROUP_MEMBER parameters 351

Table 40

GRPM_Dev_id_str sample records (cont’d.)

1

1

1

1

1

1

1

1

1

1

Site

1

1

1

1

1

1

1

Area

1

1

1

Device

DO_03_01

DO_03_02

DO_03_03

DO_03_04

DO_03_05

DO_03_06

DO_03_07

DO_03_08 [email protected]

[email protected]

Output program eIO eIO eIO eIO eIO eIO eIO eIO eSMTP eSMTP

DO

DO

Facility

DO

DO

DO

DO

DO

DO

SMTP

SMTP

GRPM_Dev_Site_id_n

This value refers to the site identifier of the input program that is associated with the group. Refer to

“Table: eKERNEL_SITE” (page

377)

for more details on the site parameter.


GRPM_Dev_Area_id_n

This value refers to the area identifier of the input program that is associated with the group. Refer to

“Table: eKERNEL_AREA” (page

313)

for more details on the site parameter.


GRP_OUTPGM_Appl_str

This field provides the output program application identifier of the application that processes the request.

A device can be used more than once depending of the used output program. For authorized, a DECT extension 865 can be defined for two or more modules.

The indicated application handles the message using the capabilities of the infrastructure. For authorized, the eDMSAPI module can send

E2 data profile messages (non-voice call-based) to extensions, such as

DECT C4040 and C4050. The supported values are shown in

Table 41

"Supported output applications" (page 352)

:



NN43120-301 02.01

4 June 2010



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. The active period ends at the time specified in GRP_To_str.

An authorized of an entry typically found in this field is as follows: 00:00

GRP_To_str


GRP_To_str denotes time when the defined device ceases to be an active member of the specified group GRP_Name_str. For authorized, 23:59 indicates the group-membership expires at midnight, and 12:00 indicates that the group-membership expires at noon. The active time period begins at the time specified in GRP_From_str.

Note 1: GRP_From_str can be larger than GRP_To_str: In this case, a job can start at 21:00 and end at 06:00 (night-shift).

Note 2: A device can be active from for more than one period of time on a given day. For authorized: 08:00-12:00 and 13:15-17:30; in this case, two group members must be defined, one of 08:00-12:00 and another with 13:15-17:30.

To clarify the possible values, authorizeds are shown in

Table 42 "Group member schedule authorizeds:" (page 353) .



NN43120-301 02.01

4 June 2010


Table 42

Group member schedule authorizeds: eKERNEL_GROUP_MEMBER parameters 353

.

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


Tuesdays. Accepted values are True (-1) or False (0). When -1 is specified, the group-member record is active on Tuesdays. When 0 is specified, the record is not active on this day.


GRP_Wed_b


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.


GRP_Thu_b


Thursdays. Accepted values are True (-1) or False (0). When -1 is specified, the group-member record is active on Thursdays. When 0 is specified, the record is not active on this day.


GRP_Fri_b


Fridays. Accepted values are True (-1) or False (0). When -1 is specified, the group-member record is active on Fridays. When 0 is specified, the record is not active on this day.



NN43120-301 02.01

4 June 2010


.



GRP_Sat_b


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.


GRP_Sun_b


Sundays. Accepted values are True (-1) or False (0).When -1 is specified, the group-member record is active on Sundays. When 0 is specified, the record is not active on this day.


GRP_Holiday_b

This value specifies whether the group-member record is active on holidays. Accepted values are True (-1) or False (0). When -1 is specified, the group-member record is active on holidays. When 0 is specified, the record is not active on this day.

Note: The term Holiday refers to the dates defined in the eKERNEL_HOLIDAY table. At installation time, a few dates are defined.

The tables must be maintained by an administrator. You can use this calendar for other purposes, such as indicating official closing days, if this is suitable to your working environment.


GRPM_Activate_timestamp_str

This field specifies the timestamp when the record becomes activated. 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.

This functionality allows to anticipate on future changes in availability of staff, and is typically used in environments where planning is needed for staff, regimes, changing schedules, holiday period, and so on.


20010101000000



NN43120-301 02.01

4 June 2010


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.

This functionality allows to anticipate on future changes in availability of staff, and is typically used in environments where there is need for on-front planning of staff, regimes, changing schedules, holiday period, and so on.


20991231235959

GRP_Comments_str

This field can optionally be used by an administrator to store reminder information, describing, for authorized, a description of the file usage.

An authorized of an entry typically found in this field is as follows: Backup of regular anesthetist during holidays

.



NN43120-301 02.01

4 June 2010



.



NN43120-301 02.01

4 June 2010


.

Table: eKERNEL_GUARDING eKERNEL_GUARDING parameters

Figure 217 eKERNEL_GUARDING parameters listing

357

.

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.


GUA_From_str


GUA_From_str denotes the start of the time interval during which the guarding facility is active. If the eKERNEL module does not receive any requests (message request, configuration request, and so on) from the input program during the GUA_Timeout_n interval, a guarding alarm is activated.

An authorized of an entry typically found in this field is as follows: "00:00"



NN43120-301 02.01

4 June 2010


358 Table: eKERNEL_GUARDING

GUA_To_str


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.

Note 2: A device can be active from for more than one period of time on a given day. For authorized: 08:00-12:00 and 13:15-17:30; in this case, two group members must be defined, one of 08:00-12:00 and another with 13:15-17:30.

If the same time is specified in more than one case, only the first record is processed.

Table 43 "Guarding schedule authorizeds" (page 358)

shows authorizeds of Guarding schedules.

Table 43

Guarding schedule authorizeds

.

GUA_Mon_b


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.


GUA_Tue_b


Tuesdays. Accepted values are True (-1) or False (0). When -1 is specified, the group-member record is active on Tuesdays. When 0 is specified, the record is not active on this day.




NN43120-301 02.01

4 June 2010


.

eKERNEL_GUARDING parameters 359

GUA_Wed_b


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.


GUA_Thu_b


Thursdays. Accepted values are True (-1) or False (0). When -1 is specified, the group-member record is active on Thursdays. When 0 is specified, the record is not active on this day.


GUA_Fri_b


Fridays. Accepted values are True (-1) or False (0). When -1 is specified, the group-member record is active on Fridays. When 0 is specified, the record is not active on this day.


GUA_Sat_b


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.


GUA_Sun_b


Sundays. Accepted values are True (-1) or False (0). When -1 is specified, the group-member record is active on Sundays. When 0 is specified, the record is not active on this day.


GUA_Timeout_n

This field specifies the timeout in seconds, before the defined guarding alarm is activated if no request (configuration request, message request, and so on) of the input program is received by the eKERNEL.



NN43120-301 02.01

4 June 2010


.


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.


GUA_msg_str

This field describes the message that is sent to the group members. Nortel recommends that you enter descriptive text that provides the recipient sufficient information to handle the alarm condition. Mobile users often lack immediate access to other information resources, such as a site map or 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.


HONEYWELL NOT ACTIVE

GUA_GRP_Name_str

The group name describes who receives the guarding alarm, and refers to a group defined in eKERNEL_GROUP and eKERNEL_GROUP_MEMBER table.


GUARDING

GUA_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).

Refer to


for more information on naming conventions.


Refer to

Table 44 "Examples of alarm characteristics" (page 361)

for more authorizeds.



NN43120-301 02.01

4 June 2010


eKERNEL_GUARDING parameters 361

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.

.



NN43120-301 02.01

4 June 2010



.



NN43120-301 02.01

4 June 2010


363

.

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. Do not use any formatting symbols, such as spaces, slashes, and so on.

Note the days must be entered manually, a process that must be repeated on regular basis. Nortel recommends that you specify one person in the organization who is responsible for maintaining the holiday information, and for notifying the administrator.

In the excerpt of the eKERNEL_GROUP_MEMBER definition given in

Table 45 "Holiday definition authorizeds" (page 363) , extension 865 of

group 00001 is not processed on holidays; the remaining members are processed on holidays.

Table 45

Holiday definition authorizeds

GRP_Name_str

00001

00001

GRP_Holiday

1

2

GRP

865

866

GRP_Holiday_b

0

-1



NN43120-301 02.01

4 June 2010


364 Table: eKERNEL_HOLIDAY

Table 45

Holiday definition authorizeds (cont’d.)

GRP_Name_str

00001

00001

GRP_Holiday

3

4

GRP

867

868

GRP_Holiday_b

-1

-1


20050815 (denotes a fictional national holiday, August 15 th , 2005).

Holiday_Comments_str

This field can contain remarks from an administrator and is used only for informational purpose. Refer to

Table 46 "Holiday comments authorizeds"

(page 364)

for authorizeds of Holiday comments values.

Table 46

Holiday comments authorizeds

Holiday_str

20050101

20050501

20050721

20050815

Holiday_Comments_str

National Holiday

.



NN43120-301 02.01

4 June 2010


.

Table: eKERNEL_INPGM eKERNEL_INPGM parameters

Figure 219 eKERNEL_INPGM parameters listing

365

.

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. Nortel recommends the following naming convention:

Table 47

Recommended naming strategy for input programs

Byte 1

Byte 2

Byte 3-5

Site identifier

Area identifier

Input program identifier



NN43120-301 02.01

4 June 2010


.

366 Table: eKERNEL_INPGM

Table 47

Recommended naming strategy for input programs (cont’d.)

Byte 3

Byte 4-5

1

2

4

5

8

9

6

7

01-9

9 eCAP or eAPI or eESPA eSNMP eVBVOICE eCSTA eIO eWEB eSMTP_server eDMSAPI



Using this method, the identifier indicates the site, area, input program application, and sequence number.


INPGM_Site_id_n

This field specifies the number of the site, as defined in eKERNEL_SITE table. In most cases this is 1.


INPGM_Area_id_n

This field specifies the number of the area, as defined in eKERNEL_AREA table. In most cases this is 1.


INPGM_Appl_str

This field indicates the specification of the input program. There is a predefined list of supported values; each of them refers to a module.

In the current release only the following values are supported: eAPI, eCAP, eESPA, eSNMP, eVBVOICE, eCSTA, eIO, eWEB and eSMTP_server. Other modules can be added to the list in future releases.

The recommended naming convention dictates the use of an appropriate value for the field INPGM_id_n. The eCAP and eAPI input programs have identities, such as xx1xx, and the eVBVOICE input programs have identifiers xx4xx and so on.

An authorized of an entry typically found in this field is as follows: eAPI



NN43120-301 02.01

4 June 2010


.

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.

An authorized of an entry typically found in this field is as follows: *BASE

INPGM_Model_str

The behavior of different modules depends to the alarm system and manufacturer, and is in most cased model related. You must enter a valid value in this field. Refer to

Table 48 "Valid model values" (page 367)

for an overview of valid values in current release.

Table 48

Valid model values eCAP eCAP eCAP eCAP eCAP eCAP eCAP eCAP eCAP eCAP eCAP eCAP eCAP eCAP eCAP

Application eAPI eCSTA eCAP eCAP eCAP eCAP eCAP

Manufacturer

API

CSTA

ARITECH

ARGINA

BEMAC

BEMAC

ELDAD

GENERIC

GENERIC

GENT

GENT

M-TECH

NIRA

TELEVIC

VSK

VSK

VSK

WORMALD

TYCO

WORMALD

WORMALD

WORMALD

Model

*BASE

INCOMING CALL

*BASE

*BASE

DIANA 1

DIANA 2

L:48-0:RC-1:SR-2:SS-3:SS-4:SR

*BASE

TYCO (see PSI for details)

3400

VIGILON EN54

ESPRESSO

*BASE

PROTOCOL CONVERTOR – L:03

DE LICHTERVELDE

OLV VAN VREDE

ST-JOZEF

*BASE

MINERVA 80

L:01

*BASE

1



NN43120-301 02.01

4 June 2010


.


Table 48

Valid model values (cont’d.) eCAP eESPA eESPA eESPA eDMSAPI eIO eSNMP eSMTP_server eDMSAPI eVBVOICE eWEB

WORMALD

ESPA

ESPA

ESPA

DMSAPI

NATIONAL-

INSTRUMENTS

SNMP

SMTP

DMSAPI

VBVOICE eWEB

G:EIPM

*BASE

VSK (see PSI for details)

ASCOM (see PSI for details)

*BASE

*BASE

*BASE

*BASE

*BASE

*BASE

*BASE

INPGM_Bidir_b

This field defines when the protocol is bidirectional to eKERNEL or not. In all cases, the value is 0 (False), only eCAP of TELEVIC model

PROTOCOL CONVERTOR – L:03 is –1 (True).

The flag that indicates bidirectional behavior defines whether external alarm system must be informed on successful or failed message delivery.

Currently, there is only one implementation of such a bidirectional protocol.


INPGM_Resource_str

This value must be set to blanks for the modules eAPI, IO, SMTP_server,

VBVOICE and WEB.

The value must be set to the COMxx for the module eCAP. The indication

COMxx must specify an available and valid COM port (that is not in use for other resources, is exclusively reserved, and is connected to the alarm system).

An authorized of an entry typically found in this field is as follows: COM01

INPGM_Settings_str

This value must be set to blanks for the modules eAPI, IO, SMTP_server,

VBVOICE and eWEB.



NN43120-301 02.01

4 June 2010


.


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.


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.

This value defines whether alarms from the defined system must automatically create a group in eKERNEL_GROUP table and a group member in the eKERNEL_GROUP_MEMBER table and a device in eKERNEL_DEVICE table. In most cases, the alarm system is unaware of the range of groups and devices and need manual configuration. In this case, the value is 0 (False).

In some cases, external parties can provide a valid DECT number in alarm datastreams. This can be because the external parties are aware of the infrastructure and number scheme of the DECT extension, or have administrative tools available in the alarm systems that allow them to adjust the alarm information according to the DECT Messenger number scheme. This means the alarm systems are capable of sending alarms containing correct destination numbers. Otherwise, they can provide a valid DECT number in their alarm data streams.

When the alarm system provides valid device names in the alarm string, you can choose to eliminate the need of defining the infrastructure over again in the eKERNEL_GROUP, eKERNEL_GROUP_MEMBER and eKERNEL_DEVICE tables.

ATTENTION

Carefully evaluate whether you trust the external parties in ALWAYS providing valid information. If you do, set the value to 1 (True), indicating automatic creation of groups, group members, and devices.

Nortel recommends using a value of 0 (False) unless you are fully aware of the risks involved, for authorized, in receiving invalid devices.

If you activate this function, you must indicate in the fields INPGM_Default

_DEV_OUTPGM_str and INPGM_Default_DEV_OUTPGM_facility_str the additional parameters that are needed for the auto—configuration process.




NN43120-301 02.01

4 June 2010


.


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. A typical value is C933, which assumes that all devices that are automatically created for this input program are to be processed by the C933 application.

See the eKERNEL_DEVICE information for a list of supported output programs.


INPGM_Default_DEV_OUTPGM_facility_str

The field INPGM_AutoCreateGRP_b allows you to indicate whether auto-create is enabled or disabled.

If O was specified, the INPGM_Default_DEV_OUTPGM_facility_str is ignored.

If -1 was specified, the INPGM_Default_DEV_OUTPGM_facility_str is used to indicate the facility that is associated with the device that is created automatically in the eKERNEL_DEVICE table. A typical value is C4050, which assumes that all devices that are automatically created for this input program are sharing the same facility C4050. As a result, auto-creation is typically reserved for environments where the peripherals are somewhat standardized.

See

“Table: eKERNEL_DEVICE” (page 327) , and

“Table: eKERNEL_DEVICE_FORMAT” (page 337) , for more information on

defining device facilities.


INPGM_Descr_str

This field allows you to enter descriptive text, which is visible in the eKERNEL module, in the associated input program and in some web-based functions.

An authorized of an entry typically found in this field is as follows: Televic

Protocol Convertor



NN43120-301 02.01

4 June 2010



INPGM_Comments_str


.



NN43120-301 02.01

4 June 2010



.



NN43120-301 02.01

4 June 2010


.

Table: eKERNEL_MESSAGE_FORMAT

373

eKERNEL_MESSAGE_FORMAT parameters

.

Msg_Ala_id_n

This field refers to the unique alarm identifiers as specified in the eKERNEL_ALARM table. See


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).

Refer to


for more information on naming conventions.

Table 49

Alarm identifiers

Byte 1

Byte 2

Site identifier

Area identifier



2 eSNMP

4

5 eVBVOICE eCSTA

6

7 eIO eWEB

8 eSMTP_server



NN43120-301 02.01

4 June 2010


.

374 Table: eKERNEL_MESSAGE_FORMAT

Table 49

Alarm identifiers (cont’d.)

Byte 4-5

9

01-9

9 eDMSAPI


Byte 6-7 Alarm sequence number


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. When definitions are found in the MESSAGE_FORMAT table, an internal preprocessing can reformat the message, either completely replacing the message or manipulating the message by means of a prefix and suffix.

Refer to

Table 50 "eKERNEL_MESSAGE_FORMAT sample data" (page

375)

for authorizeds on message formats. Messages are built based upon fixed characters and the [message] special value, which is replaced by the original message text, as follows:

• A format AA [message] translates Hello world into AA Hello world.

•

A format FIRE ALARM translates Hello world into FIRE ALARM.

An authorized of an entry typically found in this field is as follows: see

Table 50 "eKERNEL_MESSAGE_FORMAT sample data" (page 375) .

Msg_VBVoice_phrase_str

The default value for this field is blank. The value is currently ignored, unless the output program eVBVOICE is used. Since eVBVOICE sends its outbound information through audio and not through alphanumeric information, translation of a message into an audio file needs to be defined.

In the current release there is no text-to-speech facility in the product.

Therefore, each alarm identifier needs to be predefined with a prerecorded audio wave file. Refer to the eVBVOICE documentation for more information.


EvacuationSET.wav

Msg_descr_str

This describes the conversion process. This field is informational only.



NN43120-301 02.01

4 June 2010


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 50 eKERNEL_MESSAGE_FORMAT sample data

Msg_Ala_id_n

1110101

1110102

1110103

1110104

1120105

1110201

1110202

1110203

1110203

Msg_msg_str

AA [message]

AI [message]

AC [message]

CC [message]

BRANDALARM

BEMAC [message]

ALARM

BEMAC [message]

BRAND [message]

TECHN [message]

Msg_VBVoice_phrase_str

Fire.wav

Wormald_fire.wav

Wormald_technical.wav

.



NN43120-301 02.01

4 June 2010


376 Table: eKERNEL_MESSAGE_FORMAT

.



NN43120-301 02.01

4 June 2010


.

Table: eKERNEL_SITE eKERNEL_SITE parameters

377

.

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. Nortel recommends using site 1 for the first site, and increase the value by one for other sites that are added in time. If two sites have neither communications nor any interference, both sites can in theory use the same number. However, if integration is planned, give different sites different numbers.



NN43120-301 02.01

4 June 2010


.

378 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.


CFG_Site_Descr_str

This field specifies a brief description of the site; usually the name of the institution or the name of the city is entered here. You can also enter, for authorized, your Nortel customer number.

An authorized of an entry typically found in this field is as follows: Number

One Systems

CFG_Site_Admin_name_str

This field specifies the name of the system administrator who is responsible within the institution for the installation. This is usually the name of the help desk, the IT department or the person responsible of the

PBX infrastructure. The name is displayed in some user interfaces as the person to contact to request more information.

An authorized of an entry typically found in this field is as follows: Francis

Missiaen

CFG_Site_Admin_e-mail_str

This field specifies a valid e-mail address of the person or department specified in CFG_Site_Admin_name_str. In the current release, the field is informational only. If you install the eWEB module, Nortel recommends that you enter the e-mail address while configuring the Apache Web

Server 3.1.20.

An authorized of an entry typically found in this field is as follows: [email protected]

CFG_Site_eKERNEL_ip_str

This field specifies the local IP address of the system.

Note: It is required to assign a fixed IP address for the DECT

Messenger.

You can determine the IP address of the system with the IPCONFIG command (Click Start on the Windows task-bar, and choose Run >cmd.

Enter the command IPCONFIG ). You must – prior to connecting the system to the network – contact the network administrator and request a valid IP address. If DHCP server is in place, check for an IP address that



NN43120-301 02.01

4 June 2010


.

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.


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. However, Nortel recommends that you avoid using ports in the range of 0 and 1024, as these ports are likely to used by other applications.

Note: You can use the NETSTAT command to find out what ports are in use. When all required service is installed (for authorized,

DMSAPI-service, CSTA_service, PC Anywhere, Web Server, SMTP

Server, and so on), you can find out what ports are currently in use.

Click Start in the Windows task-bar and choose Run > cmd. Enter the command NETSTAT/A to display an overview of TCP/IP ports is use.

The default value 9000 is usually acceptable. Although current release does not implement eKERNEL-to-eKERNEL communication, the eKERNEL always binds a socket to the port that is reserved for eKERNEL to eKERNEL traffic in a multi-site configuration. In single site configurations, you still must enter this value. The eKERNEL module always makes this sockets connection active, even in single site configurations.


CFG_Site_eKERNEL_socket_str

This value specifies the behavior of the socket connection reserved for eKERNEL-to-eKERNEL communication. You must always specify the value Close after send here. Other preserved values are Keep socket open and Close after receive , but are currently unsupported.

An authorized of an entry typically found in this field is as follows: Close after sent

CFG_Connectionstring_DATA_str

This field specifies the connection string, which contains information used for establishing a connection to the Messenger_DATA database. A complete connection string contains all the information needed to establish a connection. The connection string is a series of keyword/value pairs separated by semicolon.

The connection string depends on which Database Engine is used.



NN43120-301 02.01

4 June 2010


.


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.

SQL server 2000 Desktop Engine (residing on Messenger PC)

For authorized, Provider=SQLOLEDB.1;Persist Security Info=False;U ser ID=sa;Password=philips;Initial Catalog=Messenger_DATA;Data

Source=127.0.0.1;

4.

SQL Sever resides on host SQLSERVER


Source=SQLSERVER

5.

SQL Sever resides on host 192.168.1.30


Source=192.168.1.30;

6.

SQL Sever resides on same system as MESSENGER


Source=127.0.0.1;

CFG_eLOG_Path_str

This field specifies the path where the daily log files are stored, in a comma separated format.

This field is only relevant if the eLOG licence is available.

If the value *NONE is set, the logging functionality is disabled.


C:\SOPHO Messenger\eLOG

CFG_eLOG_nmbr_days_n

This field specifies the number of days the eLOG-files are kept online available. Nortel recommends specifying at least 30 days. The parameter is introduced in R3.0 and refers to the eLOG functionality that generates in eKERNEL comma separated files located in C:\SOPHO



NN43120-301 02.01

4 June 2010


.

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.


CFG_Connectionstring_CFG_str

This field is reserved for future releases and is not implemented yet. The default value is shown below:

Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\SOPHO

Messenger@Net\Mdb\Messenger_CFG.MDB

CFG_log_nmbr_days_n

This field specifies the number of days the log-files are kept online available. This value is always used by eKERNEL. The other modules start with a hard-coded value of 14 days, and contact eKERNEL to request the configuration. Once the configuration is received, the modules continue work with the specified number of days. Note the modules other that eKERNEL only purge old log files at midnight. Nortel recommends specifying at least 14 days for this parameter.

Special value 0 indicates no cleanup occurs. This means log 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.


CFG_log_path_str

This field specifies the logging path for eKERNEL only. Other modules use the drive specified in the command-line parameters of the shortcut

(for authorized, /Log drive:C) in combination with a hard-coded path

(C:\SOPHO Messenger@Net\Log).


C:\SOPHO Messenger@Net\Log



NN43120-301 02.01

4 June 2010


.


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 <msgrqs> does not receive a <msgrpy>.

This helps establishing internal recovery for non-responding devices and peripherals. Nortel recommends that you specify 600 for this value.


CFG_Watchdog_com_port_str

This field specifies the usage of an optional watchdog configuration.

The default value is *DISABLED, indicating no watchdog function is available. If a Watchdog board is installed, you must specify the COM port here (for authorized, COM03). If a watchdog is operational, the system signals error conditions using a watchdog board configured on the specified COM-resource. An attached relay contact can generate an audible or visible alarm notification to signal the error condition.

An authorized of an entry typically found in this field is as follows: COM03

CFG_Watchdog_interval_n

This field specifies, in combination with CFG_Watchdog_com_port_n, the behavior of a Watchdog board.

• If *DISABLED was specified, the value must be set to 0.

• If a COM port was specified to activate the card, an interval can be specified. The value indicates the frequency eKERNEL sends a control signal to the card.

When eKERNEL fails to send the signal at the specified interval (for authorized, because of a hardware failure, operating system failure, eKERNEL failure, eKERNEL stopped, and so on.) the card detects the error condition and triggers an alarm, if the Watchdog is configured correctly. A typical value is between 10 and 60 seconds, but must match the card configuration. Large values can slow down alarm notification, while very small values unnecessarily consume system resources.


CFG_Watchdog_cmd_str

This field specifies the signal that is sending to the COM port is a 5-byte packet that includes a checksum: [0x01][0x57][0x84][CFG_Watchdog_c md_str][checksum].

The default value is 0x21.



NN43120-301 02.01

4 June 2010


.

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. The value is used to generate unique keys in the

Messenger_DATA database table RQS_IN. Resetting the value without cleaning up RQS_IN can result in system failure and is unsupported.

ATTENTION

Because table values are, for performance reasons, retrieved at startup of eKERNEL, and committed at close down of eKERNEL, never stop the eKERNEL using any method other than gracefully shutting down the application with the close button. Abnormal shutdown can result in problems when the system is started. Nortel recommends the use of a UPS. Problems due to system power failure are unsupported.


(never change the current value manually)

CFG_OUTRQS_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_OUTRQs_id_n is a number that is used to generate unique numbers to outgoing message requests. Manipulation with this value can result in system malfunction. The value is used to generate unique keys in the Messenger_DATA database. Resetting the value without cleaning up the appropriate database can result in system failure and is unsupported.

ATTENTION

Because table values are, for performance reasons, retrieved at startup of eKERNEL, and committed at close down of eKERNEL, never stop the eKERNEL using any method other than gracefully shutting down the application with the close button. Abnormal shutdown can result in problems when the system is started. Nortel recommends the use of a UPS. Problems due to system power failure are unsupported.

An authorized of an entry typically found in this field is as follows: 4 (never change the current value manually)

CFG_Comments_str

This field provides space for the administrator to enter comments, such as reminder information, describing, for authorized, the full name of the site.



NN43120-301 02.01

4 June 2010




"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 t e

S i

Description Admin

3 Sample Site 3 Francis

Missiaen francis.missiaen@

1s.be

Table 52 eKERNEL_SITE sample data (continued)

Mail Address

10.110.50.1

38

...

...

days

1

Log

Log path

C:\SOPHO

Messenger@net

Garbage

600

Watch dog

*DISAB

LED

1

0

I n t v

Port

9000

C m d

0x

21

I n

R q s

58 4

O u

R q s

Socket

Close after send

Comments

...

...

.



NN43120-301 02.01

4 June 2010


.

Table: eKERNEL_TCPCLIENT eKERNEL-TCPCLIENT parameters

385

.

TCPCLIENT_site_id_n

This field refers to the site ID specified in the eKERNEL_SITE table.

Usually this field has value 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. In this client/server model, the eKERNEL is TCP server and the remaining modules are TCP client.

At startup the eKERNEL must initiate a number of socket connections, and must listen on a specific port until an inbound socket connection is received from the client module.

The eKERNEL_TCPCLIENT table described this list of adjacent modules, and, for each instance of the module, indicates the specific port number.

Note: The adjacent modules also must know what port is reserved for them. This is implemented for most modules through a command line parameter string that is defined in the shortcut of the modules.

The administrator must carefully assign the port numbers and use the matching port number in the creation of the shortcut.



NN43120-301 02.01

4 June 2010


.

386 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. In theory, the modules can have any valid value between 0 and

65535, however Nortel recommends against using the following:

• port 0 (which results in a random port generation, and so is unsuitable for a server)

• a common port (21, 23, 25, 80, and so on)

Nortel recommends using the range 3000 to 3999 for assigning ports to modules, and using the Area number as the second digit of the port number. This means the range 31xx is used for modules of area 1, 32xx for modules of area 2, and so one. The last two digits can be a number starting at 01 and incrementing by one for the additional modules. See the sample data for more information.

An authorized of an entry typically found in this field is as follows: 3101 (for the first module on area 1)

TCPCLIENT_Area_id_n

This field refers to the area a specified in eKERNEL_AREA table. Usually this field has value 1


TCPCLIENT_INPGM_id_n

When an output-only module is specified (for authorized, eASYNC, eDMSAPI, eSMTP, and so on), the value must always be set to 0. This indicates the module is not capable of generating alarms, and is not familiar to the concept of input programs.

When an input-capable module is specified (for authorized, eAPI, eCAP, eSMTP_server, eWEB, and so on), a value other than 0 must be specified.

This field specifies the unique identifier of the input program.

As specified in the eKERNEL_INPGM and eKERNEL_ALARM table related section, Nortel recommends establishing a naming convention for script messages.

Table 53

Recommended input program identifiers naming convention

Byte 1

Byte 2

Site identifier

Area identifier



NN43120-301 02.01

4 June 2010


.

eKERNEL-TCPCLIENT parameters 387

Table 53

Recommended input program identifiers naming convention (cont’d.)



Byte 4-5

2

4

5 eSNMP eVBVOICE

6

7 eCSTA eIO

8

9 eWEB eSMTP_server eDMSAPI

01-99 Input program sequence number


With the guidelines above, the identifier implies the site, area, input program application, and sequence number.

This value is refers to the unique identifier defined in the eKERNEML_IN

PGM table. This unique identifier is also found in the eKERNEL_ALARM table, where available alarm types are defined for each input program.


TCPCLIENT_pgm_name_str

This field refers to any of the list of available modules that can be attached to eKERNEL. This list includes modules that are input only, output only, or capable of both input and output.

This list of supported modules currently includes: eAPI, eASYNC, eCAP, eESPA, eCSTA, eDMSAPI, eIO, eSMTP, eSMTP_server, eVBVOICE and eWEB. Other modules can be included in the future.

An authorized of an entry typically found in this field is as follows: eCAP

TCPCLIENT_socket_str

This field defines what happens to an inbound socket connection, when eKERNEL receives data. The following values are supported: Keep socket open, Close sockets after send, or Close sockets after receive.

As the values imply, you can choose to keep the link open, close the link after receiving data, or close the link after sending data.



NN43120-301 02.01

4 June 2010


.


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. This is a major issue, because closing a connection too soon can prevent eKERNEL from sending a feedback to the eWEB module.

Note 2: When eAPI is used, you have the choice to specify any value.

The correct value depends on a number of factors, one of them is the question whether the port is dedicated for one eAPI-based interface or shared between multiple instances of eAPI-based interface. Nortel recommends that you define Keep socket open. This requires a dedicated port for each eAPI. However, if external applications access the system through ad hoc requests to eKERNEL, you must specify the value Close after receive to free the resources for other inbound requests.

An authorized of an entry typically found in this field is as follows: Keep

socket open (required for all modules, except eWEB or eAPI).

TCPCLIENT_Environment_str

Use this field to define on what system the instance of the module resides.

In most cases all modules reside on a central system, so a single PC server runs eKERNEL, eDMSAPI, eCAP, and so on.

In some environments, multiple PC servers are used. The modules of

Messenger@Net run on a central system where the eKERNEL runs; other modules reside on a distributed system.

The field TCPCLIENT_Environment_str specifies on what system the module runs. This information is used by eGRID to generate the shortcuts for the task manager. For every environment a REG-file is produced.

Nortel recommends specifying *LOCAL for all modules that reside on the same system as eKERNEL. You can also specify the fixed IP address of the central system. Using an IP address has advantages when deploying the high-availability eTM_HA.

For modules that reside on a different PC, Nortel recommends specifying the fixed IP address of the distributed system.

An authorized of an entry typically found in this field is as follows: *LOCAL or 192.168.3.100



NN43120-301 02.01

4 June 2010


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.

3

3

3

3

3

3

3

3

3105

3106

3107

3108

3109

3110

3111

3112

Table 54 "eKERNEL_TCPClient sample data" (page 389)

shows authorizeds of data found in the eKERNEL_TCPClient table.

3

3

3

3

Table 54 eKERNEL_TCPClient sample data

Site Area Port

3101

3102

3103

3104

1

1

1

1

1

1

1

1

1

1

1

1

Input program

31901

31101

31102

31103

Application eDMSAPI eCAP eCAP eAPI

0

31401

31501

31601

31701

31801

0

31105 eASYNC eVBVOICE eCSTA eIO eWEB eSMTP_server eSMTP eESPA

Socket

Keep open

Keep open

Keep open

Close after receive

Keep open

Keep open

Keep open

Keep open

Close after sent

Keep open

Keep open

Keep open

.



NN43120-301 02.01

4 June 2010



.



NN43120-301 02.01

4 June 2010


391

.

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.


eLOC_Area_id_n

This parameter refers to the area identifier, as defined in eKERNEL_AREA 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. One instance of eLOCATION module can work with only one SIP

DECT system. Each SIP DECT system should have it own eLOCATION instance for location detection.


eLOC_LA_address_str

If SIP DECT is used, this parameter refers to the IP address of the DAP

Controller that is handled by the instance of the eLOCATION module.

Refer to the system administrator of the PBX to obtain the IP address. The

DAP Controller port is performing the role of TCP Server; the eLOCATION module is performing the role of TCP Client.



NN43120-301 02.01

4 June 2010


.

392 Table: eLOCATION


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. When the eLOCATION module receives a location request from the eKERNEL, a question is sent to the DAP

Controller, and the DAP Controller is responds with the last known location information. The timeout parameter defines the allotted time to wait for an answer from the DAP Controller. When a timeout occurs, the location returned to eKERNEL is undefined (N/A). If you experience frequent time-outs, you should consider increasing the value or try to isolate the resource problem.


eLOC_Retry_count_n

This parameter defines how many retries are sent to the eLOCATION module when a negative acknowledge (NACK) is received on the eLOCATION request. This situation is typically when there is no response from the DAP Controller on location request. The requests are sent with a eLOC_Retry_intv_n interval (in seconds). If after eLOC_Retry_count_n retries, a negative acknowledgement is still received, the request status is *END (in eLOCATION_REEQUEST table). If this request was only sent to one eLOCATION module, the alarm is set, and the replacements values [Location], [Location Date] and [Location Time] are set to “?”. If the location request was sent to more then one eLOCATION module, the parameters associated with this request (see table eLOCATION_INBOUND_RESULT) are relevant.


eLOC_Retry_intv_n

This field specifies the interval in seconds, to re-send a location request to the eLOCATION module when it previously received a negative acknowledge.




NN43120-301 02.01

4 June 2010


eLOCATION parameters 393

eLOC_Polling_intv_n

This parameter is not implemented in current release. Specify value “0” here.


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.

.



NN43120-301 02.01

4 June 2010


394 Table: eLOCATION

.



NN43120-301 02.01

4 June 2010


.

Table: eLOCATION INBOUND RESULT

395

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). Note that the eLOCATION_INBOUND_RESULT table can have definitions of more than one input program. Although there is a functional relationship between eDMSAPI and eLOCATION instances, there is no one-to-one relation between these instances.


eLOCIR_Called_dev_str

This field contains the number of the extension type *LA from eDMSAPI_INBOUND table.


eLOCIR_Calling_dev_str

This field contains the (internal) extension of the calling party, so the extension that initiated the alarm by sending a message to an extension type *LA specified above. This field can contain a fully qualified extension number (for instance 860) or a generic extension using an ending wildcard-character (for instance 86*) or a generic value ’*ALL’. Fully



NN43120-301 02.01

4 June 2010


.

396 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. In case there are more than one eLOCATION instances, the location detection is distributed to all eLOCATION instances of the current site, and the eLOCATION with the most recent information is used to assign the site and area definition.


eLOCIR_eLOC_Area_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. In case there are more than one eLOCATION instances, the location detection is distributed to all eLOCATION instances of the current site, and the eLOCATION with the most recent information is used to assign the site and area definition.


eLOCIR_GRP_Name_str

This field defines the group name that is used as the final destination of the resulting action of the location alarm. Since the alarm generation is done on behalf of the input program eDMSAPI, the definitions of groups and alarm descriptions are associated with this input program.


SOSPBX1

eLOCIR_Msg_str

This field defines the message that is used to generate a resulting alarm.

The value can be a combination of constant text and replacement values.

The supported replacement values are:

• [Location]: field eLOCRPN_Message_str from eLOCATION_RPN table for the corresponding RPN (keyword <rpn> in <msgrpy> from eLOCATION

• [Location Date]: value of tag <date> from <msgrpy> from eLOCATION

• [Location Time]: value of tag <time> from <msgrpy> from eLOCATION



NN43120-301 02.01

4 June 2010


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.0, it is possible to use a ‘visual DNR’ to a device in the Messenger (new field “DEV_Visual_dnr_str” in table eKERNEL_DEVICE). Now when the system configurator configures a device with a visual DNR, this DNR is used to format a message when it contains [Calling number]. The end-user is confronted with the visual DNR.

An authorized of an entry typically found in this field is as follows: SOS from [calling number] on [location] at [Location Date] [location time]

eLOCIR_Comments_str

Use this field to enter additional information. It is informational only.

An authorized of an entry typically found in this field is as follows: Default configuration.

.



NN43120-301 02.01

4 June 2010


398 Table: eLOCATION INBOUND RESULT

.



NN43120-301 02.01

4 June 2010


399

.

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.169

port 28008 is handled by eLOCATION instance site 1 and area 1, and may feature a number of RPNs, each of them defined in the eLOCATION_RPN table.


eLOCRPN_Area_id_n

This parameter refers to the area identifier, as defined in the

KERNEL_AREA table. 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.169 port 28008 is handled by eLOCATION instance site 1 and area 1, and may feature a number of RPNs, each of them defined in the eLOCATION_RPN table.


eLOCRPN_RPN_str

This field contains the hexadecimal identification of the access point

(RPN). The fields eLOCRPN_Site_id_n, eLOCRPN_Area_id_n and eLOCRPN_RPN_str combine the unique key in the table eLOCATION_RPN table. The value should be formatted as a two-byte



NN43120-301 02.01

4 June 2010


400 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.

When using configurations with more than 255 radios, a 2 digit identification should be used for values between 00 and FF and a 3 digit definition should be used for the identifications that follow, so 100, 101 and so on.


eLOCRPN_Message_str

Use this field to specify a text message that clearly indicates the physical location of origin of a alarm. For authorized, you can associate the text “Emergency room” to RPN 01, “Elevator” to RPN 02, “Psychiatric department” to RPN 03, and so on. As a result, end-users can easily locate the origin of a location detection alarm.

An authorized of an entry typically found in this field is as follows: Building

KOC UCPS division

eLOCRPN_Comments_str

Use this field to enter administrator comments. It can contain information on physical location, cabling, building plan references, and so on. It can also be used to add MAC addresses and IP addresses here.

An authorized of an entry typically found in this field is as follows: Default configuration

.



NN43120-301 02.01

4 June 2010


401

.

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.


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.


eOAI_Framework_Address_str

This field describes the IP address of the Framework that handles the OAI

Services.


127.0.0.1

eOAI_Framework_Port_n

This field describes the port number of the Framework that handles the

OAI Services.




NN43120-301 02.01

4 June 2010


.

402 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. This can be done through eOAI

(inbound SMS and confirm through CLIP or pincode), eCSTA (dial-in and confirm using CLID) or eVBVOICE (dial-in and confirm through DTMF).

Since eKernel release 2.9.18 the message reply (<msgrpy>) sent by the eOAI module to the eKernel is treated as a NACK reply (even if a ACK was sent) in case the priority of the alarm is lower or equal (so has an higher importance) then the eOAI_ALA_Prty_DTMF_Confirm_n priority.

This means that alarms that are sent by eOAI (and are successfully delivered (so status = ACK)) and need a confirmation behave the same as alarms with status NACK. The result is the alarm is repeated every eOAI_Silence_intv_nseconds until confirmation, and proceeds with the alternative device(s) (if configured) if not confirmed within the

DEV_Retry_count_ALT_DEV_id_n (eKernel_device) retries.


eOAI_Silence_intv_n

This value specifies the silence interval in seconds; the frequency users are informed on remaining active messages. The default value is 600.

The function is enabled to prevent calling the provider over again for each individual change that occurs, and thus leads module and their destination users some pace interval.



eOAI_Comments_str

Use this field to enter administrator comments. It is informational only.

An authorized of an entry typically found in this field is as follows: Default eOAI configuration



NN43120-301 02.01

4 June 2010


403

.

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.


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.


eOAP_Framework_Address_str

This field describes the IP address of the Framework that handles the OAP

Services.


127.0.0.1

eOAP_Framework_Port_n

This field describes the port number of the Framework that handles the

OAP Services.




NN43120-301 02.01

4 June 2010


.

404 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. This can be done through eOAP

(inbound SMS and confirm through CLIP or pincode), eCSTA (dial-in and confirm using CLID) or eVBVOICE (dial-in and confirm through DTMF).

Since eKernel release 2.9.18 the functionality is implemented that the message reply (<msgrpy>) sent by the eOAP module to the eKernel is treated as a NACK reply (even if a ACK was sent) in case the priority of the alarm is lower or equal (so has an higher importance) then the eOAP_ALA_Prty_DTMF_Confirm_n priority. This means that alarms that are sent by OAP (and are successfully delivered (so status = ACK)) and need a confirmation, behave the same as alarms with status NACK.

The result is the alarm is repeated every eOAP_Silence_intv_nseconds until confirmation, and proceeds with the alternative device(s) (if configured) if not confirmed within the DEV_Retry_count_ALT_DEV_id_n

(eKernel_device) retries.


eOAP_Silence_intv_n

This value specifies the silence interval in seconds, the frequency users are informed on remaining active messages. The default value is 600.

The function is enabled to prevent calling the provider over again for each individual change that occurs, and thus leads module and their destination users some pace interval.



eOAP_Comments_str

Use this field to enter administrator comments. It is informational only.

An authorized of an entry typically found in this field is as follows: Default eOAP configuration



NN43120-301 02.01

4 June 2010


.

Table: eSMTP_CLIENT eSMTP_CLIENT parameters

.

eSMTP_Site_id_n


In most environments, the value is 1.


eSMTP_Area_id_n

This field specifies the area identifier, as defined in eKERNEL_AREA table. In most environments, the value is 1.


eSMTP_srv_ip_str

This field specifies the IP address of the SMTP server that is used to handle outbound SMTP messages. This is typically an SMTP compatible system, for authorized, Lotus Notes, Lotus Domino, Microsoft Exchange,

AS400 SMTP Server, iSeries400 SMTP server, Windows 2000 SMTP server, and so on.

The SMTP server must be properly configured to allow inbound SMTP requests from the DECT Messengerapplications (relaying, and so on).



NN43120-301 02.01

4 June 2010


405

.

406 Table: eSMTP_CLIENT


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.


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. The domain parameter is associated to the HELO command in the SMTP dialog.

An authorized of an entry typically found in this field is as follows: ibsbe.be

eSMTP_ALA_Prty_DTMF_Confirm_n

This field specifies what alarm priority levels require a confirmation. Alarm priority is defined in the eKERNEL_ALARM table.

Alarms that do not meet the requirements are automatically confirmed when the DECT MessengerSMTP client sends a message to an external

SMTP server. The message is considered sent when it reaches the server.

However, at this stage, there is no guaranteed message delivery, because there is no read indication. This situation is similar to eASYNC, where

SMS and PAGING as well do not foresee end user confirmation. An SMTP mail can be pending between intermediate server (for authorized, in an internet environment) or remain unread in the mailbox for a large amount of time.

Confirmation techniques can be appropriate to force mail destinations to respond to the alarm request. This can be accomplished by calling back to a predefined DID number. In eKERNEL release 2.9.18 and later, the functionality is implemented that if the priority of the alarm is lower than or equal to this value (so has an higher importance), the message reply

(<msgrpy>) sent by the eSMTP module to the eKERNEL is treated as a NACK reply (even if a ACK was sent). Therefore, alarms that are sent using eSMTP (and are successfully delivered (so status = ACK)), and that need a confirmation, have the same behavior as alarms with status NACK.

This results in the alarm repeating every eSMTP_Silence_intv_n seconds until confirmation. If the alarm is not confirmed within the

DEV_Retry_count_ALT_DEV_id_n (eKERNEL_device) retries, the alarm is sent to the alternative devices (if configured).



NN43120-301 02.01

4 June 2010


.

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.


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. Due to bandwidth restrictions, a larger value than specified in eKERNEL_ALARM table is suitable. For authorized, repeating unconfirmed alarms every two minutes in a mail destination environment is not desirable. A typical value is ten minutes. The value must be expressed in seconds.


eSMTP_From_address_str

This field specifies the e-mail address of the sender of both eSMTP module and eWEB module (form Send SMTP Message). The specified value is used in the MAIL FROM tag of the mail composition process, as spec RFC821 and RFC1521.

Note: In R3.0, there is now the ability to specify a friendly name as well.

The module eSMTP and eWEB now support any of the following three syntax: [email protected]

<[email protected]>

Francis Missiaen <[email protected]>

An authorized of an entry typically found in this field is as follows: [email protected]

eSMTP_Comments_str


Table 55 "eSMTP_CLIENT sample data" (page 407)

shows authorizeds of data found in the eSMTP_CLIENT table.

Table 55 eSMTP_CLIENT sample data

1

Site

1

Area Address Port

10.110.17.6

25

Domain

1s.be

1

Confirm Interval

600

Comments



NN43120-301 02.01

4 June 2010


408 Table: eSMTP_CLIENT

.



NN43120-301 02.01

4 June 2010


.

Table: eSMTP_SERVER eSMTP_SERVER parameters

409

.

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.


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.


eSMTPS_Email_dir_str

This field specifies the directory that is polled upon arrival of incoming e-mail. In the Windows 2000 environment with the Internet

Information Server component SMTP server activated, this is typically c:\inetpub\mailroot\drop. The specified directory is the directory where the

Windows shipped SMTP server drops incoming mail.



NN43120-301 02.01

4 June 2010


.

410 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. The value is expressed in seconds, and typically has a value of 10 seconds.

Specifying a smaller value requires additional system resources, and can speed up the detection process of inbound e-mail based alarm generation. Note however that e-mail processing is as such a technology that is not designed to guarantee lightning-speed response, and therefore a very small interval does not lead to substantial benefit. Only in very special environments with internal LAN-only mail exchange and dedicated resources are time-critical intervals suitable.


eSMTPS_Email_dir_processed

Once an inbound e-mail is detected, the eSMTP_server module moves the processed e-mail message an archive storage location.

A special value *NONE can be defined here, indicating the processed e-mail messages are not kept online, and are removed from the hard disk. Although some kind of logging information is often still available, the originating mail message is destroyed.

In most cases, a directory name is specified, and defines the location where the processed e-mail messages are temporarily archived. This archive allows system administrators to perform more detailed problem analysis.

Warning: the value specified must be different from the value specified in the eSMTPS_Email_dir_str parameter, or otherwise an infinite looping condition occurs. The eSMTP_server module attempts to create the hierarchical directory structure if the path does not exist.

An authorized of an entry typically found in this field is as follows: c:\inetpub\mailroot\drop\processed.



NN43120-301 02.01

4 June 2010


.

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.


eSMTPS_Email_dir_error_str

Once an inbound e-mail is detected, the eSMTP_server module moves the processed e-mail message to some kind of archive storage location.

This location is defined in eSMTPS_Email_dir_processed_str. Mail that cannot be processed is moved to a separate location, defined in eSMTPS_Email_dir_error_str.

A special value *NONE can be defined here, indicating the e-mail messages in error are not kept online, and are removed from the hard disk. Although some kind of logging information is often still available, the originating mail message is destroyed.

In most cases, a directory name is specified, and defines the location where the e-mail messages in error are temporarily archived. This archive allows system administrators to perform more detailed problem analysis.

Warning: the value specified must be different from the value specified in the eSMTPS_Email_dir_str parameter, or otherwise infinite looping condition occurs. The eSMTP_server module attempts to create the hierarchical directory structure if the path does not exist.

An authorized of an entry typically found in this field is as follows: c:\inetpub\mailroot\drop\error

eSMTPS_Email_keep_error_n

This field specifies the number of days the archive of e-mail messages in error 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 the number of inbound e-mail messages, the requested archive period, and the available disk space.




NN43120-301 02.01

4 June 2010


412 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.


MESSAGE SUCCESSFULLY DELIVERED

eSMTPS_NonDelivery_text_str

When an inbound e-mail message is rejected by eKERNEL, the sender receives a non-delivery report. This non-delivery report is sent through eSMTP client. (The eSMTP module is a prerequisite.)

The message text for the non-delivery messages is defined in the eSMTPS_NonDelivery_text_str field.


MESSAGE COULD NOT BE DELIVERED

eSMTPS_ALA_id_n

When an inbound e-mail message is accepted or rejected by eKERNEL, the sender receives a delivery or non-delivery report. This report is sent from eKERNEL to eSMTP client. (The eSMTP module is a prerequisite.)

To produce such outbound message, eKERNEL must known the alarm identifier that is used to produce the message for eSMTP. This value must match the value specified in eKERNEL_ALARM table. Verify the length of the delivery and non-delivery messages specified in eSMTPS_Delivery_text_str and eSMTPS_NonDelivery_text_str.


eSMTPS_Comments

This field can contain remarks from an administrator and is informational only.

.



NN43120-301 02.01

4 June 2010


413

.

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. As a result, the Web Server can use its own IP address to retrieve the configuration data from the database. The values are needed in eWEB to set up a proper socket connection to eKERNEL module, and to give the user access to the correct site and area-related data. You can define multiple addresses for the same eWEB module.


10.100.50.138

eWEB_Site_id_n

This field specifies the site 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_SITE.




NN43120-301 02.01

4 June 2010


.

414 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.


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. Therefore, eKERNEL and the Apache Web Server must reside on the same computer. Future releases can implement the architecture of distributed web servers that reside on another system (for authorized, located in a

DMZ).


10.100.50.138

eWEB_Branding_str

This field is introduced in R3.0 and defines the branding information shown in eWEB user interface.

Note that tampering with branding information without permission is a copyright violation.


NORTEL

eWEB_Comments_str


Table 56 eWEB sample data

Address

10.110.50.138

10.110.53.138

127.0.0.1

Table 56 "eWEB sample data" (page 414)

shows authorizeds of data found in the eWEB table.

1

1

1

Site

1

1

1

Area Kernel address

10.110.50.138

10.110.53.138

127.0.0.1

Comments



NN43120-301 02.01

4 June 2010


415

.

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.


WSC_Area_id_n



WSC_Script_id_n

This field specifies the unique identifier of the script message within one site.

Script messages are a special type of message requests with the unique feature of being traceable.

Although you are free to enter a numeric value of choice, Nortel recommends establishing a naming convention for script messages.



NN43120-301 02.01

4 June 2010


.

416 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.


WSC_Script_Descr_str

This field is a description of the script message.

In the eWeb module, the visualization of the script message is performed with the description of the script message, and never with the script ID.


EMERGENCY

WSC_GRP_Name_str

This parameter specifies the name of the group as defined in the field

GRP_Name_str in the eKernel_group table or another valid text is *ALL.

If this field is equal to *ALL, the user can select a group, otherwise the group (the message destinations) are fixed.

The groups are presented as message destinations.

If the group name defined does not match a group name in the eKernel_group table, no devices are shown, so the alarm is not processed.


EVACUATION

WCS_ALA_id_n

This field must have a value that corresponds with any of the definitions in the eKernel_alarm table for input program related to eWEB. For authorized, if eWEB is input program 11701 and eKernel_alarm table contains alarm identifiers 1170101 and 1170102, one of these defined values must be used. In most cases, a number of alarm identifiers are defined to handle different message lengths and different message priorities.


WSC_Msg_str

This field describes the message that is sent to the group members. Nortel recommends that you add a descriptive message that allows the recipient sufficient information to handle the alarm condition. Mobile users often lack immediate access to other information resources, such as a site map or



NN43120-301 02.01

4 June 2010


.

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.


EVACUATION is active

WSC_Min_dev_cnt_str

This field specifies the minimum number of devices that must be selected from the group by the end user, before a script message can be activated.

The only other valid entry in the current release is *ALL; therefore, all devices from the group receive the message, so the end user does not have the opportunity to select devices.

Warning: you must not specify a value larger then the number of devices present in the group.

Note: In the current release, this parameter has nothing to do with the number of devices that must receive the message before clearing the message for all other devices from the group.


WSC_Max_Active_n

This field specifies the maximum number of times this script message can be active. The keyword *NOMAX can be used to indicate there is no limit.

An authorized of an entry typically found in this field is as follows: 1 (for

EVACUATION) or *NOMAX (for informative messages)

WSC_Currently_Active_n

This field specifies the number of script messages currently active.

This field is used by the eKernel application, and has nothing to do with configuration of the database.

WSCA_Comments_str

This field can be used by an administrator to enter remarks. The field is informational only.



NN43120-301 02.01

4 June 2010


418 Table: eWEB_SCRIPT

.



NN43120-301 02.01

4 June 2010


.

Table: eWEB_SCRIPT_SET_AUTH eWEB_SCRIPT_SET_AUTH parameters

419

.

WSSA_Site_id_n



WSSA_Area_id_n



WSSA_Script_id_n

This field must have a value that corresponds with any of the definitions in eWEB_script table for the eWEB interface.


WSSA_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 set this script message. If one or more users are defined, only those users can set the related script message.



NN43120-301 02.01

4 June 2010


420 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


.



NN43120-301 02.01

4 June 2010


.

Table: eWEB_SCRIPT_TRACE_AUTH

421

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



WSTA_Area_id_n



WSTA_Script_id_n





NN43120-301 02.01

4 June 2010


422 Table: eWEB_SCRIPT_TRACE_AUTH

WSTA_UserID_str



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.

An authorized of an entry typically found in this field is as follows: KDS

WSTA_Auth_str

This field is provided for security enhancements in future releases.

Only the value *VIEW and *EXCLUDE are supported in the current release.

If the end user must have the authority to trace a script message, this field must be *VIEW. *EXCLUDE is similar to not entering a record.

An authorized of an entry typically found in this field is as follows: *VIEW

WSTA_Comments_str


.



NN43120-301 02.01

4 June 2010


.

Table: eWEB_SCRIPT_CANCEL_AUTH

423

eWEB_SCRIPT_CANCEL_AUTH parameters

.

WSCA_Site_id_n



WSCA_Area_id_n

This field specifies the area, as defined in eKERNEL_AREA table. In most cases, the value is 1.


WSCA_Script_id_n



WSCA_UserID_str



If the value *ALL is entered, any user can cancel this script message. If one or more users are defined, only those users can cancel the related script message.



NN43120-301 02.01

4 June 2010


424 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


.



NN43120-301 02.01

4 June 2010


.

Table: eWEB_SNDGRPMSG eWEB_SNDGRPMSG parameters

425

.

WGM_Site_id_n

This field specifies the site identifier, as described in table eKERNEL_SITE. In most cases this value is 1.


WGM_Area_id_n

This field specifies the area identifier, as described in table eKERNEL_AREA. In most cases this value is 1.


WGM_GRP_Name_str

This field specifies the group, as defined in eKERNEL_GROUP table.

The Send Group Message function in eWEB allows sending a predefined message to a group. The table eWEB_SNDGRPMSG allows a system administrator to predefine a number of messages that are automatically presented to a web user in the web-based Send Group Message functionality.

The field can either contain a qualified group name or can have the generic special value *ALL. This special value *ALL means the message is automatically defined for all groups. You must use this value only when appropriate, as sharing messages affects all groups.



NN43120-301 02.01

4 June 2010


.

426 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.


(qualified group) or *ALL (generic group)

WGM_Sequence_n

This field is a sequence number and makes the records unique in the database. The field allows you to define the sequence used to present the data in the Send Group Message function. Nortel recommends that you start with a value of 1 and increase by one for subsequent messages.


WGM_Message_str

This field specifies the message that is shown to the eWEB user in the

Send Group Message functionality, and is finally sent to the destination users.

Note the length of the message must be smaller than or equal to the maximum length associated with the WGM_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. A special value *FREE can be defined, enabling the end user to enter a message.


Evacuation (qualified) or *FREE (user-defined message)

WGM_AlA_id_n

This field must have a value that corresponds with any of the definitions in eKERNEL_ALARM table for the eWEB interface. For authorized, if eWEB is input program 11701 and ALARM table contains alarm identifiers

1170101 and 1170102 and 1170103, one of these defined values must be used. In most cases, a number of alarm identifiers are defined to handle different message lengths and different message priorities.


WGM_Comments_str

This field can be used by and administrator to enter some remarks. The field is informational only.

Table 57 "eWEB_SNDGRPMSG sample data" (page 427)

shows authorizeds of data found in the eWEB_SNDGRPMSG table.



NN43120-301 02.01

4 June 2010


eWEB_SNDGRPMSG parameters 427

Table 57 eWEB_SNDGRPMSG sample data

3

3

3

3

3

3

3

3

3

1

1

1

1

1

1

1

1

1

3

3

3

3

3

3

3

3

3

Site Area

1 *ALL

Group

3

1

1

1

1

1

1

1

1

1

2

2

2

2

1

1

*ALL

1

1

RAMPENPLAN 1

RAMPENPLAN 2

RAMPENPLAN 3

RAMPENPLAN 4

RAMPENPLAN 5

RAMPENPLAN 6

VSK_F 1

VSK_F 2

VSK_F

2

1

2

3

4

1

2

3

4

1

Sequence

3

Message

Emergency evacuation

*FREE

AS400 failure

NT failure

Domino failure

Firewall failure

Alarm id

3170103

3170102

3170102

3170102

3170102

3170102

Check invoice

Check mailbox

Check quotations

Check received goods

3170102

3170102

3170102

3170102

Fase 1 - start

Fase 2 - start

Fase 3 - start

Fase 1 - end

3170102

3170102

3170102

3170102

Fase 2 - end

Fase 3 - end

3170102

3170102

Brand - gelijkvloers 3170102

Brand - verdieping

1

3170102

Brand - verdieping

2

3170102

Comments

.



NN43120-301 02.01

4 June 2010


428 Table: eWEB_SNDGRPMSG

.



NN43120-301 02.01

4 June 2010


429

.

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. The table eWEB_SNDUSRMSG allows a system administrator to predefine a number of messages that are automatically presented to a web user in the web-based Send User Message functionality.

The field can either contain a qualified username or can have the generic special value *ALL. This special value *ALL means the message is defined for all users.


(qualified user) or *ALL (generic user)

WUM_Sequence_n

This field is a sequence number and makes the WUM_User_id_str and

WUM_Sequence_n a unique key. Use WUM_Sequence_n to define the sort sequence of the available predefined messages. Nortel recommends that you start with a value of 1 and increase by one for subsequent messages.




NN43120-301 02.01

4 June 2010


.

430 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. A special value *FREE can be defined, enabling the end user to enter a message.


Evacuation (qualified) or *FREE (user-defined message)

WUM_AlA_id_n

This field must have a value that corresponds with any of the definitions in ALARM table for the eWEB interface. For authorized, if eWEB is input program 11701 and eKERNEL_ALARM table contains alarm identifiers

1170101 and 1170102 and 1170103, one of these defined values must be used. In most cases, a number of alarm identifiers are defined to handle different message lengths and different message priorities.


WGM_Comments_str

This field can be used by and administrator to enter some remarks. The field is informational only.

Table 58 "eWEB_SNDUSRMSG sample data" (page 430)

shows authorizeds of data found in the eWEB_SNDUSRMSG table.

Table 58 eWEB_SNDUSRMSG sample data

Sequence

*ALL

*ALL

FMI

FMI

FMI

User

*ALL

*ALL

*ALL

*ALL

*ALL

1

2

3

4

5

6

7

1

2

3

Message

Normal message 1 for *ALL

Shared message 2 for *ALL





*FREE

Private message 1 for FMI



Alarm id

3170101

3170101

3170101

3170101

3170101

3170101

3170101

3170103

3170103

3170103

Comments



NN43120-301 02.01

4 June 2010


Table 58 eWEB_SNDUSRMSG sample data (cont’d.)

User Sequence Message

FMI

KDS

KDS

KDS

2

3

4

1


Private message 1 (Medium)

Private message 2 (Short)

Private message 3 (Long) eWEB_SNDUSRMSG parameters 431

Alarm id

3170103

3170102

3170101

3170103

Comments

.



NN43120-301 02.01

4 June 2010


432 Table: eWEB_SNDUSRMSG

.



NN43120-301 02.01

4 June 2010


.

Table: eWEB_TOC eWEB_TOC parameters

.

WTC_Site_id_n


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.


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. The key is unique within the site. WTC_Group_n is used to logically sort the table of contents in groups and items. Nortel recommends starting the first group at 1 and incrementing by 1.




NN43120-301 02.01

4 June 2010


433

.

434 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.


WTC_Language_str

This field contains a 4-byte language code. Refer to the documentation of the

“Table: eWEB_USER_AUTH” (page 439)

for a list of language codes.

This field contains a number, and when combined with WTC_Group_n, and WTC_Item_n, results in a key, which is not duplicated within a site.

This field specifies the language used in the field WTC_Text_str, and in the PHP script of HTML documents defined in WTC_Link_str.

This field allows the table of contents to be multilingual. With the correct definition, English users see the table of contents in English, Dutch users in Dutch, and so on.

To implement a new language:

1.

Define the appropriate language code in the eWEB_USER_AUTH table.

2.

Translate the descriptions of the links in the eWEB_TOC table.

3.

Edit the eWeb_mri.php file that is located in C:\SOPHO

Messenger@Net\Web\htdocs.

4.

Provide an additional section for the new language.

The eWeb_mri.php is provided in English (2909), and Dutch (2963).


WTC_Text_str

This field specifies the text that the web user sees in the table of contents.

Nortel recommends using the same language as specified in the field

WTC_Language_str.


Welcome (in English - 2909) or Welkom (in Dutch - 2963).



NN43120-301 02.01

4 June 2010


.

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)


In most cases, this field contains a valid filename of a PHP-script, a HTMLfilename of another valid string understood by a browser (for authorized, mailto:[email protected]).

Table 59 "Valid WTC_Link_str values" (page 435)

provides a list of valid links that can be used. The files are shipped with eWEB module and are located in C:\SOPHO Messenger@Net\Web\htdocs.

Table 59

Valid WTC_Link_str values eWEB_alarm_inquiry.php

eWEB_chgpwd.php

eWEB_device_inquiry.php

eWEB_eDMSAPI.php

eWEB_eSMTP.php

eWEB_group_inquiry.php

eWEB_script.php

eWEB_sndgrpmsg_1.php

eWEB_sndsrvmsg.php

eWEB_sndusrmsg_1.php

eWEB_table_view.php

eWeb_wrkgrp_1.php

info.html

mailto:[email protected]

1s/launch.htm

An authorized of an entry typically found in this field is as follows: eWEB_eDMSAPI.php

WTC_Sec_n

This field specifies whether a user can see table of contents items. For authorized, a user with security level 20 defined in the eWEB_USER_AUTH table sees only the table of contents items defined in the eWEB_TOC table with a WTC_Sec_n value lower than or equal to

20. WTC_Sec_n provides a method to restrict access to some functionality to a subset of users.



NN43120-301 02.01

4 June 2010


.

436 Table: eWEB_TOC


WTC_Comments_str


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.

Table 60 eWEB_TOC sample configuration t e

S i

G r o u p

I t e m Language

3 2 0 2909

3 2 0 2963

3 2 1 2909

3 2 1 2963

3 2 2 2909

3 2 2 2963

3 2 3 2909

3 2 3 2963

3 2 4 2909

3 2 4 2963

3 2 5 2909

3 2 5 2963

3 3 0 2909

3 3 0 2963

3 3 1 2909

3 3 1 2963

3

3

3

3

4

4

4

4

0

0

1

1

2909

2963

2909

2963

Text

Send a message

Link

Zend een boodschap

Send DMS-API message eWEB_eDMSAPI.php

Zend DMS-API boodschap eWEB_eDMSAPI.php

Send SMTP message eWEB_eSMTP.php

Zend SMTP boodschap

Send Server Message

Zend Server boodschap

Send Group Message eWEB_eSMTP.php

eWEB_sndsrvmsg.php

eWEB_sndsrvmsg.php

eWEB_sndgrpmsg_1.php

Zend Groep boodschap eWEB_sndgrpmsg_1.php

Send User Message eWEB_sndusrmsg_1.php

Zend Gebruiker boodschap eWEB_sndusrmsg_1.php

Send a script message

Zend een script boodschap

Work with Script messages eWEB_script.php

Werken met Script boodschappen eWEB_script.php

Inquiry

Overzicht

Alarm Inquiry

Alarm overzicht eWEB_alarm_inquiry.php

eWEB_alarm_inquiry.php

20

20

20

20

10

10

40

40

40

40

10

10

10

10

10

10

10

10

Level

10

10



NN43120-301 02.01

4 June 2010


eWEB_TOC parameters 437

Table 60 eWEB_TOC sample configuration (cont’d.) t e

S i

G r o u p

I t e m Language

3 4 2 2909

3 4 2 2963

3 4 3 2909

3 4 3 2963

3 4 4 2909

3 4 4 2963

3 5 0 2909

3 5 0 2963

3 5 1 2909

3 5 1 2963

3 6 0 2909

3 6 0 2963

3 6 1 2909

3 6 1 2963

3 7 0 2909

3 7 0 2963

3 7 1 2909

3 7 1 2963

3 7 2 2909

Text

Device Inquiry

Device overzicht

Group Inquiry

Groeps overzicht

Table View

Tabel bekijken

Maintenance

Onderhoud

Work with Groups

Werken met groepen

Security

Beveiliging

Change Password

Paswoord wijzigen

Help

Help

Info

Info

Contact me

3 7 2 2963 Kontakteer mij

3 7 3 2909

3 7 3 2963

Number One Systems

Number One Systems

Link eWEB_device_inquiry.php

eWEB_device_inquiry.php



eWEB_table_view.php

eWEB_table_view.php

eWeb_wrkgrp_1.php

eWeb_wrkgrp_1.php

eWEB_chgpwd.php

eWEB_chgpwd.php

info.html

info.html

mailto:francis.missiaen@1s

.be

mailto:francis.missiaen@1s

.be

1s/launch.htm

1s/launch.htm

40

40

40

10

10

40

40

40

40

40

30

30

30

30

10

10

20

20

20

20

Level

20

20

.



NN43120-301 02.01

4 June 2010


438 Table: eWEB_TOC

Figure 221 eWEB_TOC sample result (language 2909 and language 2963)

.



NN43120-301 02.01

4 June 2010


.

Table: eWEB_USER_AUTH

EWEB_USER_AUTH parameters

439

.

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.

Note 1: In many environments, other computer infrastructure is in use, such as iSeries 400, Windows NT, Lotus Notes, and so on, and users often desire to use the same username on every platform. In this case,

Nortel recommends that you ask the ICT manager for a list of existing user profiles, so that DECT Messengercan use the same User IDs.

On iSeries 400 the OS/400, command WRKUSRPRF can be used to determine defined users.

Note 2: The USERA_UserID_str field is restricted to a length of 10 bytes.

An authorized of an entry typically found in this field is as follows: FMI.



NN43120-301 02.01

4 June 2010


.

440 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. Depending on your configuration, table information is accessible through eWEB. Because the security mechanism is limited, Nortel recommends that users not use the same password used on other systems that contain secured information, as that poses a serious security risk. Inform all users of this important issue.

An authorized of an entry typically found in this field is as follows: SOPHO.

USERA_Sec_level_n

The security level is a number between 00 and 99. The higher the number, the more authority a user has. The value 99 is the highest level, and gives full access to all functionality. The value 00 is the lowest possible value.

Nortel recommends that you initially assign values in 2 or 3 levels and handle increment by 10. For instance, start with the following values: 20 for low-end users, 40 for power users, and 60 for administrators.

Note: The security level is related to the values specified in the eWEB_TOC table, where the field WTC_Sec_n level specifies the minimum required user security level that is needed for a specified function. For authorized, a user with level 20 can execute all the functions in WTC_Sec_n with level 00–20.


USERA_Description_str

This field contains a description of the user, which usually consists of the first and last name of the User ID. This field is informational only.

An authorized of an entry typically found in this field is as follows: Francis

Missiaen.

USERA_Email_str

This field specifies the e-mail address of the user. This field is important when eWEB module is activated, and the Send SMTP Message function is available to the users. When a user sends an e-mail message through the Send SMTP Message script, the system checks the username of the eWEB user, as specified during the login procedure. The e-mail address



NN43120-301 02.01

4 June 2010


.

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: [email protected].

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. Instead, the user only has access to maintain the groups he or she has been granted access to, as defined in the eKERNEL_GROUP_AUTH table.

If your environment requires it, you can create users with administrator privileges, who are allowed to maintain any existing group through the eWEB based Work with Groups. To do so, set this field to True

(-1) to grant the all object special authority to these users. Users with all object special authority do not need to be granted authority in the eKERNEL_GROUP_AUTH table.

Nortel recommends giving this special authority only to system administrators and service staff.


(denotes False).

USERA_Secadm_b

This field specifies whether a user has security administrator special authority. If this value is set to False (0), the user has access to all tables in the Table View within eWEB, except eWEB_USER_AUTH, which shows usernames and passwords in plain text.

If your environment requires it, you can create users with administrator privileges, who are allowed to maintain any user profile in eWEB. For those users, set this field to True (-1) to allow those users to consult the table eWEB_USER_AUTH, and see the user and password information.

Note: The web interface only supports inquiry to the tables.

Maintenance of the tables must be performed using the eGRID interface.


(denotes False).



NN43120-301 02.01

4 June 2010


.


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.


(denotes False).

USERA_Language_str

This field contains a 4-byte identifier that denotes the language used for eWEB-access and eGRID-access. Enter one of the valid language codes provided in

Table 61 "Currently supported language values in eWEB"

(page 442)

. The codes are in the range 2900–2999. A small number of languages are currently supported, but additional languages can be implemented if needed.

Table 61 "Currently supported language values in eWEB" (page

442)

shows the codes for currently supported languages, while

Table 62

"Language values reserved for future implementation" (page 442)

shows codes reserved for future language support.

Table 61

Currently supported language values in eWEB

Code

2909

2963

2966

Language

Belgian English

Belgian Dutch

Belgian French

Code

2902

2903

2904

2905

2906

2911

2912

2913

2914

2922

Table 62

Language values reserved for future implementation

Language

Estonian

Lithuanian

Latvian

Vietnamese

Lao

Slovenian

Croatian

Macedonian

Serbian Cyrillic

Portuguese



NN43120-301 02.01

4 June 2010


.

EWEB_USER_AUTH parameters 443

2961

2962

2963

2966

2972

2974

2975

2976

2978

2979

2980

2981

2939

2940

2942

2950

2954

2956

2957

2958

Table 62

Language values reserved for future implementation (cont’d.)

Language Code

2923

2924

2925

2926

2928

2929

2931

2932

2933

2937

2938

Dutch Netherlands

English

Finnish

Danish

French

German

Spanish

Italian

Norwegian

Swedish

English Uppercase Support for

Double-Byte Character Set (DBCS)

German Multinational Character Set

French Multinational Character Set

Italian Multinational Character Set

English Uppercase

Arabic

Turkish

Greek

Icelandic

Hebrew

Japanese Double-Byte Character Set (DBCS)

Belgium Dutch

Belgium French

Thai

Bulgarian

Czech

Hungarian

Polish

Russian

Brazilian Portuguese

Canadian French



NN43120-301 02.01

4 June 2010



Table 62

Language values reserved for future implementation (cont’d.)

Code

2984

Language

2986

2987

2989

2992

2994

2995

2996

2998

English Uppercase and Lowercase

Support for Double-Byte Character Set (DBCS)

Korean Double-Byte Character Set (DBCS)

Traditional Chinese Double-Byte

Character Set (DBCS)

Simplified Chinese Double-Byte

Character Set (DBCS) (PRC)

Romanian

Slovakian

Albanian

Portuguese Multinational Character Set

Farsi

Note: The language-code corresponds with an entry in eGRID that provides a directory where the language dependent files are stored. This path is usually C:\SOPHO Messenger@Net\pdf\mri29xx.

The concept of multilingual support in the eWEB module is implemented in the file eWeb_mri.php that is located in C:\SOPHO

Messenger@Net\Web\htdocs.


USERA_Comments_str

Use this field to record remarks about the user.


Technical manager.

.



NN43120-301 02.01

4 June 2010


.

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_n 320

ALA_to_Connect_n 320

ALA_to_Queued_n 320

ALA_to_ringing_n 320

ALA_Trace_b 323

ALA_Trace_dayToKeep_n 323

Alarm inquiry 139

Alarms 117

ALT_Alt_DEV_area_id_n 334

ALT_Alt_dev_id_str 334

ALT_Alt_DEV_Site_id_n 334

ALT_Alt_OUTPGM_Appl_str 334

ALT_Alt_OUTPGM_Facility_str 335

ALT_Comments_str 335

ALT_descr_str 335

ALT_Dev_Area_id_n 333

ALT_Dev_id_str 333

ALT_Dev_Site_id_n 333

ALT_OUTPGM_Appl_str 334

ALT_Sequence_n 334

Alternative devices 188

AREA_Area_Comments_str 314

AREA_Area_Descr_str 314

AREA_Area_id_n 313

AREA_Site_id_n 313

Authentication 150

Authorization level of Web administrator 154

B

Basic group members 184

BU_Comments_str 241

BU_From_File_str 239

BU_From_Path_str 239

BU_Site_id_n 239

BU-To_File_str 240

BU_To_Path_str 239

C

Cancel script 138

CFG_Comments_str 383

CFG_Connectionstring_CFG_str 381

CFG_Connectionstring_DATA_str 379

CFG_eLOG_nmbr_days_n 380

CFG_eLOG_Path_str 380

CFG_GarbageCollection 382

CFG_INRQS_id_n 383

CFG_log_nmbr_days_n 381

CFG_log_path_str 381



NN43120-301 02.01

4 June 2010


445

.

446

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 users 222

Configuration of basic alternative devices 188

Configuration of basic group members 184

Configuration of environments and tasks 73

Configuration of eVBVOICE AVHR 118

Configuration tables 228

Configuring basic alternative devices 188

Configuring basic overview 192

Configuring export import 230

Confirm alarms 117

D

DataFind 105

DECT handset

161–162

Define alarm and ID group 118

DEV_Area_id_n 327

DEV_Comments_str 332

DEV_Descr_str 329

DEV_Div_Area_id_n 331

DEV_Div_OUTPGM_Appl_str 331

DEV_Div_OUTPGM_Facility_str 332

DEV_Div_Site_id_n 331

DEV_id_str 327

DEV_IoRegister_b 331

DEV_Monitor_b 331

DEV_OUTPGM_facility_str 329

DEV_OUTPGM_str 328

DEV_PinCode_str 329

DEV_Prty_n 330

DEV_Ras_Area_b 332

DEV_Ras_Site_b 332

DEV_Retry_count_ALT_DEV_id_n 330

DEV_site_id_n 327

DEV_Visual_dnr_str 329

Device inquiry 140

Dialogic

105, 111

Directories 105

distributed ad hoc recorded message 117

DMS-API message 126

E

eASYNC parameters 233

eASYNC_ALA_Prty_DTMF_Confirm_n 237

eASYNC_Area_id_n 233

eASYNC_COM_Port_str 235

eASYNC_Comments_str 238

eASYNC_Init_str 236

eASYNC_Password_str 234 eASYNC_Provider_str 234

eASYNC_Retry_count_n 236 eASYNC_Retry_intv_n 236

eASYNC_Send_depth_n 237 eASYNC_Send_time_n 237

eASYNC_Settings_str 235

eASYNC_Silence_intv.N

238

eASYNC_Site_id_n 233

eASYNC_Telnr.str

235

eASYNC_Type_str 234

eBACKUP parameters 239

eCAP_generic parameters 243

eCAPG_Ala_Descr_field_n 249 eCAPG_Ala_Descr_len_n 249

eCAPG_Ala_Descr_start_n 248

eCAPG_Comments_str 252

eCAPG_Dft_Ala_Descr_str 250 eCAPG_Dft_GRP_Name_str 250 eCAPG_Dft_Msg_str 250

eCAPG_Field_Sep_str 246

eCAPG_GRP_Name_field_n 247 eCAPG_GRP_Name_len_n 247

eCAPG_GRP_Name_start_n 246

eCAPG_Inpgm_id_n 243

eCAPG_Line_Omit_len_n 245 eCAPG_Line_Omit_start_n 245

eCAPG_Line_Omit_str 246

eCAPG_Line_Select_len_n 244 eCAPG_Line_Select_start_n 244

eCAPG_Line_Select_str 245

eCAPG_Line_Sep_str 243

eCAPG_Msg_field_n 248



NN43120-301 02.01

4 June 2010


.

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 eDMSAPI_External_Address_str 254

eDMSAPI_External_Port_str 255

eDMSAPI_External_Seats_count_n 254

eDMSAPI_GeneralTimeOut_n 258

eDMSAPI_Guarding_Polling_intv_n 257 eDMSAPI_Guarding_Retry_intv_n 257

eDMSAPI_inbound parameters 259 eDMSAPI_INBOUND table 259

eDMSAPI_inbound_event parameters 263 eDMSAPI_INBOUND_EVENT table 263

eDMSAPI_INBOUND_RESULT table 267

eDMSAPI_Msg_dly_n 257 eDMSAPI_PBX_licence_str 257

eDMSAPI_PBX_port_str 256

eDMSAPI_PBX_type_str 257

eDMSAPI_Seats_count_n 254

eDMSAPI_site_id_n 253

eDMSAPII_Area_id_n 259 eDMSAPII_Called_dev_str 259

eDMSAPII_Comments_str 260

eDMSAPII_Site_id_n 259 eDMSAPII_Type_str 259

eDMSAPIIE_Ala_id_Normal_n 264 eDMSAPIIE_Ala_id_Urgent_n 264

eDMSAPIIE_Area_id_n 263 eDMSAPIIE_Calling_dev_str 263

eDMSAPIIE_Comments_str 264

eDMSAPIIE_Site_id_n 263

eDMSAPIIR_Area_id_n 267

eDMSAPIIR_Calling_dev_str 268

eDMSAPIIR_Comments_str 269 eDMSAPIIR_Descr_str 269

eDMSAPIIR_GRP_Name_str 268

eDMSAPIIR_IC_Called_dev_str 267

eDMSAPIIR_Msg_str 268

eDMSAPIIR_Site_id_n 267

eESPA parameters 271 eESPA table 271

eESPA_Ala_descr_default_str 280

eESPA_Area_id_n 271

eESPA_Comments_str 283

eESPA_ControlStation_b 272

eESPA_DataId_Ala_descr_str 278

eESPA_DataId_Group_str 273

eESPA_DataId_Msg_str 275

eESPA_ExternalAddress_n 273

eESPA_Group_default_str 275

eESPA_Handshaking_n 281

eESPA_Link_Type_str 272

eESPA_LocalAddress_n 273

eESPA_Msg_default_str 277

eESPA_NAK_retry_cnt_n 281

eESPA_OUT_Call_type_default_str 282 eESPA_OUT_Nmbr_transm_default_str 282

eESPA_outbond_cfg parameters 285 eESPA_OUTBOUND_CFG table 285

eESPA_Polling_address_list_str 272 eESPA_Polling_intv_n 272

eESPA_Remove_after_str 280

eESPA_Site_id_n 271

eESPA_Timeout_n 281

eESPAO_ALA_Prty_from_n 285

eESPAO_ALA_Prty_to_n 286

eESPAO_Area_id_n 285

eESPAO_BeepCode_str 286

eESPAO_Priority_str

286–287

eESPAO_Site_id 285

eIO_AI parameters 293 eIO_AI table 293

eIO_DI parameters 305 eIO_DI table 305

eIO_DO parameters 309 eIO_DO table 309

eIO_MODULE table 289 eIO_modules parameters 289

eIOAI_ALA_Descr_str 297

eIOAI_Area_id_n 293

eIOAI_Comments_str 297

eIOAI_Contact_str 294

447



NN43120-301 02.01

4 June 2010


.

448

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

eIOM_Comments_str 291

eIOM_Contact_cnt_n 290

eIOM_Module_str 289 eIOM_Site_id_n 289

eIOM_Type_str 290 eIOM_Url_str 290

eKERNEL_alarm parameters 315

eKERNEL_ALARM parameters 139

eKERNEL_ALARM table 315

eKERNEL_area parameters 313 eKERNEL_AREA table 313

eKERNEL_DEVICE parameters 327 eKERNEL_DEVICE table 327

eKERNEL_DEVICE_ALT parameters 333 eKERNEL_DEVICE_ALT table 333

eKERNEL_DEVICE_FORMAT parameters 337 eKERNEL_DEVICE_FORMAT table 337

eKERNEL_GROUP parameters 343 eKERNEL_GROUP table 343

eKERNEL_GROUP_AUTH 143

eKERNEL_GROUP_AUTH parameters 347 eKERNEL_GROUP_AUTH table 347

eKERNEL_GROUP_MEMBER parameters 349 eKERNEL_GROUP_MEMBER table 349

eKERNEL_GUARDING parameters 357 eKERNEL_GUARDING table 357

eKERNEL_HOLIDAY parameters 363 eKERNEL_HOLIDAY table 363

eKERNEL_INPGM parameters 365 eKERNEL_INPGM table 365

eKERNEL_MESSAGE_FORMAT parameters 373 eKERNEL_MESSAGE_FORMAT table 373

eKERNEL_SITE parameters 377 eKERNEL_SITE table 377

eKERNEL-TCPCLIENT parameters 385 eKERNEL_TCPCLIENT table 385

ELDAD example 318

eLOC_Area_id_n 391

eLOC_Comments_str 393

eLOC_GeneralTimeOut_n 392

eLOC_LA_address_str 391

eLOC_LA_port_str 392

eLOC_Polling_intv_n 393

eLOC_Retry_count_n 392 eLOC_Retry_intv_n 392

eLOC_Site_id_n 391

eLOCATION INBOUND RESULT table 395

eLOCATION parameters 391

eLOCATION RPN table 399

eLOCATION table 391

eLOCATION_INBOUND_RESULT parameters 395

eLOCATION_RPN parameters 399

eLOCIR_Called_dev_str 395 eLOCIR_Calling_dev_str 395

eLOCIR_Comments_str 397

eLOCIR_eLOC_Area_id_n 396 eLOCIR_eLOC_Site_id_n 396 eLOCIR_GRP_Name_str 396

eLOCIR_Inpgm_id_n 395

eLOCIR_Msg_str 396

eLOCRPN_Area_id_n 399

eLOCRPN_Comments_str 400 eLOCRPN_Message_str 400

eLOCRPN_RPN_str 399 eLOCRPN_Site_id_n 399

Email 161

Email address 168

End script 198

Ended alarms 181

Ended scripts 202

eOAI parameters 401



NN43120-301 02.01

4 June 2010


.

449

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 eSMTP_CLIENT table 405

eSMTP_Comments_str 407 eSMTP_From_address_str 407

eSMTP_server 25

eSMTP_SERVER parameters 409

eSMTP-server shortcut parameters 27

eSMTP_SERVER table 409

eSMTP_Silence_intv_n 407

eSMTP_Site_id_n

405, 409

eSMTP_srv_domain_str 406

eSMTP_srv_ip_str 405

eSMTP_srv_port_str 406

eSMTPS_ALA_id_n 412

eSMTPS_Area_id_n 409

eSMTPS_Comments 412 eSMTPS_Delivery_text_str 412

eSMTPS_Email_dir_error_str 411

eSMTPS_Email_dir_processed 410

eSMTPS_Email_dir_str 409

eSMTPS_Email_keep_error_n 411 eSMTPS_Email_keep_processed_n 411

eSMTPS_NonDelivery_text_str 412

eSMTPS_Poll_intv_n 410

eSNMP 39 eSNMP Architecture 39

eTM registry setting 68

eTM_HA 65

eTM_HA Check task 81

eTM_HA publisher 84

eTM_HA registry settings 73

eTM_HA shut down 82

eVBVOICE AVHR 117

eVBVOICE inbound calls 97 eVBVOICE menu option level 1 97

eVBVOICE Menu option level 2 99

eVBVOICE module

95, 104 eVBVOICE outbound calls 104

eWEB module 123

eWEB parameters

413, 415

eWEB sign-off procedure 125

eWEB sign-on procedure 123

eWEB table 413 eWEB_Address_str 413

eWEB_Area_id_n 414 eWEB_Branding_str 414 eWEB_Comments_str 414 eWEB_eKERNEL_address_str 414

eWEB_SCRIPT table 415

eWEB_SCRIPT_CANCEL_AUTH parameters 423 eWEB_SCRIPT_CANCEL_AUTH table 423

eWEB_SCRIPT_SET_AUTH parameters 419 eWEB_SCRIPT_SET_AUTH table 419

eWEB_SCRIPT_TRACE_AUTH parameters 421 eWEB_SCRIPT_TRACE_AUTH table 421

eWEB_Site_id_n 413

eWEB_SNDGRPMSG table 425

eWEB_SNDUSRMSG parameters 429 eWEB_SNDUSRMSG table 429

eWEB_TOC parameters 433 eWEB_TOC table 433

eWEB_USER_AUTH file 142

EWEB_USER_AUTH parameters 439 eWEB_USER_AUTH table 439

Expert configuration 228

Expert function 226

Expert PHP information 229

Expert tasks 226

Export import 230

F

FMT_AllowEmergency_b 340






NN43120-301 02.01

4 June 2010


.

450

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

GRP_id_str 343

GRP_InPGM_id_n 344

GRP_Mon_b 353

GRP_Name_str 344

GRP_OUTPGM_Appl_str 351

GRP_Sat_b 354

GRP_Sun_b 354

GRP_Thu_b 353

GRP_To_str 352

GRP_Tue_b 353

GRP_Wed_b 353

GRPA_Comments_str 348

GRPA_GRP_id_str 347

GRPA_UserID_str 347

GRPM_Activate_timestamp_str 354

GRPM_Desactivate_timestamp_str 355

GRPM_Dev_Area_id_n 351

GRPM_Dev_id_str 350

GRPM_Dev_Site_id_n 351

GRPM_GRP_id_str 349

GUA_ALA_id_n 360

GUA_Comments_str 361

GUA_Fri_b 359

GUA_From_str 357

GUA_GRP_Name_str 360



NN43120-301 02.01

4 June 2010


GUA_INPPGM_id_n 357

GUA_Mon_b 358

GUA_msg_str 360

GUA_Sat_b 359

GUA_Sun_b 359

GUA_Thu_b 359

GUA_Timeout_n 359

GUA_To_str 358

GUA_Tue_b 358

GUA_Wed_b 359

Guarding example 318

H

Holiday_Comments_str 364

Holiday_str 363

I

IBM AS/400 47

IBMi5 47

Inbound calls 95

Ini settings

105, 111

Initialization of eSMTP_server 27

INPGM_Appl_str 366

INPGM_Area_id_n 366

INPGM_AutoCreateGRP_b 369

INPGM_Bidir_b 368

INPGM_Comments_str 371

INPGM_Default_DEV_OUTPGM_facility_str 370

INPGM_Default_DEV_OUTPGM_str 370

INPGM_Descr_str 370

INPGM_id_n 365

INPGM_Manufacturer_str 367

INPGM_Model_str 367

INPGM_Resource_str 368

INPGM_Settings_str 368

INPGM_Site_id_n 366

Input program 25

Inquiry functions of all tables 142

Installing export import 230

Internet Information Server 23

K

Keyword processing 27

L

Languages 105

Layout 105

.

451

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

M

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

Migrate system from eTM to eTM_HA 65

Mobile phone

161, 166

Module eSMTP 13

Module eSMTP_server 25

Module eSNMP 39

Module eTM_HA 65

Module eVBVOICE 95

Module eVBVOICE AHVR 117

Module eWEB 123

Module Web Administrator 149

Module Web administrator user guide 153

Msg_Ala_id_n 373

Msg_Comments_str 375

Msg_descr_str 374

Msg_Msg_str 374

Msg_VBVoice_phrase_str 374

N

National Instruments example 318

O

Outbound calls 95

Output program activity 15

P

P

0 91

1 91

Password

159, 177

PBX 105

PHP 229

PlayMsgs 105

Plug-in modules 147

Plug-in support 147

Publisher

87, 92

Publisher and subscriber model 67

Publisher section 73

R

Record 105

RECORD 118

Record specific alarm message 117

Recording wave files 101

.reg files 79

Registry definitions 87

Relaying and routing eSMTP 21

Reporting active scripts 200

Reporting ended scripts 202

Reports of active alarms 178

Reports of ended alarms 181

Reports on alarms 183

Reset alarms 117

Rhetorex

105, 111

S

Sample data 241

SAPI_ASR 105

SAPI_TTS 105

Script message 136

Send a message 161

Send an SNMP trap 204

Send DMS-API message 126

Send group message 131

Send message requests 29

Send message to DECT handset 162

Send message to e-mail address 168

Send message to mobile phone 166

Send message using group message 171

Send message using User message 174

Send script message 136

Send server message 129

Send SMTP message 128

Send SNMP message

45, 47

Send SNMP Message 46

Send user message 134

Server message 129

Set alarm 118

Set script 137




NN43120-301 02.01

4 June 2010


.

452

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 92

System 105

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 eESPA 271

Table eESPA_OUTBOUND_CFG 285

Table eIO_AI 293

Table eIO_DI 305

Table eIO_DO 309

Table eIO_MODULE 289

Table eKERNEL_ALARM 315

Table eKERNEL_AREA 313

Table eKERNEL_DEVICE 327

Table eKERNEL_DEVICE_ALT 333

Table eKERNEL_DEVICE_FORMAT 337

Table eKERNEL_GROUP 343

Table eKERNEL_GROUP_AUTH 347

Table eKERNEL_GROUP_MEMBER 349

Table eKERNEL_GUARDING 357

Table eKERNEL_HOLIDAY 363

Table eKERNEL_INPGM 365

Table eKERNEL_MESSAGE_FOR-

MAT 373

Table eKERNEL_SITE 377

Table eKERNEL_TCPCLIENT 385

Table eLOCATION 391

Table eLOCATION INBOUND RESULT 395

Table eLOCATION RPN 399

Table eOAI 401

Table eOAP 403

Table eSMTP_CLIENT 405

Table eSMTP_SERVER 409

Table eWEB 413

Table eWEB_SCRIPT 415

Table eWEB_SCRIPT_CAN-

CEL_AUTH 423

Table eWEB_SCRIPT_SET_AUTH 419

Table eWEB_SCRIPT_TRACE_AUTH 421

Table eWEB_SNDGRPMSG 425

Table eWEB_SNDUSRMSG 429

Table eWEB_TOC 433

Table eWEB_USER_AUTH 439

Table view 142

Task manager

81–82

TCPCLIENT_Area_id_n 386

TCPCLIENT_Comments_str 389

TCPCLIENT_Environment_str 388

TCPCLIENT_INPGM_id_n 386

TCPCLIENT_kernel_port_str 385

TCPCLIENT_pgm_name_str 387

TCPCLIENT_site_id_n 385

TCPCLIENT_socket_str 387

TELEVIC example 318

Trace active script 138

Trace ended script 139

U

User message

134, 161, 174

User name 159

USERA_Allobj_b 441

USERA_Comments_str 444

USERA_Description_str 440

USERA_Email_str 440

USERA_Language_str 442

USERA_Password_str 440

USERA_Sec_level_n 440

USERA_Secadm_b 441

USERA_Service_b 442

USERA_UserID_str 439

V

VBV4.ini file settings 105

VBV4.ini hardware-specific settings 111

Voicecard 111

VoiceCard 105

W

WCS_ALA_id_n 416



NN43120-301 02.01

4 June 2010


.

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 226

Work with users 151

WSC_Area_id_n 415

WSC_Currently_Active_n 417

WSC_GRP_Name_str 416

WSC_Max_Active_n 417

WSC_Min_dev_cnt_str 417

WSC_Msg_str 416

WSC_Script_Descr_str 416

WSC_Script_id_n 415

WSC_Site_id_n 415

WSCA_Area_id_n 423

WSCA_Comments_str

417, 424

WSCA_Script_id_n 423

WSCA_Site_id_n 423

WSCA_UserID_str 423

WSSA_Area_id_n 419

WSSA_Comments_str 420

WSSA_Script_id_n 419

WSSA_Site_id_n 419

WSSA_UserID_str 419

WSTA_Area_id_n 421

WSTA_Auth_str 422

WSTA_Comments_str 422

WSTA_Script_id_n 421

WSTA_Site_id_n 421

WSTA_UserID_str 422

WTC_Comments_str 436

WTC_Group_n 433

WTC_Item_n 434

WTC_Language_str 434

WTC_Link_str 435

WTC_Sec_n 435

WTC_Site_id_n 433

WTC_Text_str 434

WUM_AlA_id_n 430

WUM_Message_str 430

WUM_Sequence_n 429

WUM_User_id_str 429

X

x-receiver 27 x-sender 27

XML image 90



NN43120-301 02.01

4 June 2010


453

454

.



NN43120-301 02.01

4 June 2010




Release: 7.0

Publication: NN43120-301

Document revision: 02.01

Document release date: 4 June 2010


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.

Nortel, Nortel Networks, the Nortel logo, and the Globemark are trademarks of Nortel Networks.

All other trademarks are the property of their respective owners.

To provide feedback or to report a problem in this document, go to www.nortel.com/documentfeedback.

www.nortel.com