Snapshot configuration
Configure the snapshot process by adding the snapshot configuration parameters to the properties files of the Common Services components for which snapshots are to be taken. To collect snapshots from multiple instances of a component, specify the snapshot configuration parameters in the properties file of every instance of the component. Make sure that parameters such as file and path names are different for each instance to ensure that the snapshot files from the different instances do not overwrite each other.
| Parameter | Default value | Description |
|---|---|---|
| snapshotFileCount | 3 | The total number of snapshot files to keep, including the current snapshot. Each time a
new snapshot is taken, the existing snapshot files are renamed. If the number of snapshot files exceed the
number to keep, the oldest snapshot file is discarded. For example, if snapshotFileCount is three and the default snapshot file name is used, the snapshot files that are kept are snapshot.zip, snapshot1.zip, and snapshot2.zip. When the next snapshot is taken, snapshot2.zip is discarded and the other two are renamed. The valid values for this parameter are 1 - 100. |
| snapshotFileStatusHourLimit | 24 | Limits the number of items retrieved from the GW_FILE_STAT table. With a default value of 24, it retrieves the last 24 hours of records in the table. Be aware when many records are retrieved, you might need to increase the memory of the Gateway Server. |
| snapshotMaxFileSizeMeg | 0 | The maximum file size, in megabytes, for a snapshot archive file. This parameter is used
to accommodate the attachment size restrictions used by different email systems. If the snapshot archive file size is larger than this parameter, smaller archive files are created in addition to the original snapshot file. To limit the number of files created, the size of the smaller files is as close to the maximum size value as possible. When an archive file with a single log file is larger than the maximum size, it is not divided into smaller files. When the smaller archive files are created, the files in the archive files might appear in a different order than the original snapshot archive file. The names of the smaller files indicate the order in which they were created. For example, if three smaller archive files are created, they are named snapshot.1of3.zip, snapshot.2of3.zip, and snapshot.3of3.zip. The valid values for this parameter are 0 - 1000. A value of 0 disables this function. |
| snapshotImportExportPath | The directory that contains the spreadsheets that are used by the data setup utility. By default, collecting these spreadsheets is not enabled and the parameter is set to blank. If the customer agrees to send the data they used to import data into the database, specify the directory that contains the import files. | |
| snapshotUserPath | The directory used to send any other files requested. Every file in this directory is included in the snapshot archive file. By default, sending files from this directory is not enabled and this parameter is blank. | |
| snapshotIncludeConfig | false | Indicates whether the config.properties file is to be included in the snapshot archive file. |
| Parameter | Default value | Description |
|---|---|---|
| snapshotBrIncludeWorkflowXmls | false | Indicates whether the workflow XML files are to be included in the snapshot archive file. |
| snapshotBrIncludeWorkflowTbls | false | Indicates whether the workflow TBL files are to be included in the snapshot archive file. |