pyegeria 5.4.4__py3-none-any.whl → 5.4.4.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 (27) hide show
  1. commands/cat/debug_log.2025-09-10_13-48-37_153090.log.zip +0 -0
  2. commands/cat/dr_egeria_command_help.py +11 -17
  3. md_processing/data/commands.json +763 -134
  4. md_processing/dr-egeria-outbox/Business-Imperative-DrE-2025-09-11-21-21-15.md +33 -0
  5. md_processing/md_commands/governance_officer_commands.py +5 -2
  6. md_processing/md_processing_utils/common_md_proc_utils.py +159 -127
  7. md_processing/md_processing_utils/common_md_utils.py +7 -4
  8. md_processing/md_processing_utils/debug_log +186 -1
  9. md_processing/md_processing_utils/debug_log.2025-09-09_11-10-03_528597.zip +0 -0
  10. md_processing/md_processing_utils/dr-egeria-help-2025-09-10T14:49:49.md +3460 -0
  11. md_processing/md_processing_utils/dr-egeria-help-2025-09-10T14:57:46.md +472 -0
  12. md_processing/md_processing_utils/extraction_utils.py +75 -36
  13. md_processing/md_processing_utils/generate_md_cmd_templates.py +4 -4
  14. pyegeria/_output_formats.py +1 -1
  15. pyegeria/glossary_manager.py +2 -2
  16. pyegeria/governance_officer.py +1 -4
  17. pyegeria/utils.py +110 -0
  18. {pyegeria-5.4.4.dist-info → pyegeria-5.4.4.2.dist-info}/METADATA +1 -1
  19. {pyegeria-5.4.4.dist-info → pyegeria-5.4.4.2.dist-info}/RECORD +22 -22
  20. commands/cat/debug_log.2025-09-01_07-02-58_818650.log.zip +0 -0
  21. commands/cat/debug_log.2025-09-02_07-44-39_567276.log.zip +0 -0
  22. commands/cat/debug_log.2025-09-03_07-45-21_986388.log.zip +0 -0
  23. commands/cat/debug_log.2025-09-04_08-21-58_788009.log.zip +0 -0
  24. commands/cat/debug_log.2025-09-05_09-37-53_062579.log.zip +0 -0
  25. {pyegeria-5.4.4.dist-info → pyegeria-5.4.4.2.dist-info}/LICENSE +0 -0
  26. {pyegeria-5.4.4.dist-info → pyegeria-5.4.4.2.dist-info}/WHEEL +0 -0
  27. {pyegeria-5.4.4.dist-info → pyegeria-5.4.4.2.dist-info}/entry_points.txt +0 -0
