3.4.11 - Archive Help Files

Action Option -AH (-ArchiveHelpFile) (Aliases: -ArchiveHelp, -ArchHelp, -ArchHelpFile) :

(Alias: -ArchiveHelp|-ArchHelp|-ArchHelpFile), copies local files to the GDEX Server as Help files (Documents and Software) and registers them in GDEXDB. One or more files may be archived per execution.

dsarch [-(DS|dataset)] dNNNNNN -(AH|ArchiveHelpFile) [Mode Options]

-(LF|LocalFile) LocalFileNames

[-(HF|HelpFile) HelpFileNames]

[-(HT|HelpFileType) HelpFileTypes]

[-(FS|FileStatus) HelpFileStatus]

[-(FF|FileFlag) FilesOrPaths]

[-(DF|DataFormat) FileContentFormat]

[-(AF|ArchiveFormat) FileArchiveFormat]

[-(DO|DisplayOrder) DisplayOrderIndices]

[-(SZ|Size) FileSizes]

[-(LC|Location) StorageLocationFlags]

[-(MC|MD5Checksum) MD5ChecksumValues]

[-(DE|Description) SavedFileDescriptions]

[-(VS|ValidSize) MinSizeForValidFile]

[-(LN|LoginName) LoginAccountName]

[-(QS|QsubOptions) PBSBatchOptions]

[-(BP|BatchProcess) [BatchControlInfo]]

[-(DD|DeleteDir) DeleteLocalDirLevel]

[-(DB|Debug) DebugModeInfo]

Available mode options:

-(BG|BackGround)	runs in background; suppresses screen output and errors
-(CL|CleanLocal)	removes local files after all are successfully archived
-(EM|EMailNotice)	sends an email summary (including any errors) when the action completes or aborts
-(GZ|GMTZone)	uses GMT rather than local time for archiving timestamps
-(KP|KeepLocalPath)	uses local file paths as relative paths on the GDEX Server
-(MD|MyDataset)	allows any specialist to set GDEXDB information, regardless of dataset ownership
-(NE|NoEmail)	suppresses email notification on failure
-(NT|NoTrim)	skips trimming of spaces and comments from input values, speeding up input file processing
-(OE|OverrideExist)	overwrites existing Help files
-(RO|ResetOrder)	resets display order indices to match the order files are given per -HF. Alternatively, use -ON (-OrderNames) to reorder all files in the dataset and affected groups
-(SC|SetChecksum)	computes MD5 checksums for Help files and saves them to GDEXDB

Local file names are provided via -LF (-LocalFile). On the command line, ‘*’ and ‘?’ wildcards are supported. Files not in the current directory must include relative or absolute paths. If a directory is given via -LD (-LocalDirectory), files are gathered recursively.

Local file names are used as Help file names by default unless -HF (-HelpFile) is given explicitly. When -KP (-KeepLocalPath) is specified, local file paths are used as-is on the GDEX Server.

The number of values supplied to Info options must match the number of local file names, except for options that accept a single shared value: -DF, -AF, and -HT (-HelpFileType).

The storage location is set via -LC (-Location). Defaults to ‘B’ (both Web Disk and bOreas).

Back to Top

Back to Table of Contents