Wiki source code of SharedVariableExportManager

Last modified by Michael Sibayan on 2022/05/03 16:48

author	version	line-number	content
		1	The Shared Variable Export Manager is an application which created/controls Export Groups (a group of NI SVE variables to be exported to flat text file). Each group runs independently and can create comma separated variable data files, JSON sensor measurement data files, and JSON sensor state files.
		2
		3	[[image:SensorVariableExportManager_SS.png]]
		4
		5	The manager application has the ability to perform the following actions:
		6	- Start a group
		7	- Stop a group
		8	- Reload a group
		9	- Add a new group
		10	- Remove a group
		11	- Open the configuation file of a group
		12	- Shut down all groups and close application
		13
		14	All configuration files placed in the auto load folder (typically .\ExportManager\ExportGroups\) will automatically load when the application is loaded.
		15	{{warning}}Due to the nature of the Shared Variable Engine (SVE), each variable is "opened" when the group is loaded. This can cause long start-up delays when connecting to a large number of variables.{{/warning}}
		16
		17	=== Configuration of an Export Group ===
		18	The configuration file for an export group is ASCII text NI_LVConfig format, where [square brackets] indicate sections and variables = value.
		19
		20	Each config file uses the section [General] for logging information and a set of [Variable_IDs] for export variable configuration. Below is an example of an export group with two variables.
		21
		22	{{box}}
		23	{{code}}
		24	[General]
		25	name = "IsotopeLab"
		26	logging interval = 1
		27	interval in seconds = true
		28	write csv datafile = true
		29	export only on change = false
		30	csv datafile length = "day"
		31	csv datafile output folder = "x:\\data\\isotopelab\\csv\\"
		32	write sensor datafile = false
		33	sensor datafile output folder = "x:\\data\\isotopelab\\datafile\\"
		34	write sensor statefile = true
		35	sensor statefile output folder = "x:\\data\\statefiles\\"
		36
		37	[HeaterA]
		38	path = "\\\\192.168.1.144\\Mod4\\HeaterA_TempC"
		39	datatype = double
		40	[HeaterB]
		41	path = "\\\\192.168.1.144\\Mod4\\HeaterB_TempC"
		42	datatype = double
		43	{{/code}}
		44	{{/box}}
		45
		46	The [General] section has the following variables:
		47	{{info}}There are no required fields, but no exporting will occur by default{{/info}}
		48	\|VARIABLE\|DATATYPE\|NOTES
		49	\|name\|string\|Name of the group, used in naming output files. Default uses the config file name.
		50	\|logging interval\|int\|Period of which the group is executed, default is 15
		51	\|interval in seconds\|boolean\|TRUE if the interval is in seconds, FALSE indicates the interval is in minutes, default is false (minute)
		52	\|export only on change\|boolean\|TRUE if the files will only be updated/generated when a variable changes value, default is false.
		53	\|write csv datafile\|boolean\|Enables/disables export to CSV, default is false
		54	\|csv datafile length\|string\|How often files are separated. Valid lengths are:{{code}}second, minute, hour, day, month, year, perpetual{{/code}}. Default is perpetual.
		55	\|csv datafile output folder\|string\|Path to the folder which to write csv data, no data will be written if the path is non existent. Default is "c:\data"
		56	\|write sensor datafile\|boolean\|Enables/disables exporting to sensor measurement JSON files, default is false
		57	\|sensor datafile output folder\|string\|Path to the folder which to write sensor measurement data, no data will be written if the path is non existent. Default is "c:\data"
		58	\|write sensor statefile\|boolean\|Enables/disables exporting current state to file, default is false
		59	\|sensor statefile output folder\|string\|Path to the folder which to write sensor state data, no data will be written if the path is non existent. Default is "c:\data"
		60
		61	{{info}}A note about "export only on change": This is still dependent on the interval, so if we log at 1 minute intervals, it will check for system changes every 1 minute and only write to file if there is a change.{{/info}}
		62
		63
		64	Each variable to be exported needs to be defined using it's own section (don't call any variable [General] or it will be ignored, also give each section a unique name).
		65	A [variable_id] section has the following variables:
		66	{{info}}There are two required fields:"path" and "datatype"{{/info}}
		67	\|VARIABLE\|DATATYPE\|NOTES
		68	\|path\|string\|The network path, in SVE path convention, to the variable
		69	\|datatype\|string\|Data type of the variable (important for correct parsing). Valid data types are:{{code}}double, int32, uint32, boolean, string, timestamp{{/code}}. Default is unknown (no data will be collected).
		70	\|DBID\|string\|Database identifier for statefiles & sensor measurements
		71	\|SensorCode\|string\|Sensor name identifier for statefiles & sensor measurements
		72	\|VariableCode\|string\|Sensor's variable name identifier for statefiles & sensor measurements
		73	\|SensorID\|string\|Sensor's database ID for statefiles & sensor measurements
		74	\|VariableID\|string\|Variable database ID for statefiles & sensor measurements
		75	\|BoxX\|string\|X (up slope) position for statefiles & sensor measurements
		76	\|BoxY\|string\|Y (cross slope) position for statefiles & sensor measurements
		77	\|DLevel\|string\|Depth position for statefiles & sensor measurements
		78	\|Units\|string\|Units of the exported data
		79	\|DataTable\|string\|Database table for statefiles & sensor measurements
		80
		81