Scenario templates
Prev  Scenarios  Next

Scenario templates

What is a template?

Templates are predefined scenarios that you can expand and customize to create new scenarios. You can then share these with friends and colleagues.

Benefits of templates

  • Creating your scenarios becomes much easier. Instead of starting each new scenario from scratch, you can use a template as a foundation to expand upon.

  • Share your templates with anyone.

  • Save your templates for future use.

Who can create templates?

Using templates

You can find the Templates tab under your Team in the left-hand menu.

templates_1.png

Search for templates using the search bar in the top-right corner.

Template types
Public templates

A collection of templates created by Axelor Connect and our partners that demonstrate many common integrations. Anyone can use them to create their own scenarios.

You can send your published templates for approval to make them available in the public templates library.

Team templates

Team templates are those you and your team create. From the team templates screen you can create, customize, save, and share your templates with others.

[Note] Note

Team templates can be private or published.

  • Private

    Visible only to the team. Cannot be shared.

  • Published

    Visible to anyone with the shareable link.

Creating a scenario from a template
Using a public template

Axelor Connect creates and maintains a library of templates. You can find it by clicking Templates on the left sidebar and looking under the Public tab.

  1. Go to Templates > Public and click the template you want to use.

    templatesSidebar.png
  2. Choose whether you want a guided setup experience or simply a new scenario from the template.

    1. Guided setup - This option includes on-screen prompts to help you configure the template for your needs.

      1. Click Start guided setup.

        templatesGuidedSetup.png
      2. Follow the on-screen prompts to configure your scenario.

        templateModuleGuide.png
      3. Optional Click Skip guided setup at any time to end the guided setup. You still need to configure all modules but on-screen prompts no longer appear.

        templateSkip.png
    2. New scenario - This option instantly creates a new scenario in your organization from the template. You need to manually configure module settings, such as Connections.

      1. Click Create a new scenario from template.

        templatesNewScenario.png
      2. Edit your new scenario the same way as any scenario.

  3. Name and save your scenario.

  4. Test and schedule your new scenario.

Using a team template
  1. Go

  2. Select the template you want to use.

  3. Click Options.

  4. Click Create scenario.

    templates_2.png
  5. Choose which organization you want to create your scenario for.

  6. Click Save.

    You are now ready to edit your scenario.

Creating templates

  1. Click Templates in the left-hand menu.

  2. Click Create a new template.

    templates_3.png

The scenario editor appears. Use the editor to create templates the same way you create regular scenarios. See our guide on editing a scenario to learn more.

Renaming templates

When you create a new template, Axelor Connect names it “New Template” by default.

Edit the name by clicking the title displayed at the top of the page, or follow the steps below:

  1. Click Options in the top-right corner.

  2. Click Rename.

[Note] Note

You can only rename private templates.

Adding a description

You can include a description of your template to inform others of its functionality.

  1. Click the gear icon in the Controls panel below your template.

    templates_4.png
  2. Add your description in the box provided (Max. 240 characters).

  3. Click Save.

Your description appears in the template information panel.

templates_6.png
Editing templates

See the scenario editor guide for more detail.

[Note] Note

You can only edit your private templates.

You cannot edit any published templates.

Templates cannot start with a webhook.

Deleting templates

You can delete any of your private or published templates.

  • From your template list, click Delete to the right of any template.

    templates_7.png
  • From a template, click Options in the top-right corner, then click Delete.

Sharing templates

Publishing

To share your template with others you must first ‘publish’ it.

To publish a template:

  1. Choose which private template you want to share.

  2. Click Publish in the top right corner.

[Note] Note

You cannot edit a published template, but you can still access and edit the private version.

If you re-edit and wish to publish again, follow the steps above. The new published template overwrites the previous one.

Share a public link

Once you publish your template you can share it with others.

Click Share public link in the top-right corner to copy the link to your clipboard.

[Note] Note

Template recipients cannot change or clone the template.

Requesting approval

You can send your published templates for approval to make them available in the public templates library.

  • Click Request approval in the top-right corner.

The button will now read “Approval pending”.

A Axelor Connect administrator reviews your template for public use. After approval, Axelor Connect adds your template to the public templates library.

[Note] Note

If your template contains a custom app, we can not add the template to the public library. You can still share the template using the public link.

Previous Next
Copyright © 2005-2024 Axelor. All Rights Reserved. White label documentation
  • What is a template?
  • Benefits of templates
  • Who can create templates?
  • Using templates
    • Template types
      • Public templates
      • Team templates
    • Creating a scenario from a template
      • Using a public template
      • Using a team template
  • Creating templates
    • Renaming templates
    • Adding a description
    • Editing templates
    • Deleting templates
  • Sharing templates
    • Publishing
    • Share a public link
    • Requesting approval

Prev  Up  Next
How to restore a previous scenario version  Home  Keyboard shortcuts