StartENVIServer Task

This task starts an ENVI Server that will be used to run ENVI tasks in the background, in parallel, and across multiple machines.

To start an ENVI Server without having to start ENVI or IDL first, see Start an ENVI Server from the Command Line.

Syntax

Result = ENVITask('StartENVIServer ')

Input parameters (Set, Get): CLEAN_SESSION , ENGINE, INSTALL_SERVICE, LOG_LEVEL, PERSISTENT, PORT, PUBLIC, USE_HTTPS, WORKERS, WORKSPACE

Output parameters (Get only): SERVER

Parameters marked as "Set" are those that you can set to specific values. You can also retrieve their current values any time. Parameters marked as "Get" are those whose values you can retrieve but not set.

Input Parameters

CLEAN_SESSION (optional)

Set this parameter to true to start the engine with a fresh sandbox and default preferences. If false, the engine will run using the current ENVI configuration and customizations.

ENGINE (optional)

Specify one of the following processing engines to use:

IDL Runtime: (default) Executes pre-compiled code.
IDL: Allows source code compilation. This option requires a valid IDL license.

INSTALL_SERVICE (optional)

Set this parameter if you want to install the server as a Service.

LOG_LEVEL (optional)

Specify the minimum severity of log messages written to both stdout and the log file with one of the following:

Critical
Error
Warning
Info
Debug

PERSISTENT (optional)

Set this parameter if you want the server to continue running after ENVI closes. This parameter is ignored if the INSTALL_SERVICE parameter is set.

PORT (optional)

Specify the port the server listen on. The default is 9191.

PUBLIC (optional)

Set this parameter to true if you want your server to be accessible from other machines in your network. If false, only your machine will be able to submit jobs to it.

USE_HTTPS (optional)

Set this parameter to use HTTPS instead of HTTP, which will encrypt communications with the server.

WORKERS (optional)

Specify the number of workers that can run in parallel. Additional jobs will wait in the queue until one of the workers becomes available. Use -1 to indicate there is no limit in the number of workers that can run in parallel. If set to 0, each job will be run one by one. This will block the main ENVI process, meaning it could take many hours - or even days - to process large jobs.