Snapshot configuration

Configure the snapshot process by adding the snapshot configuration parameters to the properties files of the Payment Feature 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. Examples of the snapshotFileName parameter for multiple instances are shown in Table 3.

Table 1 shows the general configuration parameters for the snapshot.

Table 1. General snapshot configuration parameters
Parameter	Default value	Description
snapshotFileName	../snapshot/snapshot.zip	Identifies the name and location of the snapshot archive file. Note: The directory and file specified does not have to be on the machine taking the snapshot.
snapshotFileCount	3	The total number of snapshot files, including the current snapshot, to keep. 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 snapshotFileName 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 to 100.
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 will be created in addition to the original snapshot file. To limit the number of files created, the size of the smaller files will be as close to the maximum size value as possible. When an archive file containing a single log file is larger than the maximum size, it will not be divided into smaller files. When the smaller archive files are created, the files in the archive files may 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 to 1000. A value of 0 disables this function.
snapshotImportExportPath		The directory containing the spreadsheets used by the data setup utility. By default, this is disabled 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 containing 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 this is disabled (the parameter is blank)
snapshotIncludeConfig	false	Indicates whether the config.properties file should be included in the snapshot archive file.

Table 2 shows the Business Rules specific configuration parameters for the snapshot.

Table 2. Snapshot configuration parameters for Business Rules
Parameter	Default value	Description
snapshotBrIncludeWorkflowXmls	false	Indicates whether the workflow XML files should be included in the snapshot archive file
snapshotBrIncludeWorkflowTbls	false	Indicates whether the workflow TBL files should be included in the snapshot archive file

Configuration example 1

The snapshots can be collected and stored on a common workstation shared drive. The following example shows a snapshot configuration that collects data from two instances of Gateway, two instances of Business Rules Server, and the Transaction Server. In this example, m: represents the shared drive.

Table 3. Sample configuration for a multiple component snapshot
Component	logFileName parameter	msgTimesFileName parameter	snapshotFileName parameter
Transaction Server	tslog%g.xml		m:/TS/snapshot.zip
Gateway 1	ex1log%g.xml		m:/GW1/snapshot.zip
Gateway 2	ex2log%g.xml		m:/GW2/snapshot.zip
Business Rules Server 1	pds1log%g.xml	pds1MsgTimes.csv	m:/PS1/snapshot.zip
Business Rules Server 2	pds2log%g.xml	pds2MsgTimes.csv	m:/PS2/snapshot.zip

Configuration example 2

The following example shows the snapshot properties for a snapshot configuration that collects data from one instance of Gateway, one instance of Distribution Manager, two instances of Business Rules Server, and the Transaction Server. Each of the components also uses the newConfigurationFile property, which means that some of the configuration properties are encrypted. The encrypted properties are not included in the snapshot with the rest of the properties in the configuration properties file.

In this example, the snapshots are collected and stored in a common workstation directory. The example also defines the supportFiles directory as the directory that is used to add additional readme files, input files that create the problem, or both, to the snapshot.

Transaction Server properties:

newConfigurationFile          = properties/config.properties.enc

#
# Snapshot parameters
# ==========================
#
snapshotFileName              = /apps/dev2/ftm/rep/snapshot/snapshotITS.zip
snapshotFileCount             = 1
snapshotMaxFileSizeMeg        = 0
snapshotImportExportPath      =
snapshotUserPath              = /apps/dev2/ftm/rep/snapshot/supportFiles
snapshotIncludeConfig         = true

Gateway properties:

newConfigurationFile          = properties/config.properties.enc

#
# Snapshot parameters
# ==========================
#
snapshotFileName              = /apps/dev2/ftm/rep/snapshot/snapshotGW01.zip
snapshotFileCount             = 1
snapshotMaxFileSizeMeg        = 0
snapshotImportExportPath      =
snapshotUserPath              = /apps/dev2/ftm/rep/snapshot/supportFiles
snapshotIncludeConfig         = true

This example shows the snapshot properties for two instances of Business Rules Server. Configure only one of the instances to include the workflow XML and TBL files in the snapshot. The TBL files may be large in size and contain proprietary data, so collect these files in the snapshot only when necessary.

newConfigurationFile          = properties/config.properties.enc

#
# Snapshot parameters
# ==========================
#
snapshotFileName              = /apps/dev2/ftm/rep/snapshot/snapshotPS01.zip
snapshotFileCount             = 1
snapshotMaxFileSizeMeg        = 0
snapshotImportExportPath      =
snapshotUserPath              = /apps/dev2/ftm/rep/snapshot/supportFiles
snapshotIncludeConfig         = true
snapshotBrIncludeWorkflowXmls = true
snapshotBrIncludeWorkflowTbls = true

#
# Snapshot parameters
# ==========================
#
snapshotFileName              = /apps/dev2/ftm/rep/snapshot/snapshotPS02.zip
snapshotFileCount             = 1
snapshotMaxFileSizeMeg        = 0
snapshotImportExportPath      =
snapshotUserPath              = /apps/dev2/ftm/rep/snapshot/supportFiles
snapshotIncludeConfig         = true
snapshotBrIncludeWorkflowXmls = false
snapshotBrIncludeWorkflowTbls = false

Distribution Manager properties:

newConfigurationFile          = properties/config.properties.enc

#
# Snapshot parameters
# ==========================
#
snapshotFileName              = /apps/dev2/ftm/rep/snapshot/snapshotDM.zip
snapshotFileCount             = 1
snapshotMaxFileSizeMeg        = 0
snapshotImportExportPath      =
snapshotUserPath              = /apps/dev2/ftm/rep/snapshot/supportFiles
snapshotIncludeConfig         = true