PLA Admin Data Loader

About the Production Loss Analysis (PLA) 1-Admin Data Loader

Using the Production Loss Analysis (PLA) 1-Admin Data Loader, you can create the following records:

  • Production Units
  • Production Event Codes
  • Production Profiles
  • Profile Margins

About the Production Loss Analysis (PLA) 1-Admin Data Loader Requirements

Before you use the Production Loss Analysis (PLA) 1-Admin Data Loader:

  • Ensure that the Production Event Codes specified in the data loader workbook exist in APM.
  • If a Functional Location is specified in the data loader workbook, ensure that it exists in APM.
    Important: To use this data loader, the Functional Location family must use the baseline format of the ID Template.

Security Settings

The user who loads data must be associated with the following Security Groups and Security Roles:

  • MI Data Loader User Security Role

    -or-

    MI Data Loader Admin Security Role

  • MI Production Loss Accounting Administrator Security Group

    -or-

    A role that is associated with the MI Production Loss Accounting Administrator Security Group

About the Production Loss Analysis (PLA) 1-Admin Data Loader Data Model

The following data model illustrates which records are supported by the Production Loss Analysis (PLA) 1-Admin Data Loader:

  • Elements shown in grey are imported into APM by the Production Loss Analysis (PLA) 1-Admin Data Loader.
  • Elements shown in green exist in APM and may be related to the data that is being loaded.

About the Production Loss Analysis (PLA) 1-Admin Data Loader General Loading Strategy

This section describes any prerequisites to loading the data and the order in which the data will be loaded.

Best Practices

When using the Production Loss Analysis (PLA) 1-Admin data loader workbook, ensure that:

  • The ID fields (that is, row 2) in each worksheet do not include special characters or spaces.
  • Columns of each worksheet, including those representing custom fields, are not formatted as Text.
  • The first two rows of each worksheet are not modified.

Modification Requirements and Guidelines

To accommodate a new or an enhanced feature, APM may modify the data model from one version to the next. In this scenario, the data loaders will be modified and maintained by APM between releases.

Limitations

  • If you reimport a record that currently exists in APM, the newly imported record will replace the existing one in APM. The Production Loss Analysis (PLA) 1-Admin Data Loader does not create a duplicate record.
  • You must not modify the template of the data loader workbook.

Load Sequence

  1. Download the Production Loss Analysis (PLA) 1-Admin data loader workbook provided by APM:
  2. Identify the data requirements for exporting data from the legacy system into the data loader workbooks.
  3. Extract data from the legacy system to populate the data loader workbooks.
  4. Load data using the Production Loss Analysis (PLA) 1-Admin data loader workbook.
  5. Monitor the status of the data load operation and report results.
  6. Conduct tests in APM to ensure that the imported data is loaded properly.

About the Production Loss Analysis (PLA) 1-Admin Data Loader Workbook Layout and Use

To load data using the Production Loss Analysis (PLA) 1-Admin Data Loader, APM provides an Excel workbook, Production Loss Analysis (PLA) 1-Admin.xlsx, which supports baseline PLA in APM.

The following table provides a list of worksheets that are included in the Production Loss Analysis (PLA) 1-Admin data loader workbook:

Worksheet

Description

ProductionUnit

This worksheet is used to specify the Production Unit records.

ProductionEventCode

This worksheet is used to specify the existing Production Event Code records that have been assigned to the Production Unit records.

ProductionProfile

This worksheet is used to specify the Production Profile records.

ProfileMargin

This worksheet is used to specify the Profile Margin records.

Color Coding

Certain columns in the worksheets have different functions and requirements. To illustrate this, they are color-coded.

The PLA Administrators can choose and assign colors to the Impact Codes, and you can apply the code from the drop-down list.
Note: Colors are not applied in the baseline configuration and are not essential to the workflows.

ProductionUnit Worksheet

Production Unit records store basic information about a single Production Unit. In the ProductionUnit worksheet, you will specify the Production Unit records that you want to create.

Field Caption

Field ID

Data Type (Length)

Comments

Production Unit Key

MI_PRDNUNIT_KEY

Character (255)

This cell is required.

Enter a unique value that you want to assign to each Production Unit. Other worksheets within the workbook can reference the Production Unit using this value.

Production Unit Name

MI_PRDNUNIT_UNIT_ID_C

Character (255)

This cell is required.

Enter a unique value.

The name of the Production Unit is case-sensitive.

Production Unit Description MI_PRDNUNIT_DESCR_CCharacter (255)This cell is optional.

Associated Unit

MI_ PRDNUNIT_FUNC_LOC_C

Character (255)

This cell is recommended.

The value you enter in this cell must match the ENTITY ID of an existing Functional Location (Family ID: MI_FNCLOC00) in APM.

TimeZone

MI_PRDNUNIT_TIMEZONE_C

Character (255)

This cell is required.

Enter a valid time zone (for example, Eastern Standard Time).

ProductionEventCode Worksheet

In the ProductionEventCode worksheet, you will specify the Production Event Codes that you want to associate with your Production Unit records.

Field Caption

Field ID

Data Type (Length)

Comments

Production Unit Key

MI_PRDNUNIT_KEY

Character (255)

This cell is required.

Enter the key that is assigned to the Production Unit that you want to reference. The ProductionUnit worksheet contains this value.

Event Code

