System PrincipleTable of Contents i.........................................................................................Chapter 1 Overview 1-1......................................................................................
1.1 How to Use This Manual 1-1...................................................................1.2 Environment Requirement 1-2................................................................
Chapter 2 System Principle 2-1..........................................................................2.1 System Principle 2-1...............................................................................
2.1.1 Overview 2-1...................................................................................2.1.2 Glossary 2-1...................................................................................
2.2 Architecture of the Report System 2-2....................................................2.2.1 Architecture of the Report System 2-2............................................2.2.2 Operation flow of report system 2-4................................................2.2.3 The files involved in the report system 2-4.....................................
2.3 Functions of the Report System 2-5........................................................2.4 Overview of the Authority Management 2-2............................................2.5 System Management Functions 2-4.......................................................
2.5.1 Overview 2-4...................................................................................2.5.2 Functions 2-5..................................................................................
2.6 Attributes 2-11...........................................................................................2.7 Report Generating Process 2-13..............................................................
2.7.1 Measurement and Generating Process 2-13....................................2.7.2 Realization Principle of Report System 2-15....................................
Client ManagementTable of Contents i.........................................................................................Chapter 1 Installation and Operation of Report System Client 1-1.....................
1.1 Installing the Report System Client 1-1...................................................1.2 Running the Report System Client 1-2....................................................
1.2.1 Starting the Report System Client 1-2............................................1.2.2 Logging in to the Report System 1-3..............................................1.2.3 Introduction to the Report System Client Manager 1-5...................
Chapter 2 Public Functions of the Report System Client 2-1.............................2.1 Public Functions of the Report System Client 2-1...................................
2.1.1 Switching User Groups 2-1.............................................................2.1.2 Switching Users 2-1........................................................................2.1.3 Changing the Password of the Current User 2-1............................2.1.4 Querying the Current System Information 2-2................................
2.2 Editing, Viewing and Help Functions 2-4................................................2.3 Auxiliary Tools of the Report System 2-4................................................
2.3.1 Schedule Monitor 2-4......................................................................
2.3.2 Backing up and Restoring the System 2-6.....................................2.3.3 Clearing the Local Data File 2-10.....................................................
Chapter 3 User and User Group Management 3-1............................................3.1 User Group Management 3-2.................................................................
3.1.1 Creating a User Group 3-2.............................................................3.1.2 Modifying a User Group 3-5............................................................3.1.3 Deleting a User Group 3-6..............................................................
3.2 User Management 3-6............................................................................3.2.1 Creating a User 3-6........................................................................3.2.2 Modifying a User 3-10.......................................................................3.2.3 Deleting a User 3-12.........................................................................3.2.4 Unblocking a User 3-12....................................................................3.2.5 Activating a User 3-13......................................................................3.2.6 Deactivating a User 3-13..................................................................
Chapter 4 Datasource Management 4-1............................................................4.1 Datasource Management 4-2..................................................................
4.1.1 Creating a Datasource 4-2..............................................................4.1.2 Modifying a Datasource 4-5............................................................4.1.3 Deleting a Datasource 4-6..............................................................4.1.4 Setting a Usable Proxy Server for a Datasource 4-7......................
4.2 Table Management 4-8...........................................................................4.2.1 Creating a Table 4-8.......................................................................4.2.2 Modifying a Table 4-12.....................................................................4.2.3 Deleting a Table 4-13.......................................................................4.2.4 Getting All Tables Automatically 4-13...............................................
4.3 Stored Procedure Management 4-15........................................................4.3.1 Adding a Stored Procedure 4-15......................................................4.3.2 Importing Fields of a Stored Procedure 4-20....................................4.3.3 Modifying a Stored Procedure 4-21..................................................4.3.4 Deleting a Stored Procedure 4-22....................................................4.3.5 Getting All Stored Procedures Automatically 4-23............................
4.4 Range List Management 4-25...................................................................4.4.1 Creating a Range List 4-25...............................................................4.4.2 Modifying a Range List 4-31.............................................................4.4.3 Deleting a Range List 4-32...............................................................
4.5 Database Proxy Server Management 4-33...............................................4.5.1 Creating a Database Proxy Server 4-33...........................................4.5.2 Modifying a Database Proxy Server 4-35.........................................4.5.3 Deleting a Database Proxy Server 4-36...........................................
Chapter 5 Report and Template Management 5-1.............................................5.1 Template Group Management 5-2..........................................................
5.1.1 Creating a Template Group 5-2......................................................5.1.2 Modifying a Template Group 5-3....................................................5.1.3 Deleting a Template Group 5-4......................................................5.1.4 Changing to Folder 5-4...................................................................5.1.5 Backing up and Restoring a Template Group 5-5..........................
5.2 Sub-template Group Management 5-6....................................................5.2.1 Creating a Sub-template Group 5-6................................................5.2.2 Modifying a Sub-template Group 5-8..............................................5.2.3 Deleting a Sub-template Group 5-9................................................5.2.4 Changing to Folder 5-9...................................................................
5.3 Template File Management 5-9..............................................................5.3.1 Creating a Template File 5-9..........................................................5.3.2 Modifying a Template File 5-12........................................................5.3.3 Deleting a Template File 5-13...........................................................5.3.4 Downloading a Template File 5-14...................................................5.3.5 Uploading a Template File 5-14........................................................5.3.6 Upgrading a Template File 5-15.......................................................5.3.7 Changing to Folder 5-16...................................................................
5.4 Scheduled Task Management 5-16..........................................................5.4.1 Creating a Scheduled Task 5-16......................................................5.4.2 Modifying a Scheduled Task 5-20....................................................5.4.3 Deleting a Scheduled Task 5-21.......................................................
5.5 Report Query and Management 5-22.......................................................5.5.1 Designing a Template File 5-22........................................................5.5.2 Querying a Template File 5-23.........................................................5.5.3 Displaying a Report File 5-25...........................................................5.5.4 Deleting a Report File 5-26...............................................................5.5.5 Copying a Report File 5-26...............................................................
Introduction to Report DesignerTable of Contents i.........................................................................................Chapter 1 Introduction to Report Designer 1-1...................................................
1.1 Main Menu of Report Designer 1-1.........................................................1.2 Toolbar 1-4..............................................................................................1.3 Font Tools 1-5.........................................................................................1.4 Report Object Bar 1-5.............................................................................
1.4.1 What is An Object Bar 1-5..............................................................1.4.2 Report Band- 1-6............................................................................1.4.3 Sub Report- 1-8..............................................................................1.4.4 Rectangle Text Object- 1-8.............................................................1.4.5 Picture- 1-14.....................................................................................
1.4.6 Scribe- 1-14......................................................................................1.4.7 Chart- 1-14........................................................................................1.4.8 Shadow Rectangle Object 1-17........................................................1.4.9 Shapes- 1-18....................................................................................1.4.10 Introduction to Object Inspector 1-20..............................................
1.5 Alignment Toolbar 1-22.............................................................................1.6 Report Preview Toolbar 1-23....................................................................
Chapter 2 Report Design 2-1..............................................................................2.1 Entering the Report Designer Window 2-1..............................................2.2 Datasource Manager- 2-2.......................................................................
2.2.1 Overview 2-2...................................................................................2.2.2 Define data source 2-4...................................................................
2.3 Set Variables- 2-16...................................................................................2.4 Customizing Advanced Properties of Query Field- 2-18...........................2.5 Customizing Advanced Properties of Sorting- 2-22..................................2.6 Creating a Macro- 2-23.............................................................................2.7 Setting the Report Query Window- 2-26...................................................2.8 Editing the Report Note 2-27.....................................................................2.9 Report Template Builder- 2-28..................................................................2.10 Adding Statistic Charts into the Report- 2-30..........................................2.11 Querying the Statistic Report 2-31..........................................................
Collection of Original DataTable of Contents i.........................................................................................Chapter 1 Collection of Original Data 1-1...........................................................
1.1 Index Table Mapping 1-1........................................................................1.1.1 M2000 Performance Database Table Structure 1-1.......................1.1.2 M2000 Configuration Database Table Structure 1-3......................1.1.3 Report Data Mapping 1-3...............................................................
1.2 Measurement Task Registration 1-5.......................................................1.2.1 Registering Measurement Task 1-5................................................1.2.2 Object Selection for Multi-object Parameter Structure 1-9.............
1.3 Data Source Configuration 1-14................................................................1.3.1 Adding Data Source 1-14.................................................................1.3.2 Defining Query Wizard 1-15.............................................................
Report Customization ExamplesTable of Contents i.........................................................................................Chapter 1 Report Customization Examples 1-1.................................................
1.1 Report Making Process 1-1.....................................................................1.2 Customizing Reports 1-1.........................................................................
1.2.1 Specifying Report Requirements 1-2..............................................1.2.2 Specifying How to Realize Indices 1-2...........................................1.2.3 Registering Traffic Measurement Tasks 1-3...................................1.2.4 Defining Data Source 1-3...............................................................1.2.5 Customizing Report Templates 1-5................................................
System MaintenanceTable of Contents i.........................................................................................Chapter 1 System Maintenance 1-1...................................................................
1.1 System Database Maintenance 1-1........................................................1.1.1 Multiple Database Support 1-1.......................................................1.1.2 System Database Table Structure 1-2............................................
1.2 Service Program Description 1-6............................................................1.3 JVM Memory Management 1-7...............................................................
1.3.1 JVM Memory Management in Resin 1-8........................................1.3.2 JVM Memory Management in JDK 1-8...........................................
1.4 View Report Log 1-9...............................................................................1.5 System Fault Maintenance 1-10...............................................................
1.5.1 Fault Maintenance for System Midware 1-10...................................1.5.2 Fault Maintenance of Database Proxy Server 1-12..........................
Installation of Report SystemTable of Contents i.........................................................................................Chapter 1 Installation of Report System 1-1.......................................................
1.1 Overview 1-1...........................................................................................1.1.1 System Components 1-1................................................................1.1.2 System Structure and Path 1-1.......................................................1.1.3 Preparations 1-2.............................................................................
1.2 Install Intelligent Report System Software in UNIX 1-3...........................1.2.1 Installation Flowchart 1-3................................................................1.2.2 Create Directory 1-4.......................................................................1.2.3 Upload Files 1-4..............................................................................1.2.4 Unpackage 1-6...............................................................................1.2.5 Create Database 1-6......................................................................1.2.6 Install New System 1-8...................................................................1.2.7 Copy "license" File 1-17....................................................................1.2.8 Set Report Database Information 1-17.............................................1.2.9 Set Service Database Information 1-18............................................1.2.10 Copy Template File 1-18................................................................1.2.11 Start System 1-19...........................................................................1.2.12 Install Client Program 1-19.............................................................
1.2.13 Clear Local Temporary Files 1-19..................................................1.2.14 Register System Tasks 1-19...........................................................1.2.15 Shut Down System 1-20.................................................................
1.3 Upgrade the Intelligent Report System 1-20.............................................1.3.1 Shutdown Old System 1-20..............................................................1.3.2 Back up Data 1-20............................................................................1.3.3 Upgrading 1-21.................................................................................1.3.4 Failure Handling 1-24.......................................................................
AppendixTable of Contents i.........................................................................................Appendix A Conventional SQL Statements A-1..................................................
A.1 Query Type A-1.......................................................................................A.1.1 Simple Query A-1...........................................................................A.1.2 Connection Query A-1....................................................................A.1.3 Subquery A-2..................................................................................
A.2 Aggregation Function, Grouping and Sequencing A-2............................Appendix B Description of Multi-object Parameter Structure B-1.......................Appendix C Abbreviations C-1............................................................................
HUAWEI
1.System Principle
2.Client Management
3.Introduction to Report Designer
4.Collection of Original Data
5.Report Customization Examples
6.System Maintenance
7.Installation of Report System
8.Appendix
iManager M2000 Intelligent Report System User Manual
V100R005
iManager M2000 Intelligent Report System
User Manual
Manual Version T2-030168-20030810-C-1.51
Product Version V100R005
BOM 31013268
Huawei Technologies Co., Ltd. provides customers with comprehensive technical support and service. Please feel free to contact our local office, customer care center or company headquarters.
Huawei Technologies Co., Ltd.
Address: Administration Building, Huawei Technologies Co., Ltd.,
Bantian, Longgang District, Shenzhen, P. R. China
Postal Code: 518129
Website: http://www.huawei.com
Email: [email protected]
Copyright © 2003 Huawei Technologies Co., Ltd.
All Rights Reserved
No part of this manual may be reproduced or transmitted in any form or by any means without prior written consent of Huawei Technologies Co., Ltd.
Trademarks
, HUAWEI, C&C08, EAST8000, HONET, , ViewPoint, INtess, ETS, DMC,
TELLIN, InfoLink, Netkey, Quidway, SYNLOCK, Radium, M900/M1800, TELESIGHT, Quidview, Musa, Airbridge, Tellwin, Inmedia, VRP, DOPRA, iTELLIN, HUAWEI OptiX, C&C08 iNET, NETENGINE, OptiX, SoftX, iSite, U-SYS, iMUSE, OpenEye, Lansway, SmartAX are trademarks of Huawei Technologies Co., Ltd.
All other trademarks mentioned in this manual are the property of their respective holders.
Notice
The information in this manual is subject to change without notice. Every effort has been made in the preparation of this manual to ensure accuracy of the contents, but all statements, information, and recommendations in this manual do not constitute the warranty of any kind, express or implied.
About This Manual
Version
The product version corresponds to the manual is iManager M2000 Mobile Network Management System-V100R005.
Organization of the Manual
This manual details the philosophy of the intelligent report system, Client management, installation and maintenance of the system. It is divided into 6 chapters, followed by the appendices.
Module 1 System Principle introduces some basic concepts of the system, statistics and generation of reports, logical structure of the system and its functions.
Module 2 Client Management covers the contents of user/user group management, data dictionary management and authorization management.
Module 3 Introduction to Report Designer gives the idea of unitizing the tool to create reports.
Module 4 Collection of Original Data includes three parts: Item table mapping, measurement task registration and data source configuration.
Module 5 Report Customization Examples details the procedure of defining a report.
Module 6 System Maintenance Module 7 Installation of Report System Module 8 Appendix covers the Conventional SQL Statements, Description of
Multi-object Parameter Structure, and Abbreviations.
Target Readers
The manual is intended for the following readers:
Marketing staff Technical engineers & technicians Operation & maintenance personnel
Conventions
This manual uses the following conventions:
I. General conventions
Convention Description
Arial Normal paragraphs are in Arial.
Arial Narrow Warnings, Cautions, Notes and Tips are in Arial Narrow.
Boldface Headings are in Boldface.
Courier New Terminal Display is in Courier New.
II. Command conventions
Convention Description
Boldface The keywords of a command line are in Boldface.
italic Command arguments are in italic.
[ ] Items (keywords or arguments) in square brackets [ ] are optional.
{ x | y | ... } Alternative items are grouped in braces and separated by vertical bars. One is selected.
[ x | y | ... ] Optional alternative items are grouped in square brackets and separated by vertical bars. One or none is selected.
{ x | y | ... } * Alternative items are grouped in braces and separated by vertical bars. A minimum of one or a maximum of all can be selected.
[ x | y | ... ] * Optional alternative items are grouped in square brackets and separated by vertical bars. Many or none can be selected.
III. GUI conventions
Convention Description
< > Button names are inside angle brackets. For example, click <OK> button.
[ ] Window names, menu items, data table and field names are inside square brackets. For example, pop up the [New User] window.
/ Multi-level menus are separated by forward slashes. For example, [File/Create/Folder].
IV. Keyboard operation
Format Description
<Key> Press the key with the key name inside angle brackets. For example, <Enter>, <Tab>, <Backspace>, or <A>.
Format Description
<Key1+Key2> Press the keys concurrently. For example, <Ctrl+Alt+A> means the three keys should be pressed concurrently.
<Key1, Key2> Press the keys in turn. For example, <Alt, A> means the two keys should be pressed in turn.
V. Mouse operation
Action Description
Click Press the left button or right button quickly (left button by default).
Double Click Press the left button twice continuously and quickly.
Drag Press and hold the left button and drag it to a certain position.
VI. Symbols
Eye-catching symbols are also used in the manual to highlight the points worthy of special attention during the operation. They are defined as follows:
Caution, Warning, Danger: Means reader be extremely careful during the
operation.
Note, Comment, Tip, Knowhow, Thought: Means a complementary description.
Environmental Protection
This product has been designed to comply with the requirements on environmental protection. For the proper storage, use and disposal of this product, national laws and regulations must be observed.
HUAWEI
iManager M2000 Intelligent Report System User Manual
System Principle
User Manual iManager M2000 Intelligent Report System
System PrincipleTable of Contents
i
Table of Contents
Chapter 1 Overview....................................................................................................................... 1-1 1.1 How to Use This Manual.................................................................................................... 1-1 1.2 Environment Requirement ................................................................................................. 1-2
Chapter 2 System Principle.......................................................................................................... 2-1 2.1 System Principle ................................................................................................................ 2-1
2.1.1 Overview ................................................................................................................. 2-1 2.1.2 Glossary .................................................................................................................. 2-1
2.2 Architecture of the Report System..................................................................................... 2-2 2.2.1 Architecture of the Report System .......................................................................... 2-2 2.2.2 Operation flow of report system .............................................................................. 2-4 2.2.3 The files involved in the report system.................................................................... 2-4
2.3 Functions of the Report System ........................................................................................ 2-5 2.4 Overview of the Authority Management ............................................................................ 2-2 2.5 System Management Functions ........................................................................................ 2-4
2.5.1 Overview ................................................................................................................. 2-4 2.5.2 Functions................................................................................................................. 2-5
2.6 Attributes.......................................................................................................................... 2-11 2.7 Report Generating Process ............................................................................................. 2-13
2.7.1 Measurement and Generating Process ................................................................ 2-13 2.7.2 Realization Principle of Report System................................................................. 2-15
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 1 Overview
1-1
Chapter 1 Overview
1.1 How to Use This Manual
This manual mainly includes the following parts:
Module 1 System Principle
This module mainly describes the basic concepts concerning the IN report system so that the user can learn about this system on such aspects as its statistics generation process, logical structure, functions and interfaces it provides, and how to create a report which is a common concern among users.
Module 2 Client Management
This module describes user / user group management, data dictionary management and authority management.
Module 3 Collection of Original Data
This is the preparation for report creation, including three parts: index table mapping, measurement task registration and data source configuration.
Module 4 Introduction to Report Desginer
The report designer is the report editing environment. Here you must use tools to complete the basic design of report style, which is the premise for final report output. You cannot create complicated reports without this report designer.
Module 5 Report Customization Examples
Based on the report principles, this module describes how to realize a report requirement and guides the user to customize reports, namely, it provides an example to demonstrate the detailed report customizing procedures.
Module 6 System Maintenance
Report system maintenance is carried out on the following aspects:
1) System database maintenance 2) System service program maintenance 3) Memory management of Java virtual machine (JVM) 4) System troubleshooting
Module 7 Installation of Report System
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 1 Overview
1-2
It describes the installation procedures of the report server software, including the installation of report server software and report server Patch, server unloading, upgrading and configuration, as well as the installation and configuration of independent database proxy server.
Appendix A Conventional SQL Statements
SQL statements may be used when you create a query. This part briefly describes the use of some conventional statements.
Appendix B Description of Multi-object Parameter Structure
It is very necessary to understand the multi-object parameter structure. You may use this structure when you register a measurement task (If multiple object members are involved).
Appendix C Abbreviations
1.2 Environment Requirement
The report system requires JDK1.3 or above. JDK is the product developed by the third party, and JDK1.3 raises the demands for different operating systems as follows:
For the Solaris operating system, Solaris2.6, Solaris2.7 or Solaris2.8 is available. In the installation package, the JDK1.3 package and its corresponding patch package are provided.
For the HP-UX operating system, HP-UX 11.0 or above is required. For the IBM's AIX operating system, AIX4 or AIX5 is required. For the Windows operating system, Windows 98, Windows 2000, or Windows NT
4.0 or above is required.
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-1
Chapter 2 System Principle
2.1 System Principle
2.1.1 Overview
The Intelligent Report System is a set of powerful data mining tools. Relying on this system, the user can design adequate report templates, extract expected data from the specified database, then summarize and calculate these data so as to display and output meaningful reports, through which the user can easily get all data of the service system and then make analysis and decisions.
iManager M2000 can quickly trace the users’ requirement for reports and customize the right report system, which can save enormous workload for maintenance personnel in report designing. The system automatically analyzes all original data and outputs statistics reports on the daily or monthly basis, which minimizes the possibility of data error occurrence caused by manual intervention and makes the data accurate and convincing.
2.1.2 Glossary
The common glossary of Intelligent Report System is as Table 2-1 shown.
Table 2-1 Glossary
Glossary Description Report client The report client provides the interfaces of the system administration, report template
design and report query for the report system. Report server It is used to handle the service request from the report client, and meanwhile returns
the corresponding result to the client. The data collection request will be forwarded to the database proxy server.
Database Proxy Server It is used to collect the data form the service database, and transmit the result to the report server in batch, and then the report server will return the result to the report client.
System database The system database is used to store such system data of the report system as the user information, user group information, database proxy server information, datasource information, data dictionary of the business data. The system database can be accessed via the report server.
Template file The template file is used to define the format of a report, as well as the binary file of datasource required to be accessed in the format *.FRF. Generally, the template file is stored in the report server. The report client can keep a copy of the template file.
Report file The report file of the report system is a binary file, which is generated after the report is queried. It includes the report elements like the table, data and statistic chart in the *.FRP format. The report file can be viewed with a report browser.
License file The license file is the encrypted text configuration file to control the system authority. It will be released to users after it is configured by Huawei personnel.
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-2
Glossary Description Report browser The report browser is a stand-alone program for browsing the report file. With the
browser, the report file generated by the report system can be viewed.
2.2 Architecture of the Report System
2.2.1 Architecture of the Report System
The report system can be divided into three parts, the report client, the report server, and database proxy server. These three parts coordinately access the service database opened by the service system. The architecture of the system is shown in Figure 2-1.
Report client
Report client
Report client
Report client
Report server
Systemdatabase
JDBC mode
Database proxyserver
Database proxyserver
Database proxyserver
Servicedatabaes
Servicedatabase
Servicedatabase
Servicedatabase
N:1 1: N M:NWindows+ IE UNIX/Windows NT UNIX/Windows NT UNIX/Windows NT
HTTP mode Socket mode JDBC mode
Figure 2-1 Architecture of the report system
From the figure, it is known that only a report server is allowed in the report system, whereas multiple report clients in the system. The report server establishes the licensing mechanism, and meanwhile the number of the clients connected to the report server cannot exceed to the number of Licenses. Multiple database proxy servers are available here. Each database proxy server is permitted to access multiple service databases, that is, each service database can be accessed by multiple database proxy servers.
The functions of the main components are as follows:
1) Report client
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-3
The report client is composed of the following elements:
Client management program
It includes the user, datasource, database proxy server, report and report template of the management system.
Report template designer A user can use the report template designer to design a report template file.
Report query condition setting Interface
A user can set the query condition for a report in the report query condition setting interface.
Report template browser
A user can use the report template browser to view the report generated in the report system.
2) Report server
The report server is composed of the following elements:
Support software
Such as JAVA SDK (1.3.0 or above)
System management software
The system management software can deal with the commands sent from the client management program and report designer to the report server, such as login, modifying the datasource and downloading the report file, etc.
Data query software
It can receive the data query request from the client, communicate with the database proxy server to fetch the result and return it to the client.
3) Database proxy server
The database proxy server can only realize the single function of accessing the database and fetch the query result.
4) Report system database
The system database stores the information of the report system, including the user and authority information, definition of the data dictionary, template file material and other relevant information. The system database adopts the large relationship database, such as Informix, Oracle, SQL Server and Sybase. The report system database provides a working platform for the report server.
5) Service system database
The service system database is the business data source of report system.
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-4
2.2.2 Operation flow of report system
The common flow is as follows:
1) A user downloads the report client program from the report server via the network and installs it, and then logs in to the report server via HTTP.
2) The user sends a quest to access the service database, then the report server reads the service database information and database proxy server information from the system database after having received the request, and distributes the request to a database proxy server according to the information it has read.
3) The database proxy server accesses the service database and returns the result to the report server, then the report server packs the result and returns it to the report client, and finally the client generates a report according to the data and displays it.
Note:
HTTP is adopted in the communication between the report client and the report server, and Socket between the report server and the database proxy server. The database proxy server accesses the service database via JDBC.
2.2.3 The files involved in the report system
1) Log file
The log file is used to record the operation information and error information, and it is installed in the log sub-directory of the installation directory in the report server.
2) Template file
The template file is stored in the file system of the report server, and its information is recorded in the system database. The file is transmitted via HTTP to the report client.
3) Local template file
The local template file is stored in the file format on the local machine.
4) Report file
The report file is stored in the file format on the local machine. The file in common format can be exported from the report file.
Including:
HTML (*.htm and *.html) TXT (*.txt) EXCEL (*.xls)
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-5
2.3 Functions of the Report System
The report system is a completely stand-alone system, where the authority and files can be administered, and the report creation for the service database can be conducted by accessing the service database.
The report server is the kernel element of the report system, and it provides the webpage development to the outside and binds the report service program. A user can access this webpage via a browser, and perform the installation by downloading the installation package of client software. After the installation, the user can log in to the report service program via the client software to obtain the services provided by the server including the user management, datasource management, report and template management.
I. User management
The administrator can create or modify users or user groups for the report system, and maintain the user relationship of the system, which is described in detail in the following.
1) The administrator can create a series of user group with each user group corresponding to a service (with the License file of each service to distinguish the services).
2) The administrator can grant the authorities to the user group such as which data source and template can be accessed, and how much can be applied in the access.
3) The administrator can create a series of users, each of whom belongs to one or multiple user groups.
When a user wants to log in to the report system, he should type his ID and password, and select the corresponding working user group.
II. Datasource management
The administrator needs to write the architecture information of the service database to be dealt into the datasource, and he will design the report template file based on these datasource definitions. Meanwhile, the datasource administrator needs to configure the datasource information on the basis of the database proxy server installation of the system, and allocate the database proxy servers employed by each datasource in the access.
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-1
Note:
The information of a datasource includes the content as follows: 1) The basic information of the datasource such as the IP address and the port of the server where the datasource is located, type of the database (e.g. Oracle, Informix, etc.), database name, login ID and password. Via the above information, the system can access the business data. 2) The information about the table and stored procedure of the datasource 3) Defining which of the proxy programs the system can use to access the datasource.
III. Report management
The report management is similar to the file management, and it aims at managing the report template file, report file and relevant data file.
The design and query of reports involve the database proxy server. A user can design the report template file and store it in the home directory of the report service program. These template files are called in the query, and the service databases are accessed according to the designed content of the template files. Among them, the report service program is responsible for sending and receiving the data, whereas the database proxy server aims at the business data collection.
The report template file includes two parts: the format and the datasource definition. The format of the report is used to define the appearance of the report, such as the header, footer and heading. The datasource definition of the report is used to define the tables or the stored procedures of a certain datasource to be accessed, and these tables and stored procedures should return a result set, which the system employs to generate a report.
The report file is a binary file, which is generated by the system after the template file has obtained the data. Its content includes two parts: format of the report and the data of the report.
Note:
The relevant data information of the management of user, datasource and template is stored in the system database.
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-2
2.4 Overview of the Authority Management
I. Classification of the authority management
A user logged in to the report system can manage users, datasources and reports. So the authority management can be divided into three types, namely, user management, datasource management and report management.
User management authority: With the authority, a user can create, modify or delete a user group, user, authorize a user or change the home user group of a user, or manage an online user.
Datasource management authority: With the authority, a user can create, modify or delete the datasource, table or database proxy server, stored procedure or range, configure the database proxy server for the datasource, and fetch the datasource information from the service database system.
Report management authority: With the authority, a user can create, modify or delete the report template file, design a template file, and get a report by querying the template.
II. Authority level
For each kind of authority, it can be classified into four levels in an ascending order, namely, no right, read only, read/write and full rights.
No right: There is no authority at all. Read only: Relevant information can be viewed. For the report management, the
authority is to query reports only. Read/write: The relevant information can be modified, but cannot be created,
deleted and renamed. Full rights: It means any operation can be performed.
III. User authority management mechanism
The report system supports the independent authority management mechanism, and it adopts the user group-user mode.
In general, there are multiple user groups existing in the report system, and each user group can handle only service, that is, it corresponds to a License file.
There are also multiple users in the report system, and each user can conduct the management to the users, datasources and reports after he logs in to the report system via the report system client.
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-3
Note:
1) In the initialization, the system has created the super user group administrators and the super user admin. During the course of the report system operation, a user can create a new user group and user. 2) Administrators and admin are prohibited from being deleted. Except admin, other users cannot modify the properties of administrators and admin.
IV. Relationship between the user group authority and the user authority
A user group is granted a certain authority to the user management, datasource management and report management, which is known as user group authority. The user group authority is granted when the user group is created.
Accordingly, a logged in user granted with the authority of user management, datasource management and report management is known as user authority. The user authority refers to the authority available in the user’s home group. And it is authorized to the user when the user is added to the group, and it spares no possibility of being higher than the authority of the group.
Note:
1) The user authority is the subset of the user group authority of the home group, that is, the authority of the user should be no more than that of his home user group. 2) Both the user group authority and the user authority are limited by License.
A user may fall into multiple user groups, but when he intends to log in to the report system, he can select only a user group. For the details, please refer to Section 1.2.2 “Logging in to the Report System” of Client Management module. Then the current authority of the user is that of the current user group.
Example:
There is a user a, and he belongs to two user groups, A and B, simultaneously. The authorities of A and B and the authorities of a in A and B are shown in Table 2-2.
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-4
Table 2-2 Relevant authorities of user “a”
Authority category Report management authority
User management authority
Datasource management
authority Authority of user group A Read-only Full rights Full rights Authority of user group B Full rights Read-only Read-only Authority of user a in user group A No right Read/Write Read/Write Authority of user a in user group B Read/Write No right No right
When “a” logs in to the report system, if he selects user group A, he will have the same authority as user group A; if he selects user group B, then he has the same authority as user group B.
Note:
In the report system and the user manual, a certain user’s (or a user group’s) authority sometimes may be described in a format similar to “1/3/2”. Each number represents a kind of authority, and they respectively represent the report management authority, user management authority and datasource management authority from the left to right. The value range of each number is from 0 to 3, respectively corresponding to four authority levels, no right, read-only, read/write and full rights in an ascending order. So, 1/3/2 means that a user’s (or a user group’s) report management authority is read-only, the user management authority is full rights, and the datasource management authority is read/write.
2.5 System Management Functions
2.5.1 Overview
The Intelligent Report System has powerful customization and statistical functions, mainly including:
Powerful report design function Flexible report customization function Convenient report statistics Independence from the service system Supplying report browser Supporting the distributed large-capacity service system Various report I/O formats Strict authority control Security guarantee Supporting multiple data sources access
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-5
2.5.2 Functions
I. Powerful report design function
With the report design function provided by the Report System, report template files in a fixed format can be designed and called by different users, which avoids design duplication.
Besides, report designers can create, modify, delete or save report template files any time. The report template files can be conveniently updated and distributed in time. The operator can select any report template file within his authority and execute report statistics. This is applicable for all common report formats at any complication degree.
During report designing, the preview function is supported, which enables the designer to get a general view of the report being designed at any time and zoom the report as required. When the report format is designed, the report content can be designed conveniently according to the detailed statistics.
Data of each report can be directly queried through the defined SQL statement or obtained by the invoked store procedure.
II. Flexible report customization function
The system provides simple report customization functions for report designers who may not well understand the SQL and the store procedures.
The report customization interface is like a Wizard interface, which guides the user to fill in the related information step by step and generate a report conveniently. When the report is invoked again, the user can modify the customization information directly without repeating the configuration.
The flexible report customization functions include:
SQL customization
Through SQL customization function, you can select related data information and corresponding query conditions (one or more) from the data information list. Once the data information is selected, the report tool can automatically generate the corresponding SQL statement.
Customize store procedure invocation
Through invocation customization, user can select store procedures in the store procedure list provided by the report tool, and display the corresponding input parameters and output fields. Once a store procedure is selected, the report tool can automatically generate the statistics contents including the SQL statements for the invocation of this store procedure.
Customization of report output contents
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-6
The system provides a function to customize the statistics fields corresponding to a report, so you can decide which fields to be output and which fields not, as well as the field display order, etc. You can customize the output contents of a report as required.
III. Convenient report statistics
The system provides convenient report statistics functions enabling the user to perform report statistics conveniently and efficiently.
Graphic display function
For report statistics data, the system provides the graphic display function, which can display the detailed changes of the statistics and query data. The graphic display modes include graph, histogram, and pie chart, etc. The graph color can be set. The data change tendency can be shown through the dynamic graphical display function, which is effective for the comparison between two or among more groups of statistics data.
Automatic code meaning conversion
In the service system, some codes are used to tag the data with special meaning to save database space or for system design.
For example, each of the following codes represents a phone fault respectively:
01 Disconnected; 02 Short-circuited; 03 Not hooked on......
During report statistics, if a field error is found in the report, the statistics data should not be 01, 02 or 03, but disconnected, short-circuited or not hooked on. During report customization, the user doesn't know whether to get the meaning of a fault cause from another table, therefore, the report tool provides the function of converting the code into the meaning it represents automatically.
Totaling functions
The include several types: row and column totaling, specified field totaling, grand totaling, row and column subtotaling, grouping subtotaling, page subtotaling, and percentage, etc..
Totaling function Remark row totaling To sum up the data in a row. column totaling To sum up the data in a column. specified field totaling To sum up some fields in the report statistics output fields. grand totaling To sum up all data in a report row subtotaling To sum up the data of a certain row in a group for grouping statistics. column subtotaling To sum up the data of a certain column in a group for grouping statistics. grouping subtotaling To sum up all data of a group for grouping statistics.
page subtotaling To sum up the data in each column of a page and record the results in the last row of the page.
percentage The result of a certain data divided by the total data.
Data highlighted as per the preset value
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-7
A certain value can be preset for the statistics query data, which will be highlighted in special font or special color once beyond this preset value.
Preview function
The report statistics supports preview function and zooming function in the preview mode. It also supports the saving & reading, format conversion and printing functions for report files.
Extraction in batch
For the statistics of enormous data, the batch extraction function can be used. For example: extract 500 records each time.
Report statistics query conditions
The report statistics query conditions directly reflect the report statistics contents. With the input query conditions, the report can generate final, complete and executable SQL statements or executable store procedures.
There are various types of report statistics query conditions, include start time and end time, service type, region, number, service status, user name, etc. or the combination of several of them. After the report content is customized, the report tool can generate the corresponding statistics query conditions.
During report statistics, the report tool will pop up a window, in which the user can input the conditions. In addition, the report tool can automatically judge whether the input value of the query condition is valid according to the specified rules.
The query condition supports multi-value input. For example, if a statistics condition is "Employee ID", you can input 1, 2 or even more numbers. It also supports the relational operator formula and the Boolean formula.
The report tool supports the flexible definition of the query time.
During query statistics, the query progress can be displayed and can reflect the number of records meeting the conditions and the total number of cords. The query can be aborted at any time and the system will report the number of data actually obtained, generate a report and display the message "Part of results" in an obvious place.
IV. Independence from the service system
As a universal report tool, the Intelligent Report System is independent from the service system. In another word, any required report can be designed through the report tool for any service system.
The report tool independence from the service system includes:
Independent from the operating system
The system Client supports all Windows platforms, while the server end supports all UNIX and Windows platforms. The report tool accesses the service system database.
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-8
Except this relationship, it has nothing to do with the type of operating system used in the service system.
Independent from database
The report tool supports the major database, like Oracle, SQL Server, Sybase, and Informix, etc. and the standard SQL. It does not own any feature associated with the specified database, so as to be independent from the database.
Independent from specific services
The IN report system is independent from all other parts but the data in the service system database.
V. Supplying report browser
VI. Supporting the distributed large-capacity service system
The Intelligent Report System supports the distributed large-capacity service system. It does not limit the number of report users but supports the concurrent operation of multiple users. However the number of the users connected with the server at the same time is controlled by the system License and should not be over 250.
The system is not connected with the database directly. Instead, it realizes communication through a secure communication mechanism, which shields visitors beyond the LAN so as to prevent illegal intrusion.
VII. Diversified report I/O formats
The output formats provide by the IN report system include but not limited to the following forms: printing, RTF file, TXT file, HTML file, EXCEL file, report files in special format etc.
Output format Remark Printing Printer output is the major output mode for reports.
RTF file RTF stands for Rich Text Format. It is a widely supported text file with abundant page formats but in a simple structure.
TXT file TXT is the oldest and most applicable file format, which can be edited by almost all editors. But it does not support graphics.
HTML file The user can converted the report into a HTML file, and directly read it through the browser. The HTML format is the same as the actual report format.
EXCEL file The user can converted the report into an EXCEL file, then edit the report statistics query results directly with EXCEL. The EXCEL format is the same as the actual report format.
Report file in special format After the statistics, the report can be saved as a file in a special format, which can be read, displayed and printed with the report tool.
Report output setup
The system supports report output setup and specifically defaults which of the above formats is used for report output. For non-electronic output formats like printing and fax, the system supports the following settings: number of copies and output pages (all, current page, page range, odd and even pages), horizontal / landscape output, and so on.
Report input The report tool can read files in the format like FRP or FRF. It can convert the report file in special formats into files of other formats, for example, TXT file, HTML file, and EXCEL file.
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-9
Output format Remark
Offline function Offline means running in the stand-alone environment, disconnected with the database. The report system can realize offline reading and print of files in the above-mentioned formats.
VIII. Strict authority control
1) User types
The report system features for strict authority control. It has four types of users: system administrator, report designer, report statistician and end user.
The system administrator can set and control the authority for report designers and ordinary users.
The report designer is authorized to design reports but not for all data in the service system.
The report statistician is authorized to execute report statistics but not for all data in the service system.
The end user is authorized to execute query and statistics only the data related with himself.
The management authority is independent from the design and statistics authority. Namely, the administrator has no authority for report design and statistics. However, the statistics authority is included in the design authority.
A report user can have more than one identity. A user can be the administrator and the designer or statistician at the same time, which is determined by his authority.
2) Authority control
The authority control includes:
Operation authority control
It mainly refers to the report design and statistics authority.
Data authority control
It decides what kind of data the user has the design and statistics authority for.
The data authority can be defined according to different data sources, region, unit or other special data.
User authority control
The user authority control is set by the system administrator, who decides whether a user has the report design authority or report statistics authority, and what data can be accessed with the authority.
Several people with the same authority can be managed through a group.
Database authority control
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-10
Authority levels are set in the database. A user can access the corresponding data according to his authority. All report tool users have read-only authority for all data.
IX. Security guarantee
The report system guarantees the security of the data and operations. Its guarantee concerns operation, storage, transmission, input, output, etc. including:
Complete authority management
The strict authority control ensures that only authorized users can access the corresponding data.
Authority levels are set in the database. The user can access the corresponding data according to his authority. Except the system administrator and the report designer, all other users only have the read-only authority for all data.
Detailed log record
The log mainly contains the important operation and error records. The important operation records contain such items as operator, operation time, operation items and operated data, etc. The error record contains such items as operator, error occurrence time, error-generating module, error cause, original data of error, and so on.
The log record is generated in the file form and is not affected by the database error.
The log view function is provided to determine the supervisor, local error cause and recover faults, etc. according to the log.
The log also has the clearance function, which is used to clear history logs. Before clearance, the log should be backed up or confirmed as useless. The system always asks the user to confirm to prevent mis-operations.
Complete alarm mechanism
The error alarm is used to report system errors or data errors so that the user can timely handle them.
Secure transmission mechanism
Data transmission mainly refers to the data transmission between the report tool and the database, and between the browser and the report tool. The system guarantees that the data is not intercepted illegally.
Secure storage mechanism
The system guarantees the data storage security, especially for report template files and report data configuration, etc.
The specialized data of the report tool, like user and authority, etc., are stored in the system database.
History data clearance function
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-11
This function is used to automatically clear temporary data generated by the report system so as to prevent junk data.
Error processing mechanism
Processing mechanisms are provided corresponding to system errors or data errors so that the statistics and data security are not affected.
When there is a system error occurs, the error cause and the corresponding recommended solution are provided so that the user can quickly locate the error and handle it
The system has a self-repairing mechanism which can prevent the system functions being affected by system errors.
X. Supporting isomer data source access
A proxy can connect and access multiple databases of different types simultaneously.
2.6 Attributes
I. Reliability
The report system features a multi-layer Browser/Server structure. The Http protocol is adopted for the communication between the Client and the system midware, while the Socket protocol is adopted between system midware and data access midware. If any fault occurs, you can load the Client again without affecting the whole system. Therefore, high reliability can be ensured even in the case of heavy user access and data transfer.
II. Security
1) Communication protocol security
The Http protocol is adopted between Client and system midware to support the Security Socket Layer (SSL) and encrypt the transferred data.
The Socket protocol is used between the system midware and the data access midware. For data transfer, the self-defined object class is used, which ensures high security.
2) Interface security
Inter-module data transfer is realized via the self-defined object class of the system, which features high security.
3) Database security
The system data is stored in the system database MySQL, which is specially used for the report system and whose password is encrypted through encryption algorithm.
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-12
The system also supports database backup and file backup.
4) File security
The data access midware is an executable file.
Report template files are expressed in the binary format.
5) Operation security
The recovery function is available for any misoperation on template design elements, system objects, system data and file deletion.
6) History data clearance
The system can automatically clear the intermediate data generated by the report to prevent junk data.
III. Maintainability
1) Template file. The self-defined template format and contents are all stored in the template file. Any authorized user can directly modify the template file with the Client tool.
2) Data operation. Any data access to the report is realized via intermediate data access, and the maintenance to all data access functions of the report system can be realized through the midware maintenance.
3) Service database encapsulation: The report system encapsulates the fields of the service system database adopted by the user. To modify the field information corresponding to the report, you can directly modify the field encapsulation information corresponding to this field.
4) The system can automatically record the debugging information for online maintenance.
5) The log management function is used to record system error information for tracing and maintenance.
6) The system midware contains all alarm information displayed via the console for the system administrator.
IV. Transplantability
The report system midware is designed via Java and connected with the database via JDBC. The system has its own MySQL relationship database, which can run on any platform. The standard SQL is adopted for the operations of the system database and the service database, so the system can be transplanted between different databases. The report system is a self-sufficient system and has nothing to do with the service system.
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-13
2.7 Report Generating Process
2.7.1 Measurement and Generating Process
Generally, following procedures are necessary for the report creation:
1) Get original data -> 2) Associate data -> 3) Calculate data to get statistics result -> 4) Edit format and then output report. The following are the detailed steps:
Step 1:
Connect the service database (such as performance database, configuration database or alarm database) to extract the specified data tables.
Step 2:
Extract the expected data from a number of tables, and then conduct data association.
Step 3:
According to the extracted data, conduct grouping and summarizing calculation (get summation of peer office types according to the same office direction) or arithmetic calculation (get the answered call attempt ratio as per the number of answered calls and the number of call attempts), and so on.
Step 4:
Output the final result in the specified format.
In the following description, we take the statistics of answered ratio as an example. Figure 2-2 is the flow chart for report statistics.
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-14
Office direction No.
Number of call attempts
Number of connected calls
Number of answered calls
1 300 250 2002 400 350 3003 500 450 400
Office direction No. Peer office type
1 To BSC2 To provincial MSC3 To provincialMSC
Peer office type Number of call attempts
Number of connected calls
Number of answered calls
To BSC 300 250 200
To provincial MSC 400 350 300
To provincial MSC 500 450 400
Peer office type Number of call attempts
Number of connected calls
Number of answered calls
answered Ratio
To BSC 300 250 200 0.67To provicial
MSC 900 800 700 0.78
SummarizePeer office
type
Number of call
attempts
Number of connected
calls
Number of answered
callsTo BSC 300 250 200
To provincial MSC 900 800 700
Associate
Inter-field calculation
Traffic database
Configuration database
Data extraction 1
2
3
4Formatted output
Figure 2-2 Report statistics flow chart
As shown in Figure 2-2, the statistics and generation procedures for the answered ratio are described as follows:
Step 1:
In Figure 2-2, Step 1 is to extract "Office Direction Performance Statistics Result Table" (Traffic Database Table) and the "Configuration Information Table" (Configuration Database Table) of office directions from the database. In these two tables, we can see the statistics results of three office directions on such aspects of call attempts, connected calls and answered calls, as well as the peer office types of these three office directions. Then, we conduct the statistics of the performance items for the same peer office type.
Step 2:
Step 2 is to combine the "Office Direction Performance Statistics Result Table" and the "Configuration Information Table" of office directions, associate them and get the expected "Peer Office Type" (Remove "Office Direction Numbers" without exact meaning).
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-15
Step 3:
Summarize the indices with the same peer office, i.e. respectively get the summation of call attempts, connected calls and answered calls in the two data "to provincial MSC", and combine the results into one record. But there is only one record of "to BSC", so the combined result is also one record. Then, divide "the number of answered calls" with "the number of call attempts" to get the answered ratio. Thus the data summarizing and operation is completed.
Step 4:
Step 4 is to edit the format, including arranging tables, modifying font, setting titles, and so on. Finally, output the result in the specified format.
2.7.2 Realization Principle of Report System
In the IN report system, all steps in Section 2.7.1 Measurement and Generating Process are saved in a "Report Template". You may define these steps to get different report contents and styles, then save them and use this template for statistics.
To design a report template according to the above steps, you should also operate as per the following steps:
Step 1:
Define the "Data Dictionary" in the Intelligent Report System so as to define all the service data sources.
The "Data Dictionary" defines the database where the service data is located, the available data tables or the field meaning of the storage process, etc. Once the "Data Dictionary" is defined, the source of original data is thus defined.
Once the original data source is available, you can determine how to summarize and operate these data.
Step 2:
Define the "Query Definition Wizard" so as to define the data tables, inter-table association and data filtering conditions used in the template.
The "Query Definition Wizard" defines the following items: data source (the database providing original data), data set (the tables or storage process to be used, and how to associate them), parameters entered during the storage process (if the storage process is used), output result (available data, and can be used for inter-field operation), user query condition (used to filter expected data), grouping and sequencing.
Step 3:
User Manual iManager M2000 Intelligent Report System
System PrincipleChapter 2 System Principle
2-16
Define the data operation formula, grouping condition and summarizing method in the template. These items can be realized through report band, rectangle object, operation presentation format, and so on in this system.
The report band specifies the range and rules for display fields and data operation. In a rectangle object, you can define the field, operation formula or text format corresponding to the data. The operation expression includes arithmetic calculation, database functions, and logical judgment. It also provides powerful calculation functions.
Step 4:
Define the template format including font, location, and color, etc; or add decorative tables or pictures.
The defined template can be saved in the system database. You can transfer the query authority of this template to other user groups.
The IN report system can be divided into an architecture illustrated in Figure 2-3 as per its functional modules.
IN report system
Authority management Data dictionary management
Report basic elements
Report template design
.
.
. Rep
ort q
uery
statst
ics
For
mat e
ditor
Pre
senta
tion f
orma
t edit
or
Line
secti
on ob
ject
Diag
ram
objec
t
User
grou
p man
agem
ent
Recta
ngle
objec
t
Data
prox
y wiza
rd
Quer
y defi
nition
wiza
rd
Data
prox
y wiza
rd
Stor
age p
roce
ss m
anag
emen
t
Table
man
agem
ent
Data
reso
urce
man
agem
ent
Temp
tate t
ype a
uthor
izatio
n
User
man
agem
ent
Figure 2-3 Functional architecture of the IN report system
The specific use of each function is available in the operation guide part.
HUAWEI
iManager M2000 Intelligent Report System User Manual
Client Management
User Manual iManager M2000 Intelligent Report System
Client ManagementTable of Contents
i
Table of Contents
Chapter 1 Installation and Operation of Report System Client ................................................ 1-1 1.1 Installing the Report System Client.................................................................................... 1-1 1.2 Running the Report System Client .................................................................................... 1-2
1.2.1 Starting the Report System Client........................................................................... 1-2 1.2.2 Logging in to the Report System............................................................................. 1-3 1.2.3 Introduction to the Report System Client Manager ................................................. 1-5
Chapter 2 Public Functions of the Report System Client ......................................................... 2-1 2.1 Public Functions of the Report System Client ................................................................... 2-1
2.1.1 Switching User Groups ........................................................................................... 2-1 2.1.2 Switching Users....................................................................................................... 2-1 2.1.3 Changing the Password of the Current User .......................................................... 2-1 2.1.4 Querying the Current System Information .............................................................. 2-2
2.2 Editing, Viewing and Help Functions ................................................................................. 2-4 2.3 Auxiliary Tools of the Report System................................................................................. 2-4
2.3.1 Schedule Monitor .................................................................................................... 2-4 2.3.2 Backing up and Restoring the System.................................................................... 2-6 2.3.3 Clearing the Local Data File.................................................................................. 2-10
Chapter 3 User and User Group Management ........................................................................... 3-1 3.1 User Group Management .................................................................................................. 3-2
3.1.1 Creating a User Group ............................................................................................ 3-2 3.1.2 Modifying a User Group .......................................................................................... 3-5 3.1.3 Deleting a User Group ............................................................................................ 3-6
3.2 User Management ............................................................................................................. 3-6 3.2.1 Creating a User ....................................................................................................... 3-6 3.2.2 Modifying a User ................................................................................................... 3-10 3.2.3 Deleting a User...................................................................................................... 3-12 3.2.4 Unblocking a User................................................................................................. 3-12 3.2.5 Activating a User ................................................................................................... 3-13 3.2.6 Deactivating a User............................................................................................... 3-13
Chapter 4 Datasource Management ............................................................................................ 4-1 4.1 Datasource Management .................................................................................................. 4-2
4.1.1 Creating a Datasource ............................................................................................ 4-2 4.1.2 Modifying a Datasource .......................................................................................... 4-5 4.1.3 Deleting a Datasource............................................................................................. 4-6 4.1.4 Setting a Usable Proxy Server for a Datasource .................................................... 4-7
4.2 Table Management............................................................................................................ 4-8
User Manual iManager M2000 Intelligent Report System
Client ManagementTable of Contents
ii
4.2.1 Creating a Table...................................................................................................... 4-8 4.2.2 Modifying a Table.................................................................................................. 4-12 4.2.3 Deleting a Table .................................................................................................... 4-13 4.2.4 Getting All Tables Automatically ........................................................................... 4-13
4.3 Stored Procedure Management....................................................................................... 4-15 4.3.1 Adding a Stored Procedure................................................................................... 4-15 4.3.2 Importing Fields of a Stored Procedure ................................................................ 4-20 4.3.3 Modifying a Stored Procedure............................................................................... 4-21 4.3.4 Deleting a Stored Procedure................................................................................. 4-22 4.3.5 Getting All Stored Procedures Automatically ........................................................ 4-23
4.4 Range List Management.................................................................................................. 4-25 4.4.1 Creating a Range List ........................................................................................... 4-25 4.4.2 Modifying a Range List.......................................................................................... 4-31 4.4.3 Deleting a Range List............................................................................................ 4-32
4.5 Database Proxy Server Management.............................................................................. 4-33 4.5.1 Creating a Database Proxy Server ....................................................................... 4-33 4.5.2 Modifying a Database Proxy Server...................................................................... 4-35 4.5.3 Deleting a Database Proxy Server........................................................................ 4-36
Chapter 5 Report and Template Management............................................................................ 5-1 5.1 Template Group Management........................................................................................... 5-2
5.1.1 Creating a Template Group..................................................................................... 5-2 5.1.2 Modifying a Template Group................................................................................... 5-3 5.1.3 Deleting a Template Group ..................................................................................... 5-4 5.1.4 Changing to Folder.................................................................................................. 5-4 5.1.5 Backing up and Restoring a Template Group......................................................... 5-5
5.2 Sub-template Group Management .................................................................................... 5-6 5.2.1 Creating a Sub-template Group .............................................................................. 5-6 5.2.2 Modifying a Sub-template Group ............................................................................ 5-8 5.2.3 Deleting a Sub-template Group............................................................................... 5-9 5.2.4 Changing to Folder.................................................................................................. 5-9
5.3 Template File Management ............................................................................................... 5-9 5.3.1 Creating a Template File......................................................................................... 5-9 5.3.2 Modifying a Template File ..................................................................................... 5-12 5.3.3 Deleting a Template File ....................................................................................... 5-13 5.3.4 Downloading a Template File................................................................................ 5-14 5.3.5 Uploading a Template File .................................................................................... 5-14 5.3.6 Upgrading a Template File.................................................................................... 5-15 5.3.7 Changing to Folder................................................................................................ 5-16
5.4 Scheduled Task Management ......................................................................................... 5-16 5.4.1 Creating a Scheduled Task................................................................................... 5-16 5.4.2 Modifying a Scheduled Task ................................................................................. 5-20 5.4.3 Deleting a Scheduled Task ................................................................................... 5-21
User Manual iManager M2000 Intelligent Report System
Client ManagementTable of Contents
iii
5.5 Report Query and Management ...................................................................................... 5-22 5.5.1 Designing a Template File .................................................................................... 5-22 5.5.2 Querying a Template File...................................................................................... 5-23 5.5.3 Displaying a Report File ........................................................................................ 5-25 5.5.4 Deleting a Report File ........................................................................................... 5-26 5.5.5 Copying a Report File ........................................................................................... 5-26
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 1 Installation and Operation of Report System Client
1-1
Chapter 1 Installation and Operation of Report System Client
1.1 Installing the Report System Client 1) Open the IE browser, type "IP address of report server : HTTP port No. of report
server" (such as http://10.76.165.189:8088) in the address field, then press <Enter> to pop up a window as shown in Figure 1-1.
Figure 1-1 Downloading the report system client
2) Click <Install Report System Client> or click the link Report System Client Software V200_R001_XXX to start installing the report system client.
Please install the report system client according to the following Setup Wizard.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 1 Installation and Operation of Report System Client
1-2
Figure 1-2 Report System Client Setup Wizard
3) Click the Report browser V200_R001_XXX to download the report client tools.
Note:
1) The installation of the report system client is so simple that what a user needs to do is to select <Next> continuously. All the configurations adopt the default values. 2) The report browser can be used directly without being installed. 3) Run this program from its current location can be selected in the client download, which facilitates the installation.
1.2 Running the Report System Client
1.2.1 Starting the Report System Client
Select the [Start/Program/Huawei Report System (V200R001) / Huawei Report System Client] menu on the desktop to start the report system client.
Or, click the icon on the desktop to start the report system client.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 1 Installation and Operation of Report System Client
1-3
1.2.2 Logging in to the Report System
1) Select [Start/Programs/Huawei Report System (V200R001)/Huawei Report System Client] to start the report system client.
Figure 1-3 User login
2) In the User Login window, as shown in Figure 1-3, type the IP address of the report server: HTTP port No. of the report server in Login Website, as shown in Figure 1-3.
3) Input the User ID and User Password.
Note:
After it is installed, the report system will automatically create an initial user ID admin (the super administrator) with the initial password as admin. The user has the complete user management authority and data source authority.
4) To configure the advanced options, click <Advanced>.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 1 Installation and Operation of Report System Client
1-4
Note:
More configuration items included in the advanced configuration are shown in the following. 1) Save the Password and Automatic Login: If the configuration is employed, the user automatically logs in to the system in the next start. 2) Use Firewall Proxy: To employ the configuration, the user must input the firewall proxy name and password. 3) Use SSL Transmission: The configuration can be employed only when the report server supports the SSL security socket. The report server does not support it by default.
5) After all the configurations are performed, click <Login>. The system pops up the window for selecting the user group, as shown in Figure 1-4.
Figure 1-4 Selecting the login user group
6) Select the user group, and the system creates the system data environment.
Note:
1) A user accessing the report system may fall into multiple user groups. But he can only select a user group when logging in to the report system client. Now, the user authority is the authority available in the user group. 2) For the description of the specific authority, please see Section 2.4 “Overview of the Authority Management” of Client Management module. 3) With the shortcuts such as <Alt+1>, <Alt+2>, etc., a user can select the user group conveniently.
7) To design a report or template, please select the With Designing Permission check box. To use the current user group by default in the next start, please select the Automatic Login User Group check box. <<(P) (N)>> is available for turning the pages when there are more than 8 user groups that cannot be displayed in a page.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 1 Installation and Operation of Report System Client
1-5
Caution:
1) If a user wants to design a report or a template, he must select the With Designing Permission check box. Otherwise, though he is granted the authority in the user group to design a report or template, he cannot perform it. 2) Both the users with designing permission and those with browsing permission connected to the report server are restricted by License file, and in general, the users with designing permission are less than those with browsing permission, so it is recommended that the check box should not be checked if unnecessary.
8) Finally, the system pops up the report system client manager window, as shown in Figure 1-5.
Figure 1-5 Report system client manager
1.2.3 Introduction to the Report System Client Manager
The report system client manager window shown in Figure 1-5 is similar to that of the resource manager in the MS Windows system except for several aspects that should be paid more attention to.
1) There is a tool bar, , on the low-left in the
window with three buttons, <Report>, <User> and <Data>. By clicking these
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 1 Installation and Operation of Report System Client
1-6
buttons, a user can switch the views among Report management, User management, and Datasource management. (The window as shown in Figure 1-5 appears when the Report tab page is selected).
2) The sub-menus under the [Operation] menu vary with different operating objects selected by a user. For example, if a user selects a user group, the sub-menus under the [Operation] menu will change to [New User Group], [Modify User Group], [Delete User Group] and [New User]. If he selects a user, the sub-menus will be [New User], [Modify User], [Delete User], [Unlock User], [Activate User] and [Deactivate User].
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 2 Public Functions of the Report System Client
2-1
Chapter 2 Public Functions of the Report System Client
2.1 Public Functions of the Report System Client
2.1.1 Switching User Groups
I. Task description
It is to select another user group to log in to the report system.
II. Operation instruction
1) Select the [System/Switch User Group] menu in the report system client manager window. The system pops up the window for selecting the user group, as shown in Figure 1-4.
2) Select the user group for this login, and then re-enter the report system client manager window after the system has created the system data environment.
2.1.2 Switching Users
I. Task description
It is to log in to the report server as another user or logs in to other report servers.
II. Operation instruction
1) Select the [System/Switch User] menu in the report system client manager window. The system pops up the User Login window, as shown in Figure 1-3.
2) The following operations are the same as those of user logging in to the report system. For specific operations, please refer to Section 1.2.2 “Logging in to the Report System”.
2.1.3 Changing the Password of the Current User
I. Task description
It is to modify the password of the current user.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 2 Public Functions of the Report System Client
2-2
II. Operation instruction
1) Select the [System/Change Password] menu in the report system client manager window. The system pops up the window for changing the user password, as shown in Figure 2-1.
Figure 2-1 Changing the password of the current user
2) Input the old password and the new password in the Old Password and New Password text boxes respectively, and input the new password again in the Confirm Password text box. After that, click <OK> to finish the password of the current user change.
2.1.4 Querying the Current System Information
I. Task description
It is to view relevant information of the current system.
II. Operation instruction
Select the [System/Query the System Information] menu in the report system client manager window. The system pops up the window for querying the current system information, as shown in Figure 2-2
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 2 Public Functions of the Report System Client
2-3
Figure 2-2 Querying the current system information
III. Field description
For the description of the fields related to the operation of querying the current system information, please refer to Table 2-1.
Table 2-1 Description of fields related to the operation of querying the current system information
Field Description
Current Service The current service is related to the License. A service corresponds to a License, while a License corresponds to a user group. Therefore, different services can be obtained in the user login by selecting different user groups.
Current Service Key The current service key is related to License, and it records the key words of the current service, and works as the key of the current service.
Schedule Monitoring Whether the schedule monitoring is started. The schedule task is available only when the schedule monitoring is started. The schedule monitoring can be started by selecting the [Tools/Schedule monitor] menu.
Logout When Timeout
Means whether the user is allowed to log out if his operation times out. If allowed, the user will log out if he has no operation in a period of time. If he wants to conduct any operation, he should log in to the report system again. The user timing out logs out automatically by selecting the [Tools/Schedule monitor] menu.
Report Designing Permission Means whether the user is allowed to design a report. The permission is available only when the user checks With Designing Permission check box in the login.
Last System Error Displays relevant information about the last system error.
Template File Path It is the storing path of the template file, which is stored on the local machine in the file format.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 2 Public Functions of the Report System Client
2-4
2.2 Editing, Viewing and Help Functions
The editing function includes such sub-functions as Find, Reset, Expand All, Collasple All, Select All and Invert Selection.
The viewing function includes such sub-functions as Tool bar (involving Standard Toolbar, Operation Toolbar and Management Toolbar), Management Page (Report Management Page) User Management Page, Datasource Management Page), Full Screen, Small Icon, List, Details and Refresh.
The help function includes such sub-functions as Help, Home Page and About.
The editing, viewing and help functions are relatively simple, and they have the similar style to that of the MS Windows, which is easy to understand, so the detailed description is omitted in this manual.
2.3 Auxiliary Tools of the Report System
The auxiliary tools of the report system include Schedule Monitor, System Backup and Clear Local Data Files.
2.3.1 Schedule Monitor
I. Task description
It is to decide whether the scheduled task is to be monitored. The monitored and activated scheduled tasks will not be executed until they meet the executing conditions. (For the creation and activation of the scheduled task, please refer to Section “5.4.1 Creating a Scheduled Task”).
Caution:
A user can create a schedule task in the report system client. But only when Start Schedule Monitor in the Schedule Monitor is checked, will the system monitor the schedule task. Only when the executing conditions are satisfied, will the system execute the scheduled task.
II. Operation instruction
1) Select the [Tools/Schedule Monitor] menu in the report system client manager window. The system pops up the schedule monitor window, as shown in Figure 2-3.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 2 Public Functions of the Report System Client
2-5
Figure 2-3 Schedule monitor
Note:
The schedule task shown in the window is just one scheduled task created by the current user.
2) The user may select or clear the check box of Start Schedule Monitor or Can Not Logout Automatically. The user can clear the log list window in the lower part in the window by clicking <Clear Log>.
3) The user clicks <Return> to exit the window.
III. Field and control description
For the description of the fields and controls in the schedule monitor window, please refer to Table 2-2.
Table 2-2 Description of fields and controls in the schedule monitor window
Field or control Description Default value
Start Schedule Monitor Only when the check box is selected, will the scheduled task be monitored and executed.
Not activate the schedule monitoring
Can Not Logout Automatically
Only when the check box is selected, will the user not log out automatically due to timeout operation. The check box is automatically selected when the Start Schedule Monitor check box is selected.
The user timing out logs out automatically.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 2 Public Functions of the Report System Client
2-6
Field or control Description Default value
<Clear Log> Clicking the button to clear the executive log of schedule task.
2.3.2 Backing up and Restoring the System
I. Task description
It is to conduct such operations as backing up datasources, backing up template groups and restoring template groups based on the actual requirements.
The general procedure is: Define the datasource in a system and design the template file; then back up the datasource and restore to the new system.
II. Operation instruction
1) Select the [Tools/System Backup] menu in the report system client manager window.
Figure 2-4 Report system backup tool
2) In the Huawei Report System Backup Tool window, as shown in Figure 2-4, select to conduct the operations such as Backup Datasource, Backup Template Group and Restore Template Group.
Backup datasource
In the window as shown in Figure 2-4, input the database script file path and name (by
clicking on the right of the text box) generated by the backup datasource, and
select the type of the database which generates the script. Click <OK> to finish the datasource backup.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 2 Public Functions of the Report System Client
2-7
Note:
1) Backup Datasource will convert all the contents (including datasource, table, stored procedure, available database proxy server, database proxy server, value range and authorization) of the datasource in the datasource list into the SQL script of a certain database type. 2) Backup file path: A valid Windows file name with completed path; if not exist, it will be created; otherwise, you will be inquired about whether to cover it. 3) Type of the SQL script, including MS SQL Server, Sybase, Informix, Oracle. 4) If the ID conflicts, user can edit this SQL script manually to get proper ID. 5) The user can execute the backup SQL script in the database system to recover the datasource.
Backup template group
In the window as shown in Figure 2-4, click the [Backup Template Group] tab to enter the Backup Template Group window, as shown in Figure 2-5.
Figure 2-5 Backing up the template group
Select the backup path of the current template group and click <OK>. The system stores the current template group according to the directory structure of the local machine, and the template file uses its name as the name of the backed up file.
Caution:
Before a user backs up the template group, he should select a template group in the [Report Management] tab in the report system client manager window.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 2 Public Functions of the Report System Client
2-8
Restore template group
In the window as shown in Figure 2-4, click the [Restore Template Group] tab to enter the Restore Template Group window, as shown in Figure 2-6.
Figure 2-6 Restoring the template group
Select the local path of the template group to be restored and click <OK>. The system will create a template group with the current folder name, and then read the template file and sub-directory in this folder in turn. The template file will be created as the template with local filename, whereas sub-directory will be created as the sub-template group.
Caution:
The properties of the template and its sub-template are set by default. For any special requirements, please modify it manually.
Note:
The operations of backing up template groups and restoring template groups are reverse to each other. In the actual operation, a template group is usually backed up to a path on the local machine. To recover the template group, the backup template group directory generated in this directory will be selected directly.
Example:
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 2 Public Functions of the Report System Client
2-9
If the current template group is test1 with the backup path as C:\, then a test1 sub-directory is generated in C:\ after the template is backed up. To restore the test1 template group, the restore path is C:\test1\. The relation between the paths in this example is shown in Table 2-3.
Table 2-3 Relation between paths in the example
Current template group Backup path Local path of the backup template group _ test1 C:\ C:\test1\
III. Field description
For the description of the fields related to the operation of backing up and restoring the system, please refer to Table 2-4.
Table 2-4 Description of fields related to the operation of backing up and restoring the system
Field Description Remark
Backup file
Database type
Complete path and filename of the backup SQL script generated by the backup datasource. Database type of the SQL script, that is, the type of the system database, which is to be employed in the datasource storing.
Basal ID Backup file’s beginning ID. It is used to avoid ID conflict.
0 ~ 2000000000
Granted user group
The user group must exist in destination report system. “administrators” is granted by default.
Delete Old Data source first
"Delete from ..." is used to clear old data source information first in restored script. Used to transplant the whole report system or combine the first restored script.
Include Ranged Data
Used to transplant the whole report system or combine the first restored script.
Backup Datasource
Include Database Proxy Data
Used to transplant the whole report system or combine the first restored script.
Backup Template Group
Backup path
Path used for backing up template files. Under this path, the system can automatically create a folder with template group name as its name to store the backup template file.
MS SQL Server, Sybase, Informix and Oracle
Restore Template Group
Restore path
Path used for restoring template files. The name of this folder is the same as that of the newly created template group. The template file and sub-directory in this directory will be restored as template and sub-template group.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 2 Public Functions of the Report System Client
2-10
2.3.3 Clearing the Local Data File
I. Task description
It is to clear the local data file on the local machine.
Note:
If a user logs in to the report system with the report client, after a period, the local machine will be filled with such data files as the report template file, report file, XML script, data file, etc. These files will occupy a large space, and not be re-used. So, the user can empty the space by deleting these files.
II. Operation instruction
1) Select the [Tools/Clear Local Data Files] menu in the report system client manager window.
Figure 2-7 Clearing data files
Note:
As shown in the figure above, the local files are partitioned according to the IP address of the report server. For example, a 10.76.176.124 data folder represents the local data file generated by the report server with the IP address as 10.76.176.124, while a 10.76.144.175 data folder represents the local data file generated by the report server with the IP address as 10.76.144.175.
2) In the Clear Data File window, as shown in Figure 2-7, click <Select All>, <Select None> or <Select> to select the local data files to be cleared, then click <OK> to finish the operation.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 2 Public Functions of the Report System Client
2-11
III. Control description
The description of controls related to the operation of clearing the local data files is shown in Table 2-5.
Table 2-5 Description of controls related to the operation of clearing the local data files
Control Description <Select All> Deletes all the local files corresponding to the data folders. <Select None> No file is to be deleted. <Select> Deletes the local files corresponding to the selected data folders.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 3 User and User Group Management
3-1
Chapter 3 User and User Group Management
The management to the user and user management in the report system can be divided into the user management and user group management. To conduct the management to a user and user group, a user should enter the user list. (You can select the [View/Management Page/User Management Page] menu in the report system client manager window to enter the user list, similar to that shown in Figure 3-1.)
Figure 3-1 User management
With different objects selected by the user, different contents are shown in the box in the right part of the window. If the user selects User Group List, the corresponding information of all user groups will be shown in the box. If the user selects a certain user group, the corresponding information of this user group will be displayed. If the user selects User List, the corresponding information of all users will be shown.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 3 User and User Group Management
3-2
Caution:
Please make sure that the non-query operations such as addition, modification or deletion can be performed to a user only on a client at the same time. Otherwise, the concurrent operations may lead to abnormity.
3.1 User Group Management
3.1.1 Creating a User Group
I. Task description
It is to create a user group in the report system, and meanwhile set the maximum authority to it.
II. Operation instruction
1) Select a user group in the window as shown in Figure 3-1, and select the [Operation/New User Group] menu. The system pops up the New User Group window, as shown in Figure 3-2.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 3 User and User Group Management
3-3
Figure 3-2 Creating a user group
2) Input and select the corresponding information of the user group, and click <OK> to finish the user group creation.
Note:
If a user clicks <Apply>, the system can also finish the user group creation. Now, the user can continue to create other user groups without exiting the New User Group window.
III. Field description
For the description of the fields related to the operation of creating a new user group, please refer to Table 3-1 .
Table 3-1 Description of fields related to the operation of creating a user group
Field Description Value range Default value
User Group ID
Only identifier of a user group. If a user group is selected in the login, its ID will be displayed on the button used for selecting the user group.
A string of up to 16 bytes without any spaces and semicolons
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 3 User and User Group Management
3-4
Field Description Value range Default value
User Group Name Name of the user group. The user groups with the same name are allowed.
A string of up to 64 bytes, which is allowed to be null. User Group ID
Service Name Service to which the user group can conduct the operation, and corresponds to the License file of the service.
Its value can be selected from the drop-down list.
Note Description of this user group. A string of up to 250 bytes, which is allowed to be null. Null
Max Report Authority
Maximum report management authority granted to the user group.
Including full rights, read/write, read only and no right
Max User Authority Maximum user management authority granted to the user group.
Including full rights, read/write, read only and no right
Max Datasource Authority
Maximum datasource management authority granted to the user group.
Including full rights, read/write, read only and no right
Template Group Template groups that the user group can access.
The template groups that the user group can access.
Datasource Datasource that the user group can access.
The datasource that the user group can access.
When authorizing operations on template groups and datasources, the user can click <Sel All>, <Sel None> or <Select> to select template groups and datasources. For the detailed description, please refer to Table 3-3.
Caution:
The License file corresponding to the user group may restrict the user group’s access to some types of the template or datasource. Therefore, though some template groups or datasource are authorized here, in the actual operation, the users in the user group cannot access them due to restriction of the License file.
Table 3-2 Description of controls related to the operation of authorizing operations on template groups and datasources
Control Description
<Sel All> Grants both the template groups and datasource allowed to be access by the current user to the user group being operated.
<Sel None> Cancels all the authorities from the user group being operated. <Select> Grants the selected template groups and datasource to the user group being
operated.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 3 User and User Group Management
3-5
3.1.2 Modifying a User Group
I. Task description
It is to modify relevant information of an existing user group except the user group ID.
II. Operation instruction
1) Select a user group in the window as shown in Figure 3-1, and select the [Operation/Modify User Group] menu.
Figure 3-3 Modifying a user group
2) In the Modify User Group window, as shown in Figure 3-3, modify the relevant information of the user group except for the user group ID. After the modification, click <OK> to finish the user group modification.
Caution:
Only after a user refreshes the setting or re-log in to the system, can the modification to the template groups or datasources, which operations are authorized on, come into effect.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 3 User and User Group Management
3-6
III. Field description
For the description of the fields related to the operation of modify a user group, please refer to Table 3-1.
3.1.3 Deleting a User Group
I. Task description
It is to delete a user group from the report system.
II. Operation instruction
1) Select a user group in the window as shown in Figure 3-1, and select the [Operation/Delete User Group] menu. The system prompts "Are you sure to delete the 1 user Group(s)?".
2) Click <OK> to finish the deletion. To cancel it, click <Cancel>.
3.2 User Management
3.2.1 Creating a User
I. Task description
It is to create a user in the report system.
II. Operation instruction
1) Select User List in the window as shown in Figure 3-1, and select the [Operation/New User] menu.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 3 User and User Group Management
3-7
Figure 3-4 Creating a user
2) In the New User window, as shown in Figure 3-4, input and select relevant information of a user, and meanwhile specify the user group that the user belongs to.
3) Click <Add> to pop up the User Group Authorize window, as shown in Figure 3-5.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 3 User and User Group Management
3-8
Figure 3-5 Authorizing a user group
4) Select the user group to be authorized in the user group list to grant the authority to the user, by which he can log in to the user group.
Note:
1) A user can select the corresponding authority from the Management authority drop-down list. Now the user’s authority in the user group is the intersection of Management authority and Maximum management authority of the user group, that is, the smaller one of the two. For example, Management authority is the report administrator authority, 3/0/1, and Maximum management authority of the user group is 1/2/2, the user’s authority in the user group is 1/0/1. 2) The user can also customize the maximum report management authority, maximum user management authority and maximum datasource management authority in the user group by clicking the buttons in the lower part of the window.
Users in the report system can be divided into the system administrator and user administrator based on different authorities. For the detailed corresponding relationship, please refer to Table 3-4.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 3 User and User Group Management
3-9
Table 3-3 The corresponding relationship between the user type and authority in the report system
Authority Field
Report authority User authority Datasource authority Super Administrator Full Rights Full Rights Full Rights
User Administrator No Right Full Rights No Right Data Dictionary Administrator Read Only No Right Full Rights
Report Administrator Full Rights No Right Read Only
Report Designer Read/Write No Right Read Only Internal Designer Read Only No Right Read Only External Designer Read Only No Right No Right
5) Click <OK> to finish the user creation.
Note:
1) If a user clicks <Apply>, the user creation is also finished. Now, the user can continue to create other users without exiting the New User Group window. 2) The user can also create user groups in batch with their IDs separated by “;”. Now, the employee ID and user name of a user serve as his user ID. For the other properties, all users’ are identical.
III. Field and control description
For the description of the fields and controls related to the operation of creating a user, please refer to Table 3-4.
Table 3-4 Description of fields and controls related to the operation of creating a user
Field Description Value range Default value
User ID Only identifier of a user. Multiple users can be created at one time with their IDs separated by ";".
A string of up to 16 bytes without any spaces and semicolons
User Password User password A string of up to 16 bytes, which is allowed to be null. Null
Confirm Password User password A string of up to 16 bytes, which is allowed to be null. Null
User Name User name A string of 64 bytes, which supports Chinese, can be null and can be repeated.
User ID
Employee ID Employee ID A string of 64 bytes, which supports Chinese, can be null and can be repeated.
User ID
Note Supplementary note to the user A string of 250 bytes, which supports Chinese, can be null and can be repeated.
Null
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 3 User and User Group Management
3-10
Field Description Value range Default value
Deactivate
If a user is deactivated, he cannot log in. If this user being operated is online, this configuration will take effect in his next login.
Deactivate and activate Activate
Allow To Login Repeatedly
If a user is allowed to login repeatedly, then this user will not be locked after his login, and other users can still log in with his ID. For a unique user ID, it can be used to log in to the system on the same client repeatedly. Meanwhile, the old login record will be deleted. If the user ID has been used to log in to the system on a client, it is not allowed to log in to the report system on other clients.
Allow and forbid Forbid
<Add> Home user group of the user is added.
<Delete> Makes the user not belong to the selected user group.
<Clear> Makes the user not belong to any of the user groups.
3.2.2 Modifying a User
I. Task description
It is to modify relevant information of an existing user except his user ID.
II. Operation instruction
1) Select User List in the window as shown in Figure 3-1, and select the user to be modified in the box on the right. Select [Operation/Modify User] to pop up the Modify User window, as shown in Figure 3-6.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 3 User and User Group Management
3-11
Figure 3-6 Modifying a user
2) Modify the relevant information of the user except his user ID. After the modification, click <OK> to finish the user modification.
Note:
1) By pressing <Ctrl> or <Shift>, multiple users can be selected simultaneously and the properties of users can be modified in batch. 2) By double clicking the text box of the user property or right clicking the check box of the user property, the color of the control can be changed. When the color of the control is light gray, the corresponding user property will remain unchanged.
III. Field description
For the description of the fields related to the operation of modifying a user, please refer to Table 3-4.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 3 User and User Group Management
3-12
3.2.3 Deleting a User
I. Task description
It is to delete a user from the report system.
II. Operation instruction
1) Select User List in the window as shown in Figure 3-1 , and select the user to be deleted in the box on the right. Select [Operation/Delete User] to pop up the prompt “Are you sure to delete the 1 user(s)?”
2) Click <OK> to finish the deletion. To cancel the operation, click <Cancel>.
Note:
Pressing <Ctrl> or <Shift>, a user can select multiple users simultaneously and then delete them in batch.
3.2.4 Unblocking a User
I. Task description
It is to unlock the lock of a user.
Note:
If the Allow to Login Repeatedly check box is not selected for a user, he will be locked by the system once he logs in successfully. The possible abnormity may leads to the deadlock of the client program in the report system. After the client program is restarted, the user is still locked, and cannot re-log in. A feasible method is to log in as another user and execute the operation of unlocking the user.
II. Operation instruction
1) Select a user to be unblocked in the window as shown in Figure 3-1 (the blocked
user is marked with in the Lock column), and select [Operation/Unlock]. The
system prompts "Are you sure to unlock the 1 user(s)?". 2) Click <OK> to unblock the user. To cancel the operation, click <Cancel>.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 3 User and User Group Management
3-13
3.2.5 Activating a User
I. Task description
It is to activate a deactivated user. The activating and deactivating operations are reverse.
II. Operation instruction
1) Select a user to be activated in the window as shown in Figure 3-1 (the
deactivated user is marked with in the Activate column), and select
[Operation/Activate]. The system prompts "Are you sure to activate the 1 user(s)?".
2) Click <OK> to finish the activation. To cancel the operation, click <Cancel>.
3.2.6 Deactivating a User
I. Task description
It is to deactivate an activated user. The deactivating and activating operations are reverse.
II. Operation instruction
1) Select the activated user in the window as shown in Figure 3-1 (the activated user has no mark on in the Activate column), and select the [Operation/Deactivate] menu. The system prompts "Are you sure to deactivate the 1 user(s)?"
2) Click <OK> to finish the deactivation (the user is marked with in the Activate
column). Click <Cancel> to cancel the operation.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-1
Chapter 4 Datasource Management
The management to the datasource of the report system consists of five parts, namely, datasource management, table management, stored procedure management, value list management, and database proxy server management. Before conducting the management to the datasource, a user should enter the datasource management window by selecting the [View/Management Page/Datasource Management Page] menu in the report system client manager window, as shown in Figure 4-1.
Figure 4-1 Datasource management
With different objects selected, different contents are shown in the box in the right part of the window. If a user selects the Datasource List, all the corresponding information about the datasource will be displayed in the right box. If he selects a certain datasource, the objects of Table List, Stored Procedure and Usable Proxy List will be shown in the box. If he selects Table List, all the information corresponding to the tables selected by the datasource will be listed. If he selects Stored Procedure, all the stored procedures of this datasource will be displayed. If he selects Usable Proxy List, all the usable database proxy servers of this datasource will be shown. If he selects
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-2
Range List, all the value lists will be displayed. If he selects Proxy List, all the database proxy servers will be displayed.
Caution:
Please make sure that the non-query operations such as addition, modification or deletion can be performed to a datasource, table, stored procedure, value list or database proxy server only on a client at the same time. Otherwise, the concurrent operations may lead to abnormity.
4.1 Datasource Management
The datasource covers all the information required in accessing the service database, such as the database name, database type, datasource IP address and port, database user name and password. Only when the information is obtained, can the report system access the service database.
The datasource is composed of two parts, table and stored procedure. By accessing tables or invoking the stored procedure in the service database, the report system obtains business data to make a report.
Meanwhile, the database proxy server must be defined for datasource. A service database can be accessed via one or more proxy servers. The method to configure a database proxy server is to configure a database proxy server list first, and then set the usable proxy server list in the content of the datasource. For the specific operation procedure, please refer to Section 4.1.4 "Setting a Usable Proxy Server for a Datasource”. If the setting is successful, a user can read the data structure of the service database, design a report template for it and query data from it.
4.1.1 Creating a Datasource
I. Task description
It is to create a datasource in the report system, the aim of which is to obtain the relevant information of the service database that a user can access.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-3
Note:
After the creation, it is suggested that a user configure the database proxy server first, and then read the information of its table or stored procedure to judge whether the data configured are correct.
Caution:
If the service database type is Sybase, a user should make sure the business has been patched. If the service database is not patched, please run the scrip program patchforjconn2.bat (the Windows operating system, including Windows 98/2000/NT) or patchforjconn2.sh (the UNIX operating system) in the sub-directory bin in the installation directory of the report server. For the detailed configuration, please refer to Table 4-2.
II. Operation instruction
1) Select Datasource List in the window as shown in Figure 4-1 and select [Operation/New Datasource].
Figure 4-2 Creating a datasource
2) In the New Datasource window, as shown in Figure 4-2, input or select the basic information of the datasource, and click <OK> to finish the datasource creation.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-4
Note:
Click <Apply>, the datasource creation can also be performed. Now, the user does can continue to create other datasources without exiting the New Datasource window.
III. Field description
For the description of the fields related to the operation of creating a datasource, please refer to Table 4-1.
Table 4-1 Description of fields related to the operation of creating a datasource
Field Description Value range Default value
Datasource ID
Serial number of a datasource in the report system, which is set by the system, and is not allowed to be modified by users.
Datasource Name
Name specified to this datasource by a user, which cannot be repeated.
A string of up to 64 bytes. It cannot be null and no Space is permitted. Such characters as /\, :, *, ?, ", <, >, |, [ and ] are not allowed.
Database Name
Name of the database to be accessed. This database must be in the service database system, and its name cannot be repeated.
A string of up to 64 bytes. Being null or including Space is not allowed. Such characters as /\, :, *, ?, ", <, >, |, [ and ] are not allowed.
Database Type
Type of the service database to be accessed by users. It has two kinds, Chinese and English. If a user cannot make sure whether the database is English or Chinese, he should try both. If the information of the table can be obtained correctly, it means the configuration is correct.
Informix (Chinese), Informix (English), Sybase (Chinese), Sybase (English), SQLServer (Chinese), SQLServer (English), Oracle (Chinese) and Oracle (English)
Datasource IP IP address of the server for installing this service database system
A string subject to IP specification
Datasource Port
Port by which the service database system provides services to the outside. The ports are different due to different database systems. For the actual requirements, please contact the database system administrator.
100~60000
The default port No. of Oracle is 1521. The default port No. of SQL Server is 1433. The default port No. of Sybase is 1433. The default port No. of Informix is 9002.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-5
Field Description Value range Default value
Database User User who accesses this service database
A string of up to 64 bytes, which cannot be null, and conform to the naming requirements to user raised by the corresponding database system.
The default name of the database service of Oracle is null. The default name of the database service of Oracle is null. Please input db.encoding = name of character set if the name of the database service of Sybase is not default. The default name of the database service of Informix is the value of INFORMIXSERVER.
Database Password
Password employed in the login of the database user.
A string of up to 64 bytes, which can be null, and conform to the requirements to the password raised by the corresponding database system.
Null
JDBC Extended Option
Content filled in the field usually depends on different database systems.
A string of up to 250 bytes, which should conform to the rules in the description.
Note Description to the current datasource
A string of up to 250 bytes, which can be null.
The configuration items required in the running of script program patchforjconn2.bat/patchforjconn2.sh are listed in Table 4-2.
Table 4-2 Description of running patchforjconn2.bat/ patchforjconn2.sh Configuration item Description Default value
Host IP IP address of the server where the service database is located.
Port
Port by which Sybase provides the services to the outside. For the actual requirements, please contact the database system administrator.
7100
sa Password Password of the Sybase user. Null
4.1.2 Modifying a Datasource
I. Task description
It is to modify relevant information of a certain datasource.
II. Operation instruction
1) Select a datasource to be modified in the window as shown in Figure 4-1, and select [Operation/Modify Datasource].
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-6
Figure 4-3 Modifying a datasource
2) In the Modify Datasource window, as shown in Figure 4-3, after the modification, click <OK> to finish the datasource modification.
III. Field description
For the description of the fields related to the operation of modifying a datasource, please refer to Table 4-1.
4.1.3 Deleting a Datasource
I. Task description
It is to delete a datasource from the report system.
Note:
To delete a datasource just means that the report system will not conduct the management to the datasource any more, and does not mean the home database of the datasource will be deleted.
II. Operation instruction
1) Select a datasource to be deleted in the window as shown in Figure 4-1, and select [Operation/Delete Datasource]. The system prompts “Are you sure to delete the 1 datasource(s)?”.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-7
2) Click <OK> to finish the datasource deletion. To cancel the operation, click <Cancel>.
4.1.4 Setting a Usable Proxy Server for a Datasource
I. Task description
It is to set some proxy servers that can provide services for the datasource being edited.
II. Operation instruction
1) Select Usable Proxy List under a certain datasource in the window as shown in Figure 4-1, and select [Operation/Set Usable Proxy].
Figure 4-4 Setting a usable proxy server for a datasource
In the Set Usable Proxy window, as shown in Figure 4-4, the existing database proxy servers in the report system are displayed in the upper part in the window, while the proxy servers that provide services for the current datasource set in the lower part.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-8
2) Set the database proxy server for the current datasource by clicking or .
3) Click the <OK> button, and the operation of setting a usable proxy server is finished.
III. Field and control description
For the description of the fields and controls involved in the operation of setting a usable proxy server, please refer to Table 4-3.
Table 4-3 Description of fields and controls related to the operation of setting a usable proxy server
Field or control Description Default value
Adds all proxy servers to serve the current datasource.
Adds the selected proxy server to serve the current datasource.
Clears all the added proxy servers.
Clears all the selected proxy servers.
Number of the connections provided to this datasource by this proxy server. The value range is 1~12.
2
4.2 Table Management
If the report system needs to access the tables in the database system, the preferred way is to create a table in the list of the datasource tables. (An available way is to extract all the tables in the datasource with the Get All Table function, and set the database management table according to the requirements)
For the convenience of accessing the table of datasource, it needs to set an alias for the table and for the field in the table, which can be realized by the operation of modifying table.
4.2.1 Creating a Table
I. Task description
It is to create a table for the datasource.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-9
Caution:
The newly created table should be a table that exists in the datasource. New Table is just used to describe its structure, which permits the report system to access it correctly.
II. Operation instruction
1) Select Table List under a certain datasource in the window as shown in Figure 4-1, or select [Operation/New Table]. The system pops up the New Table window, as shown in Figure 4-5.
Figure 4-5 Creating a table
2) Input or select relevant information of the table, and click <OK> to finish the table creation.
Here, the relationship between the field in the table and the range list can be established. For the detailed introduction to the range list, please refer to Section 4.4 “Range List Management”.
Example:
Assuming a table has a Week field, which is used for describing week, then the corresponding relationship between the field and the range list of week can be
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-10
established. (The precondition is that the range list of week has been defined in the report system.)
3) Input Week with the alias of Week, and select Range and then appears.
4) Click the button to pop up the Get Range window as shown in Figure 4-6.
Figure 4-6 Getting the range list
5) Select Week and click <OK>. Now the corresponding relationship between Week and range list of week is established, and character of week will appear in the range list line of the Week row.
III. Field description
For the description of the fields related to the operation of creating a table, please refer to Table 4-4.
Table 4-4 Description of fields related to the operation of creating a table
Field Description Value range Default value
Table ID Serial number allocated to the table by the system, which is unique. No user can modify it.
Datasource ID Serial number allocated to the home datasource of the table by the system, which is unique. No user can modify it.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-11
Field Description Value range Default value
Table Name Name of a table, which must have existed in the datasource.
A string of up to 64 bytes conforming to the naming rule for the fields in the database table. Such characters as /\, :, *, ?, ", <, >, |, [ and ] are prohibited. It is unique in this datasource.
Table Alias Alias of the table defined by the user. In the report template design, an alias with clear meaning is in favor of the design.
A string of up to 64 bytes. Such characters as /\, :, *, ?, ", <, >, |, [ and ] are prohibited. The string is unique in this datasource, and it cannot be null.
Note Description made by user to the table.
A string of up to 250 bytes, which can be null. Null
Field Name Name of a field in the table. The name must be that of a field that has existed in the datasource.
A string of up to 64 bytes, which conforms to the naming rule for the fields in the database table. Such characters as /\, :, *, ?, ", <, >, |, [ and ] are prohibited. The string is unique in this table, and it cannot be null.
Alias
Alias of the field in the table defined by the user. In the report template design, an alias with clear meaning is in favor of the design.
A string of up to 64 bytes. Such characters as /\, :, *, ?, ", <, >, |, [ and ] are prohibited. The string is unique in this table, and it cannot be null.
Type Type of the field
It contains datetime, integer, number and varchar. If a field does not belong to any of the four basic types, it will change according to the compatible rule. If it cannot change, the report system will not support this table.
Length Length of the field.
If the type of a field is number or varchar, the length of the field should be filled in. If its type is datetime or integer, the field has a fixed length.
If the type is datetime, the length is 8. If it is integer, the length is 4.
Bytes Decimal digit of the field.
Only when the type of the field is number, does the field have the decimal digit. If the type is datetime, integer or varchar, the field has no decimal digit.
If the type of the field is datetime, integer or varchar, the decimal digit is 0.
Range
The corresponding relationship between the field and the existing rang list. For the actual operation, please refer to the example in this section.
Default
The default value displayed in the field designing and querying. If the field corresponds to the range list, it should be defined as the described value of the value list.
A string of up to 32 bytes, conforming to the type of the field.
Null
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-12
Field Description Value range Default value
Restriction
Means a condition that will be attached automatically if the field is employed in the report query. The premise is that the restriction condition has been defined.
The condition should be complete, e.g. "Addr = 'New York'", and “(Count>10) and (Count<20)”. It is a string of up to 250 bytes. It should be null if it has no restriction condition.
Null
4.2.2 Modifying a Table
I. Task description
It is to modify relevant information of a table in the datasource.
II. Operation instruction
1) Select Table List under a certain datasource in the window as shown in Figure 4-1, and the table to be modified will be displayed in the box on the right.
2) Select [Operation/Modify Table]. The system pops up the Modify Table window, as shown in Figure 4-7.
Figure 4-7 Modifying a table
3) Modify the relevant information according to the requirements. Click <OK> to finish the table modification.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-13
III. Field description
For the description of the fields related to the operation of modifying a table, please refer to Table 4-4.
4.2.3 Deleting a Table
I. Task description
It is to delete a table from the report system.
Note:
To delete a table means that the report system cannot manage or query the table any more, and does not means deleting the table in the actual database.
II. Operation instruction
1) Select Table List under a certain datasource in the window as shown in Figure 4-1, and the table to be deleted will be displayed in the box on the right.
2) Select [Operation/Delete Table] to pop up the prompt “Are you sure to delete the 1 Table(s)?”
3) Click <OK> to finish the table deletion. To cancel the operation, click <Cancel>.
Note:
Pressing both <Ctrl> and <Shift>, a user can select multiple tables simultaneously and then delete these tables in batch.
4.2.4 Getting All Tables Automatically
I. Task description
It is to read all the table information in the datasource from the service database.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-14
Caution:
1) The operation of getting all tables cannot be executed normally unless the datasource information is configured correctly and the database proxy server is set well. So, this operation can be employed to check whether or not the datasource information and database proxy server are configured correctly. 2) The operation of getting all tables is restricted by License. The table without the authority will not be shown.
II. Operation instruction
1) Select Table List under a datasource in the window as shown in Figure 4-1. 2) Select [Operation/ Get All Table] to pop up the Get Table window, as shown in
Figure 4-8.
Figure 4-8 Getting all tables
3) All the tables that can be managed in the datasource are shown in the Get Table window. To select the table to be managed, check the check box before each table.
4) Click <OK> to finish the table list of this datasource creation.
Note:
1) Table generated via the operation of getting all tables has the same name with its alias. So the alias should be modified manually after the operation. With it, the table can be queried more easily and directly. 2) If the obtained table name does not conform to the naming rule (such as the space at the end, and reload mark), then it should be modified manually.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-15
III. Field and control description
For the description of the fields and controls related to the operation of getting all tables, please refer to Table 4-5.
Table 4-5 Description of fields and controls related to the operation of getting all tables
Field or control Description Table Name Name of table in the datasource.
Table Type Type of the table. The common types include: TABLE, VIEW and SYSTEM TABLE.
Note Description of the table in the datasource
<Sel All> Selecting all the displayed tables. If a user clicks <OK>, the table list under the datasource will display all the tables.
<Sel None> Canceling all the displayed tables. If a user clicks <OK>, the table list under the datasource will display none of the tables.
<Select> Selecting the checked table. If a user clicks <OK>, the table list under the datasource will display the selected tables.
4.3 Stored Procedure Management
4.3.1 Adding a Stored Procedure
I. Task description
It is to add a stored procedure of the datasource.
Caution:
1) The newly added stored procedure must be an existing stored procedure in the datasource. The operation of adding a stored procedure is just describing its structure, which allows the report system to access it correctly. 2) A stored procedure, which does not return the result set, is meaningless to the report system. Therefore, what is added through this operation is a stored procedure which can return the result set.
II. Operation instruction
1) Select Stored Procedure List under a datasource in the window as shown in Figure 4-1.
2) Select [Operation/ New Stored Procedure] to pop up the New Stored Procedure window, as shown in Figure 4-9.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-16
Figure 4-9 Adding a stored procedure
3) Input relevant information of the stored procedure and click <OK> to finish the stored procedure addition.
Example:
Assuming that a system database with its type as Informix already has a stored procedure.
create procedure sp_getuser(userid int) returning
int, int, int, varchar(64);
define ifield1 int;
define ifield2 int;
define ifield3 int;
define sfield4 varchar(64);
foreach
select columnid, tableid, dsid, columnname into ifield1, ifield2, ifield3,
sfield4
from rptcolumn where columnid = userid
return ifield1,ifield2,ifield3,sfield4 with resume;
end foreach;
end procedure;
Because the stored procedure has parameters, and it can return the result set, it is available in the report system.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-17
Note:
In Informix, the structure like "foreach… …end foreach" is employed to return the query result to a table. Only when the with resume statement is added, can the query result set be returned. Otherwise the query results will be returned one by one.
Now, the stored procedure sp_getuser can be added to the datasource setting in the report system.
4) In the window as shown in Figure 4-9, enter sp_getuser in SP Name, and Get user information in Note.
5) Click <Parameter>, and enter relevant parameters of the stored procedure, as shown in Figure 4-10.
Figure 4-10 Inputting the parameters of the stored procedure
6) Click <Result Set> and enter relevant results of the stored procedure, as shown in Figure 4-11.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-18
Figure 4-11 Results returned in the stored procedure
7) Click <OK> to finish the operation of adding the stored procedure sp_getuser.
Note:
If the parameter or result parameter entered the stored procedure is the field in table of the datasource, the field can be imported by clicking <Import Fields>. For the detailed operation procedure, please refer to Section 4.3.2 “Importing Fields of a Stored Procedure”.
III. Field description
For the description of the fields related to the operation of adding a stored procedure, please refer to Table 4-6.
Table 4-6 Description of fields related to the operation of adding a stored procedure
Field Description Value Range Default Value
SP ID Serial number allocated to the stored procedure by the system. It is unique. No user can modify it.
Datasource ID Serial number allocated to the datasource by the system. It is unique. No user can modify it.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-19
Field Description Value Range Default Value
SP Name Name of the stored procedure.
A string of up to 64 bytes, conforming to the naming rule of stored procedure specified by the database. Such characters as /\, :, *, ?, ", <, >, |, [ and ] are prohibited. The string is unique in this datasource, and it cannot be null.
SP Alias Alias of the stored procedure defined by the user. In the report template design, an alias with clear meaning is in favor of the design.
A string of up to 64 bytes. Such characters as /\, :, *, ?, ", <, >, |, [ and ] are prohibited. The string is unique in this datasource, and it cannot be null.
Note Description of this stored procedure defined by the user.
A string of up to 250 bytes, which can be null. Null
Field Name Name of the field. If the field is Parameters, it can be null. If it is Result Set, it cannot be null.
A string of up to 64 bytes, which conforms to the naming rule for fields in the stored procedure of the database. Such characters as /\, :, *, ?, ", <, >, |, [ and ] are prohibited. The string is unique in this stored procedure, and it cannot be null.
Alias
Alias of the field in the stored procedure defined by the user. In the report template design, an alias with clear meaning is in favor of the design.
A string of up to 64 bytes. Such characters as /\, :, *, ?, ", <, >, |, [ and ] are prohibited. The string is unique in this stored procedure, and it cannot be null.
Type Type of the field
It contains datetime, integer, number and varchar. If a field does not belong to any of the four basic types, it will change according to the compatibility rule. If it cannot change, the report system will not support this table.
Length Length of the field
If the type of a field is number or varchar, the length of the field should be filled in. If its type is datetime or integer, the field has a fixed length.
If the type is datetime, the length is 8. If it is integer, the length is 4.
bytes Decimal digit of the field
Only when the type of the field is number, does the field have the decimal digit. If the type is datetime, integer or varchar, the field has no decimal digit.
If the type of the field is datetime, integer or varchar, the decimal digit is 0.
Range Field bound to the existing rang list. For the actual operation, please refer to the example in this section.
Default
Default value displayed in the field designing and querying. If the field is bound to the range list, it should be defined as the described value of the value list.
A string of up to 32 bytes, conforming to the type of the field.
Null
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-20
Field Description Value Range Default Value
Restriction
A condition that will be attached automatically if the field is employed in the report query. The premise is that the restriction condition has been defined.
The condition should be complete, e.g. "Addr = 'New York'", and “(Count>10) and (Count<20)”. A string of up to 250 bytes. It should be null if it has not restriction condition.
Null
4.3.2 Importing Fields of a Stored Procedure
I. Task description
It is to import Parameter or Result Set of the stored procedure in the Import Field mode.
II. Operation instruction
1) Click <Import Field> in the window as shown in Figure 4-9 to pop up the window for importing the fields of the stored procedure, as shown in Figure 4-12.
Figure 4-12 Importing fields of a stored procedure
2) Select the database where the stored procedure is located, or select one or more fields in the table, or one or more fields in other stored procedures as Parameter or Result Set.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-21
3) Click <OK> to finish importing the fields of the stored procedure.
III. Control description
For the description of the controls related to the operation of importing fields of a stored procedure, please refer to Table 4-7.
Table 4-7 Description of controls related to the operation of importing fields of a stored procedure
Control Description
The imported fields will overwrite the original ones. That is, import Import Fields to overwrite the original Import Fields; import Result Set to overwrite the original Result Set.
The imported fields will be added to the end. That is, if Import Fields is imported, it will be appended after the original Import Fields. If Result Set is imported, it will be appended to the end of the original Result Set.
<Sel All> All the fields of the selected tables or stored procedures are imported. <Sel None> All the fields of the selected tables or stored procedures are cancelled.
4.3.3 Modifying a Stored Procedure
I. Task description
It is to modify relevant information of a certain stored procedure in a datasource.
II. Operation instruction
1) Select Stored Procedure List under a datasource in the window as shown in Figure 4-1, and the procedures to be modified will be displayed in the box on the right.
2) Click <Operation/Modify Stored Procedure> to pop up the Modify Stored Procedure window, as shown in Figure 4-13.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-22
Figure 4-13 Modifying a stored procedure
3) After the modification, click <OK> to finish the operation.
III. Field description
For the description of the fields related to the operation of modifying a stored procedure, please refer to Table 4-6.
4.3.4 Deleting a Stored Procedure
I. Task description
It is to delete a stored procedure of a datasource.
II. Operation instruction
1) Select Stored Procedure List under a datasource in the window as shown in Figure 4-1, and then the stored procedures to be deleted are displayed in the box on the right.
2) Select [Operation/Delete Store Procedure], and the system gives the prompt “Are you sure to delete the 1 Store Procedure(s)?”
3) Click <OK> to finish the procedure deletion. To cancel the operation, click <Cancel>.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-23
Note:
Pressing <Ctrl> or <Shift>, a user can select multiple stored procedures simultaneously and then delete them in batch.
4.3.5 Getting All Stored Procedures Automatically
I. Task description
It is to read all the information of the stored procedures in the datasource from the service database.
Caution:
1) The operation of getting all stored procedures cannot be executed normally unless the datasource information is configured correctly and the database proxy server is set well. Therefore, this operation can be employed to check whether or not the datasource information and database proxy server are configured correctly. 2) The operation of getting all stored procedures is restricted by License. The stored procedure without the authority will not be shown.
II. Operation instruction
1) Select Stored Procedure List under a datasource in the window as shown in Figure 4-1.
2) Select [Operation/ Get All Stored Procedure] to pop up the Get Stored Procedure window, as shown in Figure 4-14.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-24
Figure 4-14 Getting all stored procedures
3) All the stored procedures that can be managed in the datasource are shown in the Get Stored Procedure window. To select the stored procedures to be managed, check the check box before each stored procedure.
4) Click <OK> to finish the stored procedure list of this datasource creation in the report system.
Note:
1) A stored procedure generated via the operation of getting all stored procedures has the same name with its alias. So the alias should be modified manually after the operation. With it, the stored procedure can be queried more easily and directly. 2) The operation of getting all stored procedures does not include the input field and returned fields, so these fields should be added or imported manually. 3) If the name of the obtained stored procedure does not conform to the naming rule (such as the space at the end, and reload mark), then it should be modified manually.
III. Field and control description
For the description of the fields and controls related to the operation of getting all stored procedures, please refer to Table 4-8.
Table 4-8 Description of fields and controls related to the operation of automatically getting all stored procedures
Field and Control Description Stored Procedure Name Name of the stored procedure in the datasource
Stored Procedure Type Type of the stored procedure. The common types include: Return a result set, May return a result set, and Does not return a result set.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-25
Field and Control Description Note Description of the stored procedure in the datasource
<Sel All> Selecting all the displayed stored procedures. If a user clicks <OK>, the stored procedure list in the datasource will display all the stored procedures.
<Sel None> Canceling all the displayed stored procedures. If a user clicks <OK>, the stored procedure list in the datasource will not display any the stored procedures.
<Select> The stored procedures with the check boxes checked are selected. If the user clicks <OK>, the stored procedure list in the datasource will display all the selected stored procedures.
4.4 Range List Management
The key role of a value list is to establish a corresponding relationship between a field and a description in a certain table of the service database. For example, there is a field month in a certain business table. Its value range is from 1 to 12, which corresponds to January, February, March… December respectively.
So, a range list can be created with the values of 1~12, and the corresponding description January, February, March, … December, and meanwhile it is bound to month. (For the actual binding method, please refer to Section 4.2.1 “Creating a Table”) So in the design or query, the value of month is represented with from January to December. In this sense, the window becomes more friendly and more convenient to operate.
4.4.1 Creating a Range List
I. Task description
It is to create a new public range list in the report system.
Here, creating “Week range list” is taken as the example to explain the method of creating a range list. To create other range lists, please refer to this example.
II. Operation instruction
1) Select Range List in the window as shown in Figure 4-1 and select [Operation/New Range List]. The system pops up the New Range window, as shown in Figure 4-15.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-26
Figure 4-15 Creating a range list
2) Input Week in the Range name with the Note as Week range list. 3) Directly enter the value and description of the range list or import the value and
description by introducing the button mode (click <Import List>, ,
on the low-left in the window) to pop up the window for setting items in the range, as shown in Figure 4-16.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-27
Figure 4-16 Setting the items in the range list
4) Set the values of the week range list. The values are numbers in DBC case, such as 1, 2, etc, and the value range is from 1 to 7. Click <Import List> to import the seven values set to the range list.
5) Click to set the values of the week range list, as shown in Figure 4-17 .
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-28
Figure 4-17 Setting the values in the week range list
6) Check To Value and click <OK>, and the values of the week range list are shown in the window, as shown in Figure 4-18.
Figure 4-18 Result of the values in the week range list
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-29
7) Set the description of the week range list. The description of the week range list is in form like Monday, Tuesday, etc., and the value range is from 1 to 7. Click <Import List>, and import the set seven descriptions to the range list.
8) Click to set the description of the week range list, as shown in Figure 4-19.
Figure 4-19 Setting the descriptions in the week range list
9) Check To Description and click <OK>. The description of the week range list is shown in the window, as shown in Figure 4-20.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-30
Figure 4-20 Result of the descriptions in the week range list
10) Click <OK> to finish the week range list creation.
III. Field description
For the description of the fields related to the operation of creating a range list, please refer to Table 4-9 .
Table 4-9 Description of fields related to the operation of creating a range list
Field Description Value range Default value
Range ID Serial number allocated to the range by the system. It is unique. No user can modify it.
Range Name Name of a range list A string of up to 64 bytes, which cannot be null.
Note Description of a range list A string of up to 250 bytes, which can be null. Null
Value All values of the range list. The values cannot be repeated.
A string of up to 64 bytes, which cannot be null.
Range Content Descrip
tion
Description of each value of the range list. The descriptions cannot be repeated.
A string of up to 64 bytes, which cannot be null.
The controls related to the generation of description and value of the range list is depicted in Table 4-10.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-31
Table 4-10 Description of controls related to the generation of description and value of range list
Control Description
Clicks this button to pop up the Set items in the range window, in which the values and descriptions of the range list can be set.
The values and descriptions of range list can be generated in three modes, Generator, SQL, and Original.
Selects the content format of the value and description. Take the description of the week range list for example, week is filled in the first column, Monday/Tuesday is filled in the second, and the third column is null.
Selects the range of value or description. Fox example, the generation range of description of week range list is 1~7 (the upper limit is 1, whereas the lower limit is 7), while that of season range list is 1~4.
Inputs the SQL command in the left text box, while selects the datasource which executes the SQL command in the right list box.
The radio buttons on the left can decide to collect the value or description of the existing range list, while in the list box on the right, the range list to be collected can be selected. Self represents the range list being edited.
Generates the values or descriptions of the range list according to the user’s setting.
Adds the selected items to the list box on the right. Double click the selected items on the lift list box to perform the same function.
Adds all the items to the list box on the right.
Deletes all the items from the list box on the right.
Deletes the selected items from the list box on the right. Double click the selected items in the right list box to perform the same function.
Moves the selected item in the right list box line up by a line.
Moves the selected item in the right list box down by a line.
Lists the times in the right list box in reverse order.
Decides the values of the generated range list.
Decides the descriptions of the generated range list.
4.4.2 Modifying a Range List
I. Task description
It is to modify relevant information of the existing range list.
II. Operation instruction
1) Select User List in the window as shown in Figure 4-1, and select the range list to be modified in the box on the right.
2) Select [Operation/Modify Range List] to pop up the Modify Range window, as shown in Figure 4-21.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-32
Figure 4-21 Modifying a range list
3) Modify relevant information of the range list. For the detailed operation procedure, please refer to Section 4.4.1 “Creating a Range List”.
III. Field description
For the description of the fields related to the operation of modifying a range list, please refer to Table 4-9 and Table 4-10.
4.4.3 Deleting a Range List
I. Task description
It is to delete the range list from the system.
II. Operation instruction
1) Select Range List in the window as shown in Figure 4-1 and the range list to be deleted in the box on the right.
2) Select [Operation/Delete Range List], and the system gives a prompt to confirm the deletion.
Click <OK>to finish the range list deletion. To cancel the operation, click <Cancel>.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-33
4.5 Database Proxy Server Management
4.5.1 Creating a Database Proxy Server
I. Task description
It is to create a new database proxy server in the report system.
Caution:
Only the proxy server installed and configured or running on the report server is granted to conduct the operation. Therefore, a new database proxy server is generally created by administrator.
II. Operation instruction
1) Select Proxy List in the window as shown in Figure 4-1, and select [Operation/New Proxy]. The system pops up the New Proxy window, as shown in Figure 4-22.
Figure 4-22 Creating a database proxy server
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-34
2) Input the relevant information of the database proxy server, and click <OK> to finish the operation.
Note:
1) The new database proxy server creation can also be performed by clicking <Apply>. In this case, the user can continue to create other database proxy servers without exiting the New Proxy window. 2) Whether the configuration of the database proxy server is correct or not can be checked by the mode of acquiring the list of tables of the datasource using the database proxy server. If the acquiring operation succeeds, it means the configuration is correct, but if it fails, it demonstrates either the database proxy server configuration or the datasource configuration. 3) After the database proxy server is created, it can be configured in database proxy server list.
III. Field description
For the description of the fields related to the operation of creating a database proxy server, please refer to Table 4-11.
Table 4-11 Description of fields related to the operation of creating a database proxy server
Field Description Value range Default value
Proxy ID Serial number allocated to the database proxy server by the system. It is automatically maintained by the system.
Automatically generated by the system. No modification is allowed.
Proxy Name Name of the database proxy server, which is customized by user.
A string of up to 64 bytes, which cannot be null.
Proxy IP IP address of the server where the database proxy server is installed.
Proxy Port Port No. specified by the database proxy server, which is defined in installation.
100~60000 9088
Total Connections
The maximum number of the connections between the database proxy server and the report server, which is set in the database proxy server installation.
1~64 10
Note Description of the database proxy server.
A string of up to 250 bytes, which can be null. Null
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-35
4.5.2 Modifying a Database Proxy Server
I. Task description
It is to modify relevant properties of the database proxy server except its ID.
II. Operation instruction
1) Select Proxy List in the window as shown in Figure 4-1, and select a database to be modified in the box on the right. Select [Operation/Modify Proxy] to pop up the Modify Proxy window, as shown in Figure 4-23.
Figure 4-23 Modifying a database proxy server
2) Click <OK> after the modification to finish the operation.
Note:
1) Pressing <Ctrl> or <Shift>, the user can select multiple database proxy servers simultaneously and modify them in batch. 2) In modifying the database proxy servers in batch, double click the text box of the property of the database proxy server, which can change the color of the control. If it is light gray, the property cannot be modified, that is, each database proxy server should keep the property value.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 4 Datasource Management
4-36
III. Field description
For the description of the fields related to the operation of modifying a database proxy server, please refer to Table 4-11.
4.5.3 Deleting a Database Proxy Server
I. Task description
It is to delete a database proxy server from the report system.
II. Operation instruction
1) Select Proxy List in the window as shown in Figure 4-1, and select a database to be deleted in the box on the right. Select [Operation/Delete Proxy] and the system will give the prompt “Are you sure to delete the 1 Proxy(s)?”
2) Click <OK> to finish the deletion. To cancel it, click <Cancel>.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-1
Chapter 5 Report and Template Management
The report and template management of the report system falls into six parts: template group management, sub-template group management, template file management, scheduled task management, report query and statistics, and report template design. Before the operation of report and template management, enter the report management tab by selecting [View/Management Page/Report Management Page] in the report system client manager window, as shown in Figure 5-1.
Figure 5-1 Report management
The contents on the right of the window vary with different objects selected by the user. If the user selects Template Group List, the information of all template groups able to be managed currently will be displayed. If the user selects a specific template group, the sub-template groups and template files contained in this template group will be displayed. If the user selects a specific template file, the corresponding scheduled task of this template file and such local files as report file generated during query with this template will be displayed.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-2
Caution:
Please ensure that only one client performs such non-query operations as addition, modification and deletion to the same template group, sub-template, template file and scheduled task at some moment. Also, ensure that only one client performs design on the same template at some moment. Otherwise, abnormity may occur due to simultaneous operations.
5.1 Template Group Management
The operations related to template group management include creating template groups, modifying template groups, deleting template groups, changing to folder, backing up template groups and restoring template groups.
5.1.1 Creating a Template Group
I. Task description
It is to create a template group in the current report system. After a template group is created, the user can create sub-template groups and template files.
II. Operation instruction
1) Select Template Group List, and then select [Operation/New Template Group] in the window as shown in Figure 5-1.
Figure 5-2 Creating a template group
2) In the New Template Group window, as shown in Figure 5-2, input the related information of template group and then click <OK>. Then a new template group is created.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-3
III. Field description
For the description of the fields related to the operation of creating a template group, please refer to Table 5-1.
Table 5-1 Description of fields related to the operation of creating a template group
Field Description Value range
Template Group ID ID of this template group allocated by the system and automatically maintained by the system
Automatically created by the system, modification by user prohibited.
Template Group Name
Name of the template group defined by the user
A string of 64 bytes at most. It cannot be null. It cannot include the space and such characters as /\, :, *, ?, ”, <, >, |, [, and ] cannot appear. It is unique.
Note Description of the template group A string of 250 bytes at most. It is null by default.
5.1.2 Modifying a Template Group
I. Task description
It is to modify the related information of template group.
II. Operation instruction
1) Select the template group to be modified and then [Operation/Modify Template Group] in the window as shown in Figure 5-1. The system will pop up the Modify Template Group window, as shown in Figure 5-3.
Figure 5-3 Modifying the template group
Modify the related information of template group and then click <OK>.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-4
III. Field description
For the description of the fields related to the operation of modifying a template group, please refer to Table 5-1.
5.1.3 Deleting a Template Group
I. Task description
It is to delete a template group from the report system.
II. Operation instruction
1) Select the template group to be deleted and then [Operation/Delete Template Group] in the window as shown in Figure 5-1.
2) The system will pop up a window prompting “Are you sure to delete the 1 Template Group(s)?” If the user clicks <OK>, the system will fulfill delete the template group. If the user clicks <Cancel>, the system will cancel the operation of deleting the template group.
5.1.4 Changing to Folder
I. Task description
It is to store the template groups, sub-template groups and template files created by the user in the local file system of client of the report system.
Compared with the file system, the storage structure of template group is like a directory. The sub-template groups and template files of this template group are equal to the sub-directories of a directory.
Therefore, changing to folder means entering the local storage directory of template group, sub-template group or template file. If the directory has not been established yet, the system will enter the directory after establishing it.
II. Operation instruction
1) Select a template group and then [Operation/Change to Folder] in the window as shown in Figure 5-1.
2) The system pops up the corresponding operation window, as shown in Figure 5-4.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-5
Figure 5-4 Changing to the corresponding fold
5.1.5 Backing up and Restoring a Template Group
I. Task description
It is to back up and restore the template group as required.
II. Operation instruction
Backing up the template group. 1) Select the template group to be backed up and then [Operation/Backup
Template Group] in the window as shown in Figure 5-1. The system pops up the template group backup window, as shown in Figure 5-5.
Figure 5-5 Backing up the template group
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-6
2) Refer to Section 2.3.2 “Backing up and Restoring the System” for the sequent operations.
Restoring the template group 3) Select Template Group List and then [Operation/Restore Template Group] in
the window as shown in Figure 5-1. The system pops up the template group restoring window, as shown in Figure 5-6.
Figure 5-6 Restoring the template group
4) Refer to Section 2.3.2 “Backing up and Restoring the System” for the sequent operations.
III. Field description
For the description of the fields related to the operations of backing up and restoring template groups, please refer to Section 2.3.2 “Backing up and Restoring the System”.
5.2 Sub-template Group Management
The operations related to sub-template group management include creating sub-template groups, modifying sub-template groups, deleting sub-template groups and changing to folder.
5.2.1 Creating a Sub-template Group
I. Task description
It is to create a sub-template group for some template group.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-7
II. Operation instruction
1) Select the template group to be created with a new sub-template group and then [Operation/New Sub Template Group] in the window as shown in Figure 5-1. The system pops up the New Sub Template Group window, as shown in Figure 5-7.
Figure 5-7 Creating a sub-template group
2) Input the related information of sub-template group and then click <OK>. Then a new sub-template group is created.
III. Field description
For the description of the fields related to the operation of creating a sub-template group, please refer to Table 5-2.
Table 5-2 Description of fields related to the operation of creating a sub-template group
Field Description Value range
SubTempG ID ID of this sub-template group allocated by the system and automatically maintained by the system
Automatically created by the system; modification by user prohibited.
SubTempG Name Name of the sub-template group defined by the user
A string of 64 bytes at most. It cannot be null. It cannot include space and such characters as /\, :, *, ?, ”, <, >, |, [, and ] cannot appear. It is unique.
Template Group ID ID of this template group allocated by the system and automatically maintained by the system.
Automatically created by the system, modification by user prohibited.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-8
Field Description Value range
SubTempG ID
ID of the father template group of this sub-template group. If the parent template group is a template group, this parameter is 0.
Automatically created by the system, modification prohibited.
Created by ID of the user creating the sub-template group
Automatically created by the system, modification by user prohibited.
Created On Time for the creating sub-template group
Automatically created by the system, modification by user prohibited.
Last modified by ID of the last user modifying the sub-template group
Automatically created by the system, modification by user prohibited.
Last modified on The last time of modifying the sub-template group
Automatically created by the system, modification by user prohibited.
Note Description of this sub-template group
A string of 250 bytes at most; It cannot be null It is null by default.
5.2.2 Modifying a Sub-template Group
I. Task description
It is to modify the related information of a sub-template group.
II. Operation instruction
1) Select the sub-template group to be modified and then [Operation/Modify Sub Template Group] in the window as shown in Figure 5-1 .The system pops up the Modify Sub Template Group window, as shown in Figure 5-8.
Figure 5-8 Modifying the sub-template group
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-9
After modifying the related information of sub-template group, click <OK>.
III. Field description
For the description of the fields related to the operation of modifying a sub-template group, please refer to Table 5-2.
5.2.3 Deleting a Sub-template Group
I. Task description
It is to delete a sub-template group from the report system.
II. Operation instruction
1) Select the sub-template group to be deleted and then [Operation/Delete Sub Template Group] in the window as shown in Figure 5-1. The system pops up a window prompting “Are you sure to delete the 1 Sub Template Group(s)?”
2) If the user clicks <OK>, the system will delete the sub-template group. If the user clicks <Cancel>, the system will cancel the deletion operation.
5.2.4 Changing to Folder
The operation of changing to folder of sub-template is totally identical with that of template group. Therefore, please refer to Section 5.3.7 “Changing to Folder”.
5.3 Template File Management
5.3.1 Creating a Template File
I. Task description
It is to create a new template file under a template group or a sub-template group. The template file is a binary file shared by all users, with the extension name FRF. The user can choose a template file to query and obtain the *.FRP report file.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-10
Note:
1) Template file design can start after a new template file is created. Refer to Section 5.5.1 “Designing a Template File” for the detailed operation procedure. 2) The user can invoke the template file to query for report. Refer to Section 5.5.2 “Querying a Template File” for the detailed operation procedure. 3) For the report with statistic time limit, create a new scheduled task for its template file. Refer to 5.4.1 “Creating a Scheduled Task” for the detailed operation procedure.
II. Operation instruction
1) Select the template group or sub-template group to be created with new template file and then [Operation/New Template] in the window as shown in Figure 5-1. The system pops up the New Template window, as shown in Figure 5-9.
Figure 5-9 Creating a template file
2) Input the related information of template file and then click <OK> to fulfill the operation of creating a new template file.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-11
III. Field description
For the description of the fields related to the operation of creating a template file, please refer to Table 5-3.
Table 5-3 Description of fields related to the operation of creating a template file
Field Description Value range
Template ID ID of this template file in the report system allocated by the system
Automatically maintained by the system; modification by user prohibited.
Template Name Name of the template file defined by the user
A string of 64 bytes at most. It cannot be null. It cannot include space and such characters as /\, :, *, ?, ”, <, >, |, [, and ] cannot appear. It is unique.
Template Group ID ID of this template group allocated by the system
Automatically created by the system; modification by user prohibited.
SubTempG ID
ID of the parent template group of this sub-template group. If the parent template group is Template Group, this parameter is 0.
Automatically created by the system; modification prohibited.
Created by ID of the user creating the template file
Automatically created by the system; modification by user prohibited.
Created on Time for creating the template file
Automatically created by the system; modification by user prohibited.
Last modified by ID of the last user modifying the template file
Automatically created by the system; modification by user prohibited.
Last modified by The last time for the template file being modified
Automatically created by the system; modification by user prohibited.
Note Description of this template file A string of 250 bytes at most. It is null by default.
Report The report is saved as report file after being queried. It can be opened with report browser.
Selected or not selected. Not selected is the default value.
XML File The report is saved as XML file after being queried. It can be opened with IE browser or text editor.
Selected or not selected. Not selected is the default value.
EXCEL File The report is saved as Excel file after being queried. It can be opened with Excel.
Selected or not selected. Not selected is the default value.
Txt File The report is saved as Txt file after being queried. It can be opened with text editor.
Selected or not selected. Not selected is the default value.
Display Report
Whether to display the report immediately after the query. Creating report will spend much time and many memories. For the report with lots of data, do not select Report and Display Report, saving it as other local data file. Thus, processing time and resource occupation can be greatly diminished.
Selected or not selected. Selected is the default value.
Only Save The New File
The old local data file will be deleted at each query, thus to diminish the space occupation.
Selected or not selected. Selected is the default value.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-12
Field Description Value range
User-defined File Name
If this check box is checked, users will be inquired about the data file name before querying; otherwise, a combination of the current date and time YYYY/MM/DD HH.MM.SS will be adopted as the name format. This function does not apply to scheduled task.
Selected or not selected. Not selected is the default value.
Exit When Query Complete
Return to the manager window after the query if this check box is checked; otherwise, remain in the query window and the user can reset conditions to query.
Selected or not selected. Not selected is the default value.
5.3.2 Modifying a Template File
I. Task description
It is to modify the related property of the template file.
II. Operation instruction
1) Select the template file to be modified and then [Operation/Modify Template] in the window as shown in Figure 5-1 . The system pops up the Modify Template window, as shown in Figure 5-10.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-13
Figure 5-10 Modifying the template file
2) After modifying the related information of template file, click <OK>.
III. Field description
For the description of the fields related to the operation of modifying a template file, please refer to Table 5-3.
5.3.3 Deleting a Template File
I. Task description
It is to delete a template file from the report system.
II. Operation instruction
1) Select the template file to be deleted and then [Operation/Delete Template] in the window as shown in Figure 5-1. The system pops up a window prompting “Are you sure to delete the 1 Template(s)?”
2) If the user clicks <OK>, the system will delete the template file. If the user clicks <Cancel>, the system will cancel this operation.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-14
5.3.4 Downloading a Template File
I. Task description
It is to save the template file in frf to the local PC.
II. Operation instruction
1) Select the template file to be downloaded and then [Operation/Download Template] in the window as shown in Figure 5-1. The system pops up the Save As dialog box, as shown in Figure 5-11.
Figure 5-11 Selecting the path of downloading the template file and the file name
2) Select the path of downloading the template file and input the file name (the default file name: The name of template file. frf) for saving.
3) Click <Save> to fulfil the operation of downloading the template file.
5.3.5 Uploading a Template File
I. Task description
It is to upload the local .frf file of the template file to the report server.
II. Operation instruction
1) Select the template group or sub-template group whose template file needs to be uploaded and then [Operation/Upload Template] in the window as shown in Figure 5-1. The system pops up the Open dialog box, as shown in Figure 5-12.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-15
Figure 5-12 Selecting the template file to be uploaded
2) After selecting the template file to be uploaded, click <Open>. The system generates a template file under the current template group or sub-template group.
5.3.6 Upgrading a Template File
I. Task description
It is to use the local template file to overwrite the template file on the report server, so as to upgrade the template file of report server.
II. Operation instruction
1) Select the template file to be upgraded and then [Operation/Update Template] in the window as shown in Figure 5-1. The system pops up the Open dialog box, as shown in Figure 5-13.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-16
Figure 5-13 Selecting the local template file
2) After selecting the local template file, click <Open> to upgrade the template file of report server.
5.3.7 Changing to Folder
The operation of changing to folder of template file is similar to that of template group. Therefore, please refer to Section 5.1.4 “Changing to Folder”.
5.4 Scheduled Task Management
5.4.1 Creating a Scheduled Task
I. Task description
It is to create a new scheduled task for a template, so as to query the report at the specified time.
Note:
For the reports with statistic time limit (e.g. daily reports need statistics at 4 a.m. every day, monthly reports need statistics on the first day of each month, etc.), create a scheduled task for its template file.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-17
II. Operation instruction
1) Select the template file to be created with new scheduled task and then [Operation/New Schedule] in the window as shown in Figure 5-1. The system pops up the New Schedule window, as shown in Figure 5-14.
Figure 5-14 Creating a scheduled task
Caution:
Only if the check box Activate This Schedule is checked, and after it is monitored and meets the execution condition, the scheduled task can be executed automatically. For the related operations of monitoring the scheduled task, refer to Section 2.3.1 “Schedule Monitor”.
2) Select Schedule Type and Schedule Start Date. Then, click <Advanced>. The system pops up the window for setting the advanced property of scheduled task, as shown in Figure 5-15.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-18
Figure 5-15 Setting the advanced property of scheduled task
3) After setting the advanced property of scheduled task, click <OK> to return to the New Schedule window.
4) Click <OK> to create a new schedule.
III. Field description
For the description of the fields related to the operation of creating a scheduled task, please refer to Table 5-4.
Table 5-4 Description of fields related to the operation of creating a scheduled task
Field Description Value range Default
Schedule Type
The scheduled tasks are divided into several types according to their execution frequency. If you want to execute it more than once in a period, e.g. twice a month, you can create two scheduled tasks executed on a monthly basis.
Only once, once an hour, once a day, once a week, once a month, once a year or once every certain days
Schedule Start Date
Start date of executing scheduled task, available for all types of scheduled tasks
The format is YY-MM-DD. It can be chosen by user with the date drop-down list box.
Schedule Start Time
Start time of executing scheduled task, available for all types of scheduled tasks
The format is HH-MM-SS. It can be chosen by user with the date drop-down list box.
Every
It is used to set the interval between the scheduled tasks. It is valid only when Schedule Type is once every certain days.
It can be selected with the drop-down list box or be input manually. It is of integer.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-19
Field Description Value range Default
Scheduled task execute week
It is used to set the specific day of a week for the scheduled task execution. It is valid only when Schedule Type is once a week.
Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday
Activate this Schedule
It determines whether the scheduled task is activated. Only the activated scheduled task can be executed.
Activated or inactivated Activated
Previous Operation It is the operation immediately before the scheduled task is executed.
It is executed automatically. If the query condition is defined by the user, adopt the default value. Open the window for setting the query condition. Execute the operation after inputting condition.
It is executed automatically. If the query condition is user-defined, adopt the default value.
Next Operation It is the operation after the scheduled task is executed.
Automatically return to the monitor at once to continue monitoring the scheduled task. Display the obtained report in the report browser.
Automatically return to the monitor at once to continue monitoring the scheduled task.
Additional Condition
It is used to set the query condition for the scheduled task, which will be automatically added in the Where part of the SQL statement for report query. It is invalid for customized SQL or reports using stored procedure.
Append query condition or not append query condition A string of 250 bytes at most. Completed and valid SQL conditions are required. Time macro supported.
Not append query condition
Data Keep In Server
It determines whether to save the data in the report server.
Currently only not data saving is supported by the report server.
Not save data
Allow The Automatic Invalidation
It allows automatic invalidation of the scheduled task at the specified time; two modes available: To Delete and To Deactivate. The scheduled task executed only once will be automatically deactivated after being executed.
Allow the automatic invalidation or not allow the automatic invalidation
Note:
1) Additional Condition is the most commonly used advanced property. Time macro is allowed in the additional query condition. 2) The format of macro time is [Time format, difference of execution and current time]. In parameter difference of execution and current time, + means time behind and – means time ahead. Y stands for year, M for month, D for day and H for hour. The smallest unit is hour.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-20
Example:
Suppose the current execution time of some scheduled task is 12:00:00 06-26-2002, the returned results of time macro and their meaning are shown in Table 5-5.
Table 5-5 Example of using time macro
Time macro Returned result Meaning [YYYY-MM-DD HH:MM:SS] 2002-06-26 12:00:00 Current execution time
[YYYY-MM-DD HH:MM:SS, -H2] 2002-06-26 10:00:00 Two hours ahead of the current execution time
[YYYYMMDDHHMMSS,+D5] 20020703120000 Five days behind the current execution time
[YYYY-MM-DD, -M1] 2002-05-26 One month ahead of the current execution time
[YYMMDD, +Y2] 040626 Two years behind the current execution time
"(StatDate >= '[YYYY-MM-DD, -M1]') and (StatDate < '[YYYY-MM-DD]')" are usually used in the monthly statistic report, indicating that the time range for querying the report is from the last month to the current execution time.
5.4.2 Modifying a Scheduled Task
I. Task description
It is to modify the related property of some scheduled task.
II. Operation instruction
1) Select the scheduled task whose property is to be modified and then [Operation/Modify Schedule] in the window as shown in Figure 5-1. The system pops up the Modify Schedule window, as shown in Figure 5-16.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-21
Figure 5-16 Modifying the scheduled task
2) Modify the property of the scheduled task. Or click <Advanced> to modify the advanced property of the scheduled task.
3) After the modification is completed, click <OK> to modify the scheduled task.
III. Field description
For the description of the fields related to the operation of modifying a scheduled task, please refer to Table 5-4.
5.4.3 Deleting a Scheduled Task
I. Task description
It is to delete the scheduled task.
II. Operation instruction
1) Select the scheduled task to be deleted and then [Operation/Delete Schedule] in the window as shown in Figure 5-1. The system pops up a window prompting “Are you sure to delete the 1 Schedule(s)?”
2) If the user clicks <OK>, the system will delete the scheduled task. If the user clicks <Cancel>, the system will cancel the deletion operation.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-22
5.5 Report Query and Management
5.5.1 Designing a Template File
I. Task description
It is to enter the report designer window to design the report.
II. Operation instruction
1) Select the template file to be designed and then [Operation/Design Template] in the window as shown in Figure 5-1. The system pops up the report designer window, as shown in Figure 5-17.
Figure 5-17 Report designer
2) The user can perform the operations related to the report design in this window, such as configuring the datasource for report access, customizing the advanced properties of field and setting controls. For the detailed operations, refer to Module 5 “Report Customization Examples”.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-23
5.5.2 Querying a Template File
I. Task description
It is to query the database according to the designed template file to generate report.
II. Operation instruction
1) Select the designed template file and then [Operation/Query Template] in the window as shown in Figure 5-1.
2) If query condition, sorting condition or query statement has been set upon the report design, the system will pop up the query window, as shown in Figure 5-18. Otherwise, the system will execute the query operation automatically without popping up the query window. After the related query condition is set, click <OK>.
Figure 5-18 Querying the report system
Note:
The window as shown in Figure 5-18 is only an example of the report system query window. The window will vary with the different template file designed by the user. At most five areas will be included in this window. For the detailed description, refer to Table 5-6.
3) Finally, the system will pop up the report browsing window, as shown in Figure 5-19. Meanwhile, the newly generated report file will be added in the right box.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-24
Figure 5-19 Browsing the report
III. Field description
A complete report query window consists of heading area, condition list area, input area, buttons and SQL information area. Please refer to Table 5-6 for details.
Table 5-6 Description of related areas in the report query window
Area Description
Heading area Top part of the window, as shown in Figure 5-18, providing some prompt to the user
Condition list area Middle part of the window, as shown in Figure 5-18, in which the user can set the information related to the query field or sorting.
Input area Not displayed in the window, as shown in Figure 5-18, generally under Condition list area. The user can input a part of the SQL statement for powerful function.
Button area The area of the window, as shown in Figure 5-18, where such buttons as <SQL>, <OK>, <Cancel>, etc are located The user can click the button as required.
SQL information area
The lowest part of the window, as shown in Figure 5-18, which displays the generated SQL statement in real time and can be hidden by clicking <SQL>. Only if Show SQL or Hide SQL is set in the operation of setting the report query window, this area may appear. Please refer to “Setting the Report Query Window” part.
Please refer to Table 5-7 for the detailed attention points in setting Query Field, Custom Sorting and Custom SQL in the report query window.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-25
Table 5-7 Complement for the description of report query window
Field Description
Sign 1, Value 1 It sets a condition of a certain field. For instance, if the field stands for month, sign 1 means later than and value 1 indicates February, the meaning of this field is the month later than February.
Sign 2, Value 2 It sets another condition of a certain field. It is valid only if And/Or is set. For instance, if the field stands for month, then sign 2 means earlier than and value 2 indicates June. The meaning of this field is the month earlier than June.
And/Or It shows the relationship between the two conditions of a field. If it is set to And, the query condition of the month field is that the month is between February and June.
And / Or column It sets the relation between the condition of the current line and that of the next line.
Query Field
Note It is the description about this line, e.g. value range, meaning of the current condition. By clicking the button, a dialog box will pop up to display the note.
Custom Sorting Sign 1, value 1 It sets the sorting type based on this field. Ascending order, descending order and not sorting (select the option without value in the drop-down list) are optional.
Adding the From statement manually
Input manually the From statement after the previous From statement. It is usually "Sign, Table name”, e.g. “, Table1”.
Setting the From statement manually
Input manually the From statement to overwrite the previous From statement. It is usually "Table Name1, Table Name2 …”, e.g. “Table1, Table2”.
Adding the Where statement manually
Input manually the Where statement after the previous Where statement. It is usually "Sign condition”, e.g. “And (Ranged = 100)”.
Custom SQL
Setting the Where statement manually
Input manually the condition statement to overwrite to the previous Where statement. It must be a completed condition, e.g. “(Tableid=14) And (Rangeid=100)”.
5.5.3 Displaying a Report File
I. Task description
It is to browse the report file generated upon querying the template file.
II. Operation instruction
1) Select the template file queried in the window as shown in Figure 5-1 and the generated report file in the right box.
2) Select [Operation/Display Report File], and the system pops up the report browsing window, similar to Figure 5-9.
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-26
5.5.4 Deleting a Report File
I. Task description
It is to delete the report file generated upon querying the template file.
II. Operation instruction
1) Select the template file of the report file to be deleted in the window as shown in Figure 5-1and the report file to be deleted in the right box.
2) Select [Operation/Delete Report File], and the system pops up a window prompting “Are you sure to delete the Report File(s)?”
3) If the user clicks <OK>, the system will delete the report file. If the user clicks <Cancel>, the system will cancel the deletion operation.
5.5.5 Copying a Report File
I. Task description
It is to save the report file to the local PC. It can be frf, as well as Excel, HTML, TXT format, and so on.
II. Operation instruction
1) Select the template file for saving the report file in the window as shown in Figure 5-1 and the report file to be saved in the right box.
2) Select [Operation/Copy Report File], and the system pops up the Save As dialog box, as shown in Figure 5-20.
Figure 5-20 Saving the report file
User Manual iManager M2000 Intelligent Report System
Client ManagementChapter 5 Report and Template Management
5-27
After selecting or inputting the saving path, file name and saving type of the report file, click <Save>. The system will copy the report file.
HUAWEI
iManager M2000 Intelligent Report System User Manual
Introduction to Report Designer
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerTable of Contents
i
Table of Contents
Chapter 1 Introduction to Report Designer ................................................................................ 1-1 1.1 Main Menu of Report Designer.......................................................................................... 1-1 1.2 Toolbar............................................................................................................................... 1-4 1.3 Font Tools .......................................................................................................................... 1-5 1.4 Report Object Bar .............................................................................................................. 1-5
1.4.1 What is An Object Bar............................................................................................. 1-5
1.4.2 Report Band- ..................................................................................................... 1-6
1.4.3 Sub Report- ....................................................................................................... 1-8
1.4.4 Rectangle Text Object- ..................................................................................... 1-8
1.4.5 Picture- ............................................................................................................ 1-14
1.4.6 Scribe- ............................................................................................................. 1-14
1.4.7 Chart- .............................................................................................................. 1-14
1.4.8 Shadow Rectangle Object..................................................................................... 1-17
1.4.9 Shapes- .......................................................................................................... 1-18
1.4.10 Introduction to Object Inspector .......................................................................... 1-20 1.5 Alignment Toolbar............................................................................................................ 1-22 1.6 Report Preview Toolbar ................................................................................................... 1-23
Chapter 2 Report Design .............................................................................................................. 2-1 2.1 Entering the Report Designer Window .............................................................................. 2-1
2.2 Datasource Manager- .................................................................................................. 2-2
2.2.1 Overview ................................................................................................................. 2-2 2.2.2 Define data source .................................................................................................. 2-4
2.3 Set Variables- ............................................................................................................ 2-16
2.4 Customizing Advanced Properties of Query Field- .................................................. 2-18
2.5 Customizing Advanced Properties of Sorting- ......................................................... 2-22
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerTable of Contents
ii
2.6 Creating a Macro- ..................................................................................................... 2-23
2.7 Setting the Report Query Window- ............................................................................ 2-26
2.8 Editing the Report Note ................................................................................................... 2-27
2.9 Report Template Builder- ........................................................................................ 2-28
2.10 Adding Statistic Charts into the Report- .................................................................. 2-30
2.11 Querying the Statistic Report......................................................................................... 2-31
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-1
Chapter 1 Introduction to Report Designer
This chapter mainly describes the report designer on such aspects as main menu, toolbar, report object bar, and so on.
1.1 Main Menu of Report Designer
I. Main menu
Figure 1-1 Main menu
II. Menu items
[File] menu
The [File] menu for template design contains all submenus listed in Table 1-1.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-2
Table 1-1 Template [File] submenus
Submenu items Function
DataSource manager It is used to define the accessed data source of the report template. All report data are obtained from the data defined in this wizard.
Data dictionary It is used to set the alias of the data field so as to simplify the field.
Report setting List all printer information available in the system. If no printer is available, you may select one.
Default printer options It can be used to preview but not print reports. Select [Select When Loading a File] to save the printer information in the report. This printer information will be displayed upon next reading.
Page setup It is used to configure all information such as paper size, etc. Preview Preview report Close Exit from the design interface.
[Edit] menu
The [Edit] menu for template design contains all submenus listed in Table 1-2.
Table 1-2 Submenus of the [Edit] menu for template design
Submenu items Function Submenu items Function Cancel Cancel the last operation Redo Redo: repeat the last operation. Cut Cut data to clipboard Copy Copy data to clipboard Paste Get data from clipboard All Select all objects Delete Delete selected object Edit Edit object attribute
[Tool] menu
The [Tool] menu contains all submenus, as shown in Table 1-3.
Table 1-3 Submenus of [Tool] menu
Submenu items Function Toolbar It is used to show/hide all necessary elements for the report design under the toolbar.Toolbox It is used to automatically insert data field tools Option Configuration of the report design environment
[Menu] items
Click [Options] submenu, then an option configuration window will pop up, as shown in Figure 1-2.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-3
Figure 1-2 Option setting
Table 1-4 describes the option configuration
Table 1-4 Option configuration description of report design environment
Column Meaning Show grid Whether to show the grids of the design environment Align to grid The object can be for one grid each time Drawing objects Whether to show object content during movement Grid size Including three kinds of pixels as 4/8/18 Report units Including 3 units: pixel, mm and inch
Designer page
Page position 3 locations: center, left and right Colored buttons Whether to show the button colors
Editing after insert Whether to add an object, which can automatically display the Edit window.
Show report band titles Whether to show the title of the report band object Others
Localize property names Whether to display the localized attribute name in the object viewer, Use the object’s font All editors use the font of this object Editor page Use fixed setting Each editor uses specified font
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-4
1.2 Toolbar
Figure 1-3 Toolbar
When the cursor stays on the shortcut button for 2 seconds, the system will pop up the description of this button. All shortcut buttons are described in the following table in detail:
Table 1-5 Shortcut functions in the template design toolbar
Shortcut Name Detailed explanation
Query definition wizard It is used by the user to define the accessed data source of the report template. All report data are obtained from the data defined in this wizard.
Set variables alias It is used to set the alias of the data field so as to simplify the fields.
Preview Preview the report
Undo Cancel the last operation
Redo Repeat the last operation
Cut Cut data to clipboard
Copy Copy data to clipboard
Paste Get data from clipboard
Select all Select all objects
Bring to front Place the selected object in the front so that other objects do not cover it.
Page options It is used to configure all information including paper size, etc.
Grid It is used to show the grid of design interface, and to align all objects
Grid align Move the object one grid each time
Fit to grid Each peak of the object is aligned with the grid point. If not, the system will automatically align such peak with the grid point.
Close designer Exit from the design environment
Rotate 90 degrees The specified object rotates for 90 degrees
Top frame line Line appears at the top of the specified object.
Bottom frame line Line appears at the bottom of the specified object.
Left frame line Line appears on the left side of the specified object.
Right frame line Line appears on the right side the specified object.
All frame line Lines appear at the four sides of the specified object.
No frame No lines at the four sides of the specified object.
Background color Set background color for the object
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-5
Shortcut Name Detailed explanation
Frame color Set the color of the object border line
Frame size Set the size of the object border line
Insert DB field Insert the selected database field for a report automatically
1.3 Font Tools
Figure 1-4 Font toolbar
Table 1-6 Font toolbar
Icon Descriptions
Set font
Set font size
Set the font as bold, italic and underlined
Set text color
If the specified condition is satisfied, all set objects will be displayed in the preset condition.
It is used to set the Alignment mode (align against the left, center or the right)
The font can be aligned against the top, align against the center vertically and align against the bottom
1.4 Report Object Bar
1.4.1 What is An Object Bar
The object bar is used to display data set or self-defined information. You can place the self-defined information in the report object bar to customize report.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-6
Figure 1-5 Report object bar
1.4.2 Report Band-
This system is a report generating tool based on the report band design style. The report band of the intelligent report system includes report title, report summation, page header and footer, main item header, main item data, column header and footer, group header and footer.
Click and drag it to the design interface, then the system will pop up a window of
Insert New Report Band Type as shown in Figure 1-6.
Figure 1-6 Select report band type
Table 1-7 describes the report bands and their usage.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-7
Table 1-7 Report band type
Report band Usage description Report title Used to show the report title. This report band cannot be repeatedly used.
Report summary Used for calculations such as summation and statistics. This report band cannot be repeatedly used.
Page header Used to show the data at the beginning of each page. This report band cannot be repeatedly used.
Page footer Used to show the data at the end of each page. This report band cannot be repeatedly used.
Master/Detaile/Subdetail/Cross header Used to show the data title of each column. This report band may be repeatedly used.
Master/Detaile/Subdetail/Cross data
It is to show all data records, and the major part of the report. Multi-line data will be shown if the rectangular text is placed above and the relationship with the field has been properly set. This report band may be repeatedly used.
Master/Detaile/Subdetail/Cross footer It is the statistics of the main data. This report band may be repeatedly used.
Column/Group header Used to add the bar information in the header and main data. It is shown on each page. This report band may be repeatedly used.
Column/Group footer Used to create column/group report. Column/Group report indicates the report classification of the specified value/field. For example, the report band may be classified according to the product category. Each product category is a group. This report band may be repeatedly used.
Once the report band type is selected, you can edit other report object elements. For example:
Select the Insert Page Header report band, then you can add several rectangle
text objects to display the field title.
Select the Insert Main Item data report band, then you can add a number of
rectangle text objects representing the data fields on the report band, and use
them to display the report data of the corresponding query result.
Caution:
To make a rectangle show the data field value, you must associate this rectangle with the data field or the variable.
Select to insert the report band Main Item Footer to perform statistics for the main
item data. Add rectangle text object to get the summation and average value,
etc. You can also directly enter the function in the text editor.
The detailed operation procedures are described in section 1.4.3 .
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-8
1.4.3 Sub Report-
It is used to add another page when designing the report template.
1.4.4 Rectangle Text Object-
It is used to set multi-line text in a report, including setting the shape, color, size, font, alignment mode and rotation of the text. It can also be used to set the variable, data field and expression of the text, and to associate database fields.
Click to place a rectangle object on the window, then the system will automatically
pop up an Edit window in which you can input data. You may enter all kinds of characters, associated data field or system variables, etc.
Figure 1-7 Rectangle text object
The rectangle text is used very frequently. It can be used for text edition, such as inserting expressions and data fields, etc. Figure 1-8 shows the toolbar of the text editor.
Figure 1-8 Text editor
The format editor may be used to set the variable format of the text. The variables may be displayed as plain text, numerical values, date, time and Boolean value.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-9
The buttons of the editor toolbar are described in Table 1-8.
Table 1-8 Description of editor toolbar
Button Name Descriptions
Insert Expression Insert functions, data fields, variables, etc.
Insert data field Insert data field
Cut Cut to clipboard
Copy Copy data to clipboard
Paste Get data from clipboard
Auto line feed Automatically shift line upon data input (A long character string can be fed as several lines)
Cancel Exit without saving the input
OK Exit after saving input
Note:
The text object can also be used for other setting, such as: Stretch Option: the character string of the text determines the object height. The report option switch of the object must be open. Upon printing, the object will calculate the maximum height according to the stretch option. Auto Size Option: The object dimension will be automatically set.
I. Insert expression
You can enter the function format directly in the text editor for data statistics like summation or averaging value. The expression editor is shown in Figure 1-9.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-10
Figure 1-9 Expression editor
a. Description of editor buttons
Buttons Descriptions
Used to show the field selection window.
Used to show variable selection window.
Used to show the function selection window. From left to right, such buttons are: plus, minus, times, divide, equal to, unequal to, greater than, smaller than, greater than or equal to, smaller than or equal to, And, Or, Not. Each button can be used to add a symbol into the editor which has the related function. For instance, click <Add> button, "+" symbol will be added in the expression input box.
b. Click the <Function> button in this window, a window will pop up
as shown in Figure 1-11, in which you can edit an expression.
Descriptions for Common Functions:
AVG: Used to calculate the average value. For example: To get the average of Table A "EmpNo",you need to input AVG ([MainRptDataSet."EmpNo"]) in the editor, then you can get the average of the field "EmpNo", in which MainRptDataSet is the data set specified by the system. The Table A data set is also contained in this data set. Therefore the meaning of this expression is to calculate the average of the field "EmpNo" in Table A data set.
Count: Used to calculate the total lines of record. For example: To calculate the records in Table A, you can input the expression Count(Band1) in the Edit box. In
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-11
this expression, Band1 is the position for the object name of the main item data Band.
Date: Return to the current date. For example: To add the current date in the report, you can input the expression [DATE] in the Edit box. Note: the "[ ]" symbol must be used to enclose the input expression.
FORMATDATETIME: It is used to format the date output format. For example: To get the date output format yyyy-mm-dd, you can use the following expression: [FORMATDATETIME( 'yyyy-mm-dd',[date])].
Time: Used to get the current time of the system. MAX: It is used to get the max. value of a field. The method is described in the Use
of AVG Function. MIN: It is used to get the min. value of a field. The method is described in the Use
of AVG Function PAGE#: Return to the current page. Upon printing, the report page No. may be
required. You can input [PAGE#] to get this number. SUM: It is used to calculate the summation of fields. The method is described in
the Use of AVG Function TOTALPAGES: It is set to show the total page number and often used at the end
of a report.
Caution:
To use this function, you must tick the option "Twice Report" in the "Report Setting" menu.
ROUND: Its use is the same as that of the AVG function.
Direct manual calculation: The manual calculation method can be directly adopted if the result is displayed after the calculation of several fields. For example, if the result needs to be displayed in the report after field No1. is added into Field No. 2, you may input the expression [[MainRptDataSet." Field No.1"]+ [MainRptDataSet."Field No.2"]].
To get more information about a function, click this function, then the description of it will appear on the lower part of the window, as shown in Figure 1-10.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-12
Figure 1-10 Function selection
For example: after selecting the AVG function, you should select the fields for this function to get the average value to implement the "Insert Expression" function in the rectangle text object (of course, this rectangle text object must be a text object added in a report band).
c. In this window, click <Variable> , then a variable selection window
will appear as shown in Figure 1-11. You should select a variable to associate with the text objects, or as an element of the expression.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-13
Figure 1-11 Insert a window for variables
Besides the variables in "Return Field, Query Conditions", other variables like variables in the "System Variables" are also be applicable. After selection, click <OK> to save the setting.
d. In this window, click the <Field> button , then a field selection
window will appear as shown in Figure 1-12.
Similarly, you can also set the relationship between other rectangle objects and fields or variables.
II. Insert data field-
To make a rectangle show the numerical value of the data field, this rectangle must be associated with the data field or the variable. Firstly enter the rectangle edit box, click <Insert Field> button, then select a field for association in the popup window, as shown in Figure 1-12.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-14
Figure 1-12 Insert a window for data field
1.4.5 Picture-
Set picture in the report based on BMP/WMF/ICO/JPG format. The picture may be specified either from the file or from the large binary field of the database. The following options may be set for graphics:
Stretch: Stretch the graphic to fill the rectangular box of the object.
Aspect ratio: Keep proper vertical and horizontal ratio when the object is being drawn.
Center: Set the graphic in the center of the rectangular box.
1.4.6 Scribe-
This tool is be used to draw a horizontal or vertical line, to draw table lines. The user can set the line width and line color.
1.4.7 Chart-
To set the chart object corresponding to the main item data, firstly use the chart object to drag a report band of the main item data type to the interface, then set its data source as a virtual data set.
I. Chart object type
After inserting the chart object into the design interface, the system will pop up a chart attribute setting window, as shown in Figure 1-13.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-15
Figure 1-13 Set chart type
The data to be entered into the chart type setting window are described in Table 1-9.
Table 1-9 Data entered in the chart type setting window
Input data Descriptions 3D Whether to display the 3D effect (The default is 3D display) Single Whether to display single border line (The default is single line) Show legend Whether to display the coordinate axes Show marks Whether to display flags on the chart (The default is to display flags) Multi-color Whether to display the chart in colors (The default is color display)
II. Chart object data
Figure 1-14 Set chart object data
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-16
Table 1-10 Data entered in the chart data setting window
Input data Descriptions
For legend Write the name of the object to be displayed on the X-axis. In the figure the object name is memo1.
For value Write the name of the object to be displayed on the Y-axis. In the figure the object name is memo1.
Top group Display the last X values. X is determined by the data entered.0 indicates that the number is not limited.
Label It is valid only when the top display is not 0. Get the summation of the remaining packet data, and name the summation with the label value and display it at the end of the chart.
III. Chart object marks
Figure 1-15 Set chart object marks
The data to be entered in the icon flag setting window are described in Table 1-11.
Table 1-11 Data entered to set icon flag
Input data Descriptions Value The Y value of the chart is displayed on the chart top . Percentage The percentage of the chart in the total is displayed on the chart top. Label The X value of the chart is displayed on the chart top. Label and percent The X value and the percentage of this chart in the total are displayed on the chart top.Label and Value The X value and Y value of the chart are displayed on the chart top.
Five types of charts can be used in the report: line, point, bar, zone and cake.
Two text objects must be specified for the chart data as value and legend.
The text object of a chart value should include format symbols, such as "10 000.00" or "$100.00". The system will automatically pick the figure from the text and ignore all non-figure symbols. Higher formats like "10000km2" cannot be used as numerical value
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-17
of the chart. The chart value can only be invisible objects created with the same content but without format.
1.4.8 Shadow Rectangle Object
The shadow rectangle object is used to show the special display effect and make the report attractive. Drag a shadow rectangle object from the design toolbar to a report, this rectangle object will automatically display the attribute edit box. The "Attribute Edit Box" is illustrated in Figure 1-16.
Figure 1-16 Attribute editor window
The data parameters to be entered in the editor window for shadow rectangle attributes are described as follows.
The left window is used to enter data which can be a normal character string, or an expression or a data field.
The curve option indicates whether the four corners of the shadow edit box are round. The value in the nearby editor box can be used to control the rounding degree of each corner
The shadow width indicates the shadow area size of the shadow rectangle object. The color indicates the foreground color of the shadow rectangle object.
When the Italics Color is selected, the right option may change as shown in Figure 1-17.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-18
Figure 1-17 Color setting
The parameters for the color selection window are described as follows.
Style: direction of the graded colors. Start color: the start color of the graded colors. End color: the end color of the graded colors.
1.4.9 Shapes-
In the report, following shapes can be generated: round, ellipse, rectangle, round-angle rectangle, triangle, Diagonas, and so on.
The object viewer should be used to set the shape type. Select this object, press <F11> or select [Tool/Toolbar/Object Viewer], then you can activate the object viewer, as shown in Figure 1-18.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-19
Figure 1-18 Set object attributes
The "Shape" attributes are used to change the object shape.
Table 1-12 describes the optional parameters of "Shape" attributes.
Table 1-12 Style parameters of object shape attributes
Parameters Descriptions SkRectangle Rectangle gsRoundRectangle Round-angle rectangle SkEllipse Round gsTrangle Triangle gsDiagonal1 Left diagona gsDiagonal2 Right diagona
Table 1-13 describes the normal attributes in the attribute setting window for the objects shown in Figure 1-18.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-20
Table 1-13 Normal object attributes
Attribute Descriptions BandAlign It is used to select the alignment mode for objects in the report band FillColor Background color of the object Border line color Object border line color Border line type The type of the object border line Border line width Width of the border line Height Object height Left margin X-axis position of the object
Contents Invoke the input contents of the text editor, but if the object does not support the content display, this attribute is invalid
Top margin Y-axis value of the object Visible Whether the user can see the object Width Object width
AutoWidth When the object length range is not large enough to display all the contents, the contents will be displayed in the next line automatically
Restrictions: 1. Memo cannot be edited 2. Contents cannot be edited 3. Cannot be modified 4. Size cannot be changed 5. Cannot be moved 6. Cannot be deleted
Set a restriction to this object, for example: this object cannot be edited, or deleted, etc. 1. This object cannot be used to edit the displayed content 2. No content can be edited, nor any Edit window pops up 3. The object cannot be modified 4. The object size cannot be changed 5. The object cannot be moved 6. The object cannot be deleted
Stretched The object contents automatically fill the whole object display space psSolid line psDash line psDot line psDashDot combination psDashDotDot conbination
Border line type
psDouble line
1.4.10 Introduction to Object Inspector
When insert a report object, if it is necessary, user can set its attributes in order to output correct and applied Excel report format.
Example: Insert a Rectangle Text Object.
Select the Rectangle Text Object, press F11 or select [Tools/Toolbars/Object inspector]. In “Object inspector” window, as Figure 1-19 shown, about those detailed description of attributes, please refer to 1.4.9 chapter.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-21
Figure 1-19 Object inspector
User can design the output format of report by setting its “GridOption” item. The process is shown as Figure 1-20.
Figure 1-20 Object position in grid
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-22
Column number in the grid : Which column does the rectangle text object locate in the certain band?
Row number in the grid: Which row does the rectangle text object locate in the certain band?
Width (how many columns): How many columns does the rectangle text object cover in the certain band?
Height (how many rows): How many rows does the rectangle text object cover in the certain band?
Example, if “Total” item need cover two rows in output report, it can be realized by setting “GridOption” in Object inspector window.
Once report is output, user can export it as frp, Excel, htm, txt format, and so on.
Figure 1-21 Browsing report
1.5 Alignment Toolbar
Figure 1-22 Alignment toolbar
This align toolbar can be used to arrange multiple design objects in a certain order. (The first selected object will be used as reference.) Table 1-14 describes the functions of the alignment toolbar.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 1 Introduction to Report Designer
1-23
Table 1-14 Alignment toolbar functions
Tool name Function description Align along the left edge Align against the left edge of the first object Horizontally align against the center Align against the horizontal center of the first object
Equal width Equal width: The width of the first selected object is set as the width of all selected objects.
Horizontally layout Horizontally lay out the selected objects in certain spacing Align along the right edge Align against the right edge of the first object Align along the top Align against the top of the first object Align against the vertical center Horizontally align along the first object
Equal height Equal Height: The height of all selected objects is set as the height of the first selected object.
Vertical and even distribution Vertically arrange all selected objects in specified spacing vertically Align along the bottom Align against the bottom of the first object
1.6 Report Preview Toolbar
Figure 1-23 Report preview toolbar
Table 1-15 Report preview toolbar
Controls Descriptions
Scale the report by percentage
Page setup
Print button. Press it then the current report will be printed
Save the current report
Open a report file
Close the report preview window
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-1
Chapter 2 Report Design
This includes the following items: query definition wizard, definition variables, and drag report design objects to the interface to design, preview and save.
Template design can be implemented in two steps:
1) First, define template input contents with the query definition wizard including data source, data set, relationship between data sets, output result, user query conditions, grouping and sequencing, etc.
2) Then create the template output format with report bands including report title, page header and footer, main item data, group header and footer, etc.
2.1 Entering the Report Designer Window
I. Task description
It is to enter the report designer window to design the report.
II. Operation instruction
Select the template file to be designed and then click [Operation/Design Template]. The system pops up the report designer window, as shown in Figure 2-1.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-2
Figure 2-1 Report designer
Caution:
Please ensure that the fields and stored procedure adopted in designing the report template are the real information in the database. Otherwise, abnormity may occur upon querying the report or previewing the operation, or exiting the client may fail.
2.2 Datasource Manager-
2.2.1 Overview
I. Data source definition wizard window
Defining the data source is to design a SQL command or a store procedure command to access the database. Select the menu [File/Datasource manager] to invoke the datasource definition wizard window, as shown in Figure 2-2.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-3
This window has six pages: "Data Source", "Output Result", "User Query Condition" and "Grouping and Sequencing". Through these five pages, you can define the SQL command or the store procedure command.
For example: we have two commands:
Select A.a,B.b, Count (B.c) From A,B Where (A.a=B.a) and (A.a = X) Group by A.b Order by B.b
Execute procedure C(v1, v2, v3)
"Data Source" impact:
This determines the database on which this SQL command or the store procedure command is effective
"Output Result" impact:
Select A.a,B.b, Count (B.c) From A,B Where (A.a=B.a) and (A.a = X) Group by A.b Order by B.b
Execute procedure C(v1, v2, v3) (Implicit definition, not reflected in the command)
"User Query Condition" impact
Select A.a,B.b, Count (B.c) From A,B Where A.a=B.a and (A.a = X) Group by A.b Order by B.b
Execute procedure C(v1, v2, v3)
"Grouping and Sequencing" impact:
"Separable Group List" impact:
Select A.a,B.b, Count (B.c) From A,B Where (A.a=B.a) and (A.a = X) Group by A.b Order by B.b
"Sequencing" impact:
Select A.a,B.b, Count (B.c) From A,B Where (A.a=B.a) and (A.a = X) Group by A.b Order by B.b
From the above description we can see: this interface disassembles the SQL command and the standard store procedure command into different parts and then defines the parts separately, so that the SQL command and the store procedure command can be automatically combined for database query.
II. Definition wizard
You cannot start design a report unless you understand the data table structure and have registered the M2000 performance task.
To make a report, you should understand the following items:
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-4
1) The summarizing modes of each measurement item in the report; 2) Whether to disassemble all measurement items in the report into sub-reports.
The summarizing mode of each measurement items in the report:
Summarization is always necessary to get the required report measurement items via the field result of data table.
The summarizing mode may be summation, average calculation or the combination of the two modes. Here two concepts are involved as time dimension and object dimension. In a task you can summarize the results of an object on an index by time. Similarly, you can summarize the measured objects in a task.
The summarization level may be Not Summarize, One-level Summarize or Two-level Summarize. Two-level Summarize is to summarize the result data according to certain conditions first, then summarize the result of the first summarization so as to complete the whole summarizing process. The intelligent report can carry out two levels of summarization at most.
How to define summarizing modes and summarizing levels depends on how much the report maker understands about the report and the indices.
Whether to disassemble all measurement items in the report into sub-reports:
Multiple tasks may be generated after the indices required for report measurement item are registered.
If the objects of these tasks are completely consistent, the report measurement items may not be disassembled. Tasks can be associated through objects and time.
If the objects of these tasks are not consistent, you should decide whether to disassemble the report. For example: The measurement item of a report requires to generate report records by means of NE, but the objects in the measurement item including Mobile Switching Center (MSC) and office direction. Then, you can summarize the office directions of this NE first and associate these office directions with the MSC objects. In this case, you may not disassemble the report. Normally, it is recommended to disassemble the report into several sub-reports for statistics.
2.2.2 Define data source
The data source is the statistics result set of registered system measurement tasks, therefore, user should complete system traffic registration on the performance Client prior to making a report.
Defined data source is used as the input source upon report generation.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-5
I. Task description
It is to enter the datasource manager window to perform such operations as selecting the data accessed by report, defining the output result for report query, setting the conditions for report query, grouping or sorting the report output and customizing the SQL statement for report query.
Datasource definition is very important. It defines the source of report data. In addition, it specifies which data field to be returned and what conditions to be followed to return the "Output Field". The user query "Condition" defines which fields to be queried upon query statistics and how to sequence the returned fields. You cannot get the correct data to generate reports unless the above steps are correctly defined.
II. Operation instruction
1) Select [File/Datasource manager] in the report designer window as shown in Figure 2-1 . The system pops up the Report Template Datasource Manager window, as shown in Figure 2-2.
Figure 2-2 Datasource manager
2) The user can set the datasource, data table and stored procedure accessed by the report in the Datasource tab page in the Report Template Datasource Manager window. As shown in Figure 2-2, after the user selects the datasource to be
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-6
accessed by the report in the drop-down list box, all the tables and stored procedures corresponding to the datasource will be listed in the lower box. The user can add or delete the tables and stored procedures with the four buttons in the middle (refer to Table 2-1 for the functions of the four buttons). The right box will list the tables and stored procedures required by the user.
Note:
One report can only use a datasource, but it can use one or more tables. However, only one stored procedure is allowed for a report.
3) The user can define the returned result of the report query through switching over to the Output Result tab page as shown in Figure 2-3.
Note:
1) The user can define the return field for the report query and the order of the fields. If a stored procedure is queried, all fields must be returned in sequence. 2) If the user checks check box Use Keyword “Distinct”, the return record for the report query is unique. In the case of report with large data, the user may check the Return Records Only check box, then the system will only return the specified mount of records.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-7
Figure 2-3 Output results
4) If the user expects that the returned result is an expression consisting of several
fields, just click to enter the window for editing computed columns, as shown
in Figure 2-4.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-8
Figure 2-4 Editing computed columns
5) After setting the column expression, click <OK> to return to Output Result tab page. The generated column expression is also the output result of report query. For the setting of the column expression, refer to the example in the latter part of this section.
6) After switching to the Conditions tab page as shown in Figure 2-5, the user can set three additional conditions – Condition, Query Field and Extended in this tab page.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-9
Figure 2-5 Setting query conditions
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-10
Note:
1) If the user selects Condition, these conditions will be added to the Where part of the SQL statement directly. It should be noted that the stored procedure has no default condition. The method of setting the default condition is: In the left panel, select field 1 and field 2 in the upper list box and the lower list box respectively, define the signs and add them into the right list. The condition relation
between lines can be adjusted with <AND> and <OR>, and their order can be adjusted with and
.
If the macro LoginUser is selected, it will be replaced by the current user ID. 2) If the user selects Query Field, he can set the condition as he wants with the selected field during the query. Please refer to Section 5.5.2 “Querying a Template File” of Client Management module for the detailed operations. Two condition formats of "Field = Field" and "Field = Constant" are allowed in the Condition tab page, while only the latter is allowed in the Query Field tab page. The method of setting Condition is as follows: Double click the selected query field to set its advanced properties. Please refer to Section 2.4 “Customizing Advanced Properties of Query Field” for the detailed operations. The query field includes the macro, which is the variable name within the symbol {} and can be defined by the user. Please refer to Section 2.6 “Creating a Macro”. 3) If the user selects Extended, the user can input the From and Where parts of the SQL statement. The input can be set at the end of original table or conditions, or be set to overwrite the original table or conditions. Due to manual input, the report system cannot ensure the correctness of the input. Please input the contents based on rules. For the rules, please refer to Section 5.5.2 “Querying a Template File” of Client Management module . If Set When Querying is checked, the user should input these extended conditions upon querying report.
7) After switching to the Group And Sort tab page as shown in Figure 2-6, the user can set the grouping or sorting conditions for the output result of the report.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-11
Note:
1) If the user needs to set Group Field, the selected fields will be added to the Group By part of the SQL statement in turn. They do not affect the stored procedure. According to the SQL syntax, each non-computed column will be automatically added into the group field if the computed column is adopted in the output result.
By clicking and , the order of group fields can be adjusted. The output results will vary with the different sequences. 2) If the user needs to set Sort Field, the selected fields will be added to the Order By part of the SQL statement in turn. They do not affect the stored procedure. The sorting mode is selected through / .
By clicking and , the order of sort fields can be adjusted. The output results will vary with the different sequences. 3) If the user needs to set Custom Sorting, the selected fields will also be added sequentially into the Order By part of the SQL statement. However, which order to be used and whether to sort are determined by the querying user.
Double click the selected the field for sorting or click after selecting the field for sorting to set its
advanced properties. Please refer to Section 2.5 “Customizing Advanced Properties of Sorting” for the detailed operations.
By clicking and , the order of sort fields can be adjusted. The output results will vary with the
different sequences.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-12
Figure 2-6 Customizing grouping and sorting
8) After switching to the Custom SQL tab page as shown in Figure 2-7, the user can customize the SQL statement for report query.
Note:
1) There is a certain format for the user-defined SQL statement. The user can click <About User-defined SQL> to view the points for attention when manually typing the SQL statement. 2) All functions of Custom SQL can be fulfilled with Extended in the Conditions tab page. 3) If Use The User-defined SQL, Condition and Group And Sort are selected, the relevant setting on the tab page and the limit condition for the datasource are all invalid. However, the user-defined macro is valid. Therefore, the user can define macro as the SQL statement to add the user-defined query condition, or sorting and grouping condition. 4) It is recommended to modify the required SQL statement based on the current SQL statement after clicking <Show Current SQL>. 5) After customizing the SQL statement, query the report to see whether the correct result can be returned.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-13
Figure 2-7 Customizing the SQL statements
9) After all configurations of datasource manager are completed, click <OK> to perform such settings as report template datasource, output result, query condition, grouping and sorting, and SQL statement query.
Example
Suppose fields sum1 and sum2 in the accessed table represent income1 and income2 respectively. The income of the whole year is sum1 plus sum2.
10) Select [intpdb2.Table.Test.Field.income1] in the Columns drop-down list box in the window as shown in Figure 2-4
11) Click <Insert> to add the field into the Value of computed column text box, as shown in Figure 2-8.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-14
Figure 2-8 Adding the field of the first half year income to the column expression
12) Click in the button bar to add “+” behind [intpdb2.Table.Test.Field.income1].
13) Then, select intpdb2.Table.Test.Field.income2 in the Fields drop-down list box. Click <Insert> to add the field behind the expression, with the window as shown in Figure 2-9. Here, the required expression has been established.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-15
Figure 2-9 Result of creating the column expression
III. Control description
For the description of controls in the Report Template Datasource Manager window, refer to Table 2-1.
Table 2-1 Description of controls in the Report Template Datasource Manager window
Controls Descriptions Shortcut key
Adding the selected item into the list box on the right. This function can also be fulfilled by double clicking the left list. F1
Adding all items into the list box on the right. F2
Deleting all items in the list box on the right. F3
Deleting the selected item in the list box on the right. F4
The selected item in the right list box is moved upwards by a line. F5
The selected item in the right list box is moved downwards by a line. F6
Appearing in the Output Result tab page for creating the computed column F7
/
Appearing in the Condition box of the Condition tab page to define the And/Or relation between the default conditions
F7
/ Appearing in the Sorting Field box of the Group And Sort tab page to define the sequence of sorting field, Ascending or Descending
F7
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-16
Controls Descriptions Shortcut key
Appearing in the Query Field box of the Condition tab page and the Custom Sorting box of the Group And Sort tab page to define the advanced properties of the selected item
F8
Appearing in the Query Field box of the Condition tab page to create the user-defined macro F9
2.3 Set Variables-
The variable setting function is mainly to shorten and simplify the field length, therefore a variable must be set to make a simplified alias for the data field after the query definition wizard has been set. The generated variables can be either used for report design or for query statistics.
Select [File/Data dictionary] from the toolbar to pop up the "Set Variables" window. The default variables are returned fields and user conditions which are used to create aliases for returned fields and user conditions, etc.
The pull-down list box: contains [MainRptDataSet] and [System Variables]. The former is the dedicated data set of the system and cannot be modified by the user, while the latter lists all variables of all current system definitions, such as date variables, and row variables, etc. The user can define another variable to contain these variables.
List box: it contains all user-defined output fields.
Expression: It may be an expression or a function used to create a variable alias. When a new variable is created, this option is ticked by default. To create a variable for an expression, you may directly click the <fx> button nearby, otherwise, you should directly select the output field in the right list to create a variable alias for the field, as shown in Figure 2-10.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-17
Figure 2-10 Set variables
Table 2-2 describes the buttons.
Table 2-2 Variable setting buttons
Button Button name Function description
New category Used to create a variable directories, such as "Returned Field, Query Condition", etc.
New variable
Corresponding to one field in the right field list. For example: "Management Unit ID" is corresponding to the "Performance Database. Table. Office Direction. Trunk Traffic Measurement (CMSC33) Field. Management Unit ID". In the report display, "Management Unit ID" will substitute the "Performance Database. Table. Office Direction. Trunk Traffic Measurement (CMSC33) Field. Management Unit ID" and appear in the report.
Edit It is used to change the name of a specified variable or a variable directory.
Delete It is used to delete a variable or a variable directory
Caution:
The alias variable is exclusive. In other words, if this variable has appeared in one variable directory, it will not appear in another variable directory.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-18
Select "Return Field, User Condition", click <New Variable> to create a variable "ME ID", then click the "PerformanceDB.TB.Digital Mobile Switch Traffic.FD.ME ID" in the right part of the window, thus the association between the variable and the field is established as shown in Figure 2-11.
Figure 2-11 Create new variable
Similarly, more associations of between variables and fields can be established. The variable names must be exclusive.
2.4 Customizing Advanced Properties of Query Field-
I. Task description
It is to customize the advanced properties of query field. The advanced properties will be shown in the report query window once they are set.
II. Operation instruction
1) Select a condition in the Query Field box in the Condition tab page in the Report
Template Datasource Manager window, and then click . The system pops up
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-19
the window for customizing advanced properties of the query field, as shown in Figure 2-12.
Figure 2-12 Customizing advanced properties of query field
In the window for customizing advanced properties of the query field, the operation objects include Query Field Caption, Setting Control, Operators, Description, Default value and Value expression.
2) After setting the advanced properties, click <OK>.
III. Field and control description
For the description of the fields and controls related to the operation of customizing advanced properties of the query field, please refer to Table 2-3.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-20
Table 2-3 Description of fields related to the operation of customizing advanced properties of query field
Field Description and example
Query field caption
It defines the name displayed upon querying the field For instance, if the database field is UserID, we can define the name of the queried field as UserID, thus to facilitate report query.
Setting control
It defines which controls to be used for setting the field value upon querying reports. Proper control can greatly simplify the setting of query condition and ensure the correctness concerning the format of input value. If the field has been bound to the range list, the list box will be automatically taken as setting control. If the setting control is with <>>>, you can set the advanced properties of this control. Please refer to Table 8-3 for the detailed description of the control.
Operators
It defines which signs are supported by the field. They fall into three columns: “Start”, “Default sign” and “Sign alias”. For the start column, only the selected sign appears in the report query window. For the default sign column, the selected sign will be the default sign. For the scheduled task that does not open the query condition defining window, this sign will be used to create the SQL statement. For the sign alias column, we can assign the alias to the sign. For example, "=" is defined as "Equal to" for convenience of querying. The system will automatically replace "Equal to" with "=". By clicking <Rule>, you can set the standard alias based on the native language. If the first line of operator box is unchecked and the corresponding query condition is set as null in the pop-up window for querying the report system during querying the statistic report, it indicates that this query condition will not appear in the final SQL statement, otherwise, it will appear surely.The operators of the last two lines can be defined by the user.
Description It is used to set the description of the field. We can write data information of the field such as format and value range here, so that the user will be prompted to input correct result when querying.
Default value It is the default value of this field when querying. Proper default value is a good prompt to the user.The scheduled task without opening the query condition defining window will directly create the SQL statement with this default value. Error will occur if it is not defined.
Value expression
The user-defined value will be submitted to the database system after being packed with this expression Under the default situation, if the value is integer or float, the expression is [Value]; if it is of time mode or string, the expression is '[Value]'. Newline is not allowed for value expression unless it is required by the string. The expression does not support user-defined macro.
For the description of the related controls, please refer to Table 2-4.
Table 2-4 Description of related controls
Control Name Description
Edit box Here, the user can input text content.
List box
Only one item is selected from it as field value. The user should configure the content in the list box in the window for customizing advanced properties of the query field. If the number of items exceeds ten, click < > after selecting the last item to add a line.
Combo list
Here, the user can either input the text content as field value or select an item from it as field value. The user should configure the content of the combo box in the window for customizing advanced properties of the query field. If the number of items exceeds ten, click < > after selecting the last item to add a line.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-21
Control Name Description
Time picker The user can select or input the time. Current time is
the default value.
Date picker The user can select a date. Current time is the default value.
Custom datetime
Time format is allowed for this control. For the detailed time format, refer to Table 8-4. Through this control, the user can set the format of date and time as required.
Multiselect list
The user can select zero, one or several records in the left list box to add it/them into the right list box. The returned result is connected with the user-defined signs. The user should configure the content in the left list box and sign in the window for customizing advanced properties of the query field. If the number of items exceeds ten, click < > after selecting the last item to add a line.
Sql combo list
The user should obtain the content of drop-down list box from the service database. Only the data saved in the current datasource can be accessed. The user should configure the SQL statement bound to the SQL list box in the window for customizing advanced properties of the query field.
Relational sql combo
It is double drop-down list box. The contents are obtained from the service database. Only the data saved in the current datasource can be accessed. The user selects content from the first box and the content in the second box will be updated synchronously. It is commonly used for: Province-City, Area Code-Number, Company-Employee, Month-Day, etc. The user should configure the SQL statement bound to the associated SQL list box in the window for customizing advanced properties of the query field.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-22
The time formats available for the time picker are shown in Table 2-5.
Table 2-5 Description of time formats
Time format Example YYYY-MM-DD HH:MM:SS 2002-11-01 12:04:10 YY-MM-DD HH:MM:SS 02-11-01 12:04:10 Y-M-D H:M:S 2002-11-1 12:04:10 YYYY-MM-DD 2002-11-01 HH:MM:SS 12:04:10 YYYYMMDDHHMMSS 20021101120410
2.5 Customizing Advanced Properties of Sorting-
I. Task description
It is to customize the advanced properties of sorting.
II. Operation instruction
1) Enter the Custom Sorting tab page in the Group And Sort tab page of the Report Template Datasource Manager window, as shown in Figure 2-13.
Figure 2-13 Customizing sorting
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-23
2) Select a field and click , then the system pops up the window for setting
advanced properties of sorting for the field, as shown in Figure 2-14.
Figure 2-14 Setting advanced properties of sorting for a field
3) The user may set the allowed sorting modes and the default sorting mode for the field.
Note:
In Figure 2-14, checking the check box means that the sorting mode is allowed and selecting the radio button indicates that the sorting mode is the default.
2.6 Creating a Macro-
I. Task description
It is to create a new macro. And it is valid in User-define SQL, Condition, Query Field and Extended.
Note:
1) When setting query conditions, the macro appears in the conditions and it should be set by the user. 2) The user can add the macro in the customized SQL statement, thus the user can add the customized conditions to the customized SQL statement. 3) The example taken in this section is creating a new macro in the Condition box in the Condition tab page in the Report Template Datasource Manager window.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-24
II. Operation instruction
1) Enter the Query Field box in the Condition tab page in the Report Template Datasource Manager window, as shown in Figure 2-15.
Figure 2-15 Customizing the query field
2) Click and then the system pops up the New User-defined Macro window, as
shown in Figure 2-16.
Figure 2-16 Creating a macro
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-25
3) Check the Edit The Macro Immediately check box, and click <OK> after filling in the related information. The system pops up the window for customizing advanced properties of the query field, as shown in Figure 2-17.
Figure 2-17 Defining advanced properties of the query field
III. Field description
For the description of the fields related to the operation of creating a macro, please refer to Table 2-6 .
Table 2-6 Description of fields related to the operation of creating a macro
Field Description Value range Default value
Macro Name Name of the macro It is a string of 64 bytes at most. It cannot be the same as the name of user-defined variable and function.
Include Sign Whether signs are contained
If yes, sign and value are valid simultaneously in the query window; otherwise, only value is valid. Yes or No
No
Edit The Macro Immediately
Whether to edit macro properties immediately after creation
The properties of macro are the same as the advanced properties of query field. Yes or No
Yes
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-26
2.7 Setting the Report Query Window-
I. Task description
It is to set the report query window to make it more friendly.
II. Operation instruction
1) Select [File/Set Interface for querying window] in the report designer window, as shown in Figure 2-1, and then the system pops up the window for setting the style for querying window, as shown in Figure 2-18.
Figure 2-18 Setting the style for the report query window
2) The user can set the style for the report query window in the window above. Click <OK>. Then the system will save the setting of user.
III. Field description
For the description of the fields related to the style setting operation, please refer to Table 2-7.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-27
Table 2-7 Description of fields related to the style setting operation
Field Description Value range Default value
User interface style
It is used to set the items in the condition list in the report query window. The items include sign, condition column, and/or column, and field note.
The user can select four kinds of interface style or customize the interface style. Among them, there are three user interface styles – traditional user interface, user interface applicable for the SQL command and user interface applicable for the stored procedure.
The traditional user interface displays all items. The user interface applicable for the SQL command displays the sign, and/or column, and field note. The user interface applicable for the stored procedure only displays the filed note.
Query Description
We can write description about condition setting rules of the current template file in the heading area of the query window.
A string, null not allowed Name of the template for the report query
Hide SQL, Show SQL, Forbid Show SQL
Whether to display the generated SQL command in the report query window
Hide SQL: The SQL command is not displayed in the query window. However, the user can view it by clicking <SQL <<>. Show SQL: The SQL command is displayed in the query window. Forbid Show SQL: The user cannot view the SQL command of report query.
Hide SQL
2.8 Editing the Report Note
I. Task description
It is to add notes to the current template. A good report note should contain the key content of the report. Thus, it is convenient for the sequent design of other people since they can learn the intention of the original designer with ease by editing the report note.
II. Operation instruction
1) Select [File/Edit the report comment] in the report designer window, as shown in Figure 2-1 , and then the system pops up the Report template file comment definition window, as shown in Figure 2-19.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-28
Figure 2-19 Defining the notes for the report template file
From the figure, we can know that each note falls into Caption and Description, in the string without length limit.
Note:
1) If the number of items to be added exceeds six, click < > after selecting the last item to add a note. 2) At most 64 notes are allowed.
Click <OK>. Then, the system will save the notes of report template file.
2.9 Report Template Builder-
I. Task description
It is to set the style and mode of report in the report template builder.
II. Operation instruction
1) Select [Tools/Toolbar/Report Template Builder] in the report designer window, as shown in Figure 2-1, and then the system pops up the Report Template Builder window, as shown in Figure 2-20.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-29
Figure 2-20 Report template builder
2) Specify the report style based on the actual requirement or personal preference and then click <OK>. The system will save the modification of user. Once the user queries the report with this template file again, the report in new style will be generated.
III. Control description
The Report Template Builder window consists of four tab pages, i.e. Data, Title, Table Style and Page Header/Footer. Please refer to Table 2-8 for details.
Table 2-8 Description of tab pages in the Report Template Builder window
Tab page Description
Data It is used to define the column in the table. An internal column, Include Line Number Column, and an internal row, Include Summation Row, can be added.
Title It is used to set the title and subtitle of the report. Various kinds of title may occur with different styles and definitions.
Table Style Such properties as format, font, table text, space between lines, and the line and column using bold can be set. Generally, formal report adopts basic format and formal report title. It is recommended to use other styles for the informal propagandistic report.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-30
Tab page Description
Page Header/Footer It is used to define whether the report has page header or footer and set the page setup. It can lock the location of report control to avoid moving the control incautiously.
2.10 Adding Statistic Charts into the Report-
I. Task description
It is to add various kinds of statistic charts to the report.
II. Operation instruction
1) Select and drag the Master Fooder report in the report designer window, as shown
in Figure 2-1. Click in the left tool bar, and then the system will add a statistic
chart object in the blank area of the Master Fooder report. Double click the object to pop up the chart object window, as shown in Figure 2-21.
Figure 2-21 Chart object
2) After the properties of chart object are set, click <OK>. When the user queries the report with this template file again, the statistic chart expected by user will appear.
III. Control description
The chart object window includes three tab pages, i.e. Type, Data and Marks. Please refer to Table 2-9 for the description.
User Manual iManager M2000 Intelligent Report System
Introduction to Report DesignerChapter 2 Report Design
2-31
Table 2-9 Description of tab pages in the chart object window
Tab page Description
Type It is used to identify the type of statistic chart, including graph, histogram, scatter diagram, piegraph, etc. In addition, the properties of the statistic chart can also be set, including whether it is 3D, whether to show axis, etc.
Data
It is used to identify the abscissa/Y-coordinate value of the statistic chart and set the max data item (Show top, Label) as the displayed content. The Y-coordinate value of the statistic chart must be statistical type (integer or float). When there are too many data items in the statistic report, it is necessary to display the columns of large data only and combine the rest columns into one. For instance, the report query has 100-column data in total. If we only expect to display the first ten columns with large data, just input 10 in Show top. Furthermore, if we expect to display the rest 90 columns in the statistic chart as a whole, input Rest in Label.
Marks It is used to set the mark style of statistic chart. The optional item includes value, percentage, sign, etc.
2.11 Querying the Statistic Report
The content of this section is identical with that in Section 5.6.2 “Querying the Template File” of Client Management module. Please refer to the section.
HUAWEI
iManager M2000 Intelligent Report System User Manual
Collection of Original Data
User Manual iManager M2000 Intelligent Report System
Collection of Original DataTable of Contents
i
Table of Contents
Chapter 1 Collection of Original Data.......................................................................................... 1-1 1.1 Index Table Mapping ......................................................................................................... 1-1
1.1.1 M2000 Performance Database Table Structure ..................................................... 1-1 1.1.2 M2000 Configuration Database Table Structure..................................................... 1-3 1.1.3 Report Data Mapping .............................................................................................. 1-3
1.2 Measurement Task Registration........................................................................................ 1-5 1.2.1 Registering Measurement Task .............................................................................. 1-5 1.2.2 Object Selection for Multi-object Parameter Structure............................................ 1-9
1.3 Data Source Configuration .............................................................................................. 1-14 1.3.1 Adding Data Source .............................................................................................. 1-14 1.3.2 Defining Query Wizard .......................................................................................... 1-15
User Manual iManager M2000 Intelligent Report System
Collection of Original DataChapter 1 Collection of Original Data
1-1
Chapter 1 Collection of Original Data
1.1 Index Table Mapping
After getting the report style and understanding the meaning of each measurement item in the report format, we should first figure out where to get the data (namely the data source) and how to perform mapping between data of data source and measurement items in the report so as to complete this report
The iManager M2000 system provides database interfaces to users through the configuration database “cfgdb” and the performance database “pmdb”, which are the most common means. These two databases are the data sources for report creation. We set the data sources respectively as m2000.cfgdb and m2000.pmdb.
To map the data in the data source to the measurement items of the report, the report designer has to understand the table structure and related information provided in the data source.
1.1.1 M2000 Performance Database Table Structure
In the iManager M2000 performance database pmdb, the key data table is the Task Result Table.
The user can specify relevant performance items and objects as required to register a task. Each task forms a table in the performance database, namely the Task Result Table. Task Result Tables keeps the object result data in each period. Relying on these data, the user can make reports with relevant performance.
A Task Result Table can be named as tbl_rstxxx, in which xxx is the task No. generated after the task is successfully registered. The user can get this task No. by viewing the task list on the performance console of the iManager M2000 system.
Table 1-1 The field information of the Task Result Table is:
Name Field Name Field type Field length Remarks
Whether the result is valid validate smallint 2 NE ID dw_me_id int 4 Measurement start time starttime datetime 8 Measurement period stat_period smallint 2
Object set objset_m0 varchar 254 This field is reserved in the report
Object set member 1 objset_m1 int 4
User Manual iManager M2000 Intelligent Report System
Collection of Original DataChapter 1 Collection of Original Data
1-2
Name Field Name Field type Field length Remarks
Object set member n objset_mn ......... ......... Item 1 m_idxxx ......... ......... Item n m_idxxx ......... .........
Field related explanation:
The field “validate” indicates whether the result submitted from the NE is valid. 0 stands for valid, and 1 for invalid.
The field “dw_me_id” is the ObjectID of a NE. This information is corresponding to the NE information in the configuration database.
The field “starttime” indicates the start time of results. The result value generated from this start time indicates a complete period. If a task period is 60 minutes and the start time is 9:00, this field indicates the result data generated between 9:00 and 10:00.
The field “stat_period” contains the measurement period entered by the user upon task registration.
The field "Object Set" of the Task Result Table describes the result reported by a NE corresponding to an object at a moment. The field “objset_m0” is a character string of the object set members in the reserve order. It records the combination of all the object members it contains.
The "Object Set Member 1…n" presents the object set according to the normal values of all members. When the user enters object parameters on the performance console interface to register a task, he may select the task object. This object can be a member or multiple members. If only one object is selected, object1 can indicate the task object. The field is of 4-byte int type. If multiple object members are selected, please get the detailed object information and field length in Appendix B: Description of Multi-object Parameter Structure.
The number of item fields is calculated according to the item breakdown for task registration. These items include the ones registered by the user and broken down from the registered calculation items. The field name m_idxxx indicates the item used by the task.
The entire Task Result Table is created according to task registration. If the user registers a task whose indices are 300, 301, 317= (300-301)/300, object set as "Object Set A", and the server assigns the task No. as 670, the result table should be:
Table name: tbl_rst670
Field name:
|validate|dw_me_id|starttime|stat_period|objset_m0|objset_m1|objset_m2|m_id300|m_id301|m_id317|
User Manual iManager M2000 Intelligent Report System
Collection of Original DataChapter 1 Collection of Original Data
1-3
1.1.2 M2000 Configuration Database Table Structure
The table structure of the system configuration database cfgdb is described in the appendix. You can also query the cfgdb table structure in the server in the following methods:
For M2000 users:
$isql -Um2000 -Ppassword
1>use cfgdb
2>go
1>select name from sysobjects where type='U' order by name
2>go
You may only query the system tables like tblClass, tblMO, tblManagedElement, tblInherited, tblAttr, tblString, tblList and tblInvalid etc.
1>sp_help tblMO
2>go
Now you can see the table structure of tblMO.
1.1.3 Report Data Mapping
Once you have understood the above task result tables, you can complete the mapping for report data.
The report data mapping contains two parts: index mapping and object mapping.
I. Index mapping
To map the indices of a report measurement item, you should take the following steps:
Find the corresponding item in the item set for all report measurement items according to their meaning. Sometimes, report measurement may be corresponding to one item or realized by calculation of multiple items. You should remember the function set name, item ID and object type for each item.
Classify the items belonging to the same function set and sharing the same object type as one group.
Register performance tasks on the performance console by group with the consistent task period. After registration, you can see the task No. of this task on the iManager M2000 performance Client. The detailed registration steps are described in "Measurement Task Registration".
User Manual iManager M2000 Intelligent Report System
Collection of Original DataChapter 1 Collection of Original Data
1-4
Note:
Whether to group the items can be judged on the iManager M2000 performance application Client. When registering performance tasks and selecting items on the performance Client, you can classify the items that can be selected together as one group.
II. Object mapping
All values of the performance result table object members from objset_m1 to objset_mn are presented via ObjectID or the character string entered by the user. In a report, members of the ObjectID type should be translated into information which can be detected by the user. To map the objects, you should take the following steps:
Get the related object type according to the registered task. This object type can be detected on the performance Client. Get the object structure from the appendix.
Get object members of the object structure according to the report measurement objects. Namely, which object member should be used to match the report measurement item. For example: The object members of a multi-condition object are: MSC, calling number, call source office direction, outgoing office direction, called number, and call attribute. If the report is output as per the calling number, the object member is objset_m2. If the report is output as per the call source office direction, the object member is objset_m3.
If an object member is ObjectID, it should be translated via the object information table in the configuration database. You should first get the table name of this object type in the configuration database table. For example: If you perform report measurement by office direction, the name of the office direction ObjectID should be corresponding to the configuration table tblOffice. Then you should record the name of the required configuration table and understand the field structure of this configuration table.
To map the data in the performance database and the configuration database, you should create the mapping of the configuration table in the performance database. If the configuration table to be mapped is tblOffice, you may observe the following steps:
m2000 user:
$isql -Um2000 -Ppassword
1>use pmdb
2>go
1>create view tblOffice select * from cfgdb.m2000.tblOffice
User Manual iManager M2000 Intelligent Report System
Collection of Original DataChapter 1 Collection of Original Data
1-5
2>go
1>quit
1.2 Measurement Task Registration
In the M2000 IN report system, the performance measurement task result table is used as the data source for report designing, therefore you must register the performance measurement task to customize report templates in the report system.
Note:
The performance measurement task can only be created by users who have at least the normal service operation authority for centralized performance management.
1.2.1 Registering Measurement Task
The following are the detailed steps for measurement task registration:
1) In the centralized performance management system select the menu [Task/New], then a dialog box for new tasks will pop up, as shown in Figure 1-1.
Figure 1-1 Create a performance measurement task
User Manual iManager M2000 Intelligent Report System
Collection of Original DataChapter 1 Collection of Original Data
1-6
2) Fill in required parameters in the dialog box. Enter the measurement task name in the "Name" text box. In the "NE Type" list box, select the type of the NE to be measured. Select the measurement function set and function sub-set respectively in the
"Function Set" and "Function SubSet" list boxes. The selected function set and function sub-set must be the same respectively as the ones obtained through analysis in the previous chapter.
In the tree list on the left of the "Object Info" page, click the button in the middle to select NEs to be measured.
Note:
If a specific NE is selected, the report data only contains the measurement data of this NE. If all NEs are selected, the report data will contain the measurement data of all NEs. It is recommended to select all NEs if allowed by the resources. To select objects for the multi-object parameter structure, please see Section 1.2.2 of this module for details.
3) Click the page tag "Item Info." to select the performance index items to be measured, as shown in Figure 1-2. On the left are the indices to be selected and on the right are the selected ones. You may click the buttons in the middle to select or remove the items.
User Manual iManager M2000 Intelligent Report System
Collection of Original DataChapter 1 Collection of Original Data
1-7
Figure 1-2 Select measurement index items
Note:
You may only select the indices required currently, or some other indices for report extension.
4) Click the "Time Info" page tag to set the time information of the measurement task, as shown in Figure 1-3.
User Manual iManager M2000 Intelligent Report System
Collection of Original DataChapter 1 Collection of Original Data
1-8
Figure 1-3 Set time information
On the "Time Info" page, you can set information concerning the measurement time including measurement period, time segment, measurement mode, and so on. Table 1-2 describes all the parameters.
Table 1-2 Time information parameters
Column Description
Start Date It is the start date of the measurement task and set as the current system date.
Measurement Period It is the measurement period with the unit as minute. The recommended period is 60 minutes.
Measurement Time Segment It is the measurement time segment for report making. It can be the user-defined busy-hour time segment. The default time segment can be set as 00:00~24:00
Measurement Type Please select the "Semi-permanent" type. It is a task with start date only, namely this task will not stop unless it is canceled manually.
Number of measurement days Duration of a task with a limited period. It is invalid to the "semi-permanent" task.
Measurement mode Please select measurement by day. The measurement by day starts from the start date. It is activated every day during the limited period.
Storage duration of the latest measurement result
Store the latest measurement results generated since the start date. The default duration is 7 days.
User Manual iManager M2000 Intelligent Report System
Collection of Original DataChapter 1 Collection of Original Data
1-9
Note:
In the "Measurement Time Segment" you may enter three time segments. If the actual measurement time segments of a task are less than three, you may enter the actual time segments in the time order and leave the rest time segments as null. The system will automatically calculate the number of time segments used in the task.
After setting the "Object Information", "Index Information" and "Time Information", click <OK>, then the system checks whether any invalid or incomplete parameter exists. If there is any invalid or incomplete, the system will report the error information and ask you to enter the parameters again.
5) If there is no incorrect information, the system will create a new task and pop up a task registration response window and display the operation results: Succeeded.
The overall operation result is displayed in the information column on the upper part of the window, including success or failure, as well as the failure causes. In the lower part are the results of all NEs registered in this task, including success or failure, as well as the failure causes. Only when the operations on all NEs concerned in this task are successful, will the system display success in the overall result report.
If a task is successfully created, its information will be added to the task list window.
1.2.2 Object Selection for Multi-object Parameter Structure
In the current version, there are 6 types of multi-object parameter structures (described in Appendix C). The coming part describes how to select object information for the registration of measurement tasks.
User Manual iManager M2000 Intelligent Report System
Collection of Original DataChapter 1 Collection of Original Data
1-10
I. Select multi-combination object information
Figure 1-4 Selection interface for multi-combination object information
Selection modes:
Switch: Selected from the interface Caller number: Manually enter the prefix of the calling number Inlet office direction No.: Selected from the interface Outlet office direction No.: Selected from the interface Called number: Manually enter the prefix of the called number Call type: Selected from the interface
User Manual iManager M2000 Intelligent Report System
Collection of Original DataChapter 1 Collection of Original Data
1-11
II. Selection CGI object information
Figure 1-5 Selection interface for CGI object inforamtion
Selection modes:
Observed cell: Selected from the interface Adjacent cell CGI: Manually enter the CGI of the adjacent cell
User Manual iManager M2000 Intelligent Report System
Collection of Original DataChapter 1 Collection of Original Data
1-12
III. Select office direction destination object information
Figure 1-6 Selection interface for office direction destination object information
Selection modes:
Office direction: Selected from the interface Destination: Selected from the interface
User Manual iManager M2000 Intelligent Report System
Collection of Original DataChapter 1 Collection of Original Data
1-13
IV. Select intelligent event measurement parameter objects
Figure 1-7 Selection interface for intelligent event measurement parameter object
Selection modes:
Service key: Selected from the interface SCP: Selected from the interface
User Manual iManager M2000 Intelligent Report System
Collection of Original DataChapter 1 Collection of Original Data
1-14
V. Select MTP DSP object information
Figure 1-8 Selection interface for MTP DSP object information
Selection modes:
DSP: Selected from the interface Source network flag: Selected from the interface Source signaling point code: Manually enter it (OPC)
1.3 Data Source Configuration
1.3.1 Adding Data Source
The relative content of adding data source has been introduced in second chapter.
In the iManager M2000 system, following information may be displayed after the initial installation:
Suppose the data source IP as 10.129.27.110 according to data source operation
The performance database should be configured as:
Data source name: performanceDB Database type: (English) sybase
User Manual iManager M2000 Intelligent Report System
Collection of Original DataChapter 1 Collection of Original Data
1-15
Data source alias: Performance database Database name: pmdb Data source alias (English): performanceDB Database user: m2000 Database port No.: 4100 JDBC connection character string: jdbc:sybase:Tds:10.129.27.132:4100/pmdb
The configuration database should be configured as:
Data source name: configureDB Database type: (English ) sybase Data source alias (Chinese): Configuration database Database Name: cfgdb Data source alias (English): configureDB Database user name:m2000 Database Port No.: 4100 JDBC connection character string: jdbc:sybase:Tds:10.129.27.132:4100/cfgdb
Other contents are available in the data source part of the report system Client management.
1.3.2 Defining Query Wizard
You cannot start to design a report unless you have understood the data table structure and registered the M2000 performance task.
To make a report, you should understand the following points:
1) The summarizing modes for each measurement item of the report. 2) Whether to disassemble individual measurement items of the report into
sub-reports.
The summarizing modes for each measurement item of the report:
Summarization is always necessary to get the required report measurement items via the field result of data table.
The summarizing mode may be summation, average calculation or the combination of these two modes. Here two concepts occur as time dimension and object dimension. In a task you can summarize the results of an object on an index by time. Similarly, you can summarize the measured objects in a task.
The summarization level may be Not Summarize, One-level Summarize or Two-level Summarize. Two-level Summarize is to summarize the result data according to certain conditions first, and then summarize the result of the first summarization according to certain conditions so as to complete the whole summarizing process. The intelligent report can carry out two levels of summarization at most
User Manual iManager M2000 Intelligent Report System
Collection of Original DataChapter 1 Collection of Original Data
1-16
The definition of summarizing modes and summarizing levels depends on the understanding degree of the report maker about the report and the indices.
Confirm whether to disassemble all measurement items in the report into sub-reports. Multiple tasks may be generated after the indices required for report measurement item are registered.
If the objects of these tasks are completely consistent, the report measurement items may not be disassembled. Multiple tasks can be associated through objects and time.
If the objects of these tasks are not consistent, you should judge whether to disassemble the report. For example: The measurement item of a report requires to generate report records by means of NE, but the objects in the measurement item including switches and office directions. In this case, you can summarize the office directions of this NE first, and then associate these office directions with the switch objects. Then, you may not disassemble the report. Normally, it is recommended to disassemble the report into several sub-reports for measurement.
Now, you have finished the three steps: M2000 index mapping, measurement task registration and data source configuration. Then you can start template designing. The detailed description is available in the part of "Introduction to IN Report Designer".
HUAWEI
iManager M2000 Intelligent Report System User Manual
Report Customization Examples
User Manual iManager M2000 Intelligent Report System
Report Customization ExamplesTable of Contents
i
Table of Contents
Chapter 1 Report Customization Examples ............................................................................... 1-1 1.1 Report Making Process ..................................................................................................... 1-1 1.2 Customizing Reports ......................................................................................................... 1-1
1.2.1 Specifying Report Requirements ............................................................................ 1-2 1.2.2 Specifying How to Realize Indices.......................................................................... 1-2 1.2.3 Registering Traffic Measurement Tasks ................................................................. 1-3 1.2.4 Defining Data Source .............................................................................................. 1-3 1.2.5 Customizing Report Templates............................................................................... 1-5
User Manual iManager M2000 Intelligent Report System
Report Customization ExamplesChapter 1 Report Customization Examples
1-1
Chapter 1 Report Customization Examples
1.1 Report Making Process
Report construction can be realized via two modes: generated via the system’s preset template and customized.
I. Generate reports via system preset template
To generate reports via the system’s preset template, you may only register the system task on the centralized performance application console of the iManager M2000 system, then select the report template in the intelligent report system, and enter the user query conditions.
II. Customize reports
The process of customizing reports is described in the System Principle part of this manual.
Anyway, to construct a report, you should complete the following tasks:
1) Specify the report requirement 2) Specify how to realize the indices 3) Register the traffic measurement tasks 4) Define data source 5) Add reports 6) Definition wizard
Define the data source (source of the report data) Specify the data fields to be returned (output result) Define query conditions Grouping and sequencing modes (how to process the returned fields)
7) Set variables 8) Insert data fields 9) Generate reports
The coming chapter describes the steps for constructing a report.
1.2 Customizing Reports
The following is an actual example.
User Manual iManager M2000 Intelligent Report System
Report Customization ExamplesChapter 1 Report Customization Examples
1-2
Note:
During report construction, a lot of system resources will be used, therefore it is specially recommended to exit all irrelevant application programs during this process. Previewing system report may affect the system efficiency due to too many operations, therefore it is recommended to exit all irrelevant application programs during this operation.
1.2.1 Specifying Report Requirements
The requirement shown in Figure 1-1 is an example:
Code
Figure 1-1 Report requirement table
The report requires to statistic the index “CPU Occupation Radio”.
It is obvious that fields like "ME Name" and "ME ID" are needed besides the index item to customize a complete report.
1.2.2 Specifying How to Realize Indices
The above report contains only one index. The following description demonstrates how to collect data of “CPU occupation radio” index.
I. CPU occupation radio
Measurement object: CPU of each SPM
Measurement type parameter: Module No. Of SPM
The meaning and statistics point of CPU occupation radio. Refer to Table 1-1.
Table 1-1 Index meaning and statistics point of CPU occupation radio
Index Meaning Standard statistics point Occupation radio Seizure percent of Host CPU Process within Switch
Note: Mainly check the using status of CPU in each SPM. Index formula: None.
The collection objects for the above indices are all network sub-systems.
User Manual iManager M2000 Intelligent Report System
Report Customization ExamplesChapter 1 Report Customization Examples
1-3
1.2.3 Registering Traffic Measurement Tasks
Analyze report indices and specify which traffic measurement tasks to be registered.
Open the centralized performance system in the iManager M2000 system and register the report tasks required on the centralized performance console.
Object information: select the object whose data will be measured.
Index information: select the management type [BSC] τ function set [CPU Measurement Function] τ function subset [CPU Measurement Function]. The following index (In the square bracket is the index ID is contained, which can be queried in the self-defined index window and will be used in the later operation):
Occupation radio [303000]
Time information: The recommended measurement period is 60 minutes and the recommended measurement time segment is the busy hours. The result storage duration can be the required days. All other parameters can be set by default.
After the successful task registration, the new task No. will be displayed in the task table window as XXX, which will be used in the later operation.
In this example one report task is registered. If the measurement items belong to different function sets, multiple tasks should be registered. Even if they belong to the same function set, but to different measurement object types, it is also necessary to register several tasks.
1.2.4 Defining Data Source
I. Define data sources for template
Log in to the Intelligent Report System as a user with the system administrator group authority, then click the [View/Management Pages/Datasource Management Page], or select Data tab directly.
In the Report System Client window, first define the information of the data source, i.e. the database where measurement results are stored, as shown in Figure 1-2.
User Manual iManager M2000 Intelligent Report System
Report Customization ExamplesChapter 1 Report Customization Examples
1-4
Figure 1-2 Data source management window
The data source IP address should be the real address where the data is stored. Generally, it is the IP address of M2000 server. If the report server and the M2000 server are installed separately, please fill in the actual IP address.
II. Add tables
Then, add a table in this data source, i.e. to manually fill in the required parameters of the measurement result table, as shown in Figure 1-3.
User Manual iManager M2000 Intelligent Report System
Report Customization ExamplesChapter 1 Report Customization Examples
1-5
Figure 1-3 Add a table (Columns 1~6)
In tbl_rstXXX, XXX is the task No., while in m_idxxxxx, xxxxx is the index ID of the task index.
All task result tables have the same fields as follows, which should be entered manually:
dw_me_id management unit ID integer
starttime measurement start time datetime
stat_period measurement period integer
objset_m1 object ID integer
1.2.5 Customizing Report Templates
The needed is not only the task result table. It is also necessary to get NE name from the configuration table (which should be used in the layer-1 summarization). Therefore, tblME (management element table) is also needed.
Table 1-2 describes the association among the NE name.
We can associate out the NE name via the formula Task Result Table. ME ID = ME Table. NE ID.
User Manual iManager M2000 Intelligent Report System
Report Customization ExamplesChapter 1 Report Customization Examples
1-6
Table 1-2 Association among NE name
Field How to associate
NE name Task Result Table.ME ID = ME Table.ME ID (ME name is stored in ME table)
To customize a report template, we should disassemble the report as per the actual case. Sometimes it is necessary to disassemble one report into several templates.
Because only the task result tables of the same object type can be associated if the report has several task result tables, and the association conditions are the object ID and the start time. If the measurement objects of the task result tables are of different types, they cannot be kept in the same report template. Then it is necessary to disassemble one report into several report templates.
A template can be constructed in two steps:
First, define the template input contents with the query definition wizard including data source, data set, relationship among data sets, output result, user query conditions, grouping and sequencing, etc.
Then, create the template output format with the report bands including report title, page header and footer, main item data, group header and footer, etc.
I. Define data source
1) Define data source
Click <Datasource Manager>, then the system will pop up the wizard window, as shown in Figure 1-4, in which you can select the required data source.
Figure 1-4 Window of data source wizard
User Manual iManager M2000 Intelligent Report System
Report Customization ExamplesChapter 1 Report Customization Examples
1-7
Defined data source is used as the input source for report generation. It can be one or more data sources. All report data sources are listed on the data source page.
Note:
If there are several task result tables, only those tables, whose object type are same, can be associated, such as ME ID (Object ID), and start time can used as associated condition. Otherwise, it is necessary to customize several report temples to realize requirement.
2) Define output result (Return columns)
Figure 1-5 shows that the ME ID, ME name, Start time and occupation radio in the output result list are all used as grouping condition. In these fields, the ME ID is the smallest, therefore the actual grouping condition is ME ID. Namely, all records of one ME ID can be classified into one group. According to the calculated field definition, max. value of “CPU Occupation Radio” in different “start time” are used for averaging.
These fields are calculated via the database. Namely the server realizes the layer-1 summarization.
Figure 1-5 Define output result
3) User query conditions
The user query condition defined here is displayed upon template query and measurement.
User Manual iManager M2000 Intelligent Report System
Report Customization ExamplesChapter 1 Report Customization Examples
1-8
Normal traffic measurement reports require that the user can input start time for query measurement, or input the specific ME ID for query.
Figure 1-6 User query conditions
Figure 1-7 Grouping and sorting
The output results can be displayed in order via sorting.
In the separable group list, the non-calculated fields in the output result can be displayed but cannot be edited.
User Manual iManager M2000 Intelligent Report System
Report Customization ExamplesChapter 1 Report Customization Examples
1-9
II. Design template output format
In the above five steps, the data source of report template is defined. This data source is the main item data and will be used as the template input data.
1) Report generation
Basic report design can be conducted once the query definition wizard and variables are correctly created.
Click the shortcut icon to pop up a dialog box "Insert Fields", as shown in Figure
1-8.
Figure 1-8 Insert data fields
Select the fields to be inserted, and click <OK>, then a simple report will be immediately generated.
But a complete template needs at least four report bands as report title, page header, main item data, and page footer.
Some templates, which require the secondary summarization also need other report bands as group header and footer, report total, and so on.
User Manual iManager M2000 Intelligent Report System
Report Customization ExamplesChapter 1 Report Customization Examples
1-10
Generally only the constant or the system variables are needed for the designing of report bands like report title, page header and footer, etc.
The layer-1 summarization can be realized in the server, but the layer-2 summarization is realized via the group header and footer.
2) Add report title
Click the icon in the report object bar to insert a new report band, then select
"Report Title" type.
Figure 1-9 Insert a report title
Let’s suppose the report title is "XXXXX Report".
3) Add page header
Add a page header as per the report requirement defined in the above. Figure 1-10 shows an added page header.
Figure 1-10 Add a page header
4) Add group header
After adding the report title, page header and the master data, we will add a group header with the grouping condition as the field [MainRptDataSet. "PMsource.Table.
User Manual iManager M2000 Intelligent Report System
Report Customization ExamplesChapter 1 Report Customization Examples
1-11
ME table.Field. ME ID"], then we can group by ME ID. All records with the same ME ID are classified in one group.
Figure 1-11 Add a group header: grouping condition 1 (to group by ME ID)
The result after grouping will be output to the group header, therefore it is necessary to add group footer.
5) Add group footer
Calculate the summation or average of the data, which are calculated and grouped on the group footer. The items in the group footer and the ones in the group header are in one-to-one correspondence.
ME name
We can insert data fields by clicking the icon in the text editor. Select
"PMsource.Table.ME table.Field.ME Name" to establish connection with the "ME Name" in the group footer.
User Manual iManager M2000 Intelligent Report System
Report Customization ExamplesChapter 1 Report Customization Examples
1-12
Figure 1-12 NE name association
ME ID
Figure 1-13 ME ID association
Occupation radio
User Manual iManager M2000 Intelligent Report System
Report Customization ExamplesChapter 1 Report Customization Examples
1-13
Figure 1-14 Occupation radio association
6) Add page footer
A page footer marks the page No.
III. Output report template
Figure 1-15 The final report style (in the Edit status)
Now we have completed designing a report template.
But the last step is to preview the template. Through template preview we can check the final output effect of the template and make some adjustment if necessary, besides, we can also check out some syntax errors.
HUAWEI
iManager M2000 Intelligent Report System User Manual
System Maintenance
User Manual iManager M2000 Intelligent Report System
System MaintenanceTable of Contents
i
Table of Contents
Chapter 1 System Maintenance ................................................................................................... 1-1 1.1 System Database Maintenance......................................................................................... 1-1
1.1.1 Multiple Database Support...................................................................................... 1-1 1.1.2 System Database Table Structure .......................................................................... 1-2
1.2 Service Program Description ............................................................................................. 1-6 1.3 JVM Memory Management................................................................................................ 1-7
1.3.1 JVM Memory Management in Resin....................................................................... 1-8 1.3.2 JVM Memory Management in JDK ......................................................................... 1-8
1.4 View Report Log ................................................................................................................ 1-9 1.5 System Fault Maintenance .............................................................................................. 1-10
1.5.1 Fault Maintenance for System Midware................................................................ 1-10 1.5.2 Fault Maintenance of Database Proxy Server ...................................................... 1-12
User Manual iManager M2000 Intelligent Report System
System MaintenanceChapter 1 System Maintenance
1-1
Chapter 1 System Maintenance
The IN report system is designed in the Browser/Server structure. Its Client is realized via IE+ActiveX. It provides a powerful report graphic designing environment and ensures that the user can complete all operations in the browser. The system midware is installed in the Web Server and realized via Java+Application servers. The data connection midware is equipped with Java executable files and JDBC universal interfaces, which realizes the cross-platform transplantation and distribution.
The Client exchanges data with the background through HTTP. The background system is designed in the JWS+BEAN service mode. The medium between the Client and the background Web Server is Java Sever Pages (JSP). Client requests are sent to the Web Server via JSP for explanation and then realized by the relevant procedure invoked.
Generally, the operation of one Client invokes one JSP which will then invoke one BEAN to implement the corresponding operation. If the Client wants to upload a file, it sends a request and uploads basic file parameters (including the file size and file storage directory, etc.). When the JSP receives the request and the parameters, it invokes a BEAN for file uploading and sends the parameters to this BEAN, which will then process the file and return a flag indicating whether the uploading succeeds or fails.
The system midware is connected with the data connection midware via Socket.
The Client is equipped with the IE+ActiveX realization mode, and its structure is simple with little user intervention, therefore the maintenance of the intelligent report system is described in the midware of the system.
The midware management and maintenance is carried out on the following aspects:
1) System database maintenance 2) System service program maintenance 3) Memory management of Java virtual machine (JVM) 4) System troubleshooting
1.1 System Database Maintenance
1.1.1 Multiple Database Support
Currently the IN report system supports four large-capacity databases: Oracle, SQL Server, Informix, and Sybase.
User Manual iManager M2000 Intelligent Report System
System MaintenanceChapter 1 System Maintenance
1-2
The operational environment of each database requires a different JDBC driver and different description mode of database connection string. The JDBC drivers must be provided by or compatible with the used database or provided by the third party. Besides, the description modes of database connection strings are available.
1.1.2 System Database Table Structure
Table 1-1 The RptUser table has the following attributes
Attribute name Attribute type Attribute description Note
UserId String User login ID Primary key Max. Length 16
UserName String User name Max. Length 32 UserPassword String User login password Max. length 16 EmployeeID String Employee ID Max. length 32
Active int Whether to activate 0 - not activate 1 - activate
LoginFlag int Online or offline 0 - offline 1 - online
Note String User description Max. length 250
Table 1-2 Definitions of RptUserG table attributes
Attribute name Attribute type Attribute description Note
UserGId String User group ID Primary key Max. length 16
UserGName String User group name Max. length 16
UserGType Integer User group type 1 - System adminitrator group 2 - Report designer group 3 - Report statistician group 4 - End user group
Note String Remarks Max. length 250
Table 1-3 Attributes of the RptUserUserG table
Attribute name Attribute type Attribute description Note
UserId String User login ID Primary key Max. length 16
UserGId String User group ID Max. length 32
Table 1-4 Definitions of RptDS table attributes (Data Source)
Attribute name Attribute type Attribute description Note
DSId int Data source ID Primary key. It ascends automatically in the system without intervention on the Client.
DSName String Data source name Max. length 32 DSAliasCN String Data source alias (Chinese) Max. length 32 DSAliasEN String Data source alias (English) Max. length 32
User Manual iManager M2000 Intelligent Report System
System MaintenanceChapter 1 System Maintenance
1-3
Attribute name Attribute type Attribute description Note DSIP String Data source IP Max. length 16
DBType int Database type
1 - Oracle 2 - Informix 3 - Sybase 4 - SQLServer 5 - Tuxedo
DBPort int JDBC port of the database Oracle - Informix - Sybase - SQLServer -1433
DBName String Database name Max. length - 32 DBUser String Name of the database user Max. length - 32 DBPassword String Password of the database user Max. length - 16 DBParam String Database connection string Max. length - 250 Note String Remarks Max. length - 250
Table 1-5 Definitions of RptTable table attributs
Attribute name Attribute type Attribute description Note
TableId int Data table ID Primary key. It ascends automatically in the system without intervention on the Client
DSId int Data source ID
The primary key associated with the external key of the DataSource. It must be an existing ID in the DataSource table
TableName String Data table name Max. length 32 TableAliasCN String Data table alias (Chinese) Max. length 32 TableAliasEN String Data table alias (English) Max. length 32 Note String Remarks Max. length 250
Table 1-6 Definitions of RptColumn table attributes
Attribute name Attribute type Attribute description Note ColumnId int Table field ID Primary key
TableId int Data table ID The primary key associated with the Tableid of the RptTable via external keys
DSId int Data source ID It is associated with the DataSourceid of the RptDataSource via external keys.
ColumnName String Table field name Max. length 32 ColumnAliasCN String Table field alias (Chinese) Max. length 32 ColumnAliasEN String Table field alias (English) Max. length 32
ColumnLen int Field length It is the total field length (excluding the decimal point)
ColumnType String Field type Max. length 16
ColumnSLen int Length of decimal place It refers to the number of places after the decimal point (excluding the decimal point)
ValueRange String Value range Max. length 250 DefaultValue String Default value Max. length 250 Note String Remarks Max. length 250
User Manual iManager M2000 Intelligent Report System
System MaintenanceChapter 1 System Maintenance
1-4
Table 1-7 Definitions of RptSP table attributes (Store Procedure)
Attribute name Attribute type Attribute description Note
SPId int Store procedure ID Primary key. It ascends automatically in the system without intervention on the Client
DSId int Data source ID The primary key associated with the RptDataSource table via external keys. It must be an existing ID in the RptDataSource table.
SPName String Store procedure name Max. length 32
SPAliasCN String Store procedure alias (Chinese) Max. length 32
SPAliasEN String Store procedure alias (English) Max. length 32
Note String Remarks Max. length 250
Table 1-8 Definitions of RptSPIn table attributres
Attribute name Attribute type Attribute description Note
InColumnId int Input parameter field ID Primary key. It ascends automatically in the system in the system without intervention on the Client.
SPId int Store procedure ID The primary key associated with the RptSP table via external keys. It must be an existing ID in the RptSP table.
DSId int Data source ID It is associated with the RptDataSource table via external keys. It must be an existing ID in the DataSource table.
InColumnName String Name of the input parameter field Max. length 32
InColumnAliasCN String Alias of the input parameter field (Chinese) Max. length 32
InColumnAliasEN String Alias of the input parameter field (English) Max. length 32
InColumnLen int Length of the input parameter field
It is the total length of the input parameter (excluding the decimal point)
InColumnType String Type of the input parameter field Max. length 16
InColumnSLen int Length of decimal place It refers to the number of places after the decimal point (excluding the decimal point)
ValueRange String Value range Max. length 250 DefaultValue String Default value Max. length 250 Note String Remarks Max. length 250
Table 1-9 Definitions of RptSPRS table attributes
Attribute name Attribute type Attribute description Note
RSColumnId int Output result set ID It is the primary key and the exclusive ID of the output result set
SPId int Store procedure ID The primary key associated with the SPid of the RptSP via external keys
DSId int Data source ID It is associated with the DataSourceid of RptDataSource via external keys
RSColumnName String Name of the output result Max. length 32
User Manual iManager M2000 Intelligent Report System
System MaintenanceChapter 1 System Maintenance
1-5
Attribute name Attribute type Attribute description Note set field
RSColumnAliasCN String Alias of the output result set field (Chinese) Max. length 32
RSColumnAliasEN String Alias of the output result set field (English) Max. length 32
RSColumnLen int Length of the output result set field
It is the total field length (excluding the decimal point)
RSColumnType String Type of the output result set field Max. length 16
RSColumnSLen int Length of decimal place It refers to the number of places after the decimal point in the table field (excluding the decimal point)
ValueRange String Value range Max. length 250 DefaultValue String Default value Max. length 250 Note String Remarks Max. length 250
Table 1-10 Definitions of RptTemplateG table attributes
Attribute name Attribute type Attribute description Note
TemplateGID Int Template type ID It is the exclusive ID of the template type and maintained by the system automatically
TemplateGName String Template type name Max. length 32 Note String Template type description Max. length 250
Table 1-11 Definitions of RptTemplates table attributes
Attribute name Attribute type Attribute description Note
TemplateId int Template file ID Primary key Maintained by the system automatically
TemplateName String Template file name Max. length 32
TemplateGId int Template type ID
This is the ID of the type the template belongs to. and associated with the RptTemplateGroup table through external keys.It must be an existing ID of the RptTemplateGroup table.
TemplatePath String Template file path Max. length 250
MultiDS int Multi-data source or single-data source
0- single-data source 1-multi-data source
CreateUserID String Creation user ID Max. length 12. Create user ID
CreateTime Date Creation time It is the file creation time based on the server time.
ModifyUserID String Modification user ID Max. length 12. It is the ID of user who makes the final modification.
ModifyTime Date Modification time It is the final modification time of the report file based on the server time.
ModifyFlag int Modification flag 0- Not being modified 1- Being modified currently
LocalFileName string Locally saved template files
Path and file name used to save files in the local computer after downloading.
Note String Description of template files Max. length 250
User Manual iManager M2000 Intelligent Report System
System MaintenanceChapter 1 System Maintenance
1-6
Table 1-12 Attributes of the RptUserGTempG table
Attribute name Attribute type Attribute description Note TemplateGId int Template type ID Primary key UserGId String User name Max. length 32
Table 1-13 Definitions of RptProxyDS table attributes
Attribute name Attribute type Attribute description Note
ProxyId int Proxy ID The primary key. It ascends automatically in the system without intervention on the Client.
DSId int Data source ID The primary key associated with the RptDataSource table via external keys. It must be an existing ID in the RptDataSource table.
address String Address It is the IP address of the data proxy server
port int Port It is the communication port of the database proxy server
maxconnection int Max. connections
It is the maximum number of connected threads opened by the database proxy server. This parameter determines the number of Clients connected with the same server.
maxconnectcount int Max. of reconnections Number of reconnections for fault recoveryDSName String Data source name Data source name ProxyName String Proxy name Proxy name
1.2 Service Program Description
The midware of the intelligent report system provides two service programs. One is the Web Server Resin which forwards Http messages in the Web service. The other program is the DatabaseProxyServer which is responsible for the connection with the service database. These two servers can be started and stopped respectively via the following scripts:
1) Bootscript for the Web Server: httpd_start
Usage: httpd_start
2) Stop script for the Web Server: httpd_stop
Usage: httpd_stop
3) Bootscript for the database proxy server program: proxyserver
Usage: proxyserver
Once started with the above scripts, the service processes will begin to run on the background. The following methods can be adopted to observe them:
User Manual iManager M2000 Intelligent Report System
System MaintenanceChapter 1 System Maintenance
1-7
After the Web Server is started, there are three processes which can be observed via filtering the resin:
ps -ef|grep resin
m2000 2557 1 0 18:41:45 ? 0:00 perl ./resin1.2.0/bin/wrapper.pl -chdir
-name httpd -class com.caucho.server.ht
m2000 2559 2557 0 18:41:45 ? 0:00 sh -c /usr/java/bin/java
-Dresin.home=/export/home/m2000/report/resin1.2.0 co
m2000 2560 2559 0 18:41:45 ? 0:13
usr/java/bin/../bin/sparc/native_threads/java
-Dresin.home=/export/home/m2000/
When the database proxy server is started, there is only one process which can be observed via the following commands:
$ps -ef|grep java|grep rpt
m2000 2575 1 0 18:41:49 ? 0:05
/usr/bin/../java/bin/../bin/sparc/native_threads/java
com.huawei.iin.rpt.databa
If the corresponding process is not available, please start it with the bootscript.
1.3 JVM Memory Management
The midware of the intelligent report system is equipped with the Java cross-platform technology. All of its system programs are written in the JAVA language. Therefore the system midware must run on the JVM (Java Virtual Machine).
According to the features of the JVM and its programming language, the server memory management requires manual intervention in certain circumstances, normally when the Client submits enormous data collection requests to the system midware.
When the JVM starts the application programs, the default minimum memory is 2M and the maximum memory is 64M. If the midware collects an enormous amount of data (for example, thousands of records) while the JVM memory is insufficient to store all the records, the JVM will a prompt for memory overflow. In this case, manual intervention is necessary to increase memory capacity so as to meet the data saving requirement.
In order to prevent memory overflow, you need to roughly estimate the data amount of the service database in the system and the level of output data amount of the report, and then adjust the starting parameters of the JVM to provide sufficient memory.
The IN report system consists of two parts: Web Server and Database Proxy Server. Both of them run on the JVM. Therefore they should be management separately
User Manual iManager M2000 Intelligent Report System
System MaintenanceChapter 1 System Maintenance
1-8
according to the actual case. The management methods are in the running scripts of the two service programs.
1.3.1 JVM Memory Management in Resin
The running memory of Resin can be adjusted through the memory parameters set via the script (named as httpd.bat in the Windows).
httpd.sh -J-Xms32m -J-Xmx256m (Unix platform )
httpd -J-Xms32m -J-Xmx256m (WINNT platform )
Note:
httpd.sh (httpd) is Resin service starting program. -J-Xms is the parameter of the minimum occupied memory parameter for the specified JVM with the minimum memory as 32MB. -J-Xmx is the parameter for the maximum occupied memory of the specified JVM with the maximum memory as 256MB.
1.3.2 JVM Memory Management in JDK
The running memory of the database proxy server can be adjusted through the memory parameter setting via the script proxyserver (named as proxyserver.bat in Windows).
java -Xms 12m -Xmx 256m com.huawei.iin.rpt.databaseproxyserver.Database ProxyServer
Note:
-Xms is the parameter for the minimum occupied memory of the specific JVM with the minimum memory as 12MB; while -Xmx is the parameter for the maximum occupied memory of the specific JVM with the maximum memory as 256MB.
User Manual iManager M2000 Intelligent Report System
System MaintenanceChapter 1 System Maintenance
1-9
1.4 View Report Log
I. View Report Log
Report log files are mainly stored in directories /log. The detailed information is described in Table 1-14. You can view the report log so as to pull in the faults listed in sections 1.5.1 and 1.5.2 , then get the corresponding solutions.
Table 1-14 Log files in the directory inrpt/log
Log file Meaning dbp_err_date.log Exceptional log in the database proxy dbp_info_date.log Serial log of database proxy operations rs_err_date.log Error log of the report server rs_dbg_date.log Serial log of report server operation resin_error.log Error log of WebServer key points (i.e. upon start or exit) resin_error.log.date Error log of WebServer operations
II. Log Viewer of Huawei IN Report System
Besides, if you install the log viewer in Win98/WinNT, the log viewer and server programs are installed in the same computer, you can view all logs. If your server is installed in Unix or the log viewer and server programs are not on the same host, you can only browse the SQL logs in the Client.
The log viewer is generally oriented for report designers. Upon report query, they can use it as design aid to simultaneously view the contents of the SQL command or the store procedure command string sent to the service database.
If the report you have designed cannot produce the correct result, you can copy the SQL command or the store procedure command string displayed in the log viewer to the Client of the database system (e.g. dbaccess) so that you can find out the cause for database access error.
III. Caption of Log File List Tree in the Log Viewer
[Caption]
1=WebServer Log file
2=WebServer operation log
3=WebServer error log
4=ProxyServer log file
5=ProxyServer operation log
6=ProxyServer error log
7=Resin log file
8=Year
9=Month
User Manual iManager M2000 Intelligent Report System
System MaintenanceChapter 1 System Maintenance
1-10
10=Date
11=Operation flow log
12=operation error log
13=error info log
14=Client query statement log
1.5 System Fault Maintenance
1.5.1 Fault Maintenance for System Midware
The midware of the IN report system midware can be used to monitor the running status on the following aspects:
1) Resin running interface 2) inrpt/log/log.txt log files
Common operation errors are returned to the Client. The fault information displayed on the Client is packed and can only indicate the general type of a fault. To exactly locate the fault and detect the fault cause, the system administrator should conduct query on the monitor terminal of the server.
Common fault types of the system midware are:
1) Faults in midware installation and configuration 2) Faults in system database connection and operation 3) Communications faults 4) Faults in third party components
I. Faults in midware installation and configuration
The installation and configuration of the midware must be accurate and correct. It involves the installation and setting of third party components, and the setting of system midware operational environment (including the setting of system environment and system files). The following are some examples:
1) java.lang.ClassNotFoundException: The path configuration of the system environment is incorrect so JVM (Java Virtual Machine) cannot find the corresponding class. Please check whether the system environment variable CLASSPATH is correctly configured.
2) java.lang. NoClassDefFoundError: java.lang.NoClassDefFoundError: The path configuration of the system environment is incorrect so JVM cannot find the corresponding class. Please check whether the system environment variable CLASSPATH is correctly configured.
3) java.lang. FileNotFoundException: The path configuration of the system is incorrect so JVM cannot find the corresponding files. Please check whether the
User Manual iManager M2000 Intelligent Report System
System MaintenanceChapter 1 System Maintenance
1-11
Config file, Log file and the Template file exist, or check whether the path or file configured in the *.conf file under inrpt/conf/ exists.
II. Connection and operation faults of the system database
The configuration information of the system database is in the file inrpt/conf/systemdb.conf. The following are some examples about faults in database connection and operation.
1) java.lang.ClassNotFoundException: The path configuration of JDBC driver package is incorrect so JVM cannot find the relevant class. Please check whether the JDBC driver program package of the system database is configured in the system environment variable CLASSPATH.
2) java.lang.SQLException: It is an abnormality prompt given by the system database. The detailed information is displayed in the monitoring window or recorded in the log file. Please adjust the relevant configuration files or the system database.
3) com.huawei.iin.rpt.util.DatabaseConnectionNotCreateException: It implies the connection fault in the system database. Connection cannot be established between the system midware and the system database. It is because all connections of the system database in the configuration file have been occupied at the same time, while the new connection request cannot get valid database connection within the specified delay. Please relatively increase the maximum number of connections of the system database.
4) com.huawei.iin.rpt.util.DataNotFoundException: No data can be queried in the system database. Normally it is because the important data of the system database does not exist when the Client attempts to access the database during operation. Please check the related data table of the system database.
5) com.huawei.iin.rpt.util.NothingHanleException: The system database has not been modified. Normally it is because zero lines are modified when the Client attempts to modify the table records in the system database during operation.
III. Communication faults
Faults occur in the communication between the system midware and the database proxy. When the Client wants to collect report data, the TCP/IP connection will be established between the report system midware and the database proxy server. Such connection is built upon the relationship between the database proxy and the data source in the data table RptProxyDS. The following are examples for communications faults.
com.huawei.iin.rpt.util. ProxyErrorException: No valid database proxy Client is available. This fault usually occurs during report data query. The possible cause may be one of the following:
User Manual iManager M2000 Intelligent Report System
System MaintenanceChapter 1 System Maintenance
1-12
1) The relationship between the database proxy server and data source is not established. Please add relationship records between the data source and the proxy server with the database proxy management tool.
2) The network is not accessible between the midware server of the report system and the database proxy server. Please check whether the network between the two servers is normal.
3) The definition of the database proxy server is incorrect or the database proxy server is not started. Please check whether the data table RptProxyDS and the configuration file Proxyserver.conf are correctly defined.
IV. Faults in third party components
The third party components included in the system midware are: Resin1.2.0, JDK1.3 (Java Development Kit) and the system database. Common faults are:
1) The Client is inaccessible: Please check whether resin runs normally. 2) JDK cannot run normally. 3) The system prompts for "out of memory". It is because the data amount of one or
several reports queried is too large and exceeds the default memory capacity of the JVM. Please refer to Section 1.3 and make necessary adjustment.
1.5.2 Fault Maintenance of Database Proxy Server
Common faults of the database proxy server are:
1) JDK operation fault 2) Communications fault 3) Configuration fault 4) Service database connection and operation fault
I. JDK running fault
The installation and configuration of JDK1.3 is not correct on the database proxy server. The correct installation method is described in the Installation of Report System module.
II. Communication fault
java.net.SocketException: The configured server address or the IP is incorrect.
III. Configuration fault
java.lang. FileNotFoundException: Configuration files are unavailable.
User Manual iManager M2000 Intelligent Report System
System MaintenanceChapter 1 System Maintenance
1-13
IV. Service database connection and operation faults
The configuration information of the service database is configured in the file inrpt/conf/businessdb.conf. The following are some examples for the faults in database connection and operation:
1) java.lang.ClassNotFoundException: The path configuration of JDBC driver package for the service database is incorrect, so JVM cannot find the relevant class. Please check whether the JDBC driver package of the service database is configured in the system environment variable CLASSPATH.
2) java.lang.SQLException: The service database is abnormal. The abnormal information will be displayed in the monitoring window or be recorded in the log file. Please adjust the related configuration file and the service database.
3) com.huawei.iin.rpt.util.DatabaseConnectionNotCreateException: It implies the service database connection fault. Connection cannot be established between the database proxy and the service database. Normally it is because all service database connections in the configuration file has been occupied at the same time. The new connection request cannot get valid database connection within the specified delay. Please properly increase the maximum number of service database connections.
HUAWEI
iManager M2000 Intelligent Report System User Manual
Installation of Report System
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemTable of Contents
i
Table of Contents
Chapter 1 Installation of Report System..................................................................................... 1-1 1.1 Overview ............................................................................................................................ 1-1
1.1.1 System Components............................................................................................... 1-1 1.1.2 System Structure and Path ..................................................................................... 1-1 1.1.3 Preparations ............................................................................................................ 1-2
1.2 Install Intelligent Report System Software in UNIX ........................................................... 1-3 1.2.1 Installation Flowchart .............................................................................................. 1-3 1.2.2 Create Directory ...................................................................................................... 1-4 1.2.3 Upload Files ............................................................................................................ 1-4 1.2.4 Unpackage .............................................................................................................. 1-6 1.2.5 Create Database ..................................................................................................... 1-6 1.2.6 Install New System.................................................................................................. 1-8 1.2.7 Copy "license" File ................................................................................................ 1-17 1.2.8 Set Report Database Information.......................................................................... 1-17 1.2.9 Set Service Database Information ........................................................................ 1-18 1.2.10 Copy Template File ............................................................................................. 1-18 1.2.11 Start System........................................................................................................ 1-19 1.2.12 Install Client Program.......................................................................................... 1-19 1.2.13 Clear Local Temporary Files ............................................................................... 1-19 1.2.14 Register System Tasks ....................................................................................... 1-19 1.2.15 Shut Down System.............................................................................................. 1-20
1.3 Upgrade the Intelligent Report System............................................................................ 1-20 1.3.1 Shutdown Old System........................................................................................... 1-20 1.3.2 Back up Data......................................................................................................... 1-20 1.3.3 Upgrading.............................................................................................................. 1-21 1.3.4 Failure Handling .................................................................................................... 1-24
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-1
Chapter 1 Installation of Report System
1.1 Overview
1.1.1 System Components
The report system midware is installed in the Web Server and realized via Java and the Application Servers. The data midware is equipped with Java executable files and JDBC universal interfaces, which realize the cross-platform transplantation and distribution.
The Client of the user-defined report system does not require too much routine maintenance except the maintenance for the browser, which is determined by the system structure. But when the iManager M2000 system is upgraded, the report system also needs to be upgraded as per the following instructions:
If the report template is changed, delete all frf template files in windows/temp upon upgrading, otherwise, the result will be displayed via the old template.
Besides, after upgrading the iManager M2000 server, copy the latest report server license files (systemuser.conf) to the directory /export/home/inrpt/conf.
1.1.2 System Structure and Path
The interlayer service system part of the user-defined report system is described in Table 1-1.
Table 1-1 Description of component group in report system
System Component Path Component Description #Resin1.2.0 #HOME/resin Web Server and Application Server #JDK1.3 /usr/j2se Java operational environment
System configuration file $HOME/conf Running configuration file of midware programs
#JDBC driver $HOME/jdbc JDBC driver connecting all databases Template file $HOME/template Report template file Log file $HOME/log System running log file System database User-defined System database
*Database Proxy server $HOME/com General proxy gateway of service database
*Service database User-defined Service database Note: (#) indicates the components provided by the third party. (*) indicates that the component can be installed and run independently. $HOME is the home directory for report server users, normally it is equivalent to /export/home/inrpt.
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-2
Note:
1) The part containing (*) can run on other equipment. 2) The service database and Proxy server can be associated via topology.
1.1.3 Preparations
I. Environment Requirements
The report system requires JDK1.3 or above. JDK is the product developed by the third party, and JDK1.3 raises the demands for different operating systems as follows:
For the Solaris operating system, Solaris2.6, Solaris2.7 or Solaris2.8 is available. In the installation package, the JDK1.3 package and its corresponding patch package are provided.
For the HP-UX operating system, HP-UX 11.0 or above is required. For the IBM's AIX operating system, AIX4 or AIX5 is required.
For the Windows operating system, Windows 98, Windows 2000, or Windows NT 4.0 or above is required.
II. Preparations
1) First, check whether the Sybase database can work normally and ensure the two database devices (data_dev and log_dev) have been correctly installed. We can check the Sybase database by executing the isql command. The command ps -ef|grep dataserver can help check whether the Sybase database process is running. If login to the Sybase database fails, errors may exist and you should check the installation process.
2) If the M2000 user-defined report server has been installed, it should be uninstalled first.
3) Prepare installation media: CD or tape. 4) If CDROM is used as installation medium, install it into the system manually if
automatic installation is not supported. 5) If tape is used as the installation medium, execute drvconfig first so that the tape
equipment can be loaded into the system. The CD directory is usually /cdrom/cdrom0, while the tape directory might be /dev/rmt/0 which is decided by the specific system.
III. Mandatory Information
Table 1-2 describes all the mandatory information.
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-3
Table 1-2 Mandatory information for installation
Information Description root user password Mandatory m2000 user and password Mandatory Installation package inrpt_210.tar.Z Mandatory JDK installation package jdk_sun58.tar Mandatory Database scripts and template files package rptdata.tar Mandatory sybase user password Mandatory
1.2 Install Intelligent Report System Software in UNIX
1.2.1 Installation Flowchart
Figure 1-1 Report system installation flowchart
For the detailed installation and setup procedure, see Figure 1-2.
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-4
Figure 1-2 Server program installation and setup flowchart
1.2.2 Create Directory
First switch over to a Sybase user, and create a directory to store files to be installed (create the directory as bak2 in this example).
#su -sybase
$mkdir bak2
$cd bak2
1.2.3 Upload Files
Then upload the files needed by installation into the directory bak2.
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-5
Note:
Upload the installation packages inrpt_210.tar.Z, rptdata.tar and jdk_sun58.tar. 1. This step is executed in the Window system via PC. 2. In the following part, the bold contents in each square bracket is the explanation of the command. 3. The directory e:\rptinstall and the Sybase host directory "/export/home/sybase are determined by the actual case. In this description, we only take an example. 4. The BIN format should be adopted.
c:\>ftp 10.129.27.100
[Let’s supppose 10.129.27.100 is the IP address of the server to be connected]
Connected to 10.129.27.100.
220 xy FTP server (SunOS 5.6) ready.
Name (10.129.27.100:inrpt): sybase
[Enter sybase user name]
331 Password required for sybase.
Password:
[Enter sybase user password]
230 User sybase logged in.
ftp> lcd e:\rptinstall
[Switch to the local directory storing installation files]
Local directory now e:\rptinstall
ftp> pwd
[View current directories in the server]
257 "/export/home/sybase" is current directory.
ftp> cd bak2
[Switch to the bak2 directory created]
250 CWD command successful.
ftp>bin
[Switch the transmission format as binary]
ftp> prompt
[Close the dialog mode – no confirmation prompt will be given for the later transmission]
ftp> put inrpt_210.tar.Z
[Upload the file inrpt_210.tar.Z]
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-6
ftp> put rptdata.tar
[Upload the file rptdata.tar]
ftp> put jdk_sun58.tar
[Upload the file jdk_sun58.tar]
ftp> bye
[Exit]
c:\>
1.2.4 Unpackage
# su - sybase
$ cd bak2
$ pwd
/export/home/sybase/bak2
$ uncompress inrpt_210.tar.Z
$ tar -vxf inrpt_210.tar
$ tar -vxf rptdata.tar
[jdk_sun58.tar needn’t unpackage]
1.2.5 Create Database
Note:
1. The host directory "/export/home/sybase of Sybase is determined by the actual case. In this description, we only take an example. 2. The content in the following square bracket is the explanation of the command. 3. The user name and password of the database inprtdb must be consistent with the new settings for system installation. 4. No error prompt should occur in the following operation. If any occurs, please contact Huawei local office. 5. The typical installation cannot be selected unless the password of the database superuser sa is set as server1234.
#su - sybase
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-7
$ cd bak2
$ crtrptdb2.sh
Please choose between typical installation and custom installation.
choices:
t -- typical
c -- custom [?,q] c
[Here, custom mode must be selected; otherwise, the installation may be unsuccessful]
Caution:
Here the system asks whether to select the typical installation or the customized installation. You can press <Enter> for customized installation. During installation, the system will ask you to input the password for Sybase system administrator. Note: If you enter a sa password except server1234, please select customized installation.
Input db user sa passwd[default server1234].
Press enter if you agree [?,q] server1234
[Enter the sa password for the superuser of the sybase database. Here server1234 is only an example. Please enter the actual password]
Input db user [default report].
Press enter if you agree [?,q] report
[Enter the user name of the inrptdb database to be created. Here report is only an example. Please enter the actual user name, for example: m2000]
Input passwd [default report].
Press enter if you agree [?,q] report
[Enter the user password of the inrptdb database to be created. Here report is only an example. Please enter the acutal password. If the user name in the last step is m2000, the password for m2000 is required here]
Input database size[default 100M].
Press enter if you agree [?,q] 100
[Enter database space]
Set db user report
Create database inrptdb...
CREATE DATABASE: allocating 56320 pages on disk 'data_dev'
CREATE DATABASE: allocating 56320 pages on disk 'log_dev'
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-8
[Operation contents will not be displayed in the following part]
1.2.6 Install New System
Caution:
1. In the following three Cautions, the user name and password set for the database must be consistent with the settings made upon database creation. For example: If the host user of the inrptdb2 databse is M2000, you have to enter M2000 and its corresponding password. If the host user of the inrptdb2 database is report, you must enter report as the user. 2. In the following part, the content in each square bracket is the explanation of the command. 3. During a series of installation prompts, you must pay close attention to the Cautions.
(a) First decompress the installation package inrpt_sun_5_6.tar, which has been uploaded into the directory /export/home/sybase/bak2.
#su -sybase
$ cd bak2
$ tar -vxf ./inrpt_210.tar
(b) Then run the installation script files to install the new system.
The script files are also in the directory /export/home/sybase/bak2.
$ sh setup.sh
Then installation prompt information will appear on the screen.
Welcome to installation of Huawei Intelligent Report System V2.1.0. This wizard
will guide you through the following steps:
=================================================================
(1) Install JAVA SDK if necessary, JAVA SDK V1.3 or later is required.
(2) Install WebServer.
(3) Install one or more Proxy Servers.
-----------------------------------------------------------------
Note: As a convention, press 'Enter' to select the default later. -----------------------------------------------------------------
Press 'Enter' to continue...
Press <Enter> to select the default value.
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-9
Caution:
During installation, the system will give some prompts for which default values are available. You may press <Enter> if you don’t make any change. Do not click <Y> unless it is a question of yes/no, otherwise the system will recognize the letter "y" as a new value instead of the default value.)
I. Step 1: Install JDK 1.3
================================================================
Install JDK 1.3 ? ([1]Yes [2]No [0]Quit)[Default:1]: ================================================================
[In the case of initial installation, JDK should be installed. Press <Enter> to start installing JDK]
Please input JDK's installation pathname, which must be absolute,
not end with '/', be the parent of directory 'bin', and have the
same last one of name sequence with the default pathname.
[Default: /usr/j2sdk1_3_1_02]:
[Press <Enter> to confirm]
Decompress /export/home/sybase/bak2/jdk_sun58.tar...OK!
Installing JDK requires the permission of user 'root', please
enter its password.Password:
[Enter the root user password]
Now is going to install JDK on Solaris5.8.
Note:
During installation, if asked whether to agree, please answer
"y"; if asked whether to install or replace, please answer "A".
Some steps maybe take six to eight minutes, don't force to quit
in such case. If there is no response yet after 10 to 15 minutes,
please force to quit for reinstallation.
================================================================
Press "Return" to continue...
[Press <Enter> to continue]
Sun Microsystems, Inc.
Binary Code License Agreement
READ THE TERMS OF THIS AGREEMENT AND ANY PROVIDED SUPPLEMENTAL LICENSE TERMS...
[Press <Enter> to continue]
Do you agree to the above license terms? [yes or no]
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-10
[Type in "Yes"]
Unpacking...
Checksumming...
Extracting...
Archive: ./install.sfx.4139
replace j2sdk1_3_1_02/jre/bin/sparc/native_threads/java? [y]es, [n]o, [A]ll,
[N]one, [r]ename: A
inflating: j2sdk1_3_1_02/jre/bin/sparc/native_threads/java
...
java version "1.3.1_02"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.3.1_02-b02)
Java HotSpot(TM) Client VM (build 1.3.1_02-b02, mixed mode)
Press "Return" to back to console...
[Press <Enter> to continue]
II. Step 2: Install WebServer
For parameter description of intelligent report server installation, see Table 1-3.
================================================================
Install WebServer? ([1]Yes [2]No [0]Quit)[Default:1]:
[Press <Enter> to select the default 1]
Please input the UNIX user group name of WebServer.
[Default: inrpt]:
[Press <Enter> to use the default user group name]
Please input the UNIX user name of WebServer.
[Default: inrpt]:
[Press <Enter> to use the default user name]
Please input the home directory of user inrpt, which must be absolute,
not end with '/'.
[Default: /export/home/inrpt]:
[Please modify the directory to be installed for the report system, normally as "/export/home/inrpt"(it’s a example)]
Note:
This installation directory is the user directory for installing intelligent report.
If the user or user group does not exist, you need create them.
Create them? ([1]Yes [0]No) [Default:1]:
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-11
[Need to create the user]
Creating user and user group requires the permission of user 'root',
please enter root's password.
Password:
[Enter the root user password]
6 blocks
Change password for "inrpt" :
New password:
[Enter the inrpt user’s new password]
Re-enter new password:
[Please confirm the new password]
Installing WebServer requires the permission of user inrpt,
please enter user inrpt's password.
Password:
[Enter the new password of the inrpt user created just now]
...
Change current directory to '/export/home/inrpt'.
----------------------------------------------------------------
Copy installation package 'web_unix_cn_2_1_0.tar'...OK!
Decompress WebServer installation package 'web_unix_cn_2_1_0.tar'...
.......
Warning:
Upgrading will clear the system database of current system, and template files, if any, will be deleted.
How to transfer? (1-Automatically 0-Manually or not upgrade)
[Default: 0]:
[Input 0 because this is a new installation procedure].
Note:
Here, “couldn't set locale correctly” may appear in the screen, and this is caused by the mismatch of system character set. This message can be neglected because the system is not affected.
------------------------------------------------------------------------------------------------
Next, we will, if necessary, initialize system database.
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-12
Before now, you must precreate a database as the system
database in your DBMS. 'inrptdb2' is recommended as the
database name.
Press 'Return' to continue...
[Press <> to continue]
Input current version of system database configuration parameters:
[0] - Oracle(English)
[1] - Oracle(Chinese)
[2] - SQL Server(English)
[3] - SQL Server(Chinese)
[4] - Sybase(English)
[5] - Sybase(Chinese)
[6] - Informix(English)
[7] - Informix(Chinese)
Select database type[]:
[Type “4” here to select the database system]
Host address[0.0.0.0]:10.129.27.105
Port number[7100]:4100
[The port No. must be modified, because the normal port No. used in the system is 4100. The input format must be: IP address: port No.]
Database name/SID[inrptdb2]:
JDBC extended options[]:
User name[]:report
[Enter the database user name. The report here is an example. Please enter the actual user name]
User password[]:report
[Enter the password of the report database user. "report" is only an example. Please enter the actual password]
Initialize system database? (y-Initialize/n-Don't)[Don't]:y
[Type "y" to continue]
Current adopted JDBC for Sybase is jconn.jar, have you patched for system
database? (y-patched/n-not patched)[patched]:
Migrate previous version of system database? (y-Migrate/n-Don't
migrate)[Don't migrate]:
[Press <Enter>, and the upgrade is not based on the existing version]
INRPT Server's HTTP port number[8088]:
[Press <Enter>, and use the default value]
Is the above configuration right?(y-Right/n-Not right)[y]:
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-13
[Press <Enter>, and use the default value]
Configure resin.conf ..., OK
Configure system.conf ..., OK
Configure jdu.conf ..., OK
Configure ws.sh ..., OK
Configure deployws.sh ..., OK
Configure index.html ..., OK
INRPT Server was configured successfully!
--------------------------------------------------------------------------
WebServer's installation is completed!
Press 'Return' to back to console...
Note:
Here, "Unexpected exception : SqlState: ZZZZZ com.sybase.jdbc2.jdbc.SybSQLException: Cannot drop the table 'RptColumn', because it doesn't exist in the system catalogs., ErrorCode: 3701" may appear in the screen, because these tables have not been created in the new system, and the message is provided when the installation program attempts to delete these tables. The system will automatically create these tables. The message can be neglected because the system is not affected.
Table 1-3 Description of parameters in the report server installation
Configuration item Description Default value
Database type
Refers to the system database type of the report system The available database types include: 0: Oracle (English) 1: Oracle (Chinese) 2: SQLServer (English) 3: SQLServer (Chinese) 4: Sybase (English) 5: Sybase (Chinese) 6: Informix(English) 7: Informix (Chinese) In the uncertain situation, please select English.
Host address Refers to the host IP address for installing the report server.
Port Number.
Indicates the port the database system to the outside service. The ports are different due to different database systems. For details, please contact the database system administrator.
The default port No. of Oracle is 1521.The default port No. of SQLServer is 1433. The default port No. of Sybase is 7100. The default port No. of Informix is 9002.
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-14
Configuration item Description Default value
Database name Refers to the name of an empty database in the database system before the report system is installed.
JDBC Expanded options
The content filled in the field usually depends on different database systems.
The default database service name of Oracle is null. The default name of the database service of SQLServer is null. Please input db.encoding = name of character set if the database service name of Sybase is not default. The default database service name of Informix is the value of INFORMIXSERVER.
User Name Refers to the name used to access the database.
The default user name for the database of Oracle system is oracle. The default user name for the database of SQLServer system is sa. The default user name for the database of Sybase system is sa. The default user name for the database of Informix system is Informix.
User password Refers to the password of the user who accesses the database.
The default user password for the database of Oracle system is oracle. The default user password for the database of SQLServer system is null. The default user password for the database of Sybase system is null. The default user password for the database of Informix system is informix.
Create system database?
The system queries whether to create the system database after relevant parameters of the system database have been configured. If y is selected, then all the tables in the original database will be deleted and recreated. If n is selected, then only the above information will be written into the configuration file without any modification to the database.
If a new report server is installed, select y (create). If only the system configuration is conducted, select n (not create).
Have you patched for system database?
When a database of Sybase is created, the system will give the following prompt: “Current adopted JDBC for Sybase is jconn.jar, have you patched for system database?” If the match has been made, please select y. If not, select n.
If the database has been patched, select y.
Migrate previous version of system database?
To migrate the old system database, select y (migrate). To install a new report server, select n (not migrate). Note that the old report system of V 1.X needs to be migrated, and V2.X is compatible.
Not migrate
INRPT Server's HTTP Port Number
The report server provides the service port for the report client. For example, we input http://10.76.175.214:8088 in IE to access the report system. “8088” in the address is HPPT port No. of the report server.
8088
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-15
Configuration item Description Default value
Is the above configuration right?
If y (right) is selected, the system will install the report server according to the configuration made by the operator. If n (wrong) is selected, the operator will configure the above configuration items anew.
III. Step 3: Install ProxyServer
For parameters description of intelligent report database proxy installation, see Table 1-4.
Install ProxyServer? ([1]Yes [2]No [0]Quit)[Default:1]:
Please input the UNIX user group name of ProxyServer.
[Default:inrpt]:
[User group name: inrpt. Press <Enter>, and use the default value]
Please input the UNIX user name of ProxyServer..
[Default:inrpt]:
[User name: inrpt. Press <Enter>, and use the default value]
Please input the home directory of user inrpt, which must be absolute, not end
with '/'. [Default:/export/home/inrpt] :
[Installation directory: /export/home/inrpt. Press <Enter>, and use the default value]
If the user or user group does not exist, you need create them. Create them?
([1]Yes [0]No) [Default:1]:
[Press <Enter>, and use the default value]
Installing ProxyServer requires the permission of inrpt, please input user
inrpt's password.
Password:
[Type the inrpt user password]
----------------------------------------------------------------
Change current directory to "/export/home/inrpt":
----------------------------------------------------------------
Copy installation package "proxy_unix_2_1_0.tar"...OK!
Decompress ProxyServer installation package "proxy_unix_2_1_0.tar"...OK!
----------------------------------------------------------------
Please specify connecting port number for DB Proxy[9088]:
[Press <Enter>, and use the default value]
Please specify maximum connection number for DB Proxy[10]:
[Press <Enter>, and use the default value]
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-16
Please specify service thread number of each connection[2]:
[Press <Enter>, and use the default value]
Please specify maximum row number of each batch[2000]:
[Press <Enter>, and use the default value]
Is the above configuration right?(y-Right/n-Not right)[y]:y
Configure dbproxy_system.conf ..., OK
Configure ps.sh ..., OK
Configure jdu.conf ..., OK
Configure deployps.sh ..., OK
Configure patchforjconn2.sh ..., OK
DB Proxy was configured successfully!
----------------------------------------------------------------
ProxyServer's installation is completed!
Press 'Return' to back to console...
----------------------------------------------------------------
ProxyServer's installation is completed!
Press 'Return' to back to console...
Install other PrxoyServers? ([1]Yes [2]No [0]Quit)[Default:2]:
[Press <Enter>, and use the default value. It is unnecessary to install other ProxyServer]
----------------------------------------------------------------------------------------------------------
The installation ends.
Table 1-4 Description of parameters in the database proxy server installation
Configuration item Description Default value
Please specify connecting port number for DB proxy
Refers to the port that the database proxy server provides to the report server for connection, that is, the port which is entered by a user in creating a database proxy server by using the client. If multiple database proxy servers are installed on the same server, then the port numbers of the database proxy servers cannot be identical.
9088
Please specify maximum connection number of DB proxy
Refers to the max. connections created between the database proxy server and the report server, that is, the max. connections which is input by a user in creating the database proxy server by using the client. The parameter should adopt the default value of the system for a larger one will consume too much resource.
10
Please specify server thread number of each connection
Refers to the number of service threads of each connection established between the database proxy server and report server. General, it is configured to the default value.
2
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-17
Configuration item Description Default value
Please specify maximum row number of each batch
Refers to the number of records sent to the report server by the database proxy server. General, the value is from 2000-5000.
2000
Is the above configuration is right?
If y (right) is selected, the system will install the database proxy server according to the configuration made by the operator. If n (wrong) is selected, the operator will configure the above configuration items anew.
1.2.7 Copy "license" File
# su - inrpt
[hostname]% cp /export/home/sybase/bak2/omc.lic /export/home/inrpt/lic
Note:
"/export/home/Sybase" and "/export/home/inrpt" are the master directory of Sybase and inrpt user. Please modify them upon requirements.
1.2.8 Set Report Database Information
# su – sybase
$ cd bak2
$ sh set_report.sh
Input report database username [default report].
Press enter if you agree [?,q]
[Input the username of report database, and the default is “report”]
Input report database user password [default report].
Press enter if you agree [?,q]
[Input the password of report database, and the default is “report”]
Input report datasource ip address [default 10.129.27.105].
Press enter if you agree [?,q] 10.129.27.105
[Input IP address of database server]
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-18
Input report proxy ip address[default 10.129.27.105].
Press enter if you agree [?,q] 10.129.27.105
[Input IP address or proxy server]
bcp RptColumn...
...
---The End of installation---
1.2.9 Set Service Database Information
$ sh set_ds_db.sh
Input username of datasource database [default report].
Press enter if you agree [?,q] m2000
[Here it refers to the username of m2000 database, which is usually “m2000”. Please don’t just press <Enter>]
Input password of datasource database [default report].
Press enter if you agree [?,q] Z83fC868fZ07jW67
[Here it refers to the password of database user m2000, not the password of Unix user]
(1 row affected)
(1 row affected)
(1 row affected)
1.2.10 Copy Template File
# su - inrpt
[hostname]% cp -r /export/home/sybase/bak2/template .
Note:
"/export/home/Sybase" and "/export/home/inrpt" are the master directory of Sybase and inrpt user. Please modify them upon requirements.
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-19
1.2.11 Start System
# su - inrpt
hostname% cd
[Switch to the master directory of inrpt user]
hostname% b
[Start report system]
hostname% Now is starting DB proxy daemon ...
Resin 2.1.4 (built Fri Aug 2 14:16:52 PDT 2002)
Copyright(c) 1998-2002 Caucho Technology. All rights reserved.
Listening to DB proxy at port 37213 ...
Starting Resin on Wed, 30 Oct 2002 17:11:16 +0800 (CST)
http listening to *:8088
The end of installation.
1.2.12 Install Client Program
Start IE browser, input http://10.129.27.132:8088 (here assume the address of report server is 10.129.27.132); and click “Install Report System Client” to start the installation.
After the client program is successfully installed, select [Start/Programs/Huawei Report System (V20R001)/Huawei Report System Client] to start the system. In the user login interface, input the address 10.129.27.132:8088. In the installation program, the built-in user account is m2000, and password and username are the same.
For the details of client management, see “Client Management” module.
1.2.13 Clear Local Temporary Files
Start intelligent report system client manager, and select [Tool/Clear Local Data Files] to clear the local temporary files stored in client.
1.2.14 Register System Tasks
To user the report template, the user needs to register the corresponding system tasks in the performance service console. In performance service console, select [Task/Register System Task] to register system task.
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-20
1.2.15 Shut Down System
This part is used only in maintenance.
# su - inrpt
[hostname]
[Switch to the master directory of inrpt user]
[hostname]e
1.3 Upgrade the Intelligent Report System
Report system upgrade is to upgrade the current system, i.e., upgrade report template. For the detailed upgrade steps, see Release Notes. Shut down old version report system firstly in case of upgrading.
1.3.1 Shutdown Old System
# su – inrpt
[hostname]e
[hostname]pwd
/export/home/inrpt
1.3.2 Back up Data
# cp -r /export/home/inrpt/template ./template_bak2
[/export/home/inrpt is inrpt user’s HOME directory]
$ isql -Usa -Pserver1234
1> dump tran inrptdb2 with no_log
2> go
1> dump database inrptdb2 to "/export/home/sybase/bak2/inrptdb.dat"
2> go
1> quit
$ tar cvf inrptbak.tar *
$
[Here below the displayed content is omitted]
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-21
Put the above generated “inrptbak.tar” backup files in a safe place. If the files are moved to PC, they should be in bin format.
1.3.3 Upgrading
I. Upload the files to be installed to the directory created in the first step
Upload upgrade.tar files to the bak2 directory in the server.
Caution:
1. This step is executed in the Windows system on a PC. 2. The part in the square bracket is the explanation of the command. 3. The directory e:\rptinstall and the sybase host directory "/export/home/sybase" should be set as per the actual case. It is only an example. 4. The bin format should be used for the FTP of the two tar files.
II. Decompress upgrade.tar
$ pwd
/export/home/sybase/bak2
$ ls upgrade.tar
upgrade.tar
$ tar xvf upgrade.tar
x set_ds_db.sh, 828 bytes, 2 tape blocks
x set_report.sh, 1299 bytes, 3 tape blocks
x table, 0 bytes, 0 tape blocks
x table/RptColumn.txt, 6957 bytes, 14 tape blocks
x table/RptDS.txt, 318 bytes, 1 tape blocks
x table/RptProxyDS.txt, 118 bytes, 1 tape blocks
x table/RptSP.txt, 0 bytes, 0 tape blocks
x table/RptSPIn.txt, 0 bytes, 0 tape blocks
x table/RptSPRS.txt, 0 bytes, 0 tape blocks
x table/RptTable.txt, 995 bytes, 2 tape blocks
x table/RptTemplate.txt, 1044 bytes, 3 tape blocks
x table/RptTemplateG.txt, 49 bytes, 1 tape blocks
x table/RptUser.txt, 98 bytes, 1 tape blocks
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-22
x table/RptUserG.txt, 111 bytes, 1 tape blocks
x table/RptUserGTempG.txt, 66 bytes, 1 tape blocks
x table/RptUserUserG.txt, 82 bytes, 1 tape blocks
....
$
III. Import database data
# su -sybase
$ cd bak2
$ pwd
/export/home/sybase/bak2
$ chmod +x set_report.sh
$ set_report.sh
Input report database username [default report].
Press enter if you agree [?,q] report
[Enter the user name of the report database inrptdb, which should be consistent with the user name upon inrptdb creation]
Input report database user password [default report].
Press enter if you agree [?,q] report
[Enter the user password of the report database inrptdb, which should be consistent with the password upon inrptdb creation. ]
Input report datasource ip address.
Press enter if you agree [?,q] 10.129.10.11
[Enter the IP addresses of the report data source and the server of the M2000 databases pmdb and cfgdb.]
Input report proxy ip address.
Press enter if you agree [?,q] 10.129.10.11
[Enter the IP addresses of the report proxy server and the report system server]
bcp RptSP...
Starting copy...
0 rows copied.
Clock Time (ms.): total = 1
bcp RptTable...
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-23
Starting copy...
......
$
IV. Copy template files
# su - inrpt
[hostname]cd inrpt/template
[hostname]pwd
/export/home/inrpt/template
[hostname]cp /export/home/sybase/bak2/template/* /export/home/inrpt/template
V. Set report database and data source database
# su -sybase
$ cd bak2
$ chmod +x set_ds_db.sh
$ set_ds_db.sh
Input username of datasource database [default report].
Press enter if you agree [?,q] m2000
[User name of the data source database (pmdb and cfgdb of the M2000 system) ]
Input password of datasource database [default report].
Press enter if you agree [?,q] Z83fC868fZ07jW67
[User password of the data source database (pmdb and cfgdb of the M2000 system)]
$
VI. Start the system
# su - inrpt
[hostname]:>cd
[Switch to the host directory of inrtp user]
[hostname]:>b
[Start report system]
INRPT Server start…
The ProxyServer Start...
User Manual iManager M2000 Intelligent Report System
Installation of Report SystemChapter 1 Installation of Report System
1-24
Succeeded in starting report system.
[hostname]:>
Now the installation is completed.
1.3.4 Failure Handling
If the upgrading fails, please handle the failure in the following steps:
I. Restore the template data
FTP the stored inrptbak.tar files to /export/home/sybase/bak2 in the bin format, with the ftp user as Sybase.
# su – sybase
$cd bak2
$tar xvf inrptbak2.tar
II. Restore template data
# su - inrpt
[hostname] e
[hostname] pwd
/export/home/inrpt
[hostname]cd /template
[hostname]rm *
[hostname]cp /export/home/sybase/bak2/template_bak/* /export/home/inrpt/template
III. Restore database data
# su - sybase
$ cd bak2
$ isql -Usa -Pserver1234
1> load database inrptdb2 from "/export/home/sybase/bak2/inrptdb2.dat"
2> go
1> online database inrptdb2
2> go
1> quit
HUAWEI
iManager M2000 Intelligent Report System User Manual
Appendix
User Manual iManager M2000 Intelligent Report System
Appendix Table of Contents
i
Table of Contents
Appendix A Conventional SQL Statements................................................................................A-1 A.1 Query Type........................................................................................................................A-1
A.1.1 Simple Query ..........................................................................................................A-1 A.1.2 Connection Query...................................................................................................A-1 A.1.3 Subquery.................................................................................................................A-2
A.2 Aggregation Function, Grouping and Sequencing ............................................................A-2
Appendix B Description of Multi-object Parameter Structure ..................................................B-1
Appendix C Abbreviations ...........................................................................................................C-1
User Manual iManager M2000 Intelligent Report System
Appendix Appendix A Conventional SQL Statements
A-1
Appendix A Conventional SQL Statements
A.1 Query Type
A.1.1 Simple Query
A. Select several columns
Select expression [,expression]... From table_list
To select all columns, use the command Select * From table_list
B. Select several rows
Query records beginning with 415 of a payer number
Select * from bill_s where payment like '415%'? Delete rows with duplicated values
Select distinct * from bill_s
Use like for Text and char. The wildcards '%' and '-' can be used respectively for multiple characters and single characters.
Other common query conditions: (except the text type)
Value comparison =, >, <, >=, <=, !=, !> and !<
Range specified between exp1 and exp2 /net between exp1 and exp2
List or collection in (exp1[,exp2,[...]]) not in (...)
Predication like
Multiple conditions and or not
A.1.2 Connection Query
I. Equivalent connection and inequivalent connection
When "=" is used for the comparison of two data, the connection is called as equivalent connection. If any other comparison operator is used, the connection is called as inequivalent connection.
Equivalent connection:
Select * from publishers, authors where publishers.city=authors.city
User Manual iManager M2000 Intelligent Report System
Appendix Appendix A Conventional SQL Statements
A-2
Inequivalent connection:
select distinct * from publishers,authors where publishers.city <> authors.city
II. Natural connection
Among the columns with the same name in the target connection column, only one column is reserved.
Select publishers.pub_id publishers.pub_name, publishers.state, authors.*
From publishers, authors where publishers.city=authors.city
A.1.3 Subquery
I. Subquery of expression
Select au_lname, au_fname from authors where city=
(select city from publishers where pub_name=bcde)?
You can select all size comparison operators can be used. Between operator and subquery "all" or "any" can be used.
II. Definitive predication subquery
Select pub_name from publishers from publishers
Where pub_id in
(select pub_id from titles where type=bcde)?
III. Associated query
The associated query is to get the value of the external parent query by means of nested query. The nested query should be repeatedly executed for several times.
Select distinct t1.type from titles t1
Where t1.type in ( select t2.type from titles t2 where t1.pub_id!=t2.pub_id)
A.2 Aggregation Function, Grouping and Sequencing
I. Aggregate query results
Aggregation function:
User Manual iManager M2000 Intelligent Report System
Appendix Appendix A Conventional SQL Statements
A-3
Sum([all|distinct]expression),avg([all|distinct] exoression) ,Count([all|distinct]expression), count(*), max(expression), min(expression)
Select count(*) from titles
II. Group query results with group by and having Sub-statements
Select type ,avg(advance), sum(total_sales) from titles group by type
Select type from titles group by type having count(*) >1
Having has the similar function with where, but where cannot be used for aggregation functions
III. Sequence query results with order by
Select type ,avg(price) from titles group by type order by avg(price)
User Manual iManager M2000 Intelligent Report System
Appendix Appendix B Description of Multi-object Parameter Structure
B-1
Appendix B Description of Multi-object Parameter Structure
I. Multi-combination object
Field name Field type Field length Field meaning objset_m1 int 4 MSC objset_m2 varchar 24 Calling prefix objset_m3 int 4 Call source office direction objset_m4 int 4 Outgoing office direction objset_m5 varchar 24 Called prefix objset_m6 tinyint 1 Call attribute
II. CGI pairs
Field name Field type Field length Field meaning objset_m1 int 4 Observed cell objset_m2 varchar 13 Adjacent cell
III. Office direction destination
Field name Field type Field length Field meaning objset_m1 int 4 Office direction objset_m2 int 4 Destination
IV. SRF resources
Field name Field type Field length Field meaning objset_m1 int 4 Module No. objset_m2 tinyint 1 SRF resource type
V. IN event measurement parameters
Field name Field type Field length Field meaning objset_m1 int 4 Service key objset_m2 int 4 SCP flag
User Manual iManager M2000 Intelligent Report System
Appendix Appendix B Description of Multi-object Parameter Structure
B-2
VI. Multi-flow object parameters
Field name Field type Field length Field meaning objset_m1 int 4 MSC objset_m2 tinyint 1 multi-flow object parameter
VII. MTP DSP object
Field name Field type Field length Field meaning objset_m1 int 4 DSP objset_m2 tinyint 1 Source network ID objset_m3 varchar 6 OPC
User Manual iManager M2000 Intelligent Report System
Appendix Appendix C Abbreviations
C-1
Appendix C Abbreviations
F FTP File Transfer Protocol G GCI Cell Global Identification H HTML Hypertext Markup Language HTTP Hypertext transfer Protocol I IP Internet Protocol J JDBC Java Database Connectivity JDK Java Developer’s Kit JSP Java Server Pages JVM Java Virtual Machine L LAN Local Area Network M ME Management Element MSC Mobile Switch Center MTP Message Transfer Part N NE Network Element O OMC Operation and Maintenance Center OPC Original (signaling) Point Code P PS Proxy Server R RTF Rich Text Format S SCP Service Control Point SDK Software Development Kit SP Stored Procedure SQL Structured Query Language SSL Security Socket Layer T TCP Transfer Control Protocol
User Manual iManager M2000 Intelligent Report System
Appendix Appendix C Abbreviations
C-2
U URL Uniform Resource Locator V VM Virtual Machine W WMF Windows Metafile
Top Related