pyegeria 5.4.3.4__py3-none-any.whl → 5.4.4.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (215) hide show
  1. commands/cat/dr_egeria_command_help.py +11 -17
  2. commands/cat/list_format_set.py +3 -1
  3. md_processing/__init__.py +9 -1
  4. md_processing/data/commands.json +6951 -541
  5. md_processing/data/generated_format_sets.json +4137 -0
  6. md_processing/data/generated_format_sets.py +51 -0
  7. md_processing/dr_egeria.py +14 -2
  8. md_processing/md_commands/ext_ref_commands.py +543 -0
  9. md_processing/md_commands/old_solution_architect_commands.py +1139 -0
  10. md_processing/md_commands/solution_architect_commands.py +26 -59
  11. md_processing/md_processing_utils/debug_log +186 -3
  12. md_processing/md_processing_utils/debug_log.2025-09-09_11-10-03_528597.zip +0 -0
  13. md_processing/md_processing_utils/dr-egeria-help-2025-09-09T11:10:03.md +3305 -0
  14. md_processing/md_processing_utils/dr-egeria-help-2025-09-10T14:49:49.md +3460 -0
  15. md_processing/md_processing_utils/dr-egeria-help-2025-09-10T14:57:46.md +472 -0
  16. md_processing/md_processing_utils/gen_format_sets.py +422 -0
  17. md_processing/md_processing_utils/generate_md_cmd_templates.py +4 -4
  18. md_processing/md_processing_utils/md_processing_constants.py +19 -1
  19. pyegeria/_output_formats.py +240 -86
  20. pyegeria/collection_manager.py +3 -3
  21. pyegeria/egeria_tech_client.py +3 -0
  22. pyegeria/external_references.py +1794 -0
  23. pyegeria/glossary_manager.py +2 -2
  24. pyegeria/solution_architect.py +290 -485
  25. {pyegeria-5.4.3.4.dist-info → pyegeria-5.4.4.1.dist-info}/METADATA +1 -1
  26. {pyegeria-5.4.3.4.dist-info → pyegeria-5.4.4.1.dist-info}/RECORD +29 -205
  27. commands/.DS_Store +0 -0
  28. commands/cat/.DS_Store +0 -0
  29. commands/cat/.env +0 -8
  30. commands/cat/debug_log.2025-08-29_07-07-27_848189.log.zip +0 -0
  31. commands/cat/debug_log.2025-08-30_21-15-48_528443.log.zip +0 -0
  32. commands/cat/debug_log.2025-09-01_07-02-58_818650.log.zip +0 -0
  33. commands/cat/debug_log.2025-09-02_07-44-39_567276.log.zip +0 -0
  34. commands/cat/debug_log.2025-09-03_07-45-21_986388.log.zip +0 -0
  35. commands/cat/debug_log.log +0 -7276
  36. commands/cat/logs/pyegeria.log +0 -90
  37. commands/cli/debug_log.log +0 -0
  38. commands/doc/.DS_Store +0 -0
  39. commands/ops/logs/pyegeria.log +0 -0
  40. md_processing/.DS_Store +0 -0
  41. md_processing/.idea/.gitignore +0 -8
  42. md_processing/.idea/inspectionProfiles/Project_Default.xml +0 -59
  43. md_processing/.idea/md_processing.iml +0 -15
  44. md_processing/.idea/modules.xml +0 -8
  45. md_processing/.idea/sonarlint/issuestore/index.pb +0 -0
  46. md_processing/.idea/sonarlint/securityhotspotstore/index.pb +0 -0
  47. md_processing/.idea/vcs.xml +0 -6
  48. md_processing/.idea/workspace.xml +0 -107
  49. md_processing/dr_egeria_inbox/Derive-Dr-Gov-Defs.md +0 -8
  50. md_processing/dr_egeria_inbox/Dr.Egeria Templates.md +0 -873
  51. md_processing/dr_egeria_inbox/arch_test.md +0 -57
  52. md_processing/dr_egeria_inbox/archive/dr_egeria_intro.md +0 -254
  53. md_processing/dr_egeria_inbox/archive/dr_egeria_intro_more_terms.md +0 -696
  54. md_processing/dr_egeria_inbox/archive/dr_egeria_intro_part1.md +0 -254
  55. md_processing/dr_egeria_inbox/archive/dr_egeria_intro_part2.md +0 -298
  56. md_processing/dr_egeria_inbox/archive/dr_egeria_intro_part3.md +0 -608
  57. md_processing/dr_egeria_inbox/archive/dr_egeria_intro_part4.md +0 -94
  58. md_processing/dr_egeria_inbox/archive/freddie_intro.md +0 -284
  59. md_processing/dr_egeria_inbox/archive/freddie_intro_orig.md +0 -275
  60. md_processing/dr_egeria_inbox/archive/test-term.md +0 -110
  61. md_processing/dr_egeria_inbox/cat_test.md +0 -100
  62. md_processing/dr_egeria_inbox/collections.md +0 -39
  63. md_processing/dr_egeria_inbox/data_designer_debug.log +0 -6
  64. md_processing/dr_egeria_inbox/data_designer_out.md +0 -60
  65. md_processing/dr_egeria_inbox/data_designer_search_test.md +0 -11
  66. md_processing/dr_egeria_inbox/data_field.md +0 -54
  67. md_processing/dr_egeria_inbox/data_spec.md +0 -77
  68. md_processing/dr_egeria_inbox/data_spec_test.md +0 -2014
  69. md_processing/dr_egeria_inbox/data_test.md +0 -179
  70. md_processing/dr_egeria_inbox/data_test2.md +0 -429
  71. md_processing/dr_egeria_inbox/data_test3.md +0 -462
  72. md_processing/dr_egeria_inbox/dr_egeria_data_designer_1.md +0 -124
  73. md_processing/dr_egeria_inbox/dr_egeria_intro_categories.md +0 -168
  74. md_processing/dr_egeria_inbox/dr_egeria_intro_part1.md +0 -280
  75. md_processing/dr_egeria_inbox/dr_egeria_intro_part2.md +0 -318
  76. md_processing/dr_egeria_inbox/dr_egeria_intro_part3.md +0 -1073
  77. md_processing/dr_egeria_inbox/dr_egeria_isc1.md +0 -44
  78. md_processing/dr_egeria_inbox/generated_help_report.md +0 -9
  79. md_processing/dr_egeria_inbox/generated_help_terms.md +0 -842
  80. md_processing/dr_egeria_inbox/glossary_list.md +0 -5
  81. md_processing/dr_egeria_inbox/glossary_search_test.md +0 -40
  82. md_processing/dr_egeria_inbox/glossary_test1.md +0 -378
  83. md_processing/dr_egeria_inbox/gov_def.md +0 -718
  84. md_processing/dr_egeria_inbox/gov_def2.md +0 -447
  85. md_processing/dr_egeria_inbox/img.png +0 -0
  86. md_processing/dr_egeria_inbox/output_tests.md +0 -114
  87. md_processing/dr_egeria_inbox/product.md +0 -219
  88. md_processing/dr_egeria_inbox/rel.md +0 -8
  89. md_processing/dr_egeria_inbox/sb.md +0 -119
  90. md_processing/dr_egeria_inbox/solution-components.md +0 -136
  91. md_processing/dr_egeria_inbox/solution_blueprints.md +0 -118
  92. md_processing/dr_egeria_inbox/synonym_test.md +0 -42
  93. md_processing/dr_egeria_inbox/t2.md +0 -268
  94. md_processing/dr_egeria_outbox/.DS_Store +0 -0
  95. md_processing/dr_egeria_outbox/.obsidian/app.json +0 -1
  96. md_processing/dr_egeria_outbox/.obsidian/appearance.json +0 -1
  97. md_processing/dr_egeria_outbox/.obsidian/community-plugins.json +0 -7
  98. md_processing/dr_egeria_outbox/.obsidian/core-plugins.json +0 -33
  99. md_processing/dr_egeria_outbox/.obsidian/plugins/buttons/main.js +0 -5164
  100. md_processing/dr_egeria_outbox/.obsidian/plugins/buttons/manifest.json +0 -10
  101. md_processing/dr_egeria_outbox/.obsidian/plugins/buttons/styles.css +0 -624
  102. md_processing/dr_egeria_outbox/.obsidian/plugins/calendar/data.json +0 -10
  103. md_processing/dr_egeria_outbox/.obsidian/plugins/calendar/main.js +0 -4459
  104. md_processing/dr_egeria_outbox/.obsidian/plugins/calendar/manifest.json +0 -10
  105. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-kanban/data.json +0 -3
  106. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-kanban/main.js +0 -153
  107. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-kanban/manifest.json +0 -11
  108. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-kanban/styles.css +0 -1
  109. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-tasks-plugin/main.js +0 -500
  110. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-tasks-plugin/manifest.json +0 -12
  111. md_processing/dr_egeria_outbox/.obsidian/plugins/obsidian-tasks-plugin/styles.css +0 -1
  112. md_processing/dr_egeria_outbox/.obsidian/plugins/templater-obsidian/data.json +0 -38
  113. md_processing/dr_egeria_outbox/.obsidian/plugins/templater-obsidian/main.js +0 -37
  114. md_processing/dr_egeria_outbox/.obsidian/plugins/templater-obsidian/manifest.json +0 -11
  115. md_processing/dr_egeria_outbox/.obsidian/plugins/templater-obsidian/styles.css +0 -220
  116. md_processing/dr_egeria_outbox/.obsidian/types.json +0 -28
  117. md_processing/dr_egeria_outbox/.obsidian/workspace.json +0 -270
  118. md_processing/dr_egeria_outbox/Button Test.md +0 -11
  119. md_processing/dr_egeria_outbox/Scripts/.DS_Store +0 -0
  120. md_processing/dr_egeria_outbox/Scripts/sendRest.js +0 -24
  121. md_processing/dr_egeria_outbox/Templates/sendToApi.md.md +0 -17
  122. md_processing/dr_egeria_outbox/Untitled.canvas +0 -1
  123. md_processing/dr_egeria_outbox/monday/processed-2025-09-01 09:26-product.md +0 -210
  124. md_processing/dr_egeria_outbox/monday/processed-2025-09-01 14:03-product.md +0 -209
  125. md_processing/dr_egeria_outbox/monday/processed-2025-09-01 14:24-product.md +0 -263
  126. md_processing/dr_egeria_outbox/monday/processed-2025-09-01 16:03-data_spec_test.md +0 -2374
  127. md_processing/dr_egeria_outbox/monday/processed-2025-09-01 16:05-data_spec_test.md +0 -2374
  128. md_processing/dr_egeria_outbox/monday/processed-2025-09-02 08:28-data_spec_test.md +0 -2321
  129. md_processing/dr_egeria_outbox/monday/processed-2025-09-02 08:37-data_spec_test.md +0 -2304
  130. md_processing/dr_egeria_outbox/monday/processed-2025-09-02 08:56-data_spec_test.md +0 -2324
  131. md_processing/dr_egeria_outbox/monday/processed-2025-09-02 09:00-data_spec_test.md +0 -2324
  132. md_processing/dr_egeria_outbox/processed-2025-08-30 16:56-generated_help_terms.md +0 -795
  133. md_processing/dr_egeria_outbox/thursday/processed-2025-07-17 15:00-Derive-Dr-Gov-Defs.md +0 -719
  134. md_processing/dr_egeria_outbox/thursday/processed-2025-07-17 20:13-Derive-Dr-Gov-Defs.md +0 -41
  135. md_processing/dr_egeria_outbox/thursday/processed-2025-07-17 20:14-Derive-Dr-Gov-Defs.md +0 -33
  136. md_processing/dr_egeria_outbox/thursday/processed-2025-07-17 20:50-Derive-Dr-Gov-Defs.md +0 -192
  137. md_processing/dr_egeria_outbox/thursday/processed-2025-07-17 22:08-gov_def2.md +0 -486
  138. md_processing/dr_egeria_outbox/thursday/processed-2025-07-17 22:10-gov_def2.md +0 -486
  139. md_processing/dr_egeria_outbox/thursday/processed-2025-07-18 08:53-gov_def2.md +0 -486
  140. md_processing/dr_egeria_outbox/thursday/processed-2025-07-18 08:54-gov_def2.md +0 -486
  141. md_processing/dr_egeria_outbox/thursday/processed-2025-07-18 09:03-gov_def2.md +0 -486
  142. md_processing/dr_egeria_outbox/thursday/processed-2025-07-18 09:06-gov_def2.md +0 -486
  143. md_processing/dr_egeria_outbox/thursday/processed-2025-07-18 09:10-gov_def2.md +0 -486
  144. md_processing/family_docs/Data Designer/Create_Data_Class.md +0 -164
  145. md_processing/family_docs/Data Designer/Create_Data_Dictionary.md +0 -30
  146. md_processing/family_docs/Data Designer/Create_Data_Field.md +0 -162
  147. md_processing/family_docs/Data Designer/Create_Data_Specification.md +0 -36
  148. md_processing/family_docs/Data Designer/Create_Data_Structure.md +0 -38
  149. md_processing/family_docs/Data Designer/View_Data_Classes.md +0 -78
  150. md_processing/family_docs/Data Designer/View_Data_Dictionaries.md +0 -78
  151. md_processing/family_docs/Data Designer/View_Data_Fields.md +0 -78
  152. md_processing/family_docs/Data Designer/View_Data_Specifications.md +0 -78
  153. md_processing/family_docs/Data Designer/View_Data_Structures.md +0 -78
  154. md_processing/family_docs/Data Designer.md +0 -842
  155. md_processing/family_docs/Digital Product Manager/Add_Member->Collection.md +0 -42
  156. md_processing/family_docs/Digital Product Manager/Attach_Collection->Resource.md +0 -36
  157. md_processing/family_docs/Digital Product Manager/Create_Agreement.md +0 -96
  158. md_processing/family_docs/Digital Product Manager/Create_Data_Sharing_Agreement.md +0 -72
  159. md_processing/family_docs/Digital Product Manager/Create_DigitalSubscription.md +0 -102
  160. md_processing/family_docs/Digital Product Manager/Create_Digital_Product.md +0 -134
  161. md_processing/family_docs/Digital Product Manager/Link_Agreement_Items.md +0 -60
  162. md_processing/family_docs/Digital Product Manager/Link_Contracts.md +0 -26
  163. md_processing/family_docs/Digital Product Manager/Link_Digital_Product_-_Digital_Product.md +0 -30
  164. md_processing/family_docs/Digital Product Manager/Link_Subscribers.md +0 -48
  165. md_processing/family_docs/Digital Product Manager.md +0 -668
  166. md_processing/family_docs/Glossary/Attach_Category_Parent.md +0 -18
  167. md_processing/family_docs/Glossary/Attach_Term-Term_Relationship.md +0 -26
  168. md_processing/family_docs/Glossary/Create_Category.md +0 -38
  169. md_processing/family_docs/Glossary/Create_Glossary.md +0 -42
  170. md_processing/family_docs/Glossary/Create_Term.md +0 -70
  171. md_processing/family_docs/Glossary.md +0 -206
  172. md_processing/family_docs/Governance Officer/Create_Business_Imperative.md +0 -106
  173. md_processing/family_docs/Governance Officer/Create_Certification_Type.md +0 -112
  174. md_processing/family_docs/Governance Officer/Create_Governance_Approach.md +0 -114
  175. md_processing/family_docs/Governance Officer/Create_Governance_Obligation.md +0 -114
  176. md_processing/family_docs/Governance Officer/Create_Governance_Principle.md +0 -114
  177. md_processing/family_docs/Governance Officer/Create_Governance_Procedure.md +0 -128
  178. md_processing/family_docs/Governance Officer/Create_Governance_Process.md +0 -122
  179. md_processing/family_docs/Governance Officer/Create_Governance_Processing_Purpose.md +0 -106
  180. md_processing/family_docs/Governance Officer/Create_Governance_Responsibility.md +0 -122
  181. md_processing/family_docs/Governance Officer/Create_Governance_Rule.md +0 -122
  182. md_processing/family_docs/Governance Officer/Create_Governance_Strategy.md +0 -106
  183. md_processing/family_docs/Governance Officer/Create_License_Type.md +0 -112
  184. md_processing/family_docs/Governance Officer/Create_Naming_Standard_Rule.md +0 -122
  185. md_processing/family_docs/Governance Officer/Create_Regulation_Article.md +0 -106
  186. md_processing/family_docs/Governance Officer/Create_Regulation_Definition.md +0 -118
  187. md_processing/family_docs/Governance Officer/Create_Security_Access_Control.md +0 -114
  188. md_processing/family_docs/Governance Officer/Create_Security_Group.md +0 -120
  189. md_processing/family_docs/Governance Officer/Create_Service_Level_Objectives.md +0 -122
  190. md_processing/family_docs/Governance Officer/Create_Threat_Definition.md +0 -106
  191. md_processing/family_docs/Governance Officer/Link_Governance_Controls.md +0 -32
  192. md_processing/family_docs/Governance Officer/Link_Governance_Drivers.md +0 -32
  193. md_processing/family_docs/Governance Officer/Link_Governance_Policies.md +0 -32
  194. md_processing/family_docs/Governance Officer/View_Governance_Definitions.md +0 -82
  195. md_processing/family_docs/Governance Officer.md +0 -2412
  196. md_processing/family_docs/Solution Architect/Create_Information_Supply_Chain.md +0 -70
  197. md_processing/family_docs/Solution Architect/Create_Solution_Blueprint.md +0 -44
  198. md_processing/family_docs/Solution Architect/Create_Solution_Component.md +0 -96
  199. md_processing/family_docs/Solution Architect/Create_Solution_Role.md +0 -66
  200. md_processing/family_docs/Solution Architect/Link_Information_Supply_Chain_Peers.md +0 -32
  201. md_processing/family_docs/Solution Architect/Link_Solution_Component_Peers.md +0 -32
  202. md_processing/family_docs/Solution Architect/View_Information_Supply_Chains.md +0 -32
  203. md_processing/family_docs/Solution Architect/View_Solution_Blueprints.md +0 -32
  204. md_processing/family_docs/Solution Architect/View_Solution_Components.md +0 -32
  205. md_processing/family_docs/Solution Architect/View_Solution_Roles.md +0 -32
  206. md_processing/family_docs/Solution Architect.md +0 -490
  207. md_processing/md_commands/old_project_commands.py +0 -164
  208. md_processing/md_processing_utils/debug_log.log +0 -5580
  209. md_processing/md_processing_utils/generated_help_terms.md +0 -842
  210. md_processing/md_processing_utils/logs/pyegeria.log +0 -56
  211. pyegeria/.DS_Store +0 -0
  212. pyegeria/___external_references.py +0 -3255
  213. {pyegeria-5.4.3.4.dist-info → pyegeria-5.4.4.1.dist-info}/LICENSE +0 -0
  214. {pyegeria-5.4.3.4.dist-info → pyegeria-5.4.4.1.dist-info}/WHEEL +0 -0
  215. {pyegeria-5.4.3.4.dist-info → pyegeria-5.4.4.1.dist-info}/entry_points.txt +0 -0
