JAMS User Guide. 1 Table of Contents

Full text

(1)JAMS User Guide 1. Table of Contents. 1.. Table of Contents. 2.. Introduction. 4. 2.1. Terms. 4-5. 2.2. Managing Server Definitions. 5-6. 2.3. Creating Your First Job 2.4. Customizing the JAMS Client 3.. 1-3. Daily Operations. 6-12 12-13 14. 3.1. Submitting a Job. 14-15. 3.2. Managing Jobs in the Schedule. 15-17. 3.3. History. 17-18. 4.. Dates. 19-22. 5.. Definitions 5.1. Folders. 23-24. 5.2. Jobs. 24-27. 5.3. Setups. 27-29. 5.4. Schedules. 29-30. 5.5. Dependencies. 30-31. 5.5.1. Job and Setup Dependencies. 31-32. 5.5.2. Variable Dependencies. 32-33. 5.5.3. File Dependencies. 33-34. 5.6. Notifications 5.6.1. Notify Names 5.6.1.1. Notification Parameters 5.6.2. Notify Options 5.6.2.1. Completion Severity 5.7. Triggers. 34 34-35 35 35-36 36 36-37. 5.7.1. Trigger Events. 37-38. 5.7.2. Trigger Actions. 38-39. 5.8. Variables 5.9. Execution Methods 5.9.1. Command. 1. 23. 39 39-40 40. JAMS User Guide.

(2) JAMS User Guide 5.9.2. CRJob V12. 40-41. 5.9.3. CRJobV13. 41. 5.9.4. FileTransfer 5.9.5. Interactive. 42. 5.9.6. JAMSReport. 42-43. 5.9.7. JDEJob. 43-44. 5.9.8. OdbcCommand. 44. 5.9.9. OleDbCommand. 44. 5.9.10. Parsed. 44. 5.9.11. PeopleSoftJobSsh 5.9.12. PeopleSoftJobWindows 5.9.13. PowerShell 5.9.14. PowerShell32 5.9.15. PowerShellParsed. 44-45 45 45-46 46 46-47. 5.9.16. PowerShellParsed32. 47. 5.9.17. Rexec. 47. 5.9.18. RexecParsed. 47-48. 5.9.19. SAPJob. 48-49. 5.9.20. SAPStandardJob. 49-50. 5.9.21. OS/400. 50. 5.9.22. SQLCMD. 50. 5.9.23. SQLCMDServer 5.9.24. SQLCommand 5.9.25. SSH. 50-51 51 51-52. 5.9.26. SSHAgent. 52. 5.9.27. SSHDeploy. 53. 5.9.28. SSHOpenVMS. 53. 5.9.29. SSHPrompt. 53. 5.9.30. SSISDirect. 53-54. 5.9.31. SSIS. 54. 5.9.32. VBS. 54. 5.9.33. VBSParsed 5.9.34. VMS. 2. 41-42. 54-55 55. JAMS User Guide.

(3) JAMS User Guide 5.9.35. VMSParsed 5.9.36. WindowsDeploy. 55-56. 5.9.37. Workflow. 56-57. 5.9.38. MSDAX2009Job. 57. 5.9.39. MSDAX2012Job. 57-58. 5.10. Menus 5.10.1. Menu Properties. 58-59 59. 5.10.1.1. Includes. 59. 5.10.1.2. Menu. 59. 5.11. Users 5.11.1. User Properties. 59-60 60. 5.11.1.1. Security. 60. 5.11.1.2. User Name. 60. 5.12. Queues 5.12.1. Queue Properties. 6.. 55. 60-61 61. 5.12.1.1. Name. 61-62. 5.12.1.2. Status. 62. Reporting. 63. 6.1. Designing Reports. 63. 6.2. Report Properties. 63-66. 6.3. Running Reports Interactively. 66-67. 6.4. Scheduling Reports. 67-72. 7.. PeopleSoft Users Guide. 73-80. 8.. Index. 81-84. 3. JAMS User Guide.

(4) JAMS User Guide 2. Introduction. The Job Access and Management System (JAMS) is designed to automate and enhance the batch-processing capabilities provided by the operating systems. JAMS provides those in charge of operations as well as the general end-user the ability to request, monitor, and control the processing of batch jobs. JAMS provides the control mechanisms that allow you to give end-users the ability to request batch processing; you retain control of how and when the requested jobs are executed. In addition to allowing end-users to submit their own jobs, JAMS allows you to schedule jobs for unattended execution. This document is intended for people who will be using JAMS; therefore, it covers JAMS clients, not the back-end services that actually do all of the work. For information on the back-end services, consult the JAMS Administrator's Guide.. The JAMS Client The JAMS Client covers a number of different programs including the GUI, PowerShell, command line, ASP.NET, and .NET Class Library. Most of the examples and illustrations in this document will show the GUI client, but there are some PowerShell and ASP.NET examples as well. Here is an example of the JAMS GUI Client:. Do not be concerned if your client doesn't look exactly like the illustration. As you will see, you can change and customize the client in many different ways. Read the following article on the JAMS Support site for more information: Using the Free JAMS Monitor. 2.1 Terms Before you dive into this document, you should familiarize yourself with a few terms we will be using.. 4. JAMS User Guide.

(5) JAMS User Guide Job The smallest unit of work in JAMS. A Job is a single script, command, or executable unit.. Setup One or more Jobs set up to run with a specific set of parameters.. Folder A logical group of Jobs and Setups.. Trigger A means of defining an event-based schedule rather than a date-and-time-based schedule.. Variable A single bit of data, a name, and a value. Similar to an environment variable, but an environment variable goes away when you reboot; a JAMS Variable keeps its value after a reboot because the value is saved in a database.. Entry An instance of a Job or Setup in the current schedule.. Dependency A prerequisite that must be satisfied before a Job or Setup is allowed to start.. 2.2 Managing Server Definitions JAMS is a client/server application. The JAMS Client can't do much until it connects to a JAMS Server. If you are running the JAMS Client on the same computer as the JAMS Server, the Client will see and predefine that local server. Your administrator can also predefine JAMS Servers when the Client is installed. It is a simple process to create or modify a JAMS Server. Click on the JAMS J logo in the top left corner of the Client and pick Servers from the pulldown menu.. Click the Add... button to add a new Server definition, or select a Server and click the Change... or Remove. 5. JAMS User Guide.

(6) JAMS User Guide button. If adding or changing a Server, you will be presented with a form like this:. Server The Server tab identifies the Server and specifies the actual node and port to connect to.. Authentication The Authentication tab can be used to specify alternate credentials to use when connecting to the Server. You can also choose to be prompted for a user name and password every time a connection is made. In most cases, you don't want to supply any of this information. When your computer is in the same Windows domain as the JAMS Server (or there is a trust relationship), you can leave these fields blank and JAMS will use your current Windows identity.. Appearance The Appearance tab allows you to choose a theme for this Server. Different themes have completely different looks. This can be used to clearly differentiate what type of Server you are connected to. You could choose one theme for production, another for tests, and a third for development servers.. 2.3 Creating Your First Job Before you can create your first Job, or any JAMS object, you have to be in the correct location. The Add button allows you to add many different JAMS objects, depending on the context. If you're looking in Job Definitions, it will add a Job; if you're looking at Setup Definitions, it will add a Setup. So, click the Jobs shortcut under the Definitions group in the Shortcut Bar to display the list of Job Definitions you can add. Your Client should look something like this:. 6. JAMS User Guide.

(7) JAMS User Guide. Now you can click the Add button in the Ribbon Bar to start the Job Add wizard. Your first dialog will look like this:. This is a simple introduction to confirm you want to do what you have chosen. When you are comfortable working with JAMS, you can check the Don't show this introduction again box to skip this step. For now, make sure you are adding a Job and then click Next> to get this step:. 7. JAMS User Guide.

