Epicor Kinetic Integration and EDI Designer

How to use it

1. 1

   Pick the objects

   Select the business objects in scope, such as customers, parts, sales orders and shipments.

2. 2

   Add the target systems

   For each object choose the system on the other side, the direction seen from Kinetic and how often it must move.

3. 3

   Read the inventory

   Each row names the Kinetic interface (BO service, BAQ, Epicor Function or EDI document), why it fits and what to watch for.

4. 4

   Check the field map

   Open the starter map for an object, fill in the target field names and note the keys and required fields.

5. 5

   Export or save

   Download the design as PDF, Excel, Word or CSV, save it to your account, or send it to an engineer for review.

Kinetic interfaces in this tool

REST API v2 (OData v4 BO services) synchronous

Business object services under /api/v2/odata/{Company}/, for example Erp.BO.SalesOrderSvc/SalesOrders, Erp.BO.CustomerSvc/Customers and Erp.BO.PartSvc/Parts, plus custom methods such as GetNewOrderHed and MasterUpdate. Each call needs an API key (x-api-key header) and a user (Basic auth or a bearer token from TokenResource.svc); BPM and security rules run on every call.

REST API v1 (legacy paths) synchronous

The earlier REST surface at /api/v1/Erp.BO.{Service}/{EntitySet}, without the company segment in the path. Still found in existing integrations; new builds normally use v2 with API keys and access scopes.

BAQs through BaqSvc synchronous

A Business Activity Query is a governed SQL view built in the BAQ Designer and read at /api/v2/odata/{Company}/BaqSvc/{BAQID}/Data with OData $filter, $select and $top. Use it for outbound reads and change polling; an updatable BAQ (uBAQ) can also write through its update processing.

Epicor Functions over REST synchronous

Server-side C# or widget logic in a function library, published and called at /api/v2/efx/{Company}/{Library}/{Function} (unpromoted libraries run under /api/v2/efx/staging/; verify the path for your release). Wrap multi-step BO calls (order, lines, releases) in one function so the caller sends one request.

BPM directives (outbound triggers) asynchronous

Method and data directives run when a BO method executes or a table row changes. Call an Epicor Function or post to a queue from a directive to push a change out; keep external HTTP calls short or outside the transaction so a slow target does not block the user.

Epicor EDI with Demand Management asynchronous

Inbound partner documents are translated by Epicor EDI (formerly 1 EDI Source; HQXchange, ManagedXchange or AtlasExchange) or another translator, imported into the DemandHeadImport, DemandDetailImport and DemandScheduleImport staging tables, and processed through Demand Entry, Demand Workbench and Demand Mass Review into sales orders. Outbound documents are produced from shipments, invoices and orders flagged for EDI.

Data Management Tool (DMT) asynchronous

Epicor's bulk load tool: CSV or Excel templates (for example Sales > Price List > Price List Part) are loaded through the same business objects with Add and Update options. Suits migrations and scheduled bulk updates, not transactional interfaces.

Epicor Automation Studio or Integration Cloud asynchronous

Epicor Automation Studio (Workato) runs recipes against Kinetic REST and BAQs and connects to 1,000+ external apps; Epicor Integration Cloud (Jitterbit) targets orchestration with CRM, ecommerce and HR systems and ITAR-sensitive deployments. Any third-party iPaaS that speaks REST and OData can use the same APIs.

Read-only SQL (on-premises) asynchronous

On-premises only: read the Erp and Ice schemas or a replica for reporting extracts. Never write to tables; direct updates bypass BO validation, BPM and the change log. Epicor cloud tenants generally have no direct SQL access; use BAQs or Epicor Data Analytics (verify for your hosting arrangement).

Questions