Argent.scheduler[1]

Argent Job Scheduler™ Users Guide United States and Canada Europe, Middle East and Africa Asia Australia and New Zealand 860 674 1700 44 207 959 3200 852 2330 0310 61 3 9863 8220 www.Argent.com Argent Job Scheduler Users Guide Argent Job Scheduler Users Guide ® © ArgSoft Intellectual Property Holdings, Limited 1991-2006 Argent Job Scheduler Users Guide Argent Job Scheduler Users Guide Copyright Notices Copyright © 1991 - 2006 ArgSoft Intellectual Property Holdings, Limited . All rights reserved. This documentation and the software described herein are copyrighted, with all rights reserved. Under copyright laws, this documentation and software may not be copied in whole or in part without the written consent of ArgSoft Intellectual Property Holdings, Limited except in the normal use of the software or to make a backup copy as specified in the license agreement. Trademarks Argent Console is a trademark of ArgSoft Intellectual Property Holdings, Limited. Argent Data Consolidator is a trademark of ArgSoft Intellectual Property Holdings, Limited. Argent Dashboard is a trademark of ArgSoft Intellectual Property Holdings, Limited. Argent Defender is a trademark of ArgSoft Intellectual Property Holdings, Limited. Argent Exchange Monitor is a trademark of ArgSoft Intellectual Property Holdings, Limited. Argent Guardian is a registered trademark of ArgSoft Intellectual Property Holdings, Limited. Argent Predictor is a registered trademark of ArgSoft Intellectual Property Holdings, Limited. Argent Sentry is a trademark of ArgSoft Intellectual Property Holdings, Limited. Argent SQL Server Monitor is a trademark of ArgSoft Intellectual Property Holdings, Limited. Argent SuperMaps is a trademark of ArgSoft Intellectual Property Holdings, Limited. Argent SuperLinks is a trademark of ArgSoft Intellectual Property Holdings, Limited. Argent Total Support Interface is a trademark of ArgSoft Intellectual Property Holdings, Limited. All other trademarks and registered trademarks are acknowledged. Rev F — July 2006 © ArgSoft Intellectual Property Holdings, Limited 1991-2006 Argent Job Scheduler Users Guide Contents About This Document i Conventions ....................................................................................................i Worldwide Technical Support Chapter 1: Basic Concepts 1 2 In This Chapter.............................................................................................. 2 Using Argent Job Scheduler Screens ............................................................ 3 Toolbar Buttons ................................................................................. 3 Figure 2.1: Standard Toolbar......................................................................... 3 Managing The Argent Job Scheduler Scheduling Service ............................. 5 How To Access.................................................................................. 5 Service Management Window ........................................................... 6 Argent Job Scheduler Service Management Options ......................... 6 Argent Job Scheduler Log Window Options....................................... 7 Components of A Batch Job .............................................................. 8 Types of Alerts................................................................................... 8 What Are Macros? ............................................................................. 8 Chapter 2: Scheduling Jobs 9 How To Access ............................................................................................. 9 In This Chapter.............................................................................................. 9 Using Job Masks ......................................................................................... 11 Summary – Summarize Argent Job Scheduler Job Activity.............. 11 Date Masks...................................................................................... 11 Using the Date/Time Format ............................................................ 11 Types Of Job Masks ........................................................................ 12 Scheduler Colors ............................................................................. 12 Description of Job Details Columns ............................................................. 13 Popup Menu Options ....................................................................... 14 How To Access ........................................................................................... 16 In This Chapter............................................................................................ 16 Connect To Argent Queue Engine (W200X/NT) .......................................... 17 Connecting To A Server Running W200X/NT Argent Queue Engine ............................................................................................. 17 Connecting To A Remote Server Running W200X/NT Queue Engine ............................................................................................. 18 Argent Queue Engine Properties................................................................. 22 General Info..................................................................................... 23 Startup Jobs .................................................................................... 23 Permissions ..................................................................................... 23 Queue Engine Properties ............................................................................ 24 Queue Status................................................................................... 24 Queue Priority.................................................................................. 24 © ArgSoft Intellectual Property Holdings, Limited 1991-2006 Contents 4 Argent Job Scheduler Users Guide Max Pending Jobs ........................................................................... 25 Max Executing Jobs......................................................................... 25 Automatically Starting and Stopping Queues ................................... 25 Retain Jobs...................................................................................... 25 Queue Description ........................................................................... 25 Popup Menu Options................................................................................... 26 Queue Options Windows............................................................................. 27 The Queue Property Tab ................................................................. 27 Queue Permission Tab .................................................................... 29 Queue CPU Affinities Tab ................................................................ 29 Argent Queue Engine Main GUI .................................................................. 30 Queue Engine Commands .......................................................................... 31 Queue Engine Security................................................................................ 32 Chapter 4: Argent Queue Engine for UNIX 33 Connect To UNIX Queue Engine................................................................. 34 General Info..................................................................................... 37 Queue Properties............................................................................. 38 Priority ............................................................................................. 39 Status .............................................................................................. 39 Pending Jobs Limit .......................................................................... 39 Executing Jobs Limit ........................................................................ 39 Automatic Starting and Stopping of Queues .................................... 39 Queue Permissions.......................................................................... 40 CPU Affinity ..................................................................................... 41 Jobs in Queue Engines.................................................................... 41 UNIX Queue Engine Security ...................................................................... 42 Chapter 5: Argent iSeries Job Adapter 43 Connect To Argent iSeries Job Adapter ...................................................... 44 General Info ................................................................................................ 47 Queue Properties ........................................................................................ 48 Status .............................................................................................. 48 iSeries Jobs ..................................................................................... 49 Submitting Jobs ............................................................................... 49 How the Job Scheduler Adapter Executes Jobs............................... 49 Job Log Files ................................................................................... 49 Job Scheduler Adapter Security .................................................................. 50 Chapter 6: Integrate With SAP System 51 Connecting To SAP System ........................................................................ 51 Chapter 7: Argent SuperMaps 54 How to Access............................................................................................. 54 Argent SuperMap Define ............................................................................. 55 Argent SuperMaps define window, Screen ID J15B. ................................... 55 Delete.......................................................................................................... 56 Delete.......................................................................................................... 57 Location Setting window, Screen ID J15C. .................................................. 57 © ArgSoft Intellectual Property Holdings, Limited 1991-2006 Contents 5 .................. 115 Defining Email Macros................................. 88 Job Log Files and Parameters................................... 93 Setting Up Exchange Email ....................................................................................................................................................................................................................................................................................................... 90 Chapter 9: Alert Definitions 91 How To Access .................................... 81 Post Job Dialog: Alert Notifications ............................... 80 Job Dependencies Dialog ............................................................................. 59 Creating a Job Class .. 75 Job Schedule Dialog ................................................... 103 Run Command Alerts Window............... 84 Job Advanced Dialog ....... 118 Defining Alert Macros .................................................. 101 Bell Alert Tab............................................ 91 In This Chapter.............................................................................................. 85 Menu Items ..................................................................................................................................................................................... 97 Advanced Pager Setup ........................................................................................................................................................... 110 Macros Window................................................................................................................................................................................................................................................................................................................. 92 Email Alert Tab................................... 111 Pager Macros Window ....................................................................................................................................................... 91 Alert Description Window ...................................................................... 108 Menu Items ............................... 112 Defining Pager Macros ......................................................................................................................... 82 Exit Code Handling .............................................................................................................................................................................................................................Argent Job Scheduler Users Guide Chapter 8: Job Class And Job Template 59 How to Access................................................................................................................................... 68 Job Definition Basic Dialog ............................................................................ 105 W200x Message Alerts Window ................................................ 95 Setting up SMTP Mail............................................................... 116 Alert Macros Window............................................................................................ 113 Email Macros Window ............................ 67 Job Definition Window ........................ 87 How Queue Engine Executes Jobs......................................... 119 User Macros Window ........ 89 Job Exit Codes.............................................. 60 Creating a Job Template ....................................................................... 59 In This Chapter................................................ 120 © ArgSoft Intellectual Property Holdings...................................................................................................................................................................... 110 In This Chapter........................................................................................................................ 87 Job Submission and Execution... 104 Example.................................... 89 Job Parameters ...................................................................... 76 Job Server Group Dialog ............................. 109 Chapter 10: Creating and Using Macros 110 How To Access . 83 Job Limits Dialog ............................................................................................................................................ 70 Job Security Dialog ...................................................................... 62 List Of Job Definitions ..................................... Limited 1991-2006 Contents 6 . 106 Argent Console Alerts Window ............. ............................................. 161 Windows Messaging Email Options ... 148 Job Menu ..... 123 Defining Queue Macros.................................................................................................................................................................... 155 GUI Options ................. 135 Defining a Complex Calendar ................................................ 146 Every Definition.................................................................................... 147 System Menu ..............Argent Job Scheduler Users Guide Defining User Macros ........................................................................................................................................................................................................................................................................................................................................................................................ 148 Scan Entire Network ......................... 148 Quit Without Saving Changes ............................................................................................................................................... 144 Menu Items ................................................................................................................................................... 139 Define Period Definitions ................................... 149 Edit Job Class Table ............................................................................................................................................................................................ 134 Defining Calendar Definitions ...... 148 Backup Database ................................................ 151 Archive Job List ........................................................... 130 The System Strings.......... 145 Some Examples of Calendars ............................................................................................................ 147 Start Or Stop Service ...... 153 Settings Menu .................. 124 Job Sequence Macros..... 154 System Options ............................................................. 146 Chapter 12: Using Job Scheduler 147 How to Access.......................................................................................................................................................... 154 Configuration Options ................................................................................................................................................................................................................................................................. 157 Email Options................................................................. 147 In This Chapter............................................................................................................................ 142 Defining Holidays .............................................................................. 137 Testing a Calendar Definition.............. 126 Defining Job Sequence Macros.................. 150 Create Job Forecast .................................... 127 Global String Macros ................................. 146 Holidays Definition ..................................... 146 Period Definition . 148 Restore Database.............................................. 129 Defining Global String Macros ...................................................... 133 In This Chapter................................................................................... 148 Refresh Time Zone Cache ......................... 153 View Job History File ................................................ 132 Chapter 11: Advanced Scheduling Using Calendars 133 How to Access.................................................................................................................................. Limited 1991-2006 Contents 7 ............................................................................................................. 121 Queue Macros Window ................................................................................................................................... 148 Submit Jobs..................................................................................................................................... 147 Verify Database ....... 133 Calendars Window .................................................................................................................................................................................................................. 132 Menu Items ................................... 162 © ArgSoft Intellectual Property Holdings............ 138 Defining An ‘Every’ Definition.... 148 Execute Manual Rollover .......................................... ................................... 190 QMODIFY........................................................................................ 197 QSUBMIT ...................................................... 174 Globally Update Argent Queue Engine Server Settings....................... 179 Accessing Network Shares From Command Procedures ....................................... 205 Rollover ...................................................................................................................................................................................................................................................................................................................................................................................................................................................... 184 Command Qualifiers ........................................................................................ 164 Job List.............. 212 © ArgSoft Intellectual Property Holdings................................................................................................................................................................................. 208 Step 1: Did The Job Run Before? ............................................................................................................................................................................................. Predefined Environment Variables.................................................................................... 187 QCREATE ......... 198 QSYSTEM ............................................................................................................................................Argent Job Scheduler Users Guide SMTP Protocol Email Options.................................................................................................................................... 177 Chapter 13: Design Job Files for Argent Queue Engine 178 Queue Engine.............................................................................................................................. 193 QREQUEUE ......................................................................................................................... Limited 1991-2006 Contents 8 ....................... 168 Service Restart................................ 169 Backup Node........ 196 QSTOP ................................................... 183 Using Job Parameters .................................................................................................................... 185 QCANCEL ...................................................................................... 178 Error Handling In Command Procedures .......................................................................... 182 Return Codes ........................................................................ 188 QDELETE................................................................... 207 Fault Tolerance and Backup Nodes............................ 191 QOPEN.... 195 QSTART ....................... 175 Assign User Rights................................................................... 206 Background Jobs.............................................. 209 Argent Queue Engine Server .................................................................................. 208 Step 2: Run the Job Directly From the Argent Queue Engine ............................................ 170 Rollover & Archiving ....................................................................................... 186 QCLOSE.............. 166 CPU Affinity....................................................................................... 207 Appendix C: Troubleshooting Batch Jobs 208 Isolate the Problem ........................................................ 172 License................................................................. 202 Appendix B: Architecture And Concepts 205 Queue Engine ..................................................................................... 184 On-line Help................. 183 Appendix A: Command Reference 184 Document Conventions .............. 194 QSHOW........................ 207 Security ........................ 184 Using Commands Across A Network .............................. 205 Scheduler Engine ................... 163 Security ......................................................... ......................................................................... 235 The Worker................................................... 222 QSTART ................................. 243 Getting Started with CFGARGJSA .... 214 Queue Names .............................................................................................. 234 Available Functionality........... 236 Sample CFGARGJSA Command ................. 236 CFGARGJSA Command Parameters........................................................................................................................... 235 The Monitor Daemon ..................................................................... 222 QSHOW..... 215 Using Commands Across A Network..................................... 236 CFGARGJSA Command Syntax ............................... 215 QCANCEL ......................................................................DAT ...................................................................................................... 232 Appendix F: Argent iSeries Job Adapter 234 Introduction ............ 219 QOPEN............... 227 Appendix E: W200x and the UNIX Queue Engine 230 W200x Facilities ........................................................................................................................................................ 240 Using the iSeries Command Prompter with CFGARGJSA.................................................................................................................................................................... 234 The Three Scheduler Processes ..................................................................... 235 Using CFGARGJSA During Installation .. 235 The Listener............................................ 230 W200x Administration........................................ 224 QSYSTEM ..................................................................................................................................................................................... 230 USERS..........................DAT ......................................................................................................................................... 213 Appendix D: UNIX Command Reference 214 Document Conventions ................................. 245 Retrieving the C/L Source .............Argent Job Scheduler Users Guide Argent Job Scheduler Logs............................................................................................ 243 Modifying the iSeries IPL Start Up Program ........................................... 214 On-line Help ............................................. 216 QCLOSE...................................................................................................................................................................................... 223 QSTOP ............................................................................................................................................................................................................................................................................ 224 QSUBMIT ............... 219 QMODIFY.................... 241 When to Use CFGARGJSA ........................................................ Limited 1991-2006 Contents 9 ....................................................... 246 Re-Compiling IPL Start Up Program ................................................................................................................. 221 QREQUEUE ................................................. 242 Including CFGARGJSA in Your Programs........................................................................................................................................................................................................... 217 QDELETE...... 213 W200x Event Logs......................................................................................................................... 214 Command Options ................................... 230 HOSTS....... 217 QCREATE ........................ 247 Appendix I: Job Scheduler Adapter for iSeries Operations 248 © ArgSoft Intellectual Property Holdings............................................ 245 Modifying the C/L Source....................................................... .....Special Library List Considerations 255 Changing the QSYSLIBL System Value ......................................... 258 Special Issues for V5R2 and Earlier Releases .................... 253 Appendix L: Job Scheduler Adapter for iSeries ........................................................................ 258 Appendix M: Argent iSeries Job Adapter Messages Appendix N: Argent iSeries Job Adapter Service Log Index 259 262 263 © ArgSoft Intellectual Property Holdings............................... Limited 1991-2006 Contents 10 ........... 251 Advanced Topics: Automating the Start Up and Shut Down ..................... 250 Ending the Argent iSeries Job Adapter.....Argent Job Scheduler Users Guide Starting the Argent iSeries Job Adapter........................ 255 Changing the ARGSCHED Job Description ................ 248 Recognizing When the Argent iSeries Job Adapter is Active .................................... button labels. Notes and Cautions to help with procedural instructions throughout the document. Used to differentiate the command keys on your keyboard. Indicates Command Line text. In addition to the conventions shown in the tables below. Bold Type Courier First Letter Capitalized Italic Type Emphasizes important words or phrases customers need to know. commands. Indicates a Toolbar or Menu Bar choice. and are familiar with enterprise networking environments and the associated terminology. Used for textual emphasis. ENTER SMALL CAPITAL LETTERS Table 1. Conventions This documentation uses the following conventions: Font Use Arial Bold Used for procedural instructions. customers will find Tips. Examples: “Click the Configuration button on the Toolbar. Also used to indicate choice decisions in procedural instructions.Argent Job Scheduler Users Guide About This Document This document assumes that customers can understand and are comfortable using the Windows 200x operating systems.” “The Configuration window” provides access to the Console. Font Conventions © ArgSoft Intellectual Property Holdings. Limited 1991-2006 About This Document • Page i . Examples: SHIFT. etc. ” Enter Check/uncheck Leaf Supply the input information. Table 2.. Terminology Conventions © ArgSoft Intellectual Property Holdings. Left click of the mouse. Limited 1991-2006 About This Document • Page ii . A folder containing a tree-like view of related entities.Argent Job Scheduler Users Guide Terminology Box Feature Box Check box Click Right Click Select Use A section of the Argent Job Scheduler screen. Embossed box that can be checked/unchecked to select/deselect the entity. Box with 3D style that can be checked / unchecked to select/deselect the entity. Examples: “Select Alert1 from Alert leaf.. Click or Double-click of the left mouse button to highlight the selected entity.” “Select the Home Path and enter a new one. To select/deselect an entity. Right click of the mouse. Australia Support@Argent. London.com Email: © ArgSoft Intellectual Property Holdings.3200 44.com Asia Telephone: Fax: Mail: 852 2330 0310 852 2330 0311 Argent Technical Support Unit 2017-2018.207. send a fax.3381 Argent Technical Support 288 Bishopsgate.959. Hung Hom.Argent Job Scheduler Users Guide Worldwide Technical Support Argent Software Technical Support is available 24 hours per day. Support@Argent. Farmington. Do not hesitate to call. seven days a week. Limited 1991-2006 Worldwide Technical Support • Page 1 . Victoria 3000. Level 1. Middle East and Africa Telephone: Fax: Mail: Email: 44.959.com Email: Europe. Metropolis Tower. Kowloon.com Email: Australia and New Zealand Telephone: Fax: Mail: 61 3 9863 8220 61 3 9863 8221 Argent Technical Support. CT 06032 United States of America Support@Argent. St Kilda Road Towers. or write us. United States and Canada Telephone: Fax: Mail: 860 674 1700 860 674 0101 Argent Technical Support 6 Forest Park Drive.207. UK EC2M 4QP Support@Argent. 10 Metropolis Drive. 1 Queens Road Melbourne. Hong Kong. e-mail. In This Chapter This chapter includes the following topics: • • • • • • Using the Argent Job Scheduler screens Toolbar Buttons Managing the Argent Job Scheduler Service Forecast Log Window Components of a Batch Job Types of Alerts © ArgSoft Intellectual Property Holdings. Limited 1991-2006 Worldwide Technical Support • Page 2 . Here ‘optional’ means that the Argent Job Scheduler can run without specifying any calendaring mechanism. These are: • • • • • • • Service Management Scheduler Argent Queue Engine and/or Argent iSeries Job Adapter Job Classes Alerts Macros Calendars (optional) Note: Calendars are an optional facility available in the Argent Job Scheduler.Argent Job Scheduler Users Guide Chapter 1: Basic Concepts The Argent Job Scheduler consists of seven main components. • Also. It displays the different types of entries in the Argent Job Scheduler logs. Customers can preview Job Info. Archive Jobs. Limited 1991-2006 Worldwide Technical Support • Page 3 . Servers. icons represent the most frequently used commands. Archived Jobs. the Quick Help tab displays information relevant to the item selected in the map details window (the upper-left pane). Job Classes. Queue Engine Settings. • On the left pane of the screen. a window relating to the server is displayed. At the bottom of the screen is the log window. Note: The choices displayed will be relevant to the option highlighted in the map details window. Last. Connect Queue Engine. Prior System Logs. • On the toolbar. Submit. Validate Job. Service Management. Each of these leaves can be expanded to view greater detail or collapsed when not needed. windows are displayed corresponding to the options that customer will select. commands can be accessed from the menu bar and. a window is displayed listing all the map details including leaves showing the Schedule. Master List. For example. Report. Figure 2. They are Exit.Argent Job Scheduler Users Guide Using Argent Job Scheduler Screens Argent Job Scheduler GUI is divided into three panes on the screen. Calendars.1: Standard Toolbar • Customers can also access and execute commands by clicking the right button of the mouse anywhere in the window. Results. whereupon the pop-up menu will display a list of commands that can be selected. Archived Jobs and Service Management. Alerts. • • Toolbar Buttons Customers can access commands in three ways. Argent Instant Help and About Box. Reports. Macros. On the right pane of the screen. Refresh All. Sever Log or Scheduler Log by clicking on these tabs. © ArgSoft Intellectual Property Holdings. commands can be executed using hot keys. if customer clicks on the Servers leaf and select a server running the queue engine. in some cases. Configuration. Manual Job Rollover. Limited 1991-2006 Worldwide Technical Support • Page 4 .Argent Job Scheduler Users Guide The Argent Job Scheduler toolbar provides “point and click” access to the different the Argent Job Scheduler screens. The toolbar buttons are listed following: Exit the Argent Job Scheduler Read control information from database and refresh the GUI Submit Job Validate Job Connect to a server running the queue engine Manually rollover jobs Argent Queue Engine general settings Manually archive jobs View archived jobs Argent Job Scheduler system configuration Access Argent Job Scheduler reports Service management Argent Instant Help Access Help © ArgSoft Intellectual Property Holdings. click on the service status icon (the yellow light bulb) in the lower right hand corner of the Argent Job Scheduler status bar. Use the correspondent button to start or stop the service. The Service Management window allows customers to view whether the Argent Job Scheduler service and the Argent Job Scheduler itself are functioning properly. How To Access The Argent Job Scheduler service can be accessed in three ways: 1. 2. Select ‘Service Management’ from left tree panel. To start or stop the Scheduling Engine • • • Select Start Service or Stop Service from the System menu bar From the Status Bar. Limited 1991-2006 Worldwide Technical Support • Page 5 . © ArgSoft Intellectual Property Holdings. It also is the interface for managing all of the Argent Job Scheduler’s administrative functions.Argent Job Scheduler Users Guide Managing The Argent Job Scheduler Scheduling Service Argent Service Management is Argent Job Scheduler’s administrative interface. To launch the Argent Job Scheduler from the Desktop: Click Start > Programs > Argent Job Scheduler > Scheduling Engine. Limited 1991-2006 Worldwide Technical Support • Page 6 . Service Management This box provides customers with the Argent Job Scheduler service information from the Window 200x Event Log.Argent Job Scheduler Users Guide Service Management Window The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler’s screens. © ArgSoft Intellectual Property Holdings. W200x Event Log for The Argent Job Scheduler This log records the activities of both the Argent Job Scheduler and the Argent Job Scheduler service. Argent Job Scheduler Service Management window. Click the Start or Stop buttons to start or stop the Argent Job Scheduler Service or start or stop the service by clicking on the icon on the status bar. The Event Log is useful for diagnosing the nature of errors occurring in the Argent Job Scheduler. as well as such information as Date/Time and Event Detail. Argent Job Scheduler Service Management Options The following options are available from the Argent Job Scheduler service management window. Screen ID J2. This number identifies the screen for reference. Warning and Error entries are entered for events that affect the function of the Argent Job Scheduler. A log of jobs submitted to the queue engine. Warning.Argent Job Scheduler Users Guide Server Log There are three different types of entries in the Argent Job Scheduler logs: Event. Parameter. i. A job status log. Results Displays the results of the job executed. such as starting and stopping the service or the GUI. Lists error messages pertaining to errors in running the Argent Job Scheduler. Scheduler Log Displays the Scheduler’s service and error status including: • • A log showing the service status for the Argent Job Scheduler. Limited 1991-2006 Worldwide Technical Support • Page 7 . and any changes made to the Argent Job Scheduler’s configurations or definitions. Job Info Tab Provides information related to Jobs such as Scheduling. Server Log Displays information about the Scheduler server including: • • • A status log for the queue engine Service. Event entries record the routine functions of the Argent Job Scheduler. whether in Start or Stop mode. and Error.. User Name and Security Info. Job Name. Job File. © ArgSoft Intellectual Property Holdings. Argent Job Scheduler Log Window Options The following options are available from the Scheduler Log window.e. A iSeries job is iSeries command with specific parameters. Pager. Batch jobs are expected to require no keyboard or mouse input since they execute with no visible window. Macros enable users to create frequently used lists of common items that can be shared across the enterprise. What Are Macros? Macros are shortcuts or abbreviations used to refer to a common list of alerts. Bell. and Argent Console.EXE) file. The queue engine can optionally detect and abort a job that is waiting for keyboard input. users.BAT) or an executable (. the queue engine queues or jobs. Alerts can be used to notify operations staff of a problem and/or to automatically take corrective action. Job Started and Job Completed Normally. Limited 1991-2006 Worldwide Technical Support • Page 8 . Message. Types of Alerts Alerts are messages to be sent depending on certain events that may occur. © ArgSoft Intellectual Property Holdings. Run Command. Alerts may also be used to inform the operations staff of normal progress. for example. A UNIX job is generally a shell script. The types of Alerts are: Email.Argent Job Scheduler Users Guide Components of A Batch Job Batch jobs are the basic units of work that can be submitted to queues.CMD or . A SAP job usually consists of multiple ABAP steps and/or external command steps. A W200X job can be either a command procedure (. This number identifies the screen for reference. Screen ID J1. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 Worldwide Technical Support • Page 9 . How To Access Argent Job Scheduler Schedule window can be accessed in the following manner: From the left pane in the Argent Job Scheduler window. Scheduler screen. click on the ‘Schedule Of Current Jobs’ leaf.Argent Job Scheduler Users Guide Chapter 2: Scheduling Jobs Argent Job Scheduler Schedule maintains a list of Jobs that are being submitted to a server running the queue engine for processing at a later time. In This Chapter This chapter contains the following topics: • • • • Schedule Window Refreshing the Job List Descriptions of Scheduler Columns Menu Items The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. The Schedule initiates each job according to its priority in the queue and then maintains the status of each job. This screen uses the Argent UST list. Users can click on the column headings to sort in ascending / descending orders. Date Mask. Server Mask and Job Status Mask options while the job details list appears in the middle half of the pane. Limited 1991-2006 Worldwide Technical Support • Page 10 .Argent Job Scheduler Users Guide The Schedule window (right pane) contains the Summary. © ArgSoft Intellectual Property Holdings. © ArgSoft Intellectual Property Holdings. it can be run on a server running the queue engine. hour or minute fields. Alternately. Show All Jobs.Argent Job Scheduler Users Guide Using Job Masks Summary – Summarize Argent Job Scheduler Job Activity Displays statistics for the currently displayed jobs. only those jobs that have been submitted today are displayed. The date/time format option allows the time that is displayed for each job to be toggled between • • Local Time Zone Job Specific – The job specific time zone is always relative to the local time zone. Start Time / End Time Set the start and end times to limit which jobs are displayed by their scheduled or actual execution times.e. I. The job can be specified in the Scheduler screens (J20J) to run at its scheduled time based on either the local time for the Argent Job Scheduler. or the time on the server running the queue engine. only the next instance of the jobs are displayed. ignore date range. These statistics can be used to estimate the current job load. The following statistics are shown: • • • • Finished Jobs Abended Jobs Jobs to Run Running Jobs Date Masks The table below describes the options available for specifying what jobs are displayed in the Scheduler screen. the job specific time zone is not shown in Zulu (or Greenwich Mean Time) but in hours earlier or later than the local time. Show Only Next Instance Of Job When this feature box is checked. then use the spin buttons to increment or decrement the values. year. select either the month. Limited 1991-2006 Worldwide Technical Support • Page 11 .. etc. Show Today’s Job List When this feature box is checked. To change the Start and End date/times. Using the Date/Time Format The date/time format option determines how the Schedule screen for each job displays the date and time. click on the pulldown button (at the right of each date/time field) to display a calendar for selection. day. When a job is scheduled. predict future workloads. This server can be running in a different time zone. Ignore Date Range When this feature box is checked. the column’s order is inverted. Sorting Columns on the Screen As with all the columnar fields in the Argent Job Scheduler. Class and Job Name enable operators to quickly focus on a small subset of jobs on a specific group of servers. independent. the column headings in the J1 screen can be sorted by clicking on them. Limited 1991-2006 Worldwide Technical Support • Page 12 . Scheduler Colors The individual job entries can be set to various colors and/or fonts based on the value of their Status column – refer to the Using the Job Scheduler / Job List. Selection Feature Boxes The six. that column sorts the list. © ArgSoft Intellectual Property Holdings. By clicking the heading. These characteristics are described below. Did Not Start. Selection Masks The three selection masks of Server. This interval can be set from the Configuration / System Options tab (J1P) using the Job List Refresh Interval option – see page 155 for details. Held. selection feature boxes of Submitted. Pattern Matching The pattern matching logic in the Argent Job Scheduler is the same as that in standard 200x file management commands (* and ? are the wild-card characters). by clicking the heading again. Otherwise. the F5 hot key can be clicked to update the actual screen.Argent Job Scheduler Users Guide Types Of Job Masks A job mask allows customers to display a list of jobs depending on particular job characteristics. the Scheduler refreshes the job list after a fixed interval. Once one or more of the selection mask fields are entered. Ended. Abended. Refreshing the Job List The job list is refreshed when the Refresh button is clicked. and Others provide additional selection tests to further refine the jobs listed on the screen. Job Number Once a job instance has started executing on a server running the queue engine. whether it is in ready state. Return Code (Exit Code) Indicates the completed job instance’s completion code or return code. this field displays the local job number assigned by the queue engine. Date/Time This is the actual/scheduled execution time of the job instance on a server running the queue engine. or executable file that was specified in the “. Two job instances running on different servers running the queue engine will have job numbers that are totally independent of each other. Server/Queue The name of a server running the queue engine and queue that the job will use. provided the job is in Ready mode. For explicit job instances (ones that use an AND-type Affinity). batch file. running or abended. For example. if the Argent Job Scheduler is running on a server on the East Coast of the United States. this is the server running the queue engine’s time zone relative to the local server that is running the Argent Job Scheduler service. Time Zone This is the time zone for the job instance. Job Name Displays the name of the job.) Status Shows the status of the job in the job list. CPU Displays the CPU time used by the job. that is. or exit code from the command procedure. Limited 1991-2006 Worldwide Technical Support • Page 13 . Sequence It is used to show the jobs started in job sequence (See Macro Definition) Refresh Button Refreshes the job list immediately.Cmd File:” field. Class Displays the Class name assigned to job. the job number is specific only to the actual server running the queue engine that executed the job. (The actual servers’ time zones relative to GMT can be viewed by using the queue engine List tab screen J3. a value of 3 would indicate a server on the West Coast of the United States.Argent Job Scheduler Users Guide Description of Job Details Columns The description of the job details columns in the Scheduler screen follows: Late Displays the label “Late” if a job has not executed on time. © ArgSoft Intellectual Property Holdings. Refresh Job Log [F6] Refreshes the log file by adding new log details Edit Job’s Command File Edits the Command file using Notepad Deselect All Deselects any selections in the job list. (Some items can also be accessed from the menu bar. Job Output and Job Completion Information. Hold Job Pauses the highlighted job Cancel Job Cancels the highlighted job Delete Job Deletes the highlighted job Edit Job Attributes Before Execution Allows a selected job’s attributes to be edited. Run Job Now Executes the highlighted job immediately Rerun Ended Job Re-executes a job which ended previously. on the entire screen © ArgSoft Intellectual Property Holdings. click the right mouse button in the Scheduler windows. Release Job Removes job from queue. To display the popup menu.) View Job Log Views the job log file which contains information regarding User Account. the server running the queue engine. Show Filter Mask Toggle on/off to display/hide filter mask window (right pane). Toggle Full Screen Displays the window on the right. Email Job Log Emails the log to the configured email address. Submission Time. The job may have ended normally or may have abended. Command Line. Limited 1991-2006 Worldwide Technical Support • Page 14 . This includes editing job parameters. Find In Job List Finds particular job/entries form the displlayed list Font Allows selection of both font and colors used to show job status.Argent Job Scheduler Users Guide Popup Menu Options The table below describes the popup menu items provided for scheduling jobs. file dependencies. Customers can reschedule it later. job dependencies and ODBC dependencies. Current Directory. Find Finds particular job/entries. Expand Lower Leaves Expands all leaves (branches) below the selected leaf in the services tree. Collapse All Leaves Collapses all leaves (branches) in the services tree (left pane). Limited 1991-2006 Worldwide Technical Support • Page 15 . Expand All Leaves Expands all leaves (branches) in the services tree (the Explorer view in the left pane). © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide Show Log/Quick Help Toggle on/off to display/hide the log and quick help window (bottom pane). local server time. How To Access The queue engine window can be accessed in the following manner: Expand the leaf of ‘Server Where Job Runs’ and select a server running the queue engine.Argent Job Scheduler Users Guide Chapter 3: Argent Queue Engine for Windows The Queue Engine Servers screen displays information on the list of connected servers running the queue engine. time zone and time difference. Limited 1991-2006 Worldwide Technical Support • Page 16 . It also maintains information about them like version. Permissions The queue engine Queue Properties Queue Status Queue Priority Max Pending Jobs Max Executing Jobs Automatic Starting and Stopping of Queues Retain Jobs Queue Description Menu Items © ArgSoft Intellectual Property Holdings. In This Chapter This chapter contains the following topics: • • • • • • • • • • • Connecting to a server running the queue engine General Information. Startup Jobs. and displays information on whether the jobs are being executed or not. These Argent Queue Engines are called remote Argent Queue Engine. © ArgSoft Intellectual Property Holdings. Connecting To A Server Running W200X/NT Argent Queue Engine To connect to a server running queue engine: Step 1: • • Right click on any Server under the node Servers Where Jobs Run and select Connect Server option from the popup menu. offering a number of options for connecting to a server running the queue engines. If Argent Queue Engine is installed in DMZ or a remote network. The Connect to Queue Engine dialog will appear. Figure 5. Argent Queue Engine should be connected differently.1: Connect to a server running the queue engine Step 2: If the intended Argent Queue Engine is not in the list. the name of server running Argent Queue Engine can be manually entered by clicking on Manual.Argent Job Scheduler Users Guide Connect To Argent Queue Engine (W200X/NT) Depending the network environment. Limited 1991-2006 Worldwide Technical Support • Page 17 . the Argent Job Scheduler main engine may connect to it through pure TCP/IP. select the server(s) to connect to and click OK. Use Ctrl+Click or Shift+Click to connect to multiple servers. Because Argent Job Scheduler usually cannot access the registry of remote machines. separate each entry by a comma or space. Note: Connected servers are checked. Or customers can select the servers manually. © ArgSoft Intellectual Property Holdings. additional information is needed to establish communications.Argent Job Scheduler Users Guide Customers unsure of the existing Argent Queue Engines can click Scan Network to scan the network for a server running the queue engine service. Click on menu ‘Remote/UNIX Server Management’ and configuration dialog should show. Once the scan is complete. The scan options for finding a server running the queue engine are: • • • • The Whole Network Only Specific Domains Exclude Specific Domains Use Active Directory When specifying more than one domain. Connecting To A Remote Server Running W200X/NT Queue Engine Customers can connect to a W200X/NT Queue Engine through a TCP/IP network. the Queue Engine window will be displayed. This applies to W200X/NT Queue Engine installed in a DMZ or over Internet connection. Limited 1991-2006 Worldwide Technical Support • Page 18 . Step 3: After the Argent Job Scheduler is connected to the queue engine. TCP/IP Port 3135 for Argent Queue Engine (XS).Argent Job Scheduler Users Guide Queue Engine Server The DNS resolvable name for the remote Queue Engine.6A NT Version Or Previous Versions’ must be used. ‘Using Message Header’ and ‘4. © ArgSoft Intellectual Property Holdings. For Argent Queue Engine (XS). Comm Protocol It can be one of ‘Not Using Message Header’. Limited 1991-2006 Worldwide Technical Support • Page 19 . Note: The settings must match the actual configuration of the remote Queue Engine to communicate properly.6A NT Version Or Previous Versions’. 3012 for iSeries Job Adapter. the option ‘4. the default setting is ‘Not Using Message Header’. For Pre-W200X Argent Queue Engine. 3000 for Argent Queue Engine (Pre-W200X). Window account should be specified in the format of DOMAIN\USER for domain account and MACHINE\USER for local account. It is vital to map the service account and job account to the accounts acceptable in the remote network in order to execute job properly. the Argent Job Scheduler service account or job account may not be valid for the network. Limited 1991-2006 Worldwide Technical Support • Page 20 .Argent Job Scheduler Users Guide The next step is to set up the account mapping. © ArgSoft Intellectual Property Holdings. The remote Queue Engine may run under a complete different network. © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide After saving the changes and repeating the Connect Server operation. Limited 1991-2006 Worldwide Technical Support • Page 21 . customer should see that the newly added server shows up in the dialog box. Argent Job Scheduler Users Guide Argent Queue Engine Properties A server running the queue engine window displays three tabs: • • • General Info Startup Jobs Permissions © ArgSoft Intellectual Property Holdings. Limited 1991-2006 Worldwide Technical Support • Page 22 . Options also allow specifying how the job should be executed as: • • • Every time the service starts When the service starts at system boot When the service starts after a non-orderly shutdown Permissions Click on the Permissions tab to view details about users and the rights they have been given. Log Size Limit. System Log File. Maximum Executing Jobs. System Boot Threshold. Customers can add a user name and rights assigned to the user to the existing list. It displays information such as Server Local Time. Priority Quantum. Maximum Job Processes and Used Today’s Licensed Jobs as well as Current Statistics of the executing jobs and job processes. Job Number Wraps After Job. © ArgSoft Intellectual Property Holdings. Default Queue. Revision Level. and select whether customers want the job to be aborted if the time limit is exceeded. Startup Jobs Use the Startup Jobs tab to set parameters like Job time limit. Limited 1991-2006 Worldwide Technical Support • Page 23 .Argent Job Scheduler Users Guide General Info Use the button View System Log on Server to load a server running the queue engine log. Queue Properties Queues have several properties that control the way they behave. customers could set a queue to start every evening and stop every morning. Queues are waiting lines and serve to schedule work in an orderly way. and thus consume CPU time. Queue Priority Every queue has a queue priority ranging from 0 to 255. a site could create queues for specific workgroups or specific tasks. With this arrangement. An open queue will accept new jobs that are submitted to it. assuming that both jobs were equally CPU-bound. while a closed queue will not. a job in a queue with a priority of 200 would receive roughly twice the CPU time as a job in a queue with a priority of 100. A started queue will execute pending jobs in the queue. the engine’s properties can be controlled by the Argent Job Scheduler. The first is whether the queue is Started or Stopped. a site could set up: • • • A queue with a high priority and an executing jobs limit of 4 or 5 for the jobs that require immediate attention A queue that executes jobs only at night and has a low priority for the jobs that can wait until the next day A queue with a low priority and an executing jobs limit of 2 or 3 for the jobs that are not urgent and can be performed in the background In addition. For this reason. For example. For example. yet those jobs will not increase the system’s daytime workload. the queue engine takes full advantage of the preemptive multitasking and Symmetric MultiProcessing (SMP) support built into Windows 200x. These properties can be specified when the queue is created. Scheduling jobs in queues allows resources to be used efficiently. Queues also allow work to be done during off-hours. and the second is whether the queue is Open or Closed. and they can be modified after the queue has been created. are not strictly CPU-bound. to serve different purposes. during the workday. so that the performance of interactive work is not adversely impacted by batch. Limited 1991-2006 Worldwide Technical Support • Page 24 . © ArgSoft Intellectual Property Holdings. Queues can also be set by choosing auto to start and stop and to open and close automatically at certain times of the day. users can submit jobs to the queue and expect the jobs to be completed by the next morning. relative to jobs that execute in other queues.Argent Job Scheduler Users Guide Queue Engine Properties Once a server running the queue engine has been connected. Most sites will want to create several queues with different properties. when interactive users are not using the system. however. Most real-world jobs. allowing lower priority jobs to use any CPU time unused by higher priority jobs. while a stopped queue will not. The priority of a queue determines the amount of CPU time given to jobs that execute in the queue. For example. so that jobs in the queue do not execute. like a waiting line in a bank. Queue Status There are two elements to a queue’s status. In some cases. and thus improve response time for users. depending on a site’s needs and resources including CPU power. Retain Jobs Jobs can also be retained for a specified amount of time.e. i. Limited 1991-2006 Worldwide Technical Support • Page 25 .. a specific queue can be configured to start at 6:30 every evening. memory and disk. Jobs that do not need to be completed until the next day can be submitted to that queue and they will automatically be executed during the off-hours. Max Executing Jobs Every queue has a limit on the number of jobs it can execute. when interactive users are not using the system. For example. it is desirable for a queue to execute only one job at a time.Argent Job Scheduler Users Guide The Queue Engine service enforces queue priorities by dynamically tracking and adjusting the priority class of all processes in all of the executing jobs several times per Max Pending Jobs A queue’s pending jobs limit is the maximum number of jobs that can be pending in the queue. Queue Description A description of the queue can be specified here. This feature can be used to balance the system’s workload throughout the day. awaiting execution. so that several jobs can execute at once in the queue. the queue is full and no additional jobs can be submitted to the queue until a pending job is started or canceled or until the queue’s pending jobs limit is increased. © ArgSoft Intellectual Property Holdings. Typical values for this attribute range from one to about 6 or 7. This value is the maximum number of jobs that can execute at one time in the queue. In other cases. so those jobs are always executed in the same order in which they are submitted. Automatically Starting and Stopping Queues The queue engine has the capability to automatically start and stop queues at certain times of the day. and stop at 7:30 every morning. it is desirable for a queue to have a higher executing jobs limit. When this limit is reached. Start / Stop The Argent Queue Engine Service Only one of these two options will be available for selection. Disconnect Server Disconnects from a server running the queue engine service. Show Log/Quick Help Toggle on/off to display/hide the log and quick help window (bottom pane).Argent Job Scheduler Users Guide Popup Menu Options The list following shows menu items provided for connecting to servers and setting parameters. Expand All Leaves Expands all leaves (branches) in the services tree (the Explorer view in the left pane). Server General Settings Access the parameters setting window for the server to execute jobs. Collapse All Leaves Collapses all leaves (branches) in the services tree (left pane). View Server Log With Notepad Creates an ASCII text file for all the log entries. New Queue Creates a new queue in the Queue Engine. Find Finds particular job/entries. Limited 1991-2006 Worldwide Technical Support • Page 26 . © ArgSoft Intellectual Property Holdings. this option will be enabled (this is disabled by default) and can be used to display the error details. depending on whether the Queue Engine is running or halted. Select the available option to toggle the execution status of the Queue Engine. Show Error Detail If a critical error occurs in the Queue Engine. Expand Lower Leaves Expands all leaves (branches) below the selected leaf in the services tree. Connect Server Click to connect to a running a server running the queue engine service. access permissions. Use Default Log Directory Select this option to use the default directory.Argent Job Scheduler Users Guide Queue Options Windows The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. The Queue Property Tab The queue engine Property screen is used to set queue properties including the log directory. Options include: Name Hows the name of the queue. The queue name is set when the queue is created and this field cannot be edited directly. This number identifies the screen for reference. priorities and job levels. Created The date/time stamp when the queue was created. Limited 1991-2006 Worldwide Technical Support • Page 27 . Queue Engine Property window. This field cannot be edited or revised. © ArgSoft Intellectual Property Holdings. Screen ID J12A. enter a new directory to be used as the default or use the browse button to select a drive/path. Optionally. If the Argent Job Scheduler has a choice of multiple queues to use and is instructed to use the first available queue. Refer also to the Permission tab (following) for additional permission settings. the queue can be read by all users. or even seen by the operators. with a default queue setting of 24 hours. something needs to be done with it. the Auto… setting may be selected for both status selections with the Auto Start: / Auto Stop: fields setting the time of day to start and stop queue operations and the Auto Open: / Auto Close: fields setting the time of day during which new tasks are accepted. Limited 1991-2006 Worldwide Technical Support • Page 28 . Stopped – The queue is halted (inactive).Argent Job Scheduler Users Guide Default Job Protection These options allow specific W200x permissions to be set at the queue level. Queue Priorities A high-priority queue has a default priority of 255 while a low priority queue has a default value of 0 for background operations and a value of 128 (mid-range) would be used for a queue which was neither urgent or background. Allow Everyone Full Control Access if selected. the queue is then considered to be unavailable. For an example: the administrator of the data center may not want certain jobs to be changed. © ArgSoft Intellectual Property Holdings. then the Scheduler will pass over the now unavailable queue and submit the job to a different queue. Allow Everyone Read Access If selected. This might be set because a job (or jobs) are too resource intensive to run more than one at a time or because of licensing issues or complications involving resource sharing. Retain Jobs for Sets the period of time to retain a job. Max Executing Jobs One of the most powerful uses of this option is to set the maximum to 1 – this permits only a single job to be run through the queue at any time. Max Pending Jobs This option is used to manage job loads. • • • • Started – The queue is running (active). This option allows that flexibility down to the granularity of a job definition. Closed – The queue will not accept new tasks. its performance would soon be degraded. If every complete job record were stored in the queue database. This setting allows the record of completed jobs to remain for a short time. Once a queue has reached its Max Pending Jobs limit. • Alternately. Status Queue status may be manually set as Started or Stopped and as Open or Closed. Open – The queue is ready to accept new tasks. Once a job is complete. full access and control is granted to everyone. Delete and Set Permissions. To set CPU affinities. a queue is allowed to use all available CPUs as shown by the checkbox next to each listed CPU. Submit Job. Queue CPU Affinities Tab On multiple CPU systems. the CPU Affinities tab shows a list of the available CPUs. Queue Permission Tab The Permission tab shows the Queue Owner along with the groups which have access to the queue and the permissions assigned to each.Argent Job Scheduler Users Guide Queue Description Provides a description of the queue. By default. Test The Current User Tests the permission settings of the current user. Check marks show which permissions are granted and individual group permissions can be changed by clicking on the permission and selecting either Yes or No from the popup option menu. Remove User/Group Removes a selected group from the Permissions lists. check the Use CPU Affinity option and then check or uncheck individual CPUs. This could include notes on the purpose the queue is intended to serve. who is responsible for the queue operations or who or what groups are authorized to use the queue. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 Worldwide Technical Support • Page 29 . Queue permissions are Control. Add User/Group Use to add or create a new group and assign permissions for the group. its main window is divided into two panes. or a queue being created. In the style of File Manager. which the queue engine lacks. If customers have advanced needs.Argent Job Scheduler Users Guide Argent Queue Engine Main GUI User can also access the Queue Engine through Argent Queue Engine Main GUI . and the right pane shows the jobs in the currently selected queue. Limited 1991-2006 Worldwide Technical Support • Page 30 . causes the display to be updated immediately. When it comes to submitting/automating jobs. The left pane shows the queues on the queue engine server. It provides a fully synchronized window into the queue system on any Queue Engine server in customers network. they will be working most with the Argent Job Scheduler.1: The Argent Queue Engine Any change in the queue system. such as a job being submitted by another user. From any computer on customers network. © ArgSoft Intellectual Property Holdings. Figure 10. the queue engine Main GUI gives them an immediate and accurate picture of all queues and jobs on the queue engine server. please use The Scheduler as it was designed with this in mind and has much functionality. Any of the commands may be used on the local computer or sent across the network to a remote Queue Engine server computer. or discards a job QCLOSE – closes a queue QCREATE – creates a new queue QDELETE – deletes a queue QMODIFY – modifies a queue QOPEN – opens a queue QREQUEUE – moves a job to a different queue QSHOW – displays information about jobs and queues QSTART – starts a queue QSTOP – stops a queue QSUBMIT – submits a job to a queue QSYSTEM – performs administrative tasks Appendix A: Command Reference provides an alphabetical reference to these commands. To make customers the commands available at the Command Prompt. Queue Engine commands are available on any computer containing either a Queue Engine client or service installation. (See Appendix A: Command Reference for more information about using the commands across a network. Limited 1991-2006 Worldwide Technical Support • Page 31 .) © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide Queue Engine Commands The queue engine commands are used to submit and manage jobs and otherwise control the queue system. add the queue engine directory to their path. aborts. The available commands are listed following: • • • • • • • • • • • • QCANCEL – cancels. Queue Engines uphold this level of security by taking full advantage of the sophisticated Windows 200x security model. users from domain A can submit jobs to a Queue Engine server in domain B because domain B trusts domain A. however. and all other objects in the system is fully upheld. processes. In the setup shown in Figure 70. as defined by the U. have a two-way trust relationship. customers can control who may submit jobs to a queue that they create. Thus. for example. Just as customers can control who may read or write to directories and files on an NTFS volume. even if a particular user is explicitly denied access to a file. In addition to upholding Windows 200x security within executing jobs. on the other hand. or who may cancel or abort a job that they submit. a job scheduled by that user with the at command may have access to the file. Users from the same domain as a computer containing a Queue Engine service installation.Argent Job Scheduler Users Guide Queue Engine Security The Windows 200x security model is designed to provide C2-level security. For example. Security on files. Users in each domain may submit jobs to Queue Engine servers in the other domain. Limited 1991-2006 Worldwide Technical Support • Page 32 . or permissions. may submit jobs to the queue engine server. or from any domain trusted by that domain. Domain A and domain C. One-way trust: B trusts A Domain A Two-way trust: A trusts C and Domain B Domain C Figure 10.S. Department of Defense. then the user’s batch job cannot access the same file or object. cannot submit jobs to a Queue Engine server in domain A because domain A does not trust domain B. Queue Engines also fully support trust relationships between domains.2: Trust relationships between domains © ArgSoft Intellectual Property Holdings. If a user cannot access a file or other object interactively. on the other hand. Users from domain B. executes in the security context of the user who submitted it. they can control access to queues and jobs on a Queue Engine server. Jobs scheduled with the Windows 200x at command are executed in the account that the Schedule service is set to log on as. A batch job started under The Queue Engine. the queue engine protects queues and jobs with discretionary access control lists. 6.7 (7). HP-UX OS version 11.11 and later. 2. Limited 1991-2006 Worldwide Technical Support • Page 33 .8 (8).18-3 (Red Hat 7. and 2.3 and later. which currently runs on Microsoft W200x systems. Linux 2. AIX OS version 4. The Argent Job Queue Engine currently runs on the following UNIX platforms: • • • • Sun Microsystems SPARC based workstations and servers running the Solaris OS 2.4.Argent Job Scheduler Users Guide Chapter 4: Argent Queue Engine for UNIX The Argent UNIX Queue Engine executes jobs on behalf of the Argent Job Scheduler. as well as jobs generated by the utilities supplied with the Queue Engine.3) and later © ArgSoft Intellectual Property Holdings. Queue Engine Server The DNS resolvable name for the UNIX Queue Engine. TCP/IP Port Default value is 3000 © ArgSoft Intellectual Property Holdings. Click on menu ‘Remote/UNIX/iSeries/SAP Management’ and configuration dialog should show. Limited 1991-2006 Worldwide Technical Support • Page 34 .Argent Job Scheduler Users Guide Connect To UNIX Queue Engine User can connect to a UNIX Queue Engine through pure TCP/IP network. UNIX server generally has its own account management. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 Worldwide Technical Support • Page 35 .Argent Job Scheduler Users Guide The next step is to set up the account mapping. It is vital to map the service account and job account to the correct UNIX accounts in order to execute job properly. Argent Job Scheduler Users Guide After saving the changes and repeating the Connect Server operation the newly added server should appear in the dialogue box. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 Worldwide Technical Support • Page 36 . Revision Level. Job Number Wraps After Job. Log Size Limit. System Boot Threshold. Priority Quantum. It displays information such as Server Local Time.Argent Job Scheduler Users Guide General Info Use the button View System Log on Server to load a server running the queue engine log. Maximum Executing Jobs. System Log File. Limited 1991-2006 Worldwide Technical Support • Page 37 . © ArgSoft Intellectual Property Holdings. Maximum Job Processes and Used Today’s Licensed Jobs as well as Current Statistics of the executing jobs and job processes. Default Queue. and they can be modified after the queue is created. for jobs that can wait until the next day A queue with a low priority and an executing jobs limit of 2 or 3. to serve different purposes.Argent Job Scheduler Users Guide Queue Properties Queues have several properties that control the way they behave. for jobs that require immediate attention A queue that executes jobs only at night and has a low priority. Most sites will want to create several queues with different properties. For example. © ArgSoft Intellectual Property Holdings. for jobs that are not urgent and can be performed in the background In addition. Limited 1991-2006 Worldwide Technical Support • Page 38 . A queue’s properties can be specified when the queue is created. a site could create queues for specific workgroups or specific tasks. a site could set up: • • • A queue with a high priority and an executing jobs limit of 4 or 5. a specific queue may be configured to start at 6:30 every evening. and stop at 7:30 every morning. Jobs that do not need to be completed until the next day may be submitted to that queue and they will automatically be executed during the off-hours. A process is usually created with a nice value of 20. which run in the background. and thus consume CPU time. Executing Jobs Limit Every queue has an executing jobs limit. it is desirable for a queue to execute only one job at a time. A process may be nice to other processes running on the system by increasing its nice value. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 Worldwide Technical Support • Page 39 . The UNIX OS uses the nice value to calculate the process’ priority value. in order to minimize its impact on the other processes running on the system. A started queue will execute pending jobs in the queue. The higher a process’ nice value. The first is whether the queue is started or stopped. depending on a site’s needs and computing power. customers could set a queue to start every evening and stop every morning. so jobs are always executed in the same order in which they are submitted. For example. so that several jobs can execute at once in the queue. lowering the process’ priority. is a desirable feature. or the queue’s pending jobs limit is increased. so jobs in the queue do not execute. This feature can be used to balance their system’s workload throughout the day. and the second is whether the queue is open or closed.Argent Job Scheduler Users Guide Priority The generic UNIX interface for affecting process priority is known as nice. Status There are two elements to a queue’s status. when interactive users are not using the system. For example. In other cases. Any process may raise its nice value. Typical values for this attribute range from one to about 6 or 7. thereby lowering its priority. An open queue will accept new jobs that are submitted to it. while a stopped queue will not. Only a process with root privileges may lower its nice value. With this arrangement. This value is the maximum number of jobs that can execute at one time in the queue. users can submit jobs to the queue and expect the jobs to be completed by the next morning. and thus improve response time for users. yet those jobs will not increase the system’s daytime workload. Pending Jobs Limit A queue’s pending jobs limit is the maximum number of jobs that can be pending in the queue. the lower a process’ scheduling priority will be. during the workday. Automatic Starting and Stopping of Queues Queue Engines has the capability to automatically start and stop queues at certain times of the day that customers specify. while a closed queue will not. Queues may also be set to start and stop or open and close automatically at certain times of the day. When this limit is reached. the queue is full and no more jobs can be submitted to the queue until a pending job is started or canceled. Nice values range from 0 to 39. In some cases. it is desirable for a queue to have a higher executing jobs limit. Since many jobs scheduled on a queue are batched background tasks. Execute permission controls who can submit and eventually execute the jobs in the queue. Read permission controls who can see the queue settings in GUI. It is configured in the typical UNIX style (owner. © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide Queue Permissions Queue permission controls who can read/write/execute job in the queue. Limited 1991-2006 Worldwide Technical Support • Page 40 . group and others). Write permission controls who can change the queue settings. Jobs are expected to be console-mode applications. Jobs in Queue Engines Jobs are the basic units of work that may be submitted to queues. Limited 1991-2006 Worldwide Technical Support • Page 41 . CtrlD). since they execute with no visible window. not X11 GUI applications.Argent Job Scheduler Users Guide CPU Affinity This setting can be useful for tuning the efficiency of job execution on the multiprocessor high-end UNIX servers. A job may be either a shell script or an executable binary file. © ArgSoft Intellectual Property Holdings. Any executing job that does look for keyboard input will get an immediate response of EOT (Null input. The UNIX Queue Engine creates jobs with their standard input (stdin) connected to /dev/null. Batch jobs are expected to require no keyboard or mouse input. If a user cannot access a file or other object interactively.* Queue Engine job-level security has two aspects: • The queue security setting of the mapped account for the job submittor (Argent Job Scheduler service account for rollover jobs and current logon user for the adhoc jobs) determines whether a job can be submitted to the specific queue. etc. or who may cancel or abort a job that they submit.Argent Job Scheduler Users Guide UNIX Queue Engine Security Queue Engine queue-level security is straightforward. Security on files. Limited 1991-2006 Worldwide Technical Support • Page 42 . cancelled. • © ArgSoft Intellectual Property Holdings. The job is executed under the context of either the default service account or the mapped account of the user specified in the job definition. then the user’s batch job cannot access the same file or object. processes. customers can control who may submit jobs to a queue that they create. and all other objects in the system is fully upheld. a running job can be aborted. The mapped account of current logon user determines it. For example. The UNIX queue engine protects queues with permissions. which currently runs on Microsoft W200x systems. The following topics introduce several important aspects of queues and queue engines.Argent Job Scheduler Users Guide Chapter 5: Argent iSeries Job Adapter Argent iSeries Job Adapter executes jobs on behalf of Argent Job Scheduler. © ArgSoft Intellectual Property Holdings. iSeries. Limited 1991-2006 Worldwide Technical Support • Page 43 . and i5/OS platforms running at version V5R1M0 or later. Argent iSeries Job Adapter currently runs on all Operating System/400. are supported. Argent Job Scheduler Users Guide Connect To Argent iSeries Job Adapter User can connect to a Argent iSeries Job Adapter through pure TCP/IP network. Click on menu ‘Remote/UNIX/iSeries/SAP Management’ and configuration dialog should show. iSeries Job Adapter The DNS resolvable name for the iSeries server. Limited 1991-2006 Worldwide Technical Support • Page 44 . TCP/IP Port Default value is 3012 © ArgSoft Intellectual Property Holdings. Limited 1991-2006 Worldwide Technical Support • Page 45 . It is vital to map the service account and job account to the correct iSeries accounts in order to execute job properly. iSeries server generally has its own account management. © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide The next step is to set up the account mapping. the newly added server should appear in the dialogue box.Argent Job Scheduler Users Guide After saving the changes and repeating the Connect Server operation. Limited 1991-2006 Worldwide Technical Support • Page 46 . © ArgSoft Intellectual Property Holdings. © ArgSoft Intellectual Property Holdings. It displays information such as Server Local Time.Argent Job Scheduler Users Guide General Info Use the button View System Log on Server to load a server running the queue engine log. Limited 1991-2006 Worldwide Technical Support • Page 47 . Revision Level. etc. the status in the Argent Job Scheduler will appear as stopped. CHGJOBQE. The first is whether the queue is started or stopped. The relationship between a queue and the iSeries subsystem description object is displayed on the queue properties. and RMVJOBQE commands. On iSeries. and the second is whether the queue is open or closed. Limited 1991-2006 Worldwide Technical Support • Page 48 . © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide Queue Properties iSeries queues are associated with subsystem description objects. Status There are two elements to a queue’s status. a queue is started if is is not in a HELD status. If the queue is held on the iSeries server using the HOLDJOBQ command. A Queue can be created at any time. but the apportionment of the queue to a subsystem description object is controlled directly on the iSeries server through the ADDJOBQE. The relationship between a subsystem description object and queue that are related to it is controlled by job queue entries within the subsystem description object. Limited 1991-2006 Worldwide Technical Support • Page 49 . iSeries Jobs Jobs are the basic units of work that may be submitted to queues. to submit a command named NIGHTLYPAY with parameters MONTHLY(*YES) and REPORTS(*ALL). The job log is a spooled output report that accompanies each job executed by the Argent iSeries Job Adapter. The job log is not available to the Argent Job Scheduler until the iSeries job has completed execution. when the job ended. it will appears in closed status. customers specify NIGHTLYPAY as the Command File and MONGTHLY(*YES) REPORTS(*ALL) as the Parameters. iSeries jobs are always executed as batch jobs by the Argent iSeries Job Adapter. but the subsystem is not active. If the queue is not configured in any iSeries subsystem description. Job Log Files Each iSeries job submitted from the Argent Job Scheduler will generate a job log. An iSeries job consists of a command and optional associated parameters. © ArgSoft Intellectual Property Holdings. For example. logged on under the account of the user who submitted the job. the Windows user account must be mapped to an iSeries user profile with sufficient authoritiy to execute the job. a user-created command. and application-provided command. the queue will also appear as closed. since they execute unattended. Batch jobs are allowed to interact with users through iSeries message commands such as SNDPGMMSG. The spooled job log report is converted to a readable text file and is returned to the Argent Job Scheduler. the command expression used bythe job. the job log can be retrieved using the Argent Job Scheduler. where it can be viewed as with any other job log file. When the job has completed. How the Job Scheduler Adapter Executes Jobs The Argent iSeries Job Adapter executes each job in a separate process. a queue is open if it is configured in an active iSeries subsystem description. Batch are expected to require full-screen user or keyboard input. The job log report contains detailed information about when the job was submitted. In order to submit jobs. which queue it was submitted to. Submitting Jobs Jobs are submitted to queues using the Argent Job Scheduler Command File and Paremeters prompts. If a queue is configured in an iSeries subsystem description.Argent Job Scheduler Users Guide On iSeries. and the end code of the job. A command can be an iSeries operating system command. or even the CALL command. If a user is not authorized to access a given file directly on the iSeries server. All iSeries security configuration is enforced. © ArgSoft Intellectual Property Holdings. that user will not be able to submit that job through the Argent iSeries Job Adapter. If a user does authority to execute a given iSeries job.Argent Job Scheduler Users Guide Job Scheduler Adapter Security A batch job submitted through the Argent iSeries Job Adapter executes in the security context of the mapped account of user who submitted it. that user will not be able to access the file through the Argent iSeries Job Adapter. for example. Limited 1991-2006 • Page 50 . Connecting To SAP System SAPGUI must installed on the Argent Job Scheduler main engine and any clients in order to connect to the SAP System.Argent Job Scheduler Users Guide Chapter 6: Integrate With SAP System Unlike UNIX and iSeries platforms. The Argent Job Scheduler does not require additional software to be installed on SAP system to communicate. Click on menu ‘Remote/UNIX/iSeries/SAP Management’ and configuration dialog should show. The Argent Job Scheduler uses the industry standard SAP BAPI interface to communicate with SAP system. Limited 1991-2006 • Page 51 . © ArgSoft Intellectual Property Holdings. SAP App Server The IP address of the SAP server SAP Router The SAP router string.Argent Job Scheduler Users Guide SAP Server The real SAP server name. Default is empty. The SAP system has its own account management. © ArgSoft Intellectual Property Holdings. It is vital to map the service account and job account to the correct SAP accounts in order to execute job properly. SAP System Number Default value is ‘0’ SAP Client Number Default value is ‘000’ The next step is to set up the account mapping. Limited 1991-2006 • Page 52 . the newly added server should appear in the dialoque box. © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide After saving the changes and repeating the Connect Server operation. Note: The Queue ‘SAP’ is only a placeholder. Limited 1991-2006 • Page 53 . Limited 1991-2006 • Page 54 . How to Access Customers can access Argent SuperMap window by selecting Servers Where Jobs Run from the left tree pane. Screen ID J15. © ArgSoft Intellectual Property Holdings. Argent SuperMaps Use the dropdown to select the Argent SuperMap to be displayed.Argent Job Scheduler Users Guide Chapter 7: Argent SuperMaps The Argent SuperMap allows customer to create their own map to monitor the status of servers and queues. Argent SuperMap window. Limited 1991-2006 • Page 55 .Argent Job Scheduler Users Guide Argent SuperMap Define Customer can create or edit SuperMaps by selecting Define Argent SuperMap on the right click menu. Screen ID J15B. © ArgSoft Intellectual Property Holdings. Argent SuperMaps define window. Note: The map need not be the image of a country or state. Argent SuperMap name window. Click OK to select the desired image. Click Yes to delete the selected SuperMap or click No to exit from the dialog.Argent Job Scheduler Users Guide Add Use the Add button to enter the name of the new Argent SuperMap. Browse For New Map File Use this button to desired image from the list. The Argent SuperMaps home is the one that is first displayed. it can be anything that represents a logical image. Select the required SuperMap from the combo box and click on the ‘Delete’ button. © ArgSoft Intellectual Property Holdings. such as a corporate map of factories. Screen ID J26. Delete Use this button to delete an existing SuperMap. Limited 1991-2006 • Page 56 . Click OK. Set As Home Check this option to set the selected SuperMap as the Argent SuperMaps home. The X and Y Coordinates can be change by dragging the location rectangle on the SuperMap define window. Y Position Enter the X and Y coordinates for the location to be placed on the SuperMap.Argent Job Scheduler Users Guide Delete Use this section to add the servers and queues onto the map to be monitored. Location Setting window. Custom Text Enter the name to be shown on the SuperMap X Position. Screen ID J15C. Click to create a new location and to edit an existing location. Text Align Use the drop down to select the text alignment of the location. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 57 . Text Color Use the color picker to specify the text color of the location. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 58 . Screen ID J76. Click edit an existing Hotlink. Select the desirable Argent SuperMap to be linked to.Argent Job Scheduler Users Guide Hotlinks The Hotlinks function is similar to an image map in HTML pages. It can link Argent SuperMaps to form any kind of hierarchy. to create a new Hotlink and to On creating a new Hotlink the following screen will be shown. Hotlink Settings window. Press left mouse button to draw a rectangle on the map for the hotlink area. Customers can select the desired map from the combo box of the sub window. since they execute with no visible window. The queue engine can optionally detect and abort a job that is waiting for keyboard input. Limited 1991-2006 • Page 59 . In This Chapter This chapter contains the following topics: • • • • • • • • Creating a Job Class List of Job Classes Creating and Defining a New Job Queue Options Alert Notification Post Job Progress Advanced Job Class Options Menu Items © ArgSoft Intellectual Property Holdings. How to Access The Job Classes window can be accessed in the following manner: • Click on the Job Classes leaf. Batch jobs are expected to require no keyboard or mouse input. Jobs are the basic units of work that are submitted to queues.Argent Job Scheduler Users Guide Chapter 8: Job Class And Job Template The Job Classes section defines batch jobs that the Argent Job Scheduler will submit to the queue engine. with classes of R&D. and CUSTSERV. On a finer level of granularity. these can be filtered by Job Class. etc. Figure 9. GL. the financial unit might organize its batch work with classes of PAYROLL. MFG. AR. The Job Classes branch must be fully collapsed for this option to appear. For instance. AP. MKTG. If New Job Class does not appear on the popup menu.Argent Job Scheduler Users Guide Creating a Job Class Job Classes are simply a means of organizing jobs. jobs may be organized according to their functional units. SALES. Step 2: Enter a name for the Job Class. collapse the Job Classes leaf (branch) and then try again. Limited 1991-2006 • Page 60 . FINANCE. © ArgSoft Intellectual Property Holdings. ENG.1: The New Job Class Name dialog The Job Classes leaf (branch) will expand to show the new class and the Job Class Properties dialog will appear. then click OK. Note: Each Class customers create will be listed in a sub-directory under the Job Classes leaf. Procedure 5: Creating A Job Class To create a job class: Step 1: Right-click the mouse on the Job Classes leaf and select New Job Class from the popup menu. ASSET. Remember that when browsing jobs in the system. then close the Job Class Properties dialog.2: The Job Class Properties dialog Edit the job class properties if necessary. Limited 1991-2006 • Page 61 .Argent Job Scheduler Users Guide Step 3: Figure 9. © ArgSoft Intellectual Property Holdings. one or more job instances are created and to be processed by the Argent Job Scheduler main engine. Edit the job properties if necessary. how to run. the “Command File” prompt refers to the name of the command to execute on the iSeries server such as CALL or DSPLIB. The “Parameters” prompt refers to the actual command line parameters that are available for the command defined as the “Command File”. the screen of first step is shown as follows: Note: On iSeries.Argent Job Scheduler Users Guide Creating a Job Template A job template defines what to run. For a W200X and iSeries Job. then click Next. © ArgSoft Intellectual Property Holdings. what to do before and after job execution etc. Through job rollover and adhoc job submission. Limited 1991-2006 • Page 62 . Step 2: Enter the name of the Job Name to be displayed. Step 1: Right-click on the new job class in the expanded Job Classes branch and select New Job from the popup menu. when to run. the screen of first step is shown as follows: © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 63 .Argent Job Scheduler Users Guide For a SAP Job. Limited 1991-2006 • Page 64 .Argent Job Scheduler Users Guide Step 3: Click Next to further specify the server to submit the job. © ArgSoft Intellectual Property Holdings. Click Finish to create the new Job. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 65 . Click Finish to create the new Job.Argent Job Scheduler Users Guide Step 4: Click Next to further specify the job schedule. Click Finish to create the new Job. © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide Step 5: Specify the job schedule. Limited 1991-2006 • Page 66 . Argent Job Scheduler Users Guide List of Job Definitions Window The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. Figure 5. List of Job Classes window. Limited 1991-2006 • Page 67 . Screen ID Number J4.3: List of Job Definitions Window List Of Job Definitions The List of Job Definitions window alternately shows a list of all the Job Classes present or a list of Job Classes in one particular Job Class. © ArgSoft Intellectual Property Holdings. This number identifies the screen for reference. 4: Job Definition Window © ArgSoft Intellectual Property Holdings. Screen ID J20. Limited 1991-2006 • Page 68 . This number identifies the screen for reference.Argent Job Scheduler Users Guide Job Definition Window The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. Figure 5. Job Definition window. Limited 1991-2006 • Page 69 . © ArgSoft Intellectual Property Holdings. the user’s rights are shown. Submit Control. Change. For example. the rights might appear as: Your Rights: Read.Argent Job Scheduler Users Guide Job Basic Job Security Job Server Group Job Limit Job Advanced Job Dependencies Post Job Job Schedule At the bottom of the window. Argent Job Scheduler Users Guide Job Definition Basic Dialog The Job Definition screen defines various parameters of a job. (W200X/NT Job) © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 70 . Argent Job Scheduler Users Guide (UNIX Job) © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 71 . Argent Job Scheduler Users Guide (iSeries Job) © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 72 . Log Setting This option is disabled when the Default Log Setting is selected. If any of the remaining three log options are chosen. right-click the mouse on the Class leaf under which customers want to place the job Job File Browse the file customers want to place in a queue for execution. To create a new job. Edit Opens Notepad to edit a batch or command file. Limited 1991-2006 • Page 73 .Argent Job Scheduler Users Guide (SAP Job) The following list shows all of the definable job parameters: Job Name Shows the name of the job selected. © ArgSoft Intellectual Property Holdings. this field is used to specify the log filename and/or path. This field should not be left blank. Argent Job Scheduler Users Guide Default Log Setting The job defers to the queue to assign a log directory path and filename. Use as Log Directory The Log Setting field specifies the directory path where the log is created. Use as Log File The Log Setting field specifies both the directory path and the log filename. For an example. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 74 . Parameters Specify any parameters required for the job. Each time the job executes. assuming one is included in the Parameters specification. Each time the job executes. Test Tests a global string macro. select the JOB_GLOBAL_STRING job – created as a demo during the installation of the Argent Job Scheduler – and then click the Test button. the previous log file is overwritten. a number is added to the filename to create a new file such that the previous log file is not overwritten. Submit Job in Held Mode Select to submit this job in Held mode. Use as Log File with Job Number Appended The Log Setting field specifies both the directory path and the log filename. the log filename is specified by the Scheduler. Argent Job Scheduler Users Guide Job Security Dialog The Job Security screen defines the job account. Password Enter the correct password for the selected user. Username The current user’s name will appear by default. Domain The local domain appears by default. domain and password. Enter a new username or use the browse button to select a domain and user account. from the tree in the Explorer pane. domain and password specified in the Job Class properties. Use password setting specified in the Job Class table Select this option to use the username. Alternately. Use this Password Select this option in order to choose a new username. right click on the Generic job class and then select Job Class Property from the popup menu to display the class properties. domain and password values from the queue engine’s default account. domain and password. Where to get Password when the Job Instance Executes This group of options allows selection of the source for the username. a domain name can be entered. This field will change if the browse button has been used to select a new domain. For example. Confirm Enter the password a second time as confirmation. Execute job under default account of the Argent Queue Engine This is the default password selection and uses the name. Limited 1991-2006 • Page 75 . © ArgSoft Intellectual Property Holdings. Argent Job Scheduler Users Guide Job Schedule Dialog The Job Schedule shows the schedule for the job and the time zone (i. Limited 1991-2006 • Page 76 . To create a schedule for a job by clicking on the schedule button on toolbar and click the New button – the leftmost button in the group of four at the right of the caption – to display the When to Submit Job dialog.. © ArgSoft Intellectual Property Holdings. the server) which the scheduling is based on.e. Argent Job Scheduler Users Guide Initially. © ArgSoft Intellectual Property Holdings. – use the More button to display the Advanced Settings portion of the dialog as shown. the When to Submit Job dialog appears in the collapsed format. Limited 1991-2006 • Page 77 . The default is one hour later than the time the job submission was created. Monthly and Use Calendar. • Daily Use the Schedule Task Daily options to schedule execution every x days. customers may specify that a job should repeat every 10 minutes or every 2 hours. For example. a job can be repeated at regular intervals or • Every – Select an interval in Minutes or Hours for the job to repeat. Options are. • Select Months – Select which months the job should run. • Duration – Sets an interval in hours/minutes for the job to repeat. © ArgSoft Intellectual Property Holdings. • Use Calendar Use the Advanced Task Scheduling option to select a Calendar Definition (see Chapter 8. • Once Since the task will only execute once. Limited 1991-2006 • Page 78 . Advanced Scheduling Using Calendars) to control job submission. repeat operations are set either until a specified time or for a specified duration as: • Time – Sets a time to terminate the repeat job.Argent Job Scheduler Users Guide Scheduling options are: Schedule Task This pull down list offer five options as Once. Daily. Repeat Job In addition to scheduling a starting time and date(s) for a job.) Use the spin buttons to change the start time or enter the desired start time manually. Weekly. Start Time All of the Schedule Task options allow a start time to be specified. • Until – Rather than allowing a job to repeat indefinitely. As scheduling interval is selected. • Weekly Use the Schedule Task Weekly options to schedule execution every x weeks on selected days of the week. the only scheduling option is the Start Time (following). the dialog changes to reflect the selection options. (The default Start Time will be the time the job submission is created. The default is one hour. Use the spin buttons to change the repeat interval or enter the number of days manually. • Day – Select the day of the month. • Monthly Use the Schedule Task Monthly options to schedule execution either by the day of the month or by the week and day of the week. Argent Job Scheduler Users Guide Advanced Settings The advanced options do not appear until the More button is selected but allow start and end dates to be specified for a job. there are a number of reasons why customers might not want it to be submitted. if the file arrives on that day. Both the start and end dates can be changed by selecting any of the date fields – day of week. the scheduler ignores the job during rollover. omitting the day of the week. Do Not Rollover If selected and the job has not started. With this option on. If the job did not have this option enabled. customers can choose the calendar button at the right of the field to display a calendar and select the desired date. • The job is submitted by another job. and. when submitted by a human (ad hoc) or at rollover time (typically midnight for the next day’s job instances). • date. Limited 1991-2006 • Page 79 . Purge The Job Instance If selected and the job has not started by rollover. If not Started. For example: a job is submitted every day at 00:01 that waits for a file (i.e. then – when a job waited for a day and was not run – the next day the job would have been submitted again. For example.. a Job Definition called JOB1 may have a schedule of from 00:00 to 23:58. The dates will appear only as month/day/*. • Ignore Year – Select this option to ignore the year field in the start and end dates. Alternately. However. this job is not included in rollover. day or year – and using the spin buttons to increment or decrement the values. the job is purged from the job instance. every hour. month. Either the job is obsolete. not yet complete. Using this option prevents the job from being added to the schedule by rollover. While a job is normally submitted automatically at rollover. the required file only shows up on some days and not at all on other days. • The job should not run. both instances of the job would run. once an hour. Thus. Often jobs are grouped into sequences where one job submits another job based on its successful completion. • End Date – The ending date must be selected explicitly but will default to today’s date. the job is not included in rollover. If Job Not Started By Rollover. one Job Definition creates twenty-four job instances. or not ready to be put into production. © ArgSoft Intellectual Property Holdings. can create multiple job instances. Start Date – The starting date is enabled by default and will appear as today’s Note: A single Job Definition. Other option settings for job schedules are: Do Not Include This Job in Rollover If selected. a file dependency). the Affinity options are: First Available Server Executes the job on the first started open queue on the first running server in the given list.Argent Job Scheduler Users Guide Job Server Group Dialog The Job Servers Group shows the available server (or servers) where the job can execute. Use Universal Naming Convention (UNC) paths for job files.. This type of affinity can be used for balancing job loads across multiple servers. Running a job with this option requires that the job be able to run on each of the servers. one for each server/queue listed. but on the node with the lowest CPU load at the time of submission. All Servers Specified Above Executes the job on all the servers/ queues listed. and be sure that all resources required by the job are available on all servers. © ArgSoft Intellectual Property Holdings. Least-busy Server (Lowest CPU) Executes the job only once. Limited 1991-2006 • Page 80 . If multiple servers are listed. This means that multiple instances of the job will run. an ODBC Dependency entry is created for the job and appears as a subbranch under the tree entry. a File Dependency entry is created for the job and appears as a sub-branch under the tree entry.Argent Job Scheduler Users Guide Job Dependencies Dialog The Dependencies tab offers three options to enable job dependencies as: Define File Dependencies for job If selected. A Job Dependency requires another specified job to have executed with a specific result and/or within a specified period. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 81 . Define Job Dependencies for job If selected. a Job Dependency entry is created for the job and appears as a sub-branch under the tree entry. including a column value in an ODBC-compliant database and can include SQL statements to perform conditional tests. Define ODBC Dependencies for job If selected. An ODBC Dependency can set several conditions for executing a job. The File Dependency requires a specified file to exist before the job can be executed. Actions include email and pager notification. two responses can be defined as: • • Fire Following Alerts – Fire an Alert when a structural error occurs Execute Following Jobs – Execute another job if a structural error occurs © ArgSoft Intellectual Property Holdings. two responses can be defined as: • • Fire Following Alerts – Fire an Alert when a job starts Execute Following Jobs – Execute another job when a job starts Notify if Structural Error Happens If this option is selected. Limited 1991-2006 • Page 82 . when a job begins. These notifications are defined in the Post Job and the Limits definitions. Notify When Job Starts If this option is selected. In the Post Job Dialog. five response options are available as notifications. when a structural error occurs. or simply ringing the system bell. network pop-up messages. execution of specific commands.Argent Job Scheduler Users Guide Post Job Dialog: Alert Notifications The Argent Job Scheduler can take actions based on events related to an individual job. Some processes return a simple “0” if the process was successful. Limited 1991-2006 • Page 83 . exit codes are important because they can be used to monitor the results of jobs so that automated decisions can be made. Other programs can have hundreds of discriminating exit codes that are cataloged in their documentation. Exit Code Handling can be used to look for either a specific number from the exit code. The exit code that is returned by customer’s job process is dependent of the job process itself.Argent Job Scheduler Users Guide The fifth – and most important – Eesponse option is the Exit Code Handling option: Exit Code Handling Besides the generic actions that the Argent Job Scheduler can take when a job begins or ends. © ArgSoft Intellectual Property Holdings. the Argent Job Scheduler can be used for more complex decisions based on the condition codes returned by the job process. or for an exit code that falls within a range of numbers. What Is An Exit Code? An exit code is a number that is returned when a process ends. and a “1” if it was not. the Argent Job Scheduler also presents the option of interrogating the condition (exit) code to determine whether the job should be labeled as Failed or Completed. When the testing criteria have been met. the Argent Job Scheduler can then submit another job and/or execute an Alert definition. In batch job scheduling. Argent Job Scheduler Users Guide Job Limits Dialog The Limits tab allows a variety of limits to be imposed on job execution. the Limits tab also offers provisions to issue notifications (Alerts) in the event various conditions are met. Limited 1991-2006 • Page 84 . Notify if job has not started by Issues an Alert if a job has not executed by a specified time. Notifications include: Notify if job runs more than Issues an Alert if a job takes longer than a specified time. Notify if job is late more than Issues an Alert if a job is late by a specified time. In addition to limiting the time allotted for a task to execute and how many times a task can be executed within a given period. © ArgSoft Intellectual Property Holdings. Execution restrictions include: Execution time limit Limits the maximum execution time for a job CPU time limit Limits the maximum CPU time allowed for a job Limit running job Limits how many times a job can be run within a specified time frame (starting and ending dates). e.Argent Job Scheduler Users Guide Notify if job has not ended by Issues an Alert if a job has not completed by a specified time. Protect from ‘Everyone’ Full Control Prevents unauthorized accounts from administering the job definition. Job Advanced Dialog The Advanced tab in the Job Definition window offers a collection of miscellaneous options – i. Protect from ‘Everyone’ Read Prevents unauthorized accounts from viewing the job definition by removing the Read permission from the Everyone group. Limited 1991-2006 • Page 85 . options that do not fit in other categories. Abort job if waiting for keyboard input This option instructs the queue engine to monitor the job for any pauses that are due to © ArgSoft Intellectual Property Holdings. This prevents inadvertent overlapping of processes. These include: Only one job instance being executed at any time Only one instance of a job is permitted to execute. Normally. Caution: any pop-up error messages. However. As an example: Visual Basic has extensive error codes internally. or dialog boxes that are generated by the job will not be detected by this method. which are defined by the object Err. Exit codes are based on the output of the job process. and still complete with an exit code of “0”. such close supervision may cause some applications to perform badly. and the Scheduler can read the file and use this code as the exit code for the batch job. Some job processes or applications have internal error codes but do not pass these to the environment as exit codes. the queue engine has the capacity to allow jobs to be submitted without CPU time monitoring. Abort job if waiting for dismissal of message box This option instructs the queue engine to abort the scheduled job if it is waiting for message box for dismissal. Then the batch job process can write an error code to this file. processes – such as BCP in MS SQL Server – may run faster in the “No Monitor Environment”. Use exit code file Exits codes are written to an exit code file on termination. Err.Number Close #1 End Sub Retain for debugging purpose. The following code fragment can be added to the error handler in the Visual Basic app so that its internal error levels.Number. To avoid such execution problems.Argent Job Scheduler Users Guide the program waiting for keyboard entry. A Visual Basic batch job may encounter a severe error internally. disabling monitoring of the CPU time usage means the queue engine cannot report CPU usage back to the Scheduler. but does not use these error codes as exit codes. In some cases. the job must be a 32-bit console application. This setting causes the scheduler to leave the file intact so that – if the batch job is not writing to the file correctly – it can be debugged. To use this option. © ArgSoft Intellectual Property Holdings. are communicated to the Scheduler ErrorHandler: Dim strExitCode As String strExitCode = Environ$("TABF_EXIT_CODE_FILE") Open strExitCode For Output As 1 Write #1. Do not Monitor Job CPU Time Normal Queue Engine jobs are monitored directly by the queue engine's launcher program however. The exit code file provides a way for these codes to be extracted from the batch job by creating a file name that both the batch job and the Scheduler are aware of. do not delete exit code file The exit code file is retained for later use. Limited 1991-2006 • Page 86 . the exit code file is deleted and this is preferred since many files may be created. The Do not Monitor Job CPU Time option – in the Advanced tab – effectively overrides the CPU time limit option found in the Limits tab. Job Submission and Execution Argent Job Scheduler does not execute the job directly. Job Class Properties Click to modify the properties for any job class. one or more scripts can be defined for execution after to running the job. Also. Click on the right mouse button for the drop-down box to be displayed or access these options from the menu bar. It controls the schedule. Optional Pre-Job Scripts Optionally. Menu Items The list below describes the menu items used to define jobs. one or more scripts can be defined for execution prior to running the job.Argent Job Scheduler Users Guide Write Record to W200x Event Log for Stopped Jobs Optional switch to log stopped jobs notification to the W200x Event Viewer’s Application Log. When it is the time to execute a job. queue options. Optional Post-Job Scripts Optionally. Limited 1991-2006 • Page 87 . alerts and advanced options. New Job Click to create a new job Save Click to save a new or revised definition Delete Click to delete the job Rename Click to rename existing jobs Copy Click to copy an existing Job Definition Delete Schedule Click to delete a Job Schedule Delete File Dependency Click to delete a File Dependency Delete Job Dependency Click to delete the Job Dependency sub-rule Validate Job Definition Click to validate a job Submit Job Click to submit a job after customers have defined it. it submit the job to the specified queue engine. Argent Job © ArgSoft Intellectual Property Holdings. they can click on the Submit icon on the tool bar to submit a Job. Universal Naming Convention (UNC) names such as \\nt2\project or \\tulsa\payroll\database1 will resolve correctly.CMD and . logged on under the account of the user who has submitted the job. they will be created in the same directory as the job's file. not the remote computer from which the job was submitted. Jobs are submitted to queues by their filenames. Every job is executed on a server running the queue engine computer. even if the job was submitted from a remote computer. CMD.BAT /QUEUE=NIGHTLY How Queue Engine Executes Jobs Queue Engines execute each job in a separate process. Limited 1991-2006 • Page 88 . customers would select the batch file on the Submit Job screen in the queue engine.EXE. © ArgSoft Intellectual Property Holdings. relative to either a server running the queue engine computer or the remote computer. or use this command: C:\> QSUBMIT PAYROLL. to submit a batch file called PAYROLL. the filename of the job file and all other files that the job might access must be relative to the server computer. For example. so that if the job creates any files without specifying a directory path. The current directory of each job's process is set to the same directory as the job's file. However. When customers submit a job. • Command procedures (. We will uses QSUBMIT in the following paragraphs to explain the concept. paths containing device names.BAT) are executed under the Windows 200x command processor. will refer to devices on a server running the queue engine computer. such as C:\payroll\database1.BAT to a queue called NIGHTLY.EXE) jobs are simply executed directly in the new process.Argent Job Scheduler Users Guide Scheduler uses the same API as the command line utility QSUBMIT to submit jobs. • Executable (. Limited 1991-2006 • Page 89 . and any other utility-type programs that are used frequently. Customers can then specify the batch file name in the job file field and the old and new file names of the file that needs to be renamed in the job parameters field. Customers can also create a Notepad file which will store all the details of that particular job for customers to view.LOG. Customers can specify an alternate log file filename when customers submit a job. database transactions. customers could create a batch job to compile a source code file. except that it has the extension LOG. they can specify the name of the file to compile as a job parameter. they could use the special character %1. By default. as the job's executable or batch file. When they submit the job. they can enter one or more parameters. The executable or command procedure that they submit can use these parameters when it executes. Suppose the batch file holds the command RENAME %1 %2. A job's log file contains the character-mode output created by the job when it executes. such as how much CPU time is used. Job log files allow customers to verify that a job worked properly and completed successfully. the job’s number is appended to the filename of the log file. Log files for batch jobs contain each command in the batch file followed by the output from the command. as in C:\PR\JOB2. Log files for executable jobs contain all console output from the job. This allows multiple log files from the same job to exist in the same directory without being overwritten.JobNumber. This feature can be very useful for setting up generic jobs or Job Classes. Job Parameters When customers submit a job to a queue. For example. for example. © ArgSoft Intellectual Property Holdings. By default. but instead of naming the file in the batch job. customers could use the special characters %1 and %2.353. and statistics about the job. output from printf statements in a C program.C Another example could be to create a batch job to rename a file. as in the following command: C:> QSUBMIT COMPILE /QUEUE=DEV/PARAMS=C:\PROJECT\MAIN.Argent Job Scheduler Users Guide Job Log Files and Parameters Because jobs in the queue system are executed behind the scenes. with no visible output. This feature is useful for setting up batch jobs to perform backups. file transfers. a log file is created for each job. and is located in the same directory. but instead of naming the file in the batch job. a job's log file has the same filename. The job's exit code is also recorded in the job’s log file and the queue engine system log file. and can be used to implement error handling in customers batch files. it returns an exit code. Job exit codes are typically used to indicate whether a job completed successfully. Other programming languages have similar methods for setting a program's exit code.Argent Job Scheduler Users Guide Job Exit Codes When a job completes. The exit codes from many Windows 200x commands are documented in Windows 200x Help. EXE) job written in C is determined by the value returned from the main function or the value passed to the exit or Exit Process function. The exit code from an executable (. the convention is that an exit code of zero indicates successful completion and a non-zero exit code indicates that an error occurred. If a job is defined so that a user is notified upon the job's completion. © ArgSoft Intellectual Property Holdings. Although there are no strict standards for exit codes. this exit code is reported to the user. The exit code from a batch job is determined by the exit code returned from the last command executed. Limited 1991-2006 • Page 90 . Limited 1991-2006 • Page 91 . The actions can be used to either notify the Operations staff of a problem. then select an individual Alert to display properties.Argent Job Scheduler Users Guide Chapter 9: Alert Definitions The Alert Definitions section defines actions that the Argent Job Scheduler can take. How To Access The Alert Definitions window can be accessed in the following manner: In the Explorer window (left pane). or to automatically take corrective action. click on the Alerts leaf. In This Chapter This chapter contains the following topics: • • • • • • • • • Email Alerts Setting Up Exchange Mail Setting Up SMTP Mail Pager Alerts Bell Alerts Run Command Alerts W200x Message Alerts Argent Console Alerts Menu Items © ArgSoft Intellectual Property Holdings. 1: The Basic Tab in the Alert Description Window The Basic tab in the Alert description is used to set the alert priority (as Low. Medium or High).Argent Job Scheduler Users Guide Alert Description Window The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. Screen ID J24A. who should be notified. Bell. why the alert was created and by whom or other information which could potentially be useful at a later date. Figure 6. Pager. The Description field is used to enter notes describing the purpose of the alert. Alert Description window. Run Command. NT Message and/or Guardian Alert – and to display a description of alert. Limited 1991-2006 • Page 92 . © ArgSoft Intellectual Property Holdings. This number identifies the screen for reference. to select the Alert Type (or types) – as Email. Argent Job Scheduler Users Guide Email Alert Tab The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. This number identifies the screen for reference. Figure 6. Screen ID J24B. select the Argent Job Scheduler Alert type as Email (J25) The email message sent by the Argent Job Scheduler can be modified in several ways. Email Alerts window. To specify which one is used for the particular Email alert that is being sent. Limited 1991-2006 • Page 93 . Email Type Use the pull down menu options to specify the type of email to be sent as either MAPI or SMTP. or directly from the Argent Job Scheduler in Simple Mail Transport Protocol (SMTP).2: Email Alerts Window The Argent Job Scheduler has the capability of sending email messages through either the local MS Exchange client. © ArgSoft Intellectual Property Holdings. The Argent Job Scheduler can use both modes of transport at once. or SMTP-based-client must be installed on the node to run this feature. Attach File A specific file can be attached to the message. Complete – The complete results of the job execution results are included. Note: Either a MAPI. Message Text Text entered in the message field will be included in the message. Separate multiple addresses on one line with a semicolon. Limited 1991-2006 • Page 94 . While most alphanumeric pagers now have email addresses. Options are: • • • None – No details are included with the message. pager service providers may truncate email messages sent to pagers to 80 characters or may page multiple times. The selection buttons (…) at the right of the To: and CC: fields allow customers to choose entries from their email address book.Argent Job Scheduler Users Guide To/CC Multiple recipients can be specified either in the main address field. In response. or to receive the alert as a carbon copy (CC). Summary – A summary of the job execution result is appended. Include the queue engine Job Log The job execution log can be included as an attachment to the message. Include Detail of Job Execution Result The alert can include detailed system information about the job in the mail message. Use the Browse button to select a file or enter the path/filename manually. Subject Specify either a custom subject line or use the default subject: “The Argent Job Scheduler Alert”. © ArgSoft Intellectual Property Holdings. standard pages can only receive 80 characters at a time. • Page – Condenses the message to the smallest reasonable size and should produce a level of detail smaller than the Summary detail level. then the account used is the one that started the service. customers must go to the Control Panel and select the mail and fax icon. Step 2: Customers will then be shown the available mail services. Step 4: Indicate the computer name of the Exchange Server. Limited 1991-2006 • Page 95 . \\Tower\WGPO. Step 3: Give customers profile a name. A profile must be created for each. answer No. perform the following steps. This is critical.Argent Job Scheduler Users Guide Setting Up Exchange Email First create an Exchange Mail Account. Procedure 6: Setting Up Exchange Email Step 1: Select add a profile. It is important to remember that profiles are associated with a login account. Step 6: When the Microsoft Exchange setup asks “Will customers be traveling with this computer?”. To start Exchange to create a profile. If customers are logged out and the program is running from the service engine. Step 7: If customers have an MS Mail Post Office.” To setup Exchange Email for the Argent Job Scheduler. Choose what customers need. or run “Microsoft Exchange Services as a program. For example. Next create (ADD) a profile. as any profile customers create must reference a mailbox associated with their login account. Step 5: Indicate a mailbox associated with customers current login account. Step 8: Select customers mailbox Step 9: Open the Argent Job Scheduler Configuration screen and select the Email Options tab (J3P) Step 10: Select the Windows Messaging option and enter the profile name and the Windows 200x password of the associated account. © ArgSoft Intellectual Property Holdings. enter the correct UNC path. the two most common errors are: Wrong profile for login When customers create a profile. enter the location or create one. Choosing the wrong mailbox © ArgSoft Intellectual Property Holdings. it is associated only with their current login profile. Limited 1991-2006 • Page 96 .Argent Job Scheduler Users Guide Step 11: If customers have a personal address book. Step 12: Customers can then select to start Exchange automatically. Step 13: Then click Finish Remember. Select the SMTP Protocol option. Setting up SMTP Mail Open the Argent Job Scheduler configurations screen and select the Email options tab (J3P). Exchange allows customers to select an incorrect mailbox but will return a MAPI error when they try to use it. enter the name of the SMTP server. Finally. Enter the User Id and Password for the SMTP server. Limited 1991-2006 • Page 97 .Argent Job Scheduler Users Guide Customers must select a mailbox created by their current login account.com and will be used to identify customers email address. or an IP address. in the field labeled This Site enter the site name. In the SMTP Host field. This can be in the format yoursite. © ArgSoft Intellectual Property Holdings. This can be a DNS name. Argent Job Scheduler Users Guide © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 98 . Screen ID J24C.3: Pager Alerts Window Pager alert options are: Telephone Number Enter the telephone number used to reach the pager. The customer must provide his operating system and node type to the paging service to get the right number. Be sure customers have the correct paging number. Figure 6. This is called the modem access number. This is normally a seven digit ID found on the back of the pager. This number identifies the screen for reference. Baud Rate Supported baud rates are 110 through 256. Pager Alert window.000 COM Port A pull down list offers the options COM1 through COM9.Argent Job Scheduler Users Guide Pager Alert Tab Window The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 99 . Pager ID Enter the pager ID. sets the maximum number of characters. and communicates using the TeleAlphanumeric Protocol (TAP) standard. Message Text A text message to send to an alphanumeric pager or a number to send to a numeric-only pager. which can be displayed on a page (screen). Test Pager Sends a test message to the pager to test the alert settings. wait for If the Scheduler is unable to sent the alert to the pager. enter the interval (in seconds) to wait between tries and the number of times to retry. © ArgSoft Intellectual Property Holdings. The Argent Job Scheduler sends messages to alphanumeric pagers by means of a modem that connects to a pager service provider. to a beep-only pager. Include Detail Select to include details with the pager alert only for alphanumeric pagers which support extended message displays. Max Chars per Page For alphanumeric pagers.Argent Job Scheduler Users Guide Type The Argent Job Scheduler can send pages to either a numeric or alphanumeric pager or. Numeric Pager A pager capable only of displaying numbers. Advanced The Advanced button displays the Advanced Pager Setup dialog discussed following. Limited 1991-2006 • Page 100 . of course. Select the pager type as: • • • AlphaNumeric Pager A pager capable of displaying a text message. Beeper Only A pager without a display feature. If Failed. Screen ID is J32. Advanced Pager Setup window. © ArgSoft Intellectual Property Holdings. Modem Termination String A command string used to terminate the connection. The default string “ATH” instructs the modem to terminate the call (hang up the phone). Settings include: Modem Initialization String A command string used to initialize the modem. The default string “ATH+++” instructs the modem to terminate a call (that is.Argent Job Scheduler Users Guide Advanced Pager Setup The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. Figure 6. This number identifies the screen for reference. Limited 1991-2006 • Page 101 . hang up the phone just in case the phone is offhook) and to pause for three seconds before proceeding.4: The Advanced Pager Setup Dialog The Advanced Pager Setup dialog is used to select settings suitable for the modem used to send the pager alert message. Parity Options are None. Stop Bits Options are 1. Flow Control Options are Xon/Xoff. Odd. The default is Tone but customers may select Pulse for older phone systems which do not support tone dialing. Short or None. Long. when the pager is tested. Timing Options are Extended. 7 or 8 data bits. Dial Type Options are Tone or Pulse. The default timing option of Standard is compatible with most modems.5 or 2. The default of 7 data bits is compatible with most modems. The default parity option of Even is compatible with most modems. Even. Limited 1991-2006 • Page 102 . Data Bits Options are 5. Standard. Debug Level Set the debug level to ‘1’ for testing. © ArgSoft Intellectual Property Holdings. Hardware or None. Mark or Space. Because paging companies all have mixed modems. The solution is to rely on a simplest common denominator – simplest settings – which should be compatible with all standard modems. The default of 1 stop bit is compatible with most modems. initialization strings should contain the following instructions: • • • • Disable error correction Disable data compression Disable hardware flow control Force the proper baud rate Paging companies do not always have the newest and most sophisticated equipment available and may have a limited ability to adjust baud rate and detect advanced modem features. The default flow control option of None is compatible with most modems. a debug log is written to the indicated file. Parity Check The Parity Check option is enabled by default and is compatible with most modems. To simplify connecting to many modems. testing pagers is nearly impossible as a different modem is always answering at the paging end. Enter a path and filename and. 6.Argent Job Scheduler Users Guide Modem Debug File Spec This is a file used to test and debug an alphanumeric pager issue. 1. Check out the capabilities of customers paging service to ensure that they support the features they are anticipating and relying on. Screen ID J24D. Use the Test button to listen to the alert. Bell Alert window . Selecting the Repeatedly option causes the bell to repeat ten times. The frequency and duration of the bell can be changed to reflect different priorities.Argent Job Scheduler Users Guide Bell Alert Tab The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. use the Save button to retain changes © ArgSoft Intellectual Property Holdings. Figure 6. This number identifies the screen for reference. The three predefined System Bells – High Priority. Medium Priority and Low Priority – each have set frequencies and durations while the Customized bell allows both the Frequency and Duration to be defined.5: The Bell Alerts Window The Argent Job Scheduler bell alert will activate the system bell on the server where the Argent Job Scheduler is running. Limited 1991-2006 • Page 103 . Additionally.Argent Job Scheduler Users Guide Run Command Alerts Window The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. Limited 1991-2006 • Page 104 . This program will be executed on the same node that is running the Argent Job Scheduler service. the Argent Job Scheduler keywords can be added to the command-line to provide information about the specific job being run. Run Command Alert window. Screen ID J24E. © ArgSoft Intellectual Property Holdings. The Argent Job Scheduler Command Alert will launch a program or command. This number identifies the screen for reference. then the following would appear on ServerXYZ: Job 1073 was submitted by TomD. If the job containing this line were submitted by user “TomD” and were job number 1073. Limited 1991-2006 • Page 105 .Argent Job Scheduler Users Guide Queue Engine keyword variables can be used in Run Command alerts as: • • • • • • • %TABF_EXIT_CODE_FILE% – The path and file name of the exit code file used by the queue engine to temporarily store the jobs exit code (optional) %TABF_JOB_FILE% – The path and filename of the batch job being run. Example The following command alert excerpt displays a line containing information about the job: Net Send ServerXYZ Job %TABF_JOB_NUMBER% was submitted by %USERNAME%. • %LowDetail% – Summary details of the batch job’s execution • %ServerNode% – The name of a server running the queue engine where the batch job is executing. © ArgSoft Intellectual Property Holdings. %TABF_JOB_NAME% – The queue engine job name %TABF_JOB_NUMBER% – The queue engine assigned job number %TABF_LOG_FILE% – The path and filename of the job log file %TABF_QUEUE% – The name of the queue that the job was run in %HighDetail% – Complete details of the batch job’s execution. Customers can select one of three types of recipient as: • Name Customers can select a user name from the drop-down list. W200x Message Alert window . If customers do not specify a domain name. Figure 6. There are several ways to specify an W200x Message Alert. or enter * for all members of a sender group. • All Users Currently Connected to Servers © ArgSoft Intellectual Property Holdings. • Domain Enter a domain name. the current domain name is assumed.Argent Job Scheduler Users Guide W200x Message Alerts Window The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. This number identifies the screen for reference.7: The W200x Message Alerts Window The Argent Job Scheduler has the capability to send console messages to a user or to all members of a sender group. A console message can be sent to a Name. Limited 1991-2006 • Page 106 . Domain or All Users connected to a server. Screen ID J24F. Select this option to send a summary of Job Detail with the console message. Include Job Detail Customers can select one of the following options to include job details: • None Select this option if customers do not want to send any Job Detail with the console message. Limited 1991-2006 • Page 107 . Test Use this button to test the console message. • • Complete Summary Select this option to send complete Job Detail with the console message.Argent Job Scheduler Users Guide Select this option to send a console message to all users currently connected to the server. Message Text Enter text in the message field to be included with the Argent Job Scheduler Message Alert. © ArgSoft Intellectual Property Holdings. Argent Job Scheduler Users Guide Argent Console Alerts Window The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. This number identifies the screen for reference.8: Argent Console Alerts Window Argent Extended Technology is a powerful monitoring and alerting product offered by Argent. Alert Name Specify the name of an alert defined on the Argent Console. © ArgSoft Intellectual Property Holdings. Argent Console Alert window. The Argent Console Alert message is defined by: Argent Console Main Engine The name of the Argent Console main engine where the message will be directed. Console Comment Enter a console comment. Screen ID J24G. Figure 6. Argent Job Scheduler has the capability to use Argent Console as its alerting mechanism. Any alert created for the Argent Console can be fired by the Argent Job Scheduler. Limited 1991-2006 • Page 108 . © ArgSoft Intellectual Property Holdings. Message Text Enter a complete text message for the alert. A summary of the job details are included with the message. Menu Items The list following describes the menu items provided for defining Alerts. New Alert Creates a new Alert definition Save Save the Alert definition Delete Delete the Alert definition Undo Undo changes Rename Rename the selected Alert Copy Copy an existing Alert definition Reset Tab Content Click to reset the tabs content Click on the right mouse button for the drop-down box to be displayed. Complete job details are included with the message.Argent Job Scheduler Users Guide Summary Enter a brief summary of the alert message. Include Job Detail The following options control job details included with the Guardian Alert message: • • • None Complete Summary No job details are included in the message. Limited 1991-2006 • Page 109 . These options can also be accessed from the menu bar. Test Use to test the Guardian Alert message. Select a macro type to expand to view individual macros or Right-click on the Macros leaf or a macro type leaf and select New Macro from the popup menu to create a new macro.Argent Job Scheduler Users Guide Chapter 10: Creating and Using Macros Macros are shortcuts. Macros enable users to create frequently used lists of common items that can be shared across the enterprise. Limited 1991-2006 • Page 110 . or abbreviations. In This Chapter This chapter contains the following topics: • • • • • • • Pager Macros Email Macros Alert Macros User Macros Queue Macros Job Sequence Macros Menu Items © ArgSoft Intellectual Property Holdings. How To Access The Macros window can be accessed in the following manner: • • • Click on the Macros leaf in the Explorer pane (left window) to expand the Macros branch. used to refer to a common list of alerts. users. the queue engine queues or jobs. © ArgSoft Intellectual Property Holdings. This number identifies the screen for reference. Macros window. notice that a series of macros are listed which have been provided as examples during the installation of the Argent Job Scheduler. Limited 1991-2006 • Page 111 .Argent Job Scheduler Users Guide Macros Window The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens.1: The Macros Window In the Macros window. Screen ID J6. Figure 7. a macro template – which can be further. Click on the &PM_SAMPLE to view the macro details. defined and then used in the Pager Alerts discussed in Chapter 6.Argent Job Scheduler Users Guide Pager Macros Window The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. © ArgSoft Intellectual Property Holdings. Screen ID J7. Figure 7.2: Pager Macros Window The Pager Macros window shows a sample email macro – or. in this case. Pager Macros window. This number identifies the screen for reference. Limited 1991-2006 • Page 112 . if customers entered PAGER_TEST_MACRO. Limited 1991-2006 • Page 113 . Figure 7. then select New Pager Macro from the popup menu. Enter a new pager macro name. the finished macro name will be &PM_PAGER_TEST_MACRO. then click OK. The new macro will be created as a blank macro definition.Argent Job Scheduler Users Guide Defining Pager Macros To create a new pager macro: Procedure 7: Defining a Pager Macro Step 1: Right-click on the Pager leaf in the Explorer tree. At this point customers may: • Enter a macro definition directly or • Select the blank definition and then click on the browser button (…) at the right of the blank definition listing to select an existing definition file or • Select the New button (leftmost button) from the tools button bar right of the Macro Definition label bar. Thus. Step 2: The New Macro for Pager dialog will appear.3: The New Macro for Pager dialog The name entered will be automatically prefixed with the string &PM_ to identify a pager macro. at the © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 114 . © ArgSoft Intellectual Property Holdings. Parity and Flow Control. Select appropriate Pager Type. Step 4: The blank pager macro definition for the new macro is replaced with a definition based on the information provided.4: The Pager Macro Parameters dialog Enter the Telephone Number and Pager ID. Figure 7. Click OK to save these settings. Stop Bits. Data Bits.Argent Job Scheduler Users Guide Step 3: The Pager Macro Parameters dialog (J49) is displayed. Argent Job Scheduler Users Guide Email Macros Window The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. Email Macros window. Limited 1991-2006 • Page 115 . © ArgSoft Intellectual Property Holdings. Click on the &EM_SAMPLE macro to view the macro details. a macro template – which can be further. This number identifies the screen for reference. in this case. Screen ID J8. defined and then used in the Email Alerts discussed in Chapter 6.5: Email Macros Window The Email Macros window shows a sample email macro – or. Figure 7. the finished macro name will be &EM_EMAIL_TEST_MACRO. then click OK.Argent Job Scheduler Users Guide Defining Email Macros To create a new email macro: Procedure 8: Defining an Email Macro Step 1: Right-click on the Email leaf in the Explorer tree.6: The New Macro for Email dialog The name entered will be automatically prefixed with the string &EM_ to identify an email macro. At this point customers may: • • • Enter a macro definition directly or Select the blank definition and then click on the button (…) at the right of the blank definition listing to select an existing entry from customers address book or Select the New button (leftmost button) from the tools button bar right of the Macro Definition label bar. then select New Email Macro from the popup menu. at the © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 116 . The new macro will be created as a blank macro definition. Step 2: Enter a new Email macro name in the New Macro for Email dialog. if customers entered EMAIL_TEST_MACRO. Figure 7. Thus. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 117 . The blank email macro definition for the new macro is replaced with a definition based on the information provided. Note that the Cc and Bcc buttons are grayed out and cannot be selected. then click OK when finished.Argent Job Scheduler Users Guide Step 3: The Address Book dialog will appear: Figure 7. Carbon copy and blind carbon copy addresses are not supported for email alerts.7: Using the Address Book to create an Email Macro Step 4: Select one or more email recipient names. Argent Job Scheduler Users Guide Alert Macros Window The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. This number identifies the screen for reference. Alert Macro window, Screen ID J9. Figure 7.8: Alert Macros Window The Alert Macros window shows a sample alert macro, which might be used in the Job Notify tab in place of hard-coding an Alert entry. Click on the &AM_SAMPLE macro to view the macro details. © ArgSoft Intellectual Property Holdings, Limited 1991-2006 • Page 118 Argent Job Scheduler Users Guide Defining Alert Macros To create a new alert macro: Procedure 9: Defining an Alert Macro Step 1: Right-click on the Alert leaf in the Explorer tree and select New Alert Macro from the popup menu. Step 2: Enter a new alert macro name in the New Macro for Alert dialog and click OK. Figure 7.9: The New Macro for Alert dialog The name entered will be automatically prefixed with the string &AM_ to identify an alert macro. Thus, if customers entered ALERT_TEST_MACRO, the finished macro name will be &AM_ALERT_TEST_MACRO. The new macro will be created as a blank macro definition. At this point customers may: • Enter a macro definition directly or • Select the blank definition and then click on the button (…) at the right of the blank definition listing or • Select the New button (leftmost button) from the tools button bar right of the Macro Definition label bar. at the Step 3: Select a predefined alert using drop-down menu and click OK. Figure 7.10: Selecting a predefined alert Select a predefined alert from the pull down list, then click OK to save the alert macro definition. © ArgSoft Intellectual Property Holdings, Limited 1991-2006 • Page 119 Argent Job Scheduler Users Guide Repeat the selection process to add additional alerts to the macro definition. User Macros Window The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. This number identifies the screen for reference. User Macros window, Screen ID J10. Figure 7.11: The Argent Job Scheduler User Macros Window The User Macros window shows a sample users macro, which might be used in the Job Notify tab in place of hard-coding a User name. Click on the &UM_SAMPLE macro to view the macro details. © ArgSoft Intellectual Property Holdings, Limited 1991-2006 • Page 120 Argent Job Scheduler Users Guide Defining User Macros To create a new user macro: Procedure 10: Defining a User Macro Step 1: Right-click on the User leaf in the Explorer tree, then select New User Macro from the popup menu. Step 2: Enter a new user macro name in the New Macro for User dialog and click OK. Figure 7.12: The New Macro for User dialog The name entered will be automatically prefixed with the string &UM_ to identify a user macro. Thus, if customers entered USER_TEST_MACRO, the finished macro name will be &UM_USER_TEST_MACRO. The new macro will be created as a blank macro definition. At this point customers may: • • • Enter a macro definition directly or Select the blank definition and then click on the button (…) at the right of the blank definition listing or Select the New button (leftmost button) from the tools button bar right of the Macro Definition label bar. at the © ArgSoft Intellectual Property Holdings, Limited 1991-2006 • Page 121 Argent Job Scheduler Users Guide Step 3: The Select a Domain or a Local User dialog will appear. Figure 7.14: Selecting a domain or a local user Select a the appropriate account and Click OK to complete the User macro. © ArgSoft Intellectual Property Holdings, Limited 1991-2006 • Page 122 Argent Job Scheduler Users Guide Queue Macros Window The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. Figure 7. Limited 1991-2006 • Page 123 . This number identifies the screen for reference.5: The Queue Macros Window The Queue Macros window shows a sample queue macro. Screen ID J11. Queue Macros window. which might be used in the Job Queue tab in place of hard-coding a Server and Queue name. Click on the &QM_SAMPLE macro to view the macro details. © ArgSoft Intellectual Property Holdings. at the © ArgSoft Intellectual Property Holdings. if customers entered QUEUE_TEST_MACRO.16: The New Macro for Queue dialog The name entered will be automatically prefixed with the string &QM_ to identify a user macro. Figure 7.Argent Job Scheduler Users Guide Defining Queue Macros To create a new queue macro: Procedure 11: Creating a Queue Macro Step 1: Right-click on the Queue leaf in the Explorer tree. At this point customers may: • • • Enter a macro definition directly or Select the blank definition and then click on the button (…) at the right of the blank definition listing or Select the New button (leftmost button) from the tools button bar right of the Macro Definition label bar. Step 2: Enter a new queue macro name in the New Macro for Queue dialog and click OK. the finished macro name will be &QM_QUEUE_TEST_MACRO. Thus. The new macro will be created as a blank macro definition. Limited 1991-2006 • Page 124 . then select New Queue Macro from the popup menu. Queue Macro Enter or select a Queue Macro to identify the desired queue or queues. Specific Queue Use the queue selected from the server tree (upper window). Figure 7.17: The Select a Server and Queue dialog Select a server and a queue from the tree. Click OK when finished. Wildcard Queues Use a wildcard specification to select a group of queues. Default Queue on the Specific Server Use the default queue on the selected server. © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide Step 3: The Select a Server and Queue dialog appears. Queue options are: Any Queue on the Server (default) Use any available queue on the selected server. This option is automatically selected by choosing any queue from the tree. Limited 1991-2006 • Page 125 . Job Classes listed in Job Sequence macros are shown with an additional append to the job number.18: The Job Sequence Macros window Job Sequence macros create flexible easy to manage job flow lists. Limited 1991-2006 • Page 126 . Job Sequence macros provide the power to run multiple job dependencies with one easy configuration. Screen ID J12. Job Sequence Macros window. This number identifies the screen for reference. Users can create a Job Sequence macro to tie any number of Job Classes together and control the flow of processing. © ArgSoft Intellectual Property Holdings. JOB3 and JOB4 are dependent on each other in numeric order. A Job Sequence macro allows the group to be listed dependently in one macro. JOB1. For example. This gives administrators a view of each macro’s progress from one screen. From the Argent Job Scheduler’s J1 screen.Argent Job Scheduler Users Guide Job Sequence Macros The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. Figure 7. JOB2. This alleviates the configuration of multiple Job Dependencies on each Job Class. Click on the &JS_SAMPLE macro to view the macro details. at the © ArgSoft Intellectual Property Holdings. if customers entered JOB_SEQUENCE_TEST_MACRO.19: The New Macro for Job Sequence dialog The name entered will be automatically prefixed with the string &JS_ to identify a user macro. Figure 7. the macro definition screen is not entirely blank – see Figure 45 – because three job handling options appear for selection using radio button controls. At this point customers may: • • • Enter a macro definition directly or Select the blank definition and then click on the button (…) at the right of the blank definition listing or Select the New button (leftmost button) from the tools button bar right of the Macro Definition label bar. the finished macro name will be &JSTE_JOB_SEQUENCE_TEST_MACRO. Step 2: Enter a new job sequence macro name in the New Macro for Job Sequence dialog and click OK. however. Unlike previous examples.Argent Job Scheduler Users Guide Defining Job Sequence Macros To create a new job sequence macro: Procedure 12: Defining a Job Sequence macro Step 1: Right-click on the Job Sequence icon in the Explorer window and select the New Job Sequence Macro from the popup menu. Thus. Limited 1991-2006 • Page 127 . The new macro will be created as a blank macro definition. Argent Job Scheduler Users Guide Step 3: The Please Select a Predefined Job dialog appears. the Run Job Immediately selection can be checked to launch the job Step 4: Select the desired Job Handling option as: • • • Purge all downstream jobs if predecessor ends abnormally Suspend all downstream jobs if predecessor ends abrnomally Submit all jobs at the same time Step 5: Enter an appropriate description for the Job Sequence Macro. © ArgSoft Intellectual Property Holdings. Figure 7. Optionally.21: Selecting a predefined job Select a predefined job from the pull down list and click OK. Limited 1991-2006 • Page 128 . Limited 1991-2006 • Page 129 . (See Figure 49. a value and identifier predefined by the system. Subsequently. selecting the correct string will insert the proper information into the job without changing the job coding. Global String Macros window.. This can be used to create reports. Screen ID J13. which are time and date stamped without making changes to job command coding.e. in both writing job files. For example. A System String can only be defined as a variable maintained by the computer – i.Argent Job Scheduler Users Guide Global String Macros The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. This number identifies the screen for reference. where the two string types are identified in the Global String dialog. Private Strings and System Strings. © ArgSoft Intellectual Property Holdings. following.) A Private String is entered as a text value and gives users incredible flexibility. Figure 7. Help Desk contact information – which changes periodically – can be written as a Private String. For example.22: Global String Macros Window Global string macros provide the ability to enter variables into jobs and are separated into two categories. the Global String macro can insert the date – a System String maintained by the computer – into a running job file. and using the Argent Job Scheduler to run them. at the © ArgSoft Intellectual Property Holdings. The new macro will be created as a blank macro definition. • • • Enter a macro definition directly or Select the blank definition and then click on the button (…) at the right of the blank definition listing or Select the New button (leftmost button) from the tools button bar right of the Macro Definition label bar. the finished macro name will be &TX_GLOBAL_STRING_TEST_MACRO. then select New Global String from the pull down menu.23: The New Macro for Global String dialog The name entered will be automatically prefixed with the string &TX_ to identify a user macro. Limited 1991-2006 • Page 130 . Thus. Step 2: Enter a new Global String macro name in the New Macro for Global String dialog and click OK. Figure 7.Argent Job Scheduler Users Guide Defining Global String Macros To create a new Global String macro: Procedure 13: Creating A Global String Macro Step 1: Right-click on the Global String leaf in the Explorer tree. if customers entered GLOBAL_STRING_TEST_MACRO. The new Global String will be identified as a Private String but it will be defined as: “This string should show the date %DAY%”. a complete custom (Private) formatted string can be created using any combination of text and predefined system values. Global String macros can also contain multiple strings – as any mixture of Private String and System String entries – which will be concatenated in use with a space delimiter between items. check the Append… option. Append text to current Global String This option can be used to append a new entry to an existing global string. • • • For example.Argent Job Scheduler Users Guide Step 3: The Global String dialog allows entry either of a Private String value as simple text or selection of a System String from the list of predefined values. © ArgSoft Intellectual Property Holdings.24: The Global String dialog Description Displays an explanation of the selected System String. Now open the same entry. select the %DAY% System String. and click OK. begin by creating a Private String reading: “This string should show the date ” (note the trailing space) and save the entry. Figure 7. In this fashion. Limited 1991-2006 • Page 131 . such as Sun. the table below describes the menu items provided for defining New Macro. etc. %YEAR% Current year in the format of CCYY. Menu Items After selecting the Macro leaf. Show Log/Quick Help Displays or hides the log and quick help pane at the bottom of the window. etc. such as January. Expand Lower Leaves Expands all leaves (branches) below the selected leaf. These variables are dynamically maintained by the computer. for 15 Dec 1999. etc. and Print. Click the right mouse button on the Macros leaf to display the popup menu. this is 15.Argent Job Scheduler Users Guide The System Strings • • %DAY% Current day in the 2-digit format. %MONTH% Current month in the 2-digit format. 1999. • • • • • • %DAY_SHORT_NAME% Abbreviation of current weekday name. February. %TIME% Current time in the format of HH:MM:SS. © ArgSoft Intellectual Property Holdings. Feb. For example. for December this is 12. %MONTH_SHORT_NAME% Current month in the abbreviation of month name. Expand All Leaves Fully expands all leaves (branches) in the tree. For example. such as Sunday. Limited 1991-2006 • Page 132 . Arrange Icon. etc. %DAY_NAME% Current day of week as English text. %MONTH_NAME% Current month as English text. Print [Ctrl+P] Print a list of existing macros. such as Jan. Collapse All Leaves Collapses all leaves (branches) in the tree. New Macro Select to create a new macro. For example. View Macro in a List. Monday. Mon. Here ‘optional’ means that the Argent Job Scheduler can run without specifying any calendaring mechanism. In This Chapter This chapter contains the following topics: • • • • • Calendar Definition Every Definition Period Definition Holiday Definition Menu Items © ArgSoft Intellectual Property Holdings. Note: Calendars are an optional facility available in the Argent Job Scheduler. How to Access Clicking on the Calendars leaf can access the Calendars window. Limited 1991-2006 • Page 133 .Argent Job Scheduler Users Guide Chapter 11: Advanced Scheduling Using Calendars Calendars are an optional facility in the Argent Job Scheduler enabling sites to define what days a Job is to execute. All the Calendars that customers have defined will be displayed under the Calendars leaf in the map details window. Figure 8. Screen ID J71. Calendars window. This number identifies the screen for reference. Limited 1991-2006 • Page 134 .Argent Job Scheduler Users Guide Calendars Window The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens.1: The Calendars Window © ArgSoft Intellectual Property Holdings. Step 2: The New Calendar Definition dialog appears. Limited 1991-2006 • Page 135 .2: Define New Calendar Definition Enter the new definition name and click OK or press ENTER.3: Pick A Calendar Day Window © ArgSoft Intellectual Property Holdings. Step 3: The Pick A Calendar Day window is displayed. Figure 8. The Calendar name appears with the prefix CAL. Figure 8.Argent Job Scheduler Users Guide Defining Calendar Definitions The steps to create a Base Calendar definition are listed following: Procedure 14: Defining A Base Calendar Step 1: Right-click on the Definitions leaf and select New Calendar Definition. Step 5: Click OK to save the selection.e. • Calendar Definition Select an existing Calendar Definition from the pull down list. day and year from the popup calendar. the year is treated as a wildcard. day or year field and use the scroll button to increment or decrement the value or Use the calendar button (at the right) to select the month. • • Specific Weekday Select the day of the week from the pull down list.. © ArgSoft Intellectual Property Holdings. Calendar Formula Select either an Every Definition or a Period Definition from the pull down lists. • Ignore Year If checked. The Every Definition and Period Definition options are discussed following. i. Limited 1991-2006 • Page 136 . the month and day repeat every year.Argent Job Scheduler Users Guide Step 4: Select the type of calendar entry to create as: Specific Date Select the month. Figure 8.Argent Job Scheduler Users Guide Defining a Complex Calendar Calendar definitions can be as simple as a single date or a single day of the week or can be as complex a mix of dates and exclusions as desired. © ArgSoft Intellectual Property Holdings.4: A complex calendar definition To add additional data elements: • • • Enter a data element definition directly or Select a blank data element and then click on the button (…) at the right of the blank listing or Select the New button (leftmost button) from the tools button bar the right of the Include… or Exclude… label bars. at Define the new data element as shown previously. Limited 1991-2006 • Page 137 . in Figure 53. For example. a calendar is defined which includes Wednesday’s and Friday’s but then excludes 7/28/2000 (a Friday). 8/9/2000 (a Wednesday) and 9/15/2000 (a Friday) as well as the Period definition PRD_QUARTERLY. Notepad Exports the forecast results to the Notepad where.5: Testing a Calendar definition Notice that Friday. a second test produced the more realistic results illustrated in Figure 8. as discussed previously. In the previous example – CAL_TEST_ENTRY – the initial test result revealed that no active dates were defined. the dates can be saved as an ASCII text file. after removing the PRD_QUARTERLY date element from the exclusion list. Start Date of Forecast / End Date of Forecast Select the range of dates examined. The start and end dates can be selected.Argent Job Scheduler Users Guide Testing a Calendar Definition The Test button (Figure 53 above) allows customers to test their calendar definition to observe which dates or date ranges are actually included. in the same fashion as other date entries. September 15th – which is one of the exclusion dates – does not appear in the list of Wednesdays and Fridays. Figure 8.5. However. if desired. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 138 . The steps to create an Every definition are listed following: Procedure 15: Defining An ‘Every’ Definition Step 1: Right-click on the Every leaf and select New Every Definition from the popup menu. © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide Defining An ‘Every’ Definition An Every definition is combined with a Period definition to provide an extremely powerful calendar facility. Step 2: The New Every Definition dialog will appear.6: Define New Every Definition Window Enter the new Every definition name and click OK or press ENTER. Limited 1991-2006 • Page 139 . Figure 8. The name of each Every definition will be prefixed with EVR_. Argent Job Scheduler Users Guide Step 4: Select the Days/Year/Month and optional Holiday logic from the Definition window (J63) that appears. Days of the Week • All Days © ArgSoft Intellectual Property Holdings. including: Weeks Of The Year • • Select All Selects all weeks of the year (1st through Last). Limited 1991-2006 • Page 140 . there are a variety of options for selecting dates and date ranges. Figure 8. Clear Clears all weeks of the year (1st through Last).7: The Every Definition Window In the Every definition window. Weeks of the year can also be selected or cleared individually. Month Months are selected or cleared individually. Months of the Year • • Year Selects all twelve months of the year (January through December). No HOLIDAY test at all No test is made to determine if a job is scheduled for a holiday event. • Use Next non-HOLIDAY day If a job is scheduled for a holiday. • Use Prior non-HOLIDAY weekday If a job is scheduled for a holiday. Optional Holiday Logic The Holiday entry under Calendars (discussed following) optionally specifies the days to be skipped in the Every definitions. • • Skip day completely If a job is scheduled for a holiday.Argent Job Scheduler Users Guide Selects all of the days of the week (Sunday through Saturday). Optionally. the first day of the week (Sunday through Saturday) preceding the holiday event is used. the next day of the week (Sunday through Saturday) following the holiday event is used. Specific Days Allows individual days of the week to be selected or cleared. the job is skipped entirely. the first weekday (Monday through Friday) preceding the holiday event is used. • Use Prior non-HOLIDAY day If a job is scheduled for a holiday. • Use Next non-HOLIDAY weekday If a job is scheduled for a holiday. Limited 1991-2006 • Page 141 . © ArgSoft Intellectual Property Holdings. the next weekday (Monday through Friday) following the holiday event is used. a description can be added to explain or identify the Every definition. • • Weekdays Selects only weekdays (Monday through Friday). 8: Define New Period Definition Window Enter the new Period Definition name and click OK or press ENTER.Argent Job Scheduler Users Guide Define Period Definitions Procedure 16: Creating a Period Definition Step 1: Right-click on the Period leaf and select New Period Definition from the popup menu. © ArgSoft Intellectual Property Holdings. Figure 8. Step 2: The New Period Definition dialog will appear. Limited 1991-2006 • Page 142 . The name of the Period Definition entry will be prefixed with PRD_. e. Date Range Displays two date entry fields for beginning and ending dates. Customers may enter a date manually.. Limited 1991-2006 • Page 143 . © ArgSoft Intellectual Property Holdings.9: The Calendar Day dialog Two options are offered as: Specific Date Displays a single date entry field. customers have several choices for how to select dates. Customers may select the arrow button at the right of either field to display a popup calendar and choose the year. For either the specific (single) or range (dual) date fields. I. day or year portions of the date and use the spin (up/down) buttons to increment or decrement the values. the same date or date range will subsequently be used every year. Ignore Year Select to have the year field treated as a wildcard. month and day as a calendar selection. The Period definition may contain more than one date or range of dates. • • • Customers may select the month.Argent Job Scheduler Users Guide Step 3: The Calendar Day dialog will appear. Figure 8. ) Step 3: Click on the Browse button to display the Pick A Calendar Day dialog (see Figure 8. (The New button is the leftmost of the four buttons – – found at the right of the Holiday Definition caption. page 135). While the Pick A Calendar Day dialog includes options to select Calendar Formula (based on Every definitions) and Calendar Definitions.3. these are less applicable for Holiday Definitions than the Specific Date and Specific Weekday selections.Argent Job Scheduler Users Guide Defining Holidays The steps to create a Holiday definition are listed following: Procedure 17: Creating A Holiday Definition Step 1: Select the Holiday leaf.) Step 2: Click on the New button and a highlighted area will be displayed with a Browse button. Limited 1991-2006 • Page 144 . Step 4: © ArgSoft Intellectual Property Holdings. (The Calendars section contains only one Holiday definition. These – and other holidays – must be entered as full dates. In Mexico. Mexico’s Independence Day – is a fixed Holiday but July 4th is not observed. Since each of these are fixed dates – as opposed to movable holidays – the asterisk (*) is a wildcard indicating these occur on the same date regardless of the year. while holidays vary worldwide. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 145 . In other cases – and in other countries – other holidays and dates follow other rules. for example. The default HOLIDAY calendar has three entries: 1/1/* or New Years Day. Menu Items The menu items provided for defining Calendars are listed as the following: New Calendar Definition Click to create a new Calendar definition New Period Definition Click to create a new Period definition New Every Definition Click to create a new Every definition Save Click to save the Calendar definition Delete Click to delete the Calendar definition Rename Click to rename the selected Calendar definition Copy Click to copy the selected Calendar definition Test Click to test the selected Calendar definition Click on the right mouse button to display the drop-down menu box or access these options from the menu bar. In like fashion. Other common holidays – such Memorial Day and Labor Day – are commonly celebrated on a Monday but on a different date every year. 7/4/* or Independence Day and 12/25/* or Christmas Day. Thanksgiving Day – which falls on the 4th Thursday in November – is also a moveable feast.Argent Job Scheduler Users Guide Specify a day or date customers want to treat as a holiday in conjunction with various period definitions. Thus. the HOLIDAY definition is fully flexible and customizable for each region. Cinco de Mayo – May 5th. but not on the weekends nor public holidays nor company holidays. Every Definition An Every Definition may specify ‘the first and third Mondays’ for the execution of a Job. If it is listed in the Holidays Definitions. Limited 1991-2006 • Page 146 . This type of advanced calendaring is implemented by using the Argent Guardian calendars. unless the day is listed in the Holidays Definition. and so on. and a third Job is to run on all normal working days for customers company. while another Job is to run only on the weekends. © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide Some Examples of Calendars Customers may want one Job to run only on weekdays. skipping monitoring. Holidays Definition A site may wish to run a Job on the first or third Monday. such as using the prior non-holiday date. then customers can specify a range of options. Period Definition A Period Definition may specify three date ranges: • • • 1 Jan to 17 Jan 4 Feb to 18 Mar 5 Oct to 19 Dec Thus the above two examples – the Every Definition and the Period Definition – would interact by saying: IF today is the first or third Monday of 1 Jan to 17 Jan OR IF today is the first or third Monday of 4 Feb to 18 Mar OR IF today is the first or third Monday of 5 Oct to 19 Dec THEN Execute the Job that specifies these Period and Every Definitions. Either the Start Service or Stop Service option – which ever is presently irrelevant—will be grayed out and cannot be selected while a colored caption at the bottom of the window displays the current run status.Argent Job Scheduler Users Guide Chapter 12: Using Job Scheduler In the previous chapters. This chapter deals with the menu options provided by the Argent Job Scheduler. A drop-down menu list will be displayed. Job or Settings items on the menu bar. In This Chapter This chapter contains following sections: • • • System Menu Job Menu Settings Menu System Menu The System menu options enable customers to backup and restore the database and use the forecast menu to schedule jobs. © ArgSoft Intellectual Property Holdings. Servers. How to Access The menu items can be accessed in the following way: • • Click on the System. Limited 1991-2006 • Page 147 . Scheduling and Alerts have been explained. Click on an individual menu option to select. This section contains the following topics: • • • • • • • • Start or Stop Service Verify Database Backup Database Restore Database Import Database Scan Entire Network Refresh Time Zone Cache Quit Without Saving Changes Start Or Stop Service Use these menu options to start or stop the Argent Job Scheduler. Jobs. Argent Job Scheduler Users Guide Verify Database Use this menu option to verify the integrity and consistency of the Argent Job Scheduler database across the network. Quit Without Saving Changes Use this menu option to quit without saving changes that have been made to the database. Create offline storage for the Argent Job Scheduler’s objects database with this menu. Backup Database Performing a backup of the database is a routine function in any enterprise. Limited 1991-2006 • Page 148 . This section contains information on the following topics: • • • • • • Submit Job Execute Manual Rollover Edit Job Class Table Create Job Forecast Archive Job List View Job History File Submit Jobs Use this menu to submit jobs for scheduling after customers have defined jobs and specified the server. Job Menu The Job menu enables customers to perform a number of administrative and operational activities. © ArgSoft Intellectual Property Holdings. and use the forecast menu to schedule jobs. Refresh Time Zone Cache Use this menu option to coordinate communication between enterprise servers running in different time zones. Restore Database Use this menu option to restore a database from an existing backup. Scan Entire Network Use this menu to scan the network for the Argent Job Scheduler job lists. and to refresh and monitor the scheduling and execution of jobs. Partial Day’s Jobs rolls over all jobs with scheduled times from the present to the next scheduled rollover. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 149 .1: The Manual Job Rollover Dialog The Manual Job Rollover dialog (J109) offers three options as: All of Today’s Jobs rolls over all jobs with scheduled times later than the previous rollover and earlier than the next scheduled rollover. either select the month. To change the From and To dates/times. year.Argent Job Scheduler Users Guide Execute Manual Rollover Use this menu item to display the Manual Job Rollover dialog: Figure 9. Over a Range of Days From / To rolls over all jobs with scheduled times with a specified range of days. day. hour or minute and use the spin buttons to increment or decrement the values or click on the pulldown button (at the right of each date/time field) to display a calendar for selection. enter the appropriate password for the selected username. Limited 1991-2006 • Page 150 . Domain Shows the current or selected domain. Use Password If the default username is not selected. Add Perm Sets permissions for an entire class of jobs. The browse button can be used to select a domain to list usernames or to select a local username. Delete Perm Deletes permissions for an entire class of jobs © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide Edit Job Class Table Use this menu item to display the Job Class Properties (J120) dialog: The job class properties options include: Job Class Select the job class from the pull down list of job classes. Execute job under guest account of the Argent Queue Engine This account allows the Job Scheduler to let the Queue Engine assign the account and password to the job. Default Username Shows the default username. Job Class Permissions Shows the users or groups which have permissions for the selected job class and the specific permissions allowed to each user or group. It is the easiest way to assign an W200x account to the job and is also handy where the job runs under an account that is local to the server where the Queue Engine resides. To change the Start and End dates. End Date of Forecast Sets the end date for the forecast. The Start/End dates help in planning the profile of the batch workload and executing the jobs most effectively. © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide Create Job Forecast Use this menu item to display the Forecast of Scheduled Jobs (J78) dialog. day or year. Limited 1991-2006 • Page 151 . The Forecast of Scheduled Jobs dialog is used to select and display pending jobs as: Start Date of Forecast Sets the starting date for the forecast. Figure 9. either select the month. and use the spin buttons to increment or decrement the values or click on the pulldown button (at the right of each date field) to display a calendar for selection. By default. By default. this will be the current date. this will be a date seven days (one week) later than the current date.3: The Forecast of Scheduled Jobs Dialog A jobs forecast is used to manage the scheduling of jobs in the enterprise by preparing a list of batch jobs to be scheduled that will help customers in managing resources. Two additional status columns – Held and Rollover are displayed by scrolling right in the window. Include Jobs not included in Rollover Select to include jobs which have the “Do Not Include This Job in Rollover” flag set in the job’s J20B screen. Limited 1991-2006 • Page 152 . Job Definition Select a listed job and then click the Job Definition option to view the full job definition in the Argent Job Scheduler’s main window. © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide Job Name Specify an individual job by name or use wildcards (* and ?) to select a series of jobs with similar names. Job Total Shows the total number of jobs in the Forecast Result List. with no job name specified. This also allows the result list to be saved for later reference. all jobs are included. Stop Stop execution of the selected job. Forecast Result List Displays the forecast jobs as a list – see Figure 58 – where the results can be sorted by clicking on any of the list headers. Print Prints the Forecast Result List. Forecast Creates a forecast list using the specified dates and criteria. View with Notepad Displays the Forecast Result List as a text file using the Notepad editor. By default. day. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 153 . Others Selects all jobs which do not have Ended. To change the From and To dates/times. View Job History File Use this menu item to view a list of archived jobs. year. Failed or Aborted status. either select the month. From / To Selects only jobs between the From and To date/time specifications.Argent Job Scheduler Users Guide Archive Job List Use this menu item to display the Archive Job List (J43) dialog. All Includes all jobs. hour or minute and use the spin buttons to increment or decrement the values or click on the pulldown button (at the right of each date/time field) to display a calendar for selection. The Archive Job List can be selected by: Purging Filter • • • Selected Includes only selected jobs. Job Status • • • • Ended Selects only jobs with an Ended status Failed Selects only jobs with a Failed status Aborted Selects only jobs with the Aborted status. Argent Job Scheduler Users Guide Settings Menu The Settings menu items enable customers to general configuration and Queue Engine options. This section contains the following topics: • • • Configuration Globally Update the Argent Queue Engine Server Settings Assign User Rights Configuration Options The Configuration menu items enable customers to select system configuration options. This section contains the following topics: • • • • • • • • • • System Options GUI Options Email Options Security Job List CPU Affinity Service Restart Backup Node Rollover & Archiving License © ArgSoft Intellectual Property Holdings, Limited 1991-2006 • Page 154 Argent Job Scheduler Users Guide System Options The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. This number identifies the screen for reference. System Options window, Screen ID J1P. Figure 9.5: System Options Window Use the System Options tab to set options. Access these by clicking on the tab. Home Path Specifies the location of the Argent Job Scheduler’s executable files such as tajs_gui.exe, i.e., the Argent Job Scheduler GUI. Database Specifies the location of the Argent Job Scheduler’s control files. The Argent Job Scheduler’s control files are used to hold control information that is created whenever users define objects, such as Jobs, Alerts, Macros, etc. Note: Do not use UNC PATH, i.e., it should be local to the system on which the Argent Job Scheduler is installed. Server Since the Argent Job Scheduler GUI can run on a server other than the Argent Job Scheduler Server, customers must specify this field if the current server is not the © ArgSoft Intellectual Property Holdings, Limited 1991-2006 • Page 155 Argent Job Scheduler Users Guide Argent Job Scheduler Server. The local server is assumed to be the Argent Job Scheduler Server unless another, fully-qualified location is specified. ODBC Setup The Argent Job Scheduler can use SQL 7.0 for its backend. The ODBC Setup shows the Data Source Name (DSN) used to connect to the SQL database. If the SQL option is not used, then this field reads “Not Applicable” Job List Refresh Interval The main Scheduler screen (J1) is updated in one of two ways; either by explicit user request (right-click and select Update Now) or by an automatic timer. This value defines the time interval, in seconds, that Job Scheduler will automatically update the Job List on the Scheduler screen. For example, if this value is set to 30, then the Argent Job Scheduler will automatically update the Scheduler screen every 30 seconds and any changes to any job’s status will be reflected on the Scheduler screen. Wait between Queue Engine Scans If the Argent Job Scheduler cannot establish communications with a server running the queue engine, then the server running the queue engine is said to have ‘timed-out’. This value specifies the time, in seconds, which the Argent Job Scheduler will wait for a response from the server running the queue engine before determining a timeout has occurred. This error is recorded on the main Scheduler screen. Sleep after Scheduling Cycle Determines the scan rate that used for calculating dependencies. Specifically, the Scheduler does not check dependencies like job, file, ODBC every second, this could put unnecessary stress on a system. Instead, it checks on an interval determined by this setting. Job Processing Thread Limit Specifies the maximum number of threads that can be created for processing a job. Job Limit Per Submission The number of jobs that can be submitted at one time. This would prevent a user from manually submitting too many jobs at once. Job Limit Per Session The number of jobs that can run during a rollover period. Like the Job Limit Per Submission, this can be used as a safety to prevent server overload. Log Screen Width Sets the width – in characters – for the job log screen. Debug Level There are three debug levels: 1,2,3. One (1) is the normal (default) setting while three (3) creates an extensive log for troubleshooting purposes. Selecting a debug level of 3 for logging during normal operations is not advised since this will fill the service log with unnecessary information and make the log harder to read. Log Size Limit Sets the maximum size – in megabytes – for the job log file. Delete Job’s Log When Job Is Deleted If selected - when the Argent Job Scheduler user explicitly deletes a job from the main Scheduler screen, the job’s actual the queue engine log will be deleted as well. © ArgSoft Intellectual Property Holdings, Limited 1991-2006 • Page 156 Argent Job Scheduler Users Guide GUI Options The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. This number identifies the screen for reference. GUI Options window, Screen ID J2P. Figure 9.6: The GUI Options Window Use this tab to set database and scanning parameters. Options are listed following: Save When Leaving New or Changed Record Check this feature box to save changes to an object (such as a job definition, an alert entry, or a macro) whenever the user changes from one tab to another tab, or from one leaf to another leaf. Show Warning Message on Delete Check this feature box to display a warning message prior to the Argent Job Scheduler object being deleted. Discard Incomplete Record Check this feature box to discard an incomplete record when the user moves from one tab to another tab, or from one leaf to another leaf. © ArgSoft Intellectual Property Holdings, Limited 1991-2006 • Page 157 Argent Job Scheduler Users Guide Application Maximized at Startup Check this feature box for the main the Argent Job Scheduler screens to be maximized at startup. Display Session Manager Registry Warning at Startup The Argent Job Scheduler uses Net Send extensively as part of the Argent Job Scheduler alerting. The Registry entry System\CurrentControlSet\Control\SessionManager\SubSystems\Windows must have a value that is greater than 512 in the part of “SharedSection=1024,3072,nnn” <nnn>= 512 Retain Job List Settings Check this feature box to retain the default settings every time the Argent Job Scheduler service is started. Show Warning Message if non_UNC file name is used for job Displays a warning message if the file name used for a job is not UNC compliant. Exclude Weekends For Product Day Exclude the weekends in the report Disable Splash Screen Not showing splash screen when GUI starts Show Job List After Submitting Job Switch to Job List screen (J1) after submitting an adhoc job. SuperMap Display Options It controls the dot size, text font and background color of SuperMap Enable Orthogonal Links It controls the job diagram style © ArgSoft Intellectual Property Holdings, Limited 1991-2006 • Page 158 Argent Job Scheduler Users Guide (With Orthogonal Link enabled) © ArgSoft Intellectual Property Holdings, Limited 1991-2006 • Page 159 Limited 1991-2006 • Page 160 .Argent Job Scheduler Users Guide (With Orthogonal Link disabled) © ArgSoft Intellectual Property Holdings. Figure 9. This number identifies the screen for reference.7: Email Options for Windows Messaging © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide Email Options The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. Email Options window. Limited 1991-2006 • Page 161 . Screen ID J3P. Email Type This feature allows users to specify parameters for both Windows Messaging (Figure 62) and SMTP Email (Figure 63). Windows Messaging Email Options Profile Name This is the Exchange profile name to use. • • • User Name User who owns the Profile. Domain The network domain of the user who owns the Profile. this field should be left blank. If no password is associated with the Profile. Email profile is under account different from The Argent Job Scheduler account Check the box to email under an account other than the Argent Job Scheduler account.Argent Job Scheduler Users Guide The Configuration Email Options include: Send Test Message Use this facility to ensure that all the specifications have been set properly. User Password This is the password for the above User Name. Advanced Option The Argent Job Scheduler Server can send email from an account different from the Argent Job Scheduler account. While the Email Alert Definition controls which protocol is used. This is a quick and easy way to test that the Email options are correctly set. the Argent Job Scheduler account must be a member of the Administration group and have user rights. If no password is associated with the profile. This button creates a test message and sends that test message using the current options on the screen. Limited 1991-2006 • Page 162 . © ArgSoft Intellectual Property Holdings. Password The password for the above Profile Name. the parameters for each type of email must be defined here. this field should be left blank. com This Site The return address. others impose firm restrictions. may be a NetBIOS name. an IP address or a DNS name. SMTP Host The address of the SMTP email server.CompanySMTP. the return address becomes John@Mycompany. While some mail servers do not require a user ID and password. Limited 1991-2006 • Page 163 . this field can be left blank or may contain a bogus password.8: Email Options for SMTP Protocol User ID The user name for the email account. In this case. In any case.com.Argent Job Scheduler Users Guide SMTP Protocol Email Options Figure 9.66. the W200x password may be required as an entry. which will be added to the user ID. the password entry is stored in an encrypted state. Examples are: • • • SrvNotesNY2 198. © ArgSoft Intellectual Property Holdings.114. Password User password for the email account. The User ID and Password entries are subject to the rules of the SMTP mail server. If the mail server does not require a password. For example. Some SMTP servers integrate the email account with the W200x account used to send the mail. if the user ID is John and the site is identified as Mycompany.150 Mail.com. The Argent Job Scheduler has an integrated security system. Security window. Limited 1991-2006 • Page 164 . a site can wish to limit the ability of some users to start or stop the Argent Job Scheduler service (The Argent Job Scheduler service is used by the Argent Job Scheduler to perform repetitive.9: The Security Window Use this option to limit access of various groups of users to the Argent Job Scheduler Service. © ArgSoft Intellectual Property Holdings. Figure 9.Argent Job Scheduler Users Guide Security The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. or time-based activities. Screen ID J4P. such as scheduling jobs on a repetitive basis). This system uses standard 200x security to enforce the Argent Job Scheduler security. For example. This number identifies the screen for reference. To check the privileges of other users. Backup/Restore. Description Displays a summary description of the Argent Job Scheduler operation selected in the Operations field. Select the user group to which the new user belongs and click Apply. The privileges are Service. Test Groups Against Security Requirement Use this tab to check out the privileges given to the user groups. simply select the user group(s) from the drop-down list. then the privileges given to that user group are displayed. Limited 1991-2006 • Page 165 . Submit Job. Service Restart Option. Cancel/Delete/Rerun Job. Explicit Groups Needed to Perform this Operation To restrict access to one or more valid 200x group names. For example. If the Current Logon Account box is checked. check the Current Logon Account box. For example. System-Wide Parameters.Argent Job Scheduler Users Guide Security Sensitive Operations Specify which of the Argent Job Scheduler’s operational functions is to have security added. In this manner. Define UI. Define SCHEDULER Database. Job Rollover. and Setup Queue Engine Service. GUI View. the description for the Service operation reads: Start/Stop Service. License. a site can define an 200x security group called the Argent Job Scheduler_SERVICE. click on the icon to display the User Groups window. and then specify the Argent Job Scheduler_SERVICE in the Security tab field Explicit Groups Needed to Perform this Operation. © ArgSoft Intellectual Property Holdings. Domain and Password. Click on Test Groups Against Security Requirements button to display the Test Security Requirement window. In this instance. Service Failure Proof Option. View GUI. To add a new group. Job Control Panel. the first entry is Service while other operations include: Backup/Restore. only users with 200x accounts that explicitly are members of the 200x group the Argent Job Scheduler_SERVICE will be able to perform the Argent Job Scheduler Service functions. and then enter the User Name. Modify BATCH Settings and Modify Job Class. License Update. Current user is a member of… – Lists the groups to which the current user belongs. 10: Job List Window The Argent Job Scheduler enables a site to customize the format of the main Scheduler screen (J1) by selecting the font and color of each job entry status line. a site can send visual clues to operators regarding the status of jobs by using foreground and background colors and fonts. Screen ID J5P. For example. © ArgSoft Intellectual Property Holdings. Figure 9. This number identifies the screen for reference. Limited 1991-2006 • Page 166 . Job List window.Argent Job Scheduler Users Guide Job List The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. Alternately. a job submitted by the local instance of Scheduler might be considered an external job if: • It has been removed from the schedule screen. Date Format This drop-down list box enables a site to specify the format of the dates displayed on the main Scheduler (J1) © ArgSoft Intellectual Property Holdings.. • The queue Retain Jobs option is set to retain an instance of the completed job for a long time.Argent Job Scheduler Users Guide Show Jobs Externally Submitted Selecting this option will display queued jobs which were not submitted by this particular instance of the Argent Job Scheduler. or manual archive/delete. If a job was submitted by the Argent Job Scheduler. This option makes it possible to monitor jobs which may have been submitted manually to the Queue Engine or which may have been submitted by another instance of the Argent Job Scheduler (i. the job is no longer in the scheduler screen (J1) so it is considered External. the job will appear in the schedule screen (J1) as a normal job. Limited 1991-2006 • Page 167 . Line Color Selection Allows selection of the foreground (text) color and the background color used to identify individual job types. Also.e. if a job is in the queue but does not appear on the schedule screen. In this case. Font Allows selection of the font (typeface) used to list jobs. then it is an external job. one executing on another machine). either by automatic rollover. Limited 1991-2006 • Page 168 . Figure 9. This number identifies the screen for reference. and then click Apply. The CPU Affinity window lists CPU_0 through CPU_15 – a total of 16 CPUs. specify the CPUs by checking the appropriate ones listed in the dialog box. Check the boxes.Argent Job Scheduler Users Guide CPU Affinity The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. CPU Affinity window. © ArgSoft Intellectual Property Holdings. Screen ID J6P.11: The CPU Affinity Window Use this tab to restrict the execution of the Argent Job Scheduler GUI and the Argent Job Scheduler Service to a specific CPU. and the Alerts to be fired if it fails. Alert to Fire if Service ‘Fails Too Frequently’ Select the alert to be fired when service “fails too frequently. Limited 1991-2006 • Page 169 . This number identifies the screen for reference. Service Restart window.Argent Job Scheduler Users Guide Service Restart The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. Figure 9.” © ArgSoft Intellectual Property Holdings. Maximum Restart Count Specify the maximum number of times job scheduler service may “fail too soon” before it is deemed Fails Too Frequently and a restart is no longer attempted. Run service in single-thread mode Specify whether customers want the job scheduler service to run in single-thread mode by checking the box. Screen ID J7P. Minimum Time Duration Specify the minimum time in seconds the service must stay alive before it is counted as “failed too soon”.12: Service Restart Window Use this tab to specify restart options on the Argent Job Scheduler Service. ) © ArgSoft Intellectual Property Holdings.Argent. Limited 1991-2006 • Page 170 . Figure 9. (The Argent Job Scheduler Service is used to perform repetitive or time-based activities. Important Note: See the Engineering Note available at www. Screen ID J8P.com on Setting Up a Backup Engine for the Argent Job Scheduler Service Restart window. such as scheduling jobs on a repetitive basis.13: Backup Node Window The Argent Job Scheduler enables a site to have two the Argent Job Scheduler Services operating concurrently on two different 200x servers in the network to ensure that there is always one the Argent Job Scheduler Service running and processing the Argent Job Scheduler work. This number identifies the screen for reference.Argent Job Scheduler Users Guide Backup Node The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. Failure-proof path for backup Should the service fail. This field specifies the UNC name of the node and directory where the Argent Job Scheduler control files are to be copied. allowing the backup server to retrieve setup information. it indicates to the Argent Job Scheduler that this is the node on which the primary the Argent Job Scheduler service is executing. If this feature box is checked. the backup server will assume that the primary server is down and take over the service. © ArgSoft Intellectual Property Holdings.date files available. while the back-up service on a second server is in sleep mode. Take care about specifying the path. Service status update frequency Specify in seconds how frequently the primary Argent Job Scheduler Service should update the status file.Argent Job Scheduler Users Guide The main. This is done to ensure that the backup service has the most up-do. If this turns out not to be the case. From time to time. Periodically. Service status checking frequency Specify in seconds how frequently the backup service should check the status file. specify the backup path to which the control files should be copied. If the status file is not updated for these many seconds. Export Control Files Use this tab to backup the files. the primary the Argent Job Scheduler Service copies all of its control files to the backup service. then just check the box. then the current node is a secondary or backup node. This field specifies the name of the primary node. Limited 1991-2006 • Page 171 . or primary. Current Node Name Displays the name of the current node. in the event it has to take over from the primary server. then the secondary service takes over. Main Service Node If the above feature box is not checked. This node runs the primary service If the current node is the primary service node. Alert to fire on service takeover Specify the name of the Argent Job Scheduler Alert to fire when the backup service finds that the primary node or the primary the Argent Job Scheduler service has failed. service processes the repetitive requests. The files will be copied into the directory specified. the secondary service interrogates the primary service to ensure that the primary service and its server are running properly. This number identifies the screen for reference. using the Every option. Important Note: The rollover signals the beginning of the job processes for the designated period. Therefore. The individual job schedule is based on a day unit. the job that is scheduled for that day may not appear on the schedule until the next day’s rollover. The conventional (and the default) time for a rollover to occur is at midnight (00:00).14: The Rollover & Archiving Window Options provided by the Rollover & Archiving dialog are: Execute rollover and archiving at Select the time of day (hours. seconds) to execute rollover and archiving. Weekly or Monthly intervals or. at a specified interval of days. Figure 9. Screen ID J9P. Rollover & Archiving window. when the rollover is set to a non-midnight time. minutes.Argent Job Scheduler Users Guide Rollover & Archiving The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. Limited 1991-2006 • Page 172 . © ArgSoft Intellectual Property Holdings. Radio buttons allow selection of rollover and archiving at Daily. Archiving Format Three archive formats are supported as: • Excel comma delimited The comma-delimited format is compatible with Microsoft’s Excel spreadsheets but can also be imported by most databases. TCP/IP. a path/file name must be supplied. If selected. The job will not appear on the Monday schedule. ODBC Setup Act as a pointer to the database to use Specify the ODBC drivers to use Specify security settings Specify the connection type (Named Pipes. Do NOT do automatic Rollover If selected.Argent Job Scheduler Users Guide For example: if the Job Scheduler is configured to rollover at 12:00 PM. the service log is archived during the rollover and archiving operation. Limited 1991-2006 • Page 173 . any existing data recorded in the named file will be erased (the file will be truncated) before the new data is recorded. • Append to file Select to have new data appended to an existing file. and a job is scheduled to run on Monday at 1:00 PM. automatic rollover is disabled. etc) for use Used to select or create a Data Source Name (DSN) which may: • • • • Archive service log at the same time If selected. ODBC compliant database Creates a data file in a format compatible with an ODBC-compliant database. Otherwise. © ArgSoft Intellectual Property Holdings. Delete archived job logs and prior system logs older than If selected. Use this tab to set parameters to establish rollover and archiving frequency of jobs. • • • Argent Job Scheduler history file Creates a data file which can be viewed using the Argent Job Scheduler viewer. but will appear on the Tuesday schedule because the rollover is at 12:00 PM. specify an age interval after which archived job and system logs can be deleted. 0A-0607 and above. This number identifies the screen for reference. Screen ID J10P.Argent Job Scheduler Users Guide License The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. License is introduced in Argent Job Scheduler 5. SAP system does not need license installed on SAP server. Note: W200X/NT/UNIX Queue Engine and iSeries Job Adapter installation require its own license. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 174 . It controls what Queue Engine. and Argent Job Scheduler service can submit jobs to. iSeries Job Adapter and SAP server that Argent Job Scheduler GUI can connect to. Rollover & Archiving window. © ArgSoft Intellectual Property Holdings. which can be executing at any one time. Customers can set: Default Queue Identifies the queue to be used if the default queue is specified in the Job Scheduler or Queue Engine job submission.Argent Job Scheduler Users Guide Globally Update Argent Queue Engine Server Settings The Screen ID Number is a numbered blue box in the upper right hand corner of each of the Argent Job Scheduler screens. Use the browse button (at right) to select a path and/or existing file. General Settings window. Customers can set various parameters for a server running the queue engine to define how the server will execute jobs. which can be executing at any one time. System Log File An ASCII text file where all log details will be saved. Maximum Executing Jobs Maximum number of jobs. Limited 1991-2006 • Page 175 . The processes limit should always be larger than the jobs limit. This number identifies the screen for reference. screen ID J97. Maximum Job Processes Maximum number of job processes. Log Size Limit Maximum size of the log file in kilobytes. Select this option by clicking on the Queue Engine icon on the tool bar or from the menu. Choose settings by checking the appropriate boxes. follow the same procedure. The results of this comparison are used in conjunction with the Startup Jobs option in the queue engine. Thus a low Priority Quantum places a queue in the ‘slow lane’ while a high setting places a queue in the ‘fast lane’ for execution. the job number rolls over to 1. If the boot threshold is larger than the uptime value. To change these settings. System Boot Threshold The queue engine measures the uptime of the machine and compares this value to the boot threshold setting when the service starts.. Job Number Wraps After Job Each job is assigned a job number by the queue engine. When the specified limit is reached. © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide Priority Quantum Sets the queue priority (0. Click OK to save the settings.255) used by the Queue Engine to allocate CPU workloads for queued jobs. the queue engine assumes that the server has just been rebooted. Limited 1991-2006 • Page 176 . 17: The Assign Required User Rights Dialog To assign required user rights. It is necessary to establish appropriate security to restrict users’ access to resources based on need. © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide Assign User Rights Customers can control access rights for the users with security domain settings.) Figure 9. (See the section on server running the queue engine Permissions. Limited 1991-2006 • Page 177 . The log on as a batch job and log on locally rights are automatically assigned to the selected accounts. simply select one or more user names by checking the boxes next to each name and then clicking the OK button. Queue Engine.Argent Job Scheduler Users Guide Chapter 13: Design Job Files for Argent Queue Engine Both executable and command procedure (. If the job containing this line was submitted by user “TomD” and was job number 1073. which may be used by command procedures. © ArgSoft Intellectual Property Holdings. These environment variables are listed following: • • • • • • • • TABF_JOB_FILE The filename of the job file TABF_LOG_FILE The filename of the job’s log file TABF_JOB_NAME The name of the job TABF_JOB_NUMBER The job number (as a decimal string) TABF_QUEUE The name of the queue the job is in TABF_COMPUTER_NAME The name of the computer executing the job USERDOMAIN The domain name the job is running under USERNAME The username the job is running under The following command procedure excerpt displays a line containing information about the job: ECHO Job %TABF_JOB_NUMBER% was submitted by %USERNAME%.CMD and . command procedures provide more control and flexibility over the operation of a job.BAT) files or UNIX shell script may be submitted as jobs to the Queue Engine. Predefined Environment Variables The queue engine defines several environment variables. However. This section describes some useful techniques for writing command procedures. then the following would appear in the job’s log file: Job 1073 was submitted by TomD. Limited 1991-2006 • Page 178 . dat \\TULSA\testshare if not errorlevel 1 goto success_300 echo Error copying file exit :success_300 echo The file has been copied from PV1 to TULSA Another way to implement error handling is to use the && (double ampersand) and || (double vertical bar) operators. through the use of the if errorlevel and if not errorlevel constructs. Using these special operators.Argent Job Scheduler Users Guide Error Handling In Command Procedures The Windows 200x command processor provides a simple means of implementing error handling in command procedures. the preceding example could be rewritten as follows: dir \\PV1\testshare || (echo Error accessing PV1 & exit) dir \\TULSA\testshare || (echo Error accessing TULSA & exit) copy \\PV1\testshare\database. The && operator causes the command that follows it to execute only if the command that precedes it succeeds.dat \\TULSA\testshare && goto success echo Error copying file exit © ArgSoft Intellectual Property Holdings. error handling can be set up as in this example: dir \\PV1\testshare if not errorlevel 1 goto success_100 echo Error accessing PV1 exit :success_100 dir \\TULSA\testshare if not errorlevel 1 goto success_200 echo Error accessing TULSA exit :success_200 copy \\PV1\testshare\database. This construct tests the exit code of the last executed command in the batch file. Limited 1991-2006 • Page 179 . Based upon the convention that an exit code of 0 represents successful completion and a non-zero exit code represents an error. The || operator causes the command that follows it to execute only if the command that precedes it fails. The & (single ampersand) operator allows customers to combine multiple commands on the same line. and parentheses allow them to group multiple commands together as one. instead of braces. and braces allow customers to group multiple commands together as one. Based upon the convention that an exit code of 0 represents successful completion and a non-zero exit code represents an error. operator allows customers to combine multiple commands on the same line. the commands are executed in a separate shell. The || operator causes the command that follows it to execute only if the command that precedes it fails. This construct tests the exit code of the last executed command in the batch file. The .Argent Job Scheduler Users Guide :success echo The file has been copied from PV1 to TULSA The UNIX command processor provides a simple means of implementing error handling in command procedures. Limited 1991-2006 • Page 180 . If the commands are grouped in parentheses. The && operator causes the command that follows it to execute only if the command that precedes it succeeds.dat /tulsa/testshare if [ “$?” -ne 0 ] then echo Error copying file exit 3 fi echo The file has been copied from PV1 to TULSA Another way to implement error handling is to use the && (double ampersand) and || (double vertical bar) operators. through the use of the if $? constructs. This would create a different effect in having the separate shell exit instead of the one that we are executing from. The shell script would continue without an error if the © ArgSoft Intellectual Property Holdings. error handling can be set up as in this example: cd /PV1/testshare if [ “$?” -ne 0 ] then echo Error accessing PV1 exit 1 fi cd /tulsa/testshare if [ “$?” -ne 0 ] then echo Error accessing TULSA exit 2 fi cp /PV1/testshare/database. } cp /PV1/testshare/database. Using these special operators. the preceding example could be rewritten as follows: # success is a shell function.} [ -d /TULSA/testshare ] || { echo Error accessing TULSA && exit 2 .dat /TULSA/testshare && success if [ “$?” -ne 0 ] then echo Error copying file exit 3 fi © ArgSoft Intellectual Property Holdings. exit 1. Limited 1991-2006 • Page 181 .Argent Job Scheduler Users Guide directory test failed. written very much like a C function success() { echo The file has been copied from PV1 to TULSA } [ -d /PV1/testshare ] || { echo Error accessing PV1 . Argent Job Scheduler Users Guide Accessing Network Shares From Command Procedures Network shares are available to batch jobs using the Universal Naming Convention (UNC) form of “\\computer\\sharename”. customers only need to change it at one point in their procedure. but it does so through network connections instead of sharenames. REM *** ESTABLISH NETWORK CONNECTIONS *** NET USE J: \\JP\MSVCNT || EXIT NET USE K: \\JP\PROJECT || EXIT REM *** SET INCLUDE PATH *** SET INCLUDE=J:\INCLUDE REM *** COMPILE THE SOURCE FILE *** J:\BIN\CL /C FILE. if network connections are used carefully and standard and unique device letters are used for different jobs. The following example uses this technique to compile a source code file using Microsoft Visual C++: REM *** SET ENVIRONMENT VARIABLES FOR SHAREPOINTS *** SET SOURCE=\\JP1\PROJECT SET MSVCNT=\\JP1\MSVCNT REM *** SET INCLUDE PATH *** SET INCLUDE=%MSVCNT%\INCLUDE REM *** COMPILE THE SOURCE FILE *** %MSVCNT%\BIN\CL /C /P %SOURCE%\FILE. For example. Limited 1991-2006 • Page 182 . conflicts can occur if two batch jobs attempt to create network connections using the same device letter. then network connections can be a very useful way of accessing network resources. although there is a drawback to using them.” However. so that if the sharename changes. The drawback is that all network connections that are established are effective across an entire computer.C Network connections (device letters assigned to network sharepoints) may also be used in batch jobs. Thus. but it is often useful to define an environment variable for a sharename. or if a batch job tries to create a network connection using a device letter that the currently logged on user has already assigned.C REM *** DELETE NETWORK CONNECTIONS © ArgSoft Intellectual Property Holdings. the batch job that tries to create a network connection with a device letter that is already in use will receive the error message “The local device name is already in use. the following command procedure excerpt performs the same compile operation as the previous example. In these cases. and so on. as in the following example: C:> QSUBMIT C:\BAT\GET_FILE. separate the parameters with spaces and enclose them in quotes.* When customers submit the job. Using Job Parameters There is often a need to pass parameters to jobs. enter the parameters for the job in the Submit Job dialog box or use the /PARAMS qualifier with the QSUBMIT command.DAT If customers need to specify more than one parameter with the QSUBMIT command. execute a job if job succeeds or execute a job if job fails depending on the jobs return code that is received. without knowing in advance what files need to be compiled or transferred.BAT” copy \\SERVER3\DATA\%1 C:\LOCALDIR\*.Argent Job Scheduler Users Guide NET USE J: /DELETE NET USE K: /DELETE Note the addition of “|| EXIT” after each of the NET USE commands. Return Codes Queue Engines provide customers the ability to notify a user.BAT /PARAMS=FY94. This causes the batch job to terminate if an error occurs in creating either of the network connections. If Job1 completes with a return code that is equal to zero then notify user. For example if Job1 completes with a return code that is not equal to zero then execute Job2. rather than allowing the procedure to continue and possibly use a network connection that is mapped to an incorrect location.BAT /PARAMS=“NAME1 NAME2” When customers specify more than one parameter. Using parameters. as in the following simplified example: rem Sample batch file “GET_FILE. customers may want to set up jobs to compile files or perform file transfers. where they want to substitute the contents of the parameter. For example. the characters %1 in the batch file are replaced with the value of the first parameter. Limited 1991-2006 • Page 183 . as in this command: C:> QSUBMIT C:\BAT\RENAME. customers can write batch jobs to perform these tasks. %2 is replaced with the value of the second parameter. %2. %3. Using parameters in batch jobs is simple – customers simply use the special characters %1. etc. © ArgSoft Intellectual Property Holdings. QueueName Text that is optional is enclosed within square brackets. For example. customers may use /DESCR instead of /DESCRIPTION. © ArgSoft Intellectual Property Holdings. e. enclose the entire value in quotes.g. enter: C:\> QSUBMIT/? If the help screen scrolls too fast.g. e. QueueName | JobNumber | /EXECUTING_JOBS On-line Help An on-line help screen for any Queue Engine command can be displayed simply by entering the command with the /? or /HELP qualifier. that modify the meaning of the command. or switches. as in the following example: C:\> QCREATE QUEUE1/DESCRIPTION=”Default queue” Qualifiers do not need to be spelled out in full.g. Many qualifiers can specify values.Argent Job Scheduler Users Guide Appendix A: Command Reference This appendix provides reference information about Queue Engine commands.g. which are given after an equals sign. Qualifiers begin with the forward slash character. Document Conventions The following conventions are used to show the syntax of the commands: • • • • Text that must be entered exactly as shown is printed in a normal font. e. as in this example: C:\> QSUBMIT/? | MORE Command Qualifiers Most of the queue engine’s commands accept qualifiers. [/ABORT] Vertical bars indicate one of many options may be used. For example. e. as in /QUEUE=NIGHTLY. Limited 1991-2006 • Page 184 . Customers only need to provide enough characters to make a qualifier unique. use the MORE filter. If customers want to specify a value that contains a space. to see a help screen for the QSUBMIT command. QSUBMIT Text that represents a value that customers must provide is printed in Italics. ---------------. Open Started. setting the TABF_SERVER environment variable: C:\> SET TABF_SERVER=NT2 C:\> QSHOW Connecting to server “NT2”.-------. using the /SERVER qualifier: C:\> QSHOW TABF ERROR 94: Queue Engine service named pipe was not found. Limited 1991-2006 • Page 185 . The second is to set the TABF_SERVER environment variable. Here is an example of the second method. Open Started. In addition. © ArgSoft Intellectual Property Holdings. That is. Open Started.-------------------------- In this example.-------. the /SERVER qualifier was not required for the QSHOW command. a command entered on one computer can be sent to a Queue Engine server on another. The second command was successful because a server computer was specified with the /SERVER qualifier. Open Started.---------------. Here is an example of the first method. Open Stopped. C:\> QSHOW/SERVER=NT2 Connecting to server “NT2”. because once the environment variable is set. The first is to use the /SERVER qualifier every time customers enter a command.Argent Job Scheduler Users Guide Using Commands Across A Network All of the queue engine’s commands can be used across a network. Open Priority Description 20 Background job queue 100 Background build queue 100 Nightly processing queue 200 SQL query queue ---------------. This method is easier to use than the /SERVER method. customers could set the TABF_SERVER environment variable with the Control Panel System applet. all Queue Engine commands will automatically be directed to the correct server computer. Open Stopped. Open Priority Description 20 Background job queue 100 Background build queue 100 Nightly processing queue 200 SQL query queue ---------------. There are two different ways to use the commands across a network. because the TABF_SERVER environment variable had been set.---------------------–--–-- The first QSHOW command in this example reported an error because the Queue Engine service was not running on the local computer. so that it is set automatically when they log on. Queue Name BACK BUILD NIGHTLY SQL Status Started. Queue Name BACK BUILD NIGHTLY SQL Status Started. The /SERVER qualifier specifies the name of a Queue Engine server computer. If the job is executing at the time this command is entered. If this qualifier is not present. aborts. If this qualifier is absent. Limited 1991-2006 • Page 186 . and.Argent Job Scheduler Users Guide QCANCEL The QCANCEL command cancels. or discards a job. depending on the current status of the specified job. then this command returns an error if the job is executing. Examples C:\> QCANCEL 522 This example cancels job number 522. it may cause loss or corruption of data. then the command assumes the local computer. Syntax QCANCEL JobNumber [/ABORT] [/SERVER=ComputerName] Qualifiers If the /ABORT qualifier is present and the specified job is executing. C:\> QCANCEL 522/ABORT This example aborts job 522. then an error message is displayed and the job is not canceled. depending on the nature of the job that is terminated. if defined. then the command uses the value of the TABF_SERVER environment variable. If this environment variable is also absent. © ArgSoft Intellectual Property Holdings. Terminating jobs is a potentially dangerous action. then the job is aborted. C:\> QCLOSE QUEUE2/SERVER=NT2 This example closes the queue called QUEUE2 on server computer NT2. Syntax QCLOSE QueueName [/SERVER=ComputerName] Qualifiers The /SERVER qualifier specifies the name of a Queue Engine server computer. Limited 1991-2006 • Page 187 . If this qualifier is absent. it will not accept jobs that are submitted to it. if defined. When a queue is closed. © ArgSoft Intellectual Property Holdings. Examples C:\> QCLOSE LOW_PRI This example closes the queue called LOW_PRI.Argent Job Scheduler Users Guide QCLOSE The QCLOSE command closes a queue. then the command assumes the local computer. then the command uses the value of the TABF_SERVER environment variable. If this environment variable is also absent. a default of 32 is used. This value determines the maximum number of jobs that may be executing in the queue at one time. If this qualifier is not specified. If these are specified. The priority of a queue should represent its priority relative to other queues. Typical values range from 1 to around 6 or 7. and may not contain any spaces. The /CLOSED and /OPEN qualifiers specify whether the queue is initially closed or open. The pending jobs limit determines the maximum number of jobs that may be pending in the queue at one time. The /PENDING_JOBS qualifier specifies the pending jobs limit for the new queue. If this qualifier is not specified. and they can also be changed at a later time with the QMODIFY command. for example. The /EXECUTING_JOBS qualifier specifies the executing jobs limit for the new queue. then the queue has no automatic start and stop times. then the queue is automatically started every day at the hour and minute specified by /AUTO_START and stopped every day at the time specified by /AUTO_STOP. If this qualifier is not specified. “6:30” means 6:30 AM. Various queue properties can be specified when the queue is created. a default value of 1 is used. By default.Argent Job Scheduler Users Guide QCREATE The QCREATE command creates a queue. © ArgSoft Intellectual Property Holdings. The queue name may be up to 16 characters long. Syntax QCREATE QueueName [/DESCRIPTION=string] [/PRIORITY=n] [/PENDING_JOBS=n] [/EXECUTING_JOBS=n] [/STOPPED | /STARTED] [/CLOSED | /OPEN] [/AUTO_START=hh:mm /AUTO_STOP=hh:mm] [/AUTO_OPEN=hh:mm /AUTO_CLOSE=hh:mm] [/SERVER=ComputerName] [/WORLDREAD] [/WORLDCONTROL] Qualifiers The /PRIORITY qualifier specifies the priority for the new queue. By default. a default priority of 128 is used. and “18:30” means 6:30 PM. More CPU time is given to jobs that execute in the queues with higher priorities. a queue is open when it is created. The /STOPPED and /STARTED qualifiers specify whether the new queue is initially stopped or started. This value may range from 0 to 255. Default values are used for any attributes that are not specified. a queue is started when it is created. Times are specified with these qualifiers in 24-hour time. Limited 1991-2006 • Page 188 . If these qualifiers are not specified. The /AUTO_START and /AUTO_STOP qualifiers specify optional automatic start and stop times for the queue. abort. and an executing jobs limit of 3. If this qualifier is not specified.Argent Job Scheduler Users Guide The /AUTO_OPEN and /AUTO_CLOSE qualifiers specify optional automatic open and close times for the queue. and an executing jobs limit of 3. Limited 1991-2006 • Page 189 . or otherwise control the jobs contained by the new queue. then the command uses the value of the TABF_SERVER environment variable. if defined. cannot view the jobs contained by the new queue. If these are specified. with default values for all queue attributes. other users. Times are specified with these qualifiers in 24-hour time. then the command assumes the local computer. cannot delete. The [/WORLDREAD] qualifier allows the queue to be viewed by other users. for example. with the description “Default queue”. Examples C:\> QCREATE ABC This command creates a queue called ABC. If this qualifier is absent. a priority of 150. The [/WORLDCONTROL] qualifier allows the queue to be controlled by other users. The queue will automatically stop every day at 8:00 AM and start every day at 6:30 PM. other users. © ArgSoft Intellectual Property Holdings. and “18:30” means 6:30 PM. a pending jobs limit of 50. C:\> QCREATE QUEUE1 /DESCR=”Default queue” /PRIORITY=150 /PENDING_JOBS=30 /EXECUTING_JOBS=3 This command creates a queue called QUEUE1. with a priority of 80. The /SERVER qualifier specifies the name of a Queue Engine server computer. except administrators. If this environment variable is also absent. except administrators. If this qualifier is not specified. a pending jobs limit of 30. then the queue is automatically opened every day at the hour and minute specified by /AUTO_OPEN and closed every day at the time specified by /AUTO_CLOSE. then the queue has no automatic open and close times. C:\> QCREATE NIGHTLY /DESCR=”Nightly batch queue” /PRIORITY=80 /PENDING_JOBS=50 /EXECUTING_JOBS=3 /AUTO_STOP=8:00/AUTO_START=18:30 This command creates a queue called NIGHTLY. “6:30” means 6:30 AM. If these qualifiers are not specified. Syntax QDELETE QueueName [/ABORT_JOBS] [/SERVER=ComputerName] Qualifiers The /ABORT_JOBS qualifier instructs the queue engine to abort any executing jobs in the queue in order to delete the queue. If the queue contains any executing jobs. canceling any jobs in the queue.Argent Job Scheduler Users Guide QDELETE The QDELETE command deletes a queue. if defined. then the command uses the value of the TABF_SERVER environment variable. the QDELETE command will not delete the queue unless the /ABORT_JOBS qualifier is used. © ArgSoft Intellectual Property Holdings. If this environment variable is also absent. and the queue contains one or more executing jobs. If customers do not use this qualifier. Examples C:\> QDELETE QUEUE1 This example deletes queue QUEUE1. If the queue contains any executing jobs. If this qualifier is absent. C:\> QDELETE QUEUE1/ABORT_JOBS This example deletes queue QUEUE1. The /SERVER qualifier specifies the name of a Queue Engine server computer. then the command assumes the local computer. then the Queue Engine does not delete the queue. aborting any executing jobs in the queue. Limited 1991-2006 • Page 190 . then an error message is displayed and the queue is not deleted. The /PENDING_JOBS qualifier specifies a new pending jobs limit for the queue. The /CLOSE and /OPEN qualifiers close or open the queue. These qualifiers must be specified together. for example. then the command uses the value of the TABF_SERVER environment variable. An alternate way to stop or start a queue is to use the QSTOP or QSTART commands. These qualifiers must be specified together. the queue will automatically open every day at the time specified by /AUTO_OPEN and close every day at the time specified by /AUTO_CLOSE. The /SERVER qualifier specifies the name of a Queue Engine server computer. if defined. The /STOP and /START qualifiers stop or start the queue. and “18:30” means 6:30 PM. Once these times are set. This value determines the maximum number of jobs that may be executing in the queue at one time. More CPU time is given to jobs that execute in the queues of higher priorities. “6:30” means 6:30 AM. This value may range from 0 to 255. This value determines the maximum number of jobs that may be pending in the queue at one time. for example. respectively. then the command assumes the local computer. The /AUTO_START and /AUTO_STOP qualifiers specify automatic start and stop times for the queue. If they are specified.Argent Job Scheduler Users Guide QMODIFY The QMODIFY command modifies one or more of a queue’s properties. Typical values range from 1 to around 6 or 7. © ArgSoft Intellectual Property Holdings. If this qualifier is absent. The /AUTO_OPEN and /AUTO_CLOSE qualifiers specify automatic open and close times for the queue. An alternate way to close or open a queue is to use the QCLOSE or QOPEN command. This value may range from 0 to 100. “6:30” means 6:30 AM. If this environment variable is also absent. These qualifiers require 24-hour time values. and “18:30” means 6:30 PM. Limited 1991-2006 • Page 191 . These qualifiers require 24-hour time values. The /PRIORITY qualifier specifies a new priority for the queue. The /EXECUTING_JOBS qualifier specifies a new executing jobs limit for the queue. This value may range from 0 to 1000. respectively. Syntax QMODIFY QueueName /DESCRIPTION=string | /PRIORITY=n | /PENDING_JOBS=n | /EXECUTING_JOBS=n | /STOP | /START | /CLOSE | /OPEN | /AUTO_START=hh:mm/AUTO_STOP=hh:mm | /AUTO_OPEN=hh:mm/AUTO_CLOSE=hh:mm [/[NO]WORLDREAD] [/[NO]WORLDCONTROL] [/SERVER=ComputerName] Qualifiers The /DESCRIPTION qualifier specifies a new description for the queue. then the queue is set to automatically start every day at the hour and minute specified by /AUTO_START and stop every day at the time specified by /AUTO_STOP. Examples C:\> QMODIFY QUEUE2/EXECUTING_JOBS=5 This example changes the executing jobs limit of queue QUEUE2 to 5. cannot delete. except administrators. other users.Argent Job Scheduler Users Guide The [/[NO]WORLDREAD] qualifier specifies whether the queue is to be viewed by other users. The [/[NO]WORLDCONTROL] qualifier allows the queue to be controlled by other users. C:\> QMODIFY CAD2/PRI=50 This example changes the priority of the queue CAD2 to 50. © ArgSoft Intellectual Property Holdings. except administrators. C:\> QMODIFY NIGHTLY/AUTO_STOP=7:30/AUTO_START=19:00 This example modifies queue NIGHTLY so that it automatically stops at 7:30 AM every day and starts at 7:00 PM every night. Limited 1991-2006 • Page 192 . or otherwise control the jobs contained by the new queue. /NOWORLDCONTROL is specified. other users. If /NOWORLDREAD is specified. cannot view the jobs contained by the new queue. abort. then the command uses the value of the TABF_SERVER environment variable. it will accept jobs that are submitted to it. Limited 1991-2006 • Page 193 . and as long as it is not full. if defined. © ArgSoft Intellectual Property Holdings. If this qualifier is absent. then the command assumes the local computer. If this environment variable is also absent. Syntax QOPEN QueueName [/SERVER=ComputerName] Qualifiers The /SERVER qualifier specifies the name of a Queue Engine server computer. C:\> QOPEN QUEUE3/SERVER=ARIES This example opens queue QUEUE3 on the server named ARIES. Examples C:\> QOPEN LOW_PRI This example opens the queue called LOW_PRI. When a queue is open.Argent Job Scheduler Users Guide QOPEN The QOPEN command opens a queue. Argent Job Scheduler Users Guide QREQUEUE The QREQUEUE command moves a job from one queue to another queue. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 194 . Syntax QREQUEUE JobNumber /QUEUE=QueueName [/SERVER=ComputerName] Qualifiers The /QUEUE qualifier specifies which queue to requeue the job to. if defined. then the command assumes the local computer. If this qualifier is absent. Examples C:\> QREQUEUE 634/QUEUE=QUEUE2 This example moves job number 634 from the queue that it was previously in to queue QUEUE2. then the command uses the value of the TABF_SERVER environment variable. This qualifier is required. If this environment variable is also absent. The /SERVER qualifier specifies the name of a Queue Engine server computer. and also displays a list of all jobs executing and pending in the queue.Argent Job Scheduler Users Guide QSHOW The QSHOW command displays information about a single queue. if defined. If this qualifier is absent. Syntax QSHOW [/ALL | QueueName [/JOBS] | JobNumber | /EXECUTING_JOBS] [/SERVER=ComputerName] Qualifiers The /ALL qualifier displays all queues in the system. The /EXECUTING_JOBS qualifier displays all jobs that are currently executing in queue. This is the default if no qualifiers are specified. Examples C:\> QSHOW NIGHTLY This command displays information about the queue called NIGHTLY. then the command uses the value of the TABF_SERVER environment variable. © ArgSoft Intellectual Property Holdings. and all queues in the system. C:\> QSHOW 642 This command displays information about the job number 642. C:\> QSHOW NIGHTLY /JOBS This command displays information about the queue called NIGHTLY. Limited 1991-2006 • Page 195 . The /SERVER qualifier specifies the name of a Queue Engine server computer. C:\> QSHOW /EXECUTING_JOBS This command displays a list of all jobs that are currently executing in queue. a single job. then the command assumes the local computer. C:\> QSHOW /ALL This command displays a list of all queues in the system. along with the other queue information. or all executing jobs. If this environment variable is also absent. C:\> QSHOW /EXECUTING_JOBS /SERVER=MICRON This command displays a list of all jobs that are currently executing on server computer MICRON. The /JOBS qualifier can be used with a queue name to display all of the jobs in the specified queue. Argent Job Scheduler Users Guide QSTART The QSTART command starts a queue. When a queue is started, it will execute jobs that are pending in the queue. Syntax QSTART QueueName [/SERVER=ComputerName] Qualifiers The /SERVER qualifier specifies the name of a Queue Engine server computer. If this qualifier is absent, then the command uses the value of the TABF_SERVER environment variable, if defined. If this environment variable is also absent, then the command assumes the local computer. Examples C:\> QSTART LOW_PRI This example starts queue LOW_PRI. C:\> QSTART QUEUE2 /SERVER=NT2 This example starts queue QUEUE2 on server computer NT2. © ArgSoft Intellectual Property Holdings, Limited 1991-2006 • Page 196 Argent Job Scheduler Users Guide QSTOP The QSTOP command stops a queue. When a queue is stopped, it will not execute jobs that are pending in the queue. Syntax QSTOP QueueName [/SERVER=ComputerName] Qualifiers The /SERVER qualifier specifies the name of a Queue Engine server computer. If this qualifier is absent, then the command uses the value of the TABF_SERVER environment variable, if defined. If this environment variable is also absent, then the command assumes the local computer. Examples C:\> QSTOP LOW_PRI This example stops queue LOW_PRI. C:\> QSTOP QUEUE2 /SERVER=NT2 This example stops queue QUEUE2 on server computer NT2. © ArgSoft Intellectual Property Holdings, Limited 1991-2006 • Page 197 Argent Job Scheduler Users Guide QSUBMIT The QSUBMIT command submits a job to a queue. The job is specified by its job file, which is either a command procedure (.CMD or .BAT) or executable (.EXE) file. If this command is being used on the server computer, i.e. the computer on which the Queue Engine service is running, then the current drive and directory is used if the drive or directory is not specified. If the command is being used to submit a job to a remote Queue Engine server computer, then the full filespec, relative to the queue engine server computer, must be used. Syntax QSUBMIT JobFile [/QUEUE=QueueName] [/NAME=Name] [/PARAMS=Params] [/LOG_FILE=Filename] [/NOLOGNUMBER] [/USER=[Domain\] Username] [/PASSWORD=Password] [/AFTER=Time] [/EVERY=hh:mm] [/NOTIFY=Username | /NONOTIFY] [/NODETECT] [/[NO]WORLDREAD] [/[NO]WORLDCONTROL] [/SERVER=ComputerName] Qualifiers The /QUEUE qualifier specifies the queue to submit the job to. If this qualifier is not specified, then the job is submitted to the default queue, which is set by the system administrator with the /DEFAULT_QUEUE qualifier of the QSYSTEM command. The /NAME qualifier specifies an alternate name for the job. If this qualifier is not used, then the job’s name is derived from the filename of the job file. The /PARAMS qualifier allows customers to supply parameters for the job. Parameters are used in batch files by using the special characters %1, %2, %3, etc. If customers need to specify more than one parameter for a job, then enclose the parameters in quotes and separate them with spaces. The /LOG_FILE qualifier specifies an alternate name for the job’s log file. If this qualifier is not used, then the job’s log file has the same name as the job filespec, except with a file type of .LOG. Also, if /NOLOGNUMBER is not used, then the Queue Engine service appends the job’s job number to the log filename. The /NOLOGNUMBER qualifier instructs the Queue Engine service not to append the job’s job number to the log file filename. By default, the Queue Engine service does append the job number, as in C:\TEST\JOB.LOG.753, in order that the filenames will be unique even if the base paths and filenames are the same for two different jobs. The /USER qualifier specifies the user account which the job runs under. If this qualifier is not specified, then the submitting user’s account is used. Either a username or a username and domain name may be specified. If a username but no domain name is specified, then the submitting user’s domain name is used. A password must be specified in order to run the job under an account other than the submitting users. © ArgSoft Intellectual Property Holdings, Limited 1991-2006 • Page 198 Argent Job Scheduler Users Guide The /PASSWORD qualifier specifies a password to associate with the job’s logon session when the job is executed. A password is required if the job file is located on a computer other than the Queue Engine server computer, or if the job must access network resources. The password must be correct at the time the job is started, or the job will fail to start. The /AFTER qualifier specifies a time after which the job may be started. The time value may be in absolute or relative time format, and various parts of the time value may be omitted. Here are some examples: Time Value 18:00 3-APR-1994:18:00 3-APR-1994 +:30 +1:30 +2:00 +1 +1-6:00 Meaning 6:00 P.M. today 6:00 P.M. on April 3, 1994 Midnight just before April 3, 1994 30 minutes from now 1 hour and 30 minutes from now 2 hours from now 1 day from now 1 day and 6 hours from now The /EVERY qualifier specifies a time interval at which the job is repeated. For example, if a value of “24:00” is used, then the job will be executed every 24 hours. The /NOTIFY qualifier specifies an alternate user to be notified when the job starts and completes. The /NONOTIFY qualifier specifies that no user is to be notified. If neither of these qualifiers are specified, then the user who submitted the job is notified. The /NODETECT qualifier instructs the Queue Engine not to automatically detect if the job is waiting for keyboard input, and then abort it. If this qualifier is not specified, then the Queue Engine automatically detects when a batch job is waiting for keyboard input, and aborts the job. The /EXIT_CODE_FILE qualifier specifies a file from which the Queue Engine takes the jobs exit code. If this is not specified, then the job’s exit code is set to the exit code returned from the jobs main process. If the qualifier is used, then the specified file is expected to exist after the job has completed, and contain a one- to four-digit ASCII string representing a decimal number, such as “1234”. Values of zero to 8,999 are allowed. If the Queue Engine cannot read the exit code file, it sets the job’s exit code to one of the following special values: © ArgSoft Intellectual Property Holdings, Limited 1991-2006 • Page 199 Argent Job Scheduler Users Guide Exit Code Value 9999 9998 9996 9995 9994 Meaning The exit code file was not found General error reading file Incorrect syntax in the file Access to file denied Sharing violation (file in use by another process) The /FAIL_EXIT_CODE qualifier specifies what exit code values constitute failure for the job. For example, GT0 means that exit codes greater than zero constitute failure for the job. GT represents “greater than”, LT represents “less than”, EQ represents “equal to”, and NE represents “not equal to”. The /SUCCESS_JOB qualifier specifies a batch file or executable to execute if the job succeeds (meaning if the job completes with an exit code not defined as failure) The /FAIL_EVENT qualifier specifies that an event should be reported to the system log on the Queue Engine server computer if the job fails (meaning if the job completes with an exit code defined as failure) The /FAIL_NOTIFY qualifier specifies that a user should be notified via the W200x Messenger Service if the job fails (meaning if the job completes with an exit code defined as failure) The /NOWORLDREAD qualifier specifies that even if the queue to which the job is submitted creates jobs with world read access as its default, this job is not to be created allowing Everyone read access to the job. The /NOWORLDCONTROL qualifier specifies that even if the queue to which the job is submitted creates jobs with world control as its default, this job is not to be created allowing Everyone full control of the job. The /SERVER qualifier specifies the name of a Queue Engine server computer. If this qualifier is absent, then the command uses the value of the TABF_SERVER environment variable, if defined. If this environment variable is also absent, then the command assumes the local computer. Examples C:\> QSUBMIT PAYROLL This example submits the batch file PAYROLL.BAT in the current directory to the current default queue. The job log file created when the job executes will be called PAYROLL.LOG in the same directory. C:\> QSUBMIT /QUEUE=NIGHTLY \CAD\MANDEL.EXE This example submits the executable MANDEL.EXE in the CAD directory to queue NIGHTLY. The job log file created when the job executes will be called MANDEL.LOG.JobNumber and will also be located in the CAD directory. © ArgSoft Intellectual Property Holdings, Limited 1991-2006 • Page 200 C:\> QSUBMIT \\NT1\BUILD\BUILD1. C:\> QSUBMIT PAYROLL.CMD /QUEUE=BUILDS /USER=DEV\tomd /PASSWORD=12345 This example submits a build job. C:\> QSUBMIT D:\ACCT\PAYROLL. not on the computer where this command was entered. When the job completes. The job log file created when the job executes will be called PAYROLL.BAT /SERVER=ARIES This example submits the batch file PAYROLL. C:\> QSUBMIT WORK. tonight. which will run under the user account called tomd.EXE to the default queue.M.EXE /AFTER=+2:00 This example submits a job called WORK.M.LOG. to be started no sooner than 6:00 P. C:\> QSUBMIT WORK.DAT © ArgSoft Intellectual Property Holdings.LOG in directory C:\JOHNV\PAYROLL. C:\> QSUBMIT C:\JOBS\BACKUP. C:\> QSUBMIT D:\BAT\GET_FILE. today. Note that the job filespec is relative to the server computer.Argent Job Scheduler Users Guide C:\> QSUBMIT D:\TOMD\NIGHTWRK.BAT in the current directory to the current default queue.BAT to queue NIGHTLY. which will run under the user account called BackupAcct. user HARRYF will be notified.BAT /PARAMS=FY94.BAT /NOTIFY=HARRYF /QUEUE=NIGHTLY This example submits the batch file D:\TOMD\NIGHTWRK. Limited 1991-2006 • Page 201 . This means that the filespec refers to drive D: and directory ACCT on ARIES.BAT /LOG=C:\JOHNV\PAYROLL.EXE /AFTER=18:00 This example submits a job called WORK.EXE to the default queue.CMD /QUEUE=SYSJOBS /AFTER=22:00 /USER=BackupAcct /PASSWORD=12345 This example submits a backup job to start at 10:00 P.BAT in directory D:\ACC\ to server computer ARIES.LOG This example submits the batch file PAYROLL. to be started in two hours. it will display a message saying that the Queue Engine service is paused. When the product is first installed. When the service is stopped. then no new jobs are started. it is much safer to pause it using the /PAUSE qualifier. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 202 . The service must be started in order for any other the Queue Engine commands to work.Argent Job Scheduler Users Guide QSYSTEM The QSYSTEM command allows the system administrator to control the queue system. This value may be increased or decreased depending on the amount of memory and other system resources available to the server. but no new jobs will be started. Most of the functions of this command are. The /START qualifier starts the Queue Engine service. or “unpauses”. Stopping the Queue Engine service is a dangerous operation. because all jobs that are executing when the service is stopped are terminated. Syntax QSYSTEM [/SHOW | /START | /STOP | /PAUSE | /CONTINUE | /DEFAULT_QUEUE=QueueName | /NO_DEFAULT_QUEUE | /LOG_FILE=Filename | /LOG_SIZE_LIMIT=KBytes | /KEY=LicenseKey] /MAX_EXEC_JOBS /MAX_JOB_PROCESSES /LICENSE [/SERVER=ComputerName] Qualifiers The /SHOW qualifier displays information about the Queue Engine service. The /PAUSE qualifier pauses the Queue Engine service. the Queue Engine service is configured to start automatically at system startup. This is the default if no qualifiers are specified. This information includes the current state of the service and the filenames of the system log file and the system settings file. no other the Queue Engine commands will work. When the service is paused. all jobs that are executing will continue to execute. the Queue Engine service. available only to members of the Administrators or Domain Admin group on the Queue Engine server computer. so it is not necessary to manually start it every time the computer boots. The /LICENSE qualifier displays installation and license information about a Queue Engine server computer. if any user tries to use the Queue Engine command. When this number of jobs are executing on the server in all queues combined. allowing it to resume normal operation. The /STOP command stops the Queue Engine service. by default. If customers need to halt the service for any reason. The /CONTINUE qualifier continues. The /MAX_EXEC_JOBS qualifier sets the maximum executing jobs value for the queue engine server. Also. This qualifier should only be used when a representative of Argent Software Inc gives customers a license key. that the system log file is allowed to reach. because although no new jobs are started. The /KEY qualifier installs a new product license key. which are already executing may create more processes. Limited 1991-2006 • Page 203 . the queue engine system log file size limit is set to 512K. The /LOG_SIZE_LIMIT qualifier changes the size limit of the queue engine system log file. By default. If this qualifier is absent. then no new jobs are started. and it is located in the \Argent\QueueEngine\Log directory. which records entries about all events in the queue system. When the service is paused. then the command uses the value of the TABF_SERVER environment variable.TXT.Argent Job Scheduler Users Guide The /MAX_JOB_PROCESSES qualifier sets the maximum number of processes among all executing jobs for the queue engine server. then the command assumes the local computer. The /LOG_FILE qualifier changes the name and/or location of the queue engine system log file. The /NO_DEFAULT_QUEUE qualifier clears the default queue. The default queue is the queue that jobs are submitted to if no queue name is specified in the QSUBMIT command. or one-half megabyte. and the queue engine commands and the queue engine Main GUI functions will not work. When the file reaches the size limit. © ArgSoft Intellectual Property Holdings. a queue name must be specified in order to submit a job. in kilobytes. Note that the actual number of job processes on a Queue Engine server may temporarily exceed this limit. if defined. This value may be increased or decreased depending on the amount of memory and other system resources available to the server. The /DEFAULT_QUEUE qualifier sets the default queue for the product. When this number of processes exists among all executing jobs. the queue engine system log file is called SVC_LOG. jobs. C:\> QSYSTEM /PAUSE This example will cause the queue engine service to pause. Usually. The /SERVER qualifier specifies the name of a Queue Engine server computer. By default. the old one is renamed and a new one is started. This value determines the maximum size. one with a moderate priority and executing jobs limit. customers will want to set the default queue to a “middle of the road” queue. Examples C:\> QSYSTEM /SHOW This example displays information about the queue system. When no default queue is set. queues will not start any pending jobs. If this environment variable is also absent. C:\> QSYSTEM /CONTINUE This example continues the queue engine service. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 204 . C:\> QSYSTEM /DEFAULT_QUEUE=HIGH_PRI This example sets the default queue to HIGH_PRI.Argent Job Scheduler Users Guide C:\> QSYSTEM /START /SERVER=ARIES This example starts the queue engine service on the queue engine server computer named ARIES. the Scheduler Engine allows customers to install a client on the desktops of users who need to schedule jobs regularly (not execute the jobs . and as such requires an account to “log in” as. Besides the advanced scheduling features which have been covered throughout this manual.Argent Job Scheduler Users Guide Appendix B: Architecture And Concepts This chapter is provided to help customers gain a clearer understanding of how the Argent Scheduling System works. the rationale being the tasks being performed by this account are usually reserved to administrators. © ArgSoft Intellectual Property Holdings. The question I am frequently asked is. The minimum installation any site requires is a normal (service) installation of the Queue Engine. which additional clients will connect to. it runs as a service. in most cases they are using the “client” to connect to the “server”. Because the Queue Engine runs in the background. Every job that must run on a specific server requires a separate Queue Engine installation. The service account must have administrative privileges. the client installation only installs the files necessary to connect to a server. both of which exist on the same computer. there is no service account under a client installation (since no services are being installed). Queue Engine The Scheduling System consists of two components that customers should now be familiar with: The Queue Engine and The Scheduler Engine. This is the Job Scheduler server. Customers will almost never need to install the queue engine client. On the other hand. Scheduler Engine The Job Scheduler consists of a server and a client. In most cases the server and client are installed on the same machine. The client portion is exactly the same as the Main GUI described in this manual. The normal installation will configure a server and install the service account. will they see each other’s jobs?” The short answer is yes and the long answer is it depends. The Queue Engine server is installed on all servers that customers wish to run jobs on. they can however if that is their preference. This is a crucial concept. If customers plan on using advanced scheduling features the minimum installation required is a normal (service) installation of the Queue Engine and a normal (service) installation of the Job Scheduler. Both components consist of a server and a client. Limited 1991-2006 • Page 205 . Here we will discuss the architecture of the product and important. Before installing a remote client they must already have installed the Scheduler Engine as a service (normal installation) on a server. “If I install the client on the desktops of 3 different users.jobs are executed by Queue Engines). Let’s say it together: jobs on the Queue Engine server(s). alerts. usually via a rightclick and choosing Submit Job to Schedule. The Scheduler Engine’s role is to keep track of schedule and ensure jobs run when and where they are supposed to. While this is fine for testing. So in a default installation (no changes in configuration) any clients that connect to a similar server will be able to see all the jobs in the shared database.Argent Job Scheduler Users Guide Every client that connects to the same server is sharing the same database. a job class can be tied to a specific W200x user group. This is the software’s automation at work. Without a rollover feature customers are forced to submit jobs to the schedule everyday which can be tedious if there are hundreds of jobs to be run. Here is the next important point to remember: the Scheduler Engine simply submits jobs to one or more Queue Engines.jobs are executed by Queue Engine(s). in a job scheduler customers shouldn’t have to submit jobs every day since that is the scheduler’s job. They can also have separate installations of Job Scheduler servers. Rollover This is a crucial concept. without customer’s intervention. at midnight all the jobs that are supposed to be run that day appear in the schedule. By default. it is in this database that all the Job Classes. Customers might want to go this route if they have two or more departments with user submitting jobs that are unrelated to each other. Customers can set security through the use of job classes. macros. we have included a Job Forecast feature that allows customers to see their projected schedule for a date range they specify. rollover (and archiving) occurs everyday at midnight. reliance on this feature defeats the purpose of rollover and automation. Remember. Customers can then see the power of the software at work. calendars and what-not are stored. by default a job will be included in rollover. and let it run its course. in this case there will be two unique databases that will not be related to each other in any way. Limited 1991-2006 • Page 206 . customers must manually specify otherwise. An ad-hoc job is a job that customers have manually submitted to the schedule. Customers can change this within System Configuration in the Scheduler Engine. © ArgSoft Intellectual Property Holdings. which is allowed to control that class and all the jobs within it. Rollover is the crux of a job scheduling system. It does not “run” these jobs . The Scheduler Engine connects to the Queue Engine(s) that customers have specified and when the time comes the jobs that are supposed to run are executed on the appropriate Queue Engine server. any job flagged to be Included in rollover will be automatically placed in the schedule on its given days. By using this they can then ensure that their rollover jobs follow the schedule they intended. and any clients connecting to a server will only see the jobs on that server. As noted in the documentation. After customers have completed the testing phase of the product they should flag most of their jobs to be included in the rollover. A job that runs automatically thanks to rollover is the opposite of an ad-hoc job. it allows customers to define a schedule for a job and gives them peace of mind in the sense that they know this job will run on everyday that it should. By default. a job requiring mouse or keyboard input will not work (without modification) in our scheduler. customers can install a separate instance of the Queue Engine on a different server. Any job requiring user intervention cannot be run in the background. While this facilitates testing and will be appropriate for most networks. Our security features don’t end here. First. Under the Servers tab.Argent Job Scheduler Users Guide Background Jobs Another crucial concept – a job scheduler by nature is designed to run jobs in the background. Fault Tolerance and Backup Nodes Customers can define a backup node within System Configuration to ensure functionality even if the server housing the Scheduler Engine goes down. it is quite the opposite. customers can explicitly state a username/password combination to use for every job they define. This includes perl scripts. On the Queue Engine side. This way. Thus. It is important to remember that this is not an “issue” or a design flaw. and then alter the job’s definition. customer’s security needs may be more stringent. In this case customers have two options. whereas an administrator might have full run of the program. customers can supply a username/password for each specific Job Class they create and have each job use this combination. as opposed to the foreground or interactively. In this way customers can have regular users only able to view the GUI. within the Scheduler Engine customers can assign specific duties to different user groups. the job will still be run. customers can choose First Available Server. all jobs submitted via the Scheduler Engine will be run under the context of the Default Account. Secondly. This account is specified in Configuration within the Queue Engine and by default it is the same as the service account. etc… Security By default. Limited 1991-2006 • Page 207 . if customersr Queue Engine goes down. VB apps. These settings can be adjusted in the Security tab of System Configuration. FTP transfers. how would customers accommodate running a job everyday at 4AM (besides enraging the tech that drew this onerous assignment)? A good rule of thumb is any job that can be run under the AT command (without the interactive switch) can be run under the Job Scheduler. © ArgSoft Intellectual Property Holdings. This user right is seldom missing. The troubleshooting procedures are presented as steps for isolating the problem together with resources for identifying causes of errors. the path/file specification C:\Folder Name\File Name is valid locally but will be invalid when referenced from a server. Limited 1991-2006 • Page 208 . For example. check with co-workers some have spent considerable time debugging a failed batch job only to find out that a co-worker had changed permission on an account. Even accounts with administrative level privileges do not have this user right by default. • File locations Where are the files? Remember that if a local path is used. Look back to the time when the issue started. The job may also need rights specific to the job. the UNC (Universal Naming Convention) format in the form: \\ServerName\ShareName\Folder Name\File Name would provide a valid reference both locally and from a remote server. Instead. What Has Changed? • Account permissions To run a batch job. to get to the crux of the problem. If a job must reference executables. First. Step 1: Did The Job Run Before? If the job ran successfully before. if customers use the browse option in the job definition in the Argent Job Scheduler to enter a local path to the batch job but submit the job to run on a remote server. The second user right. the job will fail to start. some factor must have changed to cause it to fail now. Customers don’t want to waste time debugging a symptom while they are missing the real cause of the difficulty. of course. If a required file is referenced by an entry in the path © ArgSoft Intellectual Property Holdings. arriving at a solution. it will be referenced relative to where the queue engine is installed. it needs “log on locally”. To accomplish this. For example. (dynamic link libraries). The following sequence of steps can assist in identifying the problem and. “Log on as a batch job” is more often at issue.. or dll’s. This advanced user right must be assigned. irrelevant issues must be removed from the equation. if the file cannot be found in the exact same location on that server.Argent Job Scheduler Users Guide Appendix C: Troubleshooting Batch Jobs This appendix is devoted to troubleshooting batch jobs run using the Argent Job Scheduler and Queue engine. are the dll’s located on the server where the job will be run? Even the environment must be taken into consideration. the account assigned to the job must have two user rights explicitly assigned to it. deleted an account. Isolate the Problem The first requirement is to identify the actual problem – i. or renamed a file.e. • New software installed The most obvious cause may be the software related to the actual batch job. Why? Because.Argent Job Scheduler Users Guide statement associated with a user. Limited 1991-2006 • Page 209 . however. During installation. when a process is launched from an W200x service. it may not be found by the job when run in the schedule. the search path does not contain references that are linked to a particular user. many applications may share dll’s (and many replace existing dll’s but not always with the correct versions) or make modifications to the environment or the registry that can affect the functions of other processes. the issue is likely to be in the way that the job is defined.TXT. it can be the source of the job failure. Job JOB1 (J000026). and then fail? There is a definite difference between these two. A mapped drive is linked to a specific login and cannot reliably be used by a batch job if it is not specifically created and deleted within that batch job. UNC paths are the preferred method. • Check the Queue Engine log The queue engine log will report errors on this level for example. by adding the reference to the system path in W200x. Line#: 113 Sat Jul 15 13:25:54 Process of job JOB1 (J000026) failed because of failure of creating job log file © ArgSoft Intellectual Property Holdings. if the job’s log directory is in error. What to Check If the Job Fails To Start • Job/log path Is the job there? If the job is using a local path. Error: 3. Sat Jul 15 13:25:54 Launcher cannot create the job’s log file: D:\ARGENT\WrongDirectory\JOB1_J000026. is the job file local to the server where Argent Queue Engine is installed? • Check to make sure the log file and/or directory is accessible A common error is to specify a log file or directory that either doesn’t exist or is not accessible by the batch job’s account • Mapped Drives The path cannot use a mapped drive unless the drive is mapped in the job with the Net Use command. this message will be reported in the queue engine log: For example: Sat Jul 15 13:25:53 Job JOB1 (J000026) is successfully submitted by user NTECH\JEFF. This can be easily resolved. If the job starts. If the job fails to start. Step 2: Run the Job Directly From the Argent Queue Engine Did the job fail to start? Or did it start. look first at the batch job. • Server names Has a server name been changed? Although this may appear obvious. or in file permissions. then fails. • If the W200x account valid? Queue engine error 71 indicates that the account has been locked out by 200x security. but different passwords. Basic security rules for Windows 200x will always apply. Remember. or the Log on as a batch job right. Is the account allowed to log in at this time? Does the account have Time of Day login restrictions? • Is it a domain account. and will not bend! A common error is to use two accounts. Proper naming conventions are always a good practice. • Is the account missing a required user right? Queue engine error number 67 indicates that the account is missing either the Log on locally. this naming system did not lend itself to simplified debugging. one local and one domain account that have the same name. If these accounts are mixed up.Argent Job Scheduler Users Guide Check W200x Accounts • Does the account exist? Is the password correct? Queue engine error number 68 indicates a bad account or missing or incorrect password. A good example of why naming is important can be illustrated by a conversation overheard in tech support: Tech Support: “What does the error say?” Operator: “Error in Oracle8” “Oracle8” “Oracle8” “Oracle8” “Oracle8” “Oracle8” Tech Support: “What is the name of the domain account?” Operator: Tech Support: “What is the name of the local account you are using?” Operator: Tech Support: “What is the name of the server?” Operator: Tech Support: “How about the domain name?” Operator: Tech Support: “What is the name of the batch job?” Operator: Needless to say. make sure the keyboard caps lock is not on when the password is entered. or a local account? Mixing domain and local security can cause confusion. Limited 1991-2006 • Page 210 . © ArgSoft Intellectual Property Holdings. even though consistent. the wrong account may be specified for the batch job. Run Job Validation from job definition in the Argent Job Scheduler The Argent Job Scheduler Job Validation feature quickly checks a number of settings critical to the batch job. An example of this is a batch job using MS Access that hangs because the Office Assistant help icon is enabled. then the test will be invalid. then this is an indication that the job is running into trouble early. consider a VB program using ADO (Active Data Objects) to query a SQL server table and return results. So. The reason for this is that the test data set is small enough for the query to complete before the job’s primary process has ended. and the queue engine is not on the same server as the job scheduler. This same job will also complete successfully if launched manually. • Does the job use asynchronous processes? Jobs that query or move data in a database may fail intermittently if the process that manipulates the data is asynchronous. perhaps a login screen or a connection error. but uses little or no CPU resources. or some sort of user interaction early in the job. Limited 1991-2006 • Page 211 . Applications designed to be run in a scheduled environment often already have options that allow them to run “silent” or “unattended”. and not welcome or even recognized outside of that server. but fails in production. Is this a good thing? Yes since running this way provides many more advantages including stability. An asynchronous data function returns control to the primary process before it is finished. This particular job completes successfully as a batch job during testing. For example. Because the job is © ArgSoft Intellectual Property Holdings. When the production job’s query runs. Validation will tell customers: • Account validity (if specified on the job level) • • Job file path – Does the job exist? Note: if the job uses a local path. does the account exist on the server where the queue engine is running? A local account is exactly that. If a window is displayed. if a window is displayed by the job that requires user interaction to continue.Argent Job Scheduler Users Guide • If a local account. it takes longer to complete than the main process. the job will hang. • Does the job require user interaction? Each batch job runs in a separate environment. versatility. The job has its own login. local to the server. This would point to dll issues. • • Queues – Do the queues exist? Are they started and open? Recursion – Is there an infinite loop somewhere in the job definition? What to Check If the Job Hangs • Does the job continue to use CPU time? If the job starts. and security. it is on this “virtual” desktop and will not be seen. and its own desktop. These include job logs. Some older database utilities had issues with asynchronous processes but most have issued service packs to address the issue. Limited 1991-2006 • Page 212 . Scheduler logs and W200x event logs. A common symptom of this issue is a job that ends with a return code of 128. Logs A variety of logs are maintained for different tasks. © ArgSoft Intellectual Property Holdings. difficult to read job logs. Look at the original job definition to find out where the log was generated. • Why can’t I see my job run? It should show a window. Job Logs The Argent Queue engine generates a log for each job that it executes. If all the batch jobs a server was running showed on the desktop. In addition. This could also pose a potential security risk since a user with access to the terminal could then interact with a batch job and change it. leaving it enabled will result in large. The log will contain detailed internal debugging info. What to Look For In the Job Log • • • • • The log file or job command file may be unreachable Permissions issues Job ended unexpectedly Unrecognized file name Return codes For Queue Engine specific codes: see Argent documentation. Because this debug option is designed for debugging only. the dialog box asking if the query should continue cannot be seen.Argent Job Scheduler Users Guide running as a background process. an W200x error code with the error text “No child processes to wait for”. The Debug Option From the command-line type QSYSTEM /DEBUG. Argent Queue Engine Server A server log is kept by each installation of the Argent Queue engine. then the server would be unusable. but fails with larger data sets. for Job Specific codes: see specific job’s documentation. By definition a batch job is not interactive. server logs. creating batch jobs requiring human interactions would fundamentally defeat the purpose of automating tasks. Another symptom is when the job runs successfully with a small data set. for W200x error codes: use the utility command: NET HELPMSG error#. © ArgSoft Intellectual Property Holdings. Remember. What to Look For In Logs • • Connectivity issues Licensing issues W200x Event Logs The Windows W200x system also maintains an event log. 67: Log on as a batch job right is missing The account is missing a required advanced user right such as Log on as a batch job and/or Log on locally.Argent Job Scheduler Users Guide What to Look For In Argent Queue Engine Server Log • • • W200x Security issues Server out of disk space License Key expired Common Queue Engine Error Codes • • 68: Bad account or password This always means that there is a bad account or mistyped password. Limited 1991-2006 • Page 213 . Argent Job Scheduler Logs The Argent Job Scheduler maintains a log of events during operation. • 71: Account locked out The W200x account has been locked out. even an Admin account needs to have these rights explicitly granted. What to Look For In Logs • • • W200x security issues Connectivity issues Licensing issues Common W200x Error Codes • 5: Access Denied – Inadequate permissions on a W200x resource. For example. enclose the entire value in quotes. as in the following example: $ qcreate –D “Default queue” queue1 Notice that the options are placed before the queue1 argument. as in –q NIGHTLY. Options begin with the dash character. qsubmit Text that represents a value that customers must provide is printed in Italics. All commands support the –h and -? options that print out information about using the particular command. [/ABORT] Vertical bars indicate one of many options may be used.g. e. that modify the meaning of the command. All options must precede any other argument used with the command.g.Argent Job Scheduler Users Guide Appendix D: UNIX Command Reference This appendix provides reference information about UNIX Queue Engine commands. which are given after a space. If customers want to specify a value that contains a space. as in this example: $ qsubmit -? | more Command Options Most of the queue engine’s commands accept options (options). Many options can specify values. Document Conventions The following conventions are used to show the syntax of the commands: • • • • Text that must be entered exactly as shown is printed in a normal font. © ArgSoft Intellectual Property Holdings. e. e. enter: $ qsubmit -h If the help screen scrolls too fast. use the MORE filter. Limited 1991-2006 • Page 214 . to see a help screen for the qsubmit command. or switches.g. Text that is optional is enclosed within square brackets.g. QueueName | QueueName JobNumber | /EXECUTING_JOBS On-line Help An on-line help screen for any Queue Engine command can be displayed simply by entering the command with the -? or -h option. e. The first is to use the -s option every time customers enter a command.---------------. Limited 1991-2006 • Page 215 . Open The first qshow command in this example reported an error because the Queue Engine service was not running on the local computer. The second command was successful because a server computer was specified with the –s option.-------------------------- © ArgSoft Intellectual Property Holdings.-------.---------------. That is. Using Commands Across A Network All of the queue engine’s commands can be used across a network. TID: 1.Argent Job Scheduler Users Guide Queue Names The Queue Engine handles queue names with upper case letters. There are two different ways to use the commands across a network. Wed Jul 11 17:03:02 2001 TABFGetAllQueuesInfo: QeLink Init Failed. Queue Name Status Owner Description ---------------. Open Started. Queue Name BACK BUILD NIGHTLY SQL Status Started.---------------------–--–-- Stopped. a command entered on one computer can be sent to a Queue Engine server on another. The second is to set the TABF_SERVER environment variable. Open Started. using the -s option: $ qshow connecting stream socket: Connection refused ********** Entry: 1: PID: 3090. The user may specify queue names on the command line with either upper or lower case letters. Queue Engine Error: TABFERR ERROR CONNECTING TO SERVICE $ qshow –s bearmtn Connecting to bearmtn.-------. setting the TABF_SERVER environment variable: $ export TABF_SERVER=nt2 $ qshow Connecting to nt2. Here is an example of the first method. Open Owner swr swr swr swr Description Background job queue Background build queue Nightly processing queue SQL query queue ---------------. Here is an example of the second method. it may cause loss or corruption of data. because the TABF_SERVER environment variable had been set. or discards a job. depending on the current status of the specified job. then this command returns an error if the job is executing. If the job is executing at the time this command is entered. if defined. and. then an error message is displayed and the job is not canceled. Open swr Background job queue Started. © ArgSoft Intellectual Property Holdings. If this option is absent. Examples $ qcancel 522 This example cancels job number 522. so that it is set automatically when they log on. then the job is aborted.profile. Open swr Background build queue Stopped. Syntax qcancel [-a] [-s ComputerName] JobNumber Options If the –a option is present and the specified job is executing. QCANCEL The QCANCEL command cancels. Open swr Nightly processing queue Started. In addition.Argent Job Scheduler Users Guide BACK BUILD NIGHTLY SQL Started. $ qcancel –a 522 This example aborts job 522. customers could set the TABF_SERVER environment variable in their . then the command assumes the local computer. If this environment variable is also absent. all Queue Engine commands will automatically be directed to the correct server computer. The -s option specifies the name of a Queue Engine server computer. Open swr SQL query queue In this example. Limited 1991-2006 • Page 216 . If this option is not present. then the command uses the value of the TABF_SERVER environment variable. depending on the nature of the job that is terminated. because once the environment variable is set. This method is easier to use than the -s method. the -s option was not required for the QSHOW command. Terminating jobs is a potentially dangerous action. aborts. The pending jobs limit determines the maximum number of jobs that may be pending in the queue at one time. Limited 1991-2006 • Page 217 . and they can also be changed at a later time with the QMODIFY command. then the command assumes the local computer. if defined. then the command uses the value of the TABF_SERVER environment variable. The Queue Engine handles queue names with upper case letters. $ qclose –s nt2 QUEUE2 This example closes the queue called QUEUE2 on server computer NT2. Various queue properties can be specified when the queue is created. The –j option specifies the pending jobs limit for the new queue. Syntax qcreate [ -D “string” ] [ -k ] [ -M 0NNN ] [ -p N ] [-s ComputerName ] [ -a hh:mm -b hh:mm ] [ -m hh:mm -n hh:mm ] [ -h ] [ -? ] [ -c | -o ] [ -t | -u ] [ -C N ] [ -e N ] [ -j N ] QueueName Options The -D option specifies a description for the queue. If this environment variable is also absent. it will not accept jobs that are submitted to it. Syntax qclose [-s ComputerName] QueueName Options The –s option specifies the name of a Queue Engine server computer. with 0 being the lowest priority. The –p option specifies the priority for the new queue. When a queue is closed. and may not contain any spaces. If this option is absent. If this option is not specified. Default values are used for any attributes that are not specified. The queue name may be up to 16 characters long. The default is 128. © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide QCLOSE The QCLOSE command closes a queue. a default of 32 is used. The user may specify queue names on the command line with either upper or lower case letters. Examples $ qclose LOW_PRI This example closes the queue called LOW_PRI. This value may range from 0 to 255. QCREATE The QCREATE command creates a queue. Write. The -s option specifies the name of a Queue Engine server computer. then the command uses the value of the TABF_SERVER environment variable. then the queue is automatically opened every day at the hour and minute specified by -m and closed every day at the time specified by -n. and “18:30” means 6:30 PM. The -t and -u options specify whether the new queue is initially stopped or started. and “18:30” means 6:30 PM. Examples $ qcreate ABC This command creates a queue called ABC. a default value of 1 is used. The -C option sets the Queue Affinity to processor N. that user may submit jobs to that Queue and delete jobs from that Queue. Times are specified with these options in 24-hour time. with default values for all queue attributes. Anyone else only has Read permissions (rwxr—r--). close. for example. then the queue has no automatic open and close times. that user may list the jobs associated with the Queue. a queue is open when it is created. Limited 1991-2006 • Page 218 . “6:30” means 6:30 AM. If these options are not specified. then the command assumes the local computer. The -m and -n options specify optional automatic open and close times for the queue. If these are specified. if defined. There are read. stop or start that Queue. If this parameter is set then jobs created from this queue will only execute on processor N on an SMP machine. The -a and -b options specify optional automatic start and stop times for the queue. If this option is absent. If a user has read permissions for a Queue. Generally the owner of a Queue has Read. or root. “6:30” means 6:30 AM.Argent Job Scheduler Users Guide The –e option specifies the executing jobs limit for the new queue. All others. Typical values range from 1 to around 6 or 7. Only the owner. write. The –M option is used to set the permissions Mode of the Queue. If this environment variable is also absent. If these are specified. The mode setting follows the UNIX permission mode model (see chmod(2)). © ArgSoft Intellectual Property Holdings. The –c and -o options specify whether the queue is initially closed or open. If the user has execute permissions. If this option is not specified. Any member within the same group as the Queue owner. that user may open. If these options are not specified. and Execute permissions for that Queue. can change the permissions pertaining to a Queue. then the queue is automatically started every day at the hour and minute specified by -a and stopped every day at the time specified by -b. If the user has write permissions. for example. When a Queue is created default permissions are Read. Times are specified with these options in 24-hour time. By default. then the queue has no automatic start and stop times. Write. and Execute for the owner. By default. This value determines the maximum number of jobs that may be executing in the queue at one time. and execute permissions afforded to three different classes of user: • • • The Queue owner. a queue is started when it is created. with a priority of 80. If a job number is used instead of the name of a queue. canceling any jobs in the queue. then the command assumes the local computer. then the command uses the value of the TABF_SERVER environment variable. Syntax qdelete [-n N] [-s ComputerName] QueueName|JobNumber Options The –n option will direct the Queue Engine to delete N number of jobs beginning with JobNumber. © ArgSoft Intellectual Property Holdings. if defined. If the queue contains any executing jobs. The -s option specifies the name of a Queue Engine server computer. and an executing jobs limit of 3. a pending jobs limit of 50. QMODIFY The QMODIFY command modifies one or more of a queue’s properties.Argent Job Scheduler Users Guide $ qcreate –D “Default queue” –p 150 –j 30 –e 3 queue1 This command creates a queue called QUEUE1. and an executing jobs limit of 3. Limited 1991-2006 • Page 219 . QDELETE The QDELETE command deletes a queue. If this environment variable is also absent. Examples $ qdelete QUEUE1 This example deletes queue QUEUE1. then an error message is displayed and the queue is not deleted. $ qcreate –d “Nightly batch queue” –p 80 –j 50 –e 3 –b 8:00 –a 18:30 NIGHTLY This command creates a queue called NIGHTLY. If this option is absent. a pending jobs limit of 30. with the description “Default queue”. the QDELETE command will not delete the queue. that job will be deleted from whatever queue it is associated with. The QCANCEL utility must be used first to abort any running jobs. If the queue contains any executing jobs. The queue will automatically stop every day at 8:00 AM and start every day at 6:30 PM. a priority of 150. and “18:30” means 6:30 PM. then the command uses the value of the TABF_SERVER environment variable. for example. then the command assumes the local computer. The -U option resets the Queue Affinity to association with no particular processor. The -t and -u options stop or start the queue. The -e option specifies a new executing jobs limit for the queue. The –p option specifies the priority for the queue. and “18:30” means 6:30 PM. The -C option sets the Queue Affinity to processor N. These options require 24-hour time values. “6:30” means 6:30 AM. This value may range from 0 to 255. The default time is 1440 minutes (24 hours). The -m and -n options specify automatic start and stop times for the queue. for example. then the queue is set to automatically stop every day at the hour and minute specified by -m and starts every day at the time specified by -n. These options require 24-hour time values. The –S option disables Auto Start/Stop. If this environment variable is also absent. if defined. These options must be specified together. The –a and -b options specify automatic close and open times for the queue. If this option is absent.Argent Job Scheduler Users Guide Syntax qmodify [ -D “string” ] [ -k N ] [ -M 0NNN ] [ -s ComputerName ] [ -a hh:mm -b hh:mm | -O ] [ -h ] [ -? ] [ -m hh:mm -n hh:mm | -S ] [ -e N ] [ -j N ] [ -c | -o ] [ -t | -u ] [ -p N ] [ -C N ] [ -U ] QueueName Options The -D option specifies a new description for the queue. the queue will automatically close every day at the time specified by -a and open every day at the time specified by -b. © ArgSoft Intellectual Property Holdings. This value determines the maximum number of jobs that may be executing in the queue at one time. Once these times are set. An alternate way to stop or start a queue is to use the qstop or qstart commands. respectively. The -j option specifies a new pending jobs limit for the queue. Limited 1991-2006 • Page 220 . The default is 128. The -s option specifies the name of a Queue Engine server computer. An alternate way to close or open a queue is to use the qclose or qopen command. The –k option is used to set the number of minutes that completed jobs are retained in the queue. If they are specified. This value determines the maximum number of jobs that may be pending in the queue at one time. This value may range from 0 to 100. respectively. The –O option disables Auto Open/Close. The –c and -o options close or open the queue. “6:30” means 6:30 AM. This value may range from 0 to 1000. Typical values range from 1 to around 6 or 7. If this parameter is set then jobs created from this queue will only execute on processor N on an SMP machine. with 0 being the lowest priority. These options must be specified together. © ArgSoft Intellectual Property Holdings. then the command uses the value of the TABF_SERVER environment variable. write. it will accept jobs that are submitted to it. close. and Execute permissions for that Queue. and as long as it is not full. that user may submit jobs to that Queue and delete jobs from that Queue. if defined. that user may open. If the user has execute permissions. $ qmodify –n 7:30 –m 19:00 NIGHTLY This example modifies queue NIGHTLY so that it automatically stops at 7:30 AM every day and starts at 7:00 PM every night. stop or start that Queue. Examples $ qmodify –e 5 QUEUE2 This example changes the executing jobs limit of queue QUEUE2 to 5. Write. then the command assumes the local computer. Anyone else only has Read permissions (rwxr—r--). All others. If the user has write permissions. QOPEN The QOPEN command opens a queue. Limited 1991-2006 • Page 221 . can change the permissions pertaining to a Queue. Generally the owner of a Queue has Read. There are read. or root. Write. Syntax qopen [-s ComputerName] QueueName Options The -s option specifies the name of a Queue Engine server computer. Only the owner. When a Queue is created default permissions are Read. If a user has read permissions for a Queue. $ qmodify –p 50 CAD2 This example changes the priority of the queue CAD2 to 50. and Execute for the owner. If this option is absent.Argent Job Scheduler Users Guide The –M option is used to modify the permissions Mode of the Queue. that user may list the jobs associated with the Queue. and execute permissions afforded to three different classes of user: • • • The Queue owner. If this environment variable is also absent. The mode setting follows the UNIX permission mode model (see chmod(2)). When a queue is open. Any member within the same group as the Queue owner. The -s option specifies the name of a Queue Engine server computer. $ qopen –s aries QUEUE3 This example opens queue QUEUE3 on the server named ARIES. This is the default if no options are specified. along with the other queue information. If this option is absent. QSHOW The QSHOW command displays information about a single queue. Limited 1991-2006 • Page 222 . QREQUEUE The QREQUEUE command moves a job from one queue to another queue.Argent Job Scheduler Users Guide Examples $ qopen low_pri This example opens the queue called LOW_PRI. and all queues in the system. if defined. Syntax qshow [ -h ] [-s ComputerName] [ -a | [-j] [-e] QueueName | [ -l ] JobNumber ] Options The -a option displays all queues in the system. This option is required. Syntax qrequeue –q QueueName [-s ComputerName] JobNumber Options The -q option specifies which queue to requeue the job to. Examples $ qrequeue –q queue2 634 This example moves job number 634 from the queue that it was previously in to queue QUEUE2. a single job. If this environment variable is also absent. The -j option can be used with a queue name to display all of the jobs in the specified queue. then the command uses the value of the TABF_SERVER environment variable. or all executing jobs. © ArgSoft Intellectual Property Holdings. then the command assumes the local computer. If this environment variable is also absent. $ qshow 642 This command displays information about the job number 642.Argent Job Scheduler Users Guide The -e option displays all jobs that are currently executing in queue. which can be used only in conjunction with a JobNumber. When a queue is started. then the command assumes the local computer. $ qshow –e –s micron This command displays a list of all jobs that are currently executing on server computer MICRON. $ qshow -a This command displays a list of all queues in the system. it will execute jobs that are pending in the queue. then the command uses the value of the TABF_SERVER environment variable. displays the contents of the Log File associated with that JobNumber. If this option is absent. QSTART The QSTART command starts a queue. Examples $ qshow NIGHTLY This command displays information about the queue called NIGHTLY. if defined. and also displays a list of all jobs executing and pending in the queue. $ qshow -j NIGHTLY This command displays information about the queue called NIGHTLY. The -l option. Syntax qstart [-s ComputerName] QueueName © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 223 . $ qshow -e This command displays a list of all jobs that are currently executing in queue. The -s option specifies the name of a Queue Engine server computer. if defined. then the command assumes the local computer. which is either a command procedure or executable file. If this option is absent. it will not execute jobs that are pending in the queue. QSTOP The QSTOP command stops a queue. Examples $ qstart LOW_PRI This example starts queue LOW_PRI. If this option is absent. $ qstart –s nt2 QUEUE2 This example starts queue QUEUE2 on server computer NT2.e. QSUBMIT The QSUBMIT command submits a job to a queue. $ qstop –s nt2 QUEUE2 This example stops queue QUEUE2 on server computer NT2. Examples $ qstop LOW_PRI This example stops queue LOW_PRI. Syntax qstop [-s ComputerName] QueueName Options The -s option specifies the name of a Queue Engine server computer. If the command is being used to submit a job to a remote Queue © ArgSoft Intellectual Property Holdings. If this command is being used on the server computer. then the current directory is used if the directory path is not specified.Argent Job Scheduler Users Guide Options The –s option specifies the name of a Queue Engine server computer. the computer on which the Queue Engine service is running. When a queue is stopped. then the command uses the value of the TABF_SERVER environment variable. The job is specified by its job file. If this environment variable is also absent. Limited 1991-2006 • Page 224 . If this environment variable is also absent. if defined. i. then the command assumes the local computer. then the command uses the value of the TABF_SERVER environment variable. The -n option specifies an alternate name for the job. The time value may be in absolute or relative time format.Argent Job Scheduler Users Guide Engine server computer. which the job runs under. then the submitting user’s account is used. relative to the queue engine server computer. If this option is not used.log. if -g is not used. A password is required if the job file is located on a computer other than the Queue Engine server computer. today © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 225 . then the job’s name is derived from the filename of the job file. then the Queue Engine service appends the job’s job number to the log filename. in order that the filenames will be unique even if the base paths and filenames are the same for two different jobs. The -a option specifies a time after which the job may be started. The -g option instructs the Queue Engine service not to append the job’s job number to the log file filename. $3. By default.M. $2. and various parts of the time value may be omitted. the Queue Engine service does append the job number. The -p option allows customers to supply parameters for the job. Syntax qsubmit -q QueueName [ -p ‘Parameter String’ ] [ -s ComputerName ] [-a [[[[YYYY]MM]DD]hh]mm | +hh:mm ] [-e hh:mm ] [ -P Password -U UserName ] [ -l logFileName ] [ -g ] [ -n Name ] FilePath Options The -q option specifies the queue to submit the job to. If this option is not specified. which is set by the system administrator with the -q option of the QSYSTEM command. The –g only affects the behavior of the -l option. If this option is not specified. then the job is submitted to the default queue. Also. as in /test/job. then enclose the parameters in quotes and separate them with spaces. or the job will fail to start.log is appended to the file. must be used. The password must be correct at the time the job is started. A . The -P option specifies a password to associate with the job’s logon session when the job is executed. Parameters are used in batch files by using the special characters $1. then the job’s log file has the same name as the job file name. A password must be specified in order to run the job under an account other than the submitting users. The -U option specifies the user account. or if the job must access network resources.753. If customers need to specify more than one parameter for a job. If this option is not used. Here are some examples: Time Value 1800 Meaning 6:00 P. etc. then the full file path. The -l option specifies an alternate name for the job’s log file. The job log file created when the job executes will be called MANDEL.M. $ qsubmit -s aries /acct/payroll This example submits the batch file payroll in directory /acct to server computer aries.M. today. to be started no sooner than 6:00 P. The -s option specifies the name of a Queue Engine server computer. then the command uses the value of the TABF_SERVER environment variable. then the job will be executed every 24 hours. $ qsubmit –a 18:00 work This example submits a job called work to the default queue. if defined.JobNumber and will also be located in the /cad directory. For example. The job log file created when the job executes will be called payroll in the same directory. If this option is absent. If this environment variable is also absent. on April 3.LOG payroll This example submits the batch file payroll in the current directory to the current default queue.LOG.Argent Job Scheduler Users Guide 199404031800 +00:30 +01:30 +02:00 +24:00 +28:00 6:00 P. $ qsubmit –l /users/jonhv/PAYROLL. Note that the job file path is relative to the server computer. © ArgSoft Intellectual Property Holdings. 1994 30 minutes from now 1 hour and 30 minutes from now 2 hours from now 1 day from now 1 day and 6 hours from now The -e option specifies a time interval at which the job is repeated. then the command assumes the local computer. This means that the file path refers to directory /acct on aries. The job log file created when the job executes will be called payroll in directory /users/johnv/. if a value of “24:00” is used. Examples $ qsubmit payroll This example submits the batch file payroll in the current directory to the current default queue. Limited 1991-2006 • Page 226 . $ qsubmit –q NIGHTLY /cad/mandel This example submits the executable mandel in the cad directory to queue NIGHTLY. not on the computer where this command was entered. by default. When the batch job is executed. Most of the functions of this command are. $ qsubmit –q SYSJOBS –a 22:00 –U backupacct –P frodo –p 12345 /jobs/backup This example submits a backup job to start at 10:00 P.Argent Job Scheduler Users Guide $ qsubmit –a +2:00 work This example submits a job called work to the default queue. available only to Administrators who are logged in as root on the Queue Engine server computer. Stopping the Queue Engine service is a dangerous operation.M. the string FY94. which will run under the user account called backupacct. because all jobs that are executing when the service is stopped are terminated. $ qsubmit –q BUILDS –U tomd –P mom1234 -p 12345 /build/build1 This example submits a build job. to be started in two hours. so it is not necessary to manually start it every time the computer boots. except for the -S option.DAT. tonight. When the service is stopped. The -x option starts the Queue Engine service. QSYSTEM The QSYSTEM command allows the system administrator to control the queue system. The examples illustrate this by using the ‘#’ super user prompt where appropriate. no other the Queue Engine commands will work. can only be executed by a user with root permissions.DAT /bat/get_file This example submits a job called GET_FILE to the default queue. Limited 1991-2006 • Page 227 . The -k command stops the Queue Engine service. with a first parameter of FY94. © ArgSoft Intellectual Property Holdings. The service must be started in order for any other the Queue Engine commands to work. which will run under the user account called tomd. the Queue Engine service may be configured to start automatically at system startup. This information includes the current state of the service and the filenames of the system log file and the system settings file.DAT will be substituted for all occurrences of the character $1 within the batch file. $ qsubmit –p FY94. All options. When the product is first installed. Syntax qsystem [ -L KBytes ] [ -q QueueName | -Q ] [ -x | -k ] [ -D AAnn-AAnn-AAnn-AAnn ] [-K AAnn-AAnn-AAnn-AAnn ] [ -l ] [ -S ] [ -f N ] [ -j N ] [ -p N ] [ -r N ] [ -s ComputerName ] Options The -S option displays information about the Queue Engine service. This is the default action if no options are specified. then the command assumes the local computer. The -K option installs a new product license key. By default. This option should only be used when a representative of Argent Software Inc gives customers a license key. one with a moderate priority and executing jobs limit. This is done to allow the Queue Engine to run some validity checks on the new key before it is installed. then no new jobs are started. which are already executing may create more processes. the entire Log File is displayed. if defined. the job number is reset to 0. No checking of the key’s validity takes place. the following option can be used. that the system log file is allowed to reach. © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide The –l option displays installation and license information about a Queue Engine server computer. When the job number reaches the number set by this option. customers will want to set the default queue to a “middle of the road” queue. a queue name must be specified in order to submit a job. or one megabyte. This value may be increased or decreased depending on the amount of memory and other system resources available to the server. Note that the actual number of job processes on a Queue Engine server may temporarily exceed this limit. The -Q option clears the default queue. The –f option displays the Log File of the Queue Engine. The -p option sets the maximum number of processes among all executing jobs for the queue engine server. Limited 1991-2006 • Page 228 . If N is greater than 0. The -K option executes by communicating with the Queue Engine. If N is 0. When the file reaches the size limit. The -r option sets the jobs roll over value for the queue engine server. however. the old one is renamed and a new one is started. in kilobytes. the queue engine system log file size limit is set to 1024K. If this option is absent. If this environment variable is also absent. The -D option installs a new product license key. Examples $ qsystem -S This example displays information about the queue system. This value determines the maximum size. Usually. This option should only be used when the -K option cannot be used. the last N Kbytes of the Log File will be displayed. then the command uses the value of the TABF_SERVER environment variable. When no default queue is set. jobs. This value may be increased or decreased depending on the amount of memory and other system resources available to the server. When this number of jobs is executing on the server in all queues combined. this is the option to use. The -L option changes the size limit of the queue engine system log file. The -j option sets the maximum executing jobs value for the queue engine server. The -s option specifies the name of a Queue Engine server computer. because although no new jobs are started. When this number of processes exists for all executing jobs. The default queue is the queue that jobs are submitted to if no queue name is specified in the qsubmit command. if the Queue Engine can’t run because it needs a new license key. The -q option sets the default queue for the product. If the Queue Engine is not running because there is a license key issue. then no new jobs are started. # qsystem -x -s ARIES This example starts the queue engine service on the queue engine server computer named ARIES. # qsystem -q HIGH_PRI This example sets the default queue to HIGH_PRI. and the queue engine commands and the queue engine Main GUI functions will not work. # qsystem -c This example continues the queue engine service.Argent Job Scheduler Users Guide # qsystem -p This example will cause the queue engine service to pause. queues will not start any pending jobs. Limited 1991-2006 • Page 229 . © ArgSoft Intellectual Property Holdings. When the service is paused. dat file located in the SchedulingEngine directory. Both of these programs are described in detail in the Argent Job Scheduler Users’ Guide.dat. Under whose account will a particular command or Job be executed. © ArgSoft Intellectual Property Holdings.dat in the QueueEngine directory. the W200x programs need to know two essential pieces of information: How to contact the UNIX Queue Engine.DAT SPECIFIES THE PORT AND SERVER TYPE FOR REMOTE QUEUE ENGINES INCLUDING #VARIOUS UNIX FLAVORS #THE COMMENT LINE WHICH STARTS WITH ‘#’ AND EMPTY LINES ARE IGNORED. which can be used to queue Jobs and manage Queues. The Job Scheduler uses the Hosts. The Job Scheduler is a menu driven GUI. • • Two files are used to provide this information. These files can also be created via a text editor. there are two GUI programs that run on W200x. Limited 1991-2006 • Page 230 . The Queue Engine Main GUI is an interface designed mostly for Job and Queue management purposes. These files may be created via Dialogue Boxes in the Queue Engine Main GUI and in the Job Scheduler. and the Command Line utilities. The Queue Engine Main GUI and the Command Line utilities use the Hosts. the Queue Engine GUI. The format of the Hosts. W200x Administration In order for the W200x programs to interface with the UNIX Queue Engine. There will be a Hosts.DAT The Hosts. Besides the Command Line utilities.dat file is usually located in 2 directories.dat in the Argent\QueueEngine directory and one in the Argent\SchedulingEngine directory.dat is shown as follows: #HOSTS.Argent Job Scheduler Users Guide Appendix E: W200x and the UNIX Queue Engine This appendix provides reference information about the interaction of the UNIX Queue Engine with the W200x Job Scheduler. HOSTS. which provides the user with a powerful interface to create and schedule Jobs. The file that contains the account information used to queue and control jobs is called Users. W200x Facilities The UNIX Queue Engine is a peer to the Queue Engine that runs on W200x.dat. The file that contains the contact information necessary to connect to the UNIX Queue Engine is called Hosts. These GUI programs are the Argent Job Scheduler. and the Argent Queue Engine Main GUI. #SERVER PORT TYPE MADRIVER SKYWAY WILDCAT 3000 3000 3000 SUN SUN SUN Figure 0-1. press the “System” menu button on the Queue Engine Main GUI or the “Settings” menu button on the Job Scheduler. THEY ARE ‘SERVER’.Hosts. If the Port Number has been modified on the UNIX side via the /etc/services file or NIS interface. the menu value will have to be adjusted accordingly.Dat Format The server name will have to be in the LMHOSTS file that is used/imported by enabling LMHOSTS lookup in the TCP/IP WINS menu1. The TCP/IP port 3000 is the default port that is used by the UNIX Queue Engine. If LMHOSTS lookup is not enabled. Select TCP/IP and hit the Properties button. © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide #THE FORMAT OF EACH LINE HAS THREE COLUMNS. Next right clicking on “Local Area Connection” and selecting Properties brings up the Properties menu. an IP address can be used. Limited 1991-2006 • Page 231 . If customers choose to use the Program Dialogue Box. This will cause a Dialogue Box to appear (See Figure 2). ‘PORT’ AND ‘TYPE’ #SEPERATED BY ONE OR MORE TAB CHARACTERS. Hit the “Advanced” button and customers can get top the WINS menu tab from there. Select “Remote/UNIX Server Management”. 1 This is found by right clicking “My Network Places” on the desktop and selecting Properties. Argent Job Scheduler Users Guide Figure 0-2 . The Job Scheduler uses the Users. #THE FORMAT OF EACH LINE HAS FOURS COLUMNS. THE PLAIN TEXT PASSWORD CAN BE #SPECIFIED IN THE FORMAT OF ‘#PLAIN_PASSWORD#’ #THE NT ACCOUNT IS SPECIFIED IN THE FORMAT OF ‘NT_DOMAIN\NT_LOGON_USER’ #THE UNIX ACCOUNT IS SPECIFIED IN THE FORMAT OF ‘DOMAIN\ACCT’ IF THERE IS A DOMAIN #INVOLVED #NT_ACCOUNT UNIX_SERVER UNIX_ACCOUNT PASSWORD dev\stephenr dev\stephenr dev\stephenr SKYWAY wildcat MADRIVER dev\swr dev\swr dev\swr ‡œ‰”ž– ‡œ‰”ž– ‡œ‰”ž– Figure 0-3 . Limited 1991-2006 • Page 232 . #THE COMMENT LINE WHICH STARTS WITH ‘#’ AND EMPTY LINES ARE IGNORED. THEY ARE ‘NT_ACCOUNT’ ‘UNIX_SERVER’.dat in the QueueEngine directory. #THE PASSWORD COLUMN IS NORMALLY ENCRYPTED. press the “New” button. The Queue Engine Main GUI and the Command Line utilities use the Users. #’UNIX_ACCOUNT’ AND ‘PASSWORD’ SEPERATED BY ONE OR MORE TAB CHARACTERS.DAT The Users. The format of the Users.Users. These files can also be created via a text editor.dat is shown as follows: #USERS.Hosts.dat file is usually located in 2 directories. There will be a Users.Dat Dialogue Box To insert a new host entry.Dat Note: The W200x Account must contain the domain name (or server name) as well as the user account ID in order to connect properly with the UNIX Queue Engine © ArgSoft Intellectual Property Holdings.dat in the Argent\QueueEngine directory and one in the Argent\SchedulingEngine directory. Enter the information and then press the “Save” button.DAT SPECIFIES THE ACCOUNT TRANSLATION BETWEEN NT ACCOUNT AND UNIX ACCOUNT. These files may be created via Dialogue Boxes in the Queue Engine Main GUI and in the Job Scheduler. USERS.dat file located in the SchedulingEngine directory. The UNIX Queue Engine uses the encrypted password.Dat Dialogue Box To enter a new account. Bringing up the Hosts. © ArgSoft Intellectual Property Holdings. in this case “dev”.Argent Job Scheduler Users Guide The “domain” portion of the UNIX Account. sending plain text over a network creates a potential security leak. Limited 1991-2006 • Page 233 . Putting in a “plain text” password will not work with the Queue Engine.Dat Dialogue Box and then clicking on the “Account” menu tab opens the UNIX Account Dialogue Box. press the “New” button. In addition. is not used by the UNIX Queue Engine.Users. Enter the information and then press the “Save” button. The program interfacing with the Dialogue Box encrypts the password. The user should generate this file by using the Dialogue Box. Figure 0-4 . monitoring. monitor. The Argent iSeries Job Adapter allows customers to: Submit jobs for processing Hold jobs that need special attention Release jobs that have been held Hold and release iSeries job queues Monitor each submitted job all the way through execution to completion Retrieve generated spooled file output. Available Functionality Used in conjunction with the Argent Job Scheduler engine. and manage iSeries jobs. and managing iSeries jobs require that the Argent iSeries Job Adapter be active and available at all times. Limited 1991-2006 • Page 234 . the Argent iSeries Job Adapter allows customers to submit. It is implemented as a non-stop server process that is expected to be running continuously in the background on customer systems. including job logs • • • • • • © ArgSoft Intellectual Property Holdings. Submitting. It accepts and validates incoming requests from an Argent Job Scheduler engine and helps submit.Argent Job Scheduler Users Guide Appendix F: Argent iSeries Job Adapter Introduction The Argent iSeries Job Adapter is a native TCP/IP server program running on iSeries servers. and manage iSeries batch jobs. monitor. The Worker process interacts directly with the iSeries operating system to manage iSeries jobs. and security. reliability. The Listener The Listener process is responsible for managing the connections between an iSeries server and the Argent Job Scheduler. The Worker process stays connected to the Argent Job Scheduler engine for as long as needed. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 235 . The Listener checks to make sure that only permitted connections are allowed to complete. When the Listener process detects a valid connection request from an Argent Job Scheduler. It checks continually to make sure that everything is running smoothly and that the other two processes are doing their jobs. It is responsible for making sure the Argent iSeries Job Adapter starts and runs properly. control iSeries job queues and manage generated spooled file output.Argent Job Scheduler Users Guide The Three Scheduler Processes The Argent iSeries Job Adapter runs on iSeries servers as three processes: The Monitor Daemon The Listener The Worker process that handles requests from the Argent Job Scheduler • • • Each of these processes has a specialized role and has been developed to meet the highest standards of product quality. The Monitor Daemon The Monitor Daemon is a “watchdog” process. it hands off control to a Worker process. The Worker The Worker process is responsible for doing the all the iSeries work needed by an Argent Job Scheduler. It also makes sure that the TCP/IP addresses on all incoming Job Scheduler requests meet defined policy for access. Argent Job Scheduler Users Guide Appendix G: Configuring the Argent iSeries Job Adapter Prior to using the Argent iSeries Job Adapter. Using CFGARGJSA During Installation While CFGARGJSA has many parameters. issuing the CFGARGJSA LICKEY(‘DEMO’) command by itself will configure the scheduler using the default settings. you’ll need to configure it to run on your system. port 3012 is available for use © ArgSoft Intellectual Property Holdings. Customers wishing to adjust the scheduler settings after getting started should refer to the following sections. The CFGARGJSA command simply gathers and stores some of your preferences about how the Argent Job Scheduler Adapter should operate on your system. For most installations. this will be sufficient. To do this you’ll need to use the CFGARGJSA command. PORT(nnnnn) The PORT parameter tells the adapter which TCP/IP port number to use when listening for incoming connections. Typically. The allowed values for this parameter are in the range 1024 through 65535. Limited 1991-2006 • Page 236 . CFGARGJSA Command Syntax The CFGARGJSA command has the following syntax: CFGARGJSA PORT(nnnnn) LOGLVL(log level) LOGSIZ(log file size) JOBD(job description name library/name) MSGQ(message queue library/name) ALWIPADDR(list of allowed IP addresses) ALWHOSTS(list of allowed Job Scheduler engine host names) LICKEY(license key) CFGARGJSA Command Parameters Each parameter in the command has a specific meaning as described in this section. The default value is 3012. In the case that you have difficulties connecting the Argent Job Scheduler to the Argent iSeries Job Adapter. including information about the status of internal adapter operations and important calculations and results. Limited 1991-2006 • Page 237 . The LOGSIZ parameter specifies the largest size of each member within log file LOG. *VERBOSE This value directs the adapter to the most extensive messages possible. *NORMAL This value directs the adapter to store routine messages about normal operations as well as messages about potential error conditions. There are four values supported: *NONE This value limits log messages to the very fewest possible. Each log file member within the LOG file has a member name that follows the naming convention “Myymmddnnn” where M is the letter M. the LOGSIZ parameter is expressed in bytes. Similar to many IBMprovided system values.Argent Job Scheduler Users Guide by the Argent iSeries Job Adapter. This log file is comparable to the iSeries system history logs. it may be necessary to use a different port number. The default value for the LOGLVL parameter is *NONE. © ArgSoft Intellectual Property Holdings. LOGLVL(log level) The LOGLVL parameter tells the adapter how much detail to include in the messages written to the Argent iSeries Job Adapter log file. The name of the Argent iSeries Job Adapter log file is LOG and it is stored in the production installation library ARGSCHED. yymmdd is the date the log file member was created. *DETAILED This value directs the adapter to write extensive messages. LOGSIZ(log file size) The LOGSIZ parameter tells the adapter how large each Argent iSeries Job Adapter log file member can grow before it will be closed and a new log file member will be opened for logging. The Argent iSeries Job Adapter log file contains routine messages about normal operation of the adapter as well as messages that can help identify potential problems. and nnn is a sequence number starting at 001 and ranging up to 999. This value is typically used only on the advice of qualified Argent support personnel in problemdetermination or troubleshooting scenarios. 1. Additionally. you can specify generic values using the wildcard character (“*”). *ANY is usually a good choice to get started with your new software. Limited 1991-2006 • Page 238 . It is common for iSeries system administrators to want to route messages about a system monitoring product like the Argent iSeries Job Adapter to a message queue other than *SYSOPR. which tends to make important messages like Argent’s harder to find. The default for this parameter is the special value *ANY.100 through 192. many applications send messages to *SYSOPR.1. The default for this parameter is the special value *SYSOPR.1. In some environments. you can specify the generic value 192. As with simple list element values.16.Argent Job Scheduler Users Guide JOBD(job description library/name) The JOBD parameter tells the adapter which job description to use to submit work for iSeries processing.16. Generic values are a useful way to specify a group of IP addresses that are allowed. After the adapter has been installed and running smoothly. MSGQ(message queue library/name) The MSGQ parameter tells the adapter which message queue to use to send and store informational and other messages about the operations of the Argent iSeries Job Adapter. you can use the CRTMSGQ command to create a separate message queue and then specify the message queue name and the library name of that message queue in this parameter. If more than one value is specified. The default value for this parameter is *LIBL/ARGSCHED. generic values must be enclosed in single quotes and separated by a space. ALWIPADDR(list of allowed IP addresses) The ALWIPADDR parameter allows you to restrict access to the Argent iSeries Job Adapter. each value must be enclosed in single quotes separated by spaces. *SYSOPR is interpreted by the adapter to mean message queue QSYSOPR in library QSYS. Up to sixteen (16) values can be specified for this parameter. This parameter provides the adapter with a list of IP addresses which are allowed to connect to your Argent iSeries Job Adapter.16. The default value is appropriate in most situations and should only be changed if the distributed Argent work management objects are not suitable in your iSeries IT environment.1*. In that case. © ArgSoft Intellectual Property Holdings. Simple values and generic values can be used together as list elements for this parameter. the system administrator for your iSeries machine should change this value to specify a list containing only the IP addresses that are authorized to connect. To specify that all the IP address in the range 192. If more than one value is specified. The *ANY special value is interpreted by the adapter to mean that any Job Scheduler engine is allowed to connect to your Argent iSeries Job Adapter.199 are allowed to connect to your Argent iSeries Job Adapter. the *ANY special value is disallowed. After the software has been installed and running smoothly. A license key is needed to activate the software. After the evaluation period. If more than one value is specified. you’ll need to contact Argent Software to acquire a full product license key. This parameter provides the adapter with a list of Job Scheduler engine platform names which are allowed to connect to your Argent iSeries Job Adapter. you use the special value DEMO to activate the software for an evaluation period of thirty (30) days.Argent Job Scheduler Users Guide Note: Using the *ANY special value or generic values containing the wildcard character can potentially reduce the security of your Argent iSeries Job Adapter. © ArgSoft Intellectual Property Holdings. the *ANY special value is disallowed. The default for this parameter is the special value *ANY. LICKEY(license key) The Argent iSeries Job Adapter is a licensed software program product. The *ANY special value is interpreted by the adapter to mean that any Job Scheduler engine is allowed to connect to your Argent iSeries Job Adapter. Please consult with your network administrator to be sure you have the best balance between configuration simplicity and network security. Use the CFGARGJSA command with the LICKEY parameter to configure the license key. ALWHOSTS(list of allowed Job Scheduler engine hosts) The ALWHOSTS parameter allows you to restrict access to the Argent iSeries Job Adapter. each value must be enclosed in single quotes separated by spaces. If more than one value is specified. The LICKEY parameter configures adapter license. If you’ve downloaded a trial version of the software. Up to sixteen (16) values can be specified for this parameter. *ANY is usually a good choice to get started with your new software. the system administrator for your iSeries machine should change this value to specify a list containing only the Job Scheduler engine hosts that are allowed to connect. Limited 1991-2006 • Page 239 . 221.10’) LOGSIZ(1000000) ALWHOSTS(‘*ANY’) LOGLVL(*NORMAL) is identical to the example shown previously.16.223 65.16. Experienced iSeries system administrators and users will recognize that the CFGARGJSA is like any other command object in that the order of the keywords is unimportant. The license key for the product will be configured as AA11-BB22-CC33-DD44.223’ ’65.16.16. Job Scheduler engines will be allowed to connect to Any system in the range 192. © ArgSoft Intellectual Property Holdings.221.10*’ ‘172.10*’ ‘172.1.1.16.1.10 Connection attempts from any other IP address will be rejected Any Job Scheduler engine name connecting from one of the valid IP addresses will be accepted.16.55.16.000.16.223’ ’65.1.100 through 192.221. Limited 1991-2006 • Page 240 . The sample command shown below: CFGARGJSA MSGQ(SYSADMIN/CRITMSGS) PORT(3012) JOBD(*LIBL/ARGSCHED) LICKEY(‘AA11-BB22-CC33-DD44’) ALWIPADDR(‘192.10’) ALWHOSTS(‘*ANY’) LICKEY(‘AA11-BB22-CC33-DD44’) This sample command is interpreted as follows: The port number used will be 3012.000 bytes The job description the adapter will use to submit work for processing will be job description ARGSCHED on the Argent iSeries Job Adapter library list (*LIBL) Information and notification messages generated by the adapter will be sent to message queue CRITMSGS in library SYSADMIN.55.199 172.Argent Job Scheduler Users Guide Sample CFGARGJSA Command A sample CFGARGJSA command is shown below: CFGARGJSA PORT(3012) LOGLVL(*NORMAL) LOGSIZ(1000000) JOBD(*LIBL/ARGSCHED) MSGQ(SYSADMIN/CRITMSGS) ALWIPADDR(‘192.16. The level of detail for log messages will be *NORMAL The maximum size of each log file member will be 1.16.55. Values that you specify on the command line before pressing F4 are accepted by the command prompter. Limited 1991-2006 • Page 241 . CFGARGJSA implements the IBM-provided iSeries command interpreter support. When the user presses F4 to invoke the command prompter. the user supplied the LOGLVL(*VERBOSE) parameter value from the command line. none. Values that you do not specify are supplied from the existing configuration. You can type some. For those customers. Some customers are more familiar with using the iSeries command prompter to help issue commands. The iSeries command prompter is not required. the following display is shown: © ArgSoft Intellectual Property Holdings. or all of the command keyword parameters and then press F4 to invoke the system command prompter.Argent Job Scheduler Users Guide Using the iSeries Command Prompter with CFGARGJSA CFGARGJSA works directly from any iSeries command line. As example of this is shown below: In this example. The Job Scheduler Adapter for iSeries is designed to run properly “out-of-the-box” using default values for the configuration elements just described. the LICKEY parameter must be specified once to activate the product license before first use. when needed. Argent recommends changing the adapter configuration only when system operational schedules allow for the adapter to be ended and re-started. Limited 1991-2006 • Page 242 . Other values supplied from the existing configuration are not highlighted. © ArgSoft Intellectual Property Holdings. When CFGARGJSA is used at any other time. This may be a convenient way to get started. but they are not read in by the Argent iSeries Job Adapter until the next time the adapter is ended and re-started. the values are stored in the configuration immediately. You can always change the configuration at a later time. When to Use CFGARGJSA CFGARGJSA must be used at least one time prior to running the adapter for the first time. To avoid confusion. At a minimum.Argent Job Scheduler Users Guide Notice that values supplied from the command line before pressing F4 are highlighted by the command prompter using the “>” character. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 243 .Argent Job Scheduler Users Guide Including CFGARGJSA in Your Programs Because CFGARGJSA is a command object. Getting Started with CFGARGJSA To keep things as simple as possible. provide a valid license key for the LICKEY parameter and press ENTER. CFGARGT can be invoked from the command line. Since the Argent iSeries Job Adapter configuration changes very rarely. This will provide a valid Argent iSeries Job Adapter configuration that will be suitable for your initial implementation and verification of the adapter functionality. it can be included in C/L programs that your IT system administrators and developers might need to automate or standardize the operation of the Argent XT for iSeries Agent. Argent recommends simply typing CFGARGJSA from a command line and pressing F4. Accept the defaults. submitted as a batch job. or invoked from a High Level Language (HLL) program. this capability is generally not needed. included in a C/L program. Argent Job Scheduler Users Guide Appendix H: The iSeries ARGSCHED Subsystem A subsystem description object is supplied with the Argent iSeries Job Adapter. Note: Only advanced iSeries work management experts should change or modify the ARGSCHED subsystem description object. The subsystem is named ARGSCHED and resides in library ARGSCHED. Argent strongly recommends that you perform your initial deployment and testing using the ARGSCHED subsystem. If the Argent iSeries Job Adapter is active at the time the ENDSBS command or the PWRDWNSYS command is issued. When you issue the ENDSBS ARGSCHED command or the PWRDWNSYS command. Limited 1991-2006 • Page 244 . © ArgSoft Intellectual Property Holdings. This subsystem description object contains a job queue entry specifying a job queue named ARGSCHED. The messages sent to the Argent iSeries Job Adapter message queue and the log file will reflect this. The ARGSCHED subsystem contains an auto-start job entry which invokes the Argent iSeries Job Adapter. The default job description object is also named ARGSCHED and references job queue ARGSCHED. the resulting termination of the adapter is considered to be abnormal. the subsystem will end in accordance with IBM’s design and documentation for these commands. the ARGSCHED subsystem is started. When you issue the STRSBS ARGSCHED/ARGSCHED command. When you first install and configure the Argent iSeries Job Adapter. and the Argent iSeries Job Adapter is started automatically. It is suitable for use in most environments and is compatible with your existing system management policies. . . . . . . . . . . . . . . . . . .ibm. . . . . . . please reference the IBM documentation at: http://publib. : TX*/ /* Owner . . . . . .htm Retrieving the C/L Source You can use the RTVCLSRC PGM(QSYS/QSTRUP) SRCFILE(QGPL/QCLSRC) SRCMBR(*PGM) command to retrieve the source for the IPL start up program and edit the source using the WRKMBRPDM FILE(QGPL/QCLSRC) MBR(QSTRUP) command. . . . . . . . : S000039122 SM*/ /* Source file change */ /* date/time . . . . . . . . : QSTRUP PN*/ /* Library name . . . . . . . . . . . . . . . . . Before beginning any activities described in this section. . : PC*/ /* Patch APAR ID . . : QSYS OW*/ /* Patch change ID . . . . . .com/iseries/v5r1/ic2924/index. . : $BLDSS1 SL*/ /* Original source member . . . . . : QSYS PL*/ /* Original source file . . . . . . . : *NOPATCH PO*/ /* User profile . . . . . . . . : PA*/ © ArgSoft Intellectual Property Holdings.boulder. . . . Limited 1991-2006 • Page 245 .htm?info/rzal2/rzal2chgiplstartup. This section also assumes the availability of the IBM-provided source code editing tools and the Control Language (C/L) compiler. . . . . . . . . . . . . . . IBM’s documentation for the iSeries shows how to modify the IPL start up program. . . .Argent Job Scheduler Users Guide Modifying the iSeries IPL Start Up Program This section is intended for use by advanced iSeries system programming and administration experts only and should not be used without the involvement and agreement of the security officer and IT administrators for your system. . . . . . . . . . . . . . : 11/30/03 20:06:43 SC*/ /* Patch option . . . . The source member should appear similar to the following: /********************************************************************/ /* */ /* 5722SS1 V5R3M0 040528 RTVCLSRC Output 01/09/06 14:49:03 */ /* */ /* Program name . . : *USER UP*/ /* Text . . . . : S000039122 SN*/ /* Library name . . . . . . . . . . . . . Argent Job Scheduler Users Guide /* User mod flag . . . . 2000. . . . . . Modifying the C/L Source The change that’s needed is simply to insert the following two lines in the program immediately after the NOWTRS: tag and before the RETURN statement: QSYS/STRSBS SBSD(ARGSCHED/ARGSCHED) MONMSG MSGID(CPF0000) After successfully making the source code change. . . : *NO UM*/ /* ED*/ /********************************************************************/ PGM DCL VAR(&STRWTRS) TYPE(*CHAR) LEN(1) DCL VAR(&CTLSBSD) TYPE(*CHAR) LEN(20) DCL VAR(&CPYR) TYPE(*CHAR) LEN(90) VALUE('5722-SS1 (C) COPYRIGHTIBM CORP 1980. . . you will need to change and re-compile this program. the relevant segment of the program should look like this CALL PGM(QSYS/QWCSWTRS) MONMSG MSGID(CPF0000) © ArgSoft Intellectual Property Holdings. LICENSED MATERIAL .PROGRAM PROPERTY OF IBM') QSYS/STRSBS SBSD(QSERVER) MONMSG MSGID(CPF0000) QSYS/STRSBS SBSD(QUSRWRK) MONMSG MSGID(CPF0000) QSYS/RLSJOBQ JOBQ(QGPL/QS36MRT) MONMSG MSGID(CPF0000) QSYS/RLSJOBQ JOBQ(QGPL/QS36EVOKE) MONMSG MSGID(CPF0000) QSYS/STRCLNUP MONMSG MSGID(CPF0000) QSYS/RTVSYSVAL SYSVAL(QCTLSBSD) RTNVAR(&CTLSBSD) IF COND((&CTLSBSD *NE 'QCTL QSYS ') *AND (&CTLSBSD *NE'QCTL QGPL ')) THEN(GOTO CMDLBL(DONE)) QSYS/STRSBS SBSD(QINTER) MONMSG MSGID(CPF0000) QSYS/STRSBS SBSD(QBATCH) MONMSG MSGID(CPF0000) QSYS/STRSBS SBSD(QCMN) MONMSG MSGID(CPF0000) DONE: QSYS/STRSBS SBSD(QSPL) MONMSG MSGID(CPF0000) QSYS/RTVSYSVAL SYSVAL(QSTRPRTWTR) RTNVAR(&STRWTRS) IF COND(&STRWTRS = '0') THEN(GOTO CMDLBL(NOWTRS)) CALL PGM(QSYS/QWCSWTRS) MONMSG MSGID(CPF0000) NOWTRS: RETURN CHGVAR VAR(&CPYR) VALUE(&CPYR) ENDPGM To modify your system’s IPL start up program to automatically start the ARGSCHED subsystem. Limited 1991-2006 • Page 246 . and the Argent iSeries Job Adapter will automatically start. Limited 1991-2006 • Page 247 .Argent Job Scheduler Users Guide NOWTRS: QSYS/STRSBS SBSD(ARGSCHED/ARGSCHED) MONMSG MSGID(CPF0000) RETURN CHGVAR VAR(&CPYR) VALUE(&CPYR) Re-Compiling IPL Start Up Program After you end your edit session. you can compile the program with the following command: CRTCLPGM QSYS/QSTRUP QGPL/QCLSRC The next time your system is re-IPL’ed. the ARGSCHED subsystem will be started. © ArgSoft Intellectual Property Holdings. Argent Job Scheduler Users Guide Appendix I: Job Scheduler Adapter for iSeries Operations This section describes routine operations of the Argent iSeries Job Adapter. To start the Argent iSeries Job Adapter manually when the ARGSCHED subsystem is active. when the ARGSCHED subsystem is already active. but the adapter has been previously ended. Starting the Argent iSeries Job Adapter The Argent iSeries Job Adapter can be started in one of two ways: Automatically started when the ARGSCHED subsystem is started Manually. Limited 1991-2006 • Page 248 . but the adapter has been ended. To start the Argent iSeries Job Adapter automatically follow the guidelines in the previous section. use the STRARGJSA command as shown in the example below: © ArgSoft Intellectual Property Holdings. Note: If the scheduler is already active. The message should look similar to the following example: Argent Job Scheduler Adapter has been submitted for processing.Argent Job Scheduler Users Guide The system will respond with an informational message confirming that the scheduler has been started. Limited 1991-2006 • Page 249 . the STRAGRJSA command will respond with an informational message similar to the following example: Argent Job Scheduler Adapter is not ENDED. © ArgSoft Intellectual Property Holdings. The STRARGJSA command takes no parameters and can be issued from a command line or incorporated into a High Level Language (HLL) program such as a C/L program. As display similar to the example below is shown: In this example. depending on the exact request from the Job Scheduler engine. © ArgSoft Intellectual Property Holdings. the Daemon Monitor. there are two jobs active in the ARGSCHED subsystem. The first one to take note of is JSASCHED. the Listener process. This is the Daemon Monitor process described earlier in this document. When the Job Scheduler engine has ceased issuing commands and has disconnected from the Argent iSeries Job Adapter. either automatically or manually. JSASCHED. The other job is JSAMAIN. JSAMAIN.Argent Job Scheduler Users Guide Recognizing When the Argent iSeries Job Adapter is Active Once you have started the Argent iSeries Job Adapter. Limited 1991-2006 • Page 250 . spends most of its time in a SIGW state. This is normal and shows that the Argent iSeries Job Adapter is active and operating normally. the JSAWORK job will end. This is the Listener process described earlier. It will operate normally in a variety of states. When a Job Scheduler engine has connected and has issued at least one request. the JSAWORK job will be present in the ARGSCHED subsystem. you can view the status of the adapter by using the WRKACTJOB command. spends most of its time in a TIMW state. Advanced iSeries system administrators and managers may want to consider adding library ARGSCHED to the system library list. The Argent iSeries Job Adapter is ended when the PWRDWNSYS command is used to shut down your iSeries system. An example of how to use the ADDLIBLE ARGSCHED command has been described in an earlier section of this document. Limited 1991-2006 • Page 251 . That procedure is described later in this document. The Argent iSeries Job Adapter is ended when the ENDARGJSA command is issued.Argent Job Scheduler Users Guide Ending the Argent iSeries Job Adapter The Argent iSeries Job Adapter can be ended in one of three ways. To use the ENDARGJSA command. The Argent iSeries Job Adapter is ended when the ENDSBS ARGSCHED command is used to end the ARGSCHED subsystem. the resulting termination is seen by the system as an abnormal termination and corresponding messages will be sent to the Argent iSeries Job Adapter message queue and the log file. An example of the ENDARGJSA command is shown below: © ArgSoft Intellectual Property Holdings. start by using the ADDLIBLE to make sure that the ARGSCHED library is on the library list for your terminal display session. As noted previously. when either the ENDSBS ARGSCHED command or the PWRDWNSYS command is used to end the Argent iSeries Job Adapter. The ENDARGJSA command takes no parameters. Limited 1991-2006 • Page 252 . If desired. you can verify that the Argent iSeries Job Adapter has ended by using the WRKACTJOB command. The display should appear similar to the example below: © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide When the ENDARGJSA command is issued an informational message about the result of the command is issued. The message should appear similar to the example below: Argent Job Scheduler Adapter end request has been submitted. Argent Job Scheduler Users Guide Notice that. Many iSeries system administrators have a C/L or other High Level Language (HLL) program that automates the steps needed to initiate an orderly shut down of the iSeries system. or the JSAWORK job. This helps ensure that the Argent iSeries Job Adapter will be started each and every time your iSeries system is IPL’ed. Limited 1991-2006 • Page 253 . Advanced Topics: Automating the Start Up and Shut Down Argent recommends that you consider modifying the system IPL Start Up program to automatically start the ARGSCHED subsystem. The relevant lines of code would be as follows: … ADDLIBLE ARGSCHED © ArgSoft Intellectual Property Holdings. In addition. the ARGSCHED subsystem no longer contains either the JSASCHED job. after a normal termination of the Argent iSeries Job Adapter. the JSAMAIN job. Argent recommends that you consider implementing the ENDARGJSA command in such a program. Limited 1991-2006 • Page 254 .Argent Job Scheduler Users Guide ENDARGJSA DLYJOB DLY(5) ENDSBS ARGSCHED This line is recommended for the adapter to end normally. © ArgSoft Intellectual Property Holdings. Change the ARGSCHED job description object in library ARGSCHED so that it takes advantage of the first change. there have been references to the ADDLIBLE ARGSCHED command. The following display is shown: © ArgSoft Intellectual Property Holdings. To do this.Special Library List Considerations In several places in this document. Over time.Argent Job Scheduler Users Guide Appendix L: Job Scheduler Adapter for iSeries . Changing the QSYSLIBL System Value You can change the QSYSLIBL system value by using the WRKSYSVAL QSYSLIBL command. Once you have implemented the Argent iSeries Job Adapter and deployed it in a production environment. Limited 1991-2006 • Page 255 . you may want to consider making a permanent change to the system library list. you will need to make two changes: Change the QSYSLIBL system value to include library ARGSCHED. many iSeries system administrators prefer making a permanent change to the system so as to avoid these extra keystrokes. Limited 1991-2006 • Page 256 . The following display is shown: © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide Type Option 2=Change to initiate the change. © ArgSoft Intellectual Property Holdings... The message should appear similar to the example shown below: System value QSYSLIBL changed from QSYS Press F3=EXIT to end the WRKSSYVAL command.Argent Job Scheduler Users Guide You can type the name of the ARGSCHED library on the first available line after the last one on the display as highlighted above. Limited 1991-2006 • Page 257 . you can simply press <Enter>. QSYS2 QUSRSYS . A confirmation message will be shown near the bottom of the terminal display session. Once you have completed making the change. these APIs were distributed in library QGY. Prior to V5R3M0.Argent Job Scheduler Users Guide Changing the ARGSCHED Job Description To make the companion change to the ARGSCHED job description in library ARGSCHED. IBM began distributing many OS-level APIs in library QSYS. Depending on your system administrator’s policies. If you are running V5R2 or an earlier release of the operating system. you can use the above guide to adding ARGSCHED to the QSYSLIBL system value. These APIs are critical for the successful operation of the Argent iSeries Job Adapter. you may need to make a change to the QSYSLIBL system value comparable to the change described in the previous section for library ARGSCHED. Limited 1991-2006 • Page 258 . Depending on the release level of your operating system. An example of an appropriate CHGJOBD command would be: CHGJOBD ARGSCHED/ARGSCHED INLLIBL(QTEMP QGPL QGY) © ArgSoft Intellectual Property Holdings. simply issue the following command: CHGJOBD ARGSCHED/ARGSCHED INLLIBL(QTEMP QGPL) Special Issues for V5R2 and Earlier Releases On V5R3M0. making sure that library QGY is also part of the QSYSLIBL system value. you also have the option of making a change to the ARGSCHED job description in library ARGSCHED comparable to the change described above. Argent Job Scheduler Users Guide Appendix M: Argent iSeries Job Adapter Messages The Argent iSeries Job Adapter generates messages about the progress and operation of the adapter. the name of this message queue will typically be *SYSOPR. Limited 1991-2006 • Page 259 . This value is interpreted by the Argent iSeries Job Adapter as message queue QSYSOPR in library QSYS. To view the messages generated by the Argent iSeries Job Adapter. When you first install and configure the adapter. use the following command: DSPMSG QSYSOPR ASTLVL(*INTERMED) An example of the resulting display is shown below: © ArgSoft Intellectual Property Holdings. These messages are sent to the message queue named defined in the adapter configuration. the F1=HELP key is available to display detailed information about the particular message. This might be due to things like an unexpected disconnection by a Job Scheduler engine due to a network or system failure. All messages generated by the Argent iSeries Job Adapter are clearly identifiable. for example. To use this feature of DSPMSG. messages are generated when an unexpected or unusual condition occurs. In addition. simply position the display session cursor anywhere on the line desired and press F1=HELP.Argent Job Scheduler Users Guide Normal. A display similar to the following is shown: © ArgSoft Intellectual Property Holdings. informational messages are generated each time the Argent iSeries Job Adapter starts or ends. All messages generated by the Argent iSeries Job Adapter have the three-letter prefix “JSA” and are stored in message file object JSAMSGF. Limited 1991-2006 • Page 260 . Whenever you use the DSPMSG command to view the contents of a message queue. Argent Job Scheduler Users Guide Note that. the message is clearly identifiable as a message generated by the Argent iSeries Job Adapter because it has the prefix “JSA” and the source of the message is clearly identified within the message text itself. © ArgSoft Intellectual Property Holdings. in the above example. Limited 1991-2006 • Page 261 . Argent Job Scheduler Users Guide Appendix N: Argent iSeries Job Adapter Service Log The Argent iSeries Job Adapter stores information about the internal processing performed by the adapter in a service log file. To view the service log. The Argent iSeries Job Adapter log file is named LOG and resides in library ARGSCHED. © ArgSoft Intellectual Property Holdings. Limited 1991-2006 • Page 262 . you can use the F19=LEFT and F20=RIGHT command keys to window left or right to view information not immediately visible on your terminal display session. A display similar to the following is shown: You can use the PAGE UP and PAGE DOWN keys to scroll forward and backward through the log file. In addition. use the DSPPFM ARGSCHED/LOG *LAST command. 164 Every Definition 110 Every Definitions 103 Execute Manual Rollover 113 Executing Jobs Limit 138. Limited 1991-2006 • Page 263 . 156 B Background Jobs 190 Backup Database 112 Backup Node 131 Bell Alerts 67 C Calendar Definition 100 Calendars 98 Calendars Window 99 Command Qualifiers 167. 156 Exit Code Handling 46 F Fault Tolerance and Backup Nodes 190 File Dependency 40 Font Convention i G Global String Macros 94 Guardian Alerts 72 Guest Accounts 142 GUI Options 121 H Holiday Definitions 108 Holidays Definition 110 Home Path 119 How a Queue Engine Executes Jobs 54 How the queue engine Executes Jobs 139. 202 Components of a Batch Job 20 Configuration Options 118 Connecting to Queue Engine Servers 30 CPU Affinity 129 Create Job Forecast 115 D Database 119 Defining Alert Macros 83 Defining Email Macros 80 Defining Global String Macros 95 Defining Job Sequence Macros 91 Defining Pager Macros 77 Defining Queue Macros 88 Defining User Macros 85 Definitions 14 Delete Job’s Log When Job Is Deleted 121 Discard Incomplete Record 121 Display Session Manager Registry Warning at Startup 122 Do not Monitor Job CPU Time 48 Document Conventions 167. 138.Argent Job Scheduler Users Guide Index A Abort Job if Waiting for Keyboard Input 48 About This Document i Accessing Network Shares from Command Procedures 153 Additional Buttons of The Argent Job Scheduler 4 Advanced Pager Setup 65 Alert Definitions 57 Alert Description Window 58 Alert Macros 82 Alert Notifications 46 Archive Job List 117 Automatic Starting and Stopping of Queues 34. 157 How to access Alert Definitions 57 How to access Calendars 98 How to access Job Classes 36 How to access Macros 74 How to access Queue Engine Servers 29 © ArgSoft Intellectual Property Holdings. 202 Domain Administrator Group Privileges 5 Downloading The Argent Job Scheduler 6 E Ease of Use 3 Edit Job Class Table 114 Email Alerts 59 Email Macros 79 Email Options 122 Error 1069 142 Error Handling in Command Procedures 151. 208 QMODIFY 175. 157 L List of Job Definitions Window 39 Log Screen Width 120 Log Size Limit 121 M Macros 74 Macros Window 75 Managing The Argent Job Scheduler Service 17 Max Executing Jobs 34 Max Pending Jobs 34 Menu Items for Administering a Queue Engine Server 35 Menu Items for Calendar Definitions 109 Menu Items for Defining Alerts 73 Menu Items for Job Sequence Macros 97 Menu Items for Monitoring Job Progress 27 Menu Items for The Argent Job Scheduler 53 Monitoring Job Progress 27 N NT Message Alerts 70 O ODBC Setup 120 On-line Help 167. 209 QOPEN 177. 211 QREQUEUE 178. Limited 1991-2006 • Page 264 .Argent Job Scheduler Users Guide How to access The Argent Job Scheduler Schedule 21 How to access The Argent Job Scheduler Service 17 How to access The Argent Job Scheduler’s Menu Items 111 How to Create a Job Class 37 How to Create a Schedule 42 How to Install The Argent Job Scheduler 7 How to Upgrade The Argent Job Scheduler 12 I Installation 5 J Job Activity 25 Job Classes 36 Job Classes List 39 Job Definition 40 Job Definition Basic Tab 40 Job Definition Dependencies 45 Job Definition Schedule Tab 42 Job Definition Servers 45 Job Exit Codes 56 Job Exit Codes 140. 219 Queue Description 34 © ArgSoft Intellectual Property Holdings. 158 Job Sequence Macros 90 Jobs in Queue Engines 138. 212 QSHOW 179. 213 QSTART 180. 214 QSTOP 181. 157 Job Log Files 55 Job Menu 112 Job Parameters 140. 158 Job Parameters 55 Job Processing Thread Limit 120 Job Scheduling 141.Read 48 Q QCANCEL 170 QCLOSE 171. 216 QSYSTEM 186. 215 QSUBMIT 182. 206 QDELETE 174. 205 QCREATE 172. 156 Period Definition 110 Period Definitions 106 Permissions for Startup Jobs 32 Powerful Features 3 Priority 137. 156 Protect from Everyone – Full Control 48 Protect from Everyone . 158 Job Info Tab 19 Job List 127 Job List Refresh Interval 120 Job Log Files 139. 202 Overview of The Argent Job Scheduler 2 P Pager Alerts 63 Pager Macros 76 Pending Jobs Limit 138. Creating Batch Files 150. 159 The Queue Engine. 163 The Queue Engine. Working with Jobs 150.Argent Job Scheduler Users Guide Queue Engine Assigning User Rights 136 Queue Engine General Info 32 Queue Engine Properties 33 Queue Engine Queue Affinity 45 Queue Engine Queue Properties 33 Queue Engine Queue Status 33 Queue Engine Security 146. 162 Queue Engines 137 Queue Macros 87 Queue Options 50 Queue Priority 34 Queue Properties 137. 161 Queue Engine Server General Settings 135 Queue Engine Server Log 19 Queue Engine Servers 29 Queue Engine System Configuration 147. 163 The Scheduler Engine 188 Toolbar Buttons 15 Types of Alerts 20 © ArgSoft Intellectual Property Holdings.EXE 7 S Save When Leaving New or Changed Record 121 Scan Entire Network 112 Scheduler Colors 24 Scheduler Columns 26 Security 190 Security 125 Server 120 Servers Field Option 24 Service Management Window 18 Service Restart 130 Setting Up Exchange Email 61 Setting Up SMTP Mail 62 Settings Menu 118 Show Warning Message if non_UNC file name is used for job 122 Show Warning Message on Delete 121 Simple to use The Argent Job Scheduler 2 Sleep after Scheduling Cycle 120 SMTP Protocol Email Options 124 Software Requirements 5 Some Examples of Calendars 110 Start / End Date of Forecast 115 Start Service 111 Startup Jobs 142 Startup Jobs 32 Status 138. 159 The NT Event Log forThe Argent Job Scheduler 18 The Queue Engine 188 The Queue Engine Commands 145. Predefined Environment Variables 150. Limited 1991-2006 • Page 265 . 157 Submitting Jobs 54 System Menu 111 System Options 119 System Requirements 5 T Terminology Conventions ii The Argent Job Scheduler Basics 14 The Argent Job Scheduler Features 3 The Argent Job Scheduler Log Window Options 19 The Argent Job Scheduler Scheduler 21 The Argent Job Scheduler Service Management Options 18 The Argent Job Scheduler’s Contribution to Data Center Management 1 The Log Size Limit 143. 159 The Queue Engine System Log 143. 160 The Queue Engine Main GUI 144 The Queue Engine Service 142. 156 Stop Service 111 Submit Jobs 112 Submitting Jobs 139. 155 Quit Without Saving Changes 112 R Refresh Time Zone Cache 112 Refreshing the Job List 25 Restore Database 112 Retain Job List Settings 122 Retain Jobs 34 Return Codes 154 Rollover 189 Rollover & Archiving 133 Run Command Alerts 68 Run SETUP. 163 The Queue Engine. Limited 1991-2006 • Page 266 . 155 What are Macros? 20 What is an Exit Code? 46 Why use The Argent Job Scheduler? 2 Windows Messaging Email Options 123 Write Record to NT Event Log for Stopped Jobs 49 © ArgSoft Intellectual Property Holdings.Argent Job Scheduler Users Guide Types of Job Masks 23 Types of Log Entries 19 U User Macros 84 User Notification 140 Using Job Masks 23 Using Job Parameters 154. 166 Using Show Status 24 Using The Argent Job Scheduler Window 15 Using the Commands Across a Network 168. 203 Using the Date/Time Format 24 Using the Job Scheduler 111 V Verify Database 112 View Job History File 117 W Wait between Queue Engine Scans 120 Welcome to The Argent Job Scheduler 1.