Report Generator

The Report Generator object is used to automatically generate reports in a chosen output format on a chosen schedule, when linked with a Report Item and Scheduler Item.

Quick Configuration

Before creating and configuring a Report Generator it is necessary to also have already created a Report Item and is usefule to have a Scheduler Item already created and configured.

Click on allowed parent object in the I/O Model then right-click and select Admin New Report Report Generator from the context menu.
In the Create Object wizard, give the object a name and click on the … ellipses next to Report Object.
In the object picker, find a Report Item that you wish to link to the generator, select it and click OK.
Back in the Create Object wizard, click on the … ellipses next to Scheduler Object.
In the object picker, find a Scheduler Item that you wish to link to the generator, select it and click OK.
Select the Output Options from the wizard side menu. Here the Output Format can be selected from the drop-down menu and the Output Folder can be configured. Select the format you want and enter a valid directory path for the Output Folder.
Click Create to create the Report Generator object in the I/O Model.
Select the Report Generator in the I/O Model and go to the Status property compound in the Object Properties panel. Here you can see when the last report was created and when the next one will be created. Any errors will also be displayed here.
To check the reports have been exported correctly, go to the configured Output Folder and open an exported report.

Object Properties

Common

Object Name: The user-modifiable object name. This name overrides the name which has been supplied by the external system. It must be unique within the collection of objects of the parent object.

Object Description: This is the user-modifiable object description. This text overrides the description which has been supplied by the external system.

Report Object: Define the associated report item object.

Report Name: Specifies the report name to use. If not specified, the default report name will be used.

Scheduler object: The path of the scheduler item object.

Functional Component: This determines in which service component the object is functional. The default zero value denotes the Master Core.

Debug: Additional debug messages will be generated in the event log. It is advised to not use this option in production mode.

Run once: If checked, the object will run once and return to default state.

Attachments: File attachments stored in MongoDB file store.

Usecases: Lists the usecases that apply to this object.

Output Options

The compound specified Report Generator Output Options.

Output Folder: The defined folder where output report data should be generated.

Output Format

None: Export will not be done.
PDF: Adobe PDF format for export.
XPS: Microsoft XPS format for export.
HTML Table: HTML Table export format.
RTF: Rich-Text export format.
Excel 2007: Excel 2007 format for export.
Word 2007: Word 2007 format for export.
XML: XML output format.
Image File: Report Generator creates image file.
ODS: OpenDocument Spreadsheet format is used as export format.
ODT: OpenDocument Writer format is used as export format.
PPT2007: PowerPoint 2007 export format.

Overwrite: The report file will be overwritten in the output folder.

Data Provider

Contains properties that describe the data providing mechanism that should be used by the report generator.

Mode

Select the data providing mechanism used by the report generator.

Data Provider Properties

Properties to define a data provider object.

Data Provider Object: Item that should be used as data provider.

Function Properties

Property groups to define script function properties.

Data Provider Function: Provide script that should be used as data provider for report generator.

Status

Contains properties that describe the status of an object with scheduler item.

Last Result: Result of last execution.

Last Execution (UTC): Last execution time displayed in UTC.

Next Execution (UTC): Next execution time displayed in UTC.

Custom Options

Compound to hold various structures to customize the object and to be read and written to by Lua-Script code or external interfaces.

Custom String: A generic string buffer to be used programmatically for custom purposes.

Custom Properties

This is an extensible set of named strings which can be used programmatically for custom purposes.

Property Name: A custom property name which can be used programmatically.

Property Value: The value of the custom property which can be read and written programmatically.

Custom Tables

This is an extensible set of named tables which can be used programmatically for custom purposes.

Table Name: A custom table name which can be used programmatically.

Table Data: Handles an entire table organized in columns and rows. The data can easily (cut, copy and paste) be exchanged with table-oriented data of other software products, e.g. MS Excel.