Skip to main content

Epicor Kinetic Integration Guide

Connect Epicor Kinetic to MachineMetrics for bidirectional work order and labor tracking synchronization.


Overview

The MachineMetrics and Epicor Kinetic integration enables seamless data flow between your ERP system and the shop floor, providing real-time visibility and eliminating manual data entry.

Integration Type

AttributeValue
DirectionBidirectional
Data Flow (Inbound)Work orders from Epicor → MachineMetrics
Data Flow (Outbound)Labor tickets from MachineMetrics → Epicor
Runs OnMachineMetrics Edge Device (physical or virtual)

How It Works

1. Management — Work Order Transmission

Active work orders are automatically transmitted from Epicor Kinetic to MachineMetrics. This seamless transfer ensures that the latest work orders are always available for operators in real-time.

2. Tracking — Labor and Progress Reporting

As operators work on the transmitted orders within MachineMetrics, their labor inputs:

  • Generate labor tickets
  • Update the progress of work orders
  • Maintain accurate records in real-time

3. Synchronization — Real-Time Updates

The generated labor tickets and any updates to work orders are synchronized back with Epicor. This ensures that all recorded data reflects the most current state of production activities.

4. Scheduling — Dynamic Visibility

Shop floor managers and production planners gain instant visibility into:

  • Status of work in progress
  • Whether production is on schedule
  • If adjustments are needed

Schedule changes are immediately communicated to operators, enabling them to adjust their workflow accordingly.


Requirements

Prerequisites

RequirementDetails
MachineMetrics EdgePhysical or Virtual Edge Device
Network AccessEdge device must have firewall access to Epicor's on-prem or cloud environment/APIs. See Network Requirements Guide for Edge connectivity requirements.
Epicor User AccountDedicated user account with access to necessary tables/columns
BAQ AccessBusiness Activity Query for Part Operations
API KeyGenerated in Epicor for MachineMetrics

Step-by-Step Setup Guide

Step 1: Create a MachineMetrics Dedicated User in Epicor

Create a user for the integration with access to the following entities:

Erp.BO.BomSearchSvc/GetDatasetForTreeWithPartValidation
Erp.BO.ResourceGroupSvc/Resources
Erp.BO.CapabilitySvc/Capabilities
Erp.BO.ResourceGroupSvc/ResourceGroups
Erp.BO.JobEntrySvc/JobEntries
Erp.BO.JobEntrySvc/GetDatasetForTree
Erp.BO.EmployeeSvc/Employees
Erp.BO.LaborSvc/LaborDtls

Step 2: Create a BAQ (Business Activity Query)

This BAQ allows MachineMetrics access to your Part Operation table, which may not be available via API in some versions of Kinetic.

Required BAQ Columns:

ColumnDescription
PartOpr_CompanyCompany identifier
PartOpr_PartNumPart number
PartOpr_RevisionNumRevision number
PartOpr_OprSeqOperation sequence
PartOpr_OpStdIDOperation standard ID
PartOpr_OpCodeOperation code
PartOpr_ProdStandardProduction standard
PartOpr_MachinesNumber of machines
PartOpr_QtyPerQuantity per
PartOpr_OpsPerPartOperations per part
PartOpr_StdFormatStandard format
PartOpr_StdBasisStandard basis
PartOpr_OpDescOperation description
PartOpr_AddlSetupHoursAdditional setup hours
PartOpr_RunQtyRun quantity
PartOpr_AltMethodAlternate method

Example BAQ SQL:

select
[PartOpr].[Company] as [PartOpr_Company],
[PartOpr].[PartNum] as [PartOpr_PartNum],
[PartOpr].[RevisionNum] as [PartOpr_RevisionNum],
[PartOpr].[OprSeq] as [PartOpr_OprSeq],
[PartOpr].[OpStdID] as [PartOpr_OpStdID],
[PartOpr].[OpCode] as [PartOpr_OpCode],
[PartOpr].[ProdStandard] as [PartOpr_ProdStandard],
[PartOpr].[Machines] as [PartOpr_Machines],
[PartOpr].[QtyPer] as [PartOpr_QtyPer],
[PartOpr].[OpsPerPart] as [PartOpr_OpsPerPart],
[PartOpr].[StdFormat] as [PartOpr_StdFormat],
[PartOpr].[StdBasis] as [PartOpr_StdBasis],
[PartOpr].[OpDesc] as [PartOpr_OpDesc],
[PartOpr].[AddlSetupHours] as [PartOpr_AddlSetupHours],
[PartOpr].[RunQty] as [PartOpr_RunQty],
[PartOpr].[AltMethod] as [PartOpr_AltMethod]
from Erp.PartOpr as PartOpr
where [PartOpr].[PartNum] = PartOpr.PartNum

Reference: Follow Epicor's instructional video on deploying BAQ reports: Deploy BAQ Reports as Kinetic Applications

Step 3: Create an API Key in Epicor

  1. Using the general search, search and select "API Key maintenance"
  2. Select Create a new Key ID:
    • Name: MachineMetrics
    • Description: MachineMetrics integration
    • Expiration Date: Set to a distant future date (can be changed later)
  3. Save the new key
  4. Copy and securely store the API key — you'll only see it once
  5. Open Access Scope settings
  6. Create a new Access Scope:
    • ID: MachineMetrics
    • Check the Active box
  7. Under Services, add these services and methods:
    Erp.BO.BomSearchSvc/GetDatasetForTreeWithPartValidation
    Erp.BO.ResourceGroupSvc/Resources
    Erp.BO.CapabilitySvc/Capabilities
    Erp.BO.ResourceGroupSvc/ResourceGroups
    Erp.BO.JobEntrySvc/JobEntries
    Erp.BO.JobEntrySvc/GetDatasetForTree
    Erp.BO.EmployeeSvc/Employees
    Erp.BO.LaborSvc/LaborDtls
  8. Under BAQs, grant access to the BAQ created in Step 2
  9. Save the Access Scope
  10. Apply the scope to the "MachineMetrics" API Key

Step 4: Provide MachineMetrics with the API Token

Share the following information securely with your MachineMetrics implementation team:

  • API Key
  • Epicor server URL/endpoint
  • Company ID
  • BAQ name

Security Tip: Use a secure method like Snappass or your company's secure file sharing to transmit credentials.


After Setup

Once the integration is configured:

  1. Work orders will appear in MachineMetrics automatically
  2. Operators select jobs on their tablets
  3. Labor data syncs back to Epicor in real-time
  4. Production Schedule Intelligence shows accurate job status

Verifying the Integration

  1. Go to ProductionSchedule in MachineMetrics
  2. Confirm work orders from Epicor are visible
  3. Have an operator start a job on a tablet
  4. Verify the labor ticket appears in Epicor

Troubleshooting

IssuePossible CauseSolution
Work orders not appearingAPI key expired or invalidRegenerate API key in Epicor
Missing operationsBAQ not configured correctlyVerify BAQ includes all required columns
Labor not syncing backUser permissions insufficientCheck MachineMetrics user has write access
Connection errorsFirewall blocking EdgeEnsure Edge can reach Epicor API endpoint


Getting Help

  • Setup Assistance: Contact your MachineMetrics Solution Delivery Manager (SDM)
  • Technical Issues: Email support@machinemetrics.com
  • Epicor Configuration: Consult your Epicor administrator or partner