pyegeria 5.3.10__py3-none-any.whl → 5.4.0__py3-none-any.whl

md_processing/family_docs/Glossary/Create_Category.md

@@ -0,0 +1,38 @@
+# **Create Category**
+>	A group of terms that are useful to collect together.
+
+## **Category Name**
+>	**Input Required**: True
+
+>	**Description**: The name of a category.
+
+>	**Alternative Labels**: Glossary Category Name; Glossary Category; Category; Display Name
+
+
+## **Description**
+>	**Input Required**: False
+
+>	**Description**: A description of the Category.
+
+
+## **In Glossary**
+>	**Input Required**: True
+
+>	**Description**: The name of the glossary that contains the Category. Recommend using the Qualified Name of the Glossary, if known.
+
+>	**Alternative Labels**: Owning Glossary; Glossary; In Glossary
+
+
+## **Qualified Name**
+>	**Input Required**: False
+
+>	**Description**: A unique qualified name for the element. Generated using the qualified name pattern  if not user specified.
+
+
+## **GUID**
+>	**Input Required**: False
+
+>	**Description**: A system generated unique identifier.
+
+>	**Alternative Labels**: Guid; guid
+

md_processing/family_docs/Glossary/Create_Glossary.md

@@ -0,0 +1,42 @@
+# **Create Glossary**
+>	A grouping of definitions.
+
+## **Glossary Name**
+>	**Input Required**: True
+
+>	**Description**: The name of the glossary to create or update.
+
+>	**Alternative Labels**: Glossary; Display Name
+
+
+## **Description**
+>	**Input Required**: False
+
+>	**Description**: A description of the Glossary.
+
+
+## **Language**
+>	**Input Required**: False
+
+>	**Description**: The language of the glossary. Note that multilingual descriptions are supported. Please see web site for details.
+
+
+## **Usage**
+>	**Input Required**: False
+
+>	**Description**: A description of how the glossary is to be used.
+
+
+## **Qualified Name**
+>	**Input Required**: False
+
+>	**Description**: A unique qualified name for the element. Generated using the qualified name pattern  if not user specified.
+
+
+## **GUID**
+>	**Input Required**: False
+
+>	**Description**: A system generated unique identifier.
+
+>	**Alternative Labels**: Guid; guid
+

md_processing/family_docs/Glossary/Create_Term.md

@@ -0,0 +1,70 @@
+# **Create Term**
+>	
+
+## **Term Name**
+>	**Input Required**: True
+
+>	**Description**: The name of the term to create or update.
+
+>	**Alternative Labels**: Glossary Term Name; Display Name; Term
+
+
+## **Summary**
+>	**Input Required**: False
+
+>	**Description**: A summary description of the term.
+
+
+## **Description**
+>	**Input Required**: False
+
+>	**Description**: A description of the term.
+
+
+## **Abbreviation**
+>	**Input Required**: False
+
+>	**Description**: An abbreviation for the term.
+
+
+## **Example**
+>	**Input Required**: False
+
+>	**Description**: An example of how the term is used.
+
+
+## **Usage**
+>	**Input Required**: False
+
+>	**Description**: A description of how the term is to be used.
+
+
+## **Status**
+>	**Input Required**: False
+
+>	**Description**: The lifecycle status of a term.
+
+>	**Valid Values**: DRAFT; ACTIVE, DEPRECATED; OBSOLETE; OTHER
+
+>	**Default Value**: ACTIVE
+
+
+## **Published Version Identifier**
+>	**Input Required**: False
+
+>	**Description**: 
+
+
+## **Qualified Name**
+>	**Input Required**: False
+
+>	**Description**: A unique qualified name for the element. Generated using the qualified name pattern  if not user specified.
+
+
+## **GUID**
+>	**Input Required**: False
+
+>	**Description**: A system generated unique identifier.
+
+>	**Alternative Labels**: Guid; guid
+

md_processing/family_docs/Glossary.md

