In this article, we discuss how our Batch Configurations work to keep your data safe, and how to change or update them.
If you have questions or need help configuring your batch extensions, submit a technical support case.
What are batch configurations?
Batch Configurations allow us to track what your batch extension is allowed to output to your app. We introduced this so that you can lock down your app's use of our batch extensions to keep things secure.
Essentially, when we set up your extension from the Setup Wizard, we use the parameters we create in your formula as Batch Configuration Values—then, every time your batch extension is used for that specific configuration (each setup has a unique config), we cross-reference the Configuration Values to make sure your parameters aren't tampered with.
The main parameters we configure as Configuration Values are output parameters—any parameters that dictate where the data gets output to. For example, FAID controls where the file is put when Exact Forms Plus finishes—so it is locked behind a Configuration Value. You can add whatever parameters you would like to lock down, as shown in the next section.
How to change or update batch configurations
First, go to the Extensions Portal and open the Batch Portal. You'll see a list of your extensions that currently have Batch Configurations:
On the right of each row, select the button to view the configurations for the extension. In this example, we selected the Exact Forms Plus configuration:
Here you can see a few things:
You can navigate back to the extensions grid from this screen.
The first row is a concatenated version of each key—specifically the last 8 letters. You can select the copy button to the right of any key to copy the full key. Hovering over the key's text also shows a tooltip with the full key.
You can set a name for the configuration—it doesn't have a name by default. Select the Name cell to give the configuration a name or change it.
The button on the right of each row lets you view the values for a given configuration, as shown here:
Here you can see a few things:
The first column, Parameter Name, is the name of the parameter in your batch arguments. Case doesn't matter—AppID and appid are the same.
The second column, Allowed Value(s), is the list of values that are allowed to be processed by our batch. The yellow blank value denotes a completely blank output. You must have at least one allowed value—which defaults to blank if none is supplied.
The third column has a Modify button, and the column header has an Add New button—we discuss this later in this article.
There is no remove—once a parameter is added to this grid, it's always checked. If you need one of these parameters removed, submit a technical support case—though setting the parameter to accept blank suffices in most cases.
Select Modify or Add New to open a modal where you can set or change the parameter's values:
Select the + button next to Parameter Value(s) to add more allowed values. Select the - button to the right to remove allowed values.
You can set or change the parameter's name only when adding a new parameter.
Leaving the parameter value empty sets it to blank.
If you have questions about this process, submit a technical support case for more information.