System Administration: Ability to Customize Snapshot Configuration Files

In MYOB Acumatica 2024.2.1, a customizer can now customize a predefined snapshot configuration in multiple files, and the system will merge all changes to the same snapshot configuration. This capability may be useful when, for example, a customization project adds a new table. The customizer can exclude the records of this table from the snapshot in one customization project and edit a numbering sequence for this table in another customization project.

Snapshot Configuration Files

A snapshot configuration is stored in a ESC file, which has XML format, in the App_Data/SnapshotConfigs folder of the instance. For details, see Snapshots: Custom Snapshot Configurations.

Previously, to customize a snapshot, an administrator had to create a new type of a snapshot—that is, copy the predefined ESC file, edit it, and then add it to the App_Data/SnapshotConfigs file by using a customization project.

Now for each snapshot configuration (ESC file), the SnapshotConfigs folder has a separate folder with the same name as the ESC file.

Also, now the instance contains a single configuration for a Full snapshot. So for the Full configuration, the App_Data/SnapshotConfigs includes the Full.esc file and the Full folder.

In thе folder with the same name as the predefined snapshot configuration, a customizer can save a customization of a predefined snapshot configuration (a snapshot adjustment file). This file can contain only the differences with the predefined ESC file. The snapshot adjustment file should follow the rules described in Snapshots: Custom Snapshot Configurations. An example of a snapshot adjustment file is shown in the following code.

<Tables >
  <Exclude  table="UploadFile" />
  <Exclude  table="UploadFileInScreen" />
  <Exclude  table="UploadFileRevision" />
  <Exclude  table="NoteDoc" /> 
</Tables>

To save a snapshot adjustment file to a customization project, a customizer should select it on the Custom Files page of the Customization Project Editor. When the customization project is published, the file will be saved to the AppData/SnapshotConfigs folder of the instance. Customization projects that contain the snapshot configuration files for the previous versions should work as they did before.

Note:

An administrator can still create a custom snapshot configuration by copying the predefined file and saving it to the SnapshotConfigs folder. They can also create a folder for a custom configuration and save adjustment files for this custom configuration.

Merging of the Snapshot Configurations

When a user creates a snapshot on the Tenants (SM203520) form, if an instance of MYOB Acumatica 2024.2.1 includes multiple snapshot adjustment files, the system merges them into a single snapshot configuration, and then applies it to the predefined configuration. If the system generates an error during the merge process, a detailed error message is displayed and saved to the trace log, and the snapshot is not created. In the trace log, a user can always see the file in which the conflict occurred.

Note:

During the update process, an administrator should make sure that the configuration files are merged successfully.