@@ -0,0 +1,206 @@
+
+# Family: Glossary
+
+## **Attach Category Parent**
+>	Attaches a parent category to a child category.
+### **Category Name**
+>	**Input Required**: True
+
+>	**Description**: The name of a category.
+
+>	**Alternative Labels**: Glossary Category Name; Glossary Category; Category; Display Name
+
+
+### **Parent Category**
+>	**Input Required**: True
+
+>	**Description**: The name of the parent category to attach to.
+
+>	**Alternative Labels**: Parent Category Name;  Parent Category Names
+
+
+___
+
+## **Attach Term-Term Relationship**
+>	Create a relationship between terms.
+### **Term  1**
+>	**Input Required**: True
+
+>	**Description**: The name of the first term term to connect.
+
+>	**Alternative Labels**: Term Name 1
+
+
+### **Term  2**
+>	**Input Required**: True
+
+>	**Description**: The name of the second term term to connect.
+
+>	**Alternative Labels**: Term Name 2
+
+
+### **Relationship**
+>	**Input Required**: True
+
+>	**Description**: The type of relationship to connecting the two terms.
+
+>	**Valid Values**: Synonym;  Translation;  PreferredTerm; TermISATYPEOFRelationship;  TermTYPEDBYRelationship;  Antonym; ReplacementTerm;  ValidValue; TermHASARelationship; RelatedTerm;   ISARelationship
+
+
+___
+
+## **Create Category**
+>	A group of terms that are useful to collect together.
+### **Category Name**
+>	**Input Required**: True
+
+>	**Description**: The name of a category.
+
+>	**Alternative Labels**: Glossary Category Name; Glossary Category; Category; Display Name
+
+
+### **Description**
+>	**Input Required**: False
+
+>	**Description**: A description of the Category.
+
+
+### **In Glossary**
+>	**Input Required**: True
+
+>	**Description**: The name of the glossary that contains the Category. Recommend using the Qualified Name of the Glossary, if known.
+
+>	**Alternative Labels**: Owning Glossary; Glossary; In Glossary
+
+
+### **Qualified Name**
+>	**Input Required**: False
+
+>	**Description**: A unique qualified name for the element. Generated using the qualified name pattern  if not user specified.
+
+
+### **GUID**
+>	**Input Required**: False
+
+>	**Description**: A system generated unique identifier.
+
+>	**Alternative Labels**: Guid; guid
+
+
+___
+
+## **Create Glossary**
+>	A grouping of definitions.
+### **Glossary Name**
+>	**Input Required**: True
+
+>	**Description**: The name of the glossary to create or update.
+
+>	**Alternative Labels**: Glossary; Display Name
+
+
+### **Description**
+>	**Input Required**: False
+
+>	**Description**: A description of the Glossary.
+
+
+### **Language**
+>	**Input Required**: False
+
+>	**Description**: The language of the glossary. Note that multilingual descriptions are supported. Please see web site for details.
+
+
+### **Usage**
+>	**Input Required**: False
+
+>	**Description**: A description of how the glossary is to be used.
+
+
+### **Qualified Name**
+>	**Input Required**: False
+
+>	**Description**: A unique qualified name for the element. Generated using the qualified name pattern  if not user specified.
+
+
+### **GUID**
+>	**Input Required**: False
+
+>	**Description**: A system generated unique identifier.
+
+>	**Alternative Labels**: Guid; guid
+
+
+___
+
+## **Create Term**
+>	
+### **Term Name**
+>	**Input Required**: True
+
+>	**Description**: The name of the term to create or update.
+
+>	**Alternative Labels**: Glossary Term Name; Display Name; Term
+
+
+### **Summary**
+>	**Input Required**: False
+
+>	**Description**: A summary description of the term.
+
+
+### **Description**
+>	**Input Required**: False
+
+>	**Description**: A description of the term.
+
+
+### **Abbreviation**
+>	**Input Required**: False
+
+>	**Description**: An abbreviation for the term.
+
+
+### **Example**
+>	**Input Required**: False
+
+>	**Description**: An example of how the term is used.
+
+
+### **Usage**
+>	**Input Required**: False
+
+>	**Description**: A description of how the term is to be used.
+
+
+### **Status**
+>	**Input Required**: False
+
+>	**Description**: The lifecycle status of a term.
+
+>	**Valid Values**: DRAFT; ACTIVE, DEPRECATED; OBSOLETE; OTHER
+
+>	**Default Value**: ACTIVE
+
+
+### **Published Version Identifier**
+>	**Input Required**: False
+
+>	**Description**: 
+
+
+### **Qualified Name**
+>	**Input Required**: False
+
+>	**Description**: A unique qualified name for the element. Generated using the qualified name pattern  if not user specified.
+
+
+### **GUID**
+>	**Input Required**: False
+
+>	**Description**: A system generated unique identifier.
+
+>	**Alternative Labels**: Guid; guid
+
+
+___

