Era.Common.DataDefinition.Symbol.SymbolDefinition
Description
Definition of a symbol.
A symbol is a single and unique kind of information, like "computer name" or "time of last scan". A symbol can be seen as a database column (even though it doesn't necessarily have to represent database data).
Symbols are used on several places in ERA, like reporting, rules for dynamic groups, filters for event log triggers, data transfer between ERA components, ...
Properties
| Name |
JsonSchemaType |
Description |
| data_id |
integer |
Data ID of the symbol. Typically, symbols derived from the same data have the same data ID. E.g. "computer name" and "count (computer name)". |
| default_format |
reference to Era.Common.DataDefinition.Reports.Format |
Default format for the symbol, which is preferred when adding this symbol to a report. |
| default_label |
reference to Era.Common.DataDefinition.Common.Label |
Name of the symbol. |
| default_tendency |
reference to Era.Common.DataDefinition.Reports.Tendency |
Default tendency, which should be used in a report. Simplified, says, whether larger values of the symbol are "good" or "bad". |
| field_of_interest_id |
integer |
ID of symbol's field of interest. Usually, symbols belonging to the same log or static object are grouped in one field of interest. E.g. "computer name" and "computer description". |
| log_id |
integer |
ID of the log, from which this symbol was taken or computed. |
| predefined_constant |
array of references to Era.Common.DataDefinition.Symbol.SymbolDefinition_PredefinedConstant |
Optional list of predefined constants for this symbol. The user may select from these values instead of typing the value. |
| symbol_aggregation |
enum of Era.Common.DataDefinition.Symbol.SymbolDefinition_SymbolAggregation |
Aggregation of the symbol. Always set this field, as if it is required. |
| symbol_data_type |
enum of Era.Common.DataDefinition.Symbol.SymbolDefinition_SymbolDataType |
Data type of the symbol. Always set this field, as if it is required. |
| symbol_id |
integer |
ID of the symbol. This is the main ID by which symbols are identified. |
| variable_name |
string |
variable name that can be used for textual notifications. If it is not set or empty then the symbol cannot be used with a variable name |
Dual message (request/response)
No dual message.Referenced in messages
Era.Common.NetworkMessage.ConsoleApi.Symbols.RpcGetAllSymbolsResponse
JsonSchema
{
"title": "Era.Common.DataDefinition.Symbol.SymbolDefinition",
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"additionalProperties": false,
"required": [
"Era.Common.DataDefinition.Symbol.SymbolDefinition"
],
"properties": {
"Era.Common.DataDefinition.Symbol.SymbolDefinition": {
"$ref": "#/definitions/SymbolDefinition"
}
},
"definitions": {
"SymbolDefinition": {
"additionalProperties": false,
"required": [
"data_id",
"symbol_id"
],
"type": "object",
"properties": {
"data_id": {
"type": "integer"
},
"default_format": {
"$ref": "Era.Common.DataDefinition.Reports.Format#/definitions/Format"
},
"default_label": {
"$ref": "Era.Common.DataDefinition.Common.Label#/definitions/Label"
},
"default_tendency": {
"$ref": "Era.Common.DataDefinition.Reports.Tendency#/definitions/Tendency"
},
"field_of_interest_id": {
"type": "integer"
},
"log_id": {
"type": "integer"
},
"predefined_constant": {
"type": "array",
"items": [
{
"$ref": "Era.Common.DataDefinition.Symbol.SymbolDefinition_PredefinedConstant#/definitions/SymbolDefinition_PredefinedConstant"
}
]
},
"symbol_aggregation": {
"enum": [
4,
0,
1,
2,
3,
5,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59
]
},
"symbol_data_type": {
"enum": [
99,
0,
1,
2,
3,
4,
56,
57,
58,
52,
53,
80,
6,
70,
26,
27,
28,
29,
30,
31,
98,
111,
127,
7,
8,
9,
115,
116,
119,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
23,
24,
25,
54,
89,
122,
90,
95,
112,
120,
50,
51,
92,
81,
82,
83,
84,
55,
60,
64,
65,
66,
61,
63,
59,
62,
67,
68,
69,
71,
72,
73,
74,
76,
75,
77,
78,
86,
87,
88,
91,
93,
94,
106,
96,
97,
101,
102,
103,
104,
105,
114,
117,
118,
121,
123,
124,
125,
126,
128,
129,
130,
131,
132,
133,
134,
135,
136,
137,
138,
139,
140,
141,
142,
143,
144,
145,
146,
147,
148,
149,
150,
151,
152,
153,
154,
155,
156,
107,
108,
109,
110,
113,
85,
100
]
},
"symbol_id": {
"type": "integer"
},
"variable_name": {
"type": "string"
}
}
}
}
}