Report

The Report object controls one of the three types of report generated by the EMS to record details of the mapping between subscriber directory numbers and access ports, or between Business Group Line directory numbers and names.

The Report objects are included as part of the delivered configuration, and you cannot create or delete them. You can configure whether each report is generated automatically once a day or only when requested, specify the file name to which it is written on the EMS Server, and specify which EMS objects are to be included in the report.

Object-Specific Actions
Generate report now This action generates an immediate report as defined by the configuration of this object. If a report generation is already in progress (as indicated by the Report status field), the action button is grayed and you cannot select it.

Parameter

Access

Description
Report type Read only The type of report to which this object applies. Values:
  • Subscriber Gateway endpoint-DN mapping
    Mapping between subscriber directory numbers and termination identifiers on a BLC (which is represented in the EMS as a Subscriber Gateway).
  • Access Device endpoint-DN mapping
    Mapping between subscriber directory numbers and port numbers on a GR-303 IDT
  • Business Group DN-name mapping
    List of Business Group Line directory numbers for each Business Group, together with information about each line such as the subscriber's name and the intercom dialing number.
Periodic file generation Change Specifies whether reports should be generated automatically once a day. Values:
  • Never (default)
    Reports are generated only when you request them using the Generate report now action pushbutton.
  • Once a day
    Reports are generated automatically once a day, at the time specified by the File generation time field.
File generation time Change This field appears only if Periodic file generation is set to Once a day. The hour of the day (24-hour clock) at which reports are generated. Specify a value in the range 0 (midnight) - 23 (11pm). The default is 0.
File name Change The name of the file to which the report will be written. The file is created in the EMS Craft User's home directory on the EMS Server (overwriting any existing file with the same name). You must specify a file name if Periodic file generation is set to Once a day, or before using the Generate report now action pushbutton.
Object list Change The list of EMS objects for which the report should be written. This field is a text field in which you can copy, cut, and paste text. Specify each object name on its own line, terminated by a carriage return. If you leave this field empty, the EMS includes all objects of the specified type.
  • For the Subscriber Gateway endpoint-DN mapping report, the object name is the contents of the Description field for each Subscriber Gateway corresponding to a BLC that you want to include.
  • For the Access Device endpoint-DN mapping report, the object name is the contents of the Description field from the Access Device corresponding to each GR-303 IDT that you want to include.
  • For the Business Group DN-name mapping report, the object name is the contents of the Business Group name field for each Business Group that you want to include.
Number of entries generated Read only The number of entries in the most recent report file generated.
Report status Read only The status of the most recent report file generation. Values:
  • None
    No report has been generated.
  • In progress
    A report is currently being generated.
  • Success
    The report file was generated successfully.
  • Failed
    An error occurred in generating the report file. The Alarm log correlator field identifies the log message providing more details of the failure.
Alarm state Read only The alarm state of the Report object. Values:
  • Clear
    The object does not currently require maintenance action.
  • Attention Required
    An error occurred in generating a report file.
Alarm log correlator Read only Identifier of the log message for the event that caused the last Attention Required alarm state for this object. This field is reset when the Attention Required alarm events field is reset to zero.
Attention Required alarm events Read only / Reset Number of times (since this field was reset) that this object's alarm state has gone to Attention Required.
Alarm state changed timestamp Read only Time at which the Alarm state last changed.
Alarm events reset timestamp Read only Time at which the Attention Required alarm events field was last reset to zero.