-
Notifications
You must be signed in to change notification settings - Fork 0
/
datamodel.jb-lnkconnectablecitoconnectableci.xml
432 lines (393 loc) · 14 KB
/
datamodel.jb-lnkconnectablecitoconnectableci.xml
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
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
<?xml version="1.0" encoding="UTF-8"?>
<itop_design xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.6">
<classes>
<class id="lnkConnectableCIToConnectableCI" _delta="define">
<parent>cmdbAbstractObject</parent>
<properties>
<is_link>1</is_link>
<category>bizmodel</category>
<abstract>false</abstract>
<key_type>autoincrement</key_type>
<db_table>lnkconnectablecitoconnectableci</db_table>
<db_key_field>id</db_key_field>
<db_final_class_field/>
<naming>
<attributes>
<attribute id="device1_id"/>
<attribute id="device2_id"/>
</attributes>
</naming>
<display_template/>
<icon/>
<reconciliation>
<attributes>
<attribute id="device1_id"/>
<attribute id="device2_id"/>
</attributes>
</reconciliation>
</properties>
<fields>
<field id="device1_id" xsi:type="AttributeExternalKey">
<sql>device1_id</sql>
<target_class>ConnectableCI</target_class>
<is_null_allowed>false</is_null_allowed>
<on_target_delete>DEL_AUTO</on_target_delete>
</field>
<field id="device1_name" xsi:type="AttributeExternalField">
<extkey_attcode>device1_id</extkey_attcode>
<target_attcode>name</target_attcode>
</field>
<field id="device1_port" xsi:type="AttributeString">
<sql>device1_port</sql>
<default_value/>
<is_null_allowed>true</is_null_allowed>
</field>
<field id="device2_id" xsi:type="AttributeExternalKey">
<sql>device2_id</sql>
<target_class>ConnectableCI</target_class>
<is_null_allowed>false</is_null_allowed>
<on_target_delete>DEL_AUTO</on_target_delete>
</field>
<field id="device2_name" xsi:type="AttributeExternalField">
<extkey_attcode>device2_id</extkey_attcode>
<target_attcode>name</target_attcode>
</field>
<field id="device2_port" xsi:type="AttributeString">
<sql>device2_port</sql>
<default_value/>
<is_null_allowed>true</is_null_allowed>
</field>
<field id="connection_type" xsi:type="AttributeEnum">
<values>
<value id="uplink">uplink</value>
<value id="downlink">downlink</value>
</values>
<sql>type</sql>
<default_value>downlink</default_value>
<is_null_allowed>false</is_null_allowed>
<display_style>list</display_style>
</field>
<field id="patch_label" xsi:type="AttributeString" _delta="define">
<sql>patch_label</sql>
<default_value/>
<is_null_allowed>true</is_null_allowed>
</field>
<field id="cable_type" xsi:type="AttributeEnum" _delta="define">
<sql>cable_type</sql>
<default_value>rj45</default_value>
<is_null_allowed>true</is_null_allowed>
<values>
<value id="rj45">rj45</value>
<value id="optical_fiber_single_mode">optical_fiber_single_mode</value>
<value id="optical_fiber_multi_mode">optical_fiber_multi_mode</value>
<value id="usb_3_0">usb_3_0</value>
</values>
</field>
<field id="comment" xsi:type="AttributeString" _delta="define">
<sql>comment</sql>
<default_value/>
<is_null_allowed>true</is_null_allowed>
</field>
</fields>
<methods>
<method id="IsSupportedDevice">
<static>false</static>
<access>protected</access>
<type>Overload-cmdbAbstractObject</type>
<arguments/>
<code>
<![CDATA[
protected function IsSupportedDevice() {
// The device might already be deleted (reentrance in the current procedure when both device are NETWORK devices!)
$oDevice = MetaModel::GetObject('ConnectableCI', $this->Get('device1_id'), false);
// Only subclasses of a Network Device and of IP Phones are supported.
// IPPhone relies on jb-ipdevices, hence a string comparison.
return (is_object($oDevice) && ($oDevice instanceof NetworkDevice || get_class($oDevice) == 'IPPhone'));
}]]></code>
</method>
<method id="AddCounterPartLink">
<static>false</static>
<access>protected</access>
<type>Overload-cmdbAbstractObject</type>
<code>
<![CDATA[
protected function AddCounterPartLink() {
/*
Explanation:
ConnectableCI has a field 'networkdevice_list'. It's an indirect set, meaning multiple connections are possible.
networkdevice_list (originally lnkConnectableCIToNetworkDevice) uses device1_id to refer to itself (NAS, Server, ...)
and device2_id to point to what's remotely connected.
The logic below is easier if you think from the perspective of the original lnkConnectableCIToNetworkDevice class.
Example 1: from the details view of a PC, a link with a network device is added.
- AddCounterPartLink() is triggered. Type of device1_id = pc; device2_id = NetworkDevice (switch).
- $oDevice is an object (pc).
- Only Network Device subclasses and IPPhone are supported. Otherwise no link is created.
Example 2: from the details view of a Network Device (or IP Phone = switch), a link with a network device is added.
- AddCounterPartLink() is triggered. Type of device1_id = NetworkDevice; device2_id = NetworkDevice (switch).
- $oDevice is an object (NetworkDevice). It's of the right type (!= NAS, Server, ...).
- The counterpart is created.
So how is this handled in the datamodel?
- ConnectableCI has an AttributeLinkedSetIndirect -> networkdevice_list -> ext_key_to_me = device1_id ; ext_key_to_remote = device2_id (PCs, Server etc)
- NetworkDevice has an AttributeLinkedSetIndirect -> connectablecis_list -> ext_key_to_me = network_id ; ext_key_to_remote = device1_id
NetworkDevice still has networkdevice_list, but it's hidden in presentation. (see data model viewer)
*/
if($this->IsSupportedDevice()) {
$oLnkCounterPart = $this->GetCounterPart('create');
if($oLnkCounterPart === null) {
// For the counterpart, the IDs, ports and uplink/downlink are switched around.
$oNewLink = new lnkConnectableCIToConnectableCI();
$oNewLink->Set('device2_id', $this->Get('device1_id'));
$oNewLink->Set('device1_id', $this->Get('device2_id'));
$oNewLink->Set('device2_port', $this->Get('device1_port'));
$oNewLink->Set('device1_port', $this->Get('device2_port'));
$oNewLink->Set('patch_label', $this->Get('patch_label'));
$oNewLink->Set('comment', $this->Get('comment'));
$oNewLink->Set('cable_type', $this->Get('cable_type'));
$oNewLink->Set('connection_type', ($this->Get('connection_type') == 'uplink' ? 'downlink' : 'uplink'));
$oNewLink->DBInsert();
}
}
}]]></code>
</method>
<method id="UpdateCounterPartLink">
<static>false</static>
<access>protected</access>
<type>Overload-cmdbAbstractObject</type>
<code>
<![CDATA[
protected function UpdateCounterPartLink() {
if($this->IsSupportedDevice()) {
$oLnkCounterPart = $this->GetCounterPart('update');
// There should be one link - do it in a safe manner anyway
if($oLnkCounterPart !== null) {
$oLnkCounterPart->Set('connection_type', ($this->Get('connection_type') == 'uplink' ? 'downlink' : 'uplink'));
$oLnkCounterPart->Set('device1_port', $this->Get('device2_port'));
$oLnkCounterPart->Set('device2_port', $this->Get('device1_port'));
$oLnkCounterPart->Set('patch_label', $this->Get('patch_label'));
$oLnkCounterPart->Set('comment', $this->Get('comment'));
$oLnkCounterPart->Set('cable_type', $this->Get('cable_type'));
$oLnkCounterPart->DBUpdate();
}
}
}]]></code>
</method>
<method id="DeleteCounterPartLink">
<static>false</static>
<access>protected</access>
<type>Overload-cmdbAbstractObject</type>
<code>
<![CDATA[
protected function DeleteCounterPartLink() {
if($this->IsSupportedDevice()) {
$oLnkCounterPart = $this->GetCounterPart('delete');
// There should be one link - do it in a safe manner anyway
if($oLnkCounterPart !== null) {
$oLnkCounterPart->DBDelete();
}
}
}]]></code>
</method>
<method id="AfterInsert">
<static>false</static>
<access>protected</access>
<type>Overload-DBObject</type>
<code>
<![CDATA[
protected function AfterInsert() {
$this->AddCounterPartLink();
parent::AfterInsert();
}]]></code>
</method>
<method id="AfterUpdate">
<static>false</static>
<access>protected</access>
<type>Overload-DBObject</type>
<code>
<![CDATA[
protected function AfterUpdate() {
$this->UpdateCounterPartLink();
parent::AfterUpdate();
}]]></code>
</method>
<method id="AfterDelete">
<static>false</static>
<access>protected</access>
<type>Overload-DBObject</type>
<code>
<![CDATA[
protected function AfterDelete() {
$this->DeleteCounterPartLink();
parent::AfterDelete();
}]]></code>
</method>
<method id="GetCounterPart">
<static>false</static>
<access>protected</access>
<type>Overload-cmdbAbstractObject</type>
<arguments>
<argument id="1">
<type>string</type>
<mandatory>true</mandatory>
</argument>
</arguments>
<code>
<![CDATA[
protected function GetCounterPart($sAction) {
// Find the exact same link
$sOQL = "SELECT lnkConnectableCIToConnectableCI WHERE device1_id = :device1_id AND device2_id = :device2_id AND device1_port = :device1_port AND device2_port = :device2_port AND patch_label = :patch_label AND comment = :comment AND connection_type = :connection_type AND cable_type = :cable_type";
// Switch device_id and device_port around (1 <=> 2); do same for uplink/downlink
// In case of updated ports, retrieve original info (before edit):
if($sAction == 'update') {
$aQueryArgs = [
'device1_id' => $this->Get('device2_id'),
'device1_port' => $this->GetOriginal('device2_port'),
'device2_id' => $this->Get('device1_id'),
'device2_port' => $this->GetOriginal('device1_port'),
'connection_type' => ($this->GetOriginal('connection_type') == 'uplink' ? 'downlink' : 'uplink'),
'patch_label' => $this->GetOriginal('patch_label'),
'comment' => $this->GetOriginal('comment'),
'cable_type' => $this->GetOriginal('cable_type')
];
}
// In case of deletion of original link, just find the counter part
else {
$aQueryArgs = [
'device1_id' => $this->Get('device2_id'),
'device1_port' => $this->Get('device2_port'),
'device2_id' => $this->Get('device1_id'),
'device2_port' => $this->Get('device1_port'),
'connection_type' => ($this->Get('connection_type') == 'uplink' ? 'downlink' : 'uplink'),
'patch_label' => $this->Get('patch_label'),
'comment' => $this->Get('comment'),
'cable_type' => $this->Get('cable_type')
];
}
$oSet = new DBObjectSet(DBObjectSearch::FromOQL($sOQL),
[],
$aQueryArgs
);
return $oSet->Fetch();
}
]]></code>
</method>
</methods>
<presentation>
<details>
<items>
<item id="device1_id">
<rank>10</rank>
</item>
<item id="device1_port">
<rank>20</rank>
</item>
<item id="device2_id">
<rank>30</rank>
</item>
<item id="device2_port">
<rank>40</rank>
</item>
<item id="connection_type">
<rank>50</rank>
</item>
<item id="patch_label">
<rank>60</rank>
</item>
<item id="cable_type">
<rank>70</rank>
</item>
<item id="comment">
<rank>80</rank>
</item>
</items>
</details>
<search>
<items>
<item id="device1_id">
<rank>10</rank>
</item>
<item id="device1_port">
<rank>20</rank>
</item>
<item id="device2_id">
<rank>30</rank>
</item>
<item id="device2_port">
<rank>40</rank>
</item>
<item id="connection_type">
<rank>50</rank>
</item>
<item id="patch_label">
<rank>60</rank>
</item>
<item id="cable_type">
<rank>70</rank>
</item>
</items>
</search>
<list>
<items>
<item id="device1_id">
<rank>10</rank>
</item>
<item id="device1_port">
<rank>20</rank>
</item>
<item id="device2_id">
<rank>30</rank>
</item>
<item id="device2_port">
<rank>40</rank>
</item>
<item id="connection_type">
<rank>50</rank>
</item>
<item id="patch_label">
<rank>60</rank>
</item>
<item id="cable_type">
<rank>70</rank>
</item>
<item id="comment">
<rank>80</rank>
</item>
</items>
</list>
</presentation>
</class>
<class id="ConnectableCI">
<fields>
<field id="networkdevice_list" xsi:type="AttributeLinkedSetIndirect">
<linked_class _delta="redefine">lnkConnectableCIToConnectableCI</linked_class>
<ext_key_to_me _delta="redefine">device2_id</ext_key_to_me>
<ext_key_to_remote _delta="redefine">device1_id</ext_key_to_remote>
</field>
</fields>
</class>
<class id="NetworkDevice">
<fields>
<field id="connectablecis_list" xsi:type="AttributeLinkedSetIndirect">
<linked_class _delta="redefine">lnkConnectableCIToConnectableCI</linked_class>
<ext_key_to_me _delta="redefine">device1_id</ext_key_to_me>
<ext_key_to_remote _delta="redefine">device2_id</ext_key_to_remote>
</field>
</fields>
<relations>
<relation id="impacts">
<neighbours>
<neighbour id="connectableci">
<query_down _delta="redefine">
<!-- Downstream = impacts. Get all CIs to which there is a downlink. -->
<![CDATA[SELECT ConnectableCI AS relatedCI JOIN lnkConnectableCIToConnectableCI AS link ON link.device2_id = relatedCI.id WHERE link.device1_id = :this->id AND link.connection_type = 'downlink']]>
</query_down>
<query_up _delta="redefine">
<!-- Upstream = depends on. Get all CIs to which there is an uplink. -->
<![CDATA[SELECT ConnectableCI AS relatedCI JOIN lnkConnectableCIToConnectableCI AS link ON link.device2_id = relatedCI.id WHERE link.device1_id = :this->id AND link.connection_type = 'uplink']]>
</query_up>
</neighbour>
</neighbours>
</relation>
</relations>
</class>
</classes>
</itop_design>