Words used in this course

Lesson 25 of 25 4 min read

A reference glossary for maps, profiles, overlays and the rest of the Maps & Profiles vocabulary.

Keep this page handy while you work. Each word is explained in the terms this course uses.

Maps, profiles and their parts

Word	Meaning
Map	A create map or parse map: configuration that changes a Document into a payload, or a payload into a Document.
Create map	Turns one of our Documents into the payload the target expects. Does the Create message type.
Parse map	Turns a payload we received into one of our Documents. Does the Parse message type.
Profile	A send profile or receive profile: configuration for the calls to another platform.
Send profile	The calls that carry a payload to the target system. Does the Send message type.
Receive profile	The calls that get data from the target system. Does the Receive message type.
Definition	A map or profile.
Body	The configuration text of a definition or profile.
Node id	The name of one part of a body, such as `order.priority`. Diagnostics and overlays use it.
Payload	Data in the partner's own format.

Word	Meaning
Root	A definition that holds the whole specification.
Overlay	A definition that holds only changes to its base.
Base	The definition that an overlay changes.
Shared base	A definition for all organisations that comes with each release.
Scope	How far a definition reaches: One integration, This organisation or Shared base. The most specific published one wins.
Floating	An overlay that follows each new published version of its base.
Pinned	An overlay that stays on one version of its base by choice.
Held	An overlay moved off its base because a new version of the base broke it.
Chain	The root and each overlay on it, from the root outwards.
Compose	Apply each overlay in the chain to the result of the one before. A chain that does not compose cannot run.

Word	Meaning
Version	One saved revision of a definition. Every save makes a new one.
Draft	A version that is not published, and is not used.
Live	The published version, which is used for messages.
Archived	A version replaced by a later one, or archived by an administrator. Never used, and cannot be published again.
Shipped default	Comes with the platform; each release can update it.
Locally owned	Edited here; releases do not update it any more.

Word	Meaning
Client profile	A named connection to another platform: base address, rate limit, retry rules and sign-in type.
Connect profile	How organisations connect an integration of one type.
Settings shape	The settings form of an integration type, or of one of its document types.
Fragment	A shared, read-only part that settings shapes can include.

Word	Meaning
Message type	One of the four steps: Create, Parse, Receive or Send.
Routing	Which service gets the messages of an integration type, per message type. Still required for config-driven types.
Module	Code that does the work for one message type. Published maps and profiles run before any module.
Mapping	In an organisation's settings, the rule that sends a document type from one Integration to another. Not the same as a map.

Recap

Maps shape data; profiles make calls; together they are definitions.
Roots hold everything; overlays hold changes and target node ids.
Floating follows, pinned stays by choice, held was parked by a breaking publish.
Only the live version runs; drafts and archived versions never do.
Client profiles, connect profiles and settings shapes are type-wide.

Your progress is saved in this browser. Create a free account to keep it everywhere, take quizzes and earn certificates.