Está en la página 1de 27

G.O.L.D.

CENTRAL-SHOP

REPORTS

Manual type: User manual


Manual reference: GB-CEN-509-UTI-ADMEDI-059-1

This manual corresponds to the patch: CEN509-RM00JAN11


CONFIDENTIALITY

This document contains information that is proprietary and confidential to Aldata Solution.
This information is provided for the sole purpose of permitting the recipient to evaluate the
information. In consideration of the receipt of this document, the recipient agrees to treat the
information as confidential and to not reproduce or otherwise disclose this information to any
persons outside the group directly responsible for the evaluation of its contents, without the
prior written consent of Aldata Solution.

Copyright
2007, Aldata Solution. All rights of reproduction reserved.
G.O.L.D. is a registered trademark of Aldata Solution.
All other brand names of products mentioned may be registered trademarks or trademarks of
their respective companies.
FOREWORD
ABOUT G.O.L.D. PRODUCT DOCUMENTATION

Types of manuals

There are three types of manuals related to G.O.L.D. products:


user manuals provide functional explanations and explain how to use G.O.L.D. screens
administration manuals are for the use of administrators and project managers in charge
of the installation and the maintenance
installation manuals provide all information necessary for the installation of the products

Typographic convention

In order to make Aldata manuals easier to follow, the following typographic convention has been
adopted:

Convention Use

Bold screen, programme, field

[Bold in square brackets] button

"In quotation marks" panel, tab

CAPITAL AND BOLD table

Courrier font code

Functions

This manual does not describe the use of:


lists of values to help field input
calendars to help date input
search panels
contextual menus etc
This manual explains how to create records. To consult, modify or delete records, the proce-
dure is generally identical in all screens which is why it is not described here either.
For information on these functions common to all the screens, please consult the manual Intro-
duction to G.O.L.D., Ref. GB-ALL-UTI-INTRO-001. It also contains important information on
how to navigate in G.O.L.D., carry out a search in the drop-down lists and table columns, per-
sonalise the colours of G.O.L.D. etc.
MANUAL UPDATES
This page presents the modifications that have been made to this manual since its creation.

Patch CEN509-RM00JAN11 (January 11):


Manual revision. No change. => Alignment of the manual (version GB-CEN-509-UTI-ADMEDI-
059-1) with the January patch.

Patch CEN508-RM00OCT08 (October 08):


Evolution(s) described in the version GB-CEN-508-UTI-ADMEDI-059-1 of this manual
Update of the section "Managing reports", page 9 in the chapter "General presentation",
page 7 with, in particular, the addition of diagrams, parameterisation and access rights to
reports by user profile
General update (fields, explanations etc.) of the procedures "Defining reports", page 16,
"Defining the parameters", page 19 and "Launching reports", page 24

Patch CEN507-RM00JUL07 (July 07):


Evolution(s) described in the version GB-CEN-507-UTI-ADMEDI-059-1 of this manual
Update of the chapter "Managing report launching and follow-up", page 23 and addition of
the various report display possibilities, depending on the functional profile of the con-
nected user, in the procedure "Displaying the report follow-up", page 25

Patch CEN506-RM00NOV06 (November 06):


Manual revision. No change. => Alignment of the manual (version GB-CEN-506-UTI-ADMEDI-
059-1) with the November patch

Patch CEN505-RM00MAY06 (May 06):


Evolution(s) described in the version GB-CS-505-UTI-ADMEDI-059-1 of this manual
General reorganisation of manual
Update of the procedure "Defining reports", page 16 including the addition of fields related
to the parameterisation of the number of lines per page and the number of characters per
line, for reports generated in the ASCII format

Patch CEN504-RM00NOV05 (November 05):


Evolution(s) described in the version GB-CS-UTI-ADMEDI-059-3 of this manual
Addition of the Programme type and Report format fields in the descriptive table of the
procedure "Defining reports", page 16
Display restriction in the "List of value query" tab according to the report parameter in the
procedure "Linking queries to parameters", page 20

Patch CEN503-EV01AUG05 (August 05):


Evolution(s) described in the version GB-CS-UTI-ADMEDI-059-2 of this manual
Addition of the Input help field in the procedure "Defining the parameters", page 19
Addition of the procedure "Defining the element order", page 22 (Parameter order screen)
Addition of the procedure "Displaying the report follow-up", page 25
Patch G501-CEN0001-EVO (January 05):
Manual creation (version GB-CS-UTI-ADMEDI-059-1)
TABLE OF CONTENTS

