q-monitor user guidetranscat-plm.com/pub/tcsoft/qmonitor560/doc/q-monitor_5... · 2018. 7. 24. ·...

72
Text version 9-Feb-18 12:44 PM Q Q - - M M O O N N I I T T O O R R 5.6.X FOR V5 for Q-CHECKER ® U U S S E E R R S S G G U U I I D D E E

Upload: others

Post on 17-Feb-2021

5 views

Category:

Documents


0 download

TRANSCRIPT

  • Tex

    t ve

    rsio

    n 9

    -Feb

    -18

    12:4

    4 P

    M

    QQ--MMOONNIITTOORR 5.6.X FOR V5

    for Q-CHECKER®

    UUSSEERRSS GGUUIIDDEE

  • Copyright Dassault Systèmes 2 Q-MONITOR 5.6.X FOR V5

    Orientation Symbols used in the manual

    For better orientation in the manual the following symbols are used:

    Warning symbol

    The warning symbol signals cr i t ica l moments to which you should pay attention in order to avoid problems in your work process.

    Tip symbol

    The lamp symbol signals a t ip that offers you practical experience to make your work easier.

    Note symbol

    The hand symbol relates to notes , which you should pay attention to in order to assure that you can work without problems .

    Info symbol

    The info symbol signals a background in formation .

    Step symbol

    The step symbol signals that a sequence of work operat ions is given.

    Copyright Dassault Systèmes 2000–2018.

    CATIA, ENOVIA, Q-Checker are registered trademarks of Dassault Systèmes or its

    subsidiaries in the US and/or other countries.

  • T A B L E O F C O N T E N T S

    Copyright Dassault Systèmes 3 Q-MONITOR 5.6.X FOR V5

    Table of Contents

    1. Overview–Q-MONITOR and Its Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

    2. Q-MONITOR GUI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

    2.1 Q-MONITOR Main Window .................................................................................... 8 • Menu Bar .................................................................................................................................. 10

    2.2 Tool Bar .............................................................................................................. 13

    3. Q-MONITOR Operation Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

    3.1 Starting Q-MONITOR in Native Mode .................................................................... 15

    3.2 Q-MONITOR in Batch Mode .................................................................................. 15

    3.3 Running Q-MONITOR as Applet ........................................................................... 16

    4. Working with Q-MONITOR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

    4.1 Automatic Connection Check ............................................................................... 17

    4.2 Changing Database Password .............................................................................. 17

    4.3 Database Connection and Database Control ....................................................... 18

    4.3.1 Defining Database Connections ............................................................................................. 18

    4.3.2 Checking and Updating the Criteria Table .............................................................................. 20

    • Checking the Criteria Table ...................................................................................................... 20 • Updating the Criteria Table ..................................................................................................... 20

    4.4 Creating New Reports ......................................................................................... 23

    4.4.1 Creating Report Templates with the Wizard .......................................................................... 24

    • Available Query Types .............................................................................................................. 24

    4.4.2 Report Type Selection Dialog .................................................................................................. 27

    4.4.2.1 Creating a New Report Using an Existing Report Template .................................................. 28 4.4.2.2 Report Editor Window ............................................................................................................. 29 4.4.2.3 Report Filter Options Panel .................................................................................................... 30

    • DATE-Type Comparison Option .............................................................................................. 34 • INTEGER-Type Comparison Option ....................................................................................... 36 • TEXT-Type Comparison Option .............................................................................................. 38 • Restriction Options bar for TEXT values ................................................................................. 44 • Restriction Options bar for INTEGER values .......................................................................... 45 • Restriction options bar for DATE values ................................................................................. 46

    4.4.2.4 Saving a Report Template ....................................................................................................... 46 4.4.2.5 Export and Import of Query Options ...................................................................................... 47

    4.5 Displaying the Report ......................................................................................... 47

    4.5.1 Chart View ................................................................................................................................ 48

    4.5.1.1 Chart Types .............................................................................................................................. 49 4.5.1.2 Swapped Check Box ................................................................................................................ 50 4.5.1.3 Vertical Check Box .................................................................................................................... 51 4.5.1.4 Legend Check Box ................................................................................................................... 52 4.5.1.5 Value Text Check Box ............................................................................................................... 53 4.5.1.6 3-D Check Box .......................................................................................................................... 54

  • T A B L E O F C O N T E N T S

    Copyright Dassault Systèmes 4 Q-MONITOR 5.6.X FOR V5

    4.5.1.7 Rotation Arrows ........................................................................................................................ 55 4.5.1.8 Exporting a Chart ..................................................................................................................... 56

    • JPEG settings dialog ................................................................................................................ 57

    4.5.2 Table View ................................................................................................................................ 57

    4.6 Opening an Existing Report ................................................................................ 60

    4.7 Printing a Report ................................................................................................ 61

    4.8 Closing a Report ................................................................................................. 63

    5. Exiting Q-MONITOR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

    APPENDIX .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

    1. Q-MONITOR Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 • Options tab card ....................................................................................................................... 65 • Filter tab card ........................................................................................................................... 67 • Report Fonts tab card ................................................................................................................ 68 • Colors tab card ......................................................................................................................... 69 • Help tab card ............................................................................................................................ 70 • 71 • Service tab card ......................................................................................................................... 71

    2. Color definition for Individual Report Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

  • 1 . O V E R V I E W – Q - M O N I T O R A N D I T S F E A T U R E S

    Copyright Dassault Systèmes 5 Q-MONITOR 5.6.X FOR V5

    1. Overview–Q-MONITOR and Its Features

    Q-MONITOR is a tool conceived for monitoring the data quality of CATIA CAD models.

    Q-MONITOR operates in conjunction with Q-CHECKER and interprets Q-CHECKER check

    results stored in a database. On the base of queries about the check results Q-MONITOR

    can generates reports in table or chart form giving statistical overviews over model

    parameters. As in the database a large number of data sets can be stored, the scope of

    Q-MONITOR’s operation is not limited to individual projects. It is possible to create

    overviews over the data quality of many projects of different services or companies over a

    certain period of time. The reports can be used to determine where targeted action for

    better model quality should be taken.

    To name only some of the ways Q-MONITOR reports can be used, they can make visible the

    evolution of model quality over a period of time, can provide a quality status survey of all

    models included in a project at a fixed point in time, or allow determination of the general

    faults that occur most often.

    Q-MONITOR operates with data stored in relational database as ORACLE, DB2, MySQL,

    MSSQL or other.

    The action of Q-MONITOR consists in:

    • Executing one or more database queries, and

    • Generating a report.

    The report can be displayed in two forms:

    • Char t view—on the chart tab card (see Figure 1—1; chart types—section 4.5.1.1 on page 49).

    • Tab le view—on the table tab card (see Figure 1—2)

    The display format can be controlled by the user

    (several different chart types, chart colors etc., different forms of the representation of the

    table or chart).

  • 1 . O V E R V I E W – Q - M O N I T O R A N D I T S F E A T U R E S

    Copyright Dassault Systèmes 6 Q-MONITOR 5.6.X FOR V5

    Figure 1—1: Q-MONITOR window with a sample chart

  • 1 . O V E R V I E W – Q - M O N I T O R A N D I T S F E A T U R E S

    Copyright Dassault Systèmes 7 Q-MONITOR 5.6.X FOR V5

    Figure 1—2: Q-MONITOR window with a sample table

    The table view (Figure 1—1) and the chart view (Figure 1—2) are only different representations of one and the same report.

    The reports can be exported:

    • Charts in JPEG format (see section 4.5.1.8 Exporting a Chart)

    • Tables as column-separated text (EXCEL csv format) or as HTML file.

    The Q-MONITOR software package uses predefined, ready-to-use queries to simplify the

    user’s work. The user does not need specific database knowledge.

    The user need only make choices between different options–for example, is the query to be

    limited to a certain period of time, to a certain model directory, to a certain assessment

    result (e.g. “OK”, “defective“, etc.) or to some other criterion.

    The administrator of the user’s system can customize the queries using SQL, or can

    predefine custom, user-specific queries.

    Q-MONITOR is a JAVA application; hence it can be run with no problems on any computer

    whose operating system supports JAVA (WINDOWS, UNIX etc.)

  • 2 . Q - M O N I T O R G U I

    Copyright Dassault Systèmes 8 Q-MONITOR 5.6.X FOR V5

    2. Q-MONITOR GUI

    2.1 Q-MONITOR Main Window

    When Q-MONITOR is started, the Q-MONITOR Main Window is opened (see Figure 2—1). If

    you have not yet opened the Report dialog box/a report, the window will be empty.

    Figure 2—1: Q-MONITOR main window with no report opened

    When defining a new query or modifying an existing one, on the Q-MONITOR Window the

    Report dialog box with three tab cards is opened—Options , Graph and Table tab card,

    which will be described below (see Figure 2—2).

  • 2 . Q - M O N I T O R G U I

    Copyright Dassault Systèmes 9 Q-MONITOR 5.6.X FOR V5

    Figure 2—2: Q-MONITOR main window with Report dialog box

    Menu bar—for description refer to Menu Bar—unterhalb on page 10.

    Toolbar—for description refer to Figure 2—3.

    Report dialog box with Options, Graph and Table tab cards

    Options tab card

    On this tab card the settings for the query are made. For details refer to 4.4.2.3 Report Filter Options on page 30.

  • 2 . Q - M O N I T O R G U I

    Copyright Dassault Systèmes 10 Q-MONITOR 5.6.X FOR V5

    Graph tab card

    On this tab card the query result is displayed in form of a table report. For details refer to 4.5.1 Chart View on page 48.

    Table tab card

    On this tab card the query result is displayed in form of a chart report. For details refer to 4.5.2 Table View on page 57.

    Query button

    Clicking this button triggers the query operation.

    Status bar.

    • Menu Bar

    In the following we will describe only those menu items which need to be explained. For

    self-explanatory items (like File > Open Report ) no explanation is given.

    File

    > New Report New Report: Opening the Report Type Selection Dialog in order to create a new report template or a new report or to modify an existing report template

    (For general overview see Figure 4—2 Work steps to create a new report on page 23. For detailed information see sections 4.4.2 Report Type Selection Dialog on page 27; 4.4.2.1 Creating a New Report Using an Existing Report Template on page 28.)

    > Open Report Open report (See section 4.6. Opening an Existing Report)

    > Save Report Saving a newly created or modified report (To save the report t e m p l a t e see section 4.4.2.4 Saving a Report Template on page 46).

    > Close Report Quit Q-MONITOR.

    > Print Layout A dialog box is opened for the definition of the layout of a report to print out.

    (Details: 4.7 Pr int ing a Report on page 61.)

  • 2 . Q - M O N I T O R G U I

    Copyright Dassault Systèmes 11 Q-MONITOR 5.6.X FOR V5

    > Import Filter From an XML file the settings (filter restrictions) for the database query can be imported (cf. Export Filter below).

    > Export Filter Exporting the current settings (filter restrictions) made on the Filter tab card (cf. Figure 4—5: Report Filter Options on p. 31) for the database query in an XML file.

    > Exit Closing Q-MONITOR.

    Database

    > Define The Database connection definition dialog box is opened. (Details: 4.3.1 Defin ing Database Connect ions on page 18.)

    > Change password

    See 4.2 Changing Database Password on page 17.

    > Check criteria table

    With this menu item the database is checked for consistency. The result is displayed in message box.

    > Update criteria table

    Criteria table update adds to the database lacking rows for criteria names.

    If the database check (launched via menu item Database > Check criteria table) resulted in an error, it is mandatory to update the criteria table.

    Beside that we recommend to use this function in the following cases:

    • After a new Q-CHECKER version has been installed.

    • If a new Q-CHECKER check profile has been installed—recommended!

    > Create Database

    A dialog box is opened where the specifications are to be made for the SQL script creating the database tables. (Details: Q-MONITOR INSTALLATION GUIDE—section “Create Database Tables”).

    Report Type

    > New (SQL Wizard)

    The template wizard is opened. (Details: 4.4.1 Creating Report Templates with the Wizard on page 24.)

    > Save Current Settings / Save Current Settings as

    Saving a new or modified report type.

  • 2 . Q - M O N I T O R G U I

    Copyright Dassault Systèmes 12 Q-MONITOR 5.6.X FOR V5

    Window > Cascade | Ti le Horizon-tally | Ti le Vertically | Minimize All

    Controlling the arrangement of the report windows (in case that several reports are opened simultaneously).

    Extras

    > Global Options

    Controlling the Q-MONITOR options (details: APPENDIX—section 1. Q-Monitor Options on page 65)

    > Report Type Colors

    Defining the color options for individual report templates

    (Details: APPENDIX—2. Color def in i t ion for Indiv idual Report Types on page 71)

    > Save As Job After the options in the Report Options dialog box have been set, clicking this button generates a job file (*.job) containing the definitions (filter restrictions) for a database query, included the current DB connection. The job file can be used to execute database queries in batch mode.

    Help

    > Q-Monitor Help

    Opening Q-MONITOR Users Guide. (Cf. APPENDIX—Q-MONITOR Options—Help tab card on page 70.)

    > Q-Monitor Info

    Data about Q-MONITOR

  • 2 . Q - M O N I T O R G U I

    Copyright Dassault Systèmes 13 Q-MONITOR 5.6.X FOR V5

    2.2 Tool Bar

    Figure 2—3: Buttons on the Q-MONITOR toolbar

    New Report: Opening the Report Type Selection Dialog in order to create a new report template or a new report or to modify an existing report template

    For general overview see Figure 4—2 Work steps to create a new report on page 23. For detailed information see sections 4.4.2 Report Type Selection Dialog on page 27; 4.4.2.1 Creating a New Report Using an Existing Report Template on page 28.

    Open report See section 4.6. Opening an Existing Report

    Save report Saving a newly created or modified report (To save the report t e m p l a t e see section 4.4.2.4 Saving a Report Template on page 46).

    Close report

    Print report See section 4.7. Printing a Report

    Switch to the Filter options panel See section 4.4.2.3 Report Filter Options

    Switch to the Chart panel See section 4.5.1. Chart View

    Switch to the Table panel See section 4.5.2. Table View

    Switch to the Database definition dialog.

    See section 4.3.1 Defining Database Connections

    Export chart See section 4.5.1.8. Exporting a Chart

    Export table The table can be exported as csv file (i. e. column-separated text file) or as HTML file.

  • 2 . Q - M O N I T O R G U I

    Copyright Dassault Systèmes 14 Q-MONITOR 5.6.X FOR V5

    Controlling the arrangement of the report windows (in case that several reports are opened simultaneously).

    Cascade the report windows

    Tile the report windows horizon-tally

    Tile the report windows vertically

  • 3 . Q - M O N I T O R O P E R A T I O N M O D E S

    Copyright Dassault Systèmes 15 Q-MONITOR 5.6.X FOR V5

    3. Q-MONITOR Operation Modes

    Q-MONITOR can be run in three different modes:

    (1) Native Q-MONITOR mode—

    refer to section 3.1 Starting Q-Monitor in Native Mode on page 15.

    (2) Applet mode—

    refer to section 3.3 Running Q-Monitor as Applet on page 16).

    (3) Batch mode—

    refer to section 3.2 Q-MONITOR in Batch Mode on page 15).

    3.1 Starting Q-MONITOR in Native Mode

    To start Q-MONITOR in native mode:

    • WINDOWS: Run the qmonitor.bat file

    • UNIX: Execute the qmonitor.ksh file .

    To facilitate starting Q-MONITOR, an icon with a link to the Q-MONITOR startup file can be

    placed on the desktop. If this has been done, a click (or double-click) on the icon will start

    Q-MONITOR.

    3.2 Q-MONITOR in Batch Mode

    Q-MONITOR can be run batch mode to generate a report in CSV or HTML format.

    In batch mode, Q-MONITOR requires a job file containing the report options. To create a

    job file with the current settings from the Report Options dialog, choose Extras > Save

    as Job .

    For further information, ask your administrator or refer to Q-MONITOR Installation Guide,

    section “Installing Q-Monitor Application”.

  • 3 . Q - M O N I T O R O P E R A T I O N M O D E S

    Copyright Dassault Systèmes 16 Q-MONITOR 5.6.X FOR V5

    3.3 Running Q-MONITOR as Applet

    Since version 2.1.1 Q-MONITOR can be run as applet from an internet browser. This allows

    to start Q-MONITOR from an HTML site.

    Abb. 3-1: Example: Q-MONITOR start button to start Q-MONITOR from an HTML site (the real appearance of the button depends from the design of the HTML site)

    Q-MONITOR will be started when clicking this button. Q-MONITOR in the applet mode has

    the same functionality as Q-MONITOR has in the native mode—the user can create, save

    and print out Q-MONITOR reports. The only difference is that the user can not change

    database connections and save changes in the *.ini file.

    (For detailed information for administrators refer to Q-MONITOR INSTALLATION GUIDE.)

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 17 Q-MONITOR 5.6.X FOR V5

    4. Working with Q-MONITOR

    4.1 Automatic Connection Check

    When starting Q-MONITOR, automatically the connection to the database is established.

    For that the database connection settings are used that were saved last. If Q-MONITOR is

    started with no message box and no Database Connection dialog box opened, the

    database connection has been established successfully.

    If the connection could not be established, a warning message box and the Database

    Connection dialog box are displayed (see Figure 4—1 on page 19). In the Database

    Connection dialog box the connection settings can be modified and tested (see 4.3.1

    Defining Database Connections on page 18).

    After Q-MONITOR has been started, the main window is opened (see section Figure 2—1

    on page 8).

    4.2 Changing Database Password

    Since Q-MONITOR version 2.2.1 it is possible to change the database password of the current database user. To change the password, use the following menu item in the Q-MONITOR menu bar:

    Database > Change Password .

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 18 Q-MONITOR 5.6.X FOR V5

    4.3 Database Connection and Database Control

    The Database menu offers the following items to control the interaction with the database:

    • Database > Define Defining and testing database connections, see section 4.3.1 Defining Database Connections on page 18.

    • Database > Change Password See section 4.2 Changing Database Password on page 17.

    • Database > Check Criteria Table Testing the referential integrity of the database, see section 4.3.2 Checking and Updating the Criteria Table on page 20. • Database > Update Criteria Table

    4.3.1 Defining Database Connections

    To define a database connection, press the Database definition button on the Q-MONITOR toolbar. The Database Connection dialog (Figure 4—1) will then open.

    There are three ways to define database connections:

    (1) Co p y an ex i s t in g , p rede f ined da tabase co nnec t io n de f in i t io n into combo box and change its name. In this case, there is no need to enter values in text boxes to .

    (2) Change a predefined da tabase co nnec t io n : Select a name of a predefined database connection from the list and enter the required data in text boxes to .

    (3) Crea te a new da tabase co nnec t io n : Enter the name of the new database connection in box , then enter the required data in text boxes to .

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 19 Q-MONITOR 5.6.X FOR V5

    Figure 4—1: Database connection definition dialog

    To create a new database connection, input the following data:

    Name o f the co nnec t io n .

    The exact data must be provided by the user’s database administrator.

    Your da tabase use r name .

    The associated da tabase use r p assw o rd .

    Database t yp e : select from the list in the list box.

    Database name .

    JDBC p o r t number .

    Serve r na me , i. e. the name of the computer where the database runs.

    By pressing the Test button it will be tested:

    • The physical connection to the database; • The existence of the tables CHECK_SESSION, CHECK_CRITERION and

    CRITERION_INFO;

    • The database access authorization of the user.

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 20 Q-MONITOR 5.6.X FOR V5

    To close the Database connection window w i tho ut sav in g , p ress t he Cancel but to n .

    To add the new connection definition to the ini f i l e , p ress Sav e .

    To de l e t e the displayed connection from the ini f i l e co mp le te l y , press Delete. The data for the next available connection in the ini f i l e will then be displayed.

    4.3.2 Checking and Updating the Criteria Table

    When a newer Q-CHECKER version was installed on your computer, the criteria numbers in

    the criteria table (i. e. the CRITERION_INFO table) may differ from the criteria numbers of

    Q-CHECKER’s criteria list. This results in a missing referential integrity between the

    CRITERION_NUMBER entries of the CHECK_CRITERION table and the CRITERION_INFO

    table: while Q-CHECKER writes the numbers of the new criteria in the CHECK_CRITERION

    table, in the CRITERION_INFO table written by Q-MONITOR this new numbers and the

    respective criteria names are lacking. If Q-MONITOR queries were made using this

    incomplete CRITERION_INFO table, the Q-MONITOR reports could be incorrect; at least

    for the new criteria in the reports no names would appear.

    To avoid this problem, the user should p e r io d i ca l l y e xecu te a check o f the c r i t e r i a t ab l e , and, if non-consistency has been detected, update the criteria table—for detailed information refer to the following text.

    • Checking the Criteria Table

    To check the criteria table, select the menu item Database > Check Criteria Table.

    If an inconsistency is detected between the CRITERION_NUMBER entries of the

    CRITERION_INFO table and the CHECK_CRITERION, a message will be displayed:

    • Updating the Criteria Table

    To update the CRITERION_INFO table, proceed as follows:

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 21 Q-MONITOR 5.6.X FOR V5

    (1) Select the Database > Update Criteria Table menu item.

    (2) In the dialog, choose the indicated subdirectory and file inside your Q-Checker installation directory:

    Q-CHECKER for V4 Release 1.x:

    adminV4//db/CRITERIA.par

    Q-CHECKER for V5 Release 2.x:

    adminV5//db/CRITERIA.par

    Q-CHECKER for V6 Release 1.x:

    adminV6//db/CRITERIA.par

    Q-CHECKER for V5 Release 5.x / Q-CHECKER for V6 Release 2.x:

    admin//qchecker.qcenv

    Where is the directory containing the Q-CHECKER environment.

    (3) To confirm, click the Open button.

    The entries in the CRITERION_INFO table now will be updated. The update result will be displayed in a message box:

    • Message in case of successful update

    • Message in case of error:

    A wrong file was selected that contains no criteria definitions.

    • Message in case of error:

    This error can occur when you have updated Q-CHECKER from release 5.6.x or newer from an earlier release. In this case, the CRITERION_NAME table must be updated to the new structure (cf. Q-MONITOR Installation Guide—section Database Structure).

    To update the database structure, use the DBCREATOR program (for the detailed instruc-tion see Q-MONITOR INSTALLATION GUIDE).

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 22 Q-MONITOR 5.6.X FOR V5

    • Message in case of error:

    This error can occur if the Q-CHECKER environment includes a language for which no column has been defined in the database, for example Japanese.

    Possible solutions:

    – Create a column for every additional language in the database.

    – If an additional language is not needed, remove it from the Q-CHECKER environment.

    How to remove a language:

    Q-CHECKER for V5 Release 2.x / Q-CHECKER for V6 Release 1.x:

    Open the TCACriterionTable.exe utility from the Q-CHECKER binary directory, and load the CRITERIA.par file of the environment. Choose Edit > Used Languages , and remove the unused language code from the list.

    Q-CHECKER for V5 Release 5.x / Q-CHECKER for V6 Release 5.x:

    Open the Q-CHECKER environment editor and load the environment. In the Regional Settings dialog, mark the respective language and click the Remove button.

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 23 Q-MONITOR 5.6.X FOR V5

    4.4 Creating New Reports

    Figure 4—2: Work steps to create a new report

    YES—under a new name

    You want to create a new report

    Use an existing report

    template?

    YES

    NO

    Modify the query with the Report Editor Dialog

    See section 4.4.2.2

    If necessary, define / modify options

    See section 4.4.2.3

    Create a new report template by using the template wizard

    See section 4.4.1

    Create the new report

    See on page 32 and section 4.5 on page 47

    Modify the

    query?

    NO

    Open an existing report template

    See section 4.4.2

    YES

    YES—under its old name

    Save the report

    template (see section

    4.4.2.4)

    NO

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 24 Q-MONITOR 5.6.X FOR V5

    What is a report template?

    A report template is a set of predefined commands and settings used to create a report. Using a template, the user need not define all the com-mands and options for a new report each time. The template contains the following definitions: The o b l i ga to r y part of the report template:

    the SQ L co mmands —they define which data will be read out of the data base and which operations will be made with them (this part is written in SQL syntax either directly in the SQL editor or by means of the report wizard).

    The o p t iona l part of the report template: the o p t ions for the data representation, specified by means of the report options dialog (Options tab card) and the Graph and Table tab cards—the options control which of the data output as the result of the database query will be represented in table or chart form and how will be their graphical representation.

    4.4.1 Creating Report Templates with the Wizard

    The wizard helps the user to create several types of report templates for the most

    common types of Q-MONITOR database queries. This facility accelerates the process of

    creating report templates and also allows users that have no knowledge of SQL to create

    report templates. Below you will find examples for all the template types that the Report

    Templates Wizard can create.

    • Available Query Types

    • Type: Display columns

    This query type selects only columns to be sho w n with their data, but with no calculation made on them.

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 25 Q-MONITOR 5.6.X FOR V5

    • Type: Co unt u p the number o f d i s t inc t co lumn va lues

    This query type counts the number of occurrences of the different entries in a column (but does not add up the values of the entries).

    In the example table you can see how often the different check profiles have been used for checking.

    • Type: Sum co lumn va lues

    This query type adds up the values of the different entries in a column.

    In the example table you can see the sum of the error weights of the models in the different directories.

    It is possible to define grouping columns what allows to structure the result in details. This example table in comparison to the table above gives the sum of the error weights not only for directories, but for the check profiles used for the models in the different directories.

    • Type: Ave rage o f co lumn va l ues

    This query type calculates the average of the entries in a column.

    In the example table you can see the average error weight of the models of different suppliers.

    For this type grouping also is available. The example table gives the average error weight for the different criteria and for the respective suppliers.

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 26 Q-MONITOR 5.6.X FOR V5

    H o w t o p r o c e e d

    (1) Open the menu item Template > Wizard. The Report Template Wizard will open.

    For the next steps follow the instructions on the wizard’s tab cards. When you have made your specifications on a tab card, press the Next button to proceed to the next tab card. Depending on the selected report template type, not all tab cards will be active.

    (2) Se lec t t yp e . On the Query Type tab card select the report template t yp e you want to create.

    For the description of the types see Avai lable Query Types on page 24.

    (3) S e l e c t co lumns . The tab card that will appear the next is the tab card of your selected type. Select here the column you want to use for the report. For the display data type you can select seve ra l columns.

    (4) Se lec t co lumn fo r g ro up ing . On the Grouping columns tab card one or more additional columns can be selected if it is desired to structure the results.

    F o r examples for grouping see the sum and the average types under Avai lable Query Types on page 24.

    Grouping is available only for the sum and the average types.

    (5) Change the o rde r . On the Order tab card you can change the order of the columns.

    (6) Def ine th e so r t sequence . On the Sorting tab card you can define the sort order for the selected columns.

    (7) Tes t yo ur sp ec i f i ca t io ns . On the Run tab card you can control whether your specifications made on the pre-ceding tab cards result in the desired table. To do so, press the Run button. If you have obtained the desired result, press the Next button. If the result is not satisfying, press the Back button to go to the preceding tab cards to modify the specifications. When your modifications are done and you want to get the new table, press the Run button again.

    (8) Sp ec i f y names . On the Save tab card, you can replace the default names for the report and the axes, by specifying your own names.

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 27 Q-MONITOR 5.6.X FOR V5

    (9) Save the r ep o r t t emp la te . When you press the Save button, the report template will be saved under the name specified in the Name text box.

    T I P S :

    Q-MONITOR has no facility to visualize the SQL commands but the Edit dialog box. Therefore it is recommended to use meaningful names for the report templates, making transparent for every user the use of the report template.

    If you press, instead of the Close button, the Save button a seco nd time when closing the dialog, a message box will be opened informing that a report with this name still exists.

    However you can save a report template—as it is or modified—under an other name.

    (10) Clo se the Wiza rd d ia lo g .

    The new defined report template you will find in the Report Definition dialog box in top

    position. If you want to bring it in an other position, use the Up and Down buttons.

    4.4.2 Report Type Selection Dialog

    Every report is created on the base of a r ep o r t t emp la te .

    To select a report template, you must open the Report Type Selection dialog

    To open the Report Type Selection dialog:

    • Click on the New Report button in the Q-MONITOR toolbar

    or

    • Click New on the File menu.

    The screenshot of the Report Definition dialog box is shown in Figure 4—3.

    With this dialog box you can:

    • Select one of the existing report templates to create a report—

    see section 4.4.2.2 Report Editor Window on page 29;

    • Create a new report template on the base of one of the existing report templates—

    see section 4.4.2.1 on page 28.

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 28 Q-MONITOR 5.6.X FOR V5

    • Modify existing report templates—

    same procedure as for creating new report templates on the base of existing reports,

    the only difference is that the template is saved under its old name (while for a new

    report template—under a new name).

    4.4.2.1 Creating a New Report Using an Existing Report Template

    S t e p s :

    (1) Open the Report Definition dialog, us described above in section 4.4.2.

    (2) Define a new report as follows.

    Figure 4—3: Report Type Se lect ion dialog

    To define a new report:

    Select a database connection in the list box.

    Choose a report type in the list (the features of the report can be subsequently modified and/or expanded upon)

    When you have selected a database connection and a report template, cl ick OK to proceed to the Report options dialog. (The report options dialog is described in section 4.4.2.3 Report Filter Options on page 30.)

    To edit a selected report type, press the Edit button. The Report Editor window then will open—see section 4.4.2.2 Report Editor Window on page 29.

    Press this button if you want to de le t e a report type.

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 29 Q-MONITOR 5.6.X FOR V5

    NOTE

    Once a report type is deleted, it is no more available for further work.

    After deleting the report type is still available in the backup file of the *.ini file can, so that the report type can be restored by renaming the backup file of the *.ini file from *.bak into *.ini.

    But if you have removed ano the r report type, the backup file has been overwritten again, and the report type that has been deleted first, will be no more available at all.

    To close the Report Definition window, c l i c k Cance l .

    Use these buttons to move down or up in the report types list.

    4.4.2.2 Report Editor Window

    The Report Editor window allows to write the SQL commands for the database queries

    or to modify these commands. This editor is to be used only by administrators that have

    knowledge of SQL syntax. Persons that have no SQL knowledge can define several base

    queries by means of the SQL wizard (see section 4.4.1 Creating Report Templates with

    the Wizard on page 24).

    Figure 4—4: Report Ed i tor dialog

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 30 Q-MONITOR 5.6.X FOR V5

    Report Type Name text box

    Here the report type name can be modified. This allows to create a report type with a new name.

    SQL editing box

    Here the definitions of the report type can be modified.

    Save button

    To save the modifications made on the selected report type, c l i c k Sav e .

    Close button

    To close the Report Editor window w i tho ut ed i t ing th e r ep o r t t yp e , c l i c k Cance l . After closing, you will return to the Report Definition dialog.

    4.4.2.3 Report Filter Options Panel

    In the Report Options dialog (Options tab card, see Figure 4—5) you can define the

    options of the current report template or modify them. The dialog allows you to:

    • Specify which data will be gathered for

    the report (the scope of the database

    query) and how it will be displayed.

    You can restrict the scope of a query with criteria involving

    • Model name

    • Model size

    • Date

    • Any other parameters displayed in the Options window.

    • Define the parameters for the comparison option

    (cf. section 4.4.2.3.1 Comparison Option).

    • Limit the number of the table records displayed in a chart or in a summary data block.

    • Specify the display of the values as either amounts or percentages.

    The options settings have no influence on the query, they control only which of the data resulting from the query are represented in the report table or report chart and in which form.

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 31 Q-MONITOR 5.6.X FOR V5

    Figure 4—5: Report F i l te r Opt ions tab card

    Open the Report Filter Options tab card.

    Activate the comparison option. See section 4.4.2.3.1 Comparison Option Define the parameters for the comparison option.

    The bar situated under the comparison option bar can be:

    (1) A block bar or See section 4.4.2.3.2 Block Data Values Option.

    (2) A Display rows bar (depending on the query type)

    See section 4.4.2.3.3 Display Rows Option.

    With the blocking options bar the rows to be displayed by blocking can be summarized.

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 32 Q-MONITOR 5.6.X FOR V5

    With the number of values bar the number of rows can be restricted.

    Restriction options See section 4.4.2.3.4 Filter Options.

    Custom column (user-defined restriction option)—as an example

    Query button

    After defining all the options and their respective parameters, click this button to start the query. The report will be built up and subsequently displayed.

    When the report is being generated, the following message box is displayed:

    Stop button

    The Stop button can be used to abort the query process when it lasts to long (e. g. due to a disadvantageous query definition as e. g. to big amount of data, broken database connection, database problems).

    Hide button

    Striking this button transfers the message box from the foreground (the message box being always visible) to the background.

    4.4.2.3.1 Comparison Option

    With the comparison option you can unite the results of several queries and display them

    in a s ing l e report. The individual queries have some parameters in common, but differ

    in one option, the option on which the user wishes to do the comparison. Displaying the

    results of these queries in one table or chart facilitates the comparison.

    Example:

    Assume you have a report that delivers a two-column table. In the first column are the

    names of the model assessments, and in the second are the numbers of models that

    received the associated assessment.

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 33 Q-MONITOR 5.6.X FOR V5

    Model assessment Number of models

    Faulty 1730 KO (needs intensive care) 201 Defective 99 Interrupt Criterion failed 11 In Order (OK) 159

    With the comparison option activated, the report can (but does not have to) contain

    more than two columns.

    We can, for example, compare the quantitative distribution of the model assessments over

    different time periods. If, in our example, we choose three two-week periods as the

    comparison option (i.e. a restriction in time and a time period split into three intervals),

    the result might be as follows:

    Model assessment 15.07.2001—28.07.2001

    29.07.2001—11.08.2001

    12.08.2001—25.08.2001

    Faulty 187 883 654 KO 55 50 1 Defective 6 28 65 Interrupt Criterion failed 3 8 0 In Order (OK) 0 1 2

    Figure 4—6: Comparison option control elements

    Check box for the comparison option

    If the comparison option is activated:

    • The results table will contain mo re than tw o co lumns ; and

    • the results chart will be displayed as a 3 -D cha r t , i f p o s s ib l e .

    Comparison options l ist box

    With this list box, you specify which field in the database record (i.e. which column of the CHECK_SESSION table) will be used as comparison option. The field selected will contain data of one of the following data types:

    • DATE (description see section DATE-Type )

    • INTEGER (description see section INTEGER-Type )

    • TEXT (description see section TEXT-Type ).

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 34 Q-MONITOR 5.6.X FOR V5

    Each of these types has a d i f f e ren t match c r i t e r i a in p u t mask . The different input masks will be described in the following sections.

    • DATE-Type Comparison Option

    If in the comparison option list box a field containing date-type data is selected, the

    following match criteria input mask is displayed:

    Figure 4—7: Input masks for date-type data. —Fig. above: selection of an interval-split period of time. —Fig. below: selection of variable periods of time.

    Activate the comparison option

    Select a field containing date-type data.

    Click on this buttons to specify the start and the end date . The Calendar window will be opened (see Figure 4—8).

    Select “interval” or “variable”:

    • In case of “interval” one only period of time split by intervals can be defined.

    • In case of “variable” several periods of time with variable duration can be defined.

    Define interval length

    The + button is available in case of “variable”. Click this button to add the defined space of time to the list .

    The list contains all defined periods of time.

    Click this button to delete the period of time, selected in list .

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 35 Q-MONITOR 5.6.X FOR V5

    Figure 4—8: Calendar dialog box

    NOTE

    To avoid troubles when specifying dates, observe the order Year—Month—Day .

    Year l ist box:

    Select a year.

    Month l ist box:

    Select a month.

    Selected day:

    When a day is selected in the date table , the day of the month appears in this space.

    Today button:

    If you want to specify the today’s date of the current day press this button. Using this button you do not need specify separately day, month, and year.

    Min or max. button:

    With this button the first or last date of all checks saved in the database can be set. Using this button, you do not need specify separately day, month, and year.

    Day table:

    Click on a number to select the required day.

    OK button:

    Click this button when you have finished your selection. The dialog box will be closed.

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 36 Q-MONITOR 5.6.X FOR V5

    Close button:

    Click on this button if you want to close the calendar dialog without using the date selection.

    Example:

    In Figure 4—7 the start date of 15.7.2001 (the 15 July 2001), an end date of 25.8.2001 (the

    25 August 2001) and an interval of 14 days are chosen. That means that only database

    entries with dates between 15 July 2001 and 25 August 2001 will be retrieved, and that the

    data for displaying will be grouped into 14-day periods.

    In chart form, the result will displayed as follows:

    Figure 4—9: Chart, in which the model assessments are compared for three periods of time

    • INTEGER-Type Comparison Option

    If in the comparison option list box integer-type data are selected, the following match

    criteria input mask is displayed:

    Figure 4—10: Input mask for match criteria for integer-type data

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 37 Q-MONITOR 5.6.X FOR V5

    Select integer-type data.

    In the text field, you can type the comparison expressions in manually.

    The expressions must be separated by two ampersands: && . (The double ampersands cause the results to be placed in separate columns.)

    The following table (Figure 4—11) illustrates how to define a match interval for integer data types:

    MIN, AVG and MAX buttons

    By clicking this buttons the minimum, average and the maximum value respectively is set.

    Expression Significance Example Values corresponding to the example

    -number Less then or equal to number -2 0, 1, 2

    number1-

    number2

    Greater than or equal to number1 and less than or equal to number2

    12-14 12, 13, 14

    number- Greater than or equal to number 16- 16, 17, 18 ...

    Figure 4—11: Expressions defining integer intervals as comparison criteria

    Example:

    With the values shown in the Figure 4—10 column 3, you get a result with four data rows/

    columns (see Figure 4—12).

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 38 Q-MONITOR 5.6.X FOR V5

    Figure 4—12: Chart with integer-type data as comparison option

    • TEXT-Type Comparison Option

    If in the comparison option list box are selected text -type data, the following input

    mask is displayed:

    Figure 4—13: Input mask for match criteria for text-type data

    Select selected text -type data.

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 39 Q-MONITOR 5.6.X FOR V5

    Restriction Text Box

    Text in this box defines filter restrictions for the selected option.

    In other words:

    You can define what of the current option you want to include in the query.

    If the box is empty, the query for the current option is not restricted. It means that all values of the option will be included in the query.

    There are two ways to enter text in the Restriction text box:

    (1) Restriction text can be typed into the text box manually.

    (2) Entries selected in the panel which is opened after clicking on the List button are added automatically to the text box. The text entered in this way subsequently can be modified manually.

    NOTE:

    • The asterisk * can be used as wildcard. It matches any character or sequence of characters.

    • The expressions entered for each comparison must be separated by double ampersands && (see Figure 4—14). You can add these characters manually as you type the expressions in the text box. (The double ampersands cause the results to be placed in separate columns.)

    • When you separate the expressions by a double pipe || , the result values will be added on a l i ne -b y - l ine ba s i s and displayed in o ne column.

    double ampersands

    Figure 4—14: Example: Several model names are selected for use by the comparison option

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 40 Q-MONITOR 5.6.X FOR V5

    Examples:

    With double ampersand && : B*&&C* is entered in the text box in Figure 4—13. The report table will contain:

    • In the first column – the summary of errors for all models whose names start with B ,

    • in the second column – the summary of errors for all models whose names start with C .

    If no va lu e is entered in the text box, a l l i n d i v idua l va lues of the selected column (e.g. model names, user names etc.) will be displayed in the report table/chart.

    With double pipe || : MOD1&&MOD2||MOD3 is entered in the text box. The report table will contain two columns. The first column will show the result for the model MOD1, the second the sum of the results for models MOD2 and MOD3.

    As an alternative to entering filter text manually, you can click on the List button. This opens the Comparison Values dialog box in which you select items to be included in the Filter text box . See Figure 4—15.

    Figure 4—15: Values list in the Comparison Values dialog box

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 41 Q-MONITOR 5.6.X FOR V5

    In the values list you can choose one or several values (here, model names).

    You can select two o r mo re sep a ra te items: Press and hold the Ctrl key and click the items with the left mouse button. You can select two o r mo re su ccess i ve items: Press and hold the Shift key and click the f i r s t and the l as t i t em with the left mouse button.

    When you have selected all the items desired, press the OK button.

    If you have selected more than one item, check/correct the double ampersand && and

    double pipe || separators appearing in the Comparison Text box (see Figure 4—14, see

    explanation earlier in this section).

    Clear button

    Clicking this button clears the Restricting text box .

    4.4.2.3.2 Block Data Values Option

    With the data blocking option (Figure 4—16) you can group multiple rows of the result

    table into blocks.

    Figure 4—16: Block option bar

    Enter the start value

    (i.e. the number of the f i r s t row to be included in the blocking operation).

    Enter the step value (i.e. the number of rows to be included in o ne block).

    Enter the end value (i.e. the number of the l as t row to be included in the blocking operation)

    When you have entered all the values, you can start the blocking operation by clicking Apply .

    Example:

    You want to generate a report based on a result table with 100 rows, a quantity which can not be shown on a chart.

    You define the blocking values as shown in Figure 4—16.

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 42 Q-MONITOR 5.6.X FOR V5

    After blocking you get a summarized result table that consists only of e igh t rows. (The start value is the 10th row, the end value is the 90th row. The rows are summarized by blocking 10 rows to 1 row.)

    The result of a blocking operation is a summarized result table.

    This summarized table is smaller than the initial result table and thus can be displayed as a chart.

    NOTE:

    • Blocking is a local operation. When you press the Apply button, no new database query will be made— only the result table from the last database query will be modified.

    4.4.2.3.3 Display Rows Option

    If the value of the tag in the ini file is NUMBERING, the second bar is

    displayed as a Display Rows bar (Figure 4—17).

    The Display Rows bar allows to reduce the number of rows that are included in a report.

    Figure 4—17: Disp lay Rows option bar

    Enter the start value

    (i.e. the number of the first row to be included in the report).

    Enter the number value (i.e. the number of rows to be included in the report).

    If you activate the %-Values check box, the values of the result table will be recalculated and displayed as percentages.

    When you press the Apply button, recalculation will be started.

    (Recalculation can be executed with check box either activated or deactivated.)

    Example:

    With the entries shown in Figure 4—17 you will obtain a report that displays five rows of the initial result table, the first of them is the 3rd row.

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 43 Q-MONITOR 5.6.X FOR V5

    NOTE:

    • The Display Rows options (or, if speaking in other terms, limitation features) are l o ca l operations. When you press the Apply button, no database query will be made— only the result table from the last database query will be modified.

    4.4.2.3.4 Filter Options

    All options bars situated under the first two option bars are filter (or restriction) options.

    The filter options bars can be identified by their light-gray color.

    The restriction options are another series of filters that allow restricting the report to a

    certain focus.

    Any of the main attributes of a Q-CHECKER check result can be used to restrict the results

    list.

    Each column of the check session result table can (as is the case with the Compari-

    son Option) contain data having one of three data types:

    • TEXT

    • INTEGER or

    • DATE .

    Each data type has his specific match criteria input mask, in a form of a bar. These masks

    will be described in the following sections: Restriction Options bar for TEXT values (page

    44), Restriction options bar for DATE values (page 46), Restriction Options bar for

    INTEGER values (page 45).

    Example:

    If you want to analyze only the checks made in August 2001, you can restrict the scope of the report to that period of time.

    Figure 4—18: Number of values option bar

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 44 Q-MONITOR 5.6.X FOR V5

    • Restriction Options bar for TEXT values

    If the selected restriction column contains data of the text data type, the following match

    criteria input mask is displayed:

    Figure 4—19: Restriction options bar for text values

    The restriction option can be activated (or deactivated) by clicking with the mouse.

    When activated, a check is shown.

    Filter text box

    Text in this box defines option values which restrict the query.

    If the box is empty, there is no restriction applied by this option.

    There are two ways to enter text in the filter text box:

    (1) Filter expressions can be typed into the text box manually.

    (2) Entries selected in the panel which is opened after clicking on the List button are added automatically to the text box. The text entered in this way can be modified later manually.

    NOTE:

    • The asterisk * can be used as wildcard. It matches any character or sequence of characters.

    • The expression entered for each restriction must be separated by double pipes || .

    • If you want to e xc lude a value, use two pipes and an exclamation point between them |!| .

    E xamp le : The expression USER*|!|USER25 causes the data for all users except that of USER25 to be included in the report.

    List button

    Clicking the List button opens a window with a list of all the values available for the current restriction option.

    When the list contains a too big number of values, the list can not be opened; a message will be displayed.

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 45 Q-MONITOR 5.6.X FOR V5

    In this case, in the filter text box a filter expression must be specified (or the existing filter expression must be modified) to restrict the query more. When the number of values in the list is restricted enough, the list will open.

    E xamp le : With the filter text shown in Figure 4—19, a report will be displayed which includes checks with the model assessments “ERROR”, “OK” or “KO”.

    Clear button

    Clicking this button clears the Restricting text box .

    • Restriction Options bar for INTEGER values

    If the restriction column selected contains data of the integer data type, the following

    input mask is displayed:

    Figure 4—20: Restriction options bar for integer number values

    The restriction option can be activated by clicking with the mouse.

    When activated, a check is shown.

    Comparison operator l ist box

    Choose between the operators from, >,

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 46 Q-MONITOR 5.6.X FOR V5

    • Restriction options bar for DATE values

    If the restriction column selected contains data of the date data type,

    the following input mask is displayed:

    Figure 4—21: Restriction options bar for date values

    The restriction option can be activated by clicking with the mouse.

    When activated, a check is shown.

    Set button for the start date.

    Press the button and choose the start date in the calendar window (Figure 4—8).

    Set button for the end date.

    Press the button and choose the end date in the calendar window (Figure 4—8).

    Example:

    With the settings shown in Figure 4—21, only checks made between 15 August 2001 and 14 November 2001 will be included in the report.

    4.4.2.4 Saving a Report Template

    To save a Report Template, use the menu items:

    • Template > Save Use this item to save the modified settings in the c u r ren t report template.

    • Template > Save as Use this item to create a new report template.

    Report templates are saved in the *.ini file of Q-MONITOR as a block, limited by the tags

    … .

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 47 Q-MONITOR 5.6.X FOR V5

    T I P :

    Q-MONITOR has no facility to visualize the SQL commands but the Edit dialog box. Therefore it is recommended to use meaningful names for the report templates, making transparent for every user the use of the report template.

    4.4.2.5 Export and Import of Query Options

    The currently defined set of options can be exported, or a saved set of options can be

    imported. The exported data comprise all specifications made on the Report Options tab

    card. The export and import offers the following advantages:

    • Time savings:

    Importing a similar, previously defined set of options, means that the user need not

    define all the options for a new query each time.

    • Standardization:

    Different users can work with uniform, consistent sets of options.

    The files in which the options are stored have the extension .qmo .

    To export query options, pull down the File menu and click Export Options .

    To import query options, pull down the File menu and click Import Options .

    4.5 Displaying the Report

    When the report options and criteria are defined correctly and the DO QUERY button in

    the options window is pressed, the report will be generated.

    Reports can be displayed in two forms:

    • As a report results table (Figure 4—36, Figure 4—37).

    • As a results chart (also referred to as a diagram or graph).

    Depending on the type of report selected, it is sometimes impossible to generate a

    chart (for instance, if the report is defined so as to produce a table with text values).

    If chart display is possible, graph view will automatically be selected. (Figure 4—22).

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 48 Q-MONITOR 5.6.X FOR V5

    4.5.1 Chart View

    In the chart view, the report is displayed in the form of a chart ( – in the Figure 4—22). The chart representation can be modified using the control bar at the bottom ( – in the Figure 4—22).

    Figure 4—22: Chart view

    Report chart panel

    • Report name • Report legend

    The legend is only shown if the Legend check box is activated.

    • Report chart Control bar

    The Control bar includes different control elements that make it possible to display the report in different forms.

    • Chart types list box See section 4.5.1.1 Chart Types. • Swapped check box See section 4.5.1.2 Swapped Check Box.

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 49 Q-MONITOR 5.6.X FOR V5

    • Vertical check box See section 4.5.1.3 Vertical Check Box. • Legend check box See section 4.5.1.4 Legend Check Box. • Value text check box See section 4.5.1.5 Value Text Check Box. • 3-D check box See section 4.5.1.6 3-D Check Box. • Rotation Arrows See section 4.5.1.7 Rotation Arrows. 4.5.1.1 Chart Types

    Report charts or charts can be

    displayed in different forms.

    To switch to another chart type,

    choose the desired type name in

    the Chart types list box and

    click at it.

    The available chart types are:

    • Band

    • Bar

    • Grouped bar

    • Pie

    • Ring

    • Scatter

    • Spline

    • Stacked bar

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 50 Q-MONITOR 5.6.X FOR V5

    Figure 4—23: Chart type examples: ring chart, spline chart, stacked bar (column) chart

    4.5.1.2 Swapped Check Box

    Activating or deactivating the Swapped check box causes the existing report to be

    represented in a modified form: in the results table the rows and the columns are

    interchanged (the rows become columns, and the columns become rows), the

    representation of the chart is changed. (Figure 4—24, Figure 4—25).

    Figure 4—24: Swapped check box deactivated Figure 4—25: Swapped check box activated

    Flipping

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 51 Q-MONITOR 5.6.X FOR V5

    4.5.1.3 Vertical Check Box

    By activating or deactivating the vertical check box the chart can be flipped 90º (Figure

    4—26, Figure 4—27).

    Figure 4—26: Vertical check box activated (column chart)

    Figure 4—27: Vertical check box deactivated (bar chart)

    Activating or deactivating the Vertical check box causes the existing report to be represen-ted in a new form: the report data is assigned to different axes with the vertical and horizontal axes of the chart being interchanged.

    Flipping 90°

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 52 Q-MONITOR 5.6.X FOR V5

    4.5.1.4 Legend Check Box

    If the Legend check box on the left side of the window is activated, the chart legend is

    shown. If the check box is deactivated, the legend is hidden (Figure 4—28, Figure 4—29).

    Figure 4—28: Legend check box deactivated

    Figure 4—29: Legend check box activated

    Legend

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 53 Q-MONITOR 5.6.X FOR V5

    4.5.1.5 Value Text Check Box

    If the value text check box is activated the corresponding numeric values are shown in parenthesis (Figure 4—30).

    Number values in parenthesis

    Figure 4—30: Value Text check box activated

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 54 Q-MONITOR 5.6.X FOR V5

    4.5.1.6 3-D Check Box

    The 3-D check box switches between the 2-D and the 3-D views (Figure 4—31, Figure 4—32).

    Figure 4—31: 3-D check box deactivated. The chart is displayed in a 2-D view.

    Figure 4—32: 3-D check box activated. The chart is displayed in a 3-D view.

    2-D 3-D

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 55 Q-MONITOR 5.6.X FOR V5

    4.5.1.7 Rotation Arrows

    Figure 4—33: Rotation arrows

    (3-D check box activated)

    The rotation arrows rotate the chart. Clicking on the button in the center (round arrow with point) returns the chart to its initial

    position.

    NOTE:

    • Precondition for rotating: the 3-D check box must be a c t i va ted .

    T I P : It is easier to rotate the chart using the mouse . To do so, press and ho ld the midd le and the r i gh t mo use bu t to ns . It does not matter whether the 3-D check box is activated or not—when you start the rotating action with the mouse, the view is automatically switched to 3-D.

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 56 Q-MONITOR 5.6.X FOR V5

    4.5.1.8 Exporting a Chart

    If you want to export a chart click on the JPEG Export button. The JPEG export dialog will open (see Figure 4—34).

    Figure 4—34: Chart export dialog

    Choose the d i r ec to r y where the chart is to be saved as a file.

    Choose a valid name for the file or enter a new name.

    The chart can be saved only in the JPEG fo rmat . (The All f i les (*.*) entry in the list box has no effect for saving charts).

    Buttons, from left to right: • G o up to the parent directory. • Go to the ho me directory. • Create a new d i rec to r y . • Display the file list with all de ta i l s .

    Save the chart. When the save button is clicked the JPEG settings dialog opens (see Figure 4—35).

    Cancel closes the dialog box w i tho ut sav in g .

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 57 Q-MONITOR 5.6.X FOR V5

    • JPEG settings dialog

    Figure 4—35: JPEG settings dialog

    Resolution combo box

    Select in the list an appropriate resolution for the picture or enter an integer number.

    OK button

    When the settings for the resolution and the quality are entered, press the OK button to save the image.

    Cancel button

    If you want to close the dialog box without saving the image, click Cancel.

    Quality text box

    Enter the percent value for the compression of the image. Accepted are integer values between 0 and 100.

    Scroll bars

    Use the scroll bars to move the image inside the window.

    4.5.2 Table View

    In table view the report is displayed in the form of a table (see Figure 1—1). The control

    bar at the bottom of the window contains different tools which allow changing the format

    of the table. The function of the control elements will be explained in the text following

    after Figure 4—36.

    In addition, you can change the width of the table columns. To do so:

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 58 Q-MONITOR 5.6.X FOR V5

    • Position the mouse pointer over the vertical lines separating the column headers. The

    cursor shape changes to a double arrow .

    • Press and hold the left mouse button while dragging the separating line to a new

    position.

    • When the desired width is attained, release the mouse button.

    NOTE:

    • The use of the tools for moving up, down, left, right, flipping, hiding or showing does not generate a new report. All that is changed is the form of representation of the existing report.

    Figure 4—36: Table View. Flipping the table with the Swapped check box

    On the screenshot on the top, the Swapped check box is deactivated; on the screenshot at the bottom, it is activated.

    Table row

    Table column

    Flipping

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 59 Q-MONITOR 5.6.X FOR V5

    Left and Right buttons

    P reco nd i t io n : A table c e l l must be se l ec ted (marked with a colored border).

    Clicking on the Left or Right buttons moves the selected cell and its whole column to the left or right within the table.

    Swapped check box

    If the Swapped check box is activated, the table is flipped:

    The rows of the initial table become columns of the flipped table, and the columns of the initial table become rows of the flipped table. (See Figure 4—36)

    Hide Row and Hide Column buttons

    P reco nd i t io n : A table c e l l must be se l ec ted (marked with a colored border).

    Clicking on the Hide Row button (or Hide Column button) hides the highlighted cell with its whole row or column, respectively.

    NOTE:

    • The row or column is o n l y h idden , no t de l e t ed from the report. To show the table with all its rows and columns, press the Show all button.

    Show all button

    Clicking on the Show all button makes all hidden columns and rows reappear. The whole table will again be shown.

    Up and Down buttons

    P reco nd i t io n : A table c e l l must be se l ec ted (marked with a colored border).

    Clicking on the Up or Down button moves the selected cell with its whole row up or down inside the table.

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 60 Q-MONITOR 5.6.X FOR V5

    Figure 4—37: Table View. Moving a row

    4.6 Opening an Existing Report

    To open an existing report:

    • Click on the Open report button on the Q-MONITOR toolbar.

    or

    • Pulldown the File menu and click Open… .

    The extension of the report file names is .qmr .

    NOTE:

    • When an existing report is opened, the Do Query button on the options tab card is disabled for reasons of data consistency (see Figure 4—5).

    T I P :

    You can export the options settings of the currently open report (see section 4.4.2.5 Export and Import of Query Options on page 47).

    Moving a table row

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 61 Q-MONITOR 5.6.X FOR V5

    4.7 Printing a Report

    To print a report:

    • Open the Print Preview window. Menu: Fi le > Print Layout

    • Build the report that you want to print.

    (See Figure 4—38)

    Print Preview window: Menu: Element > Add > Chart | Table | Text | Image

    • Check the paper settings. Print Preview window: Menu: Preview > Paper Setup

    • Check the printer settings. Print Preview window: Menu: Preview > Printer Setup

    • Start printing. Print Preview window: Menu: Preview > Pr inter Setup

    NOTE

    Start printing only after you have compiled a report. If the Print Preview panel is empty, the printer will output an empty list.

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 62 Q-MONITOR 5.6.X FOR V5

    Figure 4—38: Pr int p rev iew window—adding the elements of the report

    The print preview dialog offers a number of different editing tools. The user can prepare a

    printed report with one or several pages. The pages can contain text, charts, tables or

    imported images. The text can be formatted. The position and the size of charts, tables,

    images and text boxes can be controlled. When the Editable option (Options menu) is

    disabled, position and size of all elements are fixed.

    NOTE

    Text for text boxes is editable only as long as the Add text dialog is open (see Figure 4—38). Press OK only, when you are sure that you have completed the text editing. Thereafter you can no more change the text. If a mistake is discovered, the text box must be removed (menu: Element > Remove ) and the text re-entered in a new text box.

  • 4 . W O R K I N G W I T H Q - M O N I T O R

    Copyright Dassault Systèmes 63 Q-MONITOR 5.6.X FOR V5

    4.8 Closing a Report

    To close a report:

    • Click on the Close report button on the Q-MONITOR toolbar

    or

    • Pull down the File menu and click Close .

  • 5 . E X I T I N G Q - M O N I T O R

    Copyright Dassault Systèmes 64 Q-MONITOR 5.6.X FOR V5

    5. Exiting Q-MONITOR

    To exit Q-MONITOR:

    • Pull down File menu and click Close

    or

    • Use any other means provided by the operating system (WINDOWS or UNIX)

    for closing an application.

  • 1 . Q - M O N I T O R O P T I O N S

    Copyright Dassault Systèmes 65 Q-MONITOR 5.6.X FOR V5

    APPENDIX

    1. Q-MONITOR Options

    The Q-MONITOR options are accessed in the menu item Extras > Global Options.

    NOTE

    Modifications on options setting do not take effect for reports that already exist, but only for reports that will be created a f t e rw ards .

    • Options tab card

    Report options

    This setting controls whether the report after its generation first is opened in chart form or not. If the number of records in the database is greater than this number, the

  • 1 . Q - M O N I T O R O P T I O N S

    Copyright Dassault Systèmes 66 Q-MONITOR 5.6.X FOR V5

    report will be first opened in table form. (If the number of records in the database is greater than this number, the generation of the report might last a too long time due to a too big number of records, and the chart representation might be not clearly represented).

    This setting controls whether for text-type options (cf. page 38), when clicking the List button of such an option, the list will be opened. If the number of records in the database is greater than this number, the list will be not opened (opening the list in case of a too big number of records could take a too long time). In case of a list with a too big number of records a message will be displayed.

    This setting controls how many positions will be have percent values behind the decimal point.

    Security—Save database password in the ini f i le

    If this check box is activated, the database password will be saved in the ini file.

    Options for position and size of the Q-MONITOR window

    If the Maximize check box is activated, the Q-MONITOR window always will be maximized.

    If the Save last posit ion check box is activated, the position of the Q-MONITOR window always will be memorized and always will be reopened with the same size and position as it was at the end of the last session.

    These size and coordinate text boxes are active only if the Maximize and Save last posit ion options are deactivated. The settings in this boxes control a fixed size and a fixed position of the Q-MONITOR window. The x and y coordinates refer to upper left corner of the Q-MONITOR window.

    Table names Radio button

    This radio button controls whether the names of the database columns are upper-case or lowercase.

    Disable »Prepared« statement check box

    If this option is deactivated, in JDBC the Prepared statement will not be used. (Default: deactivated)

    OK button

    Clicking this button closes the Options dialog box with saving the newly entered settings.

    Cancel button

    Clicking this button closes the Options dialog box with discarding the newly entered settings.

  • 1 . Q - M O N I T O R O P T I O N S

    Copyright Dassault Systèmes 67 Q-MONITOR 5.6.X FOR V5

    • Filter tab card

    On this tab card the default aspect of the filter options on the Filter tab card of Q-MONITOR can be controlled for all report types.

    Column name:

    In this column the names of the database columns are displayed.

    Option label:

    In this column the labels for the names of the database columns are displayed and can be edited, i. e. here alias names can be specified for the table columns that will be shown on the Filter tab card of the Q-MONITOR window.

    Default value:

    Here default values can be entered.

    Checked:

    By clicking the toggle switches in this column it can be preset which of the options will be activated on the Options tab card.

  • 1 . Q - M O N I T O R O P T I O N S

    Copyright Dassault Systèmes 68 Q-MONITOR 5.6.X FOR V5

    Visible:

    By clicking the toggle switches in this column it can be controlled whether the options will be visible on the Options tab card.

    It is possible to set an option active and invisible in the same time so that it will be always active, but can not be deactivated on the Options tab card by the user.

    The options settings will be take effect after r es ta r t ing Q-MONITOR.

    • Report Fonts tab card

    On this tab card the fonts for texts of the Q-MONITOR reports can be font family, the font faces and the font size—General is applied, beside the text of the report tables, also for the report names in the Report Definition dialog box (see above).

    The aspect of the Q-MONITOR window itself depends from the settings made on the operation system level.

  • 1 . Q - M O N I T O R O P T I O N S

    Copyright Dassault Systèmes 69 Q-MONITOR 5.6.X FOR V5

    • Colors tab card

    On this tab card, the gene ra l color definition for a l l report types is executed. Cf. section

    2. Color definition for Individual Report Types on page 71.

    On this tab card the colors for the different

    chart elements are selected (see example on the right).

    In bar, group bar, band, scatter and spline charts, the different colors are used in case of a chart with seve ra l bars or bands etc.

    O verv iew bo x : colors selected for the chart elements. If you want to modify an existing color, select here the respective bar.

    Co lo r se lec t io n box : The colors can be selected in the color palette, by HSB or RGB values. Selecting a color modifies the color in the color bar highlighted in the o ve rv i ew bo x .

    Prev iew b o x : gives a preview of the selected color in combination with the text and line color.

  • 1 . Q - M O N I T O R O P T I O N S

    Copyright Dassault Systèmes 70 Q-MONITOR 5.6.X FOR V5

    Transp ar ency bo x : With the sliding controller the transparency value of the selected color can be modified.

    Add co lo r /Remo v e se l ec ted bu t to ns : With the Add button an additional color element can be added to the list in the overview box . Clicking the Remove button deletes the color element that is highlighted in the list. No color element will be deleted if the list contains only 12 elements as this is the minimum number of color elements

    A d d i n g a n e w c o l o r e l e m e n t / m o d i f y i n g a c o l o r e l e m e n t

    (1) Click the Add color button or select an existing color element in the list that you want to modify.

    (2) Select a color from the color table , or define it on the HSB or RGB tab card. You can verify your color selection in the preview box or on the highlighted color bar .

    (3) Define the color transparency .

    (4) When you have terminated the color defining, apply the settings by clicking the OK button .

    • Help tab card

    For Q-MONITOR native mode:

    Specify here the name or name path of the to o l displaying the Q-MONITOR USERS MANUAL PDF file (ACROBAT READER or similar).

    For Q-MONITOR native mode: Specify here the path of the Q-MONITOR USERS MANUAL (this manual).

  • 2 . C O L O R D E F I N I T I O N F O R I N D I V I D U A L R E P O R T T Y P E S

    Copyright Dassault Systèmes 71 Q-MONITOR 5.6.X FOR V5

    For Q-MONITOR applet mode: Specify here the HTTP server document root directory.

    For Q-MONITOR applet mode: Specify here the path and name of the Q-MONITOR USERS MANUAL (this manual) relative to the HTTP server document root directory.

    • Service tab card

    Use service to connect to Q-Monitor database (JDBC-Proxy)

    This requires specific JDBC-driver (JDBC over SOAP).

    SOAP endpoint reference for service connection

    2. Color definition for

    Individual Report Types

    For individual report types the color definition can be made via the menu item Extras >

    Report Type Colors .

    NOTE

    The color definition made for an individual report type takes the priority over the general color definitions for all report types.

  • 2 . C O L O R D E F I N I T I O N F O R I N D I V I D U A L R E P O R T T Y P E S

    Copyright Dassault Systèmes 72 Q-MONITOR 5.6.X FOR V5

    After selecting the menu item Extras > Report Type Colors first the Report Color Chooser dialog opens. Do the following steps:

    Select the report type, to which you intend to attribute an individual color set for the chart elements.

    Click then the Define button to confirm your selection.

    After that the Color dialog box opens. In the window title the name of the selected report type is displ