Skip to main content

Epicor Kinetic Integration Guide

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

SectionDescription
OverviewIntegration type and data flow summary
How It WorksEnd-to-end data flow explanation
RequirementsPrerequisites before setup
Step-by-Step Setup GuideUser, API key, access scope, and credential sharing
After SetupVerification steps
TroubleshootingCommon issues and solutions

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 redundant or estimated manual data entry. By linking MachineMetrics' real-time machine data with your ERP's business insights, you gain a comprehensive view of your shop floor activities — and you can manage most of the configuration directly within the MachineMetrics application.

Integration Type

AttributeValue
DirectionBidirectional
Data Flow (Inbound)Work orders from Epicor → MachineMetrics
Data Flow (Outbound)Labor tickets and work order updates from MachineMetrics → Epicor
Runs OnMachineMetrics Edge Device (physical or Virtual Edge)
note

This connector is under active development. Some features may change, and certain capabilities may not be available at the time of reading.


How It Works

The ERP connector runs as a service on your Edge Device (or Virtual Edge), optimizing data flow and facilitating smooth two-way communication between your ERP system and MachineMetrics.

Work Order Tracking

Active work orders are transferred from Epicor to MachineMetrics, keeping operators updated with the latest orders and enhancing operational efficiency.

Labor Tracking

Operators' labor inputs on orders in MachineMetrics generate labor tickets and update progress in real time, providing accurate records and valuable insights for transparency and efficiency.

Data Synchronization

Labor tickets and work order updates sync back with Epicor, reflecting the current production status. This ensures accurate, up-to-date ERP data.

Improved Reporting & Productivity

Operators can efficiently report completed work and adapt to schedule changes, boosting productivity and creating a more agile production environment.


Requirements

Before starting the connection process, ensure that:

RequirementDetails
MachineMetrics EdgeA physical or Virtual Edge Device to run the connector service.
Network AccessThe Edge device must have network and firewall access to Epicor's on-premise or cloud environment APIs. See the Network Requirements Guide for Edge connectivity requirements.
Epicor PermissionsYou must have the permissions required to create users and API keys in your Epicor environment.

Step-by-Step Setup Guide

Setup is performed entirely within Epicor Kinetic and consists of six steps: create a dedicated user, create an API key, create an access scope, configure the scope's services, apply the scope to the key, and securely share the credentials with MachineMetrics.

Step 1: Create User

  1. Navigate to User Account Maintenance.
  2. Select the + (plus-circle) button to create a new user.
  3. Enter a unique User ID (for example, machinemetrics).
  4. Enter a unique Name (for example, MachineMetrics).
  5. Fill out any additional required fields and save your changes.
tip

Set a password for this user account. You will share the username and password securely with MachineMetrics in Step 6.

Step 2: Create API Key

  1. Open the Epicor menu, search for API Key Maintenance, and select it.
  2. Select the + (plus-circle) button to create a new key.
  3. In the Key ID field, enter MachineMetrics.
  4. In the Description field, enter a helpful description (for example, MachineMetrics Connection).
  5. In the Expire Date field, select a date in the distant future (this can be adjusted later if needed).
  6. Select the Save button to save the new key, and be sure to copy the key to a safe location for future use — you will only see it once.

Step 3: Create Access Scope

  1. Open the Epicor menu, search for Access Scope, and select it.
  2. Select the + (plus-circle) button to create a new scope.
  3. In the Access Scope ID field, enter MachineMetrics.
  4. In the Description field, enter a helpful description (for example, MachineMetrics Connection).
  5. Make sure the Active check box is checked.

Step 4: Configure Access Scope Services

  1. Navigate to Services.
  2. Locate and select the desired service.
  3. Verify that all required methods listed below are enabled for the selected service.
  4. Click Save to apply changes.
  5. Repeat the process for each required service and its associated methods.

Required services and methods:

Erp.BO.CapabilitySvc/Capabilities
GetRows

Erp.BO.EmpBasicSvc/EmpBasics
GetRows
ClockIn
ClockOut

Erp.BO.JobEntrySvc/GetDatasetForTree
GetRows

Erp.BO.JobEntrySvc/JobEntries
GetRows

Erp.BO.LaborSvc/LaborDtls
GetRows

Erp.BO.LaborSvc/Labors
GetRows
StartActivity
CheckWarning
Update
EndActivityByEmp
recallFromApprovalBySelected
updateLaborDtl
submitForApproval

Erp.BO.ReasonSvc/Reasons
GetRows

Erp.BO.ResourceGroupSvc/ResourceGroups
GetRows

Erp.BO.ResourceGroupSvc/Resources
GetRows

Erp.BO.ResourceSvc/Resources
GetRows

Step 5: Apply Scope to API Key

  1. Open the API Key named MachineMetrics.
  2. Apply the newly created MachineMetrics scope onto the key.
  3. Select the Save button to save your changes.

Step 6: Share Your API Key

  1. Visit the MachineMetrics secure link sharing service at https://snappass.service.machinemetrics.com.
  2. Paste in the following values from your Epicor environment:
    • Key (the API key created in Step 2)
    • Owning Company
    • Username and password for the MachineMetrics user account
    • API URL
  3. Click Generate URL.
  4. Copy the generated URL and email it to your MachineMetrics representative.

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 Production → Schedule 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 invalidVerify the API key is valid and not expired; regenerate in API Key Maintenance if needed
Service calls failingAccess scope missing a required service or methodConfirm all services and methods in Step 4 are enabled on the MachineMetrics scope
Scope not taking effectAccess scope not applied to the API key, or scope not marked ActiveRe-apply the MachineMetrics scope to the key (Step 5) and confirm the Active box is checked
Labor not syncing backMissing labor methods or insufficient user permissionsEnsure Erp.BO.LaborSvc/Labors methods (StartActivity, Update, EndActivityByEmp, etc.) are enabled on the scope
Connection errorsFirewall blocking the Edge deviceEnsure the Edge can reach the 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