Using
Data Loaders Workflow
This workflow provides the basic, high-level steps for using this module. The steps and links in this workflow do not necessarily reference every possible procedure.
Procedure
Access the Data Loaders Page
Procedure
Download the Data Loader Workbooks
Procedure
Access Localized Data Loader Workbooks
About this task
The localized Data Loader workbooks are stored on the GE Digital APM Server.
Procedure
Results
You can access and use the localized workbooks to load data into GE Digital APM. Optionally, you can import the localized workbooks into GE Digital APM so that they can be accessed from the Data Loaders page.
Import Data Loader Workbooks
About this task
You can import custom Data Loader workbooks or localized workbooks into GE Digital APM, so that they can be accessed on the Data Loaders page.
Procedure
Results
The workbook that you imported can be download on the Data Loaders page.
Import an Additional Equipment and Functional Location Workbook
- Access the Export page,
- In the Available Items section, in the Select metadata type drop-down, select DataLoaders Template.
The Available Items section is populated with the Data Loader catalog entries.
- Select the Equipment and Functional Location box, and then select . The Equipment and Functional Location Data Loader appears in the Selected Items section.
- In the File Name box, enter Equipment and Functional Location Export, and then select the File Type XML(.xml).
- Select Start Export.
The Data Loader workbook files are exported, and a zip file is downloaded containing three files:
- Equipment and Functional Location Export Files: A folder containing the default Equipment and Functional Location Data Loader workbook.
- Equipment and Functional Location Export.xml: An .xml containing the metadata for the catalog item.
- ExportLog: A log file detailing the export from GE Digital APM.
- Open the Equipment and Functional Location Export Files folder, and place a copy of the workbook to be imported into the folder. In this example the workbook name is Equipment and Functional Location_DE.
- Ensure the template to be imported has a unique name different from the naming structure of the default template, and then delete the default template.
- Open the Equipment and Functional Location Export.xml file.
- In the DATALOADERTEMPLATE_ID and DATALOADERTEMPLATE_DESC parameters, replace Equipment and Functional Location with Equipment and Functional Location_DE.
- In the parameter DATALOADERTEMPLATE_FILE_NM, replace the value with Equipment and Functional Location_DE.xml.
- Save the file.
- Create a zip file with the Equipment and Functional Location Export files.
- Access the Import page.
- In the Import File box, select Choose File, and then navigate to the zip file Equipment and Functional Location Export.
In the Available Items section The Equipment and Functional Location entry appears.
- Select the The Equipment and Functional Locationbox, and then select .
- Select Start Import Button. The new template is imported into GE Digital APM, and is available to download on the Data Loaders page.
Test Data Loader Connection
Procedure
Results
The following table describes the connection status for data import jobs.
Connection Test | Description | If you get an Error... |
---|---|---|
APM Connect Web API Test | Test the connection between the GE Digital APM web API and the APM Connect server. | Ensure the ports are open between the GE Digital APM Server and the APM Connect server. |
APM Connect Configuration Test | Test the configuration of the APM Connect connection parameters configured in GE Digital APM. |
Ensure the parameters configured in GE Digital APM are correct to establish connection from GE Digital APM and APM Connect. |
APM Fileshare Access Test | Tests the file share system is connected to the GE Digital APM Server, so that the server can read and write to the configured file shares. |
Ensure the parameters configured in GE Digital APM are correct to establish connection from GE Digital APM, and the user has the necessary permissions to access the file share. |
APM Staging Database Test | Tests the GE Digital APM Server is connected tot the APM Connect IR database. | Ensure that PostgresSQL is accepting the connection from GE Digital APM . These connections are managed in the file pg_hba.conf. |
APM Connect Fileshare Access Test | Tests the file share system is connected to the APM Connect server, so that the server can read and write to the configured file shares. |
Ensure the parameters configured in GE Digital APM are correct to establish connection from GE Digital APM, and the user has the necessary permissions to access the file share. |
APM Connect Staging Database Test | Tests the connection between the APM Connect server and the IR database to ensure that files can read and written to the IR. | Ensure the RunDataLoaderRoute.cfg is configured correctly. |
Run a Data Import Job
Before you begin
Procedure
Access the Details of an Import Job
About Populating Site Reference Data
The APM Family Data Loader can be used to populate the Site Reference on Equipment and Functional Location records in GE Digital APM.
About this task
The APM Family Data Loader populates the ENTY_KEY system field and the MI_SITE_KEY system field associated with the Site Reference value to be populated. On asset records, the Site Reference is stored in the MI_SITE_KEY field, a system field in GE Digital APM. The APM Data Loader uses the Site Name (MI_SITE_NAME) to translate the value to the corresponding Site Key and populate the MI_SITE_KEY field; therefore, you do not need to know the key to be able to populate the site reference. This functionality is important because this value can change from one database to another.
Procedure
The APM Family Data Loader General Loading Strategy
This section describes any prerequisites to loading the data and the order in which the data will be loaded.
Procedure
- Determine if you want to load data into a single family or into two families that are related to each other.
- Access a sample APM Family Data Loader source file based on the type of load determined in step 1.
- Determine what families and or relationships you want to populate using the APM Family Data Loader.
- Export the metadata that reflects the metadata definition for the family or families into which you want to load data.
- Populate the Configuration worksheet.
- Populate the column headers of the <Data> worksheet using the exported metadata.
- As needed, modify the worksheets to populate unit of measure to apply the correct unit of measure to any of the numeric fields.
- As needed, modify the worksheets to populate time zones to convert any date or time fields to the correct time zone.
The Equipment and Functional Location Data Loader General Loading Strategy
This topic describes any prerequisites to loading the data and the order in which the data will be loaded for Equipment and Functional Location Data Loaders.
About this task
The Equipment and Functional Location data load must be performed in a specific sequence to successfully populate fields, create records, and link them to the predecessor and/or successor records.
Procedure
The Tags to Assets Relationship Data Loader General Loading Strategy
The Tags to Assets Relationship Data Loader manages relationships between existing GE Digital APM records including: Tag records, Equipment records, and Functional Location records.
Procedure
The Taxonomy Data Loader General Loading Strategy
This section describes any prerequisites to loading the data and the order in which the data will be loaded.
About this task
The Taxonomy data load must be performed in a specific sequence to successfully populate fields, create records, and link them to the predecessor and/or successor records:
Procedure
- Taxonomy Category
- Taxonomy Class
- Taxonomy Type
- Taxonomy Mapping Values
The Work History Data Loader General Loading Strategy
This section describes any prerequisites to loading the data and the order in which the data will be loaded.
About this task
The Work History and Work History Detail data load must be performed in a specific sequence to successfully populate fields, create records, and link them to the predecessor and/or successor records:
Procedure
Work History Data Loader Load Verification
Use this query in any GE Digital APM database to populate an Excel format with the required data fields.
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}
Considerations for Loading with .CSV Files
Typically when you load data into APM you will use the provided Data Loader workbooks, however, if you have a program that creates reports that generates .csv files, GE Digital APM can load that data as long as you follow these guidelines.
The Data Import job can accept a .zip file that contains .csv files as input. The format of the .zip file is specific to each Data Loader and must contain .csv files that conform match these specific rules.
- There must be a .csv file for each worksheet defined in the workbook template for the Data Loader.
- The filename must match the worksheet name with the file extension .csv. For example, the .csv for the Equipment worksheet must be named Equipment.csv.
- The .zip must contain all the .csv files that match the worksheets expected by the data loader.
A .zip that meets all of these requirements can be used as input to the Data Import job.
Using the Automatic Data Loader
Use the Automatic Data Loader job to manually or programmatically load asset data to GE Digital APM.
Procedure
- Identify the directory that corresponds to the data loader you are using.
- Move the data loader files (either a correctly formatted Excel workbook or .zip file) into the identified directory.