Report Generator Quick Start

What makes AssessFluence Report Generator unique?

AssessFluence report language is a universal low-code templating language.

This templating language works virtually with all documents (docx, odt, ods, md, xml, html, ...) even if AssessFluence does not know the specification of the document. For computer scientists, it is an XML-agnostic algorithm.

It uses a simple declarative programming language, which is not intrusive. You don't need to insert control flow codes such as if or start/end-loop tags in your document.

This way of programming provides more flexibility for traveling data. You can transform your original JSON array directly in the template.

In computer science, declarative programming is a programming paradigm, a style of building the structure and elements of computer programs, that expresses the logic of a computation without describing its control flow.
Many languages applying this style attempt to minimize or eliminate side effects by describing what the program should accomplish in terms of the problem domain, rather than describing how to go about accomplishing it as a sequence of the programming language primitives (the how being left up to the language's implementation).
This is in contrast with imperative programming, in which algorithms are implemented in terms of explicit steps. Wikipedia source

Essential knowledge

What is a template? A document created with the tool of your choice. It can be a DOCX, PPTX, ODT, HTML, MD, etc. AssessFluence supports almost any type of editable document.

What is JSON? A way to organize and share information in a format that is easy for both people and computers to understand. The JSON is the raw data coming directly from your responses, campaigns, etc. in AssessFluence.

What is a Tag? A placeholder (also called "merge field") in your template that indicates where data should be inserted. Tags are written between curly braces {}. Types of tags:

{d.}: Injects data from the main data object.
{c.}: Injects data from the complement object.
{# }: Special tag to declare an alias (shortcut).
{t( )}: Special tag for multi-language translation
{o.}: Special tag to apply AssessFluence options: pre-release tags and arithmetic precision.

How does AssessFluence Report Generator work? AssessFluence merges your template with the data and generates a new document.

What is a Formatter? A function (e.g., :lowerCase) that is added to the end of a tag to modify the data. What you can do with formatters:

Format numbers, dates, strings, currencies, etc.
Create conditions,
Perform mathematical computations, aggregations, etc
Use them for advanced features such as inserting images, merging PDFs, parsing HTML, or applying colors, etc.

Generate a document

Designing a template is 80% about mastering your text editor (e.g., Microsoft Word, LibreOffice, OnlyOffice) and 20% about understanding the AssessFluence Report Generator language, which is fully covered in the Help Center.

Use your text editor to add elements such as headers, footers, page numbers, and table of contents, ...
Add AssessFluence tags to inject your data and see the result

Ready to generate your first report template? Just follow this quickstart tutorial below to get started.

1 - Design a report template

Generating your first report with AssessFluence is very simple.

Simply create an ODT or DOCX document with Microsoft Word, Libreoffice or Google Docs (just to get started, other formats are of course supported 😉).

Then write tags, which are placeholders used by AssessFluence to inject data, such as:

Name: {d.data.firstname} {d.data.lastname}

Bravo 🤩, your template is ready to use!

2 - Upload a report template

For the second step, you need to upload your template into the AssessFluence platform.

Navigate to Projects > Reports.
Then click on Add, set a name and open the design studio and upload your template

3 - Preview your report

All that's left to do is insert your data into the JSON editor. Your document is immediately previewed.

4 - Download final report

You can then download your document in any format you like!

Amazing feature - Live reloading

Live reloading allows designing and editing templates from your local text editor, and AssessFluence Report Studio will preview the report automatically. Upload a template once, and the document previews on the AssessFluence studio as soon as the JSON/template is updated.

It's magic 🎉