md_processing/md_processing_utils/dr-egeria-help-2025-09-10T14:49:49.md ADDED
@@ -0,0 +1,3460 @@
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 Dr.Egeria command.
6
+
7
+ > Usage: Before executing this file, make sure you have a glossary named `Egeria-Markdown`
8
+ > already created. If you Need to create one, you can use the
9
+ # Create Term
10
+ ## Term Name
11
+
12
+ Create Governance Driver
13
+
14
+ ## Description
15
+
16
+ A motivating topic leading to governance work.
17
+
18
+ ## Glossary
19
+
20
+ Egeria-Markdown
21
+
22
+ ## Folders
23
+
24
+ Writing Dr.Egeria Markdown
25
+
26
+ ## Usage
27
+
28
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
29
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
30
+ | Display Name | True | True | False | None | Name of the definition. | False | |
31
+ | Summary | False | True | False | None | Summary of the definition. | False | |
32
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
33
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
34
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
35
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
36
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
37
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
38
+ | Scope | False | True | False | None | Scope of the definition. | False | |
39
+ | Importance | False | True | False | None | Importance of the definition. | False | |
40
+ | Implications | False | True | False | None | List of implications. | False | |
41
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
42
+ | Results | False | True | False | None | A list of expected results. | False | |
43
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
44
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
45
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
46
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
47
+
48
+
49
+ ___
50
+
51
+ # Create Term
52
+ ## Term Name
53
+
54
+ Create Governance Strategy
55
+
56
+ ## Description
57
+
58
+ The strategy used in the development of the governance domains activities. How the governance domain supports the business strategy.
59
+
60
+ ## Glossary
61
+
62
+ Egeria-Markdown
63
+
64
+ ## Folders
65
+
66
+ Writing Dr.Egeria Markdown
67
+
68
+ ## Usage
69
+
70
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
71
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
72
+ | Display Name | True | True | False | None | Name of the definition. | False | |
73
+ | Summary | False | True | False | None | Summary of the definition. | False | |
74
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
75
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
76
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
77
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
78
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
79
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
80
+ | Scope | False | True | False | None | Scope of the definition. | False | |
81
+ | Importance | False | True | False | None | Importance of the definition. | False | |
82
+ | Implications | False | True | False | None | List of implications. | False | |
83
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
84
+ | Results | False | True | False | None | A list of expected results. | False | |
85
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
86
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
87
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
88
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
89
+
90
+
91
+ ___
92
+
93
+ # Create Term
94
+ ## Term Name
95
+
96
+ Create Business Imperative
97
+
98
+ ## Description
99
+
100
+ The BusinessImperative entity defines a business goal that is critical to the success of the organization.
101
+
102
+ ## Glossary
103
+
104
+ Egeria-Markdown
105
+
106
+ ## Folders
107
+
108
+ Writing Dr.Egeria Markdown
109
+
110
+ ## Usage
111
+
112
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
113
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
114
+ | Display Name | True | True | False | None | Name of the definition. | False | |
115
+ | Summary | False | True | False | None | Summary of the definition. | False | |
116
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
117
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
118
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
119
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
120
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
121
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
122
+ | Scope | False | True | False | None | Scope of the definition. | False | |
123
+ | Importance | False | True | False | None | Importance of the definition. | False | |
124
+ | Implications | False | True | False | None | List of implications. | False | |
125
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
126
+ | Results | False | True | False | None | A list of expected results. | False | |
127
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
128
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
129
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
130
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
131
+
132
+
133
+ ___
134
+
135
+ # Create Term
136
+ ## Term Name
137
+
138
+ Create Regulation
139
+
140
+ ## Description
141
+
142
+ Defines a relevant legal regulation that the business operation must comply with. Often regulations are divided into regulation articles.
143
+
144
+ ## Glossary
145
+
146
+ Egeria-Markdown
147
+
148
+ ## Folders
149
+
150
+ Writing Dr.Egeria Markdown
151
+
152
+ ## Usage
153
+
154
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
155
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
156
+ | Display Name | True | True | False | None | Name of the definition. | False | |
157
+ | Summary | False | True | False | None | Summary of the definition. | False | |
158
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
159
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
160
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
161
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
162
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
163
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
164
+ | Scope | False | True | False | None | Scope of the definition. | False | |
165
+ | Importance | False | True | False | None | Importance of the definition. | False | |
166
+ | Regulation Source | False | True | False | None | The source of the regulation - often, an authority. | False | |
167
+ | Regulators | False | True | False | None | A list of regulators. | False | |
168
+ | Implications | False | True | False | None | List of implications. | False | |
169
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
170
+ | Results | False | True | False | None | A list of expected results. | False | |
171
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
172
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
173
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
174
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
175
+
176
+
177
+ ___
178
+
179
+ # Create Term
180
+ ## Term Name
181
+
182
+ Create Regulation Article
183
+
184
+ ## Description
185
+
186
+ A RegulationArticle entity is an article in a regulation. Dividing a regulation simplifies planning and execution.
187
+
188
+ ## Glossary
189
+
190
+ Egeria-Markdown
191
+
192
+ ## Folders
193
+
194
+ Writing Dr.Egeria Markdown
195
+
196
+ ## Usage
197
+
198
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
199
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
200
+ | Display Name | True | True | False | None | Name of the definition. | False | |
201
+ | Summary | False | True | False | None | Summary of the definition. | False | |
202
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
203
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
204
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
205
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
206
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
207
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
208
+ | Scope | False | True | False | None | Scope of the definition. | False | |
209
+ | Importance | False | True | False | None | Importance of the definition. | False | |
210
+ | Implications | False | True | False | None | List of implications. | False | |
211
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
212
+ | Results | False | True | False | None | A list of expected results. | False | |
213
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
214
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
215
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
216
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
217
+
218
+
219
+ ___
220
+
221
+ # Create Term
222
+ ## Term Name
223
+
224
+ Create Threat Definition
225
+
226
+ ## Description
227
+
228
+ The Threat entity describes a particular threat to the organization's operations that must either be guarded against or accommodated to reduce its impact.
229
+
230
+ ## Glossary
231
+
232
+ Egeria-Markdown
233
+
234
+ ## Folders
235
+
236
+ Writing Dr.Egeria Markdown
237
+
238
+ ## Usage
239
+
240
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
241
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
242
+ | Display Name | True | True | False | None | Name of the definition. | False | |
243
+ | Summary | False | True | False | None | Summary of the definition. | False | |
244
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
245
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
246
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
247
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
248
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
249
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
250
+ | Scope | False | True | False | None | Scope of the definition. | False | |
251
+ | Importance | False | True | False | None | Importance of the definition. | False | |
252
+ | Implications | False | True | False | None | List of implications. | False | |
253
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
254
+ | Results | False | True | False | None | A list of expected results. | False | |
255
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
256
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
257
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
258
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
259
+
260
+
261
+ ___
262
+
263
+ # Create Term
264
+ ## Term Name
265
+
266
+ Create Governance Policy
267
+
268
+ ## Description
269
+
270
+ Policies created in response to governance drivers. There are several types of policies.
271
+
272
+ ## Glossary
273
+
274
+ Egeria-Markdown
275
+
276
+ ## Folders
277
+
278
+ Writing Dr.Egeria Markdown
279
+
280
+ ## Usage
281
+
282
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
283
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
284
+ | Display Name | True | True | False | None | Name of the definition. | False | |
285
+ | Summary | False | True | False | None | Summary of the definition. | False | |
286
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
287
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
288
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
289
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
290
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
291
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
292
+ | Scope | False | True | False | None | Scope of the definition. | False | |
293
+ | Importance | False | True | False | None | Importance of the definition. | False | |
294
+ | Implications | False | True | False | None | List of implications. | False | |
295
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
296
+ | Results | False | True | False | None | A list of expected results. | False | |
297
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
298
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
299
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
300
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
301
+
302
+
303
+ ___
304
+
305
+ # Create Term
306
+ ## Term Name
307
+
308
+ Create Governance Principle
309
+
310
+ ## Description
311
+
312
+ The GovernancePrinciple entity defines a policy that describes an end state that the organization aims to achieve.
313
+
314
+ ## Glossary
315
+
316
+ Egeria-Markdown
317
+
318
+ ## Folders
319
+
320
+ Writing Dr.Egeria Markdown
321
+
322
+ ## Usage
323
+
324
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
325
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
326
+ | Display Name | True | True | False | None | Name of the definition. | False | |
327
+ | Summary | False | True | False | None | Summary of the definition. | False | |
328
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
329
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
330
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
331
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
332
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
333
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
334
+ | Scope | False | True | False | None | Scope of the definition. | False | |
335
+ | Importance | False | True | False | None | Importance of the definition. | False | |
336
+ | Implications | False | True | False | None | List of implications. | False | |
337
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
338
+ | Results | False | True | False | None | A list of expected results. | False | |
339
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
340
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
341
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
342
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
343
+
344
+
345
+ ___
346
+
347
+ # Create Term
348
+ ## Term Name
349
+
350
+ Create Governance Obligation
351
+
352
+ ## Description
353
+
354
+ The GovernanceObligation entity defines a policy that describes a requirement that must be met.
355
+
356
+ ## Glossary
357
+
358
+ Egeria-Markdown
359
+
360
+ ## Folders
361
+
362
+ Writing Dr.Egeria Markdown
363
+
364
+ ## Usage
365
+
366
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
367
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
368
+ | Display Name | True | True | False | None | Name of the definition. | False | |
369
+ | Summary | False | True | False | None | Summary of the definition. | False | |
370
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
371
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
372
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
373
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
374
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
375
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
376
+ | Scope | False | True | False | None | Scope of the definition. | False | |
377
+ | Importance | False | True | False | None | Importance of the definition. | False | |
378
+ | Implications | False | True | False | None | List of implications. | False | |
379
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
380
+ | Results | False | True | False | None | A list of expected results. | False | |
381
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
382
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
383
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
384
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
385
+
386
+
387
+ ___
388
+
389
+ # Create Term
390
+ ## Term Name
391
+
392
+ Create Governance Approach
393
+
394
+ ## Description
395
+
396
+ The GovernanceApproach entity defines a policy that describes a method that should be used for a particular activity.
397
+
398
+ ## Glossary
399
+
400
+ Egeria-Markdown
401
+
402
+ ## Folders
403
+
404
+ Writing Dr.Egeria Markdown
405
+
406
+ ## Usage
407
+
408
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
409
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
410
+ | Display Name | True | True | False | None | Name of the definition. | False | |
411
+ | Summary | False | True | False | None | Summary of the definition. | False | |
412
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
413
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
414
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
415
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
416
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
417
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
418
+ | Scope | False | True | False | None | Scope of the definition. | False | |
419
+ | Importance | False | True | False | None | Importance of the definition. | False | |
420
+ | Implications | False | True | False | None | List of implications. | False | |
421
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
422
+ | Results | False | True | False | None | A list of expected results. | False | |
423
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
424
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
425
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
426
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
427
+
428
+
429
+ ___
430
+
431
+ # Create Term
432
+ ## Term Name
433
+
434
+ Create Governance Control
435
+
436
+ ## Description
437
+
438
+ A governance control describes how a particular governance policy should be implemented. There are many types of controls.
439
+
440
+ ## Glossary
441
+
442
+ Egeria-Markdown
443
+
444
+ ## Folders
445
+
446
+ Writing Dr.Egeria Markdown
447
+
448
+ ## Usage
449
+
450
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
451
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
452
+ | Display Name | True | True | False | None | Name of the definition. | False | |
453
+ | Summary | False | True | False | None | Summary of the definition. | False | |
454
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
455
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
456
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
457
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
458
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
459
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
460
+ | Scope | False | True | False | None | Scope of the definition. | False | |
461
+ | Importance | False | True | False | None | Importance of the definition. | False | |
462
+ | Implications | False | True | False | None | List of implications. | False | |
463
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
464
+ | Results | False | True | False | None | A list of expected results. | False | |
465
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
466
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
467
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
468
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
469
+
470
+
471
+ ___
472
+
473
+ # Create Term
474
+ ## Term Name
475
+
476
+ Create Governance Metric
477
+
478
+ ## Description
479
+
480
+ A governance control describes how a particular governance policy should be implemented. There are many types of controls.
481
+
482
+ ## Glossary
483
+
484
+ Egeria-Markdown
485
+
486
+ ## Folders
487
+
488
+ Writing Dr.Egeria Markdown
489
+
490
+ ## Usage
491
+
492
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
493
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
494
+ | Display Name | True | True | False | None | Name of the definition. | False | |
495
+ | Summary | False | True | False | None | Summary of the definition. | False | |
496
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
497
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
498
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
499
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
500
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
501
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
502
+ | Scope | False | True | False | None | Scope of the definition. | False | |
503
+ | Importance | False | True | False | None | Importance of the definition. | False | |
504
+ | measurement | False | True | False | None | A measurement for a governance metric. | False | |
505
+ | target | False | True | False | None | Target values for a measurement. | False | |
506
+ | Implications | False | True | False | None | List of implications. | False | |
507
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
508
+ | Results | False | True | False | None | A list of expected results. | False | |
509
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
510
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
511
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
512
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
513
+
514
+
515
+ ___
516
+
517
+ # Create Term
518
+ ## Term Name
519
+
520
+ Create Governance Action
521
+
522
+ ## Description
523
+
524
+ An executable action, or sequence of actions to support a governance requirement.
525
+
526
+ ## Glossary
527
+
528
+ Egeria-Markdown
529
+
530
+ ## Folders
531
+
532
+ Writing Dr.Egeria Markdown
533
+
534
+ ## Usage
535
+
536
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
537
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
538
+ | Display Name | True | True | False | None | Name of the definition. | False | |
539
+ | Summary | False | True | False | None | Summary of the definition. | False | |
540
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
541
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
542
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
543
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
544
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
545
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
546
+ | Scope | False | True | False | None | Scope of the definition. | False | |
547
+ | Importance | False | True | False | None | Importance of the definition. | False | |
548
+ | Implications | False | True | False | None | List of implications. | False | |
549
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
550
+ | Results | False | True | False | None | A list of expected results. | False | |
551
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
552
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
553
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
554
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
555
+
556
+
557
+ ___
558
+
559
+ # Create Term
560
+ ## Term Name
561
+
562
+ Create Data Processing Purpose
563
+
564
+ ## Description
565
+
566
+ Privacy regulations such as (GDPR) require data subjects to agree the processing that is permitted on their data.
567
+
568
+ ## Glossary
569
+
570
+ Egeria-Markdown
571
+
572
+ ## Folders
573
+
574
+ Writing Dr.Egeria Markdown
575
+
576
+ ## Usage
577
+
578
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
579
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
580
+ | Display Name | True | True | False | None | Name of the definition. | False | |
581
+ | Summary | False | True | False | None | Summary of the definition. | False | |
582
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
583
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
584
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
585
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
586
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
587
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
588
+ | Scope | False | True | False | None | Scope of the definition. | False | |
589
+ | Importance | False | True | False | None | Importance of the definition. | False | |
590
+ | Implications | False | True | False | None | List of implications. | False | |
591
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
592
+ | Results | False | True | False | None | A list of expected results. | False | |
593
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
594
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
595
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
596
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
597
+
598
+
599
+ ___
600
+
601
+ # Create Term
602
+ ## Term Name
603
+
604
+ Create Governance Rule
605
+
606
+ ## Description
607
+
608
+ An executable rule that can be deployed at particular points in the operations.
609
+
610
+ ## Glossary
611
+
612
+ Egeria-Markdown
613
+
614
+ ## Folders
615
+
616
+ Writing Dr.Egeria Markdown
617
+
618
+ ## Usage
619
+
620
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
621
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
622
+ | Display Name | True | True | False | None | Name of the definition. | False | |
623
+ | Summary | False | True | False | None | Summary of the definition. | False | |
624
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
625
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
626
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
627
+ | Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
628
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
629
+ | Scope | False | True | False | None | Scope of the definition. | False | |
630
+ | Importance | False | True | False | None | Importance of the definition. | False | |
631
+ | Implementation Description | False | True | False | None | Describes how this governance control is implemnted. | False | |
632
+ | Supports Policies | False | True | False | None | The policies that this governance control supports. | False | |
633
+ | Implications | False | True | False | None | List of implications. | False | |
634
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
635
+ | Results | False | True | False | None | A list of expected results. | False | |
636
+ | Status | False | True | False | None | The status of the governance responsibility. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
637
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
638
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
639
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
640
+
641
+
642
+ ___
643
+
644
+ # Create Term
645
+ ## Term Name
646
+
647
+ Create Service Level Objectives
648
+
649
+ ## Description
650
+
651
+ Defines the performance, availability and quality levels expected by the element attached.
652
+
653
+ ## Glossary
654
+
655
+ Egeria-Markdown
656
+
657
+ ## Folders
658
+
659
+ Writing Dr.Egeria Markdown
660
+
661
+ ## Usage
662
+
663
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
664
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
665
+ | Display Name | True | True | False | None | Name of the definition. | False | |
666
+ | Summary | False | True | False | None | Summary of the definition. | False | |
667
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
668
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
669
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
670
+ | Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
671
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
672
+ | Scope | False | True | False | None | Scope of the definition. | False | |
673
+ | Importance | False | True | False | None | Importance of the definition. | False | |
674
+ | Implementation Description | False | True | False | None | Describes how this governance control is implemnted. | False | |
675
+ | Supports Policies | False | True | False | None | The policies that this governance control supports. | False | |
676
+ | Implications | False | True | False | None | List of implications. | False | |
677
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
678
+ | Results | False | True | False | None | A list of expected results. | False | |
679
+ | Status | False | True | False | None | The status of the governance responsibility. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
680
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
681
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
682
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
683
+
684
+
685
+ ___
686
+
687
+ # Create Term
688
+ ## Term Name
689
+
690
+ Create Governance Responsibility
691
+
692
+ ## Description
693
+
694
+ A responsibility assigned to an actor or team. It could be a requirement to take a certain action in specific circumstances or to make decisions or give approvals for actions.
695
+
696
+ ## Glossary
697
+
698
+ Egeria-Markdown
699
+
700
+ ## Folders
701
+
702
+ Writing Dr.Egeria Markdown
703
+
704
+ ## Usage
705
+
706
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
707
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
708
+ | Display Name | True | True | False | None | Name of the definition. | False | |
709
+ | Summary | False | True | False | None | Summary of the definition. | False | |
710
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
711
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
712
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
713
+ | Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
714
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
715
+ | Scope | False | True | False | None | Scope of the definition. | False | |
716
+ | Importance | False | True | False | None | Importance of the definition. | False | |
717
+ | Implementation Description | False | True | False | None | Describes how this governance control is implemnted. | False | |
718
+ | Supports Policies | False | True | False | None | The policies that this governance control supports. | False | |
719
+ | Implications | False | True | False | None | List of implications. | False | |
720
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
721
+ | Results | False | True | False | None | A list of expected results. | False | |
722
+ | Status | False | True | False | None | The status of the governance responsibility. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
723
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
724
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
725
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
726
+
727
+
728
+ ___
729
+
730
+ # Create Term
731
+ ## Term Name
732
+
733
+ Create Governance Procedure
734
+
735
+ ## Description
736
+
737
+ A manual procedure that is performed under certain circumstances.
738
+
739
+ ## Glossary
740
+
741
+ Egeria-Markdown
742
+
743
+ ## Folders
744
+
745
+ Writing Dr.Egeria Markdown
746
+
747
+ ## Usage
748
+
749
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
750
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
751
+ | Display Name | True | True | False | None | Name of the definition. | False | |
752
+ | Summary | False | True | False | None | Summary of the definition. | False | |
753
+ | Summary | False | True | False | None | Summary of the definition. | False | |
754
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
755
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
756
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
757
+ | Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
758
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
759
+ | Scope | False | True | False | None | Scope of the definition. | False | |
760
+ | Importance | False | True | False | None | Importance of the definition. | False | |
761
+ | Implementation Description | False | True | False | None | Describes how this governance control is implemnted. | False | |
762
+ | Supports Policies | False | True | False | None | The policies that this governance control supports. | False | |
763
+ | Implications | False | True | False | None | List of implications. | False | |
764
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
765
+ | Results | False | True | False | None | A list of expected results. | False | |
766
+ | Status | False | True | False | None | The status of the governance procedure. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
767
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
768
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
769
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
770
+
771
+
772
+ ___
773
+
774
+ # Create Term
775
+ ## Term Name
776
+
777
+ Create Security Access Control
778
+
779
+ ## Description
780
+
781
+ A technical control that defines the access control lists that an actor must belong to be entitled to perform a specific action.
782
+
783
+ ## Glossary
784
+
785
+ Egeria-Markdown
786
+
787
+ ## Folders
788
+
789
+ Writing Dr.Egeria Markdown
790
+
791
+ ## Usage
792
+
793
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
794
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
795
+ | Display Name | True | True | False | None | Name of the definition. | False | |
796
+ | Summary | False | True | False | None | Summary of the definition. | False | |
797
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
798
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
799
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
800
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
801
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
802
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
803
+ | Scope | False | True | False | None | Scope of the definition. | False | |
804
+ | Importance | False | True | False | None | Importance of the definition. | False | |
805
+ | Implications | False | True | False | None | List of implications. | False | |
806
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
807
+ | Results | False | True | False | None | A list of expected results. | False | |
808
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
809
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
810
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
811
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
812
+
813
+
814
+ ___
815
+
816
+ # Create Term
817
+ ## Term Name
818
+
819
+ Create Governance Zone
820
+
821
+ ## Description
822
+
823
+ A collection of assets that are used or processed in a specific way. Policies and controls can be attached to zones using the GovernedBy relationship.
824
+
825
+ ## Glossary
826
+
827
+ Egeria-Markdown
828
+
829
+ ## Folders
830
+
831
+ Writing Dr.Egeria Markdown
832
+
833
+ ## Usage
834
+
835
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
836
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
837
+ | Display Name | True | True | False | None | Name of the definition. | False | |
838
+ | Summary | False | True | False | None | Summary of the definition. | False | |
839
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
840
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
841
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
842
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
843
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
844
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
845
+ | Scope | False | True | False | None | Scope of the definition. | False | |
846
+ | Importance | False | True | False | None | Importance of the definition. | False | |
847
+ | criteria | False | True | False | None | The criteria for membership in a governance zone. | False | |
848
+ | Implications | False | True | False | None | List of implications. | False | |
849
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
850
+ | Results | False | True | False | None | A list of expected results. | False | |
851
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
852
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
853
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
854
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
855
+
856
+
857
+ ___
858
+
859
+ # Create Term
860
+ ## Term Name
861
+
862
+ Create Security Group
863
+
864
+ ## Description
865
+
866
+ A group of actors that need to be given the same access to a specific set of resources.
867
+
868
+ ## Glossary
869
+
870
+ Egeria-Markdown
871
+
872
+ ## Folders
873
+
874
+ Writing Dr.Egeria Markdown
875
+
876
+ ## Usage
877
+
878
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
879
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
880
+ | Display Name | True | True | False | None | Name of the definition. | False | |
881
+ | Summary | False | True | False | None | Summary of the definition. | False | |
882
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
883
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
884
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
885
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
886
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
887
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
888
+ | Scope | False | True | False | None | Scope of the definition. | False | |
889
+ | Importance | False | True | False | None | Importance of the definition. | False | |
890
+ | Implications | False | True | False | None | List of implications. | False | |
891
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
892
+ | Results | False | True | False | None | A list of expected results. | False | |
893
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
894
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
895
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
896
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
897
+
898
+
899
+ ___
900
+
901
+ # Create Term
902
+ ## Term Name
903
+
904
+ Create Naming Standard Rule
905
+
906
+ ## Description
907
+
908
+ A standard for naming specific kinds of resources.
909
+
910
+ ## Glossary
911
+
912
+ Egeria-Markdown
913
+
914
+ ## Folders
915
+
916
+ Writing Dr.Egeria Markdown
917
+
918
+ ## Usage
919
+
920
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
921
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
922
+ | Display Name | True | True | False | None | Name of the definition. | False | |
923
+ | Summary | False | True | False | None | Summary of the definition. | False | |
924
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
925
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
926
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
927
+ | Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
928
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
929
+ | Scope | False | True | False | None | Scope of the definition. | False | |
930
+ | Importance | False | True | False | None | Importance of the definition. | False | |
931
+ | Implementation Description | False | True | False | None | Describes how this governance control is implemnted. | False | |
932
+ | Supports Policies | False | True | False | None | The policies that this governance control supports. | False | |
933
+ | Name Patterns | False | True | False | None | List of implications. | False | |
934
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
935
+ | Results | False | True | False | None | A list of expected results. | False | |
936
+ | Status | False | True | False | None | The status of the naming standard rule. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
937
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
938
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
939
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
940
+
941
+
942
+ ___
943
+
944
+ # Create Term
945
+ ## Term Name
946
+
947
+ Link Terms & Conditions
948
+
949
+ ## Description
950
+
951
+ Attach or detach an agreement to a defined set of terms and conditions.
952
+
953
+ ## Glossary
954
+
955
+ Egeria-Markdown
956
+
957
+ ## Folders
958
+
959
+ Writing Dr.Egeria Markdown
960
+
961
+ ## Usage
962
+
963
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
964
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
965
+ | Display Name | True | True | False | None | Terms and Conditions are a form of governance control. | False | |
966
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
967
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
968
+ | Summary | False | True | False | None | Summary of the definition. | False | |
969
+ | Scope | False | True | False | None | Scope of the definition. | False | |
970
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
971
+ | Importance | False | True | False | None | Importance of the definition. | False | |
972
+ | Implications | False | True | False | None | List of implications. | False | |
973
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
974
+ | Results | False | True | False | None | A list of expected results. | False | |
975
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
976
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
977
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
978
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
979
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
980
+ | Identifier | False | True | False | None | A user specified identifier. | False | |
981
+ | Domain Identifier | False | True | False | None | The governance domain of the governance definition. | False | |
982
+ | Restrictions | False | True | False | None | A dictionary of property:value pairs describing restrictions. | False | |
983
+ | Obligations | False | True | False | None | A dictionary of property:value pairs describing obligations. | False | |
984
+ | Entitlements | False | True | False | None | A dictionary of property:value pairs describing entitlements. | False | |
985
+
986
+
987
+ ___
988
+
989
+ # Create Term
990
+ ## Term Name
991
+
992
+ Create Certification Type
993
+
994
+ ## Description
995
+
996
+ A type of certification.
997
+
998
+ ## Glossary
999
+
1000
+ Egeria-Markdown
1001
+
1002
+ ## Folders
1003
+
1004
+ Writing Dr.Egeria Markdown
1005
+
1006
+ ## Usage
1007
+
1008
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1009
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1010
+ | Display Name | True | True | False | None | Name of the definition. | False | |
1011
+ | Summary | False | True | False | None | Summary of the definition. | False | |
1012
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
1013
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
1014
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
1015
+ | Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
1016
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
1017
+ | Scope | False | True | False | None | Scope of the definition. | False | |
1018
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
1019
+ | Importance | False | True | False | None | Importance of the definition. | False | |
1020
+ | Details | False | True | False | None | Details of the certification. | False | |
1021
+ | Implications | False | True | False | None | List of implications. | False | |
1022
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
1023
+ | Results | False | True | False | None | A list of expected results. | False | |
1024
+ | Restrictions | False | True | False | None | A dictionary of property:value pairs describing restrictions. | False | |
1025
+ | Obligations | False | True | False | None | A dictionary of property:value pairs describing obligations. | False | |
1026
+ | Entitlements | False | True | False | None | A dictionary of property:value pairs describing entitlements. | False | |
1027
+ | Status | False | True | False | None | The status of the certification type. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
1028
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
1029
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
1030
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
1031
+
1032
+
1033
+ ___
1034
+
1035
+ # Create Term
1036
+ ## Term Name
1037
+
1038
+ Create License Type
1039
+
1040
+ ## Description
1041
+
1042
+ A type of license.
1043
+
1044
+ ## Glossary
1045
+
1046
+ Egeria-Markdown
1047
+
1048
+ ## Folders
1049
+
1050
+ Writing Dr.Egeria Markdown
1051
+
1052
+ ## Usage
1053
+
1054
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1055
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1056
+ | Display Name | True | True | False | None | Name of the definition. | False | |
1057
+ | Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
1058
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
1059
+ | Summary | False | True | False | None | Summary of the definition. | False | |
1060
+ | Scope | False | True | False | None | Scope of the definition. | False | |
1061
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
1062
+ | Importance | False | True | False | None | Importance of the definition. | False | |
1063
+ | Implications | False | True | False | None | List of implications. | False | |
1064
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
1065
+ | Results | False | True | False | None | A list of expected results. | False | |
1066
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
1067
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
1068
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
1069
+ | Details | False | True | False | None | Details of the license. | False | |
1070
+ | Status | False | True | False | None | The status of the license type definition. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
1071
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
1072
+ | Restrictions | False | True | False | None | A dictionary of property:value pairs describing restrictions. | False | |
1073
+ | Obligations | False | True | False | None | A dictionary of property:value pairs describing obligations. | False | |
1074
+ | Entitlements | False | True | False | None | A dictionary of property:value pairs describing entitlements. | False | |
1075
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
1076
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
1077
+
1078
+
1079
+ ___
1080
+
1081
+ # Create Term
1082
+ ## Term Name
1083
+
1084
+ Link Governed By
1085
+
1086
+ ## Description
1087
+
1088
+ A referenceable element can be governed by one or more governance definitions.
1089
+
1090
+ ## Glossary
1091
+
1092
+ Egeria-Markdown
1093
+
1094
+ ## Folders
1095
+
1096
+ Writing Dr.Egeria Markdown
1097
+
1098
+ ## Usage
1099
+
1100
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1101
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1102
+ | Governance Definition | True | True | False | None | The governance definition providing governance. | False | |
1103
+ | Referenceable | True | True | False | None | The object being governed. | False | |
1104
+ | Link Label | False | True | False | None | Labels the link between two elements. | False | |
1105
+ | Description | False | True | False | None | A description of the relationship. | False | |
1106
+
1107
+
1108
+ ___
1109
+
1110
+ # Create Term
1111
+ ## Term Name
1112
+
1113
+ Link License
1114
+
1115
+ ## Description
1116
+
1117
+ A license relationship between a license type and a Referencable element.
1118
+
1119
+ ## Glossary
1120
+
1121
+ Egeria-Markdown
1122
+
1123
+ ## Folders
1124
+
1125
+ Writing Dr.Egeria Markdown
1126
+
1127
+ ## Usage
1128
+
1129
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1130
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1131
+ | License Type | True | True | False | None | The license type being used for the license. | False | |
1132
+ | Referenceable | True | True | False | None | The object being licensed. | False | |
1133
+ | License GUID | False | True | False | None | Unique identifier of the license. | True | |
1134
+ | Start Date | False | True | False | None | Date at which the license takes effect. | False | |
1135
+ | End Date | False | True | False | None | Date at which the license expires. | False | |
1136
+ | Conditions | False | True | False | None | License conditions. | False | |
1137
+ | Licensed By | False | True | False | None | | False | |
1138
+ | Licensed By Type Name | False | True | False | None | | False | |
1139
+ | Licensed By Property Name | False | True | False | None | | False | |
1140
+ | Custodian | False | True | False | None | Custodian of the license. | False | |
1141
+ | Custodian Type Name | False | True | False | None | | False | |
1142
+ | Custodian Property Name | False | True | False | None | | False | |
1143
+ | Licensee | False | True | False | None | The licensee. | False | |
1144
+ | Licensee Type Name | False | True | False | None | | False | |
1145
+ | Licensee Property Name | False | True | False | None | | False | |
1146
+ | Entitlements | False | True | False | None | What the license grants to the licensee. | False | |
1147
+ | Restrictions | False | True | False | None | Restrictions imposed by the license. | False | |
1148
+ | Obligations | False | True | False | None | Obligations defined by the license. | False | |
1149
+ | Notes | False | True | False | None | Notes about the license. | False | |
1150
+
1151
+
1152
+ ___
1153
+
1154
+ # Create Term
1155
+ ## Term Name
1156
+
1157
+ Link Certification
1158
+
1159
+ ## Description
1160
+
1161
+ A certification relationship between a certification type and a referenceable element.
1162
+
1163
+ ## Glossary
1164
+
1165
+ Egeria-Markdown
1166
+
1167
+ ## Folders
1168
+
1169
+ Writing Dr.Egeria Markdown
1170
+
1171
+ ## Usage
1172
+
1173
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1174
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1175
+ | Certification Type | True | True | False | None | The license type being used for the license. | False | |
1176
+ | Referenceable | True | True | False | None | The object being certified. | False | |
1177
+ | Certificate GUID | False | True | False | None | Unique identifier of the certificate. | True | |
1178
+ | Start Date | False | True | False | None | Date at which the certification takes effect. | False | |
1179
+ | End Date | False | True | False | None | Date at which the certification expires. | False | |
1180
+ | Conditions | False | True | False | None | Certification conditions. | False | |
1181
+ | Certified By | False | True | False | None | | False | |
1182
+ | Certified By Type Name | False | True | False | None | | False | |
1183
+ | Certified By Property Name | False | True | False | None | | False | |
1184
+ | Custodian | False | True | False | None | Custodian of the certification. | False | |
1185
+ | Custodian Type Name | False | True | False | None | | False | |
1186
+ | Custodian Property Name | False | True | False | None | | False | |
1187
+ | Recipient | False | True | False | None | The receiver of the certification. | False | |
1188
+ | Recipient Type Name | False | True | False | None | | False | |
1189
+ | Recipient Property Name | False | True | False | None | | False | |
1190
+ | Notes | False | True | False | None | Notes about the certification. | False | |
1191
+
1192
+
1193
+ ___
1194
+
1195
+ # Create Term
1196
+ ## Term Name
1197
+
1198
+ Link Regulation Certification Type
1199
+
1200
+ ## Description
1201
+
1202
+ A certification type addressing a specific regulation.
1203
+
1204
+ ## Glossary
1205
+
1206
+ Egeria-Markdown
1207
+
1208
+ ## Folders
1209
+
1210
+ Writing Dr.Egeria Markdown
1211
+
1212
+ ## Usage
1213
+
1214
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1215
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1216
+ | Certification Type | True | True | False | None | The license type being used for the license. | False | |
1217
+ | Regulation | True | True | False | None | The regulation that a certification type addresses. | False | |
1218
+
1219
+
1220
+ ___
1221
+
1222
+ # Create Term
1223
+ ## Term Name
1224
+
1225
+ Link Agreement->T&C
1226
+
1227
+ ## Description
1228
+
1229
+ Attach or detach an agreement to a defined set of terms and conditions.
1230
+
1231
+ ## Glossary
1232
+
1233
+ Egeria-Markdown
1234
+
1235
+ ## Folders
1236
+
1237
+ Writing Dr.Egeria Markdown
1238
+
1239
+ ## Usage
1240
+
1241
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1242
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1243
+ | Agreement Name | True | True | False | None | The name of the agreement to add an item to. Using qualified names is recommended. | False | |
1244
+ | Identifier | False | True | False | None | A user specified identifier. | False | |
1245
+ | Domain Identifier | False | True | False | None | The governance domain of the governance definition. | False | |
1246
+ | T&C Definition Name | True | True | False | None | The name of the Terms and Conditions definition that governans an agreement. Using qualified names is recommended. | False | |
1247
+ | Implementation Description | False | True | False | None | How the Terms and Conditions are implemented. | False | |
1248
+ | Agreement Start | False | True | False | None | The start date of the agreement as an ISO 8601 string. | False | |
1249
+ | Agreement End | False | True | False | None | The end date of the agreement as an ISO 8601 string. | False | |
1250
+ | Restrictions | False | True | False | None | A dictionary of property:value pairs describing restrictions. | False | |
1251
+ | Obligations | False | True | False | None | A dictionary of property:value pairs describing obligations. | False | |
1252
+ | Entitlements | False | True | False | None | A dictionary of property:value pairs describing entitlements. | False | |
1253
+ | Usage Measurements | False | True | False | None | A dictionary of property:value pairs describing usage measurements. | False | |
1254
+
1255
+
1256
+ ___
1257
+
1258
+ # Create Term
1259
+ ## Term Name
1260
+
1261
+ Link Governance Drivers
1262
+
1263
+ ## Description
1264
+
1265
+ Link peer governance drivers with the GovernanceDriverLink relationship. Drivers are: GovernanceStrategy, BusinessImperitive, Regulation, RegulationArticle, Threat.
1266
+
1267
+ ## Glossary
1268
+
1269
+ Egeria-Markdown
1270
+
1271
+ ## Folders
1272
+
1273
+ Writing Dr.Egeria Markdown
1274
+
1275
+ ## Usage
1276
+
1277
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1278
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1279
+ | Definition 1 | True | True | False | None | The first governance driver to link. | False | |
1280
+ | Definition 2 | True | True | False | None | The second governance driver to link. | False | |
1281
+ | Link Label | False | True | False | None | Labels the link between two governance defninitions. | False | |
1282
+ | Description | False | True | False | None | A description of the relationship. | False | |
1283
+
1284
+
1285
+ ___
1286
+
1287
+ # Create Term
1288
+ ## Term Name
1289
+
1290
+ Link Governance Response
1291
+
1292
+ ## Description
1293
+
1294
+ Links Policies as a response to governance Drivers.
1295
+
1296
+ ## Glossary
1297
+
1298
+ Egeria-Markdown
1299
+
1300
+ ## Folders
1301
+
1302
+ Writing Dr.Egeria Markdown
1303
+
1304
+ ## Usage
1305
+
1306
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1307
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1308
+ | Definition 1 | True | True | False | None | The first governance driver to link. | False | |
1309
+ | Definition 2 | True | True | False | None | The second governance driver to link. | False | |
1310
+ | Link Label | False | True | False | None | Labels the link between two governance defninitions. | False | |
1311
+ | Description | False | True | False | None | A description of the relationship. | False | |
1312
+ | Rationale | False | True | False | None | The rationale for using this control to support this policy. | False | |
1313
+
1314
+
1315
+ ___
1316
+
1317
+ # Create Term
1318
+ ## Term Name
1319
+
1320
+ Link Security Group -> Security Access Control
1321
+
1322
+ ## Description
1323
+
1324
+ Establishes that a Security Access Control applies to this Security Group.
1325
+
1326
+ ## Glossary
1327
+
1328
+ Egeria-Markdown
1329
+
1330
+ ## Folders
1331
+
1332
+ Writing Dr.Egeria Markdown
1333
+
1334
+ ## Usage
1335
+
1336
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1337
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1338
+ | Definition 1 | True | True | False | None | The first governance policy to link. | False | |
1339
+ | Definition 2 | True | True | False | None | The second governance policy to link. | False | |
1340
+ | Link Label | False | True | False | None | Labels the link between two governance defninitions. | False | |
1341
+ | Description | False | True | False | None | A description of the relationship. | False | |
1342
+ | Operation Name | False | True | False | None | The name of the operation controled by the SecurityAccessControl. | False | |
1343
+
1344
+
1345
+ ___
1346
+
1347
+ # Create Term
1348
+ ## Term Name
1349
+
1350
+ Link Governance Policies
1351
+
1352
+ ## Description
1353
+
1354
+ Link peer governance policies with the GovernancePolicyLink relationship. Policies types are: GovernancePrinciple, GovernanceObligation, GovernanceApproach.
1355
+
1356
+ ## Glossary
1357
+
1358
+ Egeria-Markdown
1359
+
1360
+ ## Folders
1361
+
1362
+ Writing Dr.Egeria Markdown
1363
+
1364
+ ## Usage
1365
+
1366
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1367
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1368
+ | Definition 1 | True | True | False | None | The first governance policy to link. | False | |
1369
+ | Definition 2 | True | True | False | None | The second governance policy to link. | False | |
1370
+ | Link Label | False | True | False | None | Labels the link between two governance defninitions. | False | |
1371
+ | Description | False | True | False | None | A description of the relationship. | False | |
1372
+
1373
+
1374
+ ___
1375
+
1376
+ # Create Term
1377
+ ## Term Name
1378
+
1379
+ Link Governance Mechanism
1380
+
1381
+ ## Description
1382
+
1383
+ Link a governance policy to a governance control that supports it. The GovernanceMechanism relationship is used.
1384
+
1385
+ ## Glossary
1386
+
1387
+ Egeria-Markdown
1388
+
1389
+ ## Folders
1390
+
1391
+ Writing Dr.Egeria Markdown
1392
+
1393
+ ## Usage
1394
+
1395
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1396
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1397
+ | Definition 1 | True | True | False | None | The first governance policy to link. | False | |
1398
+ | Definition 2 | True | True | False | None | The second governance policy to link. | False | |
1399
+ | Link Label | False | True | False | None | Labels the link between two governance defninitions. | False | |
1400
+ | Description | False | True | False | None | A description of the relationship. | False | |
1401
+ | Rationale | False | True | False | None | The rationale for using this control to support this policy. | False | |
1402
+
1403
+
1404
+ ___
1405
+
1406
+ # Create Term
1407
+ ## Term Name
1408
+
1409
+ Link Governance Controls
1410
+
1411
+ ## Description
1412
+
1413
+ Link peer governance controls with the GovernanceControlLink relationship. Controls types are: GovernanceRule, GovernanceProcess, GovernanceResponsibility, GovernanceProcedure, SecurityAccessControl, SecurityGroup.
1414
+
1415
+ ## Glossary
1416
+
1417
+ Egeria-Markdown
1418
+
1419
+ ## Folders
1420
+
1421
+ Writing Dr.Egeria Markdown
1422
+
1423
+ ## Usage
1424
+
1425
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1426
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1427
+ | Control Definition 1 | True | True | False | None | The first governance control to link. | False | |
1428
+ | Control Definition 2 | True | True | False | None | The fsecond governance control to link. | False | |
1429
+ | Link Label | False | True | False | None | Labels the link between two governance defninitions. | False | |
1430
+ | Description | False | True | False | None | A description of the relationship. | False | |
1431
+
1432
+
1433
+ ___
1434
+
1435
+ # Create Term
1436
+ ## Term Name
1437
+
1438
+ Link Zone->Zone
1439
+
1440
+ ## Description
1441
+
1442
+ Links child governance zones to parent governance zone.
1443
+
1444
+ ## Glossary
1445
+
1446
+ Egeria-Markdown
1447
+
1448
+ ## Folders
1449
+
1450
+ Writing Dr.Egeria Markdown
1451
+
1452
+ ## Usage
1453
+
1454
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1455
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1456
+ | Control Definition 1 | True | True | False | None | The first governance control to link. | False | |
1457
+ | Control Definition 2 | True | True | False | None | The fsecond governance control to link. | False | |
1458
+ | Link Label | False | True | False | None | Labels the link between two governance defninitions. | False | |
1459
+ | Description | False | True | False | None | A description of the relationship. | False | |
1460
+
1461
+
1462
+ ___
1463
+
1464
+ # Create Term
1465
+ ## Term Name
1466
+
1467
+ View Governance Definition Context
1468
+
1469
+ ## Description
1470
+
1471
+ List information about a governance definition and its related elements.
1472
+
1473
+ ## Glossary
1474
+
1475
+ Egeria-Markdown
1476
+
1477
+ ## Folders
1478
+
1479
+ Writing Dr.Egeria Markdown
1480
+
1481
+ ## Usage
1482
+
1483
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1484
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1485
+ | Display Name | True | True | False | None | The unique name of the governance definition to display information for. | False | |
1486
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; MERMAID; DICT |
1487
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
1488
+ | 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 |
1489
+ | Order Property Name | False | True | False | None | The property to use for sorting if the sort_order_property is PROPERTY_ASCENDING or PROPERTY_DESCENDING | False | |
1490
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
1491
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
1492
+
1493
+
1494
+ ___
1495
+
1496
+ # Create Term
1497
+ ## Term Name
1498
+
1499
+ View Governance Definitions
1500
+
1501
+ ## Description
1502
+
1503
+ List collections based on search string.
1504
+
1505
+ ## Glossary
1506
+
1507
+ Egeria-Markdown
1508
+
1509
+ ## Folders
1510
+
1511
+ Writing Dr.Egeria Markdown
1512
+
1513
+ ## Usage
1514
+
1515
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1516
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1517
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
1518
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; DICT; MD; MERMAID; HTML |
1519
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
1520
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
1521
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
1522
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
1523
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
1524
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
1525
+
1526
+
1527
+ ___
1528
+
1529
+ # Create Term
1530
+ ## Term Name
1531
+
1532
+ Create External Reference
1533
+
1534
+ ## Description
1535
+
1536
+ Create or update External Reference Elements - or sub-types Related Media, Cited Documents, External Data Source and External Model Source.
1537
+
1538
+ ## Glossary
1539
+
1540
+ Egeria-Markdown
1541
+
1542
+ ## Folders
1543
+
1544
+ Writing Dr.Egeria Markdown
1545
+
1546
+ ## Usage
1547
+
1548
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1549
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1550
+ | Display Name | True | True | False | None | Name of the digital product | False | |
1551
+ | Description | False | True | False | None | Description of the contents of a product. | False | |
1552
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
1553
+ | Reference Title | False | True | False | None | Title of the external reference. | False | |
1554
+ | Reference Abstract | False | True | False | None | Abstract for the remote reference. | False | |
1555
+ | Authors | False | True | False | None | A list of authors. | False | |
1556
+ | Organization | False | True | False | None | Organization owning the external reference. | False | |
1557
+ | URL | False | True | False | None | URL to access the external reference. | False | |
1558
+ | Sources | False | True | False | None | A map of source strings. | False | |
1559
+ | License | False | True | False | None | The license associated with the external reference. | False | |
1560
+ | Copyright | False | True | False | None | The copy right associated with the external reference. | False | |
1561
+ | Attribution | False | True | False | None | Attribution string to describe the external reference. | False | |
1562
+ | Version Identifier | False | True | False | None | Published product version identifier. | False | |
1563
+ | Classifications | False | True | False | None | Optionally specify the initial classifications for a collection. Multiple classifications can be specified. | False | |
1564
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
1565
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
1566
+ | Additional Properties | False | True | False | None | Additional user defined values organized as name value pairs in a dictionary. | False | |
1567
+
1568
+
1569
+ ___
1570
+
1571
+ # Create Term
1572
+ ## Term Name
1573
+
1574
+ Create External Data Source
1575
+
1576
+ ## Description
1577
+
1578
+ An external data source.
1579
+
1580
+ ## Glossary
1581
+
1582
+ Egeria-Markdown
1583
+
1584
+ ## Folders
1585
+
1586
+ Writing Dr.Egeria Markdown
1587
+
1588
+ ## Usage
1589
+
1590
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1591
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1592
+ | Display Name | True | True | False | None | Name of the digital product | False | |
1593
+ | Description | False | True | False | None | Description of the contents of a product. | False | |
1594
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
1595
+ | Reference Title | False | True | False | None | Title of the external reference. | False | |
1596
+ | Reference Abstract | False | True | False | None | Abstract for the remote reference. | False | |
1597
+ | Authors | False | True | False | None | A list of authors. | False | |
1598
+ | Organization | False | True | False | None | Organization owning the external reference. | False | |
1599
+ | URL | False | True | False | None | URL to access the external reference. | False | |
1600
+ | Sources | False | True | False | None | A map of source strings. | False | |
1601
+ | License | False | True | False | None | The license associated with the external reference. | False | |
1602
+ | Copyright | False | True | False | None | The copy right associated with the external reference. | False | |
1603
+ | Attribution | False | True | False | None | Attribution string to describe the external reference. | False | |
1604
+ | Version Identifier | False | True | False | None | Published product version identifier. | False | |
1605
+ | Classifications | False | True | False | None | Optionally specify the initial classifications for a collection. Multiple classifications can be specified. | False | |
1606
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
1607
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
1608
+ | Additional Properties | False | True | False | None | Additional user defined values organized as name value pairs in a dictionary. | False | |
1609
+
1610
+
1611
+ ___
1612
+
1613
+ # Create Term
1614
+ ## Term Name
1615
+
1616
+ Create External Model Source
1617
+
1618
+ ## Description
1619
+
1620
+ An external model.
1621
+
1622
+ ## Glossary
1623
+
1624
+ Egeria-Markdown
1625
+
1626
+ ## Folders
1627
+
1628
+ Writing Dr.Egeria Markdown
1629
+
1630
+ ## Usage
1631
+
1632
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1633
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1634
+ | Display Name | True | True | False | None | Name of the digital product | False | |
1635
+ | Description | False | True | False | None | Description of the contents of a product. | False | |
1636
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
1637
+ | Reference Title | False | True | False | None | Title of the external reference. | False | |
1638
+ | Reference Abstract | False | True | False | None | Abstract for the remote reference. | False | |
1639
+ | Authors | False | True | False | None | A list of authors. | False | |
1640
+ | Organization | False | True | False | None | Organization owning the external reference. | False | |
1641
+ | URL | False | True | False | None | URL to access the external reference. | False | |
1642
+ | Sources | False | True | False | None | A map of source strings. | False | |
1643
+ | License | False | True | False | None | The license associated with the external reference. | False | |
1644
+ | Copyright | False | True | False | None | The copy right associated with the external reference. | False | |
1645
+ | Attribution | False | True | False | None | Attribution string to describe the external reference. | False | |
1646
+ | Version Identifier | False | True | False | None | Published product version identifier. | False | |
1647
+ | Classifications | False | True | False | None | Optionally specify the initial classifications for a collection. Multiple classifications can be specified. | False | |
1648
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
1649
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
1650
+ | Additional Properties | False | True | False | None | Additional user defined values organized as name value pairs in a dictionary. | False | |
1651
+
1652
+
1653
+ ___
1654
+
1655
+ # Create Term
1656
+ ## Term Name
1657
+
1658
+ Create Related Media
1659
+
1660
+ ## Description
1661
+
1662
+ Related external media.
1663
+
1664
+ ## Glossary
1665
+
1666
+ Egeria-Markdown
1667
+
1668
+ ## Folders
1669
+
1670
+ Writing Dr.Egeria Markdown
1671
+
1672
+ ## Usage
1673
+
1674
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1675
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1676
+ | Display Name | True | True | False | None | Name of the digital product | False | |
1677
+ | Description | False | True | False | None | Description of the contents of a product. | False | |
1678
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
1679
+ | Reference Title | False | True | False | None | Title of the external reference. | False | |
1680
+ | Reference Abstract | False | True | False | None | Abstract for the remote reference. | False | |
1681
+ | Authors | False | True | False | None | A list of authors. | False | |
1682
+ | Organization | False | True | False | None | Organization owning the external reference. | False | |
1683
+ | URL | False | True | False | None | URL to access the external reference. | False | |
1684
+ | Sources | False | True | False | None | A map of source strings. | False | |
1685
+ | License | False | True | False | None | The license associated with the external reference. | False | |
1686
+ | Copyright | False | True | False | None | The copy right associated with the external reference. | False | |
1687
+ | Attribution | False | True | False | None | Attribution string to describe the external reference. | False | |
1688
+ | Media Type | False | True | False | None | Type of media. | False | IMAGE; AUDIO; DOCUMENT; VIDEO; OTHER |
1689
+ | Media Type Other Id | False | True | False | None | An id associated with the media type. | False | |
1690
+ | Default Media Usage | False | True | False | None | How the media is being used. | False | ICON; THUMBNAIL; ILLUSTRATION; USAGE_GUIDANCE; OTHER |
1691
+ | default Media Usage Other Id | False | True | False | None | An id associated with the media usage. | False | |
1692
+ | Version Identifier | False | True | False | None | Published product version identifier. | False | |
1693
+ | Classifications | False | True | False | None | Optionally specify the initial classifications for a collection. Multiple classifications can be specified. | False | |
1694
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
1695
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
1696
+
1697
+
1698
+ ___
1699
+
1700
+ # Create Term
1701
+ ## Term Name
1702
+
1703
+ Create Cited Document
1704
+
1705
+ ## Description
1706
+
1707
+ A cited document
1708
+
1709
+ ## Glossary
1710
+
1711
+ Egeria-Markdown
1712
+
1713
+ ## Folders
1714
+
1715
+ Writing Dr.Egeria Markdown
1716
+
1717
+ ## Usage
1718
+
1719
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1720
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1721
+ | Display Name | True | True | False | None | Name of the digital product | False | |
1722
+ | Description | False | True | False | None | Description of the contents of a product. | False | |
1723
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
1724
+ | Reference Title | False | True | False | None | Title of the external reference. | False | |
1725
+ | Reference Abstract | False | True | False | None | Abstract for the remote reference. | False | |
1726
+ | Authors | False | True | False | None | A list of authors. | False | |
1727
+ | Organization | False | True | False | None | Organization owning the external reference. | False | |
1728
+ | URL | False | True | False | None | URL to access the external reference. | False | |
1729
+ | Sources | False | True | False | None | A map of source strings. | False | |
1730
+ | License | False | True | False | None | The license associated with the external reference. | False | |
1731
+ | Copyright | False | True | False | None | The copy right associated with the external reference. | False | |
1732
+ | Attribution | False | True | False | None | Attribution string to describe the external reference. | False | |
1733
+ | Number of Pages | False | True | False | None | The number of pages in the document. | False | |
1734
+ | Page Range | False | True | False | None | The range of pages cited. | False | |
1735
+ | Publication Series | False | True | False | None | The series this publication is part of. | False | |
1736
+ | Publication Series Volume | False | True | False | None | The volume in the series that contains the citation. | False | |
1737
+ | Publisher | False | True | False | None | The name of the publisher. | False | |
1738
+ | Edition | False | True | False | None | The edition being cited. | False | |
1739
+ | First Publication Date | False | True | False | None | Date of first publication written as an ISO string - 2025-01-31 | False | |
1740
+ | Publication Date | False | True | False | None | Publication date. In ISO 8601 format - 2025-02-23. | False | |
1741
+ | Publication City | False | True | False | None | City of publication. | False | |
1742
+ | Publication Year | False | True | False | None | Year of publication. | False | |
1743
+ | Publication Numbers | False | True | False | None | Identification numbers of the publication, if relevant. | False | |
1744
+ | Version Identifier | False | True | False | None | Published product version identifier. | False | |
1745
+ | Classifications | False | True | False | None | Optionally specify the initial classifications for a collection. Multiple classifications can be specified. | False | |
1746
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
1747
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
1748
+
1749
+
1750
+ ___
1751
+
1752
+ # Create Term
1753
+ ## Term Name
1754
+
1755
+ Link External Reference Link
1756
+
1757
+ ## Description
1758
+
1759
+ Link an external reference to a referenceable.
1760
+
1761
+ ## Glossary
1762
+
1763
+ Egeria-Markdown
1764
+
1765
+ ## Folders
1766
+
1767
+ Writing Dr.Egeria Markdown
1768
+
1769
+ ## Usage
1770
+
1771
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1772
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1773
+ | Element Name | True | True | False | None | A referenceable to link. | False | |
1774
+ | External Reference | True | True | False | None | The external reference to link to. | False | |
1775
+ | Label | False | True | False | None | Labels the link between the referenceable and the external reference. | False | |
1776
+ | Description | False | True | False | None | A description of the link. | False | |
1777
+
1778
+
1779
+ ___
1780
+
1781
+ # Create Term
1782
+ ## Term Name
1783
+
1784
+ Link Media Reference Link
1785
+
1786
+ ## Description
1787
+
1788
+ Link a medial reference to a referenceable.
1789
+
1790
+ ## Glossary
1791
+
1792
+ Egeria-Markdown
1793
+
1794
+ ## Folders
1795
+
1796
+ Writing Dr.Egeria Markdown
1797
+
1798
+ ## Usage
1799
+
1800
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1801
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1802
+ | Element Name | True | True | False | None | A referenceable to link. | False | |
1803
+ | Media Reference | True | True | False | None | The media reference to link to. | False | |
1804
+ | Label | False | True | False | None | Labels the link between the referenceable and the media reference. | False | |
1805
+ | Description | False | True | False | None | A description of the link. | False | |
1806
+ | Media Id | False | True | False | None | An identifier of the media to link to. | False | |
1807
+ | Media Usage | False | True | False | None | How the media is being used. | False | ICON; THUMBNAIL; ILLUSTRATION; USAGE_GUIDANCE; OTHER |
1808
+ | Media Usage Other Id | False | True | False | None | An id associated with the media usage. | False | |
1809
+
1810
+
1811
+ ___
1812
+
1813
+ # Create Term
1814
+ ## Term Name
1815
+
1816
+ Link Cited Document Link
1817
+
1818
+ ## Description
1819
+
1820
+ Link a cited document reference to a referenceable.
1821
+
1822
+ ## Glossary
1823
+
1824
+ Egeria-Markdown
1825
+
1826
+ ## Folders
1827
+
1828
+ Writing Dr.Egeria Markdown
1829
+
1830
+ ## Usage
1831
+
1832
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1833
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1834
+ | Element Name | True | True | False | None | A referenceable to link. | False | |
1835
+ | Cited Document | True | True | False | None | The cited document to link to. | False | |
1836
+ | Label | False | True | False | None | Labels the link between the referenceable and the media reference. | False | |
1837
+ | Description | False | True | False | None | A description of the link. | False | |
1838
+ | Reference Id | False | True | False | None | An identifier of the cited document to link to. | False | |
1839
+ | Pages | False | True | False | None | The pages referenced. | False | |
1840
+
1841
+
1842
+ ___
1843
+
1844
+ # Create Term
1845
+ ## Term Name
1846
+
1847
+ View External References
1848
+
1849
+ ## Description
1850
+
1851
+ List external references (and subtypes).
1852
+
1853
+ ## Glossary
1854
+
1855
+ Egeria-Markdown
1856
+
1857
+ ## Folders
1858
+
1859
+ Writing Dr.Egeria Markdown
1860
+
1861
+ ## Usage
1862
+
1863
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1864
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1865
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
1866
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; DICT; MD; MERMAID; HTML |
1867
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
1868
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
1869
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
1870
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
1871
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
1872
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
1873
+
1874
+
1875
+ ___
1876
+
1877
+ # Create Term
1878
+ ## Term Name
1879
+
1880
+ Create Collection
1881
+
1882
+ ## Description
1883
+
1884
+ Create or update a generic collection. While it can be used to create specific kinds of collections, you cannot set the collection-specific properties - so use the appropriate Dr.Egeria command to set all of the properties.
1885
+
1886
+ ## Glossary
1887
+
1888
+ Egeria-Markdown
1889
+
1890
+ ## Folders
1891
+
1892
+ Writing Dr.Egeria Markdown
1893
+
1894
+ ## Usage
1895
+
1896
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1897
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1898
+ | Display Name | True | True | False | None | Name of the digital product | False | |
1899
+ | Description | False | True | False | None | Description of the contents of a product. | False | |
1900
+ | Classifications | False | True | False | None | Optionally specify the initial classifications for a collection. Multiple classifications can be specified. | False | |
1901
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
1902
+ | Version Identifier | False | True | False | None | Published product version identifier. | False | |
1903
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
1904
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
1905
+
1906
+
1907
+ ___
1908
+
1909
+ # Create Term
1910
+ ## Term Name
1911
+
1912
+ Create Digital Product
1913
+
1914
+ ## Description
1915
+
1916
+ A Data Dictionary is an organized and curated collection of data definitions that can serve as a reference for data professionals
1917
+
1918
+ ## Glossary
1919
+
1920
+ Egeria-Markdown
1921
+
1922
+ ## Folders
1923
+
1924
+ Writing Dr.Egeria Markdown
1925
+
1926
+ ## Usage
1927
+
1928
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1929
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1930
+ | Display Name | True | True | False | None | Name of the digital product | False | |
1931
+ | Description | False | True | False | None | Description of the contents of a product. | False | |
1932
+ | Product Name | False | True | False | None | The external name of the digital product. | False | |
1933
+ | Status | False | True | False | None | The status of the digital product. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; APPROVED_CONCEPT; UNDER_DEVELOPMENT; DEVELOPMENT_COMPLETE; APPROVED_FOR_DEPLOYMENT; ACTIVE; DISABLED; DEPRECATED; OTHER |
1934
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
1935
+ | Category | False | True | False | None | Type of product - periodic, delta, snapshot, etc. May also be user specified. | False | |
1936
+ | Identifier | False | True | False | None | User specified product identifier. | False | |
1937
+ | Maturity | False | True | False | None | Product maturity - user defined. | False | |
1938
+ | Service Life | False | True | False | None | Estimated service lifetime of the product. | False | |
1939
+ | Introduction Date | False | True | False | None | Date of product introduction in ISO 8601 format. Either all of the dates (introduction, next version, withdrawal) dates need to be supplied or none of them. Otherwise an error will occur. | False | |
1940
+ | Next Version Date | False | True | False | None | Date of the next version, in ISO 8601 format. Either all of the dates (introduction, next version, withdrawal) dates need to be supplied or none of them. Otherwise an error will occur. | False | |
1941
+ | Withdrawal Date | False | True | False | None | Date of planned product withdrawal in ISO 8601 format. Either all of the dates (introduction, next version, withdrawal) dates need to be supplied or none of them. Otherwise an error will occur. | False | |
1942
+ | Version Identifier | False | True | False | None | Published product version identifier. | False | |
1943
+ | Product Manager | False | True | False | None | Actors responsible for managing this product. Actors may be individuals, automations, etc. | False | |
1944
+ | Agreements | False | True | False | None | A list of agreements associated with this product. The agreements must already exist. | False | |
1945
+ | Digital Subscriptions | False | True | False | None | | False | |
1946
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
1947
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
1948
+
1949
+
1950
+ ___
1951
+
1952
+ # Create Term
1953
+ ## Term Name
1954
+
1955
+ Link Product-Product
1956
+
1957
+ ## Description
1958
+
1959
+ Link digital product dependency between two digital products.
1960
+
1961
+ ## Glossary
1962
+
1963
+ Egeria-Markdown
1964
+
1965
+ ## Folders
1966
+
1967
+ Writing Dr.Egeria Markdown
1968
+
1969
+ ## Usage
1970
+
1971
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1972
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1973
+ | Digital Product 1 | True | True | False | None | The first product to link. | False | |
1974
+ | Digital Product 2 | True | True | False | None | The second product to link. | False | |
1975
+ | Label | False | True | False | None | Labels the link between two digital products. | False | |
1976
+ | Description | False | True | False | None | A description of the link. | False | |
1977
+
1978
+
1979
+ ___
1980
+
1981
+ # Create Term
1982
+ ## Term Name
1983
+
1984
+ Create Agreement
1985
+
1986
+ ## Description
1987
+
1988
+ A kind of collection that represents an Agreement. This is for generic agreements. Specific kinds of agreements have their own commands.
1989
+
1990
+ ## Glossary
1991
+
1992
+ Egeria-Markdown
1993
+
1994
+ ## Folders
1995
+
1996
+ Writing Dr.Egeria Markdown
1997
+
1998
+ ## Usage
1999
+
2000
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2001
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2002
+ | Display Name | True | True | False | None | Name of the agreement. | False | |
2003
+ | Description | False | True | False | None | Description of the contents of the agreement. | False | |
2004
+ | Identifier | False | True | False | None | A user specified agreement identifier. | False | |
2005
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define agreement types. | False | |
2006
+ | Status | False | True | False | None | The status of the agreement. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
2007
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
2008
+ | Version Identifier | False | True | False | None | Published agreement version identifier. | False | |
2009
+ | Agreement Actors | False | True | False | None | A list of actors with responsibilities for the agreement. | False | |
2010
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2011
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2012
+
2013
+
2014
+ ___
2015
+
2016
+ # Create Term
2017
+ ## Term Name
2018
+
2019
+ Create Data Sharing Agreement
2020
+
2021
+ ## Description
2022
+
2023
+ Create a new collection with the DataSharingAgreement classification.
2024
+
2025
+ ## Glossary
2026
+
2027
+ Egeria-Markdown
2028
+
2029
+ ## Folders
2030
+
2031
+ Writing Dr.Egeria Markdown
2032
+
2033
+ ## Usage
2034
+
2035
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2036
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2037
+ | Display Name | True | True | False | None | Name of the agreement. | False | |
2038
+ | Description | False | True | False | None | Description of the contents of the agreement. | False | |
2039
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2040
+ | Identifier | False | True | False | None | A user specified agreement identifier. | False | |
2041
+ | Status | False | True | False | None | The status of the data sharing. agreement There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
2042
+ | User_Defined_Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
2043
+ | Version Identifier | False | True | False | None | Published agreement version identifier. | False | |
2044
+ | Product Manager | False | True | False | None | An actor responsible for managing this product. Actors may be individuals, automations, etc. | False | |
2045
+ | Digital Subscriptions | False | True | False | None | | False | |
2046
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2047
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2048
+
2049
+
2050
+ ___
2051
+
2052
+ # Create Term
2053
+ ## Term Name
2054
+
2055
+ Create Digital Subscription
2056
+
2057
+ ## Description
2058
+
2059
+ A type of agreement for a digital subscription.
2060
+
2061
+ ## Glossary
2062
+
2063
+ Egeria-Markdown
2064
+
2065
+ ## Folders
2066
+
2067
+ Writing Dr.Egeria Markdown
2068
+
2069
+ ## Usage
2070
+
2071
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2072
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2073
+ | Display Name | True | True | False | None | Name of the agreement. | False | |
2074
+ | Description | False | True | False | None | Description of the contents of the agreement. | False | |
2075
+ | Identifier | False | True | False | None | A user specified agreement identifier. | False | |
2076
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define subscription types. | False | |
2077
+ | Status | False | True | False | None | The status of the digital subscription. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE; DEPRECATED; OTHER |
2078
+ | User_Defined_Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
2079
+ | Support Level | False | True | False | None | Level of support agreed or requested. | False | |
2080
+ | Service Levels | False | True | False | None | A dictionary of name:value pairs describing the service levels. | False | |
2081
+ | Version Identifier | False | True | False | None | Published agreement version identifier. | False | |
2082
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2083
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2084
+
2085
+
2086
+ ___
2087
+
2088
+ # Create Term
2089
+ ## Term Name
2090
+
2091
+ Link Agreement->Item
2092
+
2093
+ ## Description
2094
+
2095
+ Attach or detach an agreement to an element referenced in its definition. Agreement item can be any referencable element.
2096
+
2097
+ ## Glossary
2098
+
2099
+ Egeria-Markdown
2100
+
2101
+ ## Folders
2102
+
2103
+ Writing Dr.Egeria Markdown
2104
+
2105
+ ## Usage
2106
+
2107
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2108
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2109
+ | Agreement Name | True | True | False | None | The name of the agreement to add an item to. Using qualified names is recommended. | False | |
2110
+ | Item Name | True | True | False | None | The name of the referenceable item to add to an agreement Using qualified names is recommended. | False | |
2111
+ | Agreement Item Id | False | True | False | None | A user specified agreement item identifier. | False | |
2112
+ | Agreement Start | False | True | False | None | The start date of the agreement as an ISO 8601 string. | False | |
2113
+ | Agreement End | False | True | False | None | The end date of the agreement as an ISO 8601 string. | False | |
2114
+ | Restrictions | False | True | False | None | A dictionary of property:value pairs describing restrictions. | False | |
2115
+ | Obligations | False | True | False | None | A dictionary of property:value pairs describing obligations. | False | |
2116
+ | Entitlements | False | True | False | None | A dictionary of property:value pairs describing entitlements. | False | |
2117
+ | Usage Measurements | False | True | False | None | A dictionary of property:value pairs describing usage measurements. | False | |
2118
+
2119
+
2120
+ ___
2121
+
2122
+ # Create Term
2123
+ ## Term Name
2124
+
2125
+ Link Contracts
2126
+
2127
+ ## Description
2128
+
2129
+ Attach or detach an agreement to an element describing the location of the contract documents.
2130
+
2131
+ ## Glossary
2132
+
2133
+ Egeria-Markdown
2134
+
2135
+ ## Folders
2136
+
2137
+ Writing Dr.Egeria Markdown
2138
+
2139
+ ## Usage
2140
+
2141
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2142
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2143
+ | Contract Id | False | True | False | None | Contract identifier. | False | |
2144
+ | Contract Liaison | False | True | False | None | Name of the liaison for the contract. | False | |
2145
+ | Contract Liaison Type | False | True | False | None | type of liaison. | False | |
2146
+ | Contract Liaison Property Name | False | True | False | None | | False | |
2147
+
2148
+
2149
+ ___
2150
+
2151
+ # Create Term
2152
+ ## Term Name
2153
+
2154
+ Link Subscriber->Subscription
2155
+
2156
+ ## Description
2157
+
2158
+ Attach or detach a subscriber to a subscription. Subscriber can be any type of element.
2159
+
2160
+ ## Glossary
2161
+
2162
+ Egeria-Markdown
2163
+
2164
+ ## Folders
2165
+
2166
+ Writing Dr.Egeria Markdown
2167
+
2168
+ ## Usage
2169
+
2170
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2171
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2172
+ | Subscriber Id | False | True | False | None | identifier of a subscriber. Initially, will let this be an arbitrary string - could harden this to a qualified name later if needed. | False | |
2173
+ | Subscription | True | True | False | None | Name of the subscription agreement. Recommend using qualified name. | False | |
2174
+
2175
+
2176
+ ___
2177
+
2178
+ # Create Term
2179
+ ## Term Name
2180
+
2181
+ Link Collection->Resource
2182
+
2183
+ ## Description
2184
+
2185
+ Connect an existing collection to an element using the ResourceList relationship.
2186
+
2187
+ ## Glossary
2188
+
2189
+ Egeria-Markdown
2190
+
2191
+ ## Folders
2192
+
2193
+ Writing Dr.Egeria Markdown
2194
+
2195
+ ## Usage
2196
+
2197
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2198
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2199
+ | Collection Id | True | True | False | None | An element of base type collection (e.g. collection, agreement; subscription, ...) | False | |
2200
+ | Resource Id | True | True | False | None | The name of the resource to attach to. | False | |
2201
+ | Resource Use | False | True | False | None | Describes the relationship between the resource and the collection. | False | |
2202
+ | Resource Description | False | True | False | None | A description of the resource being attached. | False | |
2203
+ | Resource Properties | False | True | False | None | A dictionary of name:value pairs describing properties of the resource use. | False | |
2204
+
2205
+
2206
+ ___
2207
+
2208
+ # Create Term
2209
+ ## Term Name
2210
+
2211
+ Link Member->Collection
2212
+
2213
+ ## Description
2214
+
2215
+ Add/Remove a member to/from a collection.
2216
+
2217
+ ## Glossary
2218
+
2219
+ Egeria-Markdown
2220
+
2221
+ ## Folders
2222
+
2223
+ Writing Dr.Egeria Markdown
2224
+
2225
+ ## Usage
2226
+
2227
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2228
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2229
+ | Element Id | True | True | False | None | The name of the element to add to the collection. | False | |
2230
+ | Collection Id | True | True | False | None | The name of the collection to link to. There are many collection types, including Digital Products, Agreements and Subscriptions. | False | |
2231
+ | Membership Rationale | False | True | False | None | Rationale for membership. | False | |
2232
+ | Membership Status | False | True | False | None | The status of adding a member to a collection. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
2233
+
2234
+
2235
+ ___
2236
+
2237
+ # Create Term
2238
+ ## Term Name
2239
+
2240
+ View Collections
2241
+
2242
+ ## Description
2243
+
2244
+ List collections based on search string.
2245
+
2246
+ ## Glossary
2247
+
2248
+ Egeria-Markdown
2249
+
2250
+ ## Folders
2251
+
2252
+ Writing Dr.Egeria Markdown
2253
+
2254
+ ## Usage
2255
+
2256
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2257
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2258
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
2259
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; DICT; MD; MERMAID; HTML |
2260
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
2261
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
2262
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
2263
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
2264
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
2265
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
2266
+
2267
+
2268
+ ___
2269
+
2270
+ # Create Term
2271
+ ## Term Name
2272
+
2273
+ Create Data Dictionary
2274
+
2275
+ ## Description
2276
+
2277
+ A Data Dictionary is an organized and curated collection of data definitions that can serve as a reference for data professionals
2278
+
2279
+ ## Glossary
2280
+
2281
+ Egeria-Markdown
2282
+
2283
+ ## Folders
2284
+
2285
+ Writing Dr.Egeria Markdown
2286
+
2287
+ ## Usage
2288
+
2289
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2290
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2291
+ | Display Name | True | True | False | None | Name of the Data Dictionary | False | |
2292
+ | Description | False | True | False | None | A description of the Data Dictionary. | False | |
2293
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2294
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2295
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2296
+
2297
+
2298
+ ___
2299
+
2300
+ # Create Term
2301
+ ## Term Name
2302
+
2303
+ Create Data Spec
2304
+
2305
+ ## Description
2306
+
2307
+ A Data Specification defines the data requirements for a project or initiative. This includes the data structures , data fields and data classes.
2308
+
2309
+ ## Glossary
2310
+
2311
+ Egeria-Markdown
2312
+
2313
+ ## Folders
2314
+
2315
+ Writing Dr.Egeria Markdown
2316
+
2317
+ ## Usage
2318
+
2319
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2320
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2321
+ | Display Name | True | True | False | None | Name of the Data Specification. | False | |
2322
+ | Description | False | True | False | None | A description of the Data Specification. | False | |
2323
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2324
+ | Qualified Name | True | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2325
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2326
+
2327
+
2328
+ ___
2329
+
2330
+ # Create Term
2331
+ ## Term Name
2332
+
2333
+ Create Data Structure
2334
+
2335
+ ## Description
2336
+
2337
+ A collection of data fields that for a data specification for a data source.
2338
+
2339
+ ## Glossary
2340
+
2341
+ Egeria-Markdown
2342
+
2343
+ ## Folders
2344
+
2345
+ Writing Dr.Egeria Markdown
2346
+
2347
+ ## Usage
2348
+
2349
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2350
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2351
+ | Display Name | True | True | False | None | Name of the data structure. | False | |
2352
+ | Description | False | True | False | None | A description of the data structure. | False | |
2353
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2354
+ | Status | False | True | False | None | The status of the data structure. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE; DEPRECATED; OTHER |
2355
+ | In Data Specification | False | True | False | None | The data specifications this structure is a member of. | False | |
2356
+ | In Data Dictionary | False | True | False | None | What data dictionaries is this data structure in? | False | |
2357
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2358
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2359
+
2360
+
2361
+ ___
2362
+
2363
+ # Create Term
2364
+ ## Term Name
2365
+
2366
+ Create Data Field
2367
+
2368
+ ## Description
2369
+
2370
+ A data field is a fundamental building block for a data structure.
2371
+
2372
+ ## Glossary
2373
+
2374
+ Egeria-Markdown
2375
+
2376
+ ## Folders
2377
+
2378
+ Writing Dr.Egeria Markdown
2379
+
2380
+ ## Usage
2381
+
2382
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2383
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2384
+ | Display Name | True | True | False | None | Name of the Data Field | False | |
2385
+ | Description | False | True | False | None | A description of the Data Field | False | |
2386
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2387
+ | Status | False | True | False | None | The status of the data field. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE; DEPRECATED; OTHER |
2388
+ | 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 |
2389
+ | Position | False | True | False | None | Position of the data field in the data structure. If 0, position is irrelevant. | False | |
2390
+ | Minimum Cardinality | False | True | False | None | The minimum cardinality for a data element. | False | |
2391
+ | Maximum Cardinality | False | True | False | None | The maximum cardinality for a data element. | False | |
2392
+ | 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 | |
2393
+ | Data Class | False | True | False | None | The data class that values of this data field conform to. | False | |
2394
+ | Glossary Term | False | True | False | None | Term that provides meaning to this field. | False | |
2395
+ | isNullable | False | True | False | None | Can the values within the dataclass be absent? | False | |
2396
+ | Minimum Length | False | True | False | None | | False | |
2397
+ | Length | False | True | False | None | The length of a value for a field. | False | |
2398
+ | Precision | False | True | False | None | The precision of a numeric | False | |
2399
+ | Ordered Values | False | True | False | None | is this field in an ordered list? | False | |
2400
+ | Units | False | True | False | None | An optional string indicating the units of the field. | False | |
2401
+ | Default Value | False | True | False | None | Specify a default value for the data class. | False | |
2402
+ | Version Identifier | False | True | False | None | A user supplied version identifier. | False | |
2403
+ | In Data Dictionary | False | True | False | None | What data dictionaries is this data field in? | False | |
2404
+ | Parent Data Field | False | True | False | None | Optional parent field if this is a nested field. | False | |
2405
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2406
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2407
+
2408
+
2409
+ ___
2410
+
2411
+ # Create Term
2412
+ ## Term Name
2413
+
2414
+ Create Data Class
2415
+
2416
+ ## Description
2417
+
2418
+ Describes the data values that may be stored in data fields. Can be used to configure quality validators and data field classifiers.
2419
+
2420
+ ## Glossary
2421
+
2422
+ Egeria-Markdown
2423
+
2424
+ ## Folders
2425
+
2426
+ Writing Dr.Egeria Markdown
2427
+
2428
+ ## Usage
2429
+
2430
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2431
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2432
+ | Display Name | True | True | False | None | Name of the data structure. | False | |
2433
+ | Description | False | True | False | None | A description of the data class. | False | |
2434
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2435
+ | Status | False | True | False | None | The status of the data class. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE; DEPRECATED; OTHER |
2436
+ | Namespace | False | True | False | None | Optional namespace that scopes the field. | False | |
2437
+ | Match Property Names | False | True | True | None | Names of the properties that are set. | False | |
2438
+ | Match Threshold | False | True | False | None | Percent of values that must match the data class specification. | False | |
2439
+ | IsCaseSensitive | False | True | False | None | Are field values case sensitive? | False | |
2440
+ | 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 |
2441
+ | Allow Duplicate Values | False | True | False | None | Allow duplicate values within the data class? | False | |
2442
+ | isNullable | False | True | False | None | Can the values within the dataclass be absent? | False | |
2443
+ | isCaseSensitive | False | True | False | None | Indicates if the values in a data class are case sensitive. | False | |
2444
+ | Default Value | False | True | False | None | Specify a default value for the data class. | False | |
2445
+ | Average Value | False | True | False | None | Average value for the data class. | False | |
2446
+ | Value List | False | True | False | None | | False | |
2447
+ | Value Range From | False | True | False | None | Beginning range of legal values. | False | |
2448
+ | Value Range To | False | True | False | None | End of valid range for value. | False | |
2449
+ | Sample Values | False | True | False | None | Sample values of the data class. | False | |
2450
+ | Data Patterns | False | True | False | None | prescribed format of a data field - e.g. credit card numbers. Often expressed as a regular expression. | False | |
2451
+ | In Data Dictionary | False | True | False | None | What data dictionaries is this data field in? | False | |
2452
+ | Containing Data Class | False | True | False | None | Data classes this is part of. | False | |
2453
+ | Specializes Data Class | False | True | False | None | Specializes a parent data class. | False | |
2454
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2455
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2456
+
2457
+
2458
+ ___
2459
+
2460
+ # Create Term
2461
+ ## Term Name
2462
+
2463
+ View Data Fields
2464
+
2465
+ ## Description
2466
+
2467
+ Return the data fields, optionally filtered by the search string.
2468
+
2469
+ ## Glossary
2470
+
2471
+ Egeria-Markdown
2472
+
2473
+ ## Folders
2474
+
2475
+ Writing Dr.Egeria Markdown
2476
+
2477
+ ## Usage
2478
+
2479
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2480
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2481
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
2482
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; MERMAID; DICT |
2483
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
2484
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2485
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
2486
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
2487
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
2488
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
2489
+ | 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 |
2490
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
2491
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
2492
+
2493
+
2494
+ ___
2495
+
2496
+ # Create Term
2497
+ ## Term Name
2498
+
2499
+ View Data Classes
2500
+
2501
+ ## Description
2502
+
2503
+ Return the data classes, optionally filtered by the search string.
2504
+
2505
+ ## Glossary
2506
+
2507
+ Egeria-Markdown
2508
+
2509
+ ## Folders
2510
+
2511
+ Writing Dr.Egeria Markdown
2512
+
2513
+ ## Usage
2514
+
2515
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2516
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2517
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
2518
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; MERMAID; DICT |
2519
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
2520
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2521
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
2522
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
2523
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
2524
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
2525
+ | 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 |
2526
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
2527
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
2528
+
2529
+
2530
+ ___
2531
+
2532
+ # Create Term
2533
+ ## Term Name
2534
+
2535
+ View Data Structures
2536
+
2537
+ ## Description
2538
+
2539
+ Return the data structures, optionally filtered by the search string.
2540
+
2541
+ ## Glossary
2542
+
2543
+ Egeria-Markdown
2544
+
2545
+ ## Folders
2546
+
2547
+ Writing Dr.Egeria Markdown
2548
+
2549
+ ## Usage
2550
+
2551
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2552
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2553
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
2554
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST;FORM;REPORT;DICT; MERMAID |
2555
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
2556
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2557
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
2558
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
2559
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
2560
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
2561
+ | 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 |
2562
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
2563
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
2564
+
2565
+
2566
+ ___
2567
+
2568
+ # Create Term
2569
+ ## Term Name
2570
+
2571
+ View Data Specifications
2572
+
2573
+ ## Description
2574
+
2575
+ Return the data specifications, optionally filtered by the search string.
2576
+
2577
+ ## Glossary
2578
+
2579
+ Egeria-Markdown
2580
+
2581
+ ## Folders
2582
+
2583
+ Writing Dr.Egeria Markdown
2584
+
2585
+ ## Usage
2586
+
2587
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2588
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2589
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
2590
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; DICT; MD; MERMAID; REPORT |
2591
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
2592
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2593
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
2594
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
2595
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
2596
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
2597
+ | 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 |
2598
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
2599
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
2600
+
2601
+
2602
+ ___
2603
+
2604
+ # Create Term
2605
+ ## Term Name
2606
+
2607
+ View Data Dictionaries
2608
+
2609
+ ## Description
2610
+
2611
+ Return the data dictionaries, optionally filtered by the search string.
2612
+
2613
+ ## Glossary
2614
+
2615
+ Egeria-Markdown
2616
+
2617
+ ## Folders
2618
+
2619
+ Writing Dr.Egeria Markdown
2620
+
2621
+ ## Usage
2622
+
2623
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2624
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2625
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
2626
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; DICT; MD; MERMAID; REPORT |
2627
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
2628
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2629
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
2630
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
2631
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
2632
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
2633
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
2634
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
2635
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
2636
+ | 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 |
2637
+
2638
+
2639
+ ___
2640
+
2641
+ # Create Term
2642
+ ## Term Name
2643
+
2644
+ Create Information Supply Chain
2645
+
2646
+ ## Description
2647
+
2648
+ The flow of a particular type of data across a digital landscape.
2649
+
2650
+ ## Glossary
2651
+
2652
+ Egeria-Markdown
2653
+
2654
+ ## Folders
2655
+
2656
+ Writing Dr.Egeria Markdown
2657
+
2658
+ ## Usage
2659
+
2660
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2661
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2662
+ | Display Name | True | True | False | None | Name of the Information Supply Chain | False | |
2663
+ | Description | False | True | False | None | A description of the data structure. | False | |
2664
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2665
+ | Scope | False | True | False | None | Scope of the supply chain. | False | |
2666
+ | Purposes | False | True | False | None | A list of purposes. | False | |
2667
+ | Nested Information Supply Chains | False | True | False | None | A list of supply chains that compose this supply chain. | False | |
2668
+ | In Information Supply Chain | False | True | False | None | Supply chains that this supply chain is in. | False | |
2669
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2670
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2671
+ | 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 | |
2672
+
2673
+
2674
+ ___
2675
+
2676
+ # Create Term
2677
+ ## Term Name
2678
+
2679
+ Create Solution Blueprint
2680
+
2681
+ ## Description
2682
+
2683
+ A solution blueprint describes the architecture of a digital service in terms of solution components.
2684
+
2685
+ ## Glossary
2686
+
2687
+ Egeria-Markdown
2688
+
2689
+ ## Folders
2690
+
2691
+ Writing Dr.Egeria Markdown
2692
+
2693
+ ## Usage
2694
+
2695
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2696
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2697
+ | Display Name | True | True | False | None | Name of the Information Supply Chain | False | |
2698
+ | Description | False | True | False | None | A description of the data structure. | False | |
2699
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2700
+ | Status | False | True | False | None | The status of the solution blueprint. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE; DEPRECATED; OTHER |
2701
+ | Version Identifier | False | True | False | None | A user supplied version identifier. | False | |
2702
+ | Solution Components | False | True | False | None | Solution components that make up the blueprint. | False | |
2703
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2704
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2705
+
2706
+
2707
+ ___
2708
+
2709
+ # Create Term
2710
+ ## Term Name
2711
+
2712
+ Create Solution Component
2713
+
2714
+ ## Description
2715
+
2716
+ A reusable solution component.
2717
+
2718
+ ## Glossary
2719
+
2720
+ Egeria-Markdown
2721
+
2722
+ ## Folders
2723
+
2724
+ Writing Dr.Egeria Markdown
2725
+
2726
+ ## Usage
2727
+
2728
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2729
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2730
+ | Display Name | True | True | False | None | Name of the solution component. | False | |
2731
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2732
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2733
+ | Description | False | True | False | None | A description of the data structure. | False | |
2734
+ | Status | False | True | False | None | The status of the solution component. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE; DEPRECATED; OTHER |
2735
+ | Solution Component Type | False | True | False | None | Type of solution component. | False | |
2736
+ | Planned Deployed Implementation Type | False | True | False | None | The planned implementation type for deployment. | False | |
2737
+ | Initial Status | False | True | False | None | Optional lifecycle status. If not specified, set to ACTIVE. If set to Other then the value in User Defined Status will be used. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE; DISABLED; DEPRECATED; OTHER |
2738
+ | In Solution Components | False | True | False | None | Solution components that include this one. | False | |
2739
+ | In Solution Blueprints | False | True | False | None | Solution Blueprints that contain this component. | False | |
2740
+ | In Information Supply Chains | False | True | False | None | The Information Supply Chains that this component is a member of. | False | |
2741
+ | Actors | False | True | False | None | Actors associated with this component. | False | |
2742
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2743
+ | 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 | |
2744
+
2745
+
2746
+ ___
2747
+
2748
+ # Create Term
2749
+ ## Term Name
2750
+
2751
+ Link Solution Component Peers
2752
+
2753
+ ## Description
2754
+
2755
+ This command can be used to link or unlink wires between components.
2756
+
2757
+ ## Glossary
2758
+
2759
+ Egeria-Markdown
2760
+
2761
+ ## Folders
2762
+
2763
+ Writing Dr.Egeria Markdown
2764
+
2765
+ ## Usage
2766
+
2767
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2768
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2769
+ | Component1 | True | True | False | None | The first component to link. | False | |
2770
+ | Component2 | True | True | False | None | The second component to link. | False | |
2771
+ | Wire Label | False | True | False | None | Labels the link between two components. | False | |
2772
+ | Description | False | True | False | None | A description of the wire. | False | |
2773
+
2774
+
2775
+ ___
2776
+
2777
+ # Create Term
2778
+ ## Term Name
2779
+
2780
+ Create Solution Role
2781
+
2782
+ ## Description
2783
+
2784
+ A collection of data fields that for a data specification for a data source.
2785
+
2786
+ ## Glossary
2787
+
2788
+ Egeria-Markdown
2789
+
2790
+ ## Folders
2791
+
2792
+ Writing Dr.Egeria Markdown
2793
+
2794
+ ## Usage
2795
+
2796
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2797
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2798
+ | Name | True | True | False | None | Name of the role. | False | |
2799
+ | Description | False | True | False | None | A description of the data structure. | False | |
2800
+ | Title | False | True | False | None | Title of the role. | False | |
2801
+ | Scope | False | True | False | None | Scope of the role. | False | |
2802
+ | identifier | False | True | False | None | role identifier | False | |
2803
+ | Domain Identifier | False | True | False | None | Governance domain identifier | False | |
2804
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2805
+ | Role Type | False | True | False | None | Type of the role. Currently must be GovernanceRole. | False | |
2806
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2807
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2808
+
2809
+
2810
+ ___
2811
+
2812
+ # Create Term
2813
+ ## Term Name
2814
+
2815
+ Link Information Supply Chain Peers
2816
+
2817
+ ## Description
2818
+
2819
+ This command can be used to link or unlink information supply chain segments.
2820
+
2821
+ ## Glossary
2822
+
2823
+ Egeria-Markdown
2824
+
2825
+ ## Folders
2826
+
2827
+ Writing Dr.Egeria Markdown
2828
+
2829
+ ## Usage
2830
+
2831
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2832
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2833
+ | Segment1 | True | True | False | None | The first segment to link. | False | |
2834
+ | Segment2 | True | True | False | None | The second segment to link. | False | |
2835
+ | Link Label | False | True | False | None | Labels the link between two information supply chain segments. | False | |
2836
+ | Description | False | True | False | None | A description of the data structure. | False | |
2837
+
2838
+
2839
+ ___
2840
+
2841
+ # Create Term
2842
+ ## Term Name
2843
+
2844
+ View Information Supply Chains
2845
+
2846
+ ## Description
2847
+
2848
+ Return information supply chains filtered by the search string.
2849
+
2850
+ ## Glossary
2851
+
2852
+ Egeria-Markdown
2853
+
2854
+ ## Folders
2855
+
2856
+ Writing Dr.Egeria Markdown
2857
+
2858
+ ## Usage
2859
+
2860
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2861
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2862
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
2863
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; MD; REPORT; MERMAID; LIST; DICT; HTML |
2864
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
2865
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2866
+ | Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
2867
+
2868
+
2869
+ ___
2870
+
2871
+ # Create Term
2872
+ ## Term Name
2873
+
2874
+ View Solution Components
2875
+
2876
+ ## Description
2877
+
2878
+ Return the data structure details, optionally filtered by the search string.
2879
+
2880
+ ## Glossary
2881
+
2882
+ Egeria-Markdown
2883
+
2884
+ ## Folders
2885
+
2886
+ Writing Dr.Egeria Markdown
2887
+
2888
+ ## Usage
2889
+
2890
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2891
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2892
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
2893
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
2894
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
2895
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2896
+ | Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
2897
+
2898
+
2899
+ ___
2900
+
2901
+ # Create Term
2902
+ ## Term Name
2903
+
2904
+ View Solution Blueprints
2905
+
2906
+ ## Description
2907
+
2908
+ Return the data structure details, optionally filtered by the search string.
2909
+
2910
+ ## Glossary
2911
+
2912
+ Egeria-Markdown
2913
+
2914
+ ## Folders
2915
+
2916
+ Writing Dr.Egeria Markdown
2917
+
2918
+ ## Usage
2919
+
2920
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2921
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2922
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
2923
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
2924
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
2925
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2926
+ | Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
2927
+
2928
+
2929
+ ___
2930
+
2931
+ # Create Term
2932
+ ## Term Name
2933
+
2934
+ View Solution Roles
2935
+
2936
+ ## Description
2937
+
2938
+ Return the data structure details, optionally filtered by the search string.
2939
+
2940
+ ## Glossary
2941
+
2942
+ Egeria-Markdown
2943
+
2944
+ ## Folders
2945
+
2946
+ Writing Dr.Egeria Markdown
2947
+
2948
+ ## Usage
2949
+
2950
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2951
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2952
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
2953
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
2954
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
2955
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2956
+ | Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
2957
+
2958
+
2959
+ ___
2960
+
2961
+ # Create Term
2962
+ ## Term Name
2963
+
2964
+ Create Glossary
2965
+
2966
+ ## Description
2967
+
2968
+ A grouping of definitions.
2969
+
2970
+ ## Glossary
2971
+
2972
+ Egeria-Markdown
2973
+
2974
+ ## Folders
2975
+
2976
+ Writing Dr.Egeria Markdown
2977
+
2978
+ ## Usage
2979
+
2980
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2981
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2982
+ | Display Name | True | True | False | None | The name of the glossary to create or update. | False | |
2983
+ | Description | False | True | False | None | A description of the Glossary. | False | |
2984
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2985
+ | Language | False | True | False | None | The language of the glossary. Note that multilingual descriptions are supported. Please see web site for details. | False | |
2986
+ | Usage | False | True | False | None | A description of how the glossary is to be used. | False | |
2987
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2988
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2989
+
2990
+
2991
+ ___
2992
+
2993
+ # Create Term
2994
+ ## Term Name
2995
+
2996
+ Create Glossary Term
2997
+
2998
+ ## Description
2999
+
3000
+
3001
+
3002
+ ## Glossary
3003
+
3004
+ Egeria-Markdown
3005
+
3006
+ ## Folders
3007
+
3008
+ Writing Dr.Egeria Markdown
3009
+
3010
+ ## Usage
3011
+
3012
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3013
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3014
+ | Display Name | True | True | False | None | The name of the term to create or update. | False | |
3015
+ | Glossary | True | True | False | None | Zeroor more existing glossaries that a term is a member of. | False | |
3016
+ | Summary | False | True | False | None | A summary description of the term. | False | |
3017
+ | Description | False | True | False | None | A description of the term. | False | |
3018
+ | Folders | False | True | False | None | Exixting folder collections that you'd like to make the term a member of. | False | |
3019
+ | Abbreviation | False | True | False | None | An abbreviation for the term. | False | |
3020
+ | Example | False | True | False | None | An example of how the term is used. | False | |
3021
+ | Usage | False | True | False | None | A description of how the term is to be used. | False | |
3022
+ | Status | False | True | False | None | The lifecycle status of a term. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE, DEPRECATED; OTHER |
3023
+ | Version Identifier | False | True | False | None | | False | |
3024
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
3025
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
3026
+
3027
+
3028
+ ___
3029
+
3030
+ # Create Term
3031
+ ## Term Name
3032
+
3033
+ Link Term-Term Relationship
3034
+
3035
+ ## Description
3036
+
3037
+ Create a relationship between terms.
3038
+
3039
+ ## Glossary
3040
+
3041
+ Egeria-Markdown
3042
+
3043
+ ## Folders
3044
+
3045
+ Writing Dr.Egeria Markdown
3046
+
3047
+ ## Usage
3048
+
3049
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3050
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3051
+ | Term 1 | True | True | False | None | The name of the first term term to connect. | False | |
3052
+ | Term 2 | True | True | False | None | The name of the second term term to connect. | False | |
3053
+ | 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 |
3054
+ | Description | False | True | False | None | A description of the Relationship. | False | |
3055
+ | Status | False | True | False | None | | False | |
3056
+
3057
+
3058
+ ___
3059
+
3060
+ # Create Term
3061
+ ## Term Name
3062
+
3063
+ View Terms
3064
+
3065
+ ## Description
3066
+
3067
+ List terms based on search string.
3068
+
3069
+ ## Glossary
3070
+
3071
+ Egeria-Markdown
3072
+
3073
+ ## Folders
3074
+
3075
+ Writing Dr.Egeria Markdown
3076
+
3077
+ ## Usage
3078
+
3079
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3080
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3081
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
3082
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; DICT; MD; MERMAID; HTML |
3083
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
3084
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
3085
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
3086
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
3087
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
3088
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
3089
+
3090
+
3091
+ ___
3092
+
3093
+ # Create Term
3094
+ ## Term Name
3095
+
3096
+ View Glossaries
3097
+
3098
+ ## Description
3099
+
3100
+ Return the glossaries, optionally filtered by the search string.
3101
+
3102
+ ## Glossary
3103
+
3104
+ Egeria-Markdown
3105
+
3106
+ ## Folders
3107
+
3108
+ Writing Dr.Egeria Markdown
3109
+
3110
+ ## Usage
3111
+
3112
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3113
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3114
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
3115
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; DICT; MD; MERMAID; HTML |
3116
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
3117
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
3118
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
3119
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
3120
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
3121
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
3122
+
3123
+
3124
+ ___
3125
+
3126
+ # Create Term
3127
+ ## Term Name
3128
+
3129
+ Create Project
3130
+
3131
+ ## Description
3132
+
3133
+ An organized set of work.
3134
+
3135
+ ## Glossary
3136
+
3137
+ Egeria-Markdown
3138
+
3139
+ ## Folders
3140
+
3141
+ Writing Dr.Egeria Markdown
3142
+
3143
+ ## Usage
3144
+
3145
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3146
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3147
+ | Display Name | True | True | False | None | The name of the project to create or update. | False | |
3148
+ | Description | False | True | False | None | A description of the Project. | False | |
3149
+ | Project Type | False | True | False | None | A string classifiying the project. Current;y supported values are Campaign, Task. PersonalProject and StudyProject. | False | |
3150
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
3151
+ | Identifier | False | True | False | None | A user asigned identifier. | False | |
3152
+ | Mission | False | True | False | None | The project mission. | False | |
3153
+ | Purposes | False | True | False | None | A list of project purposes. | False | |
3154
+ | Start Date | False | True | False | None | Project start date as an ISO 8601 string. | False | |
3155
+ | Planned End Date | False | True | False | None | Planned project end date as an ISO 8601 string. | False | |
3156
+ | Priority | False | True | False | None | An integer priority for the project. | False | |
3157
+ | Project Phase | False | True | False | None | A string describing the phase of the project. | False | |
3158
+ | Project Status | False | True | False | None | A string representing the project status. | False | |
3159
+ | Project Health | False | True | False | None | A string representing the health of the project. | False | |
3160
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
3161
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
3162
+
3163
+
3164
+ ___
3165
+
3166
+ # Create Term
3167
+ ## Term Name
3168
+
3169
+ Create Campaign
3170
+
3171
+ ## Description
3172
+
3173
+ An organized set of work.
3174
+
3175
+ ## Glossary
3176
+
3177
+ Egeria-Markdown
3178
+
3179
+ ## Folders
3180
+
3181
+ Writing Dr.Egeria Markdown
3182
+
3183
+ ## Usage
3184
+
3185
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3186
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3187
+ | Display Name | True | True | False | None | The name of the project to create or update. | False | |
3188
+ | Description | False | True | False | None | A description of the Project. | False | |
3189
+ | Project Type | False | True | False | None | A string classifiying the project. Current;y supported values are Campaign, Task. PersonalProject and StudyProject. | False | |
3190
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
3191
+ | Identifier | False | True | False | None | A user asigned identifier. | False | |
3192
+ | Mission | False | True | False | None | The project mission. | False | |
3193
+ | Purposes | False | True | False | None | A list of project purposes. | False | |
3194
+ | Start Date | False | True | False | None | Project start date as an ISO 8601 string. | False | |
3195
+ | Planned End Date | False | True | False | None | Planned project end date as an ISO 8601 string. | False | |
3196
+ | Priority | False | True | False | None | An integer priority for the project. | False | |
3197
+ | Project Phase | False | True | False | None | A string describing the phase of the project. | False | |
3198
+ | Project Status | False | True | False | None | A string representing the project status. | False | |
3199
+ | Project Health | False | True | False | None | A string representing the health of the project. | False | |
3200
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
3201
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
3202
+
3203
+
3204
+ ___
3205
+
3206
+ # Create Term
3207
+ ## Term Name
3208
+
3209
+ Create Task
3210
+
3211
+ ## Description
3212
+
3213
+ A smaller set of work.
3214
+
3215
+ ## Glossary
3216
+
3217
+ Egeria-Markdown
3218
+
3219
+ ## Folders
3220
+
3221
+ Writing Dr.Egeria Markdown
3222
+
3223
+ ## Usage
3224
+
3225
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3226
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3227
+ | Display Name | True | True | False | None | The name of the project to create or update. | False | |
3228
+ | Description | False | True | False | None | A description of the Project. | False | |
3229
+ | Project Type | False | True | False | None | A string classifiying the project. Current;y supported values are Campaign, Task. PersonalProject and StudyProject. | False | |
3230
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
3231
+ | Identifier | False | True | False | None | A user asigned identifier. | False | |
3232
+ | Mission | False | True | False | None | The project mission. | False | |
3233
+ | Purposes | False | True | False | None | A list of project purposes. | False | |
3234
+ | Start Date | False | True | False | None | Project start date as an ISO 8601 string. | False | |
3235
+ | Planned End Date | False | True | False | None | Planned project end date as an ISO 8601 string. | False | |
3236
+ | Priority | False | True | False | None | An integer priority for the project. | False | |
3237
+ | Project Phase | False | True | False | None | A string describing the phase of the project. | False | |
3238
+ | Project Status | False | True | False | None | A string representing the project status. | False | |
3239
+ | Project Health | False | True | False | None | A string representing the health of the project. | False | |
3240
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
3241
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
3242
+
3243
+
3244
+ ___
3245
+
3246
+ # Create Term
3247
+ ## Term Name
3248
+
3249
+ Create Personal Project
3250
+
3251
+ ## Description
3252
+
3253
+ A personal project.
3254
+
3255
+ ## Glossary
3256
+
3257
+ Egeria-Markdown
3258
+
3259
+ ## Folders
3260
+
3261
+ Writing Dr.Egeria Markdown
3262
+
3263
+ ## Usage
3264
+
3265
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3266
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3267
+ | Display Name | True | True | False | None | The name of the project to create or update. | False | |
3268
+ | Description | False | True | False | None | A description of the Project. | False | |
3269
+ | Project Type | False | True | False | None | A string classifiying the project. Current;y supported values are Campaign, Task. PersonalProject and StudyProject. | False | |
3270
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
3271
+ | Identifier | False | True | False | None | A user asigned identifier. | False | |
3272
+ | Mission | False | True | False | None | The project mission. | False | |
3273
+ | Purposes | False | True | False | None | A list of project purposes. | False | |
3274
+ | Start Date | False | True | False | None | Project start date as an ISO 8601 string. | False | |
3275
+ | Planned End Date | False | True | False | None | Planned project end date as an ISO 8601 string. | False | |
3276
+ | Priority | False | True | False | None | An integer priority for the project. | False | |
3277
+ | Project Phase | False | True | False | None | A string describing the phase of the project. | False | |
3278
+ | Project Status | False | True | False | None | A string representing the project status. | False | |
3279
+ | Project Health | False | True | False | None | A string representing the health of the project. | False | |
3280
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
3281
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
3282
+
3283
+
3284
+ ___
3285
+
3286
+ # Create Term
3287
+ ## Term Name
3288
+
3289
+ Create Study Project
3290
+
3291
+ ## Description
3292
+
3293
+ A personal project.
3294
+
3295
+ ## Glossary
3296
+
3297
+ Egeria-Markdown
3298
+
3299
+ ## Folders
3300
+
3301
+ Writing Dr.Egeria Markdown
3302
+
3303
+ ## Usage
3304
+
3305
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3306
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3307
+ | Display Name | True | True | False | None | The name of the project to create or update. | False | |
3308
+ | Description | False | True | False | None | A description of the Project. | False | |
3309
+ | Project Type | False | True | False | None | A string classifiying the project. Current;y supported values are Campaign, Task. PersonalProject and StudyProject. | False | |
3310
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
3311
+ | Identifier | False | True | False | None | A user asigned identifier. | False | |
3312
+ | Mission | False | True | False | None | The project mission. | False | |
3313
+ | Purposes | False | True | False | None | A list of project purposes. | False | |
3314
+ | Start Date | False | True | False | None | Project start date as an ISO 8601 string. | False | |
3315
+ | Planned End Date | False | True | False | None | Planned project end date as an ISO 8601 string. | False | |
3316
+ | Priority | False | True | False | None | An integer priority for the project. | False | |
3317
+ | Project Phase | False | True | False | None | A string describing the phase of the project. | False | |
3318
+ | Project Status | False | True | False | None | A string representing the project status. | False | |
3319
+ | Project Health | False | True | False | None | A string representing the health of the project. | False | |
3320
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
3321
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
3322
+
3323
+
3324
+ ___
3325
+
3326
+ # Create Term
3327
+ ## Term Name
3328
+
3329
+ Link Project Hierarchy
3330
+
3331
+ ## Description
3332
+
3333
+ Links or unlinks a parent project and child project.
3334
+
3335
+ ## Glossary
3336
+
3337
+ Egeria-Markdown
3338
+
3339
+ ## Folders
3340
+
3341
+ Writing Dr.Egeria Markdown
3342
+
3343
+ ## Usage
3344
+
3345
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3346
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3347
+ | Parent Project | True | True | False | None | The id of the parent project | False | |
3348
+ | Child Project | True | True | False | None | The id of the child project | False | |
3349
+ | Description | False | True | False | None | A description of the relationship.. | False | |
3350
+ | Label | False | True | False | None | A user asigned label for this relationship. | False | |
3351
+
3352
+
3353
+ ___
3354
+
3355
+ # Create Term
3356
+ ## Term Name
3357
+
3358
+ Link Project Dependency
3359
+
3360
+ ## Description
3361
+
3362
+ Links or unlinks a project and dependent project.
3363
+
3364
+ ## Glossary
3365
+
3366
+ Egeria-Markdown
3367
+
3368
+ ## Folders
3369
+
3370
+ Writing Dr.Egeria Markdown
3371
+
3372
+ ## Usage
3373
+
3374
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3375
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3376
+ | Parent Project | True | True | False | None | The id of the project being depended on. | False | |
3377
+ | Child Project | True | True | False | None | The id of the dependent project. | False | |
3378
+ | Description | False | True | False | None | A description of the relationship. | False | |
3379
+ | Label | False | True | False | None | A user asigned label for this relationship. | False | |
3380
+
3381
+
3382
+ ___
3383
+
3384
+ # Create Term
3385
+ ## Term Name
3386
+
3387
+ View Projects
3388
+
3389
+ ## Description
3390
+
3391
+ List projects based on search string.
3392
+
3393
+ ## Glossary
3394
+
3395
+ Egeria-Markdown
3396
+
3397
+ ## Folders
3398
+
3399
+ Writing Dr.Egeria Markdown
3400
+
3401
+ ## Usage
3402
+
3403
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3404
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3405
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
3406
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; DICT; MD; MERMAID; HTML |
3407
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
3408
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
3409
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
3410
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
3411
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
3412
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
3413
+
3414
+
3415
+ ___
3416
+
3417
+ # Create Term
3418
+ ## Term Name
3419
+
3420
+ View Report
3421
+
3422
+ ## Description
3423
+
3424
+ This can be used to produce a report using any output format set.
3425
+
3426
+ ## Glossary
3427
+
3428
+ Egeria-Markdown
3429
+
3430
+ ## Folders
3431
+
3432
+ Writing Dr.Egeria Markdown
3433
+
3434
+ ## Usage
3435
+
3436
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3437
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3438
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
3439
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; MERMAID; DICT |
3440
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
3441
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
3442
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
3443
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
3444
+ | Metadata Element Subtype Names | False | True | False | None | Filter results by the list of metadata elements. If none are provided, then no status filtering will be performed. | False | |
3445
+ | Metadata Element Type Name | False | True | False | None | Optionally filter results by the type of metadata element. | False | |
3446
+ | Skip Relationshjps | False | True | False | None | Allow listed relationships to be skipped in the output returned. | False | |
3447
+ | Include Only Relationships | False | True | False | None | Include information only about specified relationships. | False | |
3448
+ | Skip Classified Elements | False | True | False | None | Skip elements with the any of the specified classifications. | False | |
3449
+ | Include Only Classified Elements | False | True | False | None | Include only elements with the specified classifications. | False | |
3450
+ | Governance Zone Filter | False | True | False | None | Include only elements in one of the specified governance zones. | False | |
3451
+ | Graph Query Depth | False | True | False | None | The depth of the hierarchy to return. Default is 5. Specifying 0 returns only the top level attributes. | False | |
3452
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
3453
+ | 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 |
3454
+ | Order Property Name | False | True | False | None | The property to use for sorting if the sort_order_property is PROPERTY_ASCENDING or PROPERTY_DESCENDING | False | |
3455
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
3456
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
3457
+
3458
+
3459
+ ___
3460
+