(8) JAMS User Guide. In the Job Name step, you must supply a unique name, and can enter a description of the Job if you like. Don't worry about overwriting an existing Job; JAMS will let you know if you enter a name that already exists. Click Next> and JAMS will validate the name that you entered. If it is acceptable, you will see the next step, choosing an Execution Method:. The Execution Method defines what type of Job, batch file, PowerShell, SQL etc. Note the Search button to the right of this Execution Method field. You can click this button to pull up a list of the available Execution Methods. Any time you see this button you can click it to search. While the Execution Method is a critical choice, we're not going to spend much time on it in this introduction because there's an entire chapter on Execution Methods. For now, we'll pick PowerShell and move on to:. 8. JAMS User Guide.

(9) JAMS User Guide. The next step is to choose the JAMS Folder you want to add this Job to. Each Job must be a member of one and only one Folder. It's similar to a file being in a directory, but Jobs will inherit settings from their Folder, so choosing the correct Folder is important though not critical, as you can always change it later. Note that the Folder name also has a search button next to it so you can search for the correct Folder Definition. Choose your Folder and click Next> to get to the Notification form:. Enter an e-mail address here where you can be notified if there's a problem with this Job. This is also the first time you will see the effects of the Folder you just selected. The last line of this form tells us that the Folder Definition doesn't have any e-mail addresses (so we entered one). If the Folder Definition did have e-mail addresses specified, they would be shown here so you can determine if you need to add one. The notification email is optional. Click Next> to advance to the User account form:. 9. JAMS User Guide.

(10) JAMS User Guide. This form is used to specify the account the job will run under. You have three choices here: you can accept the default supplied by the Folder definition; select on of the already-defined User Names using the drop-down box; or click the Enter a Username and Password button to add a new User Name Definition. Once you have selected a User Name, click Next> to go to the job's Source:. This is where you enter the actual Source or Script for the Job. Your screen may be significantly different than what you see here. The Execution Method that we selected earlier is what defines this form and what is entered. Many Execution Methods use a text editor—shown here—but an Execution Method can completley replace this text editor with something that is specific to the Execution Method. For this example, we've entered a simple PowerShell command. We can now click Next> to get to the Schedule dialog:. 10. JAMS User Guide.

(11) JAMS User Guide. The Schedule form lets you specify a Schedule for your job. JAMS understands natural-language date specifications, so you can enter almost exactly what you're thinking. You can use the drop down in the Scheduled Date field, but that just shows you some examples of what can be entered; there's no way we could list all of the possible combinations. Entering a Schedule is optional. If you don't enter a Schedule, the job will only run if it is manually submitted. You can also enter a Schedule and then uncheck the Automatically Submit check box if you're not quite ready to have the Job run automatically. Click Next> to advance to the final part of the Add Job Wizard:. As noted, in this final form, the wizard guides you through the main properties of a Job Definition. You can click the check box to edit the Job Definition after it is added if you need to set some of the other properties of the Job. Click Finish, and you have added your first Job. If you entered a Schedule for your Job, JAMS will automatically submit the Job according to that Schedule. To. 11. JAMS User Guide.

(12) JAMS User Guide test the Job, find it in the list of Job Definitions, right-click on it, and pick Submit to do an ad-hoc submit of the job. You will be presented with this dialog:. Click Submit Run Request, and your Job will be submitted to the Schedule to run right away.. 2.4 Customizing the JAMS Client The JAMS client is easy to customize. You can add as many shortcuts as you like. Each shortcut can lead to one of the JAMS views with a customized query and/or server definition. You can see in this illustration that we have three shortcuts: History, Failed History, and Backup History.. 12. JAMS User Guide.

(13) JAMS User Guide. For more information, read Customizing the Shortcut Bar in the Getting Started with JAMS guide.. 13. JAMS User Guide.

(14) JAMS User Guide 3. Daily Operations. JAMS can perform many daily operations, including: Submitting a Job (Section 3.1) Managing Jobs in the Schedule (Section 3.2) Accessing JAMS Job Execution History (Section 3.3) Establishing Date Specifications for Batch Automation (Section 4). 3.1 Submitting a Job Most of your Jobs will be completely automated, requiring no human intervention, but there will always be a need to manually submit a Job. You may need to rerun an automated Job or run a Job out of it's normal Schedule, and there are always a few Jobs that have a Schedule of "Don't run it 'til I say it's okay." Fortunately, the JAMS Submit menu provides an easy-to-navigate tree structure that makes it easy to find and submit these off Jobs:. Once you find the Job or Setup that you want to run, double-click it. You are presented with a tabbed dialog form: The Parameters tab is built dynamically from the Job or Setup Definition. It lets you specify values for the Job's Parameters. If a Job doesn't have Parameters, the tab page won't be present. The Schedule tab is always present, with fields that let you override the defaults for: Scheduled Date and Time Batch Queue Agent Node Scheduling Priority Click the Submit Run Request button and the Job is submitted to the Schedule. The back-end JAMS processes will then check the Scheduled time, Dependencies, resource requirements, etc. before allowing the Job to actually start.. 14. JAMS User Guide.

(15) JAMS User Guide To change a Job: 1. Click the Job Shortcut under the Definitions heading of the Shortcut Bar if the Job view is not already active. 2. Double-click the Job that you would like to change. 3. The Job will be opened in a new window. To delete a Job: 1. Click the Job Shortcut under the Definitions heading of the Shortcut Bar if the Job view is not already active. 2. Select the Job that you would like to delete. 3. Click Delete from the Tool Bar. 4. You will be prompted to confirm the delete request. Read the following articles on the JAMS Support site for more information: Force Job to Abort? Deleting Jobs from the Schedule Running Jobs on the Desktop Automatically Submitting Jobs. 3.2 Managing Jobs in the Schedule JAMS is a great tool for automating your batch processing. It is also a great tool for monitoring and managing this automation. While the goal may be to fully automate all of your Jobs, in real life, you need to adjust priorities, work around problems, and monitor progress. JAMS provides the Monitor view to do just that.. The JAMS Monitor view is updated in real time as Jobs progress through the Scheduler. You can double-click any Job in the view to see the details behind it, including information on what Dependencies it is waiting for.. 15. JAMS User Guide.

(16) JAMS User Guide. You can also manage entries in the Schedule by selecting one or more entries and clicking a button in the Ribbon Bar. The options available include: Hold—Holds a Job that has not yet started or, for multijob setups, prevents any further Jobs from starting. Release—Releases a Job from one or more constraints. Restart—Kills an executing Job and restarts it from the beginning. Reschedule—Changes the scheduled start date, time, priority, or batch queue. Cancel—Kills an executing Job or deletes a pending Job.. Releasing a Job Releasing a Job requires a bit more explanation because there are a number of options. When you release a Job, you are presented with this dialog:. 16. JAMS User Guide.

(17) JAMS User Guide. This dialog has a check box for each option for releasing an entry. The items that don't apply to the selected entry are disabled. The next item in the entry's progression toward execution is automatically checked. In this example, the selected entry is waiting for a Dependency to be satisfied, so Ignore Dependencies is checked. If we were to click Ok, the entry's Dependencies would be ignored and the Job would progress as if it's Dependencies had been satisfied. That would be checking for precheck Jobs, then resource requirements, and finally starting the Job.. Releasing Halted Setups In general, when a Job that is part of a setup fails, the setup goes into a "halted" state. Jobs that are executing continue, but the setup won't advance to another step, so subsequent Jobs won't be released. You have a number of options: You can select the failed Job, click Release, and check Release to run again. This will rerun the failed Job, but it won't release the halted setup. You can select the Setup, click Release, and check Release halted setup. This will release the Setup so subsequent Jobs can continue. You can select individual Jobs in the Setup, click Release, and check Release from Setup step wait. This will release the Job before the Setup has advanced to the Job's step. You can do this at any time, even when a Setup is not in a halted state. Read the following articles on the JAMS Support site for more information: Monitoring Large Numbers of Jobs on OpenVMS Automatically Submitting Jobs. 3.3 History JAMS monitors all batch jobs on the system, even jobs which were not submitted by JAMS. You can use the History function to review what jobs have run, their execution statistics, and completion status. If you retain your log files, they will be available for review as well. To view History: Click the JAMS tab in the Ribbon Bar if it is not already active. Click the History Shortcut if the History view is not already active. Fill in the History search criteria if prompted and click Ok.. 17. JAMS User Guide.

