pyegeria 5.4.2__py3-none-any.whl → 5.4.2.2__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 (21) hide show
  1. commands/cat/debug_log.2025-08-29_07-07-27_848189.log.zip +0 -0
  2. commands/cat/debug_log.log +1729 -1714
  3. commands/cat/dr_egeria_command_help.py +9 -10
  4. md_processing/data/commands.json +958 -695
  5. md_processing/dr_egeria_inbox/generated_help_terms.md +842 -0
  6. md_processing/dr_egeria_inbox/glossary_test1.md +4 -4
  7. md_processing/dr_egeria_outbox/friday/processed-2025-08-30 21:15-glossary_test1.md +326 -0
  8. md_processing/dr_egeria_outbox/friday/processed-2025-08-31 13:27-glossary_test1.md +369 -0
  9. md_processing/dr_egeria_outbox/friday/processed-2025-08-31 13:33-glossary_test1.md +392 -0
  10. md_processing/dr_egeria_outbox/processed-2025-08-30 16:56-generated_help_terms.md +795 -0
  11. md_processing/md_commands/glossary_commands.py +9 -2
  12. md_processing/md_processing_utils/common_md_utils.py +1 -0
  13. md_processing/md_processing_utils/debug_log.log +5580 -0
  14. pyegeria/config.py +12 -11
  15. {pyegeria-5.4.2.dist-info → pyegeria-5.4.2.2.dist-info}/METADATA +1 -1
  16. {pyegeria-5.4.2.dist-info → pyegeria-5.4.2.2.dist-info}/RECORD +19 -15
  17. commands/cat/debug_log.2025-08-26_20-04-40_905576.log.zip +0 -0
  18. commands/cat/debug_log.2025-08-27_20-09-41_795022.log.zip +0 -0
  19. {pyegeria-5.4.2.dist-info → pyegeria-5.4.2.2.dist-info}/LICENSE +0 -0
  20. {pyegeria-5.4.2.dist-info → pyegeria-5.4.2.2.dist-info}/WHEEL +0 -0
  21. {pyegeria-5.4.2.dist-info → pyegeria-5.4.2.2.dist-info}/entry_points.txt +0 -0