CHAPTER 1
GENERAL Introduction .............................................................................................8
PRESENTATION Aim of this module .................................................................................8
Access path .........................................................................................8
Managing reports .......................................................................................9
Report management steps ........................................................................9
Some useful parameters ........................................................................ 10
General process .................................................................................. 11
Access rights to the reports .................................................................... 11

CHAPTER 2
MANAGING THE Creating or modifying a directory ................................................................. 13
REPORT STRUCTURE Creating or modifying a sub-directory ........................................................... 15
AND DEFINITION
Defining reports ...................................................................................... 16

CHAPTER 3
DEFINING REPORT Defining the parameters ............................................................................ 19
PARAMETERS Linking queries to parameters ..................................................................... 20
Defining the element order ........................................................................ 22

CHAPTER 4
MANAGING REPORT Launching reports .................................................................................... 24
LAUNCHING AND Displaying the report follow-up ................................................................... 25
FOLLOW-UP
CHAPTER 1
GENERAL PRESENTATION

To be found in this section:


"Introduction", page 8
"Managing reports", page 9
REPORTS MANUAL CHAPTER 1 - GENERAL PRESENTATION
INTRODUCTION

INTRODUCTION

Aim of this module

The Reports module of G.O.L.D. Central Version 5 allows you to manage the different steps
related to the parameterisation, definition and launching of reports.

Access path

In the standard version of G.O.L.D. Central Version 5, the access path is as follows:
Menu > Reports

Aldata Solution Confidential document 8


REPORTS MANUAL CHAPTER 1 - GENERAL PRESENTATION
MANAGING REPORTS

MANAGING REPORTS

Report management steps

The following diagram describes the different steps to be followed to launch a report:

Aldata Solution Confidential document 9


REPORTS MANUAL CHAPTER 1 - GENERAL PRESENTATION
MANAGING REPORTS

Some useful parameters

Report format The various types of report formats used (PDF, HTML etc.) are stored in the entries of general
parameter table 1371.
However, the report format to be displayed by default is defined, by site or network, in the
numeric value 1 of entry 1 of the general parameter table 1372. This value refers to an entry in
the general parameter table 1371.

Synchronous or The reports in G.O.L.D. Central can be launched in synchronous or asynchronous mode.
asynchronous In synchronous mode, G.O.L.D. displays the report directly, in the format defined by the user,
mode when the related process was successful.
In asynchronous mode, the report request is placed in a processing queue and is carried out via
a JMS server. A G.O.L.D. screen (Report follow-up) allows you to check if the report was cor-
rectly generated, then to access a direct link to the file of this report.
The choice of mode can be parameterised, by site or network, in the numeric value 1 of entry
2 of the general parameter table 1372:
if this value is 0, the reports will be managed in synchronous mode
if this value is 1, the reports will be managed in asynchronous mode

Sending of the The sending of the report, in asynchronous mode, to a JMS processing queue can be parameter-
asynchonous ised in the numeric value 1 of entry 1 of the general parameter table 1428:
report to a JMS if this value is equal to 0, the report is not sent to the JMS processing queue
processing queue if this value is equal to 1, the report is sent to the JMS processing queue

Number of The number of reports which can be launched simultaneously by a profile, in synchronous or
simultaneous asynchronous mode, can be parameterised, by site or network, in the numeric value 2 of entry
reports 3 of the general parameter table 1372.

Aldata Solution Confidential document 10


REPORTS MANUAL CHAPTER 1 - GENERAL PRESENTATION
MANAGING REPORTS

General process

The following diagram illustrates the general process in which a report evolves, from the mod-
ule definition phase, to the launch in synchronous or asynchronous mode:

Access rights to the reports

To access the report launching, the user profile must give complete access to the screens of
G.O.L.D. Central.
The reports launched from the Reports module can be defined for the members of a user pro-
file.
For further information on the definition of access rights to reports by user profile, see the
"Administration" manual, Ref. GB-CEN-UTI-ADM-091.

Aldata Solution Confidential document 11


CHAPTER 2
MANAGING THE REPORT STRUCTURE AND
DEFINITION

To be found in this section:


"Creating or modifying a directory", page 13
"Creating or modifying a sub-directory", page 15
"Defining reports", page 16
REPORTS MANUAL CHAPTER 2 - MANAGING THE REPORT STRUCTURE AND DEFINITION
CREATING OR MODIFYING A DIRECTORY

