3.4.5 - Set Help File Information

Action Option -SH (-SetHelpFile) (Alias: -SetHelp) :

creates new or updates existing Help file records (Documents and Software) in GDEXDB for the specified dataset. Multiple records can be processed in a single run.

dsarch [-(DS|Dataset)] dNNNNNN -(SH|SetHelpFile) [Mode Options]

[-(HF|HelpFile) HelpFileNames]
[-(WU|WebURL) RemoteFileWebURL]
[-(SR|Source) ContributionSource]
[-(ON|OrderNames) OrderNameString]
[-(OB|OrderBy) OrderByPattern]
[-(HT|HelpFileType) HelpFileTypes]
[-(FS|FileStatus) HelpFileStatus]
[-(FF|FileFlag) FilesOrPaths]
[-(LC|Location) StorageLocationFlags]
[-(DF|DataFormat) DataFormats]
[-(AF|ArchiveFormat) FileArchiveFormats]
[-(DO|DisplayOrder) DisplayOrderIndices]
[-(SZ|Size) FileSizes]
[-(MC|MD5Checksum) MD5ChecksumValues]
[-(ID|InitialDate) HelpFileInitialDate]
[-(FD|FileDate) DateModified]
[-(FT|FileTime) TimeModified]
[-(DE|Description) SavedFileDescriptions]
[-(LN|LoginName) LoginAccountName]
[-(DB|Debug) DebugModeInfo]

Available mode options:

-(BG\|BackGround)	runs in background; suppresses screen output and errors
-(EM\|EMailNotice)	sends an email summary (including any errors) when the action completes or aborts
-(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
-(RO\|ResetOrder)	resets display order indices to match the order files are provided
-(SC\|SetChecksum)	computes MD5 checksums for Help files and saves them to GDEXDB

Help file names must be provided via -HF (-HelpFile) unless -ON (-OrderNames) is used to reorder files. The number of values supplied to other Info options must match the number of file names, except for options that accept a single shared value, such as -AF, -DF, and -HT (-HelpFileType).

For remotely hosted Help files (e.g., on GitHub), provide the full URL via -WU (-WebURL) to register the file in GDEXDB without a local copy on the GDEX Server.

Back to Top

Back to Table of Contents