(18) JAMS User Guide. Double-click the desired History entry. The History entry will be opened in the view pane. If you would like to change the search criteria, click the Query button in the Toolbar.. The JAMS Job Execution History is a great tool for both operations and development. You can easily query the JAMS History to find out what happened in the past hour, last night, last week, or last year.. 18. JAMS User Guide.

(19) JAMS User Guide 4. Dates. Date specifications are critical to any sort of batch automation because you have to specify when a job should run. JAMS has the unique ability to understand natural-language date specifications. The general rule is to enter what you're thinking.. Simple Date Specifications A simple date specification is, in general, a single word. JAMS understands: Sunday Monday Tuesday Wednesday Thursday Friday Saturday Workday Weekday Today Tomorrow Yesterday Daily You can abbreviate the names of the days to the first three letters, and "Workday" and "Weekday" can be pluralized. "Today," "Tomorrow," and "Yesterday" are self-explanatory. "Daily" always resolves to the current date. "Workday" and "Weekday" proceed like this: If the current date is a match, that date is returned; otherwise, we advance the date until there is a match. Refer to Workdays for an explanation of how we determine if a day is a workday.. The days of the week can also be modified by being prefaced with "This," "Last," or "Next." The date is determined like this:. 19. JAMS User Guide.

(20) JAMS User Guide Prefix Result A simple day name means that day of this week. So on a Wednesday, Monday would return today's date minus 2 and Friday would return today's date plus 2. This. If the current date matches the specified day, the current date is returned. Otherwise, we advance days until there is a match. So, "This" will always yield a date that is today or later.. Last. Evaluates the date as if it was "day name" (no prefix) and then subtracts 7 days.. Next. Evaluates the date as if it was "this day name" and then adds 7 days.. Also refer to Adding or Subtracting Days.. Complex Date Specifications Complex Date Specifications are used to specify a date relative to an arbitrary period of time. By period of time, we mean something like a month or fiscal period. A Complex Date Specification may be thought of as two components: the day specification and the period specification. For example, in the text "1st workday of next month," the day specification is "1st workday" and the period specification is "next month." The general format of a Complex Date Specification is as follows: [day-of-period OF] period The syntax for the day-of-period specification can take one of two forms. Both forms are equivalent; the choice of which form to use is left to the user. The two forms of the day-of-period specification are: FIRST LAST 1[st] 2[nd] 3[rd] Integer [th] Day of Week WORKDAY WEEKDAY DAY MONTH or Day of Week WORKDAY WEEKDAY DAY MONTH OF FIRST LAST 1[st] 2[nd] 3[rd] Integer [th] WEEK If you do not specify the day of period, the default is the current day. The syntax for the period specification is: THIS NEXT. 20. JAMS User Guide.

(21) JAMS User Guide LAST YEAR MONTH Month Name Date Type Specific Date Type Date Type, Specific Date Type While this syntax specification seems ominous, it is actually a representation of how people commonly specify dates.. User-Defined Periods If you specify a period by using user-defined Date Types, you may have to specify both the Specific and Generic Date Types. For example, if you have defined the Date Type FISCAL with Specific Date Types of PERIOD_01 through PERIOD_12, you can specify the second period as: "FISCAL PERIOD_02" or "PERIOD_02." If you defined two Date Types that both use the Specific Type PERIOD_02, then you must specify "FISCAL PERIOD_02.". Weeks When used in the context of a period, a week is defined as starting on the first day of the period and continuing for seven days.. Valid Complex Date Specifications The following examples of valid complex date specifications are based on the current date being March 1st, 1991.. Specification. Date. FIRST MONDAY OF NEXT MONTH. 01-APR-1991. 2ND MONDAY OF THIS MONTH. 12-MAR-1991. FIRST MONDAY OF LAST MARCH. 05-MAR-1990. 6TH WEEKDAY OF NEXT MONTH. 08-APR-1991. 6TH WEEKDAY OF MONTH. 08-MAR-1991. Adding or Subtracting Days With both simple and complex date specifications, you can append the addition or subtraction of days. The syntax for this is: +/- ## DAYS|WORKDAYS|WEEKDAYS If specified, the simple or complex date is evaluated and then we add or subtract the indicated number of days, workdays, or weekdays.. Workdays If you specify "WORKDAY" or "WORKDAYS" in a JAMS date specification, it is important to understand how we determine if a day is a workday. It is a two-step process: 1. We look at the WORK_ddd configuration setting, where ddd indicates the day of the week we are checking. This gives us the initial true or false indication that the day is a workday. 2. We look for special dates for the date in question, and if the Workday check box is checked, the date is a workday. If it is unchecked, the date is not a workday. And, if the check box is filled, that indicates that the special date should have no affect on the workday status. Note that if you have two special date definitions for the same date and one indicates a workday and the other indicates a nonworkday, the results are unpredictable. We will use whichever is returned first.. 21. JAMS User Guide.

(22) JAMS User Guide Read the following articles on the JAMS Support site for more information: Formatting Date Parameters Daylight Savings Time Also see Entering Natural-Language Date Specifications in the Getting Started with JAMS guide.. 22. JAMS User Guide.

(23) JAMS User Guide 5. Definitions. In the Introduction chapter of this document we walk you through creating your first Job. A Job Scheduler runs Jobs, so that's a logical first step. In reality, there are many other things (or objects) that you need to understand. There are objects that support Jobs, like Folders and Users, and there are objects that use Jobs, like Setups and Triggers. In this section, we will explain all of the JAMS objects and how they are related to one another. We will also explain some concepts that are common to many objects within JAMS. This document is not a field-by-field reference manual. For details about specific fields, you can hit the Help key (F1) in the JAMS GUI or consult the JAMS .NET Class Library Reference Manual.. 5.1 Folders A JAMS Folder definition is used to make it easier to create and manage Jobs and Setups. Each Job and each Setup belong to one and only one Folder. Many of the attributes of a Job or Setup can be defined in the Folder Definition, and the Jobs and Setups that belong to that Folder will pick up that value if the attribute isn't specified in the Job or Setup.. Example The Submit Options tab of the Folder Definition provides some good examples. Some of the fields on this tab include: Batch Queue Default User Name for Jobs Default Home Directory for Jobs These are very common things: the Batch Queue is a JAMS object (that we talk about a little later), the User. 23. JAMS User Guide.

(24) JAMS User Guide Name and Home Directory are common concepts. Every Job you ever create has to have a User Name and could probably use a Home Directory and Batch Queue, but there's no need to specify those details on every Job; just specify them in the Folder Definition and let the Jobs pick them up from there. Remember, you're just establishing defaults with the Folder Definition. If you look at the Submit Options tab of a Job Definition, you will find three fields (along with others), so if you have one Job that needs to be different, you can always override the Folder Definition at the Job level. To add a Folder 1. 2. 3. 4.. Click the JAMS tab if it is not already active. Right click inside the root Folder menu. Select Add Folder from the drop down list. The Folder Add Wizard will launch. Follow the prompts to add a new Folder.. To change a Folder: 1. 2. 3. 4.. Click the JAMS tab if it is not already active. Click the Folders Shortcut if the Folder view is not already active. Double-click the Folder that you would like to change. The Folder will be opened in a new window.. To delete a Folder: 1. 2. 3. 4. 5.. Click the JAMS tab if it is not already active. Click the Folders Shortcut if the Folder view is not already active. Select the Folder that you would like to delete. Click Delete from the Tool Bar. You will be prompted to confirm the delete request.. 5.2 Jobs Job Definitions are the centerpiece of JAMS; everything else supports or controls a Job.. 24. JAMS User Guide.

