Reference

Field formats for the data loader workbooks carry specific value and cell requirements. This topic contains guidelines for data/time format, units of measure (UOM), and cell color coding.

Cell Color Coding

In order to differentiate between required and recommended field values in the Excel workbook, cells adhere to the following color coding scheme:

• Red: a required field.
• Blue: a recommended field.

Cells that Require Logical Values

When a cell corresponds to a field in GE Digital APM that requires a Logical value, you should enter True or False.

Character Limits in Character Fields

In GE Digital APM, family fields that have the Character data type (Character fields) restrict values to a maximum length. In the Excel workbooks, when entering data in a cell that represents a Character field, the values must not exceed the character limit of the corresponding field.

Date and Time Format

Dates should be entered in the following format: YYYY-MM-DD hh:mm:ss, where:

• YYYY is the four-digit year.
• MM is the two-digit month.
• DD is the two-digit day.
• hh is hours in 24-hour notation.
• mm is minutes.
• ss is seconds.

For example, a complete entry would be the following: 2015-05-01 17:53:00. This corresponds to 5:53 PM on May 1, 2015.

Language

Data loader Excel workbooks are available with field captions in all baseline languages supported by GE Digital APM.

Reference Sheets

You can insert additional worksheets into your data loader workbook that will not be loaded into GE Digital APM by encasing the worksheet name in parentheses. For example, if you wanted to add a sheet to record notes on the data loaded into the workbook, you could add a worksheet named (Notes). Because the name of the worksheet is in parentheses, the worksheet will not be loaded into GE Digital APM.

Units of Measure

In the workbooks, values that correspond to a Unit of Measure (UOM) should be entered based on the current UOM Conversion Set setting for the Security User who will be performing the data load.

For example, if the UOM Conversion Set for the Security User is Metric, metric values should be entered in the Excel workbook.

In cells that correspond to a field that uses a UOM, you should not enter the actual UOM. For example, you should enter 10, not 10 Inches.

This section provides a high-level overview and explanation of how the data loader workbook is constructed.

In order to import data using the APM Family Data Loader, GE Digital APM provides an Excel workbook that must be used to perform the data load.

The following table lists the worksheets that are included in the APM Family.xlsx workbook.

Each worksheet in the APM Data Loader workbook contains field values that can be mapped to the appropriate APM Family Data Loader family/field.

Configuration Worksheet

The Configuration worksheet tells the APM Family Data Loader what types of data are being loaded and how the data is to be loaded, and is standard for all data loads regardless of the type of data that you are loading. The following table outlines the options that are valid or the values that are expected in each of the columns on the Configuration worksheet.

<Data> Worksheet

There is no preexisting format that must be adhered to on the <data> worksheet, because the APM Data Loader operates on a flexible framework. Field captions and ID are determined based on the data that you want to load.

Use the metadata exported from GE Digital APM to construct the <data> worksheet, to populate the rows with the actual data that will be loaded.

Steps: Export Metadata

Get a copy of the metadata definitions for the family or families that you will be working with to load data.

1. Login to GE Digital APM.
2. On the left navigation menu, select Admin, then select Configuration Manager, and then select Export.
3. At the top of the page, in the File Name box, enter a file name and in the File Type box, select Excel (.xlsx).
4. In the Select metadata type box, select Families, Fields and Field Behaviors.
5. Select the family or families that you want to export and move them to the Selected Items list.
   Tip: Be sure to order the families in the order in which you want the fields to appear in the export.

6. Select Start Export.

   The metadata is exported, and can be used to populate the <data> worksheet.

7. Save the metadata.

Configure the Data Loader Source File to Use Units of Measure

Sometimes the data that is being loaded, is in a different unit of measure than the one associated with the corresponding field in GE Digital APM. When this is the case, the APM Family Data Loader allows for you to specify the unit of measure that is tied to a specific row and column. This is done by copying the column to which the unit of measure is tied, and then adding the suffix |UOM to the end of the Column ID. Then, in the data, specify the unit of measure ID for the data being loaded. This unit of measure ID needs to be a valid unit of measure as defined GE Digital APM, and a valid conversion needs to be specified for the unit of measure specified and the field’s unit of measure. Please note that if a unit of measure is not specified, then it will use the field’s unit of measure, as defined inGE Digital APM.

