File Formats

Specific parts of the configuration to text files.

What can be exported is:

Event - Command configuration

The event-command configuration will be exported to a tab delimited text file named ##EventBrokerConfig_<time>.txt.

An example of such a file is:

// File generated by APIS Snapins Configuration Export
// ##version:2## (do not modify this line)

##EventBrokerConfiguration## (EventModuleName.EventID	CommandModuleName.CommandID)
ApisCalculate 1.8000	ApisCalculate 1.8000
ApisJava1.110	ApisJava1.100
ApisJava1.8000	ApisJava1.8000
ApisJava1.8000	ApisJava1.120
ApisOPC1.8000	ApisOPC1.8000
Java.110	Java.100
Java.8000	Java.8000

The third line indicates that this is configuration for event-commands, and the following lines represent connections between events and commands.

Important!

The required separator between the events and commands is a single [tab] character.
For clarity, the placement of the [tab] characters () is highlighted below.

// File generated by APIS Snapins Configuration Export
// ##version:2## (do not modify this line)

##EventBrokerConfiguration## (EventModuleName.EventIDCommandModuleName.CommandID)
ApisCalculate 1.8000ApisCalculate 1.8000
ApisJava1.110ApisJava1.100
ApisJava1.8000ApisJava1.8000
ApisJava1.8000ApisJava1.120
ApisOPC1.8000ApisOPC1.8000
Java.110Java.100
Java.8000Java.8000

Modules

There will be one file for each module in the configuration.
The files are named <ModuleName>_##ModuleProperties_<time>.txt.

An example of such a file is:

// File generated by Apis Configuration Export
// ##version:2## (do not modify this line)
ModuleCLSID	{d8e2d2c7-7bd5-4afa-8811-85e863c1d3a0}
ModuleName	ApisCalculate 1
ModuleStorageCLSID	{4c854c93-c667-11d2-944b-00608cf4c421}

##Module properties##
ExchangeRate	TimeReferenceItem	ExtItemCalculationSequence	ExtItem pass-through quality	UpdateInitvalsOnSave	PersistValToInitVal	Calculation	TraceToFile
100	200	300	400	1600	1650	1700	1900
0		0	64	False	0	True	

The module properties are registered immediately below the ##Module properties## line.

  • The first line contains the name of the property and is not actually used when importing.

  • The second line contains the ids of the properties.

  • The third line contains the values of the properties.

Important!

The required separator between the property attributes is a single [tab] character.
For clarity, the placement of the [tab] characters () is highlighted below.

// File generated by Apis Configuration Export
// ##Version:2## (do not modify this line)
ModuleCLSID{d8e2d2c7-7bd5-4afa-8811-85e863c1d3a0}
ModuleNameApisCalculate 1
ModuleStorageCLSID{4c854c93-c667-11d2-944b-00608cf4c421}

##Module properties##
ExchangeRateTimeReferenceItem>ExtItemCalculationSequenceExtItem pass-through qualityUpdateInitvalsOnSavePersistValToInitValCalculationTraceToFile
1002003004001600165017001900
0⇥⇥064False0True

Items

There will be one file for each item type in each module.
The files are named <ModuleName>_<NameOfItemType>_<time>.txt.

An example of such a file is:

// File generated by Apis Configuration Export
// ##version:2## (do not modify this line)
ModuleCLSID	{983b4ae2-abb9-11d2-9424-00608cf4c421}
ModuleName	ApisWorker1
ModuleStorageCLSID	{4c854c93-c667-11d2-944b-00608cf4c421}
ItemType	Signal	[ID:1]

//##Module properties## (uncomment this and the next three lines to import module properties):
//ExchangeRate	TimeReferenceItem	ExtItemCalculationSequence	ExtItem	pass-through	quality	RandomizeItemAttribs	UpdateInitvalsOnSave	PersistValToInitVal
//100	200	300	400	1500	1600	1650
//2000		0	64	True	False	0

//ItemID	Amplitude	Waveform	Address	Period	Overidden	quality	Address2	Bias	UALogger2	UALogger	Type
0	10001	10002	5020	10004	10100	5021	10005	UALogger2	UALogger
Signal1	600	0	0	60	192	0	10	True	False	4
Signal2	600	0	0	60	192	0	20	True	False	4
Signal3	700	0	0	60	192	0	30	True	False	4
Signal4	700	0	0	60	192	0	20	True	False	4
Signal5	800	0	0	60	192	0	10	True	False	4
Signal6	800	0	0	60	192	0	13	True	False	4
Signal7	900	0	0	60	192	0	14	True	False	4
Signal8	900	0	0	60	192	0	15	True	False	4
  • The first part of the file is the same as for the modules, except it also contains a line for the item type, and that module properties are commented out.

  • The last part is a list of items. The columns are the properties of the item. The first column should always have id 0, and is the name of the item.

Important!

The required separator between the property attributes is a single [tab] character.
For clarity, the placement of the [tab] characters () is highlighted below.

// File generated by Apis Configuration Export
// ##version:2## (do not modify this line)
ModuleCLSID{983b4ae2-abb9-11d2-9424-00608cf4c421}
ModuleNameApisWorker1
ModuleStorageCLSID{4c854c93-c667-11d2-944b-00608cf4c421}
ItemTypeSignal[ID:1]

//##Module properties## (uncomment this and the next three lines to import module properties):
//ExchangeRateTimeReferenceItemExtItemCalculationSequenceExtItempass-throughquality RandomizeItemAttribsUpdateInitvalsOnSavePersistValToInitVal
//100200300400150016001650
//2000064TrueFalse0

//ItemIDAmplitudeWaveformAddressPeriodOveriddenqualityAddress2BiasUALogger2UALoggerType
0100011000250201000410100502110005UALogger2UALogger
Signal16000060192010TrueFalse4
Signal26000060192020TrueFalse4
Signal37000060192030TrueFalse4
Signal47000060192020TrueFalse4
Signal58000060192010TrueFalse4
Signal68000060192013TrueFalse4
Signal79000060192014TrueFalse4
Signal89000060192015TrueFalse4