Initializing help system before first use

Types

ModelExecution  : record
Record type representing information about the status of an execution in an Xpress Executor component
id  : text
The unique identifer of the execution
iscompleted  : boolean
Whether the execution has completed (successfully or with errors), or not (not started or currently executing)
hasinput  : boolean
Whether the execution has input data.
hasresult  : boolean
Whether the execution has result data.
isexecuting  : boolean
Whether the execution is currently running (not completed and not waiting to start)
executionnode  : text
The name of the gear on which the execution was executed
progress  : real
Progress value as set by the model being executed. Always 0 in local mode.
status  : string
Status of the execution. One of: EXECUTION_STATUS_OK, EXECUTION_STATUS_MATHERR, EXECUTION_STATUS_ERROR, EXECUTION_STATUS_IOERR, EXECUTION_STATUS_NIFCT, EXECUTION_STATUS_NULL, EXECUTION_STATUS_LICERR, EXECUTION_STATUS_STOP, EXECUTION_STATUS_LOAD_ERROR, EXECUTION_STATUS_INTERNAL_ERROR, EXECUTION_STATUS_NOT_COMPLETED
exitcode  : integer
The exit code of the model - the value passed to the Mosel exit() procedure, or 0. This will always be 0 when execution status is not EXECUTION_STATUS_OK.
creationtimestamp  : real
Timestamp when the execution was created, expressed as milliseconds since 1/1/1970 00:00 UTC
starttimestamp  : real
Timestamp when the execution started to execute, expressed as milliseconds since 1/1/1970 00:00 UTC, or 0 if unset
finishtimestamp  : real
Timestamp when the execution finished executing, expressed as milliseconds since 1/1/1970 00:00 UTC, or 0 if unset
modelparams  : dynamic array(ExecutorParamNames) of text
Additional model parameters used with this execution
MoselInstanceConfig  : record
Record type representing the Mosel instance (process) re-use policy configured in the Xpress Executor component
reuse  : boolean
If false, every execution will run in a separate Mosel process. If true, Xpress Executor will re-use a Mosel process after the execution completes, in some cases. In neither case will Xpress Executor run two executions in the same Mosel process at the same time.
maxexecutions  : integer
When reuse is true, the maximum number of executions that can be run using each Mosel process before it is automatically terminated.
reuseaftererror  : boolean
If reuse is true, flag indicating whether to allow a Mosel process to be re-used if the previous execution terminated with an error code.
reuseafternonzeroexit  : boolean
If reuse is true, flag indicating whether to allow a Mosel process to be re-used if the previous execution terminated with a non-zero exit code.
RepositoryStatus  : record
Record type representing a summary of the Xpress Executor component's repository status
componentid  : string
The ID string of the Xpress Executor DMP component
componentenv  : string
The component environment / lifecycle stage, either "design", "staging" or "production", or "LOCAL" in local mode.
numgears  : integer
The number of gears assigned to the DMP component in this environment
numexecutions  : integer
The total number of executions currently in the repository
numqueued  : integer
The number of executions in the repository that have not yet started to execute
numinprogress  : integer
The number of executions in the repository that are currently executing
numcompleted  : integer
The number of executions in the repository that have completed (either successfully or with errors)
binarydatasize  : integer
The approximate number of megabytes of binary data stored in the database
binarydataquota  : integer
The maximum number of megabytes of binary data that may be stored in the database
dbsize  : integer
The current size of the database, in megabytes
RunLogFragment  : record
Record type representing part of the run log of a model execution
id  : text
The ID of the execution in the Xpress Executor component
logversion  : text
A version string for the run log. When Executor restarts an execution from the beginning, the run log version will change.
firstlinenum  : integer
The index of the first line in this fragment of the run log, where the first line of the run log has index 1.
numavailablelines  : integer
The total number of lines in the run log.
lines  : list of text
Individual lines in this fragment of the run log.