Skip to main content

​
What is an Automation?

  • Automations allow you to perform a wide variety of tasks efficiently.
  • Automations apply a function to a Speckle model.
  • Automations enable you to configure a function to meet your specific requirements.
For example, a function might render a photograph-quality image of a model. Automation allows you to specify parameters such as the camera position, lighting, and other settings to customise the output for your particular Speckle model.

​
Creating an Automation

Automations are created from the Automations tab within a project.
the automations tab
💡 Function AvailabilityThe library view includes both public functions [Coming Soon] and any private functions created for the Workspace if the project is a Workspace project created for your team. This ensures all team-specific and public resources are accessible during automation setup.
1

Select a Function

Choose a function from the list in the Automations tab and click Next.
create automation
selected function
2

Set Parameters

If the function has defined inputs, configure them now.
parameter configuration
3

Add Automation Details

Choose a Speckle Model: Select a model from the current project that will trigger your automation.
choose a model
Name Your Automation: Provide a meaningful name for reference (uniqueness is not required).
A form field to name the automation, with an example name entered
4

Create Your Automation

Click Create to finalise the setup.
create!
5

Success! 🥳

Your automation is now ready to view and manage.
⌘I