BatchFormula Object

Type name

BatchFormula

Kind

Definition

Required module

Batch

Root object

BatchFormulaRoot (via system.mes.batch.formula.getRootFormulaLink())

Parent

BatchFormulaClass or BatchFormulaRoot

Single parent only (SINGLE_PARENT). If none is provided at create time, the root formula object is assigned automatically.

Children

(none)

Formulas are leaf objects. Use Batch Formula Class objects to organize formulas in a folder tree.

Name

getName() / setName(name)

String

Unique among sibling formulas under the same parent class or root.

Description

getDescription() / setDescription(description)

String

Optional description.

UUID

getUUID()

String

Stable object identifier.

Enabled

isEnabled() / setEnabled(value)

Boolean

Whether the object is active. Removal disables the object rather than deleting it.

Master Recipe Reference

getMasterRefUUID() / setMasterRefUUID(uuid)

String

(required)

UUID of the Batch Master Recipe this formula is based on. Set automatically when the formula is created from a recipe link.

Formula Valid

isFormulaValid() / setFormulaValid(value)

Boolean

False

Whether the formula passed validation. Updated when saved through saveFormula() or when validateFormula() runs. Invalid formulas cannot be used to queue a batch.

State

getState() / setState(state)

String

Inactive

Lifecycle state from the Formula_State enum. Accepted values: Production Ready, Preproduction, Inactive.

State UUID

getStateUUID()

String

(enum UUID)

Raw enum option UUID stored in the database. Prefer getState() / setState() in scripts.

User Version

getUserVersion() / setUserVersion(version)

Integer

1

Formula version counter. Incremented automatically on save when the saved version is equal to or greater than the in-memory version. Reset to 1 when a formula is copied or imported.

Recipe User Version

getRecipeUserVersion() / setRecipeUserVersion(version)

Integer

(from recipe)

User version of the master recipe the formula was last synchronized with. When this differs from the current recipe version, the formula is stale until synced.

Scale

getScale() / setScale(scale)

Double

1.0

Batch scale factor applied to the formula.

Quantity

getQuantity() / setQuantity(quantity)

Double

1.0

Batch quantity for the formula.

validateFormula()

List of String

Runs validation and returns error messages. An empty list means the formula is valid. Does not persist changes.

isModified()

Boolean

Whether in-memory changes have not been saved.

asLink()

MESObjectLink

Lightweight link to this formula.

getParameters(includeMasterRecipeParameters)

List of BatchParameter

All parameters visible on this formula. Set includeMasterRecipeParameters to True to include recipe defaults not overridden on the formula. Items returned when includeMasterRecipeParameters is True are read-only views; changes to them do not persist.

getAllParameterProperties()

List of BatchFormulaParameterProperty

Complex property objects persisted on this formula.

getParameterValue(paramPath)

Object

Current effective parameter value (formula override or recipe default).

getParameterValueAsString(paramPath)

String

Parameter value formatted as a string.

getParameterMinValue(paramPath)

Object

Effective minimum value.

getParameterMinValueAsString(paramPath)

String

Minimum value as a string.

hasParameterMinValue(paramPath)

Boolean

Whether a minimum value is set.

getParameterMaxValue(paramPath)

Object

Effective maximum value.

getParameterMaxValueAsString(paramPath)

String

Maximum value as a string.

hasParameterMaxValue(paramPath)

Boolean

Whether a maximum value is set.

setParameterValue(paramPath, value)

None

Override the parameter value on this formula.

setParameterMinValue(paramPath, minValue)

None

Override the minimum value. Must remain within recipe constraints.

setParameterMaxValue(paramPath, maxValue)

None

Override the maximum value. Must remain within recipe constraints.

setParameterReadOnly(paramPath, readOnly)

None

Override whether the parameter is read-only in the Formula Manager.

setParameterVisible(paramPath, visible)

None

Override whether the parameter is visible in the Formula Manager.

setParameterSticky(paramPath, sticky)

None

Override whether the parameter value is sticky across batch runs.

resetParameter(paramPath)

None

Remove all formula overrides for the parameter and revert to recipe defaults.

Gateway scripts

system.mes.batch.formula.* and methods on loaded BatchFormula objects

Client / Designer scripts

Same module via RPC (BatchClientFormulaScript)

Perspective / engineering UI

Batch Formula Manager component (mes.batch.formulaManager)

Save through system.mes.saveMESObject()

Blocked: "Batch Formula must be saved through system.mes.batch.formula.saveFormula"

Remove/disable through generic MES remove

Blocked while enabled: "Batch Formula must be removed through system.mes.batch.formula.removeFormula"

createFormula with blank name

IllegalArgumentException: "Formula name is required"

createFormula without a valid master recipe link

Exception: "A valid recipe link is required to base the formula from"

createFormula with wrong link type

Exception: recipe link must reference BatchMasterRecipe

setState(invalidState)

IllegalArgumentException: state not found on Formula_State enum

Duplicate sibling name on save

Name is auto-adjusted to the next available sibling name

Referenced recipe disabled or invalid at validation

UnvalidatableFormulaException with recipe-specific message

Formula recipe version behind master recipe

Validation message: "Referenced recipe version is not the latest…" or StaleFormulaException when editing parameters on a stale formula

Invalid formula queued for batch

Blocked at runtime — formula must be valid (isFormulaValid() is True)

Import with duplicate UUID

Exception: UUID already taken

Import when referenced recipe missing

IllegalArgumentException: master recipe UUID does not exist