CREATING OR MODIFYING A DIRECTORY

Presentation This step allows you to create a tree structure to organise the reports. This tree structure rep-
resents the access path which allows you to reach the reports to be launched.

Procedure 1. Go to the Report structure input screen


(access path in the standard version of G.O.L.D. Central Version 5:
Reports > Report structure input).
Note: this screen displays the list of the report structure elements. It is possible to add, modify
or delete these elements. Each line corresponds to a different directory.
2. Click on the [+] button on the bottom right of the screen:
-> a new line is displayed.
3. Enter the following fields:

Field Explanation Type Help

Menu code Mand. Define the menu code, or the directory code. Alphanumeric

Description Mand. Define the report menu description, or the directory Alphanumeric
name.

Parent code Mand. Define the root directory code which you wish to cre- Alphanumeric
ate.

Example You can, for example, create the following directories (one directory per functionality):

Aldata Solution Confidential document 13


REPORTS MANUAL CHAPTER 2 - MANAGING THE REPORT STRUCTURE AND DEFINITION
CREATING OR MODIFYING A DIRECTORY

These directories correspond to this tree structure in the Report launch screen:

4. If you wish, you can:


delete a directory. To do so, select a directory and click on the [-] button.
modify a directory. To do so, select a directory and modify the desired fields. The Menu
code field cannot be modified.
5. Click on the [Validate] button on the toolbar to save the data.

Aldata Solution Confidential document 14


REPORTS MANUAL CHAPTER 2 - MANAGING THE REPORT STRUCTURE AND DEFINITION
CREATING OR MODIFYING A SUB-DIRECTORY

CREATING OR MODIFYING A SUB-DIRECTORY

To create or modify a sub-directory, see the procedure "Creating or modifying a directory",


page 13.

Example You can, for example, create the following sub-directories for the ORD directory (Orders):

Aldata Solution Confidential document 15


REPORTS MANUAL CHAPTER 2 - MANAGING THE REPORT STRUCTURE AND DEFINITION
DEFINING REPORTS

DEFINING REPORTS

Presentation This step allows you to define the reports which you wish to use.

Procedure 1. Go to the Report module input screen


(access path in the standard version of G.O.L.D. Central Version 5:
Reports > Module input).
2. Click on the [+] button on the toolbar:
-> The Module property screen is displayed.
3. Enter the following fields:

Field Explanation Type Help

Module Mand. Enter a name to identify the report. You can Alphanumeric
directly indicate the real report programme name
to be used.

Description Mand. Define a title for the report screen. Alphanumeric

Actual Opt. Define the name of a report programme to be Alphanumeric


module for launched if it differs from the one indicated in the
substitution Module field.

Order line Opt. Define an order line, if necessary. Alphanumeric

Menu code Mand. Define the code of the directory or sub-directory Alphanumeric List of values
in which you wish to classify this report screen.

Programme Mand. Select the type of programme to launched: a Alphanumeric List of values
type report programme or executable file.
The programme types are defined in the entries
of the general parameter table 1442. The entries
in this system table cannot be modified.

Report format Opt. Define the desired format. If it has not been ente- Alphanumeric List of values
red, G.O.L.D. will then retrieve the report format
to be displayed, defined in entry 1 in general
parameter table 1372.
If you select "User choice", this means that when
launching the report, you will be requested to
choose, in a window, the format in which you wish
to generate the report.

Aldata Solution Confidential document 16


REPORTS MANUAL CHAPTER 2 - MANAGING THE REPORT STRUCTURE AND DEFINITION
DEFINING REPORTS

Field Explanation Type Help

No. lines/ Opt. When the selected report format corresponds to Numeric
ASCII page the ASCII mode, indicate the number of lines
which can appear on a report page.
If this value is not entered, then G.O.L.D. will
take into account the number of lines per page,
defined in numeric value 1 of entry 4 of the gene-
ral parameter table 1372.

No charac./ Opt. When the selected report format corresponds to Numeric


ASCII line the ASCII mode, indicate the number of charac-
ters which can appear on a report line.
If this value is not entered, then G.O.L.D. will
take into account the number of characters per
line, defined in numeric value 2 of entry 4 of the
general parameter table 1372.

4. Click on the [Validate] button on the toolbar to save the data.

