0.60

ReferenceControlArcAutomations

Arc automations

Create, run, edit, and delete Arc automations in the Console.

An Arc automation holds Arc code or a graph of blocks, and the Driver that runs it. You create, start, and edit automations in the Console. The Arcs toolbar lists them all. To learn what Arc is and where it can run, see the Arc overview.

Enterprise

Your role decides what you can do:

  • Owner, Engineer, and Host can do all the tasks on this page.
  • Operator can open automations, and start and stop them from the editor, but cannot choose a Driver.
  • Viewer can open automations and see their status.

See users and roles.

Create an Arc automation

  1. In the left nav, click Arcs (), or press A.
  2. In the Arcs toolbar, click Create Arc automation ().
  3. Type a name, and select an Editor mode:
    • Text -> Write Arc code. Use it for sequences and for automations with many conditions.
    • Graph -> Connect blocks. See graph editor.
  4. Click Create.

The editor opens. You cannot change the editor mode later. You can also run the “Create Arc automation” command from the command palette.

Choose where it runs

In the controls bar at the bottom of the editor, open the Driver list and select a Driver. The list shows only Drivers that can run Arc. To decide between the Core and a Driver, see where an Arc automation runs.

You cannot start an automation until you choose a Driver. To move a running automation to a different Driver, select the Driver, then click Redeploy.

Set the performance level

In the controls bar, open the performance list next to the Driver list, and select Auto, Low, Medium, or High. A higher level holds timers closer to their deadlines and uses more CPU. To choose a level, see performance levels.

You can select a level only after you choose a Driver. A running automation keeps its old level until you click Redeploy. A redeploy starts the automation again from the start.

Start and stop an automation

  1. In the controls bar, click Start (). The status changes to “Started task”.
  2. To stop it, click Stop ().

You can also start and stop an automation from its entry in the Arcs toolbar.

Edit a running automation

The editor saves each change as you type, and other users see it at once. A running automation keeps the code it started with until you redeploy it:

  1. Edit the code or the graph. A Redeploy button shows in the controls bar.
  2. Click Redeploy.

The automation starts again with the new code. Its variables go back to their first values, and each sequence starts again. Stop and start also run the latest code.

Right-click an automation in the Arcs toolbar, and select Rename, Copy link (not in Synnax Desktop), or Delete.

Delete stops the automation. If its tab is open, the tab offers Restore, which brings back the code but not the Driver choice. The restored automation is stopped.

Find an automation

The Arcs toolbar lists every automation. To search by name, click Open Arc explorer in the toolbar. Double-click an automation to open it.

Export and import an automation

To save an automation as a JSON file, click Export layout in the component toolbar. To import a file, run the “Import components” command from the command palette.

Status messages

The controls bar shows the status of the automation. Click the status to see its time, its full description, and Copy diagnostics.

Status Meaning
Task not deployed The automation has not started since you created it or chose its Driver.
Started task The automation runs.
Stopped task You stopped the automation.
Node failed A part of the automation had a problem, and the automation keeps running.
Failed to run Arc program A part of the automation had an error on a Driver, and the automation stopped.
Failed to configure task The code did not compile. The description shows the line and the problem.

For what to do about an error, see errors. For how the Core and a Driver handle errors, see errors while it runs.