Table of Contents
JAMS 6.X Client Features 3
Working with Jobs 4-5
Submitting Jobs Manually 6-7
Working with Setups 8-9
Working with Views 10-14
Working with Folders 15-16
Viewing Job History 17-18
Working with Projected Schedules 19-21
Using Alerts 22-23
Using the Monitor and Gantt Views 24-26
Using the SQL Server Agent Conversion Utility 27-29
Using the Task Scheduler Conversion Utility 30-32
Converting the Task Scheduler, SQL Agent and CRON Jobs to JAMS Jobs 33-34
Assigning Named Times to Jobs and Setups 35-38
Specifying Dates Using Natural Language 39-41
Setting Triggers 42-43
Using Resources 44-46
Working with Dependencies 47-49
Working with Variables 50-53
Using Queues 54-55
Execution Methods 56-62
Menu Definitions 63-65
File Transfer Features 66-69
Working with Agents 70-72
Workflow Jobs 73-77
Manually Generating Reports 78
Creating New Report Templates and Customizing Existing Reports 79-80
Integrating Reports with Automated JAMS Jobs 81-83
Diagrams 84-87
JAMS Security: Setting Access Control Lists 88-91
JAMS Security: Working with User Definitions 92-94
JAMS Security: Managing Encryption Keys 95-96
Preinstalled Dashboards 97-102
Custom Dashboards 103-113
JAMS Scheduler Services 115-117
Configuring the JAMS Scheduler 118-120
Logon as Batch 121
Upgrading JAMS 122
Upgrading from JAMS 5.x to JAMS 6.x 123-124
Upgrading from JAMS 6.x to 6.x 125
Working with Jobs
Essentially, every component in JAMS supports or controls how a Job is defined or run. At its core a JAMS Job incorporates a number of properties and resources that ensures that it executes at the right time and under the proper conditions.
In a nutshell, a Job is a task, script or command that can be run on a variety of systems including: Windows, Unix, and PeopleSoft.
Adding a New Job
1. To create a new Job, activate the Jobs View by clicking on the Definitions Group in the Shortcut Bar and selecting the Jobs shortcut.
2. Choose the Add button on the Ribbon Bar to access the JAMS Job Definition Wizard.
Select Next to open the wizard's Jobs Name page. Enter a unique name for the Job along with an optional description. Click the Next button.
4. The Execution Method page follows. Here you can view and choose from a listing of execution methods by clicking the File Browser button.
5. Select Next to access the Notification Email Addresses page where you can supply one or more addresses to alert staff members if a Job fails or doesn’t complete within an allotted time. 6. On the next page, verify the user account for this Job using the dropdown list or by entering a
valid username and password.
7. On the Source page you can (optionally) enter the Job’s commands. Click the Next button. 8. Moving to the Schedule page, use the Scheduled Date dropdown to define a built in
schedule or manually enter single or multiple date specifications. Click Next. 9. Press the Finish button to complete the Job definition process.
Modifying an Existing Job
1. To make changes to an existing Job, open its properties window by right clicking (or double-clicking) the desired Job listing.
2. From the Job’s context menu select the Properties command.
Deleting an Existing Job
1. Navigate to the Jobs View in the Shortcut Bar 2. Highlight the Job to be deleted
3. Click the Delete button on the Ribbon Bar.
Submitting Jobs Manually
The Submit Jobs View is a listing of all current JAMS Jobs that can be run on demand. This View uses the same expanding folder hierarchy as displayed in the Definitions Group, which is located just below on the Shortcut Bar.
Once the end-user selects a Job they may be presented with a fill-in-the-blank form to define the Job’s required parameters, which can then be edited and verified before the Job is submitted.
With the built-in security model, JAMS users can submit Jobs as long as they have the proper access. As part of the submittal process, users can also modify Job output characteristics such as the print queue or number of copies to output a report.
To submit a Job or Setup follow the steps below:
1. Click the Submit Shortcut if the Submit Jobs View is not already active. 2. Expand the Folder and locate the Job or Setup to be submitted.
3. Double-click or right-click the desired Job or Setup to open the Submit dialog box. 4. Include the desired information in the Parameters, Reports, and Schedule tabs.
Note: Depending on the Job's parameters, there may only be one or two tabs
visible.
Working with Setups
A Setup defines a particular occurrence or view for one or more Jobs. Setups are commonly used to schedule a Job or stream of Jobs that automatically execute at regular intervals. Setups are created and defined using a Setup Wizard.
Start by selecting the Setups shortcut located on the bottom of the JAMS Client View window and then click the
Add button on the Ribbon Bar.
This action opens the JAMS Setup Definition Wizard's title page.
The JAMS Setup Definition Wizard
1. Select Next to open the Setup Name page. Enter a unique name for the Setup along with an optional description.
2. Select Next to access the Notification Email Addresses page where you can supply one or more addresses to alert specific staff members if a Setup fails or doesn’t complete within an allotted time frame. Click the Next button.
4. On the Schedule page (below), use the Schedule Date dropdown to choose from a list of built-in schedules or manually enter single or multiple date specifications separated by commas.
Working with Views
A View is a data grid consisting of columns and rows. Each View displays data that corresponds with a particular Shortcut. A View typically displays table listings for Jobs, Setups, Triggers, Resources, and includes variety of JAMS settings.
Views come with a few basic rules:
While several Views can be active, you can only work with one View at a time. In order to switch between active Views, select a Shortcut on the Shortcut Bar.
The data in any View can be sorted by clicking on a column header.
Customizing Views Using the Column Chooser
With the Column Chooser tool you to add, remove and repositions columns in the Monitor, History and folder Views. To activate this tool, follow the steps below:
1. Right click on any column header within a View to open its context menu.
2. Select the Column Chooser command to view all the column titles in the Customization window.
3. To add a column to the current View, drag and drop a column title to the left or right of an existing column.
Note: Double-clicking a column title appends the new column to the rightmost position within the
current View.
4. To remove an existing column, just drag and drop its header out of position until an “X” appears and then release the mouse.
command.
2. This action opens the Filter Editor window.
4. Enter a value in the blank field to filter the results. Or use the “And +” button to insert additional filter statements.
5. The filtered results appear after selecting the OK button. Use the controls at the bottom of the results screen to delete, disable or edit the search criteria.
Auto Filter Row
1. To toggle the Auto Filter Row on or off, right click on any column header and select the Show/Hide Auto
3. The filtered results appear immediately while typing. Use the controls at the bottom of the screen to delete, disable or edit the search criteria.
Disabling or Restoring a Missing Tab
Users may notice a missing tab when working in a folder view. These modal tabs define what JAMS objects users can see in a folder view: Jobs, Setups, Triggers, and Variables. It is possible that a tabbed view may have been turned off in the Definitions Navigator. To restore the missing tab, follow the steps below.
1. Right-click on the Definitions Navigator header on the Shortcut Bar and choose the Navigator Properties command to access the property window below.
Working with Folders
A JAMS Folder contains a user defined grouping of Jobs and Setups that appear on the Shortcut Bar. Folders can be defined by department (e.g., Accounting, IS, Sales), by function (e.g., EDI, Web, Security, Audit), or any other way that is meaningful to your organization. Follow the steps below to add, edit and delete a JAMS Folder.
Adding a Folder
1. Right-click anywhere in the Definitions group on the Shortcut Bar. 2. Select the Add Folder command from the context menu.
3. The JAMS Folder Definition Wizard Introduction page opens. Click the Next button to move to the Folder Name page.
4. Enter a unique name for the new Folder. Click the Next button.
5. On the Notification page, enter one or more email addresses to alert staff if there’s a problem with a Job or Setup contained in the Folder. Leave the entry field blank if no one needs to receive notifications. Click the Next button.
6. Click the Finish button to complete the Folder definition process.
Editing a Folder
1. In the Definitions group, right-click the Folder that requires editing.
2. Select the Properties command from the context menu to open the Folder Properties window.
3. Using the four tabs on the left portion of the window, make any necessary changes to the Folder properties.
Deleting a Folder
1. In the Definitions group window, right-click the Folder to be deleted. 2. Select the Delete Folder command from the context menu.
Viewing Job History
JAMS tracks all batch jobs, including jobs not originally submitted by JAMS. The History function allows you to view all previously run Jobs, their execution statistics and completion status.
1. To get started, select the History shortcut. This action opens the History Query dialog box.
2. Enter specific parameters to narrow your Job query and then select the OK button.
3. A History Inquiry View appears, listing all Jobs that match the query parameters.
Working with Projected Schedules
The Projected Schedule displays a graphical view of pending JAMS Jobs and Setups. Users can view all scheduled Jobs or filter a subset of Jobs over a specified time range.
To generate a projected schedule for all scheduled Jobs, click on the Projected Schedule Shortcut in the Shortcut Bar. The resulting display defaults to the current 24 hour timeline view.
Filtering the Projected Schedule Results
To filter a specific group of Jobs and Setups, use the Query button located on the JAMS Ribbon Bar.
1. This action opens the query dialog box. Select a Folder Name using the Folder search button or enter a Job Name.
Note: including multiple Job entries is not allowed; however, the Job Name field does allow
for wildcard queries (e.g., *workflow).
2. Enter a Time Range using the date and time selector. 3. Activate the appropriate checkboxes to refine your query.
Use Current Schedule: when enabled, pulls in the current schedule from the Monitor View.
Include Planned: filters all scheduled Jobs including those with the “Automatically Submit?” option
unchecked.
Include Repeated: when checked, this option includes all Job repetitions in the schedule.
4. Click the OK button to build the Projected Schedule based on your query parameters.
After generating a Projected Schedule, users can modify their results by selecting different views: Day, Work Week, Week, Month and Timeline.
To change the timeframe, right-click within the Projected Schedule display to view the context menu. Make a selection from the Change View To submenu or use the Go to Today or Go To Date options to modify the timeframe display. Depending on the selected view, you can also adjust the Time Scales and Captions.
Note: to zoom in and out of any Projected Schedule display, hold down Ctrl key while scrolling
the mouse wheel.
Color Flags
The Projected Schedule display uses specific color flags when a Job’s execution time deviates from its set parameters as detailed below:
Items (Jobs or Setups) in red are expected to run beyond their designated SLA (Service Level Agreement) time.
Installing the Projected Schedule Shortcut after Upgrading JAMS
JAMS V6.1.281 added the Projected Schedule function to the Shortcut Bar. For new JAMS installations, the Projected Schedule Shortcut appears by default. However, if you are running an earlier version of JAMS you must first upgrade to JAMS 6.1 or later and then add the Projected Schedule Shortcut using the manual process described below.
1. Right-click the Shortcut Bar and select Add Shortcut command from the context menu.
2. In the Add a Shortcut wizard, define the Name and Title (e.g., Projected Schedule) and choose an icon. Click the Next button.
3. On the View page, choose the Projected Schedule option from the list and click Next.
4. On the following page, define the Properties for the Projected Schedule view. For each view you can set different parameters for displaying the schedule (e.g., by Folder or Job name). Select the JAMS Server from the dropdown list, or choose the Active Server option to automatically generate a Projected Schedule using any accessible JAMS server.
Use Current Schedule: pulls in the current schedule from the Monitor View which is controlled from
the “ScheduleAdvance” option in Configuration Settings.
Include Planned: filters all scheduled Jobs including those with the “Automatically Submit?” option
unchecked.
Include Repeated: allows the Projected Schedule to include Jobs submitted based on their
recurrence schedule.
5. On the last page of the wizard, confirm your choices. At this point you can create additional Views or change the View properties by selecting the Query button from the Ribbon Bar. Click the Finish button to close the wizard.
Using Alerts
JAMS has several built-in Alerts that can be configured to send e-mail notifications to users when certain conditions are met. The following table describes the conditions that can trigger a predefined Alert.
State
Description
ActivityTimeLimit A workflow activity exceeded the assigned time limit.
EntrySucceeded An entry (Setup or Job) has successfully completed execution. EntryFailed The entry has failed to properly execute.
EntryShort An entry has completed too quickly. The time is set by the user in the "Notify Options" of a JAMS job and is based either on a set time or on a percentage of the average completion times.
EntryStalled An Alert based on a Job or Setup that has been pending in the schedule for too long.
EntryRunaway An entry has been executing for too long. This time is set by the user in the "Notify Options" of a JAMS job and is based either on a set time or on a percentage of the average completion times.
EntryMissedWindow A Job or Setup that missed the window for its scheduled run time.
Creating Alerts
1. Click on the Alerts shortcut in the Management group. 2. Select the Add button to start the Alert Definition Wizard.
3. Step through the wizard to define the Alert name, events, and notification details. Minimally, you must provide a unique name for the Alert.
4. Click the Finish button to complete the Alert definition process.
Assigning an Alert
Once an Alert has been created you can assign it to any JAMS Job, Setup or Folder. To get started: 1. Double-click on a JAMS object (Job, Setup or Folder) to open the details window and click on the
Properties tab located on the left side of the window.
2. At the lower part of the Properties tab expand the Alerts group. To assign an Alert to the JAMS object check the listed Alert to activate.
Note: If an Alert is assigned to a Folder it will be applied to all Jobs and Setups located within
that Folder.
Customizing Alerts
You can customize the Alert notifications by adding or removing information about a particular JAMS Job. Custom alerts can be defined in the Alerts property for any Job, Setup or folder. These notifications can be defined by adding email address to the Notification Names section for that alert.
Emails defined at the Folder and Job level can be removed on a per Job/Setup basis by placing a “-*” (excluding quotes) in front of the entered email address.
JAMS has additional built-in alert capabilities which can be referenced when making calls to the JAMS SDK. These additional alerts tend to be used more for in-house development purposes rather than for end-users.
Parsing in Alerts
Using the Monitor and Gantt Views
The Monitor enables users to view current Jobs and Setups in the Scheduler and provides access to comprehensive Job management tools. Use the following steps to open and manage current Jobs and Setups.
Accessing the Monitor
To get started, select the Monitor shortcut to open the Current Jobs View.
Customizing the Monitor View Using the Column Chooser
With the Column Chooser tool you to add, remove and repositions columns in the Monitor View, as well as the History and folder Views. To activate this tool, follow the steps below:
1. Right click on any column header within a View to open its context menu.
2. Select the Column Chooser command to display all column titles available in the Customization window.
3. To add a column to the current View, drag and drop a column title to the left or right of an existing column.
Note: Double-clicking a column title appends the new column to the rightmost position within the
current View.
4. To remove an existing column, just drag and drop its header out of position until an “X” appears and then release the mouse.
Icon Job or Setup Status Description
Waiting for a dependency to complete Currently executing
Halted, usually due to a failed Setup Job On hold by the user
Pending-waiting for a Setup Job step to begin executing Status flagged as containing an error
Status flagged as fatal
Status flagged as "informational", based on specific source code values or the Execution Method
Status flagged as successful
Status flagged as containing a warning Timed or scheduled
Managing a Job or Setup
To manage a Job currently in the Schedule, right-click on a Job from the Monitor Current Jobs View to open its context menu.
Select the Show Details command or just double-click the Job name to open its defintion window.
Each Job or Setup listed in the Scheduler displays a number of properties as shown in the above screenshot and detailed in the table below.
Job
Properties
Description
General Displays Folder, Setup, Submit and Job status information. Statistics Shows times, execution statistics and related charts. Log File Lists all OS generated logs.
Dependencies Details the dependencies for the Job or Setup.
Parameters Details parameter names and values associated with the Job or Setup.
Audit Trail Lists audit trail items for the Job, including: message, comment, user name, local and UTC audit times.
The Gantt View provides a visual representation of currently scheduled Jobs or Setups. It plots their current run times against average run times.
Like the Monitor, the Gantt View provides quick access to the properties (e.g. parameters, security and dependencies) for each JAMS Job or Setup.
Using the SQL Server Agent Conversion Utility
This utility lists all SQL Server Agent Jobs running on the current JAMS Client and those located on remote servers.
Accessing SQL Server Agent Jobs on the Local Machine
To view all SQL Agent Jobs located on the current machine, select the External tab on the JAMS Ribbon Bar and click on the SQL Agent Jobs Shortcut.
By default, this will display SQL Agent Jobs currently configured on the local machine.
Displaying Configured Jobs on a Remote Machine
To view a listing of all SQL Agent Jobs located on a remote machine you must define and create a shortcut that’s links directly to the SQL server. Use the steps below to set up the shortcut.
1. On the External tab, right-click on the Shortcut Bar (in the SQL Agents group) and choose the
Add Shortcut command to open the Add Shortcut Wizard.
3. On the next page select a View. Choose SQL Agent from the list and click Next. 4. Enter the SQL Server instance in the appropriate field and click Next.
5. Select the Finish button to complete the Shortcut definition.
When the newly added shortcut is selected, all Jobs on the specified remote machine are displayed. If no Jobs appear, make sure there are SQL Agent Jobs present and your user account can access the remote Jobs.
Supported SQL Scheduler Versions
JAMS agents support monitoring of SQL Agent jobs for the following versions of SQL Server. SQL Server 2014
SQL Server 2012 SQL Server 2008 SQL Server 2005
The version in use is determined by SQL Server currently installed with the JAMS Client. If the client is running SQL Server 2012, then it can access Jobs from instances running previous versions of SQL Server. However, if the JAMS Client is running SQL Server 2005, it can only access Job information from instances running from that server version.
Converting Tasks
1. To convert a SQL Server Agent Job to a JAMS Job, select a Job from the SQL Job Definitions list, right-click, and choose the Convert option or use the Convert to JAMS button on the Ribbon Bar to access the conversion wizard.
Starting, Stopping and Deleting SQL Agent Jobs
Using the Task Scheduler Conversion Utility
The Task Scheduler Conversion Utility allows you to view a description of all Windows Task Scheduler Tasks on the machine running the JAMS Client as well as those located on other computers.
Accessing and Displaying Scheduler Tasks
To view the installed Tasks running on the current machine, select the External tab on the JAMS Ribbon Bar and click on the Scheduler Tasks shortcut.
By default, this will display all Windows Scheduler Tasks currently configured on the local machine.
Displaying Configured Tasks on a Remote Machine
To display a listing of configured tasks located on a remote machine, go to the External tab. Right-click the Shortcut Bar and choose the Add Shortcut option to start the Add Shortcut Wizard.
Scheduled Tasks option from the View list and click the Next button. 3. On the wizard's Property page enter the UNC path for the remote computer.
Note: For Windows Vista, Windows 7 or Server 2008, the Task Scheduler supports folders to
organize Tasks. However, if the Folder Name field is left blank, then Tasks from all folders are displayed. To limit the results, enter the path of the desired folder. Entering a single backslash "\" displays all Tasks in the root folder. However, using the above example, Tasks within the
\Microsoft\Windows\Defrag\ directory will appear in the Task Definitions View.
4. Click the Finish button to complete the wizard.
When the newly added shortcut is selected, all Tasks within the Defrag directory on the remote machine are displayed. If no tasks appear, make sure there are Tasks present and your current user account can access the remote Tasks.
Note: After changing the shortcut’s Query properties, select the shortcut in the Shortcut Bar and click
the Refresh button in order for the Query changes to take effect.
Scheduler Versions
There are two supported versions of Windows Scheduler. The version in use is determined by the operating system on which the JAMS Client is installed. If the JAMS Client is running on Windows Vista, Windows 7 or Server 2008, then it will be able to access Task information from other machines.
However, if the client is running Windows XP or Server 2003, it will only be able to access Task information from other machines running XP or Server 2003. That’s because the libraries required to access Tasks on Vista and Server 2008 machines are not present and cannot be retrieved from these servers.
Converting Tasks
To convert a Task Scheduler Task to a JAMS Job, right-click any Task from the Task list and select Convert from the context menu. You can also use the Convert to JAMS button located on the Ribbon Bar.
A Conversion Wizard opens. On each step of the wizard, fields will be pre-populated with information. You can modify the information before the new JAMS Job is created.
Note: Not all options for a Task Scheduler task are supported by JAMS and you may receive an error
when advancing the wizard to the next conversion step.
If a Task property cannot be directly converted to a JAMS Job property then a new Wizard screen will display so that the property can be changed accordingly. Any Task that cannot be converted automatically can be canceled.
Note: Tasks can also be started, stopped, and deleted from Task Scheduler. Simply select a Task from
the Task list and click the appropriate button on the Ribbon Bar.
It is also possible to convert multiple Tasks concurrently. Just select several Tasks from the Task list and click the
Converting the Task Scheduler, SQL Agent and CRON Jobs to
JAMS Jobs
Converting Windows Task Scheduler Tasks
During the installation process, JAMS searches for all local Task Scheduler tasks, and if any are detected, a converter window opens listing these jobs.
To convert the local Task Scheduler tasks to JAMS Jobs, right-click on a listed Task Scheduler task and select the
Convert to JAMS command from the context menu.
Note: Task Scheduler tasks are supported for these operating systems: Windows XP, Vista, Windows 7,
8 and Windows Server 2003, 2008 and 2012.
Accessing and Converting Remote Task Scheduler Tasks
All Task Scheduler tasks located on an external machine can be queried using the Task Scheduler Monitor.
To convert a remote Task Scheduler task to a JAMS Job, highlight the job and press the Convert to JAMS button on the Ribbon Bar or use the steps below:
1. Select the Scheduler Tasks shortcut located on the External tab. 2. Select a Job from the Task Definitions View and right-click. 3. From the context menu choose the Convert command.
4. A Conversion Wizard opens. Moving through the wizard, some fields may be pre-populated with information that can be edited before the new JAMS Job is created.
For more information on how to convert Task Scheduler tasks, please refer to the help topic: Using the Task
Scheduler Monitor.
Converting Multiple Remote Task Scheduler Tasks
To convert multiple Scheduler tasks to JAMS Jobs. . .
1. Highlight two or more tasks from the Task View (control + Click).
2. Right-click one of the highlighted tasks and select the Convert to JAMS command from the context menu. 3. This will open the Conversion Wizard. The first few steps will prompt for information common to all the
selected tasks. The wizard then converts the selected tasks to JAMS Jobs.
Converting SQL Agent Jobs
previous section.
To convert a Server Agent job to a JAMS Job, select the job and use the Convert to JAMS button on the Ribbon Bar or follow the steps below:
1. Using the External tab, click the SQL Agent Jobs shortcut. 2. Select a Job from the SQL Job Definitions list and right-click.
3. From the context menu choose the Convert command to open the Conversion Wizard. 4. Use the wizard to define the necessary conversion parameters.
For more information on how to convert SQL Jobs, please refer to the topic: Using the SQL Agent Monitor.
Converting Multiple SQL Agent Jobs
To convert multiple SQL Agent jobs simultaneously . . .
1. Highlight two or more jobs from the SQL Job Definitions View (control + Click).
2. Right-click one of the highlighted jobs and choose the Convert to JAMS command from the context menu.
3. This action opens the Conversion Wizard. The first few steps will prompt for information common to all the selected jobs. The wizard then converts the SQL jobs to JAMS Jobs.
External Conversion Utility for CRON
JAMS can quickly convert CRON jobs to JAMS Jobs using a free UNIX Cron2JAMS converter. This tool converts your crontab configuration files to a single PowerShell script which can then be run from the JAMS Client.
1. To start, use the link to download the UNIX Cron2JAMS converter by first logging into the JAMS Technical Support site.
2. When launched, the Cron2JAMS.exe converter tool uses a script that converts existing CRON jobs into a single PowerShell script that can be quickly converted into a JAMS Job.
3. Open a command prompt (cmd.exe) on your JAMS Scheduler machine.
4. Change the directory to the location where you extracted the Cron2JAMS.exe zip file. 5. Call the Cron2JAMS with the necessary parameters that are described below.
Cron2JAMS Parameters
Inputfile: the path to the crontab file to be converted to JAMS Job definition. If the crontab file is in same
location as the Cron2JAMS.exe file, just use the file name.
Outputfile: the path and filename for the PowerShell script that Cron2JAMS creates. If the output file is in the
same location with the Cron2JAMS.exe file, use the file name.
JAMSServer: the JAMS Server where the JAMS Jobs reside. If the Cron2JAMS converter is located on the same
machine, you can substitute with “localhost”.
JAMSSystem: the system definition where all the converted Jobs are placed. AgentNode: the name of the JAMS Agent that run the Jobs.
UserName: the JAMS UserName that can run the Jobs.
Assigning Named Times to Jobs and Setups
JAMS includes different methods for scheduling Jobs and Setups. One is to create a straight-forward schedule with fixed start and end execution times. Another method defines a flexible windows of time when Jobs may be scheduled. Using this “Named Times” option JAMS can prevent Jobs from executing until their scheduled window is enabled and can also take various actions when a Job’s window closes before the Job completes.
Defining or Modifying Schedule Windows to Jobs and Setups
You can assign a Named Time to Jobs and Setups using a schedule window. If the time window needs to be shorter or longer, or a new time-of-day-range needs to be set, you make just one entry that applies to all Jobs and Setups that use it. This simplifies the process of making schedule modifications to Jobs and Setups to just a few key strokes.
To assign a new or edit an existing Named Time definition, follow the steps below: 1. From the JAMS Client click the Times shortcut in the Management Group. 2. The Named Time Definitions View opens.
3. To create a new Named Time definition, click the Add button on the Ribbon Bar to open the JAMS Named Time Definition Wizard. Enter a unique name for the Named Time and specify a start and end scheduled time. Click the Finish button.
To modify an existing Name Time, double-click a definition from the list to open its property window. Select the Times tab and make any modifications to the start and end time schedules.
For more information, refer to the Named Times Properties section at the end of this topic. Use the following controls to modify each Named Time definition.
Start Time: enter the time of day this Named Time is scheduled to be enabled.
Automatically enable: Enable the checkbox if you want JAMS to automatically enable this Named Time at the Start Time specified. If unchecked, the Named Time remains disabled until it is manually enabled.
End Time: enter the time of day this Named Time is scheduled to be disabled.
Automatically disable: Enable the checkbox if you want JAMS to automatically disable this Named
Time at the End Time specified. If unchecked, the Named Time remains enabled until it is manually disabled.
Last Time Window was Automatically Enabled or Disabled: the date and time the selected Named
Time was automatically enabled or disabled.
Currently Enabled: True if the Named Time is enabled. Use the button to manually enable or
disable the Named Time.
Named Times can be used to limit when manually submitted Jobs are allowed to run; for example, during periods when other Jobs may use significant system resources. See the Missed Windows Action No Action option described in item #6 below.
Assigning Named Times to Jobs and Setups
1. To get started, double-click a Job or Setup to open its definitions window.
2. From the definitions window select the Properties tab. Locate and expand the Submit Times option.
3. Click the File browser button to view a list of existing Name Time definitions. Double-click a definition to populate the field.
4. Use the adjusters to define the desired schedule time window.
5. From the dropdown list, select an action when a Job or Setup fails to execute within the defined schedule window. The options include:
No Action: the schedule window is used to limit the times when the Job or Setup is manually
submitted.
Continue: the Job or Setup does not start until the time window opens but does not reschedule or
abort if the window closes before the Job or Setup completes.
Abort or Delete: the Job or Setup does not start until the time window opens and is aborted or
deleted if the window closes before the Job or Setup completes.
Reschedule or Continue: if the Job or Setup has not started when the window closes it is then
rescheduled to start during the next open window. However, if the Job or Setup has started, it can continue.
Restart or Reschedule: If the Job or Setup has not completed when the window closes, it is
rescheduled for the next open window. If the Job or Setup is executing when the window closes it is aborted and then rescheduled.
6. Optionally, enable the Notify of missed window? checkbox to tell JAMS to perform a Job or Setup notification if a Schedule Window is missed.
7. Save the changes in the definitions window.
Named Time Properties
The Named Time Properties are divided into two tabs: Named Time and Times.
Name
This property includes the unique identifier for the Named Time.
Description
This optional property appears in menus, lists and reports and provides a more detailed explanation for the Named Time.
Last Changed
The Last Changed property displays the user (Username) who last modified the Named Time along with the date and time of the modification.
Times tab
Enter the time of day the Named Time is scheduled to begin.
Automatically enable
If checked (true), JAMS automatically enables the Named Time at its specified Start Time. When unchecked (false), the Named Time remains disabled until it is manually enabled.
End Time
Enter the time of day the Named Time is scheduled to end.
Automatically disable
If checked (true), JAMS automatically disables the Named Time at its specified End Time. When unchecked (false), the Named Time remains enabled until it is manually disabled.
Last Time Window was Automatically Enabled or Disabled
This property displays the last date and time when the Named Time was automatically enabled or disabled.
Currently Enabled?
Specifying Dates Using Natural Language
As a scheduling application JAMS uses date specifications for many of its features and functions. Sometimes using exact date specification is sufficient for scheduling a Job or Setup. However, most of the time a generic date (e.g., using Workdays or First Friday of the Month) can provide additional flexibility. JAMS has been designed to support natural language and generic date entries throughout the client interface.
There are three key scenarios for JAMS to accept generic date specifications:
Scheduled dates: generic dates can be used when scheduling a Job or Setup in JAMS.
Default parameters: if a Job parameter’s data type is DATE, you can specify a default value using
generic date specifications.
Note: When a user selects a Job, they are presented with a form to set values for the Job's
parameters. Parameters with a data type of DATE are presented using the standard MM/DD/YY date field, but JAMS uses the generic date specification to determine the default date.
Setup parameter values: When defining a Setup, JAMS prompts for the Job's parameter values. If the
Job parameters uses the DATE data type, the parameter form displays a sixty-character text field for the date parameter rather than the standard MM/DD/YY field. You can then enter a generic date specification.
Note: When JAMS automatically submits Jobs, prompting for the parameter values is not
possible. Instead, the generic date specification is evaluated to obtain the value for the parameter.
Simple Date Specifications
Simple date specifications specify a date relative to the current date. The format and description for a simple date specification is as follows:
Day-of-Week: can be the full name of a weekday or the first three letters of a weekday name. When
specifying a day of the week, e.g., MONDAY, JAMS interprets this as “Monday of this week.” In this context, a week begins on Monday and ends on Sunday.
The days of the week can be preceded by a modifier such as LAST, THIS, or NEXT. Inserting a THIS
modifier has no effect and is used only for readability.
When using a modifier, such as LAST, JAMS interprets this to mean " the weekday from last week." Workdays: If you specify "WORKDAY" or "WORKDAYS", JAMS determines if a day is a workday using a
two-step process.
1. JAMS looks at the WORK_ddd configuration setting, where ddd indicates the day of the week (e.g.
Wed). This sets up the initial true or false indication that the day is indeed a workday.
2. For the date in question, JAMS also searches for special dates. To access, select the Date shortcut and double-click the desired date.
If the Workday check box is enabled, the date is a workday. If the Workday box is unchecked, the date is not a workday.
the workday status.
Weekdays: specifies the first weekday after the current date. Today: identifies the current date.
Tomorrow: displays the current date plus one day. Yesterday: displays the current date minus one day.
Daily: is synonymous with TODAY and used primarily for readability.
+/- number of days: is a simple date specification that can have positive or negative integers
appended, adding or subtracting the indicated number of days.
Valid Simple Date Specifications
Included below are some examples of valid, simple-date specifications:
TODAY + 5 NEXT MON LAST TUESDAY WORKDAYS
Complex Date Specifications
Complex date specifications are used to stipulate a date relative to an arbitrary period of time (e.g., describing 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 [+/- number of days] The syntax for the day-of-period specification can take one of two forms. Both forms are comparable.
The two forms for the day-of-period specification are:
LAST 1[st] 2[nd] 3[rd]
integer [st, nd, th]
Note: If you do not specify the day of period, the default becomes the current day.
The syntax for the period specification is:
THIS NEXT LAST YEAR MONTH Month-name Date-Type Specific-Date-Type Date-Type Specific-Date-Type
Note: While this syntax specification may seem overly complex it actually a mimics how people
commonly specify dates.
User Defined Period
When specifying a period with user defined Date Types, you may need to supply both specific and generic Date Types. For example, if you 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 Date Type PERIOD_02, then you must specify FISCAL PERIOD_02.
Specifying Weeks
When used in the context of a time 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 January 1st, 2014.
Specification Date
FIRST MONDAY OF NEXT MONTH 03-FEB-2014
2ND MONDAY OF THIS MONTH 13-JAN-2014
FIRST MONDAY OF LAST JANUARY 07-JAN-2013
6TH WEEKDAY OF NEXT MONTH 10-FEB-2014
6TH WEEKDAY OF MONTH 08-JAN-2014
LAST DAY OF LAST MONTH 31-DEC-2013
2nd DAY OF THIS WEEK 31-DEC-2013
Setting Triggers
Triggers are used to define event-based schedules. A Trigger contains two important settings: events and actions. When JAMS determines that all Trigger events are true, it then executes a user-defined list of actions.
Setting up a New Trigger
To setup a new Trigger, follow the steps below:
1. Highlight the Triggers shortcut, located at the bottom of the window, to open the Trigger Definitions View.
Note: When viewing the Trigger Definitions View, select the Refresh button in the Ribbon Bar to
insure you are seeing the latest JAMS Triggers listings.
2. Click inside the Triggers Definitions View. Choose the Add button on the Ribbon to open the JAMS Trigger Definitions Wizard. Select the Next button.
3. Enter a name for the new Trigger. Click Next.
4. On the Triggers Events page create the event(s) that you need to initiate the Trigger actions. Use the Add dropdown to choose the Event type. Depending on the Event type selected (Job, Setup, File, Variable Event, or Mail Event) an Event window opens.
For each selection (except for the Mail event) click the File Browser button and navigate to the desired trigger event (Job, Setup, File or Variable Event) in the search window. Double-click the selection to close the Event type window.
5. The selected Trigger Event appears on the Trigger Events page. Complete the remaining entries. Click the
Close button and save the entry. The selected event now appear on the Trigger Events page. Continue to
add more events or choose the Next button.
6. The Trigger Actions wizard page opens. Click the Add button to open the dropdown menu and choose an action type (Submit Job or Submit Setup). Depending on your choice a Trigger Job or Setup action window appears.
2. Open the selected Triggers definition by right-clicking the Trigger entry and choosing the Properties command from the context menu or just double-click the Trigger item from the list.
3. From the Triggers definition window, use the property tabs to make changes.
On the Events tab insert a new Trigger by choosing the Add button or modify any existing properties by double-clicking the Trigger under the Description header or choose the Properties button.
4. Use the Properties button to make any changes to that Event.
Using Resources
JAMS Resources are powerful tools that can help you allocate how batch Jobs are run. Resources let you define the necessary requirements for all Jobs and Setups, allowing JAMS to determine which Jobs can run concurrently. Resources can be assigned to Folders, Jobs, and Setups. The Resource itself is defined by setting a specific quantity. Jobs and Setups typically utilize a portion of this quantity when they run.
Resource Allocation-Automatic and Manual Configuration
JAMS can automatically control how each Job or Setup acquires and releases the Resources assigned to them. The Resource quantity available can be manually increased or decreased at any time. You make the modifications in one place and it is available to all Jobs and Setups that need it.
As your batch processes move from one operating system to another JAMS continues to enforce the assigned Resources requirements.
Resource Behavior
Resources have some unique characteristics that are listed below:
Jobs and Setups inherit the Resources that have been defined in their respective Folders. Jobs and Setups can actually reduce or increase the inherited Resource requirements. Jobs and Setups can add their own Resource requirements.
Sufficient Resources must be available for a Job or Setup to run.
During the Setup execution process you can hold Resources across for all component Jobs. Resources can be specific to a node or server.
Resources can be used on any JAMS supported operating system.
The available Resource quantity can be increased or decreased at any time.
Adding a New Resource Definition
1. To define a Resource quantity, select the Resources shortcut located on the Configuration group.
2. The Resources Definitions View opens.
1. Open the Resources shortcut.
2. From the Resource Definitions View, double-click the selected Resource to open its definitions window. 3. Use the Available tab to change the Quantity Available setting.
4. Click the Security tab to choose the access level for the Resource. See the following subsection (Setting Resource Security) for a description of each access level.
5. Click the Close button to save your changes.
For a complete listing and description of each Resource property, refer to the Resource Properties topic.
Determining How Much Resource to Assign a Job or Setup
When manually modifying Resources, as described above, how do you know how much or how little to assign to a particular Job or Setup?
JAMS provides several ways to determine if a Resource is working above or below its effective allocation.
Use the Dashboard
Both the Advanced and Current Load Balancing Dashboards (available on the JAMS Client version 6.1 and newer) incorporate a graphical summary of information and trends within the JAMS environment. Specifically, both include a Resources subpanel to determine the load availability for each available Resource. For more information on using the built in Dashboards, go to the topic: Preinstalled Dashboards.
Insert a Quantity in Use Column
To see what Resources are currently active, use the Column Chooser to insert a Quantity in Use column in the Resource Definitions View.
Access the Monitor
Open the Monitor to view the status of all Jobs and Setups. If a Job or Setup has stalled or flags a ‘Waiting for Resources’ description, consider increasing the Resource allocation.
Resources in Use
SELECT M.resource_name, M.qty_available,
IsNull((select SUM(U.qty_in_use)
from dbo.ResourceInUse as U
where U.resource_id = M.resource_id), 0) as InUse FROM dbo.ResourceM as M
Adding an Existing Resource to a Job, Setup or Folder
1. Open a Job or Setup definition by double-clicking the selecting the item.
2. Select the Properties tab. Open the Resources subsection and choose the Add button.
3. This actions opens the Resource Search window. Double-click an existing Resource from the Resource Search list to associate it to the current Job or Setup.
4. Save the Job by clicking the Close button at the upper right of the definitions window.
Deleting a Resource
To delete a Resource, open the Resource Definitions View and highlight the Resource to be removed. From the Ribbon Bar choose the Delete button.
Note: you must have the proper level of access in order add or delete a Resource.
Inheriting a Resource Definition via Folders
Jobs and Setups can inherit the Resources defined within their Folder. This inheritance feature simplifies the assignment of Resources to any Job or Setup.
Working with Dependencies
Dependencies are prerequisites that must be completed before a scheduled Job or Setup can execute. A single Job or Setup can have an unlimited number of Dependencies. In fact, a JAMS Job can serve as a Dependency for any other Job regardless of where or how the Job runs. Other JAMS components, including Scripts, cannot be released to run until all their dependent Scripts have been successfully completed. For example, a Powershell script designed to run on Windows could have dependent Scripts that must complete first on other JAMS supported operating systems.
Dependency Types
JAMS supports the following types of Dependencies: Job Completion
Setup Completion File Availability Variable Value
Remote Job Completion Remote Setup Completion
In addition, you can create your own user-defined Dependency (called Pre-Check Jobs). User-defined
Dependencies add the ability to handle any type of pre-processing needs. For more detail, please refer to the Job Properties Pre-Check section located in the Job Properties topic.
Completion versus Wait States
JAMS evaluates each Dependency at the entry's scheduled start time. If all the Dependencies are satisfied, JAMS allocates the necessary resource and runs the Job. However, if any of the Dependencies are not satisfied, the entry is moved into a “wait state”. When other Jobs complete, JAMS checks to see if the Job completion will satisfy any ‘waiting’ Dependencies and, if it does, releases the waiting entries.
Defining a Job Dependency
Dependencies are defined within the Job’s properties and can only be created after a Job has been initially defined.
1. To set up a Dependency for an existing Job, open its property window and select the Dependencies tab.
2. Choose the Add button to open the Dependency wizard’s initial screen.
Note: In this example, the Job dependency option was selected making the current Job
dependent on another Job completing a run. For a complete listing and description of each Dependency Type and their associated properties, go to the related topic: Dependency
Properties ('Job Properties' in the on-line documentation).
4. The following screen displays properties related to the Job Dependency Type selected on the previous screen. Choose a dependent Job using the adjacent file browser button. Make sure the chosen Job populates the Depends on Job property.
5. Choose a Minimum Completion Severity value from the drop down list.
Note: The Depends on Job must complete with a severity level that is equal to or less severe
than the chosen minimum value.
6. Click Finish to complete the setup process or choose Next to go to the following Job Dependency set up page.
7. At the top of the following page, click the file browser button next to the Since the last time this job ran property. This action opens a pick list. Choosing a Job from the list populates the aforementioned
property.
Typically, the selected Job for this property is used as a reference to determine if the previously defined
An example of a time-based dependency might be where you have one update Job and a number of reporting Jobs. If an update Job runs at the end of every month, followed by the reporting jobs, you could define a dependency for each reporting Job requiring that each update Job be completed within the previous 28 days.
Note: If the Or within the last and the Since the last time this Job ran properties are
unpopulated, the current Job, when submitted, waits in the queue until the Depends on Job completes with a satisfactory status.
Choose the Next button to move to the final wizard page. 9. Wait for all instances of the Job to complete?
If this property is enabled, JAMS will check to see if the Depends on Job is scheduled or executing. If one or more of the Depends on Jobs are found, the current Job will remain in a pending state until all occurrences of the Depends on Job have completed.
Working with Variables
A Variable contains a single slice of data that can be globally defined for all JAMS Jobs. Variables are a powerful tool that can make batch processing easier and more effective. Once a Variable is defined you can use it in a variety of ways including . . . .
As a default value for a Job parameter. When working with multiple Jobs that require the same parameter value, creating a default value within a Variable can greatly increase efficiencies, allowing you to modify a value in one place to make changes to all Jobs that use the Variable.
Directly within the Job Source. Variables can be specified in the Job Source using
<<VariableName>>.When the Job runs it uses the value of the Variable in place of its original
specification.
As an undefined parameter in a parsed Job. Parsed Jobs can use the value of a Variable. In fact, the
Variable does not need to be associated with the Job, other than to include the Variable within the command file where you need the Variable's value to appear.
In Job Dependencies. One type of Job and Setup Dependency relies on the value of a Variable. You can
quickly define Dependencies that require a specific Variable condition to execute a Job or Setup.
In Trigger Events. Triggers are used in event-based scheduling scenarios. JAMS supports both event and
calendar scheduling simultaneously. You can design a Trigger event to use the value of a Variable to fire Trigger actions.
In your application programs and/or DCL command procedures. You can retrieve or set the value of
Variables using command procedures. This can be very useful for Jobs that do not use a parsed execution method, but still need to use the value of the Variable for their process. Whether parsed or not, Jobs that have access to the JAMS command-line interface can set the value of Variables.
Defining a New Variable
To create a new Variable, use the steps below:
1. Highlight the Variables shortcut, located at the bottom of the window. This action opens the Variable Definitions View.
DateTime (a date and time of day, e.g., 12/31/2015 2:00:00 PM) Float (a floating point number, e.g., 3.0, -122.5)
Unknown (any data type)
5. Choose the Next button and then select the Finish button on the following page to complete the Variable setup process.
6. The new Variable appears in the Variable Definitions View.
Variable Properties
You can modify an existing Variable by opening it properties. Double-click an item in the Variable Definitions View to open its properties.
Each Variable definition is organized into three tabs: Variable, Value and Security. The properties in each tab is detailed in the sections below.
Variable
This tab contains three properties that describe the Variable in general terms.
Variable Name
Includes the unique name for the Variable.
Description
This optional property can provide a more complete explanation of the Variable.
Last Changed
Value
The two properties contained in this tab define the value of the Variable.
Data Type
Each Variable must be assigned a Data Type as described in the previous section. Use the dropdown list to make a selection.
Value
Enter the value of the Variable that corresponds with the selected Data Type.
Security
The properties on this tab essentially act as an access control list with one to many Access Control Entries (ACE). Each ACE can specify the following rights:
Change: permits modification of the Variable definition provided the user also has Change access to
Using Queues
A JAMS Queue provides a temporary holding place for pending Jobs and Setups on a first-in-first-out basis. Queues can be assigned to Jobs, Setups and Folders.
Queues are either in a started or stopped state and can be set to run multiple jobs simultaneously. To enhance load balancing capabilities you can also specify what node a Queue is started on.
Note: Defining and using Queues in JAMS is optional.
Defining a New Queue
To define a new Queue, follow the steps below: 1. On the JAMS Client select the Queues shortcut. 2. This action opens the Queues Definitions View.
3. Choose the green Add button on the JAMS Ribbon to open the JAMS Queue Definition Wizard.
4. On the Queue Name page, enter a unique name and description for the Queue. Click the Next button. 5. Choose Finish to complete the Queue definition process.
Modifying Queue Properties
Queues can be modified by accessing its definitions window.
1. To open a Queue's property definition, double-click a Queue from the Definitions View list.
2. A Queue definition is organized into two tabs. The Name tab displays a Queue’s basic Name, Description and Last Changed properties. The Status tab allows you to adjust the Queue’s start/stop status and Job Limit setting.
On the Status tab the Status checkbox indicates if the Queue has currently started. If true, Jobs submitted to the Queue are available to run.
Note: An Agent node name in a Job definition overrides an Agent node name in a Queue
definition. However, the Job still runs on the assigned Queue and adheres to any Job Limit settings defined within the Queue.
Manually Stopping and Starting a Queue
When a Job is waiting for a Queue Job limit slot it cannot execute. However, you can manually start a Queue by right-clicking the Queue’s context menu from the Queue Definitions View and choosing the Start command. Conversely, you can select the Stop command to manually halt the Queue.
Queues and Resources
While there are similarities between Batch Queues and Resources there are some significant differences that are spelled out below.
A Batch Queue is defined by the number of concurrent Job executions and Job limitation settings. When submitting a Job, a Batch Queue can be adjusted, but a Resource cannot.
A Resource definition is based on the total number of unit quantities available. As these Jobs run they consume the available units that are released upon completion.
Execution Methods
An Execution Method defines how a Job executes within the JAMS environment. A default Execution Method is assigned to every Job if one is not specifically assigned.
JAMS ships with dozens of Executions Methods to run Jobs on Windows, Unix, Linux, OpenVMS, along with any operating system supporting connections using SSH or REXEC.
For detailed listing of JAMS Predefined Executions Methods, review the listing at the end of this topic.
Manually Assigning an Execution Method to a Job
To manually assign an Execution Method, open a Job’s properties and select Properties tab > Source Options. Use the File Browser button to select from a listing of available Execution Methods, as shown below.
In addition, you can customize your own Execution Methods to apply other technologies that JAMS does not interface with. Or you can modify an existing Execution Method’s functionality.
Customizing an Execution Method entails a two-step process: creating an Execution Method and modifying/updating its properties. Both steps are described in detail in the following two sections.
Creating a New Execution Method
To define a new custom Execution Method start by clicking on the shortcut to access the Execution Method View.
1. Choose the Add button from the Ribbon Bar to open the Execution Method Definition Wizard.
2. On the Execution Method Name page enter the name and description of the new Execution Method. Click
Next.
3. On the following Execution Type wizard page, select the File Browser button.
4. This action opens a search list displaying other Execution Methods from which to base this new entry. 5. Make a choice by double-clicking on a method name. The search list then closes and populates the Base
Each Execution Method is made up of six properties that correspond to the six tabs on the definitions window shown below. These properties are detailed below.
Execution Method tab
This tab includes basic identification properties including: the method name, description and date and time of the Execution Method's last revision.
Method Name
This is the unique identifier for the Execution Method parameter.
Description
This reference property is used to summarize the Execution Method definition.
Last Changed
Indicates the date and time this Execution Method parameter was last modified.
Source tab
The Source tab is used to specify certain values for a Job, including Job Modules, which reference macros in a template file.
Job Module
This is the name of a text module in the template library which is used as the starting point for parsing the Job's command procedure. Entering a value in this property implies that this Job is parsed.
The template library is a combination of the macros in the BaseMacros.xml file, the file specified in the "DefaultMacroFile" configuration setting and the macros in the xml file specified in the Job's Folder definition. The BaseMacros.xml file is replaced when installing a JAMS upgrade.
Caution: If you want to add custom macros you should avoid putting them in the BaseMacros.xml so
that you don't lose them during an upgrade.
Note: that you can specify the starting point for parsing using either the Job Module property or the
Template tab. However, you cannot use both.
Default File Extension
Options (Checkboxes)
Interactive: when enabled, this Execution Method can interact with the desktop. Caution: this
setting is not recommended since it can lead to potential security issues. The Interactive property has been included here because some applications require access to the desktop in order run properly.
Single Command: when activated, the Execution Method uses a command instead of a command
procedure.
Snapshot Source: If enabled, the option allows JAMS to grab a copy of the source when submitting a
Job.
Host Locally: Indicates that the Job should only be hosted by the machine running the JAMS
Scheduler. This setting is used for Execution Methods that need to manage connection to the Agent machine. An example would be the SSH Execution Method which executes locally and uses SSH to connect to the Agent in order to run the actual job.
Allow Edit on Submit: when activated, this checkbox permits the source to be edited when manually
submitting the Job.
Allow Edit After Start: when activated, this setting permits the source to be edited after a manually
submitted Job has started.
Execution tab
This tab incorporate several sections that are detailed below:
Rexec runs a Job by connecting to a rexec daemon.
SSH Agent executes a Job using a secure shell commands with JAMS AgentX.
Options
This property specifies options unique to the Execution Method and IJAMSHost implementation.
Create Process
Includes values that are passed to CreateProcess as the application or command argument.
Application: is the value passed to CreateProcess as the application argument. Command: is the value passed to CreateProcess as the command argument. Routine Location
This is used when the type is set to Routine. When JAMS executes the Job it loads the specified assembly, class and call methods from the IJAMSHost interface.
Assembly: the assembly name containing the class.
Class: the class that executes the job. This class must implement IJAMSHost.
Source Editor
The Source Editor is used by the JAMS Client to edit the Job’s source code. When using a text editor make sure to leave the Assembly and Class properties empty. You can create custom editors for each custom Execution Method. Each editor displays on the Job definition’s Source tab.
Viewer
This is used for viewing the progress of an executing Job, which is often a Workflow Job.
Assembly: the assembly name containing the class.
Class: the class that executes the job. This class must implement IJAMSHost.
Completion tab
Exit Code Handling
ZeroIsGood OneIsGood EvenIsGood OddIsGood PositiveIsGood MessageCode OpenVMSMessageCode SpecificGood SpecificBad MinimumValue
Enter the Minimum, Informational and Warning values.
Regular Expression Patterns
Specify a regular expression pattern that is matched against both success and error log file outputs.
Parameters tab
Execution Method parameters work the same way as Parameters within Job definitions and apply to all Jobs using this Execution Method. To insert a new Parameter, select the Add button on the Parameters tab to access the Add a Parameter wizard.
Note: if a Job has a Parameter with the same name as the Execution Method Parameter, the Job
definition is used.
For a description of Parameters, go the topic: Job Properties – Parameters ('Job Properties' in the on-line
documentation).
Template tab
Templates provide an easy way to include standard pre and post processing for your Jobs.
At submit time JAMS parses a Job source using either the template defined on this tab or the module defined in the Job Module property for the Job’s source code. Use the built-in text editor to edit the template for this Execution Method.
The example below sets up a simple template that maps two network drives, inserts the Job’s source code and executes a LogJobComplete program:
