---
alias: master-data-packages-admin
description: "This documentation guides users through creating, editing, and loading Master Data Packages for bulk data import into a manufacturing MES"
---

# Master Data Packages

:lock: Administration.**MasterDataPackages**

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.

![master_data_package_list][master_data_package_list]

!!! note
	**Download Template** on the top ribbon provides direct access to an empty **Master Data Template**.

!!! info
	You can find specific features, formats, and configurations of the packages that can be used in this section in [[master-data-packages-tutorial]].

## Details view

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

![master_data_package_details][master_data_package_details]

The **Details** view will display some or all of the following page 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.

## Execution view

This view 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.

![master_data_package_execution][master_data_package_execution]

## 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:

![Mdpackage location](images/mdpackage_location.png)

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:

![Mdpackage example](images/mdpackage_example.png)

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:

![Mdpackage example2](images/mdpackage_example2.png)

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-tutorial]], where you can also find a sample of the Master Data File.

## Creating a Master Data Package

:lock: MasterDataPackage.**Create**

To create a Master Data Package in the application you need to open the **Master Data Packages** page and select New in the ribbon:

### 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:

    ![Step 1: General Data — A duly populated MasterData.xlsx template (Screenshot shows: enmete, aetn, oma, nen, conte, ome)](images/mdpackage_template_example.png)

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

    ![Mdpackage example2](images/mdpackage_example2.png)

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

    ![Mdpackage relfileloc1](images/mdpackage_relfileloc1.png)

    ![Mdpackage relfileloc2](images/mdpackage_relfileloc2.png)

5. File information will be displayed on screen after the file is loaded and analyzed by the system. Selecting :material-trash-can: 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.

![create_master_data_package][create_master_data_package]

## Editing a Master Data Package

:lock: MasterDataPackage.**Edit**

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 top ribbon.
3. Make the necessary changes and save them by selecting **Edit**.

![edit_master_data_package][edit_master_data_package]

## Terminating a Master Data Package

:lock: 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.

![terminate_master_data_package][terminate_master_data_package]

## Loading a Master Data Package

:lock: 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 top ribbon 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.

![load_master_data_package][load_master_data_package]

!!! info
	The System State of the Master Data Package will be set to Processing during loading, and will move back to Not Processing after completing 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        | ![load_master_data_package_waiting][load_master_data_package_waiting]     |
| Running               | ![load_master_data_package_running][load_master_data_package_running]     |
| Finished successfully | ![load_master_data_package_completed][load_master_data_package_completed] |
| Error | ![load_master_data_package_error][load_master_data_package_error] |

Table: Execution status for Master Data Package Load

!!! note
	When using Load, the execution will stop if any error is raised throughout the procedure, resulting in the following possible scenarios:

| Procedure result          | Data loading                    |
|---------------------------|---------------------------------|
| No error raised           | All data loaded into the system |
| At least one error raised | No data loaded into the system  |

Table: Execution results for Master Data Package Load

## Validating a Master Data Package

:lock: 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 top ribbon 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.

![validate_master_data_package][validate_master_data_package]

[master_data_package_list]: images/master_data_package_list.png
[master_data_package_details]: images/master_data_package_details.png
[master_data_package_execution]: images/master_data_package_execution.png
[create_master_data_package]: images/create_master_data_package.png
[edit_master_data_package]: images/edit_master_data_package.png
[load_master_data_package]: images/load_master_data_package.png
[validate_master_data_package]: images/validate_master_data_package.png
[load_master_data_package_waiting]: images/load_master_data_package_waiting.png
[load_master_data_package_running]: images/load_master_data_package_running.png
[load_master_data_package_completed]: images/load_master_data_package_completed.png
[load_master_data_package_error]: images/load_master_data_package_error.png
[terminate_master_data_package]: images/terminate_master_data_package.png