Lexmark X925 Lexmark Document Distributor - Page 84

Creating custom reports, Using special LDD parameters, Querying the database

Page 84 highlights

Monitoring and maintaining the system 84 Creating custom reports LDD uses JasperReports for custom reports. You can create custom reports using the open source application iReport 3.5.2, available from http://jasperforge.org/ireport. For more information about overall report design, see the documentation for iReport. Note: Only summary reports are supported. Even if a custom report has a detail section defined, the section will not be displayed. If a custom report does not have a summary section, any reports generated from the custom report will be blank. Using special LDD parameters You can add the following parameters to the report design in order to use the specified information in other parts of the report: • start_date-This retrieves the start date for report data, as specified in a script or by the administrator when the report is run. • end_date-This retrieves the end date for report data, as specified in a script or by the administrator when the report is run. • SUBREPORT_DIR-This retrieves the reports folder, located at \Lexmark\Solutions\apps\wf-ldss\WEB-INF \reports\ where LDD is installed on each server, from the LDD installation in order to locate subreport files. Note: Additional parameters can only be added when a report is developed and uploaded with a solution using the SDK. For more information, see the Lexmark Document Distributor SDK Guide. Querying the database Information for built‑in reports and many custom reports are retrieved from the MONITOR database, which contains information about tasks. Custom reports may also retrieve information from the SOLUTIONINFO database, where some solutions store custom data. The credentials for all databases are as follows: • User name-framework • Password-rivet Information that appear in the log are available from the TASK_LOG table in the MONITOR database. The following fields are available: • ID-This is a unique ID number assigned to each entry in the log. • LOG_TIME-This is the time when an entry was added to the log. • STATUS-This is the status reported by the solution that added the log entry. • PERCENT_COMPLETE-This is the progress reported by the solution that added the log entry. • TASK_MESSAGE-This is the log message reported by the solution. • TASK_ID-This is the unique ID number assigned to a task. Each entry recorded from the same task has the same TASK_ID. Information from the Jobs list are available from the TASK_INFO table in the MONITOR database. The following fields are available: • TASK_ID-This is the unique ID number assigned to the task. • HOST_NAME-This is the host name of the server where the job was run. • TASK_NAME-This is the name of the task.

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146

Creating custom reports
LDD uses JasperReports for custom reports. You can create custom reports using the open source application iReport
3.5.2, available from
http://jasperforge.org/ireport
. For more information about overall report design, see the
documentation for iReport.
Note:
Only summary reports are supported. Even if a custom report has a detail section defined, the section will not
be displayed. If a custom report does not have a summary section, any reports generated from the custom report
will be blank.
Using special LDD parameters
You can add the following parameters to the report design in order to use the specified information in other parts of
the report:
start_date
—This retrieves the start date for report data, as specified in a script or by the administrator when
the report is run.
end_date
—This retrieves the end date for report data, as specified in a script or by the administrator when the
report is run.
SUBREPORT_DIR
—This retrieves the reports folder, located at \Lexmark\Solutions\apps\wf-ldss\WEB-INF
\reports\ where LDD is installed on each server, from the LDD installation in order to locate subreport files.
Note:
Additional parameters can only be added when a report is developed and uploaded with a solution using the
SDK. For more information, see the
Lexmark Document Distributor SDK Guide
.
Querying the database
Information for built
in reports and many custom reports are retrieved from the MONITOR database, which contains
information about tasks. Custom reports may also retrieve information from the SOLUTIONINFO database, where some
solutions store custom data.
The credentials for all databases are as follows:
User name
framework
Password
rivet
Information that appear in the log are available from the TASK_LOG table in the MONITOR database. The following
fields are available:
ID
—This is a unique ID number assigned to each entry in the log.
LOG_TIME
—This is the time when an entry was added to the log.
STATUS
—This is the status reported by the solution that added the log entry.
PERCENT_COMPLETE
—This is the progress reported by the solution that added the log entry.
TASK_MESSAGE
—This is the log message reported by the solution.
TASK_ID
—This is the unique ID number assigned to a task. Each entry recorded from the same task has the same
TASK_ID.
Information from the Jobs list are available from the TASK_INFO table in the MONITOR database. The following fields
are available:
TASK_ID
—This is the unique ID number assigned to the task.
HOST_NAME
—This is the host name of the server where the job was run.
TASK_NAME
—This is the name of the task.
Monitoring and maintaining the system
84