eptos Classification Manager User Guide
eptos Classification Manager User Guide
Breadcrumbs

Reports

Overview

Classification Manager allows users with appropriate rights (Report Viewer) to view and execute Reports.

Reports are a functionality by which user can extract information from system and receive it via e-mail or having it displayed directly in the selected Report interface.

Users may also configure and schedule Reports for execution at a later time, once, periodically or triggered by another action in system.

Based on how each Report was constructed and defined, Reports assist users in having a better overview on the Classification and its relation to other business objects.

This section lists the reports available under Classification Manager.

Note:  A flag Standard was created which prevents deployment script (dbdeploy) from overwriting of Customer Specific Reports, Key users can recognize what objects are overwritten when deployment is done.

They have a clear indication which objects are overwritten on deployment in order to save individual modifications.

If dbdeploy in case of Reports detects overwriting a (standard=false) entity it will ignore the Update and Log a Warning to stdout.

A clear Separation between deployment and configuration transports between staging systems is done.

Example of how it is loged: “Skipped update of REPORT with name ‘nnn' because it’s NON-STANDARD“.

Further details on the graphical user interface are Graphical User Interface and Basic Functions.

/*<![CDATA[*/ div.rbtoc1770892094002 {padding: 0px;} div.rbtoc1770892094002 ul {list-style: disc;margin-left: 0px;} div.rbtoc1770892094002 li {margin-left: 0px;padding-left: 0px;} /*]]>*/ Overview Structure Execute Report Execute report and e-mail result Execute report and display result Schedule report

Structure

This section includes the following pages:

Workspace area for managing Reports is under Classification Manager / Reports. Here system opens a tabular view where all available Reports are listed.

The main attributes that are displayed in the sortable list are:

  • Manager → Classification Manager

  • Name → Report name

  • Description → Report short description

  • Standard → the fact if a Report is standard or user-defined

  • Type → all current Reports are of type SQL

  • Renderers → file format in which Report may be received (CSV, XLSX)

Tabular view also offers user a Quick Search function.

Search functionality in Reports tabular view is case insensitive.

If user wishes to execute a Report, he needs to select the desired one by radio button and select Execute option.

Execute Report

After Execute option was selected, user is redirected in Execute report view.

In all cases, user needs to inspect and configure details described in below table.

Note: only options that are relevant to selected Report are visible (e.g. option "Parameter").

Option

Description

Report scope

Field is non-editable and filled in automatically with: Classification

Name

Field is non-editable and filled in automatically with: Report name

Description

Field is non-editable and filled in automatically with: Report description

Intent

Field is non-editable and filled in automatically with: User

Parameters

Allows user to insert needed information in field "Value":

  • select desired Release

Render result as

Allows user to select a file format for the Received report:

  • CSV

  • XLSX

CSV separator

Allows user to select a separator for the data included in Report:

  • Comma (',')

  • Semicolon (';')

E-mail to

Allows users to input the e-mail address where the Report will be sent.

E-mail CC

Allows users to input the e-mail address where the carbon copy of the Report will be sent.

In order to have the selected Report executed, user has three possibilities available in the toolbar:

Execute report and e-mail result

After Report details were inspected and configured by user, Report execution is started by selecting Execute report and e-mail result option.

System automatically e-mails the report to the selected e-mail recipient.

Execute report and display result

After Report details were inspected and configured by user, Report execution is started by selecting Execute report and display result option.

System automatically displays the report in the same dialog.

Schedule report

After Report details were inspected and configured by user, upon selecting Schedule report option, user is redirected in schedule Report dialog.

Following table lists and describes the scheduling options:

Option

Description

Task description *

Short Report description and emailing address.

System relevant

Allows user to decide by check-box whether task is system relevant or not in order to prevent accidental deletion.

  • System relevant tasks require additional confirmation prior to deletion

  • Tasks that are not system relevant may be deleted directly

Planning in Manager

Field is non-editable and filled in automatically with: Classification

Time *

Allows user to choose Report execution frequency:

  • Once → Run later at date / time: 

    Allows user to select a date for the scheduling by selecting:

    • a date from a calendar or

    • option Today

    After date was set, user needs to define time by selecting clock field and selecting desired hour and minute when execution should start.

    Settings may be cleared by selecting option Clean.

  • Seconds → Allows user to select number of second(s) for execution frequency. E. g.: every 50 seconds.

  • Minutes → Allows user to select number of minute(s) for execution frequency. E. g.: every 30 minutes.

  • Hourly → Allows user to select number of hour(s) for execution frequency. E. g.: every 1 hour.

  • Daily → 

    Allows user to select number of day(s), start time and time zone for execution frequency. E. g.:

    • Every - 3 days

    • Start time * (for time of first execution) - hour, minute, second

    • Time zone * - CET / MEZ (UTC+1, UTC+2DST)

    Note: User may also Save time zone settings by ticking the check-box with this name.

  • Weekly →

    Allows user to select the day of the week, start time and time zone for execution frequency. E. g.:

    • Every - Friday

    • Start time * (for time of first execution) - hour, minute, second

    • Time zone * - CET / MEZ (UTC+1, UTC+2DST)

    Note: User may also Save time zone settings by ticking the check-box with this name.

  • After another task finishes → Opens task tabular view in scheduling dialog, allowing user to select desired task. After needed task is selected, task is highlighted and is displayed as "Chained".

Time zone *

Allows user to select correct time zone, e.g.: CET / MEZ (UTC+1, UTC+2DST)

Note: User may also Save time zone settings by ticking the check-box with this name.

Validate *

Allows user to validate settings after all configurations were defined.

Cron expression is automatically filled on pressing option Validate with the defined timestamp. For special cases, when needed, users with expert skills may change this cron expression.

Note: fields marked with an asterisk (*) are mandatory.

After Report scheduling details were inspected and configured, user needs to save these settings by selecting OK option.

Now system will automatically execute and e-mail Report at the specified time.

Exiting dialog without saving is possible via Cancel symbol.