Once you've completed all the steps in your Vizlib Server installation and configuration, it's a good idea to implement back up and recovery procedures for your database. This article contains instructions on the information you'll need for backing up Vizlib Server, the location of this information e.g. Vizlib Management Console (VMC) and any other requirements.
Important: Vizlib Server does not have any specific database backup functions. We recommend you use the backup methods/principles advised for your database instance and apply the process to the information mentioned in this article
TABLE OF CONTENTS
- Vizlib Server Backup Information
- VMC Server Configuration
- Vizlib Server Database Recovery - Snapshot
- Vizlib Server Database Recovery - New Machine
- Postgres Database Backup
Vizlib Server Backup Information
Regular database backups will store a version of your database which can be used to rebuild it, helping protect you against events like table corruption, general system problems and unsuccessful upgrades. Each Vizlib Server installation sets up a Postgres database instance as a default, which hosts backend functions for Vizlib Finance and Vizlib Collaboration products. Table 1 lists the information you'll need to include for a backup, including application data, configuration settings and certificate information.
Table 1: Backup Data Requirements
| Data Type | Location and Backup Requirements |
|---|---|
| Comments Data (Vizlib Finance and Vizlib Teamwork) | The location for Comments data is held in the database integration settings in the VMC. Comments are written to a database server, then the data is stored and backed up in line with any other database in your environment. If the default database is used, it should be backed up from Vizlib Server as often as required, either by using a snapshot of the local server or restoring a database from a back up. |
| Writeback Audit Data | The location for Writeback Audit data is held in the database integration settings in the VMC. |
| Writeback Data | If Writeback data uses the default Postgres integration, additional tables are created by users or database admins, and should be identified and backed up as required. Table names and locations will depend on the details entered by the user / admin during the table setup process. |
| Configuration/Settings | Vizlib Server settings and configuration options are stored in the local Postgres database. The server hosting the Vizlib Server installation can have the previous day's settings restored using a daily snapshot, but the recommended solution is to export the server configuration after each change (for a more up-to-date backup). The exported file should be stored in a secure location that can be reached during recovery, with a step by step guide on how to export and import the configuration. Server configuration can be exported and imported using the VMC (see VMC Server Configuration below). |
| Certificates | Full details of SSL certificate requirements are held in the prerequisites article here. Save the certificate files to a location which can be reached easily from Vizlib Server. |
| Oracle Files | If you are working an Oracle database, back up and store the files tnsnames.ora, sqlnet.ora and cwallet.sso) as they will be required for restoring the database on a new server. |
VMC Server Configuration
In the VMC under System Settings > Server, there is an Export Config button you can use to create and export a JSON file containing the server configuration settings (Figure 1). There's also an Import Config button which can be used to import a JSON configuration file. Import Config is enabled when a valid file path is entered in Path to config JSON file.
Figure 1:VMC Server Configuration
Vizlib Server Database Recovery - Snapshot
The instructions in this section are a guide on recovering a database integration using a snapshot. We recommend checking the recovery instructions for the server hosting the Vizlib Server installation, in case any specific actions are required (e.g. Windows Server manages services in Task Manager).
Recover the database from the snapshot.
Stop the Vizlib Server service running.
Restore the database according to the steps outlined for the database type.
Start the Vizlib Server service again.
Import the exported server configuration (if needed).
Vizlib Server Database Recovery - New Machine
The instructions in this section are a guide on recovering a database integration on a new host server. We recommend checking the recovery instructions for the database, in case specific actions are required.
Install and configure Vizlib Server, using the instructions here.
Stop the Vizlib Server service running.
Restore the database (consulting database documentation if required).
Start the Vizlib Server service.
Import the exported server configuration (If needed).
Postgres Database Backup
Vizlib Server installs a Postgres database by default, which has an automated backup process for a Windows installation. You can find more information on Postgres backup here, and we've included an example Powershell backup script below.
REM Version 1.1, This File needs to be filled manually
REM Set backup folder, default ?:\VizlibServer\Backup\DB
SET BACKUP_FOLDER=D:\VizlibServer\Backup\DB\
REM BACK_FILE is the name of the backup coming out.
SET BACKUP_FILE=VizlibDB_%date%_%random%.backup
REM Verification of the backup filename, this row can be commented and used for troubleshooting.
echo backup file name is %BACKUP_FILE%
REM Set the log of the backup execution, default is ?:\VizlibServer\Backup\Logs\
SET LogFolder=D:\VizlibServer\Backup\Logs\
REM File the database password
SET PGPASSWORD=PASSWORD
REM Execution of the backup with all Collected options:
echo on "%ProgramFiles%\VizlibServer\postgres\bin\pg_dump" -h localhost -p 1982 -U postgres -F c -b -v -f %BACKUP_FOLDER%%BACKUP_FILE% Vizlib>>%LogFolder%%date%_%random%_log.txt
REM %date:~10,4%-%date:~4,2%-%date:~7,2%