Configure the Data Loader Source File to use Time Zones

Sometimes date and time data that is being loaded was collected in a different time zone than the time zone associated with the current user. When this is the case, the APM Family Data Loader allows you to specify the time zone that is tied to a specific row and column. This is done by copying the column to which the time zone is tied, and then adding the suffix |TZ to the end of the Column ID. Then, in the data, specify the time zone for the data being loaded. Please note that if a time zone is not specified, then it will use the time zone defined for the current user.

In addition to the APM Family Data Loader workbook, you can access an example workbook Foundation_APM_Data_Loader-Health Indicators and Readings example.xlsx. This example workbook illustrates how you can use the APM Family Data Loader to load records into a defined GE Digital APM family and link records in one family to another. You can use the information in this example as a model to configure or define templates for loading data into any baseline or custom family.

The data loader in this example creates Health Indicator records in GE Digital APM, links the Health Indicator records to Equipment records, and then links the Health Indicator records to Health Indicator Mapping records. Finally, the data loader loads Readings for one of the Health Indicators. In addition, the example spreadsheet includes how you can use a reference worksheet to store list values and other reference information that users can use when populating the data loader template with data.

Populate the Configuration Worksheet

Populate the HealthIndicators Worksheet

The HealthIndicators worksheet is populated with the actual Health Indicator records you want to load into GE Digital APM.

Populate the HealthIndicatorsEquipment Worksheet

The HealthIndicatorsEquipment worksheet is populated with the key field values for the Equipment records to which the Health Indicators on the HealthIndicators worksheet will be linked once loaded into GE Digital APM.

Populate the HealthIndicatorMappings Worksheet

The HealthIndicatorMappings worksheet is populated with the Health Indicator Mappings to load into GE Digital APM.

Populate the HealthIndicatorReadings Worksheet

The HealthIndicatorReadings worksheet is populated with the actual Health Indicators data you want to load into GE Digital APM.

On this worksheet, Column C illustrates a feature of the APM Family Data Loader where the unit of measure for a given field can be indicated, so that it can be converted to the baseline unit of measure if needed. Assume, for example, that the MI_TSVALUE_VALUE_N field was defined in GE Digital APM as being stored in PSIG, but the data in the spreadsheet was represented by BAR(G). As shown in the following image, you can add the UOM column to indicate to that the unit of measure for the source data is BAR(G). When this column is added, the APM Family Data Loader will convert the data from BAR(G) to PSIG (assuming that there is a unit of measure conversion defined for this in GE Digital APM).

Additionally, column E of the HealthIndicatorReadings worksheet illustrates how time zones can be configured. Notice the appendage to the field name as shown in the following image. Adding a column where the Field ID is appended with a |TZ indicates the timezone of the source column data.

The Configuration worksheet is needed to describe the type of data that you will be loading and how that data should be handled during the data load.

Configuration Worksheet

The Functional Location can be linked to a parent Functional Location using the relationship Functional Location Has Functional Location(s).

In order to import data using the Equipment and Functional Location Data Loaders, GE Digital APM provides an Excel workbook, Equipment and Functional Location.xlsx, which supports baseline data loading of equipment and functional locations in GE Digital APM. This workbook must be used to perform the data load.

The master Excel workbook contains one worksheet for each node that will be populated in the data model.

The following table lists the worksheets that are included in the Equipment and Functional Location Data Loaders workbook.

Configuration Worksheet

The Configuration worksheet tells the Data Loader what types of data are being loaded and how the data is to be loaded, and is standard for all data loads regardless of the type of data that you are loading. The following table outlines the options that are valid or the values that are expected in each of the columns on the Configuration worksheet.

Equipment Worksheet

On the Equipment worksheet, you will specify Equipment that you want to load into GE Digital APM.

