pyegeria 5.4.3.3__py3-none-any.whl → 5.4.4__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 (230) hide show
  1. commands/cat/debug_log.2025-09-02_07-44-39_567276.log.zip +0 -0
  2. commands/cat/debug_log.2025-09-03_07-45-21_986388.log.zip +0 -0
  3. commands/cat/debug_log.2025-09-04_08-21-58_788009.log.zip +0 -0
  4. commands/cat/debug_log.2025-09-05_09-37-53_062579.log.zip +0 -0
  5. commands/cat/list_format_set.py +5 -3
  6. commands/tech/list_information_supply_chains.py +1 -1
  7. commands/tech/list_solution_blueprints.py +1 -1
  8. commands/tech/list_solution_components.py +1 -1
  9. commands/tech/list_solution_roles.py +1 -1
  10. md_processing/__init__.py +9 -5
  11. md_processing/data/commands.json +7182 -1401
  12. md_processing/data/generated_format_sets.json +4137 -0
  13. md_processing/data/generated_format_sets.py +51 -0
  14. md_processing/dr_egeria.py +20 -11
  15. md_processing/md_commands/data_designer_commands.py +90 -425
  16. md_processing/md_commands/ext_ref_commands.py +543 -0
  17. md_processing/md_commands/old_solution_architect_commands.py +1139 -0
  18. md_processing/md_commands/solution_architect_commands.py +26 -59
  19. md_processing/md_processing_utils/common_md_utils.py +50 -1
  20. md_processing/md_processing_utils/debug_log +1 -3
  21. md_processing/md_processing_utils/dr-egeria-help-2025-09-09T11:10:03.md +3305 -0
  22. md_processing/md_processing_utils/extraction_utils.py +14 -7
  23. md_processing/md_processing_utils/gen_format_sets.py +422 -0
  24. md_processing/md_processing_utils/md_processing_constants.py +20 -2
  25. pyegeria/__init__.py +1 -1
  26. pyegeria/_client_new.py +9 -7
  27. pyegeria/_output_formats.py +278 -3
  28. pyegeria/collection_manager.py +20 -59
  29. pyegeria/config.py +10 -1
  30. pyegeria/data_designer.py +166 -117
  31. pyegeria/egeria_client.py +1 -1
  32. pyegeria/egeria_tech_client.py +4 -1
  33. pyegeria/external_references.py +1794 -0
  34. pyegeria/glossary_manager.py +71 -85
  35. pyegeria/governance_officer.py +26 -29
  36. pyegeria/output_formatter.py +127 -1
  37. pyegeria/project_manager.py +33 -36
  38. pyegeria/{solution_architect_omvs.py → solution_architect.py} +733 -873
  39. {pyegeria-5.4.3.3.dist-info → pyegeria-5.4.4.dist-info}/METADATA +1 -1
  40. {pyegeria-5.4.3.3.dist-info → pyegeria-5.4.4.dist-info}/RECORD +43 -219
  41. commands/.DS_Store +0 -0
  42. commands/cat/.DS_Store +0 -0
  43. commands/cat/.env +0 -8
  44. commands/cat/debug_log.2025-08-29_07-07-27_848189.log.zip +0 -0
  45. commands/cat/debug_log.2025-08-30_21-15-48_528443.log.zip +0 -0
  46. commands/cat/debug_log.log +0 -6102
  47. commands/cat/logs/pyegeria.log +0 -90
  48. commands/cli/debug_log.log +0 -0
  49. commands/doc/.DS_Store +0 -0
  50. commands/ops/logs/pyegeria.log +0 -0
  51. md_processing/.DS_Store +0 -0
  52. md_processing/.idea/.gitignore +0 -8
  53. md_processing/.idea/inspectionProfiles/Project_Default.xml +0 -59
  54. md_processing/.idea/md_processing.iml +0 -15
  55. md_processing/.idea/modules.xml +0 -8
  56. md_processing/.idea/sonarlint/issuestore/index.pb +0 -0
  57. md_processing/.idea/sonarlint/securityhotspotstore/index.pb +0 -0
  58. md_processing/.idea/vcs.xml +0 -6
  59. md_processing/.idea/workspace.xml +0 -107
  60. md_processing/dr_egeria_inbox/Derive-Dr-Gov-Defs.md +0 -8
  61. md_processing/dr_egeria_inbox/Dr.Egeria Templates.md +0 -873
  62. md_processing/dr_egeria_inbox/arch_test.md +0 -57
  63. md_processing/dr_egeria_inbox/archive/dr_egeria_intro.md +0 -254
  64. md_processing/dr_egeria_inbox/archive/dr_egeria_intro_more_terms.md +0 -696
  65. md_processing/dr_egeria_inbox/archive/dr_egeria_intro_part1.md +0 -254
  66. md_processing/dr_egeria_inbox/archive/dr_egeria_intro_part2.md +0 -298
  67. md_processing/dr_egeria_inbox/archive/dr_egeria_intro_part3.md +0 -608
  68. md_processing/dr_egeria_inbox/archive/dr_egeria_intro_part4.md +0 -94
  69. md_processing/dr_egeria_inbox/archive/freddie_intro.md +0 -284
  70. md_processing/dr_egeria_inbox/archive/freddie_intro_orig.md +0 -275
  71. md_processing/dr_egeria_inbox/archive/test-term.md +0 -110
  72. md_processing/dr_egeria_inbox/cat_test.md +0 -100
  73. md_processing/dr_egeria_inbox/collections.md +0 -39
  74. md_processing/dr_egeria_inbox/data_designer_debug.log +0 -6
  75. md_processing/dr_egeria_inbox/data_designer_out.md +0 -60
  76. md_processing/dr_egeria_inbox/data_designer_search_test.md +0 -11
  77. md_processing/dr_egeria_inbox/data_field.md +0 -54
  78. md_processing/dr_egeria_inbox/data_spec.md +0 -77
  79. md_processing/dr_egeria_inbox/data_spec_test.md +0 -2340
  80. md_processing/dr_egeria_inbox/data_test.md +0 -179
  81. md_processing/dr_egeria_inbox/data_test2.md +0 -429
  82. md_processing/dr_egeria_inbox/data_test3.md +0 -462
  83. md_processing/dr_egeria_inbox/dr_egeria_data_designer_1.md +0 -124
  84. md_processing/dr_egeria_inbox/dr_egeria_intro_categories.md +0 -168
  85. md_processing/dr_egeria_inbox/dr_egeria_intro_part1.md +0 -280
  86. md_processing/dr_egeria_inbox/dr_egeria_intro_part2.md +0 -318
  87. md_processing/dr_egeria_inbox/dr_egeria_intro_part3.md +0 -1073
  88. md_processing/dr_egeria_inbox/dr_egeria_isc1.md +0 -44
  89. md_processing/dr_egeria_inbox/generated_help_report.md +0 -9
  90. md_processing/dr_egeria_inbox/generated_help_terms.md +0 -842
  91. md_processing/dr_egeria_inbox/glossary_list.md +0 -5
  92. md_processing/dr_egeria_inbox/glossary_search_test.md +0 -40
  93. md_processing/dr_egeria_inbox/glossary_test1.md +0 -378
  94. md_processing/dr_egeria_inbox/gov_def.md +0 -718
  95. md_processing/dr_egeria_inbox/gov_def2.md +0 -447
  96. md_processing/dr_egeria_inbox/img.png +0 -0
  97. md_processing/dr_egeria_inbox/output_tests.md +0 -114
  98. md_processing/dr_egeria_inbox/product.md +0 -211
  99. md_processing/dr_egeria_inbox/rel.md +0 -8
  100. md_processing/dr_egeria_inbox/sb.md +0 -119
  101. md_processing/dr_egeria_inbox/solution-components.md +0 -136
  102. md_processing/dr_egeria_inbox/solution_blueprints.md +0 -118
  103. md_processing/dr_egeria_inbox/synonym_test.md +0 -42
  104. md_processing/dr_egeria_inbox/t2.md +0 -268
  105. md_processing/dr_egeria_outbox/.DS_Store +0 -0
  106. md_processing/dr_egeria_outbox/.obsidian/app.json +0 -1
  107. md_processing/dr_egeria_outbox/.obsidian/appearance.json +0 -1
  108. md_processing/dr_egeria_outbox/.obsidian/community-plugins.json +0 -7
  109. md_processing/dr_egeria_outbox/.obsidian/core-plugins.json +0 -33
  110. md_processing/dr_egeria_outbox/.obsidian/plugins/buttons/main.js +0 -5164
  111. md_processing/dr_egeria_outbox/.obsidian/plugins/buttons/manifest.json +0 -10
  112. md_processing/dr_egeria_outbox/.obsidian/plugins/buttons/styles.css +0 -624
  113. md_processing/dr_egeria_outbox/.obsidian/plugins/calendar/data.json +0 -10
  114. md_processing/dr_egeria_outbox/.obsidian/plugins/calendar/main.js +0 -4459
  115. md_processing/dr_egeria_outbox/.obsidian/plugins/calendar/manifest.json +0 -10
  116. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-kanban/data.json +0 -3
  117. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-kanban/main.js +0 -153
  118. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-kanban/manifest.json +0 -11
  119. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-kanban/styles.css +0 -1
  120. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-tasks-plugin/main.js +0 -500
  121. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-tasks-plugin/manifest.json +0 -12
  122. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-tasks-plugin/styles.css +0 -1
  123. md_processing/dr_egeria_outbox/.obsidian/plugins/templater-obsidian/data.json +0 -38
  124. md_processing/dr_egeria_outbox/.obsidian/plugins/templater-obsidian/main.js +0 -37
  125. md_processing/dr_egeria_outbox/.obsidian/plugins/templater-obsidian/manifest.json +0 -11
  126. md_processing/dr_egeria_outbox/.obsidian/plugins/templater-obsidian/styles.css +0 -220
  127. md_processing/dr_egeria_outbox/.obsidian/types.json +0 -28
  128. md_processing/dr_egeria_outbox/.obsidian/workspace.json +0 -270
  129. md_processing/dr_egeria_outbox/Button Test.md +0 -11
  130. md_processing/dr_egeria_outbox/Scripts/.DS_Store +0 -0
  131. md_processing/dr_egeria_outbox/Scripts/sendRest.js +0 -24
  132. md_processing/dr_egeria_outbox/Templates/sendToApi.md.md +0 -17
  133. md_processing/dr_egeria_outbox/Untitled.canvas +0 -1
  134. md_processing/dr_egeria_outbox/monday/processed-2025-09-01 09:26-product.md +0 -210
  135. md_processing/dr_egeria_outbox/monday/processed-2025-09-01 14:03-product.md +0 -209
  136. md_processing/dr_egeria_outbox/monday/processed-2025-09-01 14:24-product.md +0 -263
  137. md_processing/dr_egeria_outbox/monday/processed-2025-09-01 16:03-data_spec_test.md +0 -2374
  138. md_processing/dr_egeria_outbox/monday/processed-2025-09-01 16:05-data_spec_test.md +0 -2374
  139. md_processing/dr_egeria_outbox/monday/processed-2025-09-02 08:28-data_spec_test.md +0 -2321
  140. md_processing/dr_egeria_outbox/monday/processed-2025-09-02 08:37-data_spec_test.md +0 -2304
  141. md_processing/dr_egeria_outbox/monday/processed-2025-09-02 08:56-data_spec_test.md +0 -2324
  142. md_processing/dr_egeria_outbox/monday/processed-2025-09-02 09:00-data_spec_test.md +0 -2324
  143. md_processing/dr_egeria_outbox/processed-2025-08-30 16:56-generated_help_terms.md +0 -795
  144. md_processing/dr_egeria_outbox/thursday/processed-2025-07-17 15:00-Derive-Dr-Gov-Defs.md +0 -719
  145. md_processing/dr_egeria_outbox/thursday/processed-2025-07-17 20:13-Derive-Dr-Gov-Defs.md +0 -41
  146. md_processing/dr_egeria_outbox/thursday/processed-2025-07-17 20:14-Derive-Dr-Gov-Defs.md +0 -33
  147. md_processing/dr_egeria_outbox/thursday/processed-2025-07-17 20:50-Derive-Dr-Gov-Defs.md +0 -192
  148. md_processing/dr_egeria_outbox/thursday/processed-2025-07-17 22:08-gov_def2.md +0 -486
  149. md_processing/dr_egeria_outbox/thursday/processed-2025-07-17 22:10-gov_def2.md +0 -486
  150. md_processing/dr_egeria_outbox/thursday/processed-2025-07-18 08:53-gov_def2.md +0 -486
  151. md_processing/dr_egeria_outbox/thursday/processed-2025-07-18 08:54-gov_def2.md +0 -486
  152. md_processing/dr_egeria_outbox/thursday/processed-2025-07-18 09:03-gov_def2.md +0 -486
  153. md_processing/dr_egeria_outbox/thursday/processed-2025-07-18 09:06-gov_def2.md +0 -486
  154. md_processing/dr_egeria_outbox/thursday/processed-2025-07-18 09:10-gov_def2.md +0 -486
  155. md_processing/dr_egeria_outbox/tuesday/processed-2025-09-02 13:07-gov_def.md +0 -492
  156. md_processing/dr_egeria_outbox/tuesday/processed-2025-09-02 13:25-gov_def.md +0 -520
  157. md_processing/dr_egeria_outbox/tuesday/processed-2025-09-02 16:43-gov_def.md +0 -636
  158. md_processing/dr_egeria_outbox/tuesday/processed-2025-09-02 16:46-gov_def.md +0 -636
  159. md_processing/family_docs/Data Designer/Create_Data_Class.md +0 -164
  160. md_processing/family_docs/Data Designer/Create_Data_Dictionary.md +0 -30
  161. md_processing/family_docs/Data Designer/Create_Data_Field.md +0 -162
  162. md_processing/family_docs/Data Designer/Create_Data_Specification.md +0 -36
  163. md_processing/family_docs/Data Designer/Create_Data_Structure.md +0 -38
  164. md_processing/family_docs/Data Designer/View_Data_Classes.md +0 -78
  165. md_processing/family_docs/Data Designer/View_Data_Dictionaries.md +0 -78
  166. md_processing/family_docs/Data Designer/View_Data_Fields.md +0 -78
  167. md_processing/family_docs/Data Designer/View_Data_Specifications.md +0 -78
  168. md_processing/family_docs/Data Designer/View_Data_Structures.md +0 -78
  169. md_processing/family_docs/Data Designer.md +0 -842
  170. md_processing/family_docs/Digital Product Manager/Add_Member->Collection.md +0 -42
  171. md_processing/family_docs/Digital Product Manager/Attach_Collection->Resource.md +0 -36
  172. md_processing/family_docs/Digital Product Manager/Create_Agreement.md +0 -96
  173. md_processing/family_docs/Digital Product Manager/Create_Data_Sharing_Agreement.md +0 -72
  174. md_processing/family_docs/Digital Product Manager/Create_DigitalSubscription.md +0 -102
  175. md_processing/family_docs/Digital Product Manager/Create_Digital_Product.md +0 -134
  176. md_processing/family_docs/Digital Product Manager/Link_Agreement_Items.md +0 -60
  177. md_processing/family_docs/Digital Product Manager/Link_Contracts.md +0 -26
  178. md_processing/family_docs/Digital Product Manager/Link_Digital_Product_-_Digital_Product.md +0 -30
  179. md_processing/family_docs/Digital Product Manager/Link_Subscribers.md +0 -48
  180. md_processing/family_docs/Digital Product Manager.md +0 -668
  181. md_processing/family_docs/Glossary/Attach_Category_Parent.md +0 -18
  182. md_processing/family_docs/Glossary/Attach_Term-Term_Relationship.md +0 -26
  183. md_processing/family_docs/Glossary/Create_Category.md +0 -38
  184. md_processing/family_docs/Glossary/Create_Glossary.md +0 -42
  185. md_processing/family_docs/Glossary/Create_Term.md +0 -70
  186. md_processing/family_docs/Glossary.md +0 -206
  187. md_processing/family_docs/Governance Officer/Create_Business_Imperative.md +0 -106
  188. md_processing/family_docs/Governance Officer/Create_Certification_Type.md +0 -112
  189. md_processing/family_docs/Governance Officer/Create_Governance_Approach.md +0 -114
  190. md_processing/family_docs/Governance Officer/Create_Governance_Obligation.md +0 -114
  191. md_processing/family_docs/Governance Officer/Create_Governance_Principle.md +0 -114
  192. md_processing/family_docs/Governance Officer/Create_Governance_Procedure.md +0 -128
  193. md_processing/family_docs/Governance Officer/Create_Governance_Process.md +0 -122
  194. md_processing/family_docs/Governance Officer/Create_Governance_Processing_Purpose.md +0 -106
  195. md_processing/family_docs/Governance Officer/Create_Governance_Responsibility.md +0 -122
  196. md_processing/family_docs/Governance Officer/Create_Governance_Rule.md +0 -122
  197. md_processing/family_docs/Governance Officer/Create_Governance_Strategy.md +0 -106
  198. md_processing/family_docs/Governance Officer/Create_License_Type.md +0 -112
  199. md_processing/family_docs/Governance Officer/Create_Naming_Standard_Rule.md +0 -122
  200. md_processing/family_docs/Governance Officer/Create_Regulation_Article.md +0 -106
  201. md_processing/family_docs/Governance Officer/Create_Regulation_Definition.md +0 -118
  202. md_processing/family_docs/Governance Officer/Create_Security_Access_Control.md +0 -114
  203. md_processing/family_docs/Governance Officer/Create_Security_Group.md +0 -120
  204. md_processing/family_docs/Governance Officer/Create_Service_Level_Objectives.md +0 -122
  205. md_processing/family_docs/Governance Officer/Create_Threat_Definition.md +0 -106
  206. md_processing/family_docs/Governance Officer/Link_Governance_Controls.md +0 -32
  207. md_processing/family_docs/Governance Officer/Link_Governance_Drivers.md +0 -32
  208. md_processing/family_docs/Governance Officer/Link_Governance_Policies.md +0 -32
  209. md_processing/family_docs/Governance Officer/View_Governance_Definitions.md +0 -82
  210. md_processing/family_docs/Governance Officer.md +0 -2412
  211. md_processing/family_docs/Solution Architect/Create_Information_Supply_Chain.md +0 -70
  212. md_processing/family_docs/Solution Architect/Create_Solution_Blueprint.md +0 -44
  213. md_processing/family_docs/Solution Architect/Create_Solution_Component.md +0 -96
  214. md_processing/family_docs/Solution Architect/Create_Solution_Role.md +0 -66
  215. md_processing/family_docs/Solution Architect/Link_Information_Supply_Chain_Peers.md +0 -32
  216. md_processing/family_docs/Solution Architect/Link_Solution_Component_Peers.md +0 -32
  217. md_processing/family_docs/Solution Architect/View_Information_Supply_Chains.md +0 -32
  218. md_processing/family_docs/Solution Architect/View_Solution_Blueprints.md +0 -32
  219. md_processing/family_docs/Solution Architect/View_Solution_Components.md +0 -32
  220. md_processing/family_docs/Solution Architect/View_Solution_Roles.md +0 -32
  221. md_processing/family_docs/Solution Architect.md +0 -490
  222. md_processing/md_commands/old_project_commands.py +0 -164
  223. md_processing/md_processing_utils/debug_log.log +0 -5580
  224. md_processing/md_processing_utils/generated_help_terms.md +0 -842
  225. md_processing/md_processing_utils/logs/pyegeria.log +0 -56
  226. pyegeria/.DS_Store +0 -0
  227. pyegeria/___external_references.py +0 -3267
  228. {pyegeria-5.4.3.3.dist-info → pyegeria-5.4.4.dist-info}/LICENSE +0 -0
  229. {pyegeria-5.4.3.3.dist-info → pyegeria-5.4.4.dist-info}/WHEEL +0 -0
  230. {pyegeria-5.4.3.3.dist-info → pyegeria-5.4.4.dist-info}/entry_points.txt +0 -0