Aldata Solution Confidential document 17


CHAPTER 3
DEFINING REPORT PARAMETERS

To be found in this section:


"Defining the parameters", page 19
"Linking queries to parameters", page 20
"Defining the element order", page 22
REPORTS MANUAL CHAPTER 3 - DEFINING REPORT PARAMETERS
DEFINING THE PARAMETERS

DEFINING THE PARAMETERS

Presentation This step allows you to define, for each report, the parameters used by G.O.L.D. when launching
a report. The parameters to be defined depend on the report to be launched.
A parameter can be hidden (or masked) and will therefore not appear among the parameters to
be entered when launching the report. You can define:
parameters for which you will enter the value in the report screen
parameters for which G.O.L.D. will automatically retrieve the value via an "environment
variable"

Procedure 1. Go to the Parameter input screen


(access path in the standard version of G.O.L.D. Central Version 5:
Reports > Report parameter input).
2. Use the list of values in the Module field to select the report screen for which you wish to
create a new parameter.
3. Click on the [+] button on the toolbar to create a new parameter:
-> the Parameter detail screen is displayed.
4. Enter the following fields:

Field Explanation Type Help

Code Mand. Define a code to identify the parameter. Alphanumeric List of values

Description Mand. Define the parameter description. Alphanumeric

Data type Mand. Define the data type of the parameter (example: Numeric List of values
number, varchar, date).

Length Mand. Define the parameter length. Numeric

Default Opt. Define the value which will be displayed by default Alphanumeric List of values
values in the field corresponding to this parameter in the
report screen.

Mandatory Opt. Check this box if the parameter is mandatory to Checkbox


parameter launch the report. This box is checked by default.

Hidden Opt. Check this box if the parameter is hidden from the Checkbox
parameter user when launching the report.
The box of the Hide field is thus checked for the
line corresponding to this parameter in the Para-
meter input screen.

Input help Opt. If you wish, indicate extra information on this Alphanumeric
parameter: format, input mode, explanation etc.

5. Click on the [Validate] button on the toolbar to save the data.

Aldata Solution Confidential document 19


REPORTS MANUAL CHAPTER 3 - DEFINING REPORT PARAMETERS
LINKING QUERIES TO PARAMETERS

LINKING QUERIES TO PARAMETERS

Presentation This step allows you to associate SQL queries with the report parameters.
The queries simplify the input of values in the Value field of the corresponding report screen.
The aim of the query can be to:
retrieve the description corresponding to a value
suggest a list of values

Procedure 1. In the Parameter input screen, select the report parameter to which you wish to link a
query.
2. Click on the [Query] button:
-> the Query linked to parameter screen is displayed.
The screen is composed of two tabs:

Use the tab... to...

"Descriptive query" retrieve the description depending on the value you enter
in the Value field of the report screen.

"List of value query" display all the possible values for this parameter in a list of
values.
CAUTION:
This tab is only displayed when the report parameter is
not a hidden parameter.

Note: you can define a descriptive query and a list-of-values query for each parameter. A que-
ry must necessarily be performed on two columns, since the description corresponding to a
value is always retrieved.

Applicative You can use environment variables in order to define the queries.
environment The environment variables are variables which retrieve a value determined by the environment
variables (connection class, connection language, etc.).
Important: the environment variables are always preceded by the sign ":"

Environment variable Explanation

:SYSDATE System date

:LANG Connection language

:NMAG Connection class

:NPV Connection site

Aldata Solution Confidential document 20


REPORTS MANUAL CHAPTER 3 - DEFINING REPORT PARAMETERS
LINKING QUERIES TO PARAMETERS

Environment variable Explanation

:VAL Entered value


This value can be used for descriptive queries where the
values you can enter depend on a first variable (exam-
ple: the supplier department depends on the supplier)

parameter_name A parameter which has already been defined can be


used as a variable.
Example:
:p_CNUF

Descriptive 1. Click on the "Descriptive query" tab on the Query linked to parameter screen.
queries 2. Define or modify the SQL operator, the SQL prefix and the SQL query in the corresponding
fields.
3. Click on the [Validate] button on the toolbar to save the data.

List-of-value 1. Click on the "List of value query" tab on the Query linked to parameter screen.
queries 2. Define or modify the SQL operator, the SQL prefix and the SQL query in the corresponding
fields.
3. Click on the [Validate] button on the toolbar to save the data.

Aldata Solution Confidential document 21