FunctionalLocations Worksheet

On the FunctionalLocations worksheet, you enter information for Functional Locations and the Functional Location hierarchy.

FuncLocsToEquipment

FuncLocsToSuperiorFuncLocs

EquipmentToSuperiorEquipment Worksheet

On the EquipmentToSuperiorEquipment worksheet, you specify the hierarchy between an Equipment and its Superior Equipment. This generates the relationships between the entities in the database.

The Configuration worksheet is needed to describe the type of data that you will be loading and how that data should be handled during the data load.

In order to manage asset and tags relationships GE Digital APM provides an Excel workbook, Tags to Assets Relationship.xlsx, which supports linking and unlinking tag records to Equipment and Functional Location records.

The following table lists the worksheets that are included in Tags to Assets Relationship Data Loader workbook.

TagRelationship Worksheet

The baseline file is organized such that each row is capable of creating one node in the data model when all columns contain the appropriate values.

The following table lists the worksheets that are included in the Taxonomy Data Loader workbook.

Configuration Worksheet

TaxonomyCategory

TaxonomyClass

TaxonomyType

TaxonomyMapping Worksheet

Relationships:

• The Work History records are linked to Equipment and/or Functional Location records via the relationship Has Work History [MIR_HSWKHST].
• The Work History Detail records will be related to the appropriate Work History records via the relationship family Has Event Detail [MIR_EVNTDET].

To import data using the Work History Data Loader, GE Digital APM provides an Excel workbook, Work History.xlsx, which supports baseline data loading of work history and work history detail records in GE Digital APM. This workbook must be used to perform the data load.

The following table lists the worksheets that are included in the Foundation Work History Data Loader workbook.

Configuration Worksheet

The Configuration worksheet tells the Data Loader what types of data are being loaded and how the data is to be loaded, and is standard for all data loads regardless of the type of data that you are loading. The following table outlines the options that are valid or the values that are expected in each of the columns on the Configuration worksheet

WorkHistory

WorkHistoryToWHDetails Worksheet

On the WorkHistoryToWHDetails worksheet, you will find work history and work history detail fields.

WorkHistoryToEquipment Worksheet

WorkHistoryToFLOCs Worksheet

