Guide · technical

Scoping an integration

Guides

Define sources, identifiers, mappings, schedules, permitted delivery and failure handling for one useful workflow.

An integration supplies information or a permitted operation needed by a HEPO application. Start with one workflow or reading and specify the connection it needs. Existing systems retain their agreed record ownership; HEPO maintains the records and execution context assigned to it.

A supported connection may be configurable. A new adapter or business operation may require development. Establish which case applies before treating integration as a settings exercise.

Specify the connection

Decision What to write down
Purpose and source The application, external system and authoritative owner
Authentication Credential owner, permitted operations and renewal arrangements
Scope Records, identifiers, fields, granularity and relevant restrictions
Mapping Field meaning, formats, transformations and reconciliation rules
Rhythm Supported schedule or event trigger and its freshness implications
Operation Read-only intake or a separately authorised outbound path
Delivery account Available attempts, results, errors and confirmed outcomes

Transactions, customer or product records, organisational structure and other source data may contribute. Include only what the defined application needs and the selected adapter supports.

Distinguish three kinds of record

The external system holds the records assigned to it. HEPO may receive agreed information and create its own working records, readings, recommendations, decisions and execution context. An outbound operation changes or delivers something externally only when the adapter and authority explicitly permit it.

Writing a recommendation in HEPO is not automatically writing that recommendation into the ERP. Conversely, supported writeback is not limited by a blanket statement that all connectors are read-only. Name the actual operation and its owner.

Walk the first connection

  1. Select one source and a representative record for the intended use.
  2. Establish supported authentication, pagination and rate-limit handling.
  3. Map fields and identifiers; inspect transformed values and missing fields.
  4. Set a supported schedule or trigger and define what freshness means.
  5. Run the permitted operation and inspect the available delivery record.
  6. Follow the imported or changed context into the HEPO work that uses it.

A fast schedule does not prove that all source data is current. An attempt does not prove receipt. A failed operation needs a defined owner and next step.

Examine failure before expanding scope

Include an unavailable source, invalid credentials, an unmapped value and a duplicate or repeated attempt where relevant. Establish retry, idempotence and reconciliation behaviour for the actual path. Verify outbound authority separately from the business user's approval.

A useful provenance account lets a reviewer follow the value to its source, mapping and available delivery context. Inspect actual coverage rather than assuming every record has the same history.

Hand over the connection

Agree who maintains the adapter, credentials, mappings, schedule and error response. Record how source changes will be detected and how the business owner will know when a reading or workflow has incomplete inputs.

System Data Integration explains the shared capability. The Process example follows an exchange through a quotation decision. Deployment topology establishes the operating boundary.

Documentation