pyegeria 5.4.0.dev6__py3-none-any.whl → 5.4.0.dev8__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (16) hide show
  1. commands/cat/debug_log +4773 -0
  2. commands/cat/dr_egeria_command_help.py +273 -0
  3. commands/cat/dr_egeria_md.py +2 -2
  4. md_processing/data/commands.json +3752 -1297
  5. md_processing/md_commands/data_designer_commands.py +27 -126
  6. md_processing/md_processing_utils/debug_log +0 -0
  7. md_processing/md_processing_utils/generate_dr_help.py +150 -0
  8. md_processing/md_processing_utils/generate_md_templates.py +92 -0
  9. md_processing/md_processing_utils/generated_help_terms.md +842 -0
  10. pyegeria/data_designer_omvs.py +2 -2
  11. pyegeria/output_formatter.py +8 -3
  12. {pyegeria-5.4.0.dev6.dist-info → pyegeria-5.4.0.dev8.dist-info}/METADATA +1 -1
  13. {pyegeria-5.4.0.dev6.dist-info → pyegeria-5.4.0.dev8.dist-info}/RECORD +16 -10
  14. {pyegeria-5.4.0.dev6.dist-info → pyegeria-5.4.0.dev8.dist-info}/entry_points.txt +1 -0
  15. {pyegeria-5.4.0.dev6.dist-info → pyegeria-5.4.0.dev8.dist-info}/LICENSE +0 -0
  16. {pyegeria-5.4.0.dev6.dist-info → pyegeria-5.4.0.dev8.dist-info}/WHEEL +0 -0
