4 - MODE OPTIONS
Mode options modify the behavior of Action options. All Mode options are optional and do not accept values.
Mode Option -AW (-AnyWhere) :
works with Info option -BP (-BatchProcess) to use an empty working directory so that the recorded dsupdt command can be executed from any directory, rather than only from the directory where it was originally recorded.
Mode Option -BG (-BackGround) (Alias: -b) :
(Alias: -b) — background process. When present, screen display is suppressed for both standard output and errors.
Mode Option -CA (-CheckAll) :
allows the check update action -CU (-CheckUpdate) to verify availability of all remote files. Without it, checking stops after the first unavailable file.
Mode Option -CN (-CheckNewer) (Alias: -CheckNewFile) :
when the server file is available locally, checks whether it has changed on the server and re-downloads it if so. This option is ignored if -RD is present. A local copy of the data file is required for the comparison. This copy is normally the local copy of the server file, but may also be an existing remote or local file with identical content, even if the name differs.
For this option to work correctly, specialists must maintain a valid local copy of the data file together with a download command capable of detecting server-side changes. Suitable commands include ‘cp’, ‘mv’, and ‘tar’ for local files, and ‘scp’, ‘wget’, and ‘ncftpget’ for remote files. Custom download commands must include built-in logic for detecting server-side changes.
When the server and local time zones differ, provide -HO (-HourOffset) with the hour difference so that local and remote file timestamps can be compared correctly.
Mode Option -CP (-CurrentPeriod) :
allows update actions when the current date/hour falls within the current update period, even if the data end date/hour is not yet due.
Mode Option -EE (-ErrorEmail) :
sends an email notification only when an error occurs during the update action.
Mode Option -FO (-FormatOutput) :
formats the output of GET actions so that all values in a given field share the same dynamically calculated column width.
Mode Option -FU (-FutureUpdate) (Alias: -ForceUpdate) :
forces an update for at least one end date/time, even if the update is not yet due.
Mode Option -GZ (-GMTZone) (Aliases: -GMT, -GreenwichZone, -UTC) :
(Alias: -GMT|-GreenwichZone|-UTC) uses GMT rather than local time as the reference for update action scheduling.
Mode Option -HU (-HourlyUpdate) :
forces time tracking to advance in hourly steps after a successful data file archive.
Mode Option -IE (-IgnoreError) :
used with -MU (-MultipleUpdate), skips failed updates and continues processing subsequent periods. For records with a valid interval defined, dsupdt also looks back over that interval to re-archive any missing data.
Mode Option -KR (-KeepRemote) (Alias: -KeepRemoteFile) :
(Alias: -KeepRemoteFile) preserves the remote file on disk by copying it to the local file location rather than moving it.
Mode Option -KS (-KeepServer) (Alias: -KeepServerFile) :
(Alias: -KeepServerFile) preserves the server file on disk by copying it to the remote file location rather than moving it.
Mode Option -LO (-LogOn) (Alias: -LoggingOn) :
(Alias: -LoggingOn) turns on detail logging when Info option -PL (-ProcessLimit) is present for update actions.
Mode Option -MD (-MyDataset) :
allows a specialist to add or modify update records for a dataset owned by another specialist.
Mode Option -MO (-MissedOnly) :
skips files that are already archived. Typically used with -MU (-MultipleUpdate). Ignored when -RA, -RD, or -CN is present.
Mode Option -MU (-MultipleUpdate) :
processes all available elapsed update periods. Without this option, only the most recent period is processed.
Mode Option -NC (-NewControl) (Alias: -NewUpdateControl) :
is required when adding a new update control record via -SC (-SetControl) with a control index of 0. It guards against unintentional record creation.
Mode Option -NE (-NoEmail) :
suppresses all post-update email notifications.
Mode Option -NL (-NewLocfile) (Alias: -NewLocalFile) :
is required when adding a new local file record via -SL (-SetLocalFile) with a local file index of 0. It guards against unintentional record creation.
Mode Option -NY (-NoLeapYear) :
skips February 29 for leap years.
Mode Option -QE (-QuitError) (Alias: -QuitOnError) :
(Alias: -QuitOnError) stops all update processing for the dataset on the first error, rather than skipping the failed file and continuing.
Mode Option -RA (-RetryArchive) :
forces re-archiving of local files by passing -RA to dsarch.
Mode Option -RD (-RetryDownload) (Alias: -Redownload) :
(Alias: -ReDownload) retries downloading the remote file when it already exists locally, for Action -DR (-DownloadRemote).
Mode Option -RE (-ResetEndTime) :
resets the end date/hour when the file timestamp is newer than the end date/hour plus one update frequency.
Mode Option -RO (-ResetOrder) (Alias: -Reorder) :
(Alias: -Reorder) resets execution order indices to match the sequence in which local files are provided to -SL (-SetLocalFile). Alternatively, explicit order indices can be supplied via -XO (-ExecOrder); valid order index values are 1, 2, 3, …
Mode Option -SE (-SummaryEmail) :
sends a brief summary email after the update action, omitting detailed log information.
Mode Option -UB (-UseBeginTime) :
uses the beginning time of the update period to replace temporal patterns in file names, download commands, and other fields.
Mode Option -UT (-UpdateTime) :
forces an update of the data end time and the next-due update times in local file records, regardless of whether the update actions succeed.