(25) JAMS User Guide. What Is a Job? In JAMS, a Job is a single "thing" that can be executed. It could be a Script, Executable, Command, etc. The way that Jobs execute is defined by the Job's Execution Method. This guide will explain the concepts you need to understand when creating Jobs. Details regarding some of the concepts are contained in other areas of this guide. When using the JAMS GUI Client, details about specific fields are available by pressing the help (F1) key while the cursor is in the field.. Job The Job tab is common to all JAMS objects. It contains the name of the object, a description, and Last Changed information.. Schedule Options The Schedule Options tab is where you can specify a Schedule for this Job. The Job could also be submitted to the Schedule by Setup Definitions, Triggers, programmatically, or manually via the JAMS Submit-JAMSEntry PowerShell cmdlet. The Schedules topic describes how to Schedule a Job or Setup.. Submit Options The Submit Options tab defines how the Job should run. Many of these settings are inherited from the Job's Folder Definition.. Source The Source tab for a Job is the most important tab because it is used to define the actual script or commands. 25. JAMS User Guide.

(26) JAMS User Guide that the Job will execute. This tab can change based on the Job's Execution Method. Many Execution Methods use a source code editor in the Source tab. Some Execution Methods provide a custom form under the Source tab, and a few Execution Methods don't use the Source tab at all.. Parameters Parameters allow you to supply information to a Job before it executes. Parameters can define things like the date to use in a report or the path to a file. Parameters are unique to each Job Definition or Job Setup within a Setup Definition. Parameters are similar to JAMS Variables, but Parameters are local to a Job while Variables are globally defined for all JAMS Jobs. A Parameter can also call a JAMS Variable. Parameters are referred in the Job Source tab in the following syntax: <<ParameterName>>. Reports Reports can be used to provide valuable information about your JAMS system, such as the Jobs currently running, Jobs that have run in the past, or Definitions of Jobs and Setups.. Submit Times Defines how the Job is to be submitted. Options include: Override Batch Queue, Retain Option, Retain For, Scheduling Priority Modifier, Username for this Job, Agent Node Name, HomeDirectory, Restartable, Hold Job when Submitted, Suppress Display on Submit Menus, Notify Submitter.. Resources View or edit a list of the Resource Requirements currently defined for a Job. Resource Requirements specified in a Job Definition augment the Resource Requirements specified in the Job’s Folder Definition. If the Job and Folder both specify the same Resource, the Requirements are summed.. Dependencies Job Dependencies are used to ensure that all prerequisite processing has been performed before a Job can begin executing. A Job Dependency can be based on: The The The The The The. completion of a Job. completion of a Setup. completion of a Remote Job. completion of a Remote Setup. presence or absence of a File. value of a JAMS Variable.. Precheck Job A Precheck Job is used to check for user-defined prerequisites for this Job. When a Job with a Precheck Job is submitted, it will remain in a pending state until the Precheck Job completes successfully. JAMS will automatically submit the Precheck Job when the main Job is ready to run. By ready to run, we mean that the Job is not held or waiting for a specific time, all of the Job’s Dependencies have been satisfied, and there are sufficient Resources available. A Precheck Job has four options: 1. It can loop, waiting for the prerequisites. 2. It can exit with the status JAMS_TRYAGAIN and JAMS will resubmit the Precheck Job after the precheck interval has elapsed. 3. It can exit with a bad status and JAMS will perform normal notification actions and then resubmit the Precheck Job after the precheck interval has elapsed. 4. It can exit with the status JAMS_xCANCELJOB, where x is S, I, W, E or F and denotes the severity of the status. JAMS will cancel the Job that caused the Precheck to run and the final status of the Job that caused the Precheck to run will be the status the Precheck Job returned. If the Precheck Job is parsed, predefined parameters are available.. 26. JAMS User Guide.

(27) JAMS User Guide Recovery Defines the Job's recover actions. You can also edit or view the Job’s restart/recovery instructions. If the Completion Severity is If this Job completes with a severity equal to or worse than the severity specified here, the Recovery Job will be automatically submitted. The Recovery Job is not submitted if this Job is intentionally aborted. Then Submit this Job This is the name of a JAMS Job to be submitted if this Job completes with a severity equal to or worse than the specified severity. If the Recovery Job is parsed, predefined parameters are available. Recovery Instructions These instructions are included in the mail message sent if this Job requires notification.. Notify Names Defines who should be notified when the Job requires notification. These names can augment or replace the names specified on the Job’s Folder definition. To remove a name specified in the Folder Definition, prefix the name with a minus sign. To remove all named specified in the Folder Definition, enter -*. Notification is performed when the Job: Completes with a severity worse than it’s notification severity Runs too long Runs too quickly Is stalled Misses it’s execution window E-Mail Address List This is a list of e-mail addresses, separated by commas. You can also specify logical names that equate to one or more e-mail address. These individuals will receive an e-mail message indicating the reason for the notification. JAMS will include the Job's log file if it is available, and the Recovery instructions if they are defined. User Names This is a list of usernames, separated by commas. You can also specify logical names that equate to one or more username. A message will be broadcast to these users (if they are logged on at the time.) Other This is a list of operator classes, separated by commas. You can also specify logical names that equate to one or more operator class. A message will be sent to these operator classes. Notification Job This is the name of a JAMS Job that should be submitted when notification is required. A Job specified here will override a Notification Job specified in the Folder definition. If the Notification Job is parsed, predefined parameters are available to the Notification Job. Read the following articles on the JAMS Support site for more information: Adding Verbose Logging Description of the JobState Enum Type. 5.3 Setups Setup Definitions are used to create a specific instance, or view, of a Job or sequence of Jobs. A JAMS Setup can set up a single Job or a sequence of related Jobs. Setups can specify values for Parameters, Schedules, and many other attributes of a Job. A Setup is the simplest way to sequence a stream of Jobs. The Jobs in a Setup run in order based upon the step the Job is assigned. If more than one Job is assigned the same step, those Jobs can run in parallel.. 27. JAMS User Guide.

(28) JAMS User Guide. To add a Setup: 1. 2. 3. 4.. 28. Click the JAMS tab if it is not already active. Click the Setup Shortcut if the Setup view is not already active. Click Add from the Tool Bar. The Setup Add Wizard will launch. Follow the prompts to add a new Setup.. JAMS User Guide.

(29) JAMS User Guide. To change a Setup: 1. 2. 3. 4.. Click the JAMS tab if it is not already active. Click the Setup Shortcut if the Setup view is not already active. Double-click the Setup that you would like to change. The Setup will be opened in a new window.. To delete a Setup: 1. 2. 3. 4. 5.. Click the JAMS tab if it is not already active. Click the Setup Shortcut if the Setup view is not already active. Select the Setup that you would like to delete. Click Delete from the Tool Bar. You will be prompted to confirm the delete request.. Read the following article on the JAMS Support site for more information: Halting a Setup Definition. 5.4 Schedules Schedules are used in a number of places in JAMS, including: Job Definitions (Section 5.2) Setup Definitions (Section 5.3) Job and Setup Dependencies (Section 5.5.1) Trigger Actions (Section 5.7.2) You can specify what time to use as the base for calculating the next run time. The base may be the Scheduled, Start, or End time. Scheduled Date This is an English-language representation of the date or dates the Job is scheduled to run. You can specify multiple scheduled days by separating the text with commas. For example, Monday,Wednesday,Friday means the Job should be run every Monday, Wednesday, and Friday. Except For This is an English-language representation of the date or dates this Job should not be run. If you want to schedule a Job to run every Monday except the last Monday of the month, you would enter Monday into the Scheduled Date and Last Monday of Month in Except For. Scheduled Time This is the time of day the Job should be run. Non-Workday Scheduling Indicates how this Job should be scheduled if the day it is scheduled to run falls on a non-workday. There are three options: Schedule the Job, even on non-workdays Ignore the Job, do NOT schedule on non-workdays Defer the Job until the next workday Automatically submit. 29. JAMS User Guide.

