Extension Types

Description

Some of the GIS services support extensions that enhance their capabilities. Each extension is made up of a specific set of properties that are defined for the extension type. You can enable an extension on a service by submitting a JSON representation of the its configuration as a part of the service definition in the Create Service operation.

This document defines the list of supported out-of-box extension types and all their properties.

Supported types:

NoteNote:

The following property sets must be passed in as value of the properties parameter in the JSON representation of the service.

KmlServer

{ 
	"dpi" : "", 
	"imageSize" : "" ,
	"linkDescription" : "" ,
	"linkName" : "" ,
	"message" : "" ,
	"minRefreshPeriod" : "" ,
	"featureLimit" : "" ,
	"useNetworkLinkControlTag" : "" ,
	"compatibilityMode" : "" ,
	"endPointURL" : "" ,
	"useDefaultSnippets" : "" 
}

FeatureServer

{ 
        "enableZDefaults" : "",
        
        "zDefaultValue" : "",
        
        "xssPreventionEnabled" : "true|false",
        // true: Block attribute edits containing potentially harmful content. This is the default. 
        // You can optionally fine tune this behavior with the xss* settings discussed below.
        // false: Do not attempt to block potentially harmful content.

        "xssPreventionRule": "input|inputOutput", 
        // input: Block attribute edits containing potentially harmful content. This is the default.
        // inputOutput: Block attribute edits containing potentially harmful content and 
        // encode query results containing potentially harmful content.
        
        "xssInputRule": "rejectInvalid|sanitizeInvalid",
        // rejectInvalid: When editing, block potentially harmful attribute edits. This is the default.
        // sanitizeInvalid: When editing, allow potentially harmful attribute edits but encode them so they are safe.
        
        "xssTrustedFields": {"Buildings": "Description,Name", "Parcels": "Name"}  
        //{"LayerA": "FieldA,FieldB", "LayerB": "FieldA"}
        // By default there are no trusted fields. If you need to exclude certain fields from 
        // the xss* settings behavior and allow all content, set them as trusted fields.
        // "*" can be used to set all fields in a layer to be trusted.
        // If no fields are set for a layer, none of the fields in the layer will be trusted. 
		
		"allowOthersToQuery": "true|false",  
		// Applies only if enableOwnershipBasedAccessControl is true.
		// true: Features owned by someone other than the logged in user are visible and can be queried  
        // false: Features owned by someone other than the logged in user are not visible and can’t be queried.
        // NOTE: Features owned by the logged in user are always visible.

		"allowOthersToUpdate": "true|false",  
		// Applies only if enableOwnershipBasedAccessControl is true and service capabilities include Update.
		// true: Allow features owned by someone other than the logged in user to be updated.
  		// false: Prevent features owned by someone other than the logged in user from being updated.

		"allowOthersToDelete": "true|false"
		// Applies only if enableOwnershipBasedAccessControl is true and service capabilities include Delete.
		// true: Allow features owned by someone other than the logged in user to be deleted.
		// false: Prevent features owned by someone other than the logged in user from being deleted.
}

NAServer

Properties below are optional.

Time units are specified as one of esriTimeUnitsUnknown|esriTimeUnitsMilliseconds|esriTimeUnitsSeconds|esriTimeUnitsMinutes|esriTimeUnitsHours| esriTimeUnitsDays|esriTimeUnitsWeeks|esriTimeUnitsMonths|esriTimeUnitsYears|esriTimeUnitsDecades|esriTimeUnitsCenturies.

Length units are specified as one of esriCentimeters|esriDecimalDegrees|esriDecimeters|esriFeet|esriInches|esriKilometers|esriMeters|esriMiles|esriMillimeters| esriNauticalMiles|esriPoints|esriUnknownUnits|esriYards.

