home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / batmdemo.zip / README.TXT < prev    next >
Text File  |  1994-04-06  |  6KB  |  168 lines
  1. OS/2 "BATCH MANAGER" COMMAND LINE INTERFACE
  2. ===========================================
  3.  
  4. OS/2 "BATCH MANAGER" provides a series of command line interfaces as an
  5. alternative for users to submit and monitor batch jobs without interacting
  6. with the Graphical User Interface.  The functions are detailed below:
  7.  
  8. 1.  SUBMIT BATCH JOBS
  9.  
  10.     This function allows users to submit batch jobs. It is primarily
  11.     used to enable job submission from an external source (i.e.,
  12.     another user application or command procedure).  Execute the BMSUBMIT
  13.     program with the following calling format:
  14.  
  15.     Calling Format: (The arguments in brackets are optional)
  16.  
  17.     BMSUBMIT CMDFile ["JobName"] [/JobStatus] [StartDate StartTime]
  18.                      [/SingleRecurring] [/RecurringPeriod] [+CmdArg]
  19.  
  20.     ARGUMENT             DESCRIPTION
  21.     --------             -----------
  22.     CMDFile              The command file name with full path
  23.  
  24.     JobName              The name of this job start, alphabetical,
  25.                          (up to 30 characters).
  26.  
  27.     /JobStatus           The desired job status
  28.                            /P (pending, default)
  29.                            /D (delayed)
  30.                            /H (hold)
  31.  
  32.     StartDate StartTime  The required start date and time
  33.                            YYYYMMDD HHMM (default is current time)
  34.  
  35.     /SingleRecurring     The job type
  36.                            /S (Single, default)
  37.                            /R (Recurring)
  38.  
  39.     /RecurringPeriod     The Recurring Job Period
  40.                            /1 (every day, default)
  41.                            /2 (every other day)
  42.                            /3 (every Sunday)
  43.                            /4 (every Monday)
  44.                            /5 (every Tuesday)
  45.                            /6 (every Wednesday)
  46.                            /7 (every Thursday)
  47.                            /8 (every Friday)
  48.                            /9 (every Saturday)
  49.                            /10 (every First Day of month)
  50.                            /11 (every Last Day of month)
  51.  
  52.     +CmdArg                Command Argument String
  53.  
  54. 2.  GET THE QUEUE STATUS
  55.  
  56.     This function allows users to get the status of the job queue.
  57.     Execute the BMGETQ program with the following calling format:
  58.  
  59.     BMGETQ
  60.  
  61. 3.  CHANGE THE QUEUE STATUS
  62.  
  63.     This function allows users to change the status of the job queue.
  64.     Execute the BMCHQ program with the following calling format:
  65.  
  66.     BMCHQ Status
  67.  
  68.     ARGUMENT             DESCRIPTION
  69.     --------             -----------
  70.     Status               A (active)
  71.                          H (hold)
  72.  
  73. 4.  LIST ALL JOBS IN THE QUEUE
  74.  
  75.     This function allows users to list the status of all jobs in the
  76.     queue.  Execute the BMLIST program with the following calling
  77.     format:
  78.  
  79.     BMLIST
  80.  
  81.     The output format is as follows:
  82.  
  83.     COLUMN               DESCRIPTION
  84.     ------               -----------
  85.     Queue Name           The name of the job queue
  86.  
  87.     Queue Stat           The queue status
  88.                            A (active)
  89.                            H (hold)
  90.  
  91.     JID                  Job Id
  92.  
  93.     Job Name             The name of the job
  94.  
  95.     Job Status           The Job Status
  96.                            P (pending)
  97.                            D (delayed)
  98.                            H (hold)
  99.                            A (active)
  100.  
  101.     Start Date           The Job start Date
  102.                            YYYYMMDD
  103.  
  104.     Start Time           The Job Start Time
  105.                            HHMM
  106.  
  107.     C/J                  Job File Type
  108.                            C (OS/2 Command File)
  109.                            J ("PRIDE" INFORMATION FACTORY Job)
  110.  
  111.     R/S                  Type of Job
  112.                            S (Single)
  113.                            R (Recurring)
  114.  
  115.     P                    Recurring Time Period
  116.                            1 (every day)
  117.                            2 (every other day)
  118.                            3 (every Sunday)
  119.                            4 (every Monday)
  120.                            5 (every Tuesday)
  121.                            6 (every Wednesday)
  122.                            7 (every Thursday)
  123.                            8 (every Friday)
  124.                            9 (every Saturday)
  125.                            10 (every First Day of month)
  126.                            11 (every Last Day of month)
  127.  
  128.     Execute Time         Elapsed Execution Time (active jobs only)
  129.  
  130. 5.  GET THE STATUS OF A JOB
  131.  
  132.     This function allows users to get the status of a single job.
  133.     Execute the BMJOB program with the following calling format:
  134.  
  135.     BMJOB JobId
  136.  
  137.     ARGUMENT             DESCRIPTION
  138.     --------             -----------
  139.     JobId                JobId as displayed by BMLIST.
  140.  
  141. 6.  CHANGE THE STATUS OF A JOB
  142.  
  143.     This function allows users to change the status of previously
  144.     submitted batch jobs.  Execute the BMCHSTAT program with the
  145.     following calling format:
  146.  
  147.     Calling Format: (The arguments in brackets are optional)
  148.  
  149.     BMCHSTAT JobId JobStatus [StartDate StartTime]
  150.  
  151.     ARGUMENT             DESCRIPTION
  152.     --------             -----------
  153.     JobId                The Job Id
  154.     JobStatus            P (pending)
  155.                          D (delayed)
  156.                          H (hold)
  157.                          R (release)
  158.                          C (cancel)
  159.     StartDate StartTime  YYYYMMDD HHMM
  160.  
  161.     (NOTE: A JobId of 0 (zero) can be used to identify all jobs in the
  162.      queue.)
  163.  
  164. 7.  DISPLAY THE STATUS OF COMPLETED JOBS
  165.  
  166.     To display the status of completed jobs type, edit or print the
  167.     BMJOB.LOG file from the '.:\MBABATCH' directory.
  168.