ETM System v4.0 Technical Reference...both printed and electronic (PDF) format: ETM® Concepts...

ETM® System v4.0

Technical Reference

About SecureLogix Corporation

San Antonio, Texas-based SecureLogix Corporation was founded in 1998 by former government information warfare experts and leading Big-5 security consultants, and has more than 100 years of combined experience securing critical government and corporate information systems. SecureLogix Corporation provides secure, intelligent communications product solutions and professional services, including systems engineering, consulting, training, and technical support that enable the management and protection of all business-critical voice, video, and data infrastructure assets.

For more information about SecureLogix Corporation and its products and services, please contact us at:

Customer Support: Telephone: 1-877-SLC-4HELP Email: [email protected] Web Page: http://support.securelogix.com

Corporate Headquarters: SecureLogix Corporation 13750 San Pedro, Suite 230 San Antonio, Texas 78232 Telephone: 210-402-9669 (non-sales) Fax: 210-402-6996 Email: [email protected] Website: http://www.securelogix.com

Training: Telephone: 210-402-9669 Email: [email protected] Web Page: http://training.securelogix.com

Sales: Telephone: 1-800-817-4837 (North America) Email: [email protected]

Documentation: Email: [email protected] Web Page: http://support.securelogix.com

IMPORTANT NOTICE:

This manual, as well as the software and/or Products described in it, is furnished under license with SecureLogix Corporation ("SecureLogix") and may be used only in accordance with the terms of such license.

Except as permitted by such license, no part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without prior written permission of SecureLogix.

The content of this manual is subject to change without notice. SecureLogix assumes no responsibility or liability for any errors or inaccuracies that may be contained herein or to correct the same.

ETM, the ETM Emblem, TeleWall, TeleAudit, TeleView, TeleVPN, the TeleWall Emblem, the TeleAudit Emblem, the TeleView Emblem, the TeleVPN Emblem, SecureLogix, SecureLogix Corporation, and the SecureLogix Diamond Emblem are trademarks or registered trademarks of SecureLogix Corporation in the U.S.A. and other countries. All other trademarks mentioned herein are believed to be trademarks of their respective owners.

© Copyright 1999-2002 SecureLogix Corporation. All Rights Reserved. U.S. Patents No. US 6,249,575 B1 and US 6,320,948 B1.

U.S. and Foreign Patents Pending.

This product includes:

Data Encryption Standard software developed by Eric Young ([email protected]), © Copyright 1995 Eric Young. All Rights Reserved.

(see DESLicense.txt on ETM software CD)

Style Report software owned and licensed exclusively by InetSoft Technology Corp. © Copyright 1996-2000 InetSoft Technology Corp. All Rights Reserved.

