Parameters
Last updated
Was this helpful?
Last updated
Was this helpful?
Parameters are powerful tools used to dynamically customize a workflow's results. Parameters can be strings, numbers, dates, boolean values and more. They can also be based off of values in tables/columns in your workflow.
To create your own parameter simply click on the plus circle in the top right corner of your canvas and fill out the form. Once the parameter is created, apply it to your workflow by including it in a formula in either the Filter or Edit Columns tools. Parameters will show up in the expression builder with the format {param!example_parameter}
.
There are two ways in which parameters can be used in an AuditBoard Analytics workflow: in the Expression Builder and through Templating.
Parameters can be used in the expression builder to create dynamic formulas. Simply start to type your parameter name into your formula and it will show up as a selectable option with the {x}
icon.
Parameters can also be used in your workflow outside of the Expression Builder. This is through AuditBoard Analytics's Templating tool. There are many different ways to use templating throughout AuditBoard Analytics workflows, so we'll walk through each one here.
Simply replace the section of your URL you would like to be dynamic with your parameter in the templating format. For example, if I wanted to import Baseball data that all had the same URLs with the exception of the name of the file (i.e. Batting, Pitching, etc), I could take this URL:
https://.../auditboard-analytics/datasets/Baseball/
Batting
and convert it to:
https://.../auditboard-analytics/datasets/Baseball/
{{baseball_filename}}
This new URL parameter would allow me to dynamically change the file I wanted to import based on my parameter value.
Other tools within AuditBoard Analytics Workflows also allow you use Templating while working with your data.
For each of these workflows, parameters can be used in any of the available text boxes. Use Templating to dynamically replace values, name or describe validations, or even label chart axes.
The expression builder can be found in the , , and tools and will always be represented with the {param!example_parameter}
format.
Templating can be used to create dynamic URLs in the tool.