Activities

Activity Area Description

Actions on pulled master record in source company

Master Data Management

In the target company, you can pull master data from the source company. When you have done so, depending on the status of the master record, data steward actions can be required in the source company:

Master record status Required actions in source company
New As a data steward in the source company, approve, release, and send the master record.
Approved As a data steward in the source company, release and send the master record.
Released

As a data steward in the source company, send the master record.

Note: If you pull master data with status Released, and on the Pull master data dialog, in the 'Send master data' field, you select 'Yes', the master data is directly sent to the target company or to the MDM staging journal. The source company data steward does not have to send the master data.

Approve master record

Master Data Management

You can approve the master data records that you have edited.

For the master data entity, a validation can be defined. A validation is applied when you approve master data. If the master data is invalid, the master data is not approved.

Example

A validation rule with the BisMdmValidationCustomerBankAccount class is active for the master data entity.

You try to approve a customer master data record which bank account is not defined. As a result, the customer master data record is not approved. So, you cannot release this customer master data record till you define its bank account.

Cancel master record change request

Master Data Management

When you have decided to not make the requested changes to a master record, mark the change request as Cancelled.

Cancel master record release

Master Data Management

You can change a master record after it is released. To do so, cancel the release of the master record. As a result, the status of the record is changed to Cancelled.

You can again edit, approve, and release a cancelled master record.

Complete master record change request

Master Data Management When you have finished making the requested changes to a master record and have sent it to the applicable target companies, mark the change request as Completed.

Create master record change requests

Master Data Management

In the target company, a change can be required for a master data record. To inform the source company of the required change, create a master record change request.

When created, the change request is shown in the source company and can be picked up for further processing in the source company.

Create MDM project

Master Data Management
Use a Connectivity studio project as the basis for master data management setup. Most Connectivity studio elements are linked to a project, for example, documents, connectors, and messages. Because these elements are related to a project, you can also use a project to deploy MDM studio setup and do version management.
For a project that is used for master data management setup, make sure to set the project Purpose to 'Mdm'.

Define master records

Master Data Management For each master data entity, you can define which records are master records. To make a master data entity record a master record, subscribe it to a company. If a master data entity record has a subscription to a company, the record is defined as master data for that company.

Discuss master record change request

Master Data Management The data steward of the source company can start a discussion on the created master record change request. The discussion is shown in the Discussion section of the Master record change request page.
This topic explains how to enter a response to the source company data steward.

Edit master record

Master Data Management

With MDM studio you can manage master data. For a master data record, you can edit the:

  • Status
  • Responsible data steward
  • Subscribed target companies
  • Related D365 F&SCM record

Export company configuration

Master Data Management

You can export an MDM company configuration to an XML file. So, you can import it in another D365 F&SCM environment.

If you export a company configuration, depending on the company type, these settings of these fields are included:

Type Exported Data Notes
Standard Type  

Company accounts ID

Only the company account ID is exported. The related legal entity is not exported.

Data stewards

  • Name
  • Email address

Only the user ID is exported. The related user is not exported.

External Type  
ID  

Data stewards

  • Name
  • Email address

Only the user ID is exported. The related user is not exported.

Target group Type  
ID  
Target companies - Name A target company refers to an MDM company. In the export, you can optionally include the MDM companies to which the target companies refer. If you do so, only the company account IDs are exported. The related legal entities are not exported.
Hierarchy Type  
ID  

Organization hierarchy

Only the organization hierarchy ID is exported. The related organization hierarchy is not exported.

Export Connectivity studio configuration

Master Data Management

In MDM studio, to send data from a source company to a target company, Connectivity studio messages are used. You define the applicable messages on a master data entity or on the related hierarchy messages.

When you import master data entities into another D365 F&SCM environment, ensure that the related Connectivity studio messages already exist.

So, when you export master data entities, ensure to export the related Connectivity studio messages as well.

For more information, refer to Export Connectivity studio configuration.

Export master data entity configuration

Master Data Management

You can export a master data entity configuration to an XML file. So, you can import it in another D365 F&SCM environment.

If you export a master data entity configuration, depending on the setup, this is included:

  • General master data entity settings.
  • Custom settings.
  • All defined master data entity message records.
    Note: Only the references to the Connectivity studio messages are exported. The referenced Connectivity studio messages are not exported.
  • All defined hierarchy message records.
    Note: Only the references to the Connectivity studio messages are exported. The referenced Connectivity studio messages are not exported.
  • Display field and range settings.
  • All defined validations.
  • All defined dynamic form setup records.

