Create and Publish Circuit Templates in Qntrl Marketplace: Step-by-Step Guide| Qntrl Studio| Online help

Build and Share Circuit Templates with Qntrl Studio

Qntrl enables you to create pre-configured, ready-to-use Circuit templates that can be installed and deployed instantly, without the need for additional configuration. This simplifies the process, making it easy for users to access quickly and implement efficient automation solutions.

If you're new to Qntrl, start by exploring the platforms:

  • Circuit: A powerful tool for integrating micro-services to automate IT and business workflows. With its advanced flow controls, you can design automated processes with minimal or no coding required.

  • Qntrl Studio: A platform to build automated IT workflows as Circuit templates. Once created, these templates can be published to the Qntrl Marketplace. 

  • Qntrl Marketplace: Serves as a central hub for discovering and showcasing Qntrl extensions, much like an app store for Qntrl.

 

Using Qntrl Studio, you can easily create Circuit templates equipped with pre-built configurations that are ready to be customized and deployed within your Qntrl processes. While Qntrl offers default templates, you have the flexibility to create and share your own templates in the Qntrl Marketplace.

Step 1: Create a Circuit Template     

  1. Log in to your Studio portal.
  2. Navigate to the Circuit section in the left pane.
  3. Click the Create button to initiate the creation of a new circuit template.
  4. Fill in the New Circuit Template details:
    1. Template Name: Enter a name for the template. This name will also serve as the default circuit name, which you can edit later, if necessary.
    2. Description: Provide a brief explanation of the template's purpose and functionality.
    3. Category: Represents departments or groups under which the template will be listed. Select an appropriate category from the predefined options to organize the template.
    4. Service: The drop-down menu lists all the services integrated with Qntrl. The template will be listed under the selected services.
      1. You can select multiple services.
      2. Selecting General includes all services by default. 
  1. Click Create.

  1. A new circuit will open in the Builder view with a default "Pass" state where you can build the circuit and associate the required components.

For detailed instructions on creating and configuring a circuit, refer to the dedicated Circuit help page.

After creating the template, a draft version of the Circuit will be displayed, including the associated component details.
  • Add Developers: Click the  icon next to Developers to Invite collaborators.

  • Add Media: Click the  icon next to Images/Videos to attach images or videos to support your circuit.



You can include up to 25 developers in a template, and only they will have the authority to edit or update it.

Step 2: Building  Template Components  

You can create and associate components required for the circuit within the Studio portal. These components will automatically appear as options in the relevant sections when constructing your circuit.

Types of Components  

  • Webhooks: Enable automated HTTP notifications, triggering alerts in third-party applications based on predefined user actions within the organization.
  • Functions: Custom scripts to extend the functionality of your circuit.
  • Connections: Integrations with external systems or databases.
  • Tables (Request Basis): Stores structured data.
  • Schedules (Request Basis): Automate actions based on time or events.
  • Group: Organize related components.
  • ConfigStore: Centralized storage for configuration data.
 
To create the required components:
  1. Navigate to the left panel within the Studio portal.
  2. Select the desired component type (e.g., Webhook) from the list.

  1. Click the corresponding button prompting to create a new component (e.g., Create New Webhook).

  2. Fill in the necessary component details and create the component.

Refer to the Configuring Additional Components section for detailed instructions.

The scope of all created components is limited to the specific template and cannot be reused in other instances.

When exporting a Circuit template, components like Webhooks and Functions are exported only when they are associated with a circuit. However, Schedule, Table, Group, and Parameter are fully exported without requiring any associations. For instance, if you create three webhooks but only associate one with the circuit, only that webhook will be exported when you export the template. The same applies to functions.

Edit Circuit Template  

Access Template Details:

  • Navigate to the Circuit section in the left panel.

  • Select the desired circuit from the list.


Edit Template Details:

  • Click Edit Details to modify the template's name, description, category, and service.

  • Click Update to save the changes.    

 

Edit Template Structure:  

  • Click the Edit Template button to modify the circuit's workflow and components.

  • This will open the circuit in builder view.

  • Edit the circuit and its components, then Save the template.



















Step 3:  Test Template   

