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,122 @@
1
+ # **Create Governance Rule**
2
+ > An executable rule that can be deployed at particular points in the operations.
3
+
4
+ ## **Display Name**
5
+ > **Input Required**: True
6
+
7
+ > **Description**: Name of the definition.
8
+
9
+ > **Alternative Labels**: Name
10
+
11
+
12
+ ## **Summary**
13
+ > **Input Required**: False
14
+
15
+ > **Description**: Summary of the definition.
16
+
17
+
18
+ ## **Description**
19
+ > **Input Required**: False
20
+
21
+ > **Description**: Description of the contents of the definition.
22
+
23
+
24
+ ## **Domain Identifier**
25
+ > **Input Required**: False
26
+
27
+ > **Description**: Integer representing the governance domain. All domains is 0.
28
+
29
+ > **Default Value**: 0
30
+
31
+
32
+ ## **Document Identifier**
33
+ > **Input Required**: False
34
+
35
+ > **Description**: A user supplied identifier for the governance document.
36
+
37
+ > **Alternative Labels**: Doc Id
38
+
39
+
40
+ ## **Version Identifier**
41
+ > **Input Required**: False
42
+
43
+ > **Description**: Published version identifier.
44
+
45
+
46
+ ## **Scope**
47
+ > **Input Required**: False
48
+
49
+ > **Description**: Scope of the definition.
50
+
51
+
52
+ ## **Importance**
53
+ > **Input Required**: False
54
+
55
+ > **Description**: Importance of the definition.
56
+
57
+
58
+ ## **Implementation Description**
59
+ > **Input Required**: False
60
+
61
+ > **Description**: Describes how this governance control is implemented.
62
+
63
+ > **Alternative Labels**: Implementation
64
+
65
+
66
+ ## **Supports Policies**
67
+ > **Input Required**: False
68
+
69
+ > **Description**: The policies that this governance control supports.
70
+
71
+ > **Alternative Labels**: Policies Supported; Policy Supported
72
+
73
+
74
+ ## **Implications**
75
+ > **Input Required**: False
76
+
77
+ > **Description**: List of implications.
78
+
79
+
80
+ ## **Outcomes**
81
+ > **Input Required**: False
82
+
83
+ > **Description**: List of desired outcomes.
84
+
85
+
86
+ ## **Results**
87
+ > **Input Required**: False
88
+
89
+ > **Description**: A list of expected results.
90
+
91
+
92
+ ## **Status**
93
+ > **Input Required**: False
94
+
95
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
96
+
97
+ > **Alternative Labels**: Definition Status
98
+
99
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
100
+
101
+ > **Default Value**: DRAFT
102
+
103
+
104
+ ## **User Defined Status**
105
+ > **Input Required**: False
106
+
107
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
108
+
109
+
110
+ ## **Qualified Name**
111
+ > **Input Required**: False
112
+
113
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
114
+
115
+
116
+ ## **GUID**
117
+ > **Input Required**: False
118
+
119
+ > **Description**: A system generated unique identifier.
120
+
121
+ > **Alternative Labels**: Guid; guid
122
+
@@ -0,0 +1,106 @@
1
+ # **Create Governance Strategy**
2
+ > The strategy used in the development of the governance domains activities. How the governance domain supports the business strategy.
3
+
4
+ ## **Display Name**
5
+ > **Input Required**: True
6
+
7
+ > **Description**: Name of the definition.
8
+
9
+ > **Alternative Labels**: Name
10
+
11
+
12
+ ## **Summary**
13
+ > **Input Required**: False
14
+
15
+ > **Description**: Summary of the definition.
16
+
17
+
18
+ ## **Description**
19
+ > **Input Required**: False
20
+
21
+ > **Description**: Description of the contents of the definition.
22
+
23
+
24
+ ## **Domain Identifier**
25
+ > **Input Required**: False
26
+
27
+ > **Description**: Integer representing the governance domain. All domains is 0.
28
+
29
+ > **Default Value**: 0
30
+
31
+
32
+ ## **Document Identifier**
33
+ > **Input Required**: False
34
+
35
+ > **Description**: A user supplied identifier for the governance document.
36
+
37
+ > **Alternative Labels**: Doc Id
38
+
39
+
40
+ ## **Version Identifier**
41
+ > **Input Required**: False
42
+
43
+ > **Description**: Published version identifier.
44
+
45
+
46
+ ## **Scope**
47
+ > **Input Required**: False
48
+
49
+ > **Description**: Scope of the definition.
50
+
51
+
52
+ ## **Importance**
53
+ > **Input Required**: False
54
+
55
+ > **Description**: Importance of the definition.
56
+
57
+
58
+ ## **Business Imperatives**
59
+ > **Input Required**: False
60
+
61
+ > **Description**: List of imperitives.
62
+
63
+
64
+ ## **Outcomes**
65
+ > **Input Required**: False
66
+
67
+ > **Description**: List of desired outcomes.
68
+
69
+
70
+ ## **Results**
71
+ > **Input Required**: False
72
+
73
+ > **Description**: A list of expected results.
74
+
75
+
76
+ ## **Status**
77
+ > **Input Required**: False
78
+
79
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
80
+
81
+ > **Alternative Labels**: Definition Status
82
+
83
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
84
+
85
+ > **Default Value**: DRAFT
86
+
87
+
88
+ ## **User Defined Status**
89
+ > **Input Required**: False
90
+
91
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
92
+
93
+
94
+ ## **Qualified Name**
95
+ > **Input Required**: False
96
+
97
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
98
+
99
+
100
+ ## **GUID**
101
+ > **Input Required**: False
102
+
103
+ > **Description**: A system generated unique identifier.
104
+
105
+ > **Alternative Labels**: Guid; guid
106
+
@@ -0,0 +1,112 @@
1
+ # **Create License Type**
2
+ > A type of license.
3
+
4
+ ## **Display Name**
5
+ > **Input Required**: True
6
+
7
+ > **Description**: Name of the definition.
8
+
9
+ > **Alternative Labels**: Name
10
+
11
+
12
+ ## **Summary**
13
+ > **Input Required**: False
14
+
15
+ > **Description**: Summary of the definition.
16
+
17
+
18
+ ## **Description**
19
+ > **Input Required**: False
20
+
21
+ > **Description**: Description of the contents of the definition.
22
+
23
+
24
+ ## **Domain Identifier**
25
+ > **Input Required**: False
26
+
27
+ > **Description**: Integer representing the governance domain. All domains is 0.
28
+
29
+ > **Default Value**: 0
30
+
31
+
32
+ ## **Document Identifier**
33
+ > **Input Required**: False
34
+
35
+ > **Description**: A user supplied identifier for the governance document.
36
+
37
+ > **Alternative Labels**: Doc Id
38
+
39
+
40
+ ## **Version Identifier**
41
+ > **Input Required**: False
42
+
43
+ > **Description**: Published version identifier.
44
+
45
+
46
+ ## **Scope**
47
+ > **Input Required**: False
48
+
49
+ > **Description**: Scope of the definition.
50
+
51
+
52
+ ## **Importance**
53
+ > **Input Required**: False
54
+
55
+ > **Description**: Importance of the definition.
56
+
57
+
58
+ ## **Details**
59
+ > **Input Required**: False
60
+
61
+ > **Description**: Details of the license.
62
+
63
+
64
+ ## **Implications**
65
+ > **Input Required**: False
66
+
67
+ > **Description**: List of implications.
68
+
69
+
70
+ ## **Outcomes**
71
+ > **Input Required**: False
72
+
73
+ > **Description**: List of desired outcomes.
74
+
75
+
76
+ ## **Results**
77
+ > **Input Required**: False
78
+
79
+ > **Description**: A list of expected results.
80
+
81
+
82
+ ## **Status**
83
+ > **Input Required**: False
84
+
85
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
86
+
87
+ > **Alternative Labels**: Definition Status
88
+
89
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
90
+
91
+ > **Default Value**: DRAFT
92
+
93
+
94
+ ## **User Defined Status**
95
+ > **Input Required**: False
96
+
97
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
98
+
99
+
100
+ ## **Qualified Name**
101
+ > **Input Required**: False
102
+
103
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
104
+
105
+
106
+ ## **GUID**
107
+ > **Input Required**: False
108
+
109
+ > **Description**: A system generated unique identifier.
110
+
111
+ > **Alternative Labels**: Guid; guid
112
+
@@ -0,0 +1,122 @@
1
+ # **Create Naming Standard Rule**
2
+ > A standard for naming specific kinds of resources.
3
+
4
+ ## **Display Name**
5
+ > **Input Required**: True
6
+
7
+ > **Description**: Name of the definition.
8
+
9
+ > **Alternative Labels**: Name
10
+
11
+
12
+ ## **Summary**
13
+ > **Input Required**: False
14
+
15
+ > **Description**: Summary of the definition.
16
+
17
+
18
+ ## **Description**
19
+ > **Input Required**: False
20
+
21
+ > **Description**: Description of the contents of the definition.
22
+
23
+
24
+ ## **Domain Identifier**
25
+ > **Input Required**: False
26
+
27
+ > **Description**: Integer representing the governance domain. All domains is 0.
28
+
29
+ > **Default Value**: 0
30
+
31
+
32
+ ## **Document Identifier**
33
+ > **Input Required**: False
34
+
35
+ > **Description**: A user supplied identifier for the governance document.
36
+
37
+ > **Alternative Labels**: Doc Id
38
+
39
+
40
+ ## **Version Identifier**
41
+ > **Input Required**: False
42
+
43
+ > **Description**: Published version identifier.
44
+
45
+
46
+ ## **Scope**
47
+ > **Input Required**: False
48
+
49
+ > **Description**: Scope of the definition.
50
+
51
+
52
+ ## **Importance**
53
+ > **Input Required**: False
54
+
55
+ > **Description**: Importance of the definition.
56
+
57
+
58
+ ## **Implementation Description**
59
+ > **Input Required**: False
60
+
61
+ > **Description**: Describes how this governance control is implemnted.
62
+
63
+ > **Alternative Labels**: Implementation
64
+
65
+
66
+ ## **Supports Policies**
67
+ > **Input Required**: False
68
+
69
+ > **Description**: The policies that this governance control supports.
70
+
71
+ > **Alternative Labels**: Policies Supported; Policy Supported
72
+
73
+
74
+ ## **Name Patterns**
75
+ > **Input Required**: False
76
+
77
+ > **Description**: List of implications.
78
+
79
+
80
+ ## **Outcomes**
81
+ > **Input Required**: False
82
+
83
+ > **Description**: List of desired outcomes.
84
+
85
+
86
+ ## **Results**
87
+ > **Input Required**: False
88
+
89
+ > **Description**: A list of expected results.
90
+
91
+
92
+ ## **Status**
93
+ > **Input Required**: False
94
+
95
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
96
+
97
+ > **Alternative Labels**: Definition Status
98
+
99
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
100
+
101
+ > **Default Value**: DRAFT
102
+
103
+
104
+ ## **User Defined Status**
105
+ > **Input Required**: False
106
+
107
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
108
+
109
+
110
+ ## **Qualified Name**
111
+ > **Input Required**: False
112
+
113
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
114
+
115
+
116
+ ## **GUID**
117
+ > **Input Required**: False
118
+
119
+ > **Description**: A system generated unique identifier.
120
+
121
+ > **Alternative Labels**: Guid; guid
122
+
@@ -0,0 +1,106 @@
1
+ # **Create Regulation Article**
2
+ > A RegulationArticle entity is an article in a regulation. Dividing a regulation simplifies planning and execution.
3
+
4
+ ## **Display Name**
5
+ > **Input Required**: True
6
+
7
+ > **Description**: Name of the definition.
8
+
9
+ > **Alternative Labels**: Name
10
+
11
+
12
+ ## **Summary**
13
+ > **Input Required**: False
14
+
15
+ > **Description**: Summary of the definition.
16
+
17
+
18
+ ## **Description**
19
+ > **Input Required**: False
20
+
21
+ > **Description**: Description of the contents of the definition.
22
+
23
+
24
+ ## **Domain Identifier**
25
+ > **Input Required**: False
26
+
27
+ > **Description**: Integer representing the governance domain. All domains is 0.
28
+
29
+ > **Default Value**: 0
30
+
31
+
32
+ ## **Document Identifier**
33
+ > **Input Required**: False
34
+
35
+ > **Description**: A user supplied identifier for the governance document.
36
+
37
+ > **Alternative Labels**: Doc Id
38
+
39
+
40
+ ## **Version Identifier**
41
+ > **Input Required**: False
42
+
43
+ > **Description**: Published version identifier.
44
+
45
+
46
+ ## **Scope**
47
+ > **Input Required**: False
48
+
49
+ > **Description**: Scope of the definition.
50
+
51
+
52
+ ## **Importance**
53
+ > **Input Required**: False
54
+
55
+ > **Description**: Importance of the definition.
56
+
57
+
58
+ ## **Implications**
59
+ > **Input Required**: False
60
+
61
+ > **Description**: List of implications.
62
+
63
+
64
+ ## **Outcomes**
65
+ > **Input Required**: False
66
+
67
+ > **Description**: List of desired outcomes.
68
+
69
+
70
+ ## **Results**
71
+ > **Input Required**: False
72
+
73
+ > **Description**: A list of expected results.
74
+
75
+
76
+ ## **Status**
77
+ > **Input Required**: False
78
+
79
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
80
+
81
+ > **Alternative Labels**: Definition Status
82
+
83
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
84
+
85
+ > **Default Value**: DRAFT
86
+
87
+
88
+ ## **User Defined Status**
89
+ > **Input Required**: False
90
+
91
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
92
+
93
+
94
+ ## **Qualified Name**
95
+ > **Input Required**: False
96
+
97
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
98
+
99
+
100
+ ## **GUID**
101
+ > **Input Required**: False
102
+
103
+ > **Description**: A system generated unique identifier.
104
+
105
+ > **Alternative Labels**: Guid; guid
106
+
@@ -0,0 +1,118 @@
1
+ # **Create Regulation Definition**
2
+ > Defines a relevant legal regulation that the business operation must comply with. Often regulations are divided into regulation articles.
3
+
4
+ ## **Display Name**
5
+ > **Input Required**: True
6
+
7
+ > **Description**: Name of the definition.
8
+
9
+ > **Alternative Labels**: Name
10
+
11
+
12
+ ## **Summary**
13
+ > **Input Required**: False
14
+
15
+ > **Description**: Summary of the definition.
16
+
17
+
18
+ ## **Description**
19
+ > **Input Required**: False
20
+
21
+ > **Description**: Description of the contents of the definition.
22
+
23
+
24
+ ## **Domain Identifier**
25
+ > **Input Required**: False
26
+
27
+ > **Description**: Integer representing the governance domain. All domains is 0.
28
+
29
+ > **Default Value**: 0
30
+
31
+
32
+ ## **Document Identifier**
33
+ > **Input Required**: False
34
+
35
+ > **Description**: A user supplied identifier for the governance document.
36
+
37
+ > **Alternative Labels**: Doc Id
38
+
39
+
40
+ ## **Version Identifier**
41
+ > **Input Required**: False
42
+
43
+ > **Description**: Published version identifier.
44
+
45
+
46
+ ## **Scope**
47
+ > **Input Required**: False
48
+
49
+ > **Description**: Scope of the definition.
50
+
51
+
52
+ ## **Importance**
53
+ > **Input Required**: False
54
+
55
+ > **Description**: Importance of the definition.
56
+
57
+
58
+ ## **Source**
59
+ > **Input Required**: False
60
+
61
+ > **Description**: The source of the regulator.
62
+
63
+
64
+ ## **Regulators**
65
+ > **Input Required**: False
66
+
67
+ > **Description**: The regulatory authorities responsible for monitoring compliance to regulations.
68
+
69
+
70
+ ## **Implications**
71
+ > **Input Required**: False
72
+
73
+ > **Description**: List of implications.
74
+
75
+
76
+ ## **Outcomes**
77
+ > **Input Required**: False
78
+
79
+ > **Description**: List of desired outcomes.
80
+
81
+
82
+ ## **Results**
83
+ > **Input Required**: False
84
+
85
+ > **Description**: A list of expected results.
86
+
87
+
88
+ ## **Status**
89
+ > **Input Required**: False
90
+
91
+ > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
92
+
93
+ > **Alternative Labels**: Definition Status
94
+
95
+ > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
96
+
97
+ > **Default Value**: DRAFT
98
+
99
+
100
+ ## **User Defined Status**
101
+ > **Input Required**: False
102
+
103
+ > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
104
+
105
+
106
+ ## **Qualified Name**
107
+ > **Input Required**: False
108
+
109
+ > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
110
+
111
+
112
+ ## **GUID**
113
+ > **Input Required**: False
114
+
115
+ > **Description**: A system generated unique identifier.
116
+
117
+ > **Alternative Labels**: Guid; guid
118
+