Learn about werum PAS-X batch template placeholders
- Last UpdatedFeb 06, 2025
- 5 minute read
Generic placeholders
Using event frames, you can associate a maximum of five items of equipment with a recipe level. To record equipment allocated at a particular recipe level, create one or more MODULEPATH entries in the corresponding recipe template. For example, the following template indicates that Unit1 and Unit2 are always allocated at the third (operation) level of the recipe, creating reference elements in the resulting event frames:
RECIPE[3].MODULEPATH=Unit1
RECIPE[3].MODULEPATH=Unit2
To record details about equipment allocated at a particular a recipe level, use the following placeholders:
-
[EQMODULEID] and [EQMODULEID1] to [EQMODULEID4]
-
[EQMODULEDESC] and [EQMODULEDESC1] to [EQMODULEDESC4]
-
[EQMODULETYPE] and [EQMODULETYPE1] to [EQMODULETYPE4]
The following example uses the preceding placeholders to create two reference elements for the operation-level event frame. [EQMODULEID] represents the first piece of equipment allocated for this level, and will be the primary reference element, [EQMODULEID1] represents the second piece of equipment allocated for this level.
RECIPE[3].MODULEPATH=[EQMODULEID]
RECIPE[3].MODULEPATH=[EQMODULEID1]
|
Placeholder |
Description |
|---|---|
|
[TIMESTAMP] |
Timestamp of the event. For PI events, this placeholder refers to the start or end of the destination time interval. For all other events, this placeholder contains the timestamp of the event. |
|
[TAG] |
Refers to a PI point. |
Parameter data placeholders
The placeholders in the following table are set when the [PARAMETER] placeholder contains one of the values listed in the right-hand column.
|
Placeholder |
Available in version |
Description |
Set when [PARAMETER]= |
|---|---|---|---|
|
[ACTUALQTY] |
3.1.4+ |
Actual quantity of material produced or consumed |
MATERIAL, TAKEOUT, YIELDDETERMINATION, STOCKCREATION |
|
[CHARGEBATCHID] |
3.1.4+ |
Charge BatchID (Applicable to output materials) |
MATERIAL |
|
[CONTAINERID] |
3.1.4+ |
Material’s container ID |
TAKEOUT |
|
[CRITICALITY] |
3.1.4+ |
Parameter criticality string value |
|
|
[CRITICALITYID] |
3.1.4+ |
Parameter criticality numeric value (Available only for PASX 3.1.4) |
|
|
[CRITICALITYDESC] |
3.1.7+ |
Description of the exception event Exception event may occur at any step of the recipe. |
|
|
[CRITICALITYSDESC] |
3.1.8+ |
Short description of the event |
|
|
[CRITICALITYDATE] |
3.1.7+ |
Date of the exception event |
|
|
[CRITICALITYSTATUS] |
3.1.7+ |
Status of the exception event |
|
|
[CRITICALITYTRANSDESC] |
3.1.8+ |
Translated description of the event |
|
|
[CRITICALITYTRANSSDESC] |
3.1.8+ |
Translated short description of the event |
|
|
[DATATYPE] |
All |
Data type of the events The possible values are NUMERIC, STRING, DATE (supported in versions prior to 3.1.4). |
|
|
[DEFINITIONLWB] |
All |
Parameter’s definition lower bound (Applicable to numeric events only) |
|
|
[DEFINITIONUPB] |
All |
Parameter’s definition upper bound (Applicable to numeric events only) |
|
|
[DESC] |
All |
Parameter description |
|
|
[ELEMENTMARKERDESC] |
3.1.8+ |
Element marker description |
|
|
[ELEMENTMARKERID] |
3.1.8+ |
Element marker ID |
|
|
[ELEMENTMARKERTYPE] |
3.1.8+ |
Element marker type |
|
|
[ELEMENTMARKERTYPEDESC] |
3.1.8+ |
Element marker type description |
|
|
[EXECUTIONINDEX] |
3.1.7+ |
For a substep in a specialized basic function, [EXECUTIONINDEX] is the order in which the substep was executed. |
|
|
[FUNCTION] |
3.1.8+ |
DCSBF historian value function (for example:, exact, max., min.) |
|
|
[FUNCTIONDESCRIPTION] |
3.1.7+ |
DCSBF historian value function description |
|
|
[FUNCTIONSDESC] |
3.1.8+ |
DCSBF historian value function short description |
|
|
[FUNCTIONTRANSDESC] |
3.1.8+ |
DCSBF historian value function translated description |
|
|
[FUNCTIONTRANSSDESC] |
3.1.8+ |
DCSBF historian value function translated short description |
|
|
[GMPREVALENT] |
3.1.8+ |
GMP-relevant data |
|
|
[HISTORIANENDTIME] |
3.1.8+ |
DCSBF Historian end time |
|
|
[HISTORIANSTARTTIME] |
3.1.8+ |
DCSBF Historian start time |
|
|
[INTERVENTIONLWB] |
All |
Parameter’s intervention lower bound (Applicable to numeric events only) |
|
|
[INTERVENTIONUPB] |
All |
Parameter’s intervention upper bound (Applicable to numeric events only) |
|
|
[LOTID] |
3.1.4+ |
Material lot ID |
MATERIAL, TAKEOUT, YIELDDETERMINATION, STOCKCREATION |
|
[MATERIALID] |
All |
Material ID |
MATERIAL, TAKEOUT, YIELDDETERMINATION, STOCKCREATION |
|
[MATERIALNAME] |
All |
Material description |
MATERIAL, TAKEOUT, YIELDDETERMINATION, STOCKCREATION |
|
[ORDERNETWORKID] |
3.1.8+ |
Order network ID / Ansatz number |
|
|
[PARAMETER] |
All |
Parameter name. Mapped to data source CustomId column. |
|
|
[POSITION] |
3.1.7+ |
The position of the data item in a basic function. |
|
|
[QUANTIFICATIONTYPE] |
All |
Quantification type |
|
|
[SEQUENCE] |
3.1.7+ |
If the item was edited, specifies the instance of the edit in the audit trail of edits. |
|
|
[SETVALUE] |
All |
The Set Value of the event. Applicable to numeric events only. |
|
|
[STEPID] |
3.1.7+ |
Basic function step ID |
|
|
[TARGETQTY] |
3.1.4+ |
Target quantity of material to be produced or consumed. |
MATERIAL, TAKEOUT, YIELDDETERMINATION, STOCKCREATION |
|
[TOLERANCELWB] |
All |
Parameter’s tolerance lower bound. Applicable to numeric events only. |
|
|
[TOLERANCEUPB] |
All |
Parameter’s tolerance upper bound. Applicable to numeric events only. |
|
|
[UOM] |
All |
The units of measure |
|
|
[USERID] |
Pre-3.1.4 and 3.1.7+ |
The UserYou ID for <3.1.4. Name of user for activities and basic functions in 3.1.7+. |
|
|
[VALUE] |
All |
The value of the event |
|
|
[WARNINGLWB] |
All |
Parameter’s warning lower bound. Applicable to numeric events only. |
|
|
[WARNINGUPB] |
All |
Parameter’s warning upper bound. Applicable to numeric events only. |
|
|
[UNITPROCEDURENUM] |
3.1.8+ |
Basic function's unit procedure number |
|
|
[UOMDESC] |
3.1.8+ |
Unit of measure description |
|
|
[UOMSDESC] |
3.1.8+ |
Unit of measure short description |
|
|
[UOMTRANSDESC] |
3.1.8+ |
Unit of measure translated description |
|
|
[UOMTRANSSDESC] |
3.1.8+ |
Unit of measure translated short description |
Batch-specific placeholders
|
Placeholder |
Available in version |
Description |
|---|---|---|
|
[AREADESC] |
3.1.4+ |
Area description (Available at and below basic operation level) |
|
[AREAID] |
3.1.4+ |
Area ID (Available at and below basic operation level) |
|
[BATCHID] |
3.1.4+ |
BatchID of manufacturing order (In version 3.1.4+, this is mapped to the WLTUSER.VFERTIGUNGSAUFTRAG.chargennr column.) |
|
[BATCHTIMESTAMP] |
All |
Manufacturing order start time |
|
[BFDESC] |
All |
Basic function description (Level = 3) |
|
[BFDESC{n}] |
All |
Basic function description (Level = 3+{n}, where {n} >=1 and {n} <=5) |
|
[BFID] |
All |
Basic function ID (Level = 3) |
|
[BFID{n}] |
All |
Basic function ID (Level = 3+{n}, where {n} >=1 and {n} <=5) |
|
[BFINDEX] |
3.1.4+ |
Basic function repeat index (Level = 3) |
|
[BFINDEX{n}] |
3.1.4+ |
Basic function repeat index (Level = 3+{n}, where {n} >=1 and {n} <=5) |
|
[BFLONGDESC] |
3.1.7+ |
Basic function long description |
|
[BFTYPE] |
All |
Basic function type (Level = 3) |
|
[BFTYPE{n}] |
All |
Basic function type (Level = 3+{n}, where {n} >=1 and {n} <=5) |
|
[BODESC] |
All |
Basic operation description |
|
[BOID] |
All |
Basic operation ID |
|
[BOLONGDESC] |
<3.1.4 and 3.1.7+ |
Basic operation long description |
|
[DCSBATCHID] |
3.1.4+ |
The batchID assigned to the BES batch by DCS basic function with type: [BFTYPE] = DCSRECIPE. |
|
[EXPIRATIONDATE] |
3.1.7+ |
Date of expiry for produced batches |
|
[FORMAT] |
3.1.8+ |
Format |
|
[HISTORIANTAGNAME] |
3.1.7+ |
Tagname (address) for DCSBF historian value |
|
[MATERIALQTY] |
All |
Output material quantity |
|
[MATERIALTYPE] |
All |
Output material type |
|
[MATERIALUOM] |
All |
Output material unit of measurements |
|
[MBRAREA] |
All |
MBR area |
|
[MBRDESC] |
All |
MBR description |
|
[MBRID] |
All |
MBR ID |
|
[MBRLONGDESC] |
All |
MBR long description |
|
[MBRSTATUS] |
All |
MBR status |
|
[MBRVALIDFROMDATE] |
3.1.7+ |
MBR valid from date |
|
[MBRVERSION] |
All |
MBR version |
|
[MBRVERSIONID] |
All |
MBR version ID |
|
[MODESC] |
3.1.4+ |
Manufacturing order description (Mapped to the WLTUSER.VFERTIGUNGSAUFTRAG.HVVARIANTE column.) |
|
[MOID] |
3.1.4+ |
Manufacturing Order ID (Mapped to the WLTUSER.VFERTIGUNGSAUFTRAG.FANR column.) |
|
[PRODUCTID] |
All |
Product ID. Synonym for [MATERIALID] |
|
[PRODUCTNAME] |
All |
Product name. Synonym for [MATERIALNAME] |
|
[SFOID] |
3.1.4+ |
Shop floor order ID (Mapped to the WLTUSER.VPRODUKTIONSAUFTRAG.PAKEY column.) |
|
[STATUS] |
All |
MO, BO and BF execution status.
|
|
[UNIQUEID] |
3.1.4+ |
Refers to the root unique key of the time interval object. For PASX version 3.1.4, this is mapped to the PASX.MANUFACTURINGORDER.ENTITYKEY data source property. |
|
[UNITID] |
All |
Workroom ID |
|
[UNITNAME] |
All |
Workroom name |
|
[UNITTYPE] |
3.1.4+ |
Workroom type |