Reporter Administration 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 Administration Guide | iii
Contents 1 Release Notes ...................................................................................................................... 7 2 Introduction .......................................................................................................................... 8 2.1 Who Should Read this Manual ....................................................................................... 8 2.2 What this Manual Contains ............................................................................................. 8 3 Concepts and Architecture ................................................................................................. 9 3.1 Concepts ......................................................................................................................... 9 3.1.1 Data Source .............................................................................................................. 9 3.1.2 Extraction .................................................................................................................. 9 3.1.3 Database Contents ................................................................................................... 9 3.1.4 Node Views............................................................................................................... 9 3.1.5 Report ....................................................................................................................... 9 3.1.6 Report Template ..................................................................................................... 10 3.1.7 Tags ........................................................................................................................ 10 3.2 Architectural Components ............................................................................................ 11 3.2.1 UniViewer Console (UVC) ...................................................................................... 11 3.2.2 Reporter Server ...................................................................................................... 11 3.2.3 UniViewer Management Server (UVMS) ................................................................ 12 3.2.4 Database ................................................................................................................ 12 3.2.5 Dollar Universe Application Server (DUAS) ........................................................... 12 3.2.6 Internal Scheduler .................................................................................................. 12 3.2.7 Reporter Client for Dollar Universe ........................................................................ 12 3.2.8 UniJob (UJ) ............................................................................................................. 13 3.2.9 Reporter Client for UniJob ...................................................................................... 13 4 Installation .......................................................................................................................... 14 4.1 Hardware Requirements ............................................................................................... 14 4.1.1 Reporter Server Requirements............................................................................... 14 4.1.2 Database Server Requirements ............................................................................. 14 4.1.3 Reporter Client for UniJob/Dollar Universe Requirements ..................................... 15 4.1.4 Data Source Requirements .................................................................................... 15 4.2 Software Requirements ................................................................................................ 15 4.2.1 Java ........................................................................................................................ 15 4.2.2 JDBC Drivers .......................................................................................................... 15 4.2.3 Database Character Set ......................................................................................... 15 4.3 Preliminary Checks ....................................................................................................... 16 4.4 Installing the Reporter Server on Windows .................................................................. 16 4.4.1 Multiple Instances ................................................................................................... 16 4.4.2 The Welcome Screen ............................................................................................. 17 4.4.3 User License ........................................................................................................... 17 4.4.4 Define the Java Environment (JDK or JRE) ........................................................... 17 4.4.5 Select the Installation Type .................................................................................... 17
iv | Contents
4.4.6 Reporter Server Installation Directory .................................................................... 17 4.4.7 Reporter Server Information ................................................................................... 18 4.4.8 Define JDBC Driver ................................................................................................ 18 4.4.9 Ready to Install the Program .................................................................................. 18 4.4.10 InstallShield Wizard Completed.............................................................................. 19 4.5 Installing the Reporter Client for UniJob or Dollar Universe on Windows .................... 19 4.5.1 Destination Folder .................................................................................................. 19 4.5.2 Reporter Server Information ................................................................................... 19 4.5.3 Ready to Install the Program .................................................................................. 19 4.5.4 InstallShield Wizard Completed.............................................................................. 19 4.6 Installing the Reporter Server on Linux ........................................................................ 19 4.6.1 Installation Choice .................................................................................................. 20 4.6.2 Reporter Software License Agreement .................................................................. 20 4.6.3 Selecting the Installation Type................................................................................ 21 4.6.4 Location of the Java Command .............................................................................. 21 4.6.5 Reporter Server Name ........................................................................................... 21 4.6.6 Installation Directory ............................................................................................... 22 4.6.7 Reporter Server Host Name ................................................................................... 22 4.6.8 Reporter Server Port Number................................................................................. 22 4.6.9 Path to the JDBC Driver File .................................................................................. 22 4.6.10 Proceed with the Installation................................................................................... 22 4.7 Installing the Reporter Client for UniJob on Linux ........................................................ 23 4.7.1 Path to the UniJob Installation ................................................................................ 23 4.7.2 Reporter Server Name ........................................................................................... 23 4.7.3 Reporter Server Host Name ................................................................................... 23 4.7.4 Reporter Server IP Communication Port ................................................................ 23 4.7.5 Proceed with Installation ......................................................................................... 23 4.8 Installing the Reporter Client for Dollar Universe on Linux........................................... 23 4.8.1 Prerequisites on Linux ............................................................................................ 24 4.8.2 Location of the Java Command .............................................................................. 24 4.8.3 Dollar Universe Company Directory ....................................................................... 24 4.8.4 Reporter Server Name ........................................................................................... 24 4.8.5 Reporter Server Host Name ................................................................................... 24 4.8.6 Reporter Server IP Communication Port ................................................................ 24 4.8.7 Proceed with Installation ......................................................................................... 24 5 Configuration ..................................................................................................................... 25 5.1 Licenses ........................................................................................................................ 25 5.2 Network Configuration .................................................................................................. 25 5.3 Database Schema Setup .............................................................................................. 25 5.3.1 User Creation.......................................................................................................... 26 5.3.2 Database Initialization ............................................................................................ 26 5.3.3 Check User Rights on Tables ................................................................................. 26 5.4 Starting and Stopping the Reporter Server .................................................................. 26 5.5 Initialize Reporter Security ............................................................................................ 27 5.5.1 Users Rights ........................................................................................................... 27
Reporter Administration Guide | v
5.5.2 SSL Communication ............................................................................................... 27 5.6 Declare the UniViewer Management Server ................................................................ 35 5.7 Validate Database Settings .......................................................................................... 36 5.8 Validate Extraction and Load ........................................................................................ 36 5.9 General Recommendations .......................................................................................... 37 6 Upgrade, Rollback and Uninstall ...................................................................................... 38 6.1 Upgrade Sequence ....................................................................................................... 38 6.2 Migrating the Database................................................................................................. 38 6.2.1 Upgrade the Oracle Database Schema ................................................................. 39 6.2.2 Upgrade MS SQL Server Database Schema ......................................................... 40 6.2.3 Error Handling......................................................................................................... 41 6.2.4 Logging Upgrade Progress ..................................................................................... 41 6.3 Upgrading Reporter on Windows ................................................................................. 41 6.3.1 Upgrading the Reporter Server on Windows .......................................................... 41 6.3.2 Upgrading the Reporter Client ................................................................................ 42 6.4 Upgrading Reporter on Linux ....................................................................................... 42 6.4.1 Upgrading the Reporter Server on Linux ................................................................ 42 6.4.2 Upgrading the Reporter Client ................................................................................ 43 6.5 Rollback Reporter Database ........................................................................................ 44 6.6 Rollback Reporter ......................................................................................................... 44 6.6.1 Reporter Client for Dollar Universe Rollback on Windows ..................................... 44 6.6.2 Reporter Client for Dollar Universe Rollback on Linux ........................................... 44 6.7 Removing Reporter Components ................................................................................. 45 6.7.1 Un-installing the Reporter Server on Windows ...................................................... 45 6.7.2 Un-install the Reporter Client for Dollar Universe on Windows .............................. 45 6.7.3 Un-install the Reporter Client for UniJob on Windows ........................................... 45 6.7.4 Un-installing Reporter Server from Linux ............................................................... 45 6.7.5 Un-install the Reporter Client on Linux ................................................................... 46 7 Authentication and User Rights ....................................................................................... 47 7.1 After Installation ............................................................................................................ 48 7.1.1 Internal Users ......................................................................................................... 48 7.1.2 Extraction from Dollar Universe V5 Targets ........................................................... 48 7.1.3 Extraction from UniJob and DUAS V6 Targets ...................................................... 48 7.2 Reporter User Management ......................................................................................... 48 7.2.1 Add a User to the Reporter Internal User List ........................................................ 48 7.2.2 Delete a User from the Reporter Internal User List ................................................ 49 7.2.3 List Reporter Internal Users .................................................................................... 49 7.3 Reporter Proxy Management ....................................................................................... 49 7.3.1 Add a Proxy Rule to Reporter Server ..................................................................... 49 7.3.2 Delete a Proxy Rule from a Reporter Server .......................................................... 50 7.3.3 List Proxy Rules on a Reporter Server ................................................................... 50 7.3.4 Retrieve the Name of a Proxy User ........................................................................ 51 8 Command Interface ........................................................................................................... 52 8.1 Data Management ........................................................................................................ 52
vi | Contents
8.1.1 Triggering Extractions ............................................................................................. 52 8.1.2 Monitoring Extractions ............................................................................................ 53 8.1.3 Triggering a Database Purge ................................................................................. 55 8.2 Report Management ..................................................................................................... 56 8.2.1 Using Report Templates ......................................................................................... 56 8.2.2 Triggering Reports .................................................................................................. 57 8.2.3 Report Customization ............................................................................................. 57 9 Reporter Troubleshooting................................................................................................. 58 9.1 Tracing the Problem ..................................................................................................... 58 9.2 Error Messages ............................................................................................................ 58 9.2.1 Reporter Node Not Defined – Connection Refused ............................................... 58 9.2.2 Table Does Not Exist .............................................................................................. 58 9.2.3 Impossible to Submit Command – Job Aborted ..................................................... 61 9.2.4 Extractions Do Not Work ........................................................................................ 61 9.2.5 Database Connection ............................................................................................. 62 9.2.6 UniViewer Management Server Connection .......................................................... 62 9.2.7 Error in Custom Reports ......................................................................................... 62 9.3 Changing a Java Runtime Environment ....................................................................... 63 10
Reporter V6 Data Model ............................................................................................... 64
10.1 Functional Database Tables ......................................................................................... 64 10.1.1 UNI_EVT_AUDITTRAIL ......................................................................................... 64 10.1.2 UNI_EVT_DATASOURCES ................................................................................... 65 10.1.3 UNI_EVT_INTERVENTIONS ................................................................................. 66 10.1.4 UNI_EVT_JOBLOGS ............................................................................................. 68 10.1.5 UNI_EVT_MESSAGES .......................................................................................... 69 10.1.6 UNI_EVT_PARAMETERS...................................................................................... 69 10.1.7 UNI_EVT_RELAUNCHES ...................................................................................... 69 10.1.8 UNI_EVT_STATUSES ........................................................................................... 70 10.1.9 UNI_EVT_VARIABLES .......................................................................................... 71 10.2 Technical Database Tables .......................................................................................... 71 10.2.1 UNI_EVT_EXTRACTIONS ..................................................................................... 71 10.2.2 UNI_EVT_LOG ....................................................................................................... 71 10.2.3 UNI_EVT_PURGES ............................................................................................... 72 10.2.4 UNI_EVT_REPORTS ............................................................................................. 72 10.2.5 UNI_TECH_REPORTS .......................................................................................... 73 11
About Automic Software, Community and Services ................................................ 74
11.1 Automic Software Company ......................................................................................... 74 11.2 Automic Community...................................................................................................... 74 11.3 Download Center .......................................................................................................... 74 11.4 Technical Support ......................................................................................................... 75 11.5 Training and Services ................................................................................................... 75
Chapter 1 Release Notes | 7
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.
2015-05
Correction on a cross reference
8 | Chapter 2 Introduction
2 Introduction Welcome to the Reporter Administrator Guide! Reporter integrates directly with the UniViewer interface. It is compatible with Dollar Universe Application Server V5 and V6 which imposes changes to the database structure concerning the following new features:
Task Identifiers
Improved Intervention History
Reporter itself boasts improved Audit Trail Extraction and a dedicated security role managed from UniViewer Management Server.
2.1 Who Should Read this Manual This document is aimed for the administrator who is expected to install, configure and maintain the Reporter product. It does not detail everyday usage from the UniViewer GUI. In order to draw full benefit from this document, readers should be familiar with the following:
Dollar Universe Application Server (installation, administration, usage)
UniJob (installation, administration, usage)
UniViewer Graphical user interface
Database administration
Report templates
2.2 What this Manual Contains This document describes Reporter:
Architecture and concepts
Installation, configuration and administration
Commands for triggering extractions, generating reports and database maintenance
Troubleshooting
The data model
Chapter 3 Concepts and Architecture | 9
3 Concepts and Architecture 3.1 Concepts This section defines the key product terminology.
3.1.1 Data Source A Data Source (defined by Company, Node and Area) corresponds to the I/O server of a Dollar Universe Application Server or a UniJob. Data can be extracted from a single target Data Source or from multiple Data Sources in parallel.
3.1.2 Extraction Reporter extracts operations data from data sources and loads it into the database. The term Extraction refers to the action of extracting data and not the data extracted. An Extraction is identified by its source (Company / Node / Area), a start time and an end time. The user can only control the start time as the extraction ends when all operations data has been loaded from the targeted data sources. For UniJob Nodes the Company is always “UNIJOB” and the Area is always “X”. Extractions can be triggered for an individual Node or for groups of nodes (Node Views).
3.1.3 Database Contents Data extracted by Reporter is concerned purely with operations events, as opposed to scheduling parameters (see the Publisher v4.0.x User Manual). The data extracted by Reporter includes job monitoring data, future launches, execution history, job logs, audit trails etc. Extracted data is loaded into a database. The database is identified by the following information:
Database type
A server hostname
A global database identifier
A Reporter Server can only access one instance of a database.
3.1.4 Node Views The Node View is a collection of Nodes of the same product type (i.e. UniJob or Dollar Universe). Use of the Node View avoids the user having to specify the individual target Nodes for each extraction. Nodes can be included in a Node View by filters on the Node name, the Operating system or Tags.
3.1.5 Report A report is generated from a report template using its selection criteria: report window, Company, Node, Area, status etc.
10 | Chapter 3 Concepts and Architecture
The same template can be used to create numerous reports with different filters and selection criteria. Reports can be generated manually or scheduled from UniViewer. Report output can be presented in a PDF, displayed in HTML format or delivered by email.
3.1.6 Report Template A selection of report templates is provided to cover a wide range of reporting requirements:
Job Status
System load
Workload trends
Average loads
Success/Failure trends
Longest jobs
Elapsed time deviation
The report templates are described in the Reporter user manual.
3.1.7 Tags Tags are attributes attached to a Node that can be used to filter all Nodes having the same tag. The tag can be used, for example, to represent an application or a functional domain.
Chapter 3 Concepts and Architecture | 11
3.2 Architectural Components This section describes the major components of the architecture.
Figure 1: UniViewer and Reporter V6 Architecture
1. The user logs on to a UniViewer Management Server. The UVMS provides the connection details to the Reporter Server. 2. For Dollar Universe, the UVMS contains the list of Nodes and associated Node Views. Reporter Manager retrieves the Data Source list from the UVMS and directly addresses the target I/O Servers to extract Dollar Universe operations data. 3. For UniJob (v1.3 and later) multiple UVMS can be installed, each one managing a number of different UniJob. Each UVMS manages the configuration of its associated UniJob and the extraction of their operations data.
3.2.1 UniViewer Console (UVC) The UniViewer Console provides the graphical user interface for Reporter with the following Reporter functions:
Declaration of Reporter Server and Reporter database settings
Declaration of DUAS and UniJob Nodes
Scheduling/Monitoring of Extractions from one or many DUAS or UniJob
Report definition
Report Generation/Monitoring
3.2.2 Reporter Server The Reporter Server manages:
12 | Chapter 3 Concepts and Architecture
Access to the Reporter database
The extraction process from Dollar Universe and UniJob Node
Report definition and generation
Extractions and Reports can be triggered manually or scheduled for regular execution from the UniViewer Console.
3.2.3 UniViewer Management Server (UVMS) The UniViewer Management Server stores the data necessary for the UniViewer Console, for example, the list of Nodes (Dollar Universe and UniJob) accessible from the UniViewer Console and the location of the Reporter Server. The number of UVMS to be installed depends entirely on customer requirements. At least one UVMS is necessary. Four UVMS are shown in the architecture diagram above, simply to be able to separate the different sections of the diagram. One UVMS could be sufficient.
3.2.4 Database Reporter extracts comprehensive data from wide sources (Dollar Universe v5 and v6, UniJob) into an off-line relational database (Oracle or MS SQL Server). Reporter Server connects to the database to store extracted data along with a description of the extraction. Reporter Server connects to the database to generate reports built from extracted data. Each Reporter Server can only access one database instance.
3.2.5 Dollar Universe Application Server (DUAS) Operations data is extracted by Reporter from one or many Dollar Universe Application Server and loaded into the Reporter off-line history database where it will serve the customer’s long term reporting needs. Dollar Universe Application Server v6 registers to the UniViewer Management Server at installation, similarly to UniJob. At least one Dollar Universe Application Server v5 must be registered manually; the others can then be imported in bulk from the declared node.
3.2.6 Internal Scheduler The Internal Scheduler (UniJob or Dollar Universe Application Server v6) enables extractions and report generations to be scheduled directly from the Reporter interface with no need to script commands and enclose them in Uprocs.
3.2.7 Reporter Client for Dollar Universe The Reporter Client for Dollar Universe provides command-line instructions to enable Extractions and Report Generation tasks to be automated from a Dollar Universe Application Server. Reporter command line tools work directly with UVMS and require UVMS connection settings as parameters.
Chapter 3 Concepts and Architecture | 13
3.2.8 UniJob (UJ) UniJob registers with a UVMS at installation. Reporter supports the use of multiple UniViewer Management Servers. In this case, a UVMS heads a group of UniJobs, returns configuration information (for example, Node Views) to the Reporter Server and handles the data extraction from its UniJobs. Extracted data is passed by the UVMS to the Reporter Server which centralizes the DB load phase.
3.2.9 Reporter Client for UniJob The Reporter Client for UniJob is composed of commands that allow a UniJob to interact with the Reporter Server to trigger Extractions and Reports. The Reporter Client for UniJob must be installed on the UniJob declared in the UniViewer Management Server as the Internal Scheduler. It allows the automation of routine Reporter tasks. Not only Extractions and Report Generation but also database purges can be automated simply from the UniViewer interface with no scripting effort.
14 | Chapter 4 Installation
4 Installation Two distinct installation kits are available:
InstallShield executable for Windows
Script installer for Linux
Each kit can be used to install three different components:
Reporter Server
Reporter Client for UniJob: This module MUST be installed on the UniJob declared as the Internal Scheduler, whether local or remote to the Reporter Server. The Internal Scheduler allows routine Reporter tasks to be automated directly from the UniViewer user interface.
Reporter Client for Dollar Universe: This module must be installed on the Dollar Universe Application Server declared as the Internal Scheduler, whether local or remote to the Reporter Server.
The Windows and Linux installation dialogues are not identical so they will be documented separately in this chapter.
4.1 Hardware Requirements 4.1.1 Reporter Server Requirements A machine dedicated to hosting the Reporter Server will need the following minimum resources:
1 GB RAM
150 MB Disk space
2 GB Swap File The resource levels specified are clearly minimum values. Actual required resources will vary with how the different components are installed, the number of Data Sources, the number of UniViewer Management Servers handling the Data Sources, the volume of data extracted and loaded, the frequency, complexity and size of report generations.
4.1.2 Database Server Requirements A machine dedicated to hosting the database will need the following minimum resources. Minimum resource levels do not take into account the sizing of the database necessary to accommodate the intended volumes of data.
1 GB RAM
4 GB Disk space
2 GB Swap File
Chapter 4 Installation | 15
4.1.3 Reporter Client for UniJob/Dollar Universe Requirements The Reporter Client for UniJob/Dollar Universe provides access to the Reporter command line and inserts specific jobs into UniJob/DUAS. It can automate Extraction and report generation as well as routine maintenance tasks. The Reporter Client can be installed on any suitably sized UniJob/DUAS. Extraction-related processing takes place on the Reporter Server. The Reporter Client is used simply to trigger the extraction.
4.1.4 Data Source Requirements There are no special constraints on targeted Data Sources. The extractions are designed in such a way that they run in low priority processes to avoid penalizing other activity on the target Node.
4.2 Software Requirements For more information on supported operating systems, third party software and compatibility with other products, refer to the compatibility matrix which can be found on the Customer Service website in the content tab.
4.2.1 Java Either the PATH variable should include the path to Java binaries or the JAVA_HOME directory should be declared. The installation dialog will ask the user to specify the location of the java binaries to permit the user to use another virtual machine. Please refer to Java downloading page http://java.com/en/download/help/ie_online_install.xml for more details.
4.2.2 JDBC Drivers You must install the JDBC driver corresponding to the installed database that will be used by Reporter. Database
Driver name
Link
Oracle 11g
ojdbc5.jar
Oracle Database 11g JDBC Drivers on www.oracle.com
SQL Server
sqljdbc4.jar
Microsoft SQL Server JDBC Driver 4.0 on www.microsoft.com
The database must be accessible from the Reporter Server machine. Reporter Servers installed on Linux machines only support Oracle databases.
4.2.3 Database Character Set Unicode UTF-8
16 | Chapter 4 Installation
4.3 Preliminary Checks To install the Reporter Server:
On Windows, the user must be an administrator.
On Linux, it is preferable to use root. If the installation is executed without root rights: o
Reporter can only be started or stopped by this user.
o
The Reporter startup is not registered in the machine startup files.
Before you start:
UniViewer Console and UniViewer Management Server must be installed and running.
Dollar Universe Application Servers and UniJob must be accessible both to UniViewer and the Reporter Server.
A Java Runtime Environment must be installed.
A database must be installed and accessible (Oracle or SQL Server).
An appropriate JDBC driver must be installed.
A database user with DBA rights must exist (all examples refer to user “repowner”).
4.4 Installing the Reporter Server on Windows The name of the InstallShield executable is: reporter_6._windows.exe
Where m is the minor version number and bb is the build number. Click twice on the kit executable to launch the program. An installation inventory is maintained internally. The installation procedure is immediately aware of installed components and their versions (greater than v3.0). Detection of older components is not automatic.
4.4.1 Multiple Instances If no Reporter instances exist the Welcome Screen will be displayed directly. Multiple instances of the Reporter Product may be installed. If an existing instance of Reporter Server is found on the local machine the following choice will be proposed:
Install a new instance
Maintain or upgrade an existing instance
Select "Install a new instance" if you wish to install a new Reporter Server or if you wish to install a Reporter Client for UniJob or Dollar Universe. If you wish to upgrade, repair or remove Reporter Server refer to section "Upgrade, Rollback and Uninstall" on page 38.
Click Next to proceed
Click Cancel to abandon the installation.
Chapter 4 Installation | 17
4.4.2 The Welcome Screen The program displays a welcome to the InstallShield Wizard.
Click Next to proceed
Click Cancel to abandon the installation.
Existing instances of the Reporter Server will be listed if found. For all installations, select "Install a new instance" and click Next.
4.4.3 User License Read the agreement. Click on the "I accept …" radio button. You cannot proceed with installation if you do not accept the terms of the agreement.
Click Back to return to the previous screen
Click Next to proceed
Click Cancel to abandon the installation.
4.4.4 Define the Java Environment (JDK or JRE) Enter the path to the Java Home directory. The Java Home directory should contain the bin subdirectory that contains the java binary. Do not add /bin to the path. Click on the Browse… button to select the folder from the file system.
Click Next to proceed
Click Cancel to abandon the installation.
4.4.5 Select the Installation Type This determines whether you wish to install the Reporter Server or a Reporter Client for UniJob or Dollar Universe. Click on the desired radio button:
Server installation
UniJob client installation (Reporter Client for UniJob)
Dollar Universe 6.x client installation
(Reporter Client for Dollar Universe v6)
At least, one Reporter Server must be installed, and also one Reporter Client for each data source.
Click Back to return to the previous screen
Click Next to proceed
Click Cancel to abandon the installation.
4.4.6 Reporter Server Installation Directory Indicate the directory where the Reporter Server should be installed.
18 | Chapter 4 Installation
By default the server will be installed in C:\Program Files\AUTOMIC\Reporter
Use the Change… button to select another location from the file system. If the folder specified already contains a previous instance of Reporter Server an upgrade will be proposed.
Click Back to return to the previous screen
Click Next to proceed
Click Cancel to abandon the installation.
4.4.7 Reporter Server Information
Enter the logical name of the Reporter Server (max: 64 characters). [Defaults to local host].
Enter the hostname of the machine where the Reporter is being installed. [Defaults to local host].
Enter the TCP Port number to be reserved for the Reporter Server [Default: 10630]. The following record is created in the /mgr/uxsrsrv.alias file. _REP_X 10630/tcp
The user is free to concatenate this file with the system TCP services file to maintain central port visibility.
Click Back to return to the previous screen
Click Next to proceed
Click Cancel to abandon the installation.
4.4.8 Define JDBC Driver A JDBC driver must be present to enable Reporter to communicate with the database. Refer to section "JDBC Drivers" on page 15 for details about where to download the required driver. The installation program links to the driver in the location provided. Use the Browse… button to select the driver location from the file system.
Click Back to return to the previous screen
Click Next to proceed
Click Cancel to abandon the installation.
4.4.9 Ready to Install the Program
Click Back to return to the previous screen
Click Install to start the installation
Click Cancel to abandon the installation.
A progress bar will be displayed during the installation phase.
Chapter 4 Installation | 19
4.4.10 InstallShield Wizard Completed Click Finish to close the InstallShield Window. The Reporter Server is automatically started.
4.5 Installing the Reporter Client for UniJob or Dollar Universe on Windows Double click on the installation kit. Refer to section "Installing the Reporter Server on Windows" on page 16
4.5.1 Destination Folder Browse the file system to point to the root directory of an existing UniJob or Dollar Universe installation. The reporter_client directory will be created in the UniJob or Dollar Universe root directory.
4.5.2 Reporter Server Information Provide the details of the Reporter Server that was installed in the paragraph "Reporter Server Information". Enter the logical name of the Reporter Server (max: 64 characters). [Default: ].
Enter the hostname of the machine where the Reporter is being installed. [Default: ].
Enter the TCP Port number reserved for the Reporter Server [Default: 10630]. The TCP port number reserved for Reporter is found in the file: /mgr/uxsrsrv.alias
Click Next to proceed
Click Cancel to abandon the installation.
4.5.3 Ready to Install the Program Click Install to start the installation of the Reporter Client for UniJob/Dollar Universe.
4.5.4 InstallShield Wizard Completed Click Finish to close the InstallShield Window.
4.6 Installing the Reporter Server on Linux An installation inventory is maintained internally in: /var/opt/AUTOMIC/.Installer/Reporter The installation procedure will be immediately aware of installed components and their versions. Detection of components before v3.0 is however not automatic.
20 | Chapter 4 Installation
The name of the kit is: reporter_6._all_unix.taz
Where m is the minor version number and bb is the build number. The kit is delivered in a compressed tar format. 1. Copy the kit to a work directory. 2. Un-compress and un-tar the kit: tar xvzf reporter_6._all_unix.taz
The un-tarred kit will be found in the reporter_6._all_unix sub-directory. The unirun procedure (reporter_6._all_unix/unirun) can be launched in 3 ways:
-i: Installation of an instance
-u: Upgrade of an instance For these two modes, the following options can be used: o
–r: Record mode (optional), incompatible with -s Record mode is interactive and records user responses to a response file. Record mode requires the argument –f .
o
–s: Silent Mode (optional), incompatible with -r Silent mode is not interactive. It takes user responses from the recorded response file. Silent mode requires the argument –f . Silent mode installations can be executed from batch command files with no user interaction.
-d: Uninstallation of an instance
-h option displays the online help.
Example of installation command: ./unirun –i
Example of installation command, record mode: ./unirun –i –r –f
Example of installation command, silent mode: ./unirun –i –s –f
4.6.1 Installation Choice You can install a new , upgrade or remove an existing one . Please enter your choice: --> Please enter "i" to install, "u" to upgrade or "d" to delete an instance ?
Enter:
"i" to install Reporter
"u": refer to section "Upgrading Reporter on Linux" on page 42
"d": refer to section "Un-installing Reporter Server from Linux" on page 45
4.6.2 Reporter Software License Agreement # ---------------------------------------------------------------------# AUTOMIC license agreement:
Chapter 4 Installation | 21
# Please, read AUTOMIC license agreement, press to read next page # Press return to continue
Press [Return] to display the first page. Press [Space] to display subsequent pages. Do you accept the agreement ? --> ("y" to accept, "n" to decline and abort procedure)?
You will not be able to proceed with the installation of Reporter Server until you accept the terms of the contract. If you require more information please contact technical support.
4.6.3 Selecting the Installation Type _______________________________________________________ Reporter Installation (c) AUTOMIC 2011 _______________________________________________________ Please select the installation type - Server installation - Client installation for Dollar Universe - Client installation for UniJob
[s] [d] [u]
Enter:
“s” for Reporter Server
“u” for a Reporter Client for UniJob, refer to section "Installing the Reporter Client for UniJob on Linux" on page 23
“d” for a Reporter Client for Dollar Universe, refer to section "Installing the Reporter Client for Dollar Universe on Linux" on page 23.
To proceed with the update procedure, refer to paragraph "Upgrading Reporter on Linux" on page 42.
4.6.4 Location of the Java Command Provide the path to the directory containing Jre/Jdk. it must contain a "bin" folder with the java command inside: Location of the java folder (Jre/Jdk folder) :
4.6.5 Reporter Server Name Server Name (Max: 64 characters)
[] :
Enter the logical name of the Reporter Server (max: 64 characters). [Default: localhost]. If a Reporter Server instance has already been installed for this logical node name the following error message will display: " Data found in /var/opt/AUTOMIC/.Installer/Reporter/server/OOV/Reporter.installer You cannot install with that server name "OOV" because there is already an instance registered using that ID."
22 | Chapter 4 Installation
4.6.6 Installation Directory Installation directory [/var/opt/AUTOMIC/Reporter/] :
This is the root directory of the installation.
4.6.7 Reporter Server Host Name Change the "Reporter Server Host Name" only if you need to set a different logical network name (useful for cluster configuration). Reporter Server Host Name [] :
Press Enter if using default local host. It is generally only necessary to alter this field in the case of cluster configurations.
4.6.8 Reporter Server Port Number Port Number (Range: 1023 to 65535)
[10630] :
Enter the TCP Port number reserved for the Reporter Server [Default: 10630]. The following record is created in the /mgr/uxsrsrv.alias file. _REP_X 10630/tcp
4.6.9 Path to the JDBC Driver File Enter the FULL path to the JDBC driver file. Reporter uses the JDBC driver to communicate with the database (Oracle or MS SQL Server) If you can't find the driver file (ojdbc*.jar or sqljdbc*.jar), download it from the db vendor website. JDBC driver file path []:
A JDBC driver is required for Reporter to communicate with the database. Refer to section "JDBC Drivers" on page 15 for details about where to download the required driver. The installation program links to the driver in the location provided. The procedure expects the path and the name of the driver file. Example of path to JDBC driver file: /mnt/hgfs/Shared/ojdbc14.jar
4.6.10 Proceed with the Installation Installation of instance in /var/opt/AUTOMIC/Reporter/ is ready to start. Press Enter to continue:
Press Enter to start the installation procedure. The Reporter Server is automatically started.
Chapter 4 Installation | 23
4.7 Installing the Reporter Client for UniJob on Linux Extractions and Report Generations can be scheduled directly from the Reporter interface. For this to work the Internal Scheduler must be declared in the Reporter Node Settings. The Internal Scheduler does not have to reside on the same machine as the Reporter Server. The client should be installed on the UniJob that has been declared as the Internal Scheduler whether the product is installed locally or remotely.
4.7.1 Path to the UniJob Installation This is the root installation directory of the UniJob product where the reporter_client subdirectory will be created. In the case of UniJob the root directory will be: /UNIJOB/
The procedure looks for the values.xml file in the data sub-directory to check that the right position has been specified.
4.7.2 Reporter Server Name Enter the logical name of the Reporter Server (max: 64 characters). [Defaults: localhost].
4.7.3 Reporter Server Host Name By default the local host will be used. Change the "Reporter Server Host Name" only if you need to set a different logical network name, for example, in a cluster configuration.
4.7.4 Reporter Server IP Communication Port Enter the TCP Port number reserved for the Reporter Server [Default: 10630]. The TCP port number reserved for Reporter is found in the /mgr/uxsrsrv.alias file.
4.7.5 Proceed with Installation Enter Y to continue or N to abandon the installation.
4.8 Installing the Reporter Client for Dollar Universe on Linux Extractions and Report Generations can be scheduled directly from the Reporter interface (refer to the Reporter User Manual). For this to work the Internal Scheduler must be declared in the Reporter Node Settings. The Internal Scheduler does not have to reside on the same machine as the Reporter Server. The Reporter client for Dollar Universe should be installed on the Dollar Universe Application Server that has been declared as the Internal Scheduler whether the product is installed locally or remotely.
24 | Chapter 4 Installation
4.8.1 Prerequisites on Linux
The installation procedure must be executed under the administrator account of the targeted Dollar Universe Company.
The /var/opt/ORSYP/.Installer directory must be accessible in read and write for the Dollar Universe administrator.
4.8.2 Location of the Java Command Provide the path to the directory containing Jre/Jdk. it must contain a "bin" folder with the java command inside: Location of the java folder [] :
4.8.3 Dollar Universe Company Directory Please enter the path to your Dollar Universe Application Server installation's Company directory. This is necessary to retrieve the logical environment of the Company. The reporter_client subdirectory will be created in the Company's root directory.
4.8.4 Reporter Server Name Provide the logical name of the Reporter Server (max: 64 characters). The file /Reporter//mgr/uxsrsrv.sck on the Reporter Server machine contains the following information: ReporterServerName
Hostname
4.8.5 Reporter Server Host Name Provide the hostname of the machine supporting the Reporter Server. Note that the Reporter Server may be installed on a floating hostname in a cluster configuration.
4.8.6 Reporter Server IP Communication Port Enter the TCP Port number reserved for the Reporter Server [Default: 10630]. This can be found in /Reporter/mgr//uxsrsrv.alias.
4.8.7 Proceed with Installation Press Enter to continue or any other key to abandon the installation
Chapter 5 Configuration | 25
5 Configuration Initialization of Reporter requires:
License keys
Network configuration
Database user creation
Database schema generation
Starting the Reporter Server
Declare the list of UniViewer Management Servers known to Reporter Server
Validate Database Settings
5.1 Licenses Reporter license keys are managed on the UniViewer Management Server. The addition of a valid Reporter license causes Reporter activities ("Reporter DB" in the Administration panel and "Reports" in the Monitoring panel) to be displayed in the UniViewer interface. Consult the UniViewer documentation or the on-line help for instructions on how to enter the license key: Administration Mode > Nodes > Management Server > Node settings > Licenses
5.2 Network Configuration
The TCP port reserved for Reporter Server is declared locally in: /mgr/uxsrsrv.alias.
The logical Reporter Node name is translated to the physical hostname in: /mgr/uxsrsrv.sck.
These files do not need to contain details of target Data Source Nodes. This information is stored in the Nodes List on the UniViewer Management Server and accessible from the UniViewer GUI. The files above are customized during installation. No additional actions are required.
5.3 Database Schema Setup The creation of a dedicated database instance (all examples refer to a DB instance called REPDB) is recommended. Please refer to your Database Administrator to assist you in this task. You can follow the procedure described by the Database Administration Manual.
26 | Chapter 5 Configuration
5.3.1 User Creation The creation of a dedicated database user repowner with a DBA role is recommended. It is used to initialize the database in the following section. Reporter Server will also connect with this user to load data into the data base tables and generate reports. Examples refer to the "REPOWNER" user.
5.3.2 Database Initialization During the installation process, table creation scripts are generated in the /dbscripts/ directory. Execution of the appropriate script through the database’s SQL command line creates the tables in which Reporter will store information. This initialization creates the tables that are accessed by the Reporter Server when reading, updating and purging the database tables. Indexes, stored procedures and triggers are also created. Neither Reporter Server nor third-party software needs to access this information.
5.3.2.1 Oracle Initialization The create_db_oracle.sql script should be run with the Oracle sqlplus tool:
From a shell window launch the following command to open a DB connection: sqlplus /@
Execute the script using the following command: SQL> @/dbscripts/oracle/create_db_oracle.sql
If the access path contains spaces, run the script from the local directory.
5.3.2.2 MS SQL Initialization The create_db_mssql.sql script can be run with the MS SQL Server osql (deprecated) or sqlcmd tools. From a shell window, launch the command: osql –U –P –D –i /dbscripts/mssqlserver/create_db_mssql.sql
or : sqlcmd –U –P –d –i /dbscripts/mssqlserver/create_db_mssql.sql
5.3.3 Check User Rights on Tables The “repowner” DB user should have ‘SELECT’, ’INSERT’, ‘UPDATE’ and ‘DELETE’ rights on all database tables. Refer to section "Reporter V6 Data Model" on page 64 for the list and contents of database tables.
5.4 Starting and Stopping the Reporter Server On Windows: The Reporter Server runs as a service under the local system account. By default, the Reporter service is launched at system startup. The system administrator can change this behavior via the services console. On Linux: If installed under root, the Reporter Server runs as a daemon. Commands to start and stop the server are provided in the /exec directory:
Chapter 5 Configuration | 27
To start the server, use the batch script: o
unistartrep.bat for Windows platforms
o
unistartrep for Linux platforms.
To stop the server, use the batch script: o
unistoprep.bat for Windows platforms
o
unistoprep for Linux platforms.
To check the Reporter Server activity status: o
unicheckrep.bat for Windows platforms
o
unicheckrep for Linux platforms.
To display Reporter Server version information: o
unirepinfo.bat for Windows platforms
o
unirepinfo for Linux platforms.
On Windows, the Reporter server can be started or stopped with the menu Windows>Programs>AUTOMIC>Reporter server Start or Stop (run as administrator).
5.5 Initialize Reporter Security 5.5.1 Users Rights Two security Roles are delivered with the Reporter installation:
Reporter [Node Name] Administrator
Reporter [Node Name] Reader
By default these Roles should be assigned in the following ways to security Groups:
Reporter Administrator Role attributed to the Administrator Group.
Reporter Reader attributed Role to the Developer Group.
Reporter Reader attributed Role to the Operator Group.
Make sure that the Administrator Role at least has been checked for the Administrator Group, without which access to the Reporter Node Settings will not be possible. Refer to the UniViewer Console User Manual for details about security settings.
5.5.2 SSL Communication For confidentiality and data integrity purposes, communication between the different architecture components can be secured using SSL. The minimum versions of components that support SSL are:
UVMS v4
UVC v4 (direct, web start and web console/gateway)
DUAS v6 and the associated managers
Reporter v4
28 | Chapter 5 Configuration
The architecture and the principles are outlined in the UniViewer Administration manual. The implementation of SSL in Reporter is similar to that described for UVMS. The few differences that may occur are related to different technologies for the two products: UVMS and Reporter use java, DUAS uses Open SSL.
5.5.2.1 Certificates Reporter supports the following certificates using DER and Base 64 formats:
The chain certificates (.p7b file)
The simple certificates: server certificates and CA certificates (.cer or .crt files) In the case of using simple certificates, CA certificates must be imported BEFORE server certificates.
Server certificate: o
Specific hostname
o
Wildcard * in the CN
o
SANs extension: hostname and IP address
CA certificate o
Management of certificate chains: Additional CA certificates
Refer to the UniViewer administration manual for more information on certificates.
5.5.2.2 Configurations SSL If SSL is activated on Reporter, all incoming communications must be in SSL format. If SSL is not activated on Reporter, all incoming communications must be uncoded. In order for Reporter to extract data from DUAS v6 nodes configured in SSL, it must be configured in SSL. If Reporter is configured in SSL, the following communications will be in SSL format:
Reporter UVMS
Reporter -> DUAS v6 (SSL)
Reporter client for Dollar Universe -> Reporter
UVC -> Reporter
Even if Reporter is configured in SSL, the following communications are uncoded:
Reporter -> DUAS v6 (non SSL)
Reporter -> DUAS v5
Reporter -> UniJob v1
5.5.2.3 Reporter SSL Configuration A Reporter server's SSL configuration is performed with the help of the unissl Reporter server command. The following steps are necessary to configure a Reporter server in SSL: 1. Create the keystore Execute the command: unissl GENSTORE
Chapter 5 Configuration | 29
2. Generate a public key pair/private key on the server Execute the command: unissl GENKEY
To save the public key pair/private key in the keystore protected with a password. 3. Generate a Certificate Signing Request (CSR) on the server Execute the command: unissl GENCSR
To generate the file (in the PKCS#10 format) containing the request. 4. Send the request (CSR) to the certification authority Send the file to the certification authority. 5. Receive the server certificate signed by the certification authority Retrieve the signed certificate from the certification authority. 6. Install the certificates Execute the command: unissl IMPORT
To install the certificates in the server keystore 7. Stop Reporter 8. Activate SSL Execute the command: unissl SET
9. Restart Reporter to take these modifications into consideration. When the SSL configuration is finished the Reporter server must be restarted. Other unissl command options can enable/disable SSL, list or delete keys and certificates, change the password.
5.5.2.4 SSL Configuration of the Reporter Client for Dollar Universe If the Reporter server is configured in SSL, the Reporter client for Dollar Universe v6 must also be configured to communicate in SSL with the Reporter server. Refer to section "Activate/Deactivate SSL on the Reporter Client" on page 33.
5.5.2.5 unissl Use this command to configure SSL for the Reporter server; the same command exists for all servers for which SSL must be configured. It is located in the Reporter\exec subdirectory of the Reporter server.
Online Help To view a list of keywords type: unissl without arguments: ./unissl Choose the proper unissl SET unissl GENSTORE unissl GENKEY unissl GENCSR
object: to enable/disable SSL to generate the keystore to generate public/private keys to generate a certificate request
30 | Chapter 5 Configuration
unissl unissl unissl unissl
IMPORT LIST DELETE KEYPASSWD
to to to to
import a certificate list the content of the keystore delete an entry change the keystore password
To display online help, type: unissl KEYWORD –help. For example: ./unissl GENSTORE -help usage: unissl genstore -help display command line help -pwd Password for the new Keystore
Generate the Keystore This command generates the keystore that must accept the certificates and keys. Syntax: unissl GENSTORE –pwd Parameters
Description
-pwd
Keystore password. If this argument is not entered, the user will receive a prompt. This password will be used for all the unissl commands.
-help
Displays the online help
Only one keystore can be defined for a Reporter server. The "rep_store.cer" keystore is created in the subdirectory mgr of the Reporter server.
Example: ./unissl GENSTORE -pwd unissl Keystore created successfully
Generating Keys This command generates a set of public /private keys for the Reporter server. Syntax: unissl GENKEY –dn -alg -size –pwd -overwrite Parameters
Description
-dn
Distinguished name. Mandatory. All the X509 standard components are accepted but only CN= is used. Must be enclosed in quotes.
-alg
Algorithm used to generate the keys (DSA, RSA), default value is RSA
-size
Size of the generated key: 512, 1024, 2048 or 4096, default value is 2048
-pwd
Password. Optional, if this argument is not entered the user will be prompted. The password is defined by the unissl GENSTORE command.
-overwrite
Optional, to force an overwrite of the existing set, if not the user will be asked for a confirmation.
-help
Displays the online help
Only one set can be created in a keystore. The keys are stored in the keystore that is created with the unissl GENSTORE command. Example: unissl GENKEY -dn "CN=vmstluni99.automic.com" -pwd unissl The keys were generated successfully
Chapter 5 Configuration | 31
Generate a Certificate Request This command generates a signed certificate request (CSR) for the Reporter server and saves it in the specified file. Syntax: unissl GENCSR –file –pwd Parameters
Description
-file
Mandatory. Complete file name that contains the certificate request.
-pwd
Password. Optional, if this argument is not entered the user will be prompted. The password is defined by the unissl GENSTORE command.
-help
Displays the online help
The command returns an error if the pair's public key/private key does not exist on the server. Example: unissl GENCSR -file "/var/opt/AUTOMIC/Reporter/vmstluni99.automic.com/mgr/CSR.txt" -pwd unissl The request was generated successfully
The generated file contains the certificate request. This file must be sent to the Certification Authority that should return:
The Certification Authority certificate
The signed certificate for this server
Import a Certificate This command allows the user to approve CA certificates and to install the Reporter server certificate. 1. To add the certificate to the list of approved certificates (required for communications where Reporter acts as a client: Reporter -> DUAS): unissl IMPORT –type TRUSTEDCACERT -file -alias -position
Or unissl IMPORT –type TRUSTEDSERVER –host -port
2. To import the Reporter server certificate (required for the communications where Reporter acts as a server): unissl IMPORT –type SERVERCERT -file -pwd -overwrite Parameter
Description
-type
Mandatory; the type can be: - SERVERCERT: to import a server certificate (file .cer or .pb7) - TRUSTEDCACERT: to import and approve a certification authority certificate. (file .cer or .crt) or to import and approve one of the CA certificates from a .pb7 file - TRUSTEDSERVER : to import and approve a certification authority certificate by connecting to a remote server (-host and –port)
-file
Mandatory for TRUSTEDCACERT and SERVERCERT. Complete file name that contains the certificate.
-alias
Mandatory for TRUSTEDCACERT Alias used to import the certificate. The alias names the imported certificate and enables therefore to delete the certificate if multiple CA certificates have been imported.
-position
Available for type TRUSTEDCACERT. Position of the certificate to trust in the certificate chain if the file type is .pb7 Optional, if this argument is not entered, the user will be prompted to provide it.
32 | Chapter 5 Configuration
Parameter
Description
-host
Mandatory for type TRUSTEDSERVER. Server hostname
-port
Mandatory for type TRUSTEDSERVER. Server port number
-overwrite
Optional, to force an overwrite of the existing set, if not the user will be asked for a confirmation.
-pwd
Password. Optional, if this argument is not entered the user will be prompted. The password is defined by the unissl GENSTORE command.
-help
Displays the online help
The keyword CHAIN is no longer used starting from version 4.0.06 of Reporter. The Certification Authority certificate (TRUSTEDCACERT or TRUSTEDSERVER) must be installed on the server first before you can import the signed certificate (SERVERCERT) if it is imported from a .cert or .crt file. Only one SERVERCERT certificate can be saved in a keystore. However it is possible to add as many TRUSTEDCACERT certificates as you like to the trusted certificate base. Example 1: Import the CA certificate from a certificate chain unissl IMPORT -type TRUSTEDCACERT -file "/var/opt/AUTOMIC/Reporter/vmstluni99.automic.com/mgr/certnew.p7b" -alias ECA Enter the Keystore password: The chain contains 2 certificate(s) 1
Type: CA Certificate Subject: CN=OrsypTstCA, DC=orsyptst, DC=com Valid from: 11/05/2011 Valid to: 11/05/2016 Fingerprint (MD5): F1:9B:08:98:42:6D:A6:87:98:C3:E8:89:F0:30:CF:9A Fingerprint (SHA1): 1E:EE:43:C9:C0:6B:59:11:E8:70:BA:F3:C2:F4:2D:B0:D0:2B:F5:1B 2 Type: Server Certificate Subject: CN=vmstluni99.automic.com Valid from: 18/10/2012 Valid to: 18/10/2014 Fingerprint (MD5): D7:8B:71:EF:88:51:A3:21:2A:61:16:F6:24:91:B2:95 Fingerprint (SHA1): 02:A9:78:E2:30:F3:1C:EA:8E:59:0A:6A:19:D2:8B:9C:94:09:3B:DB Enter the position of the certificate to add to the alias "ECA" of the Keystore or 'q' to quit: [1] 1 Import successful
Example 2: Import the server certificate from a certificate chain unissl IMPORT -type SERVERCERT -file "/var/opt/AUTOMIC/Reporter/vmstluni99.automic.com/mgr/certnew.p7b" Enter the Keystore password: Import successful
Activate/Deactivate SSL Once the configuration is terminated, this command tells the Reporter server the new SSL or non SSL configuration. The Reporter server must be stopped to execute this command ("Starting and Stopping the Reporter Server" on page 26).
Chapter 5 Configuration | 33
Syntax: unissl SET –enable -pwd Parameter
Description
-enable
ON : to enable the Reporter server SSL communication OFF to disable the Reporter server SSL communication
-pwd
Password. Optional, if this argument is not entered the user will be prompted. The password is defined by the unissl GENSTORE command.
-help
Displays the online help
A server valid certificate must have been imported for this command to be executed. Example 1: Enable SSL on the Reporter server unissl set -enable on The server needs to be stopped before executing this command. Do you really want to continue? Y/N y Enter the Keystore password: The variable has been updated successfully. SSL will be enabled after starting the server.
Example 2: Disable SSL on the Reporter server unissl set -enable off The server needs to be stopped before executing this command. Do you really want to continue? Y/N y Enter the Keystore password: The variable has been updated successfully. SSL will be disabled after starting the server.
The command updates the Reporter node settings (Server Parameters category). The Reporter server must be restarted to use SSL.
Activate/Deactivate SSL on the Reporter Client This command allows the user to configure the Reporter client for Dollar Universe to use (or not) SSL for communicating with the Reporter server. The command unissl of the Reporter client is located in the directory reporter_client/exec of Dollar Universe. Syntax: unissl SET –enable -repnode Parameter
Description
-enable
ON: to activate SSL communication for the Reporter client, the Reporter server must be configured in SSL. OFF: to deactivate SSL communication for the Reporter client.
-repnode
Logical name of the Reporter node. If this parameter is not specified, the local hostname is used.
-help
Display the online help of the command.
The Reporter server must be started for the commands to be executed. To activate SSL, the user must enter “Y” to accept the Reporter server certificates. Example 1: Activate SSL on the Reporter client
34 | Chapter 5 Configuration
unissl set -enable on Server Certificate: [ ] Do you want to trust this certificate permanently? Y/N Y SSL cominucation are now enabled
Example 2: Deactivate SSL on the Reporter client unissl set -enable off SSL cominucation are now disabled
List the Keystore/Truststore Content This command lists the keystore certificates or keys. Syntax: unissl LIST –type -pwd -view Parameter
Description
-type
Mandatory; the type can be : - TRUSTEDCACERT: to display the Certification Authority certificate. - SERVERCERT : to display the server certificate - SERVERKEY: to display the public/private keys.
-pwd
Password. Optional, if this argument is not entered the user will be prompted. The password is defined by the unissl GENSTORE command.
-view
Displays all the certificate or key content.
-help
Displays the online help
The display is directed to a standard output. Example: ./unissl LIST -type TRUSTEDCACERT Enter the Keystore password: Content of alias: eca Type: CA Certificate Subject: CN=OrsypTstCA, DC=orsyptst, DC=com Valid from: 11/05/2011 Valid to: 11/05/2016 Fingerprint (MD5): F1:9B:08:98:42:6D:A6:87:98:C3:E8:89:F0:30:CF:9A Fingerprint (SHA1): 1E:EE:43:C9:C0:6B:59:11:E8:70:BA:F3:C2:F4:2D:B0:D0:2B:F5:1B Content of alias: rep Type: Certificate Subject: CN=vmstluni99.automic.com Valid from: 18/10/2012 Valid to: 18/10/2014 Fingerprint (MD5): D7:8B:71:EF:88:51:A3:21:2A:61:16:F6:24:91:B2:95 Fingerprint (SHA1): 02:A9:78:E2:30:F3:1C:EA:8E:59:0A:6A:19:D2:8B:9C:94:09:3B:DB
Delete an Entry This command deletes the keystore certificates. Syntax: unissl DELETE –type -alias -pwd
Chapter 5 Configuration | 35
Parameter
Description
-type
Mandatory; the type can be : - TRUSTEDCACERT: to display the certificate of authority certificate. - SERVERCERT: to display the server -
-alias
Mandatory if type = TRUSTEDCACERT. Alias used to store the certificate.
-pwd
Password. Optional, if this argument is not entered the user will be prompted. The password is defined by the unissl GENSTORE command.
-help
Displays the online help
The display is directed to a standard output. Example: ./unissl DELETE -type SERVERCERT Enter the Keystore password: Certificate deleted
Update the Keystore/Truststore Password This command updates the keystore password created by the unissl GENSTORE command. Syntax: unissl KEYPASSWD -pwd -new Parameter
Description
-pwd
Existing password. Optional, if this argument is not entered the user will be prompted. The password is defined by the unissl GENSTORE command.
-new
New password. Optional, if this argument is not entered the user will be prompted.
-help
Displays the online help
Example: ./unissl KEYPASSWD Enter the Keystore password: Enter the new password: Confirm the new Keystore password: The password has been changed
5.6 Declare the UniViewer Management Server A Reporter Server may manage multiple UniViewer Management Servers. Refer to the Reporter User Manual for explanations. As far as installation goes, the user is required to declare at least one UniViewer Management Server.
Open UniViewer Console, Administration Mode > Nodes.
Select the Reporter node then click Node Settings > Parameters.
Select the UniViewer Management Server example line and click Update.
Replace "name" by the UniViewer Management Server node name.
Replace "host" by the UniViewer Management Server host name.
36 | Chapter 5 Configuration
Replace the port number if different to 4184 (the default UniViewer Management Server port number).
Key in the UniViewer Management Server administrator login and password.
In the "group" field enter the UniViewer Management Server node name.
Click Save and Close.
Click Validate UniViewer Connection. The status must be "Connection Successful". If you use an UVMS failover architecture master-subordinates and if you want Reporter to change its connection UVMS if the previous one doesn't answer, you must declare as many lines as UVMS: same node name but different hostnames.
5.7 Validate Database Settings
Open UniViewer Console, Administration Mode > Nodes.
Select the Reporter node then click Node Settings > Database Settings.
We assume that you have created a database instance (e.g. REPDB) and a Database user with DBA rights (e.g. REPOWNER)
DB Instance ID = REPDB
DB Server Host leave at localhost if the database is on the same machine as Reporter Server, otherwise enter the DB Server hostname.
DB Type = Oracle or MS SQL Server
DB Port = 1521 (default Oracle) or 1433 (default SQL Server)
DB User Name = REPOWNER
DB Users Password = Repowner Password
Use Oracle Service URL: If Reporter uses an Oracle database, enter Yes to use the Oracle service name to identify the base, enter No to use Oracle SID.
DB Name (MSSQL only): If Reporter uses a MSSQL database, enter the database name.
Click Validate DB Connection, the message "The database connection verification was successful" must be displayed.
5.8 Validate Extraction and Load Launch a simple extraction to make sure that the Reporter product is running correctly: Administration Mode > Reporter DB > Extractions In the Extraction Monitor document click [Extract]
Management Server = Default UVMS
Product: Select Dollar Universe (or UniJob if no Dollar Universe Application Server declared)
Selection = Per Node View
Select a node view (All Dollar Universe Application Server UNIV62/X NODES for example.
At least one node in the node list should be checked. Click Extract The extraction will vary in duration depending on the amount of data targeted for extraction.
Chapter 5 Configuration | 37
Extraction should be shown as completed in the Extraction Monitor. If this is the case, it is reasonable to assume that the Reporter installation is in running order.
5.9 General Recommendations Report generations, Extractions and database purges are not strictly speaking incompatible but are contentious. Make sure that these activities are scheduled for different periods of the day. For example in a traditional scheme: Time window
Mainstream activity
Reporter Activity
Comments
7:00-19:00
Interactive window
Report Generation
Reports will be generated as soon as extractions are finished to ensure maximum freshness.
19:00-05:00 Batch processing window
Purges
Purges can take place whenever the Reporter Server and database are not supporting other activities.
05:00-07:00
Extractions
If possible, extractions should not start before mainstream batch processing has finished.
38 | Chapter 6 Upgrade, Rollback and Uninstall
6 Upgrade, Rollback and Uninstall This chapter details the upgrade, rollback and un-installation procedures for Reporter Server, Reporter Clients for UniJob and Dollar Universe and the database. The upgrade and uninstallation must be performed by the same user account as the one used for installation:
Administrator on Windows
Installation user or root on Linux.
Before performing any updates, please check the operating system and database pre-requisites. They are described in the paragraph "Software Requirements" on page 15. A new database schema will be installed with Reporter v4.0. The Reporter installation procedure (Windows and Linux) maintains an internal inventory of product versions installed (greater than v3.0). This inventory will be used to simplify upgrades to future Reporter releases.
6.1 Upgrade Sequence The Reporter Server upgrade from version 3 to version 6 takes place in several steps: 1. Backup the Reporter server and clients directories 2. Backup the Reporter server database 3. Migrate the Reporter Server database schema 4. Upgrade the Reporter Server binaries 5. Update the license 6. With the help of iReport v4.0.2, compile custom reports used in Reporter v3 so that they can be used by Reporter V4/V6 (refer to paragraph 6.4 in the Reporter User Manual). Depending on the initial version, step 1 must be performed several times:
An initial database migration and Reporter upgrade is required to upgrade from version v3.0 to v4.0.
A second database migration and Reporter upgrade is required to upgrade from version v4.0 to version 4.0.07.
A third database migration and Reporter upgrade is required to upgrade from version v4.0.07 to v.4.0.10. The migration of a database can take a long time.
The database schema has not been changed between v4.0.10 and v6.
6.2 Migrating the Database Be sure to make a full backup of the database before upgrade. Structural changes are carried out directly to the data in the live database tables. If an error occurs there is no rollback script.
Chapter 6 Upgrade, Rollback and Uninstall | 39
The Reporter v4.0/v6 database schema has undergone numerous modifications since version 3.0. SQL procedures are provided in the /dbscripts/dbtype directory to upgrade DB schemas of past versions to a v4.0 and v6 database schema. The database update procedure is done by executing an SQL script under a database user with sufficient privileges to alter the schema dedicated to Reporter Server. SQL script names use the following naming convention: alter_db___to_.sql
where database_type can be either oracle (for Oracle) or mssql (for Microsoft SQL Server). For example, the name of the Oracle alter script from Reporter v3 to Reporter v4.0 has the name: alter_db_oracle_v30x_to_v400. The SQL scripts must be run under a user account with privileges sufficient to create/alter/drop objects (tables, constraints, indexes, triggers, sequences, views, procedures, functions and directories). The rights for DIRECTORY objects are needed to create/drop the object corresponding to the output folder that will contain the log file. Depending on the Reporter Server upgrade version, some SQL scripts may contain only one or both objects (table, index, etc.) and data creation/modification. Database objects have been renamed and reconfigured to support new features and improve old ones. For this reason, the “alter_database” script that updates the database from v3.0 to v.4.0 does a full database migration:
It creates the necessary new objects.
It modifies the old ones.
It fills them with the corresponding data.
So, old objects will be transformed into new ones, while preserving existing data. The migration procedure has built in support to log different steps during data processing, using an external log file. This informs the user about the operation that is executing at a specific moment. This feature is handled differently for Oracle and Microsoft SQL Server, and is described below. The folder that will contain the log file must exist on the disk. Otherwise, the database engine will produce an error when trying to access a non-existing folder.
6.2.1 Upgrade the Oracle Database Schema Be sure to make a full backup of the database before upgrade. Structural changes are carried out directly to the data in the live database tables. The migration procedure is logged on the disk using the UTL_FILE package. Because of this, the database migration user must have access to this package. The right to execute the UTL_FILE package can be given to all users by executing the following grant instruction using the system database user: GRANT EXECUTE on SYS.UTL_FILE TO PUBLIC / In order to start the migration procedure, connect to the database, using the database user configured in Reporter v3.0.x. Please make sure that the database user has all the appropriate database rights to create/alter/drop objects (tables, constraints, indexes, triggers, sequences, views, procedures, functions and directories). The rights for the DIRECTORY objects are needed to create/drop the object corresponding to the output folder that will contain the log file. The migration script can be executed in two ways: 1. Execute the alter script file using the sqlplus tool from Oracle: Example:
40 | Chapter 6 Upgrade, Rollback and Uninstall
SQL> @/alter_db_oracle_v30x_to_v400.sql
2. Execute the content of the alter script using a graphical database client: copy/paste the content of the script file into a query editor and execute it. If the access path contains spaces, run the script from the local directory.
6.2.2 Upgrade MS SQL Server Database Schema Be sure to make a full backup of the database before upgrade. Structural changes are carried out directly to the data in the live database tables. Connect to the database, using the database user configured in Reporter v3.0.x. The user can execute the script file in one of two ways: 1. (Recommended): by executing the whole script file using the osql (deprecated) or sqlcmd tool from Microsoft SQL Server, using cmd.exe Please make sure that the folder containing OSQL.EXE is in the PATH environment variable. This folder path is \90\Tools\Bin. Example in a new CMD window, run this command: osql -U -P -S -d -i \alter_db_mssql_v3.0.x_to_v400.sql -o -w 1000 –n
Or : sqlcmd -U -P -S -d -i \alter_db_mssql_v3.0.x_to_v400.sql -o -w 1000
To migrate a v3.0.x database to v4.0, use the script alter_db_mssql_v3.0.x_to_v400.sql. The arguments of this command are: o
-U: username
o
-P: password
o
-S: server name
o
-d: database name
o
-i: full path name of the input file that contains the T-SQL code to be executed
o
-o: full path name of the output file, where the output will be printed; the folder containing the file must exist before calling the command
o
-w: size of each line in the output file
o
-n: removes numbering and the prompt symbol (>) from input lines
More details about osql.exe can be found in http://technet.microsoft.com/enus/library/aa214012%28v=sql.80%29.aspx More details about sqlcmd.exe can be found in http://technet.microsoft.com/enus/library/ms162773.aspx 2. Execute the content of the alter script using Microsoft SQL Server Management Studio: copy/paste the content of the script file into a query editor and execute it. Using this method causes the output of the script file to be written by default to the output console of Microsoft SQL Server Management Studio. The downside of this method is that the content is effectively displayed only when the alter script finishes its execution. However, the output console can be redirected to an external file, using specific configurations. Please refer to Microsoft documentation regarding this topic. The output log for Microsoft SQL Server will contain the following warning several times: "Caution: Changing any part of an object name
Chapter 6 Upgrade, Rollback and Uninstall | 41
could break scripts and stored procedures." This message is thrown out unconditionally by the DB engine, when database objects are renamed and it cannot be deleted. Do not worry- no database scripts nor stored procedures will break because of object renaming.
6.2.3 Error Handling If inconsistent data records are encountered they will be logged to the external log file whose address was specified in the upgrade procedure. If inconsistencies are encountered in database objects, they will be logged by the database engine to its own console. The record below in the external log file indicates successful completion of the migration process: [INFO ][date and time] Successful database migration.
If the migration process fails contact Dollar Access for expert analysis.
6.2.4 Logging Upgrade Progress The migration procedure logs processing steps to an external log file so that the user can find out what is happening at any time. The folder destined to contain the log file must exist on the disk. Otherwise, the database engine will throw an error when attempting to access an inexistent folder.
6.3 Upgrading Reporter on Windows The product upgrade is managed with the same procedure as the product installation. Refer to section "Installing the Reporter Server on Windows" on page 16. Major release upgrades require new Reporter license to be entered (v3 -> v4, v4 -> v6).
6.3.1 Upgrading the Reporter Server on Windows Existing instances of the Reporter Server and the Reporter clients will be listed if found. Select the Reporter Server instance to update and click Next.
6.3.1.1 The Welcome Screen The program displays a welcome to the InstallShield Wizard.
Click Next to proceed
Click Cancel to abandon the installation.
6.3.1.2 Define the Java (JDK or JRE) Environment - Windows Enter the path to the Java Home directory. The Java Home directory should contain the bin subdirectory that contains the java binary. Do not add /bin to the path. Click on the Browse… button to select the folder from the file system.
Click Next to proceed
42 | Chapter 6 Upgrade, Rollback and Uninstall
Click Cancel to abandon the installation.
6.3.1.3 Define JDBC Driver A JDBC driver must be present to enable Reporter to communicate with the database. Refer to section "JDBC Drivers" on page 15 for details about where to download the required driver. The installation program links to the driver in the location provided. Use the Browse… button to select the driver location from the file system.
Click Back to return to the previous screen
Click Next to proceed
Click Cancel to abandon the installation.
If the directory path is found to contain coherent Reporter contents, a message recalling the destination folder and indicating the Reporter name invites the user to request the upgrade in the next dialog.
6.3.1.4 Completing the Upgrade Procedure When the upgrade procedure is completed:
Reporter is automatically restarted after an upgrade V4 > V6 if it was started when the user launched the upgrade.
Reporter isn't restarted after an upgrade V3 > V6.
6.3.2 Upgrading the Reporter Client The product upgrade is managed with the same procedure as the product installation. Refer to section "Installing the Reporter Server on Windows" on page 16. Existing instances of the Reporter servers and clients will be listed if found. Select the Reporter client to be upgraded and click Next.
6.4 Upgrading Reporter on Linux The product upgrade is managed with the same procedure as the product installation. Refer to section: "Path to the UniJob Installation" on page 23. Major release upgrades require new Reporter license to be entered (v3 -> v4, v4 -> v6).
6.4.1 Upgrading the Reporter Server on Linux The inventory of Reporter installations (from version 3.0) is displayed. For example: List of the instances of product Reporter (version higher than 3.0) already installed on this machine: 1) Nodename="vmstluni99.automic.com" Installation directory="/var/opt/AUTOMIC/Reporter/vmstluni99.automic.com" 2) Nodename="vmstluni99" Installation directory="/var/tmp/Reporter" :
Enter the number that corresponds to the instance you want to update and click Enter.
Chapter 6 Upgrade, Rollback and Uninstall | 43
Confirmation is required, for example: Upgrade the instance vmstluni99 installed in /var/tmp/Reporter (y/n) [n] :
6.4.1.1 Location of the Java Command - Linux Provide the path to the directory containing Jre/Jdk. it must contain a "bin" folder with the java command inside: Location of the java folder (Jre/Jdk folder) :
6.4.1.2 Path to the JDBC Driver File Enter the FULL path to the JDBC driver file. Reporter uses the JDBC driver to communicate with the database (Oracle or MS SQL Server) If you can't find the driver file (ojdbc*.jar or sqljdbc*.jar), download it from the db vendor website. JDBC driver file path []:
A JDBC driver is required for Reporter to communicate with the database. Refer to section "JDBC Drivers" on page 15 for details about where to download the required driver. The installation program links to the driver in the location provided. The procedure expects the path and the name of the driver file. Example of path to JDBC driver file: /mnt/hgfs/Shared/ojdbc14.jar
6.4.1.3 Stopping Reporter If required, the update procedure will stop Reporter: The server vmstluni99 is started, we stop it
6.4.1.4 Completing the Upgrade Procedure When the upgrade procedure is completed, the following message is displayed: ==================================== Installation successfully completed ==================================== Reporter server is launched in background in nohangup mode.
When the upgrade procedure is completed:
Reporter is automatically restarted after an upgrade V4 > V6 if it was started when the user launched the upgrade.
Reporter isn't restarted after an upgrade V3 > V6.
A backup of the whole Reporter Server structure is made in ///backup_YYYYMMDD-*.tar.
6.4.2 Upgrading the Reporter Client Refer to section Upgrading the Reporter Server on Linux above.
44 | Chapter 6 Upgrade, Rollback and Uninstall
6.5 Rollback Reporter Database
Stop the Reporter Server (Refer to section: "Starting and Stopping the Reporter Server" on page 26).
Restore the database from the backup before upgrade
6.6 Rollback Reporter The user must backup himself its full Reporter folder if he wants to roll back to the previous state. The downgrade from Reporter Server current version to the previous one should be carried out manually as described below:
Stop the Reporter Server (Refer to section: "Starting and Stopping the Reporter Server" on page 26).
Copy the directory to a directory outside the Reporter Server tree.
Delete the directory tree.
Copy the contents of the directory to .
Start the Reporter Server.
6.6.1 Reporter Client for Dollar Universe Rollback on Windows The downgrade from Reporter Client current version to the previous one should be carried out manually as described below:
Copy the < Reporter_client>\ directory to a work directory outside the Dollar Universe tree.
Delete the directory tree.
Copy the contents of the directory to .
6.6.2 Reporter Client for Dollar Universe Rollback on Linux The downgrade from Reporter Client current version to the previous one should be carried out manually as described below:
Copy the < Reporter_client>/ directory to a work directory outside the Dollar Universe tree.
Delete the directory tree.
Copy the contents of the directory to .
Chapter 6 Upgrade, Rollback and Uninstall | 45
6.7 Removing Reporter Components Un-installation of the Reporter Server and the Reporter Clients for Dollar Universe and UniJob are described below.
6.7.1 Un-installing the Reporter Server on Windows Stop the Reporter Server. Select the Reporter Server from the Start Menu>Settings>Control Panel>Add & Remove Programs. Select the instance to be removed.
6.7.2 Un-install the Reporter Client for Dollar Universe on Windows Remove the Reporter Client for Dollar Universe from the Start Menu>Settings>Control Panel>Add & Remove Programs. Select the instance to be removed.
6.7.3 Un-install the Reporter Client for UniJob on Windows Remove the Reporter Client for UniJob from the Start Menu>Settings>Control Panel>Add & Remove Programs. Select the instance to be removed.
6.7.4 Un-installing Reporter Server from Linux Launch the installation procedure unirun –d (refer to section "Installing the Reporter Server on Linux" on page 19): _______________________________________________________ Reporter Uninstallation (c) AUTOMIC 2011 _______________________________________________________ Please select the installation type - Server installation - Reporter Client for UniJob - Reporter Client for Dollar Universe Enter Installation Type : s
[s] [u] [d]
Enter s for Reporter Server The list of installed instances is displayed, for example: List of the instances of product Reporter (version higher than 3.0) already installed on this machine: 1) Nodename="vmstluni99.automic.com" Installation directory="/var/opt/AUTOMIC/Reporter/vmstluni99.automic.com" 2) Nodename="vmstluni99" Installation directory="/var/tmp/Reporter" :
Enter the number of the Reporter instance to be removed. Confirmation is requested before launching the uninstallation, for example:
46 | Chapter 6 Upgrade, Rollback and Uninstall
Confirm the uninstallation of instance vmstluni99 installed in /var/tmp/Reporter (y/n)? [n] :
Enter "y" to continue or "n" to abandon.
6.7.5 Un-install the Reporter Client on Linux Launch the installation procedure unirun –d (refer to section "Installing the Reporter Server on Linux" on page 19): _______________________________________________________ Reporter Uninstallation (c) AUTOMIC 2011 _______________________________________________________ Please select the installation type - Server installation - Reporter Client for UniJob - Reporter Client for Dollar Universe Enter Installation Type : d
Enter d for Reporter Client for Dollar Universe.
Enter u for Reporter Client for UniJob.
Enter the number of the Client instance to be removed.
[s] [u] [d]
Chapter 7 Authentication and User Rights | 47
7 Authentication and User Rights Reporter V6 treats Dollar Universe Application Server V6 nodes in much the same way as UniJob nodes. The Dollar Universe Application Server V6 nodes are registered on UniViewer Management Server at installation time as are UniJob nodes. New additions are dispatched to all Dollar Universe Application Server nodes by the synchronization engine. Installation of Reporter V6 adds Reporter_Administrator and Reporter_Reader Roles and attributes them to default Groups on UniViewer Management Server. Authentication of users wanting to access Reporter V6 and beyond that Dollar Universe Application Server V6 is managed centrally on UniViewer Management Server via Logins, Roles and Groups. Local proxy and user management are maintained on Reporter V6 to be able to authenticate commands executed from the command line interface.
Figure 2: UniViewer and Reporter User Management
Commands detailed in this chapter are shown below. Category
Command
Description
Proxy
delproxy
Delete a Proxy Rule from a Reporter Server
Proxy
getproxy
Retrieve the Name of a Proxy User
Proxy
lstproxy
List Proxy Rules on a Reporter Server
Proxy
setproxy
Add a Proxy Rule to Reporter Server
User
adduser
Add a User to the Reporter Internal User List
User
deluser
Delete a User from the Reporter Internal User List
User
lstuser
List Reporter Internal Users
48 | Chapter 7 Authentication and User Rights
7.1 After Installation A list of internal users is maintained on the Reporter Server. At installation the list contains just the admin user. By default, all system users coming from any machine are mapped by proxy to Reporter’s admin user. lstproxy *
*
*
*
admin
Standard users can only execute extraction and reporting commands. Those with the ADMIN attribute can additionally execute user management commands and configure the database from the GUI.
7.1.1 Internal Users Reporter’s internal user list is maintained via Reporter’s user management commands (refer to section: Reporter User Management on page 48). No access to the internal user list is available from the UniViewer Console. To use the Reporter command-line interface, the system user must either be declared in the internal users list or be linked to a valid internal user via a Reporter proxy. (Refer to section: Reporter Proxy Management on page 49).
7.1.2 Extraction from Dollar Universe V5 Targets The internal Reporter user that executes the extraction command needs access to remote DUAS. Users should either be declared in the DUAS user tables or proxied to a valid Dollar Universe user.
7.1.3 Extraction from UniJob and DUAS V6 Targets A UniViewer console login must be specified (username and password) in the Reporter Servers/Node Settings/UVMS Parameters for data extraction by the Reporter Server from the target Nodes. It is worth creating a dedicated login (for example, rep_user) with a monitoring read only profile to fulfill the UniJob extraction function.
7.2 Reporter User Management The following commands are available on the Reporter Server in the \exec directory to manage users and access rights on the Reporter Server. User management commands are reserved for Reporter users with the ADMIN attribute.
7.2.1 Add a User to the Reporter Internal User List A user can be added with the adduser command. The syntax is: adduser [-REPNODE ] [ADMIN]
This command updates the user file \data\users.conf by adding the new user name.
Chapter 7 Authentication and User Rights | 49
Arguments
Description
REPNODE
A ten-character string giving the logical Node name of the Reporter Server. If this parameter is not provided in the command line, the parameter is automatically set to the value of the environment variable REPNODE. If the variable does not exist, REPNODE will be set to the value of the parameter com.orsyp.server.config.repnode in the server.conf file. If this parameter is not found the command will fail.
username
The name of the user to add
ADMIN
Provides administrator privileges to the user. Only administrators can execute the user management commands.
7.2.2 Delete a User from the Reporter Internal User List A user can be removed with the deluser command. The syntax is: deluser [–REPNODE ]
This command updates the user file \data\users.conf. Arguments
Description
REPNODE
A ten-character string giving the logical Node name of the Reporter Server. If this parameter is not provided in the command line, the parameter is automatically set to the value of the environment variable REPNODE. If the variable does not exist, REPNODE will be set to the value of the parameter com.orsyp.server.config.repnode in the server.conf file. If this parameter is not found the command will fail.
username
The name of the user to be deleted
7.2.3 List Reporter Internal Users The known users can be displayed through the lstuser command. The syntax is: lstuser [-REPNODE ]
This command displays the users referenced in file \data\users.conf. Arguments
Description
REPNODE
A ten-character string giving the logical Node name of the Reporter Server. If this parameter is not provided in the command line, the parameter is automatically set to the value of the environment variable REPNODE. If the variable does not exist, REPNODE will be set to the value of the parameter com.orsyp.server.config.repnode in the server.conf file. If this parameter is not found the command will fail.
7.3 Reporter Proxy Management 7.3.1 Add a Proxy Rule to Reporter Server A proxy rule can be added through the setproxy command. The syntax is: setproxy -REPNODE]
This command updates the proxy file \data\proxy.txt by adding the new translation rule.
50 | Chapter 7 Authentication and User Rights
Arguments
Description
REPNODE
A ten-character string giving the logical Node name of the Reporter Server. If this parameter is not provided in the command line, the parameter is automatically set to the value of the environment variable REPNODE. If the variable does not exist, REPNODE will be set to the value of the parameter com.orsyp.server.config.repnode in the server.conf file. If this parameter is not found the command will fail.
SystemCode
This accepts the following keys: - * for users coming from any system, - W32 for users coming from a Windows system (Batch client submission user) - UNX for users coming from a UNIX/Linux system (Batch client submission user)
UniverseNode
Dollar Universe Node
UserDomain
This is a windows specific parameter. It has to be provided only on Windows platforms. It references the windows domain of the remote user.
UserName
The remote user name
ProxyName
The local user name
For example, in order to set a rule that translates any user in the myCompany.com domain submitting requests coming from Windows Nodes whose name starts with "us_nodes_" to the local user "admin", proceed as follows: setproxy W32 us_nodes_* myCompany.com * admin
7.3.2 Delete a Proxy Rule from a Reporter Server A proxy rule can be removed through the delproxy command. The syntax is: delproxy [–REPNODE ]
This command updates the proxy from the file \data\proxy.txt by removing the described rule. Arguments
Description
REPNODE
A ten-character string giving the logical Node name of the Reporter Server. If this parameter is not provided in the command line, the parameter is automatically set to the value of the environment variable REPNODE. If the variable does not exist, REPNODE will be set to the value of the parameter com.orsyp.server.config.repnode in the server.conf file. If this parameter is not found the command will fail.
SystemCode
This accepts the following keys: - * for users coming from all systems - W32 for users coming from a Windows system (Batch client submission user) - UNX for users coming from a UNIX/Linux system (Batch client submission user)
UniverseNode
Dollar Universe Node
UserDomain
This is a windows specific parameter. It has to be provided only on Windows platforms. It references the windows domain of the remote user.
UserName
The remote user name
7.3.3 List Proxy Rules on a Reporter Server The proxy rules can be displayed through the lstproxy command. The syntax is: lstproxy [-REPNODE ]
This command displays the rules defined in the proxy file \data\proxy.txt.
Chapter 7 Authentication and User Rights | 51
Arguments
Description
REPNODE
A ten-character string giving the logical Node name of the Reporter Server. If this parameter is not provided in the command line, the parameter is automatically set to the value of the environment variable REPNODE. If the variable does not exist, REPNODE will be set to the value of the parameter com.orsyp.server.config.repnode in the server.conf file. If this parameter is not found the command will fail.
7.3.4 Retrieve the Name of a Proxy User The getproxy command can be used to find the translation of a given set of (system code, Node name, user domain, username): getproxy [-REPNODE ]
This command returns the local user defined in the proxy file \data\proxy.txt. Arguments
Description
REPNODE
A ten-character string giving the logical Node name of the Reporter Server. If this parameter is not provided in the command line, the parameter is automatically set to the value of the environment variable REPNODE. If the variable does not exist, REPNODE will be set to the value of the parameter com.orsyp.server.config.repnode in the server.conf file. If this parameter is not found the command will fail.
SystemCode
This accepts the following keys: - * for users coming from all systems - W32 for users coming from a Windows system (Batch client submission user) - UNX for users coming from a Unix/Linux system (Batch client submission user)
UniverseNode
Dollar Universe Node
UserDomain
This is a windows specific parameter. It has to be provided only on Windows platforms. It references the windows domain of the remote user.
UserName
The remote user name
52 | Chapter 8 Command Interface
8 Command Interface Reporter commands (uxrepadd, uxrepgen, uxreppurge) are scripts and not binaries. This means, in particular if CLI is used on Windows environments, that each command must be preceded by a "call' keyword when used inside Uproc script.
8.1 Data Management The command-line interface allows all major Reporter actions such as database maintenance (extract and purge) and report generation and dispatch to be executed from scripts and automated from Dollar Universe or UniJob. Commands detailed in this chapter are shown below. Category
Command
Description
Extractions
uxrepadd
Trigger an Extraction from data sources and load into database
Monitoring
unicheckrep
Check Reporter Server activity
Monitoring
unirepinfo
Check Reporter Server software version
Purging
uxreppurge
Purge extraction data from the database
8.1.1 Triggering Extractions Extractions can be triggered with the uxrepadd command (either from the Reporter Server, a Reporter Client for Dollar Universe or UniJob). The syntax is: uxrepadd EXT
-PRODUCT [-UVMS ] [-COMPANY ] [EXP, SIM, INT or APP ] [-REPNODE ] [-LABEL ] [-NODEVIEW ] [-NODE ] [-FILTER ] [WAIT|NOWAIT]
The command is available in the exec directory:
\exec for the Reporter Server
\reporter_client\exec for the Reporter Client for DUAS
\reporter_client\exec for the Reporter Client for UniJob
Like the GUI, it connects to the specified Reporter Server and triggers the extraction. Parameter
Default Mandatory/description
-PRODUCT
DUAS
-UVMS
DUAS or UNIJOB or ALL (Mandatory). It is only necessary to specify the UVMS name if multiple UVMS Nodes have been declared on the Reporter Server.
Chapter 8 Command Interface | 53
Parameter
Default Mandatory/description The UVMS determines which Nodes and Node Views are available for extraction. If multiple Nodes have been declared and this option is not provided, the uxrepadd command will end in error.
-COMPANY
Only if Product=DUAS. A six-character string giving a DUAS Company name from which to extract data. If this parameter is not provided in the command line, the parameter is automatically set to the environment variable S_COMPANY. If the environment variable does not exist, the command will fail.
EXP/SIM/INT/APP
Only if Product=DUAS. A three-character string indicating the Area from which to extract data. If this parameter is not provided in the command line, the parameter is automatically set to the environment variable S_AREA. If the environment variable does not exist, the command will fail.
-REPNODE
Indicates the name of the Reporter Server. This parameter is only necessary if the REPNODE environment variable is not set.
-LABEL
A 256-character string giving a label to the extraction. The label is for information purposes only (it displays in the Last Extractions column in UniViewer). It cannot be used to identify a group of Nodes as is possible in UniViewer. If no label is specified, “All extractions” will be displayed in UniViewer.
-NODEVIEW
Either NODE or NODEVIEW must be specified.
-NODE
Either NODE or NODEVIEW must be specified. The list of Nodes targeted for extraction. On the basis of this parameter, the command triggers an extraction on the specified Nodes.
WAIT/NOWAIT
WAIT
Flags to use in order to control the execution. If WAIT is used, the command executes synchronously and control will only be returned when the extraction has completed. This is the default behavior. NOWAIT will return control immediately.
Extractions are handled on a FIFO basis by UVMS. If 10 extractions each target 20 data sources via 10 different UVMS (and the maxParallelExtractions=10), second extraction cannot start until the 20 data sources of the first extraction have been processed.
8.1.2 Monitoring Extractions 8.1.2.1 Reporter Server Status There is no equivalent to the Extraction Monitor or the Extraction History in the command-line interface. However some commands provide useful data. The server state and activity can be displayed using the unicheckrep script, available in the exec directory:
For the Reporter Server: \exec
For the Reporter Client for DUAS: \reporter_client\exec
Command syntax: unicheckrep [-REPNODE -d]
The "–d(etail)" parameter shows the list of running and pending extractions grouped by UVMS.
54 | Chapter 8 Command Interface
Examples of the output produced by the execution of this command in an MSSQL and Oracle server environment are shown below. The table size and number of cursors are only displayed for the Oracle server environment if the user has sufficient rights on the UNI_EVT* tables (otherwise the information will not be displayed): Example for MSSQL: unicheckrep –d REPNODE=cavtlqpj01 value taken from configuration file server.conf. Reporter Server name = cavtlqpj01 Reporter Server PID = 28559 noOfPurgesInExec = 0 noOfPurgesInWait = 0 noOfExtractionsInExec = 0 noOfExtractionsInWait = 0 noOfReportsGenerateInExec = 0 noOfReportsGenerateInWait = 0 memUsage = 18.856934 memFree = 971.01807 ***********Rows Count per table*********** UNI_EVT_RELAUNCHES: 0 records. UNI_EVT_JOBLOGS: 0 records. UNI_EVT_MESSAGES: 0 records. UNI_EVT_PARAMETERS: 0 records. UNI_EVT_VARIABLES: 0 records. UNI_EVT_AUDITTRAIL: 0 records. UNI_EVT_DATASOURCES: 0 records. UNI_EVT_EXTRACTIONS: 0 records. UNI_EVT_PURGES: 0 records. UNI_EVT_LOG: 0 records. UNI_EVT_REPORTS: 0 records. UNI_EVT_TECH_REPORTS: 48 records. UNI_EVT_STATUSES: 22 records.
Example for Oracle: unicheckrep –d REPNODE=CAVTMQTKH value taken from environment variable. REPNODE Reporter Server name = CAVTMQTKH Reporter Server PID = 3980 noOfPurgesInExec = 0 noOfPurgesInWait = 0 noOfExtractionsInExec = 0 noOfExtractionsInWait = 0 noOfReportsGenerateInExec = 0 noOfReportsGenerateInWait = 0 memUsage = 107.90021 memFree = 881.9748 ***********Rows Count per table*********** UNI_EVT_RELAUNCHES: 0 records. UNI_EVT_JOBLOGS: 0 records. UNI_EVT_MESSAGES: 0 records. UNI_EVT_PARAMETERS: 0 records. UNI_EVT_VARIABLES: 0 records. UNI_EVT_AUDITTRAIL: 0 records. UNI_EVT_DATASOURCES: 0 records. UNI_EVT_EXTRACTIONS: 0 records. UNI_EVT_PURGES: 0 records. UNI_EVT_LOG: 0 records. UNI_EVT_REPORTS: 0 records. UNI_EVT_TECH_REPORTS: 24 records. UNI_EVT_STATUSES: 11 records. ***********Tables size***********
Chapter 8 Command Interface | 55
UNI_EVT_RELAUNCHES: 720896 bytes. UNI_EVT_JOBLOGS: 131072 bytes. UNI_EVT_MESSAGES: 327680 bytes. UNI_EVT_PARAMETERS: 262144 bytes. UNI_EVT_VARIABLES: 262144 bytes. UNI_EVT_AUDITTRAIL: 262144 bytes. UNI_EVT_DATASOURCES: 524288 bytes. UNI_EVT_EXTRACTIONS: 327680 bytes. UNI_EVT_PURGES: 196608 bytes. UNI_EVT_LOG: 131072 bytes. UNI_EVT_REPORTS: 196608 bytes. UNI_EVT_TECH_REPORTS: 131072 bytes. UNI_EVT_STATUSES: 131072 bytes. ***********Cursors used*********** Number of opened cursors is: 5 ***********Extractions In Progress*********** Extract from UVMS: frlpmpmgt Extraction info: name = Allextractions datasource =(UNIV53 frlpmpmgt X)
If the extraction was triggered synchronously, the user will be able follow its progress with the unicheckrep command.
8.1.2.2 Reporter Server Information The unirepinfo command displays software version and build information about the Reporter Server as well as listing the declared UVMS. Command syntax: unirepinfo [ -REPNODE ] unirepinfo REPNODE=FRLPMDEV04 the value was taken from the variable REPNODE Reporter Server Information: Version: 3.0 Build Number: 01 Build Date: 25.01.2010 Server Current Date: 10 Feb 2010 17:17:50 Server GMT: GMT+01:00 UVMS Info: UVMS:[ uvmsName=frlpmdev04, uvmsHost=frlpmdev04, uvmsPort=4184, uvmsLogin=admin FR_UVMS:[ uvmsName=frlpmpmgt, uvmsHost=frlpmpmgt, uvmsPort=4184, uvmsLogin=admin FR_Patch information:
8.1.3 Triggering a Database Purge The uxreppurge command can be launched either from the Reporter Server or a Reporter Client. The command is available in the exec directory:
For the Reporter Server: \exec
For the Reporter Client: \reporter_client\exec
A database purge can be launched with the following command: uxreppurge EXT [-LABEL ]
56 | Chapter 8 Command Interface
[-REPNODE ] Default=REPSERVER [WAIT/NOWAIT] Arguments
Description
-LABEL
(Optional) 128 character string. This label identifies the purge.
-REPNODE
A ten-character string giving the logical Node name of the Reporter Server. If this parameter is not provided in the command line, the parameter is automatically set to the value of the environment variable REPNODE. If the variable does not exist, REPNODE will be set to the value of the parameter com.orsyp.server.config.repnode in the server.conf file. If this parameter is not found the command will fail.
WAIT/NOWAIT (Optional) WAIT (default) returns control to the command line only when the purge command has finished (synchronous execution). NOWAIT returns control immediately (asynchronous execution).
This connects to the Reporter Server and triggers the purge operation; in line with Data Base Purge criteria (refer to the Reporter User Manual for details of Reporter purge settings). This command requires administrator rights for the Reporter user.
8.2 Report Management A number of standard easy to use Report Templates for Dollar Universe and UniJob data are provided with Reporter. Commands detailed in this chapter are shown below. Category
Command
Description
Reports
uxrepgen
Generates a Report from a template
8.2.1 Using Report Templates Report templates are grouped by theme:
Job Status
System load
Workload trends
Average loads
Success/Failure trends
Longest jobs
Elapsed time deviation
Report templates are stored in the directory: \data\reports\templates\system\
Report templates are prefixed by Tg-o or TUJ-g-o: Where:
T=Dollar Universe Template
TUJ=UniJob Template
g=group number
o=order number in the group
Chapter 8 Command Interface | 57
Examples T1-2 Job Status with List of Anomalies.jasper TUJ-1-2 Job Status with List of Anomalies.jasper The user has the option to create custom reports. The .jasper files should be deposited in the directory: \data\reports\templates\custom\
Please note that custom reports cannot be included in the upgrade processes supplied. 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. System and custom report templates are described in the Reporter User Manual.
8.2.2 Triggering Reports The uxrepgen command can be launched either from the Reporter Server or a Reporter Client. The command is available in the exec directory:
For the Reporter Server: \exec
For the Reporter Client: reporter_client\exec
A report can be generated with the following command: uxrepgen -REPNODE ] -DEFINITION [WAIT/NOWAIT] Arguments
Description
-REPNODE
A ten-character string giving the logical Node name of the Reporter Server. If this parameter is not provided in the command line, the parameter is automatically set to the value of the environment variable REPNODE. If the variable does not exist, REPNODE will be set to the value of the parameter com.orsyp.server.config.repnode in the server.conf file. If this parameter is not found the command will fail.
-DEFINITION
The name of the Report Definition. The Report Definition must of course exist.
WAIT/NOWAIT
(Optional) WAIT (default) returns control to the command line only when the purge command has finished (synchronous execution). NOWAIT returns control immediately (asynchronous execution).
8.2.3 Report Customization A company logo (default=AUTOMIC) is included in the upper left hand corner of the generated report. This logo is stored in: \data\report\logo.png
Overwrite this file with your company logo (after saving the default file). The new logo will be re-dimensioned proportionally to fit the available space in the upper-left corner of the report.
58 | Chapter 9 Reporter Troubleshooting
9 Reporter Troubleshooting This section provides a few pointers to help users solve most frequent problems.
9.1 Tracing the Problem There are several sources of information that are helpful to identify the origin of a problem:
The Reporter server.log file stored in the \logs directory
The logs, associated with each extraction, stored in the database, in the UNI_EVT_LOG table (can also be displayed form the UniViewer interface)
The running services table on Windows
The running processes table on Linux
The Job Log of each launch on Reporter client Nodes
The unicheckrep command
The unirepinfo command
The Audit Trail
9.2 Error Messages Error messages related to some common situations are listed below.
9.2.1 Reporter Node Not Defined – Connection Refused This message is displayed when the location of the Reporter Server is not set:
Set the REPNODE variable on the DUAS reference Node in case of a v5.3 DUAS.
Restart the server.
9.2.2 Table Does Not Exist If the Reporter DB connection user is not the owner of the DB schema, you will probably get the following message when attempting to launch an action with your connection user: “java.sql.SQL Exception: ORA-00942: table or view does not exist”
Assume that user repowner was used to create the schema and that user repcon is used to connect to the database. Both users must share the same tablespace. The following SQL script should be run under repowner to grant access to the Reporter tables to repcon: /* Grant access to Tables */ GRANT SELECT, INSERT, UPDATE, DELETE ON repowner.UNI_EVT_AUDITTRAIL repcon; GRANT SELECT, INSERT, UPDATE, DELETE ON repowner.UNI_EVT_DATASOURCES repcon; GRANT SELECT, INSERT, UPDATE, DELETE ON repowner.UNI_EVT_EXTRACTIONS repcon;
TO TO TO
Chapter 9 Reporter Troubleshooting | 59
GRANT SELECT, repcon; GRANT SELECT, repcon; GRANT SELECT, repcon; GRANT SELECT, repcon; GRANT SELECT, repcon; GRANT SELECT, repcon; GRANT SELECT, repcon; GRANT SELECT repcon; GRANT SELECT, repcon; GRANT SELECT repcon;
INSERT, UPDATE, DELETE ON repowner.UNI_EVT_JOBLOGS
TO
INSERT, UPDATE, DELETE ON repowner.UNI_EVT_LOG
TO
INSERT, UPDATE, DELETE ON repowner.UNI_EVT_MESSAGES
TO
INSERT, UPDATE, DELETE ON repowner.UNI_EVT_PARAMETERS
TO
INSERT, UPDATE, DELETE ON repowner.UNI_EVT_PURGES
TO
INSERT, UPDATE, DELETE ON repowner.UNI_EVT_RELAUNCHES
TO
INSERT, UPDATE, DELETE ON repowner.UNI_EVT_REPORTS
TO
ON repowner.UNI_EVT_STATUSES INSERT, UPDATE, DELETE ON repowner.UNI_EVT_VARIABLES ON repowner.UNI_EVT_TECH_REPORTS
/* Grant access to Views */ GRANT SELECT ON repowner.UNI_REP_LAUNCHES_VIEW
TO repcon;
/* Grant access GRANT SELECT ON GRANT SELECT ON GRANT SELECT ON GRANT SELECT ON GRANT SELECT ON GRANT SELECT ON GRANT SELECT ON
TO TO TO TO TO TO TO
to Sequences */ repowner.UNI_EVT_AUDITTRAIL_SEQ repowner.UNI_EVT_DATASOURCES_SEQ repowner.UNI_EVT_EXTRACTIONS_SEQ repowner.UNI_EVT_LOG_SEQ repowner.UNI_EVT_PURGES_SEQ repowner.UNI_EVT_RELAUNCHES_SEQ repowner.UNI_EVT_REPORTS_SEQ
TO TO TO
repcon; repcon; repcon; repcon; repcon; repcon; repcon;
/* Grant access to Stored Procedures */ GRANT EXECUTE ON repowner.INSERT_OR_UPDATE_RELAUNCH TO repcon; GRANT EXECUTE ON repowner.UPDATE_RELAUNCH TO repcon;
The following SQL script should be run by repcon to point to the objects belonging to repowner. /* Create SYNONYM for Tables */ CREATE SYNONYM repcon.UNI_EVT_AUDITTRAIL CREATE SYNONYM repcon.UNI_EVT_DATASOURCES repowner.UNI_EVT_DATASOURCES; CREATE SYNONYM repcon.UNI_EVT_EXTRACTIONS repowner.UNI_EVT_EXTRACTIONS; CREATE SYNONYM repcon.UNI_EVT_JOBLOGS CREATE SYNONYM repcon.UNI_EVT_LOG CREATE SYNONYM repcon.UNI_EVT_MESSAGES CREATE SYNONYM repcon.UNI_EVT_PARAMETERS CREATE SYNONYM repcon.UNI_EVT_PURGES CREATE SYNONYM repcon.UNI_EVT_RELAUNCHES CREATE SYNONYM repcon.UNI_EVT_REPORTS CREATE SYNONYM repcon.UNI_EVT_STATUSES CREATE SYNONYM repcon.UNI_EVT_VARIABLES CREATE SYNONYM repcon.UNI_EVT_TECH_REPORTS repowner.UNI_EVT_TECH_REPORTS;
FOR repowner.UNI_EVT_AUDITTRAIL; FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR
repowner.UNI_EVT_JOBLOGS; repowner.UNI_EVT_LOG; repowner.UNI_EVT_MESSAGES; repowner.UNI_EVT_PARAMETERS; repowner.UNI_EVT_PURGES; repowner.UNI_EVT_RELAUNCHES; repowner.UNI_EVT_REPORTS; repowner.UNI_EVT_STATUSES; repowner.UNI_EVT_VARIABLES;
/* Create SYNONYM for Views */ CREATE SYNONYM repcon.UNI_REP_LAUNCHES_VIEW FOR repowner.UNI_REP_LAUNCHES_VIEW; /* Create SYNONYM for Sequences */ CREATE SYNONYM repcon.UNI_EVT_AUDITTRAIL_SEQ repowner.UNI_EVT_AUDITTRAIL_SEQ; CREATE SYNONYM repcon.UNI_EVT_DATASOURCES_SEQ repowner.UNI_EVT_DATASOURCES_SEQ; CREATE SYNONYM repcon.UNI_EVT_EXTRACTIONS_SEQ repowner.UNI_EVT_EXTRACTIONS_SEQ;
FOR FOR FOR
60 | Chapter 9 Reporter Troubleshooting
CREATE SYNONYM repcon.UNI_EVT_LOG_SEQ repowner.UNI_EVT_LOG_SEQ; CREATE SYNONYM repcon.UNI_EVT_PURGES_SEQ repowner.UNI_EVT_PURGES_SEQ; CREATE SYNONYM repcon.UNI_EVT_RELAUNCHES_SEQ repowner.UNI_EVT_RELAUNCHES_SEQ; CREATE SYNONYM repcon.UNI_EVT_REPORTS_SEQ repowner.UNI_EVT_REPORTS_SEQ; /* Create SYNONYM for Constraints */ CREATE SYNONYM repcon.UNI_EVT_LOG_PK CREATE SYNONYM repcon.UNI_EVT_DATASOURCES_PK repowner.UNI_EVT_DATASOURCES_PK; CREATE SYNONYM repcon.UNI_EVT_EXTRACTIONS_PK repowner.UNI_EVT_EXTRACTIONS_PK; CREATE SYNONYM repcon.UNI_EVT_EXTRACTIONS_FK1 repowner.UNI_EVT_EXTRACTIONS_FK1; CREATE SYNONYM repcon.UNI_EVT_RELAUNCHES_PK repowner.UNI_EVT_RELAUNCHES_PK; CREATE SYNONYM repcon.UNI_EVT_RELAUNCHES_FK repowner.UNI_EVT_RELAUNCHES_FK; CREATE SYNONYM repcon.UNI_EVT_JOBLOGS_FK repowner.UNI_EVT_JOBLOGS_FK; CREATE SYNONYM repcon.UNI_EVT_MESSAGES_FK repowner.UNI_EVT_MESSAGES_FK; CREATE SYNONYM repcon.UNI_EVT_PARAMETERS_FK repowner.UNI_EVT_PARAMETERS_FK; CREATE SYNONYM repcon.UNI_EVT_VARIABLES_FK repowner.UNI_EVT_VARIABLES_FK; CREATE SYNONYM repcon.UNI_EVT_PURGES_PK repowner.UNI_EVT_PURGES_PK; CREATE SYNONYM repcon.UNI_EVT_AUDITTRAIL_PK repowner.UNI_EVT_AUDITTRAIL_PK; CREATE SYNONYM repcon.UNI_EVT_AUDITTRAIL_FK repowner.UNI_EVT_AUDITTRAIL_FK; CREATE SYNONYM repcon.UNI_EVT_REPORTS_PK repowner.UNI_EVT_REPORTS_PK; CREATE SYNONYM repcon.UNI_EVT_STATUSES_PK repowner.UNI_EVT_STATUSES_PK; CREATE SYNONYM repcon.UNI_TECH_REPORTS_PK repowner.UNI_TECH_REPORTS_PK; CREATE SYNONYM repcon.UNI_EVT_RELAUNCHES_UNIQUE repowner.UNI_EVT_RELAUNCHES_UNIQUE; CREATE SYNONYM repcon.UNI_EVT_JOBLOGS_UNIQUE repowner.UNI_EVT_JOBLOGS_UNIQUE; CREATE SYNONYM repcon.UNI_EVT_MESSAGES_UNIQUE repowner.UNI_EVT_MESSAGES_UNIQUE; CREATE SYNONYM repcon.UNI_EVT_PARAMETERS_UNIQUE repowner.UNI_EVT_PARAMETERS_UNIQUE; CREATE SYNONYM repcon.UNI_EVT_VARIABLES_UNIQUE repowner.UNI_EVT_VARIABLES_UNIQUE; CREATE SYNONYM repcon.UNI_EVT_AUDITTRAIL_UNIQUE repowner.UNI_EVT_AUDITTRAIL_UNIQUE;
FOR FOR FOR FOR
FOR repowner.UNI_EVT_LOG_PK; FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR
/* Create SYNONYM for Indexes */ CREATE SYNONYM repcon.UNI_EVT_DATASOURCES_UVMS repowner.UNI_EVT_DATASOURCES_UVMS; CREATE SYNONYM repcon.UNI_EVT_DATASOURCES_COMPANY repowner.UNI_EVT_DATASOURCES_COMPANY; CREATE SYNONYM repcon.UNI_EVT_DATASOURCES_NODE repowner.UNI_EVT_DATASOURCES_NODE; CREATE SYNONYM repcon.UNI_EVT_DATASOURCES_TAGS repowner.UNI_EVT_DATASOURCES_TAGS; CREATE SYNONYM repcon.UNI_EVT_DATASOURCES_AREA repowner.UNI_EVT_DATASOURCES_AREA; CREATE SYNONYM repcon.UNI_EVT_RELAUNCHES_SESS_NAME repowner.UNI_EVT_RELAUNCHES_SESS_NAME;
FOR FOR FOR FOR FOR FOR
Chapter 9 Reporter Troubleshooting | 61
CREATE SYNONYM repcon.UNI_EVT_RELAUNCHES_SESS_VERS repowner.UNI_EVT_RELAUNCHES_SESS_VERS; CREATE SYNONYM repcon.UNI_EVT_RELAUNCHES_UPROC_NAME repowner.UNI_EVT_RELAUNCHES_UPROC_NAME; CREATE SYNONYM repcon.UNI_EVT_RELAUNCHES_UPR_VERS repowner.UNI_EVT_RELAUNCHES_UPR_VERS; CREATE SYNONYM repcon.UNI_EVT_RELAUNCHES_MU repowner.UNI_EVT_RELAUNCHES_MU; CREATE SYNONYM repcon.UNI_EVT_RELAUNCHES_DATASOURCE repowner.UNI_EVT_RELAUNCHES_DATASOURCE; CREATE SYNONYM repcon.UNI_EVT_RELAUNCHES_NUMLANC repowner.UNI_EVT_RELAUNCHES_NUMLANC; CREATE SYNONYM repcon.UNI_EVT_RELAUNCHES_STATUS repowner.UNI_EVT_RELAUNCHES_STATUS; CREATE SYNONYM repcon.UNI_EVT_VARIABLES_PI repowner.UNI_EVT_VARIABLES_PI; CREATE SYNONYM repcon.UNI_EVT_VARIABLES_NAME repowner.UNI_EVT_VARIABLES_NAME; CREATE SYNONYM repcon.UNI_EVT_MESSAGES_PI repowner.UNI_EVT_MESSAGES_PI; CREATE SYNONYM repcon.UNI_EVT_MESSAGES_CRE_TIME repowner.UNI_EVT_MESSAGES_CRE_TIME; CREATE SYNONYM repcon.UNI_EVT_MESSAGES_MSG_TEXT repowner.UNI_EVT_MESSAGES_MSG_TEXT; CREATE SYNONYM repcon.UNI_EVT_PARAMETERS_PI repowner.UNI_EVT_PARAMETERS_PI; CREATE SYNONYM repcon.UNI_EVT_PARAMETERS_NAME repowner.UNI_EVT_PARAMETERS_NAME; CREATE SYNONYM repcon.UNI_EVT_JOBLOGS_PI repowner.UNI_EVT_JOBLOGS_PI; CREATE SYNONYM repcon.UNI_EVT_AUDITTRAIL_DS repowner.UNI_EVT_AUDITTRAIL_DS; CREATE SYNONYM repcon.UNI_EVT_EXTRACTIONS_DI repowner.UNI_EVT_EXTRACTIONS_DI; CREATE SYNONYM repcon.UNI_EVT_EXTRACTIONS_LI repowner.UNI_EVT_EXTRACTIONS_LI; CREATE SYNONYM repcon.UNI_EVT_PURGES_LI repowner.UNI_EVT_PURGES_LI; CREATE SYNONYM repcon.UNI_EVT_REPORTS_LI repowner.UNI_EVT_REPORTS_LI;
FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR FOR
/* Create SYNONYM for stored procedures */2 CREATE SYNONYM repcon.INSERT_OR_UPDATE_RELAUNCH FOR repowner.INSERT_OR_UPDATE_RELAUNCH; CREATE SYNONYM repcon.UPDATE_RELAUNCH FOR repowner.UPDATE_RELAUNCH;
9.2.3 Impossible to Submit Command – Job Aborted COMMAND: ../../../reporter_client/exec/uxrepadd EXT -REPNODE frlpmdev04 PRODUCT UNIJOB -UVMS *
The above error message appears in the log of an internally scheduled Job, named for example REP_EXT__, if the Reporter Client for UniJob has not been installed.
9.2.4 Extractions Do Not Work If manual requests to extract remain without effect the cause could well be that the JDBC driver installed is not the right version. Absence of the ojdbc5.jar causes the display of clear error messages stating that the Oracle JDBC driver is missing. However, if the wrong JDBC driver is installed, there is no clear error message.
62 | Chapter 9 Reporter Troubleshooting
Download the JDBC driver corresponding to your version if the database and restart the Reporter Server.
9.2.5 Database Connection If the database connection is not properly configured the following message may be displayed when opening a document: “REPORTER: Reporter Extraction Monitor on : Could not get last extraction source status: Could not open a connection to the database. Check your database settings.”
Solution:
Go to Reporter Node settings.
Verify the field related to the database connection.
Check that the connection is valid by clicking on “Verify the DB connection”.
No restart is necessary.
9.2.6 UniViewer Management Server Connection If the UVMS connection is improperly configured the following message may be displayed: “REPORTER: Reporter Extraction Monitor on : Could not get last extraction source status: Unable to initiate a connection to the central server.connect: error creating socket.”
Go to Reporter Node settings.
Verify the field related to the UVMS connection.
Check that the connection is valid by clicking on “Validate UniViewer connection”.
A restart of the UVMS will be necessary.
9.2.7 Error in Custom Reports Custom reports may abort with the error “Process ABORTED. Status changed to ABORTED: Font 'sansserif' is not available to the JVM. See the Javadoc for more details”: this is due to an issue in iReport v3.0.0 (Reporter v3).
Make sure that you have installed and configured iReport v4.0.2 as explained in the chapter 5.4 of the Reporter User Manual.
For each custom report: o
Open the corresponding jasper file in iReport v4.0.2 (the file can be found in Reporter\data\reports\templates\custom\)
o
Save it as a jrxml file
o
Open the jrxml file with a text editor
o
Replace the font name 'sansserif' with 'SansSerif'
o
Save the jrxml file.
o
In iReport v4.0.2, load the jrxml file
o
Compile it
o
Copy the jasper file obtained in the folder Reporter\data\reports\templates\custom\.
Chapter 9 Reporter Troubleshooting | 63
9.3 Changing a Java Runtime Environment If the Java Runtime Environment is upgraded, the Reporter configuration must be modified as follows:
Edit the file: o
On Windows: /mgr/setenv.bat
o
On Linux: /mgr/setenv.sh
Modify the JAVA_ORSYP variable and set it to the path of the new JRE
Save the file
Stop and restart Reporter
64 | Chapter 10 Reporter V6 Data Model
10 Reporter V6 Data Model The data model is detailed below.
Figure 3: Reporter Server V6 Data Model
10.1 Functional Database Tables 10.1.1 UNI_EVT_AUDITTRAIL All interactive activity in Dollar Universe is traced in the audit trail file. Audit trail data is also stored in the Reporter database to enable the correlation of changes to parameters and variations in production activity.
Chapter 10 Reporter V6 Data Model | 65
The audit trail is not related to any particular launch or execution but is linked to a data source. Information about the Uproc/Session/MU can be retrieved from the AUDITTRAIL_KEY field of the audit trail. Elements are not duplicated (for example after two extractions). Elements in UNI_EVT_AUDITTRAIL are not purged by the Reporter purge tools. Column Name
Format
Description
AUDITTRAIL_ID
Number
This is the primary key.
DATASOURCE_ID
Number
This is a foreign key to the Node that generated the audit trail where the action took place.
AUDITTRAIL_DATE
Timestamp
Event date
AUDITTRAIL_USERSYSTEM
64 character string
System user under which the action took place
AUDITTRAIL_USERUNIVERSE
64 character string
Corresponding Universe proxy user
AUDITTRAIL_PROFILE
64 character string
Corresponding user profile
AUDITTRAIL_NODE
256 character string
Node from which an action was generated, but not necessarily where the action took place.
AUDITTRAIL_PROG
50 character string
Technical component used to carry out the action
AUDITTRAIL_ACTION
50 character string
Operation carried out by the component
AUDITTRAIL_OBJECT
50 character string
Type of target for the operation (eg Uproc, Session etc.)
AUDITTRAIL_KEY
256 character string
Target object identifier (Task name, etc).
AUDITTRAIL_MU
64 character string
Object sub-component (e.g. MU name extracted from the key)
AUDITTRAIL_SESSION
256 character string
Object sub-component (e.g. Session name extracted from the key)
AUDITTRAIL_UPROC
256 character string
Object sub-component (e.g. Uproc name extracted from the key)
10.1.2 UNI_EVT_DATASOURCES Data source information is held in the "UNI_EVT_DATASOURCES". Each time a new data source is encountered, it will be registered (Company, Node, Area triplet) in this table. The list of data sources is extracted from UniViewer Management Server at the beginning of each extraction. If a Node is present in the database and missing from UniViewer Management Server it will be flagged as deleted. Data sources flagged as deleted are ignored during report generation. Information from a data source is synchronized with UniViewer Management Server at the beginning of each extraction. All data elements except COMPANY_NAME, NODE_NAME, AREA_NAME are involved.
66 | Chapter 10 Reporter V6 Data Model
Column Name
Format
Description
DATASOURCE_ID
Numerical
An Auto-generated identification code. It is the primary key for this table.
PRODUCT_NAME
20 character string
Name of the software component (e.g. Dollar Universe, UniJob etc.)
PRODUCT_VERSION
10 character string
Software product version
COMPANY_NAME
6 character string
Picked up from the environment
COMPANY_LABEL
64 character string
Picked up from the DUAS Company table
NODE_NAME
64 character string
Picked up from the environment
NODE_LABEL
20 character string
Picked up from the DUAS Nodes table
AREA_NAME
1 character
Picked up from the environment
AREA_LABEL
64 character string
Picked up from the DUAS Area
TAG_NAME
900 character string
List of a Node's tags
UVMS_NAME
64 character string
UniViewer Management Server where the Node is registered
DELETED
Timestamp
Date that the Node was removed from the Management Server
10.1.3 UNI_EVT_INTERVENTIONS This table contains the Intervention History which has been much enriched in Dollar Universe v6.0. The Intervention History continues to log user actions (for example update a launch window or hold a future launch) that deviate existing future launches from their normal path. Dollar Universe Application Server v6 introduces exceptions which apply to launches that have not yet been calculated. Depending on the type of intervention many fields will not be populated. Actions engaged by the operator (hold, update etc.) on future launches that exist in the run list will be recorded in the HISTORY structure of this table. Exceptions positioned on launches that have not yet been generated will appear in the EXCEPT structure first and then in the HISTORY structure once the exception has been applied. Column Name
Format
Description
EXCEPTION_ID
Number
Table's primary key
DATASOURCE_ID
Number
FK to triplet COMPANY/NODE/AREA
HISTORY_OEXID_SUBTYPE
1 character string
History Subtype May be X (Exception, O (Outage) T (Optional Task) L (Legacy).
HISTORY_OEXID_PARENTTASK_NAME
64 character string
History Name of the parent task
HISTORY_OEXID_PARENTTASK_VERS
3 character string
History Version of the parent task
HISTORY_OEXID_PARENTTASK_MU
64 character string
History MU of the parent task
HISTORY_OEXID_SPECTASK_NAME
64 character string
History Name of the specific task
HISTORY_OEXID_SPECTASK_VERS
3 character string
History Version of the specific task
HISTORY_OEXID_SESSION_NAME
64 character string
History Session Name
HISTORY_OEXID_SESSION_VERS
3 character string
History Session version
HISTORY_OEXID_UPROC_NAME
64 character string
History Uproc name
HISTORY_OEXID_UPROC_VERS
3 character string
History Uproc version
HISTORY_OEXID_MUID_NAME
64 character string
History Management Unit Name c
HISTORY_OEXID_TYPUG
1 character string
History Management Unit Type
Chapter 10 Reporter V6 Data Model | 67
Column Name
Format
Description
HISTORY_OEXID_NUMLAUNCH
Number
History Launch number
HISTORY_OEXID_NUMSESSION
Number
History Session Number
HISTORY_OEXID_NUMPROC
Number
History Uproc execution number
EXCEPT_OEXID_TYPE
1 character string
Exception Type: May be H (History), X (Exception) or O (Outage).
EXCEPT_OEXID_SUBTYPE
1 character string
Exception Subtype: If type = H may be X (Exception, O (Outage) T (Optional Task) L (Legacy). If type= X may be B (Bypass condition check), S (Skip execution) F (Force completion) H (Hold) P (optional). If Type= O, may be G (General) T (MU Type) M (MU)
EXCEPT_OEXID_PARENTTASK_NAME
64 character string
Exception Name of the parent task
EXCEPT_OEXID_PARENTTASK_VERS
3 character string
Exception Version of the parent task
EXCEPT_OEXID_PARENTTASK_MU
64 character string
Exception MU of the parent task
EXCEPT_OEXID_SPECTASK_NAME
64 character string
Exception Name of the specific task
EXCEPT_OEXID_SPECTASK_VERS
3 character string
Exception Version of the specific task
EXCEPT_OEXID_SESSION_NAME
64 character string
Exception Session Name
EXCEPT_OEXID_SESSION_VERS
3 character string
Exception Session version
EXCEPT_OEXID_UPROC_NAME
64 character string
Exception Uproc name
EXCEPT_OEXID_UPROC_VERS
3 character string
Exception Uproc version
EXCEPT_OEXID_MUID_NAME
64 character string
Exception Management Unit Name c
EXCEPT_OEXID_TYPUG
1 character string
Exception Management Unit Type
EXCEPT_OEXID_NUMLAUNCH
Number
Exception Launch number
EXCEPT_OEXID_NUMSESSION
Number
Exception Session Number
EXCEPT_OEXID_NUMPROC
Number
Exception Uproc execution number
EXCEPT_VALIDITY_CONSUMED
1 character string
Maybe " " (not consumed) C (Consumed) set by IO Server
EXCEPT_VALIDITY_COUNTER
Number
Sets the number of times an exception can be applied.
EXCEPT_VALIDITY_STARTDATE
Timestamp
Start of validity window
EXCEPT_VALIDITY_ENDDATE
Timestamp
End of validity window
EXCEPT_VALIDITY_PROCESSDATE
Timestamp
Validity processing date filter
EXCEPT_VALIDITY_TYPE
1 character string
Validity criteria set by IO Server: 0 (no criteria), 1 (counter), 2 (time window), 3 (processing date), 4 (counter+time window), 5 (counter + processing date), 6 (time window + processing date), 7 (counter + time window+ processing date).
EXCEPT_LABEL
64 character string
Exception label
EXCEPT_OPTIONS_CREATEWEVENT
1 character string
Create event option for jump/optional exception.
HISTORY_APPLICATION_DATE
Timestamp
Date exception was applied
HISTORY_ORIGTYPE
1 character string
Type of intervention
68 | Chapter 10 Reporter V6 Data Model
Column Name
Format
Description
LAUNCH_ORIGIN_NUMPROC
Number
Numproc of launch to which the exception has been applied.
LAUNCH_ORIGIN_STATE
1 character string
State of launch when the exception was applied.
LAUNCH_ORIGIN_STARTDATE
Timestamp
Start of launch window when the exception was applied.
LAUNCH_ORIGIN_ENDDATE
Timestamp
End of launch window when the exception was applied.
LAUNCH_ORIGIN_PROCESSDATE
Timestamp
Processing date when the exception was applied.
LAUNCH_ORIGIN_NUMPROCRE
Number
Relaunch launch number
LAUNCH_ORIGIN_USER
64 character string
Origin submission account
LAUNCH_ORIGIN_PRIORITY
Number
Origin priority
LAUNCH_ORIGIN_QUEUE
31 character string
Origin batch queue name
OPTIONAL_TASK_NAME
64 character string
Name of Optional Task that generated an Exception history
OPTIONAL_TASK_VERS
3 character string
Version of Optional Task that generated an Exception history
OPTIONAL_TASK_TYPE
1 character string
Optional task type b (bypass) s (skip), h (hold) f (force completion) p (regular optional task) e (event creation only)
LEGACY ACTION
1 character string
May be H (Hold), B (Bypass) R (Release) L (Launch)
PROVOKED_TASK_NAME
64 character string
Name of Provoked Task that generated an Exception history
PROVOKED_TASK_VERS
3 character string
Version of Provoked Task that generated an Exception history
PROVOKED_TASK_UPD_PRIORITY
1 character string
Updated priority of Provoked Task that generated an Exception history
PROVOKED_TASK_UPD_PROCDATE
1 character string
Updated processing date of Provoked Task that generated an Exception history
PROVOKED_TASK_UPD_QUEUE
1 character string
Updated queue of Provoked Task that generated an Exception history
PROVOKED_TASK_UPD_USER
1 character string
Updated user of Provoked Task that generated an Exception history
10.1.4 UNI_EVT_JOBLOGS Job Log retrieval is optional. Logs of completed and/or aborted Jobs can be retrieved. The log may also have been truncated if in excess of a pre-determined size limit. Refer to the Reporter User Manual for configuration details in the section: “Reporter Node-Node Settings-Extraction Process Parameters”. Column Name
Format
Description
RELAUNCH_ID
Number
Table's primary key
JOBLOG
Text
This is the Job Log retrieved for the execution
Chapter 10 Reporter V6 Data Model | 69
10.1.5 UNI_EVT_MESSAGES Each Uproc execution phase may contain none or many messages generated in its log and history trace by the uxset msg command. Each message is time-stamped. Column Name
Format
Description
RELAUNCH_ID
Numerical
Auto-generated primary key
MESSAGE_TEXT
124 character string
The generated message
CREATION_TIMESTAMP
Timestamp
Time at which this message has been generated
10.1.6 UNI_EVT_PARAMETERS A Uproc may be launched with up to 30 positional parameters. Parameters are stored in the history file for recovery purposes. Column Name
Format
Description
RELAUNCH_ID
Numerical
Auto-generated primary key
PARAMETER_NAME
64 character string
The name used to designate the parameter
PARAMETER_VALUE
256 character string
The value given to the parameter during the execution
10.1.7 UNI_EVT_RELAUNCHES This paragraph details the tables designed to contain data generated during the execution of Jobs on target data sources. During the execution of a Job, certain elements may change: Step Number, Messages, Status, Parameters, and Variables. Only the last state (Info Severity, Status, Parameters and Variables) is accessible. This paragraph details the tables containing the data characterizing Job launches. Different “phases” of a Job share the same launch number. The central table in the data model is UNI_EVT_RELAUNCHES. This table contains data common to all executions of a given launch (i.e. all records with the same value in COMPANY/NODE/AREA/LAUNCH NUMBER). One launch may be associated with multiple executions (for example, in case of a re-launch due to unsatisfied conditions). Column Name
Format
Description
RELAUNCH_ID
Numerical
Auto-generated primary key
DATASOURCE_ID
Numerical
FK to triplet COMPANY/NODE/AREA
MANAGEMENT_UNIT_NAME
64 character string
Execution Management Unit
MANAGEMENT_UNIT_LABEL
64 character string
Management Unit label
MANAGEMENT_UNIT_OFFSET_HH
3 character string
Time zone offset hours from MU table
MANAGEMENT_UNIT_OFFSET_MM
2 character string
Time zone offset minutes from MU table
MANAGEMENT_UNIT_OFFSET_SIGN
1 character string
Time zone offset direction MU table
SESSION_NAME
64 character string
Session name
SESSION_LABEL
64 character string
Session label
SESSION_NODE
64 character string
Node on which the session is executed
SESSION_VERSION
3 character string
Version of the session
UPROC_NAME
64 character string
Uproc name
70 | Chapter 10 Reporter V6 Data Model
Column Name
Format
Description
UPROC_LABEL
64 character string
Uproc descriptive label
UPROC_TYPE
10 character string
Uproc Type
UPROC_VERSION
3 character string
Version of the Uproc
RANK_IN_SESSION
4 character string
Rank of the Uproc in the session
SESSION_NUM
7 character string
Session number common to all Uprocs in the same execution of the Session
LAUNCH_NUM
7 character string
Future launch generation counter
LAUNCH_NUM_ORIG
7 character string
Original launch counter
APPLICATION
64 character string
Uproc Application Code
PROCESSING_DATE
8 character string
Business date of the data being processed.
RELAUNCH_NUM
Numerical
Relaunch counter
ACCOUNT_NAME
64 character string
Submission user account
ACCOUNT_CODE
4 character string
Author code of the submission account
PRIORITY
4 character string
Queuing priority
QUEUE_NAME
31 character string
Batch queue name
QUEUE_ENTRY_NO
6 character string
Submission counter
STARTING_EVT_TIME
Timestamp
Time of 1st condition check
PENDING_EVT_TIME
Timestamp
Time of submission for execution
RUNNING_EVT_TIME
Timestamp
Start of execution time
ENDING_EVT_TIME
Timestamp
End of execution time
FINAL_STATUS
1 character string
Job completion status code
FINAL_EXECUTION_NUM
7 character string
Execution Number
FINAL_EXECUTION_NUM_ORIG
7 character string
Original Execution Number
FINAL_INFORMATION
50 character string
Information code at end of job
FINAL_SEVERITY
4 character string
Severity code at end of job
LAUNCH_WAIT_TIME
Timestamp
Start of launch wait time
COMPL_IN_PROGRESS_TIME
Timestamp
Start of completion in progress time
LAST_DISABLE_TIME
Timestamp
Time last disabled
LAST_ACKNOWLEDGE_TIME
Timestamp
Time of last user acknowledgement
EVT_WAIT_COUNT
Numerical
Number of launches ending in event wait
TASK_NAME
64 character string
Task identifier
TASK_VERSION
3 character string
Task version
SPECIFIC_TASK
64 character string
Associated Optional and Provoked tasks
MASK_FLAGS
Numerical
Column used to store the advanced status of a job run (Actions column in the Job Runs). The encoding of this column is owner.
EXEC_RETURN_CODE
Numerical
Execution return code
10.1.8 UNI_EVT_STATUSES
Chapter 10 Reporter V6 Data Model | 71
Column Name
Format
Description
STATUS_ID
Number
Table's primary key
STATUS_CODE
2 character string
Corresponds to the FINAL_STATUS in the Relaunches table
STATUS_LABEL
30 character string
Final status: “Completed”, “Aborted”, “Refused” or “Time overrun”.
10.1.9 UNI_EVT_VARIABLES A Uproc may contain up to 80 named variables with or without values. Variable values may be altered in the Task, manual launches or recovery transactions. Initial values may also have been altered during the execution of a Uproc by the uxset var command. Column Name
Format
Description
RELAUNCH_ID
Numerical
Auto-generated primary key
VARIABLE_NAME
256 character string
The name used to designate the variable
VARIABLE_VALUE
1024 character string
The value given to the variable during the execution
10.2 Technical Database Tables 10.2.1 UNI_EVT_EXTRACTIONS This table contains extraction historical data. Column Name
Format
Description
EXTRACTION_ID
Numerical
Auto-generated primary key
DATASOURCE_ID
Numerical
Reference to the primary key of the associated data source
START_TIMESTAMP
Timestamp
Starting date/time of the extraction
LAST_UPDATE_TIMESTAMP
Timestamp
Date/time of the last update of the extraction status
LAST_RECORD_TIMESTAMP
16 Character String
Date/time of the last execution extracted
LAST_AUDIT_TIMESTAMP
16 Character String
Date last audit record was extracted
LAST_OEX_TIMESTAMP
16 Character String
Date last intervention history record was extracted
RECORD_COUNT
Numerical
Number of items extracted
STATUS
30 Character String
Extraction status
LOG_ID
Numerical
Reference to the primary key of the associated log
EXTRACTION_SET_NAME
256 Character String
Extraction name (obsolete)
CONTINUOUS
Numerical
0 if it is a manual or scheduled extraction; 1 if it is generated by the Continuous Extraction Interval mechanism
10.2.2 UNI_EVT_LOG This table contains progress messages for Reports, Purges and Extractions.
72 | Chapter 10 Reporter V6 Data Model
Column Name
Format
Description
LOG_ID
Numerical
Auto-generated primary key
MESSAGE
4000 Character String
TYPE
Numerical
10.2.3 UNI_EVT_PURGES This table contains purge historical data. Column Name
Format
Description
PURGE_ID
Numerical
Auto-generated primary key
PURGE_TYPE
256 character string
Always manual
START_TIMESTAMP
Timestamp
Starting date/time of the purge
LAST_UPDATE_TIMESTAMP
Timestamp
Date/time of the last update of the purge status
RECORD_COUNT
Numerical
Number of items purged
END_TIMESTAMP
Timestamp
Ending date/time of the purge
STATUS
30 Character String
Purge status
LOG_ID
Numerical
Reference to the primary key of the associated log
10.2.4 UNI_EVT_REPORTS This table contains report generation historical data. Column Name
Format
Description
REPORT_ID
Numerical
Auto-generated primary key
REPORT_DEFINITION_NAME
512 character string
Report name (manually defined in the case of one off reports)
REPORT_TEMPLATE_NAME
512 character string
Template name
START_TIMESTAMP
Timestamp
Starting date/time of the report generation
END_TIMESTAMP
Timestamp
Ending date/time of the report generation
STATUS
30 Character String
Status of the report generation
LOG_ID
Numerical
Reference to the primary key of the associated log
OUTDATED_NODES_COUNT
Numerical
Number of nodes not updated
Chapter 10 Reporter V6 Data Model | 73
10.2.5 UNI_TECH_REPORTS This technical table simplifies the report generation process. Column Name
Format
Description
TECH_ID
Numerical
Auto-generated primary key
DAY_HOUR
Numerical
List of the hours in the day
WEEK_DAY
Numerical
List of the days in the week
WEEK_DAY_NAME
10 Character String
Name of the weekday
YEAR_MONTH
Numerical
List of the months in the year
YEAR_MONTH_NAME
10 Character String
Name of the month
74 | Chapter 11 About Automic Software, Community and Services
11 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.
11.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 .
11.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!
11.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.
Chapter 11 About Automic Software, Community and Services | 75
11.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.
11.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.
