Skip to main content

ERP Discovery Checklist

The generic-erp-connector template is transport-agnostic. It does not know your BAQs, REST resources, table names, labor rules, or whether ShopPulse events should write back to the ERP. Use this checklist to gather and maintain ERP references and connector requirements for yourself or an AI assistant.

Discovery can start before Scaffold/Deploy, and continue through Implementation Patterns. See the latter for integration direction; align with your MachineMetrics contact when scope is unclear.

You do not need every item on day one—revisit after scaffold and after each deploy.

Integration direction​

  • ERP-driven vs ShopPulse-driven (or hybrid) — see Implementation Patterns; confirm with MM when unsure
  • Which MachineMetrics entities are in scope for v1 (jobs, operations, labor, etc.)

ERP technical access​

  • API or database documentation (OpenAPI/Swagger, vendor guides, BAQ/query definitions)
  • Base URLs, environments (sandbox vs production), and how you reach them (VPN, firewall rules, allowlists)
  • Authentication model (OAuth, API keys, SQL login, etc.) and where secrets are stored
  • Sample requests/responses or query result shapes (redacted if needed)

Business and process context​

  • How the shop uses the ERP on the floor (what is source of truth vs what MM should mirror)
  • Rules that are not in API docs (status codes, custom fields, plant-specific behavior)

Evidence to attach for AI-assisted work​

  • Links or exports of internal wiki/Confluence pages you are allowed to share
  • Pasted schema fragments, field lists, or in-repo requirement notes your team uses
  • Explicit “unknowns” and open questions so the assistant does not guess

Keep ERP references and connector requirements next to your implementation work.