URL:
https://<root>/system/properties
Methods:
GET
Required Capability:
Administrator
Version Introduced:
12.2

Description

The properties resource is a container for ArcGIS Data Pipelines Server configuration properties that govern some of its behavior. The properties are applied to all server machines in the ArcGIS Data Pipelines Server site.

Request parameters

ParameterDetails

f

The response format. The default response format is html.

Values: html | json | pjson

Server properties

PropertyDetails

maxWorkersPerMachine

The number of workers that can be active simultaneously. Workers are the compute resources that are allocated to power the ArcGIS Data Pipelines editor, scheduled task runs, and stand-alone data pipeline runs.

Example
Use dark colors for code blocksCopy
1
maxWorkersPerMachine=4

maxCoresPerWorker

The number of cores each worker can use. For example, if you process large amounts of data, you may need to increase this value in order for the runs to complete successfully.

Example
Use dark colors for code blocksCopy
1
maxCoresPerWorker=2

maxMemoryPerWorkerInMiB

The amount of memory each worker can use specified in megabytes. For example, if you process large amounts of data, you may need to increase this value in order for the runs to complete successfully.

Example
Use dark colors for code blocksCopy
1
maxMemoryPerWorkerInMiB=2000

reservedInteractiveWorkersPerMachine

The number of workers that are reserved for interactive authoring in the Data Pipelines editor. For example, if you have a single-machine ArcGIS Data Pipelines Server site, and maxWorkersPerMachine is set to 6, and reservedInteractiveWorkersPerMachine is set to 2, then two of six workers will be reserved specifically for working in the Data Pipelines editor, and four will be available for scheduled task runs and stand-alone data pipeline runs.

Example
Use dark colors for code blocksCopy
1
reservedInteractiveWorkersPerMachine=2

allowedHosts

Specifies which hosts can be used to read in data when using the URL input. The default is none (""). It is recommended you specify a list of hosts to allow read access to. If a URL redirects to another host, both hosts must be specified in the allowed hosts list.

Example
Use dark colors for code blocksCopy
1
allowedHosts="exampleHost.com, mydata.org, www.test.ca"
Example
Use dark colors for code blocksCopy
1
allowedHosts="(.*)"

allowedFileSharePaths

Specifies which file share paths are accessible by the File share input. By default, all file shares that are accessible by the ArcGIS Data Pipelines Server account will be available for use in the File share input. Some directories are always restricted, including install directories and system managed or OS protected directories.

Example
Use dark colors for code blocksCopy
1
allowedFileSharePaths=[ "\\\\network_path\\my_data", "\\\\other_network_path\\my_other_data"]

To block access to all file shares, specify an empty list.

Example
Use dark colors for code blocksCopy
1
allowedFileSharePaths=[]

Example usage

The following is a sample request URL used to access the properties resource:

Use dark colors for code blocksCopy
1
https://organization.example.com/<context>/admin/system/properties?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
5
{
  "<property1>": <value1>,
  "<property2>": <value1>,
  ...
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
    "maxMemoryPerWorkerInMiB": 4096,
    "maxCoresPerWorker": 2,
    "allowedHosts": "(.*)",
    "maxWorkersPerMachine": 6,
    "reservedInteractiveWorkersPerMachine": 2
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.