Skip to main content
Proton v5

Automation document

Proton builds the automation document from what is registered: the business process, the components with their documentation and the datasets with their data. It is useful for audits, for people joining the team and for the process owner to understand what the automation does without reading code.

To open it, use See the automation document on the automation card, in Automations > Automations. The document is read-only and works on mobile phones.

What the document shows​

  • Numbers: how many datasets there are (and how many have never run), how many steps, what share of the components is documented and the last run.
  • Process: the business process, its criticality, the owner, the responsible area and the people involved. When no process is linked, the document says so.
  • Automation: the description, the systems, the tags, the folder and the identifier.
  • Datasets and steps: for each dataset, the steps in order, each one with:
    • What it does: the component's description, objective, preconditions and notes;
    • Data used: the values of the step. Encrypted ones appear as a hidden value; a reference to the output of another step takes you to that step;
    • Expected result: the component's and this dataset's.

A component counts as documented when it has the objective or the expected result. A step without documentation is flagged. See Components.

Filters​

  • Datasets: choose which datasets are included. The choice goes into the page address, so you can send the link.
  • Search component, data or value: searches the components, the documentation texts and the data (never the encrypted values).
  • Last run: by result, or only the ones that have never run.
  • Only undocumented steps: to find what still needs documenting.

Download and history​

  • Download PDF generates the document as a PDF, in the language of the screen. With filters, the PDF includes the datasets shown on the screen and notes that it is a partial view.
  • History shows the changes to the automation: who changed it, when, where it came from (the screen, the API or AI) and each field, from which value to which.

The document requires viewing automations, and only shows an automation that you can see under the team rule.