Export Template Reports

Summary

 Word document can be completely customised. The Template Report will be available at 3 levels:

1. App
2. Record
3. Global

Details

Title: The title is the reference to the Template Report that will appear once you select to export as Template Report (Word document) from the Export option in the actions drop-down at any level.

Identifier: The identifier is a system ID for referencing a Template Report. This ID must be unique per Template Report and must contain only letters and numbers starting with a letter. It must also be a minimum of three characters. 

Subtype

The Subtype will define the level of appearance of the Template Report. There are 3 levels available:

• App: the Template Report will be available when you are in an App. At this level you will be able to export this Template Report (Word document).
• Record: this option will make the Template Report visible once you are in a record in the specified app.
• Global: the Template Report at a Global level will be available in every Homepage.

App

The App you select will determine where the Template report will be available.

This option will be required when the Subtype is App or Record. Also, if you decide this Template Report will be set as System Default for Subtype, this option will not have any value and will be hidden too. 

Use as System Default for Subtype

The default Template Report for Subtype is the Report that the user will be able to download in every single App, Record or Global level, as you predetermine in the Subtype.

Once you have filled in all these details, click on 'Create Template Report', and then you will see the option to upload your Template Report document at the bottom of the screen. At the end of the document row, there is an upload icon for you to upload you templated report. You can also remove the export by clicking the X

Note: Single file upload only. Supported file types include: ".doc & .docx".

We expect keywords to sit in their own paragraph or within a table cell. They must also be in the main body of the document so could not be added to headers or footers.

Supported Keywords 

Report Key Words 

@Report(AppIdentifier, ReportIdentifier, FilterString(optional), ChartWidth(optional), ChartHeight(optional))

     - e.g. @Report(AppA, ListReport)

     - e.g. @Report(AppB, BarChart, null, 300, 200)

NOTE : Filter strings need to be in the format they are used in the URL (URL ENCODED) - Please check out the article here on how to create the right filter

Record Key Words

@Record(Forms[], Fields[], LinkedAppReports[], ShowComments?(optional), ShowAttachmentsList?(optional))

     - e.g. @Record()

     - e.g. @Record([], [], [], false, true)

     - e.g. @Record([FormA, FormB], [FieldA, FieldB], [{ChildAppA, ListReport},{ChildAppB, BarChart}], true, false)

Fields Key Words

@Field(FieldIdentifier)

When trying to export a person field and you want the name and not the ID use the form @Field(FieldIdentifier_Text)

@ImageField(FieldIdentifier, Width (optional), Height (optional))

Where you want to export an image field (photo/picture) to specific dimensions on a word template

e.g.  @ImageField(Image1A, 300, 200) 

Height is not supplied as an optional parameter, then the image will use the Width and then keep the original ratio of the picture

@InAppChart(FieldIdentifier, ChartWidth(optional), ChartHeight(optional))

@PageBreak()

@Default()

     - This keyword can be used when overriding the system default to maintain the existing default functionality.

Exporting Child Templates

@ChildAppTemplatedReport(ChildAppIdentifier, ChildAppTemplatedReportIdentifier, FilterString)

From a template produced from a parent record, you can include the above keyword where you need child record level templates inserted for child records matching the filter criteria

Repeat Headers & Ignore when no Records

@ListReport(AppIdentifier, ReportIdentifier, filter (optional), IgnoreWhenNoRecords (optional), RepeatHeaderAcrossPages (optional)

If there are no records, this keyword reference can be used to ignore the list, and the heading can be repeated if the list spans numerous pages by setting the parameter to 'true' 

An example of this being used on a report without a filter is: 

@ListReport(Tasks, Export, , true, true)

Report Upload Validation

When uploading documents to the export template, app studio will validate the field names being referenced in the export, if any don't match then it will not upload the document and show an error message in the bottom left-hand of the screen under a red triangle saying which references are wrong. For any issue where the document has been uploaded and the export is still failing please check export summaries - Export Summaries – Softools