IlpUsage.xid.xml
15.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
<?xml version="1.0" encoding="UTF-8" ?>
<specification xmlns="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
xmlns:xid="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd https://xid.location.studio/schema/V1.0.0/XtensibleInterfaceDefinition.xsd"
identity="HpeUsage.xid.xml">
<title>ILP Usage Messages</title>
<comment>This file defines the usage generated and ingested by various ILP Services.</comment>
<import ref="https://xid.location.studio/Tensor/V1.1/Definitions.xid.xml" local="Definitions.xid.xml" />
<import ref="https://xid.location.studio/GeoSpatial/V1.0/SpatialDefs.xid.xml" local="SpatialDefs.xid.xml" />
<import ref="https://xid.location.studio/HPE/V1.2/HpeCore.xid.xml" local="HpeCore.xid.xml" />
<import ref="https://xid.location.studio/Tensor/V1.1/Logging.xid.xml" local="Logging.xid.xml" />
<namespace name="ILP">
<namespace name="Usage">
<using namespace="Tensor"/>
<using namespace="Logging"/>
<using namespace="GeoSpatial"/>
<!-- ReferenceType Enumeration -->
<enum name="ReferenceType" type="Tensor.int8" default="undefined">
<comment>
Specifies the RF radio reference type associated with the contributed or stored data.
</comment>
<literal name="undefined" value="0"/>
<literal name="gsm" value="1"/>
<literal name="cdma" value="2"/>
<literal name="wcdma" value="3"/>
<literal name="lte" value="4"/>
<literal name="nbiot" value="5"/>
<literal name="wifi" value="6"/>
<literal name="bluetooth" value="7"/>
</enum>
<!-- StorageAction Enumeration -->
<enum name="StorageAction" type="Tensor.int8" default="undefined">
<comment>
Specifies the storage action for the specified Reference.
</comment>
<literal name="undefined" value="0"/>
<literal name="added" value="1"/>
<literal name="updated" value="2"/>
<literal name="quarantined" value="3"/>
<literal name="archived" value="4"/>
</enum>
<!-- Reference Type -->
<enum name="ReferenceStatus" type="Tensor.int8" default="undefined">
<comment>
Specifies the staus of references
</comment>
<literal name="undefined" value="0"/>
<literal name="active" value="1"/>
<literal name="quarantined" value="3"/>
</enum>
<!-- ObservationMetric structure -->
<struct name="ObservationMetric" >
<comment>Metric data regarding contribution of obesrvations for a specified reference type within a specified area, time, and device.</comment>
<elem name="reftype" multiplicity="1" type="ReferenceType">
<comment>
RF Reference type specifier.
</comment>
</elem>
<elem name="obsType" multiplicity="0..1" type="ObservationType">
<comment>
Optional observation type specifier. The specific set of observations with the same ObservationType contributed.
</comment>
</elem>
<elem name="countTotal" multiplicity="1" type="uint32">
<comment>
Total count of observations submitted associated with this ObservationMetric.
</comment>
</elem>
<elem name="countWithState" multiplicity="1" type="uint32">
<comment>
Total count of observations submitted with observation state data.
</comment>
</elem>
<elem name="countFloorInfo" multiplicity="1" type="uint32">
<comment>
Total count of observations submitted with floor information.
</comment>
</elem>
<elem name="countHeight" multiplicity="1" type="uint32">
<comment>
Total count of observations submitted with height information. These are full 3-D position in the state specification version 2-D only (horizontal only).
</comment>
</elem>
<elem name="status" multiplicity="1" type="ReferenceStatus">
<comment>
Status of the references represented by this statistic.
</comment>
</elem>
<elem name="bounds" multiplicity="1" type="BoundingBox">
<comment>
Bounding box containing the area encompassing all the reference points captured in this statistic.
</comment>
</elem>
<elem name="posAvg" multiplicity="1" type="PositionECEF">
<comment>
The average (mean) center of the all the reference locations within the specified Bounding Box. Note that this is not necessarily the geometric center of the bounding box.
</comment>
</elem>
</struct>
<!-- StorageStatistic structure -->
<struct name="StatisticMetric" >
<comment>Storage metric data regarding references and areas.</comment>
<elem name="reftype" multiplicity="1" type="ReferenceType">
<comment>
RF Reference type specifier.
</comment>
</elem>
<elem name="count" multiplicity="1" type="uint32">
<comment>
Count of references that this statistic applies to within the specified bounding box.
</comment>
</elem>
<elem name="status" multiplicity="1" type="ReferenceStatus">
<comment>
Status of the references represented by this statistic.
</comment>
</elem>
<elem name="bounds" multiplicity="1" type="BoundingBox">
<comment>
Bounding box containing the area encompassing all the reference points captured in this statistic.
</comment>
</elem>
<elem name="posAvg" multiplicity="1" type="PositionECEF">
<comment>
The average (mean) center of the all the reference locations within the specified Bounding Box. Note that this is not necessarily the geometric center of the bounding box.
</comment>
</elem>
</struct>
<!-- UpdateMetric structure -->
<struct name="UpdateMetric" >
<comment>Storage update metrics for a specified reference type and action.</comment>
<elem name="reftype" multiplicity="1" type="ReferenceType">
<comment>
RF Reference type specifier.
</comment>
</elem>
<elem name="count" multiplicity="1" type="uint32">
<comment>
Count of references that this metric applies.
</comment>
</elem>
<elem name="action" multiplicity="1" type="UpdateMetric">
<comment>
Update action taken on the references represented by this UpdateMetric.
</comment>
</elem>
</struct>
<!--Contribution Msg-->
<struct name="Contribution" type="Logging.UsageMsg" rttkey='"tpf://ilp/contribution"'>
<comment>
Usage message captures ILP data contribution information.
</comment>
<elem name="contributorid" type="string" multiplicity="1">
<comment>
Source contributor identifier, this is typically defined as the source service provider of the data contribution.
Might be the name of a company, internal service, or external service name.
</comment>
</elem>
<elem name="tid" type="UUID" multiplicity="1">
<comment>
Transaction identifier that resulted in generating this contribution. This ID allows linkage of multiple contributions.
</comment>
</elem>
<elem name="tidSequence" type="uint32" multiplicity="0..1">
<comment>
Optional sequence specifier for contributions within a specific transaction (tid). These are provided typically when one
transaction results in multiple contributions. This allows preservation of order information.
</comment>
</elem>
<elem name="devid" type="string" multiplicity="1">
<comment>
Required device identifier, provides a means to associate multiple contributions with a signle device. This need not be a
specific type of device identifier. However, it is desirable to provide unique values so contributions
can be grouped by device.
</comment>
</elem>
<elem name="classDevice" type="string" multiplicity="0..1">
<comment>
Optional device classifier specification describes the type of device: e.g. smartphone, iot, automotive, etc.
</comment>
</elem>
<elem name="mfgDevice" type="string" multiplicity="0..1">
<comment>
Optional device manufacturer specification describes the organization that manufactured the device.
</comment>
</elem>
<elem name="modelDevice" type="string" multiplicity="0..1">
<comment>
Optional device model specification describes the model of the device.
</comment>
</elem>
<elem name="startDate" type="datetime" multiplicity="1">
<comment>
Start date the contributions were made. This is typically when the contributions were measured, or at very least, when they wereo submitted.
</comment>
</elem>
<elem name="endDate" type="datetime" multiplicity="1">
<comment>
End date the contributions were made. This is typically when the contributions were measured, or at very least, when they were submitted.
</comment>
</elem>
<elem name="bounds" multiplicity="1" type="BoundingBox">
<comment>
Bounding box containing the area encompassing all the reference points captured in this statistic.
</comment>
</elem>
<elem name="posAvg" multiplicity="1" type="PositionECEF">
<comment>
The average (mean) center of the all the reference locations within the specified Bounding Box. Note that this is not necessarily the geometric center of the bounding box.
</comment>
</elem>
<elem name="metrics" multiplicity="1..*" type="ObservationMetric">
<comment>
Required one or more ObservationMetric data. See ObservationMetric for more information.
</comment>
</elem>
</struct>
<!--StorageStats Report Msg-->
<struct name="StorageStats" type="Logging.UsageMsg" rttkey='"tpf://ilp/storagestats"'>
<comment>
Usage message captures ILP data storages statistics information.
</comment>
<elem name="storageid" type="string" multiplicity="1">
<comment>
Storage identifier that is providing the storages statistics, this is typically defined as the consumer service provider of the storage update.
Might be the name of a company, internal service, or external service name.
</comment>
</elem>
<elem name="tid" type="UUID" multiplicity="1">
<comment>
Transaction identifier for this set of storage statistics. This ID allows linkage of multiple storage statistics.
</comment>
</elem>
<elem name="tidSequence" type="uint32" multiplicity="0..1">
<comment>
Optional sequence specifier for storage statistics within a specific transaction (tid). These are provided typically when one
transaction results in multiple statistics messages. This allows preservation of order information.
</comment>
</elem>
<elem name="date" type="datetime" multiplicity="1">
<comment>
Date the statistics transaction occurred.
</comment>
</elem>
<elem name="statistics" multiplicity="1..*" type="StatisticMetric">
<comment>
Required one or more StatistinceMetric data. See StatisticMetric for more information.
</comment>
</elem>
</struct>
<!--StorageUpdate Msg-->
<struct name="StorageUpdate" type="Logging.UsageMsg" rttkey='"tpf://ilp/storageupdate"'>
<comment>
Usage message captures ILP data storage update information.
</comment>
<elem name="storageid" type="string" multiplicity="1">
<comment>
Storage identifier that is providing the storages update, this is typically defined as the consumer service provider of the storage update.
Might be the name of a company, internal service, or external service name.
</comment>
</elem>
<elem name="tid" type="UUID" multiplicity="1">
<comment>
Transaction identifier for this set of storage statistics. This ID allows linkage of multiple storage statistics.
</comment>
</elem>
<elem name="tidSequence" type="uint32" multiplicity="0..1">
<comment>
Optional sequence specifier for storage statistics within a specific transaction (tid). These are provided typically when one
transaction results in multiple statistics messages. This allows preservation of order information.
</comment>
</elem>
<elem name="startDate" type="datetime" multiplicity="1">
<comment>
Start date the updates were made. This is typically when the updates were calculated, or at very least, when they were submitted.
</comment>
</elem>
<elem name="endDate" type="datetime" multiplicity="1">
<comment>
End date the updates were made. This is typically when the updates were caluculated, or at very least, when they were submitted.
</comment>
</elem>
<elem name="bounds" multiplicity="1" type="BoundingBox">
<comment>
Bounding box containing the area encompassing all the reference points captured in this update.
</comment>
</elem>
<elem name="posAvg" multiplicity="1" type="PositionECEF">
<comment>
The average (mean) center of the all the reference locations within the specified Bounding Box. Note that this is not necessarily the geometric center of the bounding box.
</comment>
</elem>
<elem name="metrics" multiplicity="1..*" type="UpdateMetric">
<comment>
Required one or more UpdateMetric data. See UpdateMetric for more information.
</comment>
</elem>
</struct>
</namespace>
</namespace>
</specification>