>  Docs Center  >  ENVI API  >  Processing  >  ENVIRegisterVectorWithGeoServerTask

ENVIRegisterVectorWithGeoServerTask

ENVIRegisterVectorWithGeoServerTask

This task registers a vector with an OGC server so that it can be rendered on a web client. It does not upload vectors to the server, nor does it allow any editing or data manipulation. GeoServer must be able to access the same file system as this task.

Instead of setting keywords, you can use the GeoServer Configuration Template to define connection details. This file is in JSON format. Specify the connection details in this file, then save it as geoserver_conf.json and place it in the resource/server folder of your ENVI installation path. If you choose to set keywords to define the connection details, those settings will override any values defined in the configuration file.

Syntax


Result = ENVITask('RegisterVectorWithGeoServer')

Input properties (Set, Get): HOST, INPUT_VECTOR, PASSWORD, PORT, PROTOCOL, PROXY_HOST, PROXY_PORT, PROXY_PROTOCOL, USERNAME, WORKSPACE

Output properties (Get only): OUTPUT_FEATURE

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

Methods


This task inherits the following methods from ENVITask:

AddParameter

Execute

Parameter

ParameterNames

RemoveParameter

Properties


This task inherits the following properties from ENVITask:

COMMUTE_ON_DOWNSAMPLE

COMMUTE_ON_SUBSET

DESCRIPTION

DISPLAY_NAME

NAME

REVISION

TAGS

This task also contains the following properties:

HOST (optional)

Specify a string with the hostname for GeoServer communications. The host can be a machine name or IP address.

INPUT_VECTOR (required)

Specify a vector to register with GeoServer. Shapefiles are the only supported vector types at this time.

OUTPUT_FEATURE

The name of the feature coverage that will be created. The returned asset is assigned a unique layer name.

PASSWORD (optional)

Specify a string with the password if GeoServer requires credentials.

PORT (optional)

Specify an integer port number for GeoServer communications.

PROTOCOL (optional)

Specify a string with the protocol for GeoServer communications. Examples include 'http' and 'https'.

PROXY_HOST (optional)

Specify the host name returned to the client. The client use this name when forming OGC requests. A proxy is an upstream server that acts as a router for all requests coming into or out of a server.

PROXY_PORT (optional)

Specify a string with the port returned to the client. The client use this port when forming OGC requests.

PROXY_PROTOCOL (optional)

Specify the protocol returned to the client. The client use this protocol when forming OGC requests. Examples include 'http' and 'https'.

USERNAME (optional)

Specify a string with the username if GeoServer requires credentials.

WORKSPACE (optional)

Specify a string with the workspace for GeoServer registration. If you do not define a workspace, this task will create one called envi. The workspace name cannot contain spaces.

Version History


ENVI 5.3, Service Pack 1

Introduced

API Version


3.3

See Also


ENVITask, ENVITask::Parameter, ENVIVector, ENVIRegisterRasterWithGeoServerTask



© 2019 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us