md_processing/md_processing_utils/generated_help_terms.md ADDED
@@ -0,0 +1,842 @@
1
+ # Generating glossary entries for the documented commands
2
+
3
+
4
+ This file contains generated Dr.Egeria commands to generate glossary term entries describing
5
+ each command represented in the `commands.json` file.
6
+ # Create Term
7
+ ## Term Name
8
+
9
+ Create Data Dictionary
10
+
11
+ ## Description
12
+
13
+ A Data Dictionary is an organized and curated collection of data definitions that can serve as a reference for data professionals
14
+
15
+ ## Owning Glossary
16
+
17
+ Egeria-Markdown
18
+
19
+ ## Categories
20
+
21
+ Writing Dr.Egeria Markdown
22
+
23
+ ## Usage
24
+
25
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
26
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
27
+ | Display Name | True | True | False | None | Name of the Data Dictionary | False | |
28
+ | Description | False | True | False | None | A description of the Data Dictionary. | False | |
29
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
30
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
31
+
32
+
33
+ ___
34
+
35
+ # Create Term
36
+ ## Term Name
37
+
38
+ Create Data Specification
39
+
40
+ ## Description
41
+
42
+ A Data Specification defines the data requirements for a project or initiative. This includes the data structures , data fields and data classes.
43
+
44
+ ## Owning Glossary
45
+
46
+ Egeria-Markdown
47
+
48
+ ## Categories
49
+
50
+ Writing Dr.Egeria Markdown
51
+
52
+ ## Usage
53
+
54
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
55
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
56
+ | Display Name | True | True | False | None | Name of the Data Specification. | False | |
57
+ | Description | False | True | False | None | A description of the Data Specification. | False | |
58
+ | Collection Type | False | True | False | None | A user supplied collection type. | False | |
59
+ | Qualified Name | True | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
60
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
61
+
62
+
63
+ ___
64
+
65
+ # Create Term
66
+ ## Term Name
67
+
68
+ Create Data Structure
69
+
70
+ ## Description
71
+
72
+ A collection of data fields that for a data specification for a data source.
73
+
74
+ ## Owning Glossary
75
+
76
+ Egeria-Markdown
77
+
78
+ ## Categories
79
+
80
+ Writing Dr.Egeria Markdown
81
+
82
+ ## Usage
83
+
84
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
85
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
86
+ | Display Name | True | True | False | None | Name of the data structure. | False | |
87
+ | Description | False | True | False | None | A description of the data structure. | False | |
88
+ | In Data Specification | False | True | False | None | The data specifications this structure is a member of. | False | |
89
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
90
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
91
+
92
+
93
+ ___
94
+
95
+ # Create Term
96
+ ## Term Name
97
+
98
+ Create Data Field
99
+
100
+ ## Description
101
+
102
+ A data field is a fundamental building block for a data structure.
103
+
104
+ ## Owning Glossary
105
+
106
+ Egeria-Markdown
107
+
108
+ ## Categories
109
+
110
+ Writing Dr.Egeria Markdown
111
+
112
+ ## Usage
113
+
114
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
115
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
116
+ | Display Name | True | True | False | None | Name of the Data Field | False | |
117
+ | Description | False | True | False | None | A description of the Data Field | False | |
118
+ | Data Type | True | True | False | None | The data type of the data field. Point to data type valid value list if exists. | False | string; int; long; date; boolean; char; byte; float; double; biginteger; bigdecimal; array<string>; array<int>; map<string,string>; map<string, boolean>; map<string, int>; map<string, long>; map<string,double>; map<string, date> map<string, object>; short; map<string, array<string>>; other |
119
+ | Position | False | True | False | None | Position of the data field in the data structure. If 0, position is irrelevant. | False | |
120
+ | Minimum Cardinality | False | True | False | None | The minimum cardinality for a data element. | False | |
121
+ | Maximum Cardinality | False | True | False | None | The maximum cardinality for a data element. | False | |
122
+ | In Data Structure | False | True | False | None | The data structure this field is a member of. If display name is not unique, use qualified name. | False | |
123
+ | Data Class | False | True | False | None | The data class that values of this data field conform to. | False | |
124
+ | Glossary Term | False | True | False | None | Term that provides meaning to this field. | False | |
125
+ | isNullable | False | True | False | None | Can the values within the dataclass be absent? | False | |
126
+ | Minimum Length | False | True | False | None | | False | |
127
+ | Length | False | True | False | None | The length of a value for a field. | False | |
128
+ | Precision | False | True | False | None | The precision of a numeric | False | |
129
+ | Ordered Values | False | True | False | None | is this field in an ordered list? | False | |
130
+ | Units | False | True | False | None | An optional string indicating the units of the field. | False | |
131
+ | Default Value | False | True | False | None | Specify a default value for the data class. | False | |
132
+ | Version Identifier | False | True | False | None | A user supplied version identifier. | False | |
133
+ | In Data Dictionary | False | True | False | None | What data dictionaries is this data field in? | False | |
134
+ | Parent Data Field | False | True | False | None | Optional parent field if this is a nested field. | False | |
135
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
136
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
137
+
138
+
139
+ ___
140
+
141
+ # Create Term
142
+ ## Term Name
143
+
144
+ Create Data Class
145
+
146
+ ## Description
147
+
148
+ Describes the data values that may be stored in data fields. Can be used to configure quality validators and data field classifiers.
149
+
150
+ ## Owning Glossary
151
+
152
+ Egeria-Markdown
153
+
154
+ ## Categories
155
+
156
+ Writing Dr.Egeria Markdown
157
+
158
+ ## Usage
159
+
160
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
161
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
162
+ | Display Name | True | True | False | None | Name of the data structure. | False | |
163
+ | Description | False | True | False | None | A description of the data class. | False | |
164
+ | Namespace | False | True | False | None | Optional namespace that scopes the field. | False | |
165
+ | Match Property Names | False | True | True | None | Names of the properties that are set. | False | |
166
+ | Match Threshold | False | True | False | None | Percent of values that must match the data class specification. | False | |
167
+ | IsCaseSensitive | False | True | False | None | Are field values case sensitive? | False | |
168
+ | Data Type | True | True | False | None | Data type for the data class. | False | string; int; long; date; boolean; char; byte; float; double; biginteger; bigdecimal; array<string>; array<int>; map<string,string>; map<string, boolean>; map<string, int>; map<string, long>; map<string,double>; map<string, date> map<string, object>; short; map<string, array<string>>; other |
169
+ | Allow Duplicate Values | False | True | False | None | Allow duplicate values within the data class? | False | |
170
+ | isNullable | False | True | False | None | Can the values within the dataclass be absent? | False | |
171
+ | isCaseSensitive | False | True | False | None | Indicates if the values in a data class are case sensitive. | False | |
172
+ | Default Value | False | True | False | None | Specify a default value for the data class. | False | |
173
+ | Average Value | False | True | False | None | Average value for the data class. | False | |
174
+ | Value List | False | True | False | None | | False | |
175
+ | Value Range From | False | True | False | None | Beginning range of legal values. | False | |
176
+ | Value Range To | False | True | False | None | End of valid range for value. | False | |
177
+ | Sample Values | False | True | False | None | Sample values of the data class. | False | |
178
+ | Data Patterns | False | True | False | None | prescribed format of a data field - e.g. credit card numbers. Often expressed as a regular expression. | False | |
179
+ | In Data Dictionary | False | True | False | None | What data dictionaries is this data field in? | False | |
180
+ | Containing Data Class | False | True | False | None | Data classes this is part of. | False | |
181
+ | Specializes Data Class | False | True | False | None | Specializes a parent data class. | False | |
182
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
183
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
184
+
185
+
186
+ ___
187
+
188
+ # Create Term
189
+ ## Term Name
190
+
191
+ View Data Fields
192
+
193
+ ## Description
194
+
195
+ Return the data fields, optionally filtered by the search string.
196
+
197
+ ## Owning Glossary
198
+
199
+ Egeria-Markdown
200
+
201
+ ## Categories
202
+
203
+ Writing Dr.Egeria Markdown
204
+
205
+ ## Usage
206
+
207
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
208
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
209
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
210
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; MERMAID; DICT |
211
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
212
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
213
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
214
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
215
+ | Sort Order | False | True | False | None | How to order the results. The sort order can be selected from a list of valid value. | False | ANY; CREATION_DATE_RECENT; CREATION_DATA_OLDEST; LAST_UPDATE_RECENT; LAST_UPDATE_OLDEST; PROPERTY_ASCENDING; PROPERTY_DESCENDING |
216
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
217
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
218
+
219
+
220
+ ___
221
+
222
+ # Create Term
223
+ ## Term Name
224
+
225
+ View Data Classes
226
+
227
+ ## Description
228
+
229
+ Return the data classes, optionally filtered by the search string.
230
+
231
+ ## Owning Glossary
232
+
233
+ Egeria-Markdown
234
+
235
+ ## Categories
236
+
237
+ Writing Dr.Egeria Markdown
238
+
239
+ ## Usage
240
+
241
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
242
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
243
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
244
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; MERMAID; DICT |
245
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
246
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
247
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
248
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
249
+ | Sort Order | False | True | False | None | How to order the results. The sort order can be selected from a list of valid value. | False | ANY; CREATION_DATE_RECENT; CREATION_DATA_OLDEST; LAST_UPDATE_RECENT; LAST_UPDATE_OLDEST; PROPERTY_ASCENDING; PROPERTY_DESCENDING |
250
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
251
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
252
+
253
+
254
+ ___
255
+
256
+ # Create Term
257
+ ## Term Name
258
+
259
+ View Data Structures
260
+
261
+ ## Description
262
+
263
+ Return the data structures, optionally filtered by the search string.
264
+
265
+ ## Owning Glossary
266
+
267
+ Egeria-Markdown
268
+
269
+ ## Categories
270
+
271
+ Writing Dr.Egeria Markdown
272
+
273
+ ## Usage
274
+
275
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
276
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
277
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
278
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
279
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
280
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
281
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
282
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
283
+ | Sort Order | False | True | False | None | How to order the results. The sort order can be selected from a list of valid value. | False | ANY; CREATION_DATE_RECENT; CREATION_DATA_OLDEST; LAST_UPDATE_RECENT; LAST_UPDATE_OLDEST; PROPERTY_ASCENDING; PROPERTY_DESCENDING |
284
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
285
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
286
+
287
+
288
+ ___
289
+
290
+ # Create Term
291
+ ## Term Name
292
+
293
+ View Data Specifications
294
+
295
+ ## Description
296
+
297
+ Return the data specifications, optionally filtered by the search string.
298
+
299
+ ## Owning Glossary
300
+
301
+ Egeria-Markdown
302
+
303
+ ## Categories
304
+
305
+ Writing Dr.Egeria Markdown
306
+
307
+ ## Usage
308
+
309
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
310
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
311
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
312
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; DICT; MD; MERMAID; REPORT |
313
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
314
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
315
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
316
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
317
+ | Sort Order | False | True | False | None | How to order the results. The sort order can be selected from a list of valid value. | False | ANY; CREATION_DATE_RECENT; CREATION_DATA_OLDEST; LAST_UPDATE_RECENT; LAST_UPDATE_OLDEST; PROPERTY_ASCENDING; PROPERTY_DESCENDING |
318
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
319
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
320
+
321
+
322
+ ___
323
+
324
+ # Create Term
325
+ ## Term Name
326
+
327
+ View Data Dictionaries
328
+
329
+ ## Description
330
+
331
+ Return the data dictionaries, optionally filtered by the search string.
332
+
333
+ ## Owning Glossary
334
+
335
+ Egeria-Markdown
336
+
337
+ ## Categories
338
+
339
+ Writing Dr.Egeria Markdown
340
+
341
+ ## Usage
342
+
343
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
344
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
345
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
346
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; DICT; MD; MERMAID; REPORT |
347
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
348
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
349
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
350
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
351
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
352
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
353
+ | Sort Order | False | True | False | None | How to order the results. The sort order can be selected from a list of valid value. | False | ANY; CREATION_DATE_RECENT; CREATION_DATA_OLDEST; LAST_UPDATE_RECENT; LAST_UPDATE_OLDEST; PROPERTY_ASCENDING; PROPERTY_DESCENDING |
354
+
355
+
356
+ ___
357
+
358
+ # Create Term
359
+ ## Term Name
360
+
361
+ Create Information Supply Chain
362
+
363
+ ## Description
364
+
365
+ The flow of a particular type of data across a digital landscape.
366
+
367
+ ## Owning Glossary
368
+
369
+ Egeria-Markdown
370
+
371
+ ## Categories
372
+
373
+ Writing Dr.Egeria Markdown
374
+
375
+ ## Usage
376
+
377
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
378
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
379
+ | Display Name | True | True | False | None | Name of the Information Supply Chain | False | |
380
+ | Description | False | True | False | None | A description of the data structure. | False | |
381
+ | Scope | False | True | False | None | Scope of the supply chain. | False | |
382
+ | Purposes | False | True | False | None | A list of purposes. | False | |
383
+ | Information Supply Chain Segments | False | True | False | None | A list of supply chain segments that make up the supply chain. | False | |
384
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
385
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
386
+
387
+
388
+ ___
389
+
390
+ # Create Term
391
+ ## Term Name
392
+
393
+ Create Information Supply Chain Segment
394
+
395
+ ## Description
396
+
397
+ A collection of data fields that for a data specification for a data source.
398
+
399
+ ## Owning Glossary
400
+
401
+ Egeria-Markdown
402
+
403
+ ## Categories
404
+
405
+ Writing Dr.Egeria Markdown
406
+
407
+ ## Usage
408
+
409
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
410
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
411
+ | Display Name | True | True | False | None | Name of the Information Supply Chain | False | |
412
+ | Description | False | True | False | None | A description of the data structure. | False | |
413
+ | Scope | False | True | False | None | Scope of the supply chain. | False | |
414
+ | Integration Style | False | True | False | None | Style of integration connecting this segment. | False | |
415
+ | Estimated Volumetrics | False | True | False | None | Estimated volumetrics for rough analysis and planning. | False | |
416
+ | Information Supply Chain | False | True | False | None | The owning information supply chain for this segment. | False | |
417
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
418
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
419
+
420
+
421
+ ___
422
+
423
+ # Create Term
424
+ ## Term Name
425
+
426
+ Create Solution Blueprint
427
+
428
+ ## Description
429
+
430
+ A solution blueprint describes the architecture of a digital service in terms of solution components.
431
+
432
+ ## Owning Glossary
433
+
434
+ Egeria-Markdown
435
+
436
+ ## Categories
437
+
438
+ Writing Dr.Egeria Markdown
439
+
440
+ ## Usage
441
+
442
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
443
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
444
+ | Display Name | True | True | False | None | Name of the Information Supply Chain | False | |
445
+ | Description | False | True | False | None | A description of the data structure. | False | |
446
+ | Version Identifier | False | True | False | None | A user supplied version identifier. | False | |
447
+ | Solution Components | False | True | False | None | Solution components that make up the blueprint. | False | |
448
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
449
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
450
+
451
+
452
+ ___
453
+
454
+ # Create Term
455
+ ## Term Name
456
+
457
+ Create Solution Component
458
+
459
+ ## Description
460
+
461
+ A reusable solution component.
462
+
463
+ ## Owning Glossary
464
+
465
+ Egeria-Markdown
466
+
467
+ ## Categories
468
+
469
+ Writing Dr.Egeria Markdown
470
+
471
+ ## Usage
472
+
473
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
474
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
475
+ | Display Name | True | True | False | None | Name of the solution component. | False | |
476
+ | Description | False | True | False | None | A description of the data structure. | False | |
477
+ | Solution Component Type | False | True | False | None | Type of solution component. | False | |
478
+ | Planned Deployed Implementation Type | False | True | False | None | The planned implementation type for deployment. | False | |
479
+ | Solution SubComponents | False | True | False | None | Solution components that include this one. | False | |
480
+ | Solution Blueprints | False | True | False | None | Solution Blueprints that contain this component. | False | |
481
+ | Actors | False | True | False | None | Actors associated with this component. | False | |
482
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
483
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
484
+ | Merge Update | False | True | False | None | If true, only those attributes specified in the update will be updated; If false, any attributes not provided during the update will be set to None. | False | |
485
+
486
+
487
+ ___
488
+
489
+ # Create Term
490
+ ## Term Name
491
+
492
+ Create Solution Role
493
+
494
+ ## Description
495
+
496
+ A collection of data fields that for a data specification for a data source.
497
+
498
+ ## Owning Glossary
499
+
500
+ Egeria-Markdown
501
+
502
+ ## Categories
503
+
504
+ Writing Dr.Egeria Markdown
505
+
506
+ ## Usage
507
+
508
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
509
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
510
+ | Name | True | True | False | None | Name of the role. | False | |
511
+ | Description | False | True | False | None | A description of the data structure. | False | |
512
+ | Title | False | True | False | None | Title of the role. | False | |
513
+ | Scope | False | True | False | None | Scope of the role. | False | |
514
+ | identifier | False | True | False | None | role identifier | False | |
515
+ | Domain Identifier | False | True | False | None | Governance domain identifier | False | |
516
+ | Role Type | False | True | False | None | Type of the role. Currently must be GovernanceRole. | False | |
517
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
518
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
519
+
520
+
521
+ ___
522
+
523
+ # Create Term
524
+ ## Term Name
525
+
526
+ Attach Information Supply Chain Segments
527
+
528
+ ## Description
529
+
530
+
531
+
532
+ ## Owning Glossary
533
+
534
+ Egeria-Markdown
535
+
536
+ ## Categories
537
+
538
+ Writing Dr.Egeria Markdown
539
+
540
+ ## Usage
541
+
542
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
543
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
544
+ | Segment1 | True | True | False | None | The first segment to link. | False | |
545
+ | Segment2 | True | True | False | None | The second segment to link. | False | |
546
+ | Link Label | False | True | False | None | Labels the link between two information supply chain segments. | False | |
547
+ | Description | False | True | False | None | A description of the data structure. | False | |
548
+
549
+
550
+ ___
551
+
552
+ # Create Term
553
+ ## Term Name
554
+
555
+ View Information Supply Chains
556
+
557
+ ## Description
558
+
559
+ Return information supply chains filtered by the search string.
560
+
561
+ ## Owning Glossary
562
+
563
+ Egeria-Markdown
564
+
565
+ ## Categories
566
+
567
+ Writing Dr.Egeria Markdown
568
+
569
+ ## Usage
570
+
571
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
572
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
573
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
574
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
575
+ | Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
576
+
577
+
578
+ ___
579
+
580
+ # Create Term
581
+ ## Term Name
582
+
583
+ View Supply Chain Segments
584
+
585
+ ## Description
586
+
587
+ Return the data structure details, optionally filtered by the search string.
588
+
589
+ ## Owning Glossary
590
+
591
+ Egeria-Markdown
592
+
593
+ ## Categories
594
+
595
+ Writing Dr.Egeria Markdown
596
+
597
+ ## Usage
598
+
599
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
600
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
601
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
602
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
603
+ | Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
604
+
605
+
606
+ ___
607
+
608
+ # Create Term
609
+ ## Term Name
610
+
611
+ View Solution Components
612
+
613
+ ## Description
614
+
615
+ Return the data structure details, optionally filtered by the search string.
616
+
617
+ ## Owning Glossary
618
+
619
+ Egeria-Markdown
620
+
621
+ ## Categories
622
+
623
+ Writing Dr.Egeria Markdown
624
+
625
+ ## Usage
626
+
627
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
628
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
629
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
630
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
631
+ | Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
632
+
633
+
634
+ ___
635
+
636
+ # Create Term
637
+ ## Term Name
638
+
639
+ View Solution Blueprints
640
+
641
+ ## Description
642
+
643
+ Return the data structure details, optionally filtered by the search string.
644
+
645
+ ## Owning Glossary
646
+
647
+ Egeria-Markdown
648
+
649
+ ## Categories
650
+
651
+ Writing Dr.Egeria Markdown
652
+
653
+ ## Usage
654
+
655
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
656
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
657
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
658
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
659
+ | Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
660
+
661
+
662
+ ___
663
+
664
+ # Create Term
665
+ ## Term Name
666
+
667
+ View Solution Roles
668
+
669
+ ## Description
670
+
671
+ Return the data structure details, optionally filtered by the search string.
672
+
673
+ ## Owning Glossary
674
+
675
+ Egeria-Markdown
676
+
677
+ ## Categories
678
+
679
+ Writing Dr.Egeria Markdown
680
+
681
+ ## Usage
682
+
683
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
684
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
685
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
686
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
687
+ | Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
688
+
689
+
690
+ ___
691
+
692
+ # Create Term
693
+ ## Term Name
694
+
695
+ Create Glossary
696
+
697
+ ## Description
698
+
699
+ A grouping of definitions.
700
+
701
+ ## Owning Glossary
702
+
703
+ Egeria-Markdown
704
+
705
+ ## Categories
706
+
707
+ Writing Dr.Egeria Markdown
708
+
709
+ ## Usage
710
+
711
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
712
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
713
+ | Glossary Name | True | True | False | None | The name of the glossary to create or update. | False | |
714
+ | Description | False | True | False | None | A description of the Glossary. | False | |
715
+ | Language | False | True | False | None | The language of the glossary. Note that multilingual descriptions are supported. Please see web site for details. | False | |
716
+ | Usage | False | True | False | None | A description of how the glossary is to be used. | False | |
717
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
718
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
719
+
720
+
721
+ ___
722
+
723
+ # Create Term
724
+ ## Term Name
725
+
726
+ Create Category
727
+
728
+ ## Description
729
+
730
+ A group of terms that are useful to collect together.
731
+
732
+ ## Owning Glossary
733
+
734
+ Egeria-Markdown
735
+
736
+ ## Categories
737
+
738
+ Writing Dr.Egeria Markdown
739
+
740
+ ## Usage
741
+
742
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
743
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
744
+ | Category Name | True | True | False | None | The name of a category. | False | |
745
+ | Description | False | True | False | None | A description of the Category. | False | |
746
+ | In Glossary | True | True | False | None | The name of the glossary that contains the Category. Recommend using the Qualified Name of the Glossary, if known. | False | |
747
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
748
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
749
+
750
+
751
+ ___
752
+
753
+ # Create Term
754
+ ## Term Name
755
+
756
+ Term
757
+
758
+ ## Description
759
+
760
+
761
+
762
+ ## Owning Glossary
763
+
764
+ Egeria-Markdown
765
+
766
+ ## Categories
767
+
768
+ Writing Dr.Egeria Markdown
769
+
770
+ ## Usage
771
+
772
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
773
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
774
+ | Term Name | True | True | False | None | The name of the term to create or update. | False | |
775
+ | Summary | False | True | False | None | A summary description of the term. | False | |
776
+ | Description | False | True | False | None | A description of the term. | False | |
777
+ | Abbreviation | False | True | False | None | An abbreviation for the term. | False | |
778
+ | Example | False | True | False | None | An example of how the term is used. | False | |
779
+ | Usage | False | True | False | None | A description of how the term is to be used. | False | |
780
+ | Status | False | True | False | None | The lifecycle status of a term. | False | DRAFT; ACTIVE, DEPRECATED; OBSOLETE; OTHER |
781
+ | Published Version Identifier | False | True | False | None | | False | |
782
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
783
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
784
+
785
+
786
+ ___
787
+
788
+ # Create Term
789
+ ## Term Name
790
+
791
+ Attach Category Parent
792
+
793
+ ## Description
794
+
795
+ Attaches a parent category to a child category.
796
+
797
+ ## Owning Glossary
798
+
799
+ Egeria-Markdown
800
+
801
+ ## Categories
802
+
803
+ Writing Dr.Egeria Markdown
804
+
805
+ ## Usage
806
+
807
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
808
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
809
+ | Category Name | True | True | False | None | The name of a category. | False | |
810
+ | Parent Category | True | True | False | None | The name of the parent category to attach to. | False | |
811
+
812
+
813
+ ___
814
+
815
+ # Create Term
816
+ ## Term Name
817
+
818
+ Attach Term-Term Relationship
819
+
820
+ ## Description
821
+
822
+ Create a relationship between terms.
823
+
824
+ ## Owning Glossary
825
+
826
+ Egeria-Markdown
827
+
828
+ ## Categories
829
+
830
+ Writing Dr.Egeria Markdown
831
+
832
+ ## Usage
833
+
834
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
835
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
836
+ | Term 1 | True | True | False | None | The name of the first term term to connect. | False | |
837
+ | Term 2 | No | No | No | None | | No | [] |
838
+ | Relationship | True | True | False | None | The type of relationship to connecting the two terms. | False | Synonym; Translation; PreferredTerm; TermISATYPEOFRelationship; TermTYPEDBYRelationship; Antonym; ReplacementTerm; ValidValue; TermHASARelationship; RelatedTerm; ISARelationship |
839
+
840
+
841
+ ___
842
+