pyegeria 5.4.4__py3-none-any.whl → 5.4.4.1__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.
- commands/cat/dr_egeria_command_help.py +11 -17
- md_processing/data/commands.json +763 -134
- md_processing/md_processing_utils/debug_log +186 -1
- md_processing/md_processing_utils/debug_log.2025-09-09_11-10-03_528597.zip +0 -0
- md_processing/md_processing_utils/dr-egeria-help-2025-09-10T14:49:49.md +3460 -0
- md_processing/md_processing_utils/dr-egeria-help-2025-09-10T14:57:46.md +472 -0
- md_processing/md_processing_utils/generate_md_cmd_templates.py +4 -4
- pyegeria/_output_formats.py +1 -1
- pyegeria/glossary_manager.py +2 -2
- {pyegeria-5.4.4.dist-info → pyegeria-5.4.4.1.dist-info}/METADATA +1 -1
- {pyegeria-5.4.4.dist-info → pyegeria-5.4.4.1.dist-info}/RECORD +14 -16
- commands/cat/debug_log.2025-09-01_07-02-58_818650.log.zip +0 -0
- commands/cat/debug_log.2025-09-02_07-44-39_567276.log.zip +0 -0
- commands/cat/debug_log.2025-09-03_07-45-21_986388.log.zip +0 -0
- commands/cat/debug_log.2025-09-04_08-21-58_788009.log.zip +0 -0
- commands/cat/debug_log.2025-09-05_09-37-53_062579.log.zip +0 -0
- {pyegeria-5.4.4.dist-info → pyegeria-5.4.4.1.dist-info}/LICENSE +0 -0
- {pyegeria-5.4.4.dist-info → pyegeria-5.4.4.1.dist-info}/WHEEL +0 -0
- {pyegeria-5.4.4.dist-info → pyegeria-5.4.4.1.dist-info}/entry_points.txt +0 -0
@@ -0,0 +1,472 @@
|
|
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
|
+
| **Identity** | True | True | False | None | Distinguishes the entity. | False | |
|
32
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
33
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
34
|
+
| Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
|
35
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
36
|
+
| Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
|
37
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
38
|
+
| Usage | False | True | False | None | How the governance definition will be used. | False | |
|
39
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
40
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
41
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
42
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
43
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
44
|
+
| 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 |
|
45
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
46
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
47
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
48
|
+
|
49
|
+
|
50
|
+
___
|
51
|
+
|
52
|
+
# Create Term
|
53
|
+
## Term Name
|
54
|
+
|
55
|
+
Create Governance Strategy
|
56
|
+
|
57
|
+
## Description
|
58
|
+
|
59
|
+
The strategy used in the development of the governance domains activities. How the governance domain supports the business strategy.
|
60
|
+
|
61
|
+
## Glossary
|
62
|
+
|
63
|
+
Egeria-Markdown
|
64
|
+
|
65
|
+
## Folders
|
66
|
+
|
67
|
+
Writing Dr.Egeria Markdown
|
68
|
+
|
69
|
+
## Usage
|
70
|
+
|
71
|
+
| **Attribute Name** | **Input Required** | **Read Only** | **Generated** | **Default Value** | **Notes** | **Unique Values** | **Valid Values** |
|
72
|
+
|-----------------------|--------------------|---------------|---------------|-------------------|--------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------|
|
73
|
+
| **Display Name** | True | True | False | None | Name of the definition. | False | |
|
74
|
+
| **Identity** | True | True | False | None | Distinguishes the entity. | False | |
|
75
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
76
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
77
|
+
| Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
|
78
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
79
|
+
| Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
|
80
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
81
|
+
| Usage | False | True | False | None | How the governance definition will be used. | False | |
|
82
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
83
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
84
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
85
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
86
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
87
|
+
| 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 |
|
88
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
89
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
90
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
91
|
+
|
92
|
+
|
93
|
+
___
|
94
|
+
|
95
|
+
# Create Term
|
96
|
+
## Term Name
|
97
|
+
|
98
|
+
Create Business Imperative
|
99
|
+
|
100
|
+
## Description
|
101
|
+
|
102
|
+
The BusinessImperative entity defines a business goal that is critical to the success of the organization.
|
103
|
+
|
104
|
+
## Glossary
|
105
|
+
|
106
|
+
Egeria-Markdown
|
107
|
+
|
108
|
+
## Folders
|
109
|
+
|
110
|
+
Writing Dr.Egeria Markdown
|
111
|
+
|
112
|
+
## Usage
|
113
|
+
|
114
|
+
| **Attribute Name** | **Input Required** | **Read Only** | **Generated** | **Default Value** | **Notes** | **Unique Values** | **Valid Values** |
|
115
|
+
|-----------------------|--------------------|---------------|---------------|-------------------|--------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------|
|
116
|
+
| **Display Name** | True | True | False | None | Name of the definition. | False | |
|
117
|
+
| **Identity** | True | True | False | None | Distinguishes the entity. | False | |
|
118
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
119
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
120
|
+
| Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
|
121
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
122
|
+
| Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
|
123
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
124
|
+
| Usage | False | True | False | None | How the governance definition will be used. | False | |
|
125
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
126
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
127
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
128
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
129
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
130
|
+
| 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 |
|
131
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
132
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
133
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
134
|
+
|
135
|
+
|
136
|
+
___
|
137
|
+
|
138
|
+
# Create Term
|
139
|
+
## Term Name
|
140
|
+
|
141
|
+
Create Regulation
|
142
|
+
|
143
|
+
## Description
|
144
|
+
|
145
|
+
Defines a relevant legal regulation that the business operation must comply with. Often regulations are divided into regulation articles.
|
146
|
+
|
147
|
+
## Glossary
|
148
|
+
|
149
|
+
Egeria-Markdown
|
150
|
+
|
151
|
+
## Folders
|
152
|
+
|
153
|
+
Writing Dr.Egeria Markdown
|
154
|
+
|
155
|
+
## Usage
|
156
|
+
|
157
|
+
| **Attribute Name** | **Input Required** | **Read Only** | **Generated** | **Default Value** | **Notes** | **Unique Values** | **Valid Values** |
|
158
|
+
|-----------------------|--------------------|---------------|---------------|-------------------|--------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------|
|
159
|
+
| **Display Name** | True | True | False | None | Name of the definition. | False | |
|
160
|
+
| **Identity** | True | True | False | None | Distinguishes the entity. | False | |
|
161
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
162
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
163
|
+
| Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
|
164
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
165
|
+
| Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
|
166
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
167
|
+
| Usage | False | True | False | None | How the governance definition will be used. | False | |
|
168
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
169
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
170
|
+
| Regulation Source | False | True | False | None | The source of the regulation - often, an authority. | False | |
|
171
|
+
| Regulators | False | True | False | None | A list of regulators. | False | |
|
172
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
173
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
174
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
175
|
+
| 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 |
|
176
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
177
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
178
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
179
|
+
|
180
|
+
|
181
|
+
___
|
182
|
+
|
183
|
+
# Create Term
|
184
|
+
## Term Name
|
185
|
+
|
186
|
+
Create Regulation Article
|
187
|
+
|
188
|
+
## Description
|
189
|
+
|
190
|
+
A RegulationArticle entity is an article in a regulation. Dividing a regulation simplifies planning and execution.
|
191
|
+
|
192
|
+
## Glossary
|
193
|
+
|
194
|
+
Egeria-Markdown
|
195
|
+
|
196
|
+
## Folders
|
197
|
+
|
198
|
+
Writing Dr.Egeria Markdown
|
199
|
+
|
200
|
+
## Usage
|
201
|
+
|
202
|
+
| **Attribute Name** | **Input Required** | **Read Only** | **Generated** | **Default Value** | **Notes** | **Unique Values** | **Valid Values** |
|
203
|
+
|-----------------------|--------------------|---------------|---------------|-------------------|--------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------|
|
204
|
+
| **Display Name** | True | True | False | None | Name of the definition. | False | |
|
205
|
+
| **Identity** | True | True | False | None | Distinguishes the entity. | False | |
|
206
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
207
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
208
|
+
| Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
|
209
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
210
|
+
| Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
|
211
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
212
|
+
| Usage | False | True | False | None | How the governance definition will be used. | False | |
|
213
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
214
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
215
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
216
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
217
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
218
|
+
| 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 |
|
219
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
220
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
221
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
222
|
+
|
223
|
+
|
224
|
+
___
|
225
|
+
|
226
|
+
# Create Term
|
227
|
+
## Term Name
|
228
|
+
|
229
|
+
Create Threat Definition
|
230
|
+
|
231
|
+
## Description
|
232
|
+
|
233
|
+
The Threat entity describes a particular threat to the organization's operations that must either be guarded against or accommodated to reduce its impact.
|
234
|
+
|
235
|
+
## Glossary
|
236
|
+
|
237
|
+
Egeria-Markdown
|
238
|
+
|
239
|
+
## Folders
|
240
|
+
|
241
|
+
Writing Dr.Egeria Markdown
|
242
|
+
|
243
|
+
## Usage
|
244
|
+
|
245
|
+
| **Attribute Name** | **Input Required** | **Read Only** | **Generated** | **Default Value** | **Notes** | **Unique Values** | **Valid Values** |
|
246
|
+
|-----------------------|--------------------|---------------|---------------|-------------------|--------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------------------|
|
247
|
+
| **Display Name** | True | True | False | None | Name of the definition. | False | |
|
248
|
+
| **Identity** | True | True | False | None | Distinguishes the entity. | False | |
|
249
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
250
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
251
|
+
| Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
|
252
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
253
|
+
| Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
|
254
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
255
|
+
| Usage | False | True | False | None | How the governance definition will be used. | False | |
|
256
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
257
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
258
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
259
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
260
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
261
|
+
| 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 |
|
262
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
263
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
264
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
265
|
+
|
266
|
+
|
267
|
+
___
|
268
|
+
|
269
|
+
# Create Term
|
270
|
+
## Term Name
|
271
|
+
|
272
|
+
Create Governance Policy
|
273
|
+
|
274
|
+
## Description
|
275
|
+
|
276
|
+
Policies created in response to governance drivers. There are several types of policies.
|
277
|
+
|
278
|
+
## Glossary
|
279
|
+
|
280
|
+
Egeria-Markdown
|
281
|
+
|
282
|
+
## Folders
|
283
|
+
|
284
|
+
Writing Dr.Egeria Markdown
|
285
|
+
|
286
|
+
## Usage
|
287
|
+
|
288
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
289
|
+
|---------------------|----------------|-----------|-----------|---------------|-------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------------------------|
|
290
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
291
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
292
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
293
|
+
| Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
|
294
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
295
|
+
| Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
|
296
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
297
|
+
| Usage | False | True | False | None | How the governance definition will be used. | False | |
|
298
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
299
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
300
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
301
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
302
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
303
|
+
| 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 |
|
304
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
305
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
306
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
307
|
+
|
308
|
+
|
309
|
+
___
|
310
|
+
|
311
|
+
# Create Term
|
312
|
+
## Term Name
|
313
|
+
|
314
|
+
Create Governance Principle
|
315
|
+
|
316
|
+
## Description
|
317
|
+
|
318
|
+
The GovernancePrinciple entity defines a policy that describes an end state that the organization aims to achieve.
|
319
|
+
|
320
|
+
## Glossary
|
321
|
+
|
322
|
+
Egeria-Markdown
|
323
|
+
|
324
|
+
## Folders
|
325
|
+
|
326
|
+
Writing Dr.Egeria Markdown
|
327
|
+
|
328
|
+
## Usage
|
329
|
+
|
330
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
331
|
+
|---------------------|----------------|-----------|-----------|---------------|-------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------------------------|
|
332
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
333
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
334
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
335
|
+
| Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
|
336
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
337
|
+
| Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
|
338
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
339
|
+
| Usage | False | True | False | None | How the governance definition will be used. | False | |
|
340
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
341
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
342
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
343
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
344
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
345
|
+
| 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 |
|
346
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
347
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
348
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
349
|
+
|
350
|
+
|
351
|
+
___
|
352
|
+
|
353
|
+
# Create Term
|
354
|
+
## Term Name
|
355
|
+
|
356
|
+
Create Governance Obligation
|
357
|
+
|
358
|
+
## Description
|
359
|
+
|
360
|
+
The GovernanceObligation entity defines a policy that describes a requirement that must be met.
|
361
|
+
|
362
|
+
## Glossary
|
363
|
+
|
364
|
+
Egeria-Markdown
|
365
|
+
|
366
|
+
## Folders
|
367
|
+
|
368
|
+
Writing Dr.Egeria Markdown
|
369
|
+
|
370
|
+
## Usage
|
371
|
+
|
372
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
373
|
+
|---------------------|----------------|-----------|-----------|---------------|-------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------------------------|
|
374
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
375
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
376
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
377
|
+
| Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
|
378
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
379
|
+
| Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
|
380
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
381
|
+
| Usage | False | True | False | None | How the governance definition will be used. | False | |
|
382
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
383
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
384
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
385
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
386
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
387
|
+
| 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 |
|
388
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
389
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
390
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
391
|
+
|
392
|
+
|
393
|
+
___
|
394
|
+
|
395
|
+
# Create Term
|
396
|
+
## Term Name
|
397
|
+
|
398
|
+
Create Governance Approach
|
399
|
+
|
400
|
+
## Description
|
401
|
+
|
402
|
+
The GovernanceApproach entity defines a policy that describes a method that should be used for a particular activity.
|
403
|
+
|
404
|
+
## Glossary
|
405
|
+
|
406
|
+
Egeria-Markdown
|
407
|
+
|
408
|
+
## Folders
|
409
|
+
|
410
|
+
Writing Dr.Egeria Markdown
|
411
|
+
|
412
|
+
## Usage
|
413
|
+
|
414
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
415
|
+
|---------------------|----------------|-----------|-----------|---------------|-------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------------------------|
|
416
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
417
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
418
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
419
|
+
| Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
|
420
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
421
|
+
| Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
|
422
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
423
|
+
| Usage | False | True | False | None | How the governance definition will be used. | False | |
|
424
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
425
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
426
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
427
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
428
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
429
|
+
| 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 |
|
430
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
431
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
432
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
433
|
+
|
434
|
+
|
435
|
+
___
|
436
|
+
|
437
|
+
# Create Term
|
438
|
+
## Term Name
|
439
|
+
|
440
|
+
Create Governance Control
|
441
|
+
|
442
|
+
## Description
|
443
|
+
|
444
|
+
A governance control describes how a particular governance policy should be implemented. There are many types of controls.
|
445
|
+
|
446
|
+
## Glossary
|
447
|
+
|
448
|
+
Egeria-Markdown
|
449
|
+
|
450
|
+
## Folders
|
451
|
+
|
452
|
+
Writing Dr.Egeria Markdown
|
453
|
+
|
454
|
+
## Usage
|
455
|
+
|
456
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
457
|
+
|---------------------|----------------|-----------|-----------|---------------|----------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------------------------|
|
458
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
459
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
460
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
461
|
+
| Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
|
462
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
463
|
+
| Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
|
464
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
465
|
+
| Usage | False | True | False | None | How the governance definition will be used. | False | |
|
466
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
467
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
468
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
469
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
470
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
471
|
+
| 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 |
|
472
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status | | |
|
@@ -88,8 +88,8 @@ def main():
|
|
88
88
|
command_output = io.StringIO()
|
89
89
|
|
90
90
|
# Write command header
|
91
|
-
command_output.write(f"#
|
92
|
-
print(f"\n## {command_verb}
|
91
|
+
command_output.write(f"# {command}\n>\t{command_description}\n")
|
92
|
+
print(f"\n## {command_verb} {command}\n>\t{command_description}")
|
93
93
|
|
94
94
|
# Process command attributes
|
95
95
|
attributes = values['Attributes']
|
@@ -99,8 +99,8 @@ def main():
|
|
99
99
|
continue
|
100
100
|
user_specified = value.get('user_specified', 'true') in ["true", "True"]
|
101
101
|
|
102
|
-
command_output.write(f"\n##
|
103
|
-
print(f"\n###
|
102
|
+
command_output.write(f"\n## {key}\n")
|
103
|
+
print(f"\n### {key}")
|
104
104
|
|
105
105
|
command_output.write(f">\t**Input Required**: {value.get('input_required', 'false')}\n\n")
|
106
106
|
print(f">\tInput Required: {value.get('input_required', 'false')}")
|
pyegeria/_output_formats.py
CHANGED
@@ -443,7 +443,7 @@ base_output_format_sets = FormatSetDict({
|
|
443
443
|
formats=[
|
444
444
|
Format(
|
445
445
|
|
446
|
-
types=["DICT", "FORM", "LIST", "TABLE"],
|
446
|
+
types=["DICT", "FORM", "REPORT","LIST", "TABLE"],
|
447
447
|
columns= [
|
448
448
|
Column(name='Term Name', key='display_name'),
|
449
449
|
Column(name='Description', key='description'),
|
pyegeria/glossary_manager.py
CHANGED
@@ -2828,11 +2828,11 @@ class GlossaryManager(CollectionManager):
|
|
2828
2828
|
response = loop.run_until_complete(self._async_get_term_by_guid(term_guid, element_type, body, output_format, output_format_set))
|
2829
2829
|
return response
|
2830
2830
|
|
2831
|
-
async def _async_find_glossary_terms(self, search_string: str, starts_with: bool =
|
2831
|
+
async def _async_find_glossary_terms(self, search_string: str, starts_with: bool = True,
|
2832
2832
|
ends_with: bool = False, ignore_case: bool = False, type_name: str = "GlossaryTerm",
|
2833
2833
|
classification_names: list[str] = None, start_from: int = 0,
|
2834
2834
|
page_size: int = 0, output_format: str = 'JSON',
|
2835
|
-
output_format_set: str | dict =
|
2835
|
+
output_format_set: str | dict = "Glossary-Term-DrE", body: dict = None) -> list | str:
|
2836
2836
|
url = (f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/glossary-manager/glossaries/terms/"
|
2837
2837
|
f"by-search-string")
|
2838
2838
|
response = await self._async_find_request(url, _type= type_name,
|