Import company configuration

Master Data Management

You can import an MDM company configuration from an XML file. Usually, the company configuration in the import file is exported from another D365 F&SCM environment.

If you import a company configuration, depending on the company type, these conditions and actions apply:

Type Condition Action
Standard Company accounts ID must be specified in import file.

An MDM company is imported only if the related legal entity exists in the import environment.

Note: Legal entities are not imported with an MDM company import.

Data stewards are optional.

A data steward is imported only if the related user exists in the import environment.

Note: Users are not imported with an MDM company import.

External ID must be specified in import file.  
Data stewards are optional.

A data steward is imported only if the related user exists in the import environment.

Note: Users are not imported with an MDM company import.

Target group ID must be specified in import file.  
Target companies are optional.

In the import file, target companies can be specified for the target group. A target company refers to an MDM company.

Target group import is done in this sequence:

  1. A target company refers to an MDM company. The import file can include the MDM companies to which the target companies refer. If so, import these MDM companies. An MDM company is imported only if the related legal entity exists in the import environment.
  2. Import the target group.
  3. For the target group, set the target company references to the MDM companies.

Note: Legal entities are not imported with an MDM company import.

Hierarchy ID must be specified in import file.  
Organization hierarchy reference must be specified in import file.

In the import file, an organization hierarchy reference can be specified for the hierarchy. A hierarchy is imported only if the referenced organization hierarchy exists in the import environment.

Note: Organization hierarchies are not imported with an MDM company import.

Import Connectivity studio configuration

Master Data Management

In MDM studio, to send data from a source company to a target company, Connectivity studio messages are used. You define the applicable messages on a master data entity or on the related hierarchy messages.

When you import master data entities into another D365 F&SCM environment, ensure that the related Connectivity studio messages already exist.

To facilitate a smooth import process, make sure to import the related Connectivity Studio messages before you import the master data entities.

For more information, refer to Import Connectivity studio configuration.

Import master data entity configuration

Master Data Management

You can import a master data entity configuration from an XML file. Usually, the master data entity configuration in the import file is exported from another D365 F&SCM environment.

If you import a master data entity configuration, these conditions and actions apply:

Condition Action
The Master data type ID field must have a value in the import file. If no Master data type ID is defined, no import is done.
The imported master data entity does not exist in the import environment If the imported master data entity already exists in the import environment, you get a prompt whether you want to override the existing master data entity.
The referenced Connectivity studio messages exist in the import environment

If a referenced Connectivity studio message does not exist, you get a prompt whether you want to continue the import. If you click:

  • No, the master data entity is not imported.
  • Yes, the master data entity import continues and the master data entity message record is created without the Connectivity studio message defined. In this case, you must manually complete the setup of the master data entity.

Note: Only the references to the Connectivity studio messages are imported. The referenced Connectivity studio messages are not imported.

The referenced MDM companies exist in the import environment

If a referenced source MDM company or target MDM company does not exist in the import environment, you get a prompt whether you want to continue the import. If you click:

  • No, the master data entity is not imported.
  • Yes, the master data entity import continues and the master data entity message record is created without the missing MDM company defined. In this case, you must manually complete the setup of the master data entity.

Note: Only the references to the MDM companies are imported. The referenced MDM companies are not imported.

Initialize master data in new company

Master Data Management

You can add new target companies to your D365 F&SCM environment. Based on the source company master data, you can initialize the master data in the new companies. You can do so for a single company or for a target group (several new companies).

As a result, for the defined master data entity table:

  • All records that are marked as master data are released in the source company.
  • The master data is (optionally) sent from the source company to the new target companies.
  • Subscriptions for the new target companies are created for the master data entity records.
    Note: If you initialize a target group, a separate subscription is created for each company in the target group. To each of these company subscriptions, the used target group is added for reference purposes.

Initialize master records

Master Data Management

For a master data entity, you can initialize master records for an existing source company and existing target company or target group companies.

You can use this initialization if the master data already exists in both the source company and the target company or target group companies, but no master records exist for this data. For example, previously, you managed master data in another way than with Master Data Management Studio.

As a result, for the defined master data entity table, for the data that exists in both the source company and the target company or target group companies:

  • Master records are created.
  • Subscriptions for the target companies are created for the master data entity records.
    Note: If you initialize master records for a target group, a separate subscription is created for each company in the target group. To each of these company subscriptions, the used target group is added for reference purposes.
  • No data is pushed from the source company to the target companies.

