pyegeria 5.3.10__py3-none-any.whl → 5.4.0__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 (163) hide show
  1. commands/cat/debug_log +2806 -0
  2. commands/cat/debug_log.2025-07-15_14-28-38_087378.zip +0 -0
  3. commands/cat/debug_log.2025-07-16_15-48-50_037087.zip +0 -0
  4. commands/cat/dr_egeria_command_help.py +273 -0
  5. commands/cat/dr_egeria_md.py +90 -20
  6. commands/cat/glossary_actions.py +2 -2
  7. commands/cat/list_collections.py +24 -10
  8. commands/cat/list_data_designer.py +183 -0
  9. md_processing/__init__.py +28 -5
  10. md_processing/data/commands.json +31474 -1096
  11. md_processing/dr_egeria_outbox-pycharm/.obsidian/app.json +1 -0
  12. md_processing/dr_egeria_outbox-pycharm/.obsidian/appearance.json +1 -0
  13. md_processing/dr_egeria_outbox-pycharm/.obsidian/core-plugins.json +31 -0
  14. md_processing/dr_egeria_outbox-pycharm/.obsidian/workspace.json +177 -0
  15. md_processing/dr_egeria_outbox-pycharm/monday/processed-2025-07-14 12:38-data_designer_out.md +663 -0
  16. md_processing/dr_egeria_outbox-pycharm/thursday/processed-2025-07-17 15:00-Derive-Dr-Gov-Defs.md +719 -0
  17. md_processing/dr_egeria_outbox-pycharm/thursday/processed-2025-07-17 20:13-Derive-Dr-Gov-Defs.md +41 -0
  18. md_processing/dr_egeria_outbox-pycharm/thursday/processed-2025-07-17 20:14-Derive-Dr-Gov-Defs.md +33 -0
  19. md_processing/dr_egeria_outbox-pycharm/thursday/processed-2025-07-17 20:50-Derive-Dr-Gov-Defs.md +192 -0
  20. md_processing/dr_egeria_outbox-pycharm/tuesday/processed-2025-07-16 19:15-gov_def2.md +527 -0
  21. md_processing/dr_egeria_outbox-pycharm/tuesday/processed-2025-07-17 12:08-gov_def2.md +527 -0
  22. md_processing/dr_egeria_outbox-pycharm/tuesday/processed-2025-07-17 14:27-gov_def2.md +474 -0
  23. md_processing/family_docs/Data Designer/Create_Data_Class.md +164 -0
  24. md_processing/family_docs/Data Designer/Create_Data_Dictionary.md +30 -0
  25. md_processing/family_docs/Data Designer/Create_Data_Field.md +162 -0
  26. md_processing/family_docs/Data Designer/Create_Data_Specification.md +36 -0
  27. md_processing/family_docs/Data Designer/Create_Data_Structure.md +38 -0
  28. md_processing/family_docs/Data Designer/View_Data_Classes.md +78 -0
  29. md_processing/family_docs/Data Designer/View_Data_Dictionaries.md +78 -0
  30. md_processing/family_docs/Data Designer/View_Data_Fields.md +78 -0
  31. md_processing/family_docs/Data Designer/View_Data_Specifications.md +78 -0
  32. md_processing/family_docs/Data Designer/View_Data_Structures.md +78 -0
  33. md_processing/family_docs/Data Designer.md +842 -0
  34. md_processing/family_docs/Digital Product Manager/Add_Member->Collection.md +42 -0
  35. md_processing/family_docs/Digital Product Manager/Attach_Collection->Resource.md +36 -0
  36. md_processing/family_docs/Digital Product Manager/Create_Agreement.md +96 -0
  37. md_processing/family_docs/Digital Product Manager/Create_Data_Sharing_Agreement.md +72 -0
  38. md_processing/family_docs/Digital Product Manager/Create_DigitalSubscription.md +102 -0
  39. md_processing/family_docs/Digital Product Manager/Create_Digital_Product.md +134 -0
  40. md_processing/family_docs/Digital Product Manager/Link_Agreement_Items.md +60 -0
  41. md_processing/family_docs/Digital Product Manager/Link_Contracts.md +26 -0
  42. md_processing/family_docs/Digital Product Manager/Link_Digital_Product_-_Digital_Product.md +30 -0
  43. md_processing/family_docs/Digital Product Manager/Link_Subscribers.md +48 -0
  44. md_processing/family_docs/Digital Product Manager.md +668 -0
  45. md_processing/family_docs/Glossary/Attach_Category_Parent.md +18 -0
  46. md_processing/family_docs/Glossary/Attach_Term-Term_Relationship.md +26 -0
  47. md_processing/family_docs/Glossary/Create_Category.md +38 -0
  48. md_processing/family_docs/Glossary/Create_Glossary.md +42 -0
  49. md_processing/family_docs/Glossary/Create_Term.md +70 -0
  50. md_processing/family_docs/Glossary.md +206 -0
  51. md_processing/family_docs/Governance Officer/Create_Business_Imperative.md +106 -0
  52. md_processing/family_docs/Governance Officer/Create_Certification_Type.md +112 -0
  53. md_processing/family_docs/Governance Officer/Create_Governance_Approach.md +114 -0
  54. md_processing/family_docs/Governance Officer/Create_Governance_Obligation.md +114 -0
  55. md_processing/family_docs/Governance Officer/Create_Governance_Principle.md +114 -0
  56. md_processing/family_docs/Governance Officer/Create_Governance_Procedure.md +128 -0
  57. md_processing/family_docs/Governance Officer/Create_Governance_Process.md +122 -0
  58. md_processing/family_docs/Governance Officer/Create_Governance_Processing_Purpose.md +106 -0
  59. md_processing/family_docs/Governance Officer/Create_Governance_Responsibility.md +122 -0
  60. md_processing/family_docs/Governance Officer/Create_Governance_Rule.md +122 -0
  61. md_processing/family_docs/Governance Officer/Create_Governance_Strategy.md +106 -0
  62. md_processing/family_docs/Governance Officer/Create_License_Type.md +112 -0
  63. md_processing/family_docs/Governance Officer/Create_Naming_Standard_Rule.md +122 -0
  64. md_processing/family_docs/Governance Officer/Create_Regulation_Article.md +106 -0
  65. md_processing/family_docs/Governance Officer/Create_Regulation_Definition.md +118 -0
  66. md_processing/family_docs/Governance Officer/Create_Security_Access_Control.md +114 -0
  67. md_processing/family_docs/Governance Officer/Create_Security_Group.md +120 -0
  68. md_processing/family_docs/Governance Officer/Create_Service_Level_Objectives.md +122 -0
  69. md_processing/family_docs/Governance Officer/Create_Threat_Definition.md +106 -0
  70. md_processing/family_docs/Governance Officer/Link_Governance_Controls.md +32 -0
  71. md_processing/family_docs/Governance Officer/Link_Governance_Drivers.md +32 -0
  72. md_processing/family_docs/Governance Officer/Link_Governance_Policies.md +32 -0
  73. md_processing/family_docs/Governance Officer/View_Governance_Definitions.md +82 -0
  74. md_processing/family_docs/Governance Officer.md +2412 -0
  75. md_processing/family_docs/Solution Architect/Create_Information_Supply_Chain.md +70 -0
  76. md_processing/family_docs/Solution Architect/Create_Solution_Blueprint.md +44 -0
  77. md_processing/family_docs/Solution Architect/Create_Solution_Component.md +96 -0
  78. md_processing/family_docs/Solution Architect/Create_Solution_Role.md +66 -0
  79. md_processing/family_docs/Solution Architect/Link_Information_Supply_Chain_Peers.md +32 -0
  80. md_processing/family_docs/Solution Architect/Link_Solution_Component_Peers.md +32 -0
  81. md_processing/family_docs/Solution Architect/View_Information_Supply_Chains.md +32 -0
  82. md_processing/family_docs/Solution Architect/View_Solution_Blueprints.md +32 -0
  83. md_processing/family_docs/Solution Architect/View_Solution_Components.md +32 -0
  84. md_processing/family_docs/Solution Architect/View_Solution_Roles.md +32 -0
  85. md_processing/family_docs/Solution Architect.md +490 -0
  86. md_processing/md_commands/data_designer_commands.py +1192 -710
  87. md_processing/md_commands/glossary_commands.py +19 -32
  88. md_processing/md_commands/governance_officer_commands.py +420 -0
  89. md_processing/md_commands/product_manager_commands.py +1180 -0
  90. md_processing/md_commands/project_commands.py +5 -2
  91. md_processing/md_commands/solution_architect_commands.py +1140 -0
  92. md_processing/md_processing_utils/common_md_proc_utils.py +288 -96
  93. md_processing/md_processing_utils/common_md_utils.py +205 -6
  94. md_processing/md_processing_utils/debug_log +574 -0
  95. md_processing/md_processing_utils/dr-egeria-help-2025-07-17T17:22:09.md +2065 -0
  96. md_processing/md_processing_utils/extraction_utils.py +1 -1
  97. md_processing/md_processing_utils/generate_dr_help.py +165 -0
  98. md_processing/md_processing_utils/generate_md_cmd_templates.py +143 -0
  99. md_processing/md_processing_utils/generate_md_templates.py +92 -0
  100. md_processing/md_processing_utils/generated_help_terms.md +842 -0
  101. md_processing/md_processing_utils/md_processing_constants.py +94 -17
  102. pyegeria/__init__.py +1 -0
  103. pyegeria/_client.py +39 -1
  104. pyegeria/classification_manager_omvs.py +1 -1
  105. pyegeria/collection_manager_omvs.py +4667 -1178
  106. pyegeria/data_designer_omvs.py +348 -31
  107. pyegeria/egeria_tech_client.py +9 -25
  108. pyegeria/glossary_browser_omvs.py +5 -6
  109. pyegeria/glossary_manager_omvs.py +2 -2
  110. pyegeria/governance_officer_omvs.py +2367 -0
  111. pyegeria/output_formatter.py +157 -32
  112. pyegeria/solution_architect_omvs.py +5063 -1110
  113. pyegeria/utils.py +22 -2
  114. {pyegeria-5.3.10.dist-info → pyegeria-5.4.0.dist-info}/METADATA +3 -1
  115. pyegeria-5.4.0.dist-info/RECORD +243 -0
  116. {pyegeria-5.3.10.dist-info → pyegeria-5.4.0.dist-info}/entry_points.txt +5 -0
  117. commands/cat/.DS_Store +0 -0
  118. md_processing/dr_egeria_inbox/archive/dr_egeria_intro.md +0 -254
  119. md_processing/dr_egeria_inbox/archive/dr_egeria_intro_more_terms.md +0 -696
  120. md_processing/dr_egeria_inbox/archive/dr_egeria_intro_part1.md +0 -254
  121. md_processing/dr_egeria_inbox/archive/dr_egeria_intro_part2.md +0 -298
  122. md_processing/dr_egeria_inbox/archive/dr_egeria_intro_part3.md +0 -608
  123. md_processing/dr_egeria_inbox/archive/dr_egeria_intro_part4.md +0 -94
  124. md_processing/dr_egeria_inbox/archive/freddie_intro.md +0 -284
  125. md_processing/dr_egeria_inbox/archive/freddie_intro_orig.md +0 -275
  126. md_processing/dr_egeria_inbox/archive/test-term.md +0 -110
  127. md_processing/dr_egeria_inbox/cat_test.md +0 -100
  128. md_processing/dr_egeria_inbox/data_field.md +0 -54
  129. md_processing/dr_egeria_inbox/data_spec.md +0 -77
  130. md_processing/dr_egeria_inbox/data_spec_test.md +0 -2406
  131. md_processing/dr_egeria_inbox/data_test.md +0 -86
  132. md_processing/dr_egeria_inbox/dr_egeria_intro_categories.md +0 -168
  133. md_processing/dr_egeria_inbox/dr_egeria_intro_part1.md +0 -280
  134. md_processing/dr_egeria_inbox/dr_egeria_intro_part2.md +0 -313
  135. md_processing/dr_egeria_inbox/dr_egeria_intro_part3.md +0 -1073
  136. md_processing/dr_egeria_inbox/dr_egeria_isc1.md +0 -44
  137. md_processing/dr_egeria_inbox/glossary_test1.md +0 -324
  138. md_processing/dr_egeria_inbox/rel.md +0 -8
  139. md_processing/dr_egeria_inbox/sb.md +0 -119
  140. md_processing/dr_egeria_inbox/search_test.md +0 -39
  141. md_processing/dr_egeria_inbox/solution-components.md +0 -154
  142. md_processing/dr_egeria_inbox/solution_blueprints.md +0 -118
  143. md_processing/dr_egeria_inbox/synonym_test.md +0 -42
  144. md_processing/dr_egeria_inbox/t1.md +0 -0
  145. md_processing/dr_egeria_inbox/t2.md +0 -268
  146. md_processing/dr_egeria_outbox/processed-2025-05-15 19:52-data_test.md +0 -94
  147. md_processing/dr_egeria_outbox/processed-2025-05-16 07:39-data_test.md +0 -88
  148. md_processing/dr_egeria_outbox/processed-2025-05-17 16:01-data_field.md +0 -56
  149. md_processing/dr_egeria_outbox/processed-2025-05-18 15:51-data_test.md +0 -103
  150. md_processing/dr_egeria_outbox/processed-2025-05-18 16:47-data_test.md +0 -94
  151. md_processing/dr_egeria_outbox/processed-2025-05-19 07:14-data_test.md +0 -96
  152. md_processing/dr_egeria_outbox/processed-2025-05-19 07:20-data_test.md +0 -100
  153. md_processing/dr_egeria_outbox/processed-2025-05-19 07:22-data_test.md +0 -88
  154. md_processing/dr_egeria_outbox/processed-2025-05-19 09:26-data_test.md +0 -91
  155. md_processing/dr_egeria_outbox/processed-2025-05-19 10:27-data_test.md +0 -91
  156. md_processing/dr_egeria_outbox/processed-2025-05-19 14:04-data_test.md +0 -91
  157. md_processing/md_commands/blueprint_commands.py +0 -303
  158. pyegeria/.DS_Store +0 -0
  159. pyegeria/m_test.py +0 -118
  160. pyegeria-5.3.10.dist-info/RECORD +0 -196
  161. /commands/cat/{list_data_structures.py → list_data_structures_full.py} +0 -0
  162. {pyegeria-5.3.10.dist-info → pyegeria-5.4.0.dist-info}/LICENSE +0 -0
  163. {pyegeria-5.3.10.dist-info → pyegeria-5.4.0.dist-info}/WHEEL +0 -0
