Data Loaders

Download the Data Loader Workbooks

Procedure

  1. Access the Data Loaders page, and then select Download Templates.
    The Download Templates window appears, displaying a list of the data loader categories.

  2. Select the category whose template you want to download.
    Data Loader CategoryWorkbooks in the Category
    APM Connect Equipment and Functional Location, Tag to Asset Relationship, APM Family, Taxonomy, Work History
    APM Failure Elimination Production Loss Analysis (PLA), Root Cause Analysis (RCA)
    APM Foundation

    Geographic Information System (GIS), Custom Asset Hierarchy, Role, Asset Criticality Analysis (ACA), Policy Instance Data Loader

    APM Health Rounds Allowable Values, Rounds Readings, Rounds Routes, Rounds Templates
    APM Mechanical Integrity Inspection Management (IM) Assets, Inspection Management (IM) Functional Location, Risk Based Inspection (RBI) 580, Risk Based Inspection (RBI) 581, Risk Based Inspection (RBI) Corrosion Loop, RBI Components To TML Groups Relationship, Thickness Monitoring (TM) Equipment, Thickness Monitoring (TM) Functional Location
    APM Power Generation

    Generation Availability Analysis (GAA) Amplification Codes, Generation Availability Analysis (GAA) Cause Codes

    APM Safety Calibration, Hazards
    APM Strategy Asset Strategy Management (ASM), Asset Strategy Management (ASM) Templates, Failure Modes and Effects Analysis (FMEA), FMEA Analysis Template, FMEA Asset Template, Reliability Centered Maintenance (RCM)
  3. In the Templates column, in the row for the data loader whose template you want to download, select .

    The template is downloaded, and can be populated with data to load into GE Digital APM.

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

  1. Access the Export page.
  2. In the Available Items section, in the Select metadata type drop-down, select DataLoader Templates.
    The Available Items section is populated with the Data Loader catalog entries.
  3. Select the box of Data Loader whose workbook you want to modify, and then select .
    The Data Loader appears in the Selected Items section.
  4. In the File Name box, enter a name for the file that will be exported, and then select the File Type XML(.xml).
  5. Select Start Export.

    The Data Loader files are exported, and a zip file is downloaded containing three files:

    <Data Loader Name> Files:
    A folder containing the excel source workbook for that data loader.
    <DataLoaderName>.xml:
    An xml containing the metadata for the data loader catalog item.
    ExportLog:
    A log file detailing the export from GE Digital APM.
  6. Open the <DataLoder Name> Files folder, and place a copy of the workbook to be imported into the folder.
  7. If you want to replace the default workbook with the workbook to be imported, rename the workbook to be imported to match the exact naming structure of the default template, and then delete the default template.
    Important: The name of the file to be imported must match the original file name exactly. Otherwise, the workbook will be not be available to download in GE Digital APM
  8. If you want to add an additional workbook, and keep the default workbook:
    1. Ensure the workbook to be imported has a unique name, different from the naming structure of the default workbook, and then delete the default workbook.
    2. Open the <DataLoaderName>.xml file.
    3. In the DATALOADERTEMPLATE_ID, DATALOADERTEMPLATE_DESC, and the DATALOADERTEMPLATE_FILE_NM parameters, replace the existing value with the name of the new workbook to be imported.
    4. Save the file.
  9. Create a zip file with the <Data Loader Name> Files folder containing the new workbook to be imported, the <DataLoaderName>.xml file, and the ExportLog file.
  10. Access the Import page.
  11. In the Import File box, select Choose File, and then navigate to the zip file you created in the previous step.
  12. Select the box of Data Loader whose workbook you want to import, and then select .
  13. Select Start Import.

    The new workbook is imported into GE Digital APM.

Results

The workbook that you imported can be download on the Data Loaders page.

Import an Additional Equipment and Functional Location Workbook

  1. Access the Export page,
  2. 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.

  3. Select the Equipment and Functional Location box, and then select .
    The Equipment and Functional Location Data Loader appears in the Selected Items section.

  4. In the File Name box, enter Equipment and Functional Location Export, and then select the File Type XML(.xml).
  5. 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.
  6. 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.
  7. 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.
  8. Open the Equipment and Functional Location Export.xml file.
  9. In the DATALOADERTEMPLATE_ID and DATALOADERTEMPLATE_DESC parameters, replace Equipment and Functional Location with Equipment and Functional Location_DE.
  10. In the parameter DATALOADERTEMPLATE_FILE_NM, replace the value with Equipment and Functional Location_DE.xml.
  11. Save the file.
  12. Create a zip file with the Equipment and Functional Location Export files.
  13. Access the Import page.
  14. 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.

  15. Select the The Equipment and Functional Locationbox, and then select .
  16. 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

  1. Access the Data Loaders page.
  2. If, on the upper-left corner of the page, the <number> Error link appears beside the , then select the link.
    Note: If the number of errors link does not appear, then the connections needed to use the data loaders are configured properly.
    The Connection Errors dialog box appears displaying the connections status for each connection point needed to use the data loaders.
  3. Select OK.
    The connection status is tested.

