Template

Configuration for a flowfile template; templates can be used to generate flow files.

Properties

Field	Type	Default	Required	Description
annotations	CommonAnnotations	map[]
artifacts	array (Artifact)			A list of artifacts to be copied after generating the flow file.
description	string			A description of the template. This is used to describe what the template generates and when to reach for it, and is shown when browsing templates.
form	array (Field)	[]		Form fields to be displayed to the user when generating a flow file from a template. The form will be rendered first, and the user's input can be used to render the template.
postRun	array (TemplateRefConfig)			A list of exec executables to run after generating the flow file.
preRun	array (TemplateRefConfig)			A list of exec executables to run before generating the flow file.
template	string		Yes	The flow file template to generate. The template must be a valid flow file after rendering.

Definitions

Artifact

File source and destination configuration. Go templating from form data is supported in all fields.

Type: object

Field	Type	Default	Required	Description
asTemplate	boolean	false		If true, the artifact will be copied as a template file. The file will be rendered using Go templating from the form data. Expr language functions are available for use in the template.
dstDir	string			The directory to copy the file to. If not set, the file will be copied to the root of the flow file directory. The directory will be created if it does not exist.
dstName	string			The name of the file to copy to. If not set, the file will be copied with the same name.
if	string			An expression that determines whether the the artifact should be copied, using the Expr language syntax. The expression is evaluated at runtime and must resolve to a boolean value. If the condition is not met, the artifact will not be copied. The expression has access to OS/architecture information (os, arch), environment variables (env), form input (form), and context information (name, workspace, directory, etc.). See the flow documentation for more information.
srcDir	string			The directory to copy the file from. If not set, the file will be copied from the directory of the template file.
srcName	string			The name of the file to copy.

CommonAnnotations

A map of arbitrary string key/value metadata attached to the object. Annotations are intended for use by external tools and integrations to store system metadata. Unlike tags, annotations are not used for filtering or display in the Flow UI - treat them as opaque state. Keys should be namespaced (e.g. my-tool.example.com/state) to avoid collisions between tools.

Type: map (string -> string)

ExecutableRef

A reference to an executable. The format is <verb> <workspace>/<namespace>:<executable name>. For example, exec ws/ns:my-workflow.

• If the workspace is not specified, the current workspace will be used.
• If the namespace is not specified, the current namespace will be used.
• Excluding the name will reference the executable with a matching verb but an unspecified name and namespace (e.g. exec ws or simply exec).

Type: string

Field

A field to be displayed to the user when generating a flow file from a template. Type: object

Field	Type	Default	Required	Description
default	string			The default value to use if a value is not set.
description	string			A description of the field.
group	integer	0		The group to display the field in. Fields with the same group will be displayed together.
key	string		Yes	The key to associate the data with. This is used as the key in the template data map.
prompt	string		Yes	A prompt to be displayed to the user when collecting an input value.
required	boolean	false		If true, a value must be set. If false, the default value will be used if a value is not set.
type	string	text		The type of input field to display.
validate	string			A regular expression to validate the input value against.

TemplateRefConfig

Configuration for a template executable. Type: object

Field	Type	Default	Required	Description
args	array (string)	[]		Arguments to pass to the executable.
cmd	string			The command to execute. One of cmd or ref must be set.
if	string			An expression that determines whether the executable should be run, using the Expr language syntax. The expression is evaluated at runtime and must resolve to a boolean value. If the condition is not met, the executable will be skipped. The expression has access to OS/architecture information (os, arch), environment variables (env), form input (form), and context information (name, workspace, directory, etc.). See the flow documentation for more information.
ref	ExecutableRef			A reference to another executable to run in serial. One of cmd or ref must be set.