JAMS 6.X User Guide
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
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-94
JAMS Security: Working with User Definitions
95-97
JAMS Security: Managing Encryption Keys
98-99
Preinstalled Dashboards
100-105
Custom Dashboards
106-116
JAMS Scheduler Features
1
78
117
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
JAMS Scheduler Services
118-120
Configuring the JAMS Scheduler
121-123
Logon as Batch
124
Upgrading JAMS
125
Upgrading from JAMS 5.x to JAMS 6.x
2
126-127
Upgrading from JAMS 6.x to 6.x
128
Upgrading JAMS Using a Primary-Failover Environment
129
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
JAMS 6.X Client Features
3
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
4.
5.
6.
7.
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.
The Execution Method page follows. Here you can view and choose from a listing of execution
methods by clicking the File Browser button.
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.
On the next page, verify the user account for this Job using the dropdown list or by entering a
valid username and password.
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.
The Job's properties window appears. Select the tabs to make the desired Job modifications.
4
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Deleting an Existing Job
1.
2.
3.
4.
5
Navigate to the Jobs View in the Shortcut Bar
Highlight the Job to be deleted
Click the Delete button on the Ribbon Bar.
Confirm the deletion by clicking Yes or alternatively choose the Cancel or No button.
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
5. Press the Submit Run Request button to initiate the Job or Setup submission process.
6
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
7
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
3. On the Jobs page, add the name of individual Jobs that make up this Setup. In addition, you can remove a
Job and modify the properties of an existing Job using the buttons located below the Jobs view area.
8
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
5. Click the Next button to open the Finish page. Choose the Finish button to complete the new Setup
definition process.
9
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
5. To reposition any column, drag and drop the column header into the desired position within the current
View.
Filter Editor and Auto Filter Row
Filter Editor
For views containing a long list of items, JAMS provides several quick ways to filter the results. The Filter Editor
opens a window allowing you to enter single or multiple search statements based on a variety of variables.
1. From any JAMS view open the Filter Editor by right-clicking a column header and choose the Filter Editor
10
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
command.
2. This action opens the Filter Editor window.
3. From the window use the default variable (in this case the [Job Name] is used because the above
sample is a Job view) or choose a new search variable by choosing the pick list below by clicking the
bracketed item. .
11
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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
Filter command.
2. A new blank filter row appears where you can enter search criteria for a specific column or multiple
columns.
12
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
2. Toggle the empty checkbox to enable or disable the display properties for each tab. For example, enabling
the Jobs checkbox displays this tab, as shown below.
13
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
14
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
4. Select the Save & Close or the Save button on the toolbar.
15
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
3. Confirm the deletion to complete the process.
16
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
4. Double-click a specific Job from the list to display its statistics, log file or audit trail data in the job detail
window.
17
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
5. Select the Statistics tab to view the current Job's runtime compared to its historical data.
18
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
Modifying the Timeframe Display
19
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
Jobs and Setups displaying orange have run past their predefined end time.
Items in yellow have run beyond their original schedule time.
Note: double-clicking or right-clicking a Job within the display will open its settings window.
20
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
6. The Projected Schedule Shortcut should now appear in the Shortcut list.
21
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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: Alerts inherited from a higher level will appear grayed out as shown below.
To review which JAMS objects reference the Alert, double-click to open the Alert’s definition and select
the References tab.
22
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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
As shown below you can use parsing within the Summary Text and Detail Text properties to provide information
about the JAMS object that triggered the Alert. For example, you can use HTML tags to specify the formatting of
the email.
23
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
5. To reposition any column, drag and drop the column header into the desired position within the current
View.
To learn about sorting and filter the Monitor results, go to the topic: Working with Views.
Monitor View Icons
Every Job and Setup contained in the Monitor view includes an icon showing the current state of each entry as
listed in the table below.
24
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
Using the Gantt View
25
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
To open a properties window for a particular Job or Setup, right-click on an individual bar graph on the Gantt
diagram and select the Show Details command from the context menu or simply double-click the object.
26
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
2. Choose an icon and then enter the name and title for the shortcut. Select the Next button.
27
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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
SQL
SQL
SQL
SQL
Server
Server
Server
Server
Server
2016
2014
2012
2008
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, rightclick, and choose the Convert option or use the Convert to JAMS button on the Ribbon Bar to access the
conversion wizard.
2. On each step of the wizard, fields will be pre-populated with information from the selected SQL Agent
Job.
Note: SQL Agent Jobs that contain multiple steps will be converted to JAMS Setups comprising
two or more Jobs.
Note: Not all options for a SQL Agent Jobs are supported by JAMS. If an option is not supported
28
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
you may receive an error when advancing the conversion wizard.
Starting, Stopping and Deleting SQL Agent Jobs
SQL Agent Jobs can be manually started, stopped, and deleted by selecting a Job from the definitions list and
choosing the applicable button on the Ribbon Bar.
29
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
1. Define the shortcut’s properties. Select an icon and enter the name of the new shortcut and then select
the Next button.
2. On the following page choose a View to associate with this shortcut. In this example, select the
30
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
Converting Multiple Tasks
31
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
It is also possible to convert multiple Tasks concurrently. Just select several Tasks from the Task list and click the
Convert to JAMS button. This will start the Wizard for converting multiple Tasks. The first few steps will
prompt for information. The Wizard will then attempt to convert all of the selected Tasks to JAMS Jobs.
32
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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
SQL Agent jobs are converted using the same steps as the Windows Task Scheduler tasks, described in the
33
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
2.
3.
4.
Using the External tab, click the SQL Agent Jobs shortcut.
Select a Job from the SQL Job Definitions list and right-click.
From the context menu choose the Convert command to open the Conversion Wizard.
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.
Example: Cron2JAMS.exe crontab.txt output.ps1 BRADY Default REDHAT1 JAMS
34
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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
Once a Named Time has been created you can then associate it with any Job or Setup.
35
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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 only honored if the Job is submitted manually. Manual and
automatic submissions of a No Action Job will run to completion, even if the Schedule Window
closes.
If the No Action Job is set to submit automatically, it will start based on the automatic submit time,
and ignore the constraints of the schedule window.
For instance, if a Window of 2:00PM to 4:00PM exists on a No Action Job and the Job is submitted
manually at 1:00PM, the Job cannot run until it reaches the 2:00PM start of the Window. If the same
Job is configured to submit automatically at 1:00PM, that automatic submission will not wait for the
2:00PM start of the window, it will run as soon as it is able.
Continue: The Job does not start until the Schedule Window opens and continues running to
completion, even if the Schedule Window closes. There is no rescheduling option.
Continue Jobs within a Setup: If a Setup is executing during the schedule window of a
continue Job within the Setup, the window requirements of the Job are considered met and
the continue Job will begin executing as soon as it is able, regardless of the current state of
the schedule window.
Abort or Delete: The Job does not start until the Schedule Window opens and is deleted or aborted
if the window closes before the Job completes.
Reschedule or Continue: The Job does not start until the Schedule Window opens. If the Job does
not start by the time the window closes, it is rescheduled for the next time the window opens. If
the Job does start, this action allows the Job to continue to completion even if the window closes.
Restart or Reschedule: The Job does not start until the Schedule Window opens. If the Job has not
completed by the time the window closes, the Job is forced to abort, and is rescheduled to run the
next time the window opens.
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.
Named Time tab
36
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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
Start Time
37
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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?
If true, use the Disable button to manually disable the Named Time. If false, use the Enable button to manually
enable the Named Time.
38
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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 twostep 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.
However, if the check box is filled, it indicates that the special date should have no effect on
39
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
Every Other (day): JAMS will use the next available occurrence of the specified date type, repeating on
each alternate available date. Days can be set using Day-of-Week specifications, Weekday, or
Workday.
E.g. Job A is created on Saturday and scheduled to run "Every Other Workday". The job will run on
Monday, Wednesday, and Friday the first week, then Tuesday and Thursday the second week, and so
on.
Valid Simple Date Specifications
Included below are some examples of valid, simple-date specifications:
TODAY + 5
NEXT MON
LAST TUESDAY
WORKDAYS
Every Other Friday
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:
Form 1
FIRST
LAST
1[st]
2[nd]
3[rd]
integer [st, nd, th]
Day-of-week
WORKDAY
WEEKDAY
DAY
MONTH
Or . . .
Form 2
Day-of-week
WORKDAY
WEEKDAY
40
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
WEEK
DAY
MONTH
OF
FIRST
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
3RD DAY OF WEEK
3RD DAY OF EACH WEEK
41
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
7. Click the File Browser button and navigate to the desired trigger Job or Setup and double-click the
selection. Set the Date and Time fields. Click the Close button to save the entry. The selected Trigger
Event now appears on the Trigger Actions page. Click the Next button.
8. Click Finish to complete the Trigger setup process.
Modifying Existing Triggers
1. To change the properties for an existing Trigger, open the Trigger Definitions View by selecting the
Triggers shortcut at the bottom of the window.
42
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
5. Click the Close button on the top right corner of the window and confirm the changes.
6. On the Actions tab follow the same procedure as described in the previous 5 steps.
7. Select the Close button to update the Trigger.
43
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
3. From the Ribbon, choose the Add button to access the Resource Definition wizard.
4. On the first page of the wizard enter a name and optional description for the new Resource. Choose the
Next button.
5. On the following page set the Resource’s Quantity Available value. Click the Next button and then choose
Finish to complete the Resource definition process. The new Resource now appears in the Resource
Definitions View.
Modifying an Existing Resource Definition
44
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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
You can query the JAMS SQL database to determine what Resource definitions are currently in use.
45
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
To assign a new Resource definition: open the Folder’s definition by right-clicking and choosing Properties >
Resources. Follow the steps described in the previous section: Adding an Existing Resource to a Job, Setup or
Folder.
46
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
3. Select one of the six Dependency Types from the dropdown menu and click the Next button.
47
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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
Depends on Job has actually completed.
8. Populate the remaining properties.
The Or within the last property allows you to enter a time range dependency (number of days, hours,
minutes and seconds [day.hour:minute:seconds], e.g., 1.2:30 = 26.5 hours or 2.10 = 48 hours and 10
minutes.
48
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
10. Click the Finish button to complete the Dependency definition process.
49
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
2. Click inside the Variable Definitions View. Choose the green Add button on the Ribbon to initiate the JAMS
Variable Definitions Wizard. Choose the Next button.
3. Enter a unique name and description for the new Variable and then click the Next button.
4. On the next page select a Data Type and Value for the new Variable. The Date Type options include:
Text
Integer
Date
Time
50
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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
Includes the username who last modified this Variable and the date and time when this change occurred.
51
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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
Variable Definitions.
Control: allows modification of the Variable’s Access Control List.
Delete: provides deletion of the Variable’s definition provided the user also has Delete access to
Variable Definitions.
Inquire: allows inquiry into the Variable definition provided the user also has Inquire access to Variable
Definitions.
52
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Use the link to get more information on modifying the JAMS ACL settings.
53
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
2.
3.
4.
5.
On the JAMS Client select the Queues shortcut.
This action opens the Queues Definitions View.
Choose the green Add button on the JAMS Ribbon to open the JAMS Queue Definition Wizard.
On the Queue Name page, enter a unique name and description for the Queue. Click the Next button.
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.
Use the Job Limit adjustment to define the maximum the number of Jobs that can run concurrently.
From the Started On section, you can add, delete or modify the Agent nodes where the Queue
originates. This can include a single node or a list of nodes.
54
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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.
Resource requirements can be defined at the System, Folder and the Job level. These values are then added
together to define the total units required for the Job to begin executing.
55
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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
Execution Method property.
6. Choose the Finish button to add the new definition to the Execution Method View.
Modifying an Execution Method's Properties
The next step is to modify the new Execution Method’s definition properties. Or this can become a first and only
step if you plan on changing an existing Execution Method.
To start, highlight and double-click an Execution Method from the list to open its definition window.
56
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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
Enter the default file extension for the Job's command procedure.
57
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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:
Type
This dropdown allows you to choose the Execution Method type. The supported types are:
Agent runs a Job using a JAMS Agent.
Batch runs a Job by creating a process with a Job or Command.
Routine executes a Job using the specified class from a specified assembly using the IJAMSHost
interface.
58
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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
This dropdown controls how a processed exit code should be interpreted. Depending on the Exit Code Handling
selection, choose the specific parameter values listed below:
59
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
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:
LogJobComplete
NET USE E: \\MyServer\EShare
NET USE F: \\MyServer\FShare
<<JAMS.Current.Source>>
C:\LogJobComplete.exe <<JAMS.Job.JobName>>
Predefined Execution Methods
60
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
JAMS ships with dozens of Predefined Execution Methods that can run a variety of Jobs on Windows, Linux, UNIX
and and other operating systems detailed below.
Method
Description
OS
Banner
Executes a Banner job
Windows
BannerWin
Executes a Banner job on Windows
Windows
Command
Used to run a Windows batch procedure
Windows
CRJobV12
Crystal Reports Job using Crystal Reports version 12
Windows
CRJobV13
Crystal Reports Job using Crystal Reports version 13
Windows
File Transfer
Defines a file Transfer (FTP, SFTP, or FTP/SSL)
Windows
FileTransferV1
Defines a file Transfer (FTP, SFTP, or FTP/SSL)
Replaces File Transfer from V6.4.51 and under
Windows
InformaticaCloud
Executes an Informatica Cloud task.
Windows
JAMS Report
Generates a JAMS Report
Windows
JDEJob
Runs a J.D. Edwards job
Windows
JDEJobSsh
Runs a J.D. Edwards job on Linux via SSH
Windows
MF Job
Executes a Micro Focus Job
Windows
MSDAX2012Job
Executes a Microsoft Dynamics AX job
Windows
NeoBatchCatalog
Executes a NeoBatch Job from a NeoBatch Catalog
Windows
NeoBatchJcl
Executes NeoBatch Job from JCL stored in JAMS
Windows
NetezzaBackup
Runs a Netezza backup job using SSH
Unix, Linux
NetezzaLoad
Runs a Netezza Load job using SSH
Unix, Linux
NetezzaSQL
Executes a Netezza Query job using SSH
Unix, Linux
OdbcCommand
Executes ODBC Commands
Windows
OleDbCommand
Executes OLEDB Commands
Windows
OracleEBSConcurrent
Runs an Oracle EBS Concurrent process
AIX, HP-UX,
Linux, Solaris
OracleEBSJobSsh
Runs an Oracle E-Business Suite Job via SSH
AIX, HP-UX,
Linux, Solaris
OracleEBSRequestSet
Executes an Oracle ES Set job
AIX, HP-UX,
Linux, Solaris
OracleStoredProc
Executes an Oracle Stored Procedure Job
AIX, HP-UX,
Linux, Solaris
OS400
Runs IBM System i, OS/400 jobs
IBM System i
PeopleSoftJobSsh
Executes a PeopleSoft job using SSH
PeopleSoft
PeopleSoftJobWindows
Runs a PeopleSoft job on Windows
PeopleSoft
PowerShell
Runs a PoweShell script on Windows
Windows
PowerShell32
Runs a PoweShell script (32 bit)
Windows
PowerShellParsed
Runs a parsed PoweShell script on Windows
Windows
PowerShellParsed32
Runs a parsed PoweShell script (32 bit)
Windows
Rexec
Issues a command using rexec
Any
RexecScript
Runs a shell script on an rexec server
Any
61
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
SAPDataService
Executes a SAP Business Objects Data Services Job
SAP
SAPJobV2
Executes a SAP multi-step job
SAP
SAPStandardJob
Executes a SAP single-step job
SAP
SAPProcessChain
Executes an SAP Process Chain
SAP
SQLAgent
Runs SQL Server Agent Job
Windows
SQLCommand
Runs SQL commands
Windows
SQLStoredProc
Executes an SQL Stored Procedure
Windows
SSH
Runs a Secure Shell
Any
SSHAgent
Deploys JAMS AgentX using SSH
AIX, HP-UX,
Linux, Solaris
SSHDeploy
Deploys JMAS AgentX using AgentX
Windows
SSHNetworkConnect
A Sample SSHNetworkConnect Execution Method
OpenVMS
SSHOpenVMS
Runs a Secure Shell with OpenVMS using prompt
matching
OpenVMS
SSHPrompt
Runs a Secure Shell using prompt matching
Any
SSIS
Runs SQL Server Integration Services
Windows
SSISDirect
Runs SQL Server Integration Services
Windows
SSRS
SQL Server Reporting Services
Windows
UnixScript
Run a Unix Script based on the sheband on the first line
Unix/Linux
UnixShell
Run a shell script on a Unix Server.
Unix/Linux
Vbs
Executes a VB Script
Windows
VMS
Runs an OpenVMS DCL Command Procedure
OpenVMS
VMSParsed
Runs an OpenVMS DCL Command Parsed Procedure
OpenVMS
WindowsDeploy
Deploys a JAMS Agent to a Windows machine
Windows
Workflow
Runs a Windows Workflow job
Windows
zOS
Executes an IBM zOS job
zOS
62
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Menu Definitions
Menu definitions control how menu hierarchies appear within the JAMS Submit Jobs View. Customizing these
definitions can allow users to quickly view and submit batch Jobs.
JAMS can also create a default menu which initially lists all available Folders. After the user selects a Folder, the
available Job and Setup definitions are displayed.
Note: Using Menu Definition to customized Submit Jobs hierarchies is optional.
Adding a New Menu Definition
Defining a Menu Definitions is usually a two-part process. In the first step you add a new Menu Definition or
modify an existing definition.
The second step involves inserting those definitions into the Submit Jobs properties to control the view display.
1. To add a new Menu Definition, click the Menus shortcut to open the Menu Definitions View.
2. Click the green Add button on the JAMS Ribbon to access the JAMS Menu Definition Wizard.
3. Enter the name and description for the new Menu. Click the Next button.
4. On the Menu Details page choose the Add button to access the Menu Details dialog box. This is where you
define the Menu’s selection details.
5. There are several ways to use this dialog to control which Jobs and Setups appear in the Submit Jobs View.
Use the File Browser button to open a Folder search dialog that lists available Jobs and Setups.
Double-click on the desired Job or Setup. This action closes the dialog and populates the Include
Jobs and Setups property.
Use the Selection Criteria property to narrow your search. For example, if you only want Jobs and
Setups appear with the name ‘Test’, use a wildcard variable. For example, entering *Test may
return results such as, "JAMSTest" or "UserTest". As shown in the screenshot at the end of this topic,
entering"Act*" as the selection criteria returns ActEOM, ActPayroll and ActTraining.
63
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Select the appropriate checkbox to display specific types of JAMS elements (Folders, Jobs, Setups
and other Menu definitions).
6. Choose the window’s close button and confirm any changes. A new Menu Definition listing now appears in
the Menu Definitions View.
At this point you can either add another selection detail for this Menu Definition or choose the Finish
button to complete the process.
Modifying or Deleting Existing Menu Definitions
Existing Menu Definitions can be viewed and modified by double-clicking the desired listing from the Menu
Definition View. Each Menu Definition contains two tabs: Menu and Includes.
The Menu tab displays the selected Menu Name, Description and Last Changed date and time.
The Includes tab contains checkbox selection settings similar to the Menu Details dialog described in
the previous section. Make any changes to the current selection criteria and click the window's close
button. Or alternatively, insert a new selection criteria by choosing the Add button.
Use the Remove button to delete unwanted selection criteria from the list.
After completing the modifications, click the window close button to save any changes.
Using Menu Definitions to Customize the Submit Job View
The second step is to customize the Submit Jobs View with the new Menu Definition. Follow the steps below to
redefine this View.
1. Right-click the Submit Shortcut to open its context menu and select the Properties command to access
the shortcut's properties window.
64
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
2. On the Views section, click the properties icon shown in red.
3. This action opens the Submit View’s properties dialog. In the example below, the existing Menu Definition,
“Accounting” has been entered into the Initial Menu Name property.
4. Click OK to save the View changes.
5. Open the Submit Jobs View. Notice how the View pulls in the ‘Accounting’ Menu Definition selection
criteria that includes all folders and menus with “Act” as a prefix.
65
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
File Transfer Features
JAMS provides built-in support for all standard file transfer protocols including:
FTP: Classic (unencrypted) FTP support that conforms to RFC 959 and 1123.
FTPS: SSH File Transfer. Provides encrypted password and data encryption. Defined by RFC 959, 1123,
4217, and 2228.
SFTP: FTP over TLS/SSL. Includes encrypted password and data encryption. Considered a more secure
protocol over FTPS.
SCP: Secure CP. A variant of BSD rcp that transfers files over an SSH session.
The File Transfer Execution Method
JAMS’ File Transfer Execution Method works with all the above protocols using “fill in the blanks” ease of use
setups. In addition, this method supports automatic retries and wildcards and includes complete integration with
JAMS user security.
Since file transfers execute as standard JAMS Jobs, users have the following capabilities:
Automatic notification for failed or stalled transfers or runaway processes.
Dependency support before and after the file transfer.
File event triggering for file transfers.
Direct integration into a JAMS Setup for process sequencing and flow control.
Defining a New Job using the File Transfer Execution Method
To define a Job utilizing the File Transfer Execution Method, follow the steps below.
1. First, activate the Jobs View and click within the Definitions Group on the Shortcut Bar.
2. Choose the green Add button on the Ribbon Bar to initiate the JAMS Job Definition Wizard.
3. Select Next to open the wizard's Jobs Name page. Enter a unique name for the new Job along with an
optional description. Click the Next button.
4. The Execution Method page follows. Click the File Browser button to open the Execution Method Search
list. Navigate to and double-click the File Transfer option. This action closes the search window and
populates the Execution Method field. Select Next.
5. On the Notification Email Addresses page enter one or more address to alert specific staff if a Job fails or
doesn’t complete within an allotted time. Click the Next button.
6. On the following page, verify the user account for this Job using the dropdown list or by entering a valid
username and password. Click the Next button.
7. The Source page opens with a “fill in the blanks” form to define the file transfer properties.
66
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Use the descriptions below as a guide through the four associated Source page tabs.
File
Remote Server Name
Enter the DNS name or IP address of the remote server.
Remote Directory
Provide the default working directory on the selected remote server.
Remote File Specification
Insert the remote file specification. When left black, the filename and extension of the local file is
substituted. This field also allows wildcards.
Local File Specification
Enter or navigate to the file specification for the local file. This field also allows wildcards.
Security
User Security
Select a predefined JAMS User Security object to access the remote server.
Username and Password
Enter a user name and password to access the remote server.
Retry
Maximum Retries
Include the maximum number of retry attempts if the transfer fails.
Retry Delay
This property defines the delay (in minutes) between retries.
Options
The fields shown on the Options tab may vary based upon the selected transfer type.
67
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Port
Enter the TCP/IP port the selected server is using.
Passive
When checked, passive mode is enabled. In this mode, TCP/IP connections are always made from the
client to the server, which makes it easier to support NAT and firewalls.
Binary
When enabled, a binary transfer is performed.
Keep Alive
When checked, JAMS continues to ping in order to maintain the connection.
Keep Alive Interval
This property defines the time between JAMS ping messaging.
8. Select the Next button to advance to the Schedule page. Use the Schedule Date dropdown to create a
built in schedule or manually enter a single or multiple date specification. Click Next.
9. Choose the Finish button to complete the Job definition
Modifying an Existing File Transfer Job
1. To make changes to an existing file transfer Job, open its properties window by right clicking (or doubleclicking) the desired Job listing.
2. From the Job’s context menu select the Properties command.
3. The Job’s Properties window appears. Select the Source tab and make any desired modifications. Notice,
these are the same entry fields and configurations described in step 7 of the previous section.
4. If required, make any other modifications to this Job by accessing the other tabs within the Properties
68
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
window.
5. When completed, close the Properties window and save and confirm your changes.
69
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Working with Agents
Agents allow users to define specific actions that can run locally or remotely throughout a JAMS network. By
default, JAMS can only run Jobs and Setups on the primary engine. Agents allow users to extend that capability to
run Jobs on a variety of different environments. For example, by deploying JAMS Agents a single JAMS Scheduler
can execute tasks on many systems.
Agents can be deployed to run a Korn Shell script on a compatible Linux server or work in a failover environment
when the primary engine goes down.
Defining and Deploying JAMS Agents
The JAMS Primary Engine contains built in capabilities to remotely install a JAMS Agent on any machine running
Windows, Linux, Solaris, AIX, System I (AS400), or a HPUX operating system.
Use the following steps to define and deploy a new JAMS Agent to a remote machine.
1. First, open the Agent Definitions View by choosing the Agents Shortcut.
2. Click the Add button on the JAMS Ribbon Bar to open the JAMS Agent Definition Wizard.
3. On the Agent Name page enter the DNS Node name or IP address to direct the deployment of the new
Agent. Click the Next button.
4. On the Agent Platform page, use the dropdown to select the platform from which the Agent will run. Click
Next.
5. The following page provides options to deploy the Agent via the Deploy JAMSAgent checkbox.
When this checkbox is enabled, JAMS automatically submits a Job that deploys an Agent to the specified
remote machine. If left unchecked, it will not deploy. However, you can manually deploy the Agent by
right-clicking it from the Agent Definition View and choosing the Deploy command.
70
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Note: When initially deploying an Agent to a Linux/Unix machine, the JAMSAgentX Job will fail on
the monitor the first time it executes. This is because JAMS initially caches the host fingerprint.
Upon redeployment, JAMS Agents can also be manually installed. For more information, please
use the following links:
JAMS Agent for Windows Manual Installation
Manual Installation of JAMS Agent for Unix and Linux
Just below the checkbox option, choose an existing user account from the Deploy using this User
dropdown.
Enter the Port to connect to the Report Agent for deployment. To use the default port, select the "0"
setting.
6. Click the Finish button to complete the Agent definition process.
Modifying an Agent's Properties
To modify an existing Agent, open the Agent Definitions View by selecting the Agent Shortcut and either doubleclick or right-click the item and choose the Properties command. The Agent definition window opens revealing
three tabs.
1. On the Agent tab you can modify the name of the Agent. This is the name of the system where it
executes. This system must be running either the JAMS Agent, a SSH server or a rexec server, depending
on the Execution Method used by the Job.
2. On the Platform tab, use the dropdown to select the operating system the remote Agent node is to
deploy.
For the Deployment User Name (optionally) select the JAMS user account used to deploy the Agent to the
remote agent node.
Enter the Port used to connect to the remote agent node for deployment. To use the default port, select
the "0" setting.
3. The Status tab includes the Agent’s online status, time offset, current state, and license information.
The remaining information includes the number of Jobs that have run on this Agent and the Job limit
setting that can run the Agent.
4. After the modifications are complete, choose either the Save or Save and Close buttons at the top of the
definitions window to complete the modification process.
Removing an Agent
71
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Removing an Agent Definition
On the Agents Definitions View, highlight the Agent to be removed and choose the Delete button on the JAMS
Ribbon Bar.
Removing an Agent node from a Batch Queue
JAMS Jobs can be submitted to run on Queues with specified Agent nodes. To remove an Agent from a Queue,
open a Queue Definition View and double-click the desired Queue. On the Queue's definition Status tab, click on
the box with the black arrow pointing to the agent node listing, then press the Delete key to remove it from the
list. Select either the Save or Save and Close buttons at the top of the definitions window to complete the
process.
72
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Workflow Jobs
JAMS Workflow Jobs use the Windows Workflow Foundation that provides an extensible collection of Activities
using a rich interface for designing Job execution flows. JAMS extends the base set for these Workflow Activities
with a collection of its own Activities for interacting and performing tasks directly within the JAMS Client.
The JAMS Workflow execution method is designed for Job scenarios using decision logic and branching that
require different execution paths. Workflows are created and edited using the Workflow Designer which includes
a menu of building blocks (Activities) for submitting Jobs, updating JAMS Variables, and many more JAMS specific
tasks. To view a listing and description for all Workflow Activities (on-line documentation), select the link.
Setting up the Workflow
1. To get started, create a new Job by activating the Jobs View and selecting the Definitions Group in the
Shortcut Bar and highlighting the Jobs shortcut.
2. Select the green Add button on the Ribbon Bar.
3. This action opens the JAMS Job Definition Wizard.
4. Select Next to open the Jobs Name page. Enter a unique name for the Job along with an optional
description and click the Next button again.
5. The Execution Method page follows. Here you can access a list of default execution methods by selecting
the Execution List button (outlined in red).
73
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
6. This action opens the Execution Method list. Double-click the Workflow option. This action will close the
list window and populate the execution method field on the previous screen.
7. Continue moving through the Job Definition Wizard until you reach the Source Page and the Workflow
Designer Panel.
The Workflow Designer
The object-oriented workflow interface is made up of three panels. The left Toolbox panel contains a list
of Activities that can be used as building blocks to customize a JAMS Job to most any specification.
The Design panel is where the workflow building blocks are assembled by dragging and dropping selected
Activities from the Toolbox.
Finally, the Properties panel is used to populate or modify individual property fields related to individual
Activities.
Each Activity is organized into a grouping (e.g., JAMS, SQL, PowerShell, etc.). If specific JAMS Add-ons have
been installed, additional Activities/Grouping may also appear on the Toolbox panel.
74
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Defining a Workflow using a Sequence Activity
Workflow jobs that contain more than one Activity must be nested within a parent activity such as a Sequence or
Flowchart. A Sequence is a container object that can help create a more intricate workflow. Sequences are
powerful as they can contain any activity including Flowcharts and decision structures.
1. To include multiple Activities into a Job workflow, drag a Sequence Activity to the Designer panel to setup
the workflow framework.
2. Then drop other Activities from the Toolbar panel into that object. This action creates a parent-child
relationship.
75
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
3. Drag and drop the next Activity to create a child activity within the parent Sequence.
More complex Jobs, such as those requiring branching, can be designed using nested Sequences.
Flowchart Activity
A Flowchart object executes Activities one after another, but it also provides controls to loop back to previous
steps or can skip a step entirely. A Sequence execution can only move forward.
Using the Properties Panel
76
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Select any Activity from the Designer panel to view its specific properties. Use the Properties panel to populate
or modify individual property fields for that object.
Please review any task messages appearing on the Activity object. To view the message content hover the mouse
over the object in the Designer panel.
Note: All errors must be resolved before a JAMS Job can be successfully submitted.
Select the Save and Close button to complete the JAMS Workflow job definition process.
Note: Some JAMS Activities, such as AskQuestion and ManageActivity, allow for runtime interaction. For
more information on Workflow interaction, select the link: Runtime Workflow Interaction.
77
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Manually Generating Reports
JAMS makes it easy to add reporting capabilities for either existing and new Jobs. The following topic summarizes
how to create and generate Reports both manually and automatically.
You can view all existing reports from the JAMS Client by opening the Reporting tab and selecting the Open icon.
The Open JAMS Report window appears with a listing of categories containing Reports already built into JAMS. To
generate a Report from the list, follow the steps below.
1. To start, expand a category, highlight one of the default Reports and click the OK button. You can also
open any stand-alone Reports by choosing the File button.
2. The Parameters window opens. Define the Report by entering the properties for the specific report type.
3. Press the Submit button to query the JAMS system and generate the Report based on the entered
parameters in the previous step.
4. After running the Report you have the option to export its content using a variety of file formats from the
Export/Export To command located on the right of the Reporting Ribbon Bar.
Using the Reporting tab is an easy way to manually run reports against the JAMS system. It is also possible to run
the same Reports automatically. See the topic: Integrating Reports with Automated JAMS Jobs for additional
details.
78
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Creating New Report Templates and Customizing Existing
Reports
Use the Report Designer to modify any of the default reports or the built-in design tools to create your own
layout from scratch. Both options are described in more detail in the following subsections.
Once a new or customized report is created you can save the report definition to the JAMS system or your local
machine. Either way, the report can be loaded later or viewed manually or automatically as part of any JAMS
Job.
Creating a New Report Template from Scratch
1. To access the Report Designer select the JAMS tab and choose the Report Designer icon on the Ribbon Bar
to open a blank designer window.
2. Choose New Report from the Report Designer tab. This action opens the Select Report DataSource dialog
box. Make a selection from the dropdown list and click the OK button to open the Report Designer
Window. Each data source comes with pre-defined parameters whose values can be changed to produce a
different report output.
3. Drag and drop control objects (e.g. field, label, table and shape, etc.) from the Tool Box to one of the
Report Layout “bands” (e.g. top margin, detail and bottom margin). Right-click a “band” to view its
context menu. The context menu enables you to modify, reorder and define each “band” via its
Properties panel.
79
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
4. The Report Explorer panel displays the current report structure using a tree format.
5. The Field List displays a listing of the report’s data sources, allowing you to add new bound controls and
binding existing controls. To add a new bound report control, click on the desired item in the Field List
window and then drag and drop the item onto a report band on the report layout panel.
Note: you can also right-click a Field List item and drag and drop it onto the report's Layout
Panel. This action opens its context menu. From the menu list, select the field type desired.
6. The Property Grid panel provides a variety of options for formatting existing field controls.
7. Use the Group and Sort panel to create and define grouping fields instead of manually inserting Group
Header and Footer bands.
8. Additional formatting tools are available on the Report Designer Ribbon Bar.
9. Choose the Print Preview or the HTML View tabs to output a partial or complete report.
10. From the Ribbon Bar click Save or select the Save As option to create a standalone report (.pmx) to your
local hard drive. All standalone report files can be accessed from the Open JAMS Report dialog’s File
button.
Customizing an Existing Report
The Report Designer also provides tools for modifying existing reports. Instead of selecting a New Report and a
Datasource as described in the previous subsection, click the Open button.
1. From the Open JAMS Report dialog, expand a category and choose an existing report to modify and click
the OK button.
2. The Report Designer Window opens with the report’s layout displayed in the report layout panel.
3. Drag and drop a control object (field, label, table, and shape, etc.) from the Tool Box to one of the
Report Layout pane’s component “bands”.
4. Refer to steps 4 - 10 in the previous subsection to complete the existing report design.
80
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Integrating Reports with Automated JAMS Jobs
JAMS includes a variety of built-in Jobs that produce common reports. For example, the
ReportCurrentScheduleV2 Job (located in the JAMS Folder) generates a report that displays all currently defined
Jobs. The ReportHistoryV2 Job generates a report showing all past Jobs. To integrate these and automate other
built-in JAMS Report Jobs, follow the example below.
Setting Up the Report Job Properties
To get started, select a default Report Job and open and modify its properties.
1. Select the JAMS tab on the Ribbon Bar and highlight the JAMS directory in the Definitions Group on the
Shortcut Bar.
2. Highlight the Jobs Shortcut at the bottom of the JAMS Client window to display a listing of the Job
definitions on your local system or selected server.
3. In this example, locate and double-click the built-in Job, ReportHistoryV2 located in the JAMS folder on
the Shortcut Bar's Definitions Group.
4. Choose the Properties tab and then expand the Source Options category from the tree view.
5. Notice the Execution Method property is set to JAMSReport. This is a built-in execution method that
generates report documents attached to a JAMS Job.
To change the execution method, click the File browser button to the right of the property and make a
selection from the Execution Method Search list.
6. Next, choose the Source tab in the Job Definition window. This screen allows you to set the report
generated by this Job.
81
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
7. From the above screen, modify the default properties for this report. For example:
Use the File Browser button to set the Export Path.
Modify the File Name property to determine where to save the report’s output file.
Use the Print Queue property to enter either a printer name to output the report or a list of
email addresses to send the report. Use commas or semi-colons to separate multiple recipients.
Note: If the Print Queue property contains an email address you don't need to supply an
export path.
Note: If both the File Name and Print Queue properties are populated, the generated report is
saved and forwarded to the designated recipient or group of recipients. However, if either field
is left blank the default printer is used.
Use the Export Format dropdown to define a file format for the report. The supported formats
include: PDF, HTML, MHT, CSV, RTF, Text, XLSX (Excel) or Print.
Note: Entering “Print” instead of specifying a file format immediately sends the report output
directly to the default printer.
The Print Qualifiers are used to setup the report only if the Export Format is set to the Print
option. Use the descriptions below to define each parameter.
Margins: defines the margins of a report page (measured in hundredths of an inch). When
setting this property, the value should be entered as “Left,Right,Top,Bottom”. For example, a
1” top and bottom with .75” side margins would be entered as “75,75,100,100”.
Paper Height and Paper Width properties: define the height and width of the report page,
measured in hundredths of an inch. This property can be enabled only if Paper Kind is set to
Custom.
Paper Kind: Determines the type of paper for the report. If this is set to Custom, the printer
paper is selected according to the property's value, and its size is set to the Page Height and
Page Width Paper Name property values.
Paper Name: Sets the name of the custom paper which is used in the output printer. This can
only be set if the Paper Kind is set to Custom.
Printer Name: defines the printer to use for outputting the report.
Orientation: Sets a value for the page orientation - landscape or portrait.
8. Once the above properties have been modified, choose the Save and Close (the green checkmark button)
to return to the Job Definitions View.
Submitting the Report
82
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
1. From the Job Definitions list, right-click the modified Report Job ReportHistoryV2. From the pop-up
context menu, choose the Submit command.
2. The Submit dialog opens. Select the Parameters tab and make any final changes to the Report’s time
range definitions and other listed settings.
3. Choose the Reports tab to view the override options for the report settings. For example, both the Print
Queue and Print Form properties can override their default values.
4. All built-in Report Jobs can be manually submitted or scheduled. To define a schedule, select the
Schedule tab and enter a start time.
Note: a Job schedule can also be set by opening the Job definitions Properties tab and choosing
Schedule Options from the tree view.
5. After making the changes on the Submit dialog, click the Submit Run Request button to run the Job.
83
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Diagrams
The JAMS diagram function provides a graphical representation of the framework and relationships that make up a
Setups and Job definition. JAMS diagrams are dynamic, allowing users to modify Setups and Jobs from within the
diagram itself to allow you to add Jobs, Dependencies and Resources. Diagrams can also be reproduced using
formatting and printing controls.
JAMS diagrams comes in two flavors: a Definitions Diagram and Scheduled Jobs Diagram. While both types have
their similarities in form, each provides a different perspective on how various JAMS elements are presented.
Definition Diagram
A Definition Diagram allows the user to graphically view a Setup's detailed and often complex relationship wit its
component Jobs and Dependencies.
To manually generate a Definition Diagram . . .
1. Open the Setup Definitions View and right-click on a Setup.
2. Right-click and on the context menu choose the Diagram command.
Definition Diagram Elements
The Definition Diagram provides a bird’s eye view showing how each Job will execute within a Setup.
84
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
The top portion of a Setup diagram can include representations of Pre-check Jobs (user defined prerequisites),
recovery actions, notification details, Dependencies and Resources. Moving down the diagram hierarchy, these
objects are then linked to individual Job definitions.
Detailed Setup information along with its component Jobs and Dependencies can be viewed and modified by
accessing its property window (right-clicking the object and selecting the Properties command).
The Definition Diagram Toolbar
The Definitions Diagram toolbar, located at the bottom of the diagram window, provides additional formatting
controls that include:
Layout: changes the current layout orientation for the diagram.
Close Layer: closes the current layer if this is a subset of the original diagram. A layer can be opened
by diagramming a Setup, Job or Pre-check Job from within a diagram.
Print Preview: opens a print preview window and printing options for the current diagram.
View: the dropdown toggles between the Diagram and Design modes
Zoom: the dropdown adjusts the diagram's zoom scale.
Enhanced Diagram Functions
Within a diagram any Dependency or Job can be further diagrammed by right-clicking the object and choosing
either the Diagram Setup Job or Diagram Full Job commands. Either command will update the diagram to show
details about the selected definition. To return to the original diagram select the Close Layer button on the
diagram's toolbar.
Using the Properties Command
Right-clicking the object and selecting the Properties command opens the definition for the selected Job or
Dependency, allowing modification to be made that element.
Using Design Mode
Switching to Design mode (via the toolbar’s View dropdown) enables you to modify a Setup from within the
diagram itself. This is done by dragging and dropping a menu of objects define new Setups, Jobs, Dependencies
and Resources.
Specifically, Design mode enables the following features:
Dependencies, Resources or Setups can be removed from a definition using a right-click option.
Setups can be dragged from one step to another via its connectors.
Opens a Symbols Palette to allow dragging of new Setups, Dependencies and Resources onto the
diagram.
Scheduled Job Diagram
85
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
A Scheduled Job Diagram displays details for a scheduled Job and its Dependencies. This diagram is generated
from the Monitor View or Gantt View on the JAMS Client.
1. To create a Scheduled Job Diagram, open the Monitor or Gantt Views and right-click a Job.
2. From the context menu choose the Diagram command.
Information Details
The Scheduled Job Diagram includes detailed information about the Job such as its current status including entry
number, current elapsed time, if executed. Scheduling actions such as restarting or canceling a Job can also be
controlled from the diagram using a right-click action.
The list below details some key information displayed on each object.
Node: specifies the Agent Node that runs the Job.
Current Step: indicates the current execution step for the Setup.
State: shows current status of the Job.
Final Severity: defines a Job's completion severity (e.g., Success, Informational, Warning, Error or
Severe).
The Scheduled Job Diagram Toolbar
The Scheduled Jobs toolbar, located at the bottom of the diagram window, provides additional formatting
controls that include:
Layout: changes the current layout orientation for the diagram.
Close Layer: closes the current layer if this is a subset of the original diagram. A layer can be opened
by diagramming a Setup Job or Pre-Check Job from within a diagram.
Print Preview: opens a print preview window and printing options for the current diagram.
Refresh: refreshes the diagram information.
Zoom: adjusts the diagram's zoom scale.
Object Color Indicators
Each element within the diagram displays a border color to identify the Job’s current state, e.g., an executing
Job appears outlined in green and a pending Job displays within an orange border. These indicators also apply to
a Pre-Check Job or any Dependencies within the diagram.
86
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
87
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
JAMS Security: Setting Access Control Lists
Access Control Lists are used to define access restrictions for a variety of features within JAMS.
An ACL is a list of Access Control Entries (ACEs). Each ACE includes one or more identifier along with the type of
user access. For example, when a user attempts to perform a function, JAMS starts at the top of the ACL listing
to determine if he/she can perform that particular function by checking the identifiers specified in each ACE
against those held by the user. When a match is found the user is granted access specified on the ACE. If the end
of the ACL list is reached without a match, no access is granted.
Configure Access Control
In JAMS V6.5.18 and newer, a Job called SetJAMSAccessControl is available in the JAMS Folder. This Job
configures JAMS Access Control to match the best practices outlined below. An overview of the
SetJAMSAccessControl Job is available here.
Best Practices
Typical implementations of JAMS Security Settings result in the creation of four groups: Admin, developers,
submitters, and inquirers. The following table outlines best practice permissions given to each group. Admins
are not listed, as they are the GrantBypassGroup in the Configuration.
Access control Line Item
DEV SUB INQ
Alert Definitions
Add
X
Change
X
Delete
X
Inquire
X
X
X
X
X
X
X
Configuration
Execute
Inquire
Dates
Add
X
Change
X
Delete
X
Inquire
X
Date Types
Add
X
Change
X
Delete
X
Inquire
X
Folder Definitions
88
Add
X
Change
X
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Control
Delete
X
Inquire
X
X
X
X
X
X
X
X
X
History Inquiry
Execute
Job Definitions
Add
X
Change
X
Delete
X
Inquire
X
Menu Definitions
Add
X
Change
X
Delete
X
Inquire
X
X
Abort
X
X
Execute
X
X
Manage
X
X
See All Jobs
X
X
X
See Own Jobs
X
X
X
X
X
X
X
Monitor
Named Time Definitions
Add
X
Change
X
Delete
X
Inquire
X
Manage
X
Queues
Add
X
Change
X
Delete
X
Inquire
X
Reporting
89
Add
X
Change
X
Delete
X
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Execute
X
X
X
Inquire
X
X
X
X
X
X
X
X
X
X
X
Resource Definitions
Add
X
Change
X
Delete
X
Inquire
X
Manage
X
Security
Execute
Inquire
Server
Execute
X
Setup Definitions
Add
X
Change
X
Delete
X
Inquire
X
Trigger Definitions
Add
X
Change
X
Delete
X
Inquire
X
Manage
X
Reset
X
X
Users
Add
X
Change
X
Delete
X
Inquire
X
X
X
Variable Definitions
Add
X
Change
X
Control
Delete
90
X
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Inquire
X
X
X
The access capabilities (access types) for each security function are detailed in the following sections.
Alert Definitions
Add: allows the addition of new Alert Definitions.
Change: allows the modification of existing Alert Definitions.
Delete: allows the deletion of Alert Definitions.
Inquire: permits inquiry into Alert Definitions.
Configuration
Execute: grants or denies access to the Configuration options.
Inquire: allows viewing status to the Configuration options.
Dates
Add: permits the addition of new Date Definitions.
Change: allows the modification of existing Date Definitions.
Delete: allows the deletion of Date Definitions.
Inquire: permits inquiry into Date Definitions.
Date Types
Add: permits the addition of new Date Type Definitions.
Change: allows the modification of existing Date Type Definitions.
Delete: allows the deletion of Date Type Definitions.
Inquire: permits inquiry into Date Type Definitions.
Folder Definitions
Add: allows the addition of new Folder Definitions.
Change: permits modifications to existing Folder Definitions.
Control: permits modification of an individual Folders ACL.
Delete. permits the deletion of Folder Definitions.
Inquire: allows inquiry into Folder Definitions.
Note: Each Folder Definition has its own access control information. This ACL can be viewed
and/or modified from the Folder Definitions > Security tab.
91
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Note: In order to modify, delete or view a Folder Definition you must have Change, Delete or
Inquire access to Folder definitions as well as Change, Delete or Inquire access to the specific
Folder definition which you want to modify.
History Inquiry
History Inquiry has only one security option, Execute. You can either grant or deny access to view History entries.
Job Definitions
Add: allows the addition of new Job Definitions.
Change: permits modification of existing Job Definitions.
Delete: allows the deletion of Job Definitions.
Inquire: permits user inquiry into Job Definitions.
Note: Job Definitions can also be controlled by the Access Control List within each Folder
definition. To create a Job you must have Add access to Job Definitions plus Job Add access to
the Folder to which the Job belongs. Similarly, to modify, delete or inquire into a Job definition
you must have the corresponding Job Change, Job Delete or Job Inquire access rights for the
Folder to which the Job belongs.
Menu Definitions
Add: permits the addition of new Menu Definitions.
Change: allows the modification of existing Menu Definitions.
Delete: allows the deletion of Menu Definitions.
Inquire: permits user inquiry into Menu Definitions.
Monitor
Abort Jobs: permits a person to abort and restart any Job appearing on their display.
Execute: permits access to the Job Monitor. Only Jobs which the user has Monitor access can be
displayed.
Manage: allows a person to reschedule, hold, release and delete any Job appearing on their display.
See All Jobs: allows access to the Job Monitor and includes the ability to monitor Jobs submitted by
anyone.
See Own Jobs: allows access to the Job Monitor but only displays Jobs submitted by the user running
the monitor.
Note: Monitor capabilities are also controlled using Folder Definitions. For example, you could
grant someone See All Jobs access to the Job Monitor giving them the ability to monitor all batch
Jobs. Then each Folder definition could define whether or not the user can manage or abort any
Jobs located within that Folder.
Named Time Definitions
Add: permits the addition of new Named Time Definitions.
Change: allows the modification of existing Named Time Definitions.
Delete: allows the deletion of Named Time Definitions.
Inquire: permits the inquiry into Named Time Definitions.
92
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Manage: allows access to the Enable Time and Disable Time commands.
Queues
Add: permits the addition of new Queue Definitions.
Change: allows the modification of existing Queue Definitions.
Delete: permits the deletion of Queue Definitions.
Inquire: allows the inquiry into Queue Definitions.
Reporting
Add: allows the addition of new Report Definitions.
Change: allows the modification of existing Report Definitions.
Delete: allows the deletion of Report Definitions.
Execute: allows the execution of Report Definitions.
Inquire: permits the inquiry into Report Definitions.
Resource Definitions
Add: permits the addition of new Resource Definitions.
Change: allows the modification of existing Resource Definitions.
Delete: permits the deletion of Resource Definitions.
Inquire: allows inquiry into existing Resource Definitions.
Manage: allows the Jobs submitted by the user to acquire units of a Resource.
Security
Execute: grants the user the ability to modify the Access Control List for all security options.
Inquire: provides the user view access to the Access Control Lists for all security options.
Server
The Server ACL contains only one security option.
Execute: grants or denies access to the Server.
Setup Definitions
Add: allows the addition of new Setup Definitions.
Change: permits modification of existing Setup Definitions.
Delete: allows deletion of Setup Definitions.
Inquire: permits the inquiry into Setup Definitions.
Setup Definitions are also controlled by the Access Control List for each Folder definition. To create a
Setup you must have Add access for all Setup Definitions and Submit access to the Folder to which the
Setup’s Job definition belongs, plus Define Setup access to the Folder to which the Setup definition
belongs.
The Submit and Define Setup access rights are defined within each Folder definition.
Trigger Definitions
Add: permits the addition of new Trigger Definitions.
Change: allows modification to existing Trigger Definitions.
Delete: allows the deletion of Trigger Definitions.
Inquire: permits the inquiry into Trigger Definitions.
93
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Manage: allows the use of the Enable and Disable commands.
Reset: permits the use of the Reset command.
Users
Add: permits the addition of new user Definitions.
Change: permits the modification of existing User Definitions.
Delete: allows the deletion of User Definitions.
Inquire: allows the inquiry into User Definitions.
Variable Definitions
Add: allows addition of new Variable Definitions.
Change: allows modification of existing Variable Definitions.
Control: permits the modification of an individual Variable ACL's.
Delete: allows the deletion of Variable Definitions.
Inquire: permits the inquiry into Variable Definitions.
Note: Each Variable has an individual ACL which is used to protect only that Variable.
94
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
JAMS Security: Working with User Definitions
In JAMS individual user names are defined and later assigned to JAMS components (e.g., Jobs, Setups and
Folders). For example, when a Job is submitted it runs under the specified user name that is ultimately
controlled from an access control list (ACL). Each individual access control entry (ACE) consists of one or more
identifiers to determine the level of access granted to that user.
When a user attempts to perform a function, JAMS automatically checks if the user can actually perform that
function by matching the identifier in each ACE against the identifiers held by the user. When a match is found,
the user is granted access. If no matches are found, no access is granted.
Note: to modify a JAMS user definitions you must have the appropriate level of permissions in the ACL
to assign or change a user account’s “username” properties.
Adding a New User Name (Username)
As a prerequisite, all JAMS users must be recognized by the JAMS system before they can be assigned an access
level. To add a new user name, follow the steps below.
1. Select the Users Shortcut to open the Users View.
2. Click the green Add button on the JAMS Ribbon to initiate the JAMS Username Definition Wizard. Click the
Next button.
3. Enter a unique Display Name and optional Description for the new User. Click Next.
4. On the Logon As page use the file browser button to specify an existing user name that can be
authenticated during the log on procedure. If this field is left blank it defaults to the new username
(Display Name). Select the Next button.
5. Enter and confirm the Password for the new user name. Click the Next button.
6. On the ACL page highlight the username and use the checkboxes to select the appropriate access types
described below:
Change: includes permissions to edit the user account details.
Control: provides the ability to edit the user account's access control entry located on the User
Definition window (Security tab).
Submit: grants the selected the user account submission capabilities for a Job or Setup.
Get Password: includes permission to obtain a clear-text password using the Get-JAMSCredential
PowerShell cmdlet or via the .NET API.
7. Select the Finish button to complete the User Name definition process.
Modifying Existing User Name Properties
To change an existing username property, follow the 5 steps described below.
1. Choose the Users Shortcut to open the Users View.
2. Select and double-click an existing user name from the listing to access its User Definition.
3. Choose the Username tab to view and modify its properties as shown below.
95
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Display Name: sets the user name as seen in the Users View.
Logon As: can be used to specify the actual username used during login. If this property is left blank,
the Display Name is use by default.
Description: enter an optional description for the user.
The Key Management button: provides tools to manage the public and private key for the JAMS User
Security object that provides access to the remote server.
Note: JAMS supports SSH public/private key pairs directly within the GUI. You can load any
existing private key by selecting the Load Key button. JAMS then prompts for a Privacy
Enhanced Mail Certificate (.pem) file.
Typically, the SSH public key is loaded on the Server (JAMS Agent) and the private key is loaded on to
the Client (JAMS Scheduler).
Set Password button: allows you to enter a user name and password to access the remote server.
4. On the Security tab make any modifications to the user’s access type by selecting the appropriate
checkboxes as described in step 6 on the previous section.
To insert a new access control entry (ACE), highlight the user entry and select the (document icon) button
on the right of the dialog. Conversely, to delete an existing ACE, highlight the entry and choose the Delete
Access Control Entry button (the orange X).
96
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
5. Once all modifications to the User Definition have been completed, click the Save and Close (the large
green checkmark) button at the top left of the dialog.
97
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
JAMS Security: Managing Encryption Keys
JAMS encrypts password and private key information when it is stored in the database. The standard JAMS
installation uses a predefined encryption key, which is adequate for many sites. For additional protection you can
generate a unique encryption key but must ensure that it is properly backed up and secured.
When generating a unique encryption key, JAMS uses the Rinjndael encryption algorithm to re-encrypt all
password and private key information within the database. The generated key is then encrypted and stored using
the Windows Data Protection API (DPAPI). The protected key is then linked to user account associated with the
JAMS Server and Scheduler services.
Use the following commands available in the JAMSDBA utility to manage encryption keys:
GENERATE KEY - Generates a new 256 bit encryption key, decrypts the password with the old key then
encrypts it with the new key. The new encryption key is then stored using DPAPI.
EXPORT KEY - Pulls the encryption key from DPAPI and writes it to a text file.
Caution: It is critical that you protect the EXPORT file since the key is not encrypted.
IMPORT KEY – this is similar to the GENERATE KEY. But in this case the new key is pulled from a text file
instead of being generated. If recovering from backup or configuring the secondary server in a failover
configuration, you should use the /NOENCRYPT qualifier to skip the decryption and re-encryption of the current
data.
Protecting a Standalone JAMS Server
To protect a standalone JAMS Server, follow the steps below:
1. Log on to the server as a user with "Execute" access to JAMS configuration settings.
2. Set your default directory to the JAMS Scheduler installation directory. The default is: C:\Program
Files\MVPSI\JAMS\Scheduler
3. Execute JAMSDBA.EXE to open a JAMSDBA> prompt.
4. Enter GENERATE KEY and press Return.
5. Enter EXPORT KEY YourFileName.txt and press Return.
6. Enter EXIT and press Return.
7. Then move the exported text file to a safe location.
Restoring a Standalone JAMS Server
When restoring a backup of the JAMS database to different server, the encrypted passwords cannot be decrypted
because of the encryption key DPAPI protection associated with the original machine/user. To restore the
encryption key from a backup follow these steps:
1. Log on to the server as a user with "Execute" access to the JAMS configuration settings.
2. Set the default directory to the JAMS Scheduler installation directory. The default is: C:\Program
Files\MVPSI\JAMS\Scheduler
3. Copy the exported text file (YourFileName.txt) from your safe location to the current directory.
4. Execute JAMSDBA.EXE to open a JAMSDBA> prompt.
5. Enter IMPORT KEY/NOENCRYPT and press Return.
6. Enter EXIT and press Return.
Failover Environments
To protect the servers in a failover environment please follow the steps listed below:
1.
2.
3.
4.
Make sure that your primary JAMS Server is in the running state.
Log on to the primary server as a user with "Execute" access to the JAMS configuration settings.
Execute JAMSDBA.EXE to open a JAMSDBA> prompt.
Enter GENERATE KEY and press Return.
5. Enter EXPORT KEY YourFileName.txt and press Return.
98
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
6.
7.
8.
9.
Enter EXIT and press Return.
Move the exported text file to a safe location.
Log on to the secondary server as a user with "Execute" access to the JAMS configuration settings.
Set your default directory to the JAMS Scheduler installation directory. The default is: C:\Program
Files\MVPSI\JAMS\Scheduler
10. Copy the exported text file (YourFileName.txt) from your safe location to the current directory.
11. Execute JAMSDBA.EXE to open a JAMSDBA> prompt.
12. Enter IMPORT KEY/NOENCRYPT and press Return.
13. Enter EXIT and press Return.
99
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Preinstalled Dashboards
The Dashboard presents a graphical summary of information and trends within the JAMS environment. Starting
with version 6.2, JAMS provides a primary and other built-in Dashboards from which to choose.
In addition, JAMS comes with a set of preinstalled Dashboards that you can set up as an addition to or a
replacement for the primary Dashboard. These other Dashboards include:
The Advanced Dashboard
Completion History by Agent Dashboard
Current Load Balancing Dashboard
Job History by Agent Dashboard
PowerShell Dashboard
JAMS also includes a powerful designer tool to allow you to create custom Dashboards that track specific
information unique to your organization.
The Primary Dashboard
The primary Dashboard (dashboard.jbd) provides summary information on the current queue usage along with a
detailed 24 hour Job history.
To open the Dashboard, click on the Dashboard Shortcut. The primary Dashboard is divided into multiple panels
that are described in more detail below.
24 Hour Completion Status Summary Panel
This Dashboard panel includes a graphic display of Job completed over the past 24 hours. All
Jobs are broken out using JAMS completion status categories: fatal, warning, error,
informational, success.
100
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
The 24 hour graph is interactive. For example, when clicking on a data point, the graph zooms
in from its normal 24-hour range to focus on Jobs executed within the selected hour. To zoom
out, either right-click on the panel and select the Drill Up command or click the Drill Up icon.
Queue Usage Panel
In addition, JAMS comes with a set of preinstalled Dashboards that you can set up as an addition
to or a replacement for the primary Dashboard.
Setting up a Preinstalled Dashboard as a Default
To display the other Dashboards, you first need to open the Dashboard shortcut to alter its view settings as
described below or create a new custom shortcut.
1. To begin, right-click on the Dashboard Shortcut to view its context menu and select Properties to open the
Shortcut Properties dialog.
2. On the Views section, click the properties icon, shown in red.
3. The View Properties dialog opens.
4. Click the File Browser button to the right of the Dashboard File field to view the other preinstalled
Dashboards (all come with .jdb extensions). Choose an alternative to the primary (Dashboard.jdb) and
click the Open button.
Note: All preinstalled Dashboard (.jdb) files are located in the JAMS installation directory
(MVPSI/JAMS/Client).
5. Click OK to close the View Properties dialog.
6. Choose the OK button to close the Shortcut Properties Dialog.
7. The selected Dashboard displays and becomes the default whenever you open JAMS.
Note: The Dashboard title bar appears on some preinstalled Dashboards and is disabled on
the primary Dashboard. To change this setting refer to the Master Filter section of the Custom
Dashboards topic.
The Advanced Dashboard
The Advanced Dashboard (AdvancedDashboard.jdb) includes a dynamic display of jobs run over the past 24 hours.
All Jobs are broken out using JAMS completion status categories: fatal, warning, error, informational, success.
The Job History by Agent panel displays all Job history over the previous 7 days grouped by agent. You can
dynamically filter. The Dashboard, as shown below, uses the Master Filter to control what data is displayed in the
donut graph panel. The graph is linked or bound to the Agent Selection and Date Range items. Making changes to
either element (e.g., highlighting one or more agents or changing the date range slider), immediately updates
101
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
the graph to reflect the changing source data.
The Current Load Balancing panel is divided into three subpanels that can provide a picture of the overall health
of your JAMS environment.
Job Count by Agent subpanel allows user to select one or more agents to view how many Jobs are
running using that agent.
Queue Usage subpanel displays all queues, available usage capacity as well as their current utilization
rate.
Resources subpanel presents Resource load availability within the JAMS environment.
Completion History by Agent Dashboard
This Dashboard (CompletionHistoryByAgent.jdb) includes a Job History filtered by Agent name and final severity.
For example, selecting one or more agent names and clicking on chart’s bar elements (or key icons) refreshes the
two graphs.
102
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Current Load Balancing Dashboard
The Current Load Balancing Dashboard (CurrentLoadBalancing.jdb) is divided into three panels. All the
accompanying graphs in this Dashboard also appear in the Advanced Dashboard.
Job History by Agent Dashboard
This Dashboard (HistoryByAgent.jdb) graphically displays all Job history over the previous 7 days grouped by
agent. You can filter the data being displayed by selecting the agent name to view its individual history.
The Date Range subpanel can display Job History data within the last 7 days. For example if you only wanted to
103
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
view Job History for the previous 3 days history you could move the range selector to the correct date.
PowerShell Dashboard
This Dashboard (ServerResources.jdb) provides extensive data about the machine hosting the JAMS Client. This
multi-panel displays combines data on Disk Utilization, CPU Usage (broken down by average and Core) along with
current Memory usage. The Dashboard also includes a panel listing of all Jobs requiring user attention (e.g.,
stalled, runaway, holding, or halted).
Additional Dashboard Elements
Parameters
104
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Parameters pass information to various Dashboard Items or data sources allowing you to
quickly alter the Dashboard’s display. For example, the Advanced Dashboard contains 3
default parameters to define what agents, queues and resources to display in the Current
Load Balancing panel. Click the parameters button (icon with document and gears) to access the
Dashboard Parameters control window.
Some Dashboard Parameters use wildcard expressions. For example, in the Advanced Dashboard, if you wanted to
show specific information about current agents with “production” in their name, enter *production* in the agent
data parameter.
The Dashboard is not limited to these three parameters. You can add and customize additional parameters to
change what is displayed on the primary and preinstalled dashboards and create custom Dashboards.
Exporting Dashboard Items
You can export the Dashboard by clicking on the Export To button, which is located to the left of the Parameters
button. The export function allows you to print a snapshot of your Dashboard, control its resolution, and save it
as an image (png, jpeg, or gif) or a pdf.
Note: Some preinstalled Dashboards include Parameter settings, while others, such as the Primary
Dashboard, do not.
105
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Custom Dashboards
JAMS includes a variety of preinstalled Dashboards that are intended meet most user needs. In fact, it’s probably a
good idea to start using these Dashboards to get a better understanding what kinds of data are important and what
could potentially be added to enhance their usefulness.
JAMS comes with powerful design features to modify or completely alter a Dashboard to fit the way you use JAMS.
Custom Dashboards can incorporate a variety of data sources including: JAMS specific data, PowerShell scripts, plus
data stored in external databases, such as Microsoft SQL Server, MySQL, and Microsoft Access.
There are three key steps to setting up and building a custom Dashboard:
1. Defining a Data Source (using JAMS or external data sources).
2. Setting up a Dashboard Item (determining the Dashboard's functionality and formatting.
3. A third, optional step can include adding or modifying Parameters, setting up drill downs, filtering
functionality.
4. The last step is to add a custom Dashboard Shortcut.
Follow the steps below to build your own custom Dashboard using JAMS' powerful Dashboard Designer feature.
Defining a Data Source
The process of setting up a custom Dashboard begins by opening the Dashboard Designer and locating and
defining a Data Source. Custom Dashboards can incorporate a variety of data sources that can be used to
build simple or complex Dashboards.
To get started, select the Dashboard icon on the JAMS Ribbon Bar to open the Dashboard Designer.
1. Select the Dashboard Designer’s Data Source tab and choose the New JAMS Data Source button
located on the far left of the Ribbon.
2. The Save Dashboard File dialog opens. Enter a name for the Dashboard file (.jdb) and click Save.
3. The Add a Dashboard Data Source Wizard opens. On the first page, enter a Data Source Name and use the
pull down to select a Data Source Type (as described below). Click the Next button.
JAMS Data Source Types
History: provides JAMS history query that returns all JAMS Job properties matching a specific criteria
106
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
and time frame.
Completions By Severity: includes an optimized version of the History data source that only returns
completion count data. This is the preferred choice when retrieving historical data for a large
number of Jobs.
Queue Name: contains all the properties from your JAMS Queues.
Resource Name: includes all the information about each JAMS Resource, including usage data.
Resource Name incorporates comprehensive information about each JAMS Resource, including usage
data.
Agent Name: provides comprehensive information for all installed JAMS Agents.
PowerShell: runs a PowerShell script. The returned PowerShell objects are accessible to all
Dashboard items.
4. The Parameters Wizard page opens. Enter the desired parameters. For example, if the History type is
chosen, enter specific properties or use the wildcard expressions (as shown below) and click the Finish
button.
Using External Data Sources
You can also insert other non-JAMS data sources such as a database or XML files. To add an external data source,
follow these steps:
1. On the Dashboard Designer, select the Data Source tab.
2. Select the New External Data Source button. Please note: this is different than the New JAMS
Data Source button used in the previous section.
3. The Create Data Source wizard opens. On the first page, enter a name for your preferred data source.
Click the Next button.
4. The connection parameters page opens. Select a Provider from the drop down list. Depending on your
selection specify what data to acquire from the provider. Click the Next button.
107
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
5. After entering the desired options, click Finish to display the external data source on the Dashboard.
Setting up a Dashboard Item
Once a Data Source has been defined the next step is to set up the Dashboard item(s).
1. Begin this step by opening the Designer’s Home tab and select a Dashboard Item type on the Ribbon.
2. This action opens the Dashboard Elements page made up of three contiguous sections: Data Source
Browser, Data Items Pane and Preview Pane. This is the display where you link (or bind) the data source
created in the first step with the new Dashboard Item.
3. On the top of the Data Source Browser select an existing Data Source from the drop down menu.
4. As shown below, the selected Data Source opens displaying all associated Data Fields.
5. Drag the desired Data Field from the Data Source Browser and drop it onto the appropriate container field
on the Data Items pane.
Note: you can also remove the data item by dragging it outside the Data Items pane.
6. Use the Preview Pane to confirm each selection.
108
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Note: you can quickly change the Dashboard type by right-clicking in the Preview pane. This
action opens the Dashboard context menu. Select the Convert To command submenu to view a
listing of Dashboard types (e.g., Pivot, Grid, Chart, Pies, etc.)
7. You can insert additional Dashboard items by selecting another Dashboard type on the Designer’s Home
tab ribbon.
Note: you can only use one Data Source per Dashboard Item.
8. As shown in step 3, open an existing Data Source from the Data Source Dropdown menu and drag and drop
the desired Data Fields to the appropriate section on the Data Item Pane.
9. From the Design tab use the available tools to customize the new Dashboard item.
10. Click Save to complete the two-step Dashboard design process.
Modifying Parameters
Parameters pass information to Dashboard Items allowing you to alter what is displayed without having to make
changes from within the Dashboard Designer.
Changing an Existing Parameter
To access the parameters settings click the Parameters button (icon with document and gears located on the
top right portion of the Dashboard window). This action opens the Parameters dialog.
109
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Creating New Parameters
You can define new parameters within a Dashboard to further customize its display.
To add a parameter(s) to a Dashboard, open the Dashboard Designer.
1. On the Dashboard Designer’s Home tab click Open and navigate to the desired Dashboard
(.jdb) file, typically located in the JAMS Installation directory (MVPSI/JAMS/Client).
2. Select the Designer's Data Source tab and choose the Parameters button.
3. The Parameters Properties dialog opens. On the left panel select an existing parameter to
modify its properties.
4. Or click the Add button to define a new parameter.
5. On the right panel define the properties for the selected parameter.
110
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
6. Click the OK button when completed.
Using the New Parameter
The value of Dashboard parameters can be used for any JAMS Data Source Parameter. This is done using the
syntax $parameterName. For example, if you had a parameter called OffsetTime you would reference the
Dashboard parameter in a JAMS Completion by Severity data source by entering $OffsetTime into the wizard
instead of hard coding a number into the Time Offset field.
Setting up a Drill-Down Display
The Dashboard Designer includes a drill down function to help you create a more dynamic display with multiple
levels of information.
The example below shows how selecting a single node on 24 hour line graph zooms the information view to a
particular hour.
To create a drill down effect you must define multiple related data sets in the Arguments container field located
111
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
on the Data Items pane. The Dashboard’s highest level data is entered on the first Data Item Container field and
the “drill down” data is defined on the second.
Note: If three or more drill-down levels are needed, additional containers fields will appear on the Data
Items pane.
A Drill Down Example in 3 Steps
Use the following example to create a pie chart that displays JAMS Jobs that have executed over the past 24
hours by severity levels (e.g., Success, Warning, Error, Fatal and Informational).
Step 1: Set up the Custom Dashboard Item
To get started with this example, first create a Data Source.
1.
2.
3.
4.
From the JAMS Ribbon, open the Dashboard Designer.
On the Data Source tab select the New JAMS Data Source button located on the left end of the Ribbon.
The Add Dashboard File dialog opens.
On the first wizard page enter a Data Source Name. For this example, name it JAMS History and use the
pull down menu to select a Data Source Type. Choose the History option, which tells JAMS to provide
information on previously run Jobs. Select the Next button.
5. On the Parameters page, keep the default settings and click the Finish button
Step 2: Add a Custom Dashboard Item
6. From the Dashboard Designer, select the Home tab. On the Ribbon, choose the Pies option.
7. This action opens the Dashboard Elements page. This is where you bind specific Data Items to create the
pie chart.
8. From the Data Source Browser, use the pull-down menu to select the JAMS History Data Source you
defined in step 4. This action displays all Data Fields associated with the data source.
9. On the Data Source Browser drag and drop the specific Data Fields to the appropriate Data Item Containers
on the Data Items pane, as described below.
Find and then drag the FinalSeverity Data Field to the first Values Data Item Container.
Second, drag the same FinalSeverity item again, this time to the first Arguments container field.
These data items will appear in the top level display as shown in the preview window below.
To add the data item for the drill down view, drag the JobName data item to the second Argument
container.
112
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Step 3: Define and Setup the Drill down Property
10. On the Dashboard Designer select the Data tab.
11. Activate the Arguments button. By enabling the Arguments option the Dashboard item treats the two
arguments as distinct, but related data sets.
12. Click to activate (highlight) the Drill Down button. This allow the Dashboard Designer to interpret
different sets of data between the two Arguments data item containers.
13. On the Preview pane, test the drill down by clicking on the Success portion of the pie chart. This
actions should now detail all successful Jobs executed during the past 24 hours.
14. To move back to the first level pie chart display, right-click on the chart to display the Drill up context
menu or alternatively choose the curved arrow Drill up icon.
15. Select the other elements of the pie chart to test the drill down function.
16. Optionally, open the Design tab to take advantage of the built-in formatting tools.
17. Choose the Save button to complete the custom Dashboard.
113
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Using the Master Filter
The Master Filter is a Dashboard Designer feature that allows you to choose what data is displayed on a
Dashboard Item. For example, when Master Filtering is enabled you can click a specific Dashboard Item to
trigger updates to other items (chart, pies, gauges, etc.).
The Dashboard example below uses the Master Filter to control what data is displayed in the donut graph in the
Preview panel. In this case, the donut graph is linked to the Agent Selection and Date Range items. Making
changes to either element (e.g., highlighting one or more agents or changing the date range slider), immediately
updates the graph to reflect the changing input data.
Using Master Filter Modes
For each Dashboard Item, the Master Filter supports two selection modes: Multiple and Single.
Multiple Master Filter Mode
This mode allows you to select multiple elements within a Dashboard subpanel. For example, when choosing the
Agent Selection subpanel with the Multiple Master Filter enabled you can Control + click to highlight multiple
agents as shown in the two screenshots below.
Single Master Filter Mode
114
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Unlike the Multiple Master Filter, the Single Master Filter mode only allows you to select one element at a time
within a selected Dashboard subpanel.
Ignoring the Master Filter
Dashboard items can be set to ignore the Master Filter entirely. To do this, choose a Dashboard Item and select
the Ignore Master Filters button located on the Dashboard Designer’s Data tab.
For example, the Agent Selection sub panel, shown above, is set to ignore the master filter because it is the
primary setting for that subpanel. In other words, you input an agent selection in order to update the donut
graph, not the other way around.
Enabling the Master Filter
As described above, there are several Master Filter modes and settings, but there is no one place where you can
actually view all these settings. Instead, each individual Dashboard Item must be selected within the Designer to
view the Master Filter settings. However, you can view the Master Filter state by hovering over the filter icon adjacent to the Dashboard title.
This filter icon only appears when there is more than one criteria affecting the filter.
The Dashboard Title is turned off by default on the primary Dashboard. To change this settings open the Designer
and select the Home tab. On the far right side of the Ribbon select the Title button. On the Dashboard Title
dialog, activate the Visible and Show Master Filter state checkboxes.
Finally, to make changes to a Dashboard’s Master Filter settings, open the Dashboard Designer.
1. On the Designer’s Home tab click the Open button.
2. Navigate to and select the desired Dashboard (.jdb) file.
3. This opens the multi-panel Dashboard Elements page.
4. Select the Data tab to view what, if any, Master Filter buttons are activated.
5. On the Preview pane, select a subpanel. Notice how the Data Item Container fields are updated to reflect
the subpanel’s settings. This is where you define or modify how each Dashboard Item affects the Master
Filter.
Adding a Custom Dashboard Shortcut
Finally, you will need to create a Shortcut that links to the completed Dashboard. Every custom Dashboard
generates a .jdb and preference file. To access a Dashboard in the JAMS Client you must define a shortcut that
115
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
points to the desired .jdb file as described below.
1. From the Shortcut Bar’s Control group right-click to display the context menu and choose the Add
Shortcut command.
2. The Add a Shortcut wizard opens. On the first page, select a Dashboard icon from the dropdown list, enter
a name, title (the Dashboard’s display page title) and description for the shortcut. Choose the Next
button.
3. Select the Dashboard options from the View list. Click the Next button.
4. On the properties page, set the shortcut properties for the View by populating the name and title fields.
Locate the specific Dashboard by selecting a server or maintain the Active Server default option. Use the
File Browser button to navigate to the specific .jdb file. Click Next.
Note: You should also check for a preference (.pref) file with the same name as the Dashboard
located in that folder. If this preference file is not in the same folder as the jdb file the Dashboard
won’t function properly.
5. Specify a Refresh Interval, which is the amount of time between automatic updates to the Data Source.
Use the format: Days.Hours:Minutes:Seconds; e.g., 0.2:30 (refreshes every 2 hours and 30 minutes.
Leaving any element blank defaults to 0). Click Next.
Note: if the Refresh Interval field remains empty or is set to 0 the Dashboard cannot
automatically refresh. Alternatively, you can manually initiate a refresh by clicking the Refresh
button on the JAMS Ribbon.
6. Finally, click Finish or select the Add Another View button to include additional Views for the Shortcut.
As shown below, the new Dashboard link should appear in the Shortcut Bar's Control group.
116
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
JAMS Scheduler Features
117
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
JAMS Scheduler Services
The JAMS Scheduler is essentially the heart of the JAMS system and is responsible for keeping track of the status
of all Jobs, firing triggers, checking dependencies and communicating that status back to the JAMS Client.
While you interact with the JAMS Scheduler through the JAMS Client, the JAMS Scheduler can be configured to
operate in a centralized or decentralized fashion. In other words, you can choose to run a JAMS Scheduler on
many different machines to spread the management tasks and eliminate single points of failure.
When first installing JAMS, the Scheduler creates three Windows Services that are detailed below.
JAMS Scheduler Service
JAMS Executor Service (JAMS Agent Service)
JAMS Server Service
JAMS Scheduler Service
This key component provides background Services to allow for scheduling, maintaining and executing JAMS Jobs,
Setups, Tasks and Scripts on all types of systems available on your network.
The Scheduler Service prepares Scripts to run, takes action if required during Script execution or when a Script
completes. A more detailed explanation of the Scheduler Service is described below.
Before a Script can run, the Scheduler Service determines if . . .
A Script's Dependencies are satisfied.
It can execute the Script's Pre-Check Script, if one is specified.
The Script's Queue is started and there is a slot available.
The Script's Resources are available.
The Script's Scheduling Window is open.
The Script requires parsing (based on its Execution Method). If so, then the Script's source is parsed and
substitutions occurs for Parameter and Variable values.
While a Script is running, the Scheduler Service. . . .
Reports the Script's execution details to all JAMS Clients monitoring the Schedule.
Performs notification if the Script runs longer than its set limit.
Uses the Script's defined action if the Scheduling Window closes during execution.
Once a Script completes, the Scheduler Service . . .
118
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Reports the Script's completion to all JAMS Clients monitoring the schedule.
Records the Script's run instance in JAMS History, which is available for query from the JAMS Client.
Performs notification, if required.
Determines if the Script's completion satisfies Dependencies for other Scripts in the schedule.
Determines if the Script's completion satisfies Trigger Events so that Trigger Actions can fire.
Makes sure the Script's Resources are released.
Executor Service
As its name implies, the JAMS Executor Service is responsible for the actual execution of any given Script.
Scripts are prepared to run by the JAMS Scheduler. Once the Scheduler Service determines the Script is ready to
run the Executer . . .
1. Is notified and begins executing the Script.
2. Then writes output generated from the Script to the Script's log file.
3. And notifies the Scheduler when the Script has completed.
If the script is set to run on a different machine, JAMS Agent Services (an extension of the Executor Service)
contacts the Agent on the remote machine and directs it to run the script.
The JAMS Scheduler cannot function without access to the JAMS Database. However, JAMS is designed to be
resilient. All Job execution functions are handled by the JAMS Executor Service; so if the JAMS Scheduler Service
fails, all Job execution information remains secure.
Server Service
The JAMS Server Service provides middle-tier services to the JAMS Client. This includes all client components
including: GUI, Powershell, .NET Class Library, and Web Services.
The JAMS Server Service is primarily responsible for maintaining database access for one to many JAMS Clients.
While the Server Service is not involved in the execution of Jobs, many Jobs may utilize the JAMS Powershell
client, which requires this Service.
Troubleshooting JAMS Services
Reviewing the Event Log and .log Files
All the described JAMS Services creates a log file in the JAMS installation directory (Program
Files/MVPSI/JAMS). This log file is named ServiceName.log (i.e., JAMSScheduler.log) and is reset every Sunday.
The previous week's log files are then renamed to ServiceNameArchive.log (i.e. JAMSSchedulerArchive.log).
Each Service writes serious errors to the Windows Event log. When troubleshooting JAMS, you should check both
the event log and the aforementioned .log files.
Stopping and Restarting a Service
If you suspect there is a problem with JAMS and want to restart the JAMS Services, begin with the JAMS Scheduler
Service. The JAMS Scheduler Service does the most work and restarting it is the least disruptive to the system.
Restarting the JAMS Scheduler Service will not cause any Jobs to fail or any job completion information to be
lost. However, when the JAMS Scheduler Service is stopped, new Jobs cannot execute.
As a next step, you can stop the JAMS Server Service. This can be done without losing any Job execution
information. However, JAMS Clients cannot function while the JAMS Server Service is down.
As a last resort you can try stopping the JAMS Executor Service. Unfortunately, halting this Service doesn’t
usually resolve most problems. When putting this Service on hold, all completion information for executing Jobs
will be lost, likely causing some Jobs to fail.
Also, when doing SQL Service maintenance, there is no need to stop the JAMS Executor Service, since it does not
access the JAMS Database.
Service Accounts
119
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
JAMS Services are set to run using the LocalSystem account. However, if you need to change this to a Windows
Domain based account, JAMS recommend leaving the Executor and JAMS Agent Services running under
LocalSystem as these Services do not need to access the database or network, but they do require privileges
associated with the LocalSystem account.
You can use the Service Control application to change the account that the JAMS Scheduler and JAMS Server
services run under as this could be important when controlling network and database access.
When changing the account you may also need to adjust the security settings on:
C:\Program Files\MVPSI\JAMS\Scheduler folder
C:\Program Files\MVPSI\JAMS\Scheduler\JAMSScheduler.log
MSMQ JAMSRequests Private queue
SQL Server
JAMS Database
For the MSMQ JAMSRequests private queue, you must make sure to modify the security on the queue to grant the
domain account full access to the queue. This may require you to "Take Ownership" of the MSMQ queue.
The following Local Security access should also be granted for the domain based account:
Log on as a Batch job.
Log on as a Service.
Adjust memory quotas for a process.
Bypass traverse checking.
Replace a process level token.
If the domain based user account is not in the administrators group, create an Active Directory Group and add
the user to the group, and then include the following:
<add key="AuthorizedGroup" value="Domain\YourGroup" /> in the Common.config file located in the
Program Files\MVPSI\JAMS\Scheduler directory.
120
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Configuring the JAMS Scheduler
There are two ways to configure the JAMS Scheduler. The first is to create or modify the Configuration Settings using
the JAMS Client. The other is to edit the .exe.config file. Both methods are described below.
Configuration Setting on the JAMS Client
Configuration Settings define and maintain many of JAMS’ system-wide options. Generally, users define
these options after installing JAMS, but usually don’t update them on a frequent basis after that.
JAMS comes installed with several Scheduler-specific configuration settings. These allow users to define
how far a schedule can extend into the future or the Schedulers maximum downtime hours. Other
installed Configuration Settings include specific organizational scheduling definitions, such as “Is Monday
usually a workday?”.
To view, create or modify these settings select the Configuration Shortcut. The Configuration Settings
View opens listing the available Configurations.
Defining a New Configuration Setting
To create a new setting, select the Add button from the Ribbon Bar.
1. The JAMS Configuration Setting Wizard opens. Select the Next button.
2. On the Configuration Name page enter a unique name for the Configuration Setting and an optional
description. Click Next.
3. On the Configuration Value page, use the radio buttons to choose the Data Type for the Configuration Setting.
In the field below enter the appropriate value based on the selected data type. Choose the Next button.
4. Select the Finish button to complete the new Configuration definition.
Modifying a Configuration Setting
1. To modify a Configuration Setting, double-click an item from the Configuration Settings View.
121
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
2. The Setting properties Name tab window opens, which includes three parameters: Name, Description and Last
Changed. On this tab, only the Description parameter can be modified.
Note: Only on the Name tab can the Description parameter can be modified. To modify these
parameters you must define a new Configuration Setting, as described in the previous subsection.
3. The Value tab allows users to change the Configuration’s Value settings. In this example (“Is Monday usually a
holiday?”), users with the proper security access can modify the value from “True” to “False”. This modifies
Monday’s typical status to a non-workday. The Data Type parameter, located just above, cannot be modified
except during the definition process, as described in the previous section.
Note: When a Configuration setting is modified it usually take affect immediately. However, in some
cases you may need to restart the JAMS Scheduler Service before the change takes effect.
Editing .exe config
Configuration settings are also found in one of several .config files located in the JAMS installation directory,
Program Files\MVPSI\JAMS\Scheduler . The filename of each configuration file is:
Common.config
JAMScheduler.exe.config
JAMSExecutor.exe.config
JAMSServer.exe.config
Common.config is shared by the other .config files and contains all user-specific settings.
Note: You should only change one of the other .config files under the direction of JAMS Technical
Support unless you understand the implications of altering these files.
The Common.config file is preserved when upgrading JAMS; the other files are overwritten each time JAMS is
122
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
upgraded to a new version.
You can change settings in these configuration files at any time; however, in most cases, these settings are
only loaded when the service starts.
123
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Logon as Batch
JAMS Jobs run as batch processes using Windows. As a requirement, these batch jobs must have the Log on as
Batch user rights for the Windows account that runs them. If running the Job on an agent, users must also have
Log on as a Batch privileges within the local security of the agent machine.
Keep in mind that the agent Job must have appropriate access to perform whatever operation the particular Job
is doing; for example, if a copy process to a specific folder is included, you must have access to that folder.
Granting Rights using Windows 2008/2012
From Windows 2008/2012, you can grant the Log on as a Batch Job rights at the domain or the local level. To
manage rights under Windows 2008/2012, use the Local Security Policy or Domain Security Policy Administrator
utilities.
Managing Rights on Member Servers and Workstations
To manage user rights on member servers and workstations, choose the Select Domain... option from the User
menu. Enter \\machinename in the Domain field and click OK to be connected to the specific machine. From
here you can manage user rights on that machine.
124
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Upgrading JAMS
125
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Upgrading from JAMS 5.x to JAMS 6.x
Upgrade Requirements
Prior to upgrading JAMS from V5.x to V6.x, carefully review the following requirements:
SQL 2000 is no longer supported for the JAMS database. JAMS V6.x supports SQL 2005, 2008, 2012, and
2016.
Version 4.5 of the .NET Framework is required.
JAMS V6.x Clients are not compatible with JAMS V5.x Servers; and JAMS V5.x Clients are not compatible
with JAMS V6.x Servers.
Note: If you are using the JAMS Client on a remote workstation machine (a machine other than
the JAMS Server itself), you must upgrade the JAMS Client to V6.x to access a newly upgraded
V6.x Server. However, if you need to access a JAMS V5.x Server, the JAMS V6.x also includes an
option to install a JAMS V5.4 Client. This client installs in a new directory to allow for the
simultaneous usage of both clients.
JAMS V6.x Servers can execute Jobs on all versions of the JAMS Agents.
JAMS V5.x Servers can execute Jobs on all version of the JAMS Agents, including V6.x.
The upgrade process creates a new JAMS SQL database for V6.x and keeps your existing JAMS database
intact and remains in a static state. Once the upgrade is complete, any changes to your JAMS Job/Setup
definitions, Job Schedule, etc. are updated to the new V6.x JAMS database.
Since a single JAMS Client is not able to connect to both a V5.x and V6.x JAMS server, the only way to
move Jobs between V5.x and V6.x JAMS Servers is with the Export-JAMSXml and Import-JAMSXml
PowerShell commands.
JAMS Systems in 5.x have been renamed to Folders. Folders in JAMS V6.x serve the same purpose as
Systems in earlier versions of JAMS. In JAMS V6.x, you have the ability to define multiple levels of
folders and subfolders, allowing for greater organizational capabilities for your Jobs and Setups. In
addition to Jobs and Setups, Triggers and JAMS Variables can now be stored inside Folders.
When the JAMS V5.x Client is upgraded to V6.x all custom groups and shortcuts for that Client are lost
and must be recreated in the JAMS V6.x Client if you wish to continue using them.
It is recommend that you put any scheduled Jobs on hold and stop any batch queues in place so that no
Jobs are interrupted during the upgrade process.
The installation package must be run as a user account with SA access to your SQL instance, as the JAMS
Installation makes critical updates to the database’s Master Records and creates a new JAMSV6
database.
If you used a custom database name during the initial installation of JAMS V5.x, you must update the
common.config file located in the root installation of JAMS.
A Special Note on PowerShell Scripts in JAMS V6.x
Current JAMS PowerShell scripts should continue to work unless there is a change to the path to a JAMS object.
Prior to V6.x, JAMS included a number of "simulated" folders.
For example, in JAMS V5.X, to access a Trigger, the path might be:
JAMS:localhost\Triggers\TriggerName
The "Triggers" portion of that path represents a simulated folder. The conversion process now puts all triggers
into the “root” folder. Variables are converted in the same manner.
If you use these paths in PowerShell scripts, you can now create real folders named Triggers and Variables and
move all Trigger and Variable definitions into them to maintain the functionality of your existing PowerShell
scripts.
Systems, Jobs, and Setups within JAMS are also updated. In V5.x, you could access a Job as:
JAMS:localhost\Systems\MySystem\Jobs\MyJob
126
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
In this case, the "Systems" and "Jobs" folders are both “simulated”. However, in V6.x, the same Job is accessed
using the path:
JAMS:localhost\MyFolder\MyJob
Users who would like to retain the V5.x syntax have the option to create a folder named "Systems", move their
"MySystem" folder into it. This creates a nested "Jobs" Folder allowing you to move Jobs to that Folder.
127
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Upgrading from JAMS 6.x to 6.x
JAMS can be upgraded directly over an existing installation of an earlier 6.x JAMS Client and/or JAMS Scheduler.
Specifically, you can run a new 6.x installation executable to update JAMS using your current database while not
disturbing any existing Jobs and Schedules.
Use the steps below to prepare and initiate a JAMS 6.x upgrade.
Scheduling the Upgrade
Schedule the upgrade for a less busy time in your JAMS schedule. It is recommend that you put any
scheduled Jobs on hold and stop any batch queues in place so that no Jobs are interrupted during the
upgrade process.
Make a backup of your JAMS database just before the upgrade. Typically, there should be no issues with
the upgrade, but it is always good to have the backup if needed.
Downloading the Latest JAMS Release
Download latest JAMS release from Product Download Links page.
Note: You must first be registered for JAMS account and logged in to JAMS Support in order to access
the Product Download Links page.
Installing the Executable
When running the installation executable, choose which JAMS components you want to upgrade. At minimum, a
typical upgrade includes the JAMS Scheduler and JAMS Client on the main JAMS Scheduler Server.
Note: In JAMS 6.4.5X and up, unchecking component boxes will uninstall those components
During the upgrade the JAMS installer stops the appropriate JAMS services and then brings them back up once the
upgrade is complete.
Note: Make sure the user that you are logged in as on the JAMS Scheduler machine has full
admin rights to the JAMS SQL database. This is important to allow the database schema to be
properly updated. Typically, giving the user sysadmin rights takes care of all necessary permission
issues.
Once the JAMS Scheduler Server has been upgraded, the same installation executable can be used to upgrade any
remote JAMS Client installation. In this case, choose to upgrade only the JAMS Client when presented with the
list of JAMS Components.
Redeploying JAMS Agents
JAMS Agents can be upgraded by redeploying the Agents from the JAMS Client's Agents Shortcut. JAMS Agents can
be automatically deployed or manually deployed, whether using Windows or Unix/Linux Agents.
128
©2017 MVP Systems Software, Inc. All Rights Reserved.
JAMS 6.X User Guide
Upgrading JAMS Using a Primary-Failover Environment
Use the steps below to upgrade JAMS if you have a Primary-Failover Server Environment.
Since both the JAMS Scheduler Engines use the same database, you must first stop the JAMS Services (JAMS
Executor, JAMS Scheduler, and JAMS Server) on the Primary and Failover Engines prior to updating.
Note: This also stops any currently executing Jobs. So stop these services at a time when you can have
no Jobs running.
Upgrading the Primary Engine
1. Perform the upgrade on the Primary Engine. Once this is complete the JAMS Services and the JAMS SQL
Database starts automatically.
2. Again, stop the JAMS Services on the Primary Engine since they were started after the actual upgrade.
Upgrading the Failover Engine
1. Perform the upgrade on the Failover Engine.
2. Stop the JAMS Services on the Failover Engine again since these services originally started after the
upgrade.
Restarting the JAMS Services
1. Start the JAMS Services on the Primary Engine and wait a minute or two for the configuration to register
with the database.
2. Start the JAMS Services on the Failover Engine. Everything should register with the proper failover
configuration within approximately 3 minutes.
3. On the JAMS Client, go to About > JAMS Server and select the Status tab. You should see that each
engine listed in the correct mode. It may be necessary to scroll down to view all the pertinent
information.
Note: You may need to scroll down that window to display all the information.
129
©2017 MVP Systems Software, Inc. All Rights Reserved.