Work History Data Query

            SELECT 'Customer Event Id' "Customer Event Id", [MI_EVWKHIST].[MI_EVENT_ID]
            "Event ID", [MI_EQUIP000].[MI_EQUIP000_EQUIP_ID_C] "Equipment ID", 
            [MI_EQUIP000].[MI_EQUIP000_EQUIP_TECH_NBR_C] "Equipment Technical Number", 
            [MI_FNCLOC00].[MI_FNCLOC00_FNC_LOC_C] "Functional Location", 
            [MI_EVWKHIST].[MI_EVWKHIST_SAP_SYSTEM_C] "CMMS System", 
            [MI_EVWKHIST].[MI_EVWKHIST_ACTIV_CAUSE_C] "Activity Cause", 
            [MI_EVWKHIST].[MI_EVWKHIST_ORDR_PM_ACT_DESC_C] "Activity Type Description", 
            [MI_EVWKHIST].[MI_EVWKHIST_ORDR_PM_ACT_C] "Activity Type", 
            [MI_EVWKHIST].[MI_EVWKHIST_BRKDN_IND_F] "Breakdown Indicator", 
            [MI_EVWKHIST].[MI_EVWKHIST_DETCT_MTHD_CD_C] "Detection Method Code", 
            [MI_EVWKHIST].[MI_EVWKHIST_DETCT_MTHD_DESC_C] "Detection Method Description", 
            [MI_EVWKHIST].[MI_EVWKHIST_EFFCT_CD_C] "Effect Code", 
            [MI_EVWKHIST].[MI_EVWKHIST_EFFCT_DESC_C] "Effect Description", 
            [MI_EVWKHIST].[MI_EVWKHIST_EVENT_DATE_DESC_C] "Event Date Description", 
            [MI_EVWKHIST].[MI_EVENT_LNG_DSC_TX] "Event Long Description", 
            [MI_EVWKHIST].[MI_EVENT_SHRT_DSC_CHR] "Event Short Description", 
            [MI_EVWKHIST].[MI_EVENT_STRT_DT] "Event Start Date", 
            [MI_EVWKHIST].[MI_EVWKHIST_STATUS_C] "Event Status", 
            [MI_EVWKHIST].[MI_EVENT_TYP_CHR] "Event Type", 
            [MI_EVWKHIST].[MI_EVWKHIST_FAILR_MODE_CD_C] "Failure Mode Code", 
            [MI_EVWKHIST].[MI_EVWKHIST_FAILR_MODE_DESC_C] "Failure Mode Description", 
            [MI_EVWKHIST].[MI_EVWKHIST_FAILURE_REM_T] "Failure Remarks", 
            [MI_EVWKHIST].[MI_EVWKHIST_FNCTNL_LOSS_CD_C] "Functional Loss Code", 
            [MI_EVWKHIST].[MI_EVWKHIST_FNCTNL_LOSS_DESC_C] "Functional Loss Description", 
            [MI_EVWKHIST].[MI_EVWKHIST_MAINT_COMPL_D] "Maintenance Completion Date", 
            [MI_EVWKHIST].[MI_EVWKHIST_MAINT_CST_UOM_C] "Maintenance Cost UOM", 
            [MI_EVWKHIST].[MI_EVWKHIST_MAINT_CST_N] "Maintenance Cost", 
            [MI_EVWKHIST].[MI_EVWKHIST_MAINT_START_D] "Maintenance Start Date", 
            [MI_EVWKHIST].[MI_EVWKHIST_MECH_DWN_TIME_N] "Mechanical Down Time", 
            [MI_EVWKHIST].[MI_EVWKHIST_MECH_AVAIL_D] "Mechanically Available Date", 
            [MI_EVWKHIST].[MI_EVWKHIST_MECH_UNAVL_D] "Mechanically Unavailable Da", 
            [MI_EVWKHIST].[MI_EVWKHIST_ORDR_CRT_DT_D] "Order Creation Date", 
            [MI_EVWKHIST].[MI_EVWKHIST_ORDR_DESC_C] "Order Description", 
            [MI_EVWKHIST].[MI_EVWKHIST_ORDR_ID_C] "Order ID", 
            [MI_EVWKHIST].[MI_EVWKHIST_ORDR_MAINT_PLAN_C] "Order Maintenance Plan", 
            [MI_EVWKHIST].[MI_EVWKHIST_ORDR_PRTY_DESC_C] "Order Priority Description", 
            [MI_EVWKHIST].[MI_EVWKHIST_ORDR_PRTY_C] "Order Priority",
            [MI_EVWKHIST].[MI_EVWKHIST_ORDR_REF_DT_D] "Order Reference Date", 
            [MI_EVWKHIST].[MI_EVWKHIST_ORDR_SYS_CND_DES_C] "Order System Condition Desc", 
            [MI_EVWKHIST].[MI_EVWKHIST_ORDR_SYS_COND_C] "Order System Condition", 
            [MI_EVWKHIST].[MI_EVWKHIST_ORDR_SYS_STAT_C] "Order System Status", 
            [MI_EVWKHIST].[MI_EVWKHIST_ORDR_TYP_CD_C] "Order Type Code", 
            [MI_EVWKHIST].[MI_EVWKHIST_ORDR_TYP_DESC_C] "Order Type Description", 
            [MI_EVWKHIST].[MI_EVWKHIST_ORDR_USER_STAT_C] "Order User Status", 
            [MI_EVWKHIST].[MI_EVWKHIST_PM_NBR_C] "PM Number", 
            [MI_EVWKHIST].[MI_EVWKHIST_PRDN_CST_N] "Production Cost", 
            [MI_EVWKHIST].[MI_EVWKHIST_RQST_ID_C] "Request ID", 
            [MI_EVWKHIST].[MI_EVWKHIST_RQST_CRT_DT_D] "Request Creation Date", 
            [MI_EVWKHIST].[MI_EVWKHIST_RQST_DESC_C] "Request Description", 
            [MI_EVWKHIST].[MI_EVWKHIST_RQST_PRTY_DESC_C] "Request Priority Descriptio", 
            [MI_EVWKHIST].[MI_EVWKHIST_RQST_PRTY_C] "Request Priority", 
            [MI_EVWKHIST].[MI_EVWKHIST_RQST_SYS_STAT_C] "Request System Status", 
            [MI_EVWKHIST].[MI_EVWKHIST_RQST_TYP_CD_C] "Request Type Code", 
            [MI_EVWKHIST].[MI_EVWKHIST_RQST_TYP_DESC_C] "Request Type Description", 
            [MI_EVWKHIST].[MI_EVWKHIST_RQST_USER_STAT_C] "Request User Status", 
            [MI_EVWKHIST].[MI_EVWKHIST_SCHED_COMPL_D] "Scheduled Completion Date", 
            [MI_EVWKHIST].[MI_EVWKHIST_SCHED_START_D] "Scheduled Start Date", 
            [MI_EVWKHIST].[MI_EVWKHIST_TARGET_COMPL_D] "Target Completion Date", 
            [MI_EVWKHIST].[MI_EVWKHIST_TARGET_START_D] "Target Start Date", 
            [MI_EVWKHIST].[MI_EVWKHIST_TIME_TO_REPR_N] "Time To Repair (TTR)", 
            [MI_EVWKHIST].[MI_EVWKHIST_TOTL_CST_N] "Total Cost", 
            [MI_EVWKHIST].[MI_EVWKHIST_WORK_HIST_TYPE_C] "Work History Type", 
            [MI_EVWKHIST].[MI_EVWKHIST_WO_PRIORTY_N] "Work Order Priority", 
            'WHD_Customer WHD ID' "WHD_Customer WHD ID", [MI_DTWKHIST].[MI_DTWKHIST_EVNT_DTL_ID_C] 
            "WHD_Work History Detail ID", [MI_DTWKHIST].[MI_DTWKHIST_EVNT_DTL_DESC_C] 
            "WHD_Work Hist Detail Desc", [MI_DTWKHIST].[MI_DTWKHIST_ORDR_ID_C] 
            "WHD_Order ID", [MI_DTWKHIST].[MI_DTWKHIST_RQST_ID_C] "WHD_Request ID", 
            [MI_DTWKHIST].[MI_DTWKHIST_CAUSE_CD_C] "WHD_Cause Code", 
            [MI_DTWKHIST].[MI_DTWKHIST_CAUSE_DESC_C] "WHD_Cause Description", 
            [MI_DTWKHIST].[MI_DTWKHIST_CNDTN_CD_C] "WHD_Condition Code", 
            [MI_DTWKHIST].[MI_DTWKHIST_CNDTN_DESC_C] "WHD_Condition Description", 
            [MI_DTWKHIST].[MI_DTWKHIST_DTL_NARTV_T] "WHD_Detail Narrative", 
            [MI_DTWKHIST].[MI_DTWKHIST_MAINT_ITEM_CD_C] "WHD_Maintainable Item Code", 
            [MI_DTWKHIST].[MI_DTWKHIST_MAINT_ITEM_DESC_C] "WHD_Maintainable Item Desc", 
            [MI_DTWKHIST].[MI_DTWKHIST_MAINT_ACTN_CD_C] "WHD_Maintenance Action Code", 
            [MI_DTWKHIST].[MI_DTWKHIST_MAINT_ACTN_DESC_C] "WHD_Maintenance Action Desc"
            FROM [MI_EVWKHIST] JOIN_PRED [MI_EQUIP000] JOIN_PRED [MI_FNCLOC00] 
            ON {MIR_FLHSEQ} ON {MIR_HSWKHST} JOIN_SUCC [MI_DTWKHIST] ON {MIR_EVNTDET}
        

Data Loaders and Directories