md_processing/family_docs/Governance Officer/Create_Business_Imperative.md

@@ -0,0 +1,106 @@
+# **Create Business Imperative**
+>	The BusinessImperative entity defines a business goal that is critical to the success of the organization.
+
+## **Display Name**
+>	**Input Required**: True
+
+>	**Description**: Name of the  definition.
+
+>	**Alternative Labels**: Name
+
+
+## **Summary**
+>	**Input Required**: False
+
+>	**Description**: Summary of the definition.
+
+
+## **Description**
+>	**Input Required**: False
+
+>	**Description**: Description of the contents of the definition.
+
+
+## **Domain Identifier**
+>	**Input Required**: False
+
+>	**Description**: Integer representing the governance domain. All domains is 0.
+
+>	**Default Value**: 0
+
+
+## **Document Identifier**
+>	**Input Required**: False
+
+>	**Description**: A user supplied identifier for the governance document.
+
+>	**Alternative Labels**: Doc Id
+
+
+## **Version Identifier**
+>	**Input Required**: False
+
+>	**Description**: Published  version identifier.
+
+
+## **Scope**
+>	**Input Required**: False
+
+>	**Description**: Scope of the definition.
+
+
+## **Importance**
+>	**Input Required**: False
+
+>	**Description**: Importance of the definition.
+
+
+## **Implications**
+>	**Input Required**: False
+
+>	**Description**: List of implications.
+
+
+## **Outcomes**
+>	**Input Required**: False
+
+>	**Description**: List of desired outcomes.
+
+
+## **Results**
+>	**Input Required**: False
+
+>	**Description**: A list of expected results.
+
+
+## **Status**
+>	**Input Required**: False
+
+>	**Description**: The status of the agreement. There is a list of valid values that this conforms to.
+
+>	**Alternative Labels**: Definition Status
+
+>	**Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
+
+>	**Default Value**: DRAFT
+
+
+## **User Defined Status**
+>	**Input Required**: False
+
+>	**Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
+
+
+## **Qualified Name**
+>	**Input Required**: False
+
+>	**Description**: A unique qualified name for the element. Generated using the qualified name pattern  if not user specified.
+
+
+## **GUID**
+>	**Input Required**: False
+
+>	**Description**: A system generated unique identifier.
+
+>	**Alternative Labels**: Guid; guid
+

md_processing/family_docs/Governance Officer/Create_Certification_Type.md