REPORTS MANUAL CHAPTER 3 - DEFINING REPORT PARAMETERS
DEFINING THE ELEMENT ORDER

DEFINING THE ELEMENT ORDER

Once all the defined parameters are displayed in the Parameter order screen (accessible via
the [Element order] button in the Parameter input screen), they can be sorted with the [+]
and [-] buttons to swap two adjacent lines, for example, or by double-clicking on the column
headers to obtain an alphabetical sorting.

Aldata Solution Confidential document 22


CHAPTER 4
MANAGING REPORT LAUNCHING AND
FOLLOW-UP

To be found in this section:


"Launching reports", page 24
"Displaying the report follow-up", page 25
REPORTS MANUAL CHAPTER 4 - MANAGING REPORT LAUNCHING AND FOLLOW-UP
LAUNCHING REPORTS

LAUNCHING REPORTS

Presentation In order to launch a report, you must follow the access path in the previously-defined tree struc-
ture.

Procedure 1. Go to the Report launch screen


(access path in the standard version of G.O.L.D. Central Version 5:
Reports > Report launch).
2. To display the tree-structure, click on the root directory ROOT, then double-click on the
desired directory:
-> on the right part of the screen, G.O.L.D. displays the reports classified in the selected
directory or sub-directory:

3. Select a report screen in the right part of the screen (for example, PSSTO02P in the screen-
shot above).
4. Click on the [Validate] button on the toolbar:
-> G.O.L.D. displays the corresponding report screen (in our example: Sales stat. report).
5. In the "Mandatory data" and/or "Optional data" tabs (based on whether the report launch
parameter, is mandatory or not, indicated in the Parameter detail screen), enter the val-
ues requested, or modify the values defined in the Value column.
For further information on defining whether the report launch parameter is mandatory is
not, see "Defining the parameters", page 19.
6. Click on the [Validate] button on the toolbar to launch the report:
-> G.O.L.D. launches the corresponding report programme which takes into account the
values you have just entered.
-> G.O.L.D. displays the report.
7. Use the browser functions in order to print or save the report.

Aldata Solution Confidential document 24


REPORTS MANUAL CHAPTER 4 - MANAGING REPORT LAUNCHING AND FOLLOW-UP
DISPLAYING THE REPORT FOLLOW-UP

DISPLAYING THE REPORT FOLLOW-UP

Presentation The Report follow-up screen allows you to trace the report execution and execution status.
The user with a super user functional profile can display all the reports.
The user with a non super user functional profile can only search for and display the reports
which he previously executed.
In addition, if the functional profile includes restrictions on one or more sites, then the user
cannot display the reports launched on other sites.
For further information on functional profile management, see the "Administration" manual,
Ref. GB-CEN-UTI-ADM-091.

Procedure 1. Go to the Report follow-up screen


(access path in the standard version of G.O.L.D. Central Version 5:
Reports > Report follow-up).
2. Enter the necessary fields, then launch the search.
Note: When the connected user is associated with a non super user functional profile, then the
User field in the header panel is not accessible. This field is entered by default with the login
of the connected user.
3. The screen displays the reports and their related data.
4. The [To be returned] button allows you to return to the JMS server the reports whose pre-
vious sending failed.

Aldata Solution Confidential document 25


INDEX

D Q
Descriptive queries Queries
defining 21 defining descriptive queries 21
defining environment variables 20
defining list-of-value queries 21
E linking to parameters 20
Element order
defining 22
R
Environment variables
defining 20 Report directory
creating or modifying 13
Report sub-directory
F creating or modifying 15
Follow-up Reports
displaying 25 access path 8
access rights 11
creating or modifying a directory 13
L creating or modifying a sub-directory 15
List-of-value queries defining 16
defining 21 defining the element order 22
defining the parameters 19
displaying the follow-up 25
P general process 11
Parameters launching 24
defining 19 linking queries 20
linking queries 20 management steps 9
parameterisation 10
Aldata Solution S.A. G.O.L.D. is a trademark of Aldata Solution S.A.
Aldata Solution S.A. acknowledges the rights of all trademarks cited herein.

Aldata Solution www.aldata-solution.com


37, rue du Colonel Pierre Avia info@aldata-solution.com
75508 Paris Cedex 15
FRANCE
Tel.: +33 (0)1 46 48 28 00
Fax: +33 (0)1 46 48 28 01

También podría gustarte