Glossary of key terms
Plain-English definitions of the terms used in HighCohesion, the Control Panel, and in communications with the HC team.
This glossary defines the terms you will meet in the Control Panel and in communications with the HC team, grouped into integration terms, Control Panel terms and event status terms.
Integration terms
Stream: a configured data flow between two systems. Each stream has one source and one destination, and moves one type of data (for example orders, inventory updates or fulfilment confirmations). Your full integration is made up of multiple streams.
Event: a single unit of data passing through a stream: one order, one stock update, one return. Events are tracked individually from receipt to delivery.
Job: a single run of a stream. Each execution (scheduled, webhook-triggered or manual) creates a job, and a job creates between zero and many events depending on what data it finds in the source system.
Entity: HC's tracking record for a specific piece of data (an order, customer or SKU), storing its identifier in both the source and destination systems. Entities are how HC deduplicates, ensuring the same record is not created twice.
Key: the stored credentials HC uses to access one of your systems, such as a Shopify token or an FTP login. Managed under Keys in the Control Panel.
Trigger: the logic and schedule defining when a source or destination runs: manually, on a schedule, or in real time via webhook.
Source: the system that originates an event. For example, Shopify is the source when an order is placed.
Destination: the system that receives the processed event. For example, NetSuite is the destination when a sales order is created.
Transformation: logic applied to an event in transit: field mapping, value conversion, enrichment, filtering or conditional routing. A transformation belongs to your organisation and is visible only to your organisation. HC sets it up during delivery; after that, Owners can create and edit transformations in the Control Panel, and HC can make changes on request.
Issue: an event that failed to process. Exceptions are logged in the Control Panel and can be retried or corrected. Also referred to as a failed event.
Occurrence: a single instance of an issue happening. An issue groups repeated occurrences of the same underlying error.
Stream version: a numbered snapshot of a stream's configuration. Allows changes to be tracked and rolled back if needed.
Functions: HighCohesion's internal functions: the HighCohesion library used to extract data from source systems and send data to destination systems.
Queue: your integrations run in isolation.
Hypercare: the period immediately after your integration goes live, during which the HC team monitors your integrations closely and responds quickly to any issues.
Control Panel terms
Control Panel: HighCohesion's web interface. You use it to monitor integrations, inspect events, fix failures, and manage alerts and users.
Event payload: the data contained in an event: the full set of fields and values, as received from the source and as sent to the destination.
Payload in / payload out: the event's data before transformation (as pulled from the source system) and after transformation (as sent to the destination system). You will see both when inspecting an event.
Aggregation / parent event: for file-based destinations, HC can batch multiple events into one file. The event created for each batch is called a parent event and appears in the Control Panel like any other event.
Bulk resend: a request for HC to reprocess a large batch of failed events at once, typically after a root cause has been fixed.
Event status terms
New: the event has been created and is waiting to be transformed.
Transformed: the payload in has been transformed into the payload out. The event has not yet been sent to the destination system.
Ok: the event data was sent to the destination system successfully.
Error: the transformation failed to transform the payload in. The error detail is visible in the event.
Failed: the event data failed to be sent to the destination system. The error detail is visible in the event.
Aborted: the transformation detected a rule that stopped the event being sent. Most often this is duplicate prevention: the data has already reached the destination system, so HC aborts the event rather than sending it twice.
Note. If a term you have met is not listed here, ask the HC team; see How to get support.
Related
Was this helpful?
Still need help? Ask the team