4870
GSF 2.1 Release Notes
The Geospatial Services Framework (GSF) provides geospatial processing as a web service. It is a component-based system that runs on Node.js(R) and uses a Redis(R) datastore.
Node.js(R) is a JavaScript runtime built on Chrome's V8 JavaScript engine. Node.js(R) uses an event-driven, non-blocking I/O model that makes it lightweight and efficient.
Redis(R) is an open source (BSD licensed), in-memory data structure store, used as database, cache and message broker.
This help article contains release notes for GSF 2.1. It includes features that were added since the last release. See the following sections:
System Requirements
| Platform |
Hardware |
Operating System |
Supported Versions |
| Windows |
Intel/AMD 64-bit |
Windows |
7 SP1, 8, 10, Server 2012, Server 2016 |
| Linux |
Intel/AMD 64-bit |
Linux |
Kernel 2.6.32, glibc 2.12 |
Supported versions indicate that GSF was tested on that version. You can install and run GSF on other versions that are binary-compatible with those listed.
Additional Requirements:
- To operate, GSF requires Node.js(R) and Redis(R).
- In addition, IDL 8.5.2/ENVI 5.3SP2 or later is required to run the IDL/ENVI Service Engines.
- On Linux, GSF 2.1 was tested with Node.js(R) 5.12.0, Redis(R) 3.2.3, and IDL 8.6/ENVI 5.4.
- On Windows, GSF 2.1 was tested with Node.js(R) 5.12.0, Redis(R) 3.2.100, and IDL 8.6/ENVI 5.4.
New Features in ENVI
-
Support for ENVI 5.4/IDL 8.6
IDL and ENVI Service Engines included with GSF now support the new licensing model introduced with ENVI 5.4/IDL 8.6. The engines now run with specific engine licenses and no longer require a full IDL/ENVI development licenses.
By default, in GSF 2.1, the IDL/ENVI Service Engines require that IDL/ENVITasks are deployed with save files (.sav). If your server environment has access to an IDL development license and you wish to run IDL/ENVITasks with procedure files (.pro), update the engine configuration to pass the --compile flag through the new "engineArgs" option.
The IDL/ENVI Services Engines have a new "env" option to allow environment variable configuration on a per-engine basis. This can be useful if you have an IDL/ENVI library of routines that you want accessible by all IDL/ENVI Tasks, set the IDL_PATH environment variable to the folder containing the library of routines.
-
Job Cancelation
It is now possible to stop a running job through the Job Console.
In addition, a REST endpoint has been provided for job cancelation. See the ese-request-handler module help for details: http://localhost:9191/help/ese-request-handler/#/help/ese-request-handler/api/index.html
-
Job Console
Start Time, End Time, and Wait Time have been added as columns to the job console.
Choices made by the user on column visibility are stored and used in future client sessions.
-
New JavaScript Engine
Create tasks written in JavaScript.
Create a metatask to allow for a "workflow" of tasks to be managed by the server. See the Custom Metatasks Tutorial for details: http://localhost:9191/help/#/help/tutorials/metatasks.html
-
Task Catalog Support
A Task Catalog is a mechanism for cataloging TaskInfo and ServiceDefinition objects so the server doesn't have to query the Engines every time a client wants to know which tasks are available.
Users can create modules implementing the TaskCatalog interface to control how task information is gathered and when. A gsf-basic-task-catalog module is provided with GSF 2.1. See the module help for details: http://localhost:9191/help/gsf-basic-task-catalog/#/help/gsf-basic-task-catalog/home.html
-
Worker Configuration
It is now possible to route jobs to individual workers. This is helpful when specific services/tasks require specific machine resources or licenses.
See the Custom Licensing Tutorial for details: http://localhost:9191/help/#/help/tutorials/custom-licensing.html
-
Service Route Mapping
A gsf-service-route-mapper is now provided to map jobs from a specific service to a route. This is helpful when a specific service is not available on all nodes within a cluster.
See the module help for details: http://localhost:9191/help/gsf-service-route-mapper/#/help/gsf-service-route-mapper/home.html
-
Configuration Command Line Utility
A new command line utility for updating the server configuration. It also provides configuration backups!
This utility is recommended if deploying custom modules to GSF installations. Run the following command from the gsfxx folder to access the utility and it's help.
$ node updateConfig.js --help
-
Service Control
The GSF service can now be controlled through a command line utility. Run the following command from the gsfxx folder to access the utility and it's help.
$ node service.js --help
Fixed Issues
- GSF-25 If ese-request-handler REST requests for task information fail, user should receive error generated by engine
- GSF-24 Job Console error message shows newline characters instead of creating newline
- GSF-20 Parameter Names shouldn't have to be specified twice in the TaskInfo object
- GSF-19 ese-request-handler REST services endpoint not functioning with only an IDL install on the system (no ENVI install)
- GSF-17 gsf-amazon-s3-parameter-mapper can't configure a custom certificate bundle
- GSF-14 ese-request-handler returns only raw value if output parameter of type boolean is false
- GSF-12 gsf-amazon-s3-parameter-mapper sets the credentials by default to YourSecretKey which causes a permissions error
- GSF-11 ese-request-handler only uses reverse translated parameters from the envi-data-parameter-mapper, should use translation from any parameter mapper
- GSF-10 gsf-amazon-s3-workspace-manager returns files from jobs not requested
- GSF-9 .NET 4 must be installed so that Redis will install
- GSF-8 Clear error message should be returned when idl-service-engine has been misconfigured
- GSF-6 Job Console doesn't export users correctly
- GSF-5 Job fails to download output data from previous job when using gsf-amazon-s3-workspace-manager
- GSF-4 When workspace configured to a folder with Extended Ascii or Multi-Byte characters, output in client is incorrect
2.0 / 2016-04-08
The first release of GSF!