md_processing/dr_egeria_outbox/processed-2025-08-30 16:56-generated_help_terms.md ADDED
@@ -0,0 +1,795 @@
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
+ # Update Term
7
+ ## Qualified Name
8
+ Term::Create Data Dictionary
9
+
10
+ ## GUID
11
+ 663a636b-e50d-4f08-b177-2dd9bdf7db4f
12
+
13
+ ## Term Name
14
+
15
+ Create Data Dictionary
16
+
17
+ ## Description
18
+
19
+ A Data Dictionary is an organized and curated collection of data definitions that can serve as a reference for data professionals
20
+
21
+ ## Owning Glossary
22
+
23
+ Egeria-Markdown
24
+
25
+ ## Categories
26
+
27
+ Writing Dr.Egeria Markdown
28
+
29
+ ## Usage
30
+
31
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
32
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
33
+ | Display Name | True | True | False | None | Name of the Data Dictionary | False | |
34
+ | Description | False | True | False | None | A description of the Data Dictionary. | False | |
35
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
36
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
37
+
38
+
39
+ ___
40
+
41
+ # Update Term
42
+ ## Qualified Name
43
+ Term::Create Data Specification
44
+
45
+ ## GUID
46
+ 133dc8b0-5a77-478c-93d8-dbbc87e551dc
47
+
48
+ ## Term Name
49
+
50
+ Create Data Specification
51
+
52
+ ## Description
53
+
54
+ A Data Specification defines the data requirements for a project or initiative. This includes the data structures , data fields and data classes.
55
+
56
+ ## Owning Glossary
57
+
58
+ Egeria-Markdown
59
+
60
+ ## Categories
61
+
62
+ Writing Dr.Egeria Markdown
63
+
64
+ ## Usage
65
+
66
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
67
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
68
+ | Display Name | True | True | False | None | Name of the Data Specification. | False | |
69
+ | Description | False | True | False | None | A description of the Data Specification. | False | |
70
+ | Collection Type | False | True | False | None | A user supplied collection type. | False | |
71
+ | Qualified Name | True | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
72
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
73
+
74
+
75
+ ___
76
+
77
+ # Update Term
78
+ ## Qualified Name
79
+ Term::Create Data Structure
80
+
81
+ ## GUID
82
+ 089c9742-e3bf-4a24-9fe6-ada226e32f50
83
+
84
+ ## Term Name
85
+
86
+ Create Data Structure
87
+
88
+ ## Description
89
+
90
+ A collection of data fields that for a data specification for a data source.
91
+
92
+ ## Owning Glossary
93
+
94
+ Egeria-Markdown
95
+
96
+ ## Categories
97
+
98
+ Writing Dr.Egeria Markdown
99
+
100
+ ## Usage
101
+
102
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
103
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
104
+ | Display Name | True | True | False | None | Name of the data structure. | False | |
105
+ | Description | False | True | False | None | A description of the data structure. | False | |
106
+ | In Data Specification | False | True | False | None | The data specifications this structure is a member of. | False | |
107
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
108
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
109
+
110
+
111
+ ___
112
+
113
+ # Update Term
114
+ ## Qualified Name
115
+ Term::Create Data Field
116
+
117
+ ## GUID
118
+ 4acc992f-06a6-4457-ac72-64dfdd240da2
119
+
120
+ ## Term Name
121
+
122
+ Create Data Field
123
+
124
+ ## Description
125
+
126
+ A data field is a fundamental building block for a data structure.
127
+
128
+ ## Owning Glossary
129
+
130
+ Egeria-Markdown
131
+
132
+ ## Categories
133
+
134
+ Writing Dr.Egeria Markdown
135
+
136
+ ## Usage
137
+
138
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
139
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
140
+ | Display Name | True | True | False | None | Name of the Data Field | False | |
141
+ | Description | False | True | False | None | A description of the Data Field | False | |
142
+ | 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 |
143
+ | Position | False | True | False | None | Position of the data field in the data structure. If 0, position is irrelevant. | False | |
144
+ | Minimum Cardinality | False | True | False | None | The minimum cardinality for a data element. | False | |
145
+ | Maximum Cardinality | False | True | False | None | The maximum cardinality for a data element. | False | |
146
+ | 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 | |
147
+ | Data Class | False | True | False | None | The data class that values of this data field conform to. | False | |
148
+ | Glossary Term | False | True | False | None | Term that provides meaning to this field. | False | |
149
+ | isNullable | False | True | False | None | Can the values within the dataclass be absent? | False | |
150
+ | Minimum Length | False | True | False | None | | False | |
151
+ | Length | False | True | False | None | The length of a value for a field. | False | |
152
+ | Precision | False | True | False | None | The precision of a numeric | False | |
153
+ | Ordered Values | False | True | False | None | is this field in an ordered list? | False | |
154
+ | Units | False | True | False | None | An optional string indicating the units of the field. | False | |
155
+ | Default Value | False | True | False | None | Specify a default value for the data class. | False | |
156
+ | Version Identifier | False | True | False | None | A user supplied version identifier. | False | |
157
+ | In Data Dictionary | False | True | False | None | What data dictionaries is this data field in? | False | |
158
+ | Parent Data Field | False | True | False | None | Optional parent field if this is a nested field. | False | |
159
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
160
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
161
+
162
+
163
+ ___
164
+
165
+ # Update Term
166
+ ## Qualified Name
167
+ Term::Create Data Class
168
+
169
+ ## GUID
170
+ 7bcec2f9-4034-400b-8e15-62b82979de21
171
+
172
+ ## Term Name
173
+
174
+ Create Data Class
175
+
176
+ ## Description
177
+
178
+ Describes the data values that may be stored in data fields. Can be used to configure quality validators and data field classifiers.
179
+
180
+ ## Owning Glossary
181
+
182
+ Egeria-Markdown
183
+
184
+ ## Categories
185
+
186
+ Writing Dr.Egeria Markdown
187
+
188
+ ## Usage
189
+
190
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
191
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
192
+ | Display Name | True | True | False | None | Name of the data structure. | False | |
193
+ | Description | False | True | False | None | A description of the data class. | False | |
194
+ | Namespace | False | True | False | None | Optional namespace that scopes the field. | False | |
195
+ | Match Property Names | False | True | True | None | Names of the properties that are set. | False | |
196
+ | Match Threshold | False | True | False | None | Percent of values that must match the data class specification. | False | |
197
+ | IsCaseSensitive | False | True | False | None | Are field values case sensitive? | False | |
198
+ | 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 |
199
+ | Allow Duplicate Values | False | True | False | None | Allow duplicate values within the data class? | False | |
200
+ | isNullable | False | True | False | None | Can the values within the dataclass be absent? | False | |
201
+ | isCaseSensitive | False | True | False | None | Indicates if the values in a data class are case sensitive. | False | |
202
+ | Default Value | False | True | False | None | Specify a default value for the data class. | False | |
203
+ | Average Value | False | True | False | None | Average value for the data class. | False | |
204
+ | Value List | False | True | False | None | | False | |
205
+ | Value Range From | False | True | False | None | Beginning range of legal values. | False | |
206
+ | Value Range To | False | True | False | None | End of valid range for value. | False | |
207
+ | Sample Values | False | True | False | None | Sample values of the data class. | False | |
208
+ | Data Patterns | False | True | False | None | prescribed format of a data field - e.g. credit card numbers. Often expressed as a regular expression. | False | |
209
+ | In Data Dictionary | False | True | False | None | What data dictionaries is this data field in? | False | |
210
+ | Containing Data Class | False | True | False | None | Data classes this is part of. | False | |
211
+ | Specializes Data Class | False | True | False | None | Specializes a parent data class. | False | |
212
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
213
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
214
+
215
+
216
+ ___
217
+
218
+ # Update Term
219
+ ## Qualified Name
220
+ Term::View Data Fields
221
+
222
+ ## GUID
223
+ 01e7af02-f777-4f3d-a10e-c0f66aea1fe7
224
+
225
+ ## Term Name
226
+
227
+ View Data Fields
228
+
229
+ ## Description
230
+
231
+ Return the data fields, optionally filtered by the search string.
232
+
233
+ ## Owning Glossary
234
+
235
+ Egeria-Markdown
236
+
237
+ ## Categories
238
+
239
+ Writing Dr.Egeria Markdown
240
+
241
+ ## Usage
242
+
243
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
244
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
245
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
246
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; MERMAID; DICT |
247
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
248
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
249
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
250
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
251
+ | 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 |
252
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
253
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
254
+
255
+
256
+ ___
257
+
258
+ # Update Term
259
+ ## Qualified Name
260
+ Term::View Data Classes
261
+
262
+ ## GUID
263
+ 3af37069-04c6-4f54-a51b-3de6ff04bf7f
264
+
265
+ ## Term Name
266
+
267
+ View Data Classes
268
+
269
+ ## Description
270
+
271
+ Return the data classes, optionally filtered by the search string.
272
+
273
+ ## Owning Glossary
274
+
275
+ Egeria-Markdown
276
+
277
+ ## Categories
278
+
279
+ Writing Dr.Egeria Markdown
280
+
281
+ ## Usage
282
+
283
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
284
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
285
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
286
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; MERMAID; DICT |
287
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
288
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
289
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
290
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
291
+ | 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 |
292
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
293
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
294
+
295
+
296
+ ___
297
+
298
+ # Update Term
299
+ ## Qualified Name
300
+ Term::View Data Structures
301
+
302
+ ## GUID
303
+ 54d99ccc-ae65-467b-9e0b-74b1561aeeef
304
+
305
+ ## Term Name
306
+
307
+ View Data Structures
308
+
309
+ ## Description
310
+
311
+ Return the data structures, optionally filtered by the search string.
312
+
313
+ ## Owning Glossary
314
+
315
+ Egeria-Markdown
316
+
317
+ ## Categories
318
+
319
+ Writing Dr.Egeria Markdown
320
+
321
+ ## Usage
322
+
323
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
324
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
325
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
326
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
327
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
328
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
329
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
330
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
331
+ | 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 |
332
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
333
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
334
+
335
+
336
+ ___
337
+
338
+ # Update Term
339
+ ## Qualified Name
340
+ Term::View Data Specifications
341
+
342
+ ## GUID
343
+ 952311d4-9c21-4759-a173-a83e4d64421a
344
+
345
+ ## Term Name
346
+
347
+ View Data Specifications
348
+
349
+ ## Description
350
+
351
+ Return the data specifications, optionally filtered by the search string.
352
+
353
+ ## Owning Glossary
354
+
355
+ Egeria-Markdown
356
+
357
+ ## Categories
358
+
359
+ Writing Dr.Egeria Markdown
360
+
361
+ ## Usage
362
+
363
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
364
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
365
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
366
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; DICT; MD; MERMAID; REPORT |
367
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
368
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
369
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
370
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
371
+ | 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 |
372
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
373
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
374
+
375
+
376
+ ___
377
+
378
+ # Update Term
379
+ ## Qualified Name
380
+ Term::View Data Dictionaries
381
+
382
+ ## GUID
383
+ 038951c1-e800-4286-8bfd-18a2144b017e
384
+
385
+ ## Term Name
386
+
387
+ View Data Dictionaries
388
+
389
+ ## Description
390
+
391
+ Return the data dictionaries, optionally filtered by the search string.
392
+
393
+ ## Owning Glossary
394
+
395
+ Egeria-Markdown
396
+
397
+ ## Categories
398
+
399
+ Writing Dr.Egeria Markdown
400
+
401
+ ## Usage
402
+
403
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
404
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
405
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
406
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; DICT; MD; MERMAID; REPORT |
407
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
408
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
409
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
410
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
411
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
412
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
413
+ | 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 |
414
+
415
+
416
+ ___
417
+
418
+ # Update Term
419
+ ## Qualified Name
420
+ Term::Create Information Supply Chain
421
+
422
+ ## GUID
423
+ 14bb4b5e-39f8-4c00-a321-f2a5c3efe147
424
+
425
+ ## Term Name
426
+
427
+ Create Information Supply Chain
428
+
429
+ ## Description
430
+
431
+ The flow of a particular type of data across a digital landscape.
432
+
433
+ ## Owning Glossary
434
+
435
+ Egeria-Markdown
436
+
437
+ ## Categories
438
+
439
+ Writing Dr.Egeria Markdown
440
+
441
+ ## Usage
442
+
443
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
444
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
445
+ | Display Name | True | True | False | None | Name of the Information Supply Chain | False | |
446
+ | Description | False | True | False | None | A description of the data structure. | False | |
447
+ | Scope | False | True | False | None | Scope of the supply chain. | False | |
448
+ | Purposes | False | True | False | None | A list of purposes. | False | |
449
+ | Information Supply Chain Segments | False | True | False | None | A list of supply chain segments that make up the supply chain. | False | |
450
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
451
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
452
+
453
+
454
+ ___
455
+
456
+ No elements found
457
+
458
+ # Update Term
459
+ ## Qualified Name
460
+ Term::Create Solution Blueprint
461
+
462
+ ## GUID
463
+ 760aa1d7-cca7-4795-bfb8-25e3d855f26d
464
+
465
+ ## Term Name
466
+
467
+ Create Solution Blueprint
468
+
469
+ ## Description
470
+
471
+ A solution blueprint describes the architecture of a digital service in terms of solution components.
472
+
473
+ ## Owning Glossary
474
+
475
+ Egeria-Markdown
476
+
477
+ ## Categories
478
+
479
+ Writing Dr.Egeria Markdown
480
+
481
+ ## Usage
482
+
483
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
484
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
485
+ | Display Name | True | True | False | None | Name of the Information Supply Chain | False | |
486
+ | Description | False | True | False | None | A description of the data structure. | False | |
487
+ | Version Identifier | False | True | False | None | A user supplied version identifier. | False | |
488
+ | Solution Components | False | True | False | None | Solution components that make up the blueprint. | False | |
489
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
490
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
491
+
492
+
493
+ ___
494
+
495
+ # Update Term
496
+ ## Qualified Name
497
+ Term::Create Solution Component
498
+
499
+ ## GUID
500
+ ee038a6c-c447-4d6d-8ba7-ab7203f2cf34
501
+
502
+ ## Term Name
503
+
504
+ Create Solution Component
505
+
506
+ ## Description
507
+
508
+ A reusable solution component.
509
+
510
+ ## Owning Glossary
511
+
512
+ Egeria-Markdown
513
+
514
+ ## Categories
515
+
516
+ Writing Dr.Egeria Markdown
517
+
518
+ ## Usage
519
+
520
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
521
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
522
+ | Display Name | True | True | False | None | Name of the solution component. | False | |
523
+ | Description | False | True | False | None | A description of the data structure. | False | |
524
+ | Solution Component Type | False | True | False | None | Type of solution component. | False | |
525
+ | Planned Deployed Implementation Type | False | True | False | None | The planned implementation type for deployment. | False | |
526
+ | Solution SubComponents | False | True | False | None | Solution components that include this one. | False | |
527
+ | Solution Blueprints | False | True | False | None | Solution Blueprints that contain this component. | False | |
528
+ | Actors | False | True | False | None | Actors associated with this component. | False | |
529
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
530
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
531
+ | 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 | |
532
+
533
+
534
+ ___
535
+
536
+ # Update Term
537
+ ## Qualified Name
538
+ Term::Create Solution Role
539
+
540
+ ## GUID
541
+ 3ea0f0e1-ac1c-4d75-a7e2-79515f85a073
542
+
543
+ ## Term Name
544
+
545
+ Create Solution Role
546
+
547
+ ## Description
548
+
549
+ A collection of data fields that for a data specification for a data source.
550
+
551
+ ## Owning Glossary
552
+
553
+ Egeria-Markdown
554
+
555
+ ## Categories
556
+
557
+ Writing Dr.Egeria Markdown
558
+
559
+ ## Usage
560
+
561
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
562
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
563
+ | Name | True | True | False | None | Name of the role. | False | |
564
+ | Description | False | True | False | None | A description of the data structure. | False | |
565
+ | Title | False | True | False | None | Title of the role. | False | |
566
+ | Scope | False | True | False | None | Scope of the role. | False | |
567
+ | identifier | False | True | False | None | role identifier | False | |
568
+ | Domain Identifier | False | True | False | None | Governance domain identifier | False | |
569
+ | Role Type | False | True | False | None | Type of the role. Currently must be GovernanceRole. | False | |
570
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
571
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
572
+
573
+
574
+ ___
575
+
576
+ No elements found
577
+
578
+ # Update Term
579
+ ## Qualified Name
580
+ Term::View Information Supply Chains
581
+
582
+ ## GUID
583
+ 1ab27e24-2827-4f4e-b88d-6c7f96541511
584
+
585
+ ## Term Name
586
+
587
+ View Information Supply Chains
588
+
589
+ ## Description
590
+
591
+ Return information supply chains filtered by the search string.
592
+
593
+ ## Owning Glossary
594
+
595
+ Egeria-Markdown
596
+
597
+ ## Categories
598
+
599
+ Writing Dr.Egeria Markdown
600
+
601
+ ## Usage
602
+
603
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
604
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
605
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
606
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
607
+ | Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
608
+
609
+
610
+ ___
611
+
612
+ No elements found
613
+
614
+ # Update Term
615
+ ## Qualified Name
616
+ Term::View Solution Components
617
+
618
+ ## GUID
619
+ f908e2ba-1a2c-4de9-9ebc-1b6a819a4ed1
620
+
621
+ ## Term Name
622
+
623
+ View Solution Components
624
+
625
+ ## Description
626
+
627
+ Return the data structure details, optionally filtered by the search string.
628
+
629
+ ## Owning Glossary
630
+
631
+ Egeria-Markdown
632
+
633
+ ## Categories
634
+
635
+ Writing Dr.Egeria Markdown
636
+
637
+ ## Usage
638
+
639
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
640
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
641
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
642
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
643
+ | Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
644
+
645
+
646
+ ___
647
+
648
+ # Update Term
649
+ ## Qualified Name
650
+ Term::View Solution Blueprints
651
+
652
+ ## GUID
653
+ ee743e26-753e-47d8-8350-83d042541769
654
+
655
+ ## Term Name
656
+
657
+ View Solution Blueprints
658
+
659
+ ## Description
660
+
661
+ Return the data structure details, optionally filtered by the search string.
662
+
663
+ ## Owning Glossary
664
+
665
+ Egeria-Markdown
666
+
667
+ ## Categories
668
+
669
+ Writing Dr.Egeria Markdown
670
+
671
+ ## Usage
672
+
673
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
674
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
675
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
676
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
677
+ | Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
678
+
679
+
680
+ ___
681
+
682
+ # Update Term
683
+ ## Qualified Name
684
+ Term::View Solution Roles
685
+
686
+ ## GUID
687
+ ff51d923-3582-4ddc-8517-3acdc8c9f222
688
+
689
+ ## Term Name
690
+
691
+ View Solution Roles
692
+
693
+ ## Description
694
+
695
+ Return the data structure details, optionally filtered by the search string.
696
+
697
+ ## Owning Glossary
698
+
699
+ Egeria-Markdown
700
+
701
+ ## Categories
702
+
703
+ Writing Dr.Egeria Markdown
704
+
705
+ ## Usage
706
+
707
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
708
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
709
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
710
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
711
+ | Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
712
+
713
+
714
+ ___
715
+
716
+ # Update Term
717
+ ## Qualified Name
718
+ Term::Create Glossary
719
+
720
+ ## GUID
721
+ 4dc02870-2103-4a71-95bd-a8d72a7da340
722
+
723
+ ## Term Name
724
+
725
+ Create Glossary
726
+
727
+ ## Description
728
+
729
+ A grouping of definitions.
730
+
731
+ ## Owning Glossary
732
+
733
+ Egeria-Markdown
734
+
735
+ ## Categories
736
+
737
+ Writing Dr.Egeria Markdown
738
+
739
+ ## Usage
740
+
741
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
742
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
743
+ | Glossary Name | True | True | False | None | The name of the glossary to create or update. | False | |
744
+ | Description | False | True | False | None | A description of the Glossary. | False | |
745
+ | Language | False | True | False | None | The language of the glossary. Note that multilingual descriptions are supported. Please see web site for details. | False | |
746
+ | Usage | False | True | False | None | A description of how the glossary is to be used. | 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
+ No elements found
754
+
755
+ No elements found
756
+
757
+ No elements found
758
+
759
+ # Update Term
760
+ ## Qualified Name
761
+ Term::Attach Term-Term Relationship
762
+
763
+ ## GUID
764
+ b272c600-07fb-4314-8bbb-00eb5896d3a5
765
+
766
+ ## Term Name
767
+
768
+ Attach Term-Term Relationship
769
+
770
+ ## Description
771
+
772
+ Create a relationship between terms.
773
+
774
+ ## Owning Glossary
775
+
776
+ Egeria-Markdown
777
+
778
+ ## Categories
779
+
780
+ Writing Dr.Egeria Markdown
781
+
782
+ ## Usage
783
+
784
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
785
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
786
+ | Term 1 | True | True | False | None | The name of the first term term to connect. | False | |
787
+ | Term 2 | No | No | No | None | | No | [] |
788
+ | 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 |
789
+
790
+
791
+ ___
792
+
793
+ # Provenance
794
+
795
+ * Results from processing file generated_help_terms.md on 2025-08-30 16:56