Custom Data Service Options | ArcGIS Enterprise SDK

This topic provides details on the options that are available for configuring custom data feature services. Ensure that the custom data provider that is associated with the custom data feature service supports the desired service configuration option. Some additional ArcGIS Enterprise components may be required for some options.

Service JSON Template

The highlighted lines below illustrate the attributes that can be modified by administrative users.

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
11
11
11
11
11
11
11
11
11
11
11
11
11
11
11
11
11
11
11
11
11
11
11
11
11
11
11
11
11
11
11
{
  "serviceName": "service_name",
  "type": "FeatureServer",
  "description": "service_description",
  "capabilities": "Query",
  "provider": "CUSTOMDATA",
  "clusterName": "default",
  "minInstancesPerNode": 0,
  "maxInstancesPerNode": 0,
  "instancesPerContainer": 1,
  "maxWaitTime": 60,
Expand

Service JSON Properties

Parameter	Details
`serviceName`	Name of the service to be created. This name must be unique. If the name already exists, the operation will fail. ArcGIS Enterprise does not allow spaces or special characters other than underscores in a service name. Service names cannot be edited after creation.
`description`	Description given to the service.
`capabilities`	Specify feature service capabilities. Editing can only be enabled if the property `editingEnabled` is `true` in the custom data provider's cdconfig.json file. Editing cannot be enabled on a custom data feature service that has response caching enabled. Two options are available: `"Query"` or `"Query,Editing"`
`forwardUserIdentity`	Default value is `false`. Allows for access to user information via the `_user` object. Refer to the topic on creating custom data providers for more information. Two options are available: `false` or `true`
`dataProviderName`	Name of the registered custom data provider that will provide data for the service.
`serviceParameters`	Provide the `key` and value for each `key` that was defined in the cdconfig.json file for each service parameter. Example Use dark colors for code blocksCopy `1 2 3 4 "serviceParameters": { "crs": "3857", "tableName": "shoe_stores" }` See the topic Create a Custom Data Feed Provider for more information.
`cache.expiration`	Specify an integer number of days the cache will be stored before it is removed. The value must be greater than 0 if caching is to be enabled.
`cache.enabled`	Specify whether to enable response caching. It is required that the hosting server have the object store registered. Two options are available: `false` or `true`