report layout
Use this command configure report layouts.
Layouts help you define the content of your reports. You can create sub-styles for page headers, page footers and the body section of the report. You can also schedule a reporting cycle and set a specific time and day for generating reports. You can select a layout from a pre-defined list or you can create your own report layout. Once you have all layout parameters set, you can save it and use it in any report. You can use the following options to customize layouts or create new layouts.
config report layout edit {name} # Report layout configuration. set name {string} Report layout name. size[35] set title {string} Report title. size[127] set subtitle {string} Report subtitle. size[127] set description {string} Description. size[127] set style-theme {string} Report style theme. size[35] set options {option} 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. set format {pdf} Report format. pdf PDF. set schedule-type {demand | daily | weekly} Report schedule type. demand Run on demand. daily Schedule daily. weekly Schedule weekly. set day {option} Schedule days of week to generate report. sunday Sunday. monday Monday. tuesday Tuesday. wednesday Wednesday. thursday Thursday. friday Friday. saturday Saturday. set time {string} Schedule time to generate report [hh:mm]. set cutoff-option {run-time | custom} Cutoff-option is either run-time or custom. run-time Run time. custom Custom. set cutoff-time {string} Custom cutoff time to generate report [hh:mm]. set email-send {enable | disable} Enable/disable sending emails after reports are generated. set email-recipients {string} Email recipients for generated reports. size[511] set max-pdf-report {integer} Maximum number of PDF reports to keep at one time (oldest report is overwritten). range[1-365] config page set paper {a4 | letter} Report page paper. a4 A4 paper. letter Letter paper. set column-break-before {heading1 | heading2 | heading3} 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. set page-break-before {heading1 | heading2 | heading3} 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. set options {header-on-first-page | footer-on-first-page} Report page options. header-on-first-page Show header on first page. footer-on-first-page Show footer on first page. config header set style {string} Report header style. size[71] config header-item edit {id} # Configure report header item. set id {integer} Report item ID. range[0-4294967295] set description {string} Description. size[63] set type {text | image} Report item type. text Text. image Image. set style {string} Report item style. size[71] set content {string} Report item text content. size[511] set img-src {string} Report item image file name. size[127] next config footer set style {string} Report footer style. size[71] config footer-item edit {id} # Configure report footer item. set id {integer} Report item ID. range[0-4294967295] set description {string} Description. size[63] set type {text | image} Report item type. text Text. image Image. set style {string} Report item style. size[71] set content {string} Report item text content. size[511] set img-src {string} Report item image file name. size[127] next config body-item edit {id} # Configure report body item. set id {integer} Report item ID. range[0-4294967295] set description {string} Description. size[63] set type {text | image | chart | misc} Report item type. text Text. image Image. chart Chart. misc Miscellaneous. set style {string} Report item style. size[71] set top-n {integer} Value of top. range[0-4294967295] set hide {enable | disable} Enable/disable hide item in report. config parameters edit {id} # Parameters. set id {integer} ID. range[0-4294967295] set name {string} Field name that match field of parameters defined in dataset. size[127] set value {string} Value to replace corresponding field of parameters defined in dataset. size[1023] next set text-component {text | heading1 | heading2 | heading3} Report item text component. text Normal text. heading1 Heading 1. heading2 Heading 2. heading3 Heading 3. set content {string} Report item text content. size[511] set img-src {string} Report item image file name. size[127] set list-component {bullet | numbered} Report item list component. bullet Bullet list. numbered Numbered list. config list edit {id} # Configure report list item. set id {integer} List entry ID. range[0-4294967295] set content {string} List entry content. size[127] next set chart {string} Report item chart name. size[71] set chart-options {include-no-data | hide-title | show-caption} Report chart options. include-no-data Include chart with no data. hide-title Hide chart title. show-caption Show chart caption. set drill-down-items {string} Control how drill down charts are shown. size[11] set drill-down-types {string} Control whether keys from the parent being combined or not. size[7] set table-column-widths {string} Report item table column widths. size[179] set table-caption-style {string} Table chart caption style. size[71] set table-head-style {string} Table chart head style. size[71] set table-odd-row-style {string} Table chart odd row style. size[71] set table-even-row-style {string} Table chart even row style. size[71] set misc-component {hline | page-break | column-break | section-start} Report item miscellaneous component. hline Horizontal line. page-break Page break. column-break Column break. section-start Section start. set column {integer} Report section column number. range[0-4294967295] set title {string} Report section title. size[511] next next end