The Helix Plan Backup Service settings file contains information about database and options for backing up your data. You must change some of the settings for the service to work correctly.
1. Open the BackupServiceSettings.txt file in the directory where you installed the service (e.g., Helix Plan\BackupService).
2. Make any changes. Replace the existing values with information about your databases.
You need to add a section with the settings for each database you want the service to back up.
3. Save the file.
4. Restart the backup service.
Settings file values
| Setting | Description | Example value |
|---|---|---|
| DatabasePath | Path to the database location. | "C:/Program Files (x86)/Helix Plan/Project Manager Server/Databases/Company_Projects/Database" |
| TransactionLogPath | Path to the database transaction log location. | "C:/Program Files (x86)/Helix Plan/Project Manager Server/Databases/Company_Projects/TransactionLog" |
| Destination | Path to the destination for the backup file. | "C:/Program Files (x86)/Helix Plan/Project Manager Server/Databases/Company_Projects/Backup" |
| BackupStartHour | Hour of the day to start the backup. Valid values are 0-23. Backups should be run outside of business hours if possible. | 2 |
| BackupIntervalHours |
Number of hours between each backup. If a backup is already running when the next backup is scheduled to begin, the latter backup may be postponed until the first has finished.
|
24 |
| BackupIntervalRetryMinutes | Number of minutes to wait before retrying a failed backup. Use 0 to disable retrying. Default is 60. | 60 |
| LogIntervalSeconds | Number of seconds between each copy status log entry while the backup runs. Adjusting this setting can help you get more frequent updates when backing up large databases. | 600 |
| BackupOnStart | Boolean that indicates if the backup service should perform a backup when the service starts. | 0 |
The backup service logs information and errors about backups. You can also provide email information in the settings file to automatically send emails to administrators when errors occur.
Example settings file
Copy
HelixPlanDatabase
{
// Required backup settings
DatabasePath "C:/Program Files (x86)//Project Manager Server/Databases/Company_Projects/Database"
TransactionLogPath "C:/Program Files (x86)//Project Manager Server/Databases/Company_Projects/TransactionLog"
Destination "C:/Program Files (x86)//Project Manager Server/Databases/Company_Projects/Backup"
// Backup scheduling
BackupStartHour 2 // 0-23
BackupIntervalHours 24
// Retry the backup if failed. Otherwise no attempt will be made until the next interval. (0 to disable, default is 60)
BackupIntervalRetryMinutes 60
// Interval between logging of copy status. (0 to disable, default is 600)
LogIntervalSeconds 600
// Do a backup when starting the service. (1 or 0, default off)
BackupOnStart 0
}
//////////////////////////////////////////////////////////////////////////////////////////
// Configure Email Notification
EmailEnableLogging 0 // Logs email communication with the smtp server to the "LogEmail" folder to enable debugging email settings
EmailServer smtp.example.local // The SMTP server to send emails through.
EmailServerPort 25 // The port of the SMTP server to send emails through.
EmailsFromName "Helix Plan Backup Service" // The name appearing in the from field on sent emails.
EmailsFromEmail "helixplan@example.local" // The email appearing in the from field on sent emails.
EmailServerLoginName "" // The login name to use to login to the SMTP server. Leave blank to disable login.
EmailServerLoginPassword "" // The password to use to log in to the SMTP server.
EmailSecurityProtocol "None" // The email security protocol to use, available options are: None, SSL or TLS
EmailSendAdminEmailsTo "admin@example.local" // The email address to send administrative emails to.
EmailSendAdminEmailsToName "Admin" // The name for the email address to send administrative emails to.