Master Data Packages#

Administration.MasterDataPackages

Overview#

Master Data Packages are used to load data into a Critical Manufacturing MES environment through the use of packages, allowing any authorized user to bulk load data into the system.

The Master Data Packages page is available in the Administration page group.

The list displays packages from newest to oldest.

Details Tab#

Opening a specific Master Data Package will display information relevant to the entity. Selecting in the Master Data section will allow you to download the actual package and edit it before loading it into the system.

The Details tab provides a collapsible Details View panel on the left side of the page. The panel can be collapsed or expanded. Depending on configuration and the optional licensed modules, the panel will display some or all of the following sub-sections:

• Details - displays general information on the Master Data Package.
• Objects - displays the list of objects loaded from the package file uploaded into the system and that have undergone at least one procedure of Load or Validate performed on the Master Data Package.
• Attachments - shows the documents that are attached to the Master Data Package and enables you to attach additional documentation to it.

In the Details sub-section, the Source field identifies how the Master Data Package was created or imported:

• User - the package was created or updated through the GUI. This is the default source, when you import a package.
• Global Data Orchestrator - the package was imported by the Global Data Orchestrator ↗ service. The service sets the source and supplies the Transport Package and deployment properties.

For packages imported by the Global Data Orchestrator, the Global Data Orchestration panel displays the following information:

• Transport Package - Name of the Transport Package.
• Version - Version of the Transport Package.
• Checksum - Checksum of the Transport Package.
• Customer Environment - Customer Environment that created the Transport Package.
• Deployment Plan Instance - The Master Data Deployment Plan Instance associated with the package deployment.
• Deployment Plan - The Master Data Deployment Plan associated with the package deployment.
• Deployment User - User associated with the package deployment.
• Deployment Date - Date and time of the package deployment.

Execution Tab#

This tab shows the results of the previous execution, regardless of whether the data was loaded or validated. It displays the list of Entity Types of the last execution of the specific Master Data Package and it is only available when there has been at least one procedure of Load or Validate performed on the Master Data Package.

Package format#

File formats accepted are: .zip, .xlsx, .xml, .json.

The base path for the location of the entities to be loaded is considered as the root folder of the .zip file. As a quick example, consider the following entry of a Master Data Package Excel file:

For the system to be able to access and process the sample.pdf file, it must be placed inside a documents folder, which will have to be located in the root of the .zip file or at the same level as the .xlsx file:

Additionally, it is not possible to upload multiple Master Data files through a single .zip folder. If your root folder, which represents the Master Data Package, has multiple valid files, only one will be processed as Master Data and its selection is random (the first valid file). This means that you have no way of selecting which file will be loaded as the Master Data file. Therefore, any extra files that are to be used in the Master Data file itself must be contained in sub-folders and be duly referenced in the Master Data file:

In the eventuality that all .xlsx and .json files are tried and there is no valid file, the system will return and error with the last attempted file.

More information on Master Data Packages, where you can also find a sample of the Master Data File.

Creating a Master Data Package#

MasterDataPackage.Create

To create a Master Data Package in the application, open the Master Data Packages page and select New on the ribbon.

Cloning a Master Data Package is not supported.

Step 1: General Data#

1. Provide the name for the Master Data Package.
2. Optionally, provide a description.
3. Select the Master Data Package type. The list of possible values is taken from the lookup table MasterDataPackageType.

4. Select the file to upload by dragging it from the file explorer or by using Browse Files and selecting a file manually. Your file can be:

   • A duly populated MasterData.xlsx template:

   

   • A .zip folder if you want to load objects such as documents, queries and other:

   

   Note

   When using .zip folders you must reference objects correctly in the RelativeFileLocation column of your MasterData.xlsx:

   

   

5. File information will be displayed on screen after the file is loaded and analyzed by the system. Selecting on the right hand side of the entry will remove the file from the import queue.

6. Select Create to save the new Master Data Package.

Editing a Master Data Package#

MasterDataPackage.Edit

The Master Data Package must be Active, its System State must be Not Processing, and its Source must be User.

To edit a Master Data Package, you need to:

1. Open the Master Data Package page.
2. Open the wizard by selecting Edit on the action bar.
3. Make the necessary changes and save them by selecting Edit.

Terminating a Master Data Package#

MasterDataPackage.Terminate

To terminate a Master Data Package, you need to:

1. Open the Master Data Package page.
2. Select Terminate in the top ribbon.
3. Confirm the details and select Terminate to remove the Master Data Package.

Validating a Master Data Package#

MasterDataPackage.Validate

To validate a Master Data Package and assert the correctness of the values, the Master Data Package exists, it is Active and the System State is Not Processing. The steps to load the package are described below:

1. From the main Details page of the Master Data Package, select the Run drop down on the action bar and select Validate.
2. The system will open a dialog where you can see the Entity Types available from the loaded package file. Select which of the entity types should be loaded into the Critical Manufacturing MES system and select Validate to start the process.

Loading a Master Data Package#

MasterDataPackage.Load

To Load a Master Data Package, the Master Data Package exists, it is Active and the System State is Not Processing. The steps to load the package are described below:

1. From the main Details page of the Master Data Package, select the Run drop down on the action bar and select Load.
2. The system will open a dialog where you can see the Entity Types available from the loaded package file. Select which of the entity types should be loaded into the Critical Manufacturing MES system and select Load to start the process.

The status of the execution can be seen in real time on the main screen (and on the left sidebar) when the package is loading:

Operation result	Visual example
Waiting to run
Running
Finished successfully
Error

Table: Execution status for Master Data Package Load

Table: Execution results for Master Data Package Load

Revision State on Import#

The following settings only apply when the Global Data Orchestrator loads a Master Data Package into the destination environment as part of a Change Package deployment.

When a Master Data Package creates a revision of a versioned object during loading, the Entity Type configuration in the destination environment determines its initial revision state:

• New State For First Revision applies when the import creates the first revision of an object.
• New State For Next Revisions applies when the import creates another revision of an existing object.

If the applicable setting is Pilot, the system creates the revision in the Pilot state. Otherwise, it creates the revision in the Active state. These settings apply to newly created revisions, not to updates within an existing revision. For configuration details, see Entity Types.

A Pilot revision can be selected and referenced by other objects. It allows local qualification of imported data without replacing an Active revision with an Effective version as the default.

If no Active revision has an Effective version, the system selects, as the Default Revision, the Pilot revision with an Effective version and the highest sequence. For the complete default-selection rules, see Manage Default Revisions.

After local qualification, you can mark the revision as Active. This recalculates the default revision; it does not necessarily make that revision the default. For more information, see Mark Revision as Pilot and Mark Revision as Active.