Data Dictionary and Glossary

Definitions containing clear, brief descriptions of the .dat files.
Formats containing the required fields. Primary Key fields are in boldface.
Examples containing samples of the contents for each .dat file.
Referential Integrity Constraints identifying the required links to other tables that must be maintained for the system to operate.
Reference documentation for further information.

A.1.2 Intended Audience

The intended audience is technical staff and developers familiar with the TransPath System product and its operation. A basic understanding of telecommunications practices and nomenclature is required.

File Names	Section	Title
`alarmCats.dat`	A.2.1	Alarm Categories
`auxSigChan.dat`	A.2.2	Auxiliary Signal Path
`bearChan.dat`	A.2.3	Bearer Channels
`buckets.dat`	A.2.4	Buckets
`compTypes.dat`	A.2.7	Component Types
`components.dat`	A.2.5	Components
`properties.dat`	A.2.19	Configuration Properties
`dependencies.dat`	A.2.8	Dependencies
`dpc.dat`	A.2.6	Destination Point Codes
`dmprSink.dat`	A.2.9	Dumper Sink
`measCats.dat`	A.2.10	Measurement Categories
`measProfs.dat`	A.2.11	Measurement Profiles
`physLineIf.dat`	A.2.12	Physical Line Interface Files
`procGroups.dat`	A.2.14	Process Groups
`processes.dat`	A.2.13	Processes
`routes.dat`	A.2.18	Routes
`services.dat`	A.2.15	Services
`sigChanDev.dat`	A.2.17	Signaling Channel Devices
`sigPath.dat`	A.2.16	Signaling Path
`tables.dat`	A.2.20	Tables
`thresholds.dat`	A.2.21	Thresholds
`XECfgParm.dat`	*	See "System Management."

Table A-1:

File Names Section Title

alarmCats.dat
A.2.1

Alarm Categories

auxSigChan.dat
A.2.2

Auxiliary Signal Path

bearChan.dat
A.2.3

Bearer Channels

buckets.dat
A.2.4

Buckets

compTypes.dat
A.2.7

Component Types

components.dat
A.2.5

Components

properties.dat
A.2.19

Configuration Properties

dependencies.dat
A.2.8

Dependencies

dpc.dat
A.2.6

Destination Point Codes

dmprSink.dat
A.2.9

Dumper Sink

measCats.dat
A.2.10

Measurement Categories

measProfs.dat
A.2.11

Measurement Profiles

physLineIf.dat
A.2.12

Physical Line Interface Files

procGroups.dat
A.2.14

Process Groups

processes.dat
A.2.13

Processes

routes.dat
A.2.18

Routes

services.dat
A.2.15

Services

sigChanDev.dat
A.2.17

Signaling Channel Devices

sigPath.dat
A.2.16

Signaling Path

tables.dat
A.2.20

Tables

thresholds.dat
A.2.21

Thresholds

XECfgParm.dat
*

See "System Management."

File Name Descriptions

A.1.4 Conventions Used in this Guide

General Conventions

The following type changes and symbols are used in this guide.

Typeface	Description	Examples
`AaBbCc123`	Command, field, file, and directory names and onscreen computer output.	`rtrv-alms`
`AaBbCc123`	Replaceable file names, real name, or values.	`rtrv-cfg:<cfg table>`
AaBbCc123	Book titles, new words, terms, or words to be emphasized.	TransPath System Installation Guide.

Table A-2: Type Changes and Symbols Used in this Guide

Typeface Description Examples

AaBbCc123

Command, field, file, and directory names and onscreen computer output.

rtrv-alms

AaBbCc123

Replaceable file names, real name, or values.

rtrv-cfg:<cfg table>

AaBbCc123

Book titles, new words, terms, or words to be emphasized.

TransPath System Installation Guide.

Backus-naur Conventions


\|	A pipe. Either the preceding symbol or the succeeding symbol may occur but not both in succession.
[ ]	These brackets enclose an optional parameter.
{ \| }	{`either this one` \| `or that one`} Either the preceding symbol, or the succeeding symbol may occur, but not both in succession. There may be more than two symbols and pipes.
< >	This symbol encloses a symbol specifier.

Bellcore TL1 Conventions


:	A parameter separator.
::	An empty parameter block.
	Arguments are grouped together so that one parameter may convey several arguments.
;	End of command.

A.1.5 Data Type Conventions


point code	ANSI and ETSI have different basic formats for SS7 point codes, but both can be visually represented using a normalized version of XX.YY.ZZ.

Protocol	XX Represents	YY Represents	ZZ Represents
ANSI	Network	Cluster	Member
ETSI	Zone	Area/Network	Point Code ID

Table A-3:

Protocol XX Represents YY Represents ZZ Represents

ANSI

Network

Cluster

Member

ETSI

Zone

Area/Network

Point Code ID

Point Code

Note The use and valid values of a point code are network dependent.

Example A-1: Point Code

1.128.1 10.27.2

integer

A series of decimal digits from the set of 0 through 9 that represents a positive integer. An integer may have one or more leading zero ('0') digits padded on the left side to align the columns. Leading zeros are always valid as long as the number of digits is less than or equal to ten digits total. Values of this type have a range of zero to 4294967295.

integer	A series of decimal digits from the set of 0 through 9 that represents a positive integer. An integer may have one or more leading zero ('0') digits padded on the left side to align the columns. Leading zeros are always valid as long as the number of digits is less than or equal to ten digits total. Values of this type have a range of `zero` to `4294967295`.

Example A-2: Integers

123 000123 4200000000

signed integer

