Data Field Definitions

Data types

The data synthesized and collected in output files is of the following types:

Data Type

Description

etime

Elapsed time. This format is set by the user during output configuration.

long

64-bit integer, from -9223372036854775808 to 9223372036854775807, inclusive

int

32-bit integer, from -2147483648 to 2147483647, inclusive

timestamp

Date and time. This format is set by the user during output configuration.

char

ASCII character string.

long char

ASCII character string that is not limited to a maximum size.

float

Floating-point notation.

boolean

The string "TRUE" or "FALSE"

(Note: For general information on the four data levels, see the Introduction to the Collector.)

Conference data level

The Conference table contains non-participant information relating to the conference as a whole. Field widths are enclosed in parentheses next to the data types.

Field

Description

Data Type

Conference Id (KEY)

A unique conference ID assigned by the ZyrOSS Data Collector. Used as a primary key.

long (12)

Actual Duration

The actual duration time of the conference.

etime (12)

Actual Start Date

The actual start date and time for the conference in Greenwich Mean Time.

timestamp (24)

Billing Code

Touch tone code entered by conference leader for billing purposes. If different codes at participant level, this field is blank, but the Billing Code in the Participant table will be populated.

char (32)

Billing Participant

Name of conference leader who entered Billing Code, if only one did.

char (64)

 Cascade Mode

Conference Cascading Mode

  • None

  • Master

  • Slave

  • Auto

char (8)

 Chair Control

Chairperson control settings

  • Disabled

  • Enabled

char (8)

 Chair Password

The Chairperson password to enter the conference

chair (16)

Conference Entry   Password

The password used to access the conference

char (16)

Conference Name

The conference name harvested from the Polycom MCU.

char (128)

 Conference Type

Type of conference determined by the conference name.

This edit will fail if the conference name is manually modified..

  • Entry Queue - Conf name ends with '(conf id)'

  • Gateway - Conf name ends with '_conf id'

  • On Demand - Conf name begins with 'PNPLCM'

  • Operator - Operator Conf flag set

  • Web Office - Conf name contains an email address format

  • Regular - Conf name does not contain any of the above patterns  

char (12)

 Customer ID

The Customer ID harvested from the Polycom MCU. See Defining MCUs for methods to harvest the Customer ID

char (80)

 Date Collected

The date and time the conference CDR data was collected from the bridge

timestamp (24)

 Date Synthesized

The date and time the conference CDR data was loaded to the embedded database

timestamp (24)

 Dial In Locked

Conference locked to dial in participants. Values are true and false

boolean (6)

 Encryption

Conference encryption setting. Values are true and false

boolean  (6)

End Cause

The reason for the termination of the conference. Possible values:

  • "Conf terminated by operator."

  • "Conf  ended at scheduled end time."

  • "Conf ended automatically when participants disconnected."

  • "Conf terminated by user."

  • "Conf did not start due to scheduled end time elapsing."

  • "Conf could not start due to a problem."

  • "Conf  was ended by MCU reset."

  • "Unknown error."

  • "Unknown:(value)" where the disconnection value returned is not defined.  Ex: Returned value = 43. Disconnection cause = "Unknown:43"

char (64)

 End Cause Code

The numeric conference termination code

int (6)

End Date

The date and time the conference was concluded (Greenwich Mean Time).

timestamp (24)

First Connection Time

The time the first participant connected to the conference

timestamp (24)

GMT Offset

The difference between Greenwich Mean Time and the time zone set on the MCU.

float (9)

Good Cdr Format

If false, indicates that incomplete data was returned by the MCU and some of the values have been extrapolated from what was returned. If true, indicates that the MCU returned a complete description of the conference.

boolean (5)

Last Disconnection Time

The time the past participant disconnected from the conference

timestamp (24)

 Lecture Mode

Lecture Mode setting

  • None

  • Lecture Mode

  • Lecture Show

  • Presentation Mode

char (25)

 Lecturer

The name of the participant selected to be the lecturer