{
	
	// allows building routes which stops have time windows specified.
	"route_AllowTimeWindows": "",

	// if the longest side of the spatial extent of the input stops is bigger than the specified value, hierarchy will be used during analysis.
	"route_ForceHierarchyBeyondDistance": "",

	// units of the route_ForceHierarchyBeyondDistance parameter.
	"route_ForceHierarchyBeyondDistanceUnits": "", 
	
	// maximum number of stops allowed in single request.
	"route_MaxStops": "",
	
	// maximum number of point barriers allowed in single request. 
	"route_MaxBarriers": "",
	
	// maximum number of streets allowed to be affected by line barriers in single request.
	"route_MaxFeaturesInLineBarriers": "",
	
	// maximum number of streets allowed to be affected by polygon barriers in single request.
	"route_MaxFeaturesInPolygonBarriers": "",

	// if the longest side of the spatial extent of the input incidents and facilities is bigger than the specified value, hierarchy will be used during analysis.
        "closestFacility_ForceHierarchyBeyondDistance": "",

	// units of the closestFacility_ForceHierarchyBeyondDistance parameter.
        "closestFacility_ForceHierarchyBeyondDistanceUnits": "",
	
	// maximum number of facilities allowed in single request.
	"closestFacility_MaxFacilities": "",
	
	// maximum number of incidents allowed in single request.
	"closestFacility_MaxIncidents": "",
	
	// limits maximum number of facilities to find for each incident.
	"closestFacility_MaxFacilitiesToFind": "",
	
	// maximum number of point barriers allowed in single request.
	"closestFacility_MaxBarriers": "",
	
	// maximum number of streets allowed to be affected by line barriers in single request.
	"closestFacility_MaxFeaturesInLineBarriers": "",
	
	// maximum number of streets allowed to be affected by polygon barriers in single request.
	"closestFacility_MaxFeaturesInPolygonBarriers": "",

	// units of the serviceArea_ForceHierarchyBeyondTime parameter.
	"serviceArea_ForceHierarchyBeyondTimeUnits": "",

	// if the impedance is in time units and the largest break is greater than this value, hierarchy will be used during analysis.
	"serviceArea_ForceHierarchyBeyondTime": "",

	// units of the serviceArea_ForceHierarchyBeyondDistance parameter.	
	"serviceArea_ForceHierarchyBeyondDistanceUnits": "",

	// if the impedance is in distance units and the largest break is greater than this value, hierarchy will be used during analysis.
	"serviceArea_ForceHierarchyBeyondDistance": "",

	// if the impedance is in unknown units and the largest break is greater than this value, hierarchy will be used during analysis.
	"serviceArea_ForceHierarchyBeyondOther": "",
	
	// maximum number of facilities allowed in single request.
	"serviceArea_MaxFacilities": "",
	
	// biggest break value allowed for time-based cost attributes.
	"serviceArea_MaxBreakValue_Time": "",
	
	// biggest break value allowed for length-based cost attributes.
	"serviceArea_MaxBreakValue_Length": "",

	// units of the serviceArea_MaxBreakValue_Time parameter.  
	"serviceArea_MaxBreakValue_TimeUnits": "",

	// units of the serviceArea_MaxBreakValue_Length parameter.  
	"serviceArea_MaxBreakValue_LengthUnits": "",
	
	// biggest break value allowed for cost attributes of the Unknown units.
	"ServiceArea_MaxBreakValue_Other": "",
	
	// maximum number of point barriers allowed in single request.
	"serviceArea_MaxBarriers": "",
	
	// maximum number of streets allowed to be affected by line barriers in single request.
	"serviceArea_MaxFeaturesInLineBarriers": "",
	
	// maximum number of streets allowed to be affected by polygon barriers in single request. 
	"serviceArea_MaxFeaturesInPolygonBarriers": "",

	// if the longest side of the spatial extent of the input demand points and facilities is bigger than the specified value, hierarchy will be used during analysis.
	"locationAllocation_ForceHierarchyBeyondDistance": "",

	// units of the locationAllocation_ForceHierarchyBeyondDistance parameter.
	"locationAllocation_ForceHierarchyBeyondDistanceUnits": "", 
	
	// maximum number of demand points allowed in single request.
	"locationAllocation_MaxDemandPoints": "",
	
	// maximum number of facilities allowed in single request.
	"locationAllocation_MaxFacilities": "",
	
	// maximum number of point barriers allowed in single request."
	"locationAllocation_MaxBarriers": "",
	
	// maximum number of streets allowed to be affected by line barriers in single request.
	"locationAllocation_MaxFeaturesInLineBarriers": "",
	
	// maximum number of streets allowed to be
	// affected by polygon barriers in single request.
	"locationAllocation_MaxFeaturesInPolygonBarriers": "",
	
	// if the longest side of the spatial extent of the input origins and demands is bigger than the specified value, hierarchy will be used during analysis.
	"oDCostMatrix_ForceHierarchyBeyondDistance": "",

	// units of the oDCostMatrix_ForceHierarchyBeyondDistance parameter.
	"oDCostMatrix_ForceHierarchyBeyondDistanceUnits": "", 
	
	// maximum number of origins allowed in single request.
	"oDCostMatrix_MaxOrigins": "",
	
	// maximum number of destinations allowed in single request.
	"oDCostMatrix_MaxDestinations": "",
	
	// limits maximum number of destinations to find for each origin.
	"oDCostMatrix_MaxDestinationsToFind": "",
	
	// maximum number of point barriers allowed in single request.
	"oDCostMatrix_MaxBarriers": "",
	
	// maximum number of streets allowed to be affected by line barriers in single request.
	"oDCostMatrix_MaxFeaturesInLineBarriers": "",
	
	// maximum number of streets allowed to be affected by polygon barriers in single request.
	"oDCostMatrix_MaxFeaturesInPolygonBarriers": "",

	// if the longest side of the spatial extent of the input orders is bigger than the specified value, hierarchy will be used during analysis.
	"vRP_ForceHierarchyBeyondDistance": "",

	// units of the vRP_ForceHierarchyBeyondDistance parameter.
	"vRP_ForceHierarchyBeyondDistanceUnits": "", 
	
	// maximum number of orders allowed in single request.
	"vRP_MaxOrders": "",
	
	// maximum number of routes allowed in single request.
	"vRP_MaxRoutes": "",
	
	// maximum number of point barriers allowed in single request.
	"vRP_MaxBarriers": "",
	
	// maximum number of streets allowed to be affected by line barriers in single request.
	"vRP_MaxFeaturesInLineBarriers": "",
	
	// maximum number of streets allowed to be affected by polygon barriers in single request.
	"vRP_MaxFeaturesInPolygonBarriers": "",
	
	// the folder on server where saved network analysis layers will be stored. Default is the output directory.
	"nALayerDir": "",
	
	// allows saving network analysis layer on server for further reuse or post-processing.
	"allowSaveLayerOnServer": "",
	
	// triggers automatic saving of network analysis layer on server in cases of request processing errors.
	"saveLayerOnServerWhenError": "",
	
	// returned geometry will be generalized using this threshold unless overwritten in request.
	"defaultOutputGeometryPrecision": "",
	
	// defaultOutputGeometryPrecision value units.
	"defaultOutputGeometryPrecisionUnits": ""
}

