TSM Custom Flags Configuration
Custom flags offer the opportunity to further distinguish and prioritize values by defining flags with a name, a value and a priority.
Configuration Path
Section titled “Configuration Path”HAKOM:TSM:FlagsConfiguration Structure
Section titled “Configuration Structure”Flags└─ CustomFlags └─ CustomFlag └─ {Name} ├─ Name (must repeat {Name}) ├─ Value └─ PriorityQuick Start
Section titled “Quick Start”<HAKOM> <TSM> <Flags> <CustomFlags> <CustomFlag Name="MyCustomFlag"> <Value>42</Value> <Priority>199</Priority> </CustomFlag> <!-- insert more here --> </CustomFlags> </Flags> </TSM></HAKOM>{ "TSM": { "Flags": { "CustomFlags": { "CustomFlag": { "MyCustomFlag": { "Name": "MyCustomFlag", "Value": 42, "Priority": 199 } } } } }}HAKOM__TSM__Flags__CustomFlags__CustomFlag__MyCustomFlag__Name=MyCustomFlagHAKOM__TSM__Flags__CustomFlags__CustomFlag__MyCustomFlag__Value=42HAKOM__TSM__Flags__CustomFlags__CustomFlag__MyCustomFlag__Priority=199Configuration Elements
Section titled “Configuration Elements”Custom flags require the same properties that existing flags offer.
Path: HAKOM:TSM:Flags:CustomFlags:CustomFlag:{Name}
| Element | Type | Default | Required | Description |
|---|---|---|---|---|
Name |
string |
— | ✓ | Name of the custom flag. Must repeat the {Name} key; in XML the Name attribute of <CustomFlag> supplies both. |
Value |
int |
— | ✓ | Value of the custom flag. |
Priority |
int |
— | ✓ | Priority of the custom flag. |
Verifying the Configuration
Section titled “Verifying the Configuration”The configured custom flags are returned together with the built-in flags by the flags endpoint. The response below is shortened.
Request
GET /flagsResponse
[ { "value": 0, "priority": 0, "name": "Ignore" }, { "value": 42, "priority": 199, "name": "MyCustomFlag" }]Was this page helpful?Thanks for your feedback!