Using the report editor

The report editor is used to build the report including the document properties, content, layout and styles.


Page basics

The DOCUMENT PROPERTIES menu contains general page and display options.

../../../_images/reports_editor_detailpanel.jpg


Page size and document height

The Page format and Orientation options specify the output page settings for PDF documents. Typically a report would use DIN A4. Select Own dimensions to specify a custom width and height.

Increasing the Content height value will adjust the available vertical space in the report layout so that more elements can be added.

Content will automatically span over multiple pages as necessary. Alternatively insert a page break element to force content to flow to a new page.


Headers, footers and page number

Headers and footers are special content sections at the top and bottom of the page respectively. These sections are automatically included on every page by default. Use the Header and Footer toggle switches to enable or disable these sections. The Display option can be set to Always or Do not display on first page.

The most common use for headers and footers is to include a company logo, Page number and Page count tags.


Content elements

Click or drag-drop an element icon from the editor toolbar to insert it into the page designer.

../../../_images/reports_editor_toolbar_elements.jpg


Types of elements

Elements include text, horizontal line, image, bar code, table, frame, section and page break.

Text

Text elements are used to add text to your report. This includes headings, labels and paragraphs.

Horizontal line

Insert a horizontal line and adjust width and height as required.

Image

Add images to your report. Select Choose file from the detail panel to upload a local JPG or PNG file from your device.

Alternatively specify a URL or tag as the image Source. Charts and attachments from the workspaces tree can be added to the report via tags.

Bar code

Insert CODE 128 bar codes into your report. Use the Text field to enter the alphanumeric characters for the bar code or use tags for dynamic content.

Table

Tables make it easy to align related content. Insert a table and select the element from the main panel to access and edit the content of individual cells.

Note: you can add current parameter data values to individual cells using tags however historic data in a table is not yet supported.

Frame

Use frames to group other content elements or add backgrounds and borders to sections of your report. Drag elements into the frame to group them, then simply position the frame on the page as necessary.

Section

Sections are used to group similar content and can be used to include a special header and footer that will appear on every page the content spans over.

Note: the use of sections is currently very limited.

Page break

Insert a page break to force content appearing below the break to flow to a new page.


Create and delete

Click or drag-drop an element icon from the editor toolbar to insert it into the page designer.

An element can be removed by clicking the x delete button next to the element in the main panel or selecting the element and pressing the DELETE key.

Copy and Paste elements using CTRL+C and CTRL+V shortcut keys to quickly duplicate selected elements.


Select, resize and align

Select the element by either clicking directly on the element’s bounding box in the page designer, click and drag a selection box around elements, or clicking the element in the main panel. Additional elements can be added to the selection by holding the SHIFT key.

Drag the element(s) around the page designer to reposition or use the Arrow keys for small adjustments. Click and drag the bounding box handles to resize an element.

Note: elements will automatically snap to the designer grid during reposition and resize operations but you can temporarily disable this behaviour by toggling the grid off.

../../../_images/reports_editor_toolbar_align.jpg

When multiple elements are selected, the alignment toolbar is available to quickly align elements together on the page.


Element properties

When an element is selected its properties, display, style and conditional style options are displayed in the detail panel.

The general properties section includes the element content, position and size.

DISPLAY section options customise the behaviour of the element in the PDF including preventing the content from being split over multiple pages, adding hyperlinks, etc.

STYLE allows a predefined style to be applied or customise the appearance of elements individually.

CONDITIONAL STYLE allows a different style (predefined or individually applied) to be set when a user-defined Condition is met. An example of a conditional statement is 11 > 10, or using tags {{Parameter.currentValue}} > 10.


Styles

The + add style button in the main panel adds new predefined styles to the report.

Headings, paragraphs and other content elements generally share similar styles. You can set the styles on every element individually but this can be tedious.

Its more efficient to predefine a set of styles and then simply select the Style name on each element you want to apply it to.

../../../_images/reports_editor_styles.jpg


Tags

Tags are the mechanism in which dynamic attributes related to nodes in the workspaces tree can be inserted into the report. This can include tags such as parameter value text, location coordinates, chart images, and many more.

Tags are available for all nodes that has been linked to the report.


Drag & drop from workspaces tree

The easiest way to link a node and insert a default tag is to drag and drop the node from the workspaces tree on to the page designer.

../../../_images/reports_editor_tags_dragdrop.jpg

Note

Only nodes within the same workspace (or template) as the report can be linked.


Show available attributes

Click on the > expand arrow next to a tag in the main panel to show its available attributes.

../../../_images/reports_editor_tags_attributes.jpg


Insert tags in an element

Use the content field of an element (eg. Text or Source) to either manually enter a tag or click the ... tag list button to select from a list of available tags. Tags are always surrounded by double curly braces {{ and }}. eg. {{Parameter.currentValue}}

When the report is generated the tags are replaced with the corresponding data. Multiple tags can be inserted in a single element and are rendered inline. eg. The value is {{Parameter.currentValue}} on {{Parameter.currentTime | time: "Do MMMM"}} may be rendered in the PDF as The value is 7.12 on 10th July

../../../_images/reports_editor_tags_insert.jpg


Expressions

Use expressions directly inside report elements to control the output of the content and its formatting.

Common scenarios

  • Apply the time filter to format a timestamp: {{report_time | time}} or {{report_time | time: "DD MMMM YYYY"}}
  • Round a number to 2 decimal places: {{Parameter.currentValue | round: 2}}
  • Set a default to insert when no value exists: {{Parameter.currentValue | default: 0}}
  • Truncate long text to a maximum number of characters: {{Parameter.currentStateName | truncate: 15}}
  • Use expression if / else tags to display alternate content based on a value
{% if Parameter.currentValue > 10 %}
  Value is above expected range
{% else %}
  Value is within expected range
{% endif %}
PDF HTML Epub Powered by Read The Docs