Components

A component is a reusable automation step, such as "Log in", "Create order" or "Look up ZIP code". It is registered once and used in as many automations as needed.

In Automations > Component, components appear in a tree, grouped by system.

The component and the code

The component name is the same in Proton and in the automation code: the code finds the component by its name, with no registration anywhere. In the template projects:

• Python: the file automacao/componentes/<name>.py. FazerLogin becomes fazer_login.py.
• Java: the class <Name>.java in the components package. Fazer login becomes FazerLogin.

The same goes for parameters: the code reads each input (in_) and returns each output (out_) by its registered name. See Parameters.

The tree

• Each system shows its components. Clicking the system shows its summary and New component in this system.
• An orange dot marks a component without documentation.
• The search finds components by name, by the name of a parameter or by system.
• The chip for undocumented components filters the tree: handy for finding what still needs documenting.

Create a component

1. Use New component (or New component in this system).
2. Fill in the Component (the name, with no spaces, up to 100 characters, unique in the organization) and the System.
3. If you want, fill in What it does, the documentation and the parameters right away.
4. Save.

Documentation

The component documentation goes into the document of every automation that uses it:

Field	What to write
What it does	The action the component performs in the system.
Objective	Why the step exists: the business rule it serves.
Expected result	What has to happen for the step to be correct. Each dataset can add to it.
Preconditions	What needs to be ready beforehand.
Notes	Details for whoever maintains the component.

A component counts as documented when it has the objective or the expected result.

Suggest with AI

When editing a component, Suggest with AI proposes the documentation based on the name, the system, the parameters and where the component is used (the previous and the next step in each dataset). You choose what to use, review it in the form and save: nothing is saved without Save.

Each suggestion consumes AI credits, and the button shows how many. It requires the AI module in the plan.

Component parameters

The Parameters section lists the component's inputs and outputs.

• Add parameters links parameters that already exist in the organization.
• Create parameter creates a new parameter (input or output) and links it to the component. If a parameter with the same or a similar name already exists, Proton offers to use the existing one.
• The pencil renames the parameter or changes its description.
• The x removes the parameter from the component (when editing).

The link takes effect after you Save the component.

Impact analysis and history

• Impact analysis shows what a change to the component affects: the datasets that use it, the automations, the business processes (with their criticality) and the automation groups. It also warns you when affected datasets failed in their last run.
• History shows each change: who made it, when, where it came from (the screen, the API or AI) and the fields that changed.

Delete

A component can only be deleted when no dataset uses it. Use Impact analysis to find where it is used and remove it from those datasets first.

Permissions

Viewing, creating, changing and deleting components have their own permissions in the profile (Component). Creating and renaming parameters requires the Parameter permissions.