WCSServer

{
	"pathToCustomGetCapabilitiesFiles" : "" ,
	"name" : "" ,
	"title" : "" ,
	"abstraction" : "" ,
	"fees" : "" ,
	"accessConstraints" : "" ,
	"providerName" : "" ,
	"providerWebSite" : "" ,
	"responsiblePerson" : "" ,
	"responsiblePosition" : "" ,
	"phone" : "" ,
	"fax" : "" ,
	"email" : "" ,
	"address" : "" ,
	"city" : "" ,
	"province" : "" ,
	"zipcode" : "" ,
	"country" : "" ,
	"serviceHour" : "" ,
	"contactInstructions" : "" ,
	"role" : "" ,
	"onlineResource" : "" ,
}

WFSServer

{
	"city" : "" ,
	"contactOrganization" : "" ,
	"abstract" : "" ,
	"accessConstraints" : "" ,
	"fees" : "" ,
	"address" : "" ,
	"country" : "" ,
	"contactFacsimileTelephone" : "" ,
	"contactPosition" : "" ,
	"pathToCustomSLDFile" : "" ,
	"pathToCustomGetCapabilitiesFiles" : "" ,
	"addressType" : "" ,
	"contactVoiceTelephone" : "" ,
	"keyword" : "" ,
	"postCode" : "" ,
	"onlineResource" : "" ,
	"title" : "" ,
	"contactPerson" : "" ,
	"stateOrProvince" : "" ,
	"contactElectronicMailAddress" : "" ,
	"customGetCapabilities" : "" ,
	"inheritLayerNames" : "" ,
	"name" : "" ,
}

WMSServer

{
	"city" : "" ,
	"individualName" : "" ,
	"abstract" : "" ,
	"fees" : "" ,
	"accessConstraints" : "" ,
	"country" : "" ,
	"facsimile" : "" ,
	"positionName" : "" ,
	"pathToCustomGetCapabilitiesFiles" : "" ,
	"serviceType" : "" ,
	"serviceTypeVersion" : "" ,
	"phone" : "" ,
	"keyword" : "" ,
	"postalCode" : "" ,
	"onlineResource" : "" ,
	"title" : "" ,
	"electronicMailAddress" : "" ,
	"enableTransactions" : "" ,
	"appSchemaPrefix" : "" ,
	"appSchemaURI" : "" ,
	"hoursOfService" : "" ,
	"providerSite" : "" ,
	"role" : "" ,
	"customGetCapabilities" : "" ,
	"contactInstructions" : "" ,
	"providerName" : "" ,
	"deliveryPoint" : "" ,
	"administrativeArea" : "" ,
	"name" : "" ,
}

MobileServer

{
}

JPIPServer

{
	// Insert your own server and service information in the example below
	"jPIPServiceURL": "jpip://JPIPServer:Port/JP2Server/AGSServer_Port/ServiceName",
	"jPIPImageName": "/AGSServer_Port/ServiceName"

}

10/6/2017