APM Connect Data Bundle Status

About APM Connect Data Bundle Status

The APM Connect Data Bundles Status page contains detailed information about the data loader jobs importing status and general information such as job description, process activity, Bundle type, Bundle ID, job creation date, and imported file name. The status page displays the error messages, warnings in the records that were loaded. You can select an individual job to display the detailed status log view page. This page also provides information about the status of the Data Loader jobs that have been run by the APM Connect Data Loader feature.

Access the Data Loaders V2 Page

Procedure

In the module navigation menu, select Tools > Data Loaders - V2.

The Data Bundles Status page appears, displaying information about the data import jobs. Each data import job is considered as a Bundle and the status of all the data import jobs in the last 48 hours appears on the page. You can use the drop-down option to change the time range filter from 48 hours to another time range. Alternatively, you can use the Custom Date Range option to specify a custom range. The default frequency of refreshing the page is 10mins. You can use the drop-down option to change the frequency of refreshing the page (Off, 30 sec, 1 min, 5 min and 10 min). Also, you can manually refresh the page using the Refresh option. The default Data Bundles origin is selected as All Origins. You can change the origin of the Data Bundle from the drop-down option.

Download the Data Loader Workbooks

Procedure

  1. Access the Data Loaders V2 page.
    The Data Bundles Status page appears.
  2. Select Data Loaders.
    The Data Loaders window appears.
    Note: By default, the data loader type Unified Asset Ingestion is selected.
  3. In the DOWNLOAD TEMPLATE section, select one of the following options:
    • Default Template: Select to download the available template.
    • Generate Template: Select to create a customized template. Select to download one of the following type of templates,
      • Construct Hierarchy: You can construct a hierarchy by creating a relationship between the Enterprise/Site/Segment/Asset by appropriate selections.
      • Update/Add Asset only: You can update the existing template data by selecting the required the Asset type.
      and then enter information in the available fields.
  4. Select Download Template.

Results

The data loader template is downloaded. The downloaded template, can be populated with data to load into Predix Essentials.

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 the Excel workbook templates.

Procedure

  1. Access the Data Loaders V2 page.
    The Data Bundles Status page appears.
  2. Select Data Loaders.
    The Data Loaders window appears.
  3. In the UPLOAD DATA section, select Select file, and then navigate to and select the file that you want to import. Alternatively, you can also select the file that you want to import and drag and drop the file in the UPLOAD DATA section.
  4. In the Description box, enter a short description of the job.
  5. Select Upload.
    The job is run, and the status of the job appears in the Data Bundles Status page.

Results

The selected file is uploaded into Predix Essentials.

Log Statuses

The Status column in the Data Bundles Status page displays the status of the various Data Loader jobs that are run in the Predix Essentials system. The following table contains the list of available statuses with description.

StatusDescription
CompleteThe data has been imported successfully into Predix Essentials.
Complete with RejectsThe data was imported with warning i.e., some records are rejected. You can select the rejected record to view the detailed warning messages.
FailureThe data import job failed with system errors. You can select an individual job to view the details of the system error.
In ProgressThe data import job is loading data into the Predix Essentials Data Source.
In Progress with RejectsThe data import job is loading data into the Predix Essentials Data Source with warnings i.e., some records are rejected. You can select the rejected record to view the detailed warning messages.

Process Activity Stages

The Process Activity column in the Data Bundles Status page displays the process state management of the various Data Loader jobs that are running or have run in the Predix Essentials system.

There are three different high-level Process activity stages:
  • Prepare: Preparing stage involves Registering, Collecting, Transforming and Transmitting states
  • Process: Process stage involves Normalizing, Compiling and Slicing states
  • Ingest: Ingest stage involves Ingesting, Synchronizing and Notifying states

The following table contains the list of available stages and status mapping with description:

Process StageStatusDescription
Prepare – TransmittingIn Progress / FailureThe data upload job status is in either In Progress or Failure and the process activity is in Transmitting state of Prepare stage.
Process – NormalizeIn Progress / FailureThe data upload job status is in either In Progress or Failure and the process activity is in Normalizing state of Process stage.
Process – CompilingIn Progress / FailureThe data upload job status is in either In Progress or Failure and the process activity is in Compiling state of Process stage.
Process – SlicingIn Progress / FailureThe data upload job status is in either In Progress or Failure and the process activity is in Compiling state of Slicing stage.
Ingest – IngestingIn Progress / In Progress with Rejects / FailureThe data upload job status is in either In Progress or In Progress with Rejects or Failure and the process activity is in Ingesting state of Ingest stage.
Ingest – SynchronizingIn Progress / In Progress with Rejects / Failure / Complete with Rejects / CompleteThe data upload job status is in either In Progress or In Progress with Rejects or Failure and the process activity is in Synchronizing state of Ingest stage.
DoneComplete with Rejects / CompleteThe data upload job status is in either Complete or Complete with Rejects and all process activities are Done state.

Access the Data Bundle Execution Details of an Import Job

Before You Begin

This topic assumes that you have successfully ingested the Data Bundle Execution.

Procedure

  1. Access the Data Loaders V2 page.
    The Data Bundles Status page appears.
  2. In the Data Bundles Status page, select the job for which you want to access the details.
    The Data bundle execution details page appears, displaying the detailed information of the job.

