pyegeria 5.4.0.28__py3-none-any.whl → 5.5.3.3__py3-none-any.whl

md_processing/family_docs/Data Designer.md

@@ -1,842 +0,0 @@
-
-# Family: Data Designer
-
-## **Create Data Class**
->	Describes the data values that may be stored in data fields. Can be used to configure quality validators and data field classifiers.
-### **Display Name**
->	**Input Required**: True
-
->	**Description**: Name of the data structure.
-
->	**Alternative Labels**: Data Class; Display Name; Name; Data Class Name
-
-
-### **Description**
->	**Input Required**: False
-
->	**Description**: A description of the data class.
-
-
-### **Namespace**
->	**Input Required**: False
-
->	**Description**: Optional namespace that scopes the field.
-
-
-### **Match Property Names**
->	**Input Required**: False
-
->	**Description**: Names of the properties that are set.
-
->	**Default Value**: Can be determined by Dr. Egeria?
-
-
-### **Match Threshold**
->	**Input Required**: False
-
->	**Description**: Percent of values that must match the data class specification.
-
-
-### **IsCaseSensitive**
->	**Input Required**: False
-
->	**Description**: Are field values case sensitive?
-
->	**Default Value**: False
-
-
-### **Data Type**
->	**Input Required**: True
-
->	**Description**: Data type for the data class.
-
->	**Valid Values**: 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
-
-
-### **Allow Duplicate Values**
->	**Input Required**: False
-
->	**Description**: Allow duplicate values within the data class?
-
->	**Default Value**: true
-
-
-### **isNullable**
->	**Input Required**: False
-
->	**Description**: Can the values within the dataclass be absent?
-
->	**Alternative Labels**: Nullable
-
->	**Default Value**: true
-
-
-### **isCaseSensitive**
->	**Input Required**: False
-
->	**Description**: Indicates if the values in a  data class are case sensitive.
-
->	**Alternative Labels**: Case Sensitive
-
-
-### **Default Value**
->	**Input Required**: False
-
->	**Description**: Specify a default value for the data class.
-
->	**Alternative Labels**: Default
-
-
-### **Average Value**
->	**Input Required**: False
-
->	**Description**: Average value for the data class.
-
->	**Alternative Labels**: Average
-
-
-### **Value List**
->	**Input Required**: False
-
->	**Description**: 
-
-
-### **Value Range From**
->	**Input Required**: False
-
->	**Description**: Beginning range of legal values.
-
->	**Alternative Labels**: Range From
-
-
-### **Value Range To**
->	**Input Required**: False
-
->	**Description**: End of valid range for value.
-
->	**Alternative Labels**: Range To
-
-
-### **Sample Values**
->	**Input Required**: False
-
->	**Description**: Sample values of the data class.
-
->	**Alternative Labels**: Samples
-
-
-### **Data Patterns**
->	**Input Required**: False
-
->	**Description**: prescribed format of a data field - e.g. credit card numbers. Often expressed as a regular expression.
-
-
-### **In Data Dictionary**
->	**Input Required**: False
-
->	**Description**: What data dictionaries is this data field in?
-
-
-### **Containing Data Class**
->	**Input Required**: False
-
->	**Description**: Data classes this is part of.
-
->	**Alternative Labels**: Containing Class
-
-
-### **Specializes Data Class**
->	**Input Required**: False
-
->	**Description**: Specializes a parent  data class.
-
-
-### **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 Data Dictionary**
->	A Data Dictionary is an organized and curated collection of data definitions that can serve as a reference for data professionals
-### **Display Name**
->	**Input Required**: True
-
->	**Description**: Name of the Data Dictionary
-
->	**Alternative Labels**: Name; Data Dictionary; Data Dict; Data Dictionary Name; Dictionary Name
-
-
-### **Description**
->	**Input Required**: False
-
->	**Description**: A description of the Data Dictionary.
-
-
-### **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 Data Field**
->	A data field is a fundamental building block for a data structure.
-### **Display Name**
->	**Input Required**: True
-
->	**Description**: Name of the Data Field
-
->	**Alternative Labels**: Name; Data Field Name
-
-
-### **Description**
->	**Input Required**: False
-
->	**Description**: A description of the Data Field
-
-
-### **Data Type**
->	**Input Required**: True
-
->	**Description**: The data type of the data field. Point to data type valid value list if exists.
-
->	**Valid Values**: 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
-
->	**Default Value**: string
-
-
-### **Position**
->	**Input Required**: False
-
->	**Description**: Position of the data field in the data structure. If 0, position is irrelevant.
-
->	**Default Value**: 0
-
-
-### **Minimum Cardinality**
->	**Input Required**: False
-
->	**Description**: The minimum cardinality for a data element.
-
->	**Alternative Labels**: Min Cardinality; min cardinality
-
->	**Default Value**: 1
-
-
-### **Maximum Cardinality**
->	**Input Required**: False
-
->	**Description**: The maximum cardinality for a data element.
-
->	**Alternative Labels**: max cardinality; Max Cardinality
-
->	**Default Value**: 1
-
-
-### **In Data Structure**
->	**Input Required**: False
-
->	**Description**: The data structure this field is a member of. If display name is not unique, use qualified name.
-
->	**Alternative Labels**: Data Structure
-
-
-### **Data Class**
->	**Input Required**: False
-
->	**Description**: The data class that values of this data field conform to.
-
-
-### **Glossary Term**
->	**Input Required**: False
-
->	**Description**: Term that provides meaning to this field.
-
->	**Alternative Labels**: Term
-
-
-### **isNullable**
->	**Input Required**: False
-
->	**Description**: Can the values within the dataclass be absent?
-
->	**Alternative Labels**: Nullable
-
->	**Default Value**: true
-
-
-### **Minimum Length**
->	**Input Required**: False
-
->	**Description**: 
-
->	**Alternative Labels**: Min Length
-
-
-### **Length**
->	**Input Required**: False
-
->	**Description**: The length of a value for a field.
-
-
-### **Precision**
->	**Input Required**: False
-
->	**Description**: The precision of a numeric
-
-
-### **Ordered Values**
->	**Input Required**: False
-
->	**Description**: is this field in an ordered list?
-
-
-### **Units**
->	**Input Required**: False
-
->	**Description**: An optional string indicating the units of the field.
-
->	**Alternative Labels**: gradians
-
-
-### **Default Value**
->	**Input Required**: False
-
->	**Description**: Specify a default value for the data class.
-
->	**Alternative Labels**: Default
-
-
-### **Version Identifier**
->	**Input Required**: False
-
->	**Description**: A user supplied version identifier.
-
-
-### **In Data Dictionary**
->	**Input Required**: False
-
->	**Description**: What data dictionaries is this data field in?
-
-
-### **Parent Data Field**
->	**Input Required**: False
-
->	**Description**: Optional parent field if this is a nested field.
-
->	**Alternative Labels**: Parent Field
-
-
-### **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 Data Specification**
->	A Data Specification defines the data requirements for a project or initiative. This includes the data structures , data fields and data classes.
-### **Display Name**
->	**Input Required**: True
-
->	**Description**: Name of the Data Specification.
-
->	**Alternative Labels**: Data Spec; Name; Display Name; Data Specification Name; Data Specification
-
-
-### **Description**
->	**Input Required**: False
-
->	**Description**: A description of the Data Specification.
-
-
-### **Collection Type**
->	**Input Required**: False
-
->	**Description**: A user supplied collection type.
-
-
-### **Qualified Name**
->	**Input Required**: True
-
->	**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 Data Structure**
->	A collection of data fields that for a data specification for a data source.
-### **Display Name**
->	**Input Required**: True
-
->	**Description**: Name of the data structure.
-
->	**Alternative Labels**: Name; Display Name; Data Struct; Data Structure Name
-
-
-### **Description**
->	**Input Required**: False
-
->	**Description**: A description of the data structure.
-
-
-### **In Data Specification**
->	**Input Required**: False
-
->	**Description**: The data specifications this structure is a member of.
-
->	**Alternative Labels**: In Data Spec
-
-
-### **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
-
-
-___
-
-## **View Data Classes**
->	Return the data classes, optionally filtered by the search string.
-### **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
-
-
-### **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.
-
->	**Default Value**: 0
-
-
-___
-
-## **View Data Dictionaries**
->	Return the data dictionaries, optionally filtered by the search string.
-### **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; DICT; MD; MERMAID; REPORT
-
->	**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
-
-
-### **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.
-
->	**Default Value**: 0
-
-
-### **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
-
-
-___
-
-## **View Data Fields**
->	Return the data fields, optionally filtered by the search string.
-### **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
-
-
-### **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.
-
->	**Default Value**: 0
-
-
-___
-
-## **View Data Specifications**
->	Return the data specifications, optionally filtered by the search string.
-### **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; DICT; MD; MERMAID; REPORT
-
->	**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
-
-
-### **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.
-
->	**Default Value**: 0
-
-
-___
-
-## **View Data Structures**
->	Return the data structures, optionally filtered by the search string.
-### **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; 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
-
-
-### **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.
-
->	**Default Value**: 0
-
-
-___