Syntax For Command Line Processing of Archive, Delete, Report, and Restore Requests

Use the syntax in this topic when entering commands for command line processing of Archive, Delete, Report, and Restore Requests.

Command Line

Commands use the following structure. Enter the command and all parameters on a single line.

Parameters

You can enter parameters with the command on the command line, or you can enter these parameters into a text file (called a parameter file).

A parameter file can be reused whenever you need to run a task. You can also generate a parameter file programmatically, which allows you to automate processes.

You can enter parameters for more than one process into a parameter file. This allows you to run multiple processes by entering a single command on the command line. Enter the parameters for each process on a separate line of the parameter file.

   TYPE={ ARCHIVE | DELETE | REPORT | RESTORE }  
   REQUEST=identifier.name  
   [ STOP={ N | I | W | F } ] 
   [ OUTPUT=filename[ + ] ] 
   [ QUIET{ + | - } ] 
   [ MONITOR{ + | - } ] 
   [ SERVER={ arcservername | (local) } ] 
   [ PST=pstdirectory ] 
   [ OV={ [ “ ]override file name.txt[ ” ] | * } ] }

Overrides

Overrides allow you to override settings in a request when you use the request in command line processing.

You can enter overrides into a parameter file after the parameters, or you can enter overrides into a separate text file (called an override file) and designate the override file in a parameter.

The exact overrides that you use depend upon the type of process. Enter each override on a separate line. Use the END override to mark the end of any overrides that you use.

Archive Process

      [ SERVER { arcservername | (local) }] 
      [ AFFILE [ “ ]arc file name.af[ ” ] ] 
      [ AFXFILE [ “ ]idx file name.afx[ ” ] ] 
      [ GROUP groupidentifier ] 
      [ ADNAME identifier.name ] 
      [ DEFQUAL dbalias[ .cid ] ]
      [ PNSFILE [ “ ]pns file name.pns[ ” ] ] 
      [ STARTTAB [ [ dbalias. ]cid. ]tablename ] 
      [ ROWLIMIT n ]
      [ TABROWLIM [ [ dbalias. ]cid. ]tablename n ]
      [ DEFERDAA { Y | N } ] 
      [ SEL [ [ dbalias. ]cid. ]tablename columnname operator value ]
...
      [ SEL [ [ dbalias. ]cid. ]tablename columnname operator value ]
      [ SQL [ [ dbalias. ]cid. ]tablename sqlwhereclause ]
...
      [ SQL [ [ dbalias. ]cid. ]tablename sqlwhereclause ]
      [ VAR variablename value ] 

Delete Process

      [ AFFILE [ “ ]arc file name.af[ ” ] ]
      [ CFFILE [ “ ]con file name.cf[ ” ] ]
      [ COMMFREQ n ]
      [ LOCKTABS { Y | N } ]
      [ DISROWLIM n ] 

Report Process

      [ REPORTNAME identifier.name ]
      [ SOURCEFILE [ “ ]arc file name.af[ ” ] ] 
      [ TITLE string ]
      [ AUTOREPNEWTABLES{ Y | N }]
      [ ARCHCRITDELIMITER { , | ; | : | >| }
      [ ARCHCRITVALUE 
         ( [ SERVER  { { blank | (local) | (none) } | name } ]  |
           [ GROUP  { { blank | (none) } | name } ]  |
           [ FILENAME  name ]  |
           [ CREATOR  cid ]  |
           [ CREATIONRANGE  ( mm/dd/yyyy , mm/dd/yyyy ) ]  |
           [ RETENTIONRANGE  ( { mm/dd/yyyy | days } , { mm/dd/yyyy | days } ) ]  |
           [ STORAGEPROFILE { { blank | (none) } | name } ]  |
           [ BACKUPDEVICE  { { blank | (NO DEVICE ) } | CENTERA | NETWORKER |  TIVOLI } ]  |
           [ DESC  { { blank | (none) } | desc } ]  |
           [ TABLENAME  name ] 
           [LITIGATIONHOLD { YES | NO | % } ])
           [DELETEHOLD { YES | NO | % } ])
      [ ARCHCRITSORT { SERVER | GROUP | FILENAME | CREATOR | CREATIONRANGE | RETENTIONRANGE
        | STORAGEPROFILE | BACKUPDEVICE | DESC | TABLENAME |LITIGATIONHOLD | DELETEHOLD }
         {ASCENDING | DESCENDING }]
      [ ARCHCRITCOMBINE { AND | OR } ]

Restore Process – General

      [ DELARES {Y | N } ]  
      [ CONONERR {Y | N } ] 
      [ GLOCONN { AND | OR } ] 
      [ GLOSELCRIT [ [ dbalias. ]cid. ]tablename columnname operator value  
...
      [ GLOSELCRIT [ [ dbalias. ]cid. ]tablename columnname operator value  
      [ GLOCOLCONN [ [ dbalias. ]cid. ]tablename { AND | OR } ]
      [ GLOSQLTEXT [ [ dbalias. ]cid. ]tablename sqlwhereclause ]
      [ AUTOGENSUBXF { Y | N } ]

Restore Process – Archive File

       [ [AFn] 
         { [ SERVER { arcservername | (local) } ] AFFILE  
            [ “ ]arc file name.af[ ” ] |  AFID n | GUID string }
           [ STARTTAB [ [ dbalias. ]cid. ]tablename ] 
           [ ROWLIM n ] 
           [ REF [ [ dbalias. ]cid. ]tablename { Y | N } ]
           [ GLOSELSQL { Y | N } ] 
           [ LOCSELCRIT [ [ dbalias. ]cid. ]tablename columnname operator value
...
           [ LOCSELCRIT [ [ dbalias. ]cid. ]tablename columnname operator value
           [ LOCCOLCONN [ [ dbalias. ]cid. ]tablename {AND | OR } ]
           [ LOCSQLTEXT [ [ dbalias. ]cid. ]tablename sqlwhereclause ] 
           [ SUBXFFILE [ “ ]ext file name.xf[ ” ] ] 
           [ VAR variablename value ]

Restore Process – Insert or Load

         [ [ CFFILE  [ “ ]con file name.cf[ ” ] ] 
           [ TMNAME  identifier.name ] 
           [ COLMAPID  identifier ] 
           [ COLMAP [ [ dbalias. ]cid. ]tablename  [identifier. ] name] 
           [ DESTQUAL dbalias[ .cid ] ] 
           [ DESTTABNAME  [ [ dbalias. ]cid. ]srctablename [ [ dbalias. ]cid. ]desttablename ] ] 

Restore Process – Insert

         [ [ COMMFREQ  n ] 
           [ PROCTYPE { INS | UPDINS | UPDATE/INSERT | UPDATE ONLY } ] 
           [ LOCKTABS  { Y | N }] 
           [ DISROWLIM  n ] |

Restore Process – Load

         [ MODE dbalias { INSERT | REPLACE | APPEND | TRUNCATE } ] 
         [ PERFLOAD  dbalias { Y | N } ] 
         [ DELONSUCCESS dbalias { Y | N } ]
         [ DELONFAILURE dbalias { Y | N } ] 
         [ WORKPATH dbalias path ] 
         [ SERVPATH dbalias path ] ] ]
         [ END ]