diff --git a/developers/automate/frequently-asked-questions.mdx b/developers/automate/frequently-asked-questions.mdx index e0e1319..6d751f8 100644 --- a/developers/automate/frequently-asked-questions.mdx +++ b/developers/automate/frequently-asked-questions.mdx @@ -4,60 +4,132 @@ description: Frequently asked questions about Speckle Automate ---
+## Access & Plans + + + + +Custom-code Automate is now available only to Enterprise plans. +Talk to us to see if you qualify. +Premade Automations remain available from the Starter plan, with some restricted to Business plans. + + + +Yes. Premade Automations are accessible from the Starter plan and above. +Some are limited to Business plans. + + + +No. Only Enterprise workspaces can build and publish custom Automations. + + + +Free plan: no. +Starter plan: yes, Premade Automations only. + + + +No limits at this time. + + + + +## Setup & Operation + + + + +GitHub remains the default creation flow using the wizard, while other VCS platforms are also supported. +Contact us while the documentation for each platform is in progress. + + + +Automate runs only on Speckle-hosted servers, with app.speckle.systems as the primary environment. + + + +No. Automate cannot be self-hosted. +However, Speckle Servers emit webhook events you can consume in external systems. + + + +In the Automate Execution Engine. +This is a separate infrastructure isolated from the running Speckle application and data storage. + + + +Automations can be triggered manually or automatically on new model publish events. + + + +An Enterprise workspace and at least one Function repository connected through GitHub or another VCS. +For non-Enterprise users, start with Premade Automations to experience Automate workflows. + + + +Your code remains in the GitHub repository you used during beta. +Automations may stop running if they rely on Enterprise-only features. + + + + +--- + +## Development & Sharing + - -- Automate compute usage is **free during the public beta**, allowing you to explore its capabilities at no cost. -- **Private Functions** can only be authored and executed within **Workspaces**, a paid feature included in Speckle's subscription plans. -- Automate is **fully functional during the free trial periods** of the Standard Plan, enabling testing before committing to a subscription. -- We're still finalising future pricing and welcome feedback from beta testers to shape our plans. - - -- **It depends on your perspective.** Automate may not always run faster for individual tasks, but it excels in the bigger picture: - - **Reduced learning curve**: Instead of training every team member on specific software, reusable Automate Functions make workflows accessible to everyone. - - **Hardware independence**: Automate uses cloud infrastructure, freeing local machines for other tasks. - - **Continuous automation**: Automations trigger automatically on new model uploads, eliminating manual steps and enabling results to be ready while you focus on other work. -- By streamlining collaboration and task automation, Automate can significantly reduce overall workflow time and effort. - - -- **Fully supported SDKs:** Python and C#. -- **Under development:** JavaScript/TypeScript and Jupyter Notebooks. -- Any language or software executable via **command-line instructions** can run in Automate, though using Speckle SDKs is recommended for seamless data interaction. -- For technical flexibility, Automate supports extending functionality with custom libraries, such as C++ or Rust, though support may vary. - - -- Automate is a **separate service** relying on an available Speckle Server. -- While in beta, Automate is not open-source or self-installable. We are working to integrate Automate more tightly into the Speckle web application. - - -Just a mindset that **automation is the future**! - - -- **Purpose**: Automate automates complex, time-consuming tasks triggered on new model uploads, not real-time parametric modelling like Hypar or ShapeDiver. -- **Integration**: Automate builds on Speckle's Connectors, enabling seamless data exchange with tools like SketchUp, Rhino, Blender, and PowerBI. -- **Flexibility**: Automate supports any language or software while retaining Speckle's collaborative and open-source ethos. - - -- Function creation is currently **limited to within Workspaces** during this phase. -- Public Functions are those **authored or curated by Speckle** and made available for general use. - - -- For **personal projects**, Automations are fully configurable by the automation author. -- For **workspace projects**, Automations are configurable by project owners. - - -- **Any project viewer** can see results directly in the Speckle web application. -- **Workspace admins and project owners** can access the full history of prior automation runs. - - -- Visit our [**Community Forum**](https://speckle.community/invites/Fbk5j1wbRW) to get assistance or share feedback about Automate. - - -- While a **public function for clash detection** is not yet available, here's how it could theoretically operate: - - Automate would run clash detection **in the background**, analysing multiple models from various tools (e.g., Blender, Revit, SketchUp) without manual intervention. Results would be viewable directly in the web application, shared via links, or embedded in platforms like SharePoint or Notion. - - Results could also be retrieved into other tools via Speckle Connectors (e.g., PowerBI or Excel). - - Automate's API would enable integration with external workflows, allowing custom reporting and visualisation. -- This functionality would save time by automating repetitive tasks and simplifying collaboration across teams and platforms. -*Note: Clash detection is a theoretical use case until a public function is available.* + + +Automate can run any command-line executable. +Speckle provides SDKs for C# and Python to simplify interaction with model data. +You can bring your own code stack, though support is limited. +Promising use cases may qualify for [#BuildWithSpeckle collaboration](https://speckle.systems/build-with-speckle/). Learn more or apply via the [BuildWithSpeckle page](https://speckle.systems/build-with-speckle/). + + + +When you publish a Function to your workspace, all project owners can deploy it as an Automation. +Results are visible to project Editors and Owners. + + + +Yes. Logs are available within the Automate run details. + + + +Not yet. + -
\ No newline at end of file + +## Security & Support + + + + +All configuration values are encrypted until runtime. +Results follow the same access model as Speckle data. +The execution engine is isolated from the Speckle app and vice versa. + + + +Any project viewer can see results in the Speckle web app. +Workspace admins and project owners can view full run histories. + + + +Yes. The catalog will expand continuously based on demand and collaboration with Enterprise clients. + + + +Yes. Requests are evaluated for broad user value, with Enterprise co-developments prioritized. + + + +Visit the [Community Forum](https://speckle.community/c/automate) for guidance and discussion. + + + + + + + diff --git a/developers/automate/introduction.mdx b/developers/automate/introduction.mdx index 06242f6..cd09fcb 100644 --- a/developers/automate/introduction.mdx +++ b/developers/automate/introduction.mdx @@ -5,25 +5,25 @@ description: Speckle Automate is a fully fledged CI/CD platform designed to run image -As a software developer, you can [develop Functions](/developers/automate/create-function) -that others in your team consume in what we call [Automations](/developers/automate/create-automation). -From creating reports to running code compliance checks to wind simulations, -there is no limit to what you can do with Automate. - -## Coming Soon - -Our team will curate a set of **Public Functions** available to all users on -[app.speckle.systems](https://app.speckle.systems), which you can use to experience -the power of Automate. - - -Speckle Automate has entered the public beta phase and is now -available on the Speckle production server: [app.speckle.systems](https://app.speckle.systems). -These docs are a work in progress and are updated regularly to reflect the latest -features and improvements. - - -We are continuously improving the documentation. As Speckle Automate evolves, -there may be occasions when development temporarily outpaces the documentation. -If you have any questions, please contact us on the -[Speckle Community Forum: Automate](https://speckle.community/c/making-speckle/insiders-automate/27). \ No newline at end of file +Speckle Automate is a CI/CD platform for model intelligence and data automation. +It runs your code automatically whenever a new version of a Speckle model is published, +enabling tasks such as validation, reporting, or data transformation to happen instantly. + +As a developer, you can [create Functions](/developers/automate/create-function) that define what runs, +and package them as [Automations](/developers/automate/create-automation) for others in your workspace to use. + +## Availability + +As of **SpeckleCon 2025**, Speckle Automate is **fully released** and available to **Enterprise plans** on +[app.speckle.systems](https://app.speckle.systems). + +A curated library of **Premade Automations** is available from the **Starter plan** and above, letting any user experience Automate without writing code. +Some advanced Premade Automations are reserved for **Business** or **Enterprise** plans. + +## Capabilities + +- Run custom code automatically when a model updates +- Generate reports or perform data checks without manual effort +- Deploy reusable workflows across multiple projects +- Integrate with GitHub or other version control systems +- Review detailed logs and results directly within Speckle