Factory Plugin Configuration File Tags

A Measure Factory Plugin configuration file is defined using a factory-plugin tag with required and optional tags between open and closed braces { }.

The following table describes tags that can be used in a factory-plugin script.

Measure Factory Plugin Configuration File Tags

Tags	Examples	Notes
factory-plugin	factory-plugin { ... }	Defines the block for the factory plugin configuration file.
name	name "Concat"	Names the plugin. This name must be the same as the plugin folder name. The plugin is referenced in the `plugin` block of the factory configuration file by this name. See Data Sets Tags.
description	description "Lists all the unique values for a string rule in a single string."	Describes the purpose of the plugin.
input	input "Input B" { column "Product" type="string" column "Weight" type="double" } plugin "Example" { input "Example A" { column "Order ID" column "Product" column "Amount" } input "Example B" data-set="Products" { column "Product" column "Weight" } dimension "Order ID" plugin-rule "Total Weight" }	Names the input. The input name is mapped to a data set in the `plugin` block of the factory config. One or more inputs in the form of cBases are accepted. At run time, each input is accessible to the script as a cBase <input-name>.cbase. TIP: The plugin input can reference more than one data set as shown in the example. NOTE: In the example: For input "Example A," no data-set is specified, so this input uses the current data-set. For input "Example B," the Products data-set is specified.
data-set	input "Input1" data-set="Data Set 1" { ... }	Optional sub-tag for `input` to link the input to a data set with a different name.
column	column "Key" type="string"	Sub-tag for `input` to name the column. An input can have one or more columns. Be sure to specify the data type. Columns specified here are mapped to input columns or rules in the data set that is using the plugin.
rule	column "Input Column" rule="Rule for Input Column"	Optional sub-tag for `column` to indicate a rule with a different name in the source data set.
integrator-script	integrator-script "concat.int"	List one or more Integrator scripts for the plugin. These plugin Integrator scripts process data from input cBases and produce a single output cBase (output.cbase).
build-script	build-script "concat.build"	List one or more Spectre Build scripts for the plugin. Starting with version 7.1(13), a Spectre Build, rather than an Integrator script, can be used to supply data to the plugin.
dive-script	dive-script "my-dive.dive"	Lists a Spectre Dive script to supply data to the plugin.
output	output { ... }	Defines the output table that is joined into the original data set through a lookup.
dimension	dimension "Key"	Sub-tag for `output` that lists the output dimension to use for the lookup key. This allows the data to be joined back into the original data set. Multiple dimension/key tags are supported.
column	column "Concat" type="string"	Sub-tag for `output` that lists one or more (non-dimension) columns in the output, which contain the results of the plugin logic. Be sure to specify the data type. Columns specified here are mapped to new rules in the data set using the plugin.