This data type has the same basic format as the integer but can be both positive and negative. When negative, it is preceded by the sign (`-') character. As with the integer data type, this can be up to 10 digits in length, not including the sign character. The value of this type has a range of -2147483647 to 2147483647.

signed integer	This data type has the same basic format as the integer but can be both positive and negative. When negative, it is preceded by the sign (`-') character. As with the integer data type, this can be up to 10 digits in length, not including the sign character. The value of this type has a range of `-2147483647` to `2147483647`.

Example A-3: Signed Integers

123 -000123 -2100000000

hexadecimal

A series of sixteen-based digits from the set of 0-9, a-f, or A-F. The hexadecimal number may have one or more '0' digits padded on the left side. For all hexadecimal values the maximum size is 0xffffffff (8 hexadecimal digits).

hexadecimal	A series of sixteen-based digits from the set of `0-9`, `a-f`, or `A-F`. The hexadecimal number may have one or more '0' digits padded on the left side. For all hexadecimal values the maximum size is `0xffffffff` (8 hexadecimal digits).

Example A-4: Hexadecimal

1f3
01f3000

Note Hexadecimal and integer fields in files may have different widths (number of characters) for column alignment.

text

A series of alpha-numeric characters from the ASCII character set, where defined. Tab, space, and double quote (" ") characters cannot be used. Text can be up to 255 characters; however, it is recommended that you limit the characters to no more than 32 for readability.

text	A series of alpha-numeric characters from the ASCII character set, where defined. Tab, space, and double quote (" ") characters cannot be used. Text can be up to 255 characters; however, it is recommended that you limit the characters to no more than 32 for readability.

Example A-5: Text

EntityId LineSES_Threshold999

string

A series of alpha-numeric characters and white-space characters. A string has a double quote on either side (" "). Text can be up to 255 characters; however, it is recommended that you limit the characters to no more than 80 for readability.

string	A series of alpha-numeric characters and white-space characters. A string has a double quote on either side (" "). Text can be up to 255 characters; however, it is recommended that you limit the characters to no more than 80 for readability.

Example A-6: String

"This is a descriptive string."

Primary Key

Every table in the Configuration File chapter has one or more primary key fields. These fields are marked in the description with a "[Primary Key]" indicator. The Primary Key is the unique identifier of a record in the table.

Foreign Key

One or more fields in a table may have a foreign key entry. These fields are marked in the description with a "[Foreign Key]" indicator. The Foreign Key is the unique identifier of a record in another table. It is used to reference a record from one table to another table. The Table Relationships chapter contains a diagram of the Foreign Key relationship.

IP Address

This is a standard TCP/IP address expressed as four numbers, each between 0 and 255, and separated by periods. For example, 139.85.60.17 or 127.55.13.200.

Primary Key	Every table in the Configuration File chapter has one or more primary key fields. These fields are marked in the description with a "[Primary Key]" indicator. The Primary Key is the unique identifier of a record in the table.
Foreign Key	One or more fields in a table may have a foreign key entry. These fields are marked in the description with a "[Foreign Key]" indicator. The Foreign Key is the unique identifier of a record in another table. It is used to reference a record from one table to another table. The Table Relationships chapter contains a diagram of the Foreign Key relationship.
IP Address	This is a standard TCP/IP address expressed as four numbers, each between `0` and `255`, and separated by periods. For example, `139.85.60.17` or `127.55.13.200`.

A.1.6 Exceptions to the Conventions

All known exceptions are expressed in the specific format sections of this document. Otherwise, follow the conventions in the "Conventions Used in this Guide" section .

A.2 TransPath System Configuration Files

This chapter describes the layout of files used to configure a TransPath system network element. The TransPath system configuration files are based on relational database paradigm and the nomenclature reflects this structure. A file is a physical representation of a single relational table. It has fields, one or more primary keys, and zero or more foreign keys. See About This Manual for definitions of primary and foreign keys. As a result, the terms "file" and "table" are used interchangeably throughout this document. From a logical view, the terms have the same meaning.

The table relationships, on a field-by-field basis, are diagrammed in "Managing Status Alarms." They are not referred to in this section except when there is a special note.

The index field of a table uniquely identifies a record within the table. In this capacity it is an internal key for the record. It should not be used as the primary key. However, if the index field for a record is changed and the table is reloaded by a subsystem, the record appears internally as a new record. The Data Manager module identifies the previous index as a deleted record.

A.2.1 Alarm Categories

Definition

The alarmCats.dat file contains a definition for each alarm category in the system. Each alarm is defined by the following: the Alarm Category Identification, Alarm Category Name, Alarm/Event Severity, Report Flag, format String, and the alarm description.

Field Name	Data Type	Max Length	Specific Instructions and Exceptions
`almCategoryId`	integer	8	Table index
`almCategoryName`	string	80	[`Primary` `Key`] This is the alarm type identifier in an MML message
`severity`	integer	1	The alarm severity categories are: `0` = informational `1` = minor `2` = major `3` = critical
`reportedFlag`	text	1	The reported flag categories are: `N` = not reported to management interface `Y` = reported to management interface
`formatString`	string	80	A supplemental string in an MML message
`almDescription`	string	80	An internal description of what the alarm represents

Table A-4: alarmCats.dat Field Formats

Field Name Data Type Max Length Specific Instructions and Exceptions

almCategoryId
integer

8

Table index

almCategoryName
string

80

[Primary Key]

This is the alarm type identifier in an MML message

severity
integer

1

The alarm severity categories are:

0 = informational

1 = minor

2 = major

3 = critical

reportedFlag
text

1

The reported flag categories are:

N = not reported to management interface

Y = reported to management interface

formatString
string

80

A supplemental string in an MML message

almDescription
string

80

An internal description of what the alarm represents

Example A-7: alarmCats.dat Field Formats

0001 "Config Fail" 0 Y "Config Fail - 
Check Log"  "Config Failure- info | reported"
0002 "XE Rsc Fail" 0 Y "Resource Fail - Check Log" "XE Resource Failure - info | 
reported"
0011 "DISK"    2 Y "Low Disk Space - Contact Admin" "Generated by Disk Monitor"

This example identifies a number of alarms in the alarmCats.dat table. Refer to Alarm 0011. This is a disk alarm with a key of "DISK". It has a major severity and is reported. The supplemental string has more information for the technician, including a suggestion to contact the system administrator. The final field is for notes. This note indicates that the alarm is generated by the disk monitor process.

Referential Integrity Constraints

Alarm Category Names of existing records cannot be changed or removed because these are used as primary keys by programs and other data files.

Records must not be removed from this table almCategoryName, and must not be changed. All other fields can be redefined to the net work operating characteristics.

A.2.2 Auxiliary Signal Path

Definition

The auxSigPath.dat table contains all Auxiliary Signal Path (ASP) interfaces for a network including the local network. As a result, it can be replicated on every machine. The ASP ID is the "Instance number" of the Network Element ID for a particular TransPath system.

The ASP ID is unique to every TransPath system within an Auxiliary Signaling Network. This value is configured in XECfgParm.dat for a TransPath system under the label "*.TransPath SystemId". It is a four digit hex number.

The auxSigPath.dat table contains the TransPath SystemId of everyone in the ASN. The local ASP is identified by matching against the local TransPath SystemId. Every ASP, both local and remote, is tracked using a concatenation of 0x000E + TransPath SystemId (e.g. 0x000E001B).

Field Name	Data Type	Max Length	Specific Instructions and Exceptions
`TransPath SystemId`	hex	4	If this value does not exist or is set to 0, then the ASN is disabled.
`ASPId`	hex	4	[Primary Key] The "Instance number" of the TransPath System ID for a specific TransPath System.
`IPAddress`	IP Address	8	Use <`standard`> IP address
`IPPort`	integer	4	Internet Protocol port
`X.121_Addr`	integer	12	This is the X.121 address used to identify the NE across an X.25 Network.

Table A-5: auxSigPath.dat Field Formats

Field Name Data Type Max Length Specific Instructions and Exceptions

TransPath SystemId
hex

4

If this value does not exist or is set to 0, then the ASN is disabled.

ASPId
hex

4

[Primary Key]

The "Instance number" of the TransPath System ID for a specific TransPath System.

IPAddress
IP Address

8

Use <standard> IP address

IPPort
integer

4

Internet Protocol port

X.121_Addr
integer

12

This is the X.121 address used to identify the NE across an X.25 Network.

Example A-8: Examples

73   123.11.12.123   13   444411112222
1b   123.11.12.2      15   111122221234

In the first example, the Network Element ID number for a specific TransPath system is number 73. The Internet Protocol address is 123.11.12.123, and the Internet Protocol port number is 13. The specific TransPath system network address is 444411112222.

Referential Integrity Constraints

Only one ASPId must appear as the Network Element Instance in components.dat.

A.2.3 Bearer Channels

Definition

The bearChan.dat file is used to define the mapping between bearer channels implemented on the MUX attached to TransPath system. A bearer channel is uniquely defined by combining the associated signal path with the corresponding bearer channel.

Field Name	Data Type	Max Length	Specific Instructions and Exceptions
`sigPathId`	hex	4	[Primary Key] `sigPath.dat- sigPathId`
`bearChanId`	hex	8	[Primary key] Bearer Channels are expressed in hexadecimal. Bearer Channel values depend on the signaling path type. For example: Some DSS-1 variants = `01` to `18` DPNSS = `1` to `F` and `11` to `1F`, but not `10`. Consult the Operations Manual for the convention used for a specific protocol.
`mateSigPathId`	hex	4	`sigPath.dat - sigPathId`
`mateBearChanId`	hex	8	Values are the same as `bearChanId`.

Table A-6: bearChan.dat Field Formats

Field Name Data Type Max Length Specific Instructions and Exceptions

sigPathId
hex

4

[Primary Key]

sigPath.dat- sigPathId

bearChanId
hex

8

[Primary key]

Bearer Channels are expressed in hexadecimal.

Bearer Channel values depend on the signaling path type. For example:

Some DSS-1 variants = 01 to 18

DPNSS = 1 to F and 11 to 1F, but not 10.

Consult the Operations Manual for the convention used for a specific protocol.

mateSigPathId
hex

4

sigPath.dat - sigPathId

mateBearChanId
hex

8

Values are the same as bearChanId.

Example A-9: bearChan.dat Field Formats

0001   01   0002   01
0001   02   0002   02
0001   03   0002   03

These records demonstrate the mapping between bearer channels 1, 2, 3 of signal path 1 to the mate bearer channels 1, 2, 3 of signal path 2.

Referential Integrity Constraints

For added records to be valid in this table, both sigPathId and mateSigPathId must exist in components.dat as instances of the signaling path component type.

Records must not be deleted from this file as long as either sigPathId or mateSigPathId are referenced in sigPath.dat.

For the specified mapping to be effective, both sigPathId and mateSigPathId must exist in sigPath.dat.

A.2.4 Buckets

Definition

The buckets.dat data file defines measurement buckets/intervals with associated thresholds. A bucket may have up to two thresholds (floor and ceiling) associated with it. If a measurement is being reported on, but no alarm conditions exist for this counter, the threshold field in the record may contain a null string.

Field Name	Data Type	Max Length	Specific Instructions and Exceptions
`sequenceNum`	integer	8	Table index; this needs to be a unique identifier.
`bucketName`	text	32	[Primary Key]. The name of this bucket.
`bucketId`	integer	8	The numeric identifier of the corresponding record in `measCats.dat`. Each measurement in `measCats.dat` may have one or more buckets.
`interval`	integer	8	The defined length in seconds; it must be one of the following fixed intervals: `900` = 15 minutes `1800` = 60 minutes `86400` = 24 hours
`thresholdName`	string	80	[Foreign key] `thresholds.dat` - `thresholdName` There may be up to two thresholds per bucket. Use a null string for buckets that have no alarm thresholds associated with them.
`interval`	integer	8	The defined length in seconds; it must be one of the following fixed intervals: `900` = 15 minutes `1800` = 60 minutes `86400` = 24 hours
`thresholdName`	string	80	[Foreign key] `thresholds.dat` - `thresholdName` There may be up to two thresholds per bucket. Use a null string for buckets that have no alarm thresholds associated with them.

Table A-7: buckets.dat Field Formats

Field Name Data Type Max Length Specific Instructions and Exceptions

sequenceNum
integer

8

Table index; this needs to be a unique identifier.

bucketName
text

32

[Primary Key].

The name of this bucket.

bucketId
integer

8

The numeric identifier of the corresponding record in measCats.dat. Each measurement in measCats.dat may have one or more buckets.

interval
integer

8

The defined length in seconds; it must be one of the following fixed intervals:

900 = 15 minutes

1800 = 60 minutes

86400 = 24 hours

thresholdName
string

80

[Foreign key]

thresholds.dat - thresholdName

There may be up to two thresholds per bucket. Use a null string for buckets that have no alarm thresholds associated with them.

interval
integer

8

The defined length in seconds; it must be one of the following fixed intervals:

900 = 15 minutes

1800 = 60 minutes

86400 = 24 hours

thresholdName
string

80

[Foreign key]

thresholds.dat - thresholdName

There may be up to two thresholds per bucket. Use a null string for buckets that have no alarm thresholds associated with them.

Example A-10: buckets.dat Field Formats

003 b_lifses24    1 86400    "T_lifeses24"

Specifies the sequenceNum as 003 with a bucket name of b_lifses24. The bucket is related to measurement one in measCats.dat and has an interval of 24 hours. The final field indicates a threshold defined in quotes as: "T_lifeses24". (The thresholds.dat file must contain the definition of this threshold.) The second and third buckets in the examples are both related to measurement two; the former has a period of fifteen minutes and the latter has a period of sixty minutes. Neither the 004 nor 005 record has a threshold.

Referential Integrity Constraints

The last record in this table with a given bucketName must not be deleted if any records exist with the same bucket name in the measProfs.dat table.

Any threshold names used in this table must be defined in thresholds.dat for the entry to be valid.

A.2.5 Components

Definition

The components.dat file identifies all visible entities within a network element that can be managed by the user, who defines the type of component, instance for that component type, and the related parent component information. Components are arranged in a hierarchy.

All ASP entries are tagged with a component type of 0x000E. This is identified using the label "ASP". A dummy value of 000E0000 is used in this table. This value is never passed to either the Channel Controller or the Engine.

In prior releases, a signal path had a one-to-one relationship with a signal channel. This relationship has to be expanded for C7 signal paths since up to 16 links (signal channels) can be in a link set (signal path). In order to expand the relationship, signal channels need to have their own component IDs. Currently, signal channels do not exist as a separable entity. For C7, a signal channel needs to be recognized in compTypes.dat and components.dat.

Field Name	Data Type	Max Length	Specific Instructions and Exceptions
`componentId`			[Primary Key] This is composed of two sub-fields.
`compType`	hex	4	This is the type of component being represented, encoded as a 4-digit hex number.
`compInstance`	hex	4	This is the instance of the component type being represented. This number is significant only within a specific component type. It begins at `1` and goes up to `65535`.
`parentCompId`			This is the key of the parent component. It is used to model a containment relationship between the parent the current record. The parent must exist before the current record exists.
`parentCompType`	hex	4	See `compType` description.
`parentCompInst`	hex	4	See `compInstance` description.
`compInstName`	string	16	This name is used to symbolically identify the component. This is used by the MML interface and some processes internally.
`compDescription`	string	80	A customer-defined description of the component to be used for identification or notes. This is used in MML responses and alarms to indicate which TransPath System generated the message.

CompId	Parent CompId	MML name	Description
00010001	0000000	"TP-01"	"Martel-001"
00020005	00010001	"IOSG-01"	"IO subsystem"
0030008	00020005	"IOCC-01"	"DPNSS"
003000B	00020005	"IOCC-03"	"ITU C7"
00050001	00010001	"CARD-01"	"ITK card in slot 1"
00050002	00010001	"CARD-02"	"ITK card in slot 2"
00060001	00050001	"L-1"	"Line to card 1"
00060002	00050001	"L-2"	"Line to card 2"
00070001	00010001	"P-1"	"Signal path for DPNSS"
00070002	00010001	"P-2"	"Signal path for C7 Linkset #1"
00080001	00060001	"C-1"	"Signal channel for DPNSS"
00080002	00060001	"C-2"	"Link #1 on link set for C7"
00080003	00060002	"C-3"	"Link #2 on link set for C7"
00100001	00010001	"PC-001"	"Point code 1"
00100002	00010001	"PC-002"	"Point code 2"

Table A-8:

Field Name Data Type Max Length Specific Instructions and Exceptions

componentId

[Primary Key]

This is composed of two sub-fields.

compType
hex

4

This is the type of component being represented, encoded as a 4-digit hex number.

compInstance
hex

4

This is the instance of the component type being represented. This number is significant only within a specific component type. It begins at 1 and goes up to 65535.

parentCompId

This is the key of the parent component. It is used to model a containment relationship between the parent the current record. The parent must exist before the current record exists.

parentCompType
hex

4

See compType description.

parentCompInst
hex

4

See compInstance description.

compInstName
string

16

This name is used to symbolically identify the component. This is used by the MML interface and some processes internally.

compDescription
string

80

A customer-defined description of the component to be used for identification or notes. This is used in MML responses and alarms to indicate which TransPath System generated the message.

components.dat Field Formats
Table A-9: components.dat Field Formats

CompId Parent CompId MML name Description

00010001

0000000

"TP-01"

"Martel-001"

00020005

00010001

"IOSG-01"

"IO subsystem"

0030008

00020005

"IOCC-01"

"DPNSS"

003000B

00020005

"IOCC-03"

"ITU C7"

00050001

00010001

"CARD-01"

"ITK card in slot 1"

00050002

00010001

"CARD-02"

"ITK card in slot 2"

00060001

00050001

"L-1"

"Line to card 1"

00060002

00050001

"L-2"

"Line to card 2"

00070001

00010001

"P-1"

"Signal path for DPNSS"

00070002

00010001

"P-2"

"Signal path for C7 Linkset #1"

00080001

00060001

"C-1"

"Signal channel for DPNSS"

00080002

00060001

"C-2"

"Link #1 on link set for C7"

00080003

00060002

"C-3"

"Link #2 on link set for C7"

00100001

00010001

"PC-001"

"Point code 1"

00100002

00010001

"PC-002"

"Point code 2"

Note Signal paths are not tied to a specific card or line interface. C7 signal paths can contain signal channels (links) that exist on multiple line interfaces.

C7 has an additional requirement of specifying reachable destination point codes. This requires a component type and entries in the components.dat table. The point code and signal path associated is defined in a new file called "pointcode.dat" (see the table above).

Example A-11: components.dat Field Formats

00010001 00000000 "TRANSPATH SYSTEM-02" 
"DEMOLAB002"
00050001 00010001 "IOC-01" "Line Interface Card 1"
00060001 00050001 "L-01" "Card 1, LIF 1"

In the second example, a line card component is defined with a component type of five and an instance of one. The card has a symbolic identifier of "IOC-01" as indicated by the description. Its parent component is the network element instance 1 of type 1. This entry in the table, type=1 and instance=1 identifies the network element.

The compInstName defines the network element as a whole. In this case, it is called "TRANSPATH SYSTEM-02". The description field is replaced by the customer-defined location. This is generally a unique identifier used in a network to describe a network element based on its location
or address plan. The description in the example is "DEMOLAB002" indicating it is the second TransPath system element in the Demonstration Lab.

Referential Integrity Constraints

Both compType and parentCompType must exist in compTypes.dat before a record can be added.

A record cannot be deleted from this table if related records exist (referencing the same component instance or name) in bearChan.dat, sigPath.dat, procGroups.dat, processes.dat, or dependencies.dat.

Additional Comments

The compInstName is used as a key for lookups and it must be unique. Component identification numbers must be unique.

A.2.6 Destination Point Codes

Definitions

The dpc.dat data file defines the point codes recognized by the Network Element (NE). Each point must have a component ID and a point code number. The point code number is encoded according to rules defined by the service provider. For ETSI C7 networks, a supplementary network indicator is required to differentiate customer of CAP networks within a single service provider's network.

The final field contains the component ID of the supporting signal path or route set. If this field contains a signal path ID, then it is used as an index to sigChanDev.dat. When a signal path ID is used, the DPC is considered to be the adjacent point code and the OPC is the NE default point code. If it is a route set ID, then it is used as an index to routeset.dat.

dpc.dat Field Formats

Field Name	Data Type	Max Len	Specific Instructions
DpcId	hex	8
DpcNum	point code	8
NetworkInd	integer	1	The network indicator is defined in order to provide context for the Point Code. The following are valid values: 0 = International network 1 = Spare 2 = National network 3 = Reserved for national use

`00130002`	`0.31.1`	`2`
`00130003`	`1.100.2`	`3`

Table A-10:

Field Name Data Type Max Len Specific Instructions

DpcId

hex

8

DpcNum

point code

8

NetworkInd

integer

1

The network indicator is defined in order to provide context for the Point Code. The following are valid values:

0 = International network

1 = Spare

2 = National network

3 = Reserved for national use

dpc.dat Field Formats
Example A-12: dpc.dat Field Formats

00130002

0.31.1

2

00130003

1.100.2

3

The first record is a destination point code in the national network. The second record is a destination point code in a proprietary network.

Referential Integrity Constraints

The component ID of each record must exist in components.dat.

A.2.7 Component Types

Definition

The compTypes.dat file contains an identification number, name, and description for each type of component in the system. Examples of component types include processes, process groups, I/O cards, signaling channels, and TransPath system itself. Either the identification number or the name of the component type may be used as a key.

Field Name	Data Type	Max Length	Specific Instructions and Exceptions
`CompTypeId`	hex	4	[Primary Key] This is the table index. It also is used in `components.dat`.
`CompTypeName`	string	40	[Primary Key] This is used as a symbolic key to find the `compTypeId`.
`CompTypeDescription`	string	80	For documentation purposes only
`Signal channel`	string		With C7, the signal channel is equivalent to a link and the signal path is equivalent to a linkset.
`Point code`	string		With C7, destinations can be routed through a network. The destination, called a point code, is located via a collection of routes. MTP3 handles route management to deliver C7 messages to the desired point code.
`Route`	string		All C7 point codes available to the TransPath System are available through at least one route. A route can be accessed through one or more link sets.

Table A-11: compTypes.dat Field Formats

Field Name Data Type Max Length Specific Instructions and Exceptions

CompTypeId
hex

4

[Primary Key]

This is the table index. It also is used in components.dat.

CompTypeName
string

40

[Primary Key] This is used as a symbolic key to find the compTypeId.

CompTypeDescription
string

80

For documentation purposes only

Signal channel
string

With C7, the signal channel is equivalent to a link and the signal path is equivalent to a linkset.

Point code
string

With C7, destinations can be routed through a network. The destination, called a point code, is located via a collection of routes. MTP3 handles route management to deliver C7 messages to the desired point code.

Route
string

All C7 point codes available to the TransPath System are available through at least one route. A route can be accessed through one or more link sets.

Note This release supports only fully associated links, so a signal path is a route to a destination point code. However, there may be multiple signal paths to that point code.

Example A-13: compTypes.dat Field Formats

0001

"LPC"

"Network Element"

0005

"IO Card"

"Line Interface Card"

`0001`	`"LPC"`	`"Network Element"`
`0005`	`"IO Card"`	`"Line Interface Card"`

In this example, the first record defines the component type for the network element. It is always 1. The second record defines the component type for an IO Card. The descriptive string indicates it is used for line interface cards.

Referential Integrity Constraints

A record may not be deleted from this table as long as related records (that is, records referencing a certain component type and/or name) exist in any other table.

A.2.8 Dependencies

Definition

The dependencies.dat file controls the order in which the Process Manager starts and stops processes and groups. Dependencies may be established that prevent certain processes or process groups from starting either before another process or group or before other processes and/or groups. A command to start a process or group does not cause the process or group to start until all of its dependencies are active. The command does not fail; it is just deferred until after the dependencies are started.

Field Name	Data Type	Max Length	Specific Instructions and Exceptions
`DepType`	text	1	This text character must be one of the following: `g` = group, or `p` = process.
`DepName`	string	80	[Primary Key] `components.dat` This is the name of the process or process group that is the dependent.
`DepcyType`	text	1	This text character must be one of the following: `g` = group `p` = process
`DepcyName`	string	80	[Foreign Key] `components.dat` This is the name of the process or process group that is the dependency.

Table A-12:

Field Name Data Type Max Length Specific Instructions and Exceptions

DepType
text

1

This text character must be one of the following:

g = group, or

p = process.

DepName
string

80

[Primary Key] components.dat

This is the name of the process or process group that is the dependent.

DepcyType
text

1

This text character must be one of the following:

g = group

p = process

DepcyName
string

80

[Foreign Key] components.dat

This is the name of the process or process group that is the dependency.

dependencies.dat Field Formats
Example A-14: dependencies.dat Field Formats

g

"IOSG-01"

g

"ENGG-01"

p

"IOCM-01"

g

"XEG-01"

p

"IOCC-01"

p

"IOCM-01"

`g`	`"IOSG-01"`	`g`	`"ENGG-01"`
`p`	`"IOCM-01"`	`g`	`"XEG-01"`
`p`	`"IOCC-01"`	`p`	`"IOCM-01"`

In the first example, the Process Manager is requested not to start up the process group named "IOSG-01" until after the process group named "ENGG-01" has been started.

Referential Integrity Constraints

Both the dependent process or process group and the dependency process or process group must already exist in processes.dat or procGroups.dat. Both must also exist in components.dat.

A.2.9 Dumper Sink

Definition

The TransPath system Dumper subsystem is a mechanism to efficiently collect records and store them locally in logs in a spool area. It is the responsibility of other processes or systems to retrieve the record logs. This table configures the characteristics of the Dumper. The characteristics of the Dumper subsystem can be altered by the configuration file, dmprSinks.dat.

Field Name	Data Type	MaxLength	Specific Instructions and Exceptions
`sinkId`	integer	8	Table index.
`sinkName`	string	80	[Primary Key] This identifies the type of records to be collected. The following are valid values: `"callDetail"` = call detail records `"measReport"` = statistics records `"almState"` = alarm records
`sinkFmt`	text	3	The value must be one of the following: `csv` = comma-separated value `bin` = binary
`sinkPrefix`	string	3	Files will be created with this prefix for the name.
`openSinkDir`	string	80	Create data-identified files in this directory.
`closeSinkDir`	string	80	Place completed files in this directory after they have been closed.
`maxRecs`	integer	4	This is the maximum number of records a file is allowed to contain before it is closed. If this is zero, then there is no maximum.
`maxSize`	integer	8	This is the maximum size that a file is allowed to grow to, in 1000 bytes. If this is zero, then there is no maximum.
`maxTime`	integer	8	This is the maximum time a file is allowed to remain open, in minutes. If this is zero, then there is no maximum.

Table A-13: dmprSink.dat Field Formats

Field Name Data Type MaxLength Specific Instructions and Exceptions

sinkId
integer

8

Table index.

sinkName
string

80

[Primary Key]

This identifies the type of records to be collected.

The following are valid values:

"callDetail" = call detail records

"measReport" = statistics records

"almState" = alarm records

sinkFmt
text

3

The value must be one of the following:

csv = comma-separated value

bin = binary

sinkPrefix
string

3

Files will be created with this prefix for the name.

openSinkDir
string

80

Create data-identified files in this directory.

closeSinkDir
string

80

Place completed files in this directory after they have been closed.

maxRecs
integer

4

This is the maximum number of records a file is allowed to contain before it is closed. If this is zero, then there is no maximum.

maxSize
integer

8

This is the maximum size that a file is allowed to grow to, in 1000 bytes. If this is zero, then there is no maximum.

maxTime
integer

8

This is the maximum time a file is allowed to remain open, in minutes. If this is zero, then there is no maximum.

Example A-15: dmprSink.dat Field Formats

1   "callDetail" csv   "CDR"    "../log" 
"../spool" 1500 0 15

The above example shows that the sink name is "callDetail"; the sink format is to be a comma-separated value. The maximum number of records allowed for the file is 1500. There is no maximum file size and the file can remain open for up to 15 minutes. The above is a Relative path name.

<record type>_<yymmddHHMMSS>.<fileformat>

The following are examples of record type:

alm - alarms

cdr - cdr

meas - measurements

yymmddHHMMSS is the year, month, day, hour, minute, second that the file was written using Greenwich Mean Time (GMT).

The following is an example of the file format:

csv - comma separated variables

bin - binary

The files are stored in this special area:

Note Time stamps are always in the number of seconds starting on January 1, 1970 00:00:00 GMT.

Alarms Record Layout

Table A-14:

Field Name Data Type Max Length Comments

ReleaseLevel
Integer

3

This describes format of records.

TimeStamp
Integer

10

This is the time when record was written to log.

State
Integer

1

1 if the alarm is active, 0 if the alarm is clear. For informational alarms, this is always set to 1.

Severity
Integer

1

This is alarm severity. See alarmCats.dat for values.

AlarmCat
String

80

This is the name of the alarm category (see alarmCat.dat).

ReleaseLevel
Integer

3

This describes format of records.

TimeStamp
Integer

10

This is the time when record was written to log.

State
Integer

1

1 if the alarm is active, 0 if the alarm is clear. For informational alarms, this is always set to 1.

Severity
Integer

1

This is alarm severity. See alarmCats.dat for values.

AlarmCat
String

80

This is the name of the alarm category (see alarmCat.dat).

ComponentName
String

32

This is the component on which the alarm occurred (see components.dat).

Originator
String

32

This is the service that set or cleared this alarm (see services.dat.)

Alarms Record Layout

Measurement Record Layout

Table A-15: Measurement Record Layout

Field Name Data Type Field Length Comments

ReleaseLevel
Integer

3

Describes format of records

IntervalStarted
Integer

10

When measurement interval started using timeStamp format.

IntervalSeconds
Integer

5

Duration of collection interval in seconds.

MeasValue
Integer

10

Value of the measurement at the end of the interval.

MeasUnits
String

32

Units for which the measurement is recorded.

MeasCat
String

32

Measurement category (see measCats.dat).

ComponentName
String

32

Component for which the measurement was being collected (see components.dat).

Call Detail Record (CDR) Layout

Table A-16: Call Detail Record (CDR) Layout

Field Name Data Type Field Length Comments

Revision Level
Integer

3

Describes format of records.

Pre-trans. CLI Type Indicator
Integer

1

Indicates whether Calling Line Identification (CLI) was present.

1 = present 0 = not present

CLI - pre-translated
String

32

CLI prior to any translation performed by the TransPath System.

Dialed Number Pre-translation Indicator
Integer

1

Indicates whether the Dialed Number was present.

1 = present 0 = not present

Dialed Number - pre-translation
String

32

Dialed number prior to any translation performed by the TransPath System.

Post-trans. CLI Indicator
Integer

1

Indicates whether a translated CLI is present.

1 = present 0 = not present

CLI - post-translation
Integer

32

CLI after any translations performed by the TransPath System.

Post-trans. Dialed Number Indicator
Integer

1

Indicates whether a translated Dialed Number was present.

1 = present 0 = not present

Dialed Number - Post-translation
String

32

Dialed Number after any translations performed by the TransPath System.

Setup message timestamp
Integer

10

Time when the initial setup message was received.

Line seizure occurred timestamp
Integer

10

Time when the line was seized.

Answer supervision received timestamp
Integer

10

Time when the call was answered.

(if applicable)

Disconnect message timestamp
Integer

10

Time when call ended (if applicable).

Direction of disconnect
Integer

1

Side of the call that disconnected first.

0 = originating side

1 = terminating side

Release code
Hex

4

Cisco Systems specific format.

Signal Path ID In
Hex

8

ID for the originating Signal Path.

Traffic Channel ID In
Hex

5

ID for the originating Traffic Channel.

Protocol In ID
Integer

2

Numeric representation of the protocol family for the originating side. These values are specific to the protocols being implemented.

Signal Path ID Out
Hex

5

ID for the terminating Signal Path.

Traffic Channel ID Out
Hex

6

ID for the Traffic Channel.

Protocol Out ID
Integer

2

Numeric representation of the protocol family for the terminating side. These values are specific to the protocols being implemented.

Bearer Capabilities
Hex

4

i.e. Voice, 64K Data, etc. Cisco Systems specific format.

Orig. Line Information
Hex

4

Supplied by some protocols
Cisco Systems specific format.

Customer ID
Integer

5

Internal to Cisco Systems.

A.2.10 Measurement Categories

Definition

The measCats.dat table defines measurement categories for the system. A measurement (or counter) is uniquely defined by its measurement category and component identification number. This table includes the measurement category name, units of measure, and associated measurement profile.

Table A-17: measCats.dat Field Formats

Field Name Data Type Max Length Specific Instructions and Exceptions

measCategoryId
integer

8

Table index.

measCategoryName
string

255

[Primary Key]

profileName
text

80

[Foreign Key] measProfs.dat - profileName

measUnits
string

80

Formatted text indicating units of measurement.

measCatDesc
string

80

More verbose description of measurement.

Example A-16: measCats.dat Field Formats

001 "LIF: SES" lifses "occurrences"   
"Line Interface: Severely Errored Seconds"
002 "SC: XMIT FRM TOT"   chX_tot   "frames"   "Sigchan: frames transmitted total"
003 "SC: RCV FRM TOT"   chR_tot   "frames"   "Sigchan: frames received total"

The first example creates a measurement category identified by the short name of "LIF: SES". It points to records in measProfs.dat labeled with lifses. The units are "occurrences". Finally, the description gives more information about the measurement.

Referential Integrity Constraints

Records in this table must not be deleted if the profile name is still in use in the measProfs.dat table.

A.2.11 Measurement Profiles

Definition

The measProfs.dat table defines the profile associated with a particular measurement category. A profile contains information concerning time intervals for reporting measurements. A profile may have many measurement intervals associated with it, but it must have at least one to enable reporting for that profile. The convention is to collect each measurement on 15-minute, 60-minute and 24-hour boundaries. Thus, each measurement defined in measCats.dat will have three entries in measProfs.dat.

Table A-18: measProfs.dat Field Formats

Field Name Data Type Max Length Specific Instructions and Exceptions

sequenceNum
integer

8

Table index. This needs to be unique but otherwise has no significance.

profileName
text

32

[Primary Key]

Related fields and columns:

measCats.dat - profileName

profileId
integer

8

The identification number associated with this profile; this includes all occurrences of a given profile name in this file.

bucketName
text

32

[Foreign key] - buckets.dat bucketName

Example A-17: measProfs.dat Field Formats

001   lifses   1   b_lifses15
002   lifses   1   b_lifses60
003   lifses   1   b_lifses24

These examples show the measurement profiles for a single measurement category. The category is "lifses", which is record number one in measCats.dat. It has three buckets as identified by the "b_" convention for fifteen minutes, sixty minutes, and twenty-four hours.

Referential Integrity Constraints

Records must not be removed from this table because they may be in use by programs. Any bucket names used in this table must already exist in buckets.dat.

A.2.12 Physical Line Interface Files

Definition

The physLineIf.dat table defines line characteristics used by the IO Subsystem to configure cards. Based on the card type, card slot, and line interface identified in the table, the device for the card and the line will be synchronized. The device maps to the Line class present in the object model.

Note In the future it will become necessary to move the card type to a separate table.

Table A-19: physLineIf.dat Field Formats

Field Name Data Type Max Length Specific Instructions and Exceptions

lineCompId

[Primary Key]

Composed of two sub-fields.

lineCompType
hex

4

Type of line component being represented encoded as a 4-digit hex number.

lineCompInstance
hex

4

Instance of the line component type being
represented - This number is significant only
within a specific component type.

cardSlot
integer

1

Unique integer identifying the backplane slot
starting from 1.

cardLIF
integer

1

Line interface on card - Range is 1 to 4.

cardType
text

4

Enter one of the following:

COE1 - CO PRI
K124 - Stratus T1/E1
K112 - Stratus Synchronous V.24, V.35
ITK - ITK T1/E1

signalType
text

4

Enter one of the following:

T1 - ANSI standard Digital Signal 1 T1
CEPT - European E1
V.24 - 64kbps digital or asynchronous analog
V.35 - 64kbps digital

distVal
integer

8

Distance in feet for impedance calculations for T1.

Zero (0) for all other signal types.

format
text

4

Enter one of the following:

NA = Not Applicable

ESF = Extended Super Frame (T1 only)

D4 = Super Frame (T1 only)

CRC4 = E1

line coding
text

4

Enter one of the following:

NA = Not Applicable

AMI = alternate mark inversion (T1 only)

B8ZS = bit stuffing for clear channel (T1 only)

HDB3 = E1

cardSpecs
text

8

(Reserve for future use)

Default = standard

NTT = specific Japanese variant for timers

Example A-18: physLineIf.dat Field Formats

00060001   1   1  NEB1   CEPT   0   CRC4   
HDB3   DEFAULT

In this example, the line component ID number is 00060001. The NEB1card is in slot number 1 with a line interface of 1. It is a CEPT-E1 signal type and has a distance value of 75 feet. It is formatted for CRC4-E1 and coded for HDB3. The cardSpecs is set to the standard default.

Additional Information

For cards that do not require line format, line coding values can set these fields to NA (not applicable). It is important to remember that card slot and LIF both start from 1.

A.2.13 Processes

Definition

The processes.dat file contains information about every process on the system that TransPath system is responsible for monitoring. Three different monitoring levels are offered:

a

Active process. Process identified in the record, which is controlled and monitored directly by the process manager.

p

Passive process. Process identified in the record which does not communicate with the Process Manager.

m

Monitoring process. Periodically runs an executable or script and sets or clears an alarm based on the return code. This type of process may monitor other processes or tasks that can be checked programmatically. For example, the amount of disk space, system daemon existence, and established process dependency.

Additionally, the file holds information related to how often to check a processes' health and information about how to restart it.

Table A-20:

Field Name Data Type Max Length Specific Instructions and Exceptions

procName
string

80

[Primary Key]

Related fields and columns:

dependencies.dat -depName or
depcyName

procType
text

1

Valid text characters:

a=active

p=passive

m=monitored

procGroup
string

80

Related fields and columns:

procGroups.dat - groupName
components.dat - compInstName
dependencies.dat - depName or depcyName

almCategoryName
string

80

Related fields and columns:

alarmCats.dat - alarmCategoryName

componentId

For Monitor Procs: The Component ID used to create the alarms for this process. For Active or Passive Procs, alarms are created for the process component ID attribute, which is always ignored. The componentId is composed of two sub-fields.

compType
hex

4

Related fields and columns:

compTypes.dat -compTypeId
components.dat - compType

compInstance
hex

4

Related fields and columns:

components.dat - compInstance

initState
text

1

Defines the desired initial state of this process - It must be one of the following:

r = running

l = locked

c = cutover

chkInterval
integer

8

Health check interval determines the following based on the process type.

Active processes: Frequency of confirming existence by O/S and a positive confirmation from IPC heart-beat.

Passive processes: Frequency of confirming existence by O/S.

Monitor processes: Frequency of running the monitoring script or executable.

chkTimeout
integer

8

Enter how long to wait (in seconds) after health check before beginning error handling and restart procedures.

killGrace
integer

8

For a forced exit, enter how long to wait (in seconds) after sending termination signal before sending kill signal.

autoStart
text

1

The text must be one of the following:

Y = Start process automatically by procM when procM starts up.

N = Start process only on explicit command.

autoDelay
integer

8

The amount of time after the procM starts up to delay a processes' startup:

If = zero, always start when procM starts

If > zero, delay restart for that period of time Cannot be < 0.

maxRestarts
integer

8

This is the number of times within restart period to attempt restarting this process:

If = zero, never

If < zero, always

If > zero, restart that number of times in restart period

rstrtPeriod
integer

8

If > zero, number of seconds in the process restart period (i.e. process won't be restarted after maxRestarts, if it is still within the restart period);

If = zero, process always restarts

rstrtDelay
integer

8

Number of seconds to wait after a startup failure before attempting to restart; may = zero.

rstrtDecay
integer

8

Number of seconds to add to rstrtDelay after each restart; may = zero

cmdLine
string

80

Command line (w/arguments) used to start this process

SNMP-01

SNMP Agent. For example:

0003000E

MOOS

Manual out-of-service alarm category to signal for this process. There are three Alarm categories for this alarm:

MAJOR M-OOS

MINOR M-OOS

PROCM M-OOS

process.dat Field Formats
Example A-19: processes.dat Field Formats

"CFM-01" a "XEG-01" "SOFT_REQ" 0 r 30 5 10 
Y 0 4 120 5 5 "../bin/cfgM"
"ALM-01" a "XEG-01" "SOFT_REQ" 0 r 60 5 10 Y 0 4 120 5 5 "../bin/almM"
"DSKM-01" m "PFMG-01" "DISK" 00040003 r 60 5 5 Y 0 4 120 5 4 "../local/diskmonitor.sh"

The above is a Relative path name. This example defines several processes to the system, two active and one monitor process. The two actively managed processes are part of the XEG-01 process group and the monitor process is part of the Platform group, PFMG-01. An alarm of Software - Required, or "SOFT REQ", is reported on failure of the two active processes. An alarm of "DISK" is reported for the monitor process on the component ID of 00040003. The system translates this value to a symbolic name when reporting.

Restart and health checking options in place for this process are as follows:

Step 1 Perform health checks on this process every 30 or 60 seconds.

Step 2 If process does not respond to a health check within five seconds, begin error procedures.

Step 3 When terminating this process, allow ten seconds for it to respond before sending a kill signal.

Step 4 Do not wait before starting this process after the Process Manager comes up.

Step 5 Attempt to restart this process no more than four times within a restart period of two minutes.

Step 6 Wait five seconds after attempting a restart before attempting another one.

Step 7 Add five more seconds each time the process does not restart after the initial five seconds.

Referential Integrity Constraints

Before adding records to this table, existence verification must be performed to ensure that the following files exist:

procName exists in components.dat
procGroup exists in procGroups.dat
componentId exists in components.dat and compTypes.dat
almCategoryName exists in alarmCats.dat

Records may not be deleted from this file if entries still exist for this process in dependencies.dat.

A.2.14 Process Groups

Definition

The file procGroups.dat contains an entry for each TransPath system managed process group on the system. Information is included indicating whether the Process Manager must automatically start this group and what delay must be involved.

Table A-21: procGroups.dat Field Formats

Field Name Data Type Max Length Specific Instructions and Exceptions

groupName
string

80

[Primary Key]

components.dat - compInstName

Related fields and columns:

dependencies.dat - depName or depcyName

autoStart
text

1

Text character must be one of the following:

Y = Start proc group when procM starts.

N = Start proc group only on an explicit command.

autoDelay
integer

8

Enter the amount of time, in seconds, to delay automatic start-up. If this is set to zero (0), then the Process Manager starts the Process Group as soon as possible.

Example A-20: procGroups.dat Field Formats

"XEG-01" Y 0
"ENGG-01"Y 0
"IOSG-01"Y 0

This example defines three of the many process groups in the system. When the Process Manager comes up, it will automatically start these process groups without any delay.

Referential Integrity Constraints

Records must exist for this process group in the components.dat table before this record may be used. Records must not be deleted from this table if they are referenced in the dependencies.dat table.

A.2.15 Services

Definition

The services.dat table defines the logical services supported by the TransPath system platform. Every process or process group communicates and identifies a desired service and opens an IPC to that service. The component at the other end of the IPC provides a capability to the requesting process. As an example, the service could be measurement handling or alarm reporting.

Table A-22: services.dat Field Formats

Field Name Data Type Max Length Specific Instructions and Exceptions

servicesName
text

32

[Primary Key]

Identifies the service.

servicesId
integer

1

Table index - This needs to be unique but otherwise has no significance.

ipcKind
text

1

IPC Kind - This text character must be one of the following:

p = named pipe (FIFO), or

t = stream device

accessPerm
text

2

The only supported value is the following:

rw = read-write

ipcDevice
text

255

Location of the IPC device in the file system.

format
text

1

Optional. Text character must be one of the following:

r = raw

f = XE - formatted (default for backward compatibility)
Note See additional information on "tokens".

Example A-21: services.dat Field Formats

ProcessManagement

1 p rw ../var/procM_input

ProcessManagement_hi_pri

2 p rw ../var/procM_hp_input

ConfigManagement

3 p rw ../var/cfgM_input

The above is a Relative path name. The first example identifies the Process Management function, and the service identification. The IPC is a pipe and the access permission granted is read-write. The directory path to the IPC device is ../var/procM_input.

Referential Integrity Constraints

Corresponding records must exist in components.dat.

Additional Information


`tokens`	For Stream devices, the format field may be followed by a set of tokens. Each token is interpreted as the name of a Module to be pushed into the stream. If any module names are specified, then the format field should be present.

A.2.16 Signaling Path

Definition

The sigPath.dat file defines, for each signaling path on the system, its associated parameters. These include the symbolic protocol to use for that signaling path, whether that path is connected to the network or user side, whether the path is the `a' or `b' side (only for DPNSS), and profile, and ASP (Auxiliary Signalling Path) participation.

This file currently uses the Signal Path component instance as the key. The key must be expanded to the full component ID to differentiate between FAS signal paths and C7 destination point codes.

Table A-23: sigPath.dat Field Formats

Field Name Data Type Max Length Specific Instructions and Exceptions

sigPathId
hex

4

[Primary Key]

[Foreign Key]:

components.dat - componentsId
Related fields:

bearChan.dat - sigPathId

protocolFamily
text

80

Restrict to one of the following:

ISDNPRI
C7
DPNSS
CAS
S7

mdoFile
string

32

Basename of the MDL object file to load for this sigPath.

VNETId
string

4

Virtual network identification characters formerly called the Closed User Group. When defining the VNETId, the values accepted for this field within sigpath.dat, depends on the usage of the D channel. For example, an origination non-customer side D channel of a traffic path should have a value of 0000 or the ASC (Auxiliary Signaling Channel) functionality will not work.

VNETtbl
(For VNETtbl values, please see the Product Distribution Notes, Section 8.1.2)
integer

4

Four-digit table index used to define the VNET characteristics:

First 2 digits = on-net supports features between customers on the same VNET.

ON-NET is a call with ASP (Auxiliary Signaling Path) capabilities to a customer with the same VNETId.

Second 2 digits = off-net supports features between customers on different VNETs or non-VNET calls.

OFF-NET is an ASP call with different VNETId of a non-ASP call.

swType
integer

1

Integer representing switch type; use to differentiate between minor differences in switch implementations of a particular protocol.

Valid values are based on the corresponding MDL object file in the record. However, a value of zero (0) in this field means there is no switch-specific logic knowledge for the signaling path.

The following are current valid values:

05 BTNUP

17 5ESS

22 NI2

26 DPNSS

27 NET5

29 QSIG MASTER

30 QSIG SLAVE

side
text

7

Q.931 call model side. The following are valid values:

user = User side

network = Network side

This field is ignored for DPNSS.

A/Bflag
text

1

SpecifiesDPNSS `a' or `b' side

Valid values:

a = a side

b = b side

n = not applicable.

Field is ignored for ETSI. If this field does not string match one of the values, it fails.

o/e
integer

1

Overlap/enblock digit collection indicator. The following are valid values:

0 = enblock signaling

1 = channel sends overlap signaling

2 = channel expects overlap signaling

3 = channel sends and receives overlap signaling

o/e
integer

1

Overlap/enblock digit collection indicator. The following are valid values:

0 = enblock signaling

1 = channel sends overlap signaling

2 = channel expects overlap signaling

3 = channel sends and receives overlap signaling

ovl_min
integer

2

Minimum number of digits to collect - Default is zero.

ovl_max
integer

2

Maximum number of digits to collect.

Default is 28. "Host Computer Systems Operation.".

cr_len
integer

1

Preferred call reference length - The following are valid values:

0 = DPNSS (not applicable)

1 = 1 byte call reference (our NT switch)

2 = 2 byte call reference (standard ETSI - default)

prof_Id
text

4

Use to identify the sigPath properties record -

This field has a fixed length of four characters:

the first two characters signify on-net,

the second two characters signify off-net.

prof_Id
text

4

Use to identify the sigPath properties record -

This field has a fixed length of four characters:

the first two characters signify on-net,

the second two characters signify off-net.

ASP_part
text

1

The text character must be one of the following:

Y = Use ASP

N = Do not use ASP

Example A-22: sigPath.dat Field Formats

1 ISDNPRI   Q931   T123   0   user   n   
0   0   24   2   0101   Y
2 DPNSS   DPNSS   T123   0   user   n   3*   0   24   2   0101   Y

In the first example, the protocol family is ISDNPRI, and the MDL object file is identified as Q931. The VNETId is T123. The next field indicates there is no switch-specific logic. The user side is selected, DPNSS is not applicable. The path is configured for overlap signaling in both the sending and receiving directions. The minimum number of digits to collect is set to the zero default, while the maximum number is set to 24. The call reference length is two bytes, the standard ETSI default. The profile ID, 0101, determines the sigPath properties and characteristics. Finally, the ASP is enabled.

Note *When using DPNSS, the overlap/enblock data field can have a number of values. See the o/e data field description on the previous page.

Referential Integrity Constraints

Records may not be deleted from this table if the signaling path is referenced in bearChan.dat. Corresponding records must exist in components.dat.

Additional Information

The following logic applies to both the ovl_min and ovl_max fields:

1. When both of the ovl_min and ovl_max fields are set to zero, then the values specified in the XECfgParm.dat are used.

2. When ovl_min is greater than the default for ovl_max, then the ovl_min default is used.

3. When ovl_min is greater than ovl_max, then the ovl_max default is used.

4. When ovl_max is greater than the default, then the default is used.

A.2.17 Signaling Channel Devices

Definition

The sigChanDev.dat table relates a signaling channel to a signal path to the supporting channel controller to the lineif (in physlineif.dat) and its timeslot.

The Signaling Link Code (SLC) and Priority are used for C7 and SS7 signaling links.

The Auxiliary Signaling Network connection is included here. Currently, it rides over the native Ethernet connection so the line/timeslot can be anything, they are never looked at. The channel controller must be the Auxiliary Signaling Path (ASP).

Table A-24: sigChanDev.dat Field Description

Field Name Description

Sigchan compId
Component ID of the signal channel.

SLC
Signaling Link Code of the C7 signal channel (link) within a signal path (linkset). This value has a range of 1-16 and must be unique within the linkset.

Prio
Service priority of a C7 link within a linkset. This defines how much message traffic to put on the link to the others. This value has a range of 1-16 and can be duplicated between links. All links with the same priority will have messages sent to them based on round-robin scheduling.

sigPath compId
Component ID of the signal path towards the Engine. For facility associated signaling, this is the destination ID used in sigPath.dat. For non-facility associated signaling (e.g. C7), this is the linkset used for grouping the signaling channels.

Channel Controller compId
Component ID of the line used to carry traffic for the signal channel.

TS ( Timeslot)
64 Kbps timeslot within the line used for the original channel. Depending on line type, there may be 1, 24, or 30 timeslots available for message traffic.

Table A-25: Examples of sigChanDev.dat Field Description

Sigchan CompId Signaling Link Code Prio(rity) Sigpath compId Channel Controller compId Line compId TS (Timeslot)

00100001

0

0

00070001

00030008

00060001

1

00100003

0

1

00080001

0003000C

00060002

0

00100004

1

1

00080001

0003000C

00060002

1

00100005

2

1

00080001

0003000C

00060002

2

00100006

3

1

00080001

0003000C

00060002

3

0010000A

0

0

000E0001

0003000B

0006000A

0

Referential Integrity Constraints

All component IDs must exist in components.dat and be valid for the component type. The Channel Controller component ID must be a recognized channel controller in processes.dat. The line component ID must be a valid line in physLineIf.dat.

A.2.18 Routes

Definition

The routes.dat file defines all routes used for connecting to Destination Point Codes in a C7 network.

Table A-26: Routes.dat Field Formats

Field Name Description Special Instructions

Route CompId

C7 Route ID

DPC CompId

Destination Point Code

sigPath CompId

Linkset component ID

OPC CompId

Origination Point Code ID

This must be the same for all routes. In the future, the TransPath System will support multiple point codes.

OPC Num

Origination Point Code Number

This is the network recognized ID for the TransPath System. This must be the same for all routes. In the future, the TransPath System will support multiple point codes.

APC Num

Adjacent Point Code Number

This is the network recognized ID for the next hop in a route. For fully associated points, this is the DPC.

Prio

This is the priority of the route to the DPC.

Table A-27: Examples of Routes.dat Field Formats

Route CompId DPC CompId Sig Path CompId OPC CompId OPC Num APC Num Prio

00110002

00130003

00080002

00130001

0.028.1

0.031.1

1

00110003

00130002

00080003

00130001

0.028.1

10.27.2

1

Referential Integrity Constraints

The component IDs must exist in components.dat. The destination point codes must exist in dpc.dat. The linkset must exist in sigChanDev.dat.

A.2.19 Configuration Properties

Definition

The properties.dat file defines values for configurable entities within the TransPath system. These entities may be equipment, circuits, protocols, or software. The configuration tool generates a file called properties.dat. The data in this file pertains to both the IO Subsystem and the Engine Subsystem.

The properties.dat file tables, which show the file field formats, are provided in "Configuration Properties." These tables are organized by protocol: BTNUP, DPNSS, ISDNPRI, ISDNPRI NI2, SS7/C7, and SS7/S7. The tables are followed by examples and referential integrity constraints.

A.2.20 Tables

Definition

The tables.dat file contains numeric identification and UNIX path names for all TransPath System configuration tables.

Table A-28: tables.dat Field Formats

Field Name Data Type Max Length Specific Instructions and Exceptions

tableName
text

32

[Primary Key]

Actual table names minus the .dat extension.

tableNumber
Integer

8

Table index - This needs to be unique but otherwise has no significance.

tablePath
text

255

Enter the UNIX path name for this table.

Example A-23: tables.dat Field Formats

alarmCategories

1

../etc/alarmCats.dat

componentTypes

2

../etc/compTypes.dat

components

3

../etc/components.dat

The above is a Relative path name. This example shows three of the many configuration tables identified in tables.dat. These configuration tables are identified by tableName, tableNumber, and tablePath in the subdirectory.

Referential Integrity Constraints

Entries must exist for all TransPath system configuration files defined in this document.Additionally, an entry must exist for the services.dat table (not described in this guide).

A.2.21 Thresholds

Definition

The thresholds.dat file defines all floor and ceiling thresholds used in TransPath system. Each threshold has a type associated with it and information on the alarm category to use when that threshold is crossed.

Table A-29: thresholds.dat Field Formats

Field Name Data Type Max Length Specific Instructions and Exceptions

sequenceNum
integer

4

Table index - This needs to be unique but otherwise has no significance.

thresholdName
text

32

[Primary Key]

Related fields and columns:

buckets.dat- thresholdName

thresholdType
text

1

Specifies the type of threshold. Valid values are:

F = floor

C = ceiling

thresholdValue
integer

8

Specifies the number of occurrences in order to trigger the threshold crossing. If this is zero then the threshold is disabled; otherwise, it is enabled.

almCategory
string

80

[Foreign key]: alarmCats.dat - almCategoryName

If this is a null string (" "), then no alarm is generated.

Example A-24: thresholds.dat Field Formats

003      T_lifeses24   C   200   "LIF SES 
24"
004      T_chR_btot15   C   100   "CHAN BAD TOT 15"
016      T_dlRR_estb15   C   10   "CHAN LINK ESTAB 15"

These examples define thresholds identified in buckets.dat by the Threshold Name. The first record shows that if T_lifses24 crosses over 200, the alarm with the name of "LIF SES 24" is generated. This example shows that the measProf.dat and bucket.dat files measure Line Interface Severely Errored Seconds over a 24-hour period.

: Identifies the DPNSS call model side as either a or b. This field is ignored by ETSI.

accessPerm

: Access Permission

alarmCats.dat

: Name of the file where all alarms are stored - Each alarm is identified by the following: almCategoryId, almCategoryName, severity, reportedFlag, formatString, almdescription.

AlmCategory

: Alarm category used when a threshold is crossed. See Alarm Categories.

AlmCategoryId

: Unique identification number for an alarm category - This is a Primary key field.

AlmCategoryName

: Unique name of an alarm category - It is a Primary key field.

AlmCategoryName

: Alarm category used for this process. See alarmCats.dat - alarmCategoryName.

almdescription

: Describes the type of failure

ASPId

: Unique identification number for the auxiliary signal path interface for a network - This is a Primary key field.

ASP_part

: Field used to select whether the auxiliary signal path is to be used or not.

AutoDelay

: Value expressing the amount of time after the procM starts up to delay a processes' startup. Amount of time after the procM starts up to delay a process group startup.

AutoStart

: Automatic startup of a process - It determines whether a process starts up automatically when the procM starts up or the process starts only on explicit command.

AuxSigPath.dat

: The auxSigPath.dat table contains all auxiliary signal path (ASP) interfaces for a network, including the local network. As a result, it can be replicated on every machine.

B

bearChan.dat

: File which defines the mapping between bearer channels implemented on the MUX attached to TransPath system. A bearer channel is uniquely defined by combining the associated signal path with the corresponding bearer channel.

bearChanId

: Unique Bearer Channel identified for mapping within sigPathId.

bucket

: Generic container for storing a measurement - Each measurement defined in measProfs.dat has only one bucket.

bucketId

: Numeric identifier of the corresponding record in measCats.dat. Each measurement in measCats.dat may have one or more buckets.

bucketName

: Unique identifier for the bucket.

buckets.dat

: The buckets.dat data file defines measurement buckets/intervals with associated thresholds. A bucket may have up to two (floor and ceiling) thresholds associated with it.

C

callModel

: Timer values and characteristics of far-end switch type (this field is reserved for future use).

callreflen

: Call reference length.

card

: Represents the card that the channel is associated with.

cardSlot

: Unique integer identifying the backplane slot.

cardType

: Field which identifies the type of card being used. For example, NBE1-E1, K124, K112, etc.

chanCtlCompId

: Channel Controller Component ID - Field which identifies the channel controller component ID number.

chan

: Channel within the line (1-31).

chkInterval

: Health Check Interval which determines the following:
: Active Procs - How often to confirm existence by O/S, and a positive confirmation from IPC heartbeat.
: Passive Procs - How often to confirm existence by O/S.
: Monitor Procs - How often to run the monitoring script or executable.

chkTimeout

: Health Check Time-out - Determines how long to wait (in seconds) after health check before beginning error handling and restart procedures.

CloseSinkDir

: Place completed files in this directory after they have been closed.

Closed User Group

: CUG is no longer used (see VNETId).

cmdLine

: Command line (w/arguments) used to start a process.

coding

: Field in the phyLineIF.dat file used to identify coding characteristics information for T1.

compDescription

: Description of the component instance is used as a comment.

compInstance

: Hex number representing the instance number for this process as defined in components.dat.

compInstName

: Unique name of this component instance.

componentId

: Identifies the component type and component instance in hexadecimals.

componentId

: For Monitor Procs: The Component ID used to create the alarms for this process.
: For Active or Passive Procs: Alarms always created for the process component ID attribute and are always ignored.

components.dat

: The components.dat file defines the type of component, instance for that component type, and the related parent component information.

compType

: Hex number representing the "process" component type as defined in components.dat.

compTypeDescription

: Description of the component type.

compTypeId

: Unique hex identification number for the component type.

compTypeName

: Unique name for the component type.

compTypes.dat

: The compTypes.dat file contains an identification number, name, and description for each type of component in the system.

cr_len

: Preferred call reference length.

CUG

: Closed User Group (see VNETId).

D-E

depcyName

: Dependency Name is the process or process group on which this entry's dependent depends.

depcyType

: Dependency Type indicates whether this entry's dependency is a process or process group.

dependencies.dat

: The dependencies.dat file controls the order in which the Process Manager starts and stops processes and groups.
: Dependencies may be established that prevent certain processes or process groups from starting either before another process or group or before other processes and/or groups. A command to start a process or group does not cause the process or group to start until all of its dependencies are active. The command does not fail; it is just deferred until after the dependencies are started up.

depName

: Dependent Name is the dependent process or process group. This is a foreign key to the components table.

depType

: Dependent Type indicates whether this entry's dependent is a process or process group.

distVal

: The Distance Value - Use only for T1. This is the distance in feet for impedance calculations.

dmprSink.dat

: File which controls the behavior of the data dumper for each type of data that it handles.

F-G-H

fifo/socket

: FIFO location or Socket Address.

format

: Line format field in the phyLineIF.dat file used to provide further line characteristics information, such as: NA = Not Applicable, ESF = Extended Super Frame (T1 only), D4 = Super Frame (T1 only), CRC4 = E1.

formatString

: Displays the type of failure.

groupName

: Process group name.

I-K-L

initState

: Specifies the desired initialization state of the process. Initial Proc State defines the requested initial state of this process.

interval

: Assigned collection period for the bucket in seconds. At the end of the period, the bucket is processed and reset.

IPAddress

: Internet Protocol Address is a Primary key field that contains the "instance number" of the Network Element ID for a specific TransPath system.

IPPort

: Internet Protocol Port.

ipcKind

: IPC Kind - This text character must be one of the following:
: p = named pipe (FIFO)
: t= stream

ipcDevice

: Directory path to the IPC device in the file system.

killGrace

: For a forced exit, how long to wait (in seconds) after sending termination signal before sending kill signal.

lif

: Represents the line interface on the card which terminates the line.

line

: Logical line associated with the line interface.

lineCompId

: Unique line component identification number.

lineCompInstance

: Instance of the line type being represented. Encoded as a four-digit hex number.

lineCompType

: Type of line component being represented. Encoded as a four-digit hex number.

M-N

mateBearChanId

: Unique Bearer Channel identified for mapping within sigPathId.

matesigPathId

: Identifies which time slot controls the bearer channel paired with sigPathId and bearChanId.

maxRecs

: Maximum number of records a file is allowed to contain.

maxRestarts

: Value expressing the maximum number of times within the restart period to attempt restarting this process.

maxSize

: Maximum size that a file is allowed to grow to in K.

maxTime

: Maximum time a file is allowed to remain open in minutes.

mdoFile

: The basename of the mdo file to load for this sigPath.

measCatDesc

: Description of this measurement category.

measCategoryId

: Unique identification number for this measurement category. Name of the measurement category. Expressed in the following format: measCategoryId

measCats.dat

: The measCats.dat table defines measurement categories to the system. A measurement (or counter) is uniquely defined by its measurement category and component identification number.

measProfs.dat

: The measProfs.dat table defines the profile associated with a particular measurement category.

measUnits

: Descriptor associated with each category used to define the type of units measured. For example, erred frames.

O

o/e

: Overlap/enblock digit collection indicator.

openSinkDir

: Files that are open and being written to are in this directory.

ovl_max

: Represents the maximum number of digits to collect.

ovl_min

: Represents the minimum number of digits to collect.

P

parentCompId

: Identifies the parent component ID in hexadecimals.

parentCompInst

: Hex number represents the instance to which this component is being referred.

parentCompType

: Hexadecimal number refers to the parent component type.

physLineIf.dat

: The physLineIf.dat table defines line characteristics used by the IO Subsystem to configure cards.

Process Groups

: These are TransPath system managed process groups on the system. The Process Manager automatically starts this group and determines what length delay is used.

Process Manager (PM)

: Subsystem managing applications running on the TransPath system platform. Applications consist of one or more operating system processes managed as a group. Each application can be managed independently of the others.
: PM starts and shuts applications and their processes in an orderly manner; monitors the health of managed processes, and manages transitions so that processes can be replaced without interrupting the services provided by an application.
: PM receives commands from Command Management. The primary sources of commands are the Management Interface and the Configuration Management subsystems. These commands can target individual processes or an entire application. Any application process can request that another process be started and managed by PM.
: Subsystem starts applications in an orderly manner. Processes within an application are started based on a defined dependency order.
: Each process is given an opportunity to perform its finalization. If the process does not exit within a defined time interval, the Process Manager may force it to exit through the operating system.

processes.dat

: The processes.dat file contains information about every process on the system that TransPath system is responsible for monitoring.

procGroup

: Name of the process group that this process belongs to.

procGroups.dat

: File containing an entry for each TransPath system managed process group on the system. Information is included indicating whether the Process Manager must automatically start this group and what delay must be involved.

procName

: Name of the process - It is used by the Man Machine Language (MML).

procType

: Defines the relationship between the process and the Process Manager. It indicates how closely the Process Manager monitors the process.

profileId or profId

: Identification number associated with a profile - It includes all occurrences of a given profile name in this file.

ProfileName

: Name of the profile associated with a measurement category - This is the name of profile to associate with a bucket.

properties.dat

: The file containing configuration options and their field values.

protocolFamily

: Identifies the protocol family column of values.

protocolName

: Defines the protocol to run on the signaling path.

R

reportedFlag

: Sets a flag to report an alarm or not to report an alarm.

rstrtDecay

: Value expressing the number of seconds to add to rstrtDelay after each restart. It may equal zero.

rstrtDelay

: Value expressing the number of seconds to wait after a startup failure before attempting to restart. This value may equal zero.

rstrtPeriod

: Value expressing the number of seconds in the process restart period.

S

sequenceNum

: Unique integer identification number of a record - It is the unique identifier for this threshold.

services.dat

: The services.dat file contains information about the processes used to request a service: ID, name, state, severity, and side.

servicesId

: Unique integer identification of this service.

servicesName

: Unique string for a provided service - A process uses this to request a service.

serviceStat

: Desired service state of the signaling channel - It defines whether the signaling path is to attempt to provide service or not.

severity

: Determines whether the failure is reported or not reported.

side

: Identifies the Q.931 call model side as either user or network.

sigChanDev.dat

: The sigChanDev.dat table is an interim table used to configure the Cisco IOS software. This table relates a signaling channel to a controller.

sigPath.dat

: The sigPath.dat file defines, for each signaling path on the system, their associated parameters.

sigPathCompId

: Signal Path Component ID - Primary key field. This identifies the signaling path component ID number.

sigPathId

: Signal path ID identifies the time slot ID for the D-channel from the MUX that is controlling the associated bearer channel; this reflects an `instance' of the component type "signaling channel". This is the unique identifier for this signaling path corresponding to the instance number of the signaling path component type.

signalType

: Type of electrical signal on a line, interface - Current values are DSI, CEPT (E-1), V.35 and V.24.

sinkFmt

: Output format of the dumper. Currently it is either a comma-separated value text string or an internal binary format.

sinkId

: Unique table index.

sinkName

: Type of record being dumped.

sinkPrefix

: Files are created with this prefix to the name.

string

: A series of alphanumeric characters and white-space characters. A string is surrounded by a double quote on the left and right-hand sides ( " " ). Text can be up to 255 characters but recommended to be no more than 80 for readability.

swType

: Switch type- Identifies switch models and variants by a unique numeric value. The type is numeric so that new values can be created and passed to the Cisco IOS channel controllers and MDL files without needing changes to the sigPath XETable class that reads and interprets the file.

T-Z

tableName

: Represents one of the valid TransPath system table names (the section names in this document are the actual table names minus the .dat).

tableNumber

: Represents the integer identification of this table.

tablePath

: UNIX path name for this table.

tables.dat

: File containing numeric identification and UNIX path names for all TransPath system configuration tables.

thresholdName

: Name of a threshold for a bucket - This is a foreign key to the thresholds table.

thresholds.dat

: The thresholds.dat file defines all floor and ceiling thresholds used in TransPath system. Each threshold has a type associated with it and information on the alarm category to use when that threshold is crossed.

thresholdType

: There are two types of thresholds: Floor or ceiling.

thresholdValue

: Threshold value is the setting for the number of occurrences (times) that the threshold is crossed.

VNETId

: Virtual network identification characters formerly called the Closed User Group (CUG).

VNETtbl

: A four digit table index used to define which supplemental VNET features are allowed:
: First 2 digits = on-net. Supports features between customers on the same VNET.
: Second 2 digits = off-net Supports features between customers on different vnets or non-VNET calls.

x.121Addr

: The x.121 address used to identify the NE across an X25 Network.

Field Name	Data Type	Max Length	Comments
`ReleaseLevel`	Integer	3	This describes format of records.
`TimeStamp`	Integer	10	This is the time when record was written to log.
`State`	Integer	1	`1` if the alarm is active, `0` if the alarm is clear. For informational alarms, this is always set to `1`.
`Severity`	Integer	1	This is alarm severity. See `alarmCats.dat` for values.
`AlarmCat`	String	80	This is the name of the alarm category (see `alarmCat.dat`).
`ReleaseLevel`	Integer	3	This describes format of records.
`TimeStamp`	Integer	10	This is the time when record was written to log.
`State`	Integer	1	`1` if the alarm is active, `0` if the alarm is clear. For informational alarms, this is always set to `1`.
`Severity`	Integer	1	This is alarm severity. See `alarmCats.dat` for values.
`AlarmCat`	String	80	This is the name of the alarm category (see `alarmCat.dat`).
`ComponentName`	String	32	This is the component on which the alarm occurred (see `components.dat`).
`Originator`	String	32	This is the service that set or cleared this alarm (see `services.dat`.)

Field Name	Data Type	Field Length	Comments
`ReleaseLevel`	Integer	3	Describes format of records
`IntervalStarted`	Integer	10	When measurement interval started using `timeStamp` format.
`IntervalSeconds`	Integer	5	Duration of collection interval in seconds.
`MeasValue`	Integer	10	Value of the measurement at the end of the interval.
`MeasUnits`	String	32	Units for which the measurement is recorded.
`MeasCat`	String	32	Measurement category (see `measCats.dat`).
`ComponentName`	String	32	Component for which the measurement was being collected (see `components.dat`).

Field Name	Data Type	Field Length	Comments
`Revision Level`	Integer	3	Describes format of records.
`Pre-trans. CLI Type Indicator`	Integer	1	Indicates whether Calling Line Identification (CLI) was present. `1` = present `0` = not present
`CLI - pre-translated`	String	32	CLI prior to any translation performed by the TransPath System.
`Dialed Number Pre-translation Indicator`	Integer	1	Indicates whether the Dialed Number was present. `1` = present `0` = not present
`Dialed Number - pre-translation`	String	32	Dialed number prior to any translation performed by the TransPath System.
`Post-trans. CLI Indicator`	Integer	1	Indicates whether a translated CLI is present. `1` = present `0` = not present
`CLI - post-translation`	Integer	32	CLI after any translations performed by the TransPath System.
`Post-trans. Dialed Number Indicator`	Integer	1	Indicates whether a translated Dialed Number was present. `1` = present `0` = not present
`Dialed Number - Post-translation`	String	32	Dialed Number after any translations performed by the TransPath System.
`Setup message timestamp`	Integer	10	Time when the initial setup message was received.
`Line seizure occurred timestamp`	Integer	10	Time when the line was seized.
`Answer supervision received timestamp`	Integer	10	Time when the call was answered. (if applicable)
`Disconnect message timestamp`	Integer	10	Time when call ended (if applicable).
`Direction of disconnect`	Integer	1	Side of the call that disconnected first. `0` = originating side `1` = terminating side
`Release code`	Hex	4	Cisco Systems specific format.
`Signal Path ID In`	Hex	8	ID for the originating Signal Path.
`Traffic Channel ID In`	Hex	5	ID for the originating Traffic Channel.
`Protocol In ID`	Integer	2	Numeric representation of the protocol family for the originating side. These values are specific to the protocols being implemented.
`Signal Path ID Out`	Hex	5	ID for the terminating Signal Path.
`Traffic Channel ID Out`	Hex	6	ID for the Traffic Channel.
`Protocol Out ID`	Integer	2	Numeric representation of the protocol family for the terminating side. These values are specific to the protocols being implemented.
`Bearer Capabilities`	Hex	4	i.e. Voice, 64K Data, etc. Cisco Systems specific format.
`Orig. Line Information`	Hex	4	Supplied by some protocols Cisco Systems specific format.
`Customer ID`	Integer	5	Internal to Cisco Systems.

Field Name	Data Type	Max Length	Specific Instructions and Exceptions
`measCategoryId`	integer	8	Table index.
`measCategoryName`	string	255	[Primary Key]
`profileName`	text	80	[Foreign Key] `measProfs.dat - profileName`
`measUnits`	string	80	Formatted text indicating units of measurement.
`measCatDesc`	string	80	More verbose description of measurement.

Field Name	Data Type	Max Length	Specific Instructions and Exceptions
`sequenceNum`	integer	8	Table index. This needs to be unique but otherwise has no significance.
`profileName`	text	32	[Primary Key] Related fields and columns: `measCats.dat - profileName`
`profileId`	integer	8	The identification number associated with this profile; this includes all occurrences of a given profile name in this file.
`bucketName`	text	32	[Foreign key] - `buckets.dat bucketName`

Field Name	Data Type	Max Length	Specific Instructions and Exceptions
`lineCompId`			[Primary Key] Composed of two sub-fields.
`lineCompType`	hex	4	Type of line component being represented encoded as a 4-digit hex number.
`lineCompInstance`	hex	4	Instance of the line component type being represented - This number is significant only within a specific component type.
`cardSlot`	integer	1	Unique integer identifying the backplane slot starting from 1.
`cardLIF`	integer	1	Line interface on card - Range is `1` to `4`.
`cardType`	text	4	Enter one of the following: `COE1 - CO PRI` `K124 - Stratus T1/E1` `K112 - Stratus Synchronous V.24, V.35` `ITK - ITK T1/E1`
`signalType`	text	4	Enter one of the following: `T1 - ANSI standard Digital Signal 1 T1` `CEPT - European E1` `V.24 - 64kbps digital or asynchronous analog` `V.35 - 64kbps digital`
`distVal`	integer	8	Distance in feet for impedance calculations for T1. Zero (0) for all other signal types.
`format`	text	4	Enter one of the following: `NA` = Not Applicable `ESF` = Extended Super Frame (T1 only) `D4` = Super Frame (T1 only) `CRC4` = E1
`line coding`	text	4	Enter one of the following: `NA` = Not Applicable `AMI` = alternate mark inversion (T1 only) `B8ZS` = bit stuffing for clear channel (T1 only) `HDB3` = E1
`cardSpecs`	text	8	(Reserve for future use) `Default` = standard `NTT` = specific Japanese variant for timers

`a`	Active process. Process identified in the record, which is controlled and monitored directly by the process manager.
`p`	Passive process. Process identified in the record which does not communicate with the Process Manager.
`m`	Monitoring process. Periodically runs an executable or script and sets or clears an alarm based on the return code. This type of process may monitor other processes or tasks that can be checked programmatically. For example, the amount of disk space, system daemon existence, and established process dependency.

Field Name	Data Type	Max Length	Specific Instructions and Exceptions
`procName`	string	80	[Primary Key] Related fields and columns: `dependencies.dat -depName or` `depcyName`
`procType`	text	1	Valid text characters: `a`=active `p`=passive `m`=monitored
`procGroup`	string	80	Related fields and columns: `procGroups.dat - groupName` `components.dat - compInstName` `dependencies.dat - depName` or `depcyName`
`almCategoryName`	string	80	Related fields and columns: `alarmCats.dat - alarmCategoryName`
`componentId`			For Monitor `Procs`: The Component ID used to create the alarms for this process. For Active or Passive `Procs`, alarms are created for the process component ID attribute, which is always ignored. The `componentId` is composed of two sub-fields.
`compType`	hex	4	Related fields and columns: `compTypes.dat -compTypeId` `components.dat - compType`
`compInstance`	hex	4	Related fields and columns: `components.dat - compInstance`
`initState`	text	1	Defines the desired initial state of this process - It must be one of the following: `r` = running `l` = locked `c` = cutover
`chkInterval`	integer	8	Health check interval determines the following based on the process type. Active processes: Frequency of confirming existence by O/S and a positive confirmation from IPC heart-beat. Passive processes: Frequency of confirming existence by O/S. Monitor processes: Frequency of running the monitoring script or executable.
`chkTimeout`	integer	8	Enter how long to wait (in seconds) after health check before beginning error handling and restart procedures.
`killGrace`	integer	8	For a forced exit, enter how long to wait (in seconds) after sending termination signal before sending kill signal.
`autoStart`	text	1	The text must be one of the following: `Y` = Start process automatically by `procM` when `procM` starts up. `N` = Start process only on explicit command.
`autoDelay`	integer	8	The amount of time after the `procM` starts up to delay a processes' startup: If = zero, always start when `procM` starts If > zero, delay restart for that period of time Cannot be < 0.
`maxRestarts`	integer	8	This is the number of times within restart period to attempt restarting this process: If = zero, never If < zero, always If > zero, restart that number of times in restart period
`rstrtPeriod`	integer	8	If > zero, number of seconds in the process restart period (i.e. process won't be restarted after `maxRestarts`, if it is still within the restart period); If = zero, process always restarts
`rstrtDelay`	integer	8	Number of seconds to wait after a startup failure before attempting to restart; may = zero.
`rstrtDecay`	integer	8	Number of seconds to add to `rstrtDelay` after each restart; may = zero
`cmdLine`	string	80	Command line (w/arguments) used to start this process
`SNMP-01`			SNMP Agent. For example: 0003000E
`MOOS`			Manual out-of-service alarm category to signal for this process. There are three Alarm categories for this alarm: MAJOR M-OOS MINOR M-OOS PROCM M-OOS

Field Name	Data Type	Max Length	Specific Instructions and Exceptions
`groupName`	string	80	[Primary Key] `components.dat - compInstName` Related fields and columns: `dependencies.dat - depName` or `depcyName`
`autoStart`	text	1	Text character must be one of the following: `Y` = Start `proc` group when `procM` starts. `N` = Start `proc` group only on an explicit command.
`autoDelay`	integer	8	Enter the amount of time, in seconds, to delay automatic start-up. If this is set to zero (0), then the Process Manager starts the Process Group as soon as possible.

Field Name	Data Type	Max Length	Specific Instructions and Exceptions
`servicesName`	text	32	[Primary Key] Identifies the service.
`servicesId`	integer	1	Table index - This needs to be unique but otherwise has no significance.
`ipcKind`	text	1	IPC Kind - This text character must be one of the following: `p` = named pipe (FIFO), or `t` = stream device
`accessPerm`	text	2	The only supported value is the following: `rw` = read-write
`ipcDevice`	text	255	Location of the IPC device in the file system.
`format`	text	1	Optional. Text character must be one of the following: `r` = raw `f` = XE - formatted (default for backward compatibility) Note See additional information on "tokens".

`ProcessManagement`	`1 p rw ../var/procM_input`
`ProcessManagement_hi_pri`	`2 p rw ../var/procM_hp_input`
`ConfigManagement`	`3 p rw ../var/cfgM_input`

Field Name	Data Type	Max Length	Specific Instructions and Exceptions
`sigPathId`	hex	4	[Primary Key] [Foreign Key]: `components.dat - componentsId` Related fields: `bearChan.dat - sigPathId`
`protocolFamily`	text	80	Restrict to one of the following: `ISDNPRI` `C7` `DPNSS` `CAS` `S7`
`mdoFile`	string	32	Basename of the MDL object file to load for this `sigPath`.
`VNETId`	string	4	Virtual network identification characters formerly called the Closed User Group. When defining the `VNETId`, the values accepted for this field within `sigpath.dat`, depends on the usage of the D channel. For example, an origination non-customer side D channel of a traffic path should have a value of `0000` or the ASC (Auxiliary Signaling Channel) functionality will not work.
`VNETtbl` `(For VNETtbl values, please see the Product Distribution Notes, Section 8.1.2)`	integer	4	Four-digit table index used to define the VNET characteristics: First 2 digits = on-net supports features between customers on the same VNET. ON-NET is a call with ASP (Auxiliary Signaling Path) capabilities to a customer with the same `VNETId`. Second 2 digits = off-net supports features between customers on different VNETs or non-VNET calls. OFF-NET is an ASP call with different `VNETId` of a non-ASP call.
`swType`	integer	1	Integer representing switch type; use to differentiate between minor differences in switch implementations of a particular protocol. Valid values are based on the corresponding MDL object file in the record. However, a value of zero (0) in this field means there is no switch-specific logic knowledge for the signaling path. The following are current valid values: 05 BTNUP 17 5ESS 22 NI2 26 DPNSS 27 NET5 29 QSIG MASTER 30 QSIG SLAVE
`side`	text	7	Q.931 call model side. The following are valid values: `user` = User side `network` = Network side This field is ignored for DPNSS.
`A/Bflag`	text	1	SpecifiesDPNSS `a' or `b' side Valid values: `a` = a side `b` = b side `n` = not applicable. Field is ignored for ETSI. If this field does not string match one of the values, it fails.
`o/e`	integer	1	Overlap/enblock digit collection indicator. The following are valid values: `0` = enblock signaling `1` = channel sends overlap signaling `2` = channel expects overlap signaling `3` = channel sends and receives overlap signaling
`o/e`	integer	1	Overlap/enblock digit collection indicator. The following are valid values: `0` = enblock signaling `1` = channel sends overlap signaling `2` = channel expects overlap signaling `3` = channel sends and receives overlap signaling
`ovl_min`	integer	2	Minimum number of digits to collect - Default is zero.
`ovl_max`	integer	2	Maximum number of digits to collect. Default is 28. "Host Computer Systems Operation.".
`cr_len`	integer	1	Preferred call reference length - The following are valid values: `0` = DPNSS (not applicable) `1` = 1 byte call reference (our NT switch) `2` = 2 byte call reference (standard ETSI - default)
`prof_Id`	text	4	Use to identify the `sigPath` properties record - This field has a fixed length of four characters: the first two characters signify on-net, the second two characters signify off-net.
`prof_Id`	text	4	Use to identify the `sigPath` properties record - This field has a fixed length of four characters: the first two characters signify on-net, the second two characters signify off-net.
`ASP_part`	text	1	The text character must be one of the following: `Y` = Use ASP `N` = Do not use ASP

Field Name	Description
`Sigchan compId`	Component ID of the signal channel.
`SLC`	Signaling Link Code of the C7 signal channel (link) within a signal path (linkset). This value has a range of 1-16 and must be unique within the linkset.
`Prio`	Service priority of a C7 link within a linkset. This defines how much message traffic to put on the link to the others. This value has a range of 1-16 and can be duplicated between links. All links with the same priority will have messages sent to them based on round-robin scheduling.
`sigPath compId`	Component ID of the signal path towards the Engine. For facility associated signaling, this is the destination ID used in sigPath.dat. For non-facility associated signaling (e.g. C7), this is the linkset used for grouping the signaling channels.
`Channel Controller compId`	Component ID of the line used to carry traffic for the signal channel.
`TS ( Timeslot)`	64 Kbps timeslot within the line used for the original channel. Depending on line type, there may be 1, 24, or 30 timeslots available for message traffic.

Sigchan CompId	Signaling Link Code	Prio(rity)	Sigpath compId	Channel Controller compId	Line compId	TS (Timeslot)
00100001	0	0	00070001	00030008	00060001	1
00100003	0	1	00080001	0003000C	00060002	0
00100004	1	1	00080001	0003000C	00060002	1
00100005	2	1	00080001	0003000C	00060002	2
00100006	3	1	00080001	0003000C	00060002	3
0010000A	0	0	000E0001	0003000B	0006000A	0

Field Name	Description	Special Instructions
Route CompId	C7 Route ID
DPC CompId	Destination Point Code
sigPath CompId	Linkset component ID
OPC CompId	Origination Point Code ID	This must be the same for all routes. In the future, the TransPath System will support multiple point codes.
OPC Num	Origination Point Code Number	This is the network recognized ID for the TransPath System. This must be the same for all routes. In the future, the TransPath System will support multiple point codes.
APC Num	Adjacent Point Code Number	This is the network recognized ID for the next hop in a route. For fully associated points, this is the DPC.
Prio	This is the priority of the route to the DPC.

Route CompId	DPC CompId	Sig Path CompId	OPC CompId	OPC Num	APC Num	Prio
00110002	00130003	00080002	00130001	0.028.1	0.031.1	1
00110003	00130002	00080003	00130001	0.028.1	10.27.2	1

Field Name	Data Type	Max Length	Specific Instructions and Exceptions
`tableName`	text	32	[Primary Key] Actual table names minus the `.dat` extension.
`tableNumber`	Integer	8	Table index - This needs to be unique but otherwise has no significance.
`tablePath`	text	255	Enter the UNIX path name for this table.

`alarmCategories`	`1`	`../etc/alarmCats.dat`
`componentTypes`	`2`	`../etc/compTypes.dat`
`components`	`3`	`../etc/components.dat`

Table of Contents

Data Dictionary and Glossary