Validate the Formula File and System Parameter "Exact Formula Match"

The system validates the formula against the recipe when a formula is used at runtime (i.e., when initializing a batch). If there is any conflict, an error message is displayed. For example, if the process variable's value is not within the high and low limit, an error message is shown.

The System Parameter "Exact Formula Match" affects how the validation is performed. If this parameter is set to 0, the formula inputs/outputs and process variables in the formula can be a subset of those in the recipe. If this parameter is set to 1, the formula inputs/outputs and process variables in the formula must exactly match those in the recipe. The default value is 1.

Technically, the validation logic works as follows:

• If this parameter is set to 0:

  • The inputs, outputs, and process variables in the formula must exist in the recipe.

  • The phase inputs and outputs in the formula must exist in the recipe.

  • If the phase inputs or outputs are included in the xml/csv file, the referenced formula inputs or outputs must be included, as well.

• If this parameter is set to 1:

  • The inputs, outputs, and process variables in the formula and recipe must exactly match.

  • The phase inputs and outputs in the formula and recipe must exactly match.

Additionally, the system validates the following for the CSV format formula file:

• The header row is validated.

• The number of columns is validated where extra columns will be ignored.

• The first data row must contain a valid recipe ID.

• For values such that comma is allowed, they must be enclosed in double quotes.

  Note: During validation, the application does not enforce that the recipe and the formula must have the same version number. As long as the formula data is valid against the recipe, it can be imported to that recipe.

The following example illustrates a sample exported CSV formula file:

ID,ParameterType,ValueString,DataInterpretation,DataType,
UnitOfMeasure,EnumerationSetID,MaterialID,OverrideMaterial,Total,ToleranceType,HighDeviation,LowDeviation,Name,
ProcessVariableType,ParentInstance,Phase,PhaseParameter,
Label,FormulaParameterID, RecipeID,RecipeVersion

1,ProcessInput,15.000000,Equation,double,"kg",,"Flour",,
True,General,20,10,,,,,,,,CookieDough,3

2,ProcessInput,68.000000,Equation,double,"kg",,"Lemon",
"Chocolate",True,General,100,50,,,,,,,,,

3,ProcessInput,20.000000,Equation,double,"kg",,"Sugar",,
True,General,30,10,,,,,,,,,

4,ProcessOutput,100.000000,Equation,double,"kg",,
"Dough",,True,,,,,,,,,,,,

5,ProcessParameter,"Medium",Constant,Enumeration,,
"MIXSPEED",,,,General,0,0,"Speed",Process,Mixer,Mix,
Speed,4,,,

6,ProcessParameter,"High",Constant,Enumeration,,
"MIXSPEED",,,,General,0,0,"Speed",Process,Mixer,Mix,
Speed,8,,,

7,ProcessParameter,"40.000000",Constant,double,,,,,,
General,0,0,"Time",Process,Mixer,Mix,Time,4,,,

8,ProcessParameter,"20.000000",Constant,double,,,,,,
General,0,0,"Time",Process,Mixer,Mix,Time,8,,,

9,ProcessInput,15.000000,,double,,,,,,,,,"Weight",
Process,Mixers,ManualAdd,,3,1,,

10,ProcessInput,20.000000,,double,,,,,,,,,"Weight",
Process,Mixers,ManualAdd,,5,3,,

11,ProcessInput,34.000000,,double,,,,,,,,," Weight",
Process,Mixer, ManualAdd,,4,2,,

12,ProcessInput,34.000000,,double,,,,,,,,," Weight",
Process,Mixer, ManualAdd,,8,2,,

13,ProcessOutput,100.000000,,double,,,,,,,,,"Weight",
Transfer,MixHold,Transfer,,13,3,,

Note:

• In the second row, the RecipeID is mandatory. However, it is not required in the remaining rows.

• In the second row, the RecipeVersion is specified. However, it is optional.

• In the row with ID 2, OverrideMaterialID is defined. During runtime, the ingredient Chocolate will replace Lemon in the recipe. However, it is optional.

• Rows with ID (1,2,3,4) illustrate some formula inputs and output. There are four of them here, but you could have zero or as many as needed.

• Rows with ID (9,10, 11,12,13) illustrate some phase inputs and outputs, which have the Label and FormulaParameterID defined. There are five of them here, but you could have zero or as many as needed.

• The phase input/output and its referenced formula input/output must be included at the same time. For example, row with ID 9 references FormulaParameterID 1. Row with ID 1 must be included if row with ID 9 is included.

• A double quote (" ") is required to enclose the value if the comma is a valid character of the value.

• Only a comma is accepted as the separator.