SUPPORTING DOCUMENT: PM File Format Definition

PM File Format Definition

Version 3.0

Term Definition Comment

<PMFileFormat> := <TableStructureRecord> <PMDataRecords>n File format defined in BNF like notation.
<TableStructureRecord> := "User Label" <SepChar> "EMS Name" <SepChar> First record describes attribute names of the table.
"EMS Native Name" <SepChar> "ME Name" <SepChar>
"ME Native Name" <SepChar> "PTP Name" <SepChar>
"PTP Native Name" <SepChar> "CTP Name" <SepChar>
"CTP Native Name" <SepChar> "Layer Rate" <SepChar>
"Granularity" <SepChar> "Period Start Time" <SepChar>
"Monitored Time" <SepChar> "PM Parameter" <SepChar>
"Location" <SepChar> "Value" <SepChar> "Unit" <SepChar>
"Status" <SepChar> "Nr Of Periods" <EORChars>
<PMDataRecords> := <DescriptorRecord> [<PMValueRecord>]n Note: Records are terminated by carriage return
<DescriptorRecord> := <UserLabel> <SepChar> <EMSNameValue> <SepChar> Descriptor record for PM records
[<EMSNativeNameValue>] <SepChar> <MENameValue>
<SepChar> [<MENativeNameValue>] <SepChar>
<PTPNameValue> <SepChar> [<PTPNativeNameValue>]
<SepChar> [<CTPNameValue>] <SepChar>
[<CTPNativeNameValue>] <SepChar> <LayerRate>
<SepChar> <Granularity> <EORChars>
<PMValueRecord> := <SepChar>11 <StartTime> <SepChar> [<MonitoredTime>] PM record
<SepChar> <PMParName> <SepChar> <Location> <SepChar> Separators make the file .csv compatible.
<Value> <SepChar> [<Unit>] <SepChar> <Status> <SepChar>
[<NumberOfPeriods>] <EORChars>
<UserLabel> := String userLabel as set by the NMS operation setUserLabel() for
the TP

1 © TeleManagement Forum 2003 MTNM Version 3.0

 SUPPORTING DOCUMENT: PM File Format Definition

<EMSNameValue> := String value of the EMS object name according to

objectNaming.pdf

<EMSNativeNameValue> := String Native EMS name of EMS object

This field may be empty if the native name equals the
object name.
<MENameValue> := String value of the ME part of the ME object name according to
objectNaming.pdf
<MENativeNameValue> := String Native EMS name of ME object
This field may be empty if the native name equals the
object name.
<PTPNameValue> := String value of the PTP part of the name of the containing
PTP/FTP object (if measurement is at the CTP)
or of the PTP/FTP object itself (if measurement
is at the PTP/FTP) according to the PTPName
value in objectNaming.pdf
<PTPNativeNameValue> := String Native EMS name of (containing) PTP/FTP object
This field may be empty if the native name equals the
object name.
<CTPNameValue> := String CTP object name according to the CTPName value in
objectNaming.pdf
This field is empty if the measurement refers to the PTP.
<CTPNativeNameValue> := String Native EMS name of CTP object
This field is empty if the measurement refers to the PTP.
It may be empty if the native name equals the object name.

MTNM Version 3.0 © TeleManagement Forum 2003 2

 SUPPORTING DOCUMENT: PM File Format Definition

<LayerRate> := String TPName and LayerRate define the PM measurement point

(PMP).
This is the string identifier of that integer according to
LayerRates.pdf (e.g., "LR_VT2_and_TU12_VC12").
<Granularity> := String value according to performance::Granularity_T
<StartTime> := String value according to globaldefs::Time_T
Is the period start time of the interval for which data is
being reported. Time is aligned in UTC.
In case of zero-suppression this identifies the start time of
the first record.
<MonitoredTime> := Integer optional, default value empty field if not supported
Gives the number of seconds monitored within the
measurement period. Empty field means that the whole
measurement period is monitored or that information is not
supported at all.
<PMParName> := String value according to performance::PMParameterName_T
(see PerformanceParameters.pdf)
<Location> := String value according to performance::PMLocation_T
<Value> := Float Accounts both gauge and digital values.
<Unit> := String For gauge values this is the unit of the measurement.
For counter values this is empty.
<Status> := "Valid" | "Incomplete" | "Invalid" | "Unavailable" | "Zero- • Valid - valid data for the whole interval.
suppressed" • Incomplete - data available for a part of the
measurement interval (optional - time monitored
given in the monitored time).
• Invalid - data available but marked as invalid for
the interval (when the EMS can not distinguish
incomplete measurements from invalid
measurements, "Invalid" will be used)
3 © TeleManagement Forum 2003 MTNM Version 3.0
 SUPPORTING DOCUMENT: PM File Format Definition

• Unavailable - no data is available for a specified

TP measurement point within the time period.
• Zero-suppressed - optional, means record contains
a number of valid measurement intervals with a
zero value (number of intervals given in next field)

<NumberOfPeriods> := Integer optional, empty field if not supported (means 1)

Counts the number of periods with the same value and
status starting with <StartTime> ( e.g., used for zero
suppression).
A number of zero-suppressed records is represented by
one record with the status field "Zero_suppressed" and the
number of zero value intervals indicated by
numberOfPeriods. Zero-suppressed records should have a
full/complete monitored time. If not, extra zero record(s)
with incomplete monitoredTime should be added.
<SepChar> := , Comma separates fields of a record.
<EORChars> := carriage return character, followed by line feed character Terminates records.
String := a printable character set The set is delimited by double-quotes except CR (Carriage
Return).
A double-quote character has to be marked by an extra
double-quote.
Integer := a digit character sequence unsigned integer number in decimal ASCII representation
Float := a character sequence with digits, signs or points float number in decimal ASCII representation

See PMExample.txt and PMExample.xls for PM file format examples in plain text and MS Excel format.

MTNM Version 3.0 © TeleManagement Forum 2003 4