A GUIDE TO DSARCH

Table of Contents

• 1 - INTRODUCTION
• 2 - GENERAL DSARCH USAGE
• 3 - ACTION OPTIONS
  • 3.1 - Dataset Actions
    • 3.1.1 - Set Dataset Information
    • 3.1.2 - Get Dataset Information
  • 3.2 - DOI/Version Actions
    • 3.2.1 - Set Version Control
    • 3.2.2 - Get Version Control
    • 3.2.3 - Terminate Version Control
  • 3.3 - Group Actions
    • 3.3.1 - Set Group Information
    • 3.3.2 - Get Group Information
    • 3.3.3 - Delete Group Information
    • 3.3.4 - Change Group Information
  • 3.4 - File Actions
    • 3.4.1 - Set Saved File Information
    • 3.4.2 - Get Saved File Information
    • 3.4.3 - Set Web File Information
    • 3.4.4 - Get Web File Information
    • 3.4.5 - Set Help File Information
    • 3.4.6 - Get Help File Information
    • 3.4.7 - Set Quasar File Information
    • 3.4.8 - Get Quasar File Information
    • 3.4.9 - Archive Saved Files
    • 3.4.10 - Archive Web Files
    • 3.4.11 - Archive Help Files
    • 3.4.12 - Backup Quasar Files
    • 3.4.13 - Restore Quasar Files
    • 3.4.14 - Move Saved/Web/Help/Quasar Files
    • 3.4.15 - Delete Saved/Web/Help/Quasar Files
  • 3.5 - All Info Actions
    • 3.5.1 - Get All Information
    • 3.5.2 - Set All Information
  • 3.6 - Webpage Actions
    • 3.6.1 - Regenerate Dataset Webpages
    • 3.6.2 - Increment Cache Number
• 4 - MODE OPTIONS
  • Mode Option -BG (-BackGround) (Alias: -b) :
  • Mode Option -CL (-CleanLocal) (Aliases: -CleanLocFile, -CleanLocalFile) :
  • Mode Option -DX (-DeleteXML) :
  • Mode Option -EM (-EmailNotice) :
  • Mode Option -FO (-FormatOutput) :
  • Mode Option -GF (-GrowingFile) (Alias: -GrowingDataFile) :
  • Mode Option -GX (-GatherXML) (Alias: -Grid2XML) :
  • Mode Option -GZ (-GMTZone) (Aliases: -GMT, -GreenwichZone, -UTC) :
  • Mode Option -KM (-KeepMetadata) (Alias: -KeepMeta) :
  • Mode Option -KP (-KeepPath) (Alias: -KeepLocalPath) :
  • Mode Option -MD (-MyDataset) :
  • Mode Option -NE (-NoEmail) :
  • Mode Option -NT (-NoTrim) :
  • Mode Option -NV (-NewVersion) :
  • Mode Option -OE (-OverrideExist) :
  • Mode Option -PE (-ShowPeriod) :
  • Mode Option -RA (-RetryArchive) :
  • Mode Option -RD (-RemoveDir) (Aliases: -RemoveDirectory, -RemoveEmptyDir) :
  • Mode Option -RG (-RecursiveGroup) (Alias: -RepeatGroup) :
  • Mode Option -RN (-RelativeName) (Aliases: -RelativePathName, -RelativeFileName) :
  • Mode Option -RO (-ResetOrder) (Alias: -Reorder) :
  • Mode Option -RS (-GXRSOptions) :
  • Mode Option -RT (-ResetTIndex) (Alias: -ResetTopGroup) :
  • Mode Option -SC (-SetChecksum) :
  • Mode Option -TO (-TarOnly) :
  • Mode Option -TS (-ToSaved) (Aliases: -ToSavedFile, -MovedToSaved) :
  • Mode Option -TT (-TotalSummary) :
  • Mode Option -TW (-ToWeb) (Aliases: -ToWebFile, -MovedToWeb) :
  • Mode Option -UZ (-UnzipData) (Aliases: -Uncompress, -UncompressData, -Unzip) :
  • Mode Option -WC (-WithChecksum) (Aliases: -ValidateChecksum, -WithMD5, -ValidateMD5) :
  • Mode Option -WM (-WithMetadata) (Alias: -WithMeta) :
  • Mode Option -WN (-WithFileNumber) (Alias: -WithNumber) :
  • Mode Option -WS (-WithFileSize) :
  • Mode Option -XC (-CrossCopy) :
  • Mode Option -XM (-CrossMove) :
  • Mode Option -ZD (-ZipData) (Aliases: -Compress, -CompressData, -Zip) :
