Haystack Discovery Rules and CSV Format
The HaystackConfiguration.csv file can contain two types of structured lines.
- Configuration section: to set specific entities description and functions
- Import section: to filter in/out entities
Function and Description Assignation Section
The assignation line has the following format:
SITE|EQUIP|BOOL|NUMBER|STR,[SiteReference],[EquipmentReference],[DescriptionTag],[FunctionName],[Tag=“...”|Marker],[Tag=“...”|Marker],[Tag=“...”|Marker],[Tag=“...”|Marker]
It should be interpreted as follows:
For SITE|EQUIP|BOOL|NUMBER|STR,[SiteReference],[EquipmentReference] entities, with [Tag=“...”|Marker] and [Tag=“...”|Marker] and [Tag=“...”|Marker] and [Tag=“...”|Marker], use [DescriptionTag] and [FunctionName]
NOTES:
- Commas are always required for the documented fields.
- More markers can be appended as necessary.
- In case of multiple rules, the first rule that applies will be used for any given entity. Make sure to specify the most selective rules first, and leave the most general rule as last.
For example:
SITE|EQUIP|BOOL|NUMBER|STR | SiteRef | EquipmentRef | Description Tag | Function Name | Tag=“...” | Marker | Tag=“...” | Marker | Tag=“...” | Marker | Tag=“...” | Marker |
SITE, | , | , | siteDescr, | Haystack_MonitorRain, | site, | hq, | , |
|
For Site entities with site and hq markers, use siteDescr value as Desigo CC Description and Haystack_MonitorRain as Desigo CC Function. | ||||||||
SITE, | , | , | siteDescr, | Haystack_Monitor, | hq, | , | , |
|
For Site entities with hq marker, use siteDescr value as Desigo CC Description and Haystack_Monitor as Desigo CC Function. | ||||||||
SITE, | , | , | siteDescr, | Haystack_MonitorFire, | , | , | , |
|
For all other Site entities, use siteDescr value as Desigo CC Description and Haystack_MonitorFire as Desigo CC Function. | ||||||||
EQUIP, | , | , | , | Haystack_MonitorFire, | , | , | , |
|
For Equipment entities, use the Adapter.config setting as Desigo CC Description and Haystack_MonitorFire as Desigo CC Function. | ||||||||
NUMBER, | Milan, | Controller_A1, | floorRef, | Haystack_Sensor, | Sensor, | , | , |
|
For Number entities in Milan Site and Controller_A1 EQUIP with Sensor marker, use floorRef value as Desigo CC Description and Haystack_Sensor as Desigo CC Function. | ||||||||
Import Section
The import section starts with the line: ##### Import section #####, which must not be removed.
The import line has the following format:
INCLUDE|EXCLUDE,NUMBER|BOOL|STR,[Tag=”…”|Marker],[Tag=”…”|Marker],[Tag=”…”|Marker],[Tag=”…”|Marker]
It should be interpreted as follows:
INCLUDE,NUMBER|BOOL|STR entities, with [Tag=”…”|Marker] and [Tag=”…”|Marker] and [Tag=”…”|Marker] and [Tag=”…”|Marker] and exclude everything else.
OR
EXCLUDE,NUMBER|BOOL|STR entities, with [Tag=”…”|Marker] and [Tag=”…”|Marker] and [Tag=”…”|Marker] and [Tag=”…”|Marker]
NOTES:
- Commas are always required for the documented fields.
- More tags/markers can be appended as necessary.
For example:
I/E | NUMBER|BOOL|STR | Tag=”…” | Marker | Tag=”…” | Marker | Tag=”…” | Marker | Tag=”…” | Marker |
INCLUDE, | NUMBER, | Sensor, | engNotation="CenMonitoring", | , |
|
Exclude Number entities that do not have Sensor marker and engNotation tag value= CenMonitoring | |||||
EXCLUDE, | STR, | Note, | , | , |
|
Exclude String entities that have Note marker | |||||