Monitor master data errors

Master Data Management

As a data steward in the source company, you can monitor the errors that occurred when master data was sent to the target company.

You can monitor master data errors on the Master data management - Operation workspace, on the Master data errors tab. This tab shows the same data as the Master data inbox in the target company. However, here only the master data records are shown for which an error occurred when sent.

The error can for example be a data error, an error in the message, or an error in the message run.

To investigate the master data error, you can follow the steps to:

  • Monitor the master data inbox.
  • Monitor the master data staging journal, if staging is applicable.

Monitor Master data inbox

Master Data Management

When a source company releases a master record, it is added to the Master data inbox of the target company.

The added record has the status To be processed. You can only view the record.
When the source company runs an MDM message and no errors occur, in the Master data inbox, the status of the record is changed to processed. This indicates that the master data is imported in the database of the target company or in the staging journal.
Possible statuses of the Master data inbox are:
  • To be processed: Status after the record is released.
  • In processes: The MDM message is running.
  • Processed: The master data is imported in the database of the target company or in the staging journal.
  • Cancelled: The data steward of the source company cancelled the release of the record.
  • Error: An error occurred when running the MDM message.
Note: Monitor the Master data inbox in the target company.

Monitor master record change requests

Master Data Management In the target company, a change request can be created for a master data record.
As a data steward of the source company, monitor the master record change requests in the source company.
You can start a discussion with the user who created the change request in the target company.
When the required changes are clear and agreed upon, as a next action, you can start making the changes.

Monitor MDM staging journal

Master Data Management

If you use staging in your master data process, master records are imported into the staging journal by the ‘Data to staging’ message. You can monitor the master record staging journals in the target company.
Each time a ‘Data to staging’ message is run, all related master records (with status Released) are imported into the staging journal. For each message run and target company combination, a journal is added to the MDM staging journal. Each processed master record results in a line in the relevant journal. For each line, all the fields, as defined in the document, are shown with the related values.

Staging journal validations

The master records in the staging journal can be validated according to the applicable staging journal validation setup. If the applicable validation rules are:

  • Met, the staging journal line is automatically approved. Depending on the master data entity setup, the approved lines are processed automatically by the 'Data from staging' message or you must manually run this message.
  • Not met, an error or warning is given. Before the line can be processed further, review the errors and warnings, and take appropriate actions.

If you use data comparison, you can also apply a staging journal validation. This validation defines what happens with journal lines with data differences. If you manually generate a data comparison, make sure the data comparison is done before you manually apply staging journal validations.

To apply a staging validation, in Connectivity studio, in the Staging display options, for the desired record, set up a validation with the BisValidationMdmDifference validation class. The Exception behavior and Type settings of the validation setup define what happens if differences are found. For more information, refer to Set up staging validations

Pull master data

Master Data Management

In the target company, as a data steward, you can pull master data from the source company.

Pull master data with dynamic button

Master Data Management

In the target company, as a data steward, you can use a dynamic button to pull master data from the source company.

From which pages you can use the dynamic button is defined by the dynamic button setup.

Release master record

Master Data Management

You can release approved master records.
If you release a master record, it is added to the Master data inbox of the target company.

You cannot change a released master record.

Send master record

Master Data Management Run the master data messages to send released master records to the target companies or to the MDM staging journal. All messages, as defined for the master data entity, are run.
The master data entity messages process all Released master records of the master data entity.

Set up dynamic button to pull master data

Master Data Management

In the target company, to any D365 F&SCM page, you can add a dynamic button to pull master data from the source company.

As a result, to the Action Pane of the D365 F&SCM page, the Master data management tab is added with the dynamic button. The dynamic button opens a page showing the available records. Which page is opened, is defined in the Dynamic menu form setup of the applicable master data entity.

For example, to the Sales orders (SalesTable) page, you can add a dynamic button to pull customer accounts to the current company.

Set up dynamic menu form setup for master data entity

Master Data Management

For a master data entity, you can set up the dynamic form setup.

You can use the dynamic menu form setup for these purposes:

  • Manage master data from a related D365 F&SCM form.
    Setup: To the Action Pane of a form, you can add the Master data management tab. Depending on the company from which you open the form, the Master data management tab has these buttons:
    • Create master data (Shown in source company only.)
    • Master data (Shown in source company only.)
    • Master data inbox (Shown in source company and target company.)
  • In a target company, pull master data from the source company.
    Setup: To the Action Pane of a form, to the Master data management tab, you can add the Pull master data button. (Shown in source company, when opened from target company.)

