-
Notifications
You must be signed in to change notification settings - Fork 21
/
atr_itemclass_backcoll.md
304 lines (257 loc) · 10.7 KB
/
atr_itemclass_backcoll.md
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
#### [Content](/docs/en/index.md)
### The previous page: [Reference attribute](atr_ref_backref.md)
# Collection attribute
## Description
**Collection** - is a data type that allows you to display the list of other objects in one. The data of the object can be the object of any class including the initial.
All references in the collection are divided with commas. All values of the consequence of the references and commas are stored in the DB.
### Types of connections of the collection type:
1. `one-to-many` - is the classic connection of the heir object to the ancestor object. Define the container and nested object with the reference to the container. In the container, specify the collection and in the collection specify the reference attribute of the nested object. __See Back reference__
2. `many-to-many` - is determined through a collection without references and a class of nested elements — connections are created in the collection and stored as separate entities in the DB. __See Collection__
3. `back collection` - is similar to the `one-to-many` connection but in the opposite direction - connection from the reference object. Set the connection using the *backColl* property.__See Back collection__
### Example of collection
```
{
"orderNumber": 50,
"name": "table",
"caption": "Table",
"type": 14,
"size": null,
"decimals": 0,
"allowedFileTypes": null,
"maxFileCount": 0,
"nullable": true,
"readonly": false,
"indexed": false,
"unique": false,
"autoassigned": false,
"hint": null,
"defaultValue": null,
"refClass": "",
"itemsClass": "collRefCatalog@develop-and-test",
"backRef": "",
"backColl": "",
"binding": "",
"semantic": null,
"selConditions": [],
"selSorting": [],
"selectionProvider": null,
"indexSearch": false,
"eagerLoading": false,
"formula": null
}
```
**NB:** if a collection refers to a class with many heirs, then when filling the collection you can create objects of both the parent and child classes.
Collections together with the object are loaded according to the semantics specified in the meta class of a collection or reference attribute.
## Back reference in the context of collection
The back reference in the context of collection if formed as follows:
- create a regular collection specifying the reference attribute
- in the reference class create the reference attribute, that refers to the initial class and has the `"unique": false` property. The values in the reference attribute is assigned immediately when creating a connection with the collection, without saving the form
- specify the `"backRef"` property in the initial class of the collection. In this property, write down the code of the reference attribute from the reference class
### Example of back reference
```
{
"orderNumber": 30,
"name": "coll",
"caption": "Collection with back reference",
"type": 14,
"size": null,
"decimals": 0,
"allowedFileTypes": null,
"maxFileCount": 0,
"nullable": true,
"readonly": false,
"indexed": false,
"unique": false,
"autoassigned": false,
"hint": null,
"defaultValue": null,
"refClass": null,
"itemsClass": "ref_backcoll_ref@develop-and-test",
"backRef": "ref_backcoll_ref",
"backColl": "",
"binding": "",
"semantic": "backcoll_data",
"selConditions": [],
"selSorting": [],
"selectionProvider": null,
"indexSearch": false,
"eagerLoading": true,
"formula": null
}
```
## Display mode of the "Collection" attribute on the form:
You can set the display mode in the meta view. Set the mode using the `"mode"` property or the `"options"` property to set it as a template.
* **mode: 4** - "Tag Cloud" stores the values of one or several objects by reference in the form of tags, the name of which is determined by the semantics of the object by reference.
* **mode: 3** - "Table" stores the values of one or several objects by reference in a table, the columns of which are predefined for the view form.
### Example:
```
{
"caption": "Table",
"type": 3,
"property": "table",
"size": 2,
"maskName": null,
"mask": null,
"mode": 3,
"fields": [],
"columns": [],
...
},
...
```
* **"Comment"** - is set in the same way as the “Table” display mode, but with the template specified in the `"options"` property. It is a field that contains data that was predefined in the `"columns"` property for an object by reference. It is intended to discuss information on an object at a certain stage of a workflow.
### Example:
```
{
"caption": "Comment",
"type": 3,
"property": "coment",
"size": 2,
"maskName": null,
"mask": null,
"mode": 3,
"fields": [],
"columns": [
{
"sorted": true,
"caption": "Date",
"type": 120,
"property": "date",
...
},
{
"sorted": true,
"caption": "Confirmation (Rationale)",
"type": 7,
"property": "descript",
...
},
{
"caption": "Lead",
"type": 2,
"property": "owner",
...
}
],
"actions": null,
"commands": [
{
"id": "CREATE",
"caption": "Create",
"visibilityCondition": null,
"enableCondition": null,
"needSelectedItem": false,
"signBefore": false,
"signAfter": false,
"isBulk": false
},
{
"id": "EDIT",
"caption": "Edit",
"visibilityCondition": null,
"enableCondition": null,
"needSelectedItem": true,
"signBefore": false,
"signAfter": false,
"isBulk": false
}
],
"orderNumber": 80,
...
"tags": null,
"options": {
"template": "comments",
"comments": {
"textProperty": "descript",
"userProperty": "owner",
"parentProperty": "answlink",
"photoProperty": "owner_ref.foto.link",
"dateProperty": "date"
}
}
}
```
# Back collection
The previous example can be converted into the back collection as follows:
```
{
"orderNumber": 30,
"name": "backcoll",
"caption": "Back collection",
"type": 14,
"size": null,
"decimals": 0,
"allowedFileTypes": null,
"maxFileCount": 0,
"nullable": true,
"readonly": false,
"indexed": false,
"unique": false,
"autoassigned": false,
"hint": null,
"defaultValue": null,
"refClass": "",
"itemsClass": "coll_backcoll_coll",
"backRef": "",
"backColl": "coll",
"binding": "",
"semantic": "backcoll_data",
"selConditions": [],
"selSorting": [],
"selectionProvider": null,
"indexSearch": false,
"eagerLoading": true,
"formula": null
}
```
Pay attention to the `"backColl"` property, which contains an additional value — the name of an attribute from a class in the collection (from the example above - coll).
Thus, a many-to-many connection is realized without an intermediate class. Not only the `"backcoll"` attribute with the "Collection" type can contain several references, but objects by reference can also contain several references to objects of the original class in their "coll" collection.
**Attention**
- `"type": 14` - the attribute type "Collection"
- `"backColl"` - the name of the reference attribute of the collection type, that refers to the initial collection class.
- `"itemsClass"` - the name of the class whose objects can store their identifiers in the collection and, thus, form a reference to the object by identifier.
- `"backRef"` - the attribute reference from the reference class specified in `" itemsClass "`
- When specifying a parent class, it is possible to create objects of the parent and child classes
- Collections with objects are loaded according to the semantics specified in the collection class or the collection attribute
## Colour highlighted objects in Collection
Use it when it is necessary to highlight the objects in the attribute table of the "Collection" type, according to some conditions. The configuration is the same as in the [conditions for highlighting objects in lists](/docs/en/2_system_description/metadata_structure/meta_view/styles.md).
You can set it in the meta view of the class for the attribute of the "Collection" type. The `"options"` property.
### Example
```
{
"caption": "Field with collection",
"type": 3,
"property": "testCol",
...
"columns": [
....
],
...
"options": {
"styles": {
"attention-1": "nempty($atrOfItemsClass)"
}
}
},
```
## Collection processing and storage format
To save the collection, transfer the array of actions (the example below) in the corresponding attribute of the object:
```
"collection": [
{"action": "put", "id": "1234"},
{"action": "put", "id": "1235"},
{"action": "put", "id": "1236"},
{"action": "eject", "id": "1230"}
]
```
The order of the objects must correspond to the order of relevant actions. Available operations: `put` - add to the collection,` eject` - extract from the collection. The algorithm for creating and editing is the same. Actions on collections are performed after the container is created or saved.
The working principle of collections on the create and edit form is fundamentally different:
* On the create form, interconnection with the server is required only to receive and display in the table the selected/created object of the collection
* On the edite form, it is possible to get a server response if necessary, and to change the select parameters upon request, depending on the actions performed in the collection.
### The next page: [Conditions of sorting the valid values](atr_selconditions.md)
--------------------------------------------------------------------------
#### [Licence](/LICENSE)   [Contact us](https://iondv.com/portal/contacts)   [Russian](/docs/ru/2_system_description/metadata_structure/meta_class/atr_itemclass_backcoll.md)  
<div><img src="https://mc.iondv.com/watch/local/docs/framework" style="position:absolute; left:-9999px;" height=1 width=1 alt="iondv metrics"></div>
--------------------------------------------------------------------------
Copyright (c) 2018 **LLC "ION DV"**.
All rights reserved.