esi-batch-config
Batch data configuration
Dependencies
library | version | inmation core library |
---|---|---|
dkjson |
5.3.0 |
yes |
debug |
5.3.0 |
yes |
esi-datetime |
1.0.0 |
yes |
esi-string |
1.0.0 |
yes |
esi-tool |
1.0.0 |
yes |
esi-subtype |
1.0.0 |
yes |
Available functions
All functions have to be called according to the ESI standard, using colons, e.g. lib:FUNCTIONNAME(params)
Documentation
SET_DEBUG_LOG_VAR(rec)
Set Log Variable
this method seems to have little effect, but should be included for compatibility reasons
SETTIMESTAMPOPTIONS(localtime,options,format,script)
Sets the options to convert timestamps
Modifies: self
SET_CUSTOM_ANALYTICS(batchEnd,operationEnd,phaseEnd,stepEnd,periodic)
Set the custom analytivs entry
CLEAR_OPERATION_CHARACTERISTICS()
Clear operation characteristics
replace the existing configTable for characteristics on operation level with an new empty one.
LOOKUP_EQ_STEP_NAME(opid,opname,phid,phname,id)
Look up the equipment step name for an id
NORMALIZE_OPERATION_DATA(opdata)
Normalize Operation Data
this adds operation id or operation name if they are configured but not given in the live data. Changes will be done to the opdata object directly
NORMALIZE_EQ_PHASE_DATA(opdata,phdata)
Normalize Equipment Phase Data
this adds eq. phase id or eq. phase name if they are configured but not given in the live data. Changes will be done to the phdata object directly
NORMALIZE_EQ_STEP_DATA(opdata,phdata,stdata)
Normalize Equipment Phase Data
this adds eq. step id or eq. step name if they are configured but not given in the live data. Changes will be done to the stdata object directly
CLEAR_EQ_PHASE_CHARACTERISTICS()
Clear eq. phase charachteristics
clear all entries in the configuration table for eq. phases
ADD_EQ_PHASE_CHARACTERISTICS(map,opAll,opId,opName,all,id,name)
Adds eq. phase characteristics
ADD_EQUIPMENT_FOR_EQ_PHASES(map)
Adds equipment for eq. phase
as well as the name or id of the phase. This can’t be used with all phases.
FIND_EQUIPMENT_FOR_EQ_PHASE(opIdInt,opName,epIdInt,epName)
Find equipment for a dedicated eq. phase
CLEAR_EQ_STEP_CHARACTERISTICS()
Clear eq. step characteristics
clear all entries in the configuration table for eq. steps
ADD_EQ_STEP_CHARACTERISTICS(map,opAll,opId,opName,epAll,epId,epName,all,id,name)
Adds eq. step characteristics
CLEAR_OPERATION_EVENTS()
Clear config table for the events of an operation
replace the configTable for events on operation level with a new and empty one
CLEAR_EQ_PHASE_EVENTS()
Clear config table for the events of an eq. phase
replace the configTable for events on eq phase level with a new and empty one
CLEAR_EQ_STEP_EVENTS()
Clear config table for the events of eq. steps
replace the configTable for events on eq. step level with a new and empty one
ADD_EQ_STEP_EVENTS(map,allOp,opId,opName,allPh,phid,phName,allSt,stId,stName)
Adds eq. step events
CLEAR_OPERATION_TRENDS()
Clear config table for the trends for operations
replace the configTable for trends on operation level with a new and empty one
CLEAR_EQ_PHASE_TRENDS()
Clear config table for the trends for eq. phases
replace the configTable for trends on eq. phase level with a new and empty one
CLEAR_EQ_STEP_TRENDS()
Clear config table for the trends for eq. steps
replace the configTable for trends on eq. step level with a new and empty one
ADD_EQ_STEP_TRENDS(map,allOp,opId,opName,allPh,phid,phName,allSt,stId,stName)
Adds eq. step trends
COLLECT_EQUIPMENT_PHASE_CHARACTERISTICS(opId,opName,id,name)
Collects all characteristics for a given eq. phase
COLLECT_EQUIPMENT_STEP_CHARACTERISTICS(opId,opName,epId,epName,id,name)
Collects all characteristics for a given eq. step