char (80

 Master Name

The name of the participant that acts as a link to the Master Conference

char (80)

Maximum Participants

The maximum number of participants that can connect to the conference, A value of 'Auto' will accommodate the maximum participants that the MCU can connect.

char (10)

Meet Me Per Conference

Meet Me Per Conf setting. Values are true and false.

boolean (6)

MCU Bill Code

A billing code assigned to the conference

char (80)

MCU Conference ID

A Conference ID assigned by either the MCU or the operator. It is unique within a particular MCU.

long (9)

MCU Name

ID for MCU assigned by the user on the "Add/Edit an MCU" page within the ZyrOSS Data Collector.

char (16)

Minimum Participants

Number of undefined parties. The number of participants for which the system reserved resources

int (6)

Number of Audio Participants

The number of audio-only participants in the conference.

int (10)

Number of Participants

The total number of participants in the conference.

int (10)

Number of Video Participants

The number of video participants in the conference.

int (10)

 Numeric ID

A numeric code that uniquely identifies the conference

char (16)

 Operator Remarks

Remarks entered by the operator during the conference

long char

Remarks

Comments entered when the conference is scheduled.

char (300)

Reserved Duration

The time reserved for the conference.

etime (12)

Reserved Start Date

The scheduled start date and time for the conference (Greenwich Mean Time).

timestamp (24)

Restricted Mode

Whether the conference was set to a restricted line rate ("56kbs") or a normal line rate ("64kbs") or "Auto."

char (5)

Total End Point Connection Time

The total of all participants' end point connection time.

etime (12)

Total Transport Connection Time

The total of all participants' transport connection time.

etime (12)

 Transfer Rate

The overall throughput rate from the conference. Possible values are in according to the 'Line Rate' option in the H221 dialog box. This is also used to reserve ISDN and MUX resources for H.320 participants.

char (10)

Undefined Participants Allowed

Unlimited reservation setting. Undefined participants allowed to join the conference. Values are true and false

char (6)

User Defined 1

Optional field that enables additional information to be recorded and written to the CDR

char (120)

User Defined 2

Optional field that enables additional information to be recorded and written to the CDR

char (120)

User Defined 3

Optional field that enables additional information to be recorded and written to the CDR

char (120)

Video Session

Value can be:

  • "Switched" -- all participants at SAME rate and algorithms, full screen only

  • "Video Transcoded" -- any participant at ANY rate and algorithm, full screen only

  • "Continuous Presence" -- same as "Transcoded" but 21 possible screen layouts

  • "IP Continuous Presence" --software continuous presence for IP only with no video transcoding.

  • "Quad Layout Cont. Pres." -- required the video module with video transcoding.

  • "Unknown:(Value)" -- An undefined Video Session numeric value.  Ex: "Unknown:8" where the Video Session value is "8". This value will only appear if the MCU software has been upgraded before the Data Collector software has been upgraded.

char (25)

Web Chair Password

The password used by the participant to identify himself/herself as the conference chairperson

char (16)

Web Reserved Database ID

Database ID of the reservation establisher.

char (64)

Web Reserved

Indicates whether this conference was reserved with Web Commander.

boolean (6)

Web Reserved User ID

User ID of the reservation establisher.

char (64)

Participant data level

Each field describes a conference participant.

Field

Description

Data Type

Conference Id (KEY)

Foreign key from Conference table.

long (12)

Participant Name (KEY)

The name associated with an end point at conference setup time. Participant names assigned by the MGC are typically the conference ID. Entry queues end with "(id)" and Gateway calls end with "-id". Ex: 99999(001) or 99999_001.

char (80)

Billing Code

Touchtone code entered by the conference leader(s) for billing purposes. (See also Billing Code in Conference table.)

char (32)

Bonding Mode

The ISDN B-Channel bonding mode setting. Values are true and false.

boolean (6)

Bonding Phone Number

The phone number for bonding dial out calls.

char (45)

Chairperson

This field is set to true for participants that have a 'Chairperson Joined the Conference' event. Values are true and false.

boolean (6)

Conference Name

The conference name harvested from the Polycom MCU.

char (128)

Conf Customer ID

The Conference Customer ID harvested from the Polycom MCU. See Defining MCUs for methods to harvest the Customer ID

char (80)

Part Customer ID

The Participant Customer ID harvested from the Polycom MCU. See Defining MCUs for methods to harvest the Customer ID

char (80)

Destination IP Address

The endpoint name if it is defined in the conference parameters or the transport address, which consists of the prefix TA followed by the TCP/IP address and the listening port (e.g., TA:172.22.140.65:1720 in which 172.22.140.65 is the IP address and 1720 is the port).If there are multiple Destination IP Addresses, this field will contain the value "Various".

char (255)

Dial In/Out Type

Whether the reserved connection was inbound, outbound, or direct connect. Possible values:

  • "Dial-In"

  • "Dial-Out"

  • "Direct Connect"

char (14)

Encryption

The participant encryption setting.  Values are true and false.

boolean (6)

First Connection Time

The first time that the participant connected to the conference.  

timestamp (24)

H243 Password

The H.243 password

char (16)

H323 Alias Type

The alias type for H.323 participants

  • E164

  • H323 ID

  • URL ID Alias Type

  • Transport ID

  • Email ID

  • Participant Number

For SIP Participants

  • SIP URI

  • TEL URL

 

H323 Participant Alias Name

The H.323 participant alias name OR the SIP participant address.

char (512)

Interface Type

Network interface type

  • ISDN

  • ATM

  • H.323

  • MPI

  • T1-CAS

  • SIP

Char (10)

IP Address

IP participant specified IP address. If no address was specified, the value is 'None'.

char (45)

Last Disconnection Time

The last time that the participant disconnected from the conference.

timestamp (24)

MCU Conference Id

A Conference ID assigned by either the MCU or the operator. It is unique within a particular MCU.

long (12)

MCU Name

ID for MCU assigned by the user on the "Add/Edit an MCU" page within the ZyrOSS Data Collector.

char (16)

Net Number of Channels

The number of channels reserved for this participant.

int (6)

Net Service Name

Name of the network service. Blank value means the default network service.

Char (20)

Number Type

Type of telephone number used in connection. Contains one of the following values:

  • "Unknown"

  • "International"

  • "National"

  • "Network Specific"

  • "Subscriber"

  • "Abbreviated"

  • "Taken from Service"

char (20)

Number of End Point Connections

The number of end point connections recorded for this participant.

int (6)

Number of IP Connections

The number of IP connections recorded for this participant.

int (6)

Number of ISDN Connections

The number of ISDN connections recorded for this participant.

int (6)

Number of Other Connections

The number of connections recorded for this participant with a transport type other than End Point, IP, or ISDN.

int (6)

Participant Type

Participant type

  • Defined

  • Undefined

char (10)

Recording Link

The participant for which there was a 'Recording Link' event. Values are true and false.

boolean (6)

Reservation Type

Whether this participant was reserved before the conference started or was added by the operator once the conference was in progress. Possible values:

  • "Reservation"

  • "Add Party"

  • "Update Party"

  • "Undefined Party"

  • "Moved to Conf"

  • "Attend Conf"

char (10)

Restricted Speed

Whether the participant was set to a restricted line rate ("56kbs") or a normal line rate ("64kbs") or "Auto."

char (10)

Source IP Address

The endpoint name if it is defined in the conference parameters or the transport address, which consists of the prefix TA followed by the TCP/IP address and the listening port (e.g., TA:172.22.140.65:1720 in which 172.22.140.65 is the IP address and 1720 is the port).If there are multiple Source IP Addresses associated with this connection, this field will contain the value "Various".

char (255)

Total End Point Connection Time

The total amount of time in milliseconds that the participant's end point was joined to the conference.

etime (12)

Total Transport   Connection Time

The total amount of time in milliseconds that the participant was connected to the MCU at the transport layer. (See Connection record for the different transport mechanisms.)

etime (12)

Transport Called Phone Number

The phone number dialed to connect the participant to the MCU. If there are multiple called phone numbers, this field will contain the value "Various".

char (32)

Transport Calling Phone Number

The originating phone number for the participant connection. If there are multiple calling phone numbers, this field will contain the value "Various".

char (32)

Transport Types

Comma-delimited list of unique transport types of associated participant connections.

char (20)

User Defined 1

Optional field that enables additional information to be recorded and written to the CDR

char (120)

User Defined 2

Optional field that enables additional information to be recorded and written to the CDR

char (120)

User Defined 3

Optional field that enables additional information to be recorded and written to the CDR

char (120)

User Defined 4

Optional field that enables additional information to be recorded and written to the CDR

char (120)

VIP Indicator

Participant VIP indicator

boolean (5)

Visual Name

Name entered by operator and associated with a participant during a conference.

char (20)

Voice

Whether the participant is reserved for voice only or both video and audio. Possible values:

  • "No" -- Both audio and video

  • "Yes" -- Voice only

  • "Unknown" -- Not set at time reservation was made

char (7)

Connection Total data level

A Connection Total record is created for each group of participant connection records that share the same participant name and transport type.

Field

Description

Data Type

Conference Id (KEY)

Foreign key from the Conference table. Used with Participant Name, Transport Type, and Restricted Speed to build a primary key.

long (12)

Participant Name (KEY)

Foreign key from the Participant table. Used with Conference Id and Transport Type to build a primary key.

char (80)

Transport Type (KEY)

The type of connection that this total refers to. Used with Conference Id and Participant Name to build a primary key. Possible values:

  • "End Point"

  • "ISDN"

  • "ATM"

  • "MPI"

  • "IP"

char (10)

Conference Name

The conference name harvested from the Polycom MCU.

char (128)

MCU Conference Id

A Conference ID assigned by either the MCU or the operator. It is unique within a particular MCU.

long (12)

MCU Name

ID for MCU assigned by the user on the "Add/Edit an MCU" page within the ZyrOSS Data Collector.

char (6)

Number of
Channels

The total number of connections of this type and speed that this record refers to.

int (6)

Restricted Speed

Can be "56k," "64k," or "Auto".

char (10)

Total Time
Connected

The total connected time for all channels. To obtain the average time, divide this figure by Number of Channels.

etime (12)

Connection data level

The Connection table contains a record for each matching connection and disconnection event that takes place for a participant.

Field

 

Description

 

Data Type

 

Connection Types

End Point

ISDN

ATM

MPI

IP

Conference Id (KEY)

Foreign key from Conference table. Used with Participant Name  to build a primary key.

long (12)

ü

ü

ü

ü

ü

Participant Name (KEY)

Foreign key from Participant table. Used with Conference Id and Transport Type to build a primary key for Connection data.

char (80)

ü

ü

ü

ü

ü

Transport Type (KEY)

The type of connection that the record describes. Possible values:

  • "End Point"

  • "ISDN"

  • "ATM"

  • "MPI"

  • "IP"

char (10)

ü

ü

ü

ü

ü

Connection Sequence (KEY)

A sequential number indicating the order in which the connections were made.

int (6)

ü

ü

ü

ü

ü

Bandwidth

Connection Video rate for IP and calculated from number of B-Channels for ISDN.

long (10)

ü

 

ü

ü

ü

Channel ID

Channel number according to order of arrival on MCU, starting at 1.

int (3)

 

ü

 

 

 

Conference Name

The conference name harvested from the Polycom MCU.

char (128)

ü

ü

ü

ü

ü

Connection Protocol

IP Connection Protocol

  • H.323

  • SIP

char (8)

ü

 

ü

ü

ü

Destination
Address IP

The endpoint name if it is defined in the conference parameters or the transport address, which consists of the prefix TA followed by the TCP/IP address and the listening port (e.g., TA:172.22.140.65:1720 in which 172.22.140.65 is the IP address and 1720 is the port).

char (255)

 

 

 

 

ü

End Point
Disconnection
Cause

The reason the participant was disconnected. Possible values:

  •  "MGC"

  • "End-Oper"

  • "End-Time"

  • "Party " (plus the Q.931 description, if any)

  • "Operator"

  • "Chairman"

  • "Moved Out"

  • "H.243CC"

  • "?Resource Deficient"

  • "Password Failure"

  • "?Bonding Failure"

  • "?No Net Connect " (plus the Q.931 description, if any)

  • "?MGC Net Deficiency"

  • "?MGC Mux Deficiency"

  • "?MGC Audio Deficiency"

  • "?MGC Video Deficiency"

  • "?MGC Data Deficiency"

  • "Conf EndTime"

  • "?MGC AudMsg Deficiency"

  • "?MGC Vgate NoResp"

  • "?MGC IP Deficiency"

  • "?MGC T123 Deficiency"

  • "?H323-GK ConID Fail"

  • "?H323-NoPortAudio"

  • "?H323-NoPortVideo"

  • "?H323-NoPortT120"

  • "?H323-NoPortControl"

  • "?H323-NoPortAudioX"

  • "?H323-NoPortVideoX"

  • "?Bonding-Long Delay"

  • "?Bonding-Internal Err"

  • "?Bonding-No Answer"

  • "?Bonding-ErrDialChn"

  • "?H243-ErrFullRateFail"

  • "?H243-CapExFailCall"

  • "?H243-CapExFailChange"

  • "?H243-Unspecified"

  • "?H243-NoEndInit"

  • "?GK-CalledNotReg"

  • "?GK-InvPerm"

  • "?GK-ReqDenied"

  • "?GK-UndefReason"

  • "?GK-CallerNotReg"

  • "?GK-RouteToGK"

  • "?GK-InvEndPt"

  • "?GK-ResourceUnv"

  • "?GK-SecurityDenial"

  • "?GK-QOSnotSup"

  • "?GK-IncompAdr"

  • "?GK-ARQtimeout"

  • "?GK-DRQtimeout"

  • "?H323-RemoteBusy"

  • "H323-Party"

  • "H323-RemoteReject"

  • "?H323-RemoteUnreachable"

  • "?H323-UnknownReason"

  • "?H323-CloseMGC"

  • "?H323-NeedMaint"

  • "?H323-SmallBandwidth"

  • "?H323-GKfailure"

  • "?H323-GKrejectARQ"

  • "?H323-NoPorts"

  • "?H323-GKxDRQ"

  • "?H323-NoDestIpAdr"

  • "?H323-NoCapsFromRemote"

  • "?H323-NoAudioChn"

  • "?H323-WaitT120"

  • "?H323-BadRemoteCap"

  • "?H323-RemoteRejectCaps"

  • "?H323-Failure"

  • "H323-RemoteNoResponse"

  • "Unknown:(value)" where the disconnection value returned is not defined.  Ex: Returned value = 43. Disconnection cause = "Unknown:43"

 Q.931 Descriptions

  • "None"

  • "?UnAllocatedNumber"

  • "?NoRouteToNet"

  • "?NoRouteToDest"

  • "?OutOfService"

  • "?MisdialPrefix"

  • "Normal"

  • "Busy"

  • "NoResponse"

  • "NoAnswer"

  • "Rejected"

  • "?NumberChanged"

  • "?OutOfOrder"

  • "?InvalidNumber"

  • "NormalUnspecified"

  • "?NoCircuits"

  • "?NetFailure"

  • "?TempFailure"

  • "?Congestion"

  • "?ResourceUnavailable"

  • "?NotSupportd"

  • "?NAchanType"

  • "?NAfacility"

  • "RestrictBchnOnly"

  • "?BadChanNum"

  • "?Incompatible"

  • "?MsgNotCompatible"

  • "?TimerExp"

  • "?InterNetworkFail"

  • Unknown:(value)" where the Q.931 Description value returned is not defined.  Ex: Returned value = 99. Q.931 Description = "Unknown:99"

char (64)

ü

 ü

 

 

 ü 

End Point Disconnection Cause Code

The numeric cause for the end point disconnection

int (6)

ü

 

 

 

 

Force Closed Connection

Indicates whether an actual discreet close event was found for this connection. If false, it means that the disconnect time has been extrapolated to match the conference end time.

boolean (5)

ü

ü

ü

ü

ü

IP End Point Type

The kind of end-point device. Possible values:

  • "Terminal"

  • "Gateway"

  • "MCU"

  • "Gatekeeper"

  • "Undefined"

char (10)

 

 

 

 

ü

Local Sync Lost Counter

The number of times that the synchronization of the MCU MUX unit was lost.

int (6)

ü

 

ü

ü

ü

Local Video Sync Lost Counter

The number of times that the synchronization of the MCU Video unit was lost.

int (6)

ü

 

ü

ü

ü

Maximum Rate IP

The maximum data transfer rate for an IP connection in bits/second. The value comes from the H.323 call setup. Used to determine the connection speeds supported by the caller. Not necessarily the actual speed used.

long (12)

 

 

 

 

ü

MCU Conference Id

A Conference ID assigned by either the MCU or the operator. It is unique only within a particular MCU.

long (12)

ü

ü

ü

ü

ü

MCU Name

ID for MCU assigned by the user on the "Add/Edit an MCU" page within the ZyrOSS Data Collector.

char (16)

ü

ü

ü

ü

ü

Maximum Rate IP

The maximum data transfer rate for an IP connection in bits/second. The value comes from the H.323 call setup. Used to determine the connection speeds supported by the caller. Not necessarily the actual speed used.

long (12)

 

 

 

 

ü

Net Number of Channels

The bonded  B-Channels

Int (6)

ü

 

 

 

 

Remote Sync Lost Counter

The number of times that the synchronization of the participant MUX unit was lost.

int (6)

ü

 

ü

ü

ü

Remote Video Sync Lost Counter

The number of times that the synchronization of the participant Video unit was lost.

int (6)

ü

 

ü

ü

ü

Restricted Speed

This is for ATM and MPI connections only. It's either "Yes" or "No".

char (10)

 

 

ü

 ü

 

Source IP Address

The endpoint name if it is defined in the conference parameters or the transport address, which consists of the prefix TA followed by the TCP/IP address and the listening port (e.g., TA:172.22.140.65:1720 in which 172.22.140.65 is the IP address and 1720 is the port).

char (255)

 

 

 

 

ü

Transport ATM
Address

The address of the ATM node where the participant is located.

char (32)

 

 

ü

 

 

Transport Call Type

Describes the specific mode of use of the ISDN B channel. Possible values:

  • "Voice"

  • "Modem"

  • "56k"

  • "64k"

  • "64k restrict"

  • "384k"

  • "384k restrict"

char (15)

 

ü

 

 

 

Transport Called Number Plan

The number dialed to connect the participant to the MCU.

char (32)

 

ü

ü

ü

 

Transport Called
Number Type

Indicates the type of phone number the participant dialed to obtain this connection to the MCU. Possible values:

  • "Unknown"

  • "National"

  • "International"

  • "Subscriber"

  • "Abbreviated"

char (20)

 

ü

ü

ü

 

Transport Called Phone Number

The phone number dialed to connect participant to the MCU.

char (32)

 

ü

ü

ü

 

Transport Calling Number Plan

The phone number plan the participant used.

char (32)

 

ü

 

 

 

Transport Calling  Number Type

Indicates the type of phone number the participant dialed to obtain this connection to the MCU. Possible values:

  • "Unknown"

  • "National"

  • "International"

  • "Subscriber"

  • "Abbreviated"

char (20)

 

ü

 

 

 

Transport Calling
Phone Number

The originating phone number for the participant connection.

char (32)

 

ü

 

 

 

Transport
Connection State

Indicates whether the connection is "Connected" or "Secondary."

char (10)

ü

 

 

 

 

Transport Connection Time

The date and time when the participant was connected to the MCU at the transport level.

timestamp (24)

ü

ü

ü

ü

ü

Transport
Disconnection
Time

The date and time when the participant was disconnected from the MCU at the transport level.

timestamp (24)

ü

ü

ü

ü

ü

Transport Dialin/Dialout

Indicates whether the participant dialed into the MCU to obtain the connection ("Dial-in") or whether the MCU dialed out to connect to the participant ("Dial-out").

char (10)

 

ü

ü

 

ü

Video Protocol

Video connection protocol

  • H.261

  • H.263

  • H.264*

  • H.264

  • Auto

char (10)

 

 

ü

ü

ü