1. To-Increase Dynamics 365 for Finance & Operations
  2. Data modeling studio
  3. Setting up and maintaining Data modeling studio

Set up parameters

Before you can use Data modeling studio, define the Data modeling studio parameters.


DMS Administrator DMS Administrator Start Start Set up entity creation parameters Set up entity creation parameters Set up the parameters that are applied: To the creation of Data sets in D365 FO. On deploy, to the creation of entities in the target database. Procedure 1. Go to Data modeling studio > Data modeling studio > Parameters. 2. Sub-task: Set the prefixes and suffix parameters. 3. You can define a prefix for system fields. On deploy, the prefix is applied when the system fields are added to the applicable table in the target database. Example: If the entity system fields prefix is 'CDP' and systems fields are added to a table on the target database, the system field name is 'CDPRecId'. In the Entity system fields prefix field, type a value. Note: The default entity system fields prefix is 'CDP'. If you use CDPR on the data warehouse, you must always use 'CDP' as entity system fields prefix. If you don not use CDPR, you can define a prefix as desired. 4. You can define a prefix that is applied: - To the creation of Data sets in D365 FO. The defined entity prefix is added as prefix to the data set identification. Example: If the entity prefix is 'CDP' and you create a data set for the SalesTable, the data set identification is 'CDPSalesTableDataEntity'. - On deploy, to the creation of tables in the target database. The defined entity prefix is added as prefix to the table name in the target database. Example: If the entity prefix is 'CDP' and on deploy, on the target database, a table is created for the SalesTable, the table name is: CDPSalesTableSTAGING. In the Entity prefix field, type a value. Note: -The default entity prefix is 'CDP'. If you use CDPR on the data warehouse, you must always use 'CDP' as entity prefix. If you don't use CDPR, you can define a prefix as desired. - If the entity prefix is changed between the creation of a data set and deploy, the entity prefix from the parameters is applied. So, it overwrites the prefix as applied to the data set identification. - On deploy, the entity prefix is not applied to the creation of metadata tables. - On deploy, the entity prefix is applied to the creation of the financial dimensions table. 5. You can define a suffix that is applied, on deploy, to the creation of tables in the target database. The defined entity suffix is added as suffix to the table name in the target database. Example: If the entity suffix is 'STAGING', and on deploy, on the target database, a table is created for the SalesTable, the table name is 'CDPSalesTableSTAGING'. In the Suffix field, type a value. Note: - On creation of a data set, the fixed 'DataEntity' suffix is applied. On deploy, this suffix is replaced with the entity suffix as defined in the parameters. For example, if a data set identification is CDPSalesTableDataEntity, on deploy, the table name in the target database becomes 'CDPSalesTableSTAGING'. - On deploy, the entity suffix is not applied to the creation of the metadata tables and the financial dimensions table. 6. Sub-task: Set the fields parameters. 7. In the Add date and time fields field, select the desired option: 'Yes' or 'No'. 8. You can define the default value for the Add system fields field on the data set. If, on the data set, this field is set to 'Yes', on deploy, the table system fields are added to the target database. On export, the data of these system fields is also exported. In the Add system fields field, select the desired option: 'Yes' or 'No'. Note: If you add system fields to the target database, these fields get a prefix in the target database as defined by the Entity system fields prefix parameter. Set up data export parameters Set up data export parameters Set up the parameters that are applied: To scheduling an export batch job. During the export of data, like timeout settings. To creation of data models: Schema. Procedure 1. Go to Data modeling studio > Data modeling studio > Parameters. 2. Click the Data export tab. 3. Sub-task: For DMF parameters, refer to Data management framework documentation. 4. Sub-task: Set scheduling parameters. 5. You can define a default recurrence in hours. On creation of a data model, this recurrence is used to set the default recurrence of the data model. If you schedule an export batch job for the data model, the data model default recurrence is used to set the default batch job recurrence. In the Recurrence (in hours) field, enter a number. Note: If the default recurrence parameter is changed after the creation of a data model, the default data model recurrence is not changed. 6. In the Window size field, enter a number. 7. You can define the schema that is used to set the default schema for a data model. On deploy of a data model, the schema is applied to create the tables in the target database. In the Schema field, type a value. Note: In an ETL (Extract, Transform, Load) process, the best practice schema for unprocessed data is 'RAW'. 8. The export of data from D365 FO to the target database is done by the Bulk copy (SQLBulkCopy) function. You can define a timeout to limit the time of an export. If you define an export timeout, the data export is stopped when the defined number of seconds has passed. If an export is stopped by a timeout, the data export is rolled back and the entity export status is set to Error. In the Export timeout (in seconds) field, enter a number. Note: If the timeout is 0 seconds, no timeout is applied. 9. On export, several SQL operations can be executed on both the D365 FO database and the target database. These SQL operations are triggered by the Execute command (ExecuteCommand) function. An operation can be, for example, a count on the Target database or a select on the D365 FO database. You can define a timeout to limit the execute command SQL operation execution time. If you define a command timeout, the operations execution is stopped when the defined number of seconds has passed. If an operation is stopped by a timeout, no response is returned. In the Command timeout (in seconds) field, enter a number. Note: If the timeout is 0 seconds, no timeout is applied. 10. On deploy, you can apply transformations. You can define a timeout to limit the time of a transformation execution. The timeout is applied to each transformation separately. If you define a timeout, a deploy transformation execution is stopped when the defined number of seconds has passed. When a transformation is stopped by a timeout, the transformation is rolled back and no transformation is done. In the Transformation timeout (in seconds) field, enter a number. Note: If the timeout is 0 seconds, no timeout is applied. 11. On data export, you can apply pre- and post-export transformations. You can define a timeout to limit the time of a transformation execution. The timeout is applied to each transformation separately. If you define a processing timeout, an export transformation execution is stopped when the defined number of seconds has passed. When a transformation is stopped by a timeout, the transformation is rolled back and no transformation is done. In the Post-processing timeout (in seconds) field, enter a number. Note: If the timeout is 0 seconds, no timeout is applied. Set up metadata synchronization parameters Set up metadata synchronization parameters Set up the metadata-related parameters. Procedure 1. Go to Data modeling studio > Data modeling studio > Parameters. 2. Click the Metadata synchronization tab. 3. Sub-task: Set application metadata parameters. 4. In the Export labels field, select the desired option: 'Yes' or 'No'. 5. In the Export enumerations field, select the desired option: 'Yes' or 'No'. 6. In the Export data dictionary field, select the desired option: 'Yes' or 'No'. 7. You can indicate if, on deploy, the CDPManifestTableSTAGING must be created in the target database. This table contains information of the Data modeling studio as installed for D365 FO. The information includes, for example, version information and used prefixes. On deploy, for the created CDPManifestTableStaging table, also the data is exported from D365 FO to the target database. In the Export manifest field, select the desired option: 'Yes' or 'No'. Note: In the target database, the CDPManifestTableSTAGING is (re)created on deploy of each data model. 8. Sub-task: Set processing metadata parameters. 9. These fields together define the default value of the Processing metadata field for each created data model: - Synchronize data export log - Synchronize data export details On creation of a data model, only if both of these parameters are set to 'Yes', the Processing metadata field on the Data model page is set to 'Yes'. If for a data model the Processing metadata field is set to 'Yes', on deploy, these tables are created and filled in the target database: - CDPLogStaging: This table is used to log the deploy and export history. It shows the export history using messages. - CDPProcessingStaging: This table is used to log the deploy and export processing history. It shows the technical details of the export history. On data export, the data in these tables is updated. In the Synchronize data export log field, select the desired option: 'Yes' or 'No'. Note: You can view the log and processing history on the Data exchange monitoring page. 10. In the Synchronize data export details field, select the desired option: 'Yes' or 'No'. 11. In the Processing record retention (days) field, enter a number. 12. In the Log record retention (days) field, enter a number. 13. Sub-task: Set data model metadata parameter. 14. In the Synchronize data set configuration field, select the desired option: 'Yes' or 'No'. 15. Sub-task: Set entity export status parameter. 16. In the Entity export status field, select the desired option: 'Yes' or 'No'. 17. Sub-task: View metadata table dates. 18. For the Data modeling studio metadata tables, the data is collected in D365 FO and stored in these tables in D365 FO. On deploy or export, for some of these metadata tables, the data is taken from these metadata tables in D365 FO. For other metadata tables, the data is used in data modeling. It is important to keep the data in the metadata tables up to date. To update the metadata in the metadata tables in D365 FO, click Update metadata. Note: Make sure to update the metadata tables after each change or creation of a data model. Set up maintenance parameters Set up maintenance parameters Several upgrade scripts are available to be used on upgrading your Data modeling studio installation to a newer version. Probably, most of these upgrade scripts aren't applicable anymore to must of the Data modeling studio installations. The only one that can possibly be applicable is the Upgrade post processing script (updateStagingEntitySuffixScript). You can use this upgrade script if you upgrade your Data modeling studio installation from a version that's older than 10.0.25.... This script solves possible issues with the entity suffix. Run the script after you have upgraded your Data modeling studio installation to the newest version. You can also define some diagnostics-related settings. Procedure 1. Go to Data modeling studio > Data modeling studio > Parameters. 2. Click the Maintenance tab. 3. Sub-task: Run upgrade script. 4. In the list, find and select the Upgrade post processing script (updateStagingEntitySuffixScript). 5. Click Run selected script. Note: You can run the upgrade script only once. If it has run successfully (Status='Success'), the Run selected script button is disabled. Also, if you click Run all scripts, the scripts which Status is 'Success' are not run. 6. Sub-task: Define diagnostics settings. 7. Select Yes in the Metadata caching field. 8. By default, on data export, SQL statements are only logged if an error occurs. For diagnostics or troubleshooting purposes, you can have all SQL statements logged on data export. Select Yes in the SQL execution field. Note: If you select 'Yes', a dialog is opened where you can define the SQL statement logging settings. 9. In the Model name field, enter or select a value. 10. In the Data entity field, type a value. 11. In the Number of executions field, enter a number. 12. Click OK. 13. Close the page. End End

Activities

Name Responsible Description

Set up entity creation parameters

DMS Administrator

Set up the parameters that are applied:

  • To the creation of Data sets in D365 FO.
  • On deploy, to the creation of entities in the target database.

Set up data export parameters

DMS Administrator

Set up the parameters that are applied:

  • To scheduling an export batch job.
  • During the export of data, like timeout settings.
  • To creation of data models: Schema.

Set up metadata synchronization parameters

DMS Administrator

Set up the metadata-related parameters.

Set up maintenance parameters

DMS Administrator

Several upgrade scripts are available to be used on upgrading your Data modeling studio installation to a newer version. Probably, most of these upgrade scripts aren't applicable anymore to must of the Data modeling studio installations.

The only one that can possibly be applicable is the Upgrade post processing script (updateStagingEntitySuffixScript). You can use this upgrade script if you upgrade your Data modeling studio installation from a version that's older than 10.0.25.... This script solves possible issues with the entity suffix.

Run the script after you have upgraded your Data modeling studio installation to the newest version.

You can also define some diagnostics-related settings.

Provide feedback