Set up and manage archive data in finance and operations apps
This article describes how to set up and manage archive data in Microsoft Dynamics 365 Finance and operations apps.
Required privileges
The following privileges are required:
In Power Platform:
The System Administrator and System Customizer roles in Power Platform admin center.
To confirm that you have these privileges, follow these steps.
- In the Power Platform Admin Center, go to Environments.
- Select the relevant environment.
- In the Access section, select users.
- Select Installing user > Roles. Confirm the necessary privileges.
In Microsoft Dynamics 365 Finance and operations apps:
The System administrator role in Microsoft Dynamics 365 Finance and operations apps.
To confirm that you have these privileges, follow these steps.
- In Dynamics 365 Finance and operations apps, go to System administration.
- Select Users > Users.
- Select Installing user > Roles. Confirm the necessary permissions.
In Microsoft Dynamics Lifecycle Services:
- The Organization Admin role to create environments. Additionally, the Project owner or Environment manager role must be assigned to the user in the Project security role field in Lifecycle Services.
Prepare the environment
To prepare your environment to archive data, follow these steps.
To align it with your production instance, refresh your PROD data in your sandbox instance.
Ensure that your sandbox instance is on the latest version of Dynamics 365 Finance and operations apps version 10.0.39 or later. Be sure to apply the latest quality updates for the version.
Under license configuration, ensure that SQL row version change tracking is enabled. If it isn't enabled, follow these steps:
- In Microsoft Dynamics Lifecycle Services, select the environment, and go to Maintain > Enable Maintenance Mode.
- Sign in to Finance and operations apps, and go to System administrator > Setup > License configuration. Select the SQL row version change tracking checkbox, and then select Save.
- In Lifecycle Services, select the environment, and then select Maintain > Disable Maintenance Mode.
Note
If the Microsoft Power Platform environment isn't set up for the sandbox instance, complete the setup in Lifecyle Services.
Set up Finance and operations apps to archive data with Dataverse long-term retention
To archive data, follow these steps to confirm that the Dataverse archive add-in can be installed.
- In Power Platform admin center, go to Environments, select the environment, and then select Dynamics 365 apps. Ensure that the Power Platform environment is a Managed Environment.
- Update the Finance and operations virtual entity app if the status is Update available.
- If the Dynamics 365 finance and operations platform tools app isn't installed in Power Platform admin center for the selected environment, install it.
- Install Dynamics 365 Archive with Dataverse long term retention from the Power Platform admin center.
- If you already have the app installed, you should install the latest update.
Enable finance and operations data archival with Dataverse long-term retention
- In Finance and operations apps, go to Feature management.
- Select the Archive with Dataverse long term retention feature for overall archival service integration. This feature enables all supported Finance functional scenarios for archiving with Dataverse long-term retention.
The Archive with Dataverse long term retention workspace should now be available in the Workspaces list in Finance and operations apps.
Schedule an archive job
Note
Before you schedule an archive job, check for custom fields in archive tables by running the validate archive table schema script. If custom fields are found, follow the instructions in Archive customization to include those fields in the data archive.
- You can schedule Finance and operations apps archive jobs from the archive workspace for supported functional scenarios by using the new long-term retention job wizard.
- While you can schedule a time during which you would like the job to run in order to minimize impact on other database operations, only the move to history process runs during the scheduled window. The other asynchronous archive processes for Dataverse long term retention occur continuously even outside of the scheduled duration.
- Only one archive job across all scenarios runs at any given time. The scheduled job starts to run only after the previous archive job is completed.
Important
Known issue: When you submit a new archive job for the first time, you might receive this error message: "An error occurred while accessing the archive service. Please check your archive service installation."
Workaround: Wait 15 minutes, and then resubmit the archive job.
View archive job progress
The Finance and operations apps archive workspace provides the following details about the archival process as it progresses through its various stages.
The Job status column that's visible for each archive scenario captures the overall status of the archive job.
| Job status | Description |
|---|---|
| Scheduled | A job is scheduled, but it isn't being processed yet. Details about the scheduled date and time are available on the dashboard. |
| In progress | The archive job is in progress. Some of the interim stages in the archive job might be completed. |
| Complete | All stages of the archive job are complete. |
| Failed | The archive job failed. |
You can view the detailed progress log for each archive job by selecting View progress > View detailed logs.
Note
The In progress status indicates that the end-to-end archival process is ongoing, even if individual stages are completed.
View information in the Finance and operations apps archive workspace
| Information | Description |
|---|---|
| Initiating long term retention | The long-term retention job is activated. |
| Initial sync for <tablename> in progress [x of y records synced] | Initial synchronization to the Dataverse long term retention is in progress. |
| Initial sync for <tablename> completed | Initial synchronization to the Dataverse long term retention is completed. |
| Marking in progress [x of y records of <tablename> marked] | The process is marking records in the finance and operations live application table for archiving, and the equivalent records in the Dataverse long term retention are being updated as retained. |
| Reconciliation in progress | Reconciliation is in progress to verify that the records that are marked as retained in Dataverse long term retention match the records that are marked for archiving in the finance and operations live application tables. |
| Reconciliation completed | Reconciliation for all finance entities is completed. |
| Pending move to history | The move to history process is waiting to begin. |
| Initiating move to history | The move to history process is activated. |
| Staging data for move to history in progress [x of y records of <tablename> staged] | Data is in the staging/queueing process for the move to history. |
| Staging data for move to history completed for <tablename> | Staging/queueing completed for the specified table. |
| Staging data for move to history completed for all tables | Staging/queueing completed. |
| Move to history in progress [x of y records of <tablename> moved] | Data is being moved from live tables to history tables. |
| Completed archival of table <tablename> | The move to history process completed for the specified table. |
| The archive job is complete | The end-to-end archival process completed for all tables in the functional scenario. |