To manage master data from a D365 F&SCM form, fill in these fields:

  • Form name
  • Data source name
  • Default form (Optional)

To pull master data, fill in these fields:

  • Form name
  • Data source name
  • Pull menu item name
  • Default form (Selected)

Set up external company

Master Data Management Set up an external company for each external application to which you want to send master data.

Set up hierarchy company

Master Data Management

You can use an organization hierarchy to define the source company and target companies for master data distribution. To be able to use an organization hierarchy for master data distribution, set up a company of type 'Hierarchy' and link the organization hierarchy to it.

Note: Make sure that each legal entity in the organization hierarchy is set up as a master data management company as well. This is required because of the company-specific data steward setup.

Set up master data entity

Master Data Management

Use a master data entity to define:

  • Which table holds master data.
  • Who sends this master data.
  • Where you send this master data to.
  • How you select the right master record.

This topic explains the basic setup of a master data entity.

Set up master data entity display fields

Master Data Management

For a master data entity, you can define display fields. These display fields are the fields that are shown on the Available records page.

You are advised to at least set up an identification field as display field. So, you can see which records are released and which records are not released.

Set up master data entity message - Hierarchy

Master Data Management

To distribute master data in MDM studio, Connectivity studio messages are used.

If you use an organization hierarchy to define a source company and target companies for master data distribution, set up master data entity messages of type Hierarchy.

An organization hierarchy has several levels of companies (legal entities) between which you can distribute master data. The master data distribution between two organization hierarchy levels is called a layer.

For each master data distribution layer, define the messages that are used to send master data:

  • From a source company to target companies.
  • From a source company to staging journals.
  • From a staging journal to a target company.

Prerequisites:

  • Organization hierarchy setup
  • Company setup
  • Connectivity studio setup (messages)

Set up master data entity message - Standard, External, or Target group

Master Data Management

To distribute master data in MDM studio, Connectivity studio messages are used.

For a master data entity, you can define the messages that are used to send master data:

  • From a source company to a target company.
  • From a source company to a staging journal.
  • From a source company to a target group.
  • From a staging journal to a target company.

This topic explains how to set up a master data entity message of type Standard, External, or Target group.

Prerequisites:

  • Company setup
  • Connectivity studio setup (messages)

Set up master data entity validations

Master Data Management

For a master data entity, you can define the applicable validations.

A validation is applied when you approve master data. If the master data is invalid, the master data is not approved.

These validation classes are delivered with MDM studio:

  • BisMdmValidationCustomerContactPerson: Checks if the contact person is defined.
  • BisMdmValidationCustomerBankAccount: Checks if the bank account is defined.

Only apply these validations if the Record table is 'CustTable'.

You can create custom validation classes. To do so, extend the BisMdmValidationBase class.

Example

A validation rule with the BisMdmValidationCustomerBankAccount class is active for the master data entity.

You try to approve a customer master data record which bank account is not defined. As a result, the customer master data record is not approved. So, you cannot release this customer master data record till you define its bank account.

Set up MDM message - Data from staging

Master Data Management

To send data form a staging journal to a target company, you need two connectors, two documents, and a message.
For the 'Data from staging' message, you can re-use the connectors and documents that are used for the 'Data to staging' message. 
Make sure you use the:

  • Source connector and document of the ‘Data to staging’ message as target connector and document on the ‘Data from staging’ message.
  • Target connector and document of the ‘Data to staging’ message as source connector and document on the ‘Data from staging’ message.
Note: This results in a mirrored mapping compared to the mapping of the ‘Data to staging’ message. The target records and fields become the source records and fields, the source records and fields become the target records and fields.

For more information on setting up connectors, documents, and messages, refer to Connectivity studio.

Set up MDM message - Data to staging

Master Data Management

To send data from a source company to a staging journal, you need two connectors, two documents, and a message. 

To set up these components for MDM studio, some specific setup is required:

Component Description
Source connector

Use a source connector of type 'D365 F&SCM'.

Target connector

Use a target connector of type 'Staging journal'. Make sure the 'BisConnectorStagingJournal' handler class is used.

Source document

The required setup for a source document is:

  • Document type: D365 F&SCM
  • Handler: BisMdmDocumentAxDatabase
Target document

