Templates

4 min

A template is a JSON file containing configuration settings for a Litmus Edge device. The Templates page provides a centralized location for creating, organizing, and deploying these configurations.

You can access all templates available for an instance, an open company, or an open project here. You can create a template from an online edge device or upload a template from a file for an edge device after you have selected a company and opened a project. You can upload templates for:

an instance from the Admin Console.

a company from a file.

a project from a file or create one from an edge device.

Templates for edge devices can include devices, analytics, flows, and connectors. You can make selections for these categories when creating a template from an edge device.

Important: Before you can create a template, you must add one or more online edge devices in Edge Devices.

Three scopes are defined for a template:

Instance: All companies for this Litmus Edge Manager

Company: All projects for this company

Project: Only this project

You can select the scope for a template when you upload. For example, if you upload a template from the Company > Templates pane, the template is accessible to all the projects for that company. If you upload a template from a Project Templates pane, the template is accessible to only that project.

When you modify a template, you can modify the scope by selecting Company or Project in the Edit Template dialog box.

You can apply, modify, parameterize, download, and remove a template from the Templates pane.

Access Template UI

You can access company-level templates and project-level templates.

To access company-level templates:

Select a company. The Projects pane appears.

From the Navigation panel, select Templates. The Templates pane for the company appears.

To access project-level templates:

Select a company. The Projects pane appears.

From the Projects pane, click a project tile. The Dashboard pane appears for the project.

From the Navigation panel, select Templates. The Templates pane for the project appears.

Litmus Edge Manager

Refer to the following actions you can take on the Litmus Edge Manager User UI's Templates pane. The user interface below is for Litmus Edge Manager version 2.11.0 and later.

Templates [Company View]

Templates [Project View]

Action	Details
[1] Show filter	Search by Description.
[2] Create Template from device	At least one Edge device must be connected to use this option.
[3] Load template from file	Upload a Simple Template (.json) or Parameterized Template (.zip)
[4] Parameterize a Template	See link for details.
[5] Actions	(Project-View only) Apply Template: Apply a Parameterized Template Apply a Parameterized Template During Activation Edit Template: Template scope cannot be changed from Company to Project. Parameterize a Template Download Template: A .json file. When downloaded from the Company List Templates UI, the file contains information on all projects for the company. When downloaded from the Project List Templates UI, the file contains information on only the project. Delete: Deleting a template makes it unavailable for users to apply. Download the template prior to removal so it can be re-uploaded if necessary.
[6] View Template Statistics

Next Steps

Parameterize a Template

Apply a Parameterized Template

How-to guide: Apply a Parameterized Template During Activation