Before publishing, it's essential to test your entire template. Qntrl Studio enables template testing in a dedicated test environment. Any changes made in the test environment are automatically synchronized with the studio environment and vice versa. Only the template configurations (metadata) are imported back after testing, ensuring data privacy. For example, if you use an email address, only the email field will be saved, not the specific email.

  • The test environment is designed for testing existing circuits and does not support the creation of new circuits.
  • While the test environment supports all Qntrl features, it is limited to testing circuit-related modules only.
  • Configuration settings are locked in the test environment. You can run the template with different input values but cannot add, modify, or delete configurations.

To test templates in the service environment:
  1. In your Studio portal, navigate to the Circuit section in the left pane.
  2. Select the circuit you want to test.
  3. Click the Test Template button at the top-right corner.
  4. You will be redirected to a test environment of the selected service in the Sandbox.
  5. Test the template's functionality within the sandbox test environment.

Learn more about testing within the Sandbox environment.

Step 4:  Publish Your Template    

Publishing your template on Qntrl Marketplace allows you to reach a wider audience. 

Submitting Your Template     

  1. In your Studio portal, navigate to the Circuit section in the left pane.

  2. Select the circuit you want to publish.

  3. Click the Submit to Studio Gallery button.

  1. Fill in the required fields in the form, select the agreement and terms and conditions checkbox, and click Next.

  1. Complete and submit the form.


Template Status  

As you build and manage your Circuit template, its status will change to reflect its progress.

  1. Draft: Initial phase when the template is created or being edited.
  2. Incomplete: Template submission form is not fully completed.
  3. Under Review: The template is awaiting review and cannot be modified. The Studio portal becomes read-only during this phase.
  4. Retest: Template is rejected and requires revisions.

  • Until the form is completed and submitted, the template status will be 'Incomplete'.

  • Only after submission will the template move to the 'Under Review' stage and enter the review queue of the market.

  • Once the template is submitted to the marketplace, its name cannot be edited permanently.


Syncing Changes   

Data is synced across three data centres (US, IN, EU) to a common location.

  • Click the Sync Details button to view the synchronization process.

  • Sync status is displayed in a pop-up window.
  • Failed syncs can be retried individually.



Review Process

  • Once submitted, the template moves to a central review area and its status changes to Under Review.
  • Designated reviewers from the relevant service team will evaluate the template. They can approve and publish it to the gallery or reject it.
  • You can track the review process through the partner console.
  • Templates can be previewed and installed by users.
  • Global installation is enabled only after final review and publication.
 

Template Versions  

  • After publishing, the template is assigned a version. If you edit and republish, it will be updated to a new version.


Post-Publication Actions   

Accessing and Installing Templates

  • User can install and use these templates through their Qntrl portal by navigating to the Marketplace section in the settings or directly from Qntrl Marketplace portal.
  • Click on the desired template to view its details and associated components.
  • Click Install to create a new circuit based on the template.
  • The circuit will be installed, and the circuit page will open in builder view.
  • In the Builder view, you can view and edit the circuit and its associated components.

  • Installing a template always creates a new circuit.

  • There's currently no option to upgrade or uninstall installed templates.

  • Each template installation results in a separate circuit, without affecting existing ones.







    • Related Articles

    • Build Extensions using Qntrl Studio

      Extension is a software module that can be installed to expand the functionality of Qntrl. It could be a feature enhancement, third-party integration, or any such value addition. Qntrl Marketplace hosts a wide range of extensions which can be ...

    • Build Board Templates using Qntrl Studio

      A Board is a key component in Qntrl from which each process’s automation flow begins. It comprises elements which can create forms to record user inputs, design blueprints to outline the flow of processes, and finally, review the process and publish ...

    • Settings in Qntrl Studio

      Create and track extensions with the help of features like Functions, Executions, Connections, Developers, and Audit Logs. This helps create more advanced extensions and contributes to a versatile workspace in Qntrl Marketplace. Developers Add users ...

    • Customize Email Templates

      Overview of email templates Communication is key in any organization. It often becomes a challenge to track the myriad of ongoing tasks in a huge team. Qntrl helps your team overcome this challenge and stay informed via notifications and emails. ...

    • Build Boards

      Qntrl lets users create a board in three different ways: Start from scratch : This is a quick create option where a default process (Form and Blueprint) will be created with default fields in the forms and a simple blueprint, which can be customized ...

    You are currently viewing the help articles of Qntrl 3.0. If you are still using our older version and require guidance with it, Click here.