Statistics and Reports

This screen acts as a dashboard for statistics and reports.

Note

The agent has to be the member of the group stats to use this dashboard.

Reports

Reports are automatically generated statistics. In this widget, it is possible to set statistics as reports.

Report List Widget

Report List Widget

To create a report:

  1. Click on the + icon in the header of the Report List widget. A new screen will be displayed for the report creation.

  2. Fill in the general information about the report.

    General Report Information

    General Report Information

    Name *

    The name of the report.

    Description *

    Add additional information to this report. It is recommended that you always fill this field with full sentences for better clarity, because the description will also be displayed in the report list.

    Validity

    Set the validity of this report. Reports can only be used in OTRS only if this field is set to valid. Setting this field to invalid or invalid-temporarily will disable the use of the report.

  3. Select the times when the report will be automatically generated and fill in the email details.

    Automatic Generation Settings

    Automatic Generation Settings

    No schedule

    No email will be sent automatically.

    Basic schedule

    Select an automatic generation time from the list. An email with the report will be sent at this configured time.

    Custom schedule

    Use cron syntax to define custom times for sending the emails.

    Automatic Generation Language

    Select a language from the list for the report generation.

    Email Subject

    The subject for the email containing the report can be added here.

    Email Body

    The body text for the email containing the report can be added here.

    Email Recipients

    The recipients for the email containing the report can be added here, separated by commas.

  4. Fill in the output settings.

    Output Settings

    Output Settings

    Headline

    This text will be used as headline text in the report.

    Title

    The title of the report.

    Caption for Preamble

    The caption for preamble included in the report.

    Preamble

    The preamble text of the report.

    Caption for Epilogue

    The caption for epilogue included in the report.

    Epilogue

    The epilogue text of the report.

  5. Select one or more statistics to be added to the report. Each added statistic has its own overview and settings screen.

  6. After all information has been collected and set, click on the Create Report button to create the report.

The edit report screen is the same as the create report screen, but the fields are pre-filled with the current values.

To edit a report:

  1. Select a report in the Report List widget.
  2. Modify the fields.
  3. Click on the Save or Save and Close button.

To run a report immediately:

  1. Click on the play icon in the Run column.
  2. Click on the Run Report button in the new screen.

To delete a report:

  1. Click on the trash icon in the Delete column.
  2. Click on the Yes button in the confirmation dialog.

Statistics

OTRS comes with some pre-installed statistics. Lists of statistics can be found in separate widgets for each type of statistic.

Metrics Widget

This widget list the statistics that are displayed in a table format.

Metrics Widget

Metrics Widget

Lists Widget

This widget list the statistics that are displayed in a list format.

Lists Widget

Lists Widget

Static Widget

This widget list the static statistics.

Static Widget

Static Widget

Creating a new statistic requires some steps.

  1. Click on the + icon in the header of any statistic widget. A new screen will be displayed for the statistic creation.

  2. Select the statistic type. The statistic can be Matrix, List or Static.

    Statistic Type Selection

    Statistic Type Selection

    • Matrix: Each cell contains a single data point.
    • List: Each row contains data of one entity.
    • Static: Non-configurable complex statistics.
  3. Fill in the general information for the statistic.

    General Statistic Information

    General Statistic Information

    Title *

    Add a title for the statistic.

    Description *

    Longer description about the statistic.

    Object *

    Select an object from the list. The available objects depend on the statistic type.

    Permissions *

    You can select one or more groups to define access for different agents.

    Format *

    Select the format that will be available when the statistic is run.

    Time Zone *

    Select a time zone for the generated statistic. The selected time periods in the statistic are time zone neutral.

    This field is not available for static statistics.

    Create summation row

    If this is checked, an additional row is generated containing sums for all data rows.

    Create summation column

    If this is checked, an additional column is generated containing sums for all data columns.

    Valid

    If this is not checked end users can not generate the statistic.

  4. Click on the Generate Statistic button. The screen will be refreshed; the previous widgets will be collapsed, and new widgets will be displayed.

  5. Select the values for the X-axis.

    Configure X-Axis

    Configure X-Axis

    It is possible to allow changes to element values before running the statistic by checking the checkbox below the list.

    The available values depend on the the statistic type.

  1. Select the values for the Y-axis.

    Configure Y-Axis

    Configure Y-Axis

    It is possible to allow changes to element values before running the statistic by checking the checkbox below the list.

    The available values depend on the the statistic type.

  2. Select the filters for the data.

    Add Filters

    Add Filters

  3. Click on the Save and Close button.

During the statistic creation, a preview widget will show the results.

Statistic Preview Widget

Statistic Preview Widget

Note

The preview uses random data and does not consider data filters.

The edit statistic screen is the same as the create statistic screen, but the fields are pre-filled with the current values.

To edit a statistic:

  1. Select a statistic in any statistic widget.
  2. Modify the fields.
  3. Click on the Save or Save and Close button.

To export a statistic:

  1. Click on the export icon in the Export column.
  2. Choose a location in your computer to save the .xml file.

To import a statistic:

  1. Click on the Import button in the header of any statistic widget.
  2. Select a previously exported .xml file.
  3. Modify the fields and the statistics details, if needed.
  4. Click on the Save or Save and Close button.

To run a statistic immediately:

  1. Click on the play icon in the Run column.
  2. Click on the Run Statistic button in the new screen.

To delete a statistic:

  1. Click on the trash icon in the Delete column.
  2. Click on the Yes button in the confirmation dialog.