(30) JAMS User Guide Indicates whether or not the Job should be automatically submitted at the scheduled date and time. No entry indicates the scheduled date and time are to be used only for management and capacity planning. Recurrence If you want the Job to run many times during a day, you can specify the delta time between runs and the time of day to stop repeating. Then, any time this Job completes it will be resubmitted to run hh:mm later. If the Resubmit even after failure box is checked, the Job will be resubmitted no matter what its completion status was or how it was submitted. The only way to stop this repetition is to abort/delete the scheduled entry. If the box is not checked, the job will not be resubmitted if it fails.. For more information see the following: JAMS Time Specifications article on the JAMS Support site Entering Natural-Language Date Specifications in the Getting Started with JAMS guide.. 5.5 Dependencies Dependencies are prerequisites that must be satisfied before an entry (a Job or Setup in the Schedule) is allowed to start. A single Job or Setup can have an unlimited number of Dependencies. Any Job can serve as a Dependency for any other Job regardless of where or how the Job runs. Scripts will not be released to run until all their dependent Scripts complete properly. For example, a Script designed to run on Windows could have dependent Scripts that must complete properly on one or more of the other supported operating systems first. JAMS supports the following types of Dependencies: Job Completion Setup Completion File Presence File Absence File Availability Variable Value Remote Job Completion Remote Setup Completion JAMS evaluates an entry's Dependencies at the entry's scheduled start time. If the Dependencies are all satisfied, the entry advances to the next step in the execution cycle, allocation of resources. If the Dependencies are not all satisfied, the entry goes into a Dependency Wait State until they are. When an entry is in a Dependency Wait State, there is no polling or periodic checking. JAMS is event driven; for example, when a Job completes, JAMS checks to see if that Job completion would satisfy any waiting Dependencies and, if it did, would release the entries that were waiting. If an entry is waiting for Dependencies and you hold the entry or reschedule it for a later time, all of the Dependency evaluations are erased and the Dependencies are re-evaluated when the entry reaches the new scheduled time.. 30. JAMS User Guide.

(31) JAMS User Guide. 5.5.1 Job and Setup Dependencies Job and Setup Dependencies are so similar that we will describe them just once, pointing out the differences as we go. Likewise, Remote Job Dependency and Remote Setup Dependency are so close to Local Dependency that we cover them together at the end of this section.. When you create a Job Dependency, the first thing you need to specify is Depends on Job (what Job do you depend on?). In this example, we are adding a Dependency on the CheckDB Job. This is the key difference between a Job Dependency and a Setup Dependency. With a Setup Dependency, you would specify a Setup here. The next bit of information has to do with how well the Job ran. The default value (Informational) means the Job must have worked properly. If the Job fails, the Dependency won't be satisfied. If you don't care about the outcome of the Job that you depend on, you could change this setting.. Since When? Ok, we have a Dependency on the CheckDB job, but now we have to answer the question: Since when? Of course, the CheckDB Job has completed successfully and it may run every day, so we have to have a way to define how recently the CheckDB Job must have completed. We do that with the Since the last time this Job ran and Or within the last fields. The default is empty, which means right now there is no look-back window. With those settings, when JAMS. 31. JAMS User Guide.

(32) JAMS User Guide evaluates the Dependency it will never be satisfied, so we will make the Job wait until we see the CheckDB Job complete. While this may not seem ideal, in many cases it's exactly what you want. Many times you have a bunch of Jobs scheduled to start at the same time, but some of them have Dependencies on some of the others. As long as they're all scheduled for the same time, this blank Since the last time this Job ran works great. In many cases, you will need a large look-back time. Suppose this Job was scheduled to run at 6:00 a.m. every morning. You know the CheckDB Job is scheduled for 1:00 a.m., so it should be done; but what if it isn't? You're adding this dependency to make sure the CheckDB Job is done, but you have to look back at least 5 hours because CheckDB is scheduled to start 5 hours before our Job. The easiest way to do that is to type "05:00" into Or within the last.. Since Job The Since the last time this Job ran field gives us a little more flexibility. When JAMS evaluates a Dependency that has a Since Job specified, we look at that Job to see when it last completed with the specified severity, and that time becomes our Since time. In this example, we're adding a dependency to the PostTransactionUpdates Job, and we've also specified that Job as our Since Job. This is a very common scenario. Imagine a daily cycle where the PostTransactionsUpdate Job is sort of the end-of-day posting. You have a number of Jobs that need to run during the day but they tend to move around, so you need to make sure they are done for the day, but it's difficult to come up with an absolute Within Time. Specifying the Job that you're adding the Dependency to as the Since job results in the Since Time being reset every time the Job completes.. Remote Dependencies JAMS also supports Remote Job Dependency and Remote Setup Dependency. These are Dependencies on a Job or Setup that a different JAMS Scheduler is executing. The only difference between a Local Dependency and a Remote Dependency is that you need to specify the name of the remote JAMS Scheduler. Otherwise, they work the same as a Local Dependency. Read the following article on the JAMS Support site for more information: JAMS Time Specifications. 5.5.2 Variable Dependencies Variable Dependencies, an easy hook to allow external processes to affect Job execution, are very simple, yet provide JAMS with a tremendous amount of power.. 32. JAMS User Guide.

(33) JAMS User Guide. A Variable Dependency needs to know two things: 1. What variable do you want to test? 2. What is the test? The types of tests you can make will vary based on the data type of the variable. In this illustration, we are testing a boolean variable, so we can test for True, False, or Changed. When you are testing a numeric or text variable, you can test for: = Equal To < Less Than > Greater Than <= Less Than or Equal To >= Greater Than or Equal To <> Not Equal To Changed Defining Variable Dependencies is easy, but the key to understanding them is knowing how they make it easy to integrate other applications with JAMS. We provide many different ways for applications to change a JAMS variable: command line, PowerShell, callable, web service, etc. You can find a way to make just about any application change a JAMS variable so it can affect Dependencies and Job Processing.. 5.5.3 File Dependencies Many times, Jobs depend on Files for the data they will process. You can define those File Dependencies in JAMS so a Job won't start until the Files it requires are ready.. File Specification All File Dependencies need a File Specification—the file that we are watching for. The File Specification can contain wildcards if you're unsure of what the exact name will be. The File Specification should be in the format used by the Agent operating system.. 33. JAMS User Guide.

(34) JAMS User Guide The file must be: This combo box specifies what JAMS should look for. The options are: Present—The file is present; JAMS does not try to open the file. Available—The file is present and JAMS can open the file for exclusive access. Absent—The file is not present.. Minimum File Size This is an optional field. If you specify a value greater than zero, JAMS will wait until the File size exceeds the number of bytes you specify. Note that many File transfer tools will create a zero-byte File when a transfer starts and the size will go to the actual size when the transfer is complete; so, looking for a minimum size of 1 byte can be a good way to wait until a transfer is complete.. Agent Node The Agent Node is optional. If it isn't specified, JAMS looks for the File on the system where the JAMSScheduler is running. If the File will actually arrive on a different machine, you can specify the name here. This can be a Windows machine with the JAMSAgent installed or any platform that has JAMSAgentX installed.. Username There are two reasons you might need to specify a Username: 1. You are looking for the File via a JAMS Agent and you need to specify an account that is valid on that machine. 2. The File will arrive in an area the JAMS Scheduler service does not have access to. In that case, specify a Username that will have access to the File.. 5.6 Notifications Notifications define who should be contacted when a Job requires notification as well as limiting Trigger notifications. These two types of Notification are: Notify Names (Section 5.6.1) Notify Options (Section 5.6.2). 5.6.1 Notify Names Defines who should be notified when a Job or Setup in this Folder requires notification. Notification is required when a Job or Setup: Completes with a severity worse than its notification severity Runs too long Is stalled Misses its execution window Runs too quickly E-Mail Address List This is a list of e-mail addresses separated by commas. If a Job or Setup in this Folder requires notification, an email message will be sent to this list of addresses. Usernames This is a list of usernames separated by commas. If a Job or Setup in this Folder requires notification, a message will be broadcast to these users (if they are logged on at the time.) Other This is a list of operator classes separated by commas. If a Job or Setup in this Folder requires notification, a message will be sent to these operator classes. Notification Job. 34. JAMS User Guide.

