How to Use the DIM Rotate Database Tool Guide

How to Use the DIM Rotate Database Tool Guide

The DIM Rotate Database Tool prevents Companies from encountering Sent Form processing delays and possible stoppage issues in the Data Integration Module (DIM) due to large histories of processed Sent Forms. This tool fixes or prevents issues by renaming and archiving the DIM's old database file and creates a new one that only downloads data from the current date forward. This keeps the DIM running smoothly with minimal downtime and prevents any unexpected stoppages.

Step-by-Step Guide
  1. Download the Rotate Database Tool
    1. The Rotate Database Tool is also available in the file share:
    2. 32-Bit Version
    3. 64-Bit Version
    4. Copy the RotateDatabase_X.exe (where X is the x86 for 32-Bit and x64 is for 64-Bit) into the DIM installation directory.
      1. This may prompt before Administrator access since the DIM is typically installed in a protected Program Files folder.
  2. Choosing the Correct Version to download the Rotate Database Tool
    There are two versions of the tool: RotateDatabase_x86.exe and RotateDatabase_x64.exe.
    1. If you installed the 32-bit version of the DIM, use RotateDatabase_x86.exe (even if your server is 64-bit).
    2. If you installed the 64-bit version of the DIM, use RotateDatabase_x64.exe.
    3. If you run the wrong version, the tool will simply result in outputting an error.
  3. Stop the DIM Service
    1. The DIM service must be stopped while the tool runs. It runs quickly, so downtime will be minimal.
      1. The DIM Service can be stopped using the DIM Admin Utility or using Windows Services. If the DIM Admin Utility is used, close that application after stopping the service.
    2. Make sure all pending work in the DIM is completed before running the tool. Any queued dispatches will be dropped and skipped after running the tool.
  4. Deploy and Run the Tool
    1. Open an elevated command prompt and navigate to the DIM installation directory.
      1. This is necessary because the DIM is typically installed in a protected Program Files folder.
    2. Run RotateDatabase_X.exe (where X is the x86 for 32-Bit and x64 is for 64-Bit).
    3. The tool will display informational messages in the command window and print ‘Done’ when complete.
  5. Verify and Restart
    1. After the tool runs successfully, use the File Explorer to confirm the old Transformer.sdf file will be renamed with a timestamp (e.g., Transformer.20220315T143212.sdf).
    2. A new Transformer.sdf file will be created with empty dispatch queues.
    3. Restart the DIM service and verify that it resumes downloading and processing data from where it left off.
    4. If the DIM service account has custom permissions, you may need to update permissions on the new Transformer.sdf file.
  6. Handling Errors
    1. If there are any errors, the old Transformer.sdf file will remain intact, and error information will be written to the console.
    2. You can resume the DIM with the old database file and send the error information to the Technical Support Team for further debugging.
Notes
Side Note: If you're upgrading the DIM and have a large database, use the Rotate Database Tool to archive the Transformer.sdf file. This will help ensure a smooth upgrade. If the old Transformer file has been archived, previously used minRFITimestamps in project files will no longer limit jobs by date, and the DIM will remember where it left off and continue from there. Downloading previously sent forms post-rotation is not recommended.

By following these steps, you can ensure that your DIM continues to process forms efficiently, even with high traffic. If you encounter any issues, please reach out to our Support Team, email us at F2BSupport@field2base.com.