...
Introduction
Object reports can be used are a useful way to export a selected set of objects . Object report can be generated several varieties.
...
in various formats. There are several varieties of object reports available:
Generic Spreadsheet Report: This type can contain multiple sheets, with each sheet representing one per class.
Spreadsheet report based on template - Report Based on Template: Specifically designed for one class and available as in MS Excel or Open Document format format.
PDF output Output Based on Spreadsheet Template: This type is based on spreadsheet template (Based either on MS Excel or Open Document )and generates PDF output.
MS Word based on Word template onlyBased on Word Template Only: Exclusively utilizes a Word template for generating MS Word documents.
Reports from Search
Search results can be exported as a Report in one of the available formats:
...
Grid View tabs can be exported as selected report type:
...
Depending on the report type:
Current The current tab will have XLS and PDF formats available - both . Both will be either generic or template-based , if a template was defined by an a system administrator.
All tabs will allow only for a generic XLS report, as each class requires a different sheet to accommodate it's its metadata.
Checked records - this option is activated when there are any records checked in the grid view. It only applies to the current tab.
Templates
A template can be used to create a more appealing results from object export . Any using any spreadsheet file can be used as a template.
Formats that can be used for templates isare:
Office Open XML Spreadsheet (*.xlsx)
Open Document Format - Spreadsheet (*.ods)
Office Open XML Document (*.docx)
The file can be prepped prepared using 3rd party software like:
Microsoft Office
LibreOffice suite (free) that can be downloaded here: https://www.libreoffice.org/
Other software that can produce compatible *.xlsx / *.ods / *.docx files
...
You can design your template as needed, keeping in mind a few these important rules:
The spreadsheet should fit well into a page if you are going to print it or use it as a base of PDF output
In Microsoft Office Excel, please use View - Page Layout to confirm that the content does not overflow
You can add any footer or header, logos and more
For MS Word templates, only one table can be used in the body. Additional tables can be used in header/footer sections.
For ODS stylesheets, there is one
...
additional row to
...
fill: 'sample data row' (more on this row in the last section
...
under paragraph
...
Identifying sample data row). This Sample Data row, which is next
...
after the header row ('header index + 1' row), should contain data style formatting with sample text. If this row is not filled or
...
contains no text with fill and formatting, then formatting from header row style will be inherited. This may lead to confusion
...
; thus remember to fill sample data
...
rows'
...
cells with
...
formatted text and fill.
For XLSX
...
stylesheets, this
...
additional step does not
...
apply.
Next
...
comes the Footer Row right after '
...
sample data row
...
.' This Row's cells
...
might include stylesheet functions references (For ODS and XLSX stylesheets only). More
...
about this step is covered in paragraph
...
Identifying sample footer
...
rows at end of section.
Adding data tableData Table:
At some location in the spreadsheet a data table that will be filled in automatically where automatic filling must start , take make note of starting index as it has to be provided when while adding the template to the system
Create a header row, you can use distinctive colors or other formatting as neededdistinctive colored or otherwise formatted Header Row
3.As column headers , enter field names that are available for this class , like shown below with e.g., "fi2space_name" and "fi2space_class"
4.Set the column width as requiredaccording requirement
The report will be generated according to follow this layout , only where selected columns will be usedexclusively feature.
Special columnsColumns
Currently there is 's one special column header that can be used, to include includes object location path information.
To add path column , in the header add simply include $path as header value. value
Sample template for MS Excel:
...
Limitations
Spreadsheet / Excel
For When creating Excel report creationreports, there are no known limitations in terms of template compatibility. There is a vast number of However, due to the numerous options and combinations that can be done available in XLS spreadsheetspreadsheets, so that we cannot guarantee that every option will work smoothly.
If in doubt, start unsure, it's recommended to begin with a simple template and then gradually build on that gradually it until a the desired effect is achieved.
The PDF output has may encounter some compatibility issues with templates based on Office on Office Open XML Spreadsheet (*.xlsx). One of the known issues relate An example of this is related to images present in header sections, that will which may not be visible on the PDF output if the template was in in *.xlsx format. If you wish to use To utilize this functionality, please create consider creating a template using LibreOffice or Open Office.
MS Word
Only It's important to note that only one table can be used in the template body for MS Word.
Template Manager
The Template manager is a tool available for System Administrator. Go to Administrators. Access it by going to the Administration panel and select selecting Report Templates:
...
One template can be uploaded per class and output type. To upload a template, use New button and select appropriate options:
...
Class: an An object class indicating where this template will be usedapplied.
Type: output type where Output type specifying the context in which this template should be usedutilized.
Header Index: a A row index indicating where that indicates the starting point of the data table starts. This row should contain include columns with class field names.
Header index for For MS Word templatetemplates, the header index is a specific row number in the table that contains data header. Header containing the data headers. The header will be created at this row. Data , and data will be inserted at on the next subsequent row.Report Template: a A template file to be uploadedupload
Identifying header index:
...
Next row after header row should be trated treated as an empty data row. For ODF formats, this row should contain data style formatting with sample text. If no styling is provided, formatting from the header row style will be used.
This may lead to confusion, so one has to remember to fill this row's cells with sample formatted text and fill options.
Footer row
Row following the sample data row will be used as a footer row. It can contain either simple text or one of the available formulas.
Please note , that templates support only these simple, predefined formulas and not regular stylesheet formulas!
Template formulas must be provided in the following format:
HDC prefix prefix ($HDC_) + 'function name'
Allowed functions are: COUNT, SUM, and AVERAGE, so their corresponding references will be the following texts:
$HDC_COUNT
$HDC_SUM
$HDC_AVERAGE
...
| Note |
|---|
Formulas will not be resolved when the document is opened in |
...
read-only mode. Editing must be enabled before the calculation happens. |