Partners and Partner Groups
Section 1: Feature Overview
A Partner is the master company's representation of one subscriber company. Every partner record describes how the master should reach that subscriber: which company on the same tenant (Database transport), which cloud environment and Entra application (Web-service transport), or which shared file storage location (External File Account or, for legacy implementations, Azure Blob Storage). Each partner carries a unique ID that must match the Partner ID configured in the subscriber's Global Master Setup — this exact match is what ties the two sides together. When a partner is placed On Hold, no IC files are created and no record data is sent; removing the hold activates synchronisation. Partners also expose counters for the number of data templates directly assigned and the number of partner groups they belong to, giving a quick overview of what that subscriber receives.
Partner Groups allow the same set of data templates to be shared across many partners simultaneously. Instead of assigning templates to each partner individually, you assign them once to the group and add the partners as members. This is particularly useful when many subscriber companies need identical master data — for example, a chain of franchise sites or a family of subsidiary companies. A group follows a lifecycle — Under Development, Pending Update, On Hold, and Released — that governs when changes can be made and when data can be exchanged. Templates and members can only be added while the group is Under Development. When the group is Released, the job queue or a manual Transfer Record Data action distributes data to all members at once.
When a partner group releases data, the process generates Partner Group File Logs — one log entry per template per release run. Each file log records the template, file creation timestamps, number of data lines, whether it represents an update (catch-up exchange for newly added members), and any error text. The file log is then "exploded" into individual Subscriber IC File Logs for each member partner, so each subscriber receives its own file through its configured transport. You can monitor both the group-level file logs and the per-member IC file logs from the Partner Group card. Partner Group Updates are the pending work items created whenever a new member is added or a template is assigned while the group already has a history of data exchange; handling these updates aligns the new member with the existing exchange history before the group returns to Released.
Key Facts
| Aspect | Detail |
|---|---|
| Pages — Partners | Global Master Partner List, Partner Card |
| Pages — Partner Groups | Global Master Partner Groups, Partner Group (card) |
| Supporting pages | Partner Group Members, Partner Group File Logs, Partner Group Updates, Add Members to Partner Group (wizard), Convert and assign partners wizard, Remove Partner Group Member, GM Tenant Connector Codes |
| Transport type options | Database, Web-service, External File Account, Azure Blob Storage (legacy, hidden unless enabled in setup) |
| Partner Group status values | Under Development → Pending Update → Released (or On Hold) |
| Key partner fields | ID, Description, Data Exchange Type, Company Name, On Hold, Embed Record Set, Assigned Data Templates, Assigned Partner Groups |
| Key partner group fields | Code, Description, Status, No. of Group Members, Assigned Data Templates, Unhandled Partner Group Updates, Failed Partner Group Updates |
| Integration points | Global Master Setup (company type and Partner ID), Data Templates (assigned to partners or groups), Subscriber IC File Logs (transport artefacts), Job Queue (batch exchange via Transfer Record Data report) |
Section 2: Getting Started
The following steps take you from a blank system to an active partner that is ready to exchange master data. Complete the Global Master Setup and create at least one Data Template before starting.
-
Open the Global Master Partner List. Search for Global Master Partner List in the tell-me bar, or navigate through the Global Master Setup menu. The list is empty for a new installation.
-
Create a new partner record. Choose New. Enter a unique ID — this value must match exactly the Partner ID in the subscriber company's Global Master Setup. The ID cannot be the same as any existing Partner Group code.
-
Add a description. Type a human-readable name in the Description field. If you enter the Company Name first, the description is auto-filled from it.
-
Select the Data Exchange Type. Choose one of the transport options:
- Database — subscriber is a company on the same Business Central tenant.
- Web-service — subscriber is on a different Business Central Online tenant, authenticated via OAuth2.
- External File Account — uses the BC File Management connector (SharePoint, Azure Blob, SFTP, etc.) configured in the File Accounts setup.
- Azure Blob Storage — legacy option, visible only when enabled in Global Master Setup.
Changing this value resets the transport-specific fields and puts the partner back On Hold.
-
Configure the transport-specific connection.
- Database: Select or type the Company Name using the look-up. The system validates that the company exists on the tenant.
- Web-service: Enter the Environment Name, the Company ID (the subscriber company's GUID), and select a Tenant Connector Code that holds the Microsoft Entra credentials. Use the Test Web Service Connection action to verify before saving.
- External File Account: Click the Select link in the External File Account group to open the file-account picker. After selecting an account, confirm the Account Name and Connector type shown.
- Azure Blob Storage: Fill in Azure Blob Storage Account Name, SAS token, and Container.
-
Set Company Name (non-Database transports). For Web-service and file-based transports, enter the subscriber's company name in the Company Name field. This is stored for informational purposes and is checked before the partner can be taken off hold.
-
Verify the Embed Record Set flag. For all transport types except Database, this checkbox must remain enabled (the default). For Database partners, you may clear it to use a direct in-memory transfer instead of creating IC file logs — however, this prevents the partner from being added to a Partner Group later.
-
Assign Data Templates. From the Partner Card, choose Assign Data Templates in the process actions. A picker shows all templates owned by this master company that are not already assigned to this partner (directly or via a group). Select one or more templates and confirm. The Assigned Data Templates counter updates immediately.
-
Test the storage connection (file-based transports only). In the Storage Connection action group, choose Upload test file, then Download test file, and finally Delete test file to confirm read/write access to the storage account. Fix any connector or credential issues before proceeding.
-
Take the partner off hold. Clear the On Hold checkbox. The system validates all required fields for the chosen transport type — Company Name, External File Account, or Web-service credentials — and raises an error if anything is missing. Once unchecked, the partner is active and will be included in the next data exchange run.
-
Run or schedule data exchange. Use Transfer Record Data on the Partner Card to push data immediately (confirms before running), or rely on the job queue entry that runs the Transfer Record Data report on a schedule. The first exchange sends all records tracked by the assigned templates.
-
Consider Partner Groups for multi-partner setups. If multiple partners need the same templates, create a Partner Group, assign the templates to the group, and add the partners as members. Individual partners can also be converted into group members using the Convert and assign Partners wizard, which automatically migrates their existing template subscriptions.
Section 3: Related Features
Partners are the core link between the Global Master Setup and the data that flows to subscriber companies — the setup article covers how to configure the master company role and the Partner ID that every partner record must reference. Data Templates define which table and fields are synchronised; a partner or partner group must be subscribed to at least one template before any data can flow, and the templates must be Released before exchange is possible. The Transfer Record Data report and the job queue work through all active subscribers (both direct partners and partner group members) in template-sequence order, creating Subscriber IC File Logs and dispatching them via the partner's configured transport. For file-based partners, the IC File Exchange feature manages the sending and receiving of those file logs; the Partner Card's Subscriber IC Files action provides a drill-down into all files created for that partner.
Section 4: User Stories
US-01 — Create a Partner for same-tenant Database sync
As a master data administrator,
I want to register a subscriber company that lives on the same Business Central tenant,
so that record data is transferred directly in memory without any file storage.
Steps:
- Open the Global Master Partner List and choose New.
- Enter a unique ID that matches the subscriber company's Partner ID in their Global Master Setup.
- Set Data Exchange Type to Database.
- Look up or type the Company Name — the system verifies the company exists on this tenant.
- The Description is auto-filled from the Company Name; adjust if needed.
- Assign one or more Data Templates using Assign Data Templates.
- Clear On Hold to activate the partner. The system validates the Company Name before allowing this.
Result: The partner is active and included in the next exchange run.
US-02 — Create a Partner for External File Account cross-tenant sync
As a master data administrator,
I want to set up a partner that uses a BC File Account connector (e.g. SharePoint or SFTP) to share IC files with a subscriber on a different tenant,
so that master data can cross tenant boundaries without an Azure Blob Storage subscription.
Steps:
- Create a new partner record, enter the ID and Description.
- Set Data Exchange Type to External File Account.
- In the External File Account section, click the select link to open the file account picker and choose the account.
- The Account Name and Connector type are displayed read-only; confirm they are correct.
- Enter the subscriber's Company Name (informational, required before taking off hold).
- Use Upload test file → Download test file → Delete test file to verify storage access.
- Assign Data Templates, then clear On Hold.
Result: IC files for this partner are written to the selected file account for the subscriber to pick up.
US-03 — Create a Partner for legacy Azure Blob Storage cross-tenant sync
As a master data administrator on an installation that still uses the original Azure Blob Storage setup,
I want to register a partner with direct Azure Blob Storage credentials,
so that IC files are written to and read from the named container.
Prerequisite: Import Method on the Global Master Setup must be set to Azure Blob Storage.
Steps:
- Create a new partner, enter ID and Description.
- Set Data Exchange Type to Azure Blob Storage.
- Enter Azure Blob Storage Account Name, SAS token, and Container in the Azure Blob Storage section.
- Enter the subscriber's Company Name.
- Optionally use the Test BLOB Storage Connection actions to upload, download, and delete a test file.
- Assign Data Templates, then clear On Hold.
Result: IC files are stored in the specified Azure Blob Storage container.
US-04 — Create a Partner for Web-service OAuth2 cross-tenant sync
As a master data administrator,
I want to connect to a subscriber company on a separate Business Central Online tenant using a registered Entra application,
so that master data is pushed directly via the Business Central API without shared file storage.
Steps:
- Ensure a GM Tenant Connector Code is already configured with the correct Microsoft Entra tenant ID, Client ID, and Client Secret.
- Create a new partner, enter ID and Description.
- Set Data Exchange Type to Web-service.
- Enter the subscriber's Environment Name (e.g. Production).
- Enter the subscriber's Company ID (the GUID of the company in their environment).
- Select the Tenant Connector Code that holds the Entra credentials.
- Use Test Web Service Connection to confirm authentication and verify that the subscriber company returns the expected Partner ID.
- Assign Data Templates, then clear On Hold.
Result: The master can authenticate to the subscriber tenant and push data via the GMDS API.
US-05 — Assign Data Templates to a Partner directly
As a master data administrator,
I want to assign specific data templates to an individual partner,
so that only the selected datasets are synchronised with that subscriber.
Steps:
- Open the Partner Card for the relevant partner.
- Choose Assign Data Templates in the process bar.
- A picker lists all templates owned by this master that are not yet assigned to this partner (directly or indirectly via a group). Templates whose members already cover this partner through a group are excluded automatically.
- Select one or more templates and confirm the assignment dialog.
- The Assigned Data Templates counter on the card reflects the new total.
Note: A partner cannot be assigned the same template both directly and as a member of a group that already holds that template.
US-06 — Take a Partner off hold to activate synchronisation
As a master data administrator,
I want to remove the On Hold flag from a fully configured partner,
so that record data starts flowing to the subscriber on the next exchange run.
Steps:
- Open the Partner Card.
- Confirm the Data Exchange Type is set and all connection fields are filled.
- Confirm at least one Data Template is assigned.
- Clear the On Hold checkbox.
- The system validates the required fields for the transport type. If anything is missing, a specific error message identifies the field to fix.
- Save the record.
Result: The partner is active and will be included in the next scheduled or manual data exchange.
US-07 — Transfer record data to a Partner manually (on-demand sync)
As a master data administrator,
I want to trigger an immediate data push to a specific partner,
so that the subscriber receives the latest master data without waiting for the job queue.
Steps:
- Open the Partner Card or select the partner in the Global Master Partner List.
- Choose Transfer Record Data in the process bar.
- Confirm the prompt. Optionally confirm a second prompt to stop on the first error (useful for diagnostics).
- The system processes all assigned templates in sequence, creating IC file logs and — for file-based transports — sending them to the partner's storage.
- Check the Subscriber IC Files action to review the outcome.
Prerequisite: The partner must not be On Hold, and Master Exchange Record Set must be enabled in the Global Master Setup.
US-08 — Create a Partner Group
As a master data administrator,
I want to create a Partner Group to manage a set of subscriber companies collectively,
so that I can assign templates once and distribute data to all members together.
Steps:
- Open the Global Master Partner Groups list and choose New.
- Enter a unique Code — this cannot match any existing Partner ID.
- Enter a Description.
- The Status defaults to Under Development, which is required for adding templates and members.
Prerequisite: Skip File Split must be disabled in the Global Master Setup (the system validates this when creating a group).
US-09 — Add members to a Partner Group
As a master data administrator,
I want to add individual partners to a group that has no overlapping template subscriptions,
so that those partners receive data through the group from now on.
Steps:
- Open the Partner Group card; Status must be Under Development.
- Choose Assign Partners in the process bar.
- The Add Members to Partner Group wizard opens. Review the introduction and choose Next.
- Click the selection link to open a picker. Only partners with Embed Record Set enabled, a valid Company Name, and no conflicting template subscriptions are shown.
- Select one or more partners and choose Next.
- Optionally specify a template company and creation time (relevant when the new companies were copied from a template company, to reduce initial exchange volume).
- On the final step, choose a finishing action:
- Review the partner group setup — no status change.
- Set status to Pending Update — queues the update for background processing.
- Handle updates and set status to Release — processes all pending updates immediately.
- Check the Add members and execute the finalizing task checkbox and choose Finish.
US-10 — Remove a member from a Partner Group
As a master data administrator,
I want to remove a partner from a group,
so that it stops receiving data through the group subscription.
Steps:
- Open the Partner Group card; Status must be Under Development.
- In the Partner Group Members subpage, select the member to remove.
- Choose Remove Member.
- If no data has been exchanged with this member yet, a confirmation removes it immediately.
- If data has already been exchanged, the Remove Partner Group Member dialog appears:
- Optionally check Set the new data templates Subscribers to Obsolete to also send a deletion signal to the subscriber company for each template.
- Choose Yes to confirm removal.
- The member's partner group updates are cleaned up and the member row is deleted.
US-11 — Assign Data Templates to a Partner Group
As a master data administrator,
I want to assign data templates to a partner group,
so that all current and future members automatically subscribe to those templates.
Steps:
- Open the Partner Group card; Status must be Under Development.
- Choose Assign Data Templates in the process bar.
- A picker lists templates not already assigned to this group that do not conflict with the existing members' direct subscriptions.
- Select one or more templates and confirm.
- Partner Group Updates are automatically created for every existing member, representing the pending exchange work for the new template.
Note: The system prevents assigning a template if any member is already a direct or indirect subscriber to that template under another assignment.
US-12 — Release a Partner Group (distribute templates and record data to all members)
As a master data administrator,
I want to release a Partner Group so that data flows to all its members,
so that the group becomes active and is included in scheduled data exchange.
Steps:
- Open the Partner Group card.
- The group must be Under Development with at least one member and at least one template assigned.
- To release directly, change Status to Released — this is only allowed when no unhandled updates exist.
- If there are unhandled updates (e.g. because members were just added), first set Status to Pending Update.
- Choose Handle Updates to process all pending updates: the system creates Partner Group File Logs, splits them into Subscriber IC File Logs per member, and sends them.
- After all updates are handled, the status automatically transitions to Released.
- Alternatively, use the Handle updates and set status to Release option in the Add Members wizard to do steps 4–6 in one action.
US-13 — Monitor Partner Group file logs
As a master data administrator,
I want to inspect the file logs produced when a partner group exchanges data,
so that I can track what was sent, when, and whether any errors occurred.
Steps:
- Open the Partner Group card or the Global Master Partner Groups list.
- Choose Partner Group File Logs in the Navigation bar.
- The Partner Group File Logs page shows one row per template per release run. Key columns:
- Entry No. — unique sequence number.
- GM Data Template Code — which template the files cover.
- File Creation Start / End — when the file set was generated.
- No. Of File Lines — data volume in the file.
- Handled — whether the log has been split into member IC file logs.
- Update — whether this log was created specifically to catch up new members.
- Error Text — any error recorded during file creation.
- To drill into the Subscriber IC File Logs for a specific group file log, choose Subscriber IC Files in the Navigation bar.
- If a log is not yet handled, use Transfer Record Data on the file log page to re-trigger file creation and sending.
US-14 — Convert individual Partner assignments to use a Partner Group
As a master data administrator,
I want to migrate partners that are already individually subscribed to templates into a partner group,
so that I can manage those subscriptions collectively going forward.
Steps:
- Open the Partner Group card; Status must be Under Development.
- Ensure the group is already assigned to at least the templates you want to migrate.
- Choose Convert and assign Partners in the process bar.
- The Convert and assign partners wizard opens. Review the explanation: only partners that are directly subscribed to one or more of the same templates as the group are eligible; their direct subscriptions to those templates will be removed and the group subscription takes over.
- On the selection step, click the link to open the picker. Select the partners to convert.
- On the finishing step, choose an action (Review / Pending Update / Handle and Release) and enable the Add members and execute the finalizing task checkbox.
- Choose Finish.
Result: The selected partners become group members. Their previous direct template subscriptions for the overlapping templates are replaced by the group subscription, and Partner Group Updates are created to ensure continuity — data already sent is not re-sent.
US-15 — Test the storage connection on a Partner
As a master data administrator,
I want to verify that a file-based partner's storage account is reachable and writable,
so that I can confirm the transport is correctly configured before activating the partner.
Steps:
- Open the Partner Card for a partner with Data Exchange Type set to External File Account or Azure Blob Storage.
- In the Storage Connection action group, choose Upload test file and confirm. The system creates a small test file in the storage account.
- Choose Download test file and confirm. The test file is retrieved — a successful download confirms read access.
- Choose Delete test file and confirm. The test file is removed from storage.
- If any step fails, review the error message and check the account credentials, SAS token validity, or connector configuration.
US-16 — View and handle Partner Group Updates
As a master data administrator,
I want to inspect which member/template combinations are pending a catch-up exchange,
so that I can monitor and troubleshoot the Pending Update phase.
Steps:
- Open the Partner Group card or the Global Master Partner Groups list.
- Choose Partner Group Updates in the Navigation bar.
- The Partner Group Updates page lists one row per partner/template combination that is pending or has been handled. Key columns:
- Subscriber Partner ID — the member needing the exchange.
- GM Data Template Code — which template.
- Last Data Exchange — the starting point for the catch-up, based on when the member joined or when the template was assigned.
- Handled — whether the update has been processed.
- Partner Group File Log No. — the file log that was created when this update was handled.
- Error Message — any error recorded during handling.
- The Unhandled Partner Group Updates and Failed Partner Group Updates counters on the group card summarise the state at a glance.
- To process unhandled updates, set the group status to Pending Update and then choose Handle Updates, or use the job queue which picks up all Pending Update groups automatically.
US-17 — Assign Data Templates via the Transfer Record Data report
As a master data administrator,
I want to run the Transfer Record Data report filtered to a specific partner or partner group,
so that I can push data to a subset of subscribers without triggering a full exchange.
Steps:
- Search for Global Master Create and send Subscriber File Log in the tell-me bar (the Transfer Record Data report).
- On the request page, apply filters:
- GM Data Template Code — limit to one or more specific templates.
- Subscriber Partner Type — choose Partner or Group.
- Subscriber Partner ID — enter the partner or group code.
- Run the report. It processes all matching, non-held subscriber rows in template-sequence order.
- Partner Group Updates for any Pending Update groups are handled automatically before the main loop.
- Review errors in the Subscriber IC File Log or Partner Group File Logs after the run.
Section 5: Field Reference
Partner Card Fields
| Field | Description |
|---|---|
| ID | Unique identifier for the partner. Must match the Partner ID in the subscriber company's Global Master Setup exactly. Cannot be the same value as any Partner Group code. |
| Description | Free-text name for the partner. Auto-filled from Company Name when left blank. |
| Data Exchange Type | Transport method: Database, Web-service, External File Account, or Azure Blob Storage (legacy). Changing this value resets connection fields and puts the partner back On Hold. |
| Company Name | The Business Central company name of the subscriber. Required for all transport types before the partner can be taken off hold. For Database partners, the company must exist on the current tenant. |
| On Hold | When checked, no IC files are created and no data is sent. New partners default to On Hold; clear it to activate. |
| Embed Record Set | When enabled (default), master data is packaged into IC file log entries. Must be enabled for External File Account, Web-service, and Azure Blob Storage transports, and for any partner that will be added to a partner group. |
| Assigned Data Templates | Count of data templates directly assigned to this partner. |
| Assigned Partner Groups | Count of partner groups this partner belongs to. |
| Environment Name | For Web-service partners: the name of the subscriber's Business Central environment (e.g. Production). |
| Company ID | For Web-service partners: the GUID identifying the subscriber company in their environment. |
| Tenant Connector Code | For Web-service partners: references the GM Tenant Connector that holds the OAuth2 credentials used to authenticate to the subscriber tenant. |
| Azure Blob Storage Account Name | For legacy Azure Blob Storage partners: the storage account name. |
| Azure Blob Storage SAS token | For legacy Azure Blob Storage partners: the Shared Access Signature token granting access. |
| Azure Blob Storage Container | For legacy Azure Blob Storage partners: the container within the storage account. |
| Remove Namespace from Record ID | Advanced compatibility field for transferring data from BC27+ to earlier versions; hidden by default. |
| Last IC File Log Entry No. | System-maintained sequence counter. Do not change in production; visible for diagnostic purposes in sandbox environments. |
| Modified By | User who last changed this record. |
| Modified On | Date and time of the last change. |
Partner Group Fields
| Field | Description |
|---|---|
| Code | Unique identifier for the partner group. Cannot match any existing Partner ID. |
| Description | Free-text name for the group. |
| Status | Lifecycle state: Under Development (editable), Pending Update (awaiting member alignment), On Hold (exchange paused), Released (active, included in exchange). |
| No. of Group Members | Calculated count of partners currently assigned as members. |
| Assigned Data Templates | Calculated count of data templates assigned to this group. |
| Unhandled Partner Group Updates | Calculated count of member/template combinations still awaiting a catch-up exchange. |
| Failed Partner Group Updates | Calculated count of partner group updates that encountered an error. |
Partner Group Member Fields
| Field | Description |
|---|---|
| Partner Group Code | The group this member belongs to. |
| Subscriber Partner ID | The partner that is a member of the group. |
| Partner Company Name | The Company Name of the partner, captured at the time of membership and stored for display. |
| Partner Description | The partner's description, calculated from the partner record. |
| Unhandled Partner Group Updates | Count of updates pending for this member within the group. |
GM Tenant Connector Codes Fields
The Tenant Connector is a separate setup record used exclusively for Web-service partners. Full configuration details are covered in the Setup and Configuration article.
| Field | Description |
|---|---|
| Code | Unique identifier for the connector. Referenced on the Partner Card. |
| Description | Free-text description of the connector. |
| Microsoft Entra tenant ID | The GUID of the subscriber's Microsoft Entra directory (formerly Azure AD Tenant ID). |
| Client ID | The application (client) ID of the Entra app registration used for OAuth2. |
| Client Secret | The client secret of the Entra app registration. Stored encrypted in Isolated Storage. |