The required additional setup for the target document is:

  • On the document header:
    • Document type: 'Staging'
    • Journal type: Enter the name of the staging journal.
    • Number sequence: Select the number sequence for the staging journal.
    • Journal table: Select 'BisStagingBufferOrderJournal'. Usually, this journal table is used.
  • On the document lines:
    • For each record, in the Record table field, enter 'BisStagingBufferTable'.
Message

The required setup for a 'Data to staging' message is:

  • On the message header, in the 'Update source status' section:
    • Status field: MessageStatus
    • Processed status: Processed
    • Error status: Error
  • On the message header, in the 'Custom' section:
    • Handler: BisMdmMessageRunDirectV2 

For more information on setting up connectors, documents, and messages, refer to Connectivity studio.

Set up MDM message - Direct

Master Data Management

To send data directly from a source company to a target company, you need two connectors, two documents and a message.

To set up these components for MDM studio, some specific setup is required:

Component Description
Source connector Use a source connector of type 'D365 F&SCM'.
Target connector Use a target connector of type 'D365 F&SCM'.
Consider re-using the source connector as target connector.
Source document The required specific setup for a source document is:
  • Document type: D365 F&SCM
  • Handler: BisMdmDocumentAxDatabase
Target document The required specific setup for a target document is:
  • Document type: D365 F&SCM
  • Handler: BisMdmDocumentAxDatabase
Consider re-using the source document as target document.
Message The required setup for a 'Direct' message is:
  • On the message header, in the 'Update source status' section:
    • Status field: MessageStatus
    • Processed status: Processed
    • Error status: Error
  • On the message header, in the 'Custom' section:
    • Handler: BisMdmMessageRunDirectV2

For more information on setting up connectors, documents, and messages, refer to Connectivity studio.

Set up MDM message - External application

Master Data Management

To send data from a source company to an external application or location, you need two connectors, two documents, and a message. 
To set up these components for MDM studio, some specific setup is required:

Component Description
Source connector

Use a source connector of type 'D365 F&SCM'.

Target connector

Use a connector of a type other than 'D365 F&SCM' or 'Staging', for example, ODBC or Windows folder. 

Source document

The required setup for a source document is:

  • Document type: D365 F&SCM
  • Handler: BisMdmDocumentAxDatabase
Target document

Use a target document with the desired external document type, for example, XML or JSON.

Message

The required setup for an 'External application' message is:

  • On the message header, in the 'Update source status' section:
    • Status field: MessageStatus
    • Processed status: Processed
    • Error status: Error
  • On the message header, in the 'Custom' section:
    • Handler: BisMdmMessageRunDirectV2 

For more information on setting up connectors, documents, and messages, refer to Connectivity studio.

Set up MDM messages with wizard - Direct

Master Data Management

In MDM studio, you can use the Create MDM message wizard to create the message for an internal direct master data setup. With an internal direct master data setup, you send data from the source (master data) company directly to the target company.

With the wizard, you create the:

  • Documents that are used in the MDM message.
  • MDM message.

Set up MDM messages with wizard - Staging

Master Data Management

In MDM studio, you can use the Create MDM message wizard to create the messages for an internal staging master data setup. With an internal staging master data setup, you send data from your source company to a staging journal. The target company triggers the message to send the data from the staging journal to the target company.

With the wizard, you create the:

  • Documents that are used in the MDM messages.
  • MDM message to send data from the source company to the staging journal (data to staging message).
  • MDM message to send data from the staging journal to the target company (data from staging message).

Set up organization hierarchy

Master Data Management

You can use an organization hierarchy to define the source company and target companies for master data distribution.

An organization hierarchy that you want to use for master data distribution:

  • Must have the 'Master data management' purpose.
  • Allows only organizations of type 'Legal entity'.

An organization hierarchy is time-effective. For master data distribution, only currently effective organization hierarchies are applied.

For more information on setting up an organization hierarchy, refer to Create an organization hierarchy.

Set up staging

Master Data Management In MDM studio, you can use a staging journal to send master data. If you send data, it first goes to the staging journal.
This topic explains how to initialize staging for a document.

Set up standard company

Master Data Management

Set up a standard company for each D365 F&SCM company that you use to distribute master data. A standard company is required for each source and each target company.

For each standard company, define the data stewards. A data steward is a user in D365 F&SCM who can send and release master data for the source company and can receive the data for the target company.
Note: A target company data steward must have full access rights in the target company and read access rights in the source company.

Set up target group

Master Data Management

If you send the same master data in the same way to several companies, you can group these companies in a target group. 

You are advised to use separate target groups for standard companies and external companies.

Provide feedback