config report layout
Report layout configuration.
config report layout
Description: Report layout configuration.
edit <name>
set title {string}
set subtitle {string}
set description {string}
set style-theme {string}
set options {option1}, {option2}, ...
set format {option1}, {option2}, ...
set schedule-type [demand|daily|...]
set day [sunday|monday|...]
set time {user}
set cutoff-option [run-time|custom]
set cutoff-time {user}
set email-send [enable|disable]
set email-recipients {string}
set max-pdf-report {integer}
config page
Description: Configure report page.
set paper [a4|letter]
set column-break-before {option1}, {option2}, ...
set page-break-before {option1}, {option2}, ...
set options {option1}, {option2}, ...
config header
Description: Configure report page header.
set style {string}
config header-item
Description: Configure report header item.
edit <id>
set description {string}
set type [text|image]
set style {string}
set content {string}
set img-src {string}
next
end
end
config footer
Description: Configure report page footer.
set style {string}
config footer-item
Description: Configure report footer item.
edit <id>
set description {string}
set type [text|image]
set style {string}
set content {string}
set img-src {string}
next
end
end
end
config body-item
Description: Configure report body item.
edit <id>
set description {string}
set type [text|image|...]
set style {string}
set top-n {integer}
set hide [enable|disable]
config parameters
Description: Parameters.
edit <id>
set name {string}
set value {string}
next
end
set text-component [text|heading1|...]
set content {string}
set img-src {string}
set list-component [bullet|numbered]
config list
Description: Configure report list item.
edit <id>
set content {string}
next
end
set chart {string}
set chart-options {option1}, {option2}, ...
set drill-down-items {string}
set drill-down-types {string}
set table-column-widths {string}
set table-caption-style {string}
set table-head-style {string}
set table-odd-row-style {string}
set table-even-row-style {string}
set misc-component [hline|page-break|...]
set column {integer}
set title {string}
next
end
next
end
config report layout
Parameter |
Description |
Type |
Size |
Default |
||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
title |
Report title. |
string |
Maximum length: 127 |
|
||||||||||||||||
subtitle |
Report subtitle. |
string |
Maximum length: 127 |
|
||||||||||||||||
description |
Description. |
string |
Maximum length: 127 |
|
||||||||||||||||
style-theme |
Report style theme. |
string |
Maximum length: 35 |
|
||||||||||||||||
options |
Report layout options. |
option |
- |
include-table-of-content auto-numbering-heading view-chart-as-heading |
||||||||||||||||
|
|
|||||||||||||||||||
format |
Report format. |
option |
- |
|
||||||||||||||||
|
|
|||||||||||||||||||
schedule-type |
Report schedule type. |
option |
- |
daily |
||||||||||||||||
|
|
|||||||||||||||||||
day |
Schedule days of week to generate report. |
option |
- |
sunday |
||||||||||||||||
|
|
|||||||||||||||||||
time |
Schedule time to generate report [hh:mm]. |
user |
Not Specified |
|
||||||||||||||||
cutoff-option |
Cutoff-option is either run-time or custom. |
option |
- |
run-time |
||||||||||||||||
|
|
|||||||||||||||||||
cutoff-time |
Custom cutoff time to generate report [hh:mm]. |
user |
Not Specified |
|
||||||||||||||||
email-send |
Enable/disable sending emails after reports are generated. |
option |
- |
disable |
||||||||||||||||
|
|
|||||||||||||||||||
email-recipients |
Email recipients for generated reports. |
string |
Maximum length: 511 |
|
||||||||||||||||
max-pdf-report |
Maximum number of PDF reports to keep at one time (oldest report is overwritten). |
integer |
Minimum value: 1 Maximum value: 365 |
31 |
config page
Parameter |
Description |
Type |
Size |
Default |
||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
paper |
Report page paper. |
option |
- |
a4 |
||||||||
|
|
|||||||||||
column-break-before |
Report page auto column break before heading. |
option |
- |
|
||||||||
|
|
|||||||||||
page-break-before |
Report page auto page break before heading. |
option |
- |
|
||||||||
|
|
|||||||||||
options |
Report page options. |
option |
- |
|
||||||||
|
|
config header
Parameter |
Description |
Type |
Size |
Default |
---|---|---|---|---|
style |
Report header style. |
string |
Maximum length: 71 |
|
config header-item
Parameter |
Description |
Type |
Size |
Default |
||||||
---|---|---|---|---|---|---|---|---|---|---|
description |
Description. |
string |
Maximum length: 63 |
|
||||||
type |
Report item type. |
option |
- |
text |
||||||
|
|
|||||||||
style |
Report item style. |
string |
Maximum length: 71 |
|
||||||
content |
Report item text content. |
string |
Maximum length: 511 |
|
||||||
img-src |
Report item image file name. |
string |
Maximum length: 127 |
|
config footer
Parameter |
Description |
Type |
Size |
Default |
---|---|---|---|---|
style |
Report footer style. |
string |
Maximum length: 71 |
|
config footer-item
Parameter |
Description |
Type |
Size |
Default |
||||||
---|---|---|---|---|---|---|---|---|---|---|
description |
Description. |
string |
Maximum length: 63 |
|
||||||
type |
Report item type. |
option |
- |
text |
||||||
|
|
|||||||||
style |
Report item style. |
string |
Maximum length: 71 |
|
||||||
content |
Report item text content. |
string |
Maximum length: 511 |
|
||||||
img-src |
Report item image file name. |
string |
Maximum length: 127 |
|
config body-item
Parameter |
Description |
Type |
Size |
Default |
||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
description |
Description. |
string |
Maximum length: 63 |
|
||||||||||
type |
Report item type. |
option |
- |
text |
||||||||||
|
|
|||||||||||||
style |
Report item style. |
string |
Maximum length: 71 |
|
||||||||||
top-n |
Number of entries in PDF report. |
integer |
Minimum value: 0 Maximum value: 1000 |
0 |
||||||||||
hide |
Enable/disable hide item in report. |
option |
- |
disable |
||||||||||
|
|
|||||||||||||
text-component |
Report item text component. |
option |
- |
text |
||||||||||
|
|
|||||||||||||
content |
Report item text content. |
string |
Maximum length: 511 |
|
||||||||||
img-src |
Report item image file name. |
string |
Maximum length: 127 |
|
||||||||||
list-component |
Report item list component. |
option |
- |
bullet |
||||||||||
|
|
|||||||||||||
chart |
Report item chart name. |
string |
Maximum length: 71 |
|
||||||||||
chart-options |
Report chart options. |
option |
- |
include-no-data hide-title show-caption |
||||||||||
|
|
|||||||||||||
drill-down-items |
Control how drill down charts are shown. |
string |
Maximum length: 11 |
|
||||||||||
drill-down-types |
Control whether keys from the parent being combined or not. |
string |
Maximum length: 7 |
|
||||||||||
table-column-widths |
Report item table column widths. |
string |
Maximum length: 179 |
|
||||||||||
table-caption-style |
Table chart caption style. |
string |
Maximum length: 71 |
|
||||||||||
table-head-style |
Table chart head style. |
string |
Maximum length: 71 |
|
||||||||||
table-odd-row-style |
Table chart odd row style. |
string |
Maximum length: 71 |
|
||||||||||
table-even-row-style |
Table chart even row style. |
string |
Maximum length: 71 |
|
||||||||||
misc-component |
Report item miscellaneous component. |
option |
- |
hline |
||||||||||
|
|
|||||||||||||
column |
Report section column number. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||||
title |
Report section title. |
string |
Maximum length: 511 |
|
config parameters
Parameter |
Description |
Type |
Size |
Default |
---|---|---|---|---|
name |
Field name that match field of parameters defined in dataset. |
string |
Maximum length: 127 |
|
value |
Value to replace corresponding field of parameters defined in dataset. |
string |
Maximum length: 1023 |
|
config list
Parameter |
Description |
Type |
Size |
Default |
---|---|---|---|---|
content |
List entry content. |
string |
Maximum length: 127 |
|