Results

The following table describes the connection status for data import jobs.

Connection TestDescriptionIf 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 TestTest 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 TestTests 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 TestTests 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 TestTests 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 TestTests 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

This topic assumes that you have migrated your data to the required format for the modules into which you want to import data. The format should match either:

Procedure

  1. Access the Data Loaders page.
  2. Select Import New.
    The Import Data window appears.

  3. In navigation tree, select the data loader category, and then select the data loader that you want to use to import data according the following table.
    Data Loader CategoryWorkbooks in the Category
    APM Connect Equipment and Functional Location, Tag to Asset Relationship, APM Family, Taxonomy, Work History
    APM Failure Elimination Production Loss Analysis (PLA), Root Cause Analysis (RCA)
    APM Foundation

    Geographic Information System (GIS), Custom Asset Hierarchy, Role, Asset Criticality Analysis (ACA), Policy Instance Data Loader

    APM Health Rounds Allowable Values, Rounds Readings, Rounds Routes, Rounds Templates
    APM Mechanical Integrity Inspection Management (IM) Assets, Inspection Management (IM) Functional Location, Risk Based Inspection (RBI) 580, Risk Based Inspection (RBI) 581, Risk Based Inspection (RBI) Corrosion Loop, RBI Components To TML Groups Relationship, Thickness Monitoring (TM) Equipment, Thickness Monitoring (TM) Functional Location
    APM Power Generation

    Generation Availability Analysis (GAA) Amplification Codes, Generation Availability Analysis (GAA) Cause Codes

    APM Safety Calibration, Hazards
    APM Strategy Asset Strategy Management (ASM), Asset Strategy Management (ASM) Templates, Failure Modes and Effects Analysis (FMEA), FMEA Analysis Template, FMEA Asset Template, Reliability Centered Maintenance (RCM)
  4. In the Select a File for importing box, select Choose File, and then navigate to and select the file that you want to import.
  5. In the Job Description box, enter a short description of the job.
  6. Select Import.
    The job is run, and the status of the job appears in the Status and Log column.
    Tip: If necessary, you can cancel an import job by selecting the button that appears in the Status and Log column. If you cancel a job, any changes that have already occurred are not removed, therefore, you may need to manually modify records to update or remove unwanted data.
    StatusDescription
    WaitingInitial state when job is created. The data import job is queued for pre-processing on the APM Connect Server.
    Staging In ProgressThe data import job is being prepared on the APM Connect Server.
    Staging FailureThe data import job failed during preparation.
    Staging CompleteThe data import job was prepared successfully.
    Dataloader Enqueued The maximum number of data load jobs has been exceeded, as determined in the APM Connect Connection Records, or there is a job of the same type running. The data import will begin once the other jobs are complete.
    Configuring DataloaderThe data import job is configuring the proper user roles and arranging data processing for most efficient execution flow.
    In ProgressThe data import job is loading data into the GE Digital APM Data Source.
    Data Synchronization in ProgressThe data import job is synchronizing the loaded data and relationships across the APM Data Source.
    Job CancellingThe data import job is in the process of being cancelled. This occurs after you select .
    Cancelled by UserThe data import job was cancelled successfully.
    Note: When a job is cancelled, the data imported prior to cancelling is not removed.
    ErrorsThe data import is complete, but encountered one or more errors. You can download the log file to view detailed error messages.
    CompleteData has been imported into GE Digital APM.
    Note: If the icon appears, the data was imported with warnings. You can download the log file to view detailed warning messages.

Access the Details of an Import Job

Before You Begin

This topic assumes that you have successfully run a data import job.

Procedure

  1. Access the Data Loaders page.
  2. In the Job ID column, select the job that you want to open.
    On a new page, the datasheet for the selected job appears.

  3. To view the information contained in the Log Text, select .
    The Text Editor window appears, displaying details about the job, such as error messages, warnings concerning the data load and general information regarding the data records that were loaded.

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

  1. On the data worksheet, add a column that contains MI_SITE_NAME in the column name.
    For example if you are working with a relationship, where a distinction needs to be made regarding which family is associated with each column, then the column name will be prefaced with the Family ID. As shown in the following image, the column name might take the form MI_EQUIP000|MI_SITE_NAME, where MI_EQUIP000 is the Family ID.
  2. Enter the site name to designate the site by which the asset record, once loaded into GE Digital APM, will be filtered.
  3. Continue populating the source workbook, and then run the data loader.

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.