Documentation
This page expands the Documentation path from the Overview. It lists each document in the connector documentation chain and what it covers.
1. README.md (project root)
Summary: Orientation for your connector repo—prerequisites, local development commands, and pointers to deeper guides in the same repository.
Path: <your-connector-repo>/README.md
2. CONNECTOR-GUIDE.md (project root)
Summary: Step-by-step implementation workflow for your generated project—configuration, sync patterns, and how to use SDK utilities in context. This is the intermediary guide between this knowledge-base section and the SDK reference.
Path: <your-connector-repo>/CONNECTOR-GUIDE.md
3. CONNECTOR_SDK_UTILITIES.md (SDK package)
Summary: Canonical reference for SDK helper classes, sync utilities, logging, and connector runtime APIs shipped with @machinemetrics/mm-erp-sdk.
Path after npm install: node_modules/@machinemetrics/mm-erp-sdk/CONNECTOR_SDK_UTILITIES.md
Source repository: machinemetrics/mm-erp-sdk (requires MachineMetrics GitHub org access)
4. MM_ENTITY_KEYS_REFERENCE.md (SDK package)
Summary: Canonical entity key definitions and field mappings used when transforming ERP data into MachineMetrics entities.
Path after npm install: node_modules/@machinemetrics/mm-erp-sdk/MM_ENTITY_KEYS_REFERENCE.md
Source repository: machinemetrics/mm-erp-sdk (requires MachineMetrics GitHub org access)
Reference implementation
For a complete example of a connector, see machinemetrics/epicor-ten-connector on GitHub. It uses SQL-based integration with transparent in-repo operations. Caveat: labor-ticket writes to Epicor require knowing table and update expectations—API-based ERPs often hide this complexity. This repo is a reference, not the scaffold template for new work (generic-erp-connector is).
Requires MachineMetrics GitHub org access. For an archive or walkthrough, contact your MachineMetrics contact or use the delegated scaffold fallback.