(35) JAMS User Guide This is the name of a JAMS Job that should be submitted when notification is required. If the Notification Job is parsed then these predefined parameters are available to the Notification Job.. 5.6.1.1 Notification Parameters Notification Jobs that are parsed have these predefined parameters available: JAMS_NOTIFY_JAMS_ENTRY The JAMS entry number of the Job that caused the notification. JAMS_NOTIFY_JOB_NAME The Job Name of the Job that caused the notification. JAMS_NOTIFY_JOB_STATUS The current Job Status value of the Job that caused the notification. JAMS_NOTIFY_LOG_FILENAME The full file specification of the log file for the Job that caused the notification. JAMS_NOTIFY_MAIL_ADR The list of names that will be notified via e-mail. JAMS_NOTIFY_OTHER The list of names for use by a plug-in notification module. JAMS_NOTIFY_PID The process ID of the Job that caused the notification. JAMS_NOTIFY_REASON The reason for the notifications. This parameter could be: COMPLETED, FAILED, SHORT, RUNAWAY, STALLED, or MISSED_WINDOW. JAMS_NOTIFY_USERS The list of names that will receive a message. JAMS_NOTIFY_RON The JAMS run occurrence number of the Job that caused the notification. JAMS_NOTIFY_STATUS The final status of the Job that caused the notification. JAMS_NOTIFY_SUBMITTED_BY The Username that submitted the Job that caused the notification. JAMS_NOTIFY_FOLDER_NAME The JAMS Folder Name of the Job that caused the notification.. 5.6.2 Notify Options Pending Longer Than Specifies how much time may elapse after a Job's scheduled time before the Job is considered to be Stalled. When the Job is considered stalled, JAMS will perform notification for the Job. Runaway % of Average Elapsed Time Specifies how long a Job may run before it is considered a Runaway Job. This is specified as a percentage of the Job's average elapsed time. When the Job is considered Runaway, JAMS will perform notification for the Job. Runaway % of Average CPU Time Specifies how much CPU time a Job may consume before it is considered a Runaway Job. This is specified as a percentage of the Job's average CPU time. When the Job is considered Runaway, JAMS will perform notification for the Job. Short % of Average Elapsed Time Specifies a minimum elapsed time for a Job. If the Job completes successfully in less than this amount of time, it is considered a Short Job. This is specified as a percentage of the Job's average elapsed time. When a Job is determined to be a Short Job, JAMS will perform notification for the Job and may change the Completion Severity of the Job.. 35. JAMS User Guide.

(36) JAMS User Guide Short % of Average CPU Time Specifies a minimum CPU time for a Job. If the Job completes successfully but used less than this amount of CPU time, it is considered a Short Job. This is specified as a percentage of the Job's average CPU time. When a Job is determined to be a Short Job, JAMS will perform notification for the Job and may change the Completion Severity of the Job. Change a Short Job's Severity to If specified, when a Job is determined to be a Short Job, the completion severity will be changed to the severity specified here.. 5.6.2.1 Completion Severity The possible Severity values, in order from good to bad are: Success Informational Warning Error Fatal or Severe. 5.7 Triggers Triggers are used to define event-based schedules. A Trigger consists of a list of events and a list of actions. When JAMS sees that all of a Trigger's events are true, it will perform the list of actions. You can add, change, and delete Triggers from the Shortcut Bar. This section covers: Trigger Events (Section 5.7.1) Trigger Actions (Section 5.7.2). 36. JAMS User Guide.

(37) JAMS User Guide. 5.7.1 Trigger Events Triggers have one to many Events. JAMS then carries out the Trigger's Actions once all of the Events are true. There are four types of Events: Job Completion Event: A Job Completion Event is true if the specified Job has completed with the specified severity level since the last time the Trigger was reset. Setup Completion Event: A Setup Completion Event is true if the specified Setup has completed with the specified severity level since the last time the Trigger was reset. File Event: A File Event is true if the specified File condition is met. This can be set by the File must be and Minimum File Size properties. Mail Event: A Mail Event is true if a mail message arrives in the specified mailbox which matches the selection criteria. Variable Value Event: A Variable Value Event is true or false based strictly upon the value of the specified Variable. There is no relation to the Trigger's last reset time. Note that the order of Events is not important.. Job Completion Events Job Name of the JAMS Job that this Event will depend upon. Severity This is the minimum or maximum Severity needed to cause this Event to be true. Note that if you intentionally delete a Job from the Schedule, it will not cause a Trigger event to be true. Better or Worse Used in conjunction with the Severity to determine if an instance of the specified Job should cause this Event to be true.. Setup Completion Events Setup Name of the JAMS Setup that this Event will depend upon. Severity This is the minimum or maximum Severity needed to cause this Event to be true. Note that if you intentionally delete a Setup from the Schedule, it will not cause a Trigger event to be true. Better or Worse Used in conjunction with the Severity to determine if an instance of the specified Setup should cause this Event to be true.. File Events File Name This is the path to the File the Event depends on. It is required that this File meet the specified criteria before the Event will fire. The file must be: It is required that the File Name must be either Available, Present, or Absent in order for the Event to fire. By specifying file availability, JAMS will fire the trigger when it has exclusive access rights to the file. Minimum File Size This field specifies the minimum required file size needed for the Event to fire. File size is measured in bytes. Agent node This field determines which Agent Node will request the file. This is an optional property; If left blank, the file will be checked locally by the JAMS Scheduler. Username This property determines which Username will be used to check the File. If left blank, the Username of the JAMS Scheduler will be used.. 37. JAMS User Guide.

(38) JAMS User Guide Mail Events Mail Server Specifies the properties of the mail server including: The name of the mail server. The protocol to use, IMAP or POP3. Whether to secure the connection with SSL. Whether to use implicit SSL security. The polling interval. E-Mail Account Select a JAMS user definition that contains the logon credentials for the e-mail account to be polled. Mail Selection Criteria You can enter values which must be found in the subject, from address or to address for a mail message.. Variable Value Events Variable Name of the JAMS Variable this Event will depend upon. Condition Boolean operator or code used to define how the comparison will be performed. Comparison Value the Variable will be compared to. Variable's Data Type The Data Type of the selected variable is displayed here.. 5.7.2 Trigger Actions Triggers have one to many Actions. JAMS carries out a Trigger's Actions once all of its Events are true. Each Action is a Job or Setup that will be submitted when the Trigger fires.. 38. JAMS User Guide.

(39) JAMS User Guide Submit Job - Selecting the Submit Job action will submit the selected JAMS Job definition based upon the settings below: Submit this Job Name of the Job that will be submitted when this Trigger is fired. You must have Submit access to the Job. Date Date specification for when the Job should be submitted. Time Time specification for when the Job should be submitted. Submit on hold Specifies whether or not this Job should be placed in a "holding" state when it is submitted. Submit Setup - Selecting the Submit Setup action will submit the selected JAMS Setup definition based upon the settings below: Submit this Setup Name of the Setup that will be submitted when this Trigger is fired. You must have Submit access to the Setup. Date Date specification for when the Setup should be submitted. Time Time specification for when the Setup should be submitted. Submit on hold Specifies whether or not this Setup should be placed in a "holding" state when it is submitted.. 5.8 Variables Variables are used to hold single pieces of data that may be used in your Batch Scheduling and/or Processing. A JAMS Variable is a piece of data that can be used: As a default value for a Job’s Parameter As an undefined Parameter in a Parsed Job In Job Dependencies In Trigger Events In your application programs and/or DCL Command Procedures You can add, change, and delete Variables from the Shortcut Bar.. 5.9 Execution Methods Execution Methods are a very important part of JAMS; they define how a Job will run. A default Execution Method is assigned to every Job if one is not specifically assigned. JAMS ships with Execution Methods to run Jobs on Windows, UNIX, OpenVMS, and any operating system which supports REXEC. You can modify existing Execution Methods or create new Execution Methods.. 39. JAMS User Guide.

(40) JAMS User Guide. Read the following articles on the JAMS Support site for more information: Adding Syslog Capability How to Create a Custom Parsed Execution Method. 5.9.1 Command The Command Execution Method is a simple Windows batch file script. The source code for a Job can be any valid Windows .BAT or .CMD script.. 5.9.2 CRJob V12 The CRJobV12 execution method is for running Crystal Report Jobs. This execution method is for running Crystal Reports version 12:. 40. JAMS User Guide.

(41) JAMS User Guide. 5.9.3 CRJobV13 The CRJobV13 execution method is for running Crystal Report Jobs. This execution method is for running Crystal Reports version 13:. 5.9.4 FileTransfer The File Transfer Execution Method transfers one or more files between systems. This Execution Method has a custom editor that provides a fill-in-the-blanks ease of use.. 41. JAMS User Guide.

