Report templates

 

General

The formatting of text, size, color, font etc is controlled by the format of the command in Word. What you see you get.

Templates are created in word and saved as a word document (*.docx)

Reports from Instance, Type, Room, Level, Building grid i working. Do you want an instance report with all information you have to project those parameters to instance.

Sorting in reports is as how you sorted in Grid when reporting. For Grouped reports you can use a code to sort in tables.

Cover page

You can have one page as Cover Page in your Report. 

Add an empty page as the first page in your template and by adding a, in Word Page Break on the first page you will define that the report will start from the second page.

On a Cover page you can write texts and add images like logos etc. or write information from the Company Information or from the fields in the Create Report form.

Example of commands to use on cover pages:

${companyinfo.company}

${projectinfo.projectnumber}

Metadata after the dot is metadata set on the company/project level

Metadata from when creating reportdialog

${reportinfo.createdBy}
${reportinfo.documentationDate}
${reportinfo.revision}
${reportinfo.revisionDate}
${reportinfo.status}
${reportinfo.description}

 

Header and footer

You can design your report header and footer by adding texts, images, available fields and object parameter data.

 

Example of commands to use to write object parameter data in header or footer is:

${Parameter name}  ${companyinfo.xxx} ${projectinfo.yyy} ${reportinfo.zzz}

Instance/object reports

${Parameter name}

 

Images

Example of image command:

1. ${image alignment="center" unit="cm" width="3" height="2":tagName} - Image will be set at 3 cm width and 2 cm height in center of document.
2. ${image:tagName} or ${image unit="percent" width="100":tagName} - Image will be set at original size in report.
3. ${image unit="cm" width="3":tagName} - Width of image in report will be set at 3 cm and height of image will be changed from original value with same percentage as width  because uniformity of image.

Properties of image command:

1. alignment - center, left or right (in all examples above you can add alignment property, default value is left)
2. unit - cm, point, inc or percent (default value is cm, you can not use unit property without width or height property)
3. width and height - dimensions in measurement unit from unit property

 

Table report (Grouped)

If you want to create table in the report then you add a table in the report with the correct formatting, design and layout and then add the commands for writing object parameter data in the rows.

Example of template table:

Grouped reports

It is necessary to put options Grouped on Yes when you upload grouped template.

Example of commands to use on grouped templates:

1. @{Parameter name} - data will be grouped by parameter with Parameter name from this command.
2. ${Parameter name} - parameter with Parameter name from this command will not affect on grouping. With this command in report will be displayed all values of Parameter name for certain group. That values will be comma separated.
3. $_T{Parameter name} - parameter with Parameter name from this command will not affect on grouping. With this command in report will be displayed all values of Parameter name for certain group. These values will be displayed in a table that has as many rows as the parameters.
4. @{Quantity} - Number of instances for certain group.

 

This is example of grouped commands in one template and report generated from that template.

 

   

Sorting in grouped reports:

@{sortDirection="ASC" sortOrder="1":Parameter Name} - data is sorted and grouped by Parameter Name from this command.

Properties of sort command:

1. sortDirection - have just one of two values: ASC or DESC and that is direction of sorting (ascending or descending).
2. sortOrder - must be number and it is priority(order) of sorting because we can sorting data by multiple parameters. 1 is greatest priority.

 

We can use multiple sorting commands in one template and we will get data sorted by all of that parameters.

 

Group in two levels

Objects per destination

Global BIMEYE ID		Total no of articles	Image
@{groupLevel=”1”:Global Name}		@{groupLevel=”1”:Quantity}	${image alignment=”center” unit=”cm” maxWidth=”3” maxHeight=”2”:Furn}
	Room number	Room name	Qty
	@{groupLevel=”2”:Room Number (in room)}	@{groupLevel=”2”:Room Name (in room)}	@{groupLevel=”2”:Quantity}

 

Objects per room

Room number	Room name	Total no of articles
@{groupLevel=”1”:Room Number (in room)}	@{groupLevel=”1”:Room Name (in room)}	@{groupLevel=”1”:Quantity}

Global BIMEYE ID	Quantity
@{groupLevel=”2”:Global Name}	@{groupLevel=”2”:Quantity}

 

Changelog

Put what parameters that define the objects as a header.

${Global Native Category}, ${Global Name}

${new}
${changed}
${deleted}

Revision reports

Upload the standard report marked as a Revision report.

Table of content

Coming