Configuration

Configuration Details

The Configuration definition derives from the TimeRangeActivity definition, and includes all of the base class properties.

51 Properties	Required	Description
Id	N	An identification name for this configuration, used in debugging messages when something goes wrong. If omitted, the name of source TOML file or global settings will be used.
Priority	N	Defaults to Priority = 1. Configurations are processed in priority order, starting from 1, and incrementing upwards until all configurations have been tried. Configurations with a value of 0 or less and considered disabled. Priority values do not need to be unique or consecutive.
Separator	N	Defaults to Separator = ','. A single character string, describing the character used to separate columns in the CSV file. If you have tab-delimited file, you would use Separator = "\t" (note the use of a double-quoted string, which interprets the \ as an escape character).
LocaleName	N	Defaults to LocaleName = 'en-US'. The locale can be used to parse numbers and dates in a specific locale. Use LocaleName = 'es-ES' to use the Spanish locale when parsing values. See the Locales and Encodings page for more details.
EncodingName - v20.3.+	N	Defaults to EncodingName = 'utf-8'. The encoding tells the plugin how to interpret each byte of the CSV as a text character. When text data is outside the 7-bit ASCII range, you may need to tell the plugin how to interpret the data. A quick way to test if you need to change the encoding is to load your CSV data into the Test Drive page. If you see any black diamond question mark � characters in your data, that is a strong hint that the CSV text is not UTF-8 compatible and you need to specifiy a different encoding. Using EncodingName = 'Windows-1252' is often appropriate when UTF-8 is not working for Western European languages. See the Locales and Encodings page for more details.
PrefaceRowCount	N	When set, this value specifies an exact number of lines in the preface area.
PrefaceEndsWith	N	When set and when a preface line starts with the given text string, the matching line will be considered to be the last line of the preface area.
PrefaceEndsBefore	N	When set and when a preface line starts with the given text string, the matching line will be considered to be the first line of the header or data areas.
PrefaceMustContain	N	When set, at least one of the preface lines must contain the given text string. If no preface lines match, then no data rows will be processed.
PrefaceMustMatchRegex	N	This is an alternate to the simpler PrefaceMustContain property. When set, the entire set of preface lines is matched against the regular expression. If no match is found, then no data rows will be processed.
MaximumPrefaceLines	N	Defaults to MaximumPrefaceLines = 50. When a preface is configured, stop processing if the number of preface lines exceeds this value. Use MaximumPrefaceLines = 0 to disable this limit check.
HeaderRowCount	N	By default, this value will be automatically set to 1 if any ColumnHeader source types are used. But you can override the automatic behaviour when needed. See the Header topic for more details.
IgnoredLeadingHeaderRowCount v21.4.3+	N	Defaults to 0, and allows some leading rows to be excluded from affecting column names. See the Header topic for more details.
IgnoredTrailingingHeaderRowCount v21.4.3+	N	Defaults to 0and allows some trailing rows to be excluded from affecting column names. See the Header topic for more details.
NoDataRowsExpected	N	When true, all data must come from a PrefaceRegex source.
CommentLinePrefix	N	If set, and data row which begins with the prefix string will be treated as a comment and the entire data row will be ignored.
FooterStartsWith v20.3.16+	N	When set, data rows will stop being processed if the given text string is encountered.
FooterMatchesRegex v20.3.16+	N	This is an alternate to the simpler FooterStartsWith property. When set, data rows will stop if the current line matches the regular expression.
StrictMode	N	Defaults to StrictMode = true. Enables or disables some strict configuration validation logic, which will warn you if your configuration makes no sense.
Location	N	This property sets the location identifier of the visit data. See the Location page for more details on this property. If no location identifier is set, then the configuration will not be able to parse data from CSV files uploaded to the main Springboard drop target. Instead, your users will need to open a specific location in Location Details, and then upload the CSV file directly to that selected location.
UtcOffset - v20.3.12+	N	If set, this UTC offset will be used to resolve ambiguous timestamps. If not set, assume the location's configured UTC offset. See the Timestamp page for supported UTC offset patterns.
SkipVisitIfNoActivities - v21.4.6+	N	Defaults to SkipVisitIfNoActivities = false. When true, a visit will not be created from a data row unless it has at least one non-empty activity (eg. a reading or a discharge measurement). This is a useful setting to control when importing very wide-but-sparse CSV files where all the times are extracted from one column. It avoids creating empty visits with no real data other than a timestamp.
Time Times StartTime StartTimes EndTime EndTimes DateOnly - v20.3+ TimeOnly - v20.3+ StartDateOnly - v20.3+ StartTimeOnly - v20.3+ EndDateOnly - v20.3+ EndTimeOnly - v20.3+	N	15 inherited TimeRangeActivity properties. The Time/StartTime/EndTime properties will be used for any parsed item times, unless overriden by a specific [section].
SheetName - v21.4.12+	N	Only used when Importing Excel files.
SheetNumber - v21.4.12+	N	Only used when Importing Excel files.

A configuration also has these optional sections, to define activity-specific properties to be parsed:

Sections	Required	Description
[Visit]	N	Visit properties.
[ControlCondition]	N	Control condition properties.
[GageAtZeroFlow] - v20.3+	N	Gage height at zero flow activity properties.
[Reading] [[Readings]]	N	A list of readings.
[Inspection] [[Inspections]]	N	A list of inspections.
[Calibration] [[Calibrations]]	N	A list of calibrations.
[AdcpDischarge] [[AdcpDischarges]]	N	A list of ADCP discharges.
[PanelDischargeSummary] [[PanelDischargeSummaries]]	N	A list of panel discharge summaries.
v20.3+ - [VolumetricDischarge] v20.3+ - [[VolumetricDischarges]]	N	A list of volumetric discharges.
v20.3+ - [EngineeredStructureDischarge] v20.3+ - [[EngineeredStructureDischarges]]	N	A list of engineered structure discharges.
v20.3+ - [OtherDischarge] v20.3+ - [[OtherDischarges]]	N	A list of Other discharges.
[LevelSurvey] [[LevelSurveys]]	N	A list of level surveys.
[Aliases]	N	A powerful configuration mechanism to map values from CSV into different values required by AQTS.

General Configuration properties

• Use the Priority value to control the order in which the configurations are processed by the Tabular plugin. Use a Priority value of 0 or less to completely disable the configuration.
• Use the LocaleName value to enable parsing of numbers or dates in a different language other than English.

Use the Preface area to quickly skip parsing of CSV files that don't match your configuration.

If your CSV data data has a preface area (a short number of lines which preceed any header or data rows), then it is recommended that you set one of the preface-related properties to assert what your data file looks like, so that the plugin can quickly validate those assumptions without trying to process and parse every data row.