@@ -1,42 +0,0 @@
1
- # **Add Member->Collection**
2
- > Add a member to a collection.
3
-
4
- ## **Element_Id**
5
- > **Input Required**: True
6
-
7
- > **Description**: The name of the element to add to the collection.
8
-
9
- > **Alternative Labels**: member_id
10
-
11
-
12
- ## **Collection Id**
13
- > **Input Required**: True
14
-
15
- > **Description**: The name of the collection to link to. There are many collection types, including Digital Products, Agreements and Subscriptions.
16
-
17
- > **Alternative Labels**: Collection Id; Agreement Id; Subscription Id; Digital Product Id
18
-
19
-
20
- ## **Membership Rationale**
21
- > **Input Required**: False
22
-
23
- > **Description**: Rationale for membership.
24
-
25
- > **Alternative Labels**: Rationale
26
-
27
-
28
- ## **Created By**
29
- > **Input Required**: False
30
-
31
- > **Description**: Who added the member. (currently informal string)
32
-
33
-
34
- ## **Membership Status**
35
- > **Input Required**: False
36
-
37
- > **Description**: The status of adding a member to a collection.
38
-
39
- > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
40
-
41
- > **Default Value**: APPROVED
42
-
@@ -1,36 +0,0 @@
1
- # **Attach Collection->Resource**
2
- > Connect an existing collection to an element using the ResourceList relationship.
3
-
4
- ## **Collection**
5
- > **Input Required**: True
6
-
7
- > **Description**: An element of base type collection (e.g. collection, agreement; subscription, ...)
8
-
9
- > **Alternative Labels**: Collection Id; Agreement Id; Subscription Id
10
-
11
-
12
- ## **Resource**
13
- > **Input Required**: True
14
-
15
- > **Description**: The name of the resource to attach to.
16
-
17
-
18
- ## **Resource Use**
19
- > **Input Required**: False
20
-
21
- > **Description**: Describes the relationship between the resource and the collection.
22
-
23
-
24
- ## **Resource Description**
25
- > **Input Required**: False
26
-
27
- > **Description**: A description of the resource being attached.
28
-
29
- > **Alternative Labels**: Description
30
-
31
-
32
- ## **Resource Use Properties**
33
- > **Input Required**: False
34
-
35
- > **Description**: A dictionary of name:value pairs describing properties of the resource use.
36
-
@@ -1,96 +0,0 @@
1
- # **Create Agreement**
2
- > A kind of collection that represents an Agreement. This is for generic agreements. Specific kinds of agreements have their own commands.
3
-
4
- ## **Display Name**
5
- > **Input Required**: True
6
-
7
- > **Description**: Name of the agreement.
8
-
9
- > **Alternative Labels**: Name
10
-
11
-
12
- ## **Description**
13
- > **Input Required**: False
14
-
15
- > **Description**: Description of the contents of the agreement.
16
-
17
-
18
- ## **Agreement Identifier**
19
- > **Input Required**: False
20
-
21
- > **Description**: A user specified agreement identifier.
22
-
23
-
24
- ## **Agreement Status**
25
- > **Input Required**: False
26
-
27
- > **Description**: The status of the agreement. There is a list of valid values that this conforms to.
28
-
29
- > **Alternative Labels**: Initial Status
30
-
31
- > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
32
-
33
- > **Default Value**: DRAFT
34
-
35
-
36
- ## **User Defined Status**
37
- > **Input Required**: False
38
-
39
- > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
40
-
41
-
42
- ## **Version Identifier**
43
- > **Input Required**: False
44
-
45
- > **Description**: Published agreement version identifier.
46
-
47
-
48
- ## **Agreement Actors**
49
- > **Input Required**: False
50
-
51
- > **Description**: A list of actors with responsibilities for the agreement.
52
-
53
-
54
- ## **Restrictions**
55
- > **Input Required**: False
56
-
57
- > **Description**: A dictionary of property:value pairs describing restrictions.
58
-
59
-
60
- ## **Obligations**
61
- > **Input Required**: False
62
-
63
- > **Description**: A dictionary of property:value pairs describing obligations.
64
-
65
-
66
- ## **Entitlements**
67
- > **Input Required**: False
68
-
69
- > **Description**: A dictionary of property:value pairs describing entitlements.
70
-
71
-
72
- ## **Usage Measurements**
73
- > **Input Required**: False
74
-
75
- > **Description**: A dictionary of property:value pairs describing usage measurements.
76
-
77
-
78
- ## **Product Metrics**
79
- > **Input Required**: False
80
-
81
- > **Description**: A dictionary of property:value pairs describing metrics for the product/.
82
-
83
-
84
- ## **Qualified Name**
85
- > **Input Required**: False
86
-
87
- > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
88
-
89
-
90
- ## **GUID**
91
- > **Input Required**: False
92
-
93
- > **Description**: A system generated unique identifier.
94
-
95
- > **Alternative Labels**: Guid; guid
96
-
@@ -1,72 +0,0 @@
1
- # **Create Data Sharing Agreement**
2
- > Create a new collection with the DataSharingAgreement classification.
3
-
4
- ## **Display Name**
5
- > **Input Required**: True
6
-
7
- > **Description**: Name of the agreement.
8
-
9
- > **Alternative Labels**: Name
10
-
11
-
12
- ## **Description**
13
- > **Input Required**: False
14
-
15
- > **Description**: Description of the contents of the agreement.
16
-
17
-
18
- ## **Identifier**
19
- > **Input Required**: False
20
-
21
- > **Description**: A user specified agreement identifier.
22
-
23
-
24
- ## **Agreement Status**
25
- > **Input Required**: False
26
-
27
- > **Description**: The status of the digital product. There is a list of valid values that this conforms to.
28
-
29
- > **Alternative Labels**: Status
30
-
31
- > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
32
-
33
- > **Default Value**: DRAFT
34
-
35
-
36
- ## **User_Defined_Status**
37
- > **Input Required**: False
38
-
39
- > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
40
-
41
-
42
- ## **Version Identifier**
43
- > **Input Required**: False
44
-
45
- > **Description**: Published agreement version identifier.
46
-
47
-
48
- ## **Product Manager**
49
- > **Input Required**: False
50
-
51
- > **Description**: An actor responsible for managing this product. Actors may be individuals, automations, etc.
52
-
53
-
54
- ## **Digital Subscriptions**
55
- > **Input Required**: False
56
-
57
- > **Description**:
58
-
59
-
60
- ## **Qualified Name**
61
- > **Input Required**: False
62
-
63
- > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
64
-
65
-
66
- ## **GUID**
67
- > **Input Required**: False
68
-
69
- > **Description**: A system generated unique identifier.
70
-
71
- > **Alternative Labels**: Guid; guid
72
-
@@ -1,102 +0,0 @@
1
- # **Create DigitalSubscription**
2
- > A type of agreement for a digital subscription.
3
-
4
- ## **Display Name**
5
- > **Input Required**: True
6
-
7
- > **Description**: Name of the agreement.
8
-
9
- > **Alternative Labels**: Name
10
-
11
-
12
- ## **Description**
13
- > **Input Required**: False
14
-
15
- > **Description**: Description of the contents of the agreement.
16
-
17
-
18
- ## **Identifier**
19
- > **Input Required**: False
20
-
21
- > **Description**: A user specified agreement identifier.
22
-
23
-
24
- ## **Product Status**
25
- > **Input Required**: False
26
-
27
- > **Description**: The status of the digital product. There is a list of valid values that this conforms to.
28
-
29
- > **Alternative Labels**: Initial Status
30
-
31
- > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
32
-
33
- > **Default Value**: DRAFT
34
-
35
-
36
- ## **User_Defined_Status**
37
- > **Input Required**: False
38
-
39
- > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
40
-
41
-
42
- ## **Support Level**
43
- > **Input Required**: False
44
-
45
- > **Description**: Level of support agreed or requested.
46
-
47
-
48
- ## **Service Levels**
49
- > **Input Required**: False
50
-
51
- > **Description**: A dictionary of name:value pairs describing the service levels.
52
-
53
-
54
- ## **Restrictions**
55
- > **Input Required**: False
56
-
57
- > **Description**: A dictionary of property:value pairs describing restrictions.
58
-
59
-
60
- ## **Obligations**
61
- > **Input Required**: False
62
-
63
- > **Description**: A dictionary of property:value pairs describing obligations.
64
-
65
-
66
- ## **Entitlements**
67
- > **Input Required**: False
68
-
69
- > **Description**: A dictionary of property:value pairs describing entitlements.
70
-
71
-
72
- ## **Usage Measurements**
73
- > **Input Required**: False
74
-
75
- > **Description**: A dictionary of property:value pairs describing usage measurements.
76
-
77
-
78
- ## **Product Metrics**
79
- > **Input Required**: False
80
-
81
- > **Description**: A dictionary of property:value pairs describing metrics for the product/.
82
-
83
-
84
- ## **Version Identifier**
85
- > **Input Required**: False
86
-
87
- > **Description**: Published agreement version identifier.
88
-
89
-
90
- ## **Qualified Name**
91
- > **Input Required**: False
92
-
93
- > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
94
-
95
-
96
- ## **GUID**
97
- > **Input Required**: False
98
-
99
- > **Description**: A system generated unique identifier.
100
-
101
- > **Alternative Labels**: Guid; guid
102
-
@@ -1,134 +0,0 @@
1
- # **Create Digital Product**
2
- > A Data Dictionary is an organized and curated collection of data definitions that can serve as a reference for data professionals
3
-
4
- ## **Display Name**
5
- > **Input Required**: True
6
-
7
- > **Description**: Name of the digital product
8
-
9
- > **Alternative Labels**: Name
10
-
11
-
12
- ## **Description**
13
- > **Input Required**: False
14
-
15
- > **Description**: Description of the contents of a product.
16
-
17
-
18
- ## **Product Name**
19
- > **Input Required**: False
20
-
21
- > **Description**: The external name of the digital product.
22
-
23
-
24
- ## **Product Status**
25
- > **Input Required**: False
26
-
27
- > **Description**: The status of the digital product. There is a list of valid values that this conforms to.
28
-
29
- > **Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; APPROVED_CONCEPT; UNDER_DEVELOPMENT; DEVELOPMENT_COMPLETE; APPROVED_FOR_DEPLOYMENT; ACTIVE; DISABLED; DEPRECATED; OTHER
30
-
31
- > **Default Value**: DRAFT
32
-
33
-
34
- ## **User Defined Status**
35
- > **Input Required**: False
36
-
37
- > **Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
38
-
39
-
40
- ## **Product Type**
41
- > **Input Required**: False
42
-
43
- > **Description**: Type of product - periodic, delta, snapshot, etc
44
-
45
-
46
- ## **Product Identifier**
47
- > **Input Required**: False
48
-
49
- > **Description**: User specified product identifier.
50
-
51
-
52
- ## **Product Description**
53
- > **Input Required**: False
54
-
55
- > **Description**: Externally facing description of the product and its intended usage.
56
-
57
-
58
- ## **Maturity**
59
- > **Input Required**: False
60
-
61
- > **Description**: Product maturity - user defined.
62
-
63
-
64
- ## **Service Life**
65
- > **Input Required**: False
66
-
67
- > **Description**: Estimated service lifetime of the product.
68
-
69
-
70
- ## **Introduction Date**
71
- > **Input Required**: False
72
-
73
- > **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.
74
-
75
-
76
- ## **Next Version Date**
77
- > **Input Required**: False
78
-
79
- > **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.
80
-
81
-
82
- ## **Withdrawal Date**
83
- > **Input Required**: False
84
-
85
- > **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.
86
-
87
-
88
- ## **Collection Type**
89
- > **Input Required**: False
90
-
91
- > **Description**: A user supplied collection type. Defaults to Digital Product.
92
-
93
- > **Default Value**: Digital Product
94
-
95
-
96
- ## **Current Version**
97
- > **Input Required**: False
98
-
99
- > **Description**: Published product version identifier.
100
-
101
- > **Default Value**: 1.0
102
-
103
-
104
- ## **Product Manager**
105
- > **Input Required**: False
106
-
107
- > **Description**: Actors responsible for managing this product. Actors may be individuals, automations, etc.
108
-
109
-
110
- ## **Agreements**
111
- > **Input Required**: False
112
-
113
- > **Description**: A list of agreements associated with this product. The agreements must already exist.
114
-
115
-
116
- ## **Digital Subscriptions**
117
- > **Input Required**: False
118
-
119
- > **Description**:
120
-
121
-
122
- ## **Qualified Name**
123
- > **Input Required**: False
124
-
125
- > **Description**: A unique qualified name for the element. Generated using the qualified name pattern if not user specified.
126
-
127
-
128
- ## **GUID**
129
- > **Input Required**: False
130
-
131
- > **Description**: A system generated unique identifier.
132
-
133
- > **Alternative Labels**: Guid; guid
134
-
@@ -1,60 +0,0 @@
1
- # **Link Agreement Items**
2
- > Attach or detach an agreement to an element referenced in its definition. Agreement item can be an referenced element.
3
-
4
- ## **Description**
5
- > **Input Required**: False
6
-
7
- > **Description**: Description of the contents of the agreement item.
8
-
9
-
10
- ## **Agreement Item Id**
11
- > **Input Required**: False
12
-
13
- > **Description**: A user specified agreement item identifier.
14
-
15
-
16
- ## **Agreement Start**
17
- > **Input Required**: False
18
-
19
- > **Description**: The start date of the agreement as an ISO 8601 string.
20
-
21
- > **Alternative Labels**: Start Date
22
-
23
-
24
- ## **Agreement End**
25
- > **Input Required**: False
26
-
27
- > **Description**: The end date of the agreement as an ISO 8601 string.
28
-
29
- > **Alternative Labels**: End Date
30
-
31
-
32
- ## **Restrictions**
33
- > **Input Required**: False
34
-
35
- > **Description**: A dictionary of property:value pairs describing restrictions.
36
-
37
-
38
- ## **Obligations**
39
- > **Input Required**: False
40
-
41
- > **Description**: A dictionary of property:value pairs describing obligations.
42
-
43
-
44
- ## **Entitlements**
45
- > **Input Required**: False
46
-
47
- > **Description**: A dictionary of property:value pairs describing entitlements.
48
-
49
-
50
- ## **Usage Measurements**
51
- > **Input Required**: False
52
-
53
- > **Description**: A dictionary of property:value pairs describing usage measurements.
54
-
55
-
56
- ## **Usage Metrics**
57
- > **Input Required**: False
58
-
59
- > **Description**: A dictionary of property:value pairs describing usage metrics for the agreements.
60
-
@@ -1,26 +0,0 @@
1
- # **Link Contracts**
2
- > Attach or detach an agreement to an element describing the location of the contract documents.
3
-
4
- ## **Contract Id**
5
- > **Input Required**: False
6
-
7
- > **Description**: Contract identifier.
8
-
9
-
10
- ## **Contract Liaison**
11
- > **Input Required**: False
12
-
13
- > **Description**: Name of the liaison for the contract.
14
-
15
-
16
- ## **Contract Liaison Type**
17
- > **Input Required**: False
18
-
19
- > **Description**: type of liaison.
20
-
21
-
22
- ## **Contract Liaison Property Name**
23
- > **Input Required**: False
24
-
25
- > **Description**:
26
-
@@ -1,30 +0,0 @@
1
- # **Link Digital Product - Digital Product**
2
- > Link digital product dependency between two digital products.
3
-
4
- ## **DigitalProduct1**
5
- > **Input Required**: True
6
-
7
- > **Description**: The first product to link.
8
-
9
- > **Alternative Labels**: Product 1
10
-
11
-
12
- ## **DigitalProduct2**
13
- > **Input Required**: True
14
-
15
- > **Description**: The second product to link.
16
-
17
- > **Alternative Labels**: Product 2
18
-
19
-
20
- ## **Label**
21
- > **Input Required**: False
22
-
23
- > **Description**: Labels the link between two digital products.
24
-
25
-
26
- ## **Description**
27
- > **Input Required**: False
28
-
29
- > **Description**: A description of the link.
30
-
@@ -1,48 +0,0 @@
1
- # **Link Subscribers**
2
- > Attach or detach a subscriber to a subscription. Subscriber can be any type of element.
3
-
4
- ## **Subscriber Id**
5
- > **Input Required**: False
6
-
7
- > **Description**: identifier of a subscriber. Initially, will let this be an arbitrary string - could harden this to a qualified name later if needed.
8
-
9
-
10
- ## **Agreement Start**
11
- > **Input Required**: False
12
-
13
- > **Description**: The start date of the agreement as an ISO 8601 string.
14
-
15
- > **Alternative Labels**: Start Date
16
-
17
-
18
- ## **Agreement End**
19
- > **Input Required**: False
20
-
21
- > **Description**: The end date of the agreement as an ISO 8601 string.
22
-
23
- > **Alternative Labels**: End Date
24
-
25
-
26
- ## **Restrictions**
27
- > **Input Required**: False
28
-
29
- > **Description**: A dictionary of property:value pairs describing restrictions.
30
-
31
-
32
- ## **Obligations**
33
- > **Input Required**: False
34
-
35
- > **Description**: A dictionary of property:value pairs describing obligations.
36
-
37
-
38
- ## **Entitlements**
39
- > **Input Required**: False
40
-
41
- > **Description**: A dictionary of property:value pairs describing entitlements.
42
-
43
-
44
- ## **Usage Measurements**
45
- > **Input Required**: False
46
-
47
- > **Description**: A dictionary of property:value pairs describing usage measurements.
48
-