Change log

{{ workflow }} object

This liquid object will output the Workflow details of a submitted Form.

You can use this on the default form submission page (/_form-submission-results/) or any custom redirect page you have setup for the confirmation page of your form.

The output can also be used within the forms auto-response email Body, From Name, and Subject fields, as well as the Workflow Notification email Body and Email Templates.

{{ this.workflow }}

Liquid Output

An example of the data structure for a successfully submitted form is below.

{
    "id": 2,
    "name": "Inquiry Workflow",
    "recipients": [
        "sales@example.com"
    ]
}

Accessing the Data

JSON Output

You can output the full JSON for your component data by referencing the root Liquid object {{this}} in your module’s layouts, or directly on your page, if using the collectionVariable parameter in your component tag.

For example:

{% component type: ... collectionVariable: "myData" %}

You can then render the JSON like so:

{{myData}}

For more details on using this approach, see Part 2 of the free ‘Learning Liquid Course’.

Rendering Property Values

As an example of rendering a piece of this data onto your confirmation page or within the forms autoresponder email you could use the following Liquid:

{{ this.workflow.name }}

This would output the value Inquiry Workflow to the page/email based on the above example data.

Extending on this example, we can use this data to inform the recipient of the type of Workflow being sent:

<p>You are assigned to the workflow '{{this.workflow.name}}' which is set up to notify the following recipients:<br>
{{this.workflow.recipients}}</p>

Viewing Data while Developing

It is often desirable to see all the data that is available to you on a page while developing your applications and there are two common techniques for doing this.

1. Rendering JSON to the Page

You can quickly and easily render the full JSON output directly to the page you are working on in order to view all the data and its structure in an easy to read format.
Simply wrap your desired Liquid object in <pre> tags like so; <pre>{{this.workflow}}</pre>

A JSON representation of the available data will be rendered to the page similar to the output examples above.

This of course is a temporary technique as you would not want to leave the JSON data visible on the page.

2. Rendering JSON to the Console

Perhaps a cleaner and more persistent way of viewing this data while in development, is to log the JSON output to your browser's console (in the browser's Developer Tools).

To do this, add some javascript code to your template file (just before the closing </body> tag) like this:

<script>
    console.log({{this.workflow}});
</script>

What this will do is output the JSON data into a structured data tree in your browser's Developer Tools console.

You can actually use this method to log any Liquid data to the console, such as a custom collection, for example:

<script>
    console.log({{myCustomCollection | strip_html}});
</script>

You might notice the Liquid filter | strip_html added here. This is optional, however, in some cases the JSON data will contain HTML code and this can break the Javascript, causing a scripting error.
So, keep in mind that, when using this filter, any fields containing HTML code in your JSON will not actually show the HTML in the console, however, the data is still there and accessible via Liquid when rendering to the page.

Remember to remove this code for production as it could pose a data security risk and it is best practice not to leave console logs in your scripts.


Related Articles

  • Reports
    Custom Reports
    Custom reports can be used to bring CRM data together, as a spreadsheet, based on your requirements.
  • CRM
    Form Submissions
    Form Submissions store the captured data from any form submission made on your website (from a form created under ‘Content’ > ‘Forms’).
  • CRM
    Advanced CRM Groups
    Advanced CRM Groups allow you to extend the data fields within multiple areas of the CRM, either globally or on a per-record basis.
  • Liquid Components
    orders
    This component fetches Orders from the CRM, either owned by the logged-in user or for all customer Orders.
  • Liquid Components
    CRMCustomGroup
    This component fetches Advanced CRM Group data attached to CRM Records, Cases, Orders or Event Bookings.
  • Liquid Components
    cases
    This component fetches Cases from the CRM, either owned by the logged-in user or for all customer Cases.

External Resources

There are currently no external resources available.

Please let us know if you have any other contributions or know of any helpful resources you'd like to see added here.

Questions?

We are always happy to help with any questions you may have.
Visit the Treepl Forum for community support and to search previously asked questions or send us a message at support@treepl.co and we will consult you as soon as possible.