@@ -1,668 +0,0 @@
1
-
2
- # Family: Digital Product Manager
3
-
4
- ## **Add Member->Collection**
5
- > Add a member to a collection.
6
- ### **Element_Id**
7
- > **Input Required**: True
8
-
9
- > **Description**: The name of the element to add to the collection.
10
-
11
- > **Alternative Labels**: member_id
12
-
13
-
14
- ### **Collection Id**
15
- > **Input Required**: True
16
-
17
- > **Description**: The name of the collection to link to. There are many collection types, including Digital Products, Agreements and Subscriptions.
18
-
19
- > **Alternative Labels**: Collection Id; Agreement Id; Subscription Id; Digital Product Id
20
-
21
-
22
- ### **Membership Rationale**
23
- > **Input Required**: False
24
-
25
- > **Description**: Rationale for membership.
26
-
27
- > **Alternative Labels**: Rationale
28
-
29
-
30
- ### **Created By**
31
- > **Input Required**: False
32
-
33
- > **Description**: Who added the member. (currently informal string)
34
-
35
-
36
- ### **Membership Status**
37
- > **Input Required**: False
38
-
39
- > **Description**: The status of adding a member to a collection.
40
-
41
- > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
42
-
43
- > **Default Value**: APPROVED
44
-
45
-
46
- ___
47
-
48
- ## **Attach Collection->Resource**
49
- > Connect an existing collection to an element using the ResourceList relationship.
50
- ### **Collection**
51
- > **Input Required**: True
52
-
53
- > **Description**: An element of base type collection (e.g. collection, agreement; subscription, ...)
54
-
55
- > **Alternative Labels**: Collection Id; Agreement Id; Subscription Id
56
-
57
-
58
- ### **Resource**
59
- > **Input Required**: True
60
-
61
- > **Description**: The name of the resource to attach to.
62
-
63
-
64
- ### **Resource Use**
65
- > **Input Required**: False
66
-
67
- > **Description**: Describes the relationship between the resource and the collection.
68
-
69
-
70
- ### **Resource Description**
71
- > **Input Required**: False
72
-
73
- > **Description**: A description of the resource being attached.
74
-
75
- > **Alternative Labels**: Description
76
-
77
-
78
- ### **Resource Use Properties**
79
- > **Input Required**: False
80
-
81
- > **Description**: A dictionary of name:value pairs describing properties of the resource use.
82
-
83
-
84
- ___
85
-
86
- ## **Create Agreement**
87
- > A kind of collection that represents an Agreement. This is for generic agreements. Specific kinds of agreements have their own commands.
88
- ### **Display Name**
89
- > **Input Required**: True
90
-
91
- > **Description**: Name of the agreement.
92
-
93
- > **Alternative Labels**: Name
94
-
95
-
96
- ### **Description**
97
- > **Input Required**: False
98
-
99
- > **Description**: Description of the contents of the agreement.
100
-
101
-
102
- ### **Agreement Identifier**
103
- > **Input Required**: False
104
-
105
- > **Description**: A user specified agreement identifier.
106
-
107
-
108
- ### **Agreement Status**
109
- > **Input Required**: False
110
-
111
- > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
112
-
113
- > **Alternative Labels**: Initial Status
114
-
115
- > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
116
-
117
- > **Default Value**: DRAFT
118
-
119
-
120
- ### **User Defined Status**
121
- > **Input Required**: False
122
-
123
- > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
124
-
125
-
126
- ### **Version Identifier**
127
- > **Input Required**: False
128
-
129
- > **Description**: Published agreement version identifier.
130
-
131
-
132
- ### **Agreement Actors**
133
- > **Input Required**: False
134
-
135
- > **Description**: A list of actors with responsibilities for the agreement.
136
-
137
-
138
- ### **Restrictions**
139
- > **Input Required**: False
140
-
141
- > **Description**: A dictionary of property:value pairs describing restrictions.
142
-
143
-
144
- ### **Obligations**
145
- > **Input Required**: False
146
-
147
- > **Description**: A dictionary of property:value pairs describing obligations.
148
-
149
-
150
- ### **Entitlements**
151
- > **Input Required**: False
152
-
153
- > **Description**: A dictionary of property:value pairs describing entitlements.
154
-
155
-
156
- ### **Usage Measurements**
157
- > **Input Required**: False
158
-
159
- > **Description**: A dictionary of property:value pairs describing usage measurements.
160
-
161
-
162
- ### **Product Metrics**
163
- > **Input Required**: False
164
-
165
- > **Description**: A dictionary of property:value pairs describing metrics for the product/.
166
-
167
-
168
- ### **Qualified Name**
169
- > **Input Required**: False
170
-
171
- > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
172
-
173
-
174
- ### **GUID**
175
- > **Input Required**: False
176
-
177
- > **Description**: A system generated unique identifier.
178
-
179
- > **Alternative Labels**: Guid; guid
180
-
181
-
182
- ___
183
-
184
- ## **Create Data Sharing Agreement**
185
- > Create a new collection with the DataSharingAgreement classification.
186
- ### **Display Name**
187
- > **Input Required**: True
188
-
189
- > **Description**: Name of the agreement.
190
-
191
- > **Alternative Labels**: Name
192
-
193
-
194
- ### **Description**
195
- > **Input Required**: False
196
-
197
- > **Description**: Description of the contents of the agreement.
198
-
199
-
200
- ### **Identifier**
201
- > **Input Required**: False
202
-
203
- > **Description**: A user specified agreement identifier.
204
-
205
-
206
- ### **Agreement Status**
207
- > **Input Required**: False
208
-
209
- > **Description**: The status of the digital product. There is a list of valid values that this conforms to.
210
-
211
- > **Alternative Labels**: Status
212
-
213
- > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
214
-
215
- > **Default Value**: DRAFT
216
-
217
-
218
- ### **User_Defined_Status**
219
- > **Input Required**: False
220
-
221
- > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
222
-
223
-
224
- ### **Version Identifier**
225
- > **Input Required**: False
226
-
227
- > **Description**: Published agreement version identifier.
228
-
229
-
230
- ### **Product Manager**
231
- > **Input Required**: False
232
-
233
- > **Description**: An actor responsible for managing this product. Actors may be individuals, automations, etc.
234
-
235
-
236
- ### **Digital Subscriptions**
237
- > **Input Required**: False
238
-
239
- > **Description**:
240
-
241
-
242
- ### **Qualified Name**
243
- > **Input Required**: False
244
-
245
- > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
246
-
247
-
248
- ### **GUID**
249
- > **Input Required**: False
250
-
251
- > **Description**: A system generated unique identifier.
252
-
253
- > **Alternative Labels**: Guid; guid
254
-
255
-
256
- ___
257
-
258
- ## **Create Digital Product**
259
- > A Data Dictionary is an organized and curated collection of data definitions that can serve as a reference for data professionals
260
- ### **Display Name**
261
- > **Input Required**: True
262
-
263
- > **Description**: Name of the digital product
264
-
265
- > **Alternative Labels**: Name
266
-
267
-
268
- ### **Description**
269
- > **Input Required**: False
270
-
271
- > **Description**: Description of the contents of a product.
272
-
273
-
274
- ### **Product Name**
275
- > **Input Required**: False
276
-
277
- > **Description**: The external name of the digital product.
278
-
279
-
280
- ### **Product Status**
281
- > **Input Required**: False
282
-
283
- > **Description**: The status of the digital product. There is a list of valid values that this conforms to.
284
-
285
- > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; APPROVED_CONCEPT; UNDER_DEVELOPMENT; DEVELOPMENT_COMPLETE; APPROVED_FOR_DEPLOYMENT; ACTIVE; DISABLED; DEPRECATED; OTHER
286
-
287
- > **Default Value**: DRAFT
288
-
289
-
290
- ### **User Defined Status**
291
- > **Input Required**: False
292
-
293
- > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
294
-
295
-
296
- ### **Product Type**
297
- > **Input Required**: False
298
-
299
- > **Description**: Type of product - periodic, delta, snapshot, etc
300
-
301
-
302
- ### **Product Identifier**
303
- > **Input Required**: False
304
-
305
- > **Description**: User specified product identifier.
306
-
307
-
308
- ### **Product Description**
309
- > **Input Required**: False
310
-
311
- > **Description**: Externally facing description of the product and its intended usage.
312
-
313
-
314
- ### **Maturity**
315
- > **Input Required**: False
316
-
317
- > **Description**: Product maturity - user defined.
318
-
319
-
320
- ### **Service Life**
321
- > **Input Required**: False
322
-
323
- > **Description**: Estimated service lifetime of the product.
324
-
325
-
326
- ### **Introduction Date**
327
- > **Input Required**: False
328
-
329
- > **Description**: Date of product introduction in ISO 8601 format. Either all of the dates (introduction, next version, withdrawal) dates need to be supplied or none of them. Otherwise an error will occur.
330
-
331
-
332
- ### **Next Version Date**
333
- > **Input Required**: False
334
-
335
- > **Description**: Date of the next version, in ISO 8601 format. Either all of the dates (introduction, next version, withdrawal) dates need to be supplied or none of them. Otherwise an error will occur.
336
-
337
-
338
- ### **Withdrawal Date**
339
- > **Input Required**: False
340
-
341
- > **Description**: Date of planned product withdrawal in ISO 8601 format. Either all of the dates (introduction, next version, withdrawal) dates need to be supplied or none of them. Otherwise an error will occur.
342
-
343
-
344
- ### **Collection Type**
345
- > **Input Required**: False
346
-
347
- > **Description**: A user supplied collection type. Defaults to Digital Product.
348
-
349
- > **Default Value**: Digital Product
350
-
351
-
352
- ### **Current Version**
353
- > **Input Required**: False
354
-
355
- > **Description**: Published product version identifier.
356
-
357
- > **Default Value**: 1.0
358
-
359
-
360
- ### **Product Manager**
361
- > **Input Required**: False
362
-
363
- > **Description**: Actors responsible for managing this product. Actors may be individuals, automations, etc.
364
-
365
-
366
- ### **Agreements**
367
- > **Input Required**: False
368
-
369
- > **Description**: A list of agreements associated with this product. The agreements must already exist.
370
-
371
-
372
- ### **Digital Subscriptions**
373
- > **Input Required**: False
374
-
375
- > **Description**:
376
-
377
-
378
- ### **Qualified Name**
379
- > **Input Required**: False
380
-
381
- > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
382
-
383
-
384
- ### **GUID**
385
- > **Input Required**: False
386
-
387
- > **Description**: A system generated unique identifier.
388
-
389
- > **Alternative Labels**: Guid; guid
390
-
391
-
392
- ___
393
-
394
- ## **Create DigitalSubscription**
395
- > A type of agreement for a digital subscription.
396
- ### **Display Name**
397
- > **Input Required**: True
398
-
399
- > **Description**: Name of the agreement.
400
-
401
- > **Alternative Labels**: Name
402
-
403
-
404
- ### **Description**
405
- > **Input Required**: False
406
-
407
- > **Description**: Description of the contents of the agreement.
408
-
409
-
410
- ### **Identifier**
411
- > **Input Required**: False
412
-
413
- > **Description**: A user specified agreement identifier.
414
-
415
-
416
- ### **Product Status**
417
- > **Input Required**: False
418
-
419
- > **Description**: The status of the digital product. There is a list of valid values that this conforms to.
420
-
421
- > **Alternative Labels**: Initial Status
422
-
423
- > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
424
-
425
- > **Default Value**: DRAFT
426
-
427
-
428
- ### **User_Defined_Status**
429
- > **Input Required**: False
430
-
431
- > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
432
-
433
-
434
- ### **Support Level**
435
- > **Input Required**: False
436
-
437
- > **Description**: Level of support agreed or requested.
438
-
439
-
440
- ### **Service Levels**
441
- > **Input Required**: False
442
-
443
- > **Description**: A dictionary of name:value pairs describing the service levels.
444
-
445
-
446
- ### **Restrictions**
447
- > **Input Required**: False
448
-
449
- > **Description**: A dictionary of property:value pairs describing restrictions.
450
-
451
-
452
- ### **Obligations**
453
- > **Input Required**: False
454
-
455
- > **Description**: A dictionary of property:value pairs describing obligations.
456
-
457
-
458
- ### **Entitlements**
459
- > **Input Required**: False
460
-
461
- > **Description**: A dictionary of property:value pairs describing entitlements.
462
-
463
-
464
- ### **Usage Measurements**
465
- > **Input Required**: False
466
-
467
- > **Description**: A dictionary of property:value pairs describing usage measurements.
468
-
469
-
470
- ### **Product Metrics**
471
- > **Input Required**: False
472
-
473
- > **Description**: A dictionary of property:value pairs describing metrics for the product/.
474
-
475
-
476
- ### **Version Identifier**
477
- > **Input Required**: False
478
-
479
- > **Description**: Published agreement version identifier.
480
-
481
-
482
- ### **Qualified Name**
483
- > **Input Required**: False
484
-
485
- > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
486
-
487
-
488
- ### **GUID**
489
- > **Input Required**: False
490
-
491
- > **Description**: A system generated unique identifier.
492
-
493
- > **Alternative Labels**: Guid; guid
494
-
495
-
496
- ___
497
-
498
- ## **Link Agreement Items**
499
- > Attach or detach an agreement to an element referenced in its definition. Agreement item can be an referenced element.
500
- ### **Description**
501
- > **Input Required**: False
502
-
503
- > **Description**: Description of the contents of the agreement item.
504
-
505
-
506
- ### **Agreement Item Id**
507
- > **Input Required**: False
508
-
509
- > **Description**: A user specified agreement item identifier.
510
-
511
-
512
- ### **Agreement Start**
513
- > **Input Required**: False
514
-
515
- > **Description**: The start date of the agreement as an ISO 8601 string.
516
-
517
- > **Alternative Labels**: Start Date
518
-
519
-
520
- ### **Agreement End**
521
- > **Input Required**: False
522
-
523
- > **Description**: The end date of the agreement as an ISO 8601 string.
524
-
525
- > **Alternative Labels**: End Date
526
-
527
-
528
- ### **Restrictions**
529
- > **Input Required**: False
530
-
531
- > **Description**: A dictionary of property:value pairs describing restrictions.
532
-
533
-
534
- ### **Obligations**
535
- > **Input Required**: False
536
-
537
- > **Description**: A dictionary of property:value pairs describing obligations.
538
-
539
-
540
- ### **Entitlements**
541
- > **Input Required**: False
542
-
543
- > **Description**: A dictionary of property:value pairs describing entitlements.
544
-
545
-
546
- ### **Usage Measurements**
547
- > **Input Required**: False
548
-
549
- > **Description**: A dictionary of property:value pairs describing usage measurements.
550
-
551
-
552
- ### **Usage Metrics**
553
- > **Input Required**: False
554
-
555
- > **Description**: A dictionary of property:value pairs describing usage metrics for the agreements.
556
-
557
-
558
- ___
559
-
560
- ## **Link Contracts**
561
- > Attach or detach an agreement to an element describing the location of the contract documents.
562
- ### **Contract Id**
563
- > **Input Required**: False
564
-
565
- > **Description**: Contract identifier.
566
-
567
-
568
- ### **Contract Liaison**
569
- > **Input Required**: False
570
-
571
- > **Description**: Name of the liaison for the contract.
572
-
573
-
574
- ### **Contract Liaison Type**
575
- > **Input Required**: False
576
-
577
- > **Description**: type of liaison.
578
-
579
-
580
- ### **Contract Liaison Property Name**
581
- > **Input Required**: False
582
-
583
- > **Description**:
584
-
585
-
586
- ___
587
-
588
- ## **Link Digital Product - Digital Product**
589
- > Link digital product dependency between two digital products.
590
- ### **DigitalProduct1**
591
- > **Input Required**: True
592
-
593
- > **Description**: The first product to link.
594
-
595
- > **Alternative Labels**: Product 1
596
-
597
-
598
- ### **DigitalProduct2**
599
- > **Input Required**: True
600
-
601
- > **Description**: The second product to link.
602
-
603
- > **Alternative Labels**: Product 2
604
-
605
-
606
- ### **Label**
607
- > **Input Required**: False
608
-
609
- > **Description**: Labels the link between two digital products.
610
-
611
-
612
- ### **Description**
613
- > **Input Required**: False
614
-
615
- > **Description**: A description of the link.
616
-
617
-
618
- ___
619
-
620
- ## **Link Subscribers**
621
- > Attach or detach a subscriber to a subscription. Subscriber can be any type of element.
622
- ### **Subscriber Id**
623
- > **Input Required**: False
624
-
625
- > **Description**: identifier of a subscriber. Initially, will let this be an arbitrary string - could harden this to a qualified name later if needed.
626
-
627
-
628
- ### **Agreement Start**
629
- > **Input Required**: False
630
-
631
- > **Description**: The start date of the agreement as an ISO 8601 string.
632
-
633
- > **Alternative Labels**: Start Date
634
-
635
-
636
- ### **Agreement End**
637
- > **Input Required**: False
638
-
639
- > **Description**: The end date of the agreement as an ISO 8601 string.
640
-
641
- > **Alternative Labels**: End Date
642
-
643
-
644
- ### **Restrictions**
645
- > **Input Required**: False
646
-
647
- > **Description**: A dictionary of property:value pairs describing restrictions.
648
-
649
-
650
- ### **Obligations**
651
- > **Input Required**: False
652
-
653
- > **Description**: A dictionary of property:value pairs describing obligations.
654
-
655
-
656
- ### **Entitlements**
657
- > **Input Required**: False
658
-
659
- > **Description**: A dictionary of property:value pairs describing entitlements.
660
-
661
-
662
- ### **Usage Measurements**
663
- > **Input Required**: False
664
-
665
- > **Description**: A dictionary of property:value pairs describing usage measurements.
666
-
667
-
668
- ___
@@ -1,18 +0,0 @@
1
- # **Attach Category Parent**
2
- > Attaches a parent category to a child category.
3
-
4
- ## **Category Name**
5
- > **Input Required**: True
6
-
7
- > **Description**: The name of a category.
8
-
9
- > **Alternative Labels**: Glossary Category Name; Glossary Category; Category; Display Name
10
-
11
-
12
- ## **Parent Category**
13
- > **Input Required**: True
14
-
15
- > **Description**: The name of the parent category to attach to.
16
-
17
- > **Alternative Labels**: Parent Category Name; Parent Category Names
18
-
@@ -1,26 +0,0 @@
1
- # **Attach Term-Term Relationship**
2
- > Create a relationship between terms.
3
-
4
- ## **Term 1**
5
- > **Input Required**: True
6
-
7
- > **Description**: The name of the first term term to connect.
8
-
9
- > **Alternative Labels**: Term Name 1
10
-
11
-
12
- ## **Term 2**
13
- > **Input Required**: True
14
-
15
- > **Description**: The name of the second term term to connect.
16
-
17
- > **Alternative Labels**: Term Name 2
18
-
19
-
20
- ## **Relationship**
21
- > **Input Required**: True
22
-
23
- > **Description**: The type of relationship to connecting the two terms.
24
-
25
- > **Valid Values**: Synonym; Translation; PreferredTerm; TermISATYPEOFRelationship; TermTYPEDBYRelationship; Antonym; ReplacementTerm; ValidValue; TermHASARelationship; RelatedTerm; ISARelationship
26
-