@@ -0,0 +1,2412 @@
1
+
2
+ # Family: Governance Officer
3
+
4
+ ## **Create Business Imperative**
5
+ > The BusinessImperative entity defines a business goal that is critical to the success of the organization.
6
+ ### **Display Name**
7
+ > **Input Required**: True
8
+
9
+ > **Description**: Name of the definition.
10
+
11
+ > **Alternative Labels**: Name
12
+
13
+
14
+ ### **Summary**
15
+ > **Input Required**: False
16
+
17
+ > **Description**: Summary of the definition.
18
+
19
+
20
+ ### **Description**
21
+ > **Input Required**: False
22
+
23
+ > **Description**: Description of the contents of the definition.
24
+
25
+
26
+ ### **Domain Identifier**
27
+ > **Input Required**: False
28
+
29
+ > **Description**: Integer representing the governance domain. All domains is 0.
30
+
31
+ > **Default Value**: 0
32
+
33
+
34
+ ### **Document Identifier**
35
+ > **Input Required**: False
36
+
37
+ > **Description**: A user supplied identifier for the governance document.
38
+
39
+ > **Alternative Labels**: Doc Id
40
+
41
+
42
+ ### **Version Identifier**
43
+ > **Input Required**: False
44
+
45
+ > **Description**: Published version identifier.
46
+
47
+
48
+ ### **Scope**
49
+ > **Input Required**: False
50
+
51
+ > **Description**: Scope of the definition.
52
+
53
+
54
+ ### **Importance**
55
+ > **Input Required**: False
56
+
57
+ > **Description**: Importance of the definition.
58
+
59
+
60
+ ### **Implications**
61
+ > **Input Required**: False
62
+
63
+ > **Description**: List of implications.
64
+
65
+
66
+ ### **Outcomes**
67
+ > **Input Required**: False
68
+
69
+ > **Description**: List of desired outcomes.
70
+
71
+
72
+ ### **Results**
73
+ > **Input Required**: False
74
+
75
+ > **Description**: A list of expected results.
76
+
77
+
78
+ ### **Status**
79
+ > **Input Required**: False
80
+
81
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
82
+
83
+ > **Alternative Labels**: Definition Status
84
+
85
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
86
+
87
+ > **Default Value**: DRAFT
88
+
89
+
90
+ ### **User Defined Status**
91
+ > **Input Required**: False
92
+
93
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
94
+
95
+
96
+ ### **Qualified Name**
97
+ > **Input Required**: False
98
+
99
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
100
+
101
+
102
+ ### **GUID**
103
+ > **Input Required**: False
104
+
105
+ > **Description**: A system generated unique identifier.
106
+
107
+ > **Alternative Labels**: Guid; guid
108
+
109
+
110
+ ___
111
+
112
+ ## **Create Certification Type**
113
+ > A type of certification.
114
+ ### **Display Name**
115
+ > **Input Required**: True
116
+
117
+ > **Description**: Name of the definition.
118
+
119
+ > **Alternative Labels**: Name
120
+
121
+
122
+ ### **Summary**
123
+ > **Input Required**: False
124
+
125
+ > **Description**: Summary of the definition.
126
+
127
+
128
+ ### **Description**
129
+ > **Input Required**: False
130
+
131
+ > **Description**: Description of the contents of the definition.
132
+
133
+
134
+ ### **Domain Identifier**
135
+ > **Input Required**: False
136
+
137
+ > **Description**: Integer representing the governance domain. All domains is 0.
138
+
139
+ > **Default Value**: 0
140
+
141
+
142
+ ### **Document Identifier**
143
+ > **Input Required**: False
144
+
145
+ > **Description**: A user supplied identifier for the governance document.
146
+
147
+ > **Alternative Labels**: Doc Id
148
+
149
+
150
+ ### **Version Identifier**
151
+ > **Input Required**: False
152
+
153
+ > **Description**: Published version identifier.
154
+
155
+
156
+ ### **Scope**
157
+ > **Input Required**: False
158
+
159
+ > **Description**: Scope of the definition.
160
+
161
+
162
+ ### **Importance**
163
+ > **Input Required**: False
164
+
165
+ > **Description**: Importance of the definition.
166
+
167
+
168
+ ### **Details**
169
+ > **Input Required**: False
170
+
171
+ > **Description**: Details of the certification.
172
+
173
+
174
+ ### **Implications**
175
+ > **Input Required**: False
176
+
177
+ > **Description**: List of implications.
178
+
179
+
180
+ ### **Outcomes**
181
+ > **Input Required**: False
182
+
183
+ > **Description**: List of desired outcomes.
184
+
185
+
186
+ ### **Results**
187
+ > **Input Required**: False
188
+
189
+ > **Description**: A list of expected results.
190
+
191
+
192
+ ### **Status**
193
+ > **Input Required**: False
194
+
195
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
196
+
197
+ > **Alternative Labels**: Definition Status
198
+
199
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
200
+
201
+ > **Default Value**: DRAFT
202
+
203
+
204
+ ### **User Defined Status**
205
+ > **Input Required**: False
206
+
207
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
208
+
209
+
210
+ ### **Qualified Name**
211
+ > **Input Required**: False
212
+
213
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
214
+
215
+
216
+ ### **GUID**
217
+ > **Input Required**: False
218
+
219
+ > **Description**: A system generated unique identifier.
220
+
221
+ > **Alternative Labels**: Guid; guid
222
+
223
+
224
+ ___
225
+
226
+ ## **Create Governance Approach**
227
+ > The GovernanceApproach entity defines a policy that describes a method that should be used for a particular activity.
228
+ ### **Display Name**
229
+ > **Input Required**: True
230
+
231
+ > **Description**: Name of the definition.
232
+
233
+ > **Alternative Labels**: Name
234
+
235
+
236
+ ### **Summary**
237
+ > **Input Required**: False
238
+
239
+ > **Description**: Summary of the definition.
240
+
241
+
242
+ ### **Description**
243
+ > **Input Required**: False
244
+
245
+ > **Description**: Description of the contents of the definition.
246
+
247
+
248
+ ### **Domain Identifier**
249
+ > **Input Required**: False
250
+
251
+ > **Description**: Integer representing the governance domain. All domains is 0.
252
+
253
+ > **Default Value**: 0
254
+
255
+
256
+ ### **Document Identifier**
257
+ > **Input Required**: False
258
+
259
+ > **Description**: A user supplied identifier for the governance document.
260
+
261
+ > **Alternative Labels**: Doc Id
262
+
263
+
264
+ ### **Version Identifier**
265
+ > **Input Required**: False
266
+
267
+ > **Description**: Published version identifier.
268
+
269
+
270
+ ### **Scope**
271
+ > **Input Required**: False
272
+
273
+ > **Description**: Scope of the definition.
274
+
275
+
276
+ ### **Importance**
277
+ > **Input Required**: False
278
+
279
+ > **Description**: Importance of the definition.
280
+
281
+
282
+ ### **Governance Drivers**
283
+ > **Input Required**: False
284
+
285
+ > **Description**: The drivers this policy is in response to. Drivers may be Business Imperatives, Regulations, Governance Strategy or Threats.
286
+
287
+ > **Alternative Labels**: Drivers
288
+
289
+
290
+ ### **Implications**
291
+ > **Input Required**: False
292
+
293
+ > **Description**: List of implications.
294
+
295
+
296
+ ### **Outcomes**
297
+ > **Input Required**: False
298
+
299
+ > **Description**: List of desired outcomes.
300
+
301
+
302
+ ### **Results**
303
+ > **Input Required**: False
304
+
305
+ > **Description**: A list of expected results.
306
+
307
+
308
+ ### **Status**
309
+ > **Input Required**: False
310
+
311
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
312
+
313
+ > **Alternative Labels**: Definition Status
314
+
315
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
316
+
317
+ > **Default Value**: DRAFT
318
+
319
+
320
+ ### **User Defined Status**
321
+ > **Input Required**: False
322
+
323
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
324
+
325
+
326
+ ### **Qualified Name**
327
+ > **Input Required**: False
328
+
329
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
330
+
331
+
332
+ ### **GUID**
333
+ > **Input Required**: False
334
+
335
+ > **Description**: A system generated unique identifier.
336
+
337
+ > **Alternative Labels**: Guid; guid
338
+
339
+
340
+ ___
341
+
342
+ ## **Create Governance Obligation**
343
+ > The GovernanceObligation entity defines a policy that describes a requirement that must be met.
344
+ ### **Display Name**
345
+ > **Input Required**: True
346
+
347
+ > **Description**: Name of the definition.
348
+
349
+ > **Alternative Labels**: Name
350
+
351
+
352
+ ### **Summary**
353
+ > **Input Required**: False
354
+
355
+ > **Description**: Summary of the definition.
356
+
357
+
358
+ ### **Description**
359
+ > **Input Required**: False
360
+
361
+ > **Description**: Description of the contents of the definition.
362
+
363
+
364
+ ### **Domain Identifier**
365
+ > **Input Required**: False
366
+
367
+ > **Description**: Integer representing the governance domain. All domains is 0.
368
+
369
+ > **Default Value**: 0
370
+
371
+
372
+ ### **Document Identifier**
373
+ > **Input Required**: False
374
+
375
+ > **Description**: A user supplied identifier for the governance document.
376
+
377
+ > **Alternative Labels**: Doc Id
378
+
379
+
380
+ ### **Version Identifier**
381
+ > **Input Required**: False
382
+
383
+ > **Description**: Published version identifier.
384
+
385
+
386
+ ### **Scope**
387
+ > **Input Required**: False
388
+
389
+ > **Description**: Scope of the definition.
390
+
391
+
392
+ ### **Importance**
393
+ > **Input Required**: False
394
+
395
+ > **Description**: Importance of the definition.
396
+
397
+
398
+ ### **Governance Drivers**
399
+ > **Input Required**: False
400
+
401
+ > **Description**: The drivers this policy is in response to. Drivers may be Business Imperatives, Regulations, Governance Strategy or Threats.
402
+
403
+ > **Alternative Labels**: Drivers
404
+
405
+
406
+ ### **Implications**
407
+ > **Input Required**: False
408
+
409
+ > **Description**: List of implications.
410
+
411
+
412
+ ### **Outcomes**
413
+ > **Input Required**: False
414
+
415
+ > **Description**: List of desired outcomes.
416
+
417
+
418
+ ### **Results**
419
+ > **Input Required**: False
420
+
421
+ > **Description**: A list of expected results.
422
+
423
+
424
+ ### **Status**
425
+ > **Input Required**: False
426
+
427
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
428
+
429
+ > **Alternative Labels**: Definition Status
430
+
431
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
432
+
433
+ > **Default Value**: DRAFT
434
+
435
+
436
+ ### **User Defined Status**
437
+ > **Input Required**: False
438
+
439
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
440
+
441
+
442
+ ### **Qualified Name**
443
+ > **Input Required**: False
444
+
445
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
446
+
447
+
448
+ ### **GUID**
449
+ > **Input Required**: False
450
+
451
+ > **Description**: A system generated unique identifier.
452
+
453
+ > **Alternative Labels**: Guid; guid
454
+
455
+
456
+ ___
457
+
458
+ ## **Create Governance Principle**
459
+ > The GovernancePrinciple entity defines a policy that describes an end state that the organization aims to achieve.
460
+ ### **Display Name**
461
+ > **Input Required**: True
462
+
463
+ > **Description**: Name of the definition.
464
+
465
+ > **Alternative Labels**: Name
466
+
467
+
468
+ ### **Summary**
469
+ > **Input Required**: False
470
+
471
+ > **Description**: Summary of the definition.
472
+
473
+
474
+ ### **Description**
475
+ > **Input Required**: False
476
+
477
+ > **Description**: Description of the contents of the definition.
478
+
479
+
480
+ ### **Domain Identifier**
481
+ > **Input Required**: False
482
+
483
+ > **Description**: Integer representing the governance domain. All domains is 0.
484
+
485
+ > **Default Value**: 0
486
+
487
+
488
+ ### **Document Identifier**
489
+ > **Input Required**: False
490
+
491
+ > **Description**: A user supplied identifier for the governance document.
492
+
493
+ > **Alternative Labels**: Doc Id
494
+
495
+
496
+ ### **Version Identifier**
497
+ > **Input Required**: False
498
+
499
+ > **Description**: Published version identifier.
500
+
501
+
502
+ ### **Scope**
503
+ > **Input Required**: False
504
+
505
+ > **Description**: Scope of the definition.
506
+
507
+
508
+ ### **Importance**
509
+ > **Input Required**: False
510
+
511
+ > **Description**: Importance of the definition.
512
+
513
+
514
+ ### **Governance Drivers**
515
+ > **Input Required**: False
516
+
517
+ > **Description**: The drivers this policy is in response to. Drivers may be Business Imperatives, Regulations, Governance Strategy or Threats.
518
+
519
+ > **Alternative Labels**: Drivers
520
+
521
+
522
+ ### **Implications**
523
+ > **Input Required**: False
524
+
525
+ > **Description**: List of implications.
526
+
527
+
528
+ ### **Outcomes**
529
+ > **Input Required**: False
530
+
531
+ > **Description**: List of desired outcomes.
532
+
533
+
534
+ ### **Results**
535
+ > **Input Required**: False
536
+
537
+ > **Description**: A list of expected results.
538
+
539
+
540
+ ### **Status**
541
+ > **Input Required**: False
542
+
543
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
544
+
545
+ > **Alternative Labels**: Definition Status
546
+
547
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
548
+
549
+ > **Default Value**: DRAFT
550
+
551
+
552
+ ### **User Defined Status**
553
+ > **Input Required**: False
554
+
555
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
556
+
557
+
558
+ ### **Qualified Name**
559
+ > **Input Required**: False
560
+
561
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
562
+
563
+
564
+ ### **GUID**
565
+ > **Input Required**: False
566
+
567
+ > **Description**: A system generated unique identifier.
568
+
569
+ > **Alternative Labels**: Guid; guid
570
+
571
+
572
+ ___
573
+
574
+ ## **Create Governance Procedure**
575
+ > A manual procedure that is performed under certain circumstances.
576
+ ### **Display Name**
577
+ > **Input Required**: True
578
+
579
+ > **Description**: Name of the definition.
580
+
581
+ > **Alternative Labels**: Name
582
+
583
+
584
+ ### **Summary**
585
+ > **Input Required**: False
586
+
587
+ > **Description**: Summary of the definition.
588
+
589
+
590
+ ### **Summary**
591
+ > **Input Required**: False
592
+
593
+ > **Description**: Summary of the definition.
594
+
595
+
596
+ ### **Description**
597
+ > **Input Required**: False
598
+
599
+ > **Description**: Description of the contents of the definition.
600
+
601
+
602
+ ### **Domain Identifier**
603
+ > **Input Required**: False
604
+
605
+ > **Description**: Integer representing the governance domain. All domains is 0.
606
+
607
+ > **Default Value**: 0
608
+
609
+
610
+ ### **Document Identifier**
611
+ > **Input Required**: False
612
+
613
+ > **Description**: A user supplied identifier for the governance document.
614
+
615
+ > **Alternative Labels**: Doc Id
616
+
617
+
618
+ ### **Version Identifier**
619
+ > **Input Required**: False
620
+
621
+ > **Description**: Published version identifier.
622
+
623
+
624
+ ### **Scope**
625
+ > **Input Required**: False
626
+
627
+ > **Description**: Scope of the definition.
628
+
629
+
630
+ ### **Importance**
631
+ > **Input Required**: False
632
+
633
+ > **Description**: Importance of the definition.
634
+
635
+
636
+ ### **Implementation Description**
637
+ > **Input Required**: False
638
+
639
+ > **Description**: Describes how this governance control is implemnted.
640
+
641
+ > **Alternative Labels**: Implementation
642
+
643
+
644
+ ### **Supports Policies**
645
+ > **Input Required**: False
646
+
647
+ > **Description**: The policies that this governance control supports.
648
+
649
+ > **Alternative Labels**: Policies Supported; Policy Supported
650
+
651
+
652
+ ### **Implications**
653
+ > **Input Required**: False
654
+
655
+ > **Description**: List of implications.
656
+
657
+
658
+ ### **Outcomes**
659
+ > **Input Required**: False
660
+
661
+ > **Description**: List of desired outcomes.
662
+
663
+
664
+ ### **Results**
665
+ > **Input Required**: False
666
+
667
+ > **Description**: A list of expected results.
668
+
669
+
670
+ ### **Status**
671
+ > **Input Required**: False
672
+
673
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
674
+
675
+ > **Alternative Labels**: Definition Status
676
+
677
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
678
+
679
+ > **Default Value**: DRAFT
680
+
681
+
682
+ ### **User Defined Status**
683
+ > **Input Required**: False
684
+
685
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
686
+
687
+
688
+ ### **Qualified Name**
689
+ > **Input Required**: False
690
+
691
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
692
+
693
+
694
+ ### **GUID**
695
+ > **Input Required**: False
696
+
697
+ > **Description**: A system generated unique identifier.
698
+
699
+ > **Alternative Labels**: Guid; guid
700
+
701
+
702
+ ___
703
+
704
+ ## **Create Governance Process**
705
+ > An executable process that choreographs different actions.
706
+ ### **Display Name**
707
+ > **Input Required**: True
708
+
709
+ > **Description**: Name of the definition.
710
+
711
+ > **Alternative Labels**: Name
712
+
713
+
714
+ ### **Summary**
715
+ > **Input Required**: False
716
+
717
+ > **Description**: Summary of the definition.
718
+
719
+
720
+ ### **Description**
721
+ > **Input Required**: False
722
+
723
+ > **Description**: Description of the contents of the definition.
724
+
725
+
726
+ ### **Domain Identifier**
727
+ > **Input Required**: False
728
+
729
+ > **Description**: Integer representing the governance domain. All domains is 0.
730
+
731
+ > **Default Value**: 0
732
+
733
+
734
+ ### **Document Identifier**
735
+ > **Input Required**: False
736
+
737
+ > **Description**: A user supplied identifier for the governance document.
738
+
739
+ > **Alternative Labels**: Doc Id
740
+
741
+
742
+ ### **Version Identifier**
743
+ > **Input Required**: False
744
+
745
+ > **Description**: Published version identifier.
746
+
747
+
748
+ ### **Scope**
749
+ > **Input Required**: False
750
+
751
+ > **Description**: Scope of the definition.
752
+
753
+
754
+ ### **Importance**
755
+ > **Input Required**: False
756
+
757
+ > **Description**: Importance of the definition.
758
+
759
+
760
+ ### **Implementation Description**
761
+ > **Input Required**: False
762
+
763
+ > **Description**: Describes how this governance control is implemnted.
764
+
765
+ > **Alternative Labels**: Implementation
766
+
767
+
768
+ ### **Supports Policies**
769
+ > **Input Required**: False
770
+
771
+ > **Description**: The policies that this governance control supports.
772
+
773
+ > **Alternative Labels**: Policies Supported; Policy Supported
774
+
775
+
776
+ ### **Implications**
777
+ > **Input Required**: False
778
+
779
+ > **Description**: List of implications.
780
+
781
+
782
+ ### **Outcomes**
783
+ > **Input Required**: False
784
+
785
+ > **Description**: List of desired outcomes.
786
+
787
+
788
+ ### **Results**
789
+ > **Input Required**: False
790
+
791
+ > **Description**: A list of expected results.
792
+
793
+
794
+ ### **Status**
795
+ > **Input Required**: False
796
+
797
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
798
+
799
+ > **Alternative Labels**: Definition Status
800
+
801
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
802
+
803
+ > **Default Value**: DRAFT
804
+
805
+
806
+ ### **User Defined Status**
807
+ > **Input Required**: False
808
+
809
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
810
+
811
+
812
+ ### **Qualified Name**
813
+ > **Input Required**: False
814
+
815
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
816
+
817
+
818
+ ### **GUID**
819
+ > **Input Required**: False
820
+
821
+ > **Description**: A system generated unique identifier.
822
+
823
+ > **Alternative Labels**: Guid; guid
824
+
825
+
826
+ ___
827
+
828
+ ## **Create Governance Processing Purpose**
829
+ > Privacy regulations such as (GDPR) require data subjects to agree the processing that is permitted on their data.
830
+ ### **Display Name**
831
+ > **Input Required**: True
832
+
833
+ > **Description**: Name of the definition.
834
+
835
+ > **Alternative Labels**: Name
836
+
837
+
838
+ ### **Summary**
839
+ > **Input Required**: False
840
+
841
+ > **Description**: Summary of the definition.
842
+
843
+
844
+ ### **Description**
845
+ > **Input Required**: False
846
+
847
+ > **Description**: Description of the contents of the definition.
848
+
849
+
850
+ ### **Domain Identifier**
851
+ > **Input Required**: False
852
+
853
+ > **Description**: Integer representing the governance domain. All domains is 0.
854
+
855
+ > **Default Value**: 0
856
+
857
+
858
+ ### **Document Identifier**
859
+ > **Input Required**: False
860
+
861
+ > **Description**: A user supplied identifier for the governance document.
862
+
863
+ > **Alternative Labels**: Doc Id
864
+
865
+
866
+ ### **Version Identifier**
867
+ > **Input Required**: False
868
+
869
+ > **Description**: Published version identifier.
870
+
871
+
872
+ ### **Scope**
873
+ > **Input Required**: False
874
+
875
+ > **Description**: Scope of the definition.
876
+
877
+
878
+ ### **Importance**
879
+ > **Input Required**: False
880
+
881
+ > **Description**: Importance of the definition.
882
+
883
+
884
+ ### **Implications**
885
+ > **Input Required**: False
886
+
887
+ > **Description**: List of implications.
888
+
889
+
890
+ ### **Outcomes**
891
+ > **Input Required**: False
892
+
893
+ > **Description**: List of desired outcomes.
894
+
895
+
896
+ ### **Results**
897
+ > **Input Required**: False
898
+
899
+ > **Description**: A list of expected results.
900
+
901
+
902
+ ### **Status**
903
+ > **Input Required**: False
904
+
905
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
906
+
907
+ > **Alternative Labels**: Definition Status
908
+
909
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
910
+
911
+ > **Default Value**: DRAFT
912
+
913
+
914
+ ### **User Defined Status**
915
+ > **Input Required**: False
916
+
917
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
918
+
919
+
920
+ ### **Qualified Name**
921
+ > **Input Required**: False
922
+
923
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
924
+
925
+
926
+ ### **GUID**
927
+ > **Input Required**: False
928
+
929
+ > **Description**: A system generated unique identifier.
930
+
931
+ > **Alternative Labels**: Guid; guid
932
+
933
+
934
+ ___
935
+
936
+ ## **Create Governance Responsibility**
937
+ > A responsiblity 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.
938
+ ### **Display Name**
939
+ > **Input Required**: True
940
+
941
+ > **Description**: Name of the definition.
942
+
943
+ > **Alternative Labels**: Name
944
+
945
+
946
+ ### **Summary**
947
+ > **Input Required**: False
948
+
949
+ > **Description**: Summary of the definition.
950
+
951
+
952
+ ### **Description**
953
+ > **Input Required**: False
954
+
955
+ > **Description**: Description of the contents of the definition.
956
+
957
+
958
+ ### **Domain Identifier**
959
+ > **Input Required**: False
960
+
961
+ > **Description**: Integer representing the governance domain. All domains is 0.
962
+
963
+ > **Default Value**: 0
964
+
965
+
966
+ ### **Document Identifier**
967
+ > **Input Required**: False
968
+
969
+ > **Description**: A user supplied identifier for the governance document.
970
+
971
+ > **Alternative Labels**: Doc Id
972
+
973
+
974
+ ### **Version Identifier**
975
+ > **Input Required**: False
976
+
977
+ > **Description**: Published version identifier.
978
+
979
+
980
+ ### **Scope**
981
+ > **Input Required**: False
982
+
983
+ > **Description**: Scope of the definition.
984
+
985
+
986
+ ### **Importance**
987
+ > **Input Required**: False
988
+
989
+ > **Description**: Importance of the definition.
990
+
991
+
992
+ ### **Implementation Description**
993
+ > **Input Required**: False
994
+
995
+ > **Description**: Describes how this governance control is implemnted.
996
+
997
+ > **Alternative Labels**: Implementation
998
+
999
+
1000
+ ### **Supports Policies**
1001
+ > **Input Required**: False
1002
+
1003
+ > **Description**: The policies that this governance control supports.
1004
+
1005
+ > **Alternative Labels**: Policies Supported; Policy Supported
1006
+
1007
+
1008
+ ### **Implications**
1009
+ > **Input Required**: False
1010
+
1011
+ > **Description**: List of implications.
1012
+
1013
+
1014
+ ### **Outcomes**
1015
+ > **Input Required**: False
1016
+
1017
+ > **Description**: List of desired outcomes.
1018
+
1019
+
1020
+ ### **Results**
1021
+ > **Input Required**: False
1022
+
1023
+ > **Description**: A list of expected results.
1024
+
1025
+
1026
+ ### **Status**
1027
+ > **Input Required**: False
1028
+
1029
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
1030
+
1031
+ > **Alternative Labels**: Definition Status
1032
+
1033
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
1034
+
1035
+ > **Default Value**: DRAFT
1036
+
1037
+
1038
+ ### **User Defined Status**
1039
+ > **Input Required**: False
1040
+
1041
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
1042
+
1043
+
1044
+ ### **Qualified Name**
1045
+ > **Input Required**: False
1046
+
1047
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
1048
+
1049
+
1050
+ ### **GUID**
1051
+ > **Input Required**: False
1052
+
1053
+ > **Description**: A system generated unique identifier.
1054
+
1055
+ > **Alternative Labels**: Guid; guid
1056
+
1057
+
1058
+ ___
1059
+
1060
+ ## **Create Governance Rule**
1061
+ > An executable rule that can be deployed at particular points in the operations.
1062
+ ### **Display Name**
1063
+ > **Input Required**: True
1064
+
1065
+ > **Description**: Name of the definition.
1066
+
1067
+ > **Alternative Labels**: Name
1068
+
1069
+
1070
+ ### **Summary**
1071
+ > **Input Required**: False
1072
+
1073
+ > **Description**: Summary of the definition.
1074
+
1075
+
1076
+ ### **Description**
1077
+ > **Input Required**: False
1078
+
1079
+ > **Description**: Description of the contents of the definition.
1080
+
1081
+
1082
+ ### **Domain Identifier**
1083
+ > **Input Required**: False
1084
+
1085
+ > **Description**: Integer representing the governance domain. All domains is 0.
1086
+
1087
+ > **Default Value**: 0
1088
+
1089
+
1090
+ ### **Document Identifier**
1091
+ > **Input Required**: False
1092
+
1093
+ > **Description**: A user supplied identifier for the governance document.
1094
+
1095
+ > **Alternative Labels**: Doc Id
1096
+
1097
+
1098
+ ### **Version Identifier**
1099
+ > **Input Required**: False
1100
+
1101
+ > **Description**: Published version identifier.
1102
+
1103
+
1104
+ ### **Scope**
1105
+ > **Input Required**: False
1106
+
1107
+ > **Description**: Scope of the definition.
1108
+
1109
+
1110
+ ### **Importance**
1111
+ > **Input Required**: False
1112
+
1113
+ > **Description**: Importance of the definition.
1114
+
1115
+
1116
+ ### **Implementation Description**
1117
+ > **Input Required**: False
1118
+
1119
+ > **Description**: Describes how this governance control is implemented.
1120
+
1121
+ > **Alternative Labels**: Implementation
1122
+
1123
+
1124
+ ### **Supports Policies**
1125
+ > **Input Required**: False
1126
+
1127
+ > **Description**: The policies that this governance control supports.
1128
+
1129
+ > **Alternative Labels**: Policies Supported; Policy Supported
1130
+
1131
+
1132
+ ### **Implications**
1133
+ > **Input Required**: False
1134
+
1135
+ > **Description**: List of implications.
1136
+
1137
+
1138
+ ### **Outcomes**
1139
+ > **Input Required**: False
1140
+
1141
+ > **Description**: List of desired outcomes.
1142
+
1143
+
1144
+ ### **Results**
1145
+ > **Input Required**: False
1146
+
1147
+ > **Description**: A list of expected results.
1148
+
1149
+
1150
+ ### **Status**
1151
+ > **Input Required**: False
1152
+
1153
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
1154
+
1155
+ > **Alternative Labels**: Definition Status
1156
+
1157
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
1158
+
1159
+ > **Default Value**: DRAFT
1160
+
1161
+
1162
+ ### **User Defined Status**
1163
+ > **Input Required**: False
1164
+
1165
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
1166
+
1167
+
1168
+ ### **Qualified Name**
1169
+ > **Input Required**: False
1170
+
1171
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
1172
+
1173
+
1174
+ ### **GUID**
1175
+ > **Input Required**: False
1176
+
1177
+ > **Description**: A system generated unique identifier.
1178
+
1179
+ > **Alternative Labels**: Guid; guid
1180
+
1181
+
1182
+ ___
1183
+
1184
+ ## **Create Governance Strategy**
1185
+ > The strategy used in the development of the governance domains activities. How the governance domain supports the business strategy.
1186
+ ### **Display Name**
1187
+ > **Input Required**: True
1188
+
1189
+ > **Description**: Name of the definition.
1190
+
1191
+ > **Alternative Labels**: Name
1192
+
1193
+
1194
+ ### **Summary**
1195
+ > **Input Required**: False
1196
+
1197
+ > **Description**: Summary of the definition.
1198
+
1199
+
1200
+ ### **Description**
1201
+ > **Input Required**: False
1202
+
1203
+ > **Description**: Description of the contents of the definition.
1204
+
1205
+
1206
+ ### **Domain Identifier**
1207
+ > **Input Required**: False
1208
+
1209
+ > **Description**: Integer representing the governance domain. All domains is 0.
1210
+
1211
+ > **Default Value**: 0
1212
+
1213
+
1214
+ ### **Document Identifier**
1215
+ > **Input Required**: False
1216
+
1217
+ > **Description**: A user supplied identifier for the governance document.
1218
+
1219
+ > **Alternative Labels**: Doc Id
1220
+
1221
+
1222
+ ### **Version Identifier**
1223
+ > **Input Required**: False
1224
+
1225
+ > **Description**: Published version identifier.
1226
+
1227
+
1228
+ ### **Scope**
1229
+ > **Input Required**: False
1230
+
1231
+ > **Description**: Scope of the definition.
1232
+
1233
+
1234
+ ### **Importance**
1235
+ > **Input Required**: False
1236
+
1237
+ > **Description**: Importance of the definition.
1238
+
1239
+
1240
+ ### **Business Imperatives**
1241
+ > **Input Required**: False
1242
+
1243
+ > **Description**: List of imperitives.
1244
+
1245
+
1246
+ ### **Outcomes**
1247
+ > **Input Required**: False
1248
+
1249
+ > **Description**: List of desired outcomes.
1250
+
1251
+
1252
+ ### **Results**
1253
+ > **Input Required**: False
1254
+
1255
+ > **Description**: A list of expected results.
1256
+
1257
+
1258
+ ### **Status**
1259
+ > **Input Required**: False
1260
+
1261
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
1262
+
1263
+ > **Alternative Labels**: Definition Status
1264
+
1265
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
1266
+
1267
+ > **Default Value**: DRAFT
1268
+
1269
+
1270
+ ### **User Defined Status**
1271
+ > **Input Required**: False
1272
+
1273
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
1274
+
1275
+
1276
+ ### **Qualified Name**
1277
+ > **Input Required**: False
1278
+
1279
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
1280
+
1281
+
1282
+ ### **GUID**
1283
+ > **Input Required**: False
1284
+
1285
+ > **Description**: A system generated unique identifier.
1286
+
1287
+ > **Alternative Labels**: Guid; guid
1288
+
1289
+
1290
+ ___
1291
+
1292
+ ## **Create License Type**
1293
+ > A type of license.
1294
+ ### **Display Name**
1295
+ > **Input Required**: True
1296
+
1297
+ > **Description**: Name of the definition.
1298
+
1299
+ > **Alternative Labels**: Name
1300
+
1301
+
1302
+ ### **Summary**
1303
+ > **Input Required**: False
1304
+
1305
+ > **Description**: Summary of the definition.
1306
+
1307
+
1308
+ ### **Description**
1309
+ > **Input Required**: False
1310
+
1311
+ > **Description**: Description of the contents of the definition.
1312
+
1313
+
1314
+ ### **Domain Identifier**
1315
+ > **Input Required**: False
1316
+
1317
+ > **Description**: Integer representing the governance domain. All domains is 0.
1318
+
1319
+ > **Default Value**: 0
1320
+
1321
+
1322
+ ### **Document Identifier**
1323
+ > **Input Required**: False
1324
+
1325
+ > **Description**: A user supplied identifier for the governance document.
1326
+
1327
+ > **Alternative Labels**: Doc Id
1328
+
1329
+
1330
+ ### **Version Identifier**
1331
+ > **Input Required**: False
1332
+
1333
+ > **Description**: Published version identifier.
1334
+
1335
+
1336
+ ### **Scope**
1337
+ > **Input Required**: False
1338
+
1339
+ > **Description**: Scope of the definition.
1340
+
1341
+
1342
+ ### **Importance**
1343
+ > **Input Required**: False
1344
+
1345
+ > **Description**: Importance of the definition.
1346
+
1347
+
1348
+ ### **Details**
1349
+ > **Input Required**: False
1350
+
1351
+ > **Description**: Details of the license.
1352
+
1353
+
1354
+ ### **Implications**
1355
+ > **Input Required**: False
1356
+
1357
+ > **Description**: List of implications.
1358
+
1359
+
1360
+ ### **Outcomes**
1361
+ > **Input Required**: False
1362
+
1363
+ > **Description**: List of desired outcomes.
1364
+
1365
+
1366
+ ### **Results**
1367
+ > **Input Required**: False
1368
+
1369
+ > **Description**: A list of expected results.
1370
+
1371
+
1372
+ ### **Status**
1373
+ > **Input Required**: False
1374
+
1375
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
1376
+
1377
+ > **Alternative Labels**: Definition Status
1378
+
1379
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
1380
+
1381
+ > **Default Value**: DRAFT
1382
+
1383
+
1384
+ ### **User Defined Status**
1385
+ > **Input Required**: False
1386
+
1387
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
1388
+
1389
+
1390
+ ### **Qualified Name**
1391
+ > **Input Required**: False
1392
+
1393
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
1394
+
1395
+
1396
+ ### **GUID**
1397
+ > **Input Required**: False
1398
+
1399
+ > **Description**: A system generated unique identifier.
1400
+
1401
+ > **Alternative Labels**: Guid; guid
1402
+
1403
+
1404
+ ___
1405
+
1406
+ ## **Create Naming Standard Rule**
1407
+ > A standard for naming specific kinds of resources.
1408
+ ### **Display Name**
1409
+ > **Input Required**: True
1410
+
1411
+ > **Description**: Name of the definition.
1412
+
1413
+ > **Alternative Labels**: Name
1414
+
1415
+
1416
+ ### **Summary**
1417
+ > **Input Required**: False
1418
+
1419
+ > **Description**: Summary of the definition.
1420
+
1421
+
1422
+ ### **Description**
1423
+ > **Input Required**: False
1424
+
1425
+ > **Description**: Description of the contents of the definition.
1426
+
1427
+
1428
+ ### **Domain Identifier**
1429
+ > **Input Required**: False
1430
+
1431
+ > **Description**: Integer representing the governance domain. All domains is 0.
1432
+
1433
+ > **Default Value**: 0
1434
+
1435
+
1436
+ ### **Document Identifier**
1437
+ > **Input Required**: False
1438
+
1439
+ > **Description**: A user supplied identifier for the governance document.
1440
+
1441
+ > **Alternative Labels**: Doc Id
1442
+
1443
+
1444
+ ### **Version Identifier**
1445
+ > **Input Required**: False
1446
+
1447
+ > **Description**: Published version identifier.
1448
+
1449
+
1450
+ ### **Scope**
1451
+ > **Input Required**: False
1452
+
1453
+ > **Description**: Scope of the definition.
1454
+
1455
+
1456
+ ### **Importance**
1457
+ > **Input Required**: False
1458
+
1459
+ > **Description**: Importance of the definition.
1460
+
1461
+
1462
+ ### **Implementation Description**
1463
+ > **Input Required**: False
1464
+
1465
+ > **Description**: Describes how this governance control is implemnted.
1466
+
1467
+ > **Alternative Labels**: Implementation
1468
+
1469
+
1470
+ ### **Supports Policies**
1471
+ > **Input Required**: False
1472
+
1473
+ > **Description**: The policies that this governance control supports.
1474
+
1475
+ > **Alternative Labels**: Policies Supported; Policy Supported
1476
+
1477
+
1478
+ ### **Name Patterns**
1479
+ > **Input Required**: False
1480
+
1481
+ > **Description**: List of implications.
1482
+
1483
+
1484
+ ### **Outcomes**
1485
+ > **Input Required**: False
1486
+
1487
+ > **Description**: List of desired outcomes.
1488
+
1489
+
1490
+ ### **Results**
1491
+ > **Input Required**: False
1492
+
1493
+ > **Description**: A list of expected results.
1494
+
1495
+
1496
+ ### **Status**
1497
+ > **Input Required**: False
1498
+
1499
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
1500
+
1501
+ > **Alternative Labels**: Definition Status
1502
+
1503
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
1504
+
1505
+ > **Default Value**: DRAFT
1506
+
1507
+
1508
+ ### **User Defined Status**
1509
+ > **Input Required**: False
1510
+
1511
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
1512
+
1513
+
1514
+ ### **Qualified Name**
1515
+ > **Input Required**: False
1516
+
1517
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
1518
+
1519
+
1520
+ ### **GUID**
1521
+ > **Input Required**: False
1522
+
1523
+ > **Description**: A system generated unique identifier.
1524
+
1525
+ > **Alternative Labels**: Guid; guid
1526
+
1527
+
1528
+ ___
1529
+
1530
+ ## **Create Regulation Article**
1531
+ > A RegulationArticle entity is an article in a regulation. Dividing a regulation simplifies planning and execution.
1532
+ ### **Display Name**
1533
+ > **Input Required**: True
1534
+
1535
+ > **Description**: Name of the definition.
1536
+
1537
+ > **Alternative Labels**: Name
1538
+
1539
+
1540
+ ### **Summary**
1541
+ > **Input Required**: False
1542
+
1543
+ > **Description**: Summary of the definition.
1544
+
1545
+
1546
+ ### **Description**
1547
+ > **Input Required**: False
1548
+
1549
+ > **Description**: Description of the contents of the definition.
1550
+
1551
+
1552
+ ### **Domain Identifier**
1553
+ > **Input Required**: False
1554
+
1555
+ > **Description**: Integer representing the governance domain. All domains is 0.
1556
+
1557
+ > **Default Value**: 0
1558
+
1559
+
1560
+ ### **Document Identifier**
1561
+ > **Input Required**: False
1562
+
1563
+ > **Description**: A user supplied identifier for the governance document.
1564
+
1565
+ > **Alternative Labels**: Doc Id
1566
+
1567
+
1568
+ ### **Version Identifier**
1569
+ > **Input Required**: False
1570
+
1571
+ > **Description**: Published version identifier.
1572
+
1573
+
1574
+ ### **Scope**
1575
+ > **Input Required**: False
1576
+
1577
+ > **Description**: Scope of the definition.
1578
+
1579
+
1580
+ ### **Importance**
1581
+ > **Input Required**: False
1582
+
1583
+ > **Description**: Importance of the definition.
1584
+
1585
+
1586
+ ### **Implications**
1587
+ > **Input Required**: False
1588
+
1589
+ > **Description**: List of implications.
1590
+
1591
+
1592
+ ### **Outcomes**
1593
+ > **Input Required**: False
1594
+
1595
+ > **Description**: List of desired outcomes.
1596
+
1597
+
1598
+ ### **Results**
1599
+ > **Input Required**: False
1600
+
1601
+ > **Description**: A list of expected results.
1602
+
1603
+
1604
+ ### **Status**
1605
+ > **Input Required**: False
1606
+
1607
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
1608
+
1609
+ > **Alternative Labels**: Definition Status
1610
+
1611
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
1612
+
1613
+ > **Default Value**: DRAFT
1614
+
1615
+
1616
+ ### **User Defined Status**
1617
+ > **Input Required**: False
1618
+
1619
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
1620
+
1621
+
1622
+ ### **Qualified Name**
1623
+ > **Input Required**: False
1624
+
1625
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
1626
+
1627
+
1628
+ ### **GUID**
1629
+ > **Input Required**: False
1630
+
1631
+ > **Description**: A system generated unique identifier.
1632
+
1633
+ > **Alternative Labels**: Guid; guid
1634
+
1635
+
1636
+ ___
1637
+
1638
+ ## **Create Regulation Definition**
1639
+ > Defines a relevant legal regulation that the business operation must comply with. Often regulations are divided into regulation articles.
1640
+ ### **Display Name**
1641
+ > **Input Required**: True
1642
+
1643
+ > **Description**: Name of the definition.
1644
+
1645
+ > **Alternative Labels**: Name
1646
+
1647
+
1648
+ ### **Summary**
1649
+ > **Input Required**: False
1650
+
1651
+ > **Description**: Summary of the definition.
1652
+
1653
+
1654
+ ### **Description**
1655
+ > **Input Required**: False
1656
+
1657
+ > **Description**: Description of the contents of the definition.
1658
+
1659
+
1660
+ ### **Domain Identifier**
1661
+ > **Input Required**: False
1662
+
1663
+ > **Description**: Integer representing the governance domain. All domains is 0.
1664
+
1665
+ > **Default Value**: 0
1666
+
1667
+
1668
+ ### **Document Identifier**
1669
+ > **Input Required**: False
1670
+
1671
+ > **Description**: A user supplied identifier for the governance document.
1672
+
1673
+ > **Alternative Labels**: Doc Id
1674
+
1675
+
1676
+ ### **Version Identifier**
1677
+ > **Input Required**: False
1678
+
1679
+ > **Description**: Published version identifier.
1680
+
1681
+
1682
+ ### **Scope**
1683
+ > **Input Required**: False
1684
+
1685
+ > **Description**: Scope of the definition.
1686
+
1687
+
1688
+ ### **Importance**
1689
+ > **Input Required**: False
1690
+
1691
+ > **Description**: Importance of the definition.
1692
+
1693
+
1694
+ ### **Source**
1695
+ > **Input Required**: False
1696
+
1697
+ > **Description**: The source of the regulator.
1698
+
1699
+
1700
+ ### **Regulators**
1701
+ > **Input Required**: False
1702
+
1703
+ > **Description**: The regulatory authorities responsible for monitoring compliance to regulations.
1704
+
1705
+
1706
+ ### **Implications**
1707
+ > **Input Required**: False
1708
+
1709
+ > **Description**: List of implications.
1710
+
1711
+
1712
+ ### **Outcomes**
1713
+ > **Input Required**: False
1714
+
1715
+ > **Description**: List of desired outcomes.
1716
+
1717
+
1718
+ ### **Results**
1719
+ > **Input Required**: False
1720
+
1721
+ > **Description**: A list of expected results.
1722
+
1723
+
1724
+ ### **Status**
1725
+ > **Input Required**: False
1726
+
1727
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
1728
+
1729
+ > **Alternative Labels**: Definition Status
1730
+
1731
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
1732
+
1733
+ > **Default Value**: DRAFT
1734
+
1735
+
1736
+ ### **User Defined Status**
1737
+ > **Input Required**: False
1738
+
1739
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
1740
+
1741
+
1742
+ ### **Qualified Name**
1743
+ > **Input Required**: False
1744
+
1745
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
1746
+
1747
+
1748
+ ### **GUID**
1749
+ > **Input Required**: False
1750
+
1751
+ > **Description**: A system generated unique identifier.
1752
+
1753
+ > **Alternative Labels**: Guid; guid
1754
+
1755
+
1756
+ ___
1757
+
1758
+ ## **Create Security Access Control**
1759
+ > A technical control that defines the access control lists that an actor must belong to be entitled to perform a specific action.
1760
+ ### **Display Name**
1761
+ > **Input Required**: True
1762
+
1763
+ > **Description**: Name of the definition.
1764
+
1765
+ > **Alternative Labels**: Name
1766
+
1767
+
1768
+ ### **Summary**
1769
+ > **Input Required**: False
1770
+
1771
+ > **Description**: Summary of the definition.
1772
+
1773
+
1774
+ ### **Description**
1775
+ > **Input Required**: False
1776
+
1777
+ > **Description**: Description of the contents of the definition.
1778
+
1779
+
1780
+ ### **Domain Identifier**
1781
+ > **Input Required**: False
1782
+
1783
+ > **Description**: Integer representing the governance domain. All domains is 0.
1784
+
1785
+ > **Default Value**: 0
1786
+
1787
+
1788
+ ### **Document Identifier**
1789
+ > **Input Required**: False
1790
+
1791
+ > **Description**: A user supplied identifier for the governance document.
1792
+
1793
+ > **Alternative Labels**: Doc Id
1794
+
1795
+
1796
+ ### **Version Identifier**
1797
+ > **Input Required**: False
1798
+
1799
+ > **Description**: Published version identifier.
1800
+
1801
+
1802
+ ### **Scope**
1803
+ > **Input Required**: False
1804
+
1805
+ > **Description**: Scope of the definition.
1806
+
1807
+
1808
+ ### **Importance**
1809
+ > **Input Required**: False
1810
+
1811
+ > **Description**: Importance of the definition.
1812
+
1813
+
1814
+ ### **Implementation Description**
1815
+ > **Input Required**: False
1816
+
1817
+ > **Description**: Describes how this governance control is implemnted.
1818
+
1819
+ > **Alternative Labels**: Implementation
1820
+
1821
+
1822
+ ### **Implications**
1823
+ > **Input Required**: False
1824
+
1825
+ > **Description**: List of implications.
1826
+
1827
+
1828
+ ### **Outcomes**
1829
+ > **Input Required**: False
1830
+
1831
+ > **Description**: List of desired outcomes.
1832
+
1833
+
1834
+ ### **Results**
1835
+ > **Input Required**: False
1836
+
1837
+ > **Description**: A list of expected results.
1838
+
1839
+
1840
+ ### **Status**
1841
+ > **Input Required**: False
1842
+
1843
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
1844
+
1845
+ > **Alternative Labels**: Definition Status
1846
+
1847
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
1848
+
1849
+ > **Default Value**: DRAFT
1850
+
1851
+
1852
+ ### **User Defined Status**
1853
+ > **Input Required**: False
1854
+
1855
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
1856
+
1857
+
1858
+ ### **Qualified Name**
1859
+ > **Input Required**: False
1860
+
1861
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
1862
+
1863
+
1864
+ ### **GUID**
1865
+ > **Input Required**: False
1866
+
1867
+ > **Description**: A system generated unique identifier.
1868
+
1869
+ > **Alternative Labels**: Guid; guid
1870
+
1871
+
1872
+ ___
1873
+
1874
+ ## **Create Security Group**
1875
+ > A group of actors that need to be given the same access to a specific set of resources.
1876
+ ### **Display Name**
1877
+ > **Input Required**: True
1878
+
1879
+ > **Description**: Name of the definition.
1880
+
1881
+ > **Alternative Labels**: Name
1882
+
1883
+
1884
+ ### **Summary**
1885
+ > **Input Required**: False
1886
+
1887
+ > **Description**: Summary of the definition.
1888
+
1889
+
1890
+ ### **Description**
1891
+ > **Input Required**: False
1892
+
1893
+ > **Description**: Description of the contents of the definition.
1894
+
1895
+
1896
+ ### **Domain Identifier**
1897
+ > **Input Required**: False
1898
+
1899
+ > **Description**: Integer representing the governance domain. All domains is 0.
1900
+
1901
+ > **Default Value**: 0
1902
+
1903
+
1904
+ ### **Distinguished Name**
1905
+ > **Input Required**: False
1906
+
1907
+ > **Description**: Unique identity of an actor.
1908
+
1909
+
1910
+ ### **Document Identifier**
1911
+ > **Input Required**: False
1912
+
1913
+ > **Description**: A user supplied identifier for the governance document.
1914
+
1915
+ > **Alternative Labels**: Doc Id
1916
+
1917
+
1918
+ ### **Version Identifier**
1919
+ > **Input Required**: False
1920
+
1921
+ > **Description**: Published version identifier.
1922
+
1923
+
1924
+ ### **Scope**
1925
+ > **Input Required**: False
1926
+
1927
+ > **Description**: Scope of the definition.
1928
+
1929
+
1930
+ ### **Importance**
1931
+ > **Input Required**: False
1932
+
1933
+ > **Description**: Importance of the definition.
1934
+
1935
+
1936
+ ### **Implementation Description**
1937
+ > **Input Required**: False
1938
+
1939
+ > **Description**: Describes how this governance control is implemnted.
1940
+
1941
+ > **Alternative Labels**: Implementation
1942
+
1943
+
1944
+ ### **Implications**
1945
+ > **Input Required**: False
1946
+
1947
+ > **Description**: List of implications.
1948
+
1949
+
1950
+ ### **Outcomes**
1951
+ > **Input Required**: False
1952
+
1953
+ > **Description**: List of desired outcomes.
1954
+
1955
+
1956
+ ### **Results**
1957
+ > **Input Required**: False
1958
+
1959
+ > **Description**: A list of expected results.
1960
+
1961
+
1962
+ ### **Status**
1963
+ > **Input Required**: False
1964
+
1965
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
1966
+
1967
+ > **Alternative Labels**: Definition Status
1968
+
1969
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
1970
+
1971
+ > **Default Value**: DRAFT
1972
+
1973
+
1974
+ ### **User Defined Status**
1975
+ > **Input Required**: False
1976
+
1977
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
1978
+
1979
+
1980
+ ### **Qualified Name**
1981
+ > **Input Required**: False
1982
+
1983
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
1984
+
1985
+
1986
+ ### **GUID**
1987
+ > **Input Required**: False
1988
+
1989
+ > **Description**: A system generated unique identifier.
1990
+
1991
+ > **Alternative Labels**: Guid; guid
1992
+
1993
+
1994
+ ___
1995
+
1996
+ ## **Create Service Level Objectives**
1997
+ > Defines the performance, availability and qualitiy levels expected by the element attached.
1998
+ ### **Display Name**
1999
+ > **Input Required**: True
2000
+
2001
+ > **Description**: Name of the definition.
2002
+
2003
+ > **Alternative Labels**: Name
2004
+
2005
+
2006
+ ### **Summary**
2007
+ > **Input Required**: False
2008
+
2009
+ > **Description**: Summary of the definition.
2010
+
2011
+
2012
+ ### **Description**
2013
+ > **Input Required**: False
2014
+
2015
+ > **Description**: Description of the contents of the definition.
2016
+
2017
+
2018
+ ### **Domain Identifier**
2019
+ > **Input Required**: False
2020
+
2021
+ > **Description**: Integer representing the governance domain. All domains is 0.
2022
+
2023
+ > **Default Value**: 0
2024
+
2025
+
2026
+ ### **Document Identifier**
2027
+ > **Input Required**: False
2028
+
2029
+ > **Description**: A user supplied identifier for the governance document.
2030
+
2031
+ > **Alternative Labels**: Doc Id
2032
+
2033
+
2034
+ ### **Version Identifier**
2035
+ > **Input Required**: False
2036
+
2037
+ > **Description**: Published version identifier.
2038
+
2039
+
2040
+ ### **Scope**
2041
+ > **Input Required**: False
2042
+
2043
+ > **Description**: Scope of the definition.
2044
+
2045
+
2046
+ ### **Importance**
2047
+ > **Input Required**: False
2048
+
2049
+ > **Description**: Importance of the definition.
2050
+
2051
+
2052
+ ### **Implementation Description**
2053
+ > **Input Required**: False
2054
+
2055
+ > **Description**: Describes how this governance control is implemnted.
2056
+
2057
+ > **Alternative Labels**: Implementation
2058
+
2059
+
2060
+ ### **Supports Policies**
2061
+ > **Input Required**: False
2062
+
2063
+ > **Description**: The policies that this governance control supports.
2064
+
2065
+ > **Alternative Labels**: Policies Supported; Policy Supported
2066
+
2067
+
2068
+ ### **Implications**
2069
+ > **Input Required**: False
2070
+
2071
+ > **Description**: List of implications.
2072
+
2073
+
2074
+ ### **Outcomes**
2075
+ > **Input Required**: False
2076
+
2077
+ > **Description**: List of desired outcomes.
2078
+
2079
+
2080
+ ### **Results**
2081
+ > **Input Required**: False
2082
+
2083
+ > **Description**: A list of expected results.
2084
+
2085
+
2086
+ ### **Status**
2087
+ > **Input Required**: False
2088
+
2089
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
2090
+
2091
+ > **Alternative Labels**: Definition Status
2092
+
2093
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
2094
+
2095
+ > **Default Value**: DRAFT
2096
+
2097
+
2098
+ ### **User Defined Status**
2099
+ > **Input Required**: False
2100
+
2101
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
2102
+
2103
+
2104
+ ### **Qualified Name**
2105
+ > **Input Required**: False
2106
+
2107
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
2108
+
2109
+
2110
+ ### **GUID**
2111
+ > **Input Required**: False
2112
+
2113
+ > **Description**: A system generated unique identifier.
2114
+
2115
+ > **Alternative Labels**: Guid; guid
2116
+
2117
+
2118
+ ___
2119
+
2120
+ ## **Create Threat Definition**
2121
+ > The Threat entity describes a particular threat to the organization's operations that must either be guarded against or accommodated to reduce its impact.
2122
+ ### **Display Name**
2123
+ > **Input Required**: True
2124
+
2125
+ > **Description**: Name of the definition.
2126
+
2127
+ > **Alternative Labels**: Name
2128
+
2129
+
2130
+ ### **Summary**
2131
+ > **Input Required**: False
2132
+
2133
+ > **Description**: Summary of the definition.
2134
+
2135
+
2136
+ ### **Description**
2137
+ > **Input Required**: False
2138
+
2139
+ > **Description**: Description of the contents of the definition.
2140
+
2141
+
2142
+ ### **Domain Identifier**
2143
+ > **Input Required**: False
2144
+
2145
+ > **Description**: Integer representing the governance domain. All domains is 0.
2146
+
2147
+ > **Default Value**: 0
2148
+
2149
+
2150
+ ### **Document Identifier**
2151
+ > **Input Required**: False
2152
+
2153
+ > **Description**: A user supplied identifier for the governance document.
2154
+
2155
+ > **Alternative Labels**: Doc Id
2156
+
2157
+
2158
+ ### **Version Identifier**
2159
+ > **Input Required**: False
2160
+
2161
+ > **Description**: Published version identifier.
2162
+
2163
+
2164
+ ### **Scope**
2165
+ > **Input Required**: False
2166
+
2167
+ > **Description**: Scope of the definition.
2168
+
2169
+
2170
+ ### **Importance**
2171
+ > **Input Required**: False
2172
+
2173
+ > **Description**: Importance of the definition.
2174
+
2175
+
2176
+ ### **Implications**
2177
+ > **Input Required**: False
2178
+
2179
+ > **Description**: List of implications.
2180
+
2181
+
2182
+ ### **Outcomes**
2183
+ > **Input Required**: False
2184
+
2185
+ > **Description**: List of desired outcomes.
2186
+
2187
+
2188
+ ### **Results**
2189
+ > **Input Required**: False
2190
+
2191
+ > **Description**: A list of expected results.
2192
+
2193
+
2194
+ ### **Status**
2195
+ > **Input Required**: False
2196
+
2197
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
2198
+
2199
+ > **Alternative Labels**: Definition Status
2200
+
2201
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
2202
+
2203
+ > **Default Value**: DRAFT
2204
+
2205
+
2206
+ ### **User Defined Status**
2207
+ > **Input Required**: False
2208
+
2209
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
2210
+
2211
+
2212
+ ### **Qualified Name**
2213
+ > **Input Required**: False
2214
+
2215
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
2216
+
2217
+
2218
+ ### **GUID**
2219
+ > **Input Required**: False
2220
+
2221
+ > **Description**: A system generated unique identifier.
2222
+
2223
+ > **Alternative Labels**: Guid; guid
2224
+
2225
+
2226
+ ___
2227
+
2228
+ ## **Link Governance Controls**
2229
+ > Link peer governance controls with the GovernanceControlLink relationship. Controls types are: GovernanceRule, GovernanceProcess, GovernanceResponsibility, GovernanceProcedure, SecurityAccessControl, SecurityGroup.
2230
+ ### **Control Definition 1**
2231
+ > **Input Required**: True
2232
+
2233
+ > **Description**: The first governance control to link.
2234
+
2235
+ > **Alternative Labels**: Control 1; Governance Control 1
2236
+
2237
+
2238
+ ### **Control Definition 2**
2239
+ > **Input Required**: True
2240
+
2241
+ > **Description**: The fsecond governance control to link.
2242
+
2243
+ > **Alternative Labels**: Control 2; Governance Control 2
2244
+
2245
+
2246
+ ### **Link Label**
2247
+ > **Input Required**: False
2248
+
2249
+ > **Description**: Labels the link between two governance defninitions.
2250
+
2251
+ > **Alternative Labels**: Label
2252
+
2253
+
2254
+ ### **Description**
2255
+ > **Input Required**: False
2256
+
2257
+ > **Description**: A description of the relationship.
2258
+
2259
+
2260
+ ___
2261
+
2262
+ ## **Link Governance Drivers**
2263
+ > Link peer governance drivers with the GovernanceDriverLink relationship. Drivers are: GovernanceStrategy, BusinessImperitive, Regulation, RegulationArticle, Threat.
2264
+ ### **Definition 1**
2265
+ > **Input Required**: True
2266
+
2267
+ > **Description**: The first governance driver to link.
2268
+
2269
+ > **Alternative Labels**: Driver 1; Governance Driver 1
2270
+
2271
+
2272
+ ### **Definition 2**
2273
+ > **Input Required**: True
2274
+
2275
+ > **Description**: The second governance driver to link.
2276
+
2277
+ > **Alternative Labels**: Driver 2; Governance Driver 2
2278
+
2279
+
2280
+ ### **Link Label**
2281
+ > **Input Required**: False
2282
+
2283
+ > **Description**: Labels the link between two governance defninitions.
2284
+
2285
+ > **Alternative Labels**: Label
2286
+
2287
+
2288
+ ### **Description**
2289
+ > **Input Required**: False
2290
+
2291
+ > **Description**: A description of the relationship.
2292
+
2293
+
2294
+ ___
2295
+
2296
+ ## **Link Governance Policies**
2297
+ > Link peer governance policies with the GovernancePolicyLink relationship. Policies types are: GovernancePrinciple, GovernanceObligation, GovernanceApproach.
2298
+ ### **Definition 1**
2299
+ > **Input Required**: True
2300
+
2301
+ > **Description**: The first governance policy to link.
2302
+
2303
+ > **Alternative Labels**: Policy 1; Governance Policy 1
2304
+
2305
+
2306
+ ### **Definition 2**
2307
+ > **Input Required**: True
2308
+
2309
+ > **Description**: The second governance policy to link.
2310
+
2311
+ > **Alternative Labels**: Policy 2; Governance Policy 2
2312
+
2313
+
2314
+ ### **Link Label**
2315
+ > **Input Required**: False
2316
+
2317
+ > **Description**: Labels the link between two governance defninitions.
2318
+
2319
+ > **Alternative Labels**: Label
2320
+
2321
+
2322
+ ### **Description**
2323
+ > **Input Required**: False
2324
+
2325
+ > **Description**: A description of the relationship.
2326
+
2327
+
2328
+ ___
2329
+
2330
+ ## **View Governance Definitions**
2331
+ > This can be used to list any kind of governance definitions.
2332
+ ### **Search String**
2333
+ > **Input Required**: False
2334
+
2335
+ > **Description**: An optional search string to filter results by.
2336
+
2337
+ > **Alternative Labels**: Filter
2338
+
2339
+ > **Default Value**: *
2340
+
2341
+
2342
+ ### **Output Format**
2343
+ > **Input Required**: False
2344
+
2345
+ > **Description**: Optional specification of output format for the query.
2346
+
2347
+ > **Alternative Labels**: Format
2348
+
2349
+ > **Valid Values**: LIST; FORM; REPORT; MERMAID; DICT
2350
+
2351
+ > **Default Value**: LIST
2352
+
2353
+
2354
+ ### **Starts With**
2355
+ > **Input Required**: False
2356
+
2357
+ > **Description**: If true, look for matches with the search string starting from the beginning of a field.
2358
+
2359
+ > **Default Value**: True
2360
+
2361
+
2362
+ ### **Ends With**
2363
+ > **Input Required**: False
2364
+
2365
+ > **Description**: If true, look for matches with the search string starting from the end of a field.
2366
+
2367
+ > **Default Value**: False
2368
+
2369
+
2370
+ ### **Ignore Case**
2371
+ > **Input Required**: False
2372
+
2373
+ > **Description**: If true, ignore the difference between upper and lower characters when matching the search string.
2374
+
2375
+ > **Default Value**: False
2376
+
2377
+
2378
+ ### **AsOfTime**
2379
+ > **Input Required**: False
2380
+
2381
+ > **Description**: An ISO-8601 string representing the time to view the state of the repository.
2382
+
2383
+ > **Alternative Labels**: As Of Time
2384
+
2385
+
2386
+ ### **Sort Order**
2387
+ > **Input Required**: False
2388
+
2389
+ > **Description**: How to order the results. The sort order can be selected from a list of valid value.
2390
+
2391
+ > **Valid Values**: ANY; CREATION_DATE_RECENT; CREATION_DATA_OLDEST; LAST_UPDATE_RECENT; LAST_UPDATE_OLDEST; PROPERTY_ASCENDING; PROPERTY_DESCENDING
2392
+
2393
+
2394
+ ### **Order Property Name**
2395
+ > **Input Required**: False
2396
+
2397
+ > **Description**: The property to use for sorting if the sort_order_property is PROPERTY_ASCENDING or PROPERTY_DESCENDING
2398
+
2399
+
2400
+ ### **Page Size**
2401
+ > **Input Required**: False
2402
+
2403
+ > **Description**: The number of elements returned per page.
2404
+
2405
+
2406
+ ### **Start From**
2407
+ > **Input Required**: False
2408
+
2409
+ > **Description**: When paging through results, the starting point of the results to return.
2410
+
2411
+
2412
+ ___