@@ -0,0 +1,112 @@
+# **Create Certification Type**
+>	A type of certification.
+
+## **Display Name**
+>	**Input Required**: True
+
+>	**Description**: Name of the  definition.
+
+>	**Alternative Labels**: Name
+
+
+## **Summary**
+>	**Input Required**: False
+
+>	**Description**: Summary of the definition.
+
+
+## **Description**
+>	**Input Required**: False
+
+>	**Description**: Description of the contents of the definition.
+
+
+## **Domain Identifier**
+>	**Input Required**: False
+
+>	**Description**: Integer representing the governance domain. All domains is 0.
+
+>	**Default Value**: 0
+
+
+## **Document Identifier**
+>	**Input Required**: False
+
+>	**Description**: A user supplied identifier for the governance document.
+
+>	**Alternative Labels**: Doc Id
+
+
+## **Version Identifier**
+>	**Input Required**: False
+
+>	**Description**: Published  version identifier.
+
+
+## **Scope**
+>	**Input Required**: False
+
+>	**Description**: Scope of the definition.
+
+
+## **Importance**
+>	**Input Required**: False
+
+>	**Description**: Importance of the definition.
+
+
+## **Details**
+>	**Input Required**: False
+
+>	**Description**: Details of the certification.
+
+
+## **Implications**
+>	**Input Required**: False
+
+>	**Description**: List of implications.
+
+
+## **Outcomes**
+>	**Input Required**: False
+
+>	**Description**: List of desired outcomes.
+
+
+## **Results**
+>	**Input Required**: False
+
+>	**Description**: A list of expected results.
+
+
+## **Status**
+>	**Input Required**: False
+
+>	**Description**: The status of the agreement. There is a list of valid values that this conforms to.
+
+>	**Alternative Labels**: Definition Status
+
+>	**Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
+
+>	**Default Value**: DRAFT
+
+
+## **User Defined Status**
+>	**Input Required**: False
+
+>	**Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
+
+
+## **Qualified Name**
+>	**Input Required**: False
+
+>	**Description**: A unique qualified name for the element. Generated using the qualified name pattern  if not user specified.
+
+
+## **GUID**
+>	**Input Required**: False
+
+>	**Description**: A system generated unique identifier.
+
+>	**Alternative Labels**: Guid; guid
+

md_processing/family_docs/Governance Officer/Create_Governance_Approach.md

@@ -0,0 +1,114 @@
+# **Create Governance Approach**
+>	The GovernanceApproach entity defines a policy that describes a method that should be used for a particular activity.
+
+## **Display Name**
+>	**Input Required**: True
+
+>	**Description**: Name of the  definition.
+
+>	**Alternative Labels**: Name
+
+
+## **Summary**
+>	**Input Required**: False
+
+>	**Description**: Summary of the definition.
+
+
+## **Description**
+>	**Input Required**: False
+
+>	**Description**: Description of the contents of the definition.
+
+
+## **Domain Identifier**
+>	**Input Required**: False
+
+>	**Description**: Integer representing the governance domain. All domains is 0.
+
+>	**Default Value**: 0
+
+
+## **Document Identifier**
+>	**Input Required**: False
+
+>	**Description**: A user supplied identifier for the governance document.
+
+>	**Alternative Labels**: Doc Id
+
+
+## **Version Identifier**
+>	**Input Required**: False
+
+>	**Description**: Published  version identifier.
+
+
+## **Scope**
+>	**Input Required**: False
+
+>	**Description**: Scope of the definition.
+
+
+## **Importance**
+>	**Input Required**: False
+
+>	**Description**: Importance of the definition.
+
+
+## **Governance Drivers**
+>	**Input Required**: False
+
+>	**Description**: The drivers this policy is in response to. Drivers may be Business Imperatives, Regulations, Governance Strategy or Threats.
+
+>	**Alternative Labels**: Drivers
+
+
+## **Implications**
+>	**Input Required**: False
+
+>	**Description**: List of implications.
+
+
+## **Outcomes**
+>	**Input Required**: False
+
+>	**Description**: List of desired outcomes.
+
+
+## **Results**
+>	**Input Required**: False
+
+>	**Description**: A list of expected results.
+
+
+## **Status**
+>	**Input Required**: False
+
+>	**Description**: The status of the agreement. There is a list of valid values that this conforms to.
+
+>	**Alternative Labels**: Definition Status
+
+>	**Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE'; DEPRECATED; OTHER
+
+>	**Default Value**: DRAFT
+
+
+## **User Defined Status**
+>	**Input Required**: False
+
+>	**Description**: Only valid if Product Status is set to OTHER. User defined & managed status values.
+
+
+## **Qualified Name**
+>	**Input Required**: False
+
+>	**Description**: A unique qualified name for the element. Generated using the qualified name pattern  if not user specified.
+
+
+## **GUID**
+>	**Input Required**: False
+
+>	**Description**: A system generated unique identifier.
+
+>	**Alternative Labels**: Guid; guid
+