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| Parameter Name | Description | Type | Size |
|---|---|---|---|
| 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. include-table-of-content: Include table of content in the report. auto-numbering-heading: Prepend heading with auto numbering. view-chart-as-heading: Auto add heading for each chart. show-html-navbar-before-heading: Show HTML navigation bar before each heading. dummy-option: Use this option if you need none of the above options. |
option | - |
| format | Report format. pdf: PDF. |
option | - |
| schedule-type | Report schedule type. demand: Run on demand. daily: Schedule daily. weekly: Schedule weekly. |
option | - |
| day | Schedule days of week to generate report. sunday: Sunday. monday: Monday. tuesday: Tuesday. wednesday: Wednesday. thursday: Thursday. friday: Friday. saturday: Saturday. |
option | - |
| time | Schedule time to generate report [hh:mm]. | user | Not Specified |
| cutoff-option | Cutoff-option is either run-time or custom. run-time: Run time. custom: Custom. |
option | - |
| cutoff-time | Custom cutoff time to generate report [hh:mm]. | user | Not Specified |
| email-send | Enable/disable sending emails after reports are generated. enable: Enable sending emails after generating reports. disable: Disable sending emails after generating reports. |
option | - |
| 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 |
| Parameter Name | Description | Type | Size |
|---|---|---|---|
| paper | Report page paper. a4: A4 paper. letter: Letter paper. |
option | - |
| column-break-before | Report page auto column break before heading. heading1: Column break before heading 1. heading2: Column break before heading 2. heading3: Column break before heading 3. |
option | - |
| page-break-before | Report page auto page break before heading. heading1: Page break before heading 1. heading2: Page break before heading 2. heading3: Page break before heading 3. |
option | - |
| options | Report page options. header-on-first-page: Show header on first page. footer-on-first-page: Show footer on first page. |
option | - |
| Parameter Name | Description | Type | Size |
|---|---|---|---|
| style | Report header style. | string | Maximum length: 71 |
| Parameter Name | Description | Type | Size |
|---|---|---|---|
| description | Description. | string | Maximum length: 63 |
| type | Report item type. text: Text. image: Image. |
option | - |
| 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 |
| Parameter Name | Description | Type | Size |
|---|---|---|---|
| style | Report footer style. | string | Maximum length: 71 |
| Parameter Name | Description | Type | Size |
|---|---|---|---|
| description | Description. | string | Maximum length: 63 |
| type | Report item type. text: Text. image: Image. |
option | - |
| 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 |
| Parameter Name | Description | Type | Size |
|---|---|---|---|
| description | Description. | string | Maximum length: 63 |
| type | Report item type. text: Text. image: Image. chart: Chart. misc: Miscellaneous. |
option | - |
| style | Report item style. | string | Maximum length: 71 |
| top-n | Value of top. | integer | Minimum value: 0 Maximum value: 4294967295 |
| hide | Enable/disable hide item in report. enable: Enable hide item in report. disable: Disable hide item in report. |
option | - |
| text-component | Report item text component. text: Normal text. heading1: Heading 1. heading2: Heading 2. heading3: Heading 3. |
option | - |
| 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. bullet: Bullet list. numbered: Numbered list. |
option | - |
| chart | Report item chart name. | string | Maximum length: 71 |
| chart-options | Report chart options. include-no-data: Include chart with no data. hide-title: Hide chart title. show-caption: Show chart caption. |
option | - |
| 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. hline: Horizontal line. page-break: Page break. column-break: Column break. section-start: Section start. |
option | - |
| column | Report section column number. | integer | Minimum value: 0 Maximum value: 4294967295 |
| title | Report section title. | string | Maximum length: 511 |
| Parameter Name | Description | Type | Size |
|---|---|---|---|
| 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 |
| Parameter Name | Description | Type | Size |
|---|---|---|---|
| content | List entry content. | string | Maximum length: 127 |
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| Parameter Name | Description | Type | Size |
|---|---|---|---|
| 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. include-table-of-content: Include table of content in the report. auto-numbering-heading: Prepend heading with auto numbering. view-chart-as-heading: Auto add heading for each chart. show-html-navbar-before-heading: Show HTML navigation bar before each heading. dummy-option: Use this option if you need none of the above options. |
option | - |
| format | Report format. pdf: PDF. |
option | - |
| schedule-type | Report schedule type. demand: Run on demand. daily: Schedule daily. weekly: Schedule weekly. |
option | - |
| day | Schedule days of week to generate report. sunday: Sunday. monday: Monday. tuesday: Tuesday. wednesday: Wednesday. thursday: Thursday. friday: Friday. saturday: Saturday. |
option | - |
| time | Schedule time to generate report [hh:mm]. | user | Not Specified |
| cutoff-option | Cutoff-option is either run-time or custom. run-time: Run time. custom: Custom. |
option | - |
| cutoff-time | Custom cutoff time to generate report [hh:mm]. | user | Not Specified |
| email-send | Enable/disable sending emails after reports are generated. enable: Enable sending emails after generating reports. disable: Disable sending emails after generating reports. |
option | - |
| 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 |
| Parameter Name | Description | Type | Size |
|---|---|---|---|
| paper | Report page paper. a4: A4 paper. letter: Letter paper. |
option | - |
| column-break-before | Report page auto column break before heading. heading1: Column break before heading 1. heading2: Column break before heading 2. heading3: Column break before heading 3. |
option | - |
| page-break-before | Report page auto page break before heading. heading1: Page break before heading 1. heading2: Page break before heading 2. heading3: Page break before heading 3. |
option | - |
| options | Report page options. header-on-first-page: Show header on first page. footer-on-first-page: Show footer on first page. |
option | - |
| Parameter Name | Description | Type | Size |
|---|---|---|---|
| style | Report header style. | string | Maximum length: 71 |
| Parameter Name | Description | Type | Size |
|---|---|---|---|
| description | Description. | string | Maximum length: 63 |
| type | Report item type. text: Text. image: Image. |
option | - |
| 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 |
| Parameter Name | Description | Type | Size |
|---|---|---|---|
| style | Report footer style. | string | Maximum length: 71 |
| Parameter Name | Description | Type | Size |
|---|---|---|---|
| description | Description. | string | Maximum length: 63 |
| type | Report item type. text: Text. image: Image. |
option | - |
| 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 |
| Parameter Name | Description | Type | Size |
|---|---|---|---|
| description | Description. | string | Maximum length: 63 |
| type | Report item type. text: Text. image: Image. chart: Chart. misc: Miscellaneous. |
option | - |
| style | Report item style. | string | Maximum length: 71 |
| top-n | Value of top. | integer | Minimum value: 0 Maximum value: 4294967295 |
| hide | Enable/disable hide item in report. enable: Enable hide item in report. disable: Disable hide item in report. |
option | - |
| text-component | Report item text component. text: Normal text. heading1: Heading 1. heading2: Heading 2. heading3: Heading 3. |
option | - |
| 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. bullet: Bullet list. numbered: Numbered list. |
option | - |
| chart | Report item chart name. | string | Maximum length: 71 |
| chart-options | Report chart options. include-no-data: Include chart with no data. hide-title: Hide chart title. show-caption: Show chart caption. |
option | - |
| 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. hline: Horizontal line. page-break: Page break. column-break: Column break. section-start: Section start. |
option | - |
| column | Report section column number. | integer | Minimum value: 0 Maximum value: 4294967295 |
| title | Report section title. | string | Maximum length: 511 |
| Parameter Name | Description | Type | Size |
|---|---|---|---|
| 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 |
| Parameter Name | Description | Type | Size |
|---|---|---|---|
| content | List entry content. | string | Maximum length: 127 |