(42) JAMS User Guide. The File Transfer Execution Method supports: FTP—Not secure but still useful for internal transfers FTPS—FTP over TLS/SSL, secure and reliable SFTP—SSH File Transfer SCP—Secure CP, a de facto standard. 5.9.5 Interactive The Interactive Execution Method is a Windows command procedure with interactive desktop access.. 5.9.6 JAMSReport The JAMSReport Execution Method is used for generating reports.. 42. JAMS User Guide.

(43) JAMS User Guide The JAMSReport execution method makes it easy to Schedule Reports (Section 6.4).. 5.9.7 JDEJob The JDEJob execution method is for running J.D. Edwards Jobs:. 43. JAMS User Guide.

(44) JAMS User Guide. 5.9.8 OdbcCommand The OdbcCommand Execution method is designed to run native SQL Commands on the database specified in the "ConnectionString" parameter. Commands are executed through an Odbc Connection and can optionally continue on error.. 5.9.9 OleDbCommand The OleDbCommand Execution method is designed to run native SQL Commands on the database specified in the "ConnectionString" parameter. Commands are executed through an OleDb Connection and optionally supports continuing on error.. 5.9.10 Parsed Parsed Execution Methods are an examples of putting a standard wrapper around Jobs. Examples of this are: SMS Text Alerting (Could be at the beginning and/or the end of each Job.) Syslog Notification (Could be at the beginning and/or the end of each Job.) SNMP Trap Notification (Could be at the beginning and/or the end of each Job.) Executing standard NET USE to map shares Setting environment variables Performing SQL :connect One key detail is that the parsed wrapper could be different between production, test, and development environments. When you copy a Job between environments, you don't have to change the Job. The Parsed Execution Method is a parsed Windows command procedure.. 5.9.11 PeopleSoftJobSsh. 44. JAMS User Guide.

(45) JAMS User Guide The PeopleSoftJobSsh is designed for running PeopleSoft Jobs via SSH:. 5.9.12 PeopleSoftJobWindows The PeopleSoftJobWindows execution method is for running PeopleSoft Jobs on Windows:. 5.9.13 PowerShell. 45. JAMS User Guide.

(46) JAMS User Guide The PowerShell Execution Method is a JAMS-specific PowerShell host. It operates in much the same way as a standard PowerShell command window, with a few differences. The $JAMSBatchJob variable is predefined to be $true, so your scripts can detect that they are running as a JAMS batch Job. The JAMSHost drive is automatically created using the JAMS Provider. This drive will point to the Server that is executing the Job. The JAMS cmdlets default Server will be the Server that is executing the Job. You can still change that by defining the $JAMSDefaultServer variable or with the -Server parameter.. Read the following article on the JAMS Support site for more information: PowerShell Profile Settings. 5.9.14 PowerShell32 The PowerShell32 Execution Method is a 32-bit PowerShell script.. 5.9.15 PowerShellParsed Parsed Execution Methods are an examples of putting a standard wrapper around Jobs. Examples of this are: SMS Text Alerting (Could be at the beginning and/or the end of each Job.) Syslog Notification (Could be at the beginning and/or the end of each Job.) SNMP Trap Notification (Could be at the beginning and/or the end of each Job.) Executing standard NET USE to map shares Setting environment variables Performing SQL :connect One key detail is that the parsed wrapper could be different between production, test, and development environments. When you copy a Job between environments, you don't have to change the Job. The PowerShellParsed Execution Method is a parsed PowerShell script.. 46. JAMS User Guide.

(47) JAMS User Guide. 5.9.16 PowerShellParsed32 Parsed Execution Methods are an examples of putting a standard wrapper around Jobs. Examples of this are: SMS Text Alerting (Could be at the beginning and/or the end of each Job.) Syslog Notification (Could be at the beginning and/or the end of each Job.) SNMP Trap Notification (Could be at the beginning and/or the end of each Job.) Executing standard NET USE to map shares Setting environment variables Performing SQL :connect One key detail is that the parsed wrapper could be different between production, test, and development environments. When you copy a Job between environments, you don't have to change the Job. The PowerShellParsed32 Execution Method is a 32-bit parsed PowerShell script.. 5.9.17 Rexec The Rexec Execution Method is used to run a command on a rexec server.. 5.9.18 RexecParsed Parsed Execution Methods are an examples of putting a standard wrapper around Jobs. Examples of this are: SMS Text Alerting (Could be at the beginning and/or the end of each Job.) Syslog Notification (Could be at the beginning and/or the end of each Job.) SNMP Trap Notification (Could be at the beginning and/or the end of each Job.) Executing standard NET USE to map shares Setting environment variables Performing SQL :connect One key detail is that the parsed wrapper could be different between production, test, and development. 47. JAMS User Guide.

(48) JAMS User Guide environments. When you copy a Job between environments, you don't have to change the Job. The RexecParsed Execution Method is used to run a parsed command on a rexec server.. 5.9.19 SAPJob The SAPJob execution method is for running multi-step Jobs on an SAP Server:. The Execution method provides fields to supply information for each Job Step:. Log options for a Job Step:. 48. JAMS User Guide.

(49) JAMS User Guide. Output options for a Job Step:. 5.9.20 SAPStandardJob The SAPStandardJob execution method is for running single step Jobs on an SAP Server:. 49. JAMS User Guide.

(50) JAMS User Guide. 5.9.21 OS/400 The OS400 execution method is designed for running Jobs on an IBM System i (AS400) server running the OS/400 operating system. Through the agent, jobs are submitted for execution by the OS/400 SBMJOB command. The JAMS "Source" tab in the job definition should contain the CL command that will be executed, this is passed to SBMJOB in the CMD() parameter. You can reference JAMS parameters and variables using the standard <<name>> references. The JAMS User Security object specified in the JAMS Job (or Folder) definition must be a valid OS/400 user.. Parameters The JAMS Agent for Systemi supports a number of parameters that are platform specific. They include: JOBQ - Specifies the OS/400 job queue that the job should execute in. The default is JAMSJOBQ. JOBD - Specifies the OS/400 job description for the job. The default is JAMSJOBD. LIBL - Specifies a library list for the job. There is no default.. 5.9.22 SQLCMD The SQLCmd Execution Method is designed to run native SQL commands on the local server.. 5.9.23 SQLCMDServer The SQLCmdServer Execution Method is designed to run native SQL commands on the server specified in the Job source.. 50. JAMS User Guide.

(51) JAMS User Guide. 5.9.24 SQLCommand The SQLCommand Execution method is designed to run native SQL Commands on the Server specified in the "ConnectionString" parameter. This execution method optionally supports continuing on error.. 5.9.25 SSH The SSH Execution Method uses SSH to connect to a remote system and execute commands. SSH operates on one command at a time, not scripts, so the source code for a Job is treated as a sequence of commands. Each command is executed; JAMS must wait for it to complete before it can send the next command. The SSH Execution Method needs to be able to recognize the command prompt so it knows when a command is complete. This Execution Method understands a number of well-known shells. If the shell that you use isn't recognized, you may have to use a customized version of the SSHPrompt Execution Method. The SSHPrompt Execution Method uses a regular expression to match the prompt. You will have to edit the SSHPrompt Execution Method to change the Application field, which defines the regular expression.. Tracing Connections. 51. JAMS User Guide.

(52) JAMS User Guide When trying to diagnose SSH connection issues, it can be helpful to enable detailed tracing of the SSH connection. You do that by adding a Parameter to the Job. The parameter must be named "JAMSSshLogLevel" (with matching case). The value for the parameter can be: Off Error Info Debug Verbose The additional logging will be written to the Job's regular log file.. 5.9.26 SSHAgent The SSH Agent Execution Method uses SSH to connect to a remote system. It then starts JAMSAgentX, our common agent. JAMSAgentX will accept a Script for execution, execute the Script, and then return the results when the Script completes. The source code for the Job should be a Script that is appropriate for the host where the Job will execute.. Deploying JAMSAgentX Before you can use the SSHAgent Execution Method, you must deploy the JAMSAgentX executable. This can be done via the Agents shortcut on the Management tab.. Tracing Connections When trying to diagnose SSH connection issues, it can be helpful to enable detailed tracing of the SSH connection. You do that by adding a Parameter to the job. The parameter must be named "JAMSSshLogLevel" (with matching case). The value for the parameter can be: Off Error Info Debug Verbose The additional logging will be written to the Job's regular log file. Read the following article on the JAMS Support site for more information: Moving the JAMS AgentX. 52. JAMS User Guide.

