Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...



### contexts


### process

When and the unit of processing for an extractor. In the example above, the word count extractor is processed on a single file. Below is an example of starting an extractor when a file is added to a dataset:

Code Block
"process": {   
	"dataset": [      
		"file.added"
	]
},


### dependencies

a list of packages the extractor depends upon

Code Block
"dependencies": [
	"imagemagick",
	"ufraw-batch"
],



### parameters

Allows parameters to be passed to extractor upon submission


Code Block
"parameters":{
	"schema": {
		"fields": {
			"type": "string",
			"title": "Naming Fields",
			"default": "None"
		}
	},
	"form": [
		{
		"key": "fields",
		"notitle":false
		}
	]
},



A more complicated example:

Code Block
"parameters": {
	"schema": {
		"orthophoto_resolution": {
			"type": "string",
			"title": "Quality",
			"enum": [
				"2",
				"5",
				"10"
			],
			"default": "5"
		},
	"fast-orthophoto": {
		"type": "boolean",
		"title": "Use sparse reconstruction (fast orthophoto)",
		"default": true
		}
	},
	"form": [
		{
		"key": "orthophoto_resolution",
		"type": "select",
		"notitle": true,
		"titleMap": {
			"2": "High Quality",
			"5": "Medium Quality",
			"10": "Low Quality"
		}
		},
		{
		"key": "fast-orthophoto",
		"inlinetitle": "Use sparse reconstruction (fast orthophoto flag)",
		"notitle": true
		}
	]
},