pyegeria 5.3.10__py3-none-any.whl → 5.4.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- commands/cat/debug_log +2806 -0
- commands/cat/debug_log.2025-07-15_14-28-38_087378.zip +0 -0
- commands/cat/debug_log.2025-07-16_15-48-50_037087.zip +0 -0
- commands/cat/dr_egeria_command_help.py +273 -0
- commands/cat/dr_egeria_md.py +90 -20
- commands/cat/glossary_actions.py +2 -2
- commands/cat/list_collections.py +24 -10
- commands/cat/list_data_designer.py +183 -0
- md_processing/__init__.py +28 -5
- md_processing/data/commands.json +31474 -1096
- md_processing/dr_egeria_outbox-pycharm/.obsidian/app.json +1 -0
- md_processing/dr_egeria_outbox-pycharm/.obsidian/appearance.json +1 -0
- md_processing/dr_egeria_outbox-pycharm/.obsidian/core-plugins.json +31 -0
- md_processing/dr_egeria_outbox-pycharm/.obsidian/workspace.json +177 -0
- md_processing/dr_egeria_outbox-pycharm/monday/processed-2025-07-14 12:38-data_designer_out.md +663 -0
- md_processing/dr_egeria_outbox-pycharm/thursday/processed-2025-07-17 15:00-Derive-Dr-Gov-Defs.md +719 -0
- md_processing/dr_egeria_outbox-pycharm/thursday/processed-2025-07-17 20:13-Derive-Dr-Gov-Defs.md +41 -0
- md_processing/dr_egeria_outbox-pycharm/thursday/processed-2025-07-17 20:14-Derive-Dr-Gov-Defs.md +33 -0
- md_processing/dr_egeria_outbox-pycharm/thursday/processed-2025-07-17 20:50-Derive-Dr-Gov-Defs.md +192 -0
- md_processing/dr_egeria_outbox-pycharm/tuesday/processed-2025-07-16 19:15-gov_def2.md +527 -0
- md_processing/dr_egeria_outbox-pycharm/tuesday/processed-2025-07-17 12:08-gov_def2.md +527 -0
- md_processing/dr_egeria_outbox-pycharm/tuesday/processed-2025-07-17 14:27-gov_def2.md +474 -0
- md_processing/family_docs/Data Designer/Create_Data_Class.md +164 -0
- md_processing/family_docs/Data Designer/Create_Data_Dictionary.md +30 -0
- md_processing/family_docs/Data Designer/Create_Data_Field.md +162 -0
- md_processing/family_docs/Data Designer/Create_Data_Specification.md +36 -0
- md_processing/family_docs/Data Designer/Create_Data_Structure.md +38 -0
- md_processing/family_docs/Data Designer/View_Data_Classes.md +78 -0
- md_processing/family_docs/Data Designer/View_Data_Dictionaries.md +78 -0
- md_processing/family_docs/Data Designer/View_Data_Fields.md +78 -0
- md_processing/family_docs/Data Designer/View_Data_Specifications.md +78 -0
- md_processing/family_docs/Data Designer/View_Data_Structures.md +78 -0
- md_processing/family_docs/Data Designer.md +842 -0
- md_processing/family_docs/Digital Product Manager/Add_Member->Collection.md +42 -0
- md_processing/family_docs/Digital Product Manager/Attach_Collection->Resource.md +36 -0
- md_processing/family_docs/Digital Product Manager/Create_Agreement.md +96 -0
- md_processing/family_docs/Digital Product Manager/Create_Data_Sharing_Agreement.md +72 -0
- md_processing/family_docs/Digital Product Manager/Create_DigitalSubscription.md +102 -0
- md_processing/family_docs/Digital Product Manager/Create_Digital_Product.md +134 -0
- md_processing/family_docs/Digital Product Manager/Link_Agreement_Items.md +60 -0
- md_processing/family_docs/Digital Product Manager/Link_Contracts.md +26 -0
- md_processing/family_docs/Digital Product Manager/Link_Digital_Product_-_Digital_Product.md +30 -0
- md_processing/family_docs/Digital Product Manager/Link_Subscribers.md +48 -0
- md_processing/family_docs/Digital Product Manager.md +668 -0
- md_processing/family_docs/Glossary/Attach_Category_Parent.md +18 -0
- md_processing/family_docs/Glossary/Attach_Term-Term_Relationship.md +26 -0
- md_processing/family_docs/Glossary/Create_Category.md +38 -0
- md_processing/family_docs/Glossary/Create_Glossary.md +42 -0
- md_processing/family_docs/Glossary/Create_Term.md +70 -0
- md_processing/family_docs/Glossary.md +206 -0
- md_processing/family_docs/Governance Officer/Create_Business_Imperative.md +106 -0
- md_processing/family_docs/Governance Officer/Create_Certification_Type.md +112 -0
- md_processing/family_docs/Governance Officer/Create_Governance_Approach.md +114 -0
- md_processing/family_docs/Governance Officer/Create_Governance_Obligation.md +114 -0
- md_processing/family_docs/Governance Officer/Create_Governance_Principle.md +114 -0
- md_processing/family_docs/Governance Officer/Create_Governance_Procedure.md +128 -0
- md_processing/family_docs/Governance Officer/Create_Governance_Process.md +122 -0
- md_processing/family_docs/Governance Officer/Create_Governance_Processing_Purpose.md +106 -0
- md_processing/family_docs/Governance Officer/Create_Governance_Responsibility.md +122 -0
- md_processing/family_docs/Governance Officer/Create_Governance_Rule.md +122 -0
- md_processing/family_docs/Governance Officer/Create_Governance_Strategy.md +106 -0
- md_processing/family_docs/Governance Officer/Create_License_Type.md +112 -0
- md_processing/family_docs/Governance Officer/Create_Naming_Standard_Rule.md +122 -0
- md_processing/family_docs/Governance Officer/Create_Regulation_Article.md +106 -0
- md_processing/family_docs/Governance Officer/Create_Regulation_Definition.md +118 -0
- md_processing/family_docs/Governance Officer/Create_Security_Access_Control.md +114 -0
- md_processing/family_docs/Governance Officer/Create_Security_Group.md +120 -0
- md_processing/family_docs/Governance Officer/Create_Service_Level_Objectives.md +122 -0
- md_processing/family_docs/Governance Officer/Create_Threat_Definition.md +106 -0
- md_processing/family_docs/Governance Officer/Link_Governance_Controls.md +32 -0
- md_processing/family_docs/Governance Officer/Link_Governance_Drivers.md +32 -0
- md_processing/family_docs/Governance Officer/Link_Governance_Policies.md +32 -0
- md_processing/family_docs/Governance Officer/View_Governance_Definitions.md +82 -0
- md_processing/family_docs/Governance Officer.md +2412 -0
- md_processing/family_docs/Solution Architect/Create_Information_Supply_Chain.md +70 -0
- md_processing/family_docs/Solution Architect/Create_Solution_Blueprint.md +44 -0
- md_processing/family_docs/Solution Architect/Create_Solution_Component.md +96 -0
- md_processing/family_docs/Solution Architect/Create_Solution_Role.md +66 -0
- md_processing/family_docs/Solution Architect/Link_Information_Supply_Chain_Peers.md +32 -0
- md_processing/family_docs/Solution Architect/Link_Solution_Component_Peers.md +32 -0
- md_processing/family_docs/Solution Architect/View_Information_Supply_Chains.md +32 -0
- md_processing/family_docs/Solution Architect/View_Solution_Blueprints.md +32 -0
- md_processing/family_docs/Solution Architect/View_Solution_Components.md +32 -0
- md_processing/family_docs/Solution Architect/View_Solution_Roles.md +32 -0
- md_processing/family_docs/Solution Architect.md +490 -0
- md_processing/md_commands/data_designer_commands.py +1192 -710
- md_processing/md_commands/glossary_commands.py +19 -32
- md_processing/md_commands/governance_officer_commands.py +420 -0
- md_processing/md_commands/product_manager_commands.py +1180 -0
- md_processing/md_commands/project_commands.py +5 -2
- md_processing/md_commands/solution_architect_commands.py +1140 -0
- md_processing/md_processing_utils/common_md_proc_utils.py +288 -96
- md_processing/md_processing_utils/common_md_utils.py +205 -6
- md_processing/md_processing_utils/debug_log +574 -0
- md_processing/md_processing_utils/dr-egeria-help-2025-07-17T17:22:09.md +2065 -0
- md_processing/md_processing_utils/extraction_utils.py +1 -1
- md_processing/md_processing_utils/generate_dr_help.py +165 -0
- md_processing/md_processing_utils/generate_md_cmd_templates.py +143 -0
- md_processing/md_processing_utils/generate_md_templates.py +92 -0
- md_processing/md_processing_utils/generated_help_terms.md +842 -0
- md_processing/md_processing_utils/md_processing_constants.py +94 -17
- pyegeria/__init__.py +1 -0
- pyegeria/_client.py +39 -1
- pyegeria/classification_manager_omvs.py +1 -1
- pyegeria/collection_manager_omvs.py +4667 -1178
- pyegeria/data_designer_omvs.py +348 -31
- pyegeria/egeria_tech_client.py +9 -25
- pyegeria/glossary_browser_omvs.py +5 -6
- pyegeria/glossary_manager_omvs.py +2 -2
- pyegeria/governance_officer_omvs.py +2367 -0
- pyegeria/output_formatter.py +157 -32
- pyegeria/solution_architect_omvs.py +5063 -1110
- pyegeria/utils.py +22 -2
- {pyegeria-5.3.10.dist-info → pyegeria-5.4.0.dist-info}/METADATA +3 -1
- pyegeria-5.4.0.dist-info/RECORD +243 -0
- {pyegeria-5.3.10.dist-info → pyegeria-5.4.0.dist-info}/entry_points.txt +5 -0
- commands/cat/.DS_Store +0 -0
- md_processing/dr_egeria_inbox/archive/dr_egeria_intro.md +0 -254
- md_processing/dr_egeria_inbox/archive/dr_egeria_intro_more_terms.md +0 -696
- md_processing/dr_egeria_inbox/archive/dr_egeria_intro_part1.md +0 -254
- md_processing/dr_egeria_inbox/archive/dr_egeria_intro_part2.md +0 -298
- md_processing/dr_egeria_inbox/archive/dr_egeria_intro_part3.md +0 -608
- md_processing/dr_egeria_inbox/archive/dr_egeria_intro_part4.md +0 -94
- md_processing/dr_egeria_inbox/archive/freddie_intro.md +0 -284
- md_processing/dr_egeria_inbox/archive/freddie_intro_orig.md +0 -275
- md_processing/dr_egeria_inbox/archive/test-term.md +0 -110
- md_processing/dr_egeria_inbox/cat_test.md +0 -100
- md_processing/dr_egeria_inbox/data_field.md +0 -54
- md_processing/dr_egeria_inbox/data_spec.md +0 -77
- md_processing/dr_egeria_inbox/data_spec_test.md +0 -2406
- md_processing/dr_egeria_inbox/data_test.md +0 -86
- md_processing/dr_egeria_inbox/dr_egeria_intro_categories.md +0 -168
- md_processing/dr_egeria_inbox/dr_egeria_intro_part1.md +0 -280
- md_processing/dr_egeria_inbox/dr_egeria_intro_part2.md +0 -313
- md_processing/dr_egeria_inbox/dr_egeria_intro_part3.md +0 -1073
- md_processing/dr_egeria_inbox/dr_egeria_isc1.md +0 -44
- md_processing/dr_egeria_inbox/glossary_test1.md +0 -324
- md_processing/dr_egeria_inbox/rel.md +0 -8
- md_processing/dr_egeria_inbox/sb.md +0 -119
- md_processing/dr_egeria_inbox/search_test.md +0 -39
- md_processing/dr_egeria_inbox/solution-components.md +0 -154
- md_processing/dr_egeria_inbox/solution_blueprints.md +0 -118
- md_processing/dr_egeria_inbox/synonym_test.md +0 -42
- md_processing/dr_egeria_inbox/t1.md +0 -0
- md_processing/dr_egeria_inbox/t2.md +0 -268
- md_processing/dr_egeria_outbox/processed-2025-05-15 19:52-data_test.md +0 -94
- md_processing/dr_egeria_outbox/processed-2025-05-16 07:39-data_test.md +0 -88
- md_processing/dr_egeria_outbox/processed-2025-05-17 16:01-data_field.md +0 -56
- md_processing/dr_egeria_outbox/processed-2025-05-18 15:51-data_test.md +0 -103
- md_processing/dr_egeria_outbox/processed-2025-05-18 16:47-data_test.md +0 -94
- md_processing/dr_egeria_outbox/processed-2025-05-19 07:14-data_test.md +0 -96
- md_processing/dr_egeria_outbox/processed-2025-05-19 07:20-data_test.md +0 -100
- md_processing/dr_egeria_outbox/processed-2025-05-19 07:22-data_test.md +0 -88
- md_processing/dr_egeria_outbox/processed-2025-05-19 09:26-data_test.md +0 -91
- md_processing/dr_egeria_outbox/processed-2025-05-19 10:27-data_test.md +0 -91
- md_processing/dr_egeria_outbox/processed-2025-05-19 14:04-data_test.md +0 -91
- md_processing/md_commands/blueprint_commands.py +0 -303
- pyegeria/.DS_Store +0 -0
- pyegeria/m_test.py +0 -118
- pyegeria-5.3.10.dist-info/RECORD +0 -196
- /commands/cat/{list_data_structures.py → list_data_structures_full.py} +0 -0
- {pyegeria-5.3.10.dist-info → pyegeria-5.4.0.dist-info}/LICENSE +0 -0
- {pyegeria-5.3.10.dist-info → pyegeria-5.4.0.dist-info}/WHEEL +0 -0
@@ -0,0 +1,2065 @@
|
|
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 Business Imperative
|
13
|
+
|
14
|
+
## Description
|
15
|
+
|
16
|
+
The BusinessImperative entity defines a business goal that is critical to the success of the organization.
|
17
|
+
|
18
|
+
## Owning Glossary
|
19
|
+
|
20
|
+
Egeria-Markdown
|
21
|
+
|
22
|
+
## Categories
|
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
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
34
|
+
| Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
|
35
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
36
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
37
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
38
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
39
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
40
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
41
|
+
| 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 |
|
42
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
43
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
44
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
45
|
+
|
46
|
+
|
47
|
+
___
|
48
|
+
|
49
|
+
# Create Term
|
50
|
+
## Term Name
|
51
|
+
|
52
|
+
Create Regulation Article
|
53
|
+
|
54
|
+
## Description
|
55
|
+
|
56
|
+
A RegulationArticle entity is an article in a regulation. Dividing a regulation simplifies planning and execution.
|
57
|
+
|
58
|
+
## Owning Glossary
|
59
|
+
|
60
|
+
Egeria-Markdown
|
61
|
+
|
62
|
+
## Categories
|
63
|
+
|
64
|
+
Writing Dr.Egeria Markdown
|
65
|
+
|
66
|
+
## Usage
|
67
|
+
|
68
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
69
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
70
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
71
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
72
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
73
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
74
|
+
| Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
|
75
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
76
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
77
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
78
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
79
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
80
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
81
|
+
| 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 |
|
82
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
83
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
84
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
85
|
+
|
86
|
+
|
87
|
+
___
|
88
|
+
|
89
|
+
# Create Term
|
90
|
+
## Term Name
|
91
|
+
|
92
|
+
Create Threat Definition
|
93
|
+
|
94
|
+
## Description
|
95
|
+
|
96
|
+
The Threat entity describes a particular threat to the organization's operations that must either be guarded against or accommodated to reduce its impact.
|
97
|
+
|
98
|
+
## Owning Glossary
|
99
|
+
|
100
|
+
Egeria-Markdown
|
101
|
+
|
102
|
+
## Categories
|
103
|
+
|
104
|
+
Writing Dr.Egeria Markdown
|
105
|
+
|
106
|
+
## Usage
|
107
|
+
|
108
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
109
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
110
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
111
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
112
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
113
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
114
|
+
| Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
|
115
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
116
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
117
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
118
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
119
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
120
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
121
|
+
| 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 |
|
122
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
123
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
124
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
125
|
+
|
126
|
+
|
127
|
+
___
|
128
|
+
|
129
|
+
# Create Term
|
130
|
+
## Term Name
|
131
|
+
|
132
|
+
Create Governance Principle
|
133
|
+
|
134
|
+
## Description
|
135
|
+
|
136
|
+
The GovernancePrinciple entity defines a policy that describes an end state that the organization aims to achieve.
|
137
|
+
|
138
|
+
## Owning Glossary
|
139
|
+
|
140
|
+
Egeria-Markdown
|
141
|
+
|
142
|
+
## Categories
|
143
|
+
|
144
|
+
Writing Dr.Egeria Markdown
|
145
|
+
|
146
|
+
## Usage
|
147
|
+
|
148
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
149
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
150
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
151
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
152
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
153
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
154
|
+
| Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
|
155
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
156
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
157
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
158
|
+
| Governance Drivers | False | True | False | None | The drivers this policy is in response to. Drivers may be Business Imperatives, Regulations, Governance Strategy or Threats. | False | |
|
159
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
160
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
161
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
162
|
+
| 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 |
|
163
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
164
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
165
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
166
|
+
|
167
|
+
|
168
|
+
___
|
169
|
+
|
170
|
+
# Create Term
|
171
|
+
## Term Name
|
172
|
+
|
173
|
+
Create Governance Obligation
|
174
|
+
|
175
|
+
## Description
|
176
|
+
|
177
|
+
The GovernanceObligation entity defines a policy that describes a requirement that must be met.
|
178
|
+
|
179
|
+
## Owning Glossary
|
180
|
+
|
181
|
+
Egeria-Markdown
|
182
|
+
|
183
|
+
## Categories
|
184
|
+
|
185
|
+
Writing Dr.Egeria Markdown
|
186
|
+
|
187
|
+
## Usage
|
188
|
+
|
189
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
190
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
191
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
192
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
193
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
194
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
195
|
+
| Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
|
196
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
197
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
198
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
199
|
+
| Governance Drivers | False | True | False | None | The drivers this policy is in response to. Drivers may be Business Imperatives, Regulations, Governance Strategy or Threats. | False | |
|
200
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
201
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
202
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
203
|
+
| 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 |
|
204
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
205
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
206
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
207
|
+
|
208
|
+
|
209
|
+
___
|
210
|
+
|
211
|
+
# Create Term
|
212
|
+
## Term Name
|
213
|
+
|
214
|
+
Create Governance Approach
|
215
|
+
|
216
|
+
## Description
|
217
|
+
|
218
|
+
The GovernanceApproach entity defines a policy that describes a method that should be used for a particular activity.
|
219
|
+
|
220
|
+
## Owning Glossary
|
221
|
+
|
222
|
+
Egeria-Markdown
|
223
|
+
|
224
|
+
## Categories
|
225
|
+
|
226
|
+
Writing Dr.Egeria Markdown
|
227
|
+
|
228
|
+
## Usage
|
229
|
+
|
230
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
231
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
232
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
233
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
234
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
235
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
236
|
+
| Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
|
237
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
238
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
239
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
240
|
+
| Governance Drivers | False | True | False | None | The drivers this policy is in response to. Drivers may be Business Imperatives, Regulations, Governance Strategy or Threats. | False | |
|
241
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
242
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
243
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
244
|
+
| 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 |
|
245
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
246
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
247
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
248
|
+
|
249
|
+
|
250
|
+
___
|
251
|
+
|
252
|
+
# Create Term
|
253
|
+
## Term Name
|
254
|
+
|
255
|
+
Create Governance Processing Purpose
|
256
|
+
|
257
|
+
## Description
|
258
|
+
|
259
|
+
Privacy regulations such as (GDPR) require data subjects to agree the processing that is permitted on their data.
|
260
|
+
|
261
|
+
## Owning Glossary
|
262
|
+
|
263
|
+
Egeria-Markdown
|
264
|
+
|
265
|
+
## Categories
|
266
|
+
|
267
|
+
Writing Dr.Egeria Markdown
|
268
|
+
|
269
|
+
## Usage
|
270
|
+
|
271
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
272
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
273
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
274
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
275
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
276
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
277
|
+
| Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
|
278
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
279
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
280
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
281
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
282
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
283
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
284
|
+
| 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 |
|
285
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
286
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
287
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
288
|
+
|
289
|
+
|
290
|
+
___
|
291
|
+
|
292
|
+
# Create Term
|
293
|
+
## Term Name
|
294
|
+
|
295
|
+
Create Governance Strategy
|
296
|
+
|
297
|
+
## Description
|
298
|
+
|
299
|
+
The strategy used in the development of the governance domains activities. How the governance domain supports the business strategy.
|
300
|
+
|
301
|
+
## Owning Glossary
|
302
|
+
|
303
|
+
Egeria-Markdown
|
304
|
+
|
305
|
+
## Categories
|
306
|
+
|
307
|
+
Writing Dr.Egeria Markdown
|
308
|
+
|
309
|
+
## Usage
|
310
|
+
|
311
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
312
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
313
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
314
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
315
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
316
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
317
|
+
| Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
|
318
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
319
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
320
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
321
|
+
| Business Imperatives | False | True | False | None | List of imperitives. | False | |
|
322
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
323
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
324
|
+
| 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 |
|
325
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
326
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
327
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
328
|
+
|
329
|
+
|
330
|
+
___
|
331
|
+
|
332
|
+
# Create Term
|
333
|
+
## Term Name
|
334
|
+
|
335
|
+
Create Regulation Definition
|
336
|
+
|
337
|
+
## Description
|
338
|
+
|
339
|
+
Defines a relevant legal regulation that the business operation must comply with. Often regulations are divided into regulation articles.
|
340
|
+
|
341
|
+
## Owning Glossary
|
342
|
+
|
343
|
+
Egeria-Markdown
|
344
|
+
|
345
|
+
## Categories
|
346
|
+
|
347
|
+
Writing Dr.Egeria Markdown
|
348
|
+
|
349
|
+
## Usage
|
350
|
+
|
351
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
352
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
353
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
354
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
355
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
356
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
357
|
+
| Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
|
358
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
359
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
360
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
361
|
+
| Source | False | True | False | None | The source of the regulator. | False | |
|
362
|
+
| Regulators | False | True | False | None | The regulatory authorities responsible for monitoring compliance to regulations. | False | |
|
363
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
364
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
365
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
366
|
+
| 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 |
|
367
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
368
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
369
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
370
|
+
|
371
|
+
|
372
|
+
___
|
373
|
+
|
374
|
+
# Create Term
|
375
|
+
## Term Name
|
376
|
+
|
377
|
+
Create Governance Rule
|
378
|
+
|
379
|
+
## Description
|
380
|
+
|
381
|
+
An executable rule that can be deployed at particular points in the operations.
|
382
|
+
|
383
|
+
## Owning Glossary
|
384
|
+
|
385
|
+
Egeria-Markdown
|
386
|
+
|
387
|
+
## Categories
|
388
|
+
|
389
|
+
Writing Dr.Egeria Markdown
|
390
|
+
|
391
|
+
## Usage
|
392
|
+
|
393
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
394
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
395
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
396
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
397
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
398
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
399
|
+
| Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
|
400
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
401
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
402
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
403
|
+
| Implementation Description | False | True | False | None | Describes how this governance control is implemented. | False | |
|
404
|
+
| Supports Policies | False | True | False | None | The policies that this governance control supports. | False | |
|
405
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
406
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
407
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
408
|
+
| 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 |
|
409
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
410
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
411
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
412
|
+
|
413
|
+
|
414
|
+
___
|
415
|
+
|
416
|
+
# Create Term
|
417
|
+
## Term Name
|
418
|
+
|
419
|
+
Create Service Level Objectives
|
420
|
+
|
421
|
+
## Description
|
422
|
+
|
423
|
+
Defines the performance, availability and qualitiy levels expected by the element attached.
|
424
|
+
|
425
|
+
## Owning Glossary
|
426
|
+
|
427
|
+
Egeria-Markdown
|
428
|
+
|
429
|
+
## Categories
|
430
|
+
|
431
|
+
Writing Dr.Egeria Markdown
|
432
|
+
|
433
|
+
## Usage
|
434
|
+
|
435
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
436
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
437
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
438
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
439
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
440
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
441
|
+
| Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
|
442
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
443
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
444
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
445
|
+
| Implementation Description | False | True | False | None | Describes how this governance control is implemnted. | False | |
|
446
|
+
| Supports Policies | False | True | False | None | The policies that this governance control supports. | False | |
|
447
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
448
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
449
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
450
|
+
| 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 |
|
451
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
452
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
453
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
454
|
+
|
455
|
+
|
456
|
+
___
|
457
|
+
|
458
|
+
# Create Term
|
459
|
+
## Term Name
|
460
|
+
|
461
|
+
Create Governance Process
|
462
|
+
|
463
|
+
## Description
|
464
|
+
|
465
|
+
An executable process that choreographs different actions.
|
466
|
+
|
467
|
+
## Owning Glossary
|
468
|
+
|
469
|
+
Egeria-Markdown
|
470
|
+
|
471
|
+
## Categories
|
472
|
+
|
473
|
+
Writing Dr.Egeria Markdown
|
474
|
+
|
475
|
+
## Usage
|
476
|
+
|
477
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
478
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
479
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
480
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
481
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
482
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
483
|
+
| Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
|
484
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
485
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
486
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
487
|
+
| Implementation Description | False | True | False | None | Describes how this governance control is implemnted. | False | |
|
488
|
+
| Supports Policies | False | True | False | None | The policies that this governance control supports. | False | |
|
489
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
490
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
491
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
492
|
+
| 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 |
|
493
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
494
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
495
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
496
|
+
|
497
|
+
|
498
|
+
___
|
499
|
+
|
500
|
+
# Create Term
|
501
|
+
## Term Name
|
502
|
+
|
503
|
+
Create Governance Responsibility
|
504
|
+
|
505
|
+
## Description
|
506
|
+
|
507
|
+
A responsiblity assigned to an actor or team. It could be a requirement to take a certain action in specific circumstances or to make decisions or give approvals for actions.
|
508
|
+
|
509
|
+
## Owning Glossary
|
510
|
+
|
511
|
+
Egeria-Markdown
|
512
|
+
|
513
|
+
## Categories
|
514
|
+
|
515
|
+
Writing Dr.Egeria Markdown
|
516
|
+
|
517
|
+
## Usage
|
518
|
+
|
519
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
520
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
521
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
522
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
523
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
524
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
525
|
+
| Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
|
526
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
527
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
528
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
529
|
+
| Implementation Description | False | True | False | None | Describes how this governance control is implemnted. | False | |
|
530
|
+
| Supports Policies | False | True | False | None | The policies that this governance control supports. | False | |
|
531
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
532
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
533
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
534
|
+
| 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 |
|
535
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
536
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
537
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
538
|
+
|
539
|
+
|
540
|
+
___
|
541
|
+
|
542
|
+
# Create Term
|
543
|
+
## Term Name
|
544
|
+
|
545
|
+
Create Governance Procedure
|
546
|
+
|
547
|
+
## Description
|
548
|
+
|
549
|
+
A manual procedure that is performed under certain circumstances.
|
550
|
+
|
551
|
+
## Owning Glossary
|
552
|
+
|
553
|
+
Egeria-Markdown
|
554
|
+
|
555
|
+
## Categories
|
556
|
+
|
557
|
+
Writing Dr.Egeria Markdown
|
558
|
+
|
559
|
+
## Usage
|
560
|
+
|
561
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
562
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
563
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
564
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
565
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
566
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
567
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
568
|
+
| Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
|
569
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
570
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
571
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
572
|
+
| Implementation Description | False | True | False | None | Describes how this governance control is implemnted. | False | |
|
573
|
+
| Supports Policies | False | True | False | None | The policies that this governance control supports. | False | |
|
574
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
575
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
576
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
577
|
+
| 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 |
|
578
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
579
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
580
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
581
|
+
|
582
|
+
|
583
|
+
___
|
584
|
+
|
585
|
+
# Create Term
|
586
|
+
## Term Name
|
587
|
+
|
588
|
+
Create Security Access Control
|
589
|
+
|
590
|
+
## Description
|
591
|
+
|
592
|
+
A technical control that defines the access control lists that an actor must belong to be entitled to perform a specific action.
|
593
|
+
|
594
|
+
## Owning Glossary
|
595
|
+
|
596
|
+
Egeria-Markdown
|
597
|
+
|
598
|
+
## Categories
|
599
|
+
|
600
|
+
Writing Dr.Egeria Markdown
|
601
|
+
|
602
|
+
## Usage
|
603
|
+
|
604
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
605
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
606
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
607
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
608
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
609
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
610
|
+
| Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
|
611
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
612
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
613
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
614
|
+
| Implementation Description | False | True | False | None | Describes how this governance control is implemnted. | False | |
|
615
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
616
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
617
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
618
|
+
| 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 |
|
619
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
620
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
621
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
622
|
+
|
623
|
+
|
624
|
+
___
|
625
|
+
|
626
|
+
# Create Term
|
627
|
+
## Term Name
|
628
|
+
|
629
|
+
Create Security Group
|
630
|
+
|
631
|
+
## Description
|
632
|
+
|
633
|
+
A group of actors that need to be given the same access to a specific set of resources.
|
634
|
+
|
635
|
+
## Owning Glossary
|
636
|
+
|
637
|
+
Egeria-Markdown
|
638
|
+
|
639
|
+
## Categories
|
640
|
+
|
641
|
+
Writing Dr.Egeria Markdown
|
642
|
+
|
643
|
+
## Usage
|
644
|
+
|
645
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
646
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
647
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
648
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
649
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
650
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
651
|
+
| Distinguished Name | False | True | False | None | Unique identity of an actor. | False | |
|
652
|
+
| Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
|
653
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
654
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
655
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
656
|
+
| Implementation Description | False | True | False | None | Describes how this governance control is implemnted. | False | |
|
657
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
658
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
659
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
660
|
+
| 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 |
|
661
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
662
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
663
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
664
|
+
|
665
|
+
|
666
|
+
___
|
667
|
+
|
668
|
+
# Create Term
|
669
|
+
## Term Name
|
670
|
+
|
671
|
+
Create Naming Standard Rule
|
672
|
+
|
673
|
+
## Description
|
674
|
+
|
675
|
+
A standard for naming specific kinds of resources.
|
676
|
+
|
677
|
+
## Owning Glossary
|
678
|
+
|
679
|
+
Egeria-Markdown
|
680
|
+
|
681
|
+
## Categories
|
682
|
+
|
683
|
+
Writing Dr.Egeria Markdown
|
684
|
+
|
685
|
+
## Usage
|
686
|
+
|
687
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
688
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
689
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
690
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
691
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
692
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
693
|
+
| Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
|
694
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
695
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
696
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
697
|
+
| Implementation Description | False | True | False | None | Describes how this governance control is implemnted. | False | |
|
698
|
+
| Supports Policies | False | True | False | None | The policies that this governance control supports. | False | |
|
699
|
+
| Name Patterns | False | True | False | None | List of implications. | False | |
|
700
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
701
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
702
|
+
| 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 |
|
703
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
704
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
705
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
706
|
+
|
707
|
+
|
708
|
+
___
|
709
|
+
|
710
|
+
# Create Term
|
711
|
+
## Term Name
|
712
|
+
|
713
|
+
Create Certification Type
|
714
|
+
|
715
|
+
## Description
|
716
|
+
|
717
|
+
A type of certification.
|
718
|
+
|
719
|
+
## Owning Glossary
|
720
|
+
|
721
|
+
Egeria-Markdown
|
722
|
+
|
723
|
+
## Categories
|
724
|
+
|
725
|
+
Writing Dr.Egeria Markdown
|
726
|
+
|
727
|
+
## Usage
|
728
|
+
|
729
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
730
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
731
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
732
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
733
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
734
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
735
|
+
| Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
|
736
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
737
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
738
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
739
|
+
| Details | False | True | False | None | Details of the certification. | False | |
|
740
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
741
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
742
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
743
|
+
| 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 |
|
744
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
745
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
746
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
747
|
+
|
748
|
+
|
749
|
+
___
|
750
|
+
|
751
|
+
# Create Term
|
752
|
+
## Term Name
|
753
|
+
|
754
|
+
Create License Type
|
755
|
+
|
756
|
+
## Description
|
757
|
+
|
758
|
+
A type of license.
|
759
|
+
|
760
|
+
## Owning Glossary
|
761
|
+
|
762
|
+
Egeria-Markdown
|
763
|
+
|
764
|
+
## Categories
|
765
|
+
|
766
|
+
Writing Dr.Egeria Markdown
|
767
|
+
|
768
|
+
## Usage
|
769
|
+
|
770
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
771
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
772
|
+
| Display Name | True | True | False | None | Name of the definition. | False | |
|
773
|
+
| Summary | False | True | False | None | Summary of the definition. | False | |
|
774
|
+
| Description | False | True | False | None | Description of the contents of the definition. | False | |
|
775
|
+
| Domain Identifier | False | True | False | None | Integer representing the governance domain. All domains is 0. | False | |
|
776
|
+
| Document Identifier | False | True | False | None | A user supplied identifier for the governance document. | False | |
|
777
|
+
| Version Identifier | False | True | False | None | Published version identifier. | False | |
|
778
|
+
| Scope | False | True | False | None | Scope of the definition. | False | |
|
779
|
+
| Importance | False | True | False | None | Importance of the definition. | False | |
|
780
|
+
| Details | False | True | False | None | Details of the license. | False | |
|
781
|
+
| Implications | False | True | False | None | List of implications. | False | |
|
782
|
+
| Outcomes | False | True | False | None | List of desired outcomes. | False | |
|
783
|
+
| Results | False | True | False | None | A list of expected results. | False | |
|
784
|
+
| 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 |
|
785
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
786
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
787
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
788
|
+
|
789
|
+
|
790
|
+
___
|
791
|
+
|
792
|
+
# Create Term
|
793
|
+
## Term Name
|
794
|
+
|
795
|
+
Link Governance Drivers
|
796
|
+
|
797
|
+
## Description
|
798
|
+
|
799
|
+
Link peer governance drivers with the GovernanceDriverLink relationship. Drivers are: GovernanceStrategy, BusinessImperitive, Regulation, RegulationArticle, Threat.
|
800
|
+
|
801
|
+
## Owning Glossary
|
802
|
+
|
803
|
+
Egeria-Markdown
|
804
|
+
|
805
|
+
## Categories
|
806
|
+
|
807
|
+
Writing Dr.Egeria Markdown
|
808
|
+
|
809
|
+
## Usage
|
810
|
+
|
811
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
812
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
813
|
+
| Definition 1 | True | True | False | None | The first governance driver to link. | False | |
|
814
|
+
| Definition 2 | True | True | False | None | The second governance driver to link. | False | |
|
815
|
+
| Link Label | False | True | False | None | Labels the link between two governance defninitions. | False | |
|
816
|
+
| Description | False | True | False | None | A description of the relationship. | False | |
|
817
|
+
|
818
|
+
|
819
|
+
___
|
820
|
+
|
821
|
+
# Create Term
|
822
|
+
## Term Name
|
823
|
+
|
824
|
+
Link Governance Policies
|
825
|
+
|
826
|
+
## Description
|
827
|
+
|
828
|
+
Link peer governance policies with the GovernancePolicyLink relationship. Policies types are: GovernancePrinciple, GovernanceObligation, GovernanceApproach.
|
829
|
+
|
830
|
+
## Owning Glossary
|
831
|
+
|
832
|
+
Egeria-Markdown
|
833
|
+
|
834
|
+
## Categories
|
835
|
+
|
836
|
+
Writing Dr.Egeria Markdown
|
837
|
+
|
838
|
+
## Usage
|
839
|
+
|
840
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
841
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
842
|
+
| Definition 1 | True | True | False | None | The first governance policy to link. | False | |
|
843
|
+
| Definition 2 | True | True | False | None | The second governance policy to link. | False | |
|
844
|
+
| Link Label | False | True | False | None | Labels the link between two governance defninitions. | False | |
|
845
|
+
| Description | False | True | False | None | A description of the relationship. | False | |
|
846
|
+
|
847
|
+
|
848
|
+
___
|
849
|
+
|
850
|
+
# Create Term
|
851
|
+
## Term Name
|
852
|
+
|
853
|
+
Link Governance Controls
|
854
|
+
|
855
|
+
## Description
|
856
|
+
|
857
|
+
Link peer governance controls with the GovernanceControlLink relationship. Controls types are: GovernanceRule, GovernanceProcess, GovernanceResponsibility, GovernanceProcedure, SecurityAccessControl, SecurityGroup.
|
858
|
+
|
859
|
+
## Owning Glossary
|
860
|
+
|
861
|
+
Egeria-Markdown
|
862
|
+
|
863
|
+
## Categories
|
864
|
+
|
865
|
+
Writing Dr.Egeria Markdown
|
866
|
+
|
867
|
+
## Usage
|
868
|
+
|
869
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
870
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
871
|
+
| Control Definition 1 | True | True | False | None | The first governance control to link. | False | |
|
872
|
+
| Control Definition 2 | True | True | False | None | The fsecond governance control to link. | False | |
|
873
|
+
| Link Label | False | True | False | None | Labels the link between two governance defninitions. | False | |
|
874
|
+
| Description | False | True | False | None | A description of the relationship. | False | |
|
875
|
+
|
876
|
+
|
877
|
+
___
|
878
|
+
|
879
|
+
# Create Term
|
880
|
+
## Term Name
|
881
|
+
|
882
|
+
View Governance Definitions
|
883
|
+
|
884
|
+
## Description
|
885
|
+
|
886
|
+
This can be used to list any kind of governance definitions.
|
887
|
+
|
888
|
+
## Owning Glossary
|
889
|
+
|
890
|
+
Egeria-Markdown
|
891
|
+
|
892
|
+
## Categories
|
893
|
+
|
894
|
+
Writing Dr.Egeria Markdown
|
895
|
+
|
896
|
+
## Usage
|
897
|
+
|
898
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
899
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
900
|
+
| Search String | False | True | False | None | An optional search string to filter results by. | False | |
|
901
|
+
| Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; MERMAID; DICT |
|
902
|
+
| Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
|
903
|
+
| Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
|
904
|
+
| Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
|
905
|
+
| AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
|
906
|
+
| 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 |
|
907
|
+
| 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 | |
|
908
|
+
| Page Size | False | True | False | None | The number of elements returned per page. | False | |
|
909
|
+
| Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
|
910
|
+
|
911
|
+
|
912
|
+
___
|
913
|
+
|
914
|
+
# Create Term
|
915
|
+
## Term Name
|
916
|
+
|
917
|
+
Create Digital Product
|
918
|
+
|
919
|
+
## Description
|
920
|
+
|
921
|
+
A Data Dictionary is an organized and curated collection of data definitions that can serve as a reference for data professionals
|
922
|
+
|
923
|
+
## Owning Glossary
|
924
|
+
|
925
|
+
Egeria-Markdown
|
926
|
+
|
927
|
+
## Categories
|
928
|
+
|
929
|
+
Writing Dr.Egeria Markdown
|
930
|
+
|
931
|
+
## Usage
|
932
|
+
|
933
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
934
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
935
|
+
| Display Name | True | True | False | None | Name of the digital product | False | |
|
936
|
+
| Description | False | True | False | None | Description of the contents of a product. | False | |
|
937
|
+
| Product Name | False | True | False | None | The external name of the digital product. | False | |
|
938
|
+
| Product 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 |
|
939
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
940
|
+
| Product Type | False | True | False | None | Type of product - periodic, delta, snapshot, etc | False | |
|
941
|
+
| Product Identifier | False | True | False | None | User specified product identifier. | False | |
|
942
|
+
| Product Description | False | True | False | None | Externally facing description of the product and its intended usage. | False | |
|
943
|
+
| Maturity | False | True | False | None | Product maturity - user defined. | False | |
|
944
|
+
| Service Life | False | True | False | None | Estimated service lifetime of the product. | False | |
|
945
|
+
| 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 | |
|
946
|
+
| 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 | |
|
947
|
+
| 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 | |
|
948
|
+
| Collection Type | False | True | False | None | A user supplied collection type. Defaults to Digital Product. | False | |
|
949
|
+
| Current Version | False | True | False | None | Published product version identifier. | False | |
|
950
|
+
| Product Manager | False | True | False | None | Actors responsible for managing this product. Actors may be individuals, automations, etc. | False | |
|
951
|
+
| Agreements | False | True | False | None | A list of agreements associated with this product. The agreements must already exist. | False | |
|
952
|
+
| Digital Subscriptions | False | True | False | None | | False | |
|
953
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
954
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
955
|
+
|
956
|
+
|
957
|
+
___
|
958
|
+
|
959
|
+
# Create Term
|
960
|
+
## Term Name
|
961
|
+
|
962
|
+
Link Digital Product - Digital Product
|
963
|
+
|
964
|
+
## Description
|
965
|
+
|
966
|
+
Link digital product dependency between two digital products.
|
967
|
+
|
968
|
+
## Owning Glossary
|
969
|
+
|
970
|
+
Egeria-Markdown
|
971
|
+
|
972
|
+
## Categories
|
973
|
+
|
974
|
+
Writing Dr.Egeria Markdown
|
975
|
+
|
976
|
+
## Usage
|
977
|
+
|
978
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
979
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
980
|
+
| DigitalProduct1 | True | True | False | None | The first product to link. | False | |
|
981
|
+
| DigitalProduct2 | True | True | False | None | The second product to link. | False | |
|
982
|
+
| Label | False | True | False | None | Labels the link between two digital products. | False | |
|
983
|
+
| Description | False | True | False | None | A description of the link. | False | |
|
984
|
+
|
985
|
+
|
986
|
+
___
|
987
|
+
|
988
|
+
# Create Term
|
989
|
+
## Term Name
|
990
|
+
|
991
|
+
Create Agreement
|
992
|
+
|
993
|
+
## Description
|
994
|
+
|
995
|
+
A kind of collection that represents an Agreement. This is for generic agreements. Specific kinds of agreements have their own commands.
|
996
|
+
|
997
|
+
## Owning Glossary
|
998
|
+
|
999
|
+
Egeria-Markdown
|
1000
|
+
|
1001
|
+
## Categories
|
1002
|
+
|
1003
|
+
Writing Dr.Egeria Markdown
|
1004
|
+
|
1005
|
+
## Usage
|
1006
|
+
|
1007
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1008
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1009
|
+
| Display Name | True | True | False | None | Name of the agreement. | False | |
|
1010
|
+
| Description | False | True | False | None | Description of the contents of the agreement. | False | |
|
1011
|
+
| Agreement Identifier | False | True | False | None | A user specified agreement identifier. | False | |
|
1012
|
+
| Agreement 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 |
|
1013
|
+
| User Defined Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
1014
|
+
| Version Identifier | False | True | False | None | Published agreement version identifier. | False | |
|
1015
|
+
| Agreement Actors | False | True | False | None | A list of actors with responsibilities for the agreement. | False | |
|
1016
|
+
| Restrictions | False | True | False | None | A dictionary of property:value pairs describing restrictions. | False | |
|
1017
|
+
| Obligations | False | True | False | None | A dictionary of property:value pairs describing obligations. | False | |
|
1018
|
+
| Entitlements | False | True | False | None | A dictionary of property:value pairs describing entitlements. | False | |
|
1019
|
+
| Usage Measurements | False | True | False | None | A dictionary of property:value pairs describing usage measurements. | False | |
|
1020
|
+
| Product Metrics | False | True | False | None | A dictionary of property:value pairs describing metrics for the product/. | False | |
|
1021
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
1022
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
1023
|
+
|
1024
|
+
|
1025
|
+
___
|
1026
|
+
|
1027
|
+
# Create Term
|
1028
|
+
## Term Name
|
1029
|
+
|
1030
|
+
Create Data Sharing Agreement
|
1031
|
+
|
1032
|
+
## Description
|
1033
|
+
|
1034
|
+
Create a new collection with the DataSharingAgreement classification.
|
1035
|
+
|
1036
|
+
## Owning Glossary
|
1037
|
+
|
1038
|
+
Egeria-Markdown
|
1039
|
+
|
1040
|
+
## Categories
|
1041
|
+
|
1042
|
+
Writing Dr.Egeria Markdown
|
1043
|
+
|
1044
|
+
## Usage
|
1045
|
+
|
1046
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1047
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1048
|
+
| Display Name | True | True | False | None | Name of the agreement. | False | |
|
1049
|
+
| Description | False | True | False | None | Description of the contents of the agreement. | False | |
|
1050
|
+
| Identifier | False | True | False | None | A user specified agreement identifier. | False | |
|
1051
|
+
| Agreement 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; ACTIVE'; DEPRECATED; OTHER |
|
1052
|
+
| User_Defined_Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
1053
|
+
| Version Identifier | False | True | False | None | Published agreement version identifier. | False | |
|
1054
|
+
| Product Manager | False | True | False | None | An actor responsible for managing this product. Actors may be individuals, automations, etc. | False | |
|
1055
|
+
| Digital Subscriptions | False | True | False | None | | False | |
|
1056
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
1057
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
1058
|
+
|
1059
|
+
|
1060
|
+
___
|
1061
|
+
|
1062
|
+
# Create Term
|
1063
|
+
## Term Name
|
1064
|
+
|
1065
|
+
Create DigitalSubscription
|
1066
|
+
|
1067
|
+
## Description
|
1068
|
+
|
1069
|
+
A type of agreement for a digital subscription.
|
1070
|
+
|
1071
|
+
## Owning Glossary
|
1072
|
+
|
1073
|
+
Egeria-Markdown
|
1074
|
+
|
1075
|
+
## Categories
|
1076
|
+
|
1077
|
+
Writing Dr.Egeria Markdown
|
1078
|
+
|
1079
|
+
## Usage
|
1080
|
+
|
1081
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1082
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1083
|
+
| Display Name | True | True | False | None | Name of the agreement. | False | |
|
1084
|
+
| Description | False | True | False | None | Description of the contents of the agreement. | False | |
|
1085
|
+
| Identifier | False | True | False | None | A user specified agreement identifier. | False | |
|
1086
|
+
| Product 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; ACTIVE'; DEPRECATED; OTHER |
|
1087
|
+
| User_Defined_Status | False | True | False | None | Only valid if Product Status is set to OTHER. User defined & managed status values. | False | |
|
1088
|
+
| Support Level | False | True | False | None | Level of support agreed or requested. | False | |
|
1089
|
+
| Service Levels | False | True | False | None | A dictionary of name:value pairs describing the service levels. | False | |
|
1090
|
+
| Restrictions | False | True | False | None | A dictionary of property:value pairs describing restrictions. | False | |
|
1091
|
+
| Obligations | False | True | False | None | A dictionary of property:value pairs describing obligations. | False | |
|
1092
|
+
| Entitlements | False | True | False | None | A dictionary of property:value pairs describing entitlements. | False | |
|
1093
|
+
| Usage Measurements | False | True | False | None | A dictionary of property:value pairs describing usage measurements. | False | |
|
1094
|
+
| Product Metrics | False | True | False | None | A dictionary of property:value pairs describing metrics for the product/. | False | |
|
1095
|
+
| Version Identifier | False | True | False | None | Published agreement version identifier. | False | |
|
1096
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
1097
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
1098
|
+
|
1099
|
+
|
1100
|
+
___
|
1101
|
+
|
1102
|
+
# Create Term
|
1103
|
+
## Term Name
|
1104
|
+
|
1105
|
+
Link Agreement Items
|
1106
|
+
|
1107
|
+
## Description
|
1108
|
+
|
1109
|
+
Attach or detach an agreement to an element referenced in its definition. Agreement item can be an referenced element.
|
1110
|
+
|
1111
|
+
## Owning Glossary
|
1112
|
+
|
1113
|
+
Egeria-Markdown
|
1114
|
+
|
1115
|
+
## Categories
|
1116
|
+
|
1117
|
+
Writing Dr.Egeria Markdown
|
1118
|
+
|
1119
|
+
## Usage
|
1120
|
+
|
1121
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1122
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1123
|
+
| Description | False | True | False | None | Description of the contents of the agreement item. | False | |
|
1124
|
+
| Agreement Item Id | False | True | False | None | A user specified agreement item identifier. | False | |
|
1125
|
+
| Agreement Start | False | True | False | None | The start date of the agreement as an ISO 8601 string. | False | |
|
1126
|
+
| Agreement End | False | True | False | None | The end date of the agreement as an ISO 8601 string. | False | |
|
1127
|
+
| Restrictions | False | True | False | None | A dictionary of property:value pairs describing restrictions. | False | |
|
1128
|
+
| Obligations | False | True | False | None | A dictionary of property:value pairs describing obligations. | False | |
|
1129
|
+
| Entitlements | False | True | False | None | A dictionary of property:value pairs describing entitlements. | False | |
|
1130
|
+
| Usage Measurements | False | True | False | None | A dictionary of property:value pairs describing usage measurements. | False | |
|
1131
|
+
| Usage Metrics | False | True | False | None | A dictionary of property:value pairs describing usage metrics for the agreements. | False | |
|
1132
|
+
|
1133
|
+
|
1134
|
+
___
|
1135
|
+
|
1136
|
+
# Create Term
|
1137
|
+
## Term Name
|
1138
|
+
|
1139
|
+
Link Contracts
|
1140
|
+
|
1141
|
+
## Description
|
1142
|
+
|
1143
|
+
Attach or detach an agreement to an element describing the location of the contract documents.
|
1144
|
+
|
1145
|
+
## Owning Glossary
|
1146
|
+
|
1147
|
+
Egeria-Markdown
|
1148
|
+
|
1149
|
+
## Categories
|
1150
|
+
|
1151
|
+
Writing Dr.Egeria Markdown
|
1152
|
+
|
1153
|
+
## Usage
|
1154
|
+
|
1155
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1156
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1157
|
+
| Contract Id | False | True | False | None | Contract identifier. | False | |
|
1158
|
+
| Contract Liaison | False | True | False | None | Name of the liaison for the contract. | False | |
|
1159
|
+
| Contract Liaison Type | False | True | False | None | type of liaison. | False | |
|
1160
|
+
| Contract Liaison Property Name | False | True | False | None | | False | |
|
1161
|
+
|
1162
|
+
|
1163
|
+
___
|
1164
|
+
|
1165
|
+
# Create Term
|
1166
|
+
## Term Name
|
1167
|
+
|
1168
|
+
Link Subscribers
|
1169
|
+
|
1170
|
+
## Description
|
1171
|
+
|
1172
|
+
Attach or detach a subscriber to a subscription. Subscriber can be any type of element.
|
1173
|
+
|
1174
|
+
## Owning Glossary
|
1175
|
+
|
1176
|
+
Egeria-Markdown
|
1177
|
+
|
1178
|
+
## Categories
|
1179
|
+
|
1180
|
+
Writing Dr.Egeria Markdown
|
1181
|
+
|
1182
|
+
## Usage
|
1183
|
+
|
1184
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1185
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1186
|
+
| 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 | |
|
1187
|
+
| Agreement Start | False | True | False | None | The start date of the agreement as an ISO 8601 string. | False | |
|
1188
|
+
| Agreement End | False | True | False | None | The end date of the agreement as an ISO 8601 string. | False | |
|
1189
|
+
| Restrictions | False | True | False | None | A dictionary of property:value pairs describing restrictions. | False | |
|
1190
|
+
| Obligations | False | True | False | None | A dictionary of property:value pairs describing obligations. | False | |
|
1191
|
+
| Entitlements | False | True | False | None | A dictionary of property:value pairs describing entitlements. | False | |
|
1192
|
+
| Usage Measurements | False | True | False | None | A dictionary of property:value pairs describing usage measurements. | False | |
|
1193
|
+
|
1194
|
+
|
1195
|
+
___
|
1196
|
+
|
1197
|
+
# Create Term
|
1198
|
+
## Term Name
|
1199
|
+
|
1200
|
+
Attach Collection->Resource
|
1201
|
+
|
1202
|
+
## Description
|
1203
|
+
|
1204
|
+
Connect an existing collection to an element using the ResourceList relationship.
|
1205
|
+
|
1206
|
+
## Owning Glossary
|
1207
|
+
|
1208
|
+
Egeria-Markdown
|
1209
|
+
|
1210
|
+
## Categories
|
1211
|
+
|
1212
|
+
Writing Dr.Egeria Markdown
|
1213
|
+
|
1214
|
+
## Usage
|
1215
|
+
|
1216
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1217
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1218
|
+
| Collection | True | True | False | None | An element of base type collection (e.g. collection, agreement; subscription, ...) | False | |
|
1219
|
+
| Resource | True | True | False | None | The name of the resource to attach to. | False | |
|
1220
|
+
| Resource Use | False | True | False | None | Describes the relationship between the resource and the collection. | False | |
|
1221
|
+
| Resource Description | False | True | False | None | A description of the resource being attached. | False | |
|
1222
|
+
| Resource Use Properties | False | True | False | None | A dictionary of name:value pairs describing properties of the resource use. | False | |
|
1223
|
+
|
1224
|
+
|
1225
|
+
___
|
1226
|
+
|
1227
|
+
# Create Term
|
1228
|
+
## Term Name
|
1229
|
+
|
1230
|
+
Add Member->Collection
|
1231
|
+
|
1232
|
+
## Description
|
1233
|
+
|
1234
|
+
Add a member to a collection.
|
1235
|
+
|
1236
|
+
## Owning Glossary
|
1237
|
+
|
1238
|
+
Egeria-Markdown
|
1239
|
+
|
1240
|
+
## Categories
|
1241
|
+
|
1242
|
+
Writing Dr.Egeria Markdown
|
1243
|
+
|
1244
|
+
## Usage
|
1245
|
+
|
1246
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1247
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1248
|
+
| Element_Id | True | True | False | None | The name of the element to add to the collection. | False | |
|
1249
|
+
| 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 | |
|
1250
|
+
| Membership Rationale | False | True | False | None | Rationale for membership. | False | |
|
1251
|
+
| Created By | False | True | False | None | Who added the member. (currently informal string) | False | |
|
1252
|
+
| Membership Status | False | True | False | None | The status of adding a member to a collection. | False | DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER |
|
1253
|
+
|
1254
|
+
|
1255
|
+
___
|
1256
|
+
|
1257
|
+
# Create Term
|
1258
|
+
## Term Name
|
1259
|
+
|
1260
|
+
Create Data Dictionary
|
1261
|
+
|
1262
|
+
## Description
|
1263
|
+
|
1264
|
+
A Data Dictionary is an organized and curated collection of data definitions that can serve as a reference for data professionals
|
1265
|
+
|
1266
|
+
## Owning Glossary
|
1267
|
+
|
1268
|
+
Egeria-Markdown
|
1269
|
+
|
1270
|
+
## Categories
|
1271
|
+
|
1272
|
+
Writing Dr.Egeria Markdown
|
1273
|
+
|
1274
|
+
## Usage
|
1275
|
+
|
1276
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1277
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1278
|
+
| Display Name | True | True | False | None | Name of the Data Dictionary | False | |
|
1279
|
+
| Description | False | True | False | None | A description of the Data Dictionary. | False | |
|
1280
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
1281
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
1282
|
+
|
1283
|
+
|
1284
|
+
___
|
1285
|
+
|
1286
|
+
# Create Term
|
1287
|
+
## Term Name
|
1288
|
+
|
1289
|
+
Create Data Specification
|
1290
|
+
|
1291
|
+
## Description
|
1292
|
+
|
1293
|
+
A Data Specification defines the data requirements for a project or initiative. This includes the data structures , data fields and data classes.
|
1294
|
+
|
1295
|
+
## Owning Glossary
|
1296
|
+
|
1297
|
+
Egeria-Markdown
|
1298
|
+
|
1299
|
+
## Categories
|
1300
|
+
|
1301
|
+
Writing Dr.Egeria Markdown
|
1302
|
+
|
1303
|
+
## Usage
|
1304
|
+
|
1305
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1306
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1307
|
+
| Display Name | True | True | False | None | Name of the Data Specification. | False | |
|
1308
|
+
| Description | False | True | False | None | A description of the Data Specification. | False | |
|
1309
|
+
| Collection Type | False | True | False | None | A user supplied collection type. | False | |
|
1310
|
+
| Qualified Name | True | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
1311
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
1312
|
+
|
1313
|
+
|
1314
|
+
___
|
1315
|
+
|
1316
|
+
# Create Term
|
1317
|
+
## Term Name
|
1318
|
+
|
1319
|
+
Create Data Structure
|
1320
|
+
|
1321
|
+
## Description
|
1322
|
+
|
1323
|
+
A collection of data fields that for a data specification for a data source.
|
1324
|
+
|
1325
|
+
## Owning Glossary
|
1326
|
+
|
1327
|
+
Egeria-Markdown
|
1328
|
+
|
1329
|
+
## Categories
|
1330
|
+
|
1331
|
+
Writing Dr.Egeria Markdown
|
1332
|
+
|
1333
|
+
## Usage
|
1334
|
+
|
1335
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1336
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1337
|
+
| Display Name | True | True | False | None | Name of the data structure. | False | |
|
1338
|
+
| Description | False | True | False | None | A description of the data structure. | False | |
|
1339
|
+
| In Data Specification | False | True | False | None | The data specifications this structure is a member of. | False | |
|
1340
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
1341
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
1342
|
+
|
1343
|
+
|
1344
|
+
___
|
1345
|
+
|
1346
|
+
# Create Term
|
1347
|
+
## Term Name
|
1348
|
+
|
1349
|
+
Create Data Field
|
1350
|
+
|
1351
|
+
## Description
|
1352
|
+
|
1353
|
+
A data field is a fundamental building block for a data structure.
|
1354
|
+
|
1355
|
+
## Owning Glossary
|
1356
|
+
|
1357
|
+
Egeria-Markdown
|
1358
|
+
|
1359
|
+
## Categories
|
1360
|
+
|
1361
|
+
Writing Dr.Egeria Markdown
|
1362
|
+
|
1363
|
+
## Usage
|
1364
|
+
|
1365
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1366
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1367
|
+
| Display Name | True | True | False | None | Name of the Data Field | False | |
|
1368
|
+
| Description | False | True | False | None | A description of the Data Field | False | |
|
1369
|
+
| 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 |
|
1370
|
+
| Position | False | True | False | None | Position of the data field in the data structure. If 0, position is irrelevant. | False | |
|
1371
|
+
| Minimum Cardinality | False | True | False | None | The minimum cardinality for a data element. | False | |
|
1372
|
+
| Maximum Cardinality | False | True | False | None | The maximum cardinality for a data element. | False | |
|
1373
|
+
| 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 | |
|
1374
|
+
| Data Class | False | True | False | None | The data class that values of this data field conform to. | False | |
|
1375
|
+
| Glossary Term | False | True | False | None | Term that provides meaning to this field. | False | |
|
1376
|
+
| isNullable | False | True | False | None | Can the values within the dataclass be absent? | False | |
|
1377
|
+
| Minimum Length | False | True | False | None | | False | |
|
1378
|
+
| Length | False | True | False | None | The length of a value for a field. | False | |
|
1379
|
+
| Precision | False | True | False | None | The precision of a numeric | False | |
|
1380
|
+
| Ordered Values | False | True | False | None | is this field in an ordered list? | False | |
|
1381
|
+
| Units | False | True | False | None | An optional string indicating the units of the field. | False | |
|
1382
|
+
| Default Value | False | True | False | None | Specify a default value for the data class. | False | |
|
1383
|
+
| Version Identifier | False | True | False | None | A user supplied version identifier. | False | |
|
1384
|
+
| In Data Dictionary | False | True | False | None | What data dictionaries is this data field in? | False | |
|
1385
|
+
| Parent Data Field | False | True | False | None | Optional parent field if this is a nested field. | False | |
|
1386
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
1387
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
1388
|
+
|
1389
|
+
|
1390
|
+
___
|
1391
|
+
|
1392
|
+
# Create Term
|
1393
|
+
## Term Name
|
1394
|
+
|
1395
|
+
Create Data Class
|
1396
|
+
|
1397
|
+
## Description
|
1398
|
+
|
1399
|
+
Describes the data values that may be stored in data fields. Can be used to configure quality validators and data field classifiers.
|
1400
|
+
|
1401
|
+
## Owning Glossary
|
1402
|
+
|
1403
|
+
Egeria-Markdown
|
1404
|
+
|
1405
|
+
## Categories
|
1406
|
+
|
1407
|
+
Writing Dr.Egeria Markdown
|
1408
|
+
|
1409
|
+
## Usage
|
1410
|
+
|
1411
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1412
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1413
|
+
| Display Name | True | True | False | None | Name of the data structure. | False | |
|
1414
|
+
| Description | False | True | False | None | A description of the data class. | False | |
|
1415
|
+
| Namespace | False | True | False | None | Optional namespace that scopes the field. | False | |
|
1416
|
+
| Match Property Names | False | True | True | None | Names of the properties that are set. | False | |
|
1417
|
+
| Match Threshold | False | True | False | None | Percent of values that must match the data class specification. | False | |
|
1418
|
+
| IsCaseSensitive | False | True | False | None | Are field values case sensitive? | False | |
|
1419
|
+
| 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 |
|
1420
|
+
| Allow Duplicate Values | False | True | False | None | Allow duplicate values within the data class? | False | |
|
1421
|
+
| isNullable | False | True | False | None | Can the values within the dataclass be absent? | False | |
|
1422
|
+
| isCaseSensitive | False | True | False | None | Indicates if the values in a data class are case sensitive. | False | |
|
1423
|
+
| Default Value | False | True | False | None | Specify a default value for the data class. | False | |
|
1424
|
+
| Average Value | False | True | False | None | Average value for the data class. | False | |
|
1425
|
+
| Value List | False | True | False | None | | False | |
|
1426
|
+
| Value Range From | False | True | False | None | Beginning range of legal values. | False | |
|
1427
|
+
| Value Range To | False | True | False | None | End of valid range for value. | False | |
|
1428
|
+
| Sample Values | False | True | False | None | Sample values of the data class. | False | |
|
1429
|
+
| Data Patterns | False | True | False | None | prescribed format of a data field - e.g. credit card numbers. Often expressed as a regular expression. | False | |
|
1430
|
+
| In Data Dictionary | False | True | False | None | What data dictionaries is this data field in? | False | |
|
1431
|
+
| Containing Data Class | False | True | False | None | Data classes this is part of. | False | |
|
1432
|
+
| Specializes Data Class | False | True | False | None | Specializes a parent data class. | False | |
|
1433
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
1434
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
1435
|
+
|
1436
|
+
|
1437
|
+
___
|
1438
|
+
|
1439
|
+
# Create Term
|
1440
|
+
## Term Name
|
1441
|
+
|
1442
|
+
View Data Fields
|
1443
|
+
|
1444
|
+
## Description
|
1445
|
+
|
1446
|
+
Return the data fields, optionally filtered by the search string.
|
1447
|
+
|
1448
|
+
## Owning Glossary
|
1449
|
+
|
1450
|
+
Egeria-Markdown
|
1451
|
+
|
1452
|
+
## Categories
|
1453
|
+
|
1454
|
+
Writing Dr.Egeria Markdown
|
1455
|
+
|
1456
|
+
## Usage
|
1457
|
+
|
1458
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1459
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1460
|
+
| Search String | False | True | False | None | An optional search string to filter results by. | False | |
|
1461
|
+
| Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; MERMAID; DICT |
|
1462
|
+
| Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
|
1463
|
+
| Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
|
1464
|
+
| Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
|
1465
|
+
| AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
|
1466
|
+
| 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 |
|
1467
|
+
| Page Size | False | True | False | None | The number of elements returned per page. | False | |
|
1468
|
+
| Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
|
1469
|
+
|
1470
|
+
|
1471
|
+
___
|
1472
|
+
|
1473
|
+
# Create Term
|
1474
|
+
## Term Name
|
1475
|
+
|
1476
|
+
View Data Classes
|
1477
|
+
|
1478
|
+
## Description
|
1479
|
+
|
1480
|
+
Return the data classes, optionally filtered by the search string.
|
1481
|
+
|
1482
|
+
## Owning Glossary
|
1483
|
+
|
1484
|
+
Egeria-Markdown
|
1485
|
+
|
1486
|
+
## Categories
|
1487
|
+
|
1488
|
+
Writing Dr.Egeria Markdown
|
1489
|
+
|
1490
|
+
## Usage
|
1491
|
+
|
1492
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1493
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1494
|
+
| Search String | False | True | False | None | An optional search string to filter results by. | False | |
|
1495
|
+
| Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; REPORT; MERMAID; DICT |
|
1496
|
+
| Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
|
1497
|
+
| Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
|
1498
|
+
| Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
|
1499
|
+
| AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
|
1500
|
+
| 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 |
|
1501
|
+
| Page Size | False | True | False | None | The number of elements returned per page. | False | |
|
1502
|
+
| Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
|
1503
|
+
|
1504
|
+
|
1505
|
+
___
|
1506
|
+
|
1507
|
+
# Create Term
|
1508
|
+
## Term Name
|
1509
|
+
|
1510
|
+
View Data Structures
|
1511
|
+
|
1512
|
+
## Description
|
1513
|
+
|
1514
|
+
Return the data structures, optionally filtered by the search string.
|
1515
|
+
|
1516
|
+
## Owning Glossary
|
1517
|
+
|
1518
|
+
Egeria-Markdown
|
1519
|
+
|
1520
|
+
## Categories
|
1521
|
+
|
1522
|
+
Writing Dr.Egeria Markdown
|
1523
|
+
|
1524
|
+
## Usage
|
1525
|
+
|
1526
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1527
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1528
|
+
| Search String | False | True | False | None | An optional search string to filter results by. | False | |
|
1529
|
+
| Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
|
1530
|
+
| Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
|
1531
|
+
| Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
|
1532
|
+
| Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
|
1533
|
+
| AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
|
1534
|
+
| 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 |
|
1535
|
+
| Page Size | False | True | False | None | The number of elements returned per page. | False | |
|
1536
|
+
| Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
|
1537
|
+
|
1538
|
+
|
1539
|
+
___
|
1540
|
+
|
1541
|
+
# Create Term
|
1542
|
+
## Term Name
|
1543
|
+
|
1544
|
+
View Data Specifications
|
1545
|
+
|
1546
|
+
## Description
|
1547
|
+
|
1548
|
+
Return the data specifications, optionally filtered by the search string.
|
1549
|
+
|
1550
|
+
## Owning Glossary
|
1551
|
+
|
1552
|
+
Egeria-Markdown
|
1553
|
+
|
1554
|
+
## Categories
|
1555
|
+
|
1556
|
+
Writing Dr.Egeria Markdown
|
1557
|
+
|
1558
|
+
## Usage
|
1559
|
+
|
1560
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1561
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1562
|
+
| Search String | False | True | False | None | An optional search string to filter results by. | False | |
|
1563
|
+
| Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; DICT; MD; MERMAID; REPORT |
|
1564
|
+
| Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
|
1565
|
+
| Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
|
1566
|
+
| Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
|
1567
|
+
| AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
|
1568
|
+
| 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 |
|
1569
|
+
| Page Size | False | True | False | None | The number of elements returned per page. | False | |
|
1570
|
+
| Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
|
1571
|
+
|
1572
|
+
|
1573
|
+
___
|
1574
|
+
|
1575
|
+
# Create Term
|
1576
|
+
## Term Name
|
1577
|
+
|
1578
|
+
View Data Dictionaries
|
1579
|
+
|
1580
|
+
## Description
|
1581
|
+
|
1582
|
+
Return the data dictionaries, optionally filtered by the search string.
|
1583
|
+
|
1584
|
+
## Owning Glossary
|
1585
|
+
|
1586
|
+
Egeria-Markdown
|
1587
|
+
|
1588
|
+
## Categories
|
1589
|
+
|
1590
|
+
Writing Dr.Egeria Markdown
|
1591
|
+
|
1592
|
+
## Usage
|
1593
|
+
|
1594
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1595
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1596
|
+
| Search String | False | True | False | None | An optional search string to filter results by. | False | |
|
1597
|
+
| Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; DICT; MD; MERMAID; REPORT |
|
1598
|
+
| Starts With | False | True | False | None | If true, look for matches with the search string starting from the beginning of a field. | False | |
|
1599
|
+
| Ends With | False | True | False | None | If true, look for matches with the search string starting from the end of a field. | False | |
|
1600
|
+
| Ignore Case | False | True | False | None | If true, ignore the difference between upper and lower characters when matching the search string. | False | |
|
1601
|
+
| Page Size | False | True | False | None | The number of elements returned per page. | False | |
|
1602
|
+
| Start From | False | True | False | None | When paging through results, the starting point of the results to return. | False | |
|
1603
|
+
| AsOfTime | False | True | False | None | An ISO-8601 string representing the time to view the state of the repository. | False | |
|
1604
|
+
| 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 |
|
1605
|
+
|
1606
|
+
|
1607
|
+
___
|
1608
|
+
|
1609
|
+
# Create Term
|
1610
|
+
## Term Name
|
1611
|
+
|
1612
|
+
Create Information Supply Chain
|
1613
|
+
|
1614
|
+
## Description
|
1615
|
+
|
1616
|
+
The flow of a particular type of data across a digital landscape.
|
1617
|
+
|
1618
|
+
## Owning Glossary
|
1619
|
+
|
1620
|
+
Egeria-Markdown
|
1621
|
+
|
1622
|
+
## Categories
|
1623
|
+
|
1624
|
+
Writing Dr.Egeria Markdown
|
1625
|
+
|
1626
|
+
## Usage
|
1627
|
+
|
1628
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1629
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1630
|
+
| Display Name | True | True | False | None | Name of the Information Supply Chain | False | |
|
1631
|
+
| Description | False | True | False | None | A description of the data structure. | False | |
|
1632
|
+
| Scope | False | True | False | None | Scope of the supply chain. | False | |
|
1633
|
+
| Purposes | False | True | False | None | A list of purposes. | False | |
|
1634
|
+
| Nested Information Supply Chains | False | True | False | None | A list of supply chains that compose this supply chain. | False | |
|
1635
|
+
| In Information Supply Chain | False | True | False | None | Supply chains that this supply chain is in. | False | |
|
1636
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
1637
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
1638
|
+
| 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 | |
|
1639
|
+
|
1640
|
+
|
1641
|
+
___
|
1642
|
+
|
1643
|
+
# Create Term
|
1644
|
+
## Term Name
|
1645
|
+
|
1646
|
+
Create Solution Blueprint
|
1647
|
+
|
1648
|
+
## Description
|
1649
|
+
|
1650
|
+
A solution blueprint describes the architecture of a digital service in terms of solution components.
|
1651
|
+
|
1652
|
+
## Owning Glossary
|
1653
|
+
|
1654
|
+
Egeria-Markdown
|
1655
|
+
|
1656
|
+
## Categories
|
1657
|
+
|
1658
|
+
Writing Dr.Egeria Markdown
|
1659
|
+
|
1660
|
+
## Usage
|
1661
|
+
|
1662
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1663
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1664
|
+
| Display Name | True | True | False | None | Name of the Information Supply Chain | False | |
|
1665
|
+
| Description | False | True | False | None | A description of the data structure. | False | |
|
1666
|
+
| Version Identifier | False | True | False | None | A user supplied version identifier. | False | |
|
1667
|
+
| Solution Components | False | True | False | None | Solution components that make up the blueprint. | False | |
|
1668
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
1669
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
1670
|
+
|
1671
|
+
|
1672
|
+
___
|
1673
|
+
|
1674
|
+
# Create Term
|
1675
|
+
## Term Name
|
1676
|
+
|
1677
|
+
Create Solution Component
|
1678
|
+
|
1679
|
+
## Description
|
1680
|
+
|
1681
|
+
A reusable solution component.
|
1682
|
+
|
1683
|
+
## Owning Glossary
|
1684
|
+
|
1685
|
+
Egeria-Markdown
|
1686
|
+
|
1687
|
+
## Categories
|
1688
|
+
|
1689
|
+
Writing Dr.Egeria Markdown
|
1690
|
+
|
1691
|
+
## Usage
|
1692
|
+
|
1693
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1694
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1695
|
+
| Display Name | True | True | False | None | Name of the solution component. | False | |
|
1696
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
1697
|
+
| Description | False | True | False | None | A description of the data structure. | False | |
|
1698
|
+
| Solution Component Type | False | True | False | None | Type of solution component. | False | |
|
1699
|
+
| Planned Deployed Implementation Type | False | True | False | None | The planned implementation type for deployment. | False | |
|
1700
|
+
| 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 |
|
1701
|
+
| In Solution Components | False | True | False | None | Solution components that include this one. | False | |
|
1702
|
+
| In Solution Blueprints | False | True | False | None | Solution Blueprints that contain this component. | False | |
|
1703
|
+
| In Information Supply Chains | False | True | False | None | The Information Supply Chains that this component is a member of. | False | |
|
1704
|
+
| Actors | False | True | False | None | Actors associated with this component. | False | |
|
1705
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
1706
|
+
| 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 | |
|
1707
|
+
|
1708
|
+
|
1709
|
+
___
|
1710
|
+
|
1711
|
+
# Create Term
|
1712
|
+
## Term Name
|
1713
|
+
|
1714
|
+
Link Solution Component Peers
|
1715
|
+
|
1716
|
+
## Description
|
1717
|
+
|
1718
|
+
This command can be used to link or unlink wires between components.
|
1719
|
+
|
1720
|
+
## Owning Glossary
|
1721
|
+
|
1722
|
+
Egeria-Markdown
|
1723
|
+
|
1724
|
+
## Categories
|
1725
|
+
|
1726
|
+
Writing Dr.Egeria Markdown
|
1727
|
+
|
1728
|
+
## Usage
|
1729
|
+
|
1730
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1731
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1732
|
+
| Component1 | True | True | False | None | The first component to link. | False | |
|
1733
|
+
| Component2 | True | True | False | None | The second component to link. | False | |
|
1734
|
+
| Wire Label | False | True | False | None | Labels the link between two components. | False | |
|
1735
|
+
| Description | False | True | False | None | A description of the wire. | False | |
|
1736
|
+
|
1737
|
+
|
1738
|
+
___
|
1739
|
+
|
1740
|
+
# Create Term
|
1741
|
+
## Term Name
|
1742
|
+
|
1743
|
+
Create Solution Role
|
1744
|
+
|
1745
|
+
## Description
|
1746
|
+
|
1747
|
+
A collection of data fields that for a data specification for a data source.
|
1748
|
+
|
1749
|
+
## Owning Glossary
|
1750
|
+
|
1751
|
+
Egeria-Markdown
|
1752
|
+
|
1753
|
+
## Categories
|
1754
|
+
|
1755
|
+
Writing Dr.Egeria Markdown
|
1756
|
+
|
1757
|
+
## Usage
|
1758
|
+
|
1759
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1760
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1761
|
+
| Name | True | True | False | None | Name of the role. | False | |
|
1762
|
+
| Description | False | True | False | None | A description of the data structure. | False | |
|
1763
|
+
| Title | False | True | False | None | Title of the role. | False | |
|
1764
|
+
| Scope | False | True | False | None | Scope of the role. | False | |
|
1765
|
+
| identifier | False | True | False | None | role identifier | False | |
|
1766
|
+
| Domain Identifier | False | True | False | None | Governance domain identifier | False | |
|
1767
|
+
| Role Type | False | True | False | None | Type of the role. Currently must be GovernanceRole. | False | |
|
1768
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
1769
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
1770
|
+
|
1771
|
+
|
1772
|
+
___
|
1773
|
+
|
1774
|
+
# Create Term
|
1775
|
+
## Term Name
|
1776
|
+
|
1777
|
+
Link Information Supply Chain Peers
|
1778
|
+
|
1779
|
+
## Description
|
1780
|
+
|
1781
|
+
This command can be used to link or unlink information supply chain segments.
|
1782
|
+
|
1783
|
+
## Owning Glossary
|
1784
|
+
|
1785
|
+
Egeria-Markdown
|
1786
|
+
|
1787
|
+
## Categories
|
1788
|
+
|
1789
|
+
Writing Dr.Egeria Markdown
|
1790
|
+
|
1791
|
+
## Usage
|
1792
|
+
|
1793
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1794
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1795
|
+
| Segment1 | True | True | False | None | The first segment to link. | False | |
|
1796
|
+
| Segment2 | True | True | False | None | The second segment to link. | False | |
|
1797
|
+
| Link Label | False | True | False | None | Labels the link between two information supply chain segments. | False | |
|
1798
|
+
| Description | False | True | False | None | A description of the data structure. | False | |
|
1799
|
+
|
1800
|
+
|
1801
|
+
___
|
1802
|
+
|
1803
|
+
# Create Term
|
1804
|
+
## Term Name
|
1805
|
+
|
1806
|
+
View Information Supply Chains
|
1807
|
+
|
1808
|
+
## Description
|
1809
|
+
|
1810
|
+
Return information supply chains filtered by the search string.
|
1811
|
+
|
1812
|
+
## Owning Glossary
|
1813
|
+
|
1814
|
+
Egeria-Markdown
|
1815
|
+
|
1816
|
+
## Categories
|
1817
|
+
|
1818
|
+
Writing Dr.Egeria Markdown
|
1819
|
+
|
1820
|
+
## Usage
|
1821
|
+
|
1822
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1823
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1824
|
+
| Search String | False | True | False | None | An optional search string to filter results by. | False | |
|
1825
|
+
| Output Format | False | True | False | None | Optional specification of output format for the query. | False | LIST; FORM; MD; REPORT; MERMAID; LIST; DICT; HTML |
|
1826
|
+
| Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
|
1827
|
+
|
1828
|
+
|
1829
|
+
___
|
1830
|
+
|
1831
|
+
# Create Term
|
1832
|
+
## Term Name
|
1833
|
+
|
1834
|
+
View Solution Components
|
1835
|
+
|
1836
|
+
## Description
|
1837
|
+
|
1838
|
+
Return the data structure details, optionally filtered by the search string.
|
1839
|
+
|
1840
|
+
## Owning Glossary
|
1841
|
+
|
1842
|
+
Egeria-Markdown
|
1843
|
+
|
1844
|
+
## Categories
|
1845
|
+
|
1846
|
+
Writing Dr.Egeria Markdown
|
1847
|
+
|
1848
|
+
## Usage
|
1849
|
+
|
1850
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1851
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1852
|
+
| Search String | False | True | False | None | An optional search string to filter results by. | False | |
|
1853
|
+
| Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
|
1854
|
+
| Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
|
1855
|
+
|
1856
|
+
|
1857
|
+
___
|
1858
|
+
|
1859
|
+
# Create Term
|
1860
|
+
## Term Name
|
1861
|
+
|
1862
|
+
View Solution Blueprints
|
1863
|
+
|
1864
|
+
## Description
|
1865
|
+
|
1866
|
+
Return the data structure details, optionally filtered by the search string.
|
1867
|
+
|
1868
|
+
## Owning Glossary
|
1869
|
+
|
1870
|
+
Egeria-Markdown
|
1871
|
+
|
1872
|
+
## Categories
|
1873
|
+
|
1874
|
+
Writing Dr.Egeria Markdown
|
1875
|
+
|
1876
|
+
## Usage
|
1877
|
+
|
1878
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1879
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1880
|
+
| Search String | False | True | False | None | An optional search string to filter results by. | False | |
|
1881
|
+
| Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
|
1882
|
+
| Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
|
1883
|
+
|
1884
|
+
|
1885
|
+
___
|
1886
|
+
|
1887
|
+
# Create Term
|
1888
|
+
## Term Name
|
1889
|
+
|
1890
|
+
View Solution Roles
|
1891
|
+
|
1892
|
+
## Description
|
1893
|
+
|
1894
|
+
Return the data structure details, optionally filtered by the search string.
|
1895
|
+
|
1896
|
+
## Owning Glossary
|
1897
|
+
|
1898
|
+
Egeria-Markdown
|
1899
|
+
|
1900
|
+
## Categories
|
1901
|
+
|
1902
|
+
Writing Dr.Egeria Markdown
|
1903
|
+
|
1904
|
+
## Usage
|
1905
|
+
|
1906
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1907
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1908
|
+
| Search String | False | True | False | None | An optional search string to filter results by. | False | |
|
1909
|
+
| Output Format | False | True | False | None | Optional specification of output format for the query. | False | List; Form; Report; Dict |
|
1910
|
+
| Detailed | False | True | False | None | If true a more detailed set of attributes will be returned. | False | |
|
1911
|
+
|
1912
|
+
|
1913
|
+
___
|
1914
|
+
|
1915
|
+
# Create Term
|
1916
|
+
## Term Name
|
1917
|
+
|
1918
|
+
Create Glossary
|
1919
|
+
|
1920
|
+
## Description
|
1921
|
+
|
1922
|
+
A grouping of definitions.
|
1923
|
+
|
1924
|
+
## Owning Glossary
|
1925
|
+
|
1926
|
+
Egeria-Markdown
|
1927
|
+
|
1928
|
+
## Categories
|
1929
|
+
|
1930
|
+
Writing Dr.Egeria Markdown
|
1931
|
+
|
1932
|
+
## Usage
|
1933
|
+
|
1934
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1935
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1936
|
+
| Glossary Name | True | True | False | None | The name of the glossary to create or update. | False | |
|
1937
|
+
| Description | False | True | False | None | A description of the Glossary. | False | |
|
1938
|
+
| Language | False | True | False | None | The language of the glossary. Note that multilingual descriptions are supported. Please see web site for details. | False | |
|
1939
|
+
| Usage | False | True | False | None | A description of how the glossary is to be used. | False | |
|
1940
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
1941
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
1942
|
+
|
1943
|
+
|
1944
|
+
___
|
1945
|
+
|
1946
|
+
# Create Term
|
1947
|
+
## Term Name
|
1948
|
+
|
1949
|
+
Create Category
|
1950
|
+
|
1951
|
+
## Description
|
1952
|
+
|
1953
|
+
A group of terms that are useful to collect together.
|
1954
|
+
|
1955
|
+
## Owning Glossary
|
1956
|
+
|
1957
|
+
Egeria-Markdown
|
1958
|
+
|
1959
|
+
## Categories
|
1960
|
+
|
1961
|
+
Writing Dr.Egeria Markdown
|
1962
|
+
|
1963
|
+
## Usage
|
1964
|
+
|
1965
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1966
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1967
|
+
| Category Name | True | True | False | None | The name of a category. | False | |
|
1968
|
+
| Description | False | True | False | None | A description of the Category. | False | |
|
1969
|
+
| In Glossary | True | True | False | None | The name of the glossary that contains the Category. Recommend using the Qualified Name of the Glossary, if known. | False | |
|
1970
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
1971
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
1972
|
+
|
1973
|
+
|
1974
|
+
___
|
1975
|
+
|
1976
|
+
# Create Term
|
1977
|
+
## Term Name
|
1978
|
+
|
1979
|
+
Create Term
|
1980
|
+
|
1981
|
+
## Description
|
1982
|
+
|
1983
|
+
|
1984
|
+
|
1985
|
+
## Owning Glossary
|
1986
|
+
|
1987
|
+
Egeria-Markdown
|
1988
|
+
|
1989
|
+
## Categories
|
1990
|
+
|
1991
|
+
Writing Dr.Egeria Markdown
|
1992
|
+
|
1993
|
+
## Usage
|
1994
|
+
|
1995
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
1996
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
1997
|
+
| Term Name | True | True | False | None | The name of the term to create or update. | False | |
|
1998
|
+
| Summary | False | True | False | None | A summary description of the term. | False | |
|
1999
|
+
| Description | False | True | False | None | A description of the term. | False | |
|
2000
|
+
| Abbreviation | False | True | False | None | An abbreviation for the term. | False | |
|
2001
|
+
| Example | False | True | False | None | An example of how the term is used. | False | |
|
2002
|
+
| Usage | False | True | False | None | A description of how the term is to be used. | False | |
|
2003
|
+
| Status | False | True | False | None | The lifecycle status of a term. | False | DRAFT; ACTIVE, DEPRECATED; OBSOLETE; OTHER |
|
2004
|
+
| Published Version Identifier | False | True | False | None | | False | |
|
2005
|
+
| Qualified Name | False | True | True | None | A unique qualified name for the element. Generated using the qualified name pattern if not user specified. | True | |
|
2006
|
+
| GUID | False | False | True | None | A system generated unique identifier. | True | |
|
2007
|
+
|
2008
|
+
|
2009
|
+
___
|
2010
|
+
|
2011
|
+
# Create Term
|
2012
|
+
## Term Name
|
2013
|
+
|
2014
|
+
Attach Category Parent
|
2015
|
+
|
2016
|
+
## Description
|
2017
|
+
|
2018
|
+
Attaches a parent category to a child category.
|
2019
|
+
|
2020
|
+
## Owning Glossary
|
2021
|
+
|
2022
|
+
Egeria-Markdown
|
2023
|
+
|
2024
|
+
## Categories
|
2025
|
+
|
2026
|
+
Writing Dr.Egeria Markdown
|
2027
|
+
|
2028
|
+
## Usage
|
2029
|
+
|
2030
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
2031
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
2032
|
+
| Category Name | True | True | False | None | The name of a category. | False | |
|
2033
|
+
| Parent Category | True | True | False | None | The name of the parent category to attach to. | False | |
|
2034
|
+
|
2035
|
+
|
2036
|
+
___
|
2037
|
+
|
2038
|
+
# Create Term
|
2039
|
+
## Term Name
|
2040
|
+
|
2041
|
+
Attach Term-Term Relationship
|
2042
|
+
|
2043
|
+
## Description
|
2044
|
+
|
2045
|
+
Create a relationship between terms.
|
2046
|
+
|
2047
|
+
## Owning Glossary
|
2048
|
+
|
2049
|
+
Egeria-Markdown
|
2050
|
+
|
2051
|
+
## Categories
|
2052
|
+
|
2053
|
+
Writing Dr.Egeria Markdown
|
2054
|
+
|
2055
|
+
## Usage
|
2056
|
+
|
2057
|
+
| Attribute Name | Input Required | Read Only | Generated | Default Value | Notes | Unique Values | Valid Values |
|
2058
|
+
|-------------|-------------|-------------|-------------|-------------|-------------|-------------|-------------|
|
2059
|
+
| Term 1 | True | True | False | None | The name of the first term term to connect. | False | |
|
2060
|
+
| Term 2 | True | True | False | None | The name of the second term term to connect. | False | |
|
2061
|
+
| 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 |
|
2062
|
+
|
2063
|
+
|
2064
|
+
___
|
2065
|
+
|