Initializing help system before first use

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, and the solution a single Xpress Executor component, that component will be used.
3. When no component name is given, and the solution contains multiple Executor components, an arbitrary one will be chosen.
4. 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
getstatus, executor_components

Parent Topic Subroutines

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.