report : layout
 
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.
Syntax
config report layout
edit <layout name>
set title <text>
set cache-time-out <seconds_int>
set cutoff-option {run‑time | custom}
set cutoff-time <time_str>
set description <text>
set email-recipients <recipients_str>
set email-send {enable | disable}
set format {html | pdf}
set schedule-type {demand | daily | weekly}
set time <HH:MM>
set day {sunday | monday | tuesday | wednesday | thursday | friday | saturday}
set style-theme <theme name>
set options {include‑table‑of‑contents | auto‑numbering‑heading | view‑chart‑as‑heading | show‑html‑navbar‑before-heading}
config page
set paper{A4|letter}
set column-break-before {heading1 | heading2 | heading3}
set options {header‑on‑first‑page | footer-on-first-page}
set style <style name>
config header
set style <style name>
config header-item
set edit <item_id>
set style <style name>
set type {text | image}
set content <text>
set description <text>
set img-src <text>
config footer
set style <style name>
config footer-item
set edit <item_id>
set style <style name>
set type {text | image}
set content <text>
set description <text>
set img-src <text>
end
config body-item
set edit <item_id>
set type {text | image | chart | misc}
set description <text>
set style <style name>
set text-component {heading1 | heading2 | heading3 | normal text}
set content <text>
set img-src <text>
set chart <chart name>
set chart-options {hide‑title | include‑no‑data | show‑caption}
set misc-component {hline | page‑break | column‑break | section-start}
set parameter1 <value_str>
end
end
end
 
Variable
Description
Default
edit <layout name>
Enter the name of an existing layout or a new name. Press ? to view the list of existing layouts.
 
title <text>
Enter a title for the current report layout.
 
cache-time-out <seconds_int>
Enter the timeout period in seconds for cached datasets. Range 0 to 86 400. Default is 604 800 seconds (1 week).
86400
cutoff-option {run‑time | custom}
Select the end of the report period:
run‑time — the report period ends when the report is run.
custom — the report period ends at cutoff-time.
run‑time
cutoff-time <time_str>
Enter the end of the report period in hh:mm format. This field is available when cutoff-option is custom.
00:00
description <text>
Enter a description for the current layout.
 
email-recipients <recipients_str>
Enter the email addresses of report recipients separated by semicolons. Available if email-send is enable.
Null
email-send {enable | disable}
Enable or disable sending of reports by email.
disable
format {html | pdf}
Select the layout format.
html
schedule-type {demand | daily | weekly}
Select the schedule type for the report layout.
daily
time <HH:MM>
Enter the time for the report to be run.
HH: Hour value in two digit format 0-23
MM: Minute value 0-59.
schedule-type must be set in order for time option to be available.
00:00
day {sunday | monday | tuesday | wednesday | thursday | friday | saturday}
Select the day of the week for report to be run. day option is only available when schedule-type is set to weekly.
sunday
style-theme <theme name>
Enter the name of an existing style theme or a new style theme name. More detail on style themes can be found in theme section of this chapter.
 
options {include‑table‑of‑contents | auto‑numbering‑heading | view‑chart‑as‑heading | show‑html‑navbar‑before-heading}
Use following options to configure the report page design;
include-table-of-contents — select this option to include table of contents in the report.
auto-numbering-heading — select this option to include page numbers in the heading.
view-chart-as-heading — select this option to add heading for each chat automatically.
show-html-navbar-before-heading — select this option to show html navigation bar before each heading.
 
config page
paper{A4|letter}
Select the standard paper size.
A4
column-break-before {heading1 | heading2 | heading3}
Select the heading type which will include a column break in front of it.
 
options {header‑on‑first‑page | footer-on-first-page}
Select one of these options to have the header or the footer on the first page of the report.
 
config header
style <style name>
Enter the name of an existing style or a new name. Press ? to view the list of existing styles.
 
config header-item
edit <item_id>
Enter the id of an existing report item or a new id. Press ? to view the list of existing report item ids.
 
style <style name>
Enter the name of an existing style or a new name. Press ? to view the list of existing styles.
 
type {text | image}
Select the report header item type.
text
content <text>
Enter the content material for the header item. This option only available when type is set to text.
 
description <text>
Enter the description of the image file. This option is only available when type is set to image.
 
img-src <text>
Enter the name of the header item image file. For example image.jpg. This option is only available when type is set to image.
 
config footer
style <style name>
Enter the name of an existing style or a new name. Press ? to view the list of existing styles.
 
config footer-item
edit <item_id>
Enter the id of an existing report item or a new id. Press ? to view the list of existing report item ids.
 
style <style name>
Enter the name of an existing style or a new name. Press ? to view the list of existing styles.
 
type {text | image}
Select the report footer item type.
text
content <text>
Enter the content material for the footer item. This option only available when type is set to text.
 
description <text>
Enter the description of the image file. This option is only available when type is set to image.
 
img-src <text>
Enter the name of the footer item image file. For example image.jpg. This option is only available when type is set to image.
 
config body-item
edit <item_id>
Enter the id of an existing report body item or a new id. Press ? to view the list of existing report body item ids.
 
type {text | image | chart | misc}
Select the body item type.
text
description <text>
Enter the content material for the body item. This option only available when type is set to text or misc.
 
style <style name>
Enter the name of an existing style or a new name. Press ? to view the list of existing styles.
 
text-component {heading1 | heading2 | heading3 | normal text}
Select the text component type.
text
content <text>
Enter the content material for the text component. Headings are limited to only one line.
 
img-src <text>
Enter the name of the body item image file. For example image.jpg. This option is only available when type is set to image.
 
chart <chart name>
Enter the report item chart name. This option is only available when type is set to chart.
 
chart-options {hide‑title | include‑no‑data | show‑caption}
Select one of the following options to customize the chart.
hide-title: Hide chart title.
include-no-data: Include the chart with no data.
show-caption: Show chart caption.
 
misc-component {hline | page‑break | column‑break | section-start}
Select one of the following options to add a separator component to your report.
hline — add a horizontal line
page-break — add a page break
column-break — add a column break
section-start — add a section
 
parameter1 <value_str>
Enter the parameter value for this body item.