|
<< Click to Display Table of Contents >> Navigation: Appendix > Parameter Files > ReplicationScriptParameters.par |
The following parameters are read by the PDM core and have effect on the file replication process.
Determines whether the replication process shows the progress dialog.
Set this value to 0 when the replication is executed in unattended mode without logging into the server UI.
Accepted values: 0, 1
Default value: 1
Determines whether files missing on the local site are checked and downloaded.
If set to 0, only existing local files are evaluated for refresh.
Accepted values: 0, 1
Default value: 0
Determines whether standard parts are excluded from replication.
When enabled, documents recognized as standard parts are filtered out from the download plan.
Accepted values: 0, 1
Default value: 0
Determines whether replication runs in simulation mode.
When enabled, the candidate list and checks are executed, but no files are actually downloaded.
Accepted values: 0, 1
Default value: 0
Determines whether previous rows in DBW_FILE_REPLICATION_EVENT_LOG are preserved.
If set to 0, the event log rows for the local company are cleared at the beginning of each run.
Accepted values: 0, 1
Default value: 0
Determines whether only failed downloads are written to the replication event log table.
If set to 0, successful downloads are logged as well.
Accepted values: 0, 1
Default value: 1
Determines how many days replication log files are kept on disk.
Set to 0 to keep all log files.
Accepted values: 0 or any positive integer
Default value: 1
Determines the maximum number of errors allowed for the replication to be considered successful.
If the total number of errors exceeds this value, the run is marked as failed.
Accepted values: any non-negative integer
Default value: 25
Determines the amount of detail written to the replication log file.
Level 0 logs only essential information and errors.
Level 1 logs errors.
Level 2 also logs filtered and skipped candidates.
Accepted values: 0, 1, 2
Default value: 1
Determines on which weekday a full candidate scan is performed.
If set to 0, a full candidate scan is performed every day.
If set to -1, a full candidate scan is never performed.
Weekday numbering is: 1=Monday, 2=Tuesday, ..., 7=Sunday.
Accepted values: 0, 1, 2, 3, 4, 5, 6, 7
Default value: 0
Note: When START_DATE or END_DATE is specified, the explicit date range takes precedence over the incremental replication logic. In this case, FULLCHECKWEEKDAY does not remove or override the configured date filters.
Determines how many retry attempts are performed for files that fail during download.
Retries are executed only outside test mode.
Accepted values: 0 or any positive integer
Default value: 0
Determines whether an email notification is sent at the end of replication.
Value 0 disables email notifications.
Value 1 sends email only when errors occur.
Value 2 always sends email.
Accepted values: 0, 1, 2
Default value: 0
Determines the sender email address used for replication notifications.
Accepted values: any valid email address string, or - to disable configuration
Default value: -
Determines the recipient email address or addresses used for replication notifications.
Multiple recipients can be separated by comma or semicolon.
Accepted values: one or more email addresses, or -
Default value: -
[email protected];[email protected]
Determines the SMTP server used to send replication notifications.
Accepted values: SMTP server name or address, or -
Default value: -
SENDEMAIL_SMTPSERVER=smtp.company.com
Determines the SMTP login user used to send replication notifications.
Accepted values: any login string, or -
Default value: -
Determines the SMTP login password used to send replication notifications.
Accepted values: any password string, or -
Default value: -
SENDEMAIL_LOGINPASSWORD=MyPassword123
Determines a document field used to exclude candidates from replication.
When both FILTERFIELD and FILTERVALUE are set, documents where FILTERFIELD = FILTERVALUE are excluded.
Accepted values: any valid field name in the DOCUMENT table, or empty
Default value: empty
FILTERFIELD=CATEGORY
Determines the value used together with FILTERFIELD to exclude candidates from replication.
Accepted values: any string, or empty
Default value: empty
FILTERVALUE=C1
Determines a semicolon-separated list of root directories used to filter candidates by file path.
The comparison is performed against the document file directory.
Accepted values: one or more directory paths separated by ; or empty
Default value: empty
FILTERDIRECTORIESVALUES=Z:\TEMP\FILES;Z:\TEST\FILES
Determines how FILTERDIRECTORIESVALUES is interpreted.
If set to 0, files inside the listed directories are excluded.
If set to 1, only files inside the listed directories are included.
Accepted values: 0, 1
Default value: 0
Determines whether remote files in checkout state are included in candidate selection.
If set to 0, checked-out files are filtered out.
If set to 1, checked-out files are considered for replication.
Accepted values: 0, 1
Default value: 0
Determines whether revision archive files such as .gz are downloaded together with the main file.
Accepted values: 0, 1
Default value: 0
Note: Table REVISIONS needs to be replicated
Determines whether the replication log file is attached to the notification email.
The attachment is sent only if email notifications are enabled and the log size is within the configured limit.
Accepted values: 0, 1
Default value: 0
Determines the maximum allowed size, in KB, for the log file attachment sent by email.
If the log file exceeds this size, it is not attached.
Accepted values: any positive integer
Default value: 50
Determines the lower date limit for candidate selection.
When specified, only documents with LAST_MODIFIED_FILE_DATE on or after this date are considered.
This parameter has priority over the incremental replication date logic.
Accepted formats: yyyyMMdd, yyyy/MM/dd, yyyy-M-d, yyyy-MM-dd, dd/MM/yyyy, d/M/yyyy
Default value: empty
START_DATE=2026-06-01
Determines the upper date limit for candidate selection.
When specified, only documents with LAST_MODIFIED_FILE_DATE up to this date are considered.
The end date is inclusive for the whole day.
This parameter has priority over the incremental replication date logic.
Accepted formats: yyyyMMdd, yyyy/MM/dd, yyyy-M-d, yyyy-MM-dd, dd/MM/yyyy, d/M/yyyy
Default value: empty
END_DATE=2026-06-30
Determines an additional SQL join fragment appended to the candidate selection query.
The document table alias used by the generated query is d.
This parameter is intended for advanced filtering and customizations.
Accepted values: any valid SQL join fragment, or empty
Default value: empty
CANDIDATE_ADDITIONAL_JOIN=INNER JOIN REVISIONS r ON r.DOCUMENT_UNIQUE_ID = d.UNIQUE_ID
Determines an additional SQL where fragment appended to the candidate selection query.
This parameter is intended for advanced filtering and customizations.
Accepted values: any valid SQL condition fragment, or empty
Default value: empty
CANDIDATE_ADDITIONAL_WHERE=r.NOTES = 'test'
Determines the SQL order by fragment used to sort candidate documents.
This value is used by the generated candidate query to assign replication order.
Accepted values: any valid SQL order by expression, or empty
Default value: empty
If empty, the default ordering is by document type and document id.
CANDIDATE_ORDER_BY=r.APPROVAL_DATE, d.UNIQUE_ID
Determines whether document attachments are downloaded together with the main file.
Accepted values: 0, 1
Default value: 0
Note: Attachments are downloaded only when corresponding attachment records are available in the local DBW_ATTACHMENTS table. The DBW_ATTACHMENTS table is not included in database replication by default and must be explicitly added to the replication configuration.
Determines the maximum number of files that can be scheduled for download in a single replication run.
If empty, no explicit limit is applied.
Accepted values: empty or any positive integer
Default value: empty