Results

The Data Bundle Execution details of the job is displayed with the status and progress of the imported data. You can export the data of the rejected rows during the import job to view the details of the errors occurred, if any.

Data Bundles Status Records

Data Bundles Status records store details about the imported data details for different modules. This topic provides a list and description of the fields that exist for the Data Bundles family. The information in the table reflects the baseline state and behavior of these fields. This list is not comprehensive.

FieldData TypeDescriptionBehavior and Usage
BUNDLE IDAlphanumericThe Job ID of the Integration Log Record.The Bundle ID is auto-generated with the Data Loader that was selected.
BUNDLE TYPECharacterThe type of the APM Connect Job related to the data record.This is auto-generated based on the type of the Data loader that was selected.
CREATED DATENumericThe date and time at which the Integration job was started.None
DESCRIPTIONCharacterThe text that was entered in the Job Description box by the user when importing the data job.None
EXPIRY DATENumericThe date and time at which the integration job will expire.None
FILE NAMECharacterThe name of the datasheet file that is uploaded.The name given for the file while uploading a data workbook.
ORIGINCharacter

This indicates the process that initiated the Data ingestion.

Following are the different Origin types you can select:
  • User
  • Automated Dataloader
  • EAM Integration
  • Simple Ingestion
PROCESS ACTIVITYCharacter

Displays the data processing stage of the import job.

The three different Process activity stages are Prepare, Process, and Ingest.

Below are the sub stages for each stage:
  • Prepare – Registering, Collecting, Transforming, and Transmitting
  • Process – Normalizing, Compiling, and Slicing
  • Ingest – Ingesting, Synchronizing, and Notifying
STATUSCharacter

Displays the status of the importing job.

You can select an import job to view a detailed status log. The appropriate indicators appear against each status based on the progress of the import:
  • Gray: In process
  • Red: Failure
  • Yellow: Completed with Rejects
  • Green: Completed
Note: The status log view contains the detailed information about the job such as Process Stage, Processed Records, System Errors, details of the System Errors, Rejected Rows, Event Timeline concerning the data load, and general information about the records that were loaded.
USERCharacter

The name of the user who initiated the import job in the Predix Essentials.

None

Details of the Data Bundle Execution

When you select a job in the Data Bundles Status page, the data import details page appears displaying the detailed import status and the progress of the selected data import job.

The Data Bundle Execution Details page displays the following sections:

Worksheet FieldDescription
Overall Job Status

The section displays the overall details of the job such as Asset name, Status, File name, Start Time, End Time, Bundle ID, and Progress Bar that displays the Process Stage.

Summary of the Records Processed

The section displays the summary of the processed records (# of Insert, Delete, Update, Reject and Total Records) in a donut chart. It also displays the System Errors in the job processing, if any.

System Errors

The section displays the System errors occurred during processing of the job.

Rejected Rows

The section displays all the records that are rejected while processing the job. The details include Sheet Name, Row #, Primary Record Id, Slice ID, Error Code, Message, Timestamp, Data. Select a record to view the full data of the record. You can download the Rejected record data into an .xlsx file using the Export Current Page option available in the Rejected Rows section.

Event TimelineThe section displays the process activity event timelines. The details include Timestamp, Process state of Step, Status, Message (displays system errors, if any).
Refresh

You can use the Refresh option for setting the frequency of refreshing the page (Off, 30 sec, 1 min, 5 min and 10 min). Also, you can manually refresh the page.

Export the Rejected Data Details of an Import Job

Procedure

  1. Access the Data Bundle Execution Details of an Import Job.
  2. In the Rejected Rows section, select and then select Export Current Page to download the details of the rejected data during the import job.

Results

The details of the rejected data in the Data Bundle Execution job is exported.

Download Template Records

Download Template records store details about the template classification fields. This topic provides a list and description of the fields that exist for the download template classification. The information in the table reflects the baseline state and behavior of these fields. This list is not comprehensive.

FieldData TypeDescriptionBehavior and Usage
Construct HierarchyButton

You can select this option construct a hierarchy by creating a connection between the Enterprise/Site/Segment/Asset.

You can construct a hierarchy by creating a relationship between the Enterprise/Site/Segment/Asset by appropriate selections.

RelationshipsNumericThis indicates the number of relationships created.The value is auto-generated based on the selections.
SELECT ASSET CLASSIFICATIONAlphanumericThis field displays the list of classifications/type of the Assets. Select the required Asset classification from the drop-down list.You can select one or many Asset classifications/types from the drop-down list.
SELECT ENTERPRISE CLASSIFICATIONCharacterThis field displays the list of classifications of the Enterprise. Select the required Asset classification from the drop-down list.You can select one or many Enterprise classifications/types from the drop-down list.
SELECT SEGMENT CLASSIFICATIONCharacterThis field displays the list of classifications of the Segment. Select the required Asset classification from the drop-down list.You can select one or many Segment classifications/types from the drop-down list.
SELECT SITE CLASSIFICATIONNumericThis field displays the list of classifications of the Site. Select the required Asset classification from the drop-down list.You can select one or many Site classifications/types from the drop-down list.
Update/Add Asset onlyButton

You can select this option to update the existing template data by selecting the required the Asset type.

None