executorinit
executorinit |
Purpose
Initialize the given Executor with the details of the indicated component configured in
executor_components, or in the same DMP solution.
Synopsis
procedure executorinit(exec:Executor)
procedure executorinit(exec:Executor, name:text)
procedure executorinit(exec:Executor, name:text, env:text)
Arguments
|
exec
|
The Executor to initialize
|
|
name
|
The component ID in the configuration JSON, or the component name when running within DMP. Within DMP, empty string to find any Xpress Executor component in the solution.
|
|
env
|
The component lifecycle stage ("DESIGN","STAGING" or "PRODUCTION") when the component name when running within DMP, empty string to use the lifecycle stage of the current component.
|
Example
executorinit( myexecutor )
if myexecutor.status<>EXECUTOR_OK then
writeln("Error returned by Executor: ",myexecutor.lasterror)
exit(1)
end-if
Further information
1. After calling, check the value of
exec.status for any errors.
2. When no component name is given, the first configured Xpress Executor component will be used.
3. When used from Xpress Insight running in DMP, this will initialize the Executor with the indicated Xpress Executor found within the solution containing the Insight component.
Related topics