MI_PRDEVNCD_CODE_C

Character (50)

This cell is required.

The value you enter in this cell is mapped to the corresponding Production Unit. This value must exist in the Codes workspace on the PLA Administrator page.

ProductionProfile Worksheet

Production Profile records store information about a Product. In the Production Profile worksheet, you will specify the Production Profile records that you want to create.

Field Caption

Field ID

Data Type (Length)

Comments

Production Unit Key

MI_PRDNUNIT_KEY

Character (255)

This cell is required.

Enter the key that is assigned to the Production Unit that you want to reference. The ProductionUnit worksheet contains this value.

Profile Key

MI_PRDNPROF_KEY

Character (255)

This cell is required.

Enter a unique value.

Production Profile Description MI_PRDNPROF_DESCR_CCharacter (255)This cell is optional.
Product NameMI_PRODUCT_NAME_CCharacter (50)

This cell is required.

The value you enter in this cell is used to form the name of the Production Profile.

If the entered Product Name does not exist in APM, the Product Name and the Product Description will be used to create the Product.

Product Alias

MI_PRDNPROF_ALTE_PROD_NAME_C

Character (50)

This cell is recommended. If a value is not entered in this cell, it will be populated with the Product Name of the Production Profile.

Product Description MI_PRODUCT_DESCR_CCharacter (255)This cell is optional.
Max Demonstrated RateMI_PRDNPROF_MAX_DMNSTR_RATE_NNumeric

This cell is recommended.

Enter the maximum demonstrated production rate. Max Demonstrated Rate (MDR) defines the practical limit for Maximum Sustained Capacity Rate (MSCR). It is measured in terms of Product UOM per Production Rate UOM (e.g., 500 Barrels/Day).

Product UOM

MI_PRDNPROF_PRODUCT_UOM_C

Character (255)

This cell is required.

The value you enter in this cell is used to form the name of the Production Profile.

Unit is the default Product UOM.

If the entered UOM does not exist in APM, it will be added to APM.

Production Rate UOMMI_PRDNPROF_PRO_RATE_UOM_CCharacter (255)

This cell is required.

Enter the required Unit of Measure (UOM) which defines the unit used for batch cycle time, production planning, and reporting rates.
Standard Batch Cycle TimeMI_PRDNPROF_ST_BA_CY_TI_NNumeric

This cell is required.

Enter the cycle time that is used to calculate capacity and planning rates. It is measured in terms of Production Rate UOM (for example, 1 Day).
Standard Batch SizeMI_PRDNPROF_STAN_BAT_SIZ_NNumeric

This cell is required.

Enter the batch size that is used to calculate capacity and planning rates. It is measured in terms of Product UOM (for example, 5 Barrels).
Planning RateMI_PRDNPROF_PLAN_RATE_N Numeric

This cell is required.

Enter the rate associated with the useful production time. It is measured in terms of Product UOM per Production Rate UOM (for example, 300 Barrels/Day).
Profile MSHRMI_PRDNPROF_MAX_SUS_HO_RA_MS_N Numeric

This cell is recommended.

Enter the Maximum Sustained Hourly Rate for Production. If a value is not entered in this cell, Equivalent Downtime Hours will not be calculated on Production Losses. It is measured in terms of Product UOM (for example, 50 Barrels).

ProfileMargin Worksheet

Every Production Profile must have at least one Profile Margin. In the ProfileMargin worksheet, you will specify the Profile Margin records that you want to create for a Production Profile.

Note: If there is more than one Profile Margin for a Production Profile, then one of the Profile Margins must be marked as default. If no Profile Margin is provided for a Production Profile, then the Loss value will not be calculated.

Field Caption

Field ID

Data Type (Length)

Comments

Production Unit Key

MI_PRDNUNIT_KEY

Character (255)

This cell is required.

Enter the key that is assigned to the Production Unit that you want to reference. The ProductionUnit worksheet contains this value.

Profile Key

MI_PRDNPROF_KEY

Character (255)

This cell is required.

Enter the key that is assigned to the Production Unit that you want to reference. The ProductionProfile worksheet contains this value.
MarginKey MI_MARGIN_KEY Numeric

This cell is required.

Enter a unique value.
Margin IDMI_PROFMAR_MARGI_ID_C Character (255)

This cell is required.

Enter a unique value.
Margin ValueMI_PROFMAR_MARGI_VALUE_NNumeric

This cell is required.

Enter a value for the Margin.
Default(Yes/No)MI_PROFMAR_SELE_DEFA_N Numeric

This cell is required.

Enter one of the following values:

  • 0: This will not mark the corresponding Profile Margin of the selected Production Profile as the default Profile Margin.
  • 1: This will mark the corresponding Profile Margin of the selected Production Profile as the default Profile Margin.

About the Production Loss Analysis (PLA) 1-Admin Data Loader Load Verification

About This Task

After you load data, you can access the following records:
  • Production Units
  • Production Event Codes
  • Production Profiles
  • Profile Margins

You should perform the following steps in APM to confirm the accuracy and integrity of the data imported from the data loader workbook:

Procedure

  1. Access the details of the import job. In addition to the general information regarding the records that were loaded during the data load operation, these details may include error and warning messages pertaining to the records.
  2. In PLA, access the records specified in the data loader workbook, and then verify that the expected data is present or updated, as applicable.