User-writable scheduling rule support functions

This section presents the user-writable functions that support the actual rules that are written. Each function is applicable to a specific Scheduler event such as the start of the scheduling run, the creation of a new load, or saving output. By writing a function, you can embellish the processing that is performed when the associated scheduling event occurs. The scheduling functions which are invoked when given events occur during the scheduling, are presented in alphabetical order. These events are model load, model save, create and terminate a load, create a batch or regular in-process load, setup determination, and batch forming. For assistance in writing a function and installing a rule, see Section 2. The support functions are presented in the table below.

Function Name Descriptioni
ucend Called during exit from Scheduler
ucfin1 Called just before summaries are written in finalization
ucfin2 Called just after summaries are written
ucini1 Called after global variables are read
ucini2 Called after all input is read
ucjbtra Called when an operation starts, finishes, gets interrupted or restarts after being interrupted
ucnwld Called when a load is being initialized
ucnwor Called when a job is being initialized
ucrlfb Called when a forming batch load is released for processing
ucrstra Called immediately before a resource changes to a new state
ucsini1 Called just before input is saved
ucsini2 Called just after input is saved
ucstib Called when a new batch load is created while reading load status
ucstil Called when a new load is created while reading load status
ucstring Can be used in expressions throughout the scheduling model
uctmld Called when a load is terminated
uctmor Called when a job is terminated
ucvalue Can be used in expressions throughout the scheduling model
ucwtsr Called from setup time rules to determine whether setup is necessary