Standard Fields
  • 25 Mar 2024
  • 6 Minutes to read
  • Contributors
  • Dark
    Light

Standard Fields

  • Dark
    Light

Article Summary

About Standard Fields

Standard fields are added by Syniti Migrate scripting to the staging tables and reports as control indicators.  The system delivered Standard Fields may not be altered or removed as they are core to the system.  Users may add new Standard fields.

View the following page by navigating to Administer > Advanced > Standard Fields from the Syniti Migrate Homepage.

null
Standard Fields: Display

The Search  icon on the top right corner of the pane will allow a search for a specific field.

The Standard Fields grid displays the following fields:

Heading

Description

Index

Sequence of the standard fields. Value increases by factor of 10 for each new entry.

Field

Name of the standard field.

Description

The description for this standard field.

Data Type

The format of the standard field. Ex: NVARCHAR, INT, NUMERIC, DATE

Length

The max number of characters for this standard field.

Scale

The number of decimal places for the field.

Target

The toggle that identifies this standard field as used for Targets.

Source

The toggle that identifies this standard field as used for Sources.

Note

If the Data Type field is left blank, the process for creating tables in Syniti Migrate fails.

Standard Field Details

To display the details of a Standard Field, click on the Edit  icon. 

null
Standard Fields: Display Details

Standard Fields are automatically added to the working table, the target table, or both as part of the Syniti Migration Methodology.  They are prefixed in the tables with the Field Prefix character configured in the Parameter page.   (Uppercase Z is the default prefix)

The list below provides detailed descriptions of use:

Standard Field

Description of Use

SOURCE

Identifies the original source of every record in the Working and Target Tables.   Defaults to the name of the Datasource without the src or tgt Prefix.

It should be carefully chosen to identify the source system using the common name for the system which can be easily recognized by the Validators. 

Ex: JDE, MAXIMO, ECCNA, ADAGE

Used in working table, target table

DEPLOY

Segregates the Validation Reports and ENRICH data in Releases that support multiple Business Units.   Values must be pre-defined at the start of the release and are based solely on how the project intends to Validate and Cleanse the Legacy Data.   Most often this field represents Countries, Business Units, or Site Locations.

Ex: US, CAN, MEX or S10, S20, S30.  

If a Release only contains one logical deployment, it can be named like the Release for simplicity.

Used in the working table, target table

CRITICAL

Flags the Critical Master Data as defined during the mapping sessions.  For example, top 100 Customers by sales, or top 100 Materials by Transactions, etc.

The Critical Flag is carried down to the Transactional Data based on it having a Critical Master Data item.   So a Critical PO would have a Critical Vendor or Critical Material.

The Purpose of the field is to allow the Pre and Post load validation teams to focus on the "Critical" records in order to shorten the validation time, and insure that the most important record will be converted correctly.   

Used in the working table, target table

DUPLICATE_SOURCE

Identifies the Datasource of the "Winning" record as duplicates can be found across multiple data sources (inter-source duplicates)

Used in the working table 

DUPLICATE_OF

Identifies a Duplicate Record in the Working table by referencing the "Winning" record that is relevant. Record which have DUPLICATE_OF populated generally is flagged as NOT ACTIVE so they are not inserted into the Target Table.

Used in the Working Table

ERROR_LOG

A concatenated list of ERROR MESSAGES from the Error Report registrations.  Used to identify all the errors in a given Record in a single field

Ex:  Invalid Postal Code, Missing Phone, PO Box on Ship To

Populated by the Validation Reports automatically.

Used in the Target Table

INACTIVE_REASON

A concatenated list of reasons why a record was marked as Not Active (not relevant).   Often used in addition to common Relevancy Flags (zPO, zOpenPO, zNew, zInventory, etc)

Used in the Working Table

LOADED

Identifies records which were Loading during the current load cycle.  Used for Post Load metrics and Delta Loads if needed.

Used in the Target Table

LOADDATE

Data Time the record was loaded, useful for Post Load metrics and Project Planning.

Used in the Target Table

DATA_READY

Identifies records which contain a non-critical Data Error which does not prevent the record from loading.  Populated based on the Data Readiness Error Reports.

Ex:  Missing a Phone Number.

Used in the Target Table

BUSINESS_READY

Identifies records which can be loaded, but should not due to missing business required field values.

Ex:  Missing a custom added field value.

Used in the Target Table

STAGE_READY

Identifies records which contain a Critical Data Error which prevents the record from loading, based on information available BEFORE the start of the data loads.  Populated based on the Stage Readiness Error Reports.

Ex: Missing Required Fields, Invalid Configuration Values, Missing Master data based on errors in upstream Staging Tables (not in wrkMM.dbo.MM_MARA_T)

Used in the Target Table

TARGET_READY

Identifies records which contain a Critical Data Error which prevents the record from loading, based on information available only AFTER the start of the data loads.  Populated based on the Target Readiness Error Reports.

Ex: Missing Master Data in the Target System (not in tgtECC.dbo.MARA)

Used in the Target Table

CHUNK

Integer field used in partitioning of the Export file to support Parallel Loading.  Defaults to 1.   To create 4 load files, populate each record with a 1,2, 3, or 4.   For Header/Detail targets it can be important to copy the CHUNK from the parent record (so PO Lines Items have the same chunk as the PO Header)

Used in the Target Table  

INTARGETSYS

Identifies records that already exist in the target system prior to loading data.  Applies to mergers and acquisitions, or multi-release projects where loads are into an existing Production System that already contains common master data items.

Used in the Target Table

REMEDIATED

This flag shows that the row has been remediated for one or more fields to make it successful to load.   Used for Load Metrics reporting.

Populated by the Validation Reports automatically.

Used in the Target Table

ACTIVE

This flag marks the record as Relevant for the Data Load.  The field is often derived based on predefined Relevancy Rules from the business during field mapping.

Note

This is NOT set based on Errors in the data.  It is strictly used for Relevancy (all records which you intend to load into the target system)  

Used in the Working Table

Create a Standard Field

Click Add  icon to add additional fields specific to the current project.

null
Standard Field: Add

Fields

Description

Field*

Name of the Standard Field. (Required)

Description

The description of use of the standard field.

Index*

Sequence of the Standard Fields in the table. Value increases by factor of 10 for each new entry. (Required)

Data Type

The format of the standard field. Ex: NVARCHAR, INT, NUMERIC, DATE

Field Length

The max number of characters for this standard field.

zField XML

The XML scripting to use this standard field.

XML Data Type

The XML format for this standard field. Ex: datatype="VARCHAR" size="MAX" nullable'"true"

SQL Data Type

The SQL format for this standard field. Ex: NVARCHAR(MAX).

Default Value

Enter the value that may be defaulted for this standard field.

Primary Key

Toggle to mark this standard field as Active/Inactive for a Primary Key field.

Source Field

Toggle to mark this standard field as Active/Inactive for use on the Source staging table.

Target Field

Toggle to mark this standard field as Active/Inactive for use on the Target table.

Mapping

Toggle to mark this standard field as Active/Inactive for Relevant for mapping.

Active

Toggle for status of Standard Field as active/inactive for conversion.

Note

Defaults as Active.

Active for Mapping

Select from drop-down to mark this standard field as active or inactive for mapping.

Scale

The number of decimal places for use when the Data Type is DECIMAL.

When finished with edits, click the Save  icon to complete.


Was this article helpful?