File Structure

Each different capture type is defined in a JSON file.

These files are stored in your ARDI site folder, inside folders located in the capture directory.

If you were creating a capture type called 'Batch Summary' on an ARDI site called 'default' installed into C:\ARDI on a Windows system would place capture files in c:\ARDI\sites\default\capture\batch_summary\config.json.

Below is an example of a simple capture configuration.

{
	"name": "Daily Painting KPIs",
	"uniqueid": "{Date}",
	"keys": ["Running Percentage","Not Running Percentage"],	
	"date": "StartTime",
	"steps": [			
		{
			"type": "get_day",
			"upto": "06:00",
			"comment": "Get The Full Day Span"
		},
		{
			"type": "get_query",
			"points": ["Paint Line.Speed - Actual","Paint Line.Status - Painting"],
                        "samples": 1000,
			"comment": "Get Line Running Status"
		},
		{
			"type": "timeframes",			
			"condition": "({Paint Line.Status - Painting} > 0) && ({Paint Line.Speed - Actual} > 0)",				
			"comment": "Find Painting Times"
		},
		{
			"type": "timesummary",			
			"inside": "Painting",
			"comment": "Calculate Painting Times"
		}
	]
}

There are several key properties of the JSON object inside this file.

name: The human-readable name of the capture type.
uniqueid: The unique ID for an individual capture. Substitutable.
keys: A list of the most important attributes of the capture. These will be stored in the database and can be used to filter your data.
date: The name of the attribute to use as the capture date. Normally StartTime. steps: A list of the analytic steps.

There are some additional, optional properties that can be present.

important: A list of attributes that should be highlighted to the user. These may include regular expressions.
highlight: Similar to 'important', but secondary (ie. these items will be shown below important items but before any others).
ignore: A list of attributes that should be ignored in comparisons.
matching: Used to adjust the fuzzy matching options.
modelmap: Used to rename attributes being used in explosion and AI.
link: Let users view a chart of data when looking at a capture.