Description

dataExtraction is an array of operations (each of type 19) that defines how source data is pulled into the job's extraction database before any cartographic processing runs. Each operation describes a single input (a workspace, product file, feature service, map service, or raster service), the AOI used to filter it, and any buffering, format, or dataset-inclusion controls.

How it is used

When a job runs, the Topographic Production Service executes each dataExtraction operation in order. Map-service and feature-service inputs produce feature classes inside extractionDatabase (typically under the product's featureDataset), while raster inputs are written as raster datasets or files. The extracted data is then referenced by operations through the [SourceWorkspace] resource (for example, [SourceWorkspace]\\BM\\ContourL) or directly by file path.

Expected values

Each dataExtraction entry is a JSON object with the following syntax:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
{
  "name": "<name the operation>",
  "type": 19,
  "id": "<GUID or unique string>",
  "description": "",
  "featureDataset": "<optional name of the feature dataset to which the data is extracted>",
  "disabled": <true | false>,
  "parameters": [
    {
      "name": "input_data",
      "value": "<file path to workspace connection | product file | feature service URL |
	  			map service URL | raster service URL>"
    },
    {
      "name": "AOI",
      "value": "<the string representation of an extent (space delimited) | JSON geometry | None>"
    },
    {
      "name": "spatial_relationship",
      "value": "<...>"
    },
    {
      "name": "buffer",
      "value": "<the buffer value and unit of measurement>"
    },
    {
      "name": "fileName",
      "value": "<the name of the raster file that gets extracted>"
    },
	{
	  "name": "fileExtension",
	  "value": "<the extension for the raster format that the final output should be in>"
	},
    {
      "name": "definitionQuery",
      "value": "<a valid Where clause for all of the tables in the input_data parameter value>"
    },
    {
      "name": "includeDatasets",
      "value": "<a comma-delimited list of datasets to extract>"
    },
    {
      "name": "excludeDatasets",
      "value": "<a comma-delimited list of datasets to exclude from extraction>"
    }
  ]
}

Behavior and relationships

The default extraction operations interact with the rest of the product definition:

  • defaultMapExtraction writes feature data into extractionDatabase/featureDataset. Downstream operations reference the result through [SourceWorkspace].
  • defaultRasterExtraction writes a raster (when one is configured) and is referenced by elevation- and contour-related operations.
  • The AOI parameter typically resolves to [AOILayer]\\Extent, tying extraction to the AOI feature identified by sheetIDField.
  • Setting disabled to true lets a product version skip extraction (for example, an SDE-connected editing version that works directly against the enterprise geodatabase).

User considerations

  • Use buffer carefully: a too-small buffer can clip features that influence cartography at the sheet edge, while an oversized buffer increases extraction time. Installed product definitions commonly use values such as 2 kilometers for vector data and 1.5 kilometers for raster.
  • Prefer definitionQuery to pre-filter large source tables rather than relying on AOI alone.
  • When extracting from a map service or feature service, ensure the service account used by the SOE has read access to all required layers.
  • When extracting rasters, set fileExtension explicitly if the default (.img for DEMs and image services, or the source format for .dt2/.tif inputs) does not match the downstream tooling.

Example

The following dataExtraction operation example extracts a raster:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
{
  "name": "RasterDataset",
  "type": 19,
  "id": "RasterDataset",
  "description": "Raster Dataset Extract",
  "disabled": "false",
  "parameters": [
	{
		"name": "input_data",
		"value": "[ProductFiles]\\Elevation.gdb\\DEM"
	}
	{
		"name": "AOI",
		"value": "[AOILayer]\\Extent"
	}
	{
		"name": "buffer",
		"value": "2 kilometers"
	}
	{
		"name": "fileName",
		"value": "MyRaster"
	},
	{
		"name": "fileExtension",
		"value": ".tif"
	},
	{
		"name": "spatial_relationship",
		"value": "esriSpatialRelIntersects"
	}
	{
		"name": "DefinitionQuery",
		"value": ""
	}
	{
		"name": "includeDatasets",
		"value": ""
	}
	{
		"name": "excludeDatasets",
		"value": ""
	}
	]
}
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
{
  "name": "RasterDataset",
  "type": 19,
  "id": "RasterDataset",
  "description": "Raster Dataset Extract",
  "disabled": "false",
  "parameters": [
	{
		"name": "input_data",
		"value": "[ProductFiles]\\Elevation.gdb\\DEM"
	}
	{
		"name": "AOI",
		"value": "[AOILayer]\\Extent"
	}
	{
		"name": "buffer",
		"value": "2 kilometers"
	}
	{
		"name": "fileName",
		"value": "MyRaster"
	},
	{
		"name": "fileExtension",
		"value": ".tif"
	},
	{
		"name": "spatial_relationship",
		"value": "esriSpatialRelIntersects"
	}
	{
		"name": "DefinitionQuery",
		"value": ""
	}
	{
		"name": "includeDatasets",
		"value": ""
	}
	{
		"name": "excludeDatasets",
		"value": ""
	}
	]
}

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