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
md_processing/md_processing_utils/dr-egeria-help-2025-09-09T11:10:03.md ADDED
@@ -0,0 +1,3305 @@
1
+ # Generating glossary entries for the documented commands
2
+
3
+
4
+ This file contains generated Dr.Egeria commands to generate glossary term entries describing
5
+ each Dr.Egeria command.
6
+
7
+ > Usage: Before executing this file, make sure you have a glossary named `Egeria-Markdown`
8
+ > already created. If you Need to create one, you can use the
9
+ # Create Term
10
+ ## Term Name
11
+
12
+ Create Governance Driver
13
+
14
+ ## Description
15
+
16
+ A motivating topic leading to governance work.
17
+
18
+ ## Glossary
19
+
20
+ Egeria-Markdown
21
+
22
+ ## Folders
23
+
24
+ Writing Dr.Egeria Markdown
25
+
26
+ ## Usage
27
+
28
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
29
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
30
+ | Display Name | True | True | False | None | Name of the definition. | False | |
31
+ | Summary | False | True | False | None | Summary of the definition. | False | |
32
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
33
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
34
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
35
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
36
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
37
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
38
+ | Scope | False | True | False | None | Scope of the definition. | False | |
39
+ | Importance | False | True | False | None | Importance of the definition. | False | |
40
+ | Implications | False | True | False | None | List of implications. | False | |
41
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
42
+ | Results | False | True | False | None | A list of expected results. | False | |
43
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
44
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
45
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
46
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
47
+
48
+
49
+ ___
50
+
51
+ # Create Term
52
+ ## Term Name
53
+
54
+ Create Governance Strategy
55
+
56
+ ## Description
57
+
58
+ The strategy used in the development of the governance domains activities. How the governance domain supports the business strategy.
59
+
60
+ ## Glossary
61
+
62
+ Egeria-Markdown
63
+
64
+ ## Folders
65
+
66
+ Writing Dr.Egeria Markdown
67
+
68
+ ## Usage
69
+
70
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
71
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
72
+ | Display Name | True | True | False | None | Name of the definition. | False | |
73
+ | Summary | False | True | False | None | Summary of the definition. | False | |
74
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
75
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
76
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
77
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
78
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
79
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
80
+ | Scope | False | True | False | None | Scope of the definition. | False | |
81
+ | Importance | False | True | False | None | Importance of the definition. | False | |
82
+ | Implications | False | True | False | None | List of implications. | False | |
83
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
84
+ | Results | False | True | False | None | A list of expected results. | False | |
85
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
86
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
87
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
88
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
89
+
90
+
91
+ ___
92
+
93
+ # Create Term
94
+ ## Term Name
95
+
96
+ Create Business Imperative
97
+
98
+ ## Description
99
+
100
+ The BusinessImperative entity defines a business goal that is critical to the success of the organization.
101
+
102
+ ## Glossary
103
+
104
+ Egeria-Markdown
105
+
106
+ ## Folders
107
+
108
+ Writing Dr.Egeria Markdown
109
+
110
+ ## Usage
111
+
112
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
113
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
114
+ | Display Name | True | True | False | None | Name of the definition. | False | |
115
+ | Summary | False | True | False | None | Summary of the definition. | False | |
116
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
117
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
118
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
119
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
120
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
121
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
122
+ | Scope | False | True | False | None | Scope of the definition. | False | |
123
+ | Importance | False | True | False | None | Importance of the definition. | False | |
124
+ | Implications | False | True | False | None | List of implications. | False | |
125
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
126
+ | Results | False | True | False | None | A list of expected results. | False | |
127
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
128
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
129
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
130
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
131
+
132
+
133
+ ___
134
+
135
+ # Create Term
136
+ ## Term Name
137
+
138
+ Create Regulation
139
+
140
+ ## Description
141
+
142
+ Defines a relevant legal regulation that the business operation must comply with. Often regulations are divided into regulation articles.
143
+
144
+ ## Glossary
145
+
146
+ Egeria-Markdown
147
+
148
+ ## Folders
149
+
150
+ Writing Dr.Egeria Markdown
151
+
152
+ ## Usage
153
+
154
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
155
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
156
+ | Display Name | True | True | False | None | Name of the definition. | False | |
157
+ | Summary | False | True | False | None | Summary of the definition. | False | |
158
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
159
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
160
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
161
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
162
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
163
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
164
+ | Scope | False | True | False | None | Scope of the definition. | False | |
165
+ | Importance | False | True | False | None | Importance of the definition. | False | |
166
+ | Regulation Source | False | True | False | None | The source of the regulation - often, an authority. | False | |
167
+ | Regulators | False | True | False | None | A list of regulators. | False | |
168
+ | Implications | False | True | False | None | List of implications. | False | |
169
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
170
+ | Results | False | True | False | None | A list of expected results. | False | |
171
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
172
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
173
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
174
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
175
+
176
+
177
+ ___
178
+
179
+ # Create Term
180
+ ## Term Name
181
+
182
+ Create Regulation Article
183
+
184
+ ## Description
185
+
186
+ A RegulationArticle entity is an article in a regulation. Dividing a regulation simplifies planning and execution.
187
+
188
+ ## Glossary
189
+
190
+ Egeria-Markdown
191
+
192
+ ## Folders
193
+
194
+ Writing Dr.Egeria Markdown
195
+
196
+ ## Usage
197
+
198
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
199
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
200
+ | Display Name | True | True | False | None | Name of the definition. | False | |
201
+ | Summary | False | True | False | None | Summary of the definition. | False | |
202
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
203
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
204
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
205
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
206
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
207
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
208
+ | Scope | False | True | False | None | Scope of the definition. | False | |
209
+ | Importance | False | True | False | None | Importance of the definition. | False | |
210
+ | Implications | False | True | False | None | List of implications. | False | |
211
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
212
+ | Results | False | True | False | None | A list of expected results. | False | |
213
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
214
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
215
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
216
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
217
+
218
+
219
+ ___
220
+
221
+ # Create Term
222
+ ## Term Name
223
+
224
+ Create Threat Definition
225
+
226
+ ## Description
227
+
228
+ The Threat entity describes a particular threat to the organization's operations that must either be guarded against or accommodated to reduce its impact.
229
+
230
+ ## Glossary
231
+
232
+ Egeria-Markdown
233
+
234
+ ## Folders
235
+
236
+ Writing Dr.Egeria Markdown
237
+
238
+ ## Usage
239
+
240
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
241
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
242
+ | Display Name | True | True | False | None | Name of the definition. | False | |
243
+ | Summary | False | True | False | None | Summary of the definition. | False | |
244
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
245
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
246
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
247
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
248
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
249
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
250
+ | Scope | False | True | False | None | Scope of the definition. | False | |
251
+ | Importance | False | True | False | None | Importance of the definition. | False | |
252
+ | Implications | False | True | False | None | List of implications. | False | |
253
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
254
+ | Results | False | True | False | None | A list of expected results. | False | |
255
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
256
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
257
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
258
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
259
+
260
+
261
+ ___
262
+
263
+ # Create Term
264
+ ## Term Name
265
+
266
+ Create Governance Policy
267
+
268
+ ## Description
269
+
270
+ Policies created in response to governance drivers. There are several types of policies.
271
+
272
+ ## Glossary
273
+
274
+ Egeria-Markdown
275
+
276
+ ## Folders
277
+
278
+ Writing Dr.Egeria Markdown
279
+
280
+ ## Usage
281
+
282
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
283
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
284
+ | Display Name | True | True | False | None | Name of the definition. | False | |
285
+ | Summary | False | True | False | None | Summary of the definition. | False | |
286
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
287
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
288
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
289
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
290
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
291
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
292
+ | Scope | False | True | False | None | Scope of the definition. | False | |
293
+ | Importance | False | True | False | None | Importance of the definition. | False | |
294
+ | Implications | False | True | False | None | List of implications. | False | |
295
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
296
+ | Results | False | True | False | None | A list of expected results. | False | |
297
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
298
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
299
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
300
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
301
+
302
+
303
+ ___
304
+
305
+ # Create Term
306
+ ## Term Name
307
+
308
+ Create Governance Principle
309
+
310
+ ## Description
311
+
312
+ The GovernancePrinciple entity defines a policy that describes an end state that the organization aims to achieve.
313
+
314
+ ## Glossary
315
+
316
+ Egeria-Markdown
317
+
318
+ ## Folders
319
+
320
+ Writing Dr.Egeria Markdown
321
+
322
+ ## Usage
323
+
324
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
325
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
326
+ | Display Name | True | True | False | None | Name of the definition. | False | |
327
+ | Summary | False | True | False | None | Summary of the definition. | False | |
328
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
329
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
330
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
331
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
332
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
333
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
334
+ | Scope | False | True | False | None | Scope of the definition. | False | |
335
+ | Importance | False | True | False | None | Importance of the definition. | False | |
336
+ | Implications | False | True | False | None | List of implications. | False | |
337
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
338
+ | Results | False | True | False | None | A list of expected results. | False | |
339
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
340
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
341
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
342
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
343
+
344
+
345
+ ___
346
+
347
+ # Create Term
348
+ ## Term Name
349
+
350
+ Create Governance Obligation
351
+
352
+ ## Description
353
+
354
+ The GovernanceObligation entity defines a policy that describes a requirement that must be met.
355
+
356
+ ## Glossary
357
+
358
+ Egeria-Markdown
359
+
360
+ ## Folders
361
+
362
+ Writing Dr.Egeria Markdown
363
+
364
+ ## Usage
365
+
366
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
367
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
368
+ | Display Name | True | True | False | None | Name of the definition. | False | |
369
+ | Summary | False | True | False | None | Summary of the definition. | False | |
370
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
371
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
372
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
373
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
374
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
375
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
376
+ | Scope | False | True | False | None | Scope of the definition. | False | |
377
+ | Importance | False | True | False | None | Importance of the definition. | False | |
378
+ | Implications | False | True | False | None | List of implications. | False | |
379
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
380
+ | Results | False | True | False | None | A list of expected results. | False | |
381
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
382
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
383
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
384
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
385
+
386
+
387
+ ___
388
+
389
+ # Create Term
390
+ ## Term Name
391
+
392
+ Create Governance Approach
393
+
394
+ ## Description
395
+
396
+ The GovernanceApproach entity defines a policy that describes a method that should be used for a particular activity.
397
+
398
+ ## Glossary
399
+
400
+ Egeria-Markdown
401
+
402
+ ## Folders
403
+
404
+ Writing Dr.Egeria Markdown
405
+
406
+ ## Usage
407
+
408
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
409
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
410
+ | Display Name | True | True | False | None | Name of the definition. | False | |
411
+ | Summary | False | True | False | None | Summary of the definition. | False | |
412
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
413
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
414
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
415
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
416
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
417
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
418
+ | Scope | False | True | False | None | Scope of the definition. | False | |
419
+ | Importance | False | True | False | None | Importance of the definition. | False | |
420
+ | Implications | False | True | False | None | List of implications. | False | |
421
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
422
+ | Results | False | True | False | None | A list of expected results. | False | |
423
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
424
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
425
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
426
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
427
+
428
+
429
+ ___
430
+
431
+ # Create Term
432
+ ## Term Name
433
+
434
+ Create Governance Control
435
+
436
+ ## Description
437
+
438
+ A governance control describes how a particular governance policy should be implemented. There are many types of controls.
439
+
440
+ ## Glossary
441
+
442
+ Egeria-Markdown
443
+
444
+ ## Folders
445
+
446
+ Writing Dr.Egeria Markdown
447
+
448
+ ## Usage
449
+
450
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
451
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
452
+ | Display Name | True | True | False | None | Name of the definition. | False | |
453
+ | Summary | False | True | False | None | Summary of the definition. | False | |
454
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
455
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
456
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
457
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
458
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
459
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
460
+ | Scope | False | True | False | None | Scope of the definition. | False | |
461
+ | Importance | False | True | False | None | Importance of the definition. | False | |
462
+ | Implications | False | True | False | None | List of implications. | False | |
463
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
464
+ | Results | False | True | False | None | A list of expected results. | False | |
465
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
466
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
467
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
468
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
469
+
470
+
471
+ ___
472
+
473
+ # Create Term
474
+ ## Term Name
475
+
476
+ Create Governance Metric
477
+
478
+ ## Description
479
+
480
+ A governance control describes how a particular governance policy should be implemented. There are many types of controls.
481
+
482
+ ## Glossary
483
+
484
+ Egeria-Markdown
485
+
486
+ ## Folders
487
+
488
+ Writing Dr.Egeria Markdown
489
+
490
+ ## Usage
491
+
492
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
493
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
494
+ | Display Name | True | True | False | None | Name of the definition. | False | |
495
+ | Summary | False | True | False | None | Summary of the definition. | False | |
496
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
497
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
498
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
499
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
500
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
501
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
502
+ | Scope | False | True | False | None | Scope of the definition. | False | |
503
+ | Importance | False | True | False | None | Importance of the definition. | False | |
504
+ | measurement | False | True | False | None | A measurement for a governance metric. | False | |
505
+ | target | False | True | False | None | Target values for a measurement. | False | |
506
+ | Implications | False | True | False | None | List of implications. | False | |
507
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
508
+ | Results | False | True | False | None | A list of expected results. | False | |
509
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
510
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
511
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
512
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
513
+
514
+
515
+ ___
516
+
517
+ # Create Term
518
+ ## Term Name
519
+
520
+ Create Governance Action
521
+
522
+ ## Description
523
+
524
+ An executable action, or sequence of actions to support a governance requirement.
525
+
526
+ ## Glossary
527
+
528
+ Egeria-Markdown
529
+
530
+ ## Folders
531
+
532
+ Writing Dr.Egeria Markdown
533
+
534
+ ## Usage
535
+
536
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
537
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
538
+ | Display Name | True | True | False | None | Name of the definition. | False | |
539
+ | Summary | False | True | False | None | Summary of the definition. | False | |
540
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
541
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
542
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
543
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
544
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
545
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
546
+ | Scope | False | True | False | None | Scope of the definition. | False | |
547
+ | Importance | False | True | False | None | Importance of the definition. | False | |
548
+ | Implications | False | True | False | None | List of implications. | False | |
549
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
550
+ | Results | False | True | False | None | A list of expected results. | False | |
551
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
552
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
553
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
554
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
555
+
556
+
557
+ ___
558
+
559
+ # Create Term
560
+ ## Term Name
561
+
562
+ Create Data Processing Purpose
563
+
564
+ ## Description
565
+
566
+ Privacy regulations such as (GDPR) require data subjects to agree the processing that is permitted on their data.
567
+
568
+ ## Glossary
569
+
570
+ Egeria-Markdown
571
+
572
+ ## Folders
573
+
574
+ Writing Dr.Egeria Markdown
575
+
576
+ ## Usage
577
+
578
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
579
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
580
+ | Display Name | True | True | False | None | Name of the definition. | False | |
581
+ | Summary | False | True | False | None | Summary of the definition. | False | |
582
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
583
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
584
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
585
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
586
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
587
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
588
+ | Scope | False | True | False | None | Scope of the definition. | False | |
589
+ | Importance | False | True | False | None | Importance of the definition. | False | |
590
+ | Implications | False | True | False | None | List of implications. | False | |
591
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
592
+ | Results | False | True | False | None | A list of expected results. | False | |
593
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
594
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
595
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
596
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
597
+
598
+
599
+ ___
600
+
601
+ # Create Term
602
+ ## Term Name
603
+
604
+ Create Governance Rule
605
+
606
+ ## Description
607
+
608
+ An executable rule that can be deployed at particular points in the operations.
609
+
610
+ ## Glossary
611
+
612
+ Egeria-Markdown
613
+
614
+ ## Folders
615
+
616
+ Writing Dr.Egeria Markdown
617
+
618
+ ## Usage
619
+
620
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
621
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
622
+ | Display Name | True | True | False | None | Name of the definition. | False | |
623
+ | Summary | False | True | False | None | Summary of the definition. | False | |
624
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
625
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
626
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
627
+ | Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
628
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
629
+ | Scope | False | True | False | None | Scope of the definition. | False | |
630
+ | Importance | False | True | False | None | Importance of the definition. | False | |
631
+ | Implementation Description | False | True | False | None | Describes how this governance control is implemnted. | False | |
632
+ | Supports Policies | False | True | False | None | The policies that this governance control supports. | False | |
633
+ | Implications | False | True | False | None | List of implications. | False | |
634
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
635
+ | Results | False | True | False | None | A list of expected results. | False | |
636
+ | Status | False | True | False | None | The status of the governance responsibility. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
637
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
638
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
639
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
640
+
641
+
642
+ ___
643
+
644
+ # Create Term
645
+ ## Term Name
646
+
647
+ Create Service Level Objectives
648
+
649
+ ## Description
650
+
651
+ Defines the performance, availability and quality levels expected by the element attached.
652
+
653
+ ## Glossary
654
+
655
+ Egeria-Markdown
656
+
657
+ ## Folders
658
+
659
+ Writing Dr.Egeria Markdown
660
+
661
+ ## Usage
662
+
663
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
664
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
665
+ | Display Name | True | True | False | None | Name of the definition. | False | |
666
+ | Summary | False | True | False | None | Summary of the definition. | False | |
667
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
668
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
669
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
670
+ | Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
671
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
672
+ | Scope | False | True | False | None | Scope of the definition. | False | |
673
+ | Importance | False | True | False | None | Importance of the definition. | False | |
674
+ | Implementation Description | False | True | False | None | Describes how this governance control is implemnted. | False | |
675
+ | Supports Policies | False | True | False | None | The policies that this governance control supports. | False | |
676
+ | Implications | False | True | False | None | List of implications. | False | |
677
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
678
+ | Results | False | True | False | None | A list of expected results. | False | |
679
+ | Status | False | True | False | None | The status of the governance responsibility. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
680
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
681
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
682
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
683
+
684
+
685
+ ___
686
+
687
+ # Create Term
688
+ ## Term Name
689
+
690
+ Create Governance Responsibility
691
+
692
+ ## Description
693
+
694
+ A responsibility assigned to an actor or team. It could be a requirement to take a certain action in specific circumstances or to make decisions or give approvals for actions.
695
+
696
+ ## Glossary
697
+
698
+ Egeria-Markdown
699
+
700
+ ## Folders
701
+
702
+ Writing Dr.Egeria Markdown
703
+
704
+ ## Usage
705
+
706
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
707
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
708
+ | Display Name | True | True | False | None | Name of the definition. | False | |
709
+ | Summary | False | True | False | None | Summary of the definition. | False | |
710
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
711
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
712
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
713
+ | Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
714
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
715
+ | Scope | False | True | False | None | Scope of the definition. | False | |
716
+ | Importance | False | True | False | None | Importance of the definition. | False | |
717
+ | Implementation Description | False | True | False | None | Describes how this governance control is implemnted. | False | |
718
+ | Supports Policies | False | True | False | None | The policies that this governance control supports. | False | |
719
+ | Implications | False | True | False | None | List of implications. | False | |
720
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
721
+ | Results | False | True | False | None | A list of expected results. | False | |
722
+ | Status | False | True | False | None | The status of the governance responsibility. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
723
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
724
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
725
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
726
+
727
+
728
+ ___
729
+
730
+ # Create Term
731
+ ## Term Name
732
+
733
+ Create Governance Procedure
734
+
735
+ ## Description
736
+
737
+ A manual procedure that is performed under certain circumstances.
738
+
739
+ ## Glossary
740
+
741
+ Egeria-Markdown
742
+
743
+ ## Folders
744
+
745
+ Writing Dr.Egeria Markdown
746
+
747
+ ## Usage
748
+
749
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
750
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
751
+ | Display Name | True | True | False | None | Name of the definition. | False | |
752
+ | Summary | False | True | False | None | Summary of the definition. | False | |
753
+ | Summary | False | True | False | None | Summary of the definition. | False | |
754
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
755
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
756
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
757
+ | Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
758
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
759
+ | Scope | False | True | False | None | Scope of the definition. | False | |
760
+ | Importance | False | True | False | None | Importance of the definition. | False | |
761
+ | Implementation Description | False | True | False | None | Describes how this governance control is implemnted. | False | |
762
+ | Supports Policies | False | True | False | None | The policies that this governance control supports. | False | |
763
+ | Implications | False | True | False | None | List of implications. | False | |
764
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
765
+ | Results | False | True | False | None | A list of expected results. | False | |
766
+ | Status | False | True | False | None | The status of the governance procedure. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
767
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
768
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
769
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
770
+
771
+
772
+ ___
773
+
774
+ # Create Term
775
+ ## Term Name
776
+
777
+ Create Security Access Control
778
+
779
+ ## Description
780
+
781
+ A technical control that defines the access control lists that an actor must belong to be entitled to perform a specific action.
782
+
783
+ ## Glossary
784
+
785
+ Egeria-Markdown
786
+
787
+ ## Folders
788
+
789
+ Writing Dr.Egeria Markdown
790
+
791
+ ## Usage
792
+
793
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
794
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
795
+ | Display Name | True | True | False | None | Name of the definition. | False | |
796
+ | Summary | False | True | False | None | Summary of the definition. | False | |
797
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
798
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
799
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
800
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
801
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
802
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
803
+ | Scope | False | True | False | None | Scope of the definition. | False | |
804
+ | Importance | False | True | False | None | Importance of the definition. | False | |
805
+ | Implications | False | True | False | None | List of implications. | False | |
806
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
807
+ | Results | False | True | False | None | A list of expected results. | False | |
808
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
809
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
810
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
811
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
812
+
813
+
814
+ ___
815
+
816
+ # Create Term
817
+ ## Term Name
818
+
819
+ Create Governance Zone
820
+
821
+ ## Description
822
+
823
+ A collection of assets that are used or processed in a specific way. Policies and controls can be attached to zones using the GovernedBy relationship.
824
+
825
+ ## Glossary
826
+
827
+ Egeria-Markdown
828
+
829
+ ## Folders
830
+
831
+ Writing Dr.Egeria Markdown
832
+
833
+ ## Usage
834
+
835
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
836
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
837
+ | Display Name | True | True | False | None | Name of the definition. | False | |
838
+ | Summary | False | True | False | None | Summary of the definition. | False | |
839
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
840
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
841
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
842
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
843
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
844
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
845
+ | Scope | False | True | False | None | Scope of the definition. | False | |
846
+ | Importance | False | True | False | None | Importance of the definition. | False | |
847
+ | criteria | False | True | False | None | The criteria for membership in a governance zone. | False | |
848
+ | Implications | False | True | False | None | List of implications. | False | |
849
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
850
+ | Results | False | True | False | None | A list of expected results. | False | |
851
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
852
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
853
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
854
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
855
+
856
+
857
+ ___
858
+
859
+ # Create Term
860
+ ## Term Name
861
+
862
+ Create Security Group
863
+
864
+ ## Description
865
+
866
+ A group of actors that need to be given the same access to a specific set of resources.
867
+
868
+ ## Glossary
869
+
870
+ Egeria-Markdown
871
+
872
+ ## Folders
873
+
874
+ Writing Dr.Egeria Markdown
875
+
876
+ ## Usage
877
+
878
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
879
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
880
+ | Display Name | True | True | False | None | Name of the definition. | False | |
881
+ | Summary | False | True | False | None | Summary of the definition. | False | |
882
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
883
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
884
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
885
+ | Identifier | False | True | False | None | A user supplied identifier for the governance definition. | False | |
886
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
887
+ | Usage | False | True | False | None | How the governance definition will be used. | False | |
888
+ | Scope | False | True | False | None | Scope of the definition. | False | |
889
+ | Importance | False | True | False | None | Importance of the definition. | False | |
890
+ | Implications | False | True | False | None | List of implications. | False | |
891
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
892
+ | Results | False | True | False | None | A list of expected results. | False | |
893
+ | Status | False | True | False | None | The status of the business imperative. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
894
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
895
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
896
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
897
+
898
+
899
+ ___
900
+
901
+ # Create Term
902
+ ## Term Name
903
+
904
+ Create Naming Standard Rule
905
+
906
+ ## Description
907
+
908
+ A standard for naming specific kinds of resources.
909
+
910
+ ## Glossary
911
+
912
+ Egeria-Markdown
913
+
914
+ ## Folders
915
+
916
+ Writing Dr.Egeria Markdown
917
+
918
+ ## Usage
919
+
920
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
921
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
922
+ | Display Name | True | True | False | None | Name of the definition. | False | |
923
+ | Summary | False | True | False | None | Summary of the definition. | False | |
924
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
925
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
926
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
927
+ | Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
928
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
929
+ | Scope | False | True | False | None | Scope of the definition. | False | |
930
+ | Importance | False | True | False | None | Importance of the definition. | False | |
931
+ | Implementation Description | False | True | False | None | Describes how this governance control is implemnted. | False | |
932
+ | Supports Policies | False | True | False | None | The policies that this governance control supports. | False | |
933
+ | Name Patterns | False | True | False | None | List of implications. | False | |
934
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
935
+ | Results | False | True | False | None | A list of expected results. | False | |
936
+ | Status | False | True | False | None | The status of the naming standard rule. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
937
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
938
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
939
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
940
+
941
+
942
+ ___
943
+
944
+ # Create Term
945
+ ## Term Name
946
+
947
+ Link Terms & Conditions
948
+
949
+ ## Description
950
+
951
+ Attach or detach an agreement to a defined set of terms and conditions.
952
+
953
+ ## Glossary
954
+
955
+ Egeria-Markdown
956
+
957
+ ## Folders
958
+
959
+ Writing Dr.Egeria Markdown
960
+
961
+ ## Usage
962
+
963
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
964
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
965
+ | Agreement Name | True | True | False | None | The name of the agreement to add an item to. Using qualified names is recommended. | False | |
966
+ | Identifier | False | True | False | None | A user specified identifier. | False | |
967
+ | Domain Identifier | False | True | False | None | The governance domain of the governance definition. | False | |
968
+ | T&C Definition Name | True | True | False | None | The name of the Terms and Conditions definition that governans an agreement. Using qualified names is recommended. | False | |
969
+ | Implementation Description | False | True | False | None | How the Terms and Conditions are implemented. | False | |
970
+ | Agreement Start | False | True | False | None | The start date of the agreement as an ISO 8601 string. | False | |
971
+ | Agreement End | False | True | False | None | The end date of the agreement as an ISO 8601 string. | False | |
972
+ | Restrictions | False | True | False | None | A dictionary of property:value pairs describing restrictions. | False | |
973
+ | Obligations | False | True | False | None | A dictionary of property:value pairs describing obligations. | False | |
974
+ | Entitlements | False | True | False | None | A dictionary of property:value pairs describing entitlements. | False | |
975
+ | Usage Measurements | False | True | False | None | A dictionary of property:value pairs describing usage measurements. | False | |
976
+
977
+
978
+ ___
979
+
980
+ # Create Term
981
+ ## Term Name
982
+
983
+ Create Certification Type
984
+
985
+ ## Description
986
+
987
+ A type of certification.
988
+
989
+ ## Glossary
990
+
991
+ Egeria-Markdown
992
+
993
+ ## Folders
994
+
995
+ Writing Dr.Egeria Markdown
996
+
997
+ ## Usage
998
+
999
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1000
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1001
+ | Display Name | True | True | False | None | Name of the definition. | False | |
1002
+ | Summary | False | True | False | None | Summary of the definition. | False | |
1003
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
1004
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
1005
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
1006
+ | Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
1007
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
1008
+ | Scope | False | True | False | None | Scope of the definition. | False | |
1009
+ | Importance | False | True | False | None | Importance of the definition. | False | |
1010
+ | Details | False | True | False | None | Details of the certification. | False | |
1011
+ | Implications | False | True | False | None | List of implications. | False | |
1012
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
1013
+ | Results | False | True | False | None | A list of expected results. | False | |
1014
+ | Status | False | True | False | None | The status of the certification type. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
1015
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
1016
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
1017
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
1018
+
1019
+
1020
+ ___
1021
+
1022
+ # Create Term
1023
+ ## Term Name
1024
+
1025
+ Create License Type
1026
+
1027
+ ## Description
1028
+
1029
+ A type of license.
1030
+
1031
+ ## Glossary
1032
+
1033
+ Egeria-Markdown
1034
+
1035
+ ## Folders
1036
+
1037
+ Writing Dr.Egeria Markdown
1038
+
1039
+ ## Usage
1040
+
1041
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1042
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1043
+ | Display Name | True | True | False | None | Name of the definition. | False | |
1044
+ | Summary | False | True | False | None | Summary of the definition. | False | |
1045
+ | Description | False | True | False | None | Description of the contents of the definition. | False | |
1046
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
1047
+ | Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
1048
+ | Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
1049
+ | Version Identifier | False | True | False | None | Published version identifier. | False | |
1050
+ | Scope | False | True | False | None | Scope of the definition. | False | |
1051
+ | Importance | False | True | False | None | Importance of the definition. | False | |
1052
+ | Details | False | True | False | None | Details of the license. | False | |
1053
+ | Implications | False | True | False | None | List of implications. | False | |
1054
+ | Outcomes | False | True | False | None | List of desired outcomes. | False | |
1055
+ | Results | False | True | False | None | A list of expected results. | False | |
1056
+ | Status | False | True | False | None | The status of the license type definition. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
1057
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
1058
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
1059
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
1060
+
1061
+
1062
+ ___
1063
+
1064
+ # Create Term
1065
+ ## Term Name
1066
+
1067
+ Link Governed By
1068
+
1069
+ ## Description
1070
+
1071
+ A referenceable element can be governed by one or more governance definitions.
1072
+
1073
+ ## Glossary
1074
+
1075
+ Egeria-Markdown
1076
+
1077
+ ## Folders
1078
+
1079
+ Writing Dr.Egeria Markdown
1080
+
1081
+ ## Usage
1082
+
1083
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1084
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1085
+ | Governance Definition | True | True | False | None | The governance definition providing governance. | False | |
1086
+ | Referenceable | No | No | No | None | | No | [] |
1087
+ | Link Label | False | True | False | None | Labels the link between two elements. | False | |
1088
+ | Description | False | True | False | None | A description of the relationship. | False | |
1089
+
1090
+
1091
+ ___
1092
+
1093
+ # Create Term
1094
+ ## Term Name
1095
+
1096
+ Link License
1097
+
1098
+ ## Description
1099
+
1100
+ A license relationship between a license type and a Referencable element.
1101
+
1102
+ ## Glossary
1103
+
1104
+ Egeria-Markdown
1105
+
1106
+ ## Folders
1107
+
1108
+ Writing Dr.Egeria Markdown
1109
+
1110
+ ## Usage
1111
+
1112
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1113
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1114
+ | License Type | True | True | False | None | The license type being used for the license. | False | |
1115
+ | Referenceable | True | True | False | None | The object being licensed. | False | |
1116
+ | License GUID | False | True | False | None | Unique identifier of the license. | True | |
1117
+ | Start Date | False | True | False | None | Date at which the license takes effect. | False | |
1118
+ | End Date | False | True | False | None | Date at which the license expires. | False | |
1119
+ | Conditions | False | True | False | None | License conditions. | False | |
1120
+ | Licensed By | False | True | False | None | | False | |
1121
+ | Licensed By Type Name | False | True | False | None | | False | |
1122
+ | Licensed By Property Name | False | True | False | None | | False | |
1123
+ | Custodian | False | True | False | None | Custodian of the license. | False | |
1124
+ | Custodian Type Name | False | True | False | None | | False | |
1125
+ | Custodian Property Name | False | True | False | None | | False | |
1126
+ | Licensee | False | True | False | None | The licensee. | False | |
1127
+ | Licensee Type Name | False | True | False | None | | False | |
1128
+ | Licensee Property Name | False | True | False | None | | False | |
1129
+ | Entitlements | False | True | False | None | What the license grants to the licensee. | False | |
1130
+ | Restrictions | False | True | False | None | Restrictions imposed by the license. | False | |
1131
+ | Obligations | False | True | False | None | Obligations defined by the license. | False | |
1132
+ | Notes | False | True | False | None | Notes about the license. | False | |
1133
+
1134
+
1135
+ ___
1136
+
1137
+ # Create Term
1138
+ ## Term Name
1139
+
1140
+ Link Certification
1141
+
1142
+ ## Description
1143
+
1144
+ A certification relationship between a certification type and a referenceable element.
1145
+
1146
+ ## Glossary
1147
+
1148
+ Egeria-Markdown
1149
+
1150
+ ## Folders
1151
+
1152
+ Writing Dr.Egeria Markdown
1153
+
1154
+ ## Usage
1155
+
1156
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1157
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1158
+ | Certification Type | True | True | False | None | The license type being used for the license. | False | |
1159
+ | Referenceable | True | True | False | None | The object being certified. | False | |
1160
+ | Certificate GUID | False | True | False | None | Unique identifier of the certificate. | True | |
1161
+ | Start Date | False | True | False | None | Date at which the certification takes effect. | False | |
1162
+ | End Date | False | True | False | None | Date at which the certification expires. | False | |
1163
+ | Conditions | False | True | False | None | Certification conditions. | False | |
1164
+ | Certified By | False | True | False | None | | False | |
1165
+ | Certified By Type Name | False | True | False | None | | False | |
1166
+ | Certified By Property Name | False | True | False | None | | False | |
1167
+ | Custodian | False | True | False | None | Custodian of the certification. | False | |
1168
+ | Custodian Type Name | False | True | False | None | | False | |
1169
+ | Custodian Property Name | False | True | False | None | | False | |
1170
+ | Recipient | False | True | False | None | The receiver of the certification. | False | |
1171
+ | Recipient Type Name | False | True | False | None | | False | |
1172
+ | Recipient Property Name | False | True | False | None | | False | |
1173
+ | Notes | False | True | False | None | Notes about the certification. | False | |
1174
+
1175
+
1176
+ ___
1177
+
1178
+ # Create Term
1179
+ ## Term Name
1180
+
1181
+ Link Regulation Certification Type
1182
+
1183
+ ## Description
1184
+
1185
+ A certification type addressing a specific regulation.
1186
+
1187
+ ## Glossary
1188
+
1189
+ Egeria-Markdown
1190
+
1191
+ ## Folders
1192
+
1193
+ Writing Dr.Egeria Markdown
1194
+
1195
+ ## Usage
1196
+
1197
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1198
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1199
+ | Certification Type | True | True | False | None | The license type being used for the license. | False | |
1200
+ | Regulation | True | True | False | None | The regulation that a certification type addresses. | False | |
1201
+
1202
+
1203
+ ___
1204
+
1205
+ # Create Term
1206
+ ## Term Name
1207
+
1208
+ Link Agreement->T&C
1209
+
1210
+ ## Description
1211
+
1212
+ Attach or detach an agreement to a defined set of terms and conditions.
1213
+
1214
+ ## Glossary
1215
+
1216
+ Egeria-Markdown
1217
+
1218
+ ## Folders
1219
+
1220
+ Writing Dr.Egeria Markdown
1221
+
1222
+ ## Usage
1223
+
1224
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1225
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1226
+ | Agreement Name | True | True | False | None | The name of the agreement to add an item to. Using qualified names is recommended. | False | |
1227
+ | Identifier | False | True | False | None | A user specified identifier. | False | |
1228
+ | Domain Identifier | False | True | False | None | The governance domain of the governance definition. | False | |
1229
+ | T&C Definition Name | True | True | False | None | The name of the Terms and Conditions definition that governans an agreement. Using qualified names is recommended. | False | |
1230
+ | Implementation Description | False | True | False | None | How the Terms and Conditions are implemented. | False | |
1231
+ | Agreement Start | False | True | False | None | The start date of the agreement as an ISO 8601 string. | False | |
1232
+ | Agreement End | False | True | False | None | The end date of the agreement as an ISO 8601 string. | False | |
1233
+ | Restrictions | False | True | False | None | A dictionary of property:value pairs describing restrictions. | False | |
1234
+ | Obligations | False | True | False | None | A dictionary of property:value pairs describing obligations. | False | |
1235
+ | Entitlements | False | True | False | None | A dictionary of property:value pairs describing entitlements. | False | |
1236
+ | Usage Measurements | False | True | False | None | A dictionary of property:value pairs describing usage measurements. | False | |
1237
+
1238
+
1239
+ ___
1240
+
1241
+ # Create Term
1242
+ ## Term Name
1243
+
1244
+ Link Governance Drivers
1245
+
1246
+ ## Description
1247
+
1248
+ Link peer governance drivers with the GovernanceDriverLink relationship. Drivers are: GovernanceStrategy, BusinessImperitive, Regulation, RegulationArticle, Threat.
1249
+
1250
+ ## Glossary
1251
+
1252
+ Egeria-Markdown
1253
+
1254
+ ## Folders
1255
+
1256
+ Writing Dr.Egeria Markdown
1257
+
1258
+ ## Usage
1259
+
1260
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1261
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1262
+ | Definition 1 | True | True | False | None | The first governance driver to link. | False | |
1263
+ | Definition 2 | True | True | False | None | The second governance driver to link. | False | |
1264
+ | Link Label | False | True | False | None | Labels the link between two governance defninitions. | False | |
1265
+ | Description | False | True | False | None | A description of the relationship. | False | |
1266
+
1267
+
1268
+ ___
1269
+
1270
+ # Create Term
1271
+ ## Term Name
1272
+
1273
+ Link Governance Response
1274
+
1275
+ ## Description
1276
+
1277
+ Links Policies as a response to governance Drivers.
1278
+
1279
+ ## Glossary
1280
+
1281
+ Egeria-Markdown
1282
+
1283
+ ## Folders
1284
+
1285
+ Writing Dr.Egeria Markdown
1286
+
1287
+ ## Usage
1288
+
1289
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1290
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1291
+ | Definition 1 | True | True | False | None | The first governance driver to link. | False | |
1292
+ | Definition 2 | True | True | False | None | The second governance driver to link. | False | |
1293
+ | Link Label | False | True | False | None | Labels the link between two governance defninitions. | False | |
1294
+ | Description | False | True | False | None | A description of the relationship. | False | |
1295
+ | Rationale | False | True | False | None | The rationale for using this control to support this policy. | False | |
1296
+
1297
+
1298
+ ___
1299
+
1300
+ # Create Term
1301
+ ## Term Name
1302
+
1303
+ Link Security Group -> Security Access Control
1304
+
1305
+ ## Description
1306
+
1307
+ Establishes that a Security Access Control applies to this Security Group.
1308
+
1309
+ ## Glossary
1310
+
1311
+ Egeria-Markdown
1312
+
1313
+ ## Folders
1314
+
1315
+ Writing Dr.Egeria Markdown
1316
+
1317
+ ## Usage
1318
+
1319
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1320
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1321
+ | Definition 1 | True | True | False | None | The first governance policy to link. | False | |
1322
+ | Definition 2 | True | True | False | None | The second governance policy to link. | False | |
1323
+ | Link Label | False | True | False | None | Labels the link between two governance defninitions. | False | |
1324
+ | Description | False | True | False | None | A description of the relationship. | False | |
1325
+ | Operation Name | False | True | False | None | The name of the operation controled by the SecurityAccessControl. | False | |
1326
+
1327
+
1328
+ ___
1329
+
1330
+ # Create Term
1331
+ ## Term Name
1332
+
1333
+ Link Governance Mechanism
1334
+
1335
+ ## Description
1336
+
1337
+ Link a governance policy to a governance control that supports it. The GovernanceMechanism relationship is used.
1338
+
1339
+ ## Glossary
1340
+
1341
+ Egeria-Markdown
1342
+
1343
+ ## Folders
1344
+
1345
+ Writing Dr.Egeria Markdown
1346
+
1347
+ ## Usage
1348
+
1349
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1350
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1351
+ | Definition 1 | True | True | False | None | The first governance policy to link. | False | |
1352
+ | Definition 2 | True | True | False | None | The second governance policy to link. | False | |
1353
+ | Link Label | False | True | False | None | Labels the link between two governance defninitions. | False | |
1354
+ | Description | False | True | False | None | A description of the relationship. | False | |
1355
+ | Rationale | False | True | False | None | The rationale for using this control to support this policy. | False | |
1356
+
1357
+
1358
+ ___
1359
+
1360
+ # Create Term
1361
+ ## Term Name
1362
+
1363
+ Link Governance Controls
1364
+
1365
+ ## Description
1366
+
1367
+ Link peer governance controls with the GovernanceControlLink relationship. Controls types are: GovernanceRule, GovernanceProcess, GovernanceResponsibility, GovernanceProcedure, SecurityAccessControl, SecurityGroup.
1368
+
1369
+ ## Glossary
1370
+
1371
+ Egeria-Markdown
1372
+
1373
+ ## Folders
1374
+
1375
+ Writing Dr.Egeria Markdown
1376
+
1377
+ ## Usage
1378
+
1379
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1380
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1381
+ | Control Definition 1 | True | True | False | None | The first governance control to link. | False | |
1382
+ | Control Definition 2 | True | True | False | None | The fsecond governance control to link. | False | |
1383
+ | Link Label | False | True | False | None | Labels the link between two governance defninitions. | False | |
1384
+ | Description | False | True | False | None | A description of the relationship. | False | |
1385
+
1386
+
1387
+ ___
1388
+
1389
+ # Create Term
1390
+ ## Term Name
1391
+
1392
+ Link Zone->Zone
1393
+
1394
+ ## Description
1395
+
1396
+ Links child governance zones to parent governance zone.
1397
+
1398
+ ## Glossary
1399
+
1400
+ Egeria-Markdown
1401
+
1402
+ ## Folders
1403
+
1404
+ Writing Dr.Egeria Markdown
1405
+
1406
+ ## Usage
1407
+
1408
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1409
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1410
+ | Control Definition 1 | True | True | False | None | The first governance control to link. | False | |
1411
+ | Control Definition 2 | True | True | False | None | The fsecond governance control to link. | False | |
1412
+ | Link Label | False | True | False | None | Labels the link between two governance defninitions. | False | |
1413
+ | Description | False | True | False | None | A description of the relationship. | False | |
1414
+
1415
+
1416
+ ___
1417
+
1418
+ # Create Term
1419
+ ## Term Name
1420
+
1421
+ View Governance Definition Context
1422
+
1423
+ ## Description
1424
+
1425
+ List information about a governance definition and its related elements.
1426
+
1427
+ ## Glossary
1428
+
1429
+ Egeria-Markdown
1430
+
1431
+ ## Folders
1432
+
1433
+ Writing Dr.Egeria Markdown
1434
+
1435
+ ## Usage
1436
+
1437
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1438
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1439
+ | Display Name | True | True | False | None | The unique name of the governance definition to display information for. | False | |
1440
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; MERMAID; DICT |
1441
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
1442
+ | Sort Order | False | True | False | None | How to order the results. The sort order can be selected from a list of valid value. | False | ANY; CREATION_DATE_RECENT; CREATION_DATA_OLDEST; LAST_UPDATE_RECENT; LAST_UPDATE_OLDEST; PROPERTY_ASCENDING; PROPERTY_DESCENDING |
1443
+ | Order Property Name | False | True | False | None | The property to use for sorting if the sort_order_property is PROPERTY_ASCENDING or PROPERTY_DESCENDING | False | |
1444
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
1445
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
1446
+
1447
+
1448
+ ___
1449
+
1450
+ # Create Term
1451
+ ## Term Name
1452
+
1453
+ Create External Reference
1454
+
1455
+ ## Description
1456
+
1457
+ Create or update External Reference Elements - or sub-types Related Media, Cited Documents, External Data Source and External Model Source.
1458
+
1459
+ ## Glossary
1460
+
1461
+ Egeria-Markdown
1462
+
1463
+ ## Folders
1464
+
1465
+ Writing Dr.Egeria Markdown
1466
+
1467
+ ## Usage
1468
+
1469
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1470
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1471
+ | Display Name | True | True | False | None | Name of the digital product | False | |
1472
+ | Description | False | True | False | None | Description of the contents of a product. | False | |
1473
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
1474
+ | Reference Title | False | True | False | None | Title of the external reference. | False | |
1475
+ | Reference Abstract | False | True | False | None | Abstract for the remote reference. | False | |
1476
+ | Authors | False | True | False | None | A list of authors. | False | |
1477
+ | Organization | False | True | False | None | Organization owning the external reference. | False | |
1478
+ | URL | False | True | False | None | URL to access the external reference. | False | |
1479
+ | Sources | False | True | False | None | A map of source strings. | False | |
1480
+ | License | False | True | False | None | The license associated with the external reference. | False | |
1481
+ | Copyright | False | True | False | None | The copy right associated with the external reference. | False | |
1482
+ | Attribution | False | True | False | None | Attribution string to describe the external reference. | False | |
1483
+ | Version Identifier | False | True | False | None | Published product version identifier. | False | |
1484
+ | Classifications | False | True | False | None | Optionally specify the initial classifications for a collection. Multiple classifications can be specified. | False | |
1485
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
1486
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
1487
+
1488
+
1489
+ ___
1490
+
1491
+ # Create Term
1492
+ ## Term Name
1493
+
1494
+ Create External Data Source
1495
+
1496
+ ## Description
1497
+
1498
+ An external data source.
1499
+
1500
+ ## Glossary
1501
+
1502
+ Egeria-Markdown
1503
+
1504
+ ## Folders
1505
+
1506
+ Writing Dr.Egeria Markdown
1507
+
1508
+ ## Usage
1509
+
1510
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1511
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1512
+ | Display Name | True | True | False | None | Name of the digital product | False | |
1513
+ | Description | False | True | False | None | Description of the contents of a product. | False | |
1514
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
1515
+ | Reference Title | False | True | False | None | Title of the external reference. | False | |
1516
+ | Reference Abstract | False | True | False | None | Abstract for the remote reference. | False | |
1517
+ | Authors | False | True | False | None | A list of authors. | False | |
1518
+ | Organization | False | True | False | None | Organization owning the external reference. | False | |
1519
+ | URL | False | True | False | None | URL to access the external reference. | False | |
1520
+ | Sources | False | True | False | None | A map of source strings. | False | |
1521
+ | License | False | True | False | None | The license associated with the external reference. | False | |
1522
+ | Copyright | False | True | False | None | The copy right associated with the external reference. | False | |
1523
+ | Attribution | False | True | False | None | Attribution string to describe the external reference. | False | |
1524
+ | Version Identifier | False | True | False | None | Published product version identifier. | False | |
1525
+ | Classifications | False | True | False | None | Optionally specify the initial classifications for a collection. Multiple classifications can be specified. | False | |
1526
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
1527
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
1528
+
1529
+
1530
+ ___
1531
+
1532
+ # Create Term
1533
+ ## Term Name
1534
+
1535
+ Create External Model Source
1536
+
1537
+ ## Description
1538
+
1539
+ An external model.
1540
+
1541
+ ## Glossary
1542
+
1543
+ Egeria-Markdown
1544
+
1545
+ ## Folders
1546
+
1547
+ Writing Dr.Egeria Markdown
1548
+
1549
+ ## Usage
1550
+
1551
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1552
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1553
+ | Display Name | True | True | False | None | Name of the digital product | False | |
1554
+ | Description | False | True | False | None | Description of the contents of a product. | False | |
1555
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
1556
+ | Reference Title | False | True | False | None | Title of the external reference. | False | |
1557
+ | Reference Abstract | False | True | False | None | Abstract for the remote reference. | False | |
1558
+ | Authors | False | True | False | None | A list of authors. | False | |
1559
+ | Organization | False | True | False | None | Organization owning the external reference. | False | |
1560
+ | URL | False | True | False | None | URL to access the external reference. | False | |
1561
+ | Sources | False | True | False | None | A map of source strings. | False | |
1562
+ | License | False | True | False | None | The license associated with the external reference. | False | |
1563
+ | Copyright | False | True | False | None | The copy right associated with the external reference. | False | |
1564
+ | Attribution | False | True | False | None | Attribution string to describe the external reference. | False | |
1565
+ | Version Identifier | False | True | False | None | Published product version identifier. | False | |
1566
+ | Classifications | False | True | False | None | Optionally specify the initial classifications for a collection. Multiple classifications can be specified. | False | |
1567
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
1568
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
1569
+
1570
+
1571
+ ___
1572
+
1573
+ # Create Term
1574
+ ## Term Name
1575
+
1576
+ Create Related Media
1577
+
1578
+ ## Description
1579
+
1580
+ Related external media.
1581
+
1582
+ ## Glossary
1583
+
1584
+ Egeria-Markdown
1585
+
1586
+ ## Folders
1587
+
1588
+ Writing Dr.Egeria Markdown
1589
+
1590
+ ## Usage
1591
+
1592
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1593
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1594
+ | Display Name | True | True | False | None | Name of the digital product | False | |
1595
+ | Description | False | True | False | None | Description of the contents of a product. | False | |
1596
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
1597
+ | Reference Title | False | True | False | None | Title of the external reference. | False | |
1598
+ | Reference Abstract | False | True | False | None | Abstract for the remote reference. | False | |
1599
+ | Authors | False | True | False | None | A list of authors. | False | |
1600
+ | Organization | False | True | False | None | Organization owning the external reference. | False | |
1601
+ | URL | False | True | False | None | URL to access the external reference. | False | |
1602
+ | Sources | False | True | False | None | A map of source strings. | False | |
1603
+ | License | False | True | False | None | The license associated with the external reference. | False | |
1604
+ | Copyright | False | True | False | None | The copy right associated with the external reference. | False | |
1605
+ | Attribution | False | True | False | None | Attribution string to describe the external reference. | False | |
1606
+ | Media Type | False | True | False | None | Type of media. | False | IMAGE; AUDIO; DOCUMENT; VIDEO; OTHER |
1607
+ | Media Type Other Id | False | True | False | None | An id associated with the media type. | False | |
1608
+ | Default Media Usage | False | True | False | None | How the media is being used. | False | ICON; THUMBNAIL; ILLUSTRATION; USAGE_GUIDANCE; OTHER |
1609
+ | default Media Usage Other Id | False | True | False | None | An id associated with the media usage. | False | |
1610
+ | Version Identifier | False | True | False | None | Published product version identifier. | False | |
1611
+ | Classifications | False | True | False | None | Optionally specify the initial classifications for a collection. Multiple classifications can be specified. | False | |
1612
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
1613
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
1614
+
1615
+
1616
+ ___
1617
+
1618
+ # Create Term
1619
+ ## Term Name
1620
+
1621
+ Create Cited Document
1622
+
1623
+ ## Description
1624
+
1625
+ A cited document
1626
+
1627
+ ## Glossary
1628
+
1629
+ Egeria-Markdown
1630
+
1631
+ ## Folders
1632
+
1633
+ Writing Dr.Egeria Markdown
1634
+
1635
+ ## Usage
1636
+
1637
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1638
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1639
+ | Display Name | True | True | False | None | Name of the digital product | False | |
1640
+ | Description | False | True | False | None | Description of the contents of a product. | False | |
1641
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
1642
+ | Reference Title | False | True | False | None | Title of the external reference. | False | |
1643
+ | Reference Abstract | False | True | False | None | Abstract for the remote reference. | False | |
1644
+ | Authors | False | True | False | None | A list of authors. | False | |
1645
+ | Organization | False | True | False | None | Organization owning the external reference. | False | |
1646
+ | URL | False | True | False | None | URL to access the external reference. | False | |
1647
+ | Sources | False | True | False | None | A map of source strings. | False | |
1648
+ | License | False | True | False | None | The license associated with the external reference. | False | |
1649
+ | Copyright | False | True | False | None | The copy right associated with the external reference. | False | |
1650
+ | Attribution | False | True | False | None | Attribution string to describe the external reference. | False | |
1651
+ | Number of Pages | False | True | False | None | The number of pages in the document. | False | |
1652
+ | Page Range | False | True | False | None | The range of pages cited. | False | |
1653
+ | Publication Series | False | True | False | None | The series this publication is part of. | False | |
1654
+ | Publication Series Volume | False | True | False | None | The volume in the series that contains the citation. | False | |
1655
+ | Publisher | False | True | False | None | The name of the publisher. | False | |
1656
+ | Edition | False | True | False | None | The edition being cited. | False | |
1657
+ | First Publication Date | False | True | False | None | Date of first publication written as an ISO string - 2025-01-31 | False | |
1658
+ | Publication Date | False | True | False | None | Publication date. In ISO 8601 format - 2025-02-23. | False | |
1659
+ | Publication City | False | True | False | None | City of publication. | False | |
1660
+ | Publication Year | False | True | False | None | Year of publication. | False | |
1661
+ | Publication Numbers | False | True | False | None | Identification numbers of the publication, if relevant. | False | |
1662
+ | Version Identifier | False | True | False | None | Published product version identifier. | False | |
1663
+ | Classifications | False | True | False | None | Optionally specify the initial classifications for a collection. Multiple classifications can be specified. | False | |
1664
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
1665
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
1666
+
1667
+
1668
+ ___
1669
+
1670
+ # Create Term
1671
+ ## Term Name
1672
+
1673
+ Link External Reference Link
1674
+
1675
+ ## Description
1676
+
1677
+ Link an external reference to a referenceable.
1678
+
1679
+ ## Glossary
1680
+
1681
+ Egeria-Markdown
1682
+
1683
+ ## Folders
1684
+
1685
+ Writing Dr.Egeria Markdown
1686
+
1687
+ ## Usage
1688
+
1689
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1690
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1691
+ | Element Name | True | True | False | None | A referenceable to link. | False | |
1692
+ | External Reference | True | True | False | None | The external reference to link to. | False | |
1693
+ | Label | False | True | False | None | Labels the link between the referenceable and the external reference. | False | |
1694
+ | Description | False | True | False | None | A description of the link. | False | |
1695
+
1696
+
1697
+ ___
1698
+
1699
+ # Create Term
1700
+ ## Term Name
1701
+
1702
+ Link Media Reference Link
1703
+
1704
+ ## Description
1705
+
1706
+ Link a medial reference to a referenceable.
1707
+
1708
+ ## Glossary
1709
+
1710
+ Egeria-Markdown
1711
+
1712
+ ## Folders
1713
+
1714
+ Writing Dr.Egeria Markdown
1715
+
1716
+ ## Usage
1717
+
1718
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1719
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1720
+ | Element Name | True | True | False | None | A referenceable to link. | False | |
1721
+ | Media Reference | True | True | False | None | The media reference to link to. | False | |
1722
+ | Label | False | True | False | None | Labels the link between the referenceable and the media reference. | False | |
1723
+ | Description | False | True | False | None | A description of the link. | False | |
1724
+ | Media Id | False | True | False | None | An identifier of the media to link to. | False | |
1725
+ | Media Usage | False | True | False | None | How the media is being used. | False | ICON; THUMBNAIL; ILLUSTRATION; USAGE_GUIDANCE; OTHER |
1726
+ | Media Usage Other Id | False | True | False | None | An id associated with the media usage. | False | |
1727
+
1728
+
1729
+ ___
1730
+
1731
+ # Create Term
1732
+ ## Term Name
1733
+
1734
+ Link Cited Document Link
1735
+
1736
+ ## Description
1737
+
1738
+ Link a cited document reference to a referenceable.
1739
+
1740
+ ## Glossary
1741
+
1742
+ Egeria-Markdown
1743
+
1744
+ ## Folders
1745
+
1746
+ Writing Dr.Egeria Markdown
1747
+
1748
+ ## Usage
1749
+
1750
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1751
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1752
+ | Element Name | True | True | False | None | A referenceable to link. | False | |
1753
+ | Cited Document | True | True | False | None | The cited document to link to. | False | |
1754
+ | Label | False | True | False | None | Labels the link between the referenceable and the media reference. | False | |
1755
+ | Description | False | True | False | None | A description of the link. | False | |
1756
+ | Reference Id | False | True | False | None | An identifier of the cited document to link to. | False | |
1757
+ | Pages | False | True | False | None | The pages referenced. | False | |
1758
+
1759
+
1760
+ ___
1761
+
1762
+ # Create Term
1763
+ ## Term Name
1764
+
1765
+ View External References
1766
+
1767
+ ## Description
1768
+
1769
+ List external references (and subtypes).
1770
+
1771
+ ## Glossary
1772
+
1773
+ Egeria-Markdown
1774
+
1775
+ ## Folders
1776
+
1777
+ Writing Dr.Egeria Markdown
1778
+
1779
+ ## Usage
1780
+
1781
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1782
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1783
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
1784
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; DICT; MD; MERMAID; HTML |
1785
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
1786
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
1787
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
1788
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
1789
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
1790
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
1791
+
1792
+
1793
+ ___
1794
+
1795
+ # Create Term
1796
+ ## Term Name
1797
+
1798
+ Create Collection
1799
+
1800
+ ## Description
1801
+
1802
+ Create or update a generic collection. While it can be used to create specific kinds of collections, you cannot set the collection-specific properties - so use the appropriate Dr.Egeria command to set all of the properties.
1803
+
1804
+ ## Glossary
1805
+
1806
+ Egeria-Markdown
1807
+
1808
+ ## Folders
1809
+
1810
+ Writing Dr.Egeria Markdown
1811
+
1812
+ ## Usage
1813
+
1814
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1815
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1816
+ | Display Name | True | True | False | None | Name of the digital product | False | |
1817
+ | Description | False | True | False | None | Description of the contents of a product. | False | |
1818
+ | Classifications | False | True | False | None | Optionally specify the initial classifications for a collection. Multiple classifications can be specified. | False | |
1819
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
1820
+ | Version Identifier | False | True | False | None | Published product version identifier. | False | |
1821
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
1822
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
1823
+
1824
+
1825
+ ___
1826
+
1827
+ # Create Term
1828
+ ## Term Name
1829
+
1830
+ Create Digital Product
1831
+
1832
+ ## Description
1833
+
1834
+ A Data Dictionary is an organized and curated collection of data definitions that can serve as a reference for data professionals
1835
+
1836
+ ## Glossary
1837
+
1838
+ Egeria-Markdown
1839
+
1840
+ ## Folders
1841
+
1842
+ Writing Dr.Egeria Markdown
1843
+
1844
+ ## Usage
1845
+
1846
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1847
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1848
+ | Display Name | True | True | False | None | Name of the digital product | False | |
1849
+ | Description | False | True | False | None | Description of the contents of a product. | False | |
1850
+ | Product Name | False | True | False | None | The external name of the digital product. | False | |
1851
+ | Status | False | True | False | None | The status of the digital product. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; APPROVED_CONCEPT; UNDER_DEVELOPMENT; DEVELOPMENT_COMPLETE; APPROVED_FOR_DEPLOYMENT; ACTIVE; DISABLED; DEPRECATED; OTHER |
1852
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
1853
+ | Category | False | True | False | None | Type of product - periodic, delta, snapshot, etc. May also be user specified. | False | |
1854
+ | Identifier | False | True | False | None | User specified product identifier. | False | |
1855
+ | Maturity | False | True | False | None | Product maturity - user defined. | False | |
1856
+ | Service Life | False | True | False | None | Estimated service lifetime of the product. | False | |
1857
+ | Introduction Date | False | True | False | None | 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. | False | |
1858
+ | Next Version Date | False | True | False | None | 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. | False | |
1859
+ | Withdrawal Date | False | True | False | None | 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. | False | |
1860
+ | Version Identifier | False | True | False | None | Published product version identifier. | False | |
1861
+ | Product Manager | False | True | False | None | Actors responsible for managing this product. Actors may be individuals, automations, etc. | False | |
1862
+ | Agreements | No | No | No | None | | No | [] |
1863
+ | Digital Subscriptions | False | True | False | None | | False | |
1864
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
1865
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
1866
+
1867
+
1868
+ ___
1869
+
1870
+ # Create Term
1871
+ ## Term Name
1872
+
1873
+ Link Product-Product
1874
+
1875
+ ## Description
1876
+
1877
+ Link digital product dependency between two digital products.
1878
+
1879
+ ## Glossary
1880
+
1881
+ Egeria-Markdown
1882
+
1883
+ ## Folders
1884
+
1885
+ Writing Dr.Egeria Markdown
1886
+
1887
+ ## Usage
1888
+
1889
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1890
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1891
+ | Digital Product 1 | True | True | False | None | The first product to link. | False | |
1892
+ | Digital Product 2 | True | True | False | None | The second product to link. | False | |
1893
+ | Label | False | True | False | None | Labels the link between two digital products. | False | |
1894
+ | Description | False | True | False | None | A description of the link. | False | |
1895
+
1896
+
1897
+ ___
1898
+
1899
+ # Create Term
1900
+ ## Term Name
1901
+
1902
+ Create Agreement
1903
+
1904
+ ## Description
1905
+
1906
+ A kind of collection that represents an Agreement. This is for generic agreements. Specific kinds of agreements have their own commands.
1907
+
1908
+ ## Glossary
1909
+
1910
+ Egeria-Markdown
1911
+
1912
+ ## Folders
1913
+
1914
+ Writing Dr.Egeria Markdown
1915
+
1916
+ ## Usage
1917
+
1918
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1919
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1920
+ | Display Name | True | True | False | None | Name of the agreement. | False | |
1921
+ | Description | False | True | False | None | Description of the contents of the agreement. | False | |
1922
+ | Identifier | False | True | False | None | A user specified agreement identifier. | False | |
1923
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define agreement types. | False | |
1924
+ | Status | False | True | False | None | The status of the agreement. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
1925
+ | User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
1926
+ | Version Identifier | False | True | False | None | Published agreement version identifier. | False | |
1927
+ | Agreement Actors | False | True | False | None | A list of actors with responsibilities for the agreement. | False | |
1928
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
1929
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
1930
+
1931
+
1932
+ ___
1933
+
1934
+ # Create Term
1935
+ ## Term Name
1936
+
1937
+ Create Data Sharing Agreement
1938
+
1939
+ ## Description
1940
+
1941
+ Create a new collection with the DataSharingAgreement classification.
1942
+
1943
+ ## Glossary
1944
+
1945
+ Egeria-Markdown
1946
+
1947
+ ## Folders
1948
+
1949
+ Writing Dr.Egeria Markdown
1950
+
1951
+ ## Usage
1952
+
1953
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1954
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1955
+ | Display Name | True | True | False | None | Name of the agreement. | False | |
1956
+ | Description | False | True | False | None | Description of the contents of the agreement. | False | |
1957
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
1958
+ | Identifier | False | True | False | None | A user specified agreement identifier. | False | |
1959
+ | Status | False | True | False | None | The status of the data sharing. agreement There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
1960
+ | User_Defined_Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
1961
+ | Version Identifier | False | True | False | None | Published agreement version identifier. | False | |
1962
+ | Product Manager | False | True | False | None | An actor responsible for managing this product. Actors may be individuals, automations, etc. | False | |
1963
+ | Digital Subscriptions | False | True | False | None | | False | |
1964
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
1965
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
1966
+
1967
+
1968
+ ___
1969
+
1970
+ # Create Term
1971
+ ## Term Name
1972
+
1973
+ Create Digital Subscription
1974
+
1975
+ ## Description
1976
+
1977
+ A type of agreement for a digital subscription.
1978
+
1979
+ ## Glossary
1980
+
1981
+ Egeria-Markdown
1982
+
1983
+ ## Folders
1984
+
1985
+ Writing Dr.Egeria Markdown
1986
+
1987
+ ## Usage
1988
+
1989
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
1990
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
1991
+ | Display Name | True | True | False | None | Name of the agreement. | False | |
1992
+ | Description | False | True | False | None | Description of the contents of the agreement. | False | |
1993
+ | Identifier | False | True | False | None | A user specified agreement identifier. | False | |
1994
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define subscription types. | False | |
1995
+ | Status | False | True | False | None | The status of the digital subscription. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE; DEPRECATED; OTHER |
1996
+ | User_Defined_Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
1997
+ | Support Level | False | True | False | None | Level of support agreed or requested. | False | |
1998
+ | Service Levels | False | True | False | None | A dictionary of name:value pairs describing the service levels. | False | |
1999
+ | Version Identifier | False | True | False | None | Published agreement version identifier. | False | |
2000
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2001
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2002
+
2003
+
2004
+ ___
2005
+
2006
+ # Create Term
2007
+ ## Term Name
2008
+
2009
+ Link Agreement->Item
2010
+
2011
+ ## Description
2012
+
2013
+ Attach or detach an agreement to an element referenced in its definition. Agreement item can be any referencable element.
2014
+
2015
+ ## Glossary
2016
+
2017
+ Egeria-Markdown
2018
+
2019
+ ## Folders
2020
+
2021
+ Writing Dr.Egeria Markdown
2022
+
2023
+ ## Usage
2024
+
2025
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2026
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2027
+ | Agreement Name | True | True | False | None | The name of the agreement to add an item to. Using qualified names is recommended. | False | |
2028
+ | Item Name | True | True | False | None | The name of the referenceable item to add to an agreement Using qualified names is recommended. | False | |
2029
+ | Agreement Item Id | False | True | False | None | A user specified agreement item identifier. | False | |
2030
+ | Agreement Start | False | True | False | None | The start date of the agreement as an ISO 8601 string. | False | |
2031
+ | Agreement End | False | True | False | None | The end date of the agreement as an ISO 8601 string. | False | |
2032
+ | Restrictions | False | True | False | None | A dictionary of property:value pairs describing restrictions. | False | |
2033
+ | Obligations | False | True | False | None | A dictionary of property:value pairs describing obligations. | False | |
2034
+ | Entitlements | False | True | False | None | A dictionary of property:value pairs describing entitlements. | False | |
2035
+ | Usage Measurements | False | True | False | None | A dictionary of property:value pairs describing usage measurements. | False | |
2036
+
2037
+
2038
+ ___
2039
+
2040
+ # Create Term
2041
+ ## Term Name
2042
+
2043
+ Link Contracts
2044
+
2045
+ ## Description
2046
+
2047
+ Attach or detach an agreement to an element describing the location of the contract documents.
2048
+
2049
+ ## Glossary
2050
+
2051
+ Egeria-Markdown
2052
+
2053
+ ## Folders
2054
+
2055
+ Writing Dr.Egeria Markdown
2056
+
2057
+ ## Usage
2058
+
2059
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2060
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2061
+ | Contract Id | False | True | False | None | Contract identifier. | False | |
2062
+ | Contract Liaison | False | True | False | None | Name of the liaison for the contract. | False | |
2063
+ | Contract Liaison Type | False | True | False | None | type of liaison. | False | |
2064
+ | Contract Liaison Property Name | False | True | False | None | | False | |
2065
+
2066
+
2067
+ ___
2068
+
2069
+ # Create Term
2070
+ ## Term Name
2071
+
2072
+ Link Subscriber->Subscription
2073
+
2074
+ ## Description
2075
+
2076
+ Attach or detach a subscriber to a subscription. Subscriber can be any type of element.
2077
+
2078
+ ## Glossary
2079
+
2080
+ Egeria-Markdown
2081
+
2082
+ ## Folders
2083
+
2084
+ Writing Dr.Egeria Markdown
2085
+
2086
+ ## Usage
2087
+
2088
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2089
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2090
+ | Subscriber Id | False | True | False | None | identifier of a subscriber. Initially, will let this be an arbitrary string - could harden this to a qualified name later if needed. | False | |
2091
+ | Subscription | True | True | False | None | Name of the subscription agreement. Recommend using qualified name. | False | |
2092
+
2093
+
2094
+ ___
2095
+
2096
+ # Create Term
2097
+ ## Term Name
2098
+
2099
+ Link Collection->Resource
2100
+
2101
+ ## Description
2102
+
2103
+ Connect an existing collection to an element using the ResourceList relationship.
2104
+
2105
+ ## Glossary
2106
+
2107
+ Egeria-Markdown
2108
+
2109
+ ## Folders
2110
+
2111
+ Writing Dr.Egeria Markdown
2112
+
2113
+ ## Usage
2114
+
2115
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2116
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2117
+ | Collection Id | True | True | False | None | An element of base type collection (e.g. collection, agreement; subscription, ...) | False | |
2118
+ | Resource Id | True | True | False | None | The name of the resource to attach to. | False | |
2119
+ | Resource Use | False | True | False | None | Describes the relationship between the resource and the collection. | False | |
2120
+ | Resource Description | False | True | False | None | A description of the resource being attached. | False | |
2121
+ | Resource Properties | False | True | False | None | A dictionary of name:value pairs describing properties of the resource use. | False | |
2122
+
2123
+
2124
+ ___
2125
+
2126
+ # Create Term
2127
+ ## Term Name
2128
+
2129
+ Link Member->Collection
2130
+
2131
+ ## Description
2132
+
2133
+ Add/Remove a member to/from a collection.
2134
+
2135
+ ## Glossary
2136
+
2137
+ Egeria-Markdown
2138
+
2139
+ ## Folders
2140
+
2141
+ Writing Dr.Egeria Markdown
2142
+
2143
+ ## Usage
2144
+
2145
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2146
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2147
+ | Element Id | True | True | False | None | The name of the element to add to the collection. | False | |
2148
+ | Collection Id | True | True | False | None | The name of the collection to link to. There are many collection types, including Digital Products, Agreements and Subscriptions. | False | |
2149
+ | Membership Rationale | False | True | False | None | Rationale for membership. | False | |
2150
+ | Membership Status | False | True | False | None | The status of adding a member to a collection. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
2151
+
2152
+
2153
+ ___
2154
+
2155
+ # Create Term
2156
+ ## Term Name
2157
+
2158
+ Create Data Dictionary
2159
+
2160
+ ## Description
2161
+
2162
+ A Data Dictionary is an organized and curated collection of data definitions that can serve as a reference for data professionals
2163
+
2164
+ ## Glossary
2165
+
2166
+ Egeria-Markdown
2167
+
2168
+ ## Folders
2169
+
2170
+ Writing Dr.Egeria Markdown
2171
+
2172
+ ## Usage
2173
+
2174
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2175
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2176
+ | Display Name | True | True | False | None | Name of the Data Dictionary | False | |
2177
+ | Description | False | True | False | None | A description of the Data Dictionary. | False | |
2178
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2179
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2180
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2181
+
2182
+
2183
+ ___
2184
+
2185
+ # Create Term
2186
+ ## Term Name
2187
+
2188
+ Create Data Spec
2189
+
2190
+ ## Description
2191
+
2192
+ A Data Specification defines the data requirements for a project or initiative. This includes the data structures , data fields and data classes.
2193
+
2194
+ ## Glossary
2195
+
2196
+ Egeria-Markdown
2197
+
2198
+ ## Folders
2199
+
2200
+ Writing Dr.Egeria Markdown
2201
+
2202
+ ## Usage
2203
+
2204
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2205
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2206
+ | Display Name | True | True | False | None | Name of the Data Specification. | False | |
2207
+ | Description | False | True | False | None | A description of the Data Specification. | False | |
2208
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2209
+ | Qualified Name | True | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2210
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2211
+
2212
+
2213
+ ___
2214
+
2215
+ # Create Term
2216
+ ## Term Name
2217
+
2218
+ Create Data Structure
2219
+
2220
+ ## Description
2221
+
2222
+ A collection of data fields that for a data specification for a data source.
2223
+
2224
+ ## Glossary
2225
+
2226
+ Egeria-Markdown
2227
+
2228
+ ## Folders
2229
+
2230
+ Writing Dr.Egeria Markdown
2231
+
2232
+ ## Usage
2233
+
2234
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2235
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2236
+ | Display Name | True | True | False | None | Name of the data structure. | False | |
2237
+ | Description | False | True | False | None | A description of the data structure. | False | |
2238
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2239
+ | Status | False | True | False | None | The status of the data structure. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE; DEPRECATED; OTHER |
2240
+ | In Data Specification | False | True | False | None | The data specifications this structure is a member of. | False | |
2241
+ | In Data Dictionary | False | True | False | None | What data dictionaries is this data structure in? | False | |
2242
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2243
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2244
+
2245
+
2246
+ ___
2247
+
2248
+ # Create Term
2249
+ ## Term Name
2250
+
2251
+ Create Data Field
2252
+
2253
+ ## Description
2254
+
2255
+ A data field is a fundamental building block for a data structure.
2256
+
2257
+ ## Glossary
2258
+
2259
+ Egeria-Markdown
2260
+
2261
+ ## Folders
2262
+
2263
+ Writing Dr.Egeria Markdown
2264
+
2265
+ ## Usage
2266
+
2267
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2268
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2269
+ | Display Name | True | True | False | None | Name of the Data Field | False | |
2270
+ | Description | False | True | False | None | A description of the Data Field | False | |
2271
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2272
+ | Status | False | True | False | None | The status of the data field. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE; DEPRECATED; OTHER |
2273
+ | Data Type | True | True | False | None | The data type of the data field. Point to data type valid value list if exists. | False | string; int; long; date; boolean; char; byte; float; double; biginteger; bigdecimal; array<string>; array<int>; map<string,string>; map<string, boolean>; map<string, int>; map<string, long>; map<string,double>; map<string, date> map<string, object>; short; map<string, array<string>>; other |
2274
+ | Position | False | True | False | None | Position of the data field in the data structure. If 0, position is irrelevant. | False | |
2275
+ | Minimum Cardinality | False | True | False | None | The minimum cardinality for a data element. | False | |
2276
+ | Maximum Cardinality | False | True | False | None | The maximum cardinality for a data element. | False | |
2277
+ | In Data Structure | False | True | False | None | The data structure this field is a member of. If display name is not unique, use qualified name. | False | |
2278
+ | Data Class | False | True | False | None | The data class that values of this data field conform to. | False | |
2279
+ | Glossary Term | False | True | False | None | Term that provides meaning to this field. | False | |
2280
+ | isNullable | False | True | False | None | Can the values within the dataclass be absent? | False | |
2281
+ | Minimum Length | False | True | False | None | | False | |
2282
+ | Length | False | True | False | None | The length of a value for a field. | False | |
2283
+ | Precision | False | True | False | None | The precision of a numeric | False | |
2284
+ | Ordered Values | False | True | False | None | is this field in an ordered list? | False | |
2285
+ | Units | False | True | False | None | An optional string indicating the units of the field. | False | |
2286
+ | Default Value | False | True | False | None | Specify a default value for the data class. | False | |
2287
+ | Version Identifier | False | True | False | None | A user supplied version identifier. | False | |
2288
+ | In Data Dictionary | False | True | False | None | What data dictionaries is this data field in? | False | |
2289
+ | Parent Data Field | False | True | False | None | Optional parent field if this is a nested field. | False | |
2290
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2291
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2292
+
2293
+
2294
+ ___
2295
+
2296
+ # Create Term
2297
+ ## Term Name
2298
+
2299
+ Create Data Class
2300
+
2301
+ ## Description
2302
+
2303
+ Describes the data values that may be stored in data fields. Can be used to configure quality validators and data field classifiers.
2304
+
2305
+ ## Glossary
2306
+
2307
+ Egeria-Markdown
2308
+
2309
+ ## Folders
2310
+
2311
+ Writing Dr.Egeria Markdown
2312
+
2313
+ ## Usage
2314
+
2315
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2316
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2317
+ | Display Name | True | True | False | None | Name of the data structure. | False | |
2318
+ | Description | False | True | False | None | A description of the data class. | False | |
2319
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2320
+ | Status | False | True | False | None | The status of the data class. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE; DEPRECATED; OTHER |
2321
+ | Namespace | False | True | False | None | Optional namespace that scopes the field. | False | |
2322
+ | Match Property Names | False | True | True | None | Names of the properties that are set. | False | |
2323
+ | Match Threshold | False | True | False | None | Percent of values that must match the data class specification. | False | |
2324
+ | IsCaseSensitive | False | True | False | None | Are field values case sensitive? | False | |
2325
+ | Data Type | True | True | False | None | Data type for the data class. | False | string; int; long; date; boolean; char; byte; float; double; biginteger; bigdecimal; array<string>; array<int>; map<string,string>; map<string, boolean>; map<string, int>; map<string, long>; map<string,double>; map<string, date> map<string, object>; short; map<string, array<string>>; other |
2326
+ | Allow Duplicate Values | False | True | False | None | Allow duplicate values within the data class? | False | |
2327
+ | isNullable | False | True | False | None | Can the values within the dataclass be absent? | False | |
2328
+ | isCaseSensitive | False | True | False | None | Indicates if the values in a data class are case sensitive. | False | |
2329
+ | Default Value | False | True | False | None | Specify a default value for the data class. | False | |
2330
+ | Average Value | False | True | False | None | Average value for the data class. | False | |
2331
+ | Value List | False | True | False | None | | False | |
2332
+ | Value Range From | False | True | False | None | Beginning range of legal values. | False | |
2333
+ | Value Range To | False | True | False | None | End of valid range for value. | False | |
2334
+ | Sample Values | False | True | False | None | Sample values of the data class. | False | |
2335
+ | Data Patterns | False | True | False | None | prescribed format of a data field - e.g. credit card numbers. Often expressed as a regular expression. | False | |
2336
+ | In Data Dictionary | False | True | False | None | What data dictionaries is this data field in? | False | |
2337
+ | Containing Data Class | False | True | False | None | Data classes this is part of. | False | |
2338
+ | Specializes Data Class | False | True | False | None | Specializes a parent data class. | False | |
2339
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2340
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2341
+
2342
+
2343
+ ___
2344
+
2345
+ # Create Term
2346
+ ## Term Name
2347
+
2348
+ View Data Fields
2349
+
2350
+ ## Description
2351
+
2352
+ Return the data fields, optionally filtered by the search string.
2353
+
2354
+ ## Glossary
2355
+
2356
+ Egeria-Markdown
2357
+
2358
+ ## Folders
2359
+
2360
+ Writing Dr.Egeria Markdown
2361
+
2362
+ ## Usage
2363
+
2364
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2365
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2366
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
2367
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; MERMAID; DICT |
2368
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
2369
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2370
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
2371
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
2372
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
2373
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
2374
+ | Sort Order | False | True | False | None | How to order the results. The sort order can be selected from a list of valid value. | False | ANY; CREATION_DATE_RECENT; CREATION_DATA_OLDEST; LAST_UPDATE_RECENT; LAST_UPDATE_OLDEST; PROPERTY_ASCENDING; PROPERTY_DESCENDING |
2375
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
2376
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
2377
+
2378
+
2379
+ ___
2380
+
2381
+ # Create Term
2382
+ ## Term Name
2383
+
2384
+ View Data Classes
2385
+
2386
+ ## Description
2387
+
2388
+ Return the data classes, optionally filtered by the search string.
2389
+
2390
+ ## Glossary
2391
+
2392
+ Egeria-Markdown
2393
+
2394
+ ## Folders
2395
+
2396
+ Writing Dr.Egeria Markdown
2397
+
2398
+ ## Usage
2399
+
2400
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2401
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2402
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
2403
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; MERMAID; DICT |
2404
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
2405
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2406
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
2407
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
2408
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
2409
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
2410
+ | Sort Order | False | True | False | None | How to order the results. The sort order can be selected from a list of valid value. | False | ANY; CREATION_DATE_RECENT; CREATION_DATA_OLDEST; LAST_UPDATE_RECENT; LAST_UPDATE_OLDEST; PROPERTY_ASCENDING; PROPERTY_DESCENDING |
2411
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
2412
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
2413
+
2414
+
2415
+ ___
2416
+
2417
+ # Create Term
2418
+ ## Term Name
2419
+
2420
+ View Data Specifications
2421
+
2422
+ ## Description
2423
+
2424
+ Return the data specifications, optionally filtered by the search string.
2425
+
2426
+ ## Glossary
2427
+
2428
+ Egeria-Markdown
2429
+
2430
+ ## Folders
2431
+
2432
+ Writing Dr.Egeria Markdown
2433
+
2434
+ ## Usage
2435
+
2436
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2437
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2438
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
2439
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; DICT; MD; MERMAID; REPORT |
2440
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
2441
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2442
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
2443
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
2444
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
2445
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
2446
+ | Sort Order | False | True | False | None | How to order the results. The sort order can be selected from a list of valid value. | False | ANY; CREATION_DATE_RECENT; CREATION_DATA_OLDEST; LAST_UPDATE_RECENT; LAST_UPDATE_OLDEST; PROPERTY_ASCENDING; PROPERTY_DESCENDING |
2447
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
2448
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
2449
+
2450
+
2451
+ ___
2452
+
2453
+ # Create Term
2454
+ ## Term Name
2455
+
2456
+ View Data Dictionaries
2457
+
2458
+ ## Description
2459
+
2460
+ Return the data dictionaries, optionally filtered by the search string.
2461
+
2462
+ ## Glossary
2463
+
2464
+ Egeria-Markdown
2465
+
2466
+ ## Folders
2467
+
2468
+ Writing Dr.Egeria Markdown
2469
+
2470
+ ## Usage
2471
+
2472
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2473
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2474
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
2475
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; DICT; MD; MERMAID; REPORT |
2476
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
2477
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2478
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
2479
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
2480
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
2481
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
2482
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
2483
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
2484
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
2485
+ | Sort Order | False | True | False | None | How to order the results. The sort order can be selected from a list of valid value. | False | ANY; CREATION_DATE_RECENT; CREATION_DATA_OLDEST; LAST_UPDATE_RECENT; LAST_UPDATE_OLDEST; PROPERTY_ASCENDING; PROPERTY_DESCENDING |
2486
+
2487
+
2488
+ ___
2489
+
2490
+ # Create Term
2491
+ ## Term Name
2492
+
2493
+ Create Information Supply Chain
2494
+
2495
+ ## Description
2496
+
2497
+ The flow of a particular type of data across a digital landscape.
2498
+
2499
+ ## Glossary
2500
+
2501
+ Egeria-Markdown
2502
+
2503
+ ## Folders
2504
+
2505
+ Writing Dr.Egeria Markdown
2506
+
2507
+ ## Usage
2508
+
2509
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2510
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2511
+ | Display Name | True | True | False | None | Name of the Information Supply Chain | False | |
2512
+ | Description | False | True | False | None | A description of the data structure. | False | |
2513
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2514
+ | Scope | False | True | False | None | Scope of the supply chain. | False | |
2515
+ | Purposes | False | True | False | None | A list of purposes. | False | |
2516
+ | Nested Information Supply Chains | False | True | False | None | A list of supply chains that compose this supply chain. | False | |
2517
+ | In Information Supply Chain | False | True | False | None | Supply chains that this supply chain is in. | False | |
2518
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2519
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2520
+ | Merge Update | False | True | False | None | If true, only those attributes specified in the update will be updated; If false, any attributes not provided during the update will be set to None. | False | |
2521
+
2522
+
2523
+ ___
2524
+
2525
+ # Create Term
2526
+ ## Term Name
2527
+
2528
+ Create Solution Blueprint
2529
+
2530
+ ## Description
2531
+
2532
+ A solution blueprint describes the architecture of a digital service in terms of solution components.
2533
+
2534
+ ## Glossary
2535
+
2536
+ Egeria-Markdown
2537
+
2538
+ ## Folders
2539
+
2540
+ Writing Dr.Egeria Markdown
2541
+
2542
+ ## Usage
2543
+
2544
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2545
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2546
+ | Display Name | True | True | False | None | Name of the Information Supply Chain | False | |
2547
+ | Description | False | True | False | None | A description of the data structure. | False | |
2548
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2549
+ | Status | False | True | False | None | The status of the solution blueprint. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE; DEPRECATED; OTHER |
2550
+ | Version Identifier | False | True | False | None | A user supplied version identifier. | False | |
2551
+ | Solution Components | False | True | False | None | Solution components that make up the blueprint. | False | |
2552
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2553
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2554
+
2555
+
2556
+ ___
2557
+
2558
+ # Create Term
2559
+ ## Term Name
2560
+
2561
+ Create Solution Component
2562
+
2563
+ ## Description
2564
+
2565
+ A reusable solution component.
2566
+
2567
+ ## Glossary
2568
+
2569
+ Egeria-Markdown
2570
+
2571
+ ## Folders
2572
+
2573
+ Writing Dr.Egeria Markdown
2574
+
2575
+ ## Usage
2576
+
2577
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2578
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2579
+ | Display Name | True | True | False | None | Name of the solution component. | False | |
2580
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2581
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2582
+ | Description | False | True | False | None | A description of the data structure. | False | |
2583
+ | Status | False | True | False | None | The status of the solution component. There is a list of valid values that this conforms to. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE; DEPRECATED; OTHER |
2584
+ | Solution Component Type | False | True | False | None | Type of solution component. | False | |
2585
+ | Planned Deployed Implementation Type | False | True | False | None | The planned implementation type for deployment. | False | |
2586
+ | Initial Status | False | True | False | None | Optional lifecycle status. If not specified, set to ACTIVE. If set to Other then the value in User Defined Status will be used. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE; DISABLED; DEPRECATED; OTHER |
2587
+ | In Solution Components | False | True | False | None | Solution components that include this one. | False | |
2588
+ | In Solution Blueprints | False | True | False | None | Solution Blueprints that contain this component. | False | |
2589
+ | In Information Supply Chains | False | True | False | None | The Information Supply Chains that this component is a member of. | False | |
2590
+ | Actors | False | True | False | None | Actors associated with this component. | False | |
2591
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2592
+ | Merge Update | False | True | False | None | If true, only those attributes specified in the update will be updated; If false, any attributes not provided during the update will be set to None. | False | |
2593
+
2594
+
2595
+ ___
2596
+
2597
+ # Create Term
2598
+ ## Term Name
2599
+
2600
+ Link Solution Component Peers
2601
+
2602
+ ## Description
2603
+
2604
+ This command can be used to link or unlink wires between components.
2605
+
2606
+ ## Glossary
2607
+
2608
+ Egeria-Markdown
2609
+
2610
+ ## Folders
2611
+
2612
+ Writing Dr.Egeria Markdown
2613
+
2614
+ ## Usage
2615
+
2616
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2617
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2618
+ | Component1 | True | True | False | None | The first component to link. | False | |
2619
+ | Component2 | True | True | False | None | The second component to link. | False | |
2620
+ | Wire Label | False | True | False | None | Labels the link between two components. | False | |
2621
+ | Description | False | True | False | None | A description of the wire. | False | |
2622
+
2623
+
2624
+ ___
2625
+
2626
+ # Create Term
2627
+ ## Term Name
2628
+
2629
+ Create Solution Role
2630
+
2631
+ ## Description
2632
+
2633
+ A collection of data fields that for a data specification for a data source.
2634
+
2635
+ ## Glossary
2636
+
2637
+ Egeria-Markdown
2638
+
2639
+ ## Folders
2640
+
2641
+ Writing Dr.Egeria Markdown
2642
+
2643
+ ## Usage
2644
+
2645
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2646
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2647
+ | Name | True | True | False | None | Name of the role. | False | |
2648
+ | Description | False | True | False | None | A description of the data structure. | False | |
2649
+ | Title | False | True | False | None | Title of the role. | False | |
2650
+ | Scope | False | True | False | None | Scope of the role. | False | |
2651
+ | identifier | False | True | False | None | role identifier | False | |
2652
+ | Domain Identifier | False | True | False | None | Governance domain identifier | False | |
2653
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2654
+ | Role Type | False | True | False | None | Type of the role. Currently must be GovernanceRole. | False | |
2655
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2656
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2657
+
2658
+
2659
+ ___
2660
+
2661
+ # Create Term
2662
+ ## Term Name
2663
+
2664
+ Link Information Supply Chain Peers
2665
+
2666
+ ## Description
2667
+
2668
+ This command can be used to link or unlink information supply chain segments.
2669
+
2670
+ ## Glossary
2671
+
2672
+ Egeria-Markdown
2673
+
2674
+ ## Folders
2675
+
2676
+ Writing Dr.Egeria Markdown
2677
+
2678
+ ## Usage
2679
+
2680
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2681
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2682
+ | Segment1 | True | True | False | None | The first segment to link. | False | |
2683
+ | Segment2 | True | True | False | None | The second segment to link. | False | |
2684
+ | Link Label | False | True | False | None | Labels the link between two information supply chain segments. | False | |
2685
+ | Description | False | True | False | None | A description of the data structure. | False | |
2686
+
2687
+
2688
+ ___
2689
+
2690
+ # Create Term
2691
+ ## Term Name
2692
+
2693
+ View Information Supply Chains
2694
+
2695
+ ## Description
2696
+
2697
+ Return information supply chains filtered by the search string.
2698
+
2699
+ ## Glossary
2700
+
2701
+ Egeria-Markdown
2702
+
2703
+ ## Folders
2704
+
2705
+ Writing Dr.Egeria Markdown
2706
+
2707
+ ## Usage
2708
+
2709
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2710
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2711
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
2712
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; MD; REPORT; MERMAID; LIST; DICT; HTML |
2713
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2714
+ | Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
2715
+
2716
+
2717
+ ___
2718
+
2719
+ # Create Term
2720
+ ## Term Name
2721
+
2722
+ View Solution Components
2723
+
2724
+ ## Description
2725
+
2726
+ Return the data structure details, optionally filtered by the search string.
2727
+
2728
+ ## Glossary
2729
+
2730
+ Egeria-Markdown
2731
+
2732
+ ## Folders
2733
+
2734
+ Writing Dr.Egeria Markdown
2735
+
2736
+ ## Usage
2737
+
2738
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2739
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2740
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
2741
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
2742
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2743
+ | Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
2744
+
2745
+
2746
+ ___
2747
+
2748
+ # Create Term
2749
+ ## Term Name
2750
+
2751
+ View Solution Blueprints
2752
+
2753
+ ## Description
2754
+
2755
+ Return the data structure details, optionally filtered by the search string.
2756
+
2757
+ ## Glossary
2758
+
2759
+ Egeria-Markdown
2760
+
2761
+ ## Folders
2762
+
2763
+ Writing Dr.Egeria Markdown
2764
+
2765
+ ## Usage
2766
+
2767
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2768
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2769
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
2770
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
2771
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2772
+ | Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
2773
+
2774
+
2775
+ ___
2776
+
2777
+ # Create Term
2778
+ ## Term Name
2779
+
2780
+ View Solution Roles
2781
+
2782
+ ## Description
2783
+
2784
+ Return the data structure details, optionally filtered by the search string.
2785
+
2786
+ ## Glossary
2787
+
2788
+ Egeria-Markdown
2789
+
2790
+ ## Folders
2791
+
2792
+ Writing Dr.Egeria Markdown
2793
+
2794
+ ## Usage
2795
+
2796
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2797
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2798
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
2799
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
2800
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2801
+ | Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
2802
+
2803
+
2804
+ ___
2805
+
2806
+ # Create Term
2807
+ ## Term Name
2808
+
2809
+ Create Glossary
2810
+
2811
+ ## Description
2812
+
2813
+ A grouping of definitions.
2814
+
2815
+ ## Glossary
2816
+
2817
+ Egeria-Markdown
2818
+
2819
+ ## Folders
2820
+
2821
+ Writing Dr.Egeria Markdown
2822
+
2823
+ ## Usage
2824
+
2825
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2826
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2827
+ | Display Name | True | True | False | None | The name of the glossary to create or update. | False | |
2828
+ | Description | False | True | False | None | A description of the Glossary. | False | |
2829
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2830
+ | Language | False | True | False | None | The language of the glossary. Note that multilingual descriptions are supported. Please see web site for details. | False | |
2831
+ | Usage | False | True | False | None | A description of how the glossary is to be used. | False | |
2832
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2833
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2834
+
2835
+
2836
+ ___
2837
+
2838
+ # Create Term
2839
+ ## Term Name
2840
+
2841
+ Create Glossary Term
2842
+
2843
+ ## Description
2844
+
2845
+
2846
+
2847
+ ## Glossary
2848
+
2849
+ Egeria-Markdown
2850
+
2851
+ ## Folders
2852
+
2853
+ Writing Dr.Egeria Markdown
2854
+
2855
+ ## Usage
2856
+
2857
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2858
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2859
+ | Display Name | True | True | False | None | The name of the term to create or update. | False | |
2860
+ | Glossary | True | True | False | None | Zeroor more existing glossaries that a term is a member of. | False | |
2861
+ | Summary | False | True | False | None | A summary description of the term. | False | |
2862
+ | Description | False | True | False | None | A description of the term. | False | |
2863
+ | Folders | No | No | No | None | | No | [] |
2864
+ | Abbreviation | False | True | False | None | An abbreviation for the term. | False | |
2865
+ | Example | False | True | False | None | An example of how the term is used. | False | |
2866
+ | Usage | False | True | False | None | A description of how the term is to be used. | False | |
2867
+ | Status | False | True | False | None | The lifecycle status of a term. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE, DEPRECATED; OTHER |
2868
+ | Version Identifier | False | True | False | None | | False | |
2869
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
2870
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
2871
+
2872
+
2873
+ ___
2874
+
2875
+ # Create Term
2876
+ ## Term Name
2877
+
2878
+ Link Term-Term Relationship
2879
+
2880
+ ## Description
2881
+
2882
+ Create a relationship between terms.
2883
+
2884
+ ## Glossary
2885
+
2886
+ Egeria-Markdown
2887
+
2888
+ ## Folders
2889
+
2890
+ Writing Dr.Egeria Markdown
2891
+
2892
+ ## Usage
2893
+
2894
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2895
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2896
+ | Term 1 | True | True | False | None | The name of the first term term to connect. | False | |
2897
+ | Term 2 | True | True | False | None | The name of the second term term to connect. | False | |
2898
+ | Relationship | True | True | False | None | The type of relationship to connecting the two terms. | False | Synonym; Translation; PreferredTerm; TermISATYPEOFRelationship; TermTYPEDBYRelationship; Antonym; ReplacementTerm; ValidValue; TermHASARelationship; RelatedTerm; ISARelationship |
2899
+ | Description | False | True | False | None | A description of the Relationship. | False | |
2900
+ | Status | False | True | False | None | | False | |
2901
+
2902
+
2903
+ ___
2904
+
2905
+ # Create Term
2906
+ ## Term Name
2907
+
2908
+ View Terms
2909
+
2910
+ ## Description
2911
+
2912
+ List terms based on search string.
2913
+
2914
+ ## Glossary
2915
+
2916
+ Egeria-Markdown
2917
+
2918
+ ## Folders
2919
+
2920
+ Writing Dr.Egeria Markdown
2921
+
2922
+ ## Usage
2923
+
2924
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2925
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2926
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
2927
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; DICT; MD; MERMAID; HTML |
2928
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
2929
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
2930
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
2931
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
2932
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
2933
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
2934
+
2935
+
2936
+ ___
2937
+
2938
+ # Create Term
2939
+ ## Term Name
2940
+
2941
+ View Glossaries
2942
+
2943
+ ## Description
2944
+
2945
+ Return the glossaries, optionally filtered by the search string.
2946
+
2947
+ ## Glossary
2948
+
2949
+ Egeria-Markdown
2950
+
2951
+ ## Folders
2952
+
2953
+ Writing Dr.Egeria Markdown
2954
+
2955
+ ## Usage
2956
+
2957
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2958
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2959
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
2960
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; DICT; MD; MERMAID; HTML |
2961
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
2962
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
2963
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
2964
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
2965
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
2966
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
2967
+
2968
+
2969
+ ___
2970
+
2971
+ # Create Term
2972
+ ## Term Name
2973
+
2974
+ Create Project
2975
+
2976
+ ## Description
2977
+
2978
+ An organized set of work.
2979
+
2980
+ ## Glossary
2981
+
2982
+ Egeria-Markdown
2983
+
2984
+ ## Folders
2985
+
2986
+ Writing Dr.Egeria Markdown
2987
+
2988
+ ## Usage
2989
+
2990
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
2991
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
2992
+ | Display Name | True | True | False | None | The name of the project to create or update. | False | |
2993
+ | Description | False | True | False | None | A description of the Project. | False | |
2994
+ | Project Type | False | True | False | None | A string classifiying the project. Current;y supported values are Campaign, Task. PersonalProject and StudyProject. | False | |
2995
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
2996
+ | Identifier | False | True | False | None | A user asigned identifier. | False | |
2997
+ | Mission | False | True | False | None | The project mission. | False | |
2998
+ | Purposes | False | True | False | None | A list of project purposes. | False | |
2999
+ | Start Date | False | True | False | None | Project start date as an ISO 8601 string. | False | |
3000
+ | Planned End Date | False | True | False | None | Planned project end date as an ISO 8601 string. | False | |
3001
+ | Priority | False | True | False | None | An integer priority for the project. | False | |
3002
+ | Project Phase | False | True | False | None | A string describing the phase of the project. | False | |
3003
+ | Project Status | False | True | False | None | A string representing the project status. | False | |
3004
+ | Project Health | False | True | False | None | A string representing the health of the project. | False | |
3005
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
3006
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
3007
+
3008
+
3009
+ ___
3010
+
3011
+ # Create Term
3012
+ ## Term Name
3013
+
3014
+ Create Campaign
3015
+
3016
+ ## Description
3017
+
3018
+ An organized set of work.
3019
+
3020
+ ## Glossary
3021
+
3022
+ Egeria-Markdown
3023
+
3024
+ ## Folders
3025
+
3026
+ Writing Dr.Egeria Markdown
3027
+
3028
+ ## Usage
3029
+
3030
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3031
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3032
+ | Display Name | True | True | False | None | The name of the project to create or update. | False | |
3033
+ | Description | False | True | False | None | A description of the Project. | False | |
3034
+ | Project Type | False | True | False | None | A string classifiying the project. Current;y supported values are Campaign, Task. PersonalProject and StudyProject. | False | |
3035
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
3036
+ | Identifier | False | True | False | None | A user asigned identifier. | False | |
3037
+ | Mission | False | True | False | None | The project mission. | False | |
3038
+ | Purposes | False | True | False | None | A list of project purposes. | False | |
3039
+ | Start Date | False | True | False | None | Project start date as an ISO 8601 string. | False | |
3040
+ | Planned End Date | False | True | False | None | Planned project end date as an ISO 8601 string. | False | |
3041
+ | Priority | False | True | False | None | An integer priority for the project. | False | |
3042
+ | Project Phase | False | True | False | None | A string describing the phase of the project. | False | |
3043
+ | Project Status | False | True | False | None | A string representing the project status. | False | |
3044
+ | Project Health | False | True | False | None | A string representing the health of the project. | False | |
3045
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
3046
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
3047
+
3048
+
3049
+ ___
3050
+
3051
+ # Create Term
3052
+ ## Term Name
3053
+
3054
+ Create Task
3055
+
3056
+ ## Description
3057
+
3058
+ A smaller set of work.
3059
+
3060
+ ## Glossary
3061
+
3062
+ Egeria-Markdown
3063
+
3064
+ ## Folders
3065
+
3066
+ Writing Dr.Egeria Markdown
3067
+
3068
+ ## Usage
3069
+
3070
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3071
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3072
+ | Display Name | True | True | False | None | The name of the project to create or update. | False | |
3073
+ | Description | False | True | False | None | A description of the Project. | False | |
3074
+ | Project Type | False | True | False | None | A string classifiying the project. Current;y supported values are Campaign, Task. PersonalProject and StudyProject. | False | |
3075
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
3076
+ | Identifier | False | True | False | None | A user asigned identifier. | False | |
3077
+ | Mission | False | True | False | None | The project mission. | False | |
3078
+ | Purposes | False | True | False | None | A list of project purposes. | False | |
3079
+ | Start Date | False | True | False | None | Project start date as an ISO 8601 string. | False | |
3080
+ | Planned End Date | False | True | False | None | Planned project end date as an ISO 8601 string. | False | |
3081
+ | Priority | False | True | False | None | An integer priority for the project. | False | |
3082
+ | Project Phase | False | True | False | None | A string describing the phase of the project. | False | |
3083
+ | Project Status | False | True | False | None | A string representing the project status. | False | |
3084
+ | Project Health | False | True | False | None | A string representing the health of the project. | False | |
3085
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
3086
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
3087
+
3088
+
3089
+ ___
3090
+
3091
+ # Create Term
3092
+ ## Term Name
3093
+
3094
+ Create Personal Project
3095
+
3096
+ ## Description
3097
+
3098
+ A personal project.
3099
+
3100
+ ## Glossary
3101
+
3102
+ Egeria-Markdown
3103
+
3104
+ ## Folders
3105
+
3106
+ Writing Dr.Egeria Markdown
3107
+
3108
+ ## Usage
3109
+
3110
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3111
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3112
+ | Display Name | True | True | False | None | The name of the project to create or update. | False | |
3113
+ | Description | False | True | False | None | A description of the Project. | False | |
3114
+ | Project Type | False | True | False | None | A string classifiying the project. Current;y supported values are Campaign, Task. PersonalProject and StudyProject. | False | |
3115
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
3116
+ | Identifier | False | True | False | None | A user asigned identifier. | False | |
3117
+ | Mission | False | True | False | None | The project mission. | False | |
3118
+ | Purposes | False | True | False | None | A list of project purposes. | False | |
3119
+ | Start Date | False | True | False | None | Project start date as an ISO 8601 string. | False | |
3120
+ | Planned End Date | False | True | False | None | Planned project end date as an ISO 8601 string. | False | |
3121
+ | Priority | False | True | False | None | An integer priority for the project. | False | |
3122
+ | Project Phase | False | True | False | None | A string describing the phase of the project. | False | |
3123
+ | Project Status | False | True | False | None | A string representing the project status. | False | |
3124
+ | Project Health | False | True | False | None | A string representing the health of the project. | False | |
3125
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
3126
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
3127
+
3128
+
3129
+ ___
3130
+
3131
+ # Create Term
3132
+ ## Term Name
3133
+
3134
+ Create Study Project
3135
+
3136
+ ## Description
3137
+
3138
+ A personal project.
3139
+
3140
+ ## Glossary
3141
+
3142
+ Egeria-Markdown
3143
+
3144
+ ## Folders
3145
+
3146
+ Writing Dr.Egeria Markdown
3147
+
3148
+ ## Usage
3149
+
3150
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3151
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3152
+ | Display Name | True | True | False | None | The name of the project to create or update. | False | |
3153
+ | Description | False | True | False | None | A description of the Project. | False | |
3154
+ | Project Type | False | True | False | None | A string classifiying the project. Current;y supported values are Campaign, Task. PersonalProject and StudyProject. | False | |
3155
+ | Category | False | True | False | None | A user specified category name that can be used for example, to define product types or agreement types. | False | |
3156
+ | Identifier | False | True | False | None | A user asigned identifier. | False | |
3157
+ | Mission | False | True | False | None | The project mission. | False | |
3158
+ | Purposes | False | True | False | None | A list of project purposes. | False | |
3159
+ | Start Date | False | True | False | None | Project start date as an ISO 8601 string. | False | |
3160
+ | Planned End Date | False | True | False | None | Planned project end date as an ISO 8601 string. | False | |
3161
+ | Priority | False | True | False | None | An integer priority for the project. | False | |
3162
+ | Project Phase | False | True | False | None | A string describing the phase of the project. | False | |
3163
+ | Project Status | False | True | False | None | A string representing the project status. | False | |
3164
+ | Project Health | False | True | False | None | A string representing the health of the project. | False | |
3165
+ | Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
3166
+ | GUID | False | False | True | None | A system generated unique identifier. | True | |
3167
+
3168
+
3169
+ ___
3170
+
3171
+ # Create Term
3172
+ ## Term Name
3173
+
3174
+ Link Project Hierarchy
3175
+
3176
+ ## Description
3177
+
3178
+ Links or unlinks a parent project and child project.
3179
+
3180
+ ## Glossary
3181
+
3182
+ Egeria-Markdown
3183
+
3184
+ ## Folders
3185
+
3186
+ Writing Dr.Egeria Markdown
3187
+
3188
+ ## Usage
3189
+
3190
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3191
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3192
+ | Parent Project | True | True | False | None | The id of the parent project | False | |
3193
+ | Child Project | True | True | False | None | The id of the child project | False | |
3194
+ | Description | False | True | False | None | A description of the relationship.. | False | |
3195
+ | Label | False | True | False | None | A user asigned label for this relationship. | False | |
3196
+
3197
+
3198
+ ___
3199
+
3200
+ # Create Term
3201
+ ## Term Name
3202
+
3203
+ Link Project Dependency
3204
+
3205
+ ## Description
3206
+
3207
+ Links or unlinks a project and dependent project.
3208
+
3209
+ ## Glossary
3210
+
3211
+ Egeria-Markdown
3212
+
3213
+ ## Folders
3214
+
3215
+ Writing Dr.Egeria Markdown
3216
+
3217
+ ## Usage
3218
+
3219
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3220
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3221
+ | Parent Project | True | True | False | None | The id of the project being depended on. | False | |
3222
+ | Child Project | True | True | False | None | The id of the dependent project. | False | |
3223
+ | Description | False | True | False | None | A description of the relationship. | False | |
3224
+ | Label | False | True | False | None | A user asigned label for this relationship. | False | |
3225
+
3226
+
3227
+ ___
3228
+
3229
+ # Create Term
3230
+ ## Term Name
3231
+
3232
+ View Projects
3233
+
3234
+ ## Description
3235
+
3236
+ List projects based on search string.
3237
+
3238
+ ## Glossary
3239
+
3240
+ Egeria-Markdown
3241
+
3242
+ ## Folders
3243
+
3244
+ Writing Dr.Egeria Markdown
3245
+
3246
+ ## Usage
3247
+
3248
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3249
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3250
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
3251
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; DICT; MD; MERMAID; HTML |
3252
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
3253
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
3254
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
3255
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
3256
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
3257
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
3258
+
3259
+
3260
+ ___
3261
+
3262
+ # Create Term
3263
+ ## Term Name
3264
+
3265
+ View Report
3266
+
3267
+ ## Description
3268
+
3269
+ This can be used to produce a report using any output format set.
3270
+
3271
+ ## Glossary
3272
+
3273
+ Egeria-Markdown
3274
+
3275
+ ## Folders
3276
+
3277
+ Writing Dr.Egeria Markdown
3278
+
3279
+ ## Usage
3280
+
3281
+ | Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
3282
+ |-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
3283
+ | Search String | False | True | False | None | An optional search string to filter results by. | False | |
3284
+ | Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; MERMAID; DICT |
3285
+ | Output Format Set | True | True | False | None | Optional specification of an output format set that defines the attributes/columns that will be returned. | False | |
3286
+ | Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
3287
+ | Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
3288
+ | Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
3289
+ | Metadata Element Subtype Names | False | True | False | None | Filter results by the list of metadata elements. If none are provided, then no status filtering will be performed. | False | |
3290
+ | Metadata Element Type Name | False | True | False | None | Optionally filter results by the type of metadata element. | False | |
3291
+ | Skip Relationshjps | False | True | False | None | Allow listed relationships to be skipped in the output returned. | False | |
3292
+ | Include Only Relationships | False | True | False | None | Include information only about specified relationships. | False | |
3293
+ | Skip Classified Elements | False | True | False | None | Skip elements with the any of the specified classifications. | False | |
3294
+ | Include Only Classified Elements | False | True | False | None | Include only elements with the specified classifications. | False | |
3295
+ | Governance Zone Filter | False | True | False | None | Include only elements in one of the specified governance zones. | False | |
3296
+ | Graph Query Depth | False | True | False | None | The depth of the hierarchy to return. Default is 5. Specifying 0 returns only the top level attributes. | False | |
3297
+ | AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
3298
+ | Sort Order | False | True | False | None | How to order the results. The sort order can be selected from a list of valid value. | False | ANY; CREATION_DATE_RECENT; CREATION_DATA_OLDEST; LAST_UPDATE_RECENT; LAST_UPDATE_OLDEST; PROPERTY_ASCENDING; PROPERTY_DESCENDING |
3299
+ | Order Property Name | False | True | False | None | The property to use for sorting if the sort_order_property is PROPERTY_ASCENDING or PROPERTY_DESCENDING | False | |
3300
+ | Page Size | False | True | False | None | The number of elements returned per page. | False | |
3301
+ | Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
3302
+
3303
+
3304
+ ___
3305
+