(53) JAMS User Guide 5.9.27 SSHDeploy The SSHDeploy Execution Method deploys the JAMSAgentX via SSH.. 5.9.28 SSHOpenVMS The SSHOpenVMS Execution Method is a secure shell with OpenVMS prompt matching.. 5.9.29 SSHPrompt The SSHPrompt Execution Method uses SSH to connect to a remote system and execute commands. This Execution Method is designed to handle an unusual login prompt on the SSH server.. 5.9.30 SSISDirect The SSISDirect execution method is for running SSIS Packages. A form is provided for specifying the Package source and credentials:. 53. JAMS User Guide.

(54) JAMS User Guide. 5.9.31 SSIS SSIS stands for SQL Server Integration Services.. 5.9.32 VBS The VBS Execution Method is designed to run Visual Basic scripts.. 5.9.33 VBSParsed. 54. JAMS User Guide.

(55) JAMS User Guide Parsed Execution Methods are an examples of putting a standard wrapper around Jobs. Examples of this are: SMS Text Alerting (Could be at the beginning and/or the end of each Job.) Syslog Notification (Could be at the beginning and/or the end of each Job.) SNMP Trap Notification (Could be at the beginning and/or the end of each Job.) Executing standard NET USE to map shares Setting environment variables Performing SQL :connect One key detail is that the parsed wrapper could be different between production, test, and development environments. When you copy a Job between environments, you don't have to change the Job. The VBSParsed Execution Method is a parsed VB Script.. 5.9.34 VMS The VMS Execution Method is an OpenVMS DCL command procedure.. 5.9.35 VMSParsed Parsed Execution Methods are an examples of putting a standard wrapper around Jobs. Examples of this are: SMS Text Alerting (Could be at the beginning and/or the end of each Job.) Syslog Notification (Could be at the beginning and/or the end of each Job.) SNMP Trap Notification (Could be at the beginning and/or the end of each Job.) Executing standard NET USE to map shares Setting environment variables Performing SQL :connect One key detail is that the parsed wrapper could be different between production, test, and development environments. When you copy a Job between environments, you don't have to change the Job. The VMSParsed Execution Method is an OpenVMS parsed DCL command procedure.. 55. JAMS User Guide.

(56) JAMS User Guide 5.9.36 WindowsDeploy The WindowsDeploy Execution Method deploys the JAMSAgent to a Windows machine.. 5.9.37 Workflow The Workflow execution method is for running Windows Workflow Foundation Jobs. This execution method is designed for scenarios where a Job requires decision logic and different execution paths to be defined. Jobs are edited using the Workflow Designer which includes JAMS Activities for submitting Jobs, updating JAMS Variables, and many more JAMS specific tasks:. 56. JAMS User Guide.

(57) JAMS User Guide. 5.9.38 MSDAX2009Job Please refer to the MSDAX2012Job documentation.. 5.9.39 MSDAX2012Job Generic to ALL Job Types MSDAXIncludeLog MSDAXIncludeDebugLog Language Specify the Language setting to be used when logging into AX for the Job ObjectServer Specify the Object Server setting to be used when logging into AX for the Job Configuration Specify the Object Server setting to be used when logging into AX for the Job. Report Job Type Specific Query Specify the name of a query to be applied to the report before rendering it. This Query is setup in AX Destination Specify where the report should be sent once rendered Possible Values 1 3 4 Printer Email File Default. 1. Printer Email File Printer Email File Printer. FileFormat Specify the format of the file being exported by processing a report. 57. JAMS User Guide.

(58) JAMS User Guide Possible Values Value ASCII RTF HTML PDF PDFEMBEDFONTS TEXTUTF8 1 2 3 4 5 6. Meaning Ascii Rich Text Format HTML PDF PDF with embedded fonts Text in UTF8 encoding Ascii Rich Text Format HTML PDF PDF with embedded fonts Text in UTF8 encoding. Default Value 1 , Ascii FileName Specifiy the name of the file that the report will be exported to when the destination is set to File. PrinterName Specifiy the name of the printer that the report will be printed on when the destination is set to Printer. FirstPage Specify Default. 0. LastPage Specify Default. 0. Copies Specify Default. 0. Subject Specify the subject of an Email. Used when destination is set to Email To Specify an email address to send the Report to CC Specify an email address to send the Report to. Job Specific Parameters Parm Specify a single parameter to be sent to a Job. Note the job in AX must be designed in such a way to accept a parm.. 58. JAMS User Guide.

(59) JAMS User Guide 5.10 Menus Menu Definitions define customized Menu hierarchies for the JAMS Submit Menu. These are used by JAMS to present a hierarchy of Menus to a user when they want to submit a batch Job. These Menus are available in all JAMS user interfaces and can also be accessed from within your application to submit Batch Jobs. Creating Menus is optional. JAMS can create a default Menu that initially lists all of the available Folders. After the user selects a Folder, all of the available Job and Setup Definitions are then displayed. This section covers: Menu Properties (Section 5.10.1). 5.10.1 Menu Properties Properties for a Menu are categorized as: Includes (Section 5.10.1.1): A list of Menu Detail definitions Menu (Section 5.10.1.2): Menu name, description, and Last Changed information. 5.10.1.1 Includes Displays and allows you to maintain a list of Detail Menu definitions for a Menu. A single Menu definition may have many Menu Detail definitions. Each Menu Detail definition specifies selection criteria used to build a new menu when this Menu Name is specified. Each Menu Detail definition is additive. The Menus, Jobs, and/or Setups selected by a Menu Details' definition are added to the ones selected by previous Menu Detail definitions to build a complete Menu. Include Jobs and Setups from this Folder (Optional) If a Folder is provided here, only Jobs and Setups from the indicated Folder are included in the Menu. Selection Criteria which can include wildcards Only Jobs, Setups, or Menus that match this selection criteria are included in the Menu. Include Jobs If true, Jobs that match the selection criteria will be included in the Menu. If false, Jobs will never be included in the Menu. Include Setups If true, Setups that match the selection criteria will be included in the Menu. If false, Setups will never be included in the Menu. Include Menus If true, Menus that match the selection criteria will be included in the Menu. If false, Menus will never be included in the Menu.. 5.10.1.2 Menu Menu Name Unique identifier for a Menu. Description The description is used in menus, lists, and reports to provide a more complete description of the Menu than provided by the Menu Name. Last Changed Last changed information including the Username of the person who last changed this Menu along with the date and time the change occurred.. 5.11 Users. 59. JAMS User Guide.

(60) JAMS User Guide Usernames are defined and then later assigned to JAMS Folders, Jobs, and Setups. When a Job is submitted, it will run under the Username specified. The use of Usernames is secured in that an access control list (ACL) for the Username exists to determine who may assign or change the Username for JAMS Folders, Jobs, and Setups. This section covers: User Properties (Section 5.11.1). 5.11.1 User Properties Properties for a Username are categorized as: Security (Section 5.11.1.1): Access control list (ACL) that determines who may assign this Username to Folders, Jobs, and Setups Username (Section 5.11.1.2): Username, logon, password, and last changed information. 5.11.1.1 Security Access control list (ACL) that determines who may assign this Username to Folders, Jobs, and Setups.. 5.11.1.2 User Name Username Unique Username for this user. Logon As Can be used to specify the Username that is actually used during login. Set Password Click the Set Password button to set the password for this UserSecurity object. Key Management Click the Key Management button to manage the public and private key for this UserSecurity object. Last Changed Date and time this Username was last changed.. 5.12 Queues. 60. JAMS User Guide.

No results found