• 5 - INFORMATION OPTIONS
  • 5.1 - Single-Value Info Options
    • Info Option -AL (-AsyncLimit) (Alias: -AsynchronousLimit) :
    • Info Option -AO (-ActionOption) (Alias: -ActOption) :
    • Info Option -BL (-ButtonLimit) :
    • Info Option -DD (-DeleteDir) (Aliases: -DeleteDirLevel, -DeleteEmptyDir) :
    • Info Option -DS (-Dataset) (Aliases: -Dsid, -DatasetID) :
    • Info Option -DV (-Divider) (Aliases: -Delimiter, -Separater) :
    • Info Option -ES (-EqualSign) :
    • Info Option -FL (-FileLimit) (Alias: -FileCountLimit) :
    • Info Option -FN (-FieldNames) :
    • Info Option -LD (-LocalDirectory) :
    • Info Option -LL (-LocalFileList) (Alias: -LocalList) :
    • Info Option -LN (-LoginName) :
    • Info Option -OF (-OutputFile) :
    • Info Option -ON (-OrderNames) :
    • Info Option -PO (-PatternOffset) :
    • Info Option -QS (-QsubOptions) (Alias: -PBSOptions) :
    • Info Option -UD (-UseDSARCH) (Alias: -UseRDADB) :
    • Info Option -VS (-ValidSize) :
    • Info Option -WI (-WaitInternval) :
  • 5.2 - Multi-Value Info Options
    • Info Option -AF (-ArchiveFormat) (Aliases: -FileFormat, -ExternalFormat) :
    • Info Option -BD (-BeginDate) :
    • Info Option -BF (-BackupFlag) :
    • Info Option -BP (-BatchProcess) (Aliases: -d, -DelayedMode) :
    • Info Option -BS (-BackStatus) :
    • Info Option -BT (-BeginTime) :
    • Info Option -DA (-DataAccess) (Aliases: -DataAccessflag, -FileListFlag) :
    • Info Option -DB (-Debug) :
    • Info Option -DE (-Description) (Aliases: -Desc, -Note, -FileDesc, -FileDescription) :
    • Info Option -DF (-DataFormat) (Aliases: -TF, -ContentFormat) :
    • Info Option -DN (-DOINumber) (Aliases: -DOI, -DOIName) :
    • Info Option -DO (-DisplayOrder) :
    • Info Option -ED (-EndDate) :
    • Info Option -ET (-EndTime) :
    • Info Option -EV (-ExternalVersion) :
    • Info Option -FD (-FileDate) :
    • Info Option -FF (-FileFlag) :
    • Info Option -FS (-FileStatus) :
    • Info Option -FT (-FileTime) :
    • Info Option -GI (-GroupIndex) :
    • Info Option -GL (-GroupLevel) :
    • Info Option -GN (-GroupName) (Alias: -GroupID) :
    • Info Option -GP (-GroupPattern) :
    • Info Option -GT (-GroupType) (Alias: -GroupDataType) :
    • Info Option -HF (-HelpFile) :
    • Info Option -HT (-HelpFileType) (Alias: -HelpType) :
    • Info Option -ID (-InitialDate) :
    • Info Option -IF (-InputFile) :
    • Info Option -IV (-InternalVersion) :
    • Info Option -KV (-KeyValue) :
    • Info Option -LC (-Location) (Alias: -LocationFlag) :
    • Info Option -LF (-LocalFile) (Aliases: -LocFile, -SourceFile) :
    • Info Option -MC (-MD5Checksum) :
    • Info Option -ML (-MetaLink) (Alias: -MetadataLink) :
    • Info Option -ND (-NoteDocument) (Aliases: -DocumentNote, -DescDocument) :
    • Info Option -NI (-NoteInternal) (Aliases: -InternalNote, -DescInternal, -DI) :
    • Info Option -NS (-NoteSoftware) (Aliases: -SoftwareNote, -DescSoftware) :
    • Info Option -NW (-NoteWeb) (Aliases: -WebNote, -DescWeb, -DW) :
    • Info Option -OB (-OrderBy) (Alias: -OrderByPattern) :
    • Info Option -OD (-OriginDataset) :
    • Info Option -OG (-OriginGroup) :
    • Info Option -OT (-OriginType) :
    • Info Option -PI (-ParentIndex) (Alias: -ParentGroupIndex) :
    • Info Option -QF (-QuasarFile) :
    • Info Option -QT (-QuasarFileType) (Aliases: -QuasarType, -BackupType) :
    • Info Option -RF (-OriginFile) :
    • Info Option -SF (-SavedFile) :
    • Info Option -SP (-SavedPath) :
    • Info Option -SR (-Source) :
    • Info Option -ST (-SavedFileType) (Aliases: -SavedType, -SavedArchiveType) :
    • Info Option -SZ (-Size) :
    • Info Option -TG (-TopGroupIndex) (Alias: -TopGroup) :
    • Info Option -TI (-Title) :
    • Info Option -TL (-ThreddLink) :
    • Info Option -VI (-VersionIndex) :
    • Info Option -VT (-VersionStatus) :
    • Info Option -WF (-WebFile) :
    • Info Option -WH (-WebHome) (Alias: -WebDataHome) :
    • Info Option -WP (-WebPath) :
    • Info Option -WT (-WebFileType) (Aliases: -WebType, -WebArchiveType) :
    • Info Option -WU (-WebURL) (Aliases: -URL, -WebAddress) :

Appendix A: List of Examples

• A.1. Action Option -SD (-SetDataset)

• A.2. Action Option -GD (-GetDataset)

• A.3. Action Option -SV (-SetVersion)

• A.4. Action Option -GV (-GetVersion)

• A.5. Action Option -TV (-TerminateVersion)

• A.6. Action Option -SG (-SetGroup)

• A.7. Action Option -GG (-GetGroup)

• A.8. Action Option -DG (-DeleteGroup)

• A.9. Action Option -CG (-ChangeGroup)

• A.10. Action Option -GW (-GetWebFile)

• A.11. Info Option -ON (-OrderNames)

Back to Top