Configuration File

The PDS configuration file contains the following settings:

  • Connection settings for the source database

  • Connection settings for the Patterns Server

  • A map of source-database table columns to Patterns table columns.

  • Tuning options

A fully-commented sample configuration file has the following contents:


# JDBC Driver

# Only used when the JDBC driver is not pre-packaged.

# Consult the database vendor's documetation for the class name.

# jdbcDriver: "RDBMS-specific. com.company.database.jdbc.SQLServerDriver"

# Connection settings (JDBC parameters) for connecting to the source database.

# See your database vendor’s documentation
rdbmsUrl: "RDBMS-specific"
rdbmsUser: username
rdbmsPassword: 12345678
rdbmsSchema: "RDBMS-specific"
rdbmsCatalog: "RDBMS-specific"

# rdbmsChangeLog
# Name of the source database table that contains the record changes.
# Case sensitive. Required.
rdbmsChangeLog: TPS_Addr_change_log

# rdbmsSyncState
# Name of the source database table that contains the sync state.
# Case sensitive. Required.
rdbmsSyncState: TPS_sync_state

# Connection settings for the Patterns server

patternsHost
# The IP address or DNS name of the machine where the TIBCO Patterns is
# running. Optional. Default “localhost”

patternsHost: localhost
# patternsPort
# The TCP port the TIBCO Patterns Server is listening on. Optional. Default 5051.
patternsPort: 5051

# patternsSSL
# Whether to use SSL encryption when communicating to the TIBCO Patterns Server.# Valid values are any YAML Boolean (e.g. YES or NO). Optional. Default NO.
patternsSSL: NO

# patternsTableName
# Name of the table in TIBCO Patterns that records will be synced to.
# Case sensitive. Required.
patternsTableName: Address

# Map of source-database table columns to Patterns table columns.

# columns
# Maps source-database table columns to Patterns table columns
# Defines how the RDBMS table columns maps to the Patterns table columns.
# Case sensitive. Required.
# There must be one entry for each Patterns table column.
# The values are the column-names of the RDBMS table.
# These must be ordered as they appear in the Patterns table.
# Columns in the Patterns table which have no corresponding
# column in the source database are represented by an empty
# string “”.
# For example, if the Patterns table has four columns Fname, Mname, Lname, Full_name and
# the RDBMS has three columns last, first, full:
columns:
- first # first -> Fname
- "" # (unmapped) Mname in Patterns table will always be blank
- "last" # last -> Lname
- "full" # full -> Full_name

# Tuning options

# autoPurge
# Policy for purging changes from the RDBMS after they are synced.
# Purging is performed after an empty batch is encountered.
# Valid values are:
# DISABLED: Auto-purge is disabled.
# ENABLED: Enables auto-purge only if the Patterns Table has durable-data enabled.
# This mode may cause performance issues when there is a high volume of updates.
# FORCE: Enables auto-purge unconditionally. Not recommended, it causes
# synchronization issues if Patterns is restarted without an up-to-date checkpoint.
# Optional. Default DISABLED
autoPurge: ENABLED

# batchSize
# Number of changes to sync per batch. Optional. Default 100.
batchSize: 100

# interBatchDelay
# Seconds to delay after a non-empty batch of changes. Optional. Default 0.
# May be fractional. Minimum 0, maximum 300.
interBatchDelay: 0

# emptyBatchDelay
# Seconds to delay after an empty batch of changes. Optional. Default 30.
# May be fractional. Minimum 1, maximum 300.
emptyBatchDelay: 30.0

# retryDelay
# Seconds to delay before reattempting a failed operation. Optional. Default 30.
# May be fractional. Minimum 1, maximum 300.
retryDelay: 30.0

Note:

You can find a sample (sample_pds_settings.yaml) PDS Yaml file at tps/6.1/datasync/sample.