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

md_processing/family_docs/Governance Officer/Create_Security_Access_Control.md

@@ -0,0 +1,114 @@
+# **Create Security Access Control**
+>	A technical control that defines the access control lists that an actor must belong to be entitled to perform a specific action.
+
+## **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.
+
+
+## **Implementation Description**
+>	**Input Required**: False
+
+>	**Description**: Describes how this governance control is implemnted.
+
+>	**Alternative Labels**: Implementation
+
+
+## **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_Security_Group.md

@@ -0,0 +1,120 @@
+# **Create Security Group**
+>	A group of actors that need to be given the same access to a specific set of resources.
+
+## **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
+
+
+## **Distinguished Name**
+>	**Input Required**: False
+
+>	**Description**: Unique identity of an actor.
+
+
+## **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.
+
+
+## **Implementation Description**
+>	**Input Required**: False
+
+>	**Description**: Describes how this governance control is implemnted.
+
+>	**Alternative Labels**: Implementation
+
+
+## **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_Service_Level_Objectives.md

@@ -0,0 +1,122 @@
+# **Create Service Level Objectives**
+>	Defines the performance, availability and qualitiy levels expected by the element attached.
+
+## **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.
+
+
+## **Implementation Description**
+>	**Input Required**: False
+
+>	**Description**: Describes how this governance control is implemnted.
+
+>	**Alternative Labels**: Implementation
+
+
+## **Supports Policies**
+>	**Input Required**: False
+
+>	**Description**: The policies that this governance control supports.
+
+>	**Alternative Labels**: Policies Supported; Policy Supported
+
+
+## **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_Threat_Definition.md

@@ -0,0 +1,106 @@
+# **Create Threat Definition**
+>	The Threat entity describes a particular threat to the organization's operations that must either be guarded against or accommodated to reduce its impact.
+
+## **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/Link_Governance_Controls.md

@@ -0,0 +1,32 @@
+# **Link Governance Controls**
+>	Link peer governance controls with the GovernanceControlLink relationship. Controls types are: GovernanceRule, GovernanceProcess, GovernanceResponsibility, GovernanceProcedure, SecurityAccessControl, SecurityGroup.
+
+## **Control Definition 1**
+>	**Input Required**: True
+
+>	**Description**: The  first governance control to link.
+
+>	**Alternative Labels**: Control 1; Governance Control 1 
+
+
+## **Control Definition 2**
+>	**Input Required**: True
+
+>	**Description**: The  fsecond governance control to link.
+
+>	**Alternative Labels**: Control 2; Governance Control 2 
+
+
+## **Link Label**
+>	**Input Required**: False
+
+>	**Description**: Labels the link between two governance defninitions.
+
+>	**Alternative Labels**: Label
+
+
+## **Description**
+>	**Input Required**: False
+
+>	**Description**: A description of the relationship.
+

md_processing/family_docs/Governance Officer/Link_Governance_Drivers.md

@@ -0,0 +1,32 @@
+# **Link Governance Drivers**
+>	Link peer governance drivers with the GovernanceDriverLink relationship. Drivers are: GovernanceStrategy, BusinessImperitive, Regulation, RegulationArticle, Threat.
+
+## **Definition 1**
+>	**Input Required**: True
+
+>	**Description**: The  first governance driver to link.
+
+>	**Alternative Labels**: Driver 1; Governance Driver 1
+
+
+## **Definition 2**
+>	**Input Required**: True
+
+>	**Description**: The  second governance driver to link.
+
+>	**Alternative Labels**: Driver 2; Governance Driver 2
+
+
+## **Link Label**
+>	**Input Required**: False
+
+>	**Description**: Labels the link between two governance defninitions.
+
+>	**Alternative Labels**: Label
+
+
+## **Description**
+>	**Input Required**: False
+
+>	**Description**: A description of the relationship.
+

md_processing/family_docs/Governance Officer/Link_Governance_Policies.md

@@ -0,0 +1,32 @@
+# **Link Governance Policies**
+>	Link peer governance policies with the GovernancePolicyLink relationship. Policies types are: GovernancePrinciple, GovernanceObligation, GovernanceApproach.
+
+## **Definition 1**
+>	**Input Required**: True
+
+>	**Description**: The  first governance policy to link.
+
+>	**Alternative Labels**: Policy 1; Governance Policy 1
+
+
+## **Definition 2**
+>	**Input Required**: True
+
+>	**Description**: The  second governance policy to link.
+
+>	**Alternative Labels**: Policy 2; Governance Policy 2
+
+
+## **Link Label**
+>	**Input Required**: False
+
+>	**Description**: Labels the link between two governance defninitions.
+
+>	**Alternative Labels**: Label
+
+
+## **Description**
+>	**Input Required**: False
+
+>	**Description**: A description of the relationship.
+

md_processing/family_docs/Governance Officer/View_Governance_Definitions.md

@@ -0,0 +1,82 @@
+# **View Governance Definitions**
+>	This can be used to list any kind of governance definitions.
+
+## **Search String**
+>	**Input Required**: False
+
+>	**Description**: An optional search string to filter results by.
+
+>	**Alternative Labels**: Filter
+
+>	**Default Value**: *
+
+
+## **Output Format**
+>	**Input Required**: False
+
+>	**Description**: Optional specification of output format for the query.
+
+>	**Alternative Labels**: Format
+
+>	**Valid Values**: LIST; FORM; REPORT; MERMAID; DICT
+
+>	**Default Value**: LIST
+
+
+## **Starts With**
+>	**Input Required**: False
+
+>	**Description**: If true, look for matches with the search string starting from the beginning of  a field.
+
+>	**Default Value**: True
+
+
+## **Ends With**
+>	**Input Required**: False
+
+>	**Description**: If true, look for matches with the search string starting from the end of  a field.
+
+>	**Default Value**: False
+
+
+## **Ignore Case**
+>	**Input Required**: False
+
+>	**Description**: If true, ignore the difference between upper and lower characters when matching the search string.
+
+>	**Default Value**: False
+
+
+## **AsOfTime**
+>	**Input Required**: False
+
+>	**Description**: An ISO-8601 string representing the time to view the state of the repository.
+
+>	**Alternative Labels**: As Of Time
+
+
+## **Sort Order**
+>	**Input Required**: False
+
+>	**Description**: How to order the results. The sort order can be selected from a list of valid value.
+
+>	**Valid Values**: ANY; CREATION_DATE_RECENT; CREATION_DATA_OLDEST; LAST_UPDATE_RECENT; LAST_UPDATE_OLDEST; PROPERTY_ASCENDING; PROPERTY_DESCENDING
+
+
+## **Order Property Name**
+>	**Input Required**: False
+
+>	**Description**: The property to use for sorting if the sort_order_property is PROPERTY_ASCENDING or PROPERTY_DESCENDING
+
+
+## **Page Size**
+>	**Input Required**: False
+
+>	**Description**: The number of elements returned per page.
+
+
+## **Start From**
+>	**Input Required**: False
+
+>	**Description**: When paging through results, the starting point of the results to return.
+