Terminology
3 minute read
Pryme Intercompany makes it easy to transfer data between Business Central companies using Messages. For this purpose, there are three main components:
- Party
- Topic
- Subscriptions
Party
A Party is a Business Central company that exchanges data with other companies using data messages. All companies must agree on a unique party code. This code identifies each company in the system.
Tip
Use a clear and scalable naming convention. Example: Instead of “UK,” use “UK10,” “UK11,”….Topic
In the publishing company, the data messages are organized in Topics. The topic defines:
- Which tables and fields are included in the data message.
- Restrictions or filters that determine which records are made available.
- When and which subscribers should be notified.
When the publisher detects a new or an updated record, the Topic notifies the subscribers that new data is available to pull from the publisher.
Topic records
When a publisher detects a new record, the data is converted into a Topic record. It describes what kind of data the Topic contains. It does not contain any actual data. It defines:
- Which tables and fields are included
- Any filters that limit what data is published
- Rules or metadata that help Subscribers understand the Topic
- Who is allowed to subscribe
Topic messages
The Topic message is created when a publisher detects a new or and updated record. It contains the actual data that is sent to the Subscribers when they request new messages.
Topic register
The register keep track how far we are, last created message and if there were any errors on the last run.
Subscription
The Subscription is what allows a subscriber to receive, store, and process data that another company (parties) makes available through Topic messages. The subscription pulls data from the Topic and confirms back to the Publishers what has been received.
Subscription Records
A Subscription Record describes how a Subscriber wants to receive and store data from a Topic. It doesn’t contain any actual data. The Subscription record is created when a new record is received through a Topic message.
It contains:
- Which party to receive data from
- The owner of the record
- Target tables
- Target fields
- Mappings from Topic fields (source) → Subscription fields (target)
- Filters (if any)
Note
The Subscription record tracks the owner of the record, and if it was originally created by another company. If this is the case, the field Data Owned by Party is enabled, and any local changes will not be sent to other companies.If a record, such as a payment term, was created outside the Intercompany (IC) process, there will be no agreement on ownership. Consequently, changes made across companies will be synchronized and transferred to all companies. To resolve such conflicts, disable the Data owned by party field. Subscription Messages When the Subscriber requests data from a party, the incoming Topic message is converted to a Subscription message. It contains the actual incoming data, and it is processed according to the Subscription Record’s mapping and rules. If it’s a new record, the Subscription Message creates a Subscription Record. If the message is an update of an existing record, no new Subscription record is created.
Subscription register
The register keep track how far we are, last created message and if there were any errors on the last run.