Beckon's Template Files

Overview

Template Files in Beckon can be used for bulk editing a dimension, dimension instance, metric and formula and can be saved as either a .csv or .xlsx file. This article describes the use for those files and provides a general overview of them in Beckon.

Information

Beckon's Templates allow users to:

  • Bulk edit
  • Bulk create

The following templates can be used in Beckon:

Dimension Template

A Dimension Template can be used for editing or creating dimensions. This change will affect the dimensions in the Dimensions tab.

download.png

To create a Dimension Template file, create a .csv or .xlsx file with the following headers:

  • %Template:DimensionTemplate allows Beckon to identify that the file is a dimension template file.
  • DIMENSION is the ID for the particular dimension. This field can not be modified later.
  • DIMENSION_NAME is the display name in the app for DIMENSION. This field can later be modified.
  • PARENT is an optional field and only be used if there is a parent dimension in the account.
  • PRIORITY determines the hierarchy of the dimension in the dimension dropdown.

Screen_Shot_2018-02-05_at_7.10.58_PM.png

Once completed, the file can be imported on the files' page. Once successfully imported, the updates will reflect on the Dimensions tab.

Dimension Instance Template

The Dimension Instance Template can be used for creating and editing dimension instances. This change will affect the instances that belong to a dimension.

download-1.png

Similar to the Dimension Template, create a file with the following headers:

Screen_Shot_2018-02-05_at_7.22.59_PM.png

  • %Template:DimensionInstanceTemplate allows Beckon to identify that the file is a dimension instance template file.
  • DIMENSION_INSTANCE is the ID for the particular dimension instance. This field can not be modified later.
  • DIMENSION_INSTANCE_NAME is the display name in the app for DIMENSION_INSTANCE. This field can later be modified.
  • PARENT is an optional field and only be used if there is a parent dimension in the account.
  • TOP_LEVEL_DIMENSION is the DIMENSION that the dimension instance belongs to.
  • DIMENSION_INSTANCE_IMAGE is used for associating an image to a dimension instance.

Metric Template 

The Metric Template can be used for adding new metrics into the account or for bulk editing metrics that already exist in Beckon.

Screen_Shot_2018-04-12_at_1.23.19_PM.png

  • %Template:MetricTemplate allows Beckon to identify that the file is a Metric Template file.
  • CHANNEL is the appropriate channel for the metric. Similar to the ones found in the dropdown when creating a new metric.
  • METRIC is the ID for the particular metric. This field can not be modified later.
  • METRIC_NAME is the display name in the app for METRIC. This field can later be modified.
  • METRIC_DESCRIPTION is an optional field and can be used for describing the metric.
  • UNIT_TYPE is the format of the metric (DECIMAL, CURRENCY, PERCENTAGE).
  • SERIES_TYPE is either ABSOLUTE (cumulative data) or DELTA (incremental data).
  • FREQUENCY is the granularity of the data.
  • METRIC_GOAL is either MAXIMIZE or MINIMIZE.

Comments

0 comments

Article is closed for comments.