Software developed by The Apache Software Foundation (http://www.apache.org/) © Copyright 2000 The Apache Software Foundation. All Rights Reserved.

(See ApacheLicense.txt on ETM software CD.)

Linux kernel software developed by Linus Torvalds and others; and Busy Box software developed by Bruce Perens and others. Distributed pursuant to the General Public License (GPL).

See the Open Source Code directory on the ETM software CD for related copyrights, licenses, and source code.

GNU C Library software; Distributed pursuant to the Library General Public License (LGPL). See the Open Source Code directory on the ETM software CD for related copyrights,

licenses, and source code.

Customer Support for Your ETM® System

1-877-SLC-4HELP [email protected]

http://support.securelogix.com

SecureLogix Corporation offers telephone, email, and web-based support.

For details on warranty information and support contracts, see our web site at


Contents • i

Contents

Preface v About the ETM® System Documentation ...........................................................................v

ETM® System Documentation..............................................................................v Tell Us What You Think .................................................................................... vi Additional Documentation on the Web .............................................................. vi Conventions Used in This Guide ........................................................................ vi

Appliance Status LEDs 1 LED Descriptions................................................................................................................1

LEDs on ETM® 1000-Series Appliances..............................................................1 LEDs on the ETM® 2000- and 3000-Series Appliance ........................................3

Telnet 5 Managing Telnet Logins to Cards.......................................................................................5

Authorizing Telnet Clients for a Card ..................................................................5 Logging In to a Span via Telnet............................................................................6 Failed Telnet Logins Shut Down Telnet Server....................................................7

ETM® Commands 9 ETM® Commands Reference..............................................................................................9

Important Information about Authority of Server.................................................9 Removing a Card Icon from the Tree ...................................................10

Using the Commands..........................................................................................10 Alphabetical Listing of Commands ....................................................................11

Error and Debug Logs 45 Error and Debug Logs on the ETM® Server .....................................................................45

Error Logs...........................................................................................................45 SMDR Debug Logs ............................................................................................46 Span Call/Debug Logs........................................................................................46

Logging Span Call/Debug Events to a File ..........................................46 Viewing Debug Logs............................................................................47

server-fatal Logs .................................................................................................48

System Backup and Recovery 49

ii • Contents

Backup and Recovery Guidelines .....................................................................................49 General Guidelines for Backup Maintenance .....................................................49 What to Back Up ................................................................................................49 Complete System Backup...................................................................................50 ETM® Software Installation Directory Backup ..................................................50

Restoring the ETM® Software Installation from a Full Backup ..........50 Backing Up the Database....................................................................................51

Full Database Backup...........................................................................51 Performing a Cold Database Backup....................................................52 Restoring from a Cold Backup .............................................................53

Properties/Configuration File Settings 55 User-Definable Settings in Properties/Configuration Files ...............................................55

Specifying Leading Characters for Pages ...........................................................55 Settings that Affect Reports................................................................................56 Increasing the Stack Size for the Java Virtual Machine .....................................56 Changing the Subject Line for TeleWall® Policy Tracks ...................................57 Tuning the Active-to-Historical Data Transfer Frequency .................................59

Changing the Transfer Interval Before Creating a New Data Instance ..........................................................................................59

Specifying a Modem Port for Page Tracks .........................................................60 Disabling ETM® Server-to-TeleView™ Console Encryption .............................60 Changing the Extended ETM® Application Disconnect Threshhold..................61

Windows-Specific System Settings 63 Settings that Apply to Windows Systems Only ................................................................63

Increasing the Virtual Memory on Windows NT/2000 ......................................63 Setting the TeleAudit® and ETM® Server Services to Autostart ........................64 ETM® or TeleAudit® Server Fails to Start Due to PATH Configuration............65

Uninstalling, Modifying, or Repairing the ETM® Applications 67 How to Uninstall, Modify, or Repair the ETM® Applications..........................................67

Windows.............................................................................................................67 Administering the Applications on Solaris .........................................................68

Viewing the Installation Packages........................................................68 Removing the Applications ..................................................................69

Database Maintenance 71 Using the ETM® Database Maintenance Tool ..................................................................71

Opening the Database Maintenance Tool ...........................................................71 Logging in to the Database .................................................................................72 Creating a Database ............................................................................................74 Deleting a Database ............................................................................................75 Disconnecting from a Database ..........................................................................75 Working with Data Instances..............................................................................75

Exporting a Data Instance ....................................................................75

Contents • iii

Importing an Exported Data Instance...................................................79 Setting a Data Instance as the Default ..................................................80 Deleting a Data Instance.......................................................................81 Creating a New Data Instance ..............................................................81

Managing Tables ................................................................................................82 Viewing a Table ...................................................................................82 Attempting to Repair a Table ...............................................................84 Clearing a Table ...................................................................................85 Deleting a Table ...................................................................................85 Creating a Missing Table......................................................................85

Defining Dialing Plans 87 About Dialing Plans ..........................................................................................................87

Types of Dialing Plans........................................................................................88 Default Dialing Plans ...........................................................................88

Defining and Installing Dialing Plans.................................................................89 Defining Dialing Plans .........................................................................89 Installing Dialing Plans on a Span........................................................90

Dialing Plan Contents .........................................................................................91 Section Header .....................................................................................92 Section Body ........................................................................................92

Dialing Plan Section Header Components ........................................................................93 cc.........................................................................................................................93 Name...................................................................................................................93 Label ...................................................................................................................93

Call Labels ..........................................................................................94 Phone Number Labels ..........................................................................94

Options................................................................................................................96 Type..................................................................................................................101

Defining Dialing Plan Sections.......................................................................................102 CC.....................................................................................................................102 Classify .............................................................................................................102 DDD .................................................................................................................103 Default ..............................................................................................................103 DID ...................................................................................................................104 Expand ..............................................................................................................105 NNP ..................................................................................................................106 NPA ..................................................................................................................107 Prefix ................................................................................................................107 Suffix ................................................................................................................107 Special ..............................................................................................................107

Dialing Plan Processing ..................................................................................................108 Phone Number Identification............................................................................108 Phone Number/Call Classification Phase .........................................................110

Defining an SMDR Parse File 111 About SMDR Parse Files ................................................................................................111

Files Already Defined.......................................................................................111

iv • Contents

Steps in Defining an SMDR Parse File.............................................................112 Enabling SMDR Debug Logging .....................................................................113 SMDR Parse File Components .........................................................................114

Section 1: Record Separator ...............................................................114 Section 2: Call Record........................................................................115

Final Fields .......................................................................................................115 Time Format Syntax ...........................................................................116

Regular Expression Syntax Quick Reference ...................................................118 Perl5 Regular Expression Syntax .......................................................118 Perl5 Extended Regular Expressions..................................................120

About the ETM® System Documentation • v

Preface

About the ETM® System Documentation The complete documentation for the ETM® System consists of a set of printed guides and in-depth, context-sensitive online Help.

The following set of guides is provided with your ETM® System in both printed and electronic (PDF) format:

ETM® Concepts Guide—Provides a conceptual and technical overview of the architecture and functionality of the ETM System.

ETM® System Installation Guide—Provides complete, step-by-step hardware and software installation instructions.

ETM® System Technical Reference—Provides reference information and instructions regarding settings inaccessible from the TeleView™ Console (such as those in Dialing Plan files, SMDR files, .properties and .cfg files), system backup recommendations, ETM Commands, using the Database Maintenance Tool, and other technical information not part of day-to-day system use.

TeleView™ Infrastructure Manager User Guide—Provides an overview of the TeleView application and instructions for using the TeleView Application to view telecommunications activity and administer the ETM System.

TeleWall® Telecom Firewall User Guide—Provides an overview of the TeleWall Firewall and instructions for creating and managing TeleWall Policies and viewing results of Policy enforcement.

TeleAudit® Usage Manager User Guide—Provides instructions and tutorials for producing reports of telecommunications accounting and TeleWall Policy enforcement.

ETM® System Safety and Regulatory Compliance Information—Provides statements regarding safety warnings and cautions; includes statements required for compliance with applicable regulatory and certification authorities.

ETM® System Documentation

vi • About the ETM® System Documentation

We welcome your suggestions or comments on the printed guides and the online Help provided with your ETM® System. Please send your documentation feedback to the following email address:

[email protected]

SecureLogix Corporation provides corrections and additional documentation for its products via the SecureLogix Knowledge Base online at the following web address:


The following conventions are used in this guide:

• Functions that require two or more mouse clicks to open a dialog box or make a selection are written using the pipe symbol. For example:

Click View | Implied Rules.

• Names of keys on the keyboard are uppercase. For example:

Highlight the field and press DELETE.

• If two or more keys must be pressed at the same time, the PLUS SIGN (+) is used as follows:

Press CTRL+ALT+DELETE.

• Bold text indicates GUI labels, menu items and options, literal file names, and paths. For example:

Click Edit, then click Preferences.

C:\Program Files\SecureLogix\ETM\TWLicense.txt

• Keyboard input is indicated by monospaced font. For example:

In the Name box, type: My report tutorial

• Italics indicate web addresses and names of publications.

• ETM System components and features are capitalized.

Tell Us What You Think

Additional Documentation on the Web

Conventions Used in This Guide

LED Descriptions • 1

Appliance Status LEDs

LED Descriptions The ETM® Communications Appliances have LEDs on the front and/or back of the chassis or Card to indicate status of ETM System operation and the telecommunications connections. The LEDs provide immediate visual notification of errors and warnings. Further investigation of these conditions can be made by viewing the entries in the Diagnostic Log and the Alert Tool, and by using ETM Commands via the ASCII Management Interface, direct serial connection to the Card, or Telnet.

For a detailed list of ETM Commands and their uses, see "ETM® Commands" on page 9.

The sections below describe the meanings of the various LED states on the ETM Communications Appliances.

The following LEDs appear on 1000-Series ETM® Communications Appliances:

• All 1000-series Appliances have a green Power LED on the front.

• The ETM 1010 Analog Appliance has 3 status LEDs on the back: Fault, Warning, and Normal.

• The ETM 1020, 1030, and 1040 Digital Appliances have six status LEDs. In addition to the Fault, Warning, and Normal LEDs are 3-telecom status LEDs: CO Alarms, PBX Alarms, and Online. These LEDs indicate whether the Appliance is operating normally and draw attention to conditions related to the Dialing Plan, Security Policy, Management Server interface, T1 or PRI status, Fail Safe Mode, and Card temperature. When LEDs indicate error conditions, further investigation of these conditions is made by viewing the entries in the Diagnostic Log and the Alert Tool, viewing the Health & Status display for the Card and/or Span and by using ETM Commands via the ASCII Management Interface, direct serial connection, or Telnet.

LEDs on ETM® 1000-Series Appliances

For a detailed list of ETM® Commands and their uses, see "ETM® Commands Reference" on page 9.

2 • LED Descriptions

The table below describes the types of information, errors, and warnings represented by the LEDs on the 1000 Series Appliances.

LED Status Meaning

Power Green • Power is on

Fault Red • Card temperature above 70 degrees C • Card in Fail-Safe mode • T1 or PRI Alarms (with CO/PBX Alarm LEDs red or yellow)

Warning Yellow • Dialing Plan: - file access error - allocation error - bad range or entry in file - range start greater than range end - unknown file name - algorithm ID out of range, no match string, or no

substitution string (DID) • Security Policy:

- failed to allocate Security Policy memory - invalid file (syntax error)/bad file name - unable to install default Rules - unable to install default Policy

• Management Server interface: - initially set to indicate connection to ETM® Server not

established - loss of Management Server socket connection

• Card temperature above 60 degrees C Normal Green, blinking • Dialing Plan read/parsed successfully

• Security Policy read/parsed successfully • Connection to ETM® Server is established • No telecom alarms • Card temperature below 60 degrees C

CO Alarms Yellow or Red (not on ETM 1010) With red Fault LED, indicates CO alarm (Blue Telco alarm also lights the red CO alarm LED)

PBX Alarms Yellow or Red (not on ETM 1010) With red Fault LED, indicates PBX alarm (Blue Telco alarm also lights the red PBX alarm LED)

Online Green (not on ETM 1010) Indicates equipment is inline and able to monitor calls

LED Descriptions • 3

On the ETM® 2000- and 3000-Series Appliances, the status LEDs are located on the panels of the Controller Card (in the front of the Appliance) and the Transition Module (in the back of the Appliance). These LEDs indicate whether the Appliance is operating normally and draw attention to conditions related to the Dialing Plan, Security Policy, Management Server interface, T1 or PRI status, Fail Safe Mode, and Card temperature. When LEDs indicate error conditions, further investigation of these conditions is made by viewing the entries in the Diagnostic Log and the Alert Tool, viewing the Health & Status display for the Card and/or Span, and by using ETM Commands via the ASCII Management Interface, direct serial connection, or Telnet.

The following table identifies the types of information, errors, and warnings represented by the LEDs on the ETM 2000- and 3000-Series Appliance.

LED Location Status and Meaning Error Controller

Card (front) • Error LED is off during normal operation with no errors detected

and the Status LED blinking green. • Red LED indicates:

– Card temperature above 70 degrees C – Card in fail safe mode – T1 or PRI Alarms (with Alarm LEDs red or yellow)

• Yellow blinking LED can indicate an error in one or more of the following: – Dialing Plan:

file access error allocation error bad range or entry in file range start greater than range end unknown file name algorithm ID out of range, no match string, or no substitution string

(DID) – Security Policy:

failed to allocate Security Policy memory invalid file (syntax error)/bad file name unable to install default Rules unable to install default Policy

– Management Server interface: initially set to indicate Card/Management Server socket is not

established loss of Management Server socket connection

– Cabinet temperature above 60 degrees C

LEDs on the ETM® 2000- and 3000-Series Appliance

For a detailed list of ETM® Commands and their uses, see "ETM® Commands Reference" on page 9.

4 • LED Descriptions

(LEDs on the ETM 2000- and 3000-Series Appliance, continued from previous page)

LED Location Status and Meaning Status Controller

Card (front) • Green and blinking, with Error LED off:

– Dialing Plan read/parsed successfully – Security Policy read/parsed successfully – ETM® Management Server socket connection established – No Telco Alarms – Cabinet temperature below 60 degrees C

I/F Controller Card (front)

• Green indicates that the Transition Module is operational • Red indicates that the Transition Module has an error.

PMC Controller Card (front)

• Off if the DSP Mezzanine Card is not present. • Green indicates that the DSP Mezzanine Card is operational. • Red indicates that the DSP Mezzanine Card has an error.

Alarm Transition Module (rear)

• Off during normal operation • Red indicates that the PBX/CO has a red alarm. • Yellow indicates that the PBX/CO has a yellow alarm.

Online Transition Module (rear)

• Green indicates equipment is inline and able to monitor calls • Off indicates that the equipment is offline.

Managing Telnet Logins to Cards • 5

Telnet

Managing Telnet Logins to Cards Authorized users can Telnet to a Span to view and set Card and Span configuration. The following security features protect the Cards and Spans from unauthorized Telnet access:

• The IP address of a Telnet client must be authorized to connect to the Card. Each Card has a Telnet Clients list and will reject Telnet connections from any computer not listed.

• A valid username and password must be provided to connect via Telnet, and the Enable password for the Card must be provided to modify settings.

If six Telnet login attempts fail within 10 minutes, the Span shuts down its Telnet server for 60 real-time minutes, preventing Telnet access. If this occurs, a Security event appears in the Diagnostic Log.

To authorize Telnet clients for a Card 1. In the TeleView™ Tree pane, right-click the Card and click Edit

Card(s). 2. Click the Telnet Clients tab.

See also "Failed Telnet Logins Shut Down Telnet Server" on page 7.

Authorizing Telnet Clients for a Card

6 • Managing Telnet Logins to Cards

3. Click New. The IP Address Entry dialog box appears.

4. Type the IP address of the computer from which you are

authorizing Telnet connections, then click OK. Alternately, you can specify an IP mask to authorize a group of Telnet clients. (For example, you can specify 10.1.1.255 to allow connections for any 10.1.1.x address.)

The IP address appears in the Valid Telnet IP Addresses box.

5. Click OK. The changes are downloaded to the Card and the Card will now accept Telnet connections from this IP address when a username and password are presented that:

• Are valid for the ETM Server controlling the Card.

• Belong to a user account that has permission to access the Card via RS232 login.

Telnet clients are authorized per Card, but each Span has its own Telnet server port. When you log in via Telnet, you specify the Span you want to access. If you Telnet to the Card IP address but you do not specify a Span port, you access Span 1 by default (port 23).

To Telnet to a specific Span

• After the IP address, type a space and then type the port for the Span you want to access as follows:

Span 2—port 24

Span 3—port 25

Span 4—port 26

For example, to Telnet to Span 3 of a Card at IP address 199.199.9.9, type

telnet 199.199.9.9 25

Logging In to a Span via Telnet

Managing Telnet Logins to Cards • 7

When an attempt to log in to a Span via Telnet fails, the current time is recorded, a timer is started, and a notification is sent to the Diagnostic Log. If six logins fail within 10 minutes, the Span shuts down its Telnet server for 60 minutes of real time, regardless of any changes to the Card clock. When this happens, a notification that the Telnet server has been shut down is sent to the Diagnostic Log.

To see when the Telnet server will be reactivated 1. In the TeleView™ Tree pane, right-click the Span and click

ASCII Management. The ASCII Management Interface appears.

2. In the Enter Command for Span box, type: SHOW TELNET

3. Press ENTER. The Telnet server restart time is displayed in the following format: Telnet Server Resume Time: Fri Jul 28: 11:55 2001

To restart the Telnet Server before the time has expired 1. In the TeleView Tree pane, right-click the Span and click

ASCII Management. The ASCII Management Interface appears.

2. In the Enter Command for Span box, type: RESTART

3. Press ENTER.

Failed Telnet Logins Shut Down Telnet Server

8 • Managing Telnet Logins to Cards

ETM® Commands Reference • 9

ETM® Commands

ETM® Commands Reference ETM® Commands can be issued via the following command line interfaces:

• ASCII Management Interface in the TeleView™ application.

• Telnet (Telnet is only available if the Card security posture is set to LOW).

• A terminal emulator application on a computer that is connected to the Console port of the Appliance Card.

After Cards and Spans have initially established communication with their owning ETM® Server, the Server stores a copy of the component’s configuration and is authoritative over all configuration settings. This means that each time the Card or Span connects to the Server, the Server determines whether the component’s configuration matches the copy stored on the Server. If they differ, the Server automatically pushes its copy of the configuration settings to the Card or Span.

Since the Server is authoritative, if you change a component's configuration via the Console port or Telnet, the changes are overwritten the next time the component connects to the Server. Changes made via the TeleView™ application are retained.

If it is necessary that the change be pushed from the Appliance component to the Server (such as when you change Span type), use the procedure below to remove the Card icon from the TeleView Console before allowing the Card/Span to reconnect. This deletes the Server's copy of the configuration; the Server then accepts the configuration from the Card when it reconnects.

Important Information about Authority of Server

10 • ETM® Commands Reference

To remove the Card icon from the tree 1. If the Card and Server are communicating, disrupt communication.

To do this, remove the Card IP address from the list of authorized IP addresses, then reboot the Card.

2. After the red bolt appears, indicating that the Card is not communicating, delete the Card icon from the tree by clicking Remove in the Card Configuration dialog box.

3. Re-enter the Card's IP address in the list of authorized IP addresses to allow it to reconnect.

The commands are listed in the table in all upper case for clarity; except for passwords, ETM® commands are not case sensitive. Type the part of the command that is listed in capital letters exactly as shown; the lower case, italicized part of the command in brackets indicates that a value should be inserted.

For example, for a Span in the 210 area code, the command shown in this guide as:

AREA CODE <value>

is typed as:

AREA CODE 210

You can type partial commands if the part that you type is unique. For example, for the command SHOW CONFIG, you can type

SH CO

Removing a Card Icon from the Tree

Using the Commands


The followingtable lists all of the available ETM® Commands in alphabetical order and describes their use.

ETM Command Follow-up Command

Appliance/ Span Type(s)

AAA ANSWER RINGS <value>

Specifies the number of rings before the AAA modem answers. The default is 2.

Example: AAA ANSWER RINGS 1 See also SHOW AAA CONFIG.

None AAA

AAA AUTH DURATION <milliseconds>

Specifies the maximum number of milliseconds for an authorization to complete. The default is 300,000 (5 minutes).

Example: AAA AUTH DURATION 300000 See also SHOW AAA CONFIG.

None AAA

AAA FAILED LIMIT <value>

Specifies the type of message provided to the user when the AAA LOCKOUT MAX value is exceeded during authorization. Valid values are 0 (None), 1 (Voice), and 2 (Tone). The default is 1 (Voice).

Example: AAA FAILED LIMIT 1 See also SHOW AAA CONFIG.

None AAA

AAA FAILED LOGINS <seconds>

Specifies the number of milliseconds failed login records are maintained. The default is 3600 seconds (1 hour).

Example: AAA FAILED LOGINS 3600 See also SHOW AAA CONFIG.

None AAA

AAA FAILED MSG <value>

Specifies the type of failed authorization message. Valid values are 0 (None), 1 (Voice), and 2 (Tone). The default is 1 (Voice).

Example: AAA FAILED MSG 1 See also SHOW AAA CONFIG.

None AAA

AAA HANGUP MAX <value>

Specifies the maximum number of login attempts before the call is disconnected. The default is 3.

Example: AAA HANGUP MAX 4 See also SHOW AAA CONFIG.

None AAA

Alphabetical Listing of Commands




AAA ID PROMPT <value>

Specifies the user ID prompt. Valid values are 0 (None), 1 (Voice), and 2 (Tone). The default is 1 (Voice).

Example: AAA ID PROMPT 1 See also SHOW AAA CONFIG.

None AAA

AAA LOCKOUT DURATION <seconds>

Specifies the number of milliseconds the account is locked out. The default is 86,400 seconds (1 day).

Example: AAA LOCKOUT DURATION 86400 See also SHOW AAA CONFIG.

None AAA

AAA LOCKOUT MAX <value>

Specifies the maximum number of login attempts before the user ID is locked out. The default is 3. See also SHOW AAA CONFIG.

None AAA

AAA LOCKOUT MSG <value>

Specifies the type of message provided when a user is locked out. Valid values are 0 (None), 1 (Voice), and 2 (Tone). The default is 1 (Voice).

Example: AAA LOCKOUT MSG 1 See also SHOW AAA CONFIG.

None AAA

AAA MODEM COUNT <value>

Specifies the number of modems in the AAA Appliance. Valid values are 0, 1, 2, 3, or 4. The default is 0.

Example: AAA MODEM COUNT 1 See also SHOW AAA CONFIG and SHOW AAA MODEM.

None AAA

AAA MODEM ENABLE <modem #> <value>

Specifies whether the modem (1, 2, 3, or 4) in the AAA Appliance is enabled or disabled. Valid values are ON or OFF. The default is disabled (OFF).

Example: AAA MODEM ENABLE 2 off See also SHOW AAA CONFIG and SHOW AAA MODEM.

None AAA

AAA MODEM PORT <modem #> <string>

Specifies the modem device string for the specified modem number (1, 2, 3, or 4). The default is /dev/modem.

Example: AAA MODEM PORT 1 /dev/tty1 See also SHOW AAA CONFIG and SHOW AAA MODEM.

None AAA




AAA MODEM SPEAKER <modem #> <value>

Specifies how long during the call the speaker in the specified modem (1, 2, 3, or 4) is active. Valid values are 1, 2, or 3. The default is 0. 0 = off for the entire call; 3 = on for the entire call.

Example: AAA MODEM SPEAKER 1 2 See also SHOW AAA CONFIG and SHOW AAA MODEM.

None AAA

AAA MODEM VOLUME <modem #> <value>

Specifies how loud the speaker in the specified modem (1, 2, 3, or 4) is while active. Valid values are 1 (off) to 3 (loud). The default is 2.

Example: AAA MODEM VOLUME 1 2 See also SHOW AAA CONFIG and SHOW AAA MODEM.

None AAA

AAA PIN PROMPT <value>

Specifies the AAA Services PIN number prompt. Valid values are 0 (None), 1 (Voice), and 2 (Tone). The default is 1 (Voice).

Example: AAA PIN PROMPT 1 See also SHOW AAA CONFIG.

None AAA

AAA PN PROMPT <value>

Specifies the AAA Services phone number prompt. Valid values are 0 (None), 1 (Voice), and 2 (Tone). The default is 1 (Voice).

Example: AAA PN PROMPT 1 See also SHOW AAA CONFIG.

None AAA

AAA PROMPT TIME <milliseconds>

Specifies the maximum number of milliseconds for a AAA Services prompt. The default is 30,000 (30 seconds).

Example: AAA PROMPT TIME 30000 See also SHOW AAA CONFIG.

None AAA

AAA SERVER IP <IP_addr>

Specifies the IP address of the locally connected AAA Appliance Card. The default is 0.0.0.0, which indicates that no Appliance is available.

Example: AAA SERVER IP 10.1.1.1 See also SHOW AAA CONFIG.

COMM RESET

All Span types.

AAA SERVER KEY <passphrase>

Specifies the DES key for Span connections to the AAA Appliance. The default is specified during initial "Out-of-the-Box” Configuration.

Example: AAA SERVER KEY AKSKFK83493JDAH9 See also SHOW AAA CONFIG.

None AAA




AAA SERVER LEVEL <value>

Specifies the DES encryption level for Span connections to the AAA Appliance. Valid values include 0 (no encryption), 1 (Single DES), and 2 (Triple DES). The default is 0 (no encryption).

Example: AAA SERVER LEVEL 0 See also SHOW AAA CONFIG.

None AAA

AAA SERVER PORT <port>

Specifies the IP port listener on the locally connected AAA Appliance. The default is 4312.

Example: AAA SERVER PORT 4312 See also SHOW AAA CONFIG.

None AAA

AAA SHUTDOWN MSG <value>

Specifies the message provided to the user when the AAA service shuts down during an authorization session. Valid values are 0 (None), 1 (Voice), and 2 (Tone). The default is 1 (Voice).

Example: AAA SHUTDOWN MSG 1 See also SHOW AAA CONFIG.

None AAA

AAA SUCCESS MSG <value>

Specifies the successful authorization message. Valid values are 0 (None), 1 (Voice), and 2 (Tone). The default is 1 (Voice).

Example: AAA SUCCESS MSG 1 See also SHOW AAA CONFIG.

None AAA

AAA THANKS PROMPT <value>

Specifies the thank-you message played at the end of the authorization call. Valid values are 0 (None), 1 (Voice), and 2 (Tone). The default is 1 (Voice).

Example: AAA THANKS PROMPT 1 See also SHOW AAA CONFIG.

None AAA

AAA WELCOME MSG <value>

Specifies the message provided to the user when a modem in the AAA Appliance answers the phone. Valid values are 0 (None), 1 (Voice), and 2 (Tone). The default is 1 (Voice).

Example: AAA WELCOME MSG 1 See also SHOW AAA CONFIG.

None AAA




AREA CODE <value>

Specifies the local area code. Initial value is set to 210.

Example: AREA CODE 210 See also SHOW POLICY STATUS.

POLICY CONFIG UPDATE

All Span types

CALL COUNTER <value>

Displays/clears call progress counters. Valid values include TOTAL, ALL, and CLEAR, or a specific channel number. Examples: CALL COUNTER 8

CALL COUNTER ALL See also SHOW CALL COUNTERS.

None All Span types

CALLER ID MAP <value>

Specifies whether Caller ID data is available on all channels or none. Valid values are POTS, T1, E1, NONE, ALL, or a hexadecimal mask (to specify specific channels). Examples: To specify that Caller ID is available on channels 1 through 8, type CALLER ID MAP 0xff

To specify that Caller ID is not available on any channels, type CALLER ID MAP NONE

To specify that Caller ID is available on all channels, type CALLER ID MAP ALL See also SHOW CONFIG.


All Span types

CHANNEL MAP <value>

Specifies which channels to monitor; up to 24 (T1), 30 (European ISDN PRI), or 12 (Analog). Valid values are POTS, T1, E1, or a hexadecimal mask (to specify specific channels). Example: To specify to monitor channels 1 through 8, type: CHANNEL MAP 0xff. See also SHOW CONFIG


All Span types

CLOCK SET <hhmmss-mmddyyyy>

Sets the time and date on the Controller Card clock, using 24-hour format. Example: To set the time and day as 10:56 PM on July 8, 1998, type 225600-07081998

None All Span types




COMM RESET

Closes the ETM Server, Telnet, and Console port connections, then restarts these connections.

Example: COMM RESET

None All Span types

CONSOLE BAUD <baud_rate>

Specifies the baud rate for the Card Console port. Valid values are 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, or 115200. The default is 9600.

Example: CONSOLE BAUD 9600 See also SHOW SERIAL

None All Span types

CONSOLE CR <value>

Send carriage return (ON) or new line (OFF). Valid values are ON and OFF. The default is OFF (send Carriage Return).

Example: CONSOLE CR ON See also SHOW SERIAL.

None All Span types

COUNTRY CODE <value>

Specifies the local country code. For example, type 1 for US, 44 for UK. Default value is 1.

Example: COUNTRY CODE 1 See also SHOW POLICY STATUS.


All Span types

DES KEY <key>

Specifies the DES passphrase for the Controller Card.

Example: DES KEY AKSKFK83493JDAH9 See also SHOW DES.

COMM RESET All Span types

DISABLE

Disables ENABLE mode (read/write).

Example: DISABLE See also ENABLE LOGIN value, ENABLE PASSWORD, and SHOW SERIAL

None All Span types




DSP DEBUG <DSP NUM or ALL> <level>

(Note: This command can only be issued from Span 1.) Turns on/off debug messages from the DSP. When on, there are two levels of messages: LEVEL 1 and LEVEL 2. Level 2 is much more verbose than level 1. When turned on, DSP debug message are recorded in the Span's message log. The Span sets the message type to DEBUG and prepends the message with "DSP Debug Message:" A log mask can be set to selectively display all DEBUG messages or not. Valid values are: <level> = OFF, LEVEL1, LEVEL2 <DSP NUM or ALL> = 0,1,2,3,4,5,6,7,8,9,ALL

Example: DSP DEBUG ALL LEVEL1

None ETM 2100 and 3200 Cards

E1 CLOCK <value>

Specifies whether to derive transmit clock from telephone network or PBX. Valid values are PBX and CO. CO is the default.

Example: E1 CLOCK CO See also SHOW E1.

REBOOT Euro ISDN PRI Spans

E1 CONFIG UPDATE

Uses updated line interface configuration.

Example: E1 CONFIG UPDATE

None Euro ISDN PRI Spans

E1 ERROR THRESHOLD <number>

Sets minimum number of line errors during a heartbeat period before a Log Event alarm is triggered. The default is 5.

Example: E1 ERROR THRESHOLD 5 See also SHOW E1.


E1 FRAMING<value>

Sets framing. Valid values are BASIC, CRC4, and NON-CRC4. The default is CRC4.

Example: E1 FRAMING CRC4 See also SHOW E1.

E1 CONFIG UPDATE

Euro ISDN PRI Spans

E1 INLINE

Sets state so that the Span goes inline on reboot or restart.

Example: E1 INLINE See also SHOW E1.

RESTART Euro ISDN PRI Spans

E1 LINE CODING <value>

Sets line encoding. Valid values are AMI and HDB3. The default is HDB3.

Example: E1 LINE CODING HDB3 See also SHOW E1.

E1 CONFIG UPDATE

Euro ISDN PRI Spans




E1 LINE LENGTH CO 120

Specifies ETM Communications Appliance-to-CO line length impedence in ohms. The default is 120.

Example: E1 LINE LENGTH CO 120 See also SHOW E1.

E1 CONFIG UPDATE

Euro ISDN PRI Spans

E1 LINE LENGTH PBX 120

Specifies ETM Communications Appliance-to-PBX line length impedence in ohms. Default is 120 ohms.

Example: E1 LINE LENGTH PBX 120 See also SHOW E1.

E1 CONFIG UPDATE

Euro ISDN PRI Spans

E1 OFFLINE

Closes E1 relays so that calls bypass Span.

Example: E1 OFFLINE


E1 SPAN CHECK ON | OFF

Turns on and off the hung Span detector. The default is ON. Do not set this value to OFF unless instructed to do so by SecureLogix Customer Support.

Example: E1 SPAN CHECK ON

REBOOT Euro ISDN PRI Spans

E1 STATS CLEAR

Clears E1 statistics.

Example: E1 STATS CLEAR


E1 TELCO DELAY <seconds>

Specifies the number of seconds a trunk must remain in alarm status before the Telco Log Event alarm is triggered. If the trunk goes into alarm, but clears before the specified number of seconds elapses, then the Log Event is not generated. If the trunk goes into alarm and stays in alarm long enough for the Log Event, then the ALARM CLEARED message appears as soon as the alarm clears. The default is 60 seconds.

Example: E1 TELCO DELAY 60 See also SHOW E1.


ENABLE

Prompts for Enable password.

Example: ENABLE See also ENABLE LOGIN <seconds>, ENABLE PASSWORD, and SHOW SERIAL.

None All Span types




ENABLE LOGIN <seconds>

Sets the power-on Enable mode timeout to a value from 0 to 120 seconds. The default is 120. 0 disables power-on Enable mode, so that a login is always required.

Example: ENABLE LOGIN 120 See also ENABLE PASSWORD and SHOW SERIAL.

None All Span types

ENABLE PASSWORD <password>

Sets the ENABLE mode (read/write) password. Password can contain up to 50 characters.

Example: ENABLE PASSWORD MyPasscode2 See also ENABLE LOGIN <seconds> and SHOW SERIAL.

None All Span types

EXIT

Closes the direct serial or Telnet connection to the Controller Card.

Example: EXIT

None All Span types

EXTENSION <channel> <line number>

On Analog Spans, maps a hardware channel to a PBX extension. On all Span types, used to provide the Span with a default source number of outgoing calls or a default destination number of incoming calls if this information is unavailable from call data or SMDR. Examples: To set the extension of channel 1 to a country code of 1 and area/city code of 210, and line number of 555-1212, type EXTENSION 1 [1] (210) 5551212

To delete the association between channel 5 and a logical PBX extension, type NO EXTENSION 5 To delete the association between all channels and PBX extensions, type NO EXTENSION ALL See also SHOW EXTENSION.


All Span types

GATEWAY <IP address>

Specifies the Card default IP gateway address, in dot notation. Examples: GATEWAY 10.1.1.1

For no gateway, type GATEWAY 0.0.0.0 See also SHOW IP and SHOW CONFIG.





HALT [NOW]

Performs controlled shutdown of the operating system on the Card. If you do not type NOW, you are prompted to confirm. Examples: HALT

HALT NOW

None All Span types

HEARTBEAT <seconds>

Specifies interval (in seconds) at which Span heartbeat statistics are sent to the ETM Server. Valid values are 3-3600. The default is 60 seconds. Examples: HEARTBEAT 60

NO HEARTBEAT See also SHOW SERVER and PLATFORM HEARTBEAT.

None All Span types

HELP

Lists available ETM commands for the Card/Span type.

Example: HELP

None All Span types

IP <IP address>

Specifies the Controller Card's IP address in dot notation (10.1.1.1).

Example: IP 10.1.1.1 See also SHOW IP.


ISDN ADD INTERFACE <dsl_num> <IP address>

Specifies the IP address of the associated NFAS group members in dot notation (10.1.1.1). <dsl_num> is the IDSN Q.931 interface ID/dsl number, not the Span number. ISDN KEY must be set on every member if you are setting up NFAS via ETM Commands. Example: ISDN ADD INTERFACE 4 10.1.1.1 See also SHOW ISDN. IMPORTANT Do not configure NFAS at the Console port. Use the TeleView Console. The ETM Server will not accept NFAS configuration from the Spans and it will be lost when the Spans connect to the Server. See "Defining NFAS Groups" in the ETM® System Installation Guide for configuration instructions.

COMM RESET North American ISDN PRI Spans using NFAS




ISDN BACKUP <dsl_num><IP address><Span#>

Specifies the interface/DSL, Span number, and IP address of the backup D channel. Example: To set the backup D-channel interface ID to 6 on Span 1 at IP address 10.1.1.16, type ISDN BACKUP 6 10.1.1.16 1 See also SHOW ISDN and ISDN PRIMARY id IP Span.

COMM RESET ISDN PRI Spans

ISDN CLEAR COUNTERS

Resets D-channel packet and NFAS packet counters.

Example: ISDN CLEAR COUNTERS

None North American ISDN PRI Spans using NFAS

ISDN CPN CHANGE <ON | OFF>

Specifies whether the Calling Party Number (CPN) value reported to the telephone network should be changed to a user-specified value. The default is OFF. Examples: ISDN CPN CHANGE OFF

ISDN CPN CHANGE ON See also SHOW ISDN.


ISDN PRI Spans

ISDN CPN NUMBER <number>

Specifies the digit string to be reported to the telephone network as the Calling Party Number (CPN) (10-digit string) when ISDN CPN CHANGE is ON. Examples: To specify 1-800-555-1212 to reported as the CPN, type ISDN CPN NUMBER 18005551212

To cause outgoing CPN to be delivered blank, type ISDN CPN NUMBER NONE


ISDN PRI Spans

ISDN CPN RESTRICT <ON |OFF>

Specifies whether Calling Party Number (CPN) delivery should be restricted. The default is OFF. Examples: ISDN CPN RESTRICT OFF

ISDN CPN RESTRICT ON See also SHOW ISDN.


ISDN PRI Spans




ISDN CPN TON <type>

Specifies outgoing Calling Party Number (CPN) Type of Number (TON). Values include UNKNOWN, NATIONAL, INTERNATIONAL, SUBSCRIBER. The default is NATIONAL for North American ISDN PRI and UNKNOWN for European ISDN PRI.

Example: ISDN CPN TON NATIONAL See also SHOW ISDN.


ISDN PRI Spans

ISDN DEL INTERFACE <dsl_num>

Deletes the IP address of the specified dsl/interface ID from the NFAS table.

Example: ISDN DEL INTERFACE 16

COMM RESET

ISDN PRI Spans

ISDN DIRECTION <value>

Specifies whether the Customer Premises Equipment stack or Network stack should run on the interface that is labeled TO CO on the 1000-series Appliance, or ports 1, 3, 5, and 7 on the 2100 and 3200 Transition Module. Used for ISDN PRI tie trunks. Valid values are NORMAL or REVERSE. The default is NORMAL.

Example: ISDN DIRECTION NORMAL See also SHOW ISDN.

RESTART ISDN PRI Spans

ISDN INTERFACE <number>

Sets PRI interface number. Valid values are 0-23. The default is 0.

Example: ISDN INTERFACE 0 See also SHOW ISDN.

RESTART North American ISDN PRI Spans using NFAS

ISDN KEY <key>

Sets NFAS DES encryption key.

Example: ISDN KEY QWERTY67KEYBOARD See also SHOW ISDN.


ISDN L2 CROSSOVER ON | OFF

Used for debugging PRI issues. Only change this setting if instructed to do so by SecureLogix Support personnel. Allows logical insertion/isolation from layer 2 and 3 on PRI Spans. Valid values are ON and OFF. The default is OFF.

Example: ISDN L2 CROSSOVER ON

RESTART North American ISDN PRI Spans using NFAS




ISDN L2 LOGGING ON | OFF

Determines whether ISDN Layer 2 messages are included in debug logs. Valid values are ON and OFF. The default is OFF.

Example: ISDN L2 LOGGING ON

None ISDN PRI Spans that have a D channel (i.e., 23B+D North American ISDN PRI, NFAS Primary or Backup, Euro ISDN PRI)

ISDN LEVEL <level>

Sets NFAS DES encryption level. Valid levels are NONE, SINGLE, or TRIPLE. NONE specifies no DES encryption and clear text messages.

Example: ISDN LEVEL TRIPLE See also SHOW ISDN.


ISDN PORT <number>

Sets NFAS TCP port for communication between NFAS Group Spans. Valid values are NONE or 1 through 65534. The default port is 4313. See also SHOW ISDN.


ISDN PRIMARY <dsl> <IP address> <Span>

Sets the interface/DSL number, Span number, and IP address of Primary D channel. Example: To set Primary D-channel interface ID to 6, with an IP address of 10.1.1.16, on Span 1, type ISDN PRIMARY 6 10.1.1.16 1 See also SHOW ISDN and ISDN BACKUP.

COMM RESET ISDN PRI Spans

ISDN PROTOCOL VARIANT <type>

Specifies the ISDN switch variant protocol used between PBX and telephone network. Valid values are: EUROISDN for European ISDN PRI; NI2, 4ESS, 5ESS, and DMS100 for North American ISDN PRI. The default is NI2. Example: ISDN PROTOCOL VARIANT EUROISDN See also SHOW ISDN.


ISDN TYPE <type>

Specifies the configuration of the PRI Span. Valid values for North American ISDN PRI are 23+D, 24B, D PRIMARY, and D BACKUP. Valid value for European ISDN PRI is 30+D.

Example: ISDN TYPE D PRIMARY See also SHOW ISDN.





LICENSE <key>

Specifies the license string passed from the ETM Server used to activate Spans, 2, 3, and/or 4 on a 4 Span Card. (Span 1 is licensed by default). Do not type separators between the characters in the string.

Example: LICENSE a234b56cd9123e98 See also SHOW LICENSE.

RESTART ETM 2100 and 3200 Cards

LICENSE CLEAR

Resets Card to single Span operation. (Span 1 is always licensed.)

Example: LICENSE CLEAR

REBOOT ETM 2100 and 3200 Cards




LOGMASK <type> <subtype> <startrecordnumber> <endrecordnumber>

Specifies the bit mask for the desired Log Event types and determines which Log Event messages are reported on the connection. LOGMASK <startrecordnumber> and <endrecordnumber> are more useful when combined with the current end_record_number reported by the SHOW STATUS command. INFO, CHAN, and DEBUG tokens are not logged to disk and are turned off by default. To turn them on, use the WRITEMASK command before using LOGMASK. You must supply a logmask command to start showing data. Valid tokens: ALL, NONE, INFO, CHAN, DEBUG, TELCO, STARTUP, WARN, ERROR, PANIC, SECURITY, CALL, POLICY. Note: Using LOGMASK ALL ALL via the Console port adds a significant load to the Card; however, entering the command via Telnet does not add a significant load to the Card. If you must send a large output via the Console port instead of using a Telnet session, set the baud rate to the highest rate supported by the Card and your terminal emulator. Examples: To show all data from all tokens, type LOGMASK ALL ALL

To show all data from specific tokens, type LOGMASK tok+tok ALL

To show all logged Call and Policy data, type LOGMASK CALL+POLICY ALL

To turn off the data display, type one of the following commands: LOGMASK NONE NONE

NO LOGMASK

LOGMASK 0 0

The following command captures all call debug information starting at record 1000 and ending at record 1050: LOGMASK CALL ALL 1000 1050

None All Span types

LOGOUT

Closes the Console port or Telnet connection.

Example: LOGOUT

None All Span types




MID CALL DIGITS <value>

Specifies whether DTMF digits collected during the call are reported to the ETM Server. Valid values are ON and OFF. The default is OFF. MID CALL DIGITS OFF See also SHOW POLICY STATUS.

None All Span types

NETMASK <mask>

Specifies the Card IP netmask, in dot notation.

Example: NETMASK 255.255.255.0 See also SHOW IP.


NO TELNET <IP address>

Deletes the IP/IP mask from list of allowed Telnet addresses.

Example: NO TELNET 10.1.1.255 See also SHOW TELNET.

None All Span types

PLATFORM HEARTBEAT <seconds>

Determines the number of seconds between heartbeat packets being sent from the Controller Card to the ETM Server. A value of 0 indicates packets should not be sent. Valid values are 0 or 3 to 3600 seconds. The default is 60 seconds.

Example: PLATFORM HEARTBEAT 60 See also SHOW SERVER and HEARTBEAT.

COMM RESET

All Card types

POLICY AMBIGUOUS SKIP <value>

Specifies conditions under which rules are skipped when ambiguous calls are processed. Valid values are ALL, INBOUND, and NONE. The default is NONE. Note: "Policy" refers to TeleWall Policy. Example: To skip ambiguous calls, type: POLICY AMBIGUOUS SKIP ALL See also SHOW POLICY STATUS.


All Span types

POLICY CALL ESTABLISH <milliseconds>

Specifies the milliseconds after the last digit until a call is marked as established. Valid values are 0 to 120,000 ms. The default is 20000 ms (20 seconds). Note: "Policy" refers to TeleWall Policy.

Example: POLICY CALL ESTABLISH 20000 See also SHOW POLICY STATUS.


All Span types





Causes the SPP (Security Policy Processor) and the DPP (Dialing Plan Processor) to reread the configuration variables and configuration files related to them (such as the Policy file, Dialing Plan files, terminate on/off).

Example: POLICY CONFIG UPDATE Note: "Policy" refers to TeleWall Policy

None All Span types

POLICY ENFORCE <value>

Enables or disables call termination. Valid values are ON and OFF.

Example: POLICY ENFORCE ON Note: "Policy" refers to TeleWall Policy See also SHOW POLICY STATUS.


All Span types

POLICY RESET

Resets the policy-processing state machine.

Example: POLICY RESET Note: "Policy" refers to TeleWall Policy

None All Span types

POLICY STU <value>

Enable or disable STU-III detection. Valid values are ON and OFF. The default is OFF (no STU detection). See also SHOW POLICY STATUS.

Example: POLICY STU ON Note: "Policy" refers to TeleWall Policy

RESTART All Span types

POLICY TYPE DELAY <milliseconds>

Specifies the milliseconds after a call is established until a silent call is declared Voice. Valid values are 2, 000 to 60,000 ms. The default is 60000 ms (60 seconds).

Example: POLICY TYPE DELAY 60000 Note: "Policy" refers to TeleWall Policy See also SHOW POLICY STATUS.


All Span types

POTS CALL START <milliseconds>

Sets the minimum time in milliseconds of off-hook to signal start of outbound call. The default is 200 ms.

Example: POTS CALL START 200 See also SHOW POTS.


Analog

POTS DEBOUNCE HOOK <milliseconds>

Sets the minimum time in milliseconds to debounce extraneous hook events. The default is 10 ms.

Example: POTS DEBOUNCE HOOK 10 See also SHOW POTS.


Analog




POTS DEBOUNCE RING <milliseconds>

Sets the minimum time in milliseconds to debounce extraneous ring events. The default is 200 ms.

Example: POTS DEBOUNCE RING 200 See also SHOW POTS.


Analog

POTS DIALPULSE <ON | OFF>

Specifies whether dial pulse is used to/from the telephone network. The default is OFF.

Example: POTS DIALPULSE OFF See also SHOW POTS.


Analog

POTS DIGIT <milliseconds>

Sets the minimum time in milliseconds of on-hook to signal pulsed digit. The default is 150 ms.

Example: POTS DIGIT 150


Analog

POTS HANGUP <milliseconds>

Sets the minimum time in milliseconds of on-hook to hang up. The default is 320 ms.

Example: POTS HANGUP 320


Analog

POTS PULSE <milliseconds>

Sets the maximum time in milliseconds of on-hook to signal pulsed digit. The default is 80 ms.

Example: POTS PULSE 80


Analog

POTS RING <milliseconds>

Sets the maximum time in milliseconds of on-hook with no event. The default is 7000 ms (7 seconds).

Example: POTS RING 7000


Analog

POTS TERMINATE <milliseconds>

Sets the number of milliseconds to forcibly hold on-hook when terminating a call. The default is 15000 ms (15 seconds).

Example: POTS TERMINATE 15000


Analog




REBOOT [NOW]

Causes the Compact Flash disk to be flushed/shutdown, then the watch-dog timer resets and reboots the Card. The result is very similar to power cycling the Appliance, except that only the selected Card is affected. REBOOT provides a confirmation, REBOOT NOW reboots immediately. Examples: REBOOT NOW

REBOOT ALL

None All Card types.

RESTART [ALL]

RESTART ALL restarts all of the Spans on the Card; RESTART restarts the current Span. Examples: RESTART

RESTART ALL

None ETM 2100 and 3200 Spans..

RESTART FAILSAFE

Stops all of the Spans on the Card and restarts in Fail Safe Mode.

Example: RESTART FAILSAFE

None All Card types.

RESTART SPAN <span #>

Restarts only the specified Span (1,2, 3, or 4).

Example: RESTART SPAN 1

None ETM 2100 and 3200 Spans.

SECOND DIAL TONE ON|OFF

Determines whether a System Event is to be generated when a second dial tone after answer is detected on an inbound call. The default is ON.

Example: SECOND DIAL TONE OFF


All Spans.

SECURITY HIGH | MEDIUM | LOW

Specifies Card security posture, determining by which means security and network configuration parameters can be modified. Valid values are LOW, MED, or HIGH. (HIGH does not allow the ETM Server to change the security-related configuration items such as the Card's IP address or DES key.)

Example: SECURITY LOW See also SHOW CONFIG.

COMM RESET All Card types.

SERVER IP <IP address>

Specifies the ETM Server IP address in dot notation.

Example: SERVER IP 10.1.1.1 See also SHOW SERVER and SHOW USERS.





SERVER PORT <port #>

Specifies the ETM Server IP port. Valid port numbers are 1 through 65535. The default is 4313.

Example: SERVER PORT 4313 See also SHOW SERVER.


SHOW AAA CONFIG

On Spans, displays AAA Server configuration items; on AAA Card, displays AAA prompt configuration.

Example: SHOW AAA CONFIG

None All Spans and AAA.

SHOW AAA MODEMS

Displays status and configuration settings of the modems in the AAA Server.

Example: SHOW AAA MODEMS

None AAA

SHOW AAA NETWORK

Displays AAA Server network connections.

Example: SHOW AAA NETWORK

None AAA

SHOW CHANNELS

Displays channel-specific values for each channel, including tone type, incoming and outgoing format, and format precedence.

Example: SHOW CHANNELS

None All Span types.

SHOW CONFIG

Determines Span type and executes relevant command showing configuration, including Span #, name, type, channels monitored, Caller ID Map, IP address, netmask, gateway, security level, SMDR settings, and log events.

Example: SHOW CONFIG See also SHOW T1, SHOW E1, SHOW E1 COUNTERS, and SHOW T1 COUNTERS.


SHOW DES

Displays the Card DES secret key and configuration.

Example: SHOW DES


SHOW E1

Displays E1 values, alarms, and statistics.

Example: SHOW E1

None Euro ISDN PRI Spans.




SHOW E1 COUNTERS

Displays E1 line statistics.

Example: SHOW E1 COUNTERS

None Euro ISDN PRI Spans.

SHOW EVENTS <number> <type> <channel> | ALL

Displays the number of events of a certain type for a specific channel or all channels. Valid types are: LIU, AB, PULSE, DSP, MODEM, TYPE, TRANSITION. Example: To display the last 50 AB bit, DSP, and call-type events on channel 2, type SHOW EVENTS 50 AB+DSP+TYPE 2


SHOW EXTENSIONS

Displays the extension map.

Example: SHOW EXTENSIONS


SHOW FLASH

Displays the Card flash directory.

Example: SHOW FLASH


SHOW HELP

Displays a command summary.

Example: SHOW HELP


SHOW HISTORY

Displays recently entered commands.

Example: SHOW HISTORY


SHOW IF

Displays the Card's network interface type.

Example: SHOW IF


SHOW IP

Displays the Card IP address, netmask, and IP gateway.

Example: SHOW IP


SHOW ISDN

Displays ISDN-related configuration items, such as the IP addresses of the associated and dependent NFAS Group member Spans.

Example: SHOW ISDN

None ISDN PRI Spans.




SHOW LICENSE

Displays license information for the selected Card. Span 1 is always licensed to communicate with the ETM Server.

Example: SHOW LICENSE

None 2100-and 3200-Appliances only

SHOW MAC

Displays the Media Access Control (MAC) address of the Card.

Example: SHOW MAC


SHOW MEMORY

Displays Span memory utilization.

Example: SHOW MEMORY


SHOW PANIC

Displays the last fatal error recorded by the Span.

Example: SHOW PANIC


SHOW POLICY FILE

Displays the TeleWall® Policy currently installed on the Span.

Example: SHOW POLICY FILE


SHOW POLICY STATUS

Displays the name of the TeleWall® Policy installed on the Span, the current count of calls, and configuration settings related to TeleWall Policy enforcement and call termination.

Example: SHOW POLICY STATUS


SHOW POTS

Displays parameters for Analog Spans.

Example: SHOW POTS

None Analog

SHOW SERIAL

Displays Console port configuration items, including on which Span the Console port should operate. The default is Span 1.

Example: SHOW SERIAL


SHOW SERVER

Displays the ETM Server IP address, port, and heartbeat interval.

Example: SHOW SERVER


SHOW SIGNALING

Displays the signaling type for each channel on the Span.

Example: SHOW SIGNALING





SHOW SMDR

Displays SMDR settings.

Example: SHOW SMDR


SHOW STATUS

Displays the general status of the Card.

Example: SHOW STATUS


SHOW T1

Displays parameters for the T1 Span, including line errors, relays, signaling, framing, and other T1 configuration items.

Example: SHOW T1

None T1 Spans.

SHOW T1 COUNTERS

Displays T1 line statistics.

Example: SHOW T1 COUNTERS

None T1 Spans.

SHOW TELNET

Displays the status of the Span's Telnet Server, the Telnet count, and the list of IP addresses from which Telnet is authorized.

Example: SHOW TELNET


SHOW TIME

Displays the current Card time and time zone.

Example: SHOW TIME


SHOW TRUNK

For each channel displays trunk channel states, such as call direction and call state.

Example: SHOW TRUNK


SHOW USERNAMES

Displays list of defined usernames.

Example: SHOW USERNAMES


SHOW USERS

Displays a list of active logged-on users.

Example: SHOW USERS


SHOW VERSIONS [ALL]

Specifies the current software versions running on the Card. SHOW VERSIONS ALL provides more detail. Examples: SHOW VERSIONS

SHOW VERSIONS ALL





SIGNALING FORMAT IN <channel> <format>

Specifies the incoming format for MF or DTMF digits, for a specific channel or all channels, received by PBX from the telephone network during ANI, DNIS, and DID transmission. The default format is ADDR. Construct the string using the following predefined tokens: ADD–variable length destination number ADDR–n-digit destination number ANI–variable length ANI ANI-n–n-digit ANI DID–variable length DID DID-n–n-digit DID DNIS–variable length DNIS DNIS-n–n-digit DNIS KP–MF KP digit ST–MF ST digit # –DTMF # digit * –DTMF * digit Examples: To set the incoming signaling format for all channels to DID, type: SIGNALING FORMAT IN ALL DID

To set the incoming signaling format for channel 12 to ADDR-10, type SIGNALING FORMAT IN 12 ADDR-10

See also SHOW CHANNELS.


All Span types.




SIGNALING FORMAT OUT <channel> <format>

Specifies the outgoing format for MF or DTMF digits, for a specific channel or all channels, transmitted by the PBX to the telephone network during destination transmission. The default is ADDR. Construct the signaling format string using the following predefined tokens: ADDR - variable length destination number ADDR-n –n-digit destination number KP - MF KP digit ST - MF ST digit # - DTMF # digit * - DTMF * digit Examples: To set the outgoing signaling format for all channels to DID, type SIGNALING FORMAT OUT ALL DID

To set the outgoing signaling format for channel 12 to ADDR-10, type SIGNALING FORMAT out 12 ADDR-10 See also SHOW CHANNELS.


All Span types.

SIGNALING PRECEDENCE <channel> <format>

Specifies the selection precedence for a specific channel or all channels when similar data values are present in the signaling format string. The default is an empty string. Valid formats are ADDR (default for Analog and T1), DID, and DNIS. For PRI, the default is an empty string. Example: To set the signaling precedence for all channels to DID, type: SIGNALING PRECEDENCE ALL DID See also SHOW CHANNELS.


All Span types.

SIGNALING TYPE <channel> <type>

Specifies the line interface signaling type, for a specific channel or all channels. Valid types are: WINK (T1), IMMEDIATE START (T1), IMMEDIATE DID (Analog), GROUND START (T1, Analog), LOOP START (T1, Analog), PRI (ISDN PRI), WINK IN/IMMEDIATE OUT (T1), IMMEDIATE IN /WINK OUT (T1). Example: To set the signaling TYPE for all channels to WINK, type: SIGNALING TYPE ALL WINK See also SHOW SIGNALING.


All Span types.




SMDR BAUD <baud rate>

Specifies the SMDR serial port baud rate. Valid values are 300, 1200, 2400, 4800, 9600, 19200, 38400, 57600, or 115200. The default is 9600.

Example: SMDR BAUD 57600 See also SHOW SERIAL and SHOW SMDR.

RESTART All Span types except AAA Appliances.

SMDR DATABITS <value>

Specifies the number of data bits in a serial byte. Valid values are 7 or 8. The default is 8.

Example: SMDR DATABITS 8 See also SHOW SERIAL and SHOW SMDR.


SMDR DISPLAY <value>

Turn SMDR debug displayer on or off.

Example: SMDR DISPLAY ON

None All Span types except AAA Appliances.

SMDR PARITY <value>

Specifies whether a parity bit is used and if so, whether parity is odd, even, or mark. Valid values are ODD, EVEN, MARK, and NONE. The default is none.

Example: SMDR PARITY NONE See also SHOW SERIAL and SHOW SMDR.


SMDR QUERY <hex_value>

Mask/map of channels that are to query the ETM Server for SMDR data. Example: To request SMDR for the first 8 channels, type SMDR QUERY 0xff See also SHOW POLICY STATUS, SHOW CONFIG, SHOW SMDR.


All Span types except AAA Appliances.

SMDR QUERY <value>

Mask/map of channels that are to query the ETM Server for SMDR data. Valid values are T1, POTS, and NONE. Example: To request SMDR on all channels on a T1 Span, type: SMDR QUERY T1 See also SHOW POLICY STATUS, SHOW CONFIG, SHOW SMDR.






SMDR READER <value>

Specifies whether the SMDR serial port is read and SMDR data sent to the ETM Server. Valid values are ON and OFF.

Example: SMDR READER ON See also SHOW CONFIG and SHOW SMDR.


SMDR STOPBITS <value>

Specifies the number of stop bits in a serial byte. Valid values are 1 or 2. The default is 1.

Example: SMDR STOPBITS 1 See also SHOW SERIAL and SHOW SMDR.


SMDR TIMEOUT <seconds>

Specifies the maximum number of seconds to wait for SMDR query result from the Server after a call ends. Valid values are 10 to 1200 seconds. The default is 60 seconds.

Example: SMDR TIMEOUT 60 See also SHOW POLICY STATUS, SHOW CONFIG, SHOW SMDR.



SPAN <value>

Set console serial port focus to Span 1, 2, 3, or 4.

Example: SPAN 1

None 2100-and 3200-Appliances

T1 ALERT <milliseconds>

Specifies the maximum number of milliseconds of on-hook with no other event. The default is 7000 ms (7 seconds).

Example: T1 ALERT 7000 See also SHOW T1.


T1 Spans.

T1 CALL START <milliseconds>

Specifies the minimum number of milliseconds off-hook to signal the start of an outbound call. The default is 10 ms. See also SHOW T1.


T1 Spans.

T1 CLOCK <value>

Specifies whether the T1 transmit clock should be derived from the telephone network or the PBX. Valid values are CO and PBX. CO is the default.

Example: T1 CLOCK CO See also SHOW T1.

RESTART T1 Spans.

T1 CONFIG UPDATE

Uses updated line interface configuration.

Example: T1 CONFIG UPDATE

None T1 Spans.




T1 DEBOUNCE A < milliseconds>

Specifies the minimum number of milliseconds to debounce T1 A-bit transitions. The default is 10 ms.

Example: T1 DEBOUNCE A 10 See also SHOW T1.


T1 Spans.

T1 DEBOUNCE B <milliseconds>

Specifies the minimum number of milliseconds to debounce T1 B-bit transitions. The default is 200 ms.

Example: T1 DEBOUNCE B 200 See also SHOW T1.


T1 Spans.

T1 DIGIT <milliseconds>

Specifies the minimum number of milliseconds of on-hook to signal a pulsed digit (inter-digit interval). The default is 150 ms.

Example: T1 DIGIT 150 See also SHOW T1.


T1 Spans.

T1 ERROR THRESHOLD <number>

Sets minimum number of line errors that must occur within a heartbeat interval to trigger the generation of a Telco System Event. The default is 5.

Example: T1 ERROR THRESHOLD 5 See also SHOW T1.

RESTART T1 Spans.

T1 FRAMING SF | ESF | NONE

Sets T1 framing. Valid values are none (not set), SF (Super Frame), or ESF (Extended Super Frame). The default is ESF.

Example: T1 FRAMING ESF

T1 CONFIG UPDATE

T1 Spans.

T1 HANGUP <milliseconds>

Specifies the minimum number of milliseconds on-hook to signal a hang up (inter-digit interval). The default is 225 ms.

Example: T1 HANGUP 225 See also SHOW T1.


T1 Spans.

T1 INLINE

Specifies that the Span will go inline on the next restart. Default is INLINE.

Example: T1 INLINE See also SHOW T1 and SHOW STATUS.

RESTART T1 Spans.




T1 LINE CODING NONE | AMI | B8ZS

Specifies T1 line encoding. Valid values are NONE (not set), AMI, or B8ZS. The default is B8ZS.

Example: T1 LINE CODING B8ZS See also SHOW T1.

T1 CONFIG UPDATE

T1 Spans.

T1 LINE LENGTH CO | PBX <length>

Appliance to telephone network or PBX line length. The default is LH. Valid line length values are: LH (long haul) SH_0_110 (short haul) SH_110_220 SH_220_330 SH_330_440 SH_440_550 SH_550_660 TR62411_LH TR62411_0_110 TR62411_110_220 TR62411_220_330 TR62411_330_440 TR62411_440_550 TR62411_550_660 DB-7.5 - 7.5 db line build out DB-15.0 - 15.0 db line build out DB-22.5 - 22.5 db line build out

Example: T1 LINE LENGTH CO SH See also SHOW T1.

T1 CONFIG UPDATE

T1 Spans.

T1 OFFLINE

T1 OFFLINE closes T1 relays, immediately causing call traffic to bypass the Span.

Example: T1 OFFLINE See also SHOW T1 and SHOW STATUS.

None T1 Spans.

T1 PULSE <milliseconds>

Specifies maximum number of milliseconds of on-hook to signal a pulsed digit. The default is 175 ms.

Example: T1 PULSE 175 See also SHOW T1.

T1 CONFIG UPDATE

T1 Spans.




T1 SPAN CHECK ON | OFF

Turns on and off the hung Span detector. The default is ON. Do not set this value to OFF unless instructed to do so by SecureLogix Customer Support.

Example: T1 SPAN CHECK ON

REBOOT T1 and ISDN PRI Spans

T1 STATS CLEAR

Clears T1 line statistics.

Example: T1 STATS CLEAR

None T1 Spans.

T1 TELCO DELAY

Specifies the number of seconds a trunk must remain in alarm status before a TELCO System Event is triggered. If the trunk goes into alarm, but clears before the specified number of seconds elapses, then the System Event is not generated. If the trunk goes into alarm and stays in alarm long enough for the System Event to be logged, then the ALARM CLEARED message appears in the Diagnostic Log as soon as the alarm clears. The default is 60. See also SHOW T1.

None T1 Spans.

T1 TERMINATE <milliseconds>

Specifies number of milliseconds of forcibly held on-hook to terminate a call. Valid values are 0 to 500. The default is 25.

Example: T1 TERMINATE 25 See also SHOW T1.


T1 Spans.

TELNET ALLOW <IP address>

Specifies the IP addresses/address masks the Card allows as Telnet clients.

Example: TELNET ALLOW 10.1.1.1 See also SHOW TELNET and NO TELNET.


TELNET COUNT <number>

Specifies the maximum number of Telnet connections that can be active at one time. Valid values are 0 to 3. A setting of 0 disables Telnet.

Example: TELNET COUNT 0 See also SHOW TELNET and NO TELNET.





TERMINATE <channel>

Terminates a call on a specific channel or on ALL channels. Examples: To terminate the current call on channel 8, type TERMINATE 8

To terminate all calls on all channels on a Span, type TERMINATE ALL


TIMEOUT <minutes>

Specifies the Console port or Telnet timeout period for inactivity on the connection. Valid values are 1 to 120 minutes.

Example: TIMEOUT 120


TIMEZONE <zone>

Specifies time zone: EST, CST, MST, PST, or GMT. The TeleView™ Console provides more specific time-zone options in a drop-down menu.

Example: TIMEZONE CST See also SHOW TIME.


TONE TYPE <channel> <type>

Specifies tone type, for a specific channel or ALL channels, received by PBX from the telephone network during ANI, DNIS, and DID transmission. Valid tone types are NONE, DTMF, or MF. The default is DTMF. Examples: To set the tone type on all channels to MF, type TONE TYPE ALL MF

To set the tone type on channel 4 to DTMF, type TONE TYPE 4 DTMF See also SHOW CHANNELS.


All Span types.

USERNAME <login_name> <password>

Specifies valid usernames that the Card allows as Telnet and Console port logins. Examples: To authorize a username bart with the password Spr90210, type USERNAME bart Spr90210

To delete the username bart, type NO USERNAME bart See also SHOW USERNAMES.

None All Span types. (Note: This command is not used to specify AAA Service user names.)




WRITE MASK <value>

Specifies which Span software events to record. Values include ALL, NONE, INFO, CHAN, DEBUG, TELCO, STARTUP, WARN, ERROR, PANIC, SECURITY, CALL, POLICY. Default is set to exclude DEBUG, INFO, or CHAN events. Examples: WRITE MASK 0xffff

WRITE MASK ALL

WRITE MASK NONE See also LOGMASK and SHOW CONFIG.

None All Span types

Caution: The following MAINT Commands are low-level maintenance commands and are typically only used when directed by SecureLogix Corporation support personnel. The MAINT commands could impair operation of a Card or Span if used improperly! For details about using low-level maintenance mode, see "Low-Level Maintenance Mode" in the ETM® System Installation Guide.


Appliance/ Span Type

MAINT CONFIG ERASE <key>

Erases the specified key from configuration manager.

Example: MAINT CONFIG ERASE 315

REBOOT All Span types.

MAINT CONFIG ERASE ALL

Completely clears the configuration, including all Card- and Span-level configuration items for all 4 Spans.

Example: MAINT CONFIG ERASE ALL


MAINT DELETE <filename>

Deletes the specified file.

Example: MAINT DELETE FILE.TXT


MAINT DOWNLOAD <package_version>

Downloads the specified Card and DSP software version from the ETM Server to the Card. Example: MAINT DOWNLOAD ETM_3000_4.0.6.PKG

All Span types.



Appliance/ Span Type

MAINT EVENTS MASK <value>

Sets event socket mask. Values include ALL and NONE. Examples: MAINT EVENTS MASK ALL

MAINT EVENTS MASK NONE See also SHOW EVENTS.


MAINT ISDN <value>

Examples: MAINT ISDN ALL

MAINT ISDN NONE Sets ISDN socket mask on (ALL) or off (NONE).


MAINT LOAD FLASH <filename>

Loads the boot flash (non-Boot Mode only).

Example: MAINT LOAD FLASH FILE.TXT


MAINT LOAD PLD <filename>

Programs a programmable logic device (PLD).

Example: MAINT LOAD PLD FILE.TXT


MAINT MORE <filename>

Displays the specified file. The filename is case-sensitive.

Example: MAINT MORE /proc/cpuinfo (Displays information about the CPU on the Card.)


MAINT SPAN TYPE <Span #> <Span type>

Sets the specified Span to the specified type. Example: To set Span 2 to PRI, type MAINT SPAN TYPE 2 PRI

RESTART 2100-and 3200-Appliances.

MAINT TEST LED

Cycles the T1 | E1 LEDs on and off.

Example: MAINT TEST LED


MAINT TEST SMDR <ON | OFF>

MAINT TEST SMDR ON uses loop-back cable to test the SMDR reader.

Example: MAINT TEST SMDR ON


MAINT VERIFY <filename>

Verifies the file contents checksum.

Example: MAINT VERIFY FILE.TXT


Error and Debug Logs • 45

Error and Debug Logs

Error and Debug Logs on the ETM® Server Error and debug logs are stored in the ETM® Server installation directory and include the following:

• Error logs contain records of system and user errors.

• Debug logs are only created if enabled for troubleshooting system performance issues.

• SMDR Debug logs are only created if enabled for troubleshooting SMDR resolution issues.

• Server-fatal logs are created if the ETM Server unexpectedly terminates.

The ETM® Server stores two types of system error logs:

• SystemErroryyyymmdd.data stores information relating to hardware issues (for example, "disk full" or "COM port unavailable") or ETM Server issues (for example, a corrupted message from a Span to the Server).

• Coreyyyymmdd.data is unlikely to ever contain data. This log is designed to store unforeseen errors that could adversely affect ETM System performance. If this file has any data in it, contact Customer Support.

System error logs are stored in the ETM Server installation directory. During continuous ETM Server operation, a new SystemError and Core file are created every day at 12 A.M. If the file contains no error messages, the file size is 0KB. A file size larger than this indicates that the file contains error messages.

Diagnostic logs, which are stored in the ETM® Database and viewable through the TeleView™ Console, are discussed in the TeleView™ Infrastructure Manager User Guide.

Error Logs

For instructions for setting storage limits on error logs, see "Enabling Automatic Purging of Logs" in the TeleView™ Infrastructure Manager User Guide.

46 • Error and Debug Logs

If you accepted the installation defaults, the error logs are stored at the following path:

Windows

C:\Program Files\SecureLogix\ETM\ps\errors Solaris

/opt/SecureLogix/ETM/ps/errors

To view error logs

• Open the log file in a text editor, such as Notepad.

SMDR debug logging stores raw SMDR data. This information can be used by SecureLogix Customer Support for troubleshooting SMDR resolution issues. Only enable SMDR debug logging if instructed to do so by SecureLogix Customer Support personnel, to avoid using hard drive space unnecessarily. The SMDR debug logging setting does not affect how the ETM® System uses SMDR information. See “Enabling SMDR Debug Logging” on page 113 for instructions.

Call/debug event logs can be used by SecureLogix Customer Support for troubleshooting. To avoid unnecessarily consuming hard drive space, only enable call/debug logging if instructed to do so by SecureLogix Customer Support personnel.

To log call/debug events to a file 1. In the TeleView™ tree pane, right-click the Span(s) from which

you want to obtain diagnostic information, then click Edit Span(s). To select multiple Spans, hold down CTRL and select each Span, then right-click the selection. The Span Configuration dialog box appears.

2. Click the Preferences tab.

SMDR Debug Logs

Span Call/Debug Logs

Logging Span Call/Debug Events to a File

Error and Debug Logs • 47

3. In the Logging area, select the Log Debug/Call Events to

File check box. Clear this check box when you no longer need to store this information, to prevent unnecessary use of hard drive space.

The file is named:

<macaddress_spannumber_uniqueid>.dbg and is saved in the ETM System installation directory on the ETM Server computer at the following path:

Windows

C:\Program Files\SecureLogix\ETM\ps\debug Solaris

/opt/SecureLogix/ETM/ps/debug

To view debug logs

• Open the file in a text editor, such as Notepad.

Viewing Debug Logs

48 • Error and Debug Logs

A server-fatal log is created if the ETM® Server unexpectedly terminates. This log provides valuable troubleshooting information to SecureLogix Customer Support personnel. The file is stored in the root ETM System installation directory with the name:

server-fatal-<servername>.log When the ETM Server is restarted, this file is renamed to:

server-fatal-<servername>-hhmmddyyyy-<uniqueid>.log where <uniqueid> is simply an incremental number to guarantee a unique filename.

To view a server-fatal log

• Open the file in a text editor.

server-fatal Logs

System Backup and Recovery • 49

System Backup and Recovery

Backup and Recovery Guidelines This section provides several suggested ETM® System backup methods that simplify recovery of system operation and data in cases of hardware failure, natural disaster, or other catastrophic event, or to retain an archive of data purged by the user-configurable purging function. Each section contains guidance on what is to be backed up and how often, enabling your organization to adopt the procedures that best fit your needs.

It is recommended that all backups be saved to a secondary system or to removable media, such as CD-R/CD-RW, Zip drive, or AIT.

Maintain a consistent backup routine. Performing this function at the same time daily/weekly/monthly helps to ensure the data that you expect to be available at a time of a system error is there.

Follow the same storage and rotation procedures you use for other critical information assets: rotate storage media (especially tapes), perform full backups on a regular basis, maintain secure offsite storage for backups, and so forth.

Instructions are provided for:

• Complete system backup—Recommended to minimize the amount of time and effort required for reinstallation of the operating system, the ETM® Applications, and the database.

• ETM system software installation directory backup.

• Full database backup.

Once data is purged, it cannot be recovered by any means other than by restoring from a backup.

General Guidelines for Backup Maintenance

What to Back Up

50 • System Backup and Recovery

A complete system backup can be accomplished using several methods, including:

• ‘Ghosting’ or mirroring the contents of one drive/partition onto another.

• A hard drive backup utility local to the ETM® Server computer that offloads information onto removable media, if available.

• Using existing network-based backup system, if available.

An ideal time to obtain this image is at the completion of the ETM System installation and setup process, a point where all configuration and connectivity issues have been resolved and the system is ready to go live.

Additional complete system backups may be necessary as new applications are added/updated (e.g. ETM Server upgrade) or as significant changes are made to the operating system (e.g. patches).

Regularly back up your entire ETM® software installation directory (or directories, if you have installed the ETM applications in a distributed configuration). Store these backups in a secure location to ensure that you can restore your system configuration and other files generated during system operation (such as TeleAudit® Report Templates and Elements) in the event of hard drive failure or other catastrophic event.

To restore your ETM® software installation from a backup 1. Install the ETM software as described in "Installing the ETM

Software" in the ETM® System Installation Guide. Be sure the installation directory has the same name as the original and does not contain any files from a previous ETM application installation.

2. Delete the newly installed ps/elements and ps reports subdirectories.

3. Copy and paste the backed-up directory over the new installation directory.

Note that this procedure should only be used in conjunction with a new software installation of the same version in a new directory. If you paste a backup over an existing installation that contains user-modified files, data since the last backup will be lost, and signature file corruption may occur.

Complete System Backup

ETM® Software Installation Directory Backup

Restoring the ETM® Software Installation from a Full Backup


The ETM® Database stores all call data reported by the ETM Communication Appliances and all configuration settings administered through the TeleView™ Console.

It is recommended that the database be regularly backed up. Choosing the method and the frequency of backup depends on the perceived value of the data that can be lost during a disaster event.

For most users, a full database backup should be performed, at a minimum, once every three (3) months. This preserves important Oracle and ETM® database installation and configuration settings and ensures that call data for the previous quarter is retained, phone numbers, contacts, user accounts, and other configuration settings are protected, and diagnostic logs are available for historical analysis on guaranteed uptime requirements and general troubleshooting.

This method of backup is referred to as a “cold backup.” This procedure can be manual or scripted, involving only the copying of specific files to a trusted secondary media source. This form of backup is recommended as the preferred means of recovery from a “catastrophic system event.” Once the Oracle database has been returned to a stable condition, restoration of these files will reinstate all parameters and data collected from a known point in time.

Keep in mind that a cold backup creates a snapshot of the entire ETM database. For this reason, the ETM Server and the Oracle Service must be stopped as part of the process.

Backing Up the Database

Full Database Backup

Creating a full database backup bi-weekly or monthly is especially recommended in locations where the ETM® System is placed in a mission-critical role or where loss of data is not acceptable.


To perform a cold backup 1. Stop the ETM® Server

2. Run the SQL commands listed in step 3 to verify the location of the files that are by default stored in the <ORACLE_BASE>\oradata\<sid> folder. (These commands must be run while the Oracle process is still running.)

3. Stop the appropriate Oracle process: OracleService<dbname> Only the process controlling the tablespaces for the ETM database needs to be halted. The process name reflects the name given to the ETM database (also known as the Oracle SID).

4. Copy the following files to a trusted, secondary media source:

• <ORACLE_BASE>\oradata—All files.

• <ORACLE_BASE>\admin—All folders/files.

• <ORACLE_HOME>\network\admin—The listener.ora and tnsnames.ora files.

• <ORACLE_BASE>\database—All files.

• <ORACLE_BASE>\oradata\<sid>—If the files listed below are stored in this folder, back up the entire folder. If you ran the SQL commands listed below before stopping the Oracle Service and determined that some or all of these critical files are stored elsewhere, back them up from that location. Be sure to backup the following files:

− The control files.

The names of all related control files can be determined by executing the following query within a SQL Plus shell: SELECT NAME FROM V$CONTROLFILE

− The redo logs.

Redo logs include online and archived. Archived logs will available only if archiving is enabled. Determine the names of the applicable redo logs by executing the following query within a SQL Plus shell: SELECT MEMBER FROM V$LOGFILE

Performing a Cold Database Backup


− All data files.

The names of all data files associated with the ETM database tablespaces can be determined by executing the following query within a SQL Plus shell: SELECT FILE_NAME FROM DBA_DATA_FILES

− The initialization parameter file.

This is a single file, its name based upon the ETM database name. For example, if the Oracle SID were ETM, the corresponding initialization parameter file name would be initETM.ora (though not typical, the exact name of the parameter file can vary depending on convention).

5. After all files are successfully copied, restart the ETM Server and the Oracle process.

Restoring from a full database backup (or “cold backup”) is recommended as the preferred means of recovery from a “catastrophic system event.” By this, it is assumed either the database itself has experienced unrecoverable errors or there has been some form of hardware failure on the database computer, such that there is no longer concern for overwriting files during the process of returning the system to a known state. It is important to emphasize that data stored since the time of the backup is lost when this procedure is performed.

Returning the ETM® Database to the state preserved by the backup involves following the procedures for the cold backup in reverse.

To restore from a backup 1. Verify that Oracle has been returned to a stable condition.

2. Verify that the ETM Server process is not running.

3. Verify the Oracle process associated with the ETM Database is not running.

4. Copy ALL files from the backup media back to the database server (be sure to place files in their proper path location).

5. Overwrite any existing files with the backup files.

6. Restart the Oracle process for the ETM Database.

7. Start the ETM Server.

The Oracle SID is the database name used when configuring the twms.properties file and when connecting to the ETM® database through the ETM Database Maintenance Tool.

Restoring from a Cold Backup

Properties/Configuration File Settings • 55

Properties/Configuration File Settings

User-Definable Settings in Properties/Configuration Files Certain properties and configuration files contain user-definable settings that are unavailable from within the TeleView™ Console. These settings are often defined during installation. Instructions for modifying these settings are provided in the procedures below.

IMPORTANT Be careful not to introduce any trailing spaces following a value in these files, because trailing spaces impair parsing and are very difficult to troubleshoot.

If the ETM® Server must dial any extra characters (i.e., an outside-line access code) when sending a page, you must edit the PagerService.properties file to specify the prepend digits. The default setting for leading characters is null. If no characters must be prepended, you do not need to edit this file.

This procedure applies to Windows installations only, since paging is not supported on Solaris.

To specify leading characters for pages 1. In the Server installation directory, locate the file named

PagerService.properties. If you accepted the default location during installation, use the following file path:

C:\Program Files\SecureLogix\ETM\PagerService.properties

2. Open the file in a text editor, such as Notepad.

3. Locate the section of the file that contains the following statements: ##Preface dialed numbers with the following ##characters.

##Preface: String (default is "")

#Preface=

Specifying Leading Characters for Pages

56 • Properties/Configuration File Settings

4. On the last line (#Preface=), delete # and type the string after =.

5. Save the file in the original location.

6. Stop the ETM Management Server, if running, and restart it for the change to take effect.

You can add the following variables to the twms.properties file to affect how reports are run:

• NumberConcurrentReports—Defaults to 5. The number of jobs that the TeleAudit® Server will run at the same time. This includes both scheduled and ad hoc reports.

• NumberConcurrentScheduledReports—Defaults to 5. The number of jobs that the scheduled report tool will run at the same time. This does not affect ad hoc reports.

If you experience memory errors or sluggish performance while generating reports for large amounts of data, it is recommended that you increase the stack size available to the Java Virtual Machine in the ETM® Management Server and/or TeleView™ Console configuration files.

To increase the stack size available to the Java Virtual Machine 1. Stop the application(s) whose configuration file you are modifying

(TeleView application and/or ETM Server).

2. Open the applicable configuration file, located in the ETM software installation directory, in a text editor:

• ETM Management Server

− Solaris—ETMManagementServer.cfg

− Windows—ETMManagementService.cfg

• TeleAudit Report Server

− Solaris—TeleAuditReportServer.cfg

− Windows—TeleAuditReportService.cfg

• TeleView Console—TeleviewConsole.cfg

Settings that Affect Reports

Increasing the Stack Size for the Java Virtual Machine


3. Locate the lines that read:

# Java switches to supply to the Java Virtual

# Machine.

switches=-server -Xmx200M

-OR- switches=-hotspot -Xmx200M

4. Change 200M a higher number, such as 400M , 800M, etc. , depending on system load and available memory.

5. Save the file.

6. Start the application.

The subject and content of Email, Page, SNMP, and Real-Time Alert Policy Track messages are defined by a file named delivery.properties, located in the ETM® Server installation directory. Note that this only applies to Tracks in Policies; it does not affect System Event Tracks, which are hard-coded into the system.

You can modify the subject by editing the delivery.properties file. The subject is defined by the section of the file that reads as follows:

ShortDescription=\ {7} Call of Type {6} From {2} to {3} fired rule {1} of policy {0}: {8} The indexing key at the top of the file indicates the data that can be included in the message. These numbers correspond to the numbers within the curly brackets in the ShortDescription:

# 0) Policy Name

# 1) Rule

# 2) Source Number

# 3) Destination Number

# 4) Start Time

# 5) End Time

# 6) Call Type

# 7) Allow/Terminated

# 8) Comment

# 9) Call Direction

When the email message is generated, the actual values in the call data are inserted in the locations designated by these placeholders.

Changing the Subject Line for TeleWall® Policy Tracks

You can also change the terminology used for the direction, call type, and call disposition by editing the values following the EQUAL SIGNs (=) in the terminology key at the bottom of the file. DO NOT modify the values preceding the EQUAL SIGNs.


To change the subject of TeleWall® Policy messages 1. Open delivery.properties in a text editor. If you accepted the

installation defaults, this file is located at the following path:

Windows

C:\Program Files\SecureLogix\ETM\delivery.properties Solaris

/opt/SecureLogix/ETM/delivery.properties 2. The subject is defined by the section of the file that reads as

follows:

ShortDescription=\ {7} Call of Type {6} From {2} to {3} fired rule {1} of policy {0}: {8}

3. To modify the subject line, delete from the Short Description the components that you do not want to include and/or edit the text between the numbers, then save the file. For example, if you do not want the called and calling phone numbers to appear in the subject, delete the text that is shown underlined and italicized in the example below.

ShortDescription=\ {7} Call of Type {6} From {2} to {3} fired rule {1} of policy {0}: {8}

The ShortDescription then appears as follows:

ShortDescription=\

{7} Call of Type {6} fired rule {1} of policy {0}: {8}

Based on this example, the subject line now appears as follows:

Allowed Call of Type Modem fired rule 8 of Policy MODEM WATCH: Allow and log all outbound modem calls.

4. Restart the ETM Server for the change to take effect.


The ETM® Database stores two sets of call data: active and historical. This enables the ETM Database to function as both a transactional and data warehouse database. The TeleWall® Policy Log retrieves data from the active call table; the TeleAudit® Usage Manager retrieves data from the historical call table. Once data has been copied to the historical table, it is available for reports. Once data has been deleted from the active table, it is no longer viewable in the TeleWall Policy Log. By default, the copy frequency is twice as often as the delete frequency.

This division improves reports performance. The frequency at which data is copied from the active to the historical call table and the frequency at which data that has already been copied to the historical table is deleted from the active table are configurable. Note that data is never deleted from the active table unless it has been copied to the historical table and is older than the specified delete frequency.

IMPORTANT This procedure only applies to new data instances. For information on tuning the transfer frequency on an existing instance, contact SecureLogix Customer Support.

To set the transfer interval 1. Open the file DEFAULTS.spec in a text editor. The file and the

directory in which it is contained are created the first time you open the ETM® Database Maintenance Tool. (If the directory does not exist, create it by opening the ETM Database Maintenance Tool, then close the GUI when it appears.) This file is located at the following path:

Windows

C:\Program Files\SecureLogix\ETM\\ps\maint\sql\ Solaris

/opt/SecureLogix/ETM/\ps\maint\sql\ Locate the entry in this file that reads:

## A default frequency migration value.

properties | ('<INMTAG>', 'InsertActionsFrequency', '21600000')

properties | ('<INMTAG>', 'DeleteActionsFrequency', '43200000')

Tuning the Active-to-Historical Data Transfer Frequency

Changing the Transfer Interval Before Creating a New Data Instance


• The default interval at which data is copied from the active to the historical call table is 21600000 milliseconds (6 hours). This value is specified by the InsertActionsFrequency parameter. Be sure that this value is always smaller than the delete frequency.

• The default interval at which data that has already been copied to the historical table is deleted from the active table is 43200000 milliseconds (12 hours). This value is specified by the DeleteActionsFrequency parameter. Be sure that this value is always greater than the copy frequency.

2. Change the values as desired and save the file.

3. Restart the ETM Database Maintenance Tool for the change to take effect.

The ETM® Server is configured by default to use COM1 for Page Tracks. If COM1 is not the correct port, use the following procedure to specify a different COM port.

To define the ETM® Server modem port 1. In the ETM Server installation directory, locate the file named

twms.properties. If you accepted the default location during installation, use the following file path:

C:\Program Files\SecureLogix\ETM\twms.properties 2. Open twms.properties in a text editor.

3. Locate the line that reads

## The com port on which a modem is ## available to deliver alpha-numeric pages.

ModemPort=COM1

4. Replace 1 with the applicable number.

ETM® Server-to-TeleView™ Console encryption can be resource intensive. This is especially noticeable when Span state is changing frequently (since Span data is sent to the TeleView Console to update the display) and when the Channel Monitor is open (because every call state change must be sent from the Server to the TeleView Console).

You can disable encryption between the ETM Server and all TeleView Consoles with which it communicates. This does not affect encryption between any other ETM Platform components, including Server-to-Card or NFAS communication.

Specifying a Modem Port for Page Tracks

Page Tracks are not supported on Solaris; however, pages can be initiated via email for many pager services.

Disabling ETM® Server-to-TeleView™ Console Encryption


To disable Server-to-TeleView Console encryption 1. On the ETM Server computer, open the twms.properties file in

a text editor. If you accepted the installation defaults, twms.properties is located at the following path in the ETM Server installation directory:

Windows

C:\Program Files\SecureLogix\ETM\twms.properties

Solaris

/opt/SecureLogix/ETM/twms.properties 2. Change the following line

ClientEncryptionEnabled=True

to read

ClientEncryptionEnabled=False

3. Stop the ETM Management Server service or application, if running, and restart for the change to take effect.

A system event titled Extended ETM Application Disconnect Detected is sent to the Diagnostic Log when a Card or Span has been disconnected from the ETM Server in excess of a set threshold. This threshold is set in the twms.properties file.

To modify this threshhold 1. Open twms.properties in a text editor.

2. Locate the line that reads:

## The Interval at which span health is verified. If a span is disconnected from the MS for more than this interval, a diagnostic message will be generated.

SpanConnectivityCheckInterval=300000

3. Change 300000 to the interval you choose.

4. Save the file, then restart the Server for the change to take effect.

Changing the Extended ETM® Application Disconnect Threshhold

Windows-Specific System Settings • 63

Windows-Specific System Settings

Settings that Apply to Windows Systems Only The procedures below explain:

• How to increase the virtual memory to improve ETM® application performance.

• How to set the ETM Services to autostart when the computer is rebooted.

• How to edit the PATH configuration on Windows if the ETM services fail to start.

To increase the amount of available virtual memory on Windows NT or 2000 1. On the Windows task bar, click Start | Settings | Control

Panel. 2. Double-click System.

3. Do one of the following:

• Windows NT 4.0

a. Click the Performance tab.

b. In the Virtual Memory area, click Change.

• Windows 2000

a. Click the Advanced tab.

b. In the Performance Options area, click Virtual Memory, then click Change.

4. In the Drive area, click the local drive letter on which you want to increase the size of the paging file.

Increasing the Virtual Memory on Windows NT/2000

64 • Windows-Specific System Settings

5. Under Paging File Size for Selected Drive, change the Maximum Size [MB] to 600.

6. Click Set, then click OK to commit the change.

7. Restart Windows to effect the change.

By default, the TeleAudit® and ETM® Server services are set to manual operation. If you want them to start automatically when the computer is rebooted, use the Windows Services dialog as described in the following procedure.

To set the services to start automatically 1. From the Start menu, click Settings | Control Panel. 2. Open the Services dialog box:

• Windows NT

a. Double-click the Services icon. The Services dialog box appears.

b. Double-click ETM Management Service. The Service dialog box for the ETM Server opens.

c. Under Startup Type, click Manual and click OK.

• Windows 2000

a. Double-click Administrative Tools | Services.

b. Scroll down to and right-click ETM Management Service.

c. Under Startup Type, click Automatic and click OK.

3. On the Services dialog box click Close.

Setting the TeleAudit® and ETM® Server Services to Autostart

Windows-Specific System Settings • 65

On Windows NT/2000, the ETM® and TeleAudit® Server services may not start if a mapped network drive appears in the system path. The ETM and TeleAudit Server service are set by default to start using the LocalSystem account. This account has most privileges for the local computer, but may not be able to access resources outside of the local computer, such as a network drive. When you start the ETM or TeleAudit Server, the operating system goes through each entry in the PATH until it finds the directory containing jvm.dll. If the operating system encounters a network drive entry in the PATH before it encounters the entry that corresponds to the local drive directory containing the jvm.dll file, the operating system attempts to access the network drive. An error occurs if the local system account cannot access the network and the service aborts.

If the ETM or TeleAudit Server fails to start, verify that the directory containing the file jvm.dll is placed before any network drives in the PATH variable on the local machine. The file jvm.dll is located (by default) in the directory C:\Program Files\JavaSoft\JRE\1.3.1_04\bin\server; however, your installation may vary.

Caution Incorrectly editing the PATH variable can introduce a variety of errors. If necessary, request assistance from your system administrator or SecureLogix Customer Support before editing the PATH variable.

To access the PATH variable 1. On the desktop, right-click My Computer.

2. Click Properties.

3. Click the Environment tab.

4. In the System Variables box, scroll down to and click PATH.

5. The PATH variable appears in the Value box. Edit if necessary as described above.

ETM® or TeleAudit® Server Fails to Start Due to PATH Configuration

66 • Windows-Specific System Settings

Uninstalling, Modifying, or Repairing the ETM® Applications • 67

Uninstalling, Modifying, or Repairing the ETM® Applications

How to Uninstall, Modify, or Repair the ETM® Applications The sections below provide instructions specific to your operating system for uninstalling, modifying, or repairing the ETM® Applications.

On Windows 98/NT/2000 operating systems, you can modify, repair, or remove the ETM® System software suite using the Program Maintenance feature of the InstallShield Wizard.

To repair, modify, or remove applications on Windows

1. Insert the installation CD into the CD-ROM drive.

2. Open My Computer, double-click the CD drive letter, and then double-click Software\Installers\Complete\setup.exe. The initial InstallShield Wizard dialog box appears.

3. Click Next. The Program Maintenance dialog box appears.

4. Select one of the following options:

• Modify—Select this option if you want to add or remove one or more applications from the ETM System software installation. (If you want to remove the entire ETM System software suite, select Remove.)

a. Select Modify, then click Next. The Custom Setup dialog box appears.

b. In the Custom Setup dialog box, select the components you want to remove/add, then click Next.

c. Continue clicking Next until the Ready to Modify dialog box appears, then click Install. The components you selected are added/removed.

Windows

68 • Uninstalling, Modifying, or Repairing the ETM® Applications

• Repair—Select this option if you delete a necessary ETM system file. The Repair option overwrites installation files; user-created files are not overwritten.

a. Select Repair, then click Next until the Ready to Repair the Program dialog box appears.

b. Click Install. The InstallShield Wizard reinstalls the necessary files.

• Remove—When you uninstall the ETM System applications from your computer, no user-created files are changed or removed and the ETM system file structure is not deleted.

a. Select Remove, then click Next.

b. The Remove the Program dialog box appears.

c. Click Remove. The ETM System applications, desktop icons, Start menu items, and services are removed from your computer. The ETM System directory structure, which contains all user-modified files, are saved to a backup directory. If you accepted the defaults at installation, the backup directory is

C:\Program Files\SecureLogix\ETM\Backup

5. When the Installation Complete dialog box appears, click Finish. You are then prompted to reboot your computer.

On Solaris 7 or 8 operating systems, you have the options of viewing which packages are currently installed on the machine and removing the applications from the machine.

To view the ETM® packages that are installed on your computer 1. Log in to the operating system.

2. Open an XTerm window or another command-line shell.

3. Execute the pkginfo command. (It is not necessary to logon as root to use this command.)

pkginfo | grep <string>

where <string> contains the characters in the package name(s) in which you are interested. For example, display all packages containing the string SLC, type

pkginfo | grep SLC

Administering the Applications on Solaris Viewing the Installation Packages

Uninstalling, Modifying, or Repairing the ETM® Applications • 69

When you uninstall the ETM® applications from your computer, no user-created files are changed or removed and the ETM System file structure is not deleted.

To uninstall the ETM® software on Solaris 1. Logon as root.

2. Stop the ETM Management Server and TeleAudit® Report Server.

3. Open an XTerm window or another command-line shell.

4. To begin uninstalling the ETM software, execute

pkgrm <string>

where <string> contains the package name(s) that you want to remove, as follows:

• To remove all ETM packages, execute:

pkgrm SLCETM

• To remove only the TeleView™ application, execute:

pkgrm SLCTVC

• To remove only AAA Services, execute:

pkgrm SLCAAAS

5. At the Do you want to remove this package? prompt, type Y.

Removing the Applications

70 • Uninstalling, Modifying, or Repairing the ETM® Applications

Database Maintenance • 71

Database Maintenance

Using the ETM® Database Maintenance Tool The ETM® Database Maintenance Tool enables you to perform the following tasks:

• Create, delete, import, and export data instances.

• View, repair, clear, create, and delete tables in the database.

By default, the ETM Database Maintenance Tool is installed on the ETM Server computer and on each computer where a remote TeleView™ Console is installed. It can also be independently installed using the Custom installation option in the ETM System InstallShield Wizard. For installation instructions, see "Installing the ETM® Software" in the ETM® System Installation Guide.

To open the ETM® Database Maintenance Tool

• Do one of the following:

Windows NT/2000

– On the Windows task bar, select Start | Programs | SecureLogix | ETM System| Utilities | ETM Database Maintenance Tool.

Solaris 7/8

– Execute the following script, located in the ETM software installation directory on the computer where the ETM Database Maintenance Tool is installed: ETMDBMaintTool

Opening the Database Maintenance Tool

72 • Database Maintenance

The ETM Database Maintenance Tool appears.

To log in to the ETM® Database 1. Open the ETM Database Maintenance Tool. (See "Opening

the Database Maintenance Tool" above.)

2. In the Databases Tree, right-click the database used by this ETM Server and click Connect. The Login dialog box appears.

3. In the Username box, type the username defined for the ETM

Database. This is the username that authorizes the ETM Database Maintenance Tool to connect to the database.

4. In the Password box, type the password associated with the specified username.

5. Click OK.

Logging in to the Database See "Creating a Database" on page 74 for instructions for creating a Database.


The ETM Database Maintenance Tool connects to the database and verifies each of the tables in the database. When verification is complete, an icon appears next to each table, indicating its status:

A green check mark indicates the table is valid.

A Warning icon indicates an error in the table. Contact SecureLogix Customer Support for assistance. See “Attempting to Repair a Table” on page 84 for more information.

Indicates a missing expected table. Unlikely ever to occur except when upgrading to a later version of the ETM System. Contact SecureLogix Customer Support for assistance. See "Creating a Missing Table" on page 85 for more information.

Indicates an unknown table. These are typically temporary tables created during database operation. These do not represent an invalid database state and will not impair system operation. Contact SecureLogix Customer Support before deleting any tables.

Indicates a temporary table created during report generation. These do not represent an invalid database state and will not impair system operation. Contact SecureLogix Customer Support before deleting any tables.


To enable the ETM® Database Maintenance Tool to connect to the ETM Database on the DBMS, you create a corresponding database component that contains the necessary connection information.

To create a new Database 1. Open the ETM Database Maintenance Tool.

2. Click Database | New, or right-click Databases and click

New.

The Edit Database Definition dialog box appears.

Server IP address —The IP address of the computer on which the DBMS is installed.

Port number—The port on which the DBMS accepts connection requests.

Database name—The name of the database you created on your DBMS.

3. Click OK. The database appears in the tree.

Creating a Database

The ETM® Server uses information in its twms.properties file to locate and access the database.


Deleting a Database only deletes the icon that enables the ETM® Database Maintenance Tool to connect to the database. It does not delete the actual database or any tables, instances, or data.

To delete a Database

• In the Databases tree, right-click the Database and click Delete.

To disconnect from a database

• Right-click the applicable database in the Databases tree and click Disconnect.

Each ETM® Server stores its data in a data instance within the ETM database. This enables multiple Servers to store their data in the same database. The data instance a Server uses is specified in the twms.properties file in the Server installation directory.

You can use the ETM Database Maintenance Tool to create, delete, import, and export data instances.

CAUTION It is recommended that you stop the ETM Management Server while performing any of the data instance maintenance steps described in this section.

The procedure below can be used to export data instances. For example, you might use this procedure if you are preparing to perform upgrade procedures on your DBMS or want to move the ETM Database to a different DBMS. See "Importing an Exported Data Instance" on page 79 for instructions for importing previously exported data instances.

To export a data instance 1. Determine where you will save the export file. Depending on the

amount of data in the data instance, exported instances can be very large (400MB or more) so be sure adequate hard drive space is available.

Deleting a Database

Disconnecting from a Database

Working with Data Instances

Exporting a Data Instance


2. Open the ETM Database Maintenance Tool as follows, depending on your operating system:

• On Solaris—Execute the following script, located in the ETM Platform installation directory, by default /opt/SecureLogix/ETM

ETMDatabaseMaintenanceTool

• On Windows—From the Start menu, click Programs | SecureLogix | ETM System Software | Utilities | ETM Database Maintenance Tool.

3. The ETM Database Maintenance Tool appears.

If the Database Maintenance Tool you are using has not yet been used to connect to the database, the database will not appear in the list. See "Creating a Database" on page 74 before continuing with this procedure.

4. Right-click the database that contains the instance you want to export, then click Connect. In the illustration above, the database is represented as 10.1.2.144:1521/ETM_DB.


5. The Login dialog box appears. Type the username and password that the ETM Server uses to connect to the database, then click OK. This information can be viewed in the twms.properties file on the ETM Server computer.

6. The ETM Database Maintenance Tool connects to the database and verifies each of the tables in the database. This may take a few minutes. When verification is complete, a list of all the data instances in the database appears.

7. Right-click the data instance to be exported and click Export Instance.


8. The Select Export Directory dialog box appears.

9. In the File Name box, type a file name for the directory that is to contain the exported data instance, or leave the default. The file name defaults to the following format: instancename_mmddyyyy_hhmmss

10. By default, exported data instances are saved in the ETM Server installation directory. If you accepted the installation defaults, the path is as follows:

On Solaris—/opt/SecureLogix/ETM/ps/maint/exports

On Windows—C:\Program Files\ SecureLogix \ ETM\ ps\maint \exports

11. To select a different directory, next to the Look in box, click the down arrow, then select the applicable directory. Be sure to select a location with adequate available hard drive space.


12. Click Export. The export begins and a progress indicator appears.

The time needed to complete the export is directly related to the amount of data in the data instance. A large data instance may take more than 30 minutes to export and may generate a directory containing over 400MB of data files.

13. When the export is complete, close the ETM Database Maintenance Tool. You now have a single export directory containing all of the call information from the ETM Server that uses that data instance.

For easier handling and storage, it is recommended that you compress the exported directory into a single archive using a compression utility such as WinZip.

You cannot import data into an existing data instance. You must import the data as a new data instance and then set the imported data instance as the default for this ETM® Server.

To import a data instance 1. In the ETM Maintenance Tool, while connected to the

applicable database, click Data Instance | Import Instance. The Select Data to Import dialog box appears, listing previously exported data instances.

2. In the Select exported data instance to import area, click

the instance to import.

Importing an Exported Data Instance See "Setting a Data Instance as the Default" on page 80.

See "Exporting a Data Instance" on page 75.


3. In the New instance name box, type the name to use for the imported instance. An instance name can contain up to 20 letters and/or digits, but no spaces or special characters.

4. Click OK. The data instance is imported into the database and appears under the specified name in the Data Instances tree.

When you set a data instance as the default, the ETM® Database Maintenance Tool modifies the twms.properties file with the information needed to associate the ETM Server with the data instance. The following sections of the file are modified:

########################################

## The instance name

Instance=docs

#########################################

###############################################

## The URL of the database

DatabaseURL=jdbc:oracle:thin:@10.1.1.81:1521:orahumv

################################################

## The user id to log into the database

DatabaseUserid=spurs

################################################

## The passphrase to log into the database

DatabasePassphrase=spurs

################################################

To associate a data instance with an ETM® Server

• If the ETM Database Maintenance Tool is installed on the same computer as the ETM Server, while connected to the ETM Database, simply right-click the correct data instance and select Set as default. If the ETM Database Maintenance Tool and ETM Server are installed on separate computers, you can manually edit the sections of the twms.properties file shown above on the ETM Server computer.

Setting a Data Instance as the Default

You can also manually edit these sections to create the association.


WARNING When you delete a data instance, all of the data corresponding to that instance is permanently removed from the database and cannot be recovered. Contact SecureLogix Customer Support before deleting a data instance.

To delete a data instance

• In the ETM® Database Maintenance Tool, while connected to the applicable database, right-click the data instance and click Delete.

Each ETM® Server uses a separate data instance. This enables data from multiple Servers to be stored in the same database. When you create the data instance for an ETM Server, you also define the initial password for the default admin account for that Server. This is the password that is used to initially log in to a newly installed ETM Server.

To create a data instance for a Server 1. On the main menu, click Data Instance | New Instance. The

ETM Data Instance Edit dialog box appears.

2. In the ETM data instance name box, type a unique identifier

for this data instance.

3. In the Admin password box, type the initial password for the default admin user account on the ETM Server. When you log in to this ETM Server via the TeleView™ Console for the first time, you will use the username admin and the password you specify in this dialog box.

4. In the Confirm password box, type the same password again to confirm it.

5. Click OK. The data instance is created and its name appears under the Data instances node.

Deleting a Data Instance

Creating a New Data Instance

If you are using multiple ETM® Server application instances on the same computer, you must use the <instance_id> of the application instance as the data instance name.


This section explains how to use the ETM® Database Maintenance Tool to view, repair, delete, create, and clear ETM Database tables.

WARNING Improper use of the ETM Database Maintenance Tool can result in impaired operation of your database or lost data. Contact SecureLogix Customer Support before using the ETM Database Maintenance Tool for any of the table maintenance tasks described below other than viewing tables.

To view a table 1. In the ETM® Database Maintenance Tool, while connected to

the applicable database, double-click a table.

Managing Tables

Viewing a Table


2. The Description tab of the Table Properties dialog box shows the following information:

• Columns area:

– Status—the status of each row:

indicates a valid row.

indicates an invalid row.

– Index, Name, and Type—expected values.

– DBIndex, DBName, and DBType—the corresponding values that actually exist in the database.

• The Indices area shows the indices for the table and their status. (Not all tables have indices; if the table has no index, this area will be blank):

– Status—the status of each index:

indicates the index is present.

indicates the index is missing.

– Columns—which column is expected as the index.

– DB Columns—the index in the database (if an index is expected but missing, the word <missing> appears.)

• Primary Key area: – Primary Key—the column expected as the primary key

for the database. Not all databases have a primary key; if the database has no primary key, this area will be blank.

– DB Primary Key—the status ( present or missing ) of the primary key in the database, its value, and its name.


3. The Data tab of the Table Properties dialog box shows the data stored in the table.

WARNING This feature is provided for troubleshooting by SecureLogix Support personnel. Contact SecureLogix Customer Support before attempting to repair any tables.

The ETM® Database Maintenance Tool provides a Repair Table feature that attempts to repair simple errors in a table.

To repair a table

• Right-click the table and click Repair Table. The ETM Database Maintenance Tool makes a backup copy of the affected table and names it <table_name>_tmp, then creates a new table with the correct structure with the original table name. The ETM Database Maintenance Tool then attempts to copy the data from <table_name>_tmp into the new, correct table. If the repair succeeds, <table_name>_tmp is deleted and a green check mark appears next to the table name. If the data cannot be successfully copied to the new table, <table_name>_tmp is not deleted, and the Repair Table operation fails. SecureLogix Customer Support can assist you with additional troubleshooting.

Attempting to Repair a Table


WARNING Clearing a table permanently deletes the data in the table, and may impair or prevent operation of your database. Do not delete any tables unless instructed to do so by SecureLogix Customer Support.

To clear a table

• In the Tables node of the ETM® Database Maintenance Tool, right-click the table and click Clear table.

WARNING Deleting a table removes the table and all of its data from the database, and may impair or prevent operation of your database. Do not delete any tables unless instructed to do so by SecureLogix Customer Support.

CAUTION Stop the ETM® Management Server before deleting a table.

To delete a table

• In the Tables node of the ETM Maintenance Tool, right-click the table and click Delete table.

Tables are unlikely to ever be missing except when upgrading from one version of the ETM® System to another, when new tables may have been implemented.

WARNING Contact SecureLogix Customer Support before using the Create Table feature on a database that contains data.

To create a missing table

• Right-click the table and click Create table.

Clearing a Table

Deleting a Table

Creating a Missing Table

Defining Dialing Plans • 87

Defining Dialing Plans

About Dialing Plans Dialing Plans enable the Span to convert a calling sequence into a fully qualified, normalized phone number and to provide call classification information. A calling sequence is a series of digits comprised of phone number components. Phone number components include prefixes (such as an outside line access code), country code, NNP, NPA (area/city code), extension, and suffix (such as a PIN code).

The Dialing Plan serves the following purposes:

• Specifies the order in which components are expected to occur in a calling sequence, based on the direction of the call.

• Specifies the content and/or length of certain components. For example, if an outside-line access code must be dialed, the digits are specified in the Dialing Plan.

• Adjusts the calling sequence appropriately if one or more components are missing (for example, append the local area code).

• Provides call and phone number classification information. This information is used to classify calls as local, long distance, international, information, toll-free or toll, and so forth.

Incorrectly configured Dialing Plan sections can prevent the ETM® System from correctly recognizing phone numbers for TeleWall® Policy processing and cause wrongly classified calls in reports.

IMPORTANT The Incoming and Outgoing Numbering Formats must be properly specified in the Channel Map tab of the Span Configuration dialog box for normalization to succeed.

88 • Defining Dialing Plans

Each Span uses two Dialing Plans to identify and classify the called and calling phone numbers for each call:

• The World Dialing Plan (WNP) defines global dialing information that rarely needs to be updated. This includes information related primarily to recognizing and classifying long distance, international, toll, and toll-free calls.

• The Local Dialing Plan (LNP) defines dialing information specific to the location where the Appliance is installed. This information must be tailored during installation to suit the local dialing environment and may need to be updated periodically if the dialing environment changes. The LNP provides information that the Span uses to convert the string of digits in a called or calling phone number into the actual, fully qualified phone number.

The Dialing Plan Processor (DPP) in the Span reads in the LNP and WNP when the Span is booted up and when a new Dialing Plan is downloaded from the ETM® Server. Any section type can be used in either the WNP or the LNP; both Dialing Plans are read into memory at the same time and used concurrently in processing. In the default Dialing Plans, however, sections that are unlikely to change are placed in the WNP, while those that are likely to require tailoring for the Appliance locale are placed in the LNP.

Default Dialing Plans are provided that enable call monitoring. These plans contain sections that you can modify to suit your telecommunications network. The following default LNP and WNP plans are provided:

• CA_Default—Applies to Canada.

• DSN_Default—Applies to the Defense Switched Network (used by the U.S.A. Armed Forces) Numbering Plan.

• NANP_Default—Applies to the United States.

• UK_Default—Applies to countries in the United Kingdom Numbering Plan.

• ZA_Default—Applies to countries in the South African Numbering Plan.

• IT_Default—Applies to Italy.

Types of Dialing Plans

Default Dialing Plans


IMPORTANT Reliable TeleWall® Security Policy processing and enforcement does not occur until after the correct Dialing Plans are defined and installed on the Span. Each Span uses a Local Numbering Plan (LNP) specific to the Appliance locale and a World Numbering Plan (WNP) specific to the country where the Appliance is located.

Spans have default Local and World Dialing Plans installed that enable the ETM® System to process calls. However, various call classification sections should be customized for the specific Appliance locale to ensure proper call classification (for example, local vs. long distance).

Follow the instructions below to install Dialing Plans on each Span.

See "Defining Dialing Plan Sections" on page 102 for a detailed description of each type of Dialing Plan Section. Each section in the Default Dialing Plans is preceded with an explanatory comments section to aid you in customizing those sections.

To define a Dialing Plan 1. Open the default .LNP file or .WNP file appropriate for your

country in a text editor, such as Notepad. Default Dialing Plan files are located in the ETM® Server installation directory. If you accepted the installation defaults, use the following path:

Solaris

<INSTALL_DIR>/ps/software_repository/ini/ Windows

<INSTALL_DIR>\ps\software_repository\ini\ Define the appropriate sections according to your Appliance locale. See "Defining Dialing Plan Sections" on page 102 for a detailed explanation of the components of each Dialing Plan file and instructions for modifying each section.

2. Save the file under any identifiable name in the same directory, with an .LNP file or .WNP extension. This extension must be capitalized.

IMPORTANT The updated Dialing Plan is not used for call processing until it is installed on the Span.

3. Install the Dialing Plan on the Span(s). See "Installing Dialing Plans on a Span" on page 90 for instructions.

Defining and Installing Dialing Plans

Defining Dialing Plans


To install the Dialing Plans on one or more Spans 1. In the TeleView™ tree pane, do one of the following:

• Right-click a Span and click Manage Dial Plan.

• Hold down CTRL, click each Span on which you want to install the same Dialing Plan(s), then right-click the selection and click Manage Dial Plan.

The Dial Plan Configuration dialog box appears.

2. Under the World INI box, click Modify. The Software Version

Selection dialog box appears. Only .WNP files stored in the software_repository\ini directory in the ETM® Server installation directory appear.

3. Click the .WNP file that represents the numbering plan for long

distance phone numbers for this Appliance, then click OK.

4. Under the Local INI box, click Modify. The Software Version Selection dialog box appears. Only .LNP files stored in the software_repository\ini directory in the ETM Server installation directory appear.

Installing Dialing Plans on a Span

Important If a Dialing Plan is modified on the Server, it must be reinstalled on the Span(s) before the changes take effect.


5. Click the .LNP file that represents the numbering plan for local phone numbers for this Appliance, then click OK.

6. In the Dial Plan Configuration dialog box, be sure that install is selected under each box, then click OK.

The Dialing Plan(s) is/are downloaded to the Span(s) and used immediately for call processing.

Dialing Plans consist of a set of sections that represent possible phone number components. Each section consists of a section header and section body. The default Dialing Plans included with your ETM® System contain default sections that represent common situations. Each of these default sections is preceded by a comments area that describes the section. A default Dialing Plan section is shown below.

Dialing Plan Contents

Explanatory Comments

Section Header

Section Body


The Section Header is enclosed in square brackets on the line above the section body. The fields in the section header are case-sensitive and separated by colons. A section header uses the following general format:

[cc:Type:Name:Label:Option] Note that only Type is required, and the Option field does not apply to all types. Header fields are case-sensitive. Each Section Header component is explained in detail in "Dialing Plan Section Header Components" on page 93.

The Section Body provides the values against which the calling sequence is compared. The type of values depend on the section type. "Defining Dialing Plan Sections" on page 102 explains the contents of the Section Body for each Section Type.

The Section Body can contain any of the following:

• Phone Number characters (the digits 0-9, *, #)

• Wildcard characters—N or X (not case sensitive). N or n matches any one of the phone number digits 0-9; X or x matches any one of the phone number characters. For example, 10NNNN matches any number from 100000 to 109999. Wildcards cannot be used in ranges, or in the CC, NPA, or NNP sections, or in DDD sections that use a PRI TON option.

• Range indicator (..). For example, 210..212 represents the numbers 210, 211, and 212. Ranges must be in ascending order.

• A phone number component enclosed in curly brackets ({ }), for some sections. For example, 210 {402, 522} specifies the exchanges 402 and 522 in the 210 area code.

Section Header

Section Body


Dialing Plan Section Header Components Each of the possible components of the section header are described in detail below.

(Optional) The cc field specifies the country code to which the section applies. If cc is not defined, it defaults to the Span’s local country code.

(Optional) The Name field is a user-definable identifier used to identify the section in error or warning messages in the Diagnostic Log. Some sections have default names. If no name is defined for a section, the Diagnostic Log refers to it as “unnamed section.”

(Optional) The Label field provides call and phone number classification information that is useful in reports. Labels can include any character except single or double quote marks (‘ or “), up to 10 characters per label. Multiple labels can be used per header, up to 40 characters for all labels in the header. Some sections provide default explicit labels; others have implicit labels that are applied if you do not specify a label in the header—when this is the case, it is noted in the comments preceding the section.

Two types of labels are available, described in detail in the following sections:

• Call labels classify the call as a whole.

• Phone number labels classify a called or calling number.

cc

Name

Label


Call labels classify the call as a whole. Enclose call labels in double quotes (i.e., “LOC”). Call labels appear in the Call Details field of the call log.

- On inbound calls, the call label applied is based on the Source #. If Source is unavailable, UNK appears in the Call Details field.

- On outbound calls, the call label is based on the Destination #. If Destination is unavailable, UNK appears in the Call Details field.

- If no call label is explicitly defined for a call by the matched section(s), the call is labeled “LD” if the NPA of either the inbound source or outbound destination differs from the Span’s local NPA; otherwise, it is labeled “LOC.”

- Call labels for DSN calls are preceded by DSN.

The table below lists the default Call Labels and describes their meanings.

Call Labels Meaning DSN DSN #

LOC Local call

LD Long distance call

FREE Toll-free numbers (e.g., 1-800 numbers in the U.S.)

INTL International call

UNK Unknown relationship between Source and Destination number. Usually caused when inbound source or outbound destination number is unavailable (NOPN appears in the applicable PN label field).

Phone number labels classify a called or calling number. Enclose phone number labels in single quotes (i.e., ‘INFO’). The Phone Number Label for the calling number appears in the Source Details field of the call log. The Phone Number Label for the called number appears in the Destination Details field of the call log.

Call Labels

Phone Number Labels


The tables below list the default Phone Number Labels and describes their meanings.

PN Labels Meaning CLI (UK only) The phone number is prefixed with a code to

suppress calling line identification (CLI).

MAP The phone number was obtained from the Extension column of the Channel Map tab on the Span Configuration dialog box.

SMDR The phone number was obtained from SMDR data.

DID The phone number was provided by Direct Inward Dialing service.

METRO The phone number is a local number in a foreign numbering plan area (FNPA).

NONEMRG The phone number is a non-emergency assistance number (e.g., 311 in the USA).

INFO The phone number is an Information number (i.e., 411 or 555-1212 in the USA).

TOLL The phone number represents a toll call (e.g., a 1-900 call in the USA).

800 The phone number represents a toll-free call (such as a 1-800 call in the USA).

OPER The phone number was dialed with operator assistance.

TOLLX The phone number is a toll exchange number.

EMRG The phone number is an Emergency number (i.e., 911 in the USA).

SERV The phone number is a Service number.

PN The phone number is a normal phone number

NOPN The phone number is unavailable (for example, a user blocked CPN).

VSC The phone number is prefixed with a vertical service code (*70, etc.).

101x The phone number is a 101x carrier service number (such as 1010220+).


If the DSN Dialing Plan is used, any of the following access or route codes may be added to the PN label field:

DSN Access Codes Meaning FO Force Override

I Immediate

F Force

R Routine

P Priority

LTN Local Telephone Network

DSN Route Codes Meaning VDAT Voice Data

DGD Data Grade

HOTV Hot Voice

HOTD Hot Data

FTS FTS line type

DDD DDD line type

You can also create compound labels by enclosing multiple call and/or phone number labels in parenthesis and separating each label with the logical operator symbols && (meaning AND) or || (meaning OR):

• && means calls matching the section receive both labels. For example, you might use the label (“INTL”&&’OPER’) to denote international, operator assisted calls.

• || means calls that match the section receive the first label; calls that do not match receive the second label. For example, you might use the label (“LD”||”LOC”) so that calls that match the section are labeled LD (long distance); those that do not are labeled LOC (local).

(Optional) Options are parameters that affect how the information in the section is processed. For example, the option /fCC can be used in Prefix and DDD sections to indicate that when a given calling sequence matches the section, the next component will be the country code.

Some sections have implicit default options. For example, the DID Section Type defaults to the /id (inbound destination) Call Direction option. Applicable options depend on the section type; not all types have options.

Options


The table below lists and describes valid options and the section type(s) to which each applies.

Option Type Purpose Option Effect /id Section applies only to inbound

destination phone numbers.

/is Section applies only to inbound source phone numbers phone numbers.

/od Section applies only to outbound destination phone numbers.

/os Section applies only to outbound source phone numbers.

Call Direction (Applicable to all section types except Default and DID.)

Indicates the call direction(s) to which the section applies.

/io Section applies to both source and destination for both outbound and inbound calls.

/fCC Country code follows this component.

/fNPA NPA follows this component.

/fNUM Number follows this component.

Follow (Applicable to Prefix and DDD sections types. /fNUM and /fSUFX also apply to the NPA section type.)

Indicates the next phone number component expected in a calling sequence that matches the section. If no Follow Option is specified for a Prefix or DDD section, /fNPA is the default; for an NPA section, /fNUM is the default.

/fSUFX Suffix follows this component.

/Acall Add Call label at end of Call label list.

/Apn Add PN label to end of PN label list.

/AFcall Add Call label at start of Call label list.

/AFpn Add PN label at start of PN label list.

/Ocall Overwrite the last Call label of the Call label list.

/Opn Overwrite the last PN label of the PN label list.

/OFcall Overwrite the first Call label in the Call label list.

Label (Applicable to all section types except Default.)

Indicates how labels in the section header are to be added to the Call and/or PN Label list. If no label option is specified, the label is added to the end of the respective list.

/OFpn Overwrite the first PN label in the PN label list.


(Section Header Options table continued from previous page.)

Option Type Purpose Option Effect /Npa Only the NPA field is compared.

/Num Only the Number field is compared.

Match (Applicable to the Classify and Special section types.)

Specifies the phone number components to be compared with the section data. If no Match Option is specified, the Special section default is /Npa; the Classify section, default is /Npa followed by an optional partial Number match.

/NN The NPA and Number fields are compared.

/Next Proceed to next Classify section, even if a match has occurred.

Next (Applicable to the Classify section type only.)

Indicates whether the next Classify section should be examined after a call matches a Classify section. By default, classification stops when a match occurs.

/NMNext Proceed to the next Classify section only if the call does not match the current section.

/pcco For non-PRI calls, indicates the section is to be evaluated if a DDD component was identified in the calling sequence. For PRI calls that receive a TON value, indicates the first entry in the section body represents the PRI Presubscriber Common Carrier Operator code.

/PCCO Defines the PRI Presubscriber Common Carrier Operator, used if the DDD component is not in the dialed digits.

/pi Entries are matched against the dialed digits if the DDD component is dialed. The first number specified in the list represents the PRI international code, used if the DDD component is not in the dialed digits.

/PI Defines the PRI international code, used if the DDD component is not in the dialed digits.

PRI TON (Applicable to Prefix and DDD section types.)

Uppercase Options—Used to interpret PRI TON by Spans that receive the specified TON value. Lowercase Options—Used by PRI calls that receive a TON value, or other call types in which the DDD value is dialed. If no PRI TON Option is defined and the Span does not receive the component in the call data, that component will not be present in the phone number compared against the Security Policy.

/pio Entries are matched against the dialed digits if the DDD component is dialed. The first number specified in the list represents the PRI international operator code, used if the DDD component is not in the dialed digits.



Option Type

Purpose Option Effect

(PRI TON options, continued)

/PIO Defines the PRI international operator code, used if the DDD component is not in the dialed digits.

/pn Entries are matched against the dialed digits if the DDD component is dialed. The first number specified in the list represents the PRI national code, used if the DDD component is not in the dialed digits.

/PN Defines the PRI national code, used if the DDD component is not in the dialed digits.

/po Entries are matched against the dialed digits if the DDD component is dialed. The first number specified in the list represents the PRI operator code, used if the DDD component is not in the dialed digits.

/PO Defines the PRI operator code, used if the DDD component is not in the dialed digits.



Option Type Purpose Option Effect Required Component (Applicable for Prefix and NNP section types.)

Prefix section type—Indicates that the prefix must occur first in the calling sequence. If multiple Prefix sections use the /r Option, the prefixes in the dialing sequence must occur in the same order as the prefix sections in the LNP file. If a Prefix section is defined and does not use the /r option, the prefix is treated as optional. NNP section type—Indicates that the NNP must occur in the calling sequence. Otherwise, the call is assumed a local number.

/r One of the listed prefix numbers is required on an outbound call.

Search (Applicable for the Classify section type only.)

Indicates that a calling sequence that has the pattern of a local number (for example, a 7-digit number in the United States) may actually be a number in a foreign NPA (FNPA).

/s For areas where FNPA long distance numbers can be dialed without dialing the area code, a Classify section using the /s option is used to identify which area code is associated with the specific exchange or partial phone number. The /s causes the section to be searched for the matching area code.

/NPA Defines the number of digits in an NPA.

Size (Applicable to NPA section type only.)

Specifies how many digits are in an NPA and/or a phone number. If an NPA size is not specified, the number of digits in the listed NPA is assumed; if a phone number size is not specified (and no Default section defines it), a phone number is assumed 7 digits.

/NUM Defines the number of digits in the subsequent phone number.



Option Type Purpose Option Effect /SMDR Used in conjunction with the PRI

TON Options. If a DDD component is matched or inserted by the PRI TON Option, the SMDR Option causes that value to be prepended to the raw destination string. The Management Server uses the raw destination string to reconcile SMDR data with calls.

SMDR

Used for SMDR processing.

/NOSMDR Causes a prefix digit to be removed from the raw destination. The Management Server uses the raw destination string to reconcile SMDR data with calls.

/v The specified number is a valid phone number alone, but may be followed by additional digits.

Valid PN Used to indicate that the entries of a Prefix, DDD, NPA, or Special section can be accepted as valid phone numbers. /V The specified number is a valid phone

number, but may be followed by additional digits, which are collected as suffix digits.

(Required) The section type in the section header indicates what kind of information the section contains. Any section type can be used in either the WNP or the LNP; both Dialing Plans are read into memory at the same time and used concurrently in processing. In the default Dialing Plans, however, sections that are unlikely to change are placed in the WNP, while those that are likely to require tailoring for the Appliance locale are placed in the LNP. Note that types are case-sensitive. A detailed discussion of each type of section is provided in "Defining Dialing Plan Sections" on page 102.

Type


Defining Dialing Plan Sections Each of the possible types of Dialing Plan sections are described below, including when to use them, where they are located by default, and how to define them. Certain types of sections are required in all Dialing Plans, while others depend on the dialing environment. Default sections of each type are included in the default LNP and WNP files. Optional sections are commented out, while those that are required are not. These default sections can be used as templates for customizing the Dialing Plan. Refer to "Dialing Plan Section Header Components" on page 93 for a complete description of possible section header components.

Use the procedures below as a reference when customizing the Dialing Plans.

(Predefined) The default WNP contains a CC section that is used to recognize and confirm the country code component of a dialing sequence. The CC section body consists of a comma-separated list of all possible country codes (no wildcards allowed). The CC section is unlikely to require modification.

Use a Classify section to classify calls (for example, as local, long distance, or toll-free) for audit reporting. The difference between "Special" and "Classify" is that a Special number is matched while the number is being received or as the digits are dialed. Classify sections are processed after the number has been completely dialed/received and parsed.

A Classify section body consists of one of the following:

• A comma-separated list of applicable NPAs. Each NPA can optionally be followed with a list of applicable exchanges or initial portions of the phone numbers, enclosed in curly brackets.

• A comma-separated list of local numbers. In this case, use a /Num Option in the section header.

• A comma-separated list of NPAs and local numbers. In this case, use an /NN Option in the section header.

Unless other options are explicitly specified, the following implicit options apply to Classify sections:

• Match—/NPA (only the NPA component is compared, which is the first 3 digits after any Prefix and DDD digits.)

• Call Direction—/od (outbound destination).

CC

Classify


Classify sections that are unlikely to change (such as toll-free designations) should be placed in the WNP. Those more subject to change (such as Metro exchanges) should be placed in the LNP.

The default Dialing Plans contain several Classify sections for common situations that you may need to customize to suit the Appliance locale.

Use one or more DDD (Direct Distance Dialing) sections to identify DDD codes, such as long distance and international dialing access codes, used for outbound calls in the dialing environment. A DDD section consists of a comma-separated list of DDD codes. Wildcards are allowed unless a PRI TON option is used. Since DDD codes are specific to the Appliance locale and may be subject to change, place them in the LNP.

The following implicit option applies to DDD sections:

Call Direction— /od (outbound destination) or /is (inbound source).

(Optional) You can define a Default section to identify default values for labels and phone number component lengths. The values in Default sections are used when a section does not explicitly state a value. If no defaults are specified, the implicit default values are used. A Default section can be defined in either the LNP or the WNP.

Default Section Headers do not use Options.

A Default section consists of one or more entries, each on a separate line, of the form: <item_name>=”value”; Defaults can be set for the following items:

DP_Name—The Dialing Plan name shown in logs.

DP_Flag—Label to be added to all CALL flags (for example, "DSN" when the DSN Dialing Plan is used.)

HNPA_Flag—Label used for PNs with local NPAs ("LOC")

FNPA_Flag—Label used for PNs with foreign NPAs ("LD")

NPA_Length—Default length of NPA for the CC.

NUM_Length—Default length of local number for the CC.

PN_Min_Valid_Length—Minimum Number length.

PN_Max_Valid_Length—Maximum Number length.

NPA_Intl_Length—Default NPA length for INTL PNs.

NUM_Intl_Length—Default Number length for INTL PNs.

DDD

Default


Define one or more DID (Direct Inward Dialing) sections if inbound destination DID extensions are present in the dialing environment. DID sections are used to construct a complete line number from inbound destination DID extensions, for use in TeleWall® Policy enforcement. DID sections should be defined in the LNP.

Multiple definitions can be included in one section. If a section contains entries of both types of algorithms, they are processed in the order in which they appear in the section. If multiple DID sections are defined, they are processed in the order they appear in the Dialing Plan files (beginning with the WNP). Two DID algorithms are provided:

• Use Algorithm 1 when all of the DID extensions are the same length. The algorithm uses the format 1, m, r 1 indicates the algorithm number.

m represents the digits to be matched and replaced from the beginning of the extension. If you want to add digits to the DID extension instead of replacing digits, leave the m section empty. In this case, the digits you type for r are added to the front of the DID number without replacing any digits. Wildcard characters can be used in the m value.

r represents the digits you want to add to the DID extension, either to replace the digits specified in the m section, or in front of the DID extension if you left the m field empty.

For example, suppose a typical DID extension in your organization is 22345. To turn this extension into 555-1345, you would type the following:

1,22,5551

For a more complicated case, suppose you have the following DID ranges associated with the following exchanges:

Exchange 555: DID Range 2000–2099

Exchange 756: DID Range 5800–5999

You would use the following algorithm to convert the DIDs into local numbers:

1,20,55520

1,58,75658

1,59,75659

DID

DID sections are for Inbound Destination numbers only. In cases where DID-type partial numbers are received for other than Inbound Destination, use an Expand section definition instead.


• Use Algorithm 2 when DIDs of varying lengths are present and you want to prescribe different actions based on the length of the DID. Algorithm 2 uses the following format:

2, l, m, r 2 indicates the algorithm number.

l represents the length of the DID extension to be matched.

m represents the digits to be matched and replaced from the beginning of the extension. If you want to add digits to the DID extension instead of replacing digits, leave the m section empty. In this case, the digits you type for r are added to the front of the DID number without replacing any digits. Wildcard characters can be used in the m value.

r represents the digits you want to add to the DID extension, either to replace the digits specified in the m section, or in front of the DID extension if you left the m field empty.

For example, suppose you are in the U.S. and you have some 4-digit extensions and some 3-digit extensions. The 4-digit extensions take exchange 555, and the 3-digit extensions take exchange 399. For the 3-digit extensions, you also need to add an extra digit (in this case, you want to use 1) following the exchange to result in a 7-digit local number. You would use the following algorithm:

2,4,,555

2,3,,3991

Define an Expand section if partial, DID-type extensions other than inbound destination are present in the dialing environment. An Expand section is used to expand these partial, non-DID extensions into fully qualified phone numbers. IMPORTANT Do not use for inbound destination partial extensions; use a DID section instead.

Multiple definitions can be included in one section. If a section contains entries of both types of algorithms, they are processed in the order in which they appear in the section. If multiple Expand sections are defined, they are processed in the order they appear in the Dialing Plan files (starting from the WNP).

Expand


Two Expand algorithms are provided:

• Use Algorithm 1 when all of the calling sequences to be expanded are the same length. The algorithm uses the format 1, m, r 1 indicates the algorithm number.

m represents the digits to be matched and replaced from the beginning of the calling sequence. If you want to add digits to the calling sequence instead of replacing digits, leave the m section empty. In this case, the digits you type for r are added to the front of the calling sequence without replacing any digits. Wildcard characters can be used in the m value.

r represents the digits you want to add to the calling sequence, either to replace the digits specified in the m section, or in front of the calling sequence if you left the m field empty. See the Algorithm 1 example in the DID section on page 104.

• Use Algorithm 2 when calling sequences to be expanded are of varying lengths and you want to prescribe different actions based on the length of the calling sequence. Algorithm 2 uses the following format:

2, l, m, r 2 indicates the algorithm number.

l represents the length of the calling sequence to be matched.

m represents the digits to be matched and replaced from the beginning of the calling sequence. If you want to add digits to the calling sequence instead of replacing digits, leave the m section empty. In this case, the digits you type for r are added to the front of the calling sequence without replacing any digits. Wildcard characters can be used in the m value.

r represents the digits you want to add to the calling sequence, either to replace the digits specified in the m section, or in front of the calling sequence if you left the m field empty. See the Algorithm 2 example in the DID section on page 104.

Define an NNP (National NPA Prefix) section if a prefix is always dialed before the NPA when placing a long-distance, non-international call (for example, 0 in the UK).

NNP


(Required) The default WNP contains an NPA (numbering plan area) section used to identify and confirm the NPA phone number component (region/city/area codes) in a calling sequence. The NPA section consists of a comma-separated list of all possible NPAs for a given country or numbering plan area. The NPA section is placed by default in the WNP, since it is unlikely to change often. Update when new area codes are added to the dialing plan area.

Define a Prefix section to identify digits that may occur as the initial digits in a calling sequence (such as an outside line access code, operator-assistance code, etc.). The section body consists of a comma-separated list of digit strings or ranges.

Define a Suffix section to identify digits or other characters (such as #) that may occur following the extension in a calling sequence to mark the end of the phone number. After prefixes and DDD sections have been examined, any digits following a member of the Suffix section are treated a suffix digits.

The Suffix section body consists of a comma-separated list of single characters. Only single-character Suffix indicators can be specified. For multiple-digit suffix indicators, only the first digit is recognized.

Define a Special section to identify initial digits in a calling sequence that indicate the phone number is not to be normalized, but used as received (for example, emergency access codes such as 911 and service codes such as 1411 for information). The difference between "Special" and "Classify" is that a Special section is matched while the number is being received or as the digits are dialed, while Classify sections are processed after the number has been completely dialed/received and parsed. For example, the dialed sequence 9117654 will be classified as an Emergency number by the time the third digit is dialed, since "911" is defined as a Special number in the Dialing Plan.

NPA

Prefix

Suffix

Special


Dialing Plan Processing When the Span determines the end of the dialed digits during a call, the Dialing Plan Processor (DPP) in the Span processes the call against its Dialing Plans. The DPP processes each call in two phases:

1. Phone number identification, during which the called and calling call sequence are evaluated to identify the complete phone numbers to be used for TeleWall Policy processing and TeleAudit® reporting.

2. Phone number/call classification, during which the call is compared to any defined classification sections to determine if any additional call or phone number labels apply to the call. Classify sections are evaluated in the order in which they appear, beginning with the WNP, followed by the LNP.

During the phone number identification phase, the calling sequence is evaluated to determine the phone number and create a normalized phone number. The Dialing Plan contains various types of sections that represent possible phone number components. Calls are compared with these sections in a specific order, as described below.

Dialing Plans can contain more than one section of a given type; when more than one section of a given type occurs, calls are evaluated against that type of section in the order in which the sections appear in the file.

1. First, special cases are considered:

• If the calling sequence is a fully qualified, normalized phone number for the locale, processing continues with Phase 2: Classification. For example, in the United States, a normalized phone number is one of the form [CC] (NPA) <exchange>-<extension>.

• If the calling sequence is marked as an inbound Direct Inward Dialing (DID) extension, the DPP compares the number with any DID sections that are defined in the LNP to see if it matches those criteria. If so, the number is expanded, and then processing continues as described in 2 below. Whether a calling phone number is marked as a DID is determined by the Incoming Numbering Format and Format Precedence settings on the Channel Map tab of the Span Configuration dialog box.

• Special sections are compared against the dialed digits as they are being received/dialed.

Phone Number Identification


2. The calling sequence is processed against the Dialing Plan sections in the following order:

a. Prefix sections—Prefix sections specify how the beginning digits of the calling sequence are to be treated. A Dialing Plan can contain multiple Prefix sections, and more than one Prefix section may apply to a given calling sequence. Prefix sections may apply only to outbound, only to inbound, or to both call directions. Prefix sections can also be marked as required according to call direction; for example, a Prefix section can specify that all outbound calls contain a line access code prefix, such as 9. If they are not marked as required, then Prefix sections indicate digits that may appear at the beginning of the calling sequence. If a calling sequence of the applicable call direction does not match a required Prefix section, processing continues normally, but a warning message is sent to the Span debug log.

The calling sequence is matched against Prefix sections in the following order:

i. Required Prefix, such as an outside line access code.

ii. Optional Prefix, such as a number used to access a specific long distance provider (i.e., 101xxxx).

b. DDD (Direct Distance Dialing) sections, such as long distance, international, and operator assisted dialing access codes (for example, +1, +0, and +011 in the U.S.).

c. If a previously matched DDD section had the /fCC option, the CC(country code ) section is evaluated, to determine whether the dialed digits contain a CC. If no CC is present, the Appliance's local CC is used in the normalized number.

d. NNP (National NPA Prefix) section—In some countries, a required prefix is dialed before the NNP when placing a long distance, non-international call.

e. NPA (Numbering Plan Area) section—The region/city/area code. The DPP attempts to match the next n digits in the calling sequence with the NPA section in the .WNP. The NPA section header can define how many digits an NPA is to contain, and how many digits following the NPA the extension should contain (ranges can be used). If an NPA section does not specify lengths, the default values are used. If no NPA match is found and the calling sequence is the least as long as the specified length for a local number (as defined in the NPA section header, a default section, etc.), the number is assumed to be local to the Appliance location and the local NPA is used in the normalized number.

If no CC/NPA/NUM lengths are defined, these values default to NANP values.


f. Expand—If none of the previous sections produced a match and the calling sequence is not the right size for a local number, any Expand sections are evaluated. If a match is made, the calling sequence is expanded as defined, and then the expanded number is again processed by the DPP to create a normalized number.

g. If no match has been found, the calling sequence is invalid and is labeled NOPN in Source or Destination Details (depending on direction) column of the call log.

After the phone number processing phase is complete and the called and calling phone numbers have been identified, Dialing Plan processing continues with the phone number/call classification phase.

During the phone number/call classification phase, Classify sections are evaluated in the order in which they appear, beginning with the WNP, followed by the LNP. Unless a Classify section header has an option that causes evaluation to continue after a match, processing stops when the call matches a Classify section.

• WNP Classify sections provide global type classifications that apply to the call as a whole (for example, international, toll free, toll).

• LNP Classify sections typically provide local, long distance, and metro designations. If no call label is explicitly defined for a call by any matched section(s), the call is labeled “LD” if the NPA of either the inbound source or outbound destination differs from the Span’s local NPA; otherwise, it is labeled “LOC.”

Phone Number/Call Classification Phase

Defining an SMDR Parse File • 111

Defining an SMDR Parse File

About SMDR Parse Files An SMDR parse file is a text file that defines the format of outgoing SMDR records so that the ETM® System can extract necessary call information from those records. For SMDR parse files to be available for download to the SMDR Provider Card, they must be stored in the ini folder in the ETM Server directory. If you accepted the installation defaults, this directory is located at the following path:

Windows

C:\Program Files\SecureLogix\ETM\software_repository\smdr\

Solaris

/opt/SecureLogix/ETM/software_repository/smdr/

SecureLogix has defined SMDR parse files for a number of PBX brands, including DMS-100, Meridian 1, ATT G2, DEFINITY, and Norstar. Before you attempt to create your own SMDR data definition file, please contact SecureLogix Customer Support to find out whether a data definition file is already available for your PBX. Contact SecureLogix Customer Support at any of the following:

• 1-877-SLC-4HELP

• [email protected]

• http://support.securelogix.com

For complete instructions for configuring the ETM® System to use SMDR, including installing the correct SMDR parse file on the SMDR Provider Card, see "Configuring SMDR and/or NFAS" in the ETM® System Installation Guide.

Files Already Defined

112 • Defining an SMDR Parse File

Use the following steps, described in detail in this section, to define the SMDR parse file:

1. Capture SMDR data by enabling SMDR debug logging on the ETM® Server via the TeleView™ Console.

2. Open an existing SMDR parse file to use as a template.

3. Modify each of the sections to match the SMDR data in use. See "SMDR Parse File Components" on page 114 for instructions specific to each section.

4. Save the file with a .txt extension in the smdr folder in the ETM Server directory. If you accepted the installation defaults, this folder is located at the following path:

Windows C:\Program Files\SecureLogix\ETM\ps\software_repository\smdr

Solaris

/opt/SecureLogix/ETM/ps/software_repository/smdr It is strongly recommended that a preexisting SMDR parse file be used as a template and modified to fit the needs of the current raw SMDR data. Several SMDR parse files are included in the smdr folder.

SMDR parse files are heavily dependent on regular expressions. It is strongly recommended that you have a reference guide for regular expressions as you modify/create the parse files. A brief reference for Perl5 regular expressions is included in this chapter.

Steps in Defining an SMDR Parse File


SMDR debug logging stores SMDR data and debugging information in a file named smdr_debug.txt in the ETM® Server installation directory.

By default, this file is located at the following path:

Windows C:\Program Files\SecureLogix\ETM\smdr_debug.txt

Solaris

/opt/SecureLogix/ETM/smdr_debug.txt

This information can be used for configuring the ETM System to use SMDR data and for troubleshooting SMDR resolution issues.

To enable/disable SMDR debug logging 1. On the TeleView™ main menu, click Admin | Server | Server

Administration. The ETM Server Administration Tool appears.

Enabling SMDR Debug Logging


2. On the General tab, in the SMDR Debugging area:

• Select the Enabled check box to store SMDR data in a file called SMDR_DEBUG.txt in the ETM Server installation directory.

• Clear the Enabled check box when you no longer need to store the data, so that it does not unnecessarily consume hard drive space.

3. Click OK to apply the setting and close the dialog box, or Apply to apply the setting and leave the dialog box open.

4. The smdr_debug.txt file is created and stores SMDR data and debugging information until you disable this setting. If you accepted the installation defaults, smdr_debug.txt is located at the following path:

Windows C:\Program Files\SecureLogix\ETM\smdr_debug.txt

Solaris

/opt/SecureLogix/ETM/smdr_debug.txt

This section defines the regular expressions of the token(s) that delineate outgoing call records. For single line SMDR data, the easiest delineator to use is ‘\r\n’ because this is always how the line ends (even if the raw data seen at the PBX has only ‘\r’ or ‘\n’ or even ‘^C’).

If a single call data record spans multiple lines, the final line should be defined as the Record Separator. For example, the following tokens are used in the proprietary Norstar SMDR format as the Record Separator:

<RECORD_SEPARATOR>

(CALL\sRELEASED\r\n|TRANSFERRED\r\n)

</RECORD_SEPARATOR>

SMDR Parse File Components

Section 1: Record Separator


The goal of this section is to create a regular expression that matches the outbound call record produced by the PBX and saves the necessary pieces of information.

To create the call record section 1. Print out a number of SMDR records.

2. Highlight the following information: Start Time, Source Extension, Dialed Digits, and Channel. If Start Time is not present, you can use the End time and Duration. The point of this step is to determine which pieces of information need to be saved in the Regular Expression.

3. Create a Regular Expression (or modify an existing one) that matches the raw data you have printed out.

IMPORTANT The expression does NOT have to match the entire data record, but must match from the first saved token to the last. You do not need to write processing code for the fields following the last saved token.

4. To mark a field as one that you want to save, use parentheses “( )” around the fields.

Finally, a number of fields must be defined following the Call Record section. Each field is defined on a separate line and enclosed in angle brackets. The sample SMDR definition files included in the ETM® Server installation directory demonstrate the syntax of the final fields. Call SecureLogix Customer Support if you have a special case.

The index in the final fields refers to the numeric order of the parenthesis you have used in the regular expression. For example, if the Start Time call data is represented by the subpattern enclosed within the third set of parenthesis, the index is 3; it would use the following final field: <START_TIME_FIELD=3>.

• <TIME_FIELD_FORMAT=format>—This specifies the format of the start (or end) time that you have specified to be saved in the Call Record section (for example, MM/dd/yy HH:mm:ss or MM/dd HH:mm). See "Time Format Syntax" on page 116 for important information about specifying the time format.

• <DURATION_FIELD_FORMAT=format>—This is the format of the duration that you have specified to be saved in the Call Record section. Omit this field if you are using Start Time.

Section 2: Call Record

Final Fields


• <STATION_FIELD=n>—This is the index (1-based) of where the station/extension field is in relation to the other saved tokens.

• <DIALED_DIGITS_FIELD=n>—This is the index (1-based) of where the station field is in relation to the other saved tokens.

• <START_TIME_FIELD=n>—This is the index (1-based) of where the start time field is in relation to the other saved tokens. Omit this field if you are using End Time and Duration.

• <CHANNEL_FIELD=n>—This is the index (1-based) of where the channel field is in relation to the other saved tokens.

• <END_TIME_FIELD=n>—This is the index (1-based) of where the start time field is in relation to the other saved tokens. Omit this field if you are using Start Time.

• <DURATION_FIELD=n>—This is the index (1-based) of where the duration field is in relation to the other saved tokens. Omit this field if you are using start time.

• Optional: <SMDR_1_FIELD=n>, <SMDR_2_FIELD=n>, and/or <SMDR_3_FIELD=n>—Provide indexes to up to 3 other saved tokens that you want to appear in the SMDR #1, SMDR #2, and SMDR #3 fields in the Policy Log and call data store. These fields may be used to extract PIN codes or other call accounting information.

The time format is specified using a time pattern string. In this pattern, all ASCII letters are reserved as pattern letters, which are defined as the following:

Symbol Meaning Presentation Example G era designator (Text) AD

y year (Number) 1996

M month in year (Text & Number) July & 07

d day in month (Number) 10

h hour in am/pm (1~12) (Number) 12

H hour in day (0~23) (Number) 0

m minute in hour (Number) 30

s second in minute (Number) 55

S millisecond (Number) 978

E day in week (Text) Tuesday

w week in year (Number) 27

Time Format Syntax


(Time format syntax table, continued from previous page)

Symbol Meaning Presentation Example D day in year (Number) 189

F day of week in month (Number) 2

W week in month (Number) 2

a am/pm marker (Text) PM

k hour in day (1~24) (Number) 24

K hour in am/pm (0~11)

(Number) 0

z time zone (Text) Pacific Standard Time

' escape for text (Delimiter)

'' single quote (Literal) '

The count of pattern letters determines the format:

• (Text)—4 or more pattern letters, use full form; fewer than 4, use short or abbreviated form, if one exists.

• (Number)—the minimum number of digits. Shorter numbers are zero-padded to this amount. Year is handled specially; that is, if the count of 'y' is 2, the year is truncated to 2 digits.

• (Text & Number)—3 or more pattern letters, use text; fewer than 3, use number.

Any characters in the pattern that are not in the ranges of ['a'..'z'] and ['A'..'Z'] will be treated as quoted text. For instance, characters like ':', '.', ' ', '#' and '@' will appear in the resulting time text even if they are not enclosed within single quotes.

The following table shows examples of time formats:

Format Pattern Result "yyyy.MM.dd G 'at' hh:mm:ss z" 1996.07.10 AD at 15:08:56

PDT

"EEE, MMM d, ''yy" Wed, July 10, '96

"h:mm a" 12:08 PM

"hh 'o''clock' a, zzzz" 12 o'clock PM, Pacific Daylight Time

"K:mm a, z" 0:00 PM, PST

"yyyyy.MMMMM.dd GGG hh:mm aaa" 1996.July.10 AD 12:08 PM

A pattern containing any invalid letter results in a thrown exception during formatting or parsing.


A regular expression uses a sequence of symbols to denote a pattern that serves as a state-machine or mini-program to match specific sequences of characters. The ETM® System SMDR parser uses Perl5 regular expressions.

The character set operator [...] works only on ASCII characters (Unicode characters 0 through 255). Otherwise, all Unicode characters should be valid in SMDR parser file regular expressions. The following sections list Perl5 regular and extended regular expression syntax.

Perl5 regular expression syntax consists of the following:

• Alternatives separated by the "pipe" symbol ( | )

• Quantified atoms:

{n, m} —Match at least n but not more than m times.

*—Match 0 or more times.

? —Match 0 or 1 times.

{n,} —Match at least n times.

{n} —Match exactly n times.

+—Match 1 or more times.

By default, a quantified subpattern is greedy, meaning it matches as many times as possible without causing the rest of the pattern not to match. To cause the quantifiers to match the minimum number of times possible, without causing the rest of the pattern not to match, add a ? following the quantifier. For example:

*? —Match 0 or more times

?? —Match 0 or 1 times

{n}? —Match at least n times

{n, m}? —Match at least n but not more than m times

{n}? —Match exactly n times

+? —Match 1 or more times

Regular Expression Syntax Quick Reference

Perl5 Regular Expression Syntax


• Atoms:

– Regular expression enclosed in parentheses —Matched as subpattern groups and saved for use by certain methods

– $—A null token matching the end of a string or line (i.e., the position right before a newline or right after the end of a string)

– . —(period) Matches everything except \n

– ^—A null token matching the beginning of a string or line (i.e., the position right after a newline or right before the beginning of a string)

– Character classes (e.g., [abcd]) and ranges (e.g. [a-z])—Special backslashed characters work within a character class (except for backreferences and boundaries). Inside a character class, \b represents backspace.

– Special backslashed characters (Note: Any backslashed character not in this list matches itself) \cD—matches the corresponding control character \b—null token matching a word boundary (\w on one side and \W on the other) \0—matches null character \A—Match only at beginning of string \B—null token matching a boundary that is not a word boundary \d—digit [0-9] \D—non-digit [NOT 0-9] \f—formfeed \n—newline \1, \2, \3, etc.—backreference. Matches whatever the specified parenthesized group matched. If no corresponding group exists, the number is interpreted as an octal representation of a character. \nn or \nnn—octal representation of character unless a backreference \r—carriage return \s—a whitespace character [ \t\n\r\f] \S—a non-whitespace character [NOT \t\n\r\f] \t—tab \w—word character [0-9_a-z_A-Z] \W—a non-word character [NOT 0-9_a-z_A-Z] \xnn—hexadecimal representation of character \Z—Match only at end of string (or before newline at the end)


Perl5 extended regular expression syntax consist of the following:

Expression Meaning (?!regexp) A zero-width negative lookahead assertion. For

example, bay(?!front) matches any occurrence of "bay" not followed by "front". Since this is a zero-width assertion, x(?!y)z will match xz, for example, because x is followed by a character that is not y (the z) and a z follows the zero-width assertion.

(?#text) An embedded comment causing text to be ignored.

(?:regexp) Groups whatever is contained in the regexp but does not cause the group match to be saved.

(?=regexp) A zero-width positive lookahead assertion. For example, \w+(?=\s) matches a word followed by whitespace, without including whitespace in the MatchResult.

(?imsx) One or more embedded pattern-match modifiers.

• i enables case insensitivity.

• m enables multiline treatment of the input.

• s enables single line treatment of the input.

• x enables extended whitespace comments.

Perl5 Extended Regular Expressions

ETM System v4.0 Technical Reference...both printed and electronic (PDF) format: ETM® Concepts...

Documents

Transcript of ETM System v4.0 Technical Reference...both printed and electronic (PDF) format: ETM® Concepts...