- Print
- DarkLight
- PDF
Maintain Data Elements Tab
This topic is related to the following sections:
Data Elements Overview
Data Elements are created and maintained through the Syniti Knowledge Platform, and then imported as a data object into this portion of Syniti Migrate. They are a required prerequisite to Mapping as they serve as the target fields.
Refer to section Data Element Column Details for details.
To access Data Elements, click on the Data Elements tab within a Dataset using pathway Catalog > Dataset Design > Edit Dataset. This page is used to document data elements associated with the Dataset.
The Data Elements tab displays the list of fields that have been toggled as Data Element Active on the Tables and Fields tab. The Data Elements tab of the Dataset contains one panel and all tables are listed in ascending order by Table and then by Fields. It is within this panel that the Data Designer may manage the fields details. The details may be maintained one by one or by using Bulk Edit feature.
The Data Elements grid displays the following columns:
Heading | Definition |
---|---|
Name | The name of the Data Element. (Field) |
Definition | The description of the Data Element. |
Key Field | Check box to indicate if this field is a Key Field. |
Data Type | The Data Type of this Data Element based upon the Database Type. |
Length | The length of the field in an integer value. |
Check Table | The associated table within the target system that provides a list of values for selection should one exist for this Data Element. |
Comment | The added comments associated with the Data Element. |
Datasource | The Datasource from which the active objects are mapped. The system is defined in Deploy as a Datasource. (Ex: ECC) |
Technical Table | The target table name if one is associated with this data element. |
Technical Column | The target column name if one is associated with this data element. |
Technical Field | The full field name including application, table, field name. |
Security Classification | This value is pulled from the Data Element Type should one be assigned for a security classification value. (Ex: Internal Only, Public, Sensitive) For more details, navigate to Administer > Advanced > Security Classifications. |
Field Type | The Field Type as defined in the drop-down list including Optional, Required, Process Required, Derived, and Display. See additional section below.
|
Business Impact | This value is pulled from the Data Element Type should one be assigned as a business impact otherwise select one. Ex: Critical, Medium, Low. |
Usage Level | Select from the drop-down the value for Usage Level. This includes Global, Local, or a mixture of both. |
Data Types within the Dataset
Data Types vary depending upon the Working Database used and the Target System used. In the most basic situation, where SQL Server is the Working Database, and SAP ECC or S4H is the Target System, the Data Types for the Tables and Fields and Data Elements tabs are set to the Target System (ECC, S4H) Example: CHAR, DATS, or NUMC.
The Migration tab contains Data Types for the Working Database being used. For example, the user can view Data Types as:
Database | Data Types |
---|---|
Oracle | NVARCHAR2(), NUMBER(*,0), DATE |
SQL Server | NVARCHAR(), DECIMAL, INT, DATE, BIT |
HANA DB | NVARCHAR(), DECIMAL, INTEGER, DATE, BOOLEAN |
Alignment of Data Element Values in the List
Note
Edit the order of Data Elements in the multiple panel view by selecting(highlighting) the Data Element and dragging and dropping into the desired order. This automatically adjusts the index of the Data Element(s) you have reordered. If any sort order has been enabled for a column then the drag and drop functionality is disabled, removing the sort order enables drag and drop functionality again.
Activate a Data Element from Tables and Fields
Data Elements may be selected as relevant to the Dataset and marked Active from within the tab for Tables and Fields. Within the lower panel Fields, toggle the Data Element relevancy to Active. This action makes the field display within the tab for Data Elements.
Data Element Column Details
Data Elements provide details for the format of each field including Data Type, Data Length, and Scale. This profiling data may be maintained in the Column Details tab of Data Elements Details page.
Note
There are three profiling scripts stored within the working database SQL Server as stored procedures. The stored procedures allow one table, one schema, or one database to be profiled. The results are stored in two tables (SYN_PROFILE and SYN_PROFILE_VALUES). The stored procedure creates these tables if they do not already exist within the MIGRATE working database. These profiling procedures are:
Table example - EXEC MIGRATE.dbo.SYN_PROFILE_DATABASE 'TGTECC', 'dbo'
Database example - EXEC MIGRATE.dbo.SYN_PROFILE_DATABASE 'Adventureworks',NULL
Schema example - EXEC MIGRATE.dbo.SYN_PROFILE_TABLE 'TGTS4H','dbo','MARA'
Display the results of this profiling by running the view - SELECT * FROM MIGRATE.dbo.SYN_PROFILE_COLUMN_VALUES from within SQL Server.
Field definitions for Column Details:
Field | Definition |
---|---|
Name* | Name of Data Element. (Required) |
Description | The long, descriptive name or description of the Data Element. |
Index* | Sequence of the Data Element. Value increases by factor of 10 for each new entry. (Required) |
Data Type | The data type of this data element based upon the database type. |
Data Length | The length of the field in an integer value. |
Scale | Decimal places for the data type. |
Default Value | A value that defaults for this data element. |
Nullable | Toggle to determine if this data element may have a NULL value. |
Key Field | Toggle to determine if this data element is a key field in the table. |
Auto Generated | Toggle to determine if this data element was auto generated. |
Do Not Import | Toggle to determine if this data element can be imported to the mapping tables. |
Check Table | The check table value for this data element that provides a list of allowed field values. |
Add a New Data Element Independent of Migration (Derived)
The documenting of a process, report, activity, or transaction includes Datasets and Data Elements. Click on the Add icon to add a new Data Element. Examples of added data elements would include calculated or summarized counts and values in reports or additional validation criteria for a data lake. The Derived Data Element is determined by selecting a Field Type = Derived which updates the page to add Field Mapping for use.
This new Data Element is created by a click on the Add icon. The details of this newly added data element provides descriptions and formatting associated with the data element. Refer to section Edit Data Element Details for field specific details of this section.
Click SAVE icon to save the page to activate the FIELD MAPPING button. At this point, the user may enter the Data Mapping Details for this derived field as shown below:
Field | Description |
---|---|
Mapping Rule* | Enter the scripting for the rule. This value displays as the Field Derivation. (Required) |
Datasource | The Datasource from which the active objects are mapped. The system is defined as a Datasource. (Ex: ECC) |
Table | Target Table for this mapping. |
Field | Field being mapped. |
Check Table | Enter the SAP check table name, if needed. |
Comment | Enter additional comments on the rule build. |
Enter the Mapping Rule, the Datasource, Table, and Field for each of the fields used in this derived field. To add more fields, click on the ADD ROW button. Field Mapping requires a value to be entered into the field for Comments as it is a required field in order to save a derived field.
When finished with edits, click the Save icon to complete.
De-Activate a Derived Field from Data Elements
The added data element is stored within a table identified as "Unassigned" within the Tables and Fields tab. If the user should mark this new data element Not Active, it is removed from the list on the Data Elements tab but remains visible in this Unassigned table.
Edit Data Element Details
To maintain individual Data Elements, click on the Edit icon for the row of data element to change. This action opens the Data Elements Detail page.
The left side of the Data Element page contains the Data Element Details. These fields are supportive of the Data Element's design, usage, classification, and review. Each section of this panel stores valuable information. At the header of this left side panel there are quick use icons as shown below:
Icon | Name | Use |
---|---|---|
Save | The Save icon saves the current entries. | |
Cancel | The Cancel icon leaves the current page without saving changed data. | |
History | The History icon presents a list of the past changes to this Data Element. | |
Help | The Help icon links to the page in Syniti help text to provide detailed explanation of this section and use. |
While viewing this page in the Edit mode, the user may enter, or update field values based upon the information listed below:
Section | Field | Description of Use |
---|---|---|
Details | Dataset | Name of the Dataset. (Required) |
Details | Name* | Data Element name. (Required) |
Details | Definition | The description of the Data Element. |
Details | Field Type | The Field Type as defined in the drop-down list including Optional, Required, Process Required, Derived, and Display. See Field Type section below.
|
Details | Requirement Notes* | Contingent field that provides notes if the Field Type = Process Required. Otherwise, this field is hidden. |
Details | Business Impact | Select from the drop-down the Business Impact value. (Ex: Critical, Medium, Low) |
Details | Impact Details | Enter text to provide details of the business impact. |
Details | CheckTable | The selection of a check table as reference if one is associated with this data element.
|
Details | Active | Toggle to make the Data Element Active/Inactive.
|
Stakeholders | Various | A configurable section to store names of each Stakeholder type. For more details, navigate to Administer > Advanced > Stakeholders. See Stakeholder Details |
Additional Details | Usage Level | Select from the drop-down the value for Usage Level. This includes Global, Local, or a mixture of both |
Additional Details | Data Owner | Select the Data Owner value from the drop-down list of active Subject Areas. This is not configurable, and new entries cannot be entered into this field. |
Additional Details | Security Classification | Select the type of security (ex: Public, Internal) |
Additional Details | Comments | Enter added comments associated with the Data Element. |
Technical Details | Data Type | Select the Data Type of this Data Element.
|
Technical Details | Field Length | The length of the field in an integer value. |
Technical Details | Decimals | The number of decimal places for a decimal value. This entry is contingent upon having entered a Data Type value of Decimal. |
Technical Details | Primary Key | Toggle to mark this data element as Active/Inactive as a primary key field. |
Technical Details | Default Value | Enter the defaulted value for this data element that is defaulted into the field in the target system |
Attributes | Various | A configurable section to store attributes of this data element. |
Migration Details | Active For Mapping | Select from the drop-down Yes, No, or Blank value.
|
Migration Details | Is Migration Specific | Toggle to mark this data element as Active/Inactive as a Migration Specific field. Display only field |
Migration Details | Migration Key | Toggle to mark this data element as Active/Inactive as a Migration Key field for the table. |
Migration Details | Migration Field Name Override | Enter a field name with reduced length or prevent issues during loading . |
Migration Details | Load Segment | Enter the EDI Segment name. Used for new fields added to the load. |
Migration Details | Load Field | Enter the EDI Field name. Used for new fields added to the load. |
Audit | Various Fields | These are the system generated values for metrics reporting and auditing the work. |
Note
Vertical section Migration Details is only be visible if the Dataset has been added to a Mapping. The Migration tab is visible as this Dataset is being used as a Migration dataset. The fields allow for edits if the Dataset contains Target Reporting.
The View Details icon is part of the Data Element Details page assist to provide information supporting the associated field.
History of Changes
Provided below is an example of a History of Changes list at the Data Element level. The user clicks on the History icon to open this page and provide details of the history of changes made to this Data Element.
Note
The Download icon will produce a file on the local drive with details of this table data. The Search icon will provide filtering of data.
Note
As with any page grid of data, on the right upper corner, click the Hamburger Details icon to view the options for show or hide column, filter of rows, and column width. This is extremely handy for situations where the data is fluid and changes or when there are many records that are hard to review in the small window provided for the list. Refer to section Page Grid Options for details.
Once viewing is complete, click the Cancel icon to exit this process.
Field Type Assignment
The Field Type is a configurable field with a drop-down list. The values for this list are added within Administer > Advanced > List Boxes. The values and usage for this field are as follows:
Field | Definition of Use |
---|---|
Optional | This is the most used entry. It allows the data element to be present but does not need to contain a value. |
Required | The data element a required field. |
Process Required | This entry indicates to the users that the data element requires additional work. If this option is selected, the field Requirement Notes becomes visible and required. |
Display | This entry makes the data element a display only field. |
Suppressed | This entry makes the data element a suppressed field. This value is used where the field may be used in multiple record types with different Field Types |
Derived | This entry is used for fields where the value may be calculated. This field is not a physical field value but a derived value from one or more fields. |
Not Used | This entry defines the field as not being used. |