Workflows allow you to save time by automating tasks such as syncing the organisation data from your accounting system and generating and delivering report bundles to your email inbox. You can manually start a workflow or have it automatically triggered at a scheduled time.

The video below shows you how to set up an automated workflow. Written instructions are also included.

For further information on workflows, please see Edit Workflow Actions and Properties, View Workflow Activity and History, and What to do if your Workflow Fails.


Create a Workflow

The steps below will outline how to create a workflow in the online app.

  1. Sign into the Calxa online app.

  2. Click on the Automation menu at the top of your screen.

  3. Click on New Workflow.

  4. Click into the area where you see My new workflow and type in a workflow name that you will be able to easily identify in a list.

  5. Click on Add Action to add the first action to be taken in your workflow.

  6. To sync the organisation data from your accounting system, click on the Select an action drop-down and then select Organisation update.

  7. Click on the Select an organisation drop-down that now appears and pick the organisation you would like to update in this workflow. Click Save Action.

    If you have multiple organisations to sync, Click Add Action again to add the next one.

  8. After you have saved the first action in the workflow, click on the Add Workflow button at the top right.

  9. To add an action to run your report bundle click on Add Action again. Note: The Add Action button will open be visible after you have clicked on the Add Workflow button as shown in the step above.

  10. Select Generate & send report bundle from the Select an action drop down. Next click on the Select report bundle drop-down and select the bundle you want to run.

    Now enter the email address of  the users you want to receive the report bundle in the Send to field. User email addresses should be separated by a semi-colon (;). Click Save Action.

    Note: You can add actions to sync and run reports on multiple organisations all within one workflow.

    Note 2: Many users will have at least 2 separate workflows: One to sync their organisation data, then a 2nd workflow to sync organisation(s) data, run report bundle(s) and email them out to a distribution list.

  11. When you choose to generate & send a report bundle and include the email address(es) of recipients, each recipient will receive an email from that looks similar to the image below. The selected report bundle document will be attached.

Schedule a Workflow (Triggers)

A workflow can be configured to run automatically on a trigger. A schedule trigger is available currently. Additional conditional triggers will be added later as they are developed. You can also choose to run a workflow manually.

  1. To configure a workflow to run automatically, click the button next to 'Activate this workflow any time one of the following events occurs'. Then click on Add Trigger.

  2. To configure a schedule, select the time and days and frequency (monthly or weekly) you would like the workflow to run and click Save Trigger.

    Set the 24h time for when you want the workflow to run - Calxa suggests late night or early morning so you can receive your reports in your inbox in the morning. The UTC time should be set to the timezone where you live.

    In the example below, the workflow will run on the 10th day of each month at 4:00 am Brisbane time.


    In this example the workflow will run every Monday at 2:00 am Brisbane time.


  3. Note you can set up more than one scheduled trigger. The workflow below will run every Monday, and once a month on the 10th day of the month.

  4. You can also run an automatic workflow manually at any time by clicking the Run Now button at the top right of the workflow screen.

  5. To choose to only run a workflow manually, click the button next to 'Only activate this workflow manually' in the Triggers section.

    The status of the running or completed workflow will be displayed after you click Run Now. Click Refresh to update the status (did not run, running, succeeded, failed).

Date Selection for Bundles in Workflows

With workflows, there is no place on the Automation screen for you to select the Report Month because workflows are intended to be an automated process done on a schedule.

The key thing to be aware of here is that Calxa will always consider the report month to be the last full calendar month by default when working with workflows. You will therefore need to set the date criteria in your bundled reports with that in mind to ensure you get the reports you expect. For example, when an automated workflow runs late in the calendar month of June, the report month when it runs will be May.

Note: To clarify, an automated workflow's report month bears no relationship to the date you last synced your organisation data. If you haven't synced your organisation in 4 months, for example, and you are now in the calendar month of October, the report month in workflows will be set to September by default. 

  1. For instance, let's say you want to set up a workflow to run during the current month, like in the case of running reports in mid-June for the month-to-date of June.

    The report month when it's run in June will be May in Calxa by default. This is because May is the last full calendar month available from your accounting system when you run a workflow in June.

    What this means for date selection in your month-to-date bundle is that you should set dates based on a report month of the previous month.

    For example with the Actual & Budget report, which displays the month and YTD actual vs budget P&L, you would set the Period in the Report Filters to Relative 1 so the report gives you results for the current month-to-date of June.

    In summary, the report month for the workflow in this example here is May. To get a report showing June month-to-date results, you must ask for the report month + 1 month (May + 1 = June), with a Period of Relative 1.

  2. On the other hand, if you wanted to run a workflow in mid-June to report on May's month-end results (full month), you would set the Period to Relative 0, just the same as you do when running a single report in the Builder screen.