Table of Contents | |
---|---|
|
Purpose
...
Table of Contents | |
---|---|
|
Purpose
Report designer allows you to create and design reports for custom configured Activity and Lab Test Forms. First you will need to create a Report Type. Once the Report Type is created, you can start designing your report.
...
Element | Description | |
---|---|---|
Label |
| |
Paragraph |
| |
Panel |
| |
Vertical Table |
| |
Horizontal Table |
| |
Checkbox List |
| |
Image |
| |
Line |
| |
Page Break |
|
...
Property | Description | ||||||
---|---|---|---|---|---|---|---|
Width |
| ||||||
Minimum / Maximum Height |
| ||||||
Border |
| ||||||
Group By | Data Set | Allows you to set the
| |||||
Text |
| ||||||
| |||||||
Text |
| ||||||
Data Set |
| ||||||
Source |
| ||||||
Font Size |
| ||||||
Bold | Two choices:
| ||||||
Italic | Two choices:
| ||||||
Underline | Two choices:
| ||||||
Text Align |
| ||||||
Hide Expression |
| ||||||
Direction |
| ||||||
Padding |
| ||||||
Number Format |
| ||||||
Background Color |
| ||||||
Options to Display |
| ||||||
Options Orientation |
|
...
The Reports Setting section allows you to define the settings for each report (report name, titles, legal text, digital signature properties, etc. See Reports - Report Types for specific setting information). Depending on the type of report you are working with (Activity or Lab Test) you will see different options.
...
Setting |
---|
...
title | File Upload Display |
---|
...
When PDF files are uploaded to Activity records you have the option to add these documents to the report or to not allow these to display. By default all PDF documents will be apended to the end of a report. If you would like to control which fields that contain file uploads are actually added to the report, change the "Display File Uploads" field found under Report Settings to "Added to Report Template". When this option is selected you must add the field to the report template in order for the uploaded PDF documents be added to your report.
Creating Columns of Data
Splitting your report into multiple columns can be achieved using multiple Panel elements. It's important to use panels to define alignment of the various elements used in your report design.
Step | Direction | 1. |
---|
Info |
---|
In the example, three panels where added to achieve three columns |
For each column, set the desired Width (% preferred) to defined the size of each column
Info |
---|
In the example: column 1 = 25%, column 2 = 25%, column 3 = 50% |
- Name for the report design
- Not to be confused with the Report Title (below)
- Short name / code for the report
- Must be unique across the system
- Default title of the report
- Tile of the report that will override the Default Title if the report is generated from the Field module
- Tile of the report that will override the Default Title if the report is generated from the QC module
- Gives the user generating a report the option to override the Report Title
- Discloses an operational standard that the report meets / is for (i.e. ASTM 1234)
- Assigns the digital signature profile / option that is available for this report
- Allows generated Field Reports to be sent to Quality Control for report review or, straight to Delivery
- Allows for configuration for all file uploads to display or, just uploads on the report template
- If a table extends to a subsequent page, column headers can be set to display again, at the top of the subsequent pages
- Legal text appearing at the bottom of the report if generated from the Field module
- Legal text appearing at the bottom of the report if generated from the QC module
- Determines if a field signature can be captured when generating the report from the Field module
- A field signature is similar to signing for a courier delivery - report recipient would "sign off" on the screen that the report has been delivered
- The signature obtained is part of the Field report generated
- Allows for uploading of static image onto report
- Allows for static text to display at bottom of report's body
- Displays the data of which the report was finalized and created in the header (not necessarily the same date as the activity / data).
- Displays the time of when the report was finalized and created in the header (not the time that the activity/data was entered)
- Show Report Date in Header setting must be selected to see this option
- Format of the file name generated for the report.
- Placeholder variables can be used to configure the file name. See table in the next section below for more details about placeholder options.
- Format of the report description metadata generated for the report
- Placeholder variables can be used to configure the report description, including {{SetNumber}} to return the sample's set number
- If associated report(s) exists, a short description of the will appear near the end of the body of the report (similar to a table of contents)
- Inserts an automatic page break when multiple form records are included in one report
- The start of each form included on the report will appear at the top of a a page
Info |
---|
For reports using Multi-record/Grouped record grid elements, this setting should not be used. |
- Allows for report type to be in available list of reports that can be associated to other reports
- Allows for report type to be added as an option in Report Type filter (picklist) in QC Draft Report module
- Allows for report type to be added as an option in Report Type filter (picklist) in Delivery module
- Allows for the person finalizing a report to also email the report as part of the finalization process
- Allows for the person finalizing a report to also make the report public in AgilePort
- Allows for user to apply a different digital signature type, based on project specification setting. (i.e. Typically sign this report but, for specific project, need to apply a seal instead)
- Yes = Report is used primarily for internal operations
- No = Report is used primarily for distribution to clients / customers
- Yes = Only reports marked with "YES" can be viewed when clicking on the Print early Test List
- No = Only reports marked with "NO" are listed in "Preview Report"
- Form type the report is for
- System value that is not editable
- System = Standard MetaField report header / footer assigned
- Custom = Report designer is able to design their own header / footer using the Report Designer
- None = No header / footer is included on the report
- Displays if Header And Footer Type = Custom AND Apply Page Break On Every New Record = Yes
- Displays if Allow Distinct Header And Footer On Each Record = Yes
- This setting will force a distinct header value for each underlying form instead of combining / concatenating / taking the first value when there are multiple values to report
- Displays if Header And Footer Type = Custom
- No (default) = WBS and Cost summary is not included in report
- Yes = WBS and/ or Cost summary is included in report
- This is only available if Include WBS / Cost Summary is toggled to Yes
- Yes = WBS fields are included in the summary report
- No = Only Cost summary is included and the WBS fields are not summarized on the report
- Count of the number of elements in your report design (label, field value, line, panel, etc. are all examples of elements)
- Report designs are limited to 500 elements
Placeholders
Both the File Name and Report Description values have dynamic placeholder values that can be implemented. Hover over the information icon next to each field to see the available placeholders. The placeholders are case sensitive and must be placed within brackets {{ }}.
File Name
Dictates the name of the file if a report is downloaded or emailed. Customizing this value can make it easy for clients to better identify a report without having to open the file PDF file.
Placeholder | Description |
---|---|
Office Name | Inserts the office value that is selected when generating a report. |
Report Description | Inserts the 'Report Description' which is can also be configured within the Report Designer. See table below for more information regarding this field. |
Report ID | A number that serves as a unique identifier for a report. No two reports will have the same ID. |
Report Note | Inserts the text value entered in the 'Report Note' field which a user can enter before finalizing a report. |
Report Number | If report numbering is turned on, then the file name will include the report number. |
Report Title | Inserts the 'Default Title' value set within the report designer. |
Report Description
Placeholder | Description |
---|---|
ActlvityDate | For Activity records only, displays the date the activity date found in most activity forms. |
ActivityNumber | For Activity records only, displays the date the activity number identifier found in most activity forms. |
ClientName | The name of the client associated with the project. |
ClientProjectNumber | The ' |
CurrentUser | Display the name of the user generating the report. |
DensityTestDate | For Density tests only, displays the date the test was conducted. |
DensityTestNumber | For Density tests only, displays the test number associated with the density test record. |
FieldActivityDate | For Activity records only, displays the date the Field Activity Date found in some activity forms. |
LabTestDate | For Test records processed through the LIMS module. Displays the date the test was conducted. |
LabTestNumber | For Test records processed through the LIMS module. Displays the date test number for the test record. |
LargestTestAge | For Test records processed through the LIMS module. Displays the largest number found in a specimen set. |
LocationDetails | For Test records processed through the LIMS module. Displays the data entered in 'Location Details' field. |
Location | For Test records processed through the LIMS module. Displays the data entered in 'Location' field. |
ProjectName | Displays the current Project Name. |
ProjectNumber | Displays the current Project Number. |
ReportDate | Displays the date the report was generated. |
SampleDate | Displays the data a sample record was created. |
SetNumber | Displays the set number tied to a sample record |
SpecimenNumber | For Test records processed through the LIMS module. Displays the specimen number for a test record. |
Technician | Display the Techician who captured or processed the sample or test record. |
Warning | ||
---|---|---|
| ||
When PDF files are uploaded to Activity records you have the option to add these documents to the report or to not allow these to display. By default all PDF documents will be apended to the end of a report. If you would like to control which fields that contain file uploads are actually added to the report, change the "Display File Uploads" field found under Report Settings to "Added to Report Template". When this option is selected you must add the field to the report template in order for the uploaded PDF documents be added to your report. |
Creating Columns of Data
Splitting your report into multiple columns can be achieved using multiple Panel elements. It's important to use panels to define alignment of the various elements used in your report design.
Step | Direction | Example | |||||
---|---|---|---|---|---|---|---|
1. | Within a panel, add the number of panels that equals the number of desired columns
| ||||||
2. | For each column, set the desired Width (% preferred) to defined the size of each column
| ||||||
3. | Add fields inside each column.
|
...
As you are building your report, you will be working with various elements. Elements can be split into two categories based of off complexity of the content:
...
To allow for faster addition of Form Fields, several additional elements are preconfigured for you upon dropping a Field onto a form. For example text based field types (Number, Text Area, Muliple Multiple Choice, etc.) are dropped onto the report as two Labels (one for the field label and one to display the field value) wrapped inside Panel component. After a Field has been added, all of these components can be altered to fit your needs.
...
Info |
---|
Upon dropping a field onto your report, the Panel has a Hide Expression added automatically to hide itself and the elements inside, if the record being reported contains no value. If you would like this to be hidded hidden using a different set of rules, this may be adjusted from the Properties menu. |
...
File Upload field types have the same structure as the text based field types, except that they are using an Image component to display the field’s value.
...
Info | ||
---|---|---|
| ||
Is empty is used to check whether a field does NOT contain any value. It has the following format: [DataSet][FormField][FormField] = ‘’ Examples: FormFields.ActivityNumber = " " FormFields.Discrepancies.Status = " " |
Info | ||
---|---|---|
| ||
Is last record expression is used to determine whether the component is used in the last activity record on the template or the last row of a Data Grid field (implemented using Panel or Table). This expression is mainly used with Line components in order to hide the line separator in the last rendered record. The expression is used like a function: last() |
= " " FormFields.Discrepancies.Status = " " |
Info | ||
---|---|---|
| ||
Is last record expression is used to determine whether the component is used in the last activity record on the template or the last row of a Data Grid field (implemented using Panel or Table). This expression is mainly used with Line components in order to hide the line separator in the last rendered record. The expression is used like a function: last() |
Calculation Expressions
Calculation Expression is a property that allows you to write expressions directly on a report. This allows for the ability to dynamically report on different data elements within the report itself. The Calculation Expression property is available for standalone fields (Label, Paragraph) or to table fields. When an applicable field is selected Caclulation Expression will be listed under the properties tab.
Working with Basic Table Elements
...
How to Control Data Grid Sort Order
Step | Direction | Example |
---|---|---|
1. | Right click on a selected cell in the table and click Select Table. |
2. | Select the properties tab. |
3. | Choose the Data set and source that you want to use to control sorting.
| ||
4. | Choose your primary sorting data element and if you would like to sort by ascending or descending. | ||
5. | (Optional) If you'd like to use a secondary sorting criteria, choose a data element from the Secondary Sort option and choose ascending or descending for the Secondary Sort Direction. |
Info |
---|
Can Sort Order can be applied to data grids or panel data elements that use a data source. |
How to Hide Duplicate Records
When Report Designer has Unique Row = “Yes” setting applied and if there are duplicate data entries for fields present in Multi Record Grid then for those entries Distinct Record is displayed. |
Using Main Level, Section and Report Resource Fields Inside a Table
...
Step | Description | Example (Click Image to Enlarge) | ||
---|---|---|---|---|
1. | Go to the elements tab and add a line component as the last element inside the Panel.
| |||
2. | Select the line and open the Properties tab. | |||
3. | Type last() inside the Hide Expression property to hide the line in the last row. |
Working with Images
How to fix stretched images
To keep the aspect ratio of your images, set a value only for one of the size properties: Width or Height.
...