Reporter User Guide Version: 6.7.01 Publication Date: 2016-09 Automic Software GmbH ii | Copyright Copyright Automic® and the Automic logo® are trademarks owned by Automic Software GmbH (Automic). All such trademarks can be used by permission only and are subject to the written license terms. This software/computer program is proprietary and confidential to Automic Software and is only available for access and use under approved written license terms. This software/computer program is further protected by copyright laws, international treaties and other domestic and international laws and any unauthorized access or use gives rise to civil and criminal penalties. Unauthorized copying or other reproduction of any form (in whole or in part), disassembly, decompilation, reverse engineering, modification, and development of any derivative works are all strictly prohibited, and any party or person engaging in such will be prosecuted by Automic Software. No liability is accepted for any changes, mistakes, printing or production errors. Reproduction in whole or in part without permission is prohibited. © Copyright Automic Software GmbH. All rights reserved. Other names may be trademarks of their respective holders. Reporter User Guide | iii Contents 1 Release Notes ...................................................................................................................... 5 2 Introduction .......................................................................................................................... 6 3 Administering Reporter ....................................................................................................... 7 3.1 Node Declarations .......................................................................................................... 7 3.1.1 Nodes ....................................................................................................................... 7 3.2 Declaring the Internal Scheduler .................................................................................... 8 3.3 Node Settings – Reporter ............................................................................................... 8 3.3.1 Node Settings – Database Settings ......................................................................... 8 3.3.2 Node Settings – Extraction Parameters ................................................................... 9 3.3.3 Node Settings – Maintenance .................................................................................. 9 3.3.4 Node Settings – Server Parameters ....................................................................... 11 3.3.5 Node Settings – SMTP Parameters ....................................................................... 12 3.3.6 Node Settings – Extraction Process Parameters ................................................... 12 3.3.7 Node Settings – UVMS Parameters ....................................................................... 13 4 Reporter Data Management .............................................................................................. 15 4.1 Reporter DB .................................................................................................................. 15 4.2 Reporter – Extractions .................................................................................................. 15 4.2.1 Reporter Extraction Monitor .................................................................................... 15 4.2.2 Reporter Extraction Monitor – Details .................................................................... 16 4.3 Reporter Extraction Schedules ..................................................................................... 19 4.3.1 Reporter Extraction Schedules – Details ................................................................ 19 4.3.2 Reporter Extraction Schedules – Features ............................................................ 20 4.3.3 Reporter Extraction Schedules – New ................................................................... 20 4.4 Reporter Extraction Purges .......................................................................................... 21 4.4.1 Reporter Purge Monitor – Details ........................................................................... 21 4.4.2 Reporter Purge Monitor – Features ........................................................................ 21 4.4.3 New Reporter Purge Schedule – Details ................................................................ 22 5 Report Management .......................................................................................................... 23 5.1 Report Definitions ......................................................................................................... 23 5.1.1 Report Definitions – Details .................................................................................... 23 5.1.2 Report Definitions – Features ................................................................................. 23 5.1.3 New Report Definition ............................................................................................. 24 5.2 Reports ......................................................................................................................... 27 5.2.1 Reports – Columns ................................................................................................. 27 5.2.2 Reports – Features ................................................................................................. 28 5.2.3 Reports – New Report ............................................................................................ 28 5.2.4 Reports – Display ................................................................................................... 30 5.3 Report Templates ......................................................................................................... 32 5.3.1 Dollar Universe Report Templates ......................................................................... 32 5.3.2 UniJob Report Templates ....................................................................................... 38 iv | Contents 6 Custom Reports ................................................................................................................. 40 6.1 Prerequisites and recommendations ............................................................................ 40 6.2 Internationalization ........................................................................................................ 40 6.2.1 Description .............................................................................................................. 40 6.2.2 Naming Conventions .............................................................................................. 40 6.2.3 Executing Reports .................................................................................................. 41 6.3 SQL Queries Guidelines ............................................................................................... 42 6.4 iReport .......................................................................................................................... 43 6.4.1 iReport Configuration .............................................................................................. 43 6.4.2 Compiling and Executing Report Templates .......................................................... 46 7 About Automic Software, Community and Services ...................................................... 47 7.1 Automic Software Company ......................................................................................... 47 7.2 Automic Community...................................................................................................... 47 7.3 Download Center .......................................................................................................... 47 7.4 Technical Support ......................................................................................................... 48 7.5 Training and Services ................................................................................................... 48 Chapter 1 Release Notes | 5 1 Release Notes The following is the change history. Information on bug-fixes and known errors is available in the Workload Automation Release Notes and by contacting Automic technical support. Date Key Features 2014-11 Dollar Universe user manuals change their look to integrate the Automic world. 6 | Chapter 2 Introduction 2 Introduction Welcome to the Reporter 6 User Guide! This user manual deals exclusively with the UniViewer interface to Reporter. In order to draw full benefit from this document, readers should be familiar with the following: Dollar Universe Application Server (installation, administration, usage) UniJob Servers (installation, administration, usage) UniViewer Console graphical user interface This document describes the use of Reporter from the UniViewer Console. It covers: Administration of Reporter and the definition of various settings Extraction of data (manual and automatic) from UniJob and Dollar Universe Data Sources Loading of extracted data into the Reporter database Generation of reports (manual and automatic) from the Reporter database Chapter 3 Administering Reporter | 7 3 Administering Reporter UniViewer Console is the user interface for configuring and administering Reporter. This section documents the use of UniViewer specific to the needs of Reporter. Please refer to the UniViewer User Manual on general usage of the UniViewer Console interface. 3.1 Node Declarations After UVMS is installed, only the UniViewer Management Server node is present in the Node List. UniJob Nodes are registered on a UniViewer Management Server by the UniJob installation procedure. Dollar Universe v6 nodes are registered on the UVMS by the Dollar Universe v6 installation procedure. Dollar Universe v5 Nodes can be mass imported from Dollar Universe v5 administration tables or created manually in the Node List. The Reporter Server Node must be declared manually. Extractions can only be launched from the UniViewer interface on Nodes that are present in the list. In production, extractions, purges and report generation will be scheduled by the internal (UniJob or Dollar Universe v.6) scheduler. However it is still possible to configure these operations manually. 3.1.1 Nodes This feature displays the “Nodes List” document on the UniViewer Management Server. The Nodes List document manages the types of Nodes recognized by UniViewer. 3.1.1.1 Reporter Node – General Type: This field indicates the Node type (e.g. “Reporter”) Node: This field contains the logical identifier of the Reporter Server instance. The validity of this code is not verified. Hostname: This field contains the name of the computer where the Reporter Server is located. SSL Enabled: Check the box so that UVC can communicate with the Reporter node in SSL. In this case, Reporter and UVMS must be started in SSL mode. Only the "Enable SSL" parameter in the "Node Settings – Server Parameters" category of the Reporter node displays the effective or non-effective use of SSL by the Reporter node. SSL communication is only effective starting with Reporter version 4, UniViewer version 4, and Dollar Universe version 6. 3.1.1.2 Reporter Node – Network Configuration To update the port number, double click on the line to activate data entry. Key in the Reporter Server TCP port number: found in the system services file under the entry REPSERVER_REP_X on the Reporter Server host. The default value is 10630. Press Enter to confirm data entry before saving the Reporter Node record. 8 | Chapter 3 Administering Reporter 3.1.1.3 Reporter Node – SSL This section displays information about the SSL encryption that is being used. SSL Status: Enabled or Disabled, as selected in the "Node Settings – Server Parameters". If the status is disabled, the following information is invalid. Validity Date: of the certificate. Certificate Authority Details: Click this button to display the certificate. 3.2 Declaring the Internal Scheduler To benefit from built-in scheduling functions for extraction, purge and report generation a UniJob or a Dollar Universe v6 Server (either local or remote) should be declared as the "Internal Scheduler". This declaration is made in the UVMS Node Settings/Internal Scheduler category. Refer to the UniViewer online help or the user manual for details on these parameters. The Internal Scheduler requires the Reporter client (for UniJob or for Dollar Universe v6) to be installed even if the scheduler is on the same machine as the Reporter Server. Refer to the Reporter Administrator Manual. The submission account associated with this internal scheduler (Administration mode > UVMS node > Node Settings > Internal Scheduler > Submission account) must be declared as a submission account. : In UniJob : Design mode > Jobs Design > Submission Accounts Or Dollar Universe : Design mode > Environment > Accounts 3.3 Node Settings – Reporter Only the Reporter Server Node settings are dealt with in this manual. 3.3.1 Node Settings – Database Settings The following variables are stored in the <Reporter Server>\data\loadtarget\default.load.xml file. Binary values are displayed in the interface as “yes” or “no” but are stored in the configuration files as “true” or “false”. Use the “Validate DB Connection” button to make sure that the database identification and connection parameters are correct. Name/ Variable Description dbId DB Instance ID The Oracle SID or the MS SQL DB instance name. dbName DB Name (MSSQL only) This is the name of the database. The “default” database name is used by default if no other name is specified. dbHostname DB Server Host This is the hostname supporting the database. dbType DB Type This is the type of database: Oracle or MS SQL Server. Chapter 3 Administering Reporter | 9 Name/ Variable Description dbPort DB Port This is the default Oracle or MS SQL Server listener port number. dbMaxRetry DB Maximum Retries This indicates the number of connection attempts that will be made before returning an error: 3 by default. dbRetryDelay DB Retry Delay This is the delay in seconds between two connection attempts: 10 seconds by default. dbUserName DB User Name The database connection user account. dbPassword DB User Password The database connection user password. use_oracle_service_url Use Oracle Service URL (defined in mgr/server.conf file) If Yes, Oracle service name will be used to identify the base. If No, Oracle SID. 3.3.2 Node Settings – Extraction Parameters The following variables are stored in the <Reporter Server>\data\loadtarget\default.load.xml file. Name Description extMaxRetry Ext Maximum Retries The maximum number of times that Reporter Server will attempt to connect to a Data Source before returning an error. If default values are used, Reporter Server will try to connect 3 times in 30 seconds before abandoning the extraction. 3 attempts by default. extRetryDelay Ext Retry Delay Delay in seconds between two connection attempts: 10 seconds by default. ConnectionReadTimeout Ext Connection Read Timeout Maximum wait time for a request from Reporter to Dollar Universe before Reporter closes the connection with Dollar Universe. 60 seconds by default, 0 is interpreted as an infinite amount of time. Binary values are displayed in the interface as “yes” or “no” but are stored in the configuration files as “true” or “false”. 3.3.3 Node Settings – Maintenance The following criteria are stored in the <Reporter Server>\data\loadtarget\default.load.xml. 3.3.3.1 Purge for Dollar Universe Name Variable Default Value UVMS Node UvmsName * Company Company * Node Node * Area Area * MU Mu * Session Session * Uproc Uproc * 10 | Chapter 3 Administering Reporter Name Variable Default Value Limit Days Age 30 days The UVMS Node Name field filters data from all Dollar Universe Nodes belonging to a particular UniViewer Management Server. By default, when a purge is requested (either from the “Reporter DB>Extraction Purges” feature or the command uxreppurge) all data older than the specified limit will be purged. If the limit in days is equal to zero, the age of the data will not be taken into account, and all data targeted by other filters will be deleted. For example, if all fields contain the wild card (“*”) as shown in the table above and the limit was set to 0 days, all records for all Nodes, Companies, Areas etc. would be deleted. Multiple purge criteria may be added but they are accumulative. The order specified in the file is of no importance. Example: Data is collected from machines A, B and C. Data from machine A should be kept for 150 days and everything else (i.e. from machines B and C) for 100 days. If the following filters are set as: UVMS Node Company Node Area MU Session Uproc Limit Days * A * * * * * 150 * * * * * * * 100 All data for all Nodes will be purged after 100 days. If the following filters are set as: UVMS Node Company Node Area MU Session Uproc Limit Days * A * * * * * 150 * B * * * * * 100 * C * * * * * 100 Data for A will be kept for 150 days. Data for B and C will be kept for only 100 days. 3.3.3.2 Purge for UniJob Name Variable Default Value UVMS Node UvmsName * Node Node * Target Target * Job Job * Limit Days Age 30 days By default, when a purge is requested (either from the “Reporter DB - Extraction Purges” feature or the command “uxreppurge”) all data older than 30 days will be purged. The UVMS Node Name field filters data from all UniJob Nodes belonging to a particular UniViewer Management Server. 3.3.3.3 Purge for Reporter Chapter 3 Administering Reporter | 11 Name/ Variable Description extractionAge Extraction History Removes all records from the Extraction History list older than 180 days (by default). purgeAge Purge History Removes all records from the Purge History list older than 180 days (by default). reportAge Reports Purge Removes report generation history data from the database together with internal output stored under <Reporter>\data\reports\internal\jasperprints older than 180 days (by default). It does not remove PDF or HTML output. 3.3.4 Node Settings – Server Parameters The following criteria are stored in the <Reporter Server>\mgr\server.conf file. Binary values are displayed in the interface as “yes” or “no” but are stored in the configuration files as “true” or “false”. Name/Variable Description maxParallelExtractions Maximum Number of Parallel Extractions This defines the maximum number of extractions that can be executed simultaneously. Extractions exceeding the limit will stay PENDING until another finishes. 10 by default. maxParallelReportGeneration Maximum Parallel Report Generation Limits the number of simultaneous report generations. 5 by default. maximumJobLogSize Maximum Job Log Size (bytes) Job Logs in excess of this limit will be truncated in the middle. This option is only valid if Job Log extraction has been requested. 2048 bytes by default. useDBChecker Switch Operations to Aborted on Server Failure If Yes (by default), at Reporter startup, all RUNNING, PENDING statuses are changed to ABORTED. The impacted objects are: extractions, purges, reports. This status update is also logged in the extraction log. This operation is required to fix brutal shutdown of server process. max_hibernate_dbconnections Maximum Number of Hibernate DB Connections The number of connections used for updating and listing the Extraction and Purge statuses. Only one is required. The use of multiple connections is not recommended. 5 by default. nodeCompanyFilter Company Filter Target Reporter extractions on certain Companies only. * by default. ssl_enabled Enable SSL Displays Yes if Reporter is configured and started in SSL mode or No if Reporter is not used in SSL mode (by default). Reporter configuration in SSL mode can only be done by executing the Reporter command unissl. Refer to the UVMS Administrator Manual for more details about this command. ssl_Keystore Certificate Keystore If Reporter is started in SSL mode, this parameter must contain the directory that contains the certificates: mgr/rep_store.cer by default. ssl_Keystore_Pass Keystore Password Password to access certificates. 12 | Chapter 3 Administering Reporter 3.3.5 Node Settings – SMTP Parameters The following criteria are stored in the <Reporter Server>\mgr\server.conf file. Binary values are displayed in the interface as “yes” or “no” but are stored in the configuration files as “true” or “false”. Name Description smtpIsSecure SMTP Use Secure Only possible if Authentication is required. No by default. smtpRequireAuth SMTP Authentication Required If your company’s SMTP server uses the SMTP-AUTH protocol. Yes by default. smtpServer SMTP Server Enter the hostname of the SMTP server. smtpPort SMTP Port The SMTP port number. 25 by default. smtpUserName SMTP User Only necessary if authentication is required. smtpPassword SMTP Password This is the password associated with the SMTP User below. Only necessary if Authentication is required. maxAttachamentSize Maximum Attachment Size (MB) Limits the size of output attachments for notification. If In this case an email is sent to say that the "Report is generated and it can be accessed within UniViewer Console". 1 MB by default. mailSender Message Origin (From address) Name used in the sender field for email notification. The name is not verified. [email protected] by default. 3.3.6 Node Settings – Extraction Process Parameters The parameters below concern data types that the customer may or may not find useful to extract and load into the data base. For example extracting Job Logs may noticeably penalize performance. This varies of course with the size and number of the logs concerned. Extracting only logs concerning aborted Jobs may constitute a reasonable compromise if performance and database size turn out to be a problem. The following criteria are stored in the <Reporter Server>\mgr\server.conf file. Binary values are displayed in the interface as “yes” or “no” ("no" by default) but are stored in the configuration files as “true” or “false”. Variable Name extractParametersDuas (Dollar Universe) Extract Parameters extractVariablesDuas (Dollar Universe) Extract Variables extractMessagesDuas (Dollar Universe) Extract Messages extractUprocTypeDuas (Dollar Universe) Extract Uproc Type extractInterventionHistoryDuas (Dollar Universe 6) Extract Intervention History extractJobLogForAbortedJobRunsDuas (Dollar Universe) Extract Job Log for Aborted Job Runs extractJobLogForCompletedJobRunsDuas (Dollar Universe) Extract Job Log for Completed Job Runs Chapter 3 Administering Reporter | 13 Variable Name extractAuditTrailDuas (Dollar Universe) Extract Audit Trail extractLabelsForMuUprocSessionDuas (Dollar Universe) Extract Labels for MU, Uproc and Session extractLabelsForNodeCompanyDuas (Dollar Universe) Extract Labels for Node and Company extractEW (Dollar Universe) Extract Event Wait Status extractJobLogForAbortedJobRunsUnijob (UniJob) Extract Job Log for Aborted Job Runs extractJobLogForCompletedJobRunsUnijob (UniJob) Extract Job Log for Completed Job Runs extractAuditTrailUnijob (UniJob) Extract Audit Trail 3.3.7 Node Settings – UVMS Parameters Reporter supports multiple UniViewer Management Servers for UniJob or Dollar Universe Servers. Each UVMS stores the configuration of a number of UniJob and Dollar Universe Servers. It will concentrate the extraction processes for the UniJob or Dollar Universe Servers in its domain. UVMS Parameters specify the UniViewer Management Server where logins are stored. The login and password are necessary to extract data from UniJob or Dollar Universe Servers. Figure 1: Multiple UniViewer Management Servers Name Description Node Name UVMS logical identifier Host Hostname supporting the UVMS Port The IP port used by the UniViewer Management Server (4184 by default). Login The UniViewer login used for extraction from servers (admin by default). Password The UniViewer login password. The value is encrypted. 14 | Chapter 3 Administering Reporter Name Description Group Name UVMS cluster name. If UVMS is not installed in a cluster this name must be the UVMS node name (default value). Priority Priority of the UVMS node in the cluster: 1, 2… If UVMS is not installed in a cluster, the priority must be 1 SSL Port SSL port number for UVMS (4443 by default). SSL Enabled SSL active on this UVMS node (true) or inactive (false by default). Each line in this list corresponds to a UVMS server that Reporter can extract data. The Group name and Priority fields have a particular function: if two (or more) UVMS belong to the same group, in this case they are considered as two instances of the same UVMS server. For each group, Reporter attempts to contact the UVMS server with the lowest priority. If this fails, it attempts to contact the next group member with the lowest priority and so forth. Chapter 4 Reporter Data Management | 15 4 Reporter Data Management Reporter data management covers two major activities. Loading of new data extracted from Data Sources (Dollar Universe and UniJob Servers) into the Reporter database Purging of old data from the same database Reporter V6 brings new features: The management of Dollar Universe V6 (as well as Dollar Universe V5 and UniJob) node data The declaration of a Dollar Universe V6 (or UniJob) internal scheduler SSL communication 4.1 Reporter DB The Reporter DB section in the UniViewer Administration panel proposes the following documents in the Reporter DB panel: Extractions: This option opens the Extractions Monitor document for manual extractions. Extraction Schedules: This option opens the Extractions Schedules document. Extractions can be scheduled at specific times or for continuous processing within a window. Extraction Purges: This option opens the Extraction Purge Monitor document. Purges can be triggered manually or scheduled regularly from this document. 4.2 Reporter – Extractions Reporter will be used to extract data from UniJob and Dollar Universe (v5 and v6) servers. 4.2.1 Reporter Extraction Monitor The extraction log displays a consolidated view of extractions by UVMS and by product/Company/Area. The user can navigate, from this document, to reach the extraction at the Node level. DataSources: This column displays a list of all the UniViewer Management Servers declared in the Reporter Server's Node Settings. The UVMS can be expanded to list values for UniJob together with Dollar Universe Company/Areas. Click on the + plus sign in front of the line to develop the extractions list requested by the UVMS. Age of Data: This column contains the age in days (or hours if less than a day) of the oldest successful extraction concerning the UVMS. Nodes: This column contains the number of Nodes included in the consolidated view. Completed: This is the number of consolidated Data Sources whose extraction completed successfully. Aborted: This is the number of consolidated Data Sources whose last extraction failed: 16 | Chapter 4 Reporter Data Management o Connection to the server impossible, connection lost, corrupt data, etc. o Or extraction stopped by the operation (if it is not continuous extraction). Suspended: This is the number of consolidated Data Sources whose last extraction status was suspended: the extraction has been stopped by the user or by the server. o The server suspends an extraction when it stops or if the end of the continuous extraction window is reached, o Or the extraction is stopped by the operator (in the case of a continuous extraction). Refused: This is the number of consolidated Data Sources whose last extraction status was refused because the target Data Source (the node) was unreachable. Pending: Number of consolidated data sources in which the extraction is waiting to execute: The extraction is registered on the server; it will begin as soon as the conditions are met: o No other current extraction on the same node o No purge in progress o The number of executing processes +1 is less than the maximum number of parallel executions (this parameter is defined in the "Node Settings – Server Parameters" on page 11). Running: Number of consolidated data in which the last extraction is in progress. 4.2.1.1 Reporter Extraction Monitor – Features Extract: This button opens the New Extraction document. Refer to section "Reporter Extraction Monitor Details – New Extraction" on page 17. Details: After expanding a UVMS record and selecting either UniJob or a Dollar Universe Company and Area, click on Details to display the full list of Data Sources found within the selected grouping. Refer to section "Reporter Extraction Monitor – Details" below. Extract Aborted: This button restarts the latest aborted extractions. Extract Refused: This button restarts the latest refused extractions. Extract Old: Extractions older than 24 hours can be relaunched. Tools: o Copy to Clipboard (CSV). This option copies selected data to the clipboard in Comma Separated Values format. Refresh: The refresh button refreshes the data display. 4.2.2 Reporter Extraction Monitor – Details Product: This column shows the product (Dollar Universe or UniJob) running on the Data Source. Data Source: The identification (Company – Node – Area for Dollar Universe or Node for UniJob) of the Data Source from which operations data is extracted. Last Extraction: If the extraction targeted a Node View, the name of the Node View will be displayed. If the extraction was triggered by the uxrepadd command with a label, the label will be displayed. Otherwise this field will contain "all extractions". Last Status: This field shows the current status of this particular extraction. Possible values are shown below. o Pending. The extraction is waiting to run. This could be because the maximum parallel extractions limit has been exceeded. Chapter 4 Reporter Data Management | 17 o Running. The extraction is in progress. o Completed. The extraction completed successfully. o Aborted. The extraction failed. Refer to the log for details. o Refused. The connection to the target Data Source was lost. o Suspended. The Continuous Extraction Interval has finished. Start Date: The date and time that the extraction started on the target Data Source. End Date: The date and time that the extraction finished, whether successful or aborted. Records: This is the number of new records loaded into the database. Duration: This is the elapsed time of the extraction. Age: The Age column allows the identification of Data Sources whose extractions are not up to date (current date – start date) 4.2.2.1 Reporter Extraction Monitor Details – Features Extract: This button opens the New Extraction document. History: This button opens the Extraction History document for the selected Data Source. Refer to section "Reporter Extraction Monitor – History" on page 18 Log: This button opens the Reporter Extraction Log document for the selected extraction. Stop: This button cancels extractions that were "Running". The extraction status will change to "Aborted". Tools: o Copy to Clipboard (CSV) copies selected data to the clipboard in Comma Separated Values format. Refresh: This button refreshes the data display. 4.2.2.2 Reporter Extraction Monitor Details – New Extraction Extractions can target one or many Dollar Universe Nodes OR one or many UniJob Nodes. Target Data Sources must exist in the UniViewer Node list. Dollar Universe Nodes (DUAS v.5) can be manually declared or imported as a group from an existing DUAS. UniJob and Dollar Universe v6 Nodes are automatically declared in the UniViewer server at installation. An extraction request can address multiple Data Sources (of the same type) via the Node View grouping mechanism. Click on Extract to trigger the extraction process for the currently selected Data Sources. Reporter New Extraction – General Management Server: The extraction request can target all or some of the Nodes attached to one Management Server. Select the Management Server from the list by clicking on the arrow. Product: The product is either Dollar Universe or UniJob. The default value is Dollar Universe. Select the Product from the list by clicking on the arrow. Selection: Data Sources can be selected either "Per Node" or "Per Node View". The default value is per Node. Choose the selection method from the list by clicking on the arrow. 18 | Chapter 4 Reporter Data Management Node View: If "Per Node view" is the required selection method, choose a Node View from the list displayed by clicking on the arrow. Reporter New Extraction – Nodes This section lists all Dollar Universe or UniJob Nodes on the UniViewer Management Server depending on the Product and Node View selected in the General section. Each Data Source, (identified by the Company/Area/Node trigram) is prefixed by a selection checkbox. Select All: This checkbox will select all Data Sources in the list. Select None: This checkbox will deselect all Data Sources in the list. If a Node View was selected in the General section, Data Sources in the Node View will be preselected. 4.2.2.3 Reporter Extraction Monitor – History Select a Data Source from the Reporter Extraction Monitor detail document and click on the History button to access the extraction history document. The extraction history allows the user to compare extractions (no of records, elapsed time etc.) from the same Data Source. Each finished extraction is listed with related information. Reporter Extraction History – Detail Extraction: This column displays the Node View Name or Extraction label associated with this particular extraction. The same Data Source can be present in more than one Node View. Status: Available states in this column are "Running", "Completed", "Aborted", "Suspended" or "Refused". Start Date: This is the date and time that the extraction started for this particular Data Source. End Date: This is the date and time that the extraction finished for this particular Data Source. Records: This is the number of records inserted in the base, which could be fewer or equal to the number extracted from the Data Source. Duration: This indicates how long the extraction took in elapsed time (end date – start date). Reporter Extraction History – Features Graph: This button toggles between table and graphical display. The graph represents the progression over time of the number of records extracted (red line) and the extraction elapsed time (blue line). Delete: This button removes a selected line from the Extraction History table. Data removal has an immediate impact on the graphical representation. Log: This displays the Reporter Extraction Log document for the selected extraction. Refer to section "Reporter Extraction – Log" on page 19. Stop: This button cancels extractions that were running. The extraction status will change to "Aborted". Tools: o Copy to Clipboard (CSV): copies selected data to the clipboard in Comma Separated Values Format. Refresh: This refreshes the data display. Chapter 4 Reporter Data Management | 19 4.2.2.4 Reporter Extraction – Log The Reporter Extraction Log document is accessible from both the Reporter Extraction Monitor and the Reporter Extraction History. Each record in the extraction log is time stamped. Logging shows the following information. Extraction registration status with the Execution Manager. Status of each Data Source connection attempt. Start / End of execution extraction. Start / End of history extraction. Start / End of exception extraction (Dollar Universe v6 only). Number of records extracted and the number of records inserted into each table. End of extraction process status. Extraction status Reporter Extraction Log – Features Save As… The log can be saved to disk as a text file. The user must specify the output directory and file name. 4.2.2.5 Reporter Extraction – Stop The Reporter Extraction "Stop" feature is accessible from both the Reporter Extraction Monitor and from the Extraction History documents. This command cancels the selected extractions in the "Running" or "Pending" status. If the cancellation was successful the extraction status will be set to "Aborted". The Reporter Extraction Log will finish with the following message: “Process ABORTED. Status changed to ABORTED. Stop command received.” 4.3 Reporter Extraction Schedules Reporter integrates scheduling features for routine Reporter tasks (Extraction, Report Generation and database maintenance). 4.3.1 Reporter Extraction Schedules – Details UVMS: Extractions can be scheduled for Data Sources of an individual UVMS or for those of all UVMS (*). Selection: Extractions can be scheduled for Data Sources "Per Node View" or "Per product". The default value is "Per product". Data Sources: If the selection is "Per product", this column will contain UniJob, DUAS or *, otherwise it will contain the name of the selected Node View. Schedule: This column indicates whether the extraction is scheduled to take place regularly (scheduled) or continuously during a pre-defined window (continuous). Next Run: If the extraction is "Scheduled", the next run date is displayed in this column. Continuous Extraction Interval: If the extraction is "Continuous", the extraction window is displayed in this column. 20 | Chapter 4 Reporter Data Management 4.3.2 Reporter Extraction Schedules – Features New: opens a new Extraction Schedule window, refer to section "Reporter Extraction Schedules – New" below. Display: displays the Extraction Schedule of the selected record in Read-Only mode Update: opens the Extraction Schedule of the selected record in Update mode Delete: removes the schedule after confirmation Tools: o Copy to Clipboard (CSV) copies selected data to the clipboard in Comma Separated Values format. Refresh: updates the data display 4.3.3 Reporter Extraction Schedules – New The Save button writes the new schedule to disk. 4.3.3.1 Reporter New Extraction Schedules – General UVMS: This field accepts "*" for all UVMS or the name of the particular UVMS to be targeted. Selection: This field accepts "Per product" or "Per Node View". Per product is the default value. Product/Node View: If the selection is "Per product", Dollar Universe, UniJob or * (both) can be entered, otherwise the required Node View should be specified. Schedule: Scheduling types can be "Scheduled" or "Continuous". If an internal scheduler is not defined in UVMS (UVMS node settings > Internal Scheduler), the only available option is Continuous. If the internal scheduler (Dollar Universe v6 or UniJob) is defined in UVMS, the default schedule type is Scheduled. Refer to paragraph "Declaring the Internal Scheduler" on page 8 for the description of the internal scheduler definition. o If "Scheduled" is selected, the Schedule and Schedule preview sections are open. The Scheduled type implies scheduling at regular intervals using standard UniJob scheduling algorithms. o If "Continuous" is selected, only the Schedule (Continuous) section is open. Extraction will take place almost continuously during the specified interval to ensure that database contents are as fresh as possible. The extraction can only be scheduled on a daily basis. Continuous extraction can be done without any Internal Scheduler defined for the UVMS. The scheduling type Continuous may increase the network traffic. 4.3.3.2 Reporter New Extraction Schedules – Schedule This section contains the standard UniJob scheduling mechanism. Refer to the UniJob User Manual for UniViewer for details. 4.3.3.3 Reporter New Extraction Schedules – Schedule Preview Refer to the UniJob User Manual for details. Chapter 4 Reporter Data Management | 21 4.3.3.4 Reporter New Extraction Schedules – Schedule (Continuous) Continuous extraction requires the user to define a daily time range during which extraction will take place (Start and End fields). Additional parameters allow the definition of a delay between the end of an extraction and the start of the next (waiting time between extractions) and the maximum number of extractions that should be attempted in any single interval (number of repetitive extractions for the interval). 4.4 Reporter Extraction Purges The function to purge data extracted by Reporter, accessible in the UniViewer Administration panel, offers the user a view of the Reporter database purge activity. Purges of the database can be triggered manually from UniViewer Console or be regularly scheduled from Dollar Universe or UniJob. 4.4.1 Reporter Purge Monitor – Details Purge type: This column indicates whether purges are triggered manually from the UniViewer Console or scheduled automatically with the internal scheduler. o If the purge is triggered from UniViewer Console, the Purge Type will be "Manual". o If the purge is automated with the internal scheduler, the Purge Type will be "Automatic". Status: available states are "Running", "Completed" or "Aborted" Start date: the date and time that the purge started End date: the date and time that the purge finished Duration: elapsed time for the purge (End time – Start Time) Records: the total number of data records purged from the database 4.4.2 Reporter Purge Monitor – Features Purge: Opens a popup window requesting user confirmation for a purge to be triggered and the criteria it will use (refer to section "Node Settings – Maintenance" on page 9 for how to define purge criteria.) Purge Schedule: Opens the Update Reporter Purge Schedule document. Refer to section "New Reporter Purge Schedule – Details" below. Delete: Removes the selected purge record from the list after confirmation. Log: Opens the Reporter Purge Log for the selected purge. Log records are time stamped and indicate the different status changes of the purge process. The purge log can be saved to disk using the "Save as …" button. Stop: Cancels a selected purge that was "Running" or "Pending". The purge status will change to "Aborted". Tools: o Copy to Clipboard (CSV) copies selected data to the clipboard in Comma Separated Values format. Refresh: Updates the data display 22 | Chapter 4 Reporter Data Management 4.4.3 New Reporter Purge Schedule – Details The Save button saves the new purge schedule to disk. 4.4.3.1 New Reporter Purge Schedule – Schedule This section contains the standard UniJob scheduling mechanism. Refer to the UniJob User Manual for details. 4.4.3.2 New Reporter Purge Schedule – Schedule Preview Refer to the UniJob User Manual for details. Chapter 5 Report Management | 23 5 Report Management Report Management is accessible from the UniViewer Report & Documentation Panel – Reports section. Two transactions are available. Report Definitions Reports A number of standard report templates are provided with Reporter. Refer to section "Report Templates" on page 32 for a detailed description of the templates. The user has the option to create custom reports, refer to section "Custom Reports" on page 40 . The standard process for creating a report is to create a Report Definition from a Report Template and then to schedule the Report Definition for regular generation. However, users may also wish to generate one off reports more simply. To satisfy this requirement, reports can be manually generated directly from the report template, skipping the Report Definition phase. The user has to supply a Report Definition name. The Report Definition is created and can be scheduled, updated and deleted like any Report Definition. 5.1 Report Definitions This document displays a list of all Report Definitions and their associated Report Template. A Report Definition is necessary to be able to schedule a report for regular generation. Report Definitions can be scheduled directly from this function using the Internal Scheduler with no scripting. 5.1.1 Report Definitions – Details Template: This column contains the name of the Report Template. Report Definition: This column contains the name of the Report Definition attributed by the user. 5.1.2 Report Definitions – Features New: opens the New Report Definition document Display: displays the contents of the selected Report Definition Update: opens the selected Report Definition for update Delete: requests confirmation before removing the selected Report Definition from the list Tools: o Copy to Clipboard (CSV) copies selected data to the clipboard in Comma Separated Values format. Refresh: updates the data display. 24 | Chapter 5 Report Management 5.1.3 New Report Definition Save: the user can either save the new Report Definition by clicking Save, or cancel the creation by clicking on the cross in the upper right-hand corner. 5.1.3.1 New Report Definition – General Report Definition: Enter the name of a new report. This name must be unique. Report Template: Select a Report Template from the list of those available. o Dollar Universe Report Templates are coded as follows: Tx-y Label o UniJob Report Templates are coded as follows: TUJ-x-y Label Where: Element Description T The prefix common to Dollar Universe Templates TUJ- The prefix common to UniJob Templates x The Report Template theme (refer to section "Report Management" on page 23). y The number of the report template within the theme Label The report description Click on the double arrow template. to the right of this field to display the description of the report The report templates are described in the paragraph "Report Templates" on page 32. 5.1.3.2 New Report Definition – Parameters After selecting the report template, the corresponding parameters are displayed in the Parameters section. The content of the Parameters section will differ if the report template concerns Dollar Universe or UniJob. The shared parameters are described below. The parameters specific to a report are detailed in the report template description. Refer to section "Report Templates" on page 32. To change the parameter values select the parameter and click on the Update button or double click on the value. Dollar Universe Parameters: Parameter Value COMPANY No wildcards. Key in a 6 character company code. The company code is verified in the database. If there is no data for the company specified, the generated report output will be empty. NODES [default=*] Data from Nodes not in the list will be excluded from the report. TAGS [default=*] Data from untagged Nodes will be excluded from the report. AREA [default=X] A drop down list allows the user to select which Areas to filter. By default the Production Area is selected. Click on ALL or check the Area(s) that you want to retain. APPLICATION [default=*] Data from applications (of Uprocs) not in the list will be excluded from the report. MU [default=*] Data from MUs not in the list will be excluded from the report. TASK [default=*] T7 only. Data from Tasks not in the list will be excluded from the report. SESS [default=*] Data from Sessions not in the list will be excluded from the report. UPROC [default=*] Data from Uprocs not in the list will be excluded from the report. Chapter 5 Report Management | 25 Parameter Value LANGUAGE [default=English] The language is currently only useable for custom reports. UniJob Parameters: Parameter Value NODES [default=*] Data from Nodes not in the list will be excluded from the report. TAGS [default=*] Data from untagged Nodes will be excluded from the report. TARGET [default=*] Data from Targets not in the list will be excluded from the report. JOB [default=*] Data from Jobs not in the list will be excluded from the report. LANGUAGE [default=English] The language is currently only useable for custom reports. Nodes, Targets or Job filters can be specified as comma separated values (for example: node1,node2,node3) or as a single element with wildcard (node*). New Report Definition-Enhanced Parameter Filtering Mechanisms Reporter introduces enhanced parameter filtering mechanisms. The filters described below are accessible in transactions where the parameters section is available in Update mode (Report definition, manual report generation, report regeneration). The COMPANY parameter does not accept filters. The enhanced filter mechanism support is based on a combination of values to be specified for the report parameters. The following filters are available: Filtering based on a single simple value: o A single simple value (one word only) that can contain wildcard characters (? = 1 character; * = 0 or multiple characters) o A list of simple values (above) split by ‘ ‘ (space character), ‘,’ (comma) or ‘;’ (semicolon). In this case the parameter should contain all the values (logical implicit AND) to be selected. Examples: Simple values: “val1 val2” or “val1.val2” or “val1:val"2”: records with parameters matching val1 AND val2 will be selected Regular expression values: val1: records with parameters starting with val1 will be selected. Regular expression values: val2?: records with parameters starting with val2 - followed by a single character, will be selected. All possible combinations: “val1?,val2,val*”: records with parameters matching val2 and with parameters starting with val1 - followed by a single character, and parameters starting with val will be selected. Filtering based on a set of values: Inclusion filters: a database value is valid if it matches the values provided for the corresponding parameter. The available inclusion/exclusion filters are: Filter Type Description ONE OF Records with one of the list of values will be selected (default value) ALL OF Records with all values in the list will be selected (Nodes Tags only). A node can have several tags, all tags will be evaluated. NONE OF Records with none of the values in the list will be selected. The filter type must be followed by a colon (:) or the type will not be recognized. 26 | Chapter 5 Report Management o Items in the list of values can be separated by space " ", comma "," or semi-colon ";". o Wildcards (? = 1 character; * = multiple characters) can be used anywhere in the parameter. Examples: "simpleval" is equivalent to "ONE OF:simpleval" "rege*aa*" is equivalent to "ONE OF: rege*aa*" ONE OF: val2,val3, val4 records with parameters matching val2, val3 OR val4 will be selected ONE OF: a*,b*,f* records with parameters starting with a,b OR f will be selected Tags only: ALL OF: val1,val2,val3 records whose tags match val1, val2 AND val3 will be selected ALL OF: a*,b*,f* records with tags starting with a, b AND f will be selected For the following rows in the database: Row NODE AREA TAGS 1 cawpmcml X montreal,dev,support, america 2 frlpmcml X paris,dev,sales,support,europe 3 uklmcml X london,sales,europe 4 dewpmcml X frankfurt,sales,europe 5 uslpmcml X boston, sales, america The following filters on TAGS will produce: ALL OF:europe rows 2,3 and 4 ALL OF:dev,support rows 1 and 2 ALL OF:e*,s* rows 2,3 and 4 ONE OF:sales,support rows 1,2,3,4 and 5 ONE OF:par* row 2 NONE OF:dev,support rows 3,4 and 5 5.1.3.3 New Report Definition – Report Window The Report Window is the interval of observation during which data will be selected from the Reporter database to generate the report. All records pertaining to Jobs that started, finished or were running during the window will be selected. The start and end of the Report Window are expressed as a number of months, days, hours and seconds offset from a reference point. The reference point (day) could be: today, the 1st day of the current week or the 1st day of the current month. The reference point (time) can be: now, on the hour: 00:00-23:00. Example: It is now 17h54 on the 4th December 2008. Reference Day Reference Time Offset Start window End window Current Day Current Time -1 month 17h54-4th Nov 2008 17h54-4th Dec 2008 Current Day On the Hour -1 month 17h00-4th Nov 2008 17h00-4th Dec 2008 1st day of current month 00:00 -1 month 00h00-1st Nov 2008 00h00-30th Nov 2008 Current Day 17h00 -1 day 17h00-3rd Dec 2008 17h00-4th Dec 2008 Chapter 5 Report Management | 27 If the extraction from a given Data Source took place before or during the Report Window, data in the database for the Data Source in question will be considered out of date. A warning will be printed at the foot of the generated report indicating that data used for the report may have been incomplete. 5.1.3.4 New Report Definition – Additional Output By default, reports will be generated as PDF files in the directory: <Reporter Server>\data\reports\ Reports are named report_template_name_-_report_definition_name_-_nn.pdf Where nn is the generation counter. Optionally, they can be generated in HTML format and/or be dispatched by email (refer to section "Node Settings – SMTP Parameters" on page 12 for email configuration details). If email dispatch is required, multiple destinations should be separated by commas. If PDF, HTML and email are checked, the report will be saved to disk and emailed in both formats. 5.1.3.5 New Report Definition – Schedule This section contains the standard UniJob scheduling mechanism. Refer to the UniJob User Manual for details. 5.1.3.6 New Report Definition – Schedule Preview Refer to the UniJob User Manual for details. 5.1.3.7 New Report Definition – Purge This section contains just one field: Retention Count [default value=20]. The retention count concerns the number of reports that will be retained on line. For example with the default value at 20, when report number 21 is generated all report files (PDF and HTML) of the generation number 1 will be deleted. Manually generated reports are not purged. The retention count also affects the historical perspectives (refer to section "Reports – Features" below). 5.2 Reports This feature, accessible from the UniViewer Report mode, displays the status of the last execution of each known report. New reports can be generated from existing Report Definitions. One off reports can be generated directly from the Report Template, in which case no Report Definition is required. 5.2.1 Reports – Columns Template: This column displays the name of the Report Template from which each Report Definition was created. 28 | Chapter 5 Report Management Report Definition: This column displays the name of each known Report Definition. Status: Possible states are shown below: o Unknown Status: The Report Definition exists but has never been executed. o Running: The report generation is in progress. o Completed: The report was successfully generated. o Aborted: The report generation was unsuccessful. Consult the Report Generation Log. Start Date: This field shows the date and time that the last generation of this Report Definition started. End Date: This field shows the date and time that the last generation of this Report Definition finished. Duration: This field shows the elapsed time (end time – start time).of the generation. Outdated Nodes: If the extraction from a Data Source precedes the end of the Report Window the data from the Data Source in question will be considered potentially incomplete. This column displays a counter of Nodes whose last extraction is considered out of date. Data is now considered outdated relative to a Report Window rather than an absolute age in days. 5.2.2 Reports – Features New Report: opens an empty Report Generation document. Refer to section "Reports – New Report" on page 28 Display: displays the currently selected generated Report Delete: deletes the selected Report Generation record from the list after user confirmation. History: This button opens the Report Execution History document. This constitutes a list of past generations of the selected report based on the number of reports found in the <Reporter>\data\reports\output directory. Consequently, the number of historical records is also determined by the “Retention Count” defined in the Report Definition [default=20], refer to section "New Report Definition – Purge" on page 27. Log: displays the Report Execution Log. Records are time stamped. This log shows: o Status changes in the generation process o The parameters used formats that were generated. o Who received the report o The details of the purge o Overall completion status Tools: o Copy to Clipboard (CSV) copies selected data to the clipboard in Comma Separated Values format. Refresh: updates the data display 5.2.3 Reports – New Report The "New Report" feature can be used to generate a one shot or regular reports from a Report Definition. The Generate button triggers report generation. Cancel the transaction by clicking on the cross in the upper right-hand corner. Chapter 5 Report Management | 29 5.2.3.1 New Report – General Generation: select a generation mode from the list. o From a Report Definition: the Report Definition must have been created beforehand. The Report can be manually triggered. o Manual report generation: the report can be generated directly from the template. In this mode, the user has to supply a Report Definition name. Report Definition / Report Name: select a Report Definition from the drop-down list or enter Report Definition name for a manual report generation. This field is mandatory in all cases. Report Template: if the report is to be generated from a Report Definition, this field will display the associated Report Template in read-only mode (gray background). If this is a manual report generation with no Report Definition, select a Report Template from the list. This field becomes mandatory (pink background). 5.2.3.2 New Report – Parameters The parameter list displays parameters and their values that will be applied in this generation. Parameters will vary depending on whether the Report Template concerns Dollar Universe or UniJob. If the generation mode is "From a report definition" the parameter list will be read-only. Refer to section "New Report Definition – Parameters" on page 24 for details of the parameters. 5.2.3.3 New Report – Report Window If the generation mode is "From a report definition", the Report Window was defined in the Report Template and cannot be updated in the "New Report Generation" document. If the generation mode is "Manual report generation" the Report Window should be set. The default end date will be set to current date and time and start date will be end date – 1 month. 5.2.3.4 New Report – Additional Output This section displays the output formats that have been selected. If PDF, HTML and email were checked, the report will be saved to disk and emailed in both formats. 5.2.3.5 New Report– Schedule If the Report Definition was scheduled, the scheduling pattern will be displayed in this section. Refer to the UniJob User Manual for details. 5.2.3.6 New Report– Schedule Preview If the Report Definition was scheduled, the schedule can be previewed in this section. Refer to the UniJob User Manual for details. 5.2.3.7 New Report – Purge This section displays the Retention Count. The retention count concerns the number of reports that will be retained on line. For example with the default value at 20, when report number 21 is generated all report files (PDF and HTML) of the generation number 1 will be deleted. The retention count also affects the historical perspectives. 30 | Chapter 5 Report Management 5.2.4 Reports – Display This feature displays the generated report in standard format. Reports can be divided into three parts: Header Body Footer Refer to the Reporter Administrator Manual for a detailed list of provided Report Templates. 5.2.4.1 Example – Report Header Figure 2: Example of Report Header The first part of the banner indicates that the report concerns Dollar Universe Data Sources. The Report Definition name is T1-2 Job Status with List of Anomalies. The second line indicates the name of the Report Template. Next are all parameters and their values used to generate the report. Chapter 5 Report Management | 31 5.2.4.2 Example - Report Body Figure 3: Example of Report Body In this report the first part is a pie graph representation of the distribution of various Job statuses detected in the data for the Report Window. The second part is the list of Jobs with an abnormal status (Aborted, Refused, Time Overrun). The majority of report templates are separated into two sections: 1. Graph 2. List The number of jobs from UVC might not match the number of jobs in the reports or in the database because they do not show the same data: UVC shows a feed coming from the CDJ server that groups the relaunches as one job. Launches or Job runs can also be deleted. Reporter stores data coming from the IO server and describes everything that happened on the Dollar Universe node in detail including all relaunches and adds each execution history. 32 | Chapter 5 Report Management 5.2.4.3 Example – Report Footer Figure 4: Example of Report Footer Extractions are considered "outdated" if they are not dated after the end of the Report Window. If the data of targeted Nodes is considered outdated, this warning will be displayed in the report footer. 5.3 Report Templates Standard report templates are organized around several themes: 1: Job Status 2: System load 4: Average load distribution 5: Status trends 6: Longest Jobs 7: Greatest deviation 8: Relaunched jobs 9: Functional flow 10: Sessions 11: Variables 12: Intervention history 5.3.1 Dollar Universe Report Templates 5.3.1.1 T1-1 Job Status This report displays the number of Jobs per status that ran at some time during the Reporting window. If there are no Jobs recorded for a status, the status is not displayed. This report includes Jobs: That started and finished within the window That started before and finished within That started before and finished after That started within and finished after 5.3.1.2 T1-2 Job Status with List of Anomalies Similar to T1-1 Job Status The second section of the report lists all the executions with anomalies (status Aborted, Time Overrun or Refused) that were completed during the Reporting window. This report is best suited for short Reporting windows (several hours). Chapter 5 Report Management | 33 5.3.1.3 T1-3 Job Status with List of Anomalies and Job Log Similar to T1-2 Job Status with List of Anomalies In the table of the second part of the report, an extra column displays a “Log” hyperlink to the execution log if the job ends in error (“N/A” indicates that the log could not be retrieved). Click on this link to display the associated log. The third section of the report shows the system traces for jobs that end in error if the node parameter for the Reporter node “Extract Job Log for Aborted Job Runs”, section Node Settings – Extraction Process Parameters, is set to Yes. Otherwise, the system trace of jobs that end in error is not listed in the report and the hyperlink does not work. 5.3.1.4 T1-4: Job Status with List of Completed Jobs Similar to T1-1 Job Status The second part of the report lists all the jobs that completed successfully (Completed status) during the Reporting window. 5.3.1.5 T2-1 Load (Elapsed Time) Distribution by Node This report displays the load for each of the servers data was extracted on during the Reporting window. Load is calculated by aggregating the elapsed time of Jobs (in seconds) that ran during the Reporting window (Completed, Aborted, Refused and Time Overrun statuses). 5.3.1.6 T4-1 Average Load Distribution throughout the Day This report displays the average hourly load during the Reporting window: average execution time and average number of jobs for each time period. Load is calculated from the elapsed time of all Jobs (Completed and Aborted statuses) that ran during the hour. 5.3.1.7 T4-2 Average Load Distribution throughout the Week Similar to T4-1 Average Load Distribution throughout the Day This report displays the average per day of the week load during the Reporting window: average execution time and average number of jobs for each day of the week. Load is calculated from the elapsed time of all Jobs (Completed and Aborted statuses) that ran during the day. 5.3.1.8 T5-1 Status Trends (Days) This report lists, for each day of operation of the report window, the number of jobs for each execution status (Completed, Aborted, Refused, Time Overrun) and the proportion compared to the total number of executions. This report is best suited to a monthly Reporting window. 5.3.1.9 T6-1-2 N Longest Jobs per Context (with Condition Check) This report lists the n longest Jobs that ran during the Reporting window. Two graphs are displayed: The average duration of condition checks corresponds to the duration of the Event Wait status. 34 | Chapter 5 Report Management The average execution time corresponds to the duration of Pending and Running statuses. The duration taken into account starts with the first status change that takes place during the Reporting window (Pending and Running) and ends with the final status (Completed or Aborted). The Jobs are taken in their specific execution context (Company, Node, Area, Management Unit, Session and Session node). A specific parameter LONGEST_JOBS_NO is used to decide how many jobs are included in the report. Parameter Description LONGEST_JOBS_NO [default=10] The number of longest jobs that will be displayed in the report. 5.3.1.10 T6-2-2 N Longest Jobs per Context (without Condition Check) Similar to T6-1-2 N Longest Jobs per Context (with Condition Check) Only the running phase is included in the calculation of the duration. 5.3.1.11 T6-3-2 N Longest Sessions per Context (with Condition Check) Similar to T6-1-2 N Longest Jobs per Context (with Condition Check) This report lists the n longest Sessions that ran during the Reporting window. The Sessions are taken in their specific execution context (Company, Node, Area, Management Unit and Session node). A specific parameter LONGEST_SESS_NO is used to decide how many Sessions are included in the report. Parameter Description LONGEST_SESS_NO [default=10] The number of longest Sessions that will be displayed in the report. 5.3.1.12 T6-4-2 N Longest Sessions per Context (without Condition Check) Similar to T6-3-2 N Longest Sessions per Context (with Condition Check) Only the running phase is included in the calculation of the duration. 5.3.1.13 T7-1-1 Greatest Deviation per Job Context (with Condition Check) This report displays all the jobs that were executed during the Reporting window and indicates the variation of their execution duration compared to the average. Jobs whose variation of the execution duration exceeds a given threshold are included in the report. For each job, two curves are displayed; the variation of the condition checks duration (Event Wait status) and the variation of the total duration of the execution (Event Wait, Pending and Running statuses). Jobs are taken in their specific execution context (Company, Node, Area, Management Unit, Session and Session node). Parameter Description SAMPLING_COEFFICIENT [default=30.0] The percentage of the reporting window that will be used to calculate the deviation. THRESHOLD [default=-100.0] Percentage deviations shorter than this value will be excluded from the report. MIN_DURATION [default=1] Durations shorter than this value will be excluded from the report. Chapter 5 Report Management | 35 Deviation is calculated by comparing average duration in the last part of the reporting window compared to the average duration in the first part of the reporting window. Excess is calculated as a percentage (i.e. the execution lasted 20% longer in the second part compared to the first part). Figure 5: Report T7 Calculation Principles SAMPLING_COEFFICIENT represents the duration of the second period as a percentage of the reporting window. DRIFT_RATIO is an indicator that represents the ratio with which the average execution duration increases or decreases in the second period compared to the first period. THRESHOLD represents a DRIFT_RATIO filter, for example: o A value of -100 will display all the variations (increases and decreases). o A value of 0 only displays increases in the duration. o A value of 30 only displays increases of 30% or higher. 5.3.1.14 T7-2-1 Greatest Deviation per Job Context (without Condition Check) Similar to T7-1-1 Greatest Deviation per Job Context (with Condition Check) Only the running phase is included in the calculation of the deviation. Jobs are taken in their specific execution context (Company, Node, Area, Management Unit, Session and Session node). 5.3.1.15 T7-3-1 Greatest Deviation per Session Context (with Condition Check) Similar to T7-1-1 Greatest Deviation per Job Context (with Condition Check) This report displays all the sessions that were executed during the Reporting window and indicates the variation of their execution duration compared to the average. Sessions are taken in their specific execution context (Company, Node, Area, Management Unit and Session node). 5.3.1.16 T7-4-1 Greatest Deviation per Session Context (without Condition Check) Similar to T7-3-1 Greatest Deviation per Session Context (with Condition Check) Only the running phase is included in the calculation of the deviation. Sessions are taken in their specific execution context (Company, Node, Area, Management Unit and Session node). 5.3.1.17 T8-1 Re-launched Jobs This report lists the jobs that were executed during the Reporting window. The specific parameter ONLY_RELAUNCHED_JOBS is used to display only the jobs that were relaunched. 36 | Chapter 5 Report Management Parameter Description ONLY_RELAUNCHED_JOBS [default=Yes] If Yes is selected, only relaunched jobs will be displayed in the report. If No is selected, all jobs are displayed in the report. 5.3.1.18 T9-1 Functional Flow This report is about the status and duration of complex business processes. This report measures the length of an inter-session functional chain or compares the duration of two inter-session functional chains, during the report window. The notion of a functional chain doesn't exists in Dollar Universe, the user is invited to indicate the starting and ending job in the functional chain, as well as the maximum deviation in the processing date between the starting and ending jobs. The parameters below allow for the following data to be entered: Parameter Description FUNCTIONAL_FLOW No wildcards. Enter the first and last Uproc of the functional flow in the following format: For one functional chain: (U1=UPROC1,S1=SESSION1,M1=UG1,U2=UPROC2,S2=SESSION2,M2=UG2). For two functional chains: (U1=UPROC1,S1=SESSION1,M1=UG1,U2=UPROC2,S2=SESSION2,M2=UG2),(U 3=UPROC3,S3=SESSION3,M3=UG3,U4=UPROC4,S4=SESSION4,M4=UG4) The start and end date of the flow will be displayed in the report. If there is no data for the flow specified, the generated report output will be empty. PROCESSING_DATE_ MAX_OFFSET [default=1] Maximum deviation (in days) in the processing date between the starting and ending jobs in the functional chain. Offsets longer than this value will be excluded from the report. The time scale displayed on the abscissa corresponds to the Reporting window. The time displayed on the ordinate is the calculated duration between the start of the job of the first Uproc and end of the job on the last Uproc. The final status corresponds to the status of the last Uproc in the functional chain. The unit of time is a day: If the functional chain is executed several times in the same day, the duration displayed in the graph is the average duration of these executions. If the functional chain is not executed for a day, no points will be displayed in the curve. 5.3.1.19 T9-2 Functional Flow Similar to T9-1 Functional Flow The unit of time is a minute: If the functional chain is executed several times in the same minutes, the duration displayed is the average of these executions. If the functional chain is not executed for a minute, no points will be displayed in the curve. 5.3.1.20 T9-3 Functional Flow Similar to T9-1 Functional Flow The unit of time is a week: Chapter 5 Report Management | 37 If the functional chain is executed several times in the same week, the duration displayed in the graph is the average duration of these executions. If the functional chain is not executed for a week, no points will appear in the curve. 5.3.1.21 T10-1 Session Overview This report lists each selected task (Node, MU, Task, Session, Uproc or Heading Uproc) as well as associated production information. The list is sorted according to the following rules: Independent Uprocs, sorted by the Uproc number Session (one line by session), sorted by Task name and Session number. The Status column indicates: In the case of an independent Uproc: the last status obtained when this Uproc was executed. In the case of a Session: the status of the Session Uproc with the highest priority. The Session status is obtained with the following rule: if at least one Uproc in a Session is completed with the follow status (in following order of priority), the Session will take the same status: 1. Aborted 2. Refused 3. Time Overrun 4. Even Wait 5. Running 6. Completed The Start Date indicates the first launch date of the Uproc or of the first Uproc in a session. The Last Modification Date is the date of the update of the last Uproc status change (in the case of an independent Uproc) or a Uproc in a session. The Number of the last column shows the Uproc number for an independent Uproc or the Session number for a Session. 5.3.1.22 T10-2 Expanded Sessions Similar to T10-1 Session Overview The list is sorted according to the following rules; Independent Uprocs: sorted by the Uproc number Sessions: sorted by the task name and the Session number. For each Session number, the list displays all the Uprocs sorted by Uproc number with their launch and end date/hour as well as their status. 5.3.1.23 T11-1 Execution Variables This report displays all the job runs (with a Completed, Aborted, Refused or Time Overrun status) in the Reporting window therefore at least one of the variables corresponds to the variables listed in the VARIABLES parameter. 38 | Chapter 5 Report Management Parameter Description VARIABLES [default=*] Variables that must appear in the report. Several variables can be entered separately using a comma, for example: VAR1,VAR2 The list is sorted by Node, Area, MU, Task, Session, Uproc and variable. 5.3.1.24 T12-1 History This report displays the Interventions history, exceptions history and/or outages history, for the selected tasks within the time period specified in the Reporting window. Parameter Description REPORTTYPE [default=* all histories] Indicates the data type contained in the report: H: interventions history: displays the user’s actions in production. X: exceptions history: displays the exceptions used by production. O outages history: displays the outages. PARENT_TASK [default=*] Data from main Tasks not in the list will be excluded from the report. SPECIFIC_TASK [default=*] Data from specific Tasks not in the list will be excluded from the report. If all histories are required, each history is the subject of a chapter, in the following order: User actions, Outages and Exceptions. Each intervention/outage/exception is the subject of a specific section containing all important data. 5.3.2 UniJob Report Templates 5.3.2.1 TUJ-1-1 Job Status This report displays status of Jobs that ran during the Reporting window. If no jobs are recorded for a certain status, the status will not appear in the report. This includes Jobs that started and finished within the window, that started before and finished within, that started before and finished after, that started within and finished after. 5.3.2.2 TUJ-1-2 Job Status with list of anomalies Similar to TUJ-1-1 Job Status The second part of the report lists all the jobs with anomalies (Aborted or Time Overrun statuses) that ended within the Reporting window. This report is best suited for short Reporting windows (several hours). 5.3.2.3 TUJ-2-1 Load (Elapsed Time) Distribution by Node Indicates the load for each server where data was extracted during the Reporting window. The load is calculated by adding the elapsed time of jobs (in seconds) that were executed (Completed, Aborted and Time Overrun statuses) during the Reporting window. Chapter 5 Report Management | 39 5.3.2.4 TUJ-4-1 Average Load Distribution throughout the Day This report indicates the average load per hour during the Reporting window: average job duration and average number of jobs for each hour. The load is calculated from the elapsed time of all jobs (Completed and Aborted statuses) in an hour. 5.3.2.5 TUJ-4-2 Average Load Distribution throughout the Week Similar to TUJ-4-1 Average Load Distribution throughout the Day This report indicates the average load per day of the week during the Reporting window: the average job duration and the average number of jobs for each day of the week. The load is calculated from the elapsed time of all jobs (Completed and Aborted statuses) during the day. 5.3.2.6 TUJ-5-1 Status Trends (Days) This report presents, for each day of operation of the Reporting window, the number of jobs for each execution status (Completed, Aborted and Time Overrun) and the proportion compared to the total number of jobs. This report is best suited to a monthly Reporting window. 5.3.2.7 TUJ-6-1 N Longest Jobs per Context This report lists the longest n jobs that were executed during the Reporting window. The average job duration corresponds to the duration of the Pending and Running statuses. The duration that is taken into account starts with the first known status change in the Reporting window (Pending and Running) and ends with the final status (Completed or Aborted). The Jobs are taken in their specific execution context (Node and Target). A specific parameter LONGEST_JOBS_NO is used to decide how many jobs are included in the report. Parameter Description LONGEST_JOBS_NO [default=10] The number of longest jobs that will be displayed in the report. 5.3.2.8 TUJ-8-1 Re-launched jobs This report lists the jobs that were executed during the Reporting window. A specific parameter ONLY_RELAUNCHED_JOBS is used to display only the jobs that were relaunched. Parameter Description ONLY_RELAUNCHED_JOBS [default=Yes] If Yes is selected, only relaunched jobs will be displayed in the report. If No is selected, all jobs are displayed in the Report. 40 | Chapter 6 Custom Reports 6 Custom Reports If the report templates provided by Reporter are not sufficient, the user can create custom reports. He can internationalize the provided reports into other languages than those provided. The two types of customization are described below. Please note that custom report templates cannot be included in the upgrade processes supplied by Reporter. If the database schema changes in a new version, which is frequently the case, custom reports may need to be adapted before they can function correctly. 6.1 Prerequisites and recommendations The following software versions are required to modify/create custom reports: iReport : version 4.0.2 JDBC driver : versions supported by Reporter JRE : version supported by Reporter Notes on modifying existing reports Before modifying an existing standard template, ensure that you have a backup of the files in a safe place. A template modification is effective at the next report generation. It is therefore recommended to ensure there is no automatic scheduling of this report generation before making any modifications. 6.2 Internationalization Report templates are provided in two languages: French and English. It is always possible to obtain reports in other languages by creating new resource files (containing the report text) in the selected language. 6.2.1 Description Jasper Reports enables the association of resource bundle files to internationalize text within the report templates. These resource bundle files have the extension .properties and contain a list of key value associations that describe all static text in the report templates. The standard report templates properties files in Reporter can be found in the directory: <Reporter Server>\data\reports\templates\system\resources. The custom report templates properties files in Reporter can be found in the directory: <Reporter Server>\data\reports\templates\custom\. To add another language translation set to the existing list, the user must create another file that will contain the same keys but is associated with translated values. 6.2.2 Naming Conventions These files must respect the following naming conventions: <Base File Name>_<Language>[_<Country>].properties Chapter 6 Custom Reports | 41 For example, with the base file name SystemResourceBundle it is possible to have the following translations: For English: SystemResourceBundle_en.properties For French: SystemResourceBundle_fr.properties For French in France locale: SystemResourceBundle_fr_FR.properties Once created, the files must be placed in the resources folder, either under system or custom. In the case of an upgrade or a patch, translations sent by default to the data\reports\templates\system\resources folder may be overwritten. To this effect, custom reports and resources should always be located under data\reports\templates\custom\. 6.2.3 Executing Reports Jasper Reports offers two methods for retrieving the messages from the properties file: msg() – used for parameterized messages str() – used for simple messages. For example: The base name for the report’s resource bundle is set in the report’s properties section. When executing the reports within iReport the user must do some additional configurations: Verify that the resource bundle file exists under the same folder as the report template that is being executed. Set up the locale files that will be used for the report: 42 | Chapter 6 Custom Reports Select the report locale so that the right internationalized file will be used either from predefined locales or create a custom locale. 6.3 SQL Queries Guidelines In order to develop custom report templates for Reporter, the user must follow some rules regarding the content of the SQL query, and if using iReport 4.0.2 for development, then the user must also configure it properly. If the user does not use a GUI to develop reports, the following element must be modified inside the report template source file (it is a .jrxml file): <queryString> to <queryString language="ORSYP_SQL"> A table column that has an associated report parameter and which is supposed to be filtered using the enhanced mechanism, must be used with the $X{…} syntax inside the comparison (where clause). In JasperReports, the following syntax: $X{<function name>, <DB_column_name>, <parameter_name>} represents the mechanism of calling a custom function, defined and registered with the report template. In Reporter, the custom function is named REPORTER_DB_FILTER and it represents the enhanced filter mechanism. The binding between this function and its implementation is made by the new query executer that must be registered with the report template. Inside the corresponding Java code, in Reporter Server, this function dynamically generates the corresponding SQL code that is used inside the where clause to filter data. In order to make use of the enhanced filter mechanism, the user must use this custom function, with the proper column name and the proper associated parameter, and the Reporter Server will replace that construction with a dynamic SQL clause that will filter the data. For example, for filtering the database column named NODE_NAME, using the values passed into the parameter named NODES, the where clause will contain the following line. $X{REPORTER_DB_FILTER, NODE_NAME, NODES} If there is an alias used for the table containing the column that will be filtered, then the column name must be accessed using that alias (otherwise there will be errors in the SQL query). This Example computes the number of executions, grouped by status: select rl.FINAL_STATUS, count(*) STATUS_COUNT from UNI_EVT_RELAUNCHES rl inner join UNI_EVT_DATASOURCES d on rl.DATASOURCE_ID = d.DATASOURCE_ID where (d.COMPANY_NAME = $P{COMPANY}) and $X{REPORTER_DB_FILTER, d.NODE_NAME, NODES} and $X{REPORTER_DB_FILTER, d.AREA_NAME, AREA} and $X{REPORTER_DB_FILTER, d.TAG_NAME, TAGS} and $X{REPORTER_DB_FILTER, rl.MANAGEMENT_UNIT_NAME, MU} and $X{REPORTER_DB_FILTER, rl.APPLICATION, APPLICATION} and $X{REPORTER_DB_FILTER, rl.SESSION_NAME, SESS} and $X{REPORTER_DB_FILTER, rl.UPROC_NAME, UPROC} group by rl.FINAL_STATUS The above example returns the status count for each status, and the filtering is made based on COMPANY, NODES, AREA, TAGS, MU, APPLICATION, SESS and UPROC. The columns that must be filtered in the regular way must be used the same way as they were used before (see COMPANY, for this case). Chapter 6 Custom Reports | 43 6.4 iReport Reporter Server uses a new database model. In order to support this new model, all the SQL queries inside the report templates have been updated. All report templates provided by Reporter have been developed with iReport V4.0.2. iReport is the most popular visual designer tool for JasperReports Library and JasperReports Server (Business Intelligence) and can be downloaded on the internet. Custom templates reports are .jasper files that should be located in the following directory: <ReporterServer>\data\reports\templates\custom\<db_type>. 6.4.1 iReport Configuration If developing reports with iReport 4.0.2, the following configurations have to be done, in order to be able to use the enhanced filtering. 6.4.1.1 JDBC Driver Installation Since Reporter works with only two types of databases, the corresponding JDBC driver have to be added to iReport’s class path. After downloading the driver, it must be added either into iReport’s class path either copied into the iReport lib subdirectory, for example: C:\Program Files\JasperSoft\iReport-4.0.2\lib. Database connections in iReport V4.0.2 can be managed through the Connections/Data Sources action that can be accessed by clicking on the icon in the toolbar. To configure a connection in iReport there are two possible situations depending on the type of database: 44 | Chapter 6 Custom Reports Figure 6: iReport connection to Oracle server configuration Figure 7: iReport connection to MS SQL server configuration 6.4.1.2 Add the Query Executer classes to the class path To be able to compile and execute Reporter reports templates, iReport must have access to the enhanced filter classes. Copy the following jars files from Reporter’s exec folder: o RepPubCommon.jar o RepPubServer.jar o RepServerJava.jar Chapter 6 Custom Reports | 45 Either to the iReport class path. Select the Tools/Options menu option and then the Classpath tab or enter “Classpath” into the search window. Or into iReport’s lib folder. For example: C:\Program Files\JasperSoft\iReport-4.0.2\lib. 6.4.1.3 Register New Query Executer The user must register a new query executer inside iReport. Select the Tools/ Options menu option and then the Query Executers tab. The new executer that must be added has the following information: Language: ORSYP_SQL Factory Class: com.orsyp.reports.filters.OrsypJdbcQueryExecuterFactory Fields Provider class: com.jaspersoft.ireport.designer.data.fieldsproviders.SQLFieldsProvider 6.4.1.4 Set New Query Language The report query language must be set to ORSYP_SQL. This new language is the one defined at the previous configuration step, when registering the new report executer. 46 | Chapter 6 Custom Reports 6.4.2 Compiling and Executing Report Templates All report source files must be compiled in order to be used in Reporter Server. This is a process that applies to both newly created reports and updated reports from previous versions. When using iReport 4.0.2 for compiling templates, even if the compilation is successful, the following warning message may appear: net.sf.jasperreports.engine.JRRuntimeException: net.sf.jasperreports.engine.JRException: Class com.orsp.reports.filters.OrsypJdbcQueryExecuterFactory not found. This message should be ignored as it is displayed because iReport does not have access to the Reporter Server’s query executer class. The newly created report can be executed from iReport if the user adds a hidden parameter named HIDDEN_DB_TYPE and sets up the type of DB it executes on as the default value. For example: After successfully compiling and testing the report templates, deploy the compilation output into the corresponding folders <Reporter Server>\data\reports\templates\custom\ or \data\reports\templates\system\resources. Chapter 7 About Automic Software, Community and Services | 47 7 About Automic Software, Community and Services This topic introduces the Automic Software company and how to leverage the full potential of our solutions to you. You can also obtain Automic documentation online from docs.automic.com. 7.1 Automic Software Company Automic Software is dedicated to business automation. Automic is the world's most comprehensive platform in automating businesses. Founded 1985, Automic pioneered the largest, independent, globally deployed automation platform which powers the enterprise, application and infrastructure. Now, as the consumerization of IT accelerates, Automic is re-imagining how organizations integrate next generation service models such as Cloud, DevOps and Big Data. Today, our software automates tens of millions of operations a day for over 2,000 customers worldwide. We challenge conventional thinking, enabling our customers to be faster, smarter, in control. Automic – the standard in business automation. Find out more at our website www.automic.com . 7.2 Automic Community Want to connect with other Automic users to compare notes or learn how others are tackling problems that you’re running into? Talk with other users from around the world to learn how they optimize their business automation with Automic. Interact with the Automic Team to get ONE Automation Platform tips and tricks straight from the source. Join the Automic Community and become an Automic Insider and be among the first to get news about new products and events, even before they are generally announced! 7.3 Download Center Make sure that you are using our products to their fullest potential. The Download Center is the place where you find product downloads, documentation and information on new releases and hot-fixes about your Automic solution. It’s all in one place: from service hotfixes, release notes, and all guides. You will also find patch descriptions, known bugs or workarounds. 48 | Chapter 7 About Automic Software, Community and Services 7.4 Technical Support We have a support team you can trust. Our team of professionals is ready to support you, anytime and anywhere. Three support centers located in Europe, the United States, and Asia Pacific build the core of the Automic support organization. Our Technical Support Team makes sure that your closest Automic experts are never more than a few hours flight away, no matter on which continent your subsidiaries and data centers are located. Automic Software is designed to provide global connectivity for international companies. You are employing Automic software on a global scale and therefore you can expect global service. 7.5 Training and Services Do you want to learn even more about Automic solutions? We offer a range of training options on how to get the most out of your Automic solution. Depending on your location, either open training sessions at an Automic Software Service Center, or personalized training sessions at your company's site suits best. Visit the training site and get detailed information about currently offered courses.
© Copyright 2026 Paperzz