Maintaining the integrity and performance of your data files is crucial for the operation of SapphireOne. This guide outlines the essential steps for data file maintenance in both Server and Single User modes. The procedures are performed utilising both the various Tabs on the server interface and the Maintenance and security centre.
Before undertaking any maintenance tasks, it is critical to ensure that a backup of the live data file is created and that no other users are accessing the data file.
Accessing Server Administration
To access Server Administration, you can do so directly by double-clicking on the server application or shortcut. Alternatively, from the top menu, select Window > Administration. In the Client application, navigate through Utilities > Server Administration.
Server Administration Tabs
Server Administration offers a streamlined interface for managing server operations through various tabs:
- Monitor Tab – Displays server details and real-time resource usage statistics.
- Users Tab – Shows active users and provides options to message, monitor, or disconnect them.
- Processes Tab – Lists current server processes, offering insights into SapphireOne’s active tasks.
- Maintenance Tab – Contains tools for data file maintenance, such as Verification, Compacting, Uptime, Backup, Request, and Debug log, to uphold data integrity and system performance.
When the SapphireOne Server is launched under Windows or macOS, a graphical administration window is available, providing many analysis and control tools. Complete documentation for all SapphireOne server administration window functionality is currently available at developer.4d.com.
Verifying Data Files
The verification process is a critical maintenance task designed to ensure the integrity and consistency of your data. By conducting this procedure, you can detect and address any potential issues early, preventing data corruption and safeguarding the smooth operation of SapphireOne within your organisation. Regular verification helps maintain optimal system performance and data accuracy, which are essential for informed decision-making and efficient business practices. Let’s proceed with the steps to verify your data file effectively.
- Ensure no users are on the server and manually back up the data file.
- Select the Maintenance Tab.
- Select the ‘Verify records and Index’ button to check both the data file and its index file. A progress alert will display, followed by a success or failure message.
- Use the report button to view the verification report in your default web browser.
Compacting Data Files
Maintaining the efficiency and performance of SapphireOne is essential for the smooth operation of your organisation. Over time, your data file can grow in size due to the accumulation of records and transactions. This can lead to longer processing times and reduced responsiveness. Compacting the data file is a crucial maintenance task that helps optimise the performance of SapphireOne by reducing the file size and reorganising the data structure for more efficient access and storage. By performing a compaction, you ensure that SapphireOne continues to operate at peak efficiency, providing faster access to data and improving overall SapphireOne performance.
It’s important to note that this process should be carried out with care, and a backup must always be created prior to initiating the compaction to safeguard your data against any unforeseen issues.
Follow the detailed steps below to compact your data file safely and effectively.
- Confirm no users are on the server and back up the data file if not already done.
- Select the compacting button to initiate the process, which will disconnect all users and shut down the server temporarily.
The server creates a “Replaced Files (Compacting) datetime” folder containing the original data files, allowing for a rollback if necessary. Compaction duration depends on the data file size and the machine’s processing power.
Timing of Maintenance
Ensuring the integrity and performance of SapphireOne is paramount for your organisation’s operational efficiency. Regular maintenance, including the verification of records and indexes, is essential. The following guidance outlines the recommended timing and procedures for maintaining the robustness of your data within SapphireOne.
- Monthly maintenance is typically sufficient, focusing on verifying records and indexes.
- Prior to running end-of-month procedures, perform a system shutdown, backup, and verification to ensure data integrity.
- Re-indexing should only be done when necessary by deleting the .4DIndx file and allowing SapphireOne to rebuild it.
Maintenance and Security Centre
The SapphireOne Maintenance and Security Centre is a critical tool for conducting routine maintenance on your data file. When accessing a data file in server mode, users can perform various actions, including the Verify function, which checks the data file’s integrity without disrupting other users activities in SapphireOne. It is essential to back up your live data file before commencing any compaction process to prevent data loss or other issues.
For the safe use of additional features or processes available within the Maintenance and Security Centre, users should follow the explicit instructions and supervision of the SapphireOne support team. These functions and procedures can have significant effects on the data file, and improper use may lead to data corruption or other serious problems. The SapphireOne support team is available to provide accurate guidance and ensure the safe execution of these tasks.
Before performing maintenance or security tasks in the Centre, it’s crucial to create a backup of your active data file to protect your data’s integrity. Verify that the backup is without errors to ensure it’s dependable. If any issues arise, this backup will be essential for restoring your data to its previous condition.
Differences between Single User and Server Modes
Single User Mode
When accessing the Maintenance and Security Centre from Single user mode:
- Direct access to the Maintenance and Security Centre is available only in SapphireOne’s Single User mode.
- This mode ensures that only one user is logged into the data file, preventing conflicts or corruption.
- All functions, including Verification and Compaction, are available to the user. However, backing up the live data file before undertaking any risky actions is crucial.
Server Mode
When accessing the Maintenance and Security Centre from Server mode:
- Access to the Maintenance and Security Centre from the server window is not available.
- Users can still perform the Verify function and compact the data file during server shutdown to optimise performance and size.
- A backup of the live data file is mandatory before any compaction process.
- The server will undergo a polite shutdown before compaction, which may take several hours for larger data files.
Single User Procedure
To access the Maintenance and Security Centre in Single User mode, users must link the necessary data file to the current build by logging in and out at least once. This step is essential for SapphireOne to access the data file. Once linked, users can utilise the Centre’s features and processes for maintenance and security tasks. Again, creating a backup of the active data file before commencing actions is imperative. The procedure is as follows.
- For Mac OS Users – Double-click the SapphireOne Icon while holding down the Alt/Option Key until an alert message appears.
- For Windows Users – Double-click the SapphireOne Icon, then hold the Alt/Control key until the alert message is displayed.
After selecting the Open the Maintenance and Security Centre option, follow the on-screen instructions for verification.
Do not select any other options unless directed by SapphireOne staff. If errors are detected during verification, they will be logged, and users should contact SapphireOne support for assistance.
In conclusion regular maintenance of your data files ensures the optimal performance of SapphireOne. By following these guidelines, your organisation can maintain data integrity and prevent potential issues. Should you encounter any errors or require assistance, please contact SapphireOne support staff.
You can review our Blog and YouTube channel for additional information and resources on SapphireOne ERP, CRM and Business Accounting software.