JAMS 7.X Installation Guide
Table of Contents
JAMS Installation Guide
2-22
Installing and Deploying Specific JAMS Agents
23
JAMS Agent for System i
24
JAMS Agent for Windows
25
JAMS AgentX
26
Installing and Configuring JAMS add-ons
27
Dynamics AX add-on: Configuring and Job Setup
28
Oracle EBS add-on: Configuring and Automating
29
Automating Oracle EBS Jobs
30-31
PeopleSoft add-on: Installing and Configuring
32
PeopleSoft
SAP EEC add-on: Configuring JAMS on SAP EEC EHP 3 & 7
43
JAMS Instrumentation add-on
44
JAMS Management Pack for MS SCOM
45
Microsoft SCOM
Running SAS Jobs with JAMS
SAS
46-50
51
52
JAMS Incident Management Pack for ServiceNow
53
Symitar add-on: Configuring and Job Setup
54
Symitar
1
33-42
55-63
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
JAMS Installation Guide
NOTE: Uninstall features are present in the Installation Wizard. Unchecking component boxes in the
Add-Ons section will uninstall those components.
Installed Components
The JAMS environment incorporates several key components that work together to create a unique and
powerful scheduling system.
JAMS Client
The JAMS Client provides the primary user controls for JAMS and includes:
Windows-based GUI (JAMS Client)
PowerShell Cmdlets
JAMS PowerShell provider
.NET-based Class Library
JAMS.exe command line tool
JAMS Scheduler for Windows
This is essentially the heart of the JAMS system. The scheduler provides background services that maintain,
schedule and execute JAMS Jobs.
JAMS Agent for Windows
JAMS Agents provide background services that execute JAMS Jobs under the direction of a JAMS Scheduler
located on a different machine.
JAMS Agent for OpenVMS
The JAMS Agent for OpenVMS provides background processes that execute JAMS Jobs under the direction of a
JAMS Scheduler located on a different machine.
Preparing for the JAMS Installation
JAMS Scheduler
JAMS Agent
.Net Framework v.4.6
(or higher)
Software
Prerequisites
Microsoft Message
Queue (installed with
JAMS)
Microsoft SQL Server
2012, 2014, or 2016
Hardware
Server
(minimum)
2
Processor: Dual Core
~2.5 GHZ (x86 or X64)
Memory: 8 GB
Disk Space: 10 GB, in
addition to the disk
space required by the
OS
JAMS Client
.Net
Framework
v.4.6 (or
higher)
.Net
Framework
v.4.6 (or
higher)
Processor:
1 GHZ
(x86 or
x64)
Processor:
1 GHZ
(x86 or
X64)
Memory: 1
GB
Memory: 1
GB
Disk
Space: 75
MB
Disk
Space: 300
MB
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Hardware
Server
(50,000 to
100,000 Jobs
per Day)
Processor: 8 Core ~3.2
GHZ (x86 or X64)
Memory: 32+ GB
Disk Space: 1+TB
Recommended: A
separate SQL Cluster
for the JAMS SQL Backend
Processor: 16 Cores,
~3.2GHZ
Memory: 64+ GB
Harware Server
(>100,000 jobs
per day)
Disk Space: 1+ TB
One server hosting the
JAMS Scheduler
One server reserved for
the SQL Server with
multiple high-speed
SCSI drives
Processor:
1 GHZ
(x86 or
x64)
Processor:
1 GHZ
(x86 or
X64)
Memory: 1
GB
Memory: 1
GB
Disk
Space: 75
MB
Disk
Space: 300
MB
Processor:
1 GHZ
(x86 or
x64)
Processor:
1 GHZ
(x86 or
X64)
Memory: 1
GB
Memory: 1
GB
Disk
Space: 75
MB
Disk
Space: 300
MB
NOTE: The JAMS Site (REST API) requires Server 2012 R2 or higher.
Permissions
To install JAMS, ensure that the user performing the installation is logged in as an account with administrator
privileges to the application server. In addition, the account must have the ability to create a database on the
database server. JAMS creates the database locally by default. Typically, giving the user sysadmin rights takes
care of all necessary permissions.
Prerequisites
Before installing JAMS, please review the following requirements detailing the prerequisite software and
minimum hardware requirements.
The JAMS self-extracting setups checks for and installs all prerequisites.
.NET Framework v. 4.6
The JAMS Client and Scheduler require .NET Framework v. 4.6 (or higher). Once the JAMS installation begins,
it checks if this version of .Net Framework is installed. If v. 4.6 is not installed, the installation will ask users
to accept Microsoft's license agreement. Once the agreement is accepted, the software will then download
and install the framework.
Note: Installing v.4.6 of the .NET Framework will require a system reboot.
.NET Framework v. 4.6
The JAMS Agent requires v.4.6 (or higher) of the .NET Framework.
Microsoft Message Queue (MSMQ)
The JAMS Scheduler requires the Microsoft Message Queue (MSMQ). When installing the JAMS Scheduler, the
installer will check for the MSMQ and, if it's not installed, will ask you to confirm that you want to install it.
For more details, go the MSMQ section in this topic.
Note: MSMQ is included with Microsoft Windows, but it is optional and not installed by default.
3
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Microsoft SQL Server
The JAMS Scheduler requires Microsoft SQL Server 2012, 2014, or 2016. The SQL Server does not need to be
installed on the same machine as the JAMS Scheduler.
If you or your DBA choose to install the JAMS Scheduler component, the installer will first check for a
connection to an SQL Server. If the server not installed, the installer will ask to install the SQL Server 2012
Express Edition.
You also have the option of using an SQL Server on a different machine. Please note, when the installer checks
for the SQL Server, it only looks for the default instance names of MSSQLSERVER and SQLEXPRESS.
If you have a different instance preference, decline the SQL Express installation and specify your preferred
instance when the JAMS installer asks for the SQL server name and instance.
NOTE: To run SQLStoredProc Execution Method Jobs, Shared Management Objects for your version
of SQL will be needed. Shared Management Objects can be found in the appropriate Microsoft
Feature Pack version, or in the install for SQL Management Studio.
NOTE: To run SSISDirect Execution Method Jobs, the Client Tools Backwards Compatibility and Client
Tools SDK Shared Features are required.
PowerShell
The JAMS Client component includes a PowerShell Snap-In that contains a number of JAMS cmdlets and a JAMS
Provider. PowerShell is not required, but in order to use the Snap-In you must install PowerShell before
installing JAMS. If you happened to install PowerShell after installing the JAMS Client, just reinstall the JAMS
Client to pick up the JAMS Snap- In.
Note: JAMS supports PowerShell v. 2 and higher
Hardware Server Specifications for the JAMS Scheduler
Processor: ~2.5 GHZ (x86 or x64)
Memory: 8 GB
Disk Space: 10 GB, in addition to the disk space required by the OS.
These are the minimum system requirements that can support running thousands of jobs per day. Heavy loads,
for example, over 100,000 jobs per day, will require more resources.
For database planning, the JAMS test lab runs approximately 1,000 jobs per day using one instance of JAMS.
Retaining 30 days of information generates a database approximately 110 Mb in size.
For sites running over 100,000 Jobs per day
Based upon customer implementations where more than 100,000 jobs are executed each day, the JAMS
installation should consist of:
Two Windows servers, each with Dual Quad 2.0 GHz CPUs and 32 GB of RAM (or more).
Specifically, one of the above servers hosting the JAMS Scheduler and the second server reserved for
the SQL Server with multiple high-speed SCSI drives.
Hardware Server Specs for JAMS Agents
Processor: 1 GHZ (x86 or x64)
Memory: 1 GB
Disk Space: 75 MB
Hardware Server Specs for the JAMS Client
Processor: 1 GHZ (x86 or x64)
Memory: 1 GB
4
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Disk Space: 300 MB
Supporting JAMS in a Virtual Environment
MVP Systems Software, Inc. supports customers running JAMS on any supported operating system in a
virtualized environment, such as VMware and HyperV.
Installing JAMS
Follow the steps below to install JAMS on a Windows computer.
1. Log on to Windows using an account with administrator privileges. (Typically, using an account
with sysadmin rights takes care of all necessary permissions.)
NOTE: Users must also have the ability to create a database on the database server. The
default database server is the local machine.
2.
3.
4.
5.
Rick click the SetupJAMS executable and select Run as Administrator to start the JAMS installer.
On the Welcome step, verify this installation is the proper edition and version. Click the Next button.
On the License Agreement step, review and accept the JAMS license agreement. Click the Next button.
On the Core Components step, select the JAMS Components to install. If this is a new installation where
no Scheduler exists, the JAMS Client and JAMS Scheduler should be installed at minimum. When
finished, click the Next button.
6. On the Integration Packs step, select the packs to install. Note that Integration Packs are not required
to install JAMS. Click the Next button.
7. On the Contact Information step, enter the information that will be used when working with the JAMS
technical team. Click the Next button.
8. On the SQL step, enter the information that will be used to create the JAMS database, as well as the
authentication used to connect to the JAMS database. Click the Next button.
NOTE: The JAMS Scheduler Service will not start until the JAMS database is created.
NOTE: Users should NEVER attempt to manually create the JAMS database.
9. On the Locations step, define the preferred target directory or accept the default for JAMS and the
JAMS database files. Click the Next button.
NOTE: In an upgrade, the target directory cannot be modified.
10. On the JAMS Sample Jobs step, decide whether the sample jobs should be installed. If installing sample
jobs, define a JAMS user to run the sample jobs. Click the Next button.
11. On the Web Client Details step, select where the web client should be installed.
12. You may be presented with a page that asks you to confirm that you want to install MSMQ.
13. In addition, you may be presented with a page that asks if you want to download and install the SQL
Server Express Edition.
14. On the Finish page click the Finish button to begin the installation.
JAMS Client Installation Components
The JAMS Client installation includes the following items:
A Start Menu shortcut to JAMSWin.exe
The JAMSShr.dll Class Library
The JAMS PowerShell Snap-In (only if PowerShell is installed at the time of the JAMS Client
installation)
The JAMS.exe command line tool
JAMS Help files
JAMS Scheduler Services Installation
5
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
The JAMS Scheduler installation also contains other important JAMS components including:
JAMS Scheduler Services
JAMS Server Services
JAMS Executor Services
Note: if this is the initial installation of the JAMS Scheduler, you will be prompted for additional
information when the installer configures the JAMS Database.
JAMS Command Line Environment
In addition to the JAMS Client GUI, the Powershell SnapIn, and the .NET Controls, JAMS offers a command line
interpreter to manage your scheduling environment.
When the JAMS Client installs, it also includes a command line tool (JAMS.EXE)
1. When started from the command line, a JAMS> prompt appears.
2. Type HELP to reveal all the supporting commands. Type HELP COMMAND to get additional assistance
for a particular command (e.g., HELP EXPORT JOB).
Your first action establishes the connection to the JAMS ServerName.
Creating the JAMS Database
The JAMS Installer will create the database, unless users specify otherwise. The Database should always be
created by JAMS. If the database was not created on installation, users may manually start the JAMS Database
Creation Wizard.
Note: Installing JAMS without a database won’t affect the JAMS installation, but JAMS cannot
function without a database. To reinstall the JAMS Database, start the wizard as described in
the Troubleshooting subsection below.
Troubleshooting: Starting the JAMS Database Creation Wizard
If you encounter problems with the JAMS Database, start the JAMS database creation wizard by following these
four steps:
1. Open a command window (PowerShell or CMD.EXE)
2. Set your default directory to the JAMS Scheduler default directory (C:\Program
Files\MVPSI\JAMS\Scheduler).
3. If the file Common.config file exists, delete it.
4. Enter the command: JAMSDBA INSTALL
Support Contract Information
6
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Support Contact Information page requests information to be sent to JAMS technical support in the event of a
failure. This information includes the:
Company Name
Contact Name
Phone Number
E-Mail Address
SMTP Server
Note: Populating this page is optional, but entering accurate information can help JAMS support staff
improve its support capabilities. If you’re unsure about the information, leave it blank and enter it at
a later time.
SQL Server Page
On this page you will specify the name of the SQL server machine and the SQL Instance. If the SQL Server is
installed on the local machine, the default will be (local). If the server you want isn't listed in the pull-down
control, you can enter the name and instance manually.
Database Name
This is the name of the database that will be created. The default is JAMS. However, you will need to change
this to a unique name if, for example, you are running the JAMS Scheduler on two different machines but are
sharing the same SQL Server machine.
Authentication
Select the type of authentication to use when creating the JAMS database. If you select SQL Server
Authentication, you must also supply a database user name and password.
Location of JAMS Database Files Page
The JAMS installation allows users to specify the location of JAMS database files.
The JAMS database is divided into three data files and a log file. These paths are on the database server
machine, which may not be the same machine where JAMS is being installed.
Primary File
The Primary data file holds most of the database tables. These tables store the definitions of JAMS objects.
Data is inserted and deleted only when JAMS objects are created or deleted.
Volatile File
The Volatile data file contains database tables that have records inserted and deleted whenever a task
executes. This could equate to hundreds or thousands of inserts/deletes per day. History Data File
The History data file includes historical database tables. A record is inserted into this file every time a task is
executed, depending upon how much history you choose to keep. If not controlled, the data file can easily
balloon in size.
Database Logs
The database log file holds transaction information that is used to recover the database in case of a failure. If
possible, you should place the database log file on a separate disk from the other database files.
Default Directories
The JAMS installtion allows users to specify the location of JAMS temporary files and log files. These paths
must be on the local machine.
7
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Temporary Files
In most cases, JAMS creates a temporary script file when a Job is executed. These temporary files are created
in the directory specified in this file. You can change this directory using the Configuration shortcut option
in the JAMS Client.
Job Log files
When a Job is executed, JAMS keeps a log of the run. You can specify the location of the log file from the Job
Definition or in the Job's Folder Definition. If the location isn't specified in one of those two places, it defaults
to the value specified in the Job Log file. You can change this directory using the Configuration shortcut option
in the JAMS Client.
Account Information
When the JAMS database is initially loaded, a folder named JAMS is created along with a number of Jobs.
There are also a number of sample Jobs installed. These Jobs cannot run unless they have an Execute As user
credential to run. You will be presented with a dialog requesting a user name and password for these Jobs.
If you don't enter a user name and password, it can be added at a later time.
NOTE: To run jobs in JAMS, an Execute As user MUST be specified.
After Installing JAMS
Here are some additional details you may need to know in order to continue using or evaluating JAMS.
Access Control
The JAMS Scheduler is secure by default. However, in order to work with all JAMS functions you must be part
of the administrators group.
The Server ACL controls who may connect to a specific server. The administrators group retains full access
with authenticated users granted limited access.
As an administrator, start the JAMS Client and select the Access Control shortcut from the JAMS Menu.
From the ACL list, choose the Server command to make a server selection. The ACL can then be adjusted to
define who should have access to JAMS.
When launching the JAMS Client, you will not initially be a part of the Administrators group. To gain
administrator access,-click on the JAMS Client icon in the Windows start menu and select the Run as
administrator command from the pop-up menu. This action will open the JAMS Client with Administrator
rights giving you permissions to adjust the ACLs for other users.
Setting an Execute As user
For security purposes, JAMS will not run Jobs without an Execute As user defined. An Execute As user may be
defined at the Job or Folder level. To allow all Jobs in the environment to run, users may set an Execute As
user on the root folder.
To add the Execute As user, navigate to the Properties tab of the Job or Folder definition. Click Add Property,
then select Execute As from the property list and click OK. With the Execute As property added, users will be
able to select a JAMS Credential from the drop-down list.
8
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
NOTE: JAMS Properties that display as greyed-out must be added to the object before their value can
be defined.
Server Definition
If you're running the JAMS Client on the same machine as the JAMS Scheduler, the JAMS Client can
automatically locate the Scheduler.
However, if the Scheduler is running on a different machine, you must include a server definition to tell the
client where to find the Scheduler. In order to add a Server definition, click on Client Settings in the upper
right corner of the JAMS Client and select Servers. to open the JAMS Servers dialog.
Note: you can have many servers defined within the JAMS Client.
Installing JAMS Integration Packs
JAMS natively supports automation using many leading business applications. “Integration Packs” for these
preferred applications are selected using a checkbox during the JAMS installation process. Once an Integration
Pack for a product is enabled, users can create, manage, deploy and monitor almost any kind of JAMS Job
using the following products:
Banner
Informatica Cloud
J.D. Edwards
MicroFocus
Microsoft Dynamics AX
NeoBatch
Netezza
Oracle E-Business Suite
PeopleSoft
SAP
Symitar
When installing JAMS, check the product Inetegration Pack you want to include. If you have already installed
JAMS without the necessary Integration Pack, re-run the JAMS installer and check the Integration Packs to
install.
NOTE: In JAMS upgrades, unchecking component boxes will uninstall those components
9
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
The JAMSDBA Utility
The JAMSDBA.exe utility is used to manage the JAMS Database and to perform other installation and
management tasks. JAMSDBA is a command line utility located in the Scheduler installation directory
(C:\Program Files\MVPSI\JAMS\Scheduler by default).
When starting the JAMSDBA, you will be presented with a JAMSDBA> prompt. You can enter the command you
want to execute or enter HELP to access online help.
You can also start JAMSDBA with a command appending the command you want to execute; for example:
JAMSDBA UPDATE/LOG
The JAMS Client
With the exception of the PowerShell Client, the JAMS Client can also be deployed with an XCOPY installation.
Simply copy the contents of the client directory to the client machine.
NOTE: The JAMS Web Client only requires a web browser and access to the configured JAMS Site.
MVP recommends using the latest release of Microsoft Edge or Google Chrome to run the JAMS Web
Client.
NOTE: The PowerShell Snap-In is installed only if PowerShell is already installed. If you install
PowerShell after installing JAMS, you must reinstall the JAMS Client to pick up the PowerShell SnapIn.
There is no configuration required for the JAMS Client.
<subkey name="Shortcut006">
<property name="Type">4</property>
<property name="Name">JAMS Jobs</property>
<property name="Title">JAMS Job Definitions</property>
<property name="Description" />
<property name="PromptForKeys">false</property>
<property name="QueryJobName">*</property>
<property name="QuerySystemName">JAMS</property>
</subkey>
<JAMSServers>
<subkey name="Server000">
<property name="Name">Jimmy</property>
<property name="Node">jimmy.yourco.com</property>
<property name="Port">773</property>
<property name="Prompt">False</property>
</subkey>
<subkey name="Server001">
<property name="Name">Joe</property>
<property name="Node">joe.yourco.com</property>
<property name="Port">773</property>
<property name="Prompt">False</property>
</subkey>
</JAMSServers>
Microsoft Messaging Queueing (MSMQ)
JAMS uses Microsoft Message Queue (MSMQ) to reliably pass messages between the JAMS Services. It does this
by creating a private queue named JAMSRequests.
MSMQ is included with Windows, but it is not installed by default. If MSMQ is not installed before installing
JAMS, the JAMS installer will install MSMQ using the default minimum settings.
10
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Note: if you want to control how MSMQ is installed it is best to install MSMQ before starting the JAMS
installation.
If you want to change the way that MSMQ is installed after installing JAMS:
1. Stop the JAMS Services.
2. Reinstall MSMQ.
3. Then restart the JAMS Services.
Configuration Settings
JAMS contains a number of configuration settings. You can change these settings using the Configuration
shortcut on the JAMS Menu.
The configuration settings are described in the table below:
11
Setting
Description
Contact
Description
Company Name
The company name to include in error reports.
Contact Name
The person in your organization responsible for JAMS deployment.
Contact Email
The responsible person’s email address.
Contact Phone
The responsible person’s phone number.
Automatically Report
Exceptions
When set to true, failures of the JAMSServices will be automatically sent to
JAMS technical support.
E-Mail
Description
Default Notify Email
Address
A comma separated list of e-mail addresses that will receive all notifications.
You can remove inherited addresses by prefixing the address with a minus (-)
sign. You can remove all inherited addresses by entering -*.
From Address
The from email address used when sending the e-mail from JAMS.
Maximum Log Size
Log files that are larger than this value will not be attached to notification emails.
SMTPServer
The name of the SMTP server used for JAMS. This must be configured to send
error reports to JAMS Support.
Configuration
Options
Description
Schedule Examples
Examples of natural language date specifications displayed in date editors.
Configuration
ACL Security
Bypass
Description
Grant Administrators
Bypass
Option to allow individuals in the Admin. group to bypass ACL security.
Grant Bypass Group
Individuals listed in a specified group to bypass ACL security.
Configuration
Encoding
Description
Default input Encoding
The default input encoding for routine jobs.
DefaultOutputEncoding
The default output encoding for routine jobs.
Configuration
Description
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
File Locations
Default Log Location*
The default location for Job log files.
Default Macro File
The default macro file used for parsing.
Temporary File
Location
The location for temporary files.
Configuration
History
Description
History Lookback
Period
The number of days in the past to query history inside a detail dialog.
History Query Limit
Maximum number of history records to return in a single query? (zero means
unlimited)
History Query Time
Limit
The maximum time to wait (in seconds) for a response to a history query.
Configuration
Monitor
Description
Keep Completed
Keep completed Jobs in the Monitor for a specified period of time.
Configuration
Workdays
Description
Work Monday
Is Monday usually a workday?
Work Tuesday
Is Tuesday usually a workday?
Work Wednesday
Is Wednesday usually a workday?
Work Thursday
Is Thursday usually a workday?
Work Friday
Is Friday usually a workday?
Work Saturday
Is Saturday usually a workday?
Work _Sunday
Is Sunday usually a workday?
Presentation
Theme
Description
Light Theme
The theme shown to end-users when they select Light Theme.
Dark Theme
The theme shown to end-users when they select the Dark Theme.
Presentation
Description
Documentation
Header
This HTML fragment is placed before all documentation content configured
within this server.
Footer
This HTML fragment is placed after all documentation content configured within
this server.
Presentation E- Description
Mail
12
E-Mail Header
This HTML fragment is placed before all e-mail content configured within this
server.
E-Mail Footer
This HTML fragment is placed after all e-mail content configured within this
server.
Integrations
Paladin
Description
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Certificate
The name of the x.509 certificate used to authenticate with Paladin.
Paladin User
The Paladin User
Ask Job
A Job that is submitted when we need to ask Paladin for a response.
Severity
Only log files that are smaller than this maximum will be uploaded to Paladin.
Paladin URL
The URL for the Paladin service
*The DefaultLogLocation is a .NET format string used to construct the full file specification for a Job's log file.
The data values passed in the formatting operation are:
0. Directory specification
1. Filename
2. File Extension
3. Folder Name
4. Job or Sequence Name
5. Run occurrence number
6. JAMS Entry Number
7. Timestamp date & time
8. Timestamp year
9. Timestamp month
10. Timestamp day
11. Timestamp hour
12, Timestamp minute
13. Timestamp second
14. Timestamp millisecond
Working with JAMS Services
JAMS Scheduler installation includes four Windows Services:
JAMS Scheduler Services
JAMS Server Service
JAMS Executor Service
JAMS Agent Service
Note: Installing JAMS Agents on Windows also includes the JAMS Agent Windows Service.
JAMS Scheduler Service
The JAMS Scheduler Service is responsible for automatically scheduling jobs, firing triggers, and checking
dependencies, etc. The JAMS Scheduler must include access to the JAMS Database or the service will fail.
However, JAMS is designed to be resilient. Job execution is handled by the JAMS Executor service, so if the
JAMS Scheduler service fails, no job execution information is lost.
JAMS Server Service
The JAMS Server provides middle-tier services to all JAMS Client components (GUI, Powershell, .NET Class
Library, and Web services). While the JAMS Server service is not involved in the execution of Jobs, many jobs
can use the JAMS PowerShell client, which does utilize this service.
JAMS Executor and Agent Services
The JAMS Executor is responsible for executing and monitoring Jobs. This service does not access the JAMS
Database.
13
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
The JAMS Agent service is an extension of the JAMS Executor service. When the JAMS Executor needs to
execute a Job on a different machine, it does so using the JAMS Agent running on that machine.
Troubleshooting JAMS Services
Each JAMS Service generates a ServiceName.log (e.g. JAMSScheduler.log) in the installation directory. These
logs are reset every Sunday with the previous weeks log files renamed to ServiceNameArchive.log (e.g.
JAMSSchedulerArchive.log).
Note: JAMS Services writes any serious errors to the Windows Event log. When troubleshooting
JAMS, always check the event log and the .log files.
If you suspect there are problems with JAMS, shutting down one of the three services may resolve your issues.
The list below provides some guidelines from the least to most disruptive option.
Restart the JAMS Scheduler
While the JAMS Scheduler Service does the most work, restarting it is the least disruptive. Restarting the JAMS
Scheduler Service does not cause any Jobs failures and all job completion information remains intact. While
the JAMS Scheduler service is stopped, no new Jobs can execute.
Stop the JAMS Server Service
The JAMS Server service may be stopped without losing any job execution information. The JAMS Client will
not function while the JAMS Server service is shut down.
Shut down the JAMS Executor Service
Stopping the JAMS Executor service should be a last resort, as it will not typically resolve JAMS issues. This
service executes and monitors Jobs. When this service is halted, completion information for any executing
Jobs will be lost and some executing Jobs may fail. The JAMS Executor service does not access the JAMS
database, so stopping this service won’t be necessary during SQL service maintenance.
Service Accounts
By default, JAMS services are set to run under the LocalSystem account, although this can be modified to run
on a Windows Domain based account.
In general, it is recommended that you leave the JAMS Executor and JAMS Agent services running under
LocalSystem. These services require access to the database or network and require the privileges associated
with the LocalSystem account.
Use the Service Control application to change the account for the JAMS Scheduler and JAMS Server services in
order to control network and database access.
When modifying the account, you may 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
JAMS Database
You will need to modify the security on the MSMQ JAMSRequests private queue in order 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 policies 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, than
add the user to the group and make the following changes in the Common.config file located at: Program
Files\MVPSI\JAMS\Scheduler<directory>
14
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
<add key=AuthorizedGroup" value="domain\YourGroup"/>
Managing the JAMS Database
The JAMS Database provides critical features to the JAMS Scheduler and stores JAMS definitions. The following
section contains information on managing the JAMS SQL database back end.
Manually Creating the JAMS Database
In most instances, the JAMS Database is created with the JAMS Scheduler during the installation process.
However, in some cases, when installing the JAMS Scheduler you may prefer not to create the JAMS Database.
NOTE: The JAMS Database should always be created using the JAMS Installer or JAMS DBA utility.
Manually creating the JAMS Database outside of these tools will cause various issues in JAMS.
JAMS looks for the SQL Server connection string in the Common.config file. This file is created during the
database creation process, so if it is missing the JAMS Database does not exist. Likewise, if you want to
recreate the database, simply delete or rename the file.
To create a JAMS database after the JAMS Scheduler has been installed, open a command window and execute
the following commands:
CD "C:\Program Files\MVPSI\JAMS\Scheduler" JAMSDBA INSTALL
During the installation process you will be required to provide SQL authentication information and use an
account that has the ability to create a new database. To review these changes to the database, go to:
C:\ProgramFiles\MVSPI\JAMS\Scheduler\JAMS_DB_ERRORS.sql file
Security
JAMS supports either Windows Integrated Authentication or SQL Server Authentication. This can be modified
after installation by changing the connection string found in the Common.config file. The default installation
requires the JAMS Services to be running under the LocalSystem account. To facilitate this the installation
executes the following SQL commands:
exec sp_grantlogin @loginame='BUILTIN\Administrators' exec sp_grantdbaccess
@loginame='BUILTIN\Administrators', @name_in_db='JAMSService' exec
sp_addrolemember @rolename='JAMSApp', @membername='JAMSService'
The net effect of using Windows Integrated authentication is that anyone in the administrators group can map
the JAMSService Database user and become a part of the JAMSApp Database role.
Note: You can modify the security to fit your needs, but the JAMS Services must be included in the
JAMSApp Database role.
Backing up the JAMS Database
It is critical to back up the JAMS Database. Since the JAMS Database is a standard SQL Server database, simply
add it to your existing SQL Server backup procedures.
Choosing the Recovery Model
Before implementing a backup plan, you will need to choose which recovery model to use with the JAMS
database.
The default installation uses the Simple Recovery Model. The other option is the Full Recovery Model. The
main difference between the two is in the amount of journaling performed by the database.
Simple Recovery Model
The Simple Recovery Model is the easiest to use. You periodically backup the JAMS database only, not the
journal file. The downside to this model is a lack of recovery options. If the JAMS Database becomes corrupted
you can recover it from a backup but, all database changes since the last backup will be lost. This includes job
15
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
execution history, so Job dependencies may not work as expected.
Full Recovery Model
This model contain more robust recovery features. However, the disadvantage of this model is that you must
manage the journal file for the JAMS Database. Each time a change is made to the JAMS Database it is also
written to the journal file.
For example, if a hardware failure occurs or you have otherwise corrupted the JAMS Database, you can restore
a backup and then recover it using the journal files up to a specific point in time.
Restoring the JAMS Database from a Backup
Restoring a JAMS Database from a backup requires a standard SQL Server restore operation, but there are
some details to consider before attempting the restoration process.
The JAMS Database includes the current schedule. Often, you may not want the current schedule to be
restored. For example, if the database was backed up on Monday and you restore it on Friday, you probably
don’t want to start running Monday’s Jobs along with the rest of the week’s processing.
CD C:\Program Files\MVPSI\JAMS\Scheduler" JAMSDBA RESET SCHEDULE
CD C:\Program Files\MVPSI\JAMS\Scheduler" JAMSDBA UPDATE/LOG
Moving the JAMS SQL Database
To relocate the SQL database used by JAMS:
1. Perform a normal SQL database backup and restore it to the target SQL server.
2. Edit the connection string property of the Common.config file found in: C:\Program
Files\MVPSI\JAMS\Scheduler.
3. Restart the JAMS Scheduler service from the Windows control panel services applet.
4. Run JAMS_DB_ERRORS.sql on the new server. This script is found in the JAMS Scheduler directory.
Note: The process for moving a SQL/JAMS database does not require reinstalling JAMS.
The common.config file contains the connection string used by JAMS services to link to the SQL database.
Below are two examples of connection strings; one for Windows Authentication models and another for SQL
Authentication models.
Connection Strings for Windows Authentication
<?xml version="1.0" encoding="utf-8" ?>
<appSettings>
<add key="ConnectionString" value="Server=SQLA\INST1; Failover Partner=SQLB\INST1;
Database=JAMS; Application
Name=JAMS; Connect Timeout=600; Integrated Security=SSPI"/>
</appSettings>
Connection Strings for SQL Account Authentication
<?xml version="1.0" encoding="utf-8" ?>
<appSettings>
<add key="ConnectionString" value="Server=SQLA\INST1; Failover Partner=SQLB\INST1;
Database=JAMS; Application
Name=JAMS; Connect
Timeout=600;Trusted_Connection=False;uid=YOURSQLACCOUNT;pwd=YOURPASSWORD" />
</appSettings>
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.
16
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
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 this 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.
For additional information on protecting/restoring a JAMS Server as well as working in failover environments,
go to the complete topic: JAMS Security: Managing Encryption Keys (on-line documentation).
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 the JAMS configuration settings.
2. Set your default directory to the JAMS Scheduler installation directory. The default is:
C:\Program Files\MVPSI\JAMS\Scheduler
3.
4.
5.
6.
7.
Execute JAMSDBA.EXE to open a JAMSDBA> prompt.
Enter GENERATE KEY and press Return.
Enter EXPORT KEY YourFileName.txt and press Return.
Enter EXIT and press Return.
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 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.
5.
6.
7.
8.
9.
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.
Enter EXPORT KEY YourFileName.txt and press Return.
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
17
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
10.
11.
12.
13.
Copy the exported text file (YourFileName.txt) from your safe location to the current directory.
Execute JAMSDBA.EXE to open a JAMSDBA> prompt.
Enter IMPORT KEY/NOENCRYPT and press Return.
Enter EXIT and press Return
High Availability
It is always beneficial when a secondary Failover environment can be configured as part of your JAMS
installation. The Failover provides a completely redundant instance of JAMS residing on a secondary server
that relies on a heartbeat connection between the two. By default, this heartbeat is set to a 60 second
interval. In the event the Failover does not get a response from the Primary sever within 3 consecutive beats,
the Failover will “takeover” as the Primary scheduler in order to maintain the integrity of the scheduler
system.
JAMS Failover Architecture
The JAMS Failover Architecture should consist of at least three servers:
JAMS Primary Scheduler Server
JAMS Failover Scheduler Server
JAMS Agent Server(s), where Jobs are run
In the event of a failure, the Failover Scheduler will take over for the Primary Scheduler, ensuring the
schedule of Jobs remains intact. If Jobs are executing locally on the Primary Scheduler Server, a failure would
result in the failure of all Jobs executing on the Scheduler server. Running Jobs on JAMS Agent Server(s)
insulates those Jobs from Primary Scheduler Server failure. To further insulate the executing JAMS Jobs from
server failure, the JAMS Agent can be configured in a cluster.
Installing and Configuring the JAMS Failover
The JAMS Failover Engine provides automatic failover for the JAMS Scheduler without using a Microsoft Cluster.
Note that the JAMS Failover should NOT be configured in a cluster.
Follow the instructions below to install a JAMS Failover Server:
1. Begin by stepping through the normal installation of the JAMS Primary Engine.
2. For redundancy of the JAMS Database, you can configure AlwaysOn Availability (which replaced
Database Mirroring starting with SQL Server 2012), after you complete these steps.
3. At this point, make sure to stop the JAMS Scheduler service on the Primary Engine machine.
4. Next, begin by installing the JAMS Scheduler on the second node. When prompted for the database
server, specify the same SQL Server, Instance and Database Name as you did with the Primary JAMS
Engine. After choosing Next, a dialog will appear stating “Database already exists”. Be sure to select
“Use Database.”
5. At this point, make sure to stop the JAMS Scheduler service on the secondary server, just as you did in
the previous step with the Primary Server.
6. Create/Edit a Failover.config file (a sample is displayed below) in the \MVPSI\JAMS\Scheduler
directory on the Primary server - by default the path is: C:\Program Files\MVPSI\JAMS\Scheduler\
7. Copy the completed Failover.config from the Primary Engine to the Secondary Failover server. Make
sure the Failover.config is identical on both servers.
8. Next, start the JAMS Scheduler server on both the Primary and Failover machines.
9. Lastly, if the Primary and Failover share a database, it will be necessary to add a user to the JAMS
database to allow the Secondary engine to connect. This can be done by running the following SQL
statements on the JAMS database.
Note: Make sure to replace the login name with your machine name as shown below:
exec sp_grantlogin @loginame='YourDomain\YourMachineName$'
exec sp_grantdbaccess @loginame='YourDomain\YourMachineName$',
@name_in_db='JAMSMachine2'
exec sp_addrolemember @rolename='JAMSApp', @membername='JAMSMachine2'
A Sample Failover config
18
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
<FailoverConfig>
<Primary>Server1</Primary>
<Secondary>Server2</Secondary>
<Port>4773</Port>
<Interval>60</Interval>
</FailoverConfig>
Common Log Output Location
If you choose to have a common log output location on network share for both Primary and Secondary
schedulers, please review the following article.
Setting a common log output location for JAMS in a Failover Environment
Clustering
JAMS Supports Windows Clustering. There are many ways to configure a Windows Cluster and your options can
vary depending on whether you are configuring the JAMS Scheduler or the JAMS Agent.
JAMS Scheduler
The JAMS Scheduler can be configured in an active/passive mode. The JAMS Services should be included in the
same cluster resource group to enable failover as a unit.
JAMS Agent using an Active/Passive Configuration
The JAMS Agent can be configured using an “active/active” or “active/passive mode”. The key is the IP
address cluster resource. When directing Jobs or Queues to a clustered agent you can specify a DNS name that
resolves to an IP address that fails over in a cluster to execute a Job on whichever node in the cluster is
currently serving that IP address. This is considered an active/passive configuration.
JAMS Agent using an Active/Active Configuration
You could also specify a DNS name that resolves to an IP address that does not failover. In this way, you are
directing the Job to a specific machine in the cluster. This is considered an active/active configuration.
In addition, you can create multiple IP address resources that normally runs on different nodes in the cluster,
but fails over if a machine stops. This is also considered to be an active/active configuration.
SQL Server Mirroring
JAMS supports database mirroring. Please consult the SQL Server documentation for information on configuring
and creating a mirrored database.
Once the JAMS Database has been successfully created, you should edit the connection string located in the
Common.config file to add the "Failover Partner= OtherServer." This isn't strictly required, but if JAMS
starts and the primary database server isn't available, JAMS won't know where the secondary server is located.
Disaster Recovery Configuration
Recommended DR Model
The JAMS Server and Agents should have DR equivalents, named differently than the production servers. This
will ensure the boxes are not seen on the network with the same name as their Production equivalents.
19
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
With the JAMS DR architecture set up as outlined above, the DR Process will consist of:
Restoring the Production JAMS database to the DR Server and running any necessary database SQL
scripts
Replacing references to the JAMS Production nodes with DR equivalents
Disaster Recovery Process
Before beginning the DR Process
On the DR Server, ensure the following are true:
The JAMS Services are disabled (Includes the JAMS Executor, JAMS Scheduler, and JAMS Server)
Host files on the JAMS Server and Agent Nodes are pointing to the DR Servers
Common.config is pointing to the local SQL Server (located at C:\Program
Files\MVPSI\JAMS\Scheduler\Common.config by default)
20
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
1. Restore the SQL Database
First, create a backup of the JAMS Production Database, then restore the JAMS Production Database in DR.
2. Truncate the Failover Table
Truncate the failover table on the DR Server.
NOTE: The failover table details the GUID of the JAMS server that is running against this database.
This GUID should match the Installed GUID found in the Server Configuration file (located at
C:\Program Files\MVPSI\JAMS\Scheduler\Server.config by default).
3. Backup the current Monitor View state
On the JAMS DR Server:
Start the "JAMS Server" Service
Within the JAMS DR Client, go to the Monitor View and take screenshots of the current Jobs within
the Monitor View
Stop the "JAMS Server" service
NOTE: The Failover table on the DR Server must be truncated before the JAMS Server is started. The
JAMS Server will then automatically add the required entries to the table.
4. Update the JAMS Server Agents/Nodes to point to the DR Servers
The JAMS Nodes must be updated to point to the DR Servers instead of Production Servers. In this example, all
Sequences and Jobs within JAMS refer to a JAMS Queue, rather than point to an Agent Node directly. With this
Queue configuration, re-directing the Nodes will be a simple case of updating the Production Queues to point
to the DR Nodes.
JAMS will not allow existing nodes to be deleted if any running or pending Jobs that point to those
Queues/Nodes are within the Schedule/Monitor view. Therefore, in order to allow the nodes to be updated, all
Jobs will need to be cleared from the Monitor View using the Reset Schedule process detailed below.
5. Reset the JAMS Schedule
On the JAMS DR Server
Ensure the JAMS Scheduler Service is Stopped
The JAMS Scheduler service should be stopped so that the Reset Schedule command (explained later)
does not re-schedule Jobs before the queue nodes have been updated.
Run the JAMSDBA executable as an Administrator
Type RESET SCHEDULE and hit Enter
Note that when JAMS starts up against a restored database, it will check to see whether the Schedule is over
48 hours old. If it is, it will automatically rebuild the schedule from the current time, otherwise it will
continue with the current schedule as-is. As the JAMS Database will likely be less than 48 hours old on DR, the
'Reset Schedule" process will have to be manually run using the JAMS DBA utility.
Once the Scheduler Service starts, the Schedule will be built based on the current time. In order to rebuild the
Schedule against a different time, the /Restart switch can be specified.
6. Enable Access to the JAMS Client
Start the JAMS Server Service on the DR Server. In order to be able to successfully connect to the Server from
a JAMS Client, the JAMS Server service will need to be enabled and started. The status of the JAMS Server can
be seen at the bottom left hand corner of the JAMS client.
7. Update the JAMS Server Nodes
Ensure the JAMS Client is opening against the DR Server and that all Jobs have been cleared from the
Monitor View
21
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Run the "Update Queues" PowerShell script. This will update JAMS Queues to point to DR Nodes
NOTE: As the JAMS Scheduler will still be disabled, the Update Queues script must be run outside of
JAMS
Ensure the Queues have been successfully re-pointed in the front end by viewing the Agents and
Queue Nodes
8. Start the JAMS Services
On the DR Server, manually start the JAMS Scheduler Service and the JAMS Executor Service. Starting the JAMS
Scheduler will result in the Schedule being rebuilt within the Monitor view, as defined by the JAMS DBA utility.
NOTE: Sequences or Jobs that were scheduled before DR that were still pending when production
went offline may need manual attention.
9. Run Test Processes
On the DR Server, run a test process in JAMS to validate that the Scheduler is working as expected.
Licensing DR
The JAMS DR Server requires a unique JAMS License.
Agents will be consumed as follows:
The JAMS License is on the JAMS Server and it will detail the number of available Agent licenses. When the
JAMS Server is restarted, the number of allocated Agent licenses is set to zero. As Jobs consume Agents, the
allocated License count is incremented.
JAMS TCP/IP Ports
JAMS uses the following TCP/IP Ports for both outgoing and incoming connections.
JAMSAgent.exe: The JAMS Agent listens on port 77 for requests to execute Jobs from other machines running
JAMS.
JAMSServer.exe: The JAMS Server listens on port 773 for connection requests from JAMS Clients.
JAMSScheduler.exe: The JAMS Scheduler listens on port 2773 for connections from the JAMS Server and JAMS
Debugger. This is usually confined to the local machine.
JAMSExecutor.exe: The JAMS Executor listens on port 3773 for connections from the JAMS Scheduler and
JAMS Debugger. This is usually confined to the local machine.
JAMSScheduler.exe: The JAMS Scheduler listens on port 4773 for connections from the Failover JAMS
Scheduler. This is configured in the Failover.config file.
Common Configuration: If no port is specified in the common.config file in C:\Program
Files\MVPSI\JAMS\Scheduler (default location), the default SQL port of 1433 is used.
Web Interface HTTP: The JAMS Web Interface uses port 80 by default for HTTP.
Web Interface HTTPS: The JAMS Web Interface uses port 443 by default for HTTPS.
22
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Installing and Deploying Specific JAMS Agents
23
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
JAMS Agent for System i
The JAMS Agent for System i is designed to support the IBM System i operating system (aka i5/OS and OS/400).
JAMS connects to the IBM System iServer using TCP/IP protocols.
Deploying the JAMS Agent for System i
The JAMS Agent for IBM System i is installed along with the JAMS Scheduler, but must be pushed out
to the agent machines. Specifically, deployment is controlled from the Agents view in the JAMS
Client.
Before attempting to deploy, make sure you have provided each JAMS user the appropriate System i
access along with the privileges required to deploy the agent.
NOTE: If the library JAMSLIB is present in both the system library list and user library list,
remove JAMSLIB from the system library list.
Upgrading the JAMS Agent for System i
Installing an updated version of JAMS may already include the JAMS Agent. To deploy the update, select one or
more agents from the Agent Definitions view, right-click, and select Deploy.
Troubleshooting the JAMS Agent for System i Deployment
The most common issues with the JAMS Agent deployment are:
The user selected for the deployment job does not have sufficient privileges on the target machine.
FTP settings are disabled or blocked.
To gain a more detailed view of the deployment, review the Job Log of the DeploySystemi in Job History.
If the JAMS DeploySeriesi job does not work because of access restrictions (e.g., the FTP is blocked), you can
manually deploy the agent by following steps described below:
1.
2.
3.
4.
Create a JAMS user profile: CRTUSRPRF USRPRF(JAMS) PASSWORD(*NONE) SPCAUT(*JOBCTL)
Create a library: CRTLIB LIB(JAMSLIB)
Create a save file: CRTSAVF FILE(JAMSLIB/JAMSSAVF)
Copy the JAMSSAVF.SAVF from the JAMS Scheduler to the AS/400 server (JAMSSAVF.SAVF is located at
C:\Program Files\MVPSI\JAMS\Scheduler\Agents\IBMSeriesi by default)
5. Restore the objects: RSTOBJ OBJ(*ALL) SAVLIB(JAMSLIB) DEV(*SAVF) SAVF(JAMSLIB/JAMSSAVF)
MBROPT(*ALL) RSTLIB(JAMSLIB)
6. Start the JAMS subsystem: STRSBS SBSD(JAMSLIB/JAMS)
24
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
JAMS Agent for Windows
The JAMS Agent for Windows includes background services that execute JAMS Jobs under the direction of a JAMS
Scheduler on a different machine.
Manually Installing the JAMS Agent for Windows
1. To manually install the JAMS Windows agent, go to the JAMS Primary Engine (Scheduler) machine and
navigate to the following path: Program Files\MVPSI\JAMS\Scheduler\Agents\Windows
2. Once there, obtain either the SetupAgent.msi or SetupAgentx64.msi file and copy it to the remote
Agent machine.
3. From the remote agent machine, double-click to run the installer and follow the prompts. When the
installation is complete you will see a Windows service called 'JAMS Agent' running.
4. The installer package set up an agent service on the machine called 'JAMS Agent', and a directory is
expanded containing the executable files in C:\program files\MVPSI\JAMS\Agent by default.
5. The JAMS Agent service listens on port 77 in order to communicate with the JAMS Scheduler.
6. The agent must then be defined in the JAMS Client.
Select the Agents shortcut and click the Add button on the Ribbon bar to open the Agent Definition
Wizard.
Enter the appropriate information to define the agent.
Note: the agent deployment is not necessary, leave the Deploy JAMS Agent box unchecked, as
you have already performed a manual install of the agent.
7. It is recommended that the JAMS Agent Service run as 'Local System'.
Push Deploy the Windows Agent using Local User Accounts
When deploying a remote JAMS Agent to a Windows server, the standard practice is to use a domain account user
with Administrator privileges on both the JAMS Primary Engine (Scheduler) and the remote JAMS Agent machine.
However, if you don’t have an environment that uses domain accounts, there are two alternative options for
setting up the remote JAMS Agent software for a Windows server:
Manually install the JAMS Agent for Windows (see the preceding section) or . . .
Modify the registry setting changes on the Agent Machine. In order to allow the push deployment of the
Windows JAMS Agent to a remote server when not using domain user accounts, make sure that the JAMS
Primary Engine (Scheduler) and remote Agent server utilize the same administration level user account
and password. Once that step is complete, perform the following registry edit on the remote agent
machine:
CAUTION: Improperly modifying the registry can harm your system. It is always recommended
that you back up your registry prior to making any changes.
1. Browse to the following folder:
HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\system\
2.
3.
4.
5.
6.
Right-click a blank area in the right pane.
Click New.
Click DWORD Value and Name it LocalAccountTokenFilterPolicy.
Double-click the item you just created and Type “1” into the Value Data box and click the OK button.
Restart your computer.
You should now be able to push deploy the JAMS Agent to the remote machine.
25
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
JAMS AgentX
JAMS AgentX is designed to support non-Windows operating systems. JAMS uses SSH in order to connect to a
machine and then starts JAMS AgentX to handle executing Jobs.
Deploying JAMS AgentX
JAMS AgentX is installed along with the JAMS Scheduler, but must be pushed out to the Agent machines.
Specifically, deployment is controlled from the Agents view in the JAMS Client.
1. Begin the deployment by selecting the Add button on the Agent Definitions view to access the Add Agent
Definition dialog.
2. Continue working through the wizard by entering the appropriate information and selecting the Next
button.
Note: To run a Job successfully, you must first deploy JAMS AgentX and run the Job on this
agent.
Deploying the AgentX Upgrade after Upgrading JAMS
Installing an updated version of JAMS may also include an updated version of JAMS AgentX. In order to deploy the
update, select one or more Agents from the Agent Definitions view, right-click, and select Deploy.
JAMS AgentX Data
JAMS AgentX uses a simple database to track executing Jobs. In addition, it also maintains Job scripts and log
files while executing. These scripts and log files are kept in a directory identified by the JAMS_HOME
environment variable. If JAMS_HOME is undefined, the default is a directory named .jams found in the user's
home directory.
You can change the value of JAMS_HOME by modifying the command in the Execution Method. By default, the
command is JAMS AgentX. This command can be modified to:
env 'JAMS_HOME=/usr/data/jams' JAMSAgentX to define JAMS_HOME before starting JAMS AgentX.
Troubleshooting the JAMS AgentX Deployment
The most common issues with the JAMS AgentX deployment are:
The user selected for the deployment job does not have sufficient privileges on the target machine.
There are Jobs executing using the current version of JAMS AgentX.
To get a better picture of the deployment, review the DeployAgentX job log from Job History.
26
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Installing and Configuring JAMS add-ons
27
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Dynamics AX add-on: Configuring and Job Setup
28
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Oracle EBS add-on: Configuring and Automating
29
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Automating Oracle EBS Jobs
JAMS natively supports automation using many leading business applications, including the Oracle E-Business Suite. Integration Packs for this and other preferred applications are selected during the JAMS installation
process. Once the Oracle E-Business Suite integration is enabled, users can create, manage, deploy and monitor every kind of Oracle EBS batch process job, regardless of where it resides.
In This Topic:
Installing the Oracle EBS Integration Pack
Configuring Oracle EBS Connection Strings
Creating Oracle EBS Jobs
Creating OracleEBSConcurrent Jobs
Creating OracleEBSJobSsh Jobs
Creating OracleEBSRequestSet Jobs
Installing the Oracle E-Business Suite Integration Pack
To work with Oracle EBS in JAMS, users must install the Oracle E-Business Suite Integration Pack on the JAMS Scheduler Server and deploy an Agent to the Oracle Server. For more information on deploying Agents,
see Agent D ('JAMS Agentd for Linux/Unix' in the on-line documentation) and Agent X sections.
On the JAMS Scheduler Server, run the JAMS Installer.
On the Feature Selection step, ensure the JAMS Integration Pack for Oracle E-Business Suite component is checked. Do not un-check any components unless those components should be uninstalled.
Finish the installation.
NOTE: Un Checking components in the Feature Selection step will uninstall those components.
Configuring Oracle EBS Connection Strings
The Oracle EBS Connection String allows users to connect to Oracle from within JAMS. This connection string must be properly configured to run Oracle Jobs in JAMS. The Oracle EBS connection should be configured
on each Oracle EBS Execution Method in JAMS.
Users may override the connection string configured on an Execution Method by configuring a Connection String Parameter at the Folder level or Job level.
NOTE: If the User on an Oracle EBS Job has OS Authentication permissions to Oracle, then JAMS will pass the credentials from the User into the defined connection string during execution, and an
Oracle user is not needed in the Job's source. If the User on the Job does not have OS Authentication, an Oracle user must be defined in the dropdown list that has permissions to the oracle Database.
Configure the Oracle EBS Connection on the Execution Method
1.
2.
3.
4.
5.
Run the JAMS Client as an administrator.
Select the Execution Methods shortcut from the Menu.
Double click on the given Oracle EBS Execution Method to open the Execution Method Properties dialog.
On the Parameters tab, select the OEBSConnectionString Parameter, then click Properties to open the Parameter Properties dialog.
Set the Default Value to the following, with "Host=Orchid64" and "SERVICE_NAME=MVP" adjusted to values that match the given environment.
User Id = {0}; Password = {1}; Data Source = (DESCRIPTION = (ADDRESS = (PROTOCOL = TCP)(HOST = Orchid64)(PORT = 1521))(CONNECT_DATA = (SERVICE_NAME = MVP)));
6. Save and Close the Parameter Properties dialog.
7. Save and Close the Execution Method dialog.
Configure the Oracle EBS Connection on the Folder level
A Connection String should ONLY be defined at the Folder level if users wish to override the Execution Method level Connection Strings. Note that the Folder level Connection String will apply to all Oracle EBS Jobs
within that folder.
1.
2.
3.
4.
5.
Right click on the desired Folder and select Properties from the drop-down list to open the Folder Properties dialog.
Select the Parameters tab, and check for a Parameter named OEBSConnectionString. If this Parameter does not yet exist on the folder, click the Add button.
In the Add a Parameter dialog, name the Parameter OEBSConnectionString.
Ensure the Data Type is set to Text.
Set the Default Value to the following, with "Host=Orchid64" and "SERVICE_NAME=MVP" adjusted to values that match the given environment.
User Id = {0}; Password = {1}; Data Source = (DESCRIPTION = (ADDRESS = (PROTOCOL = TCP)(HOST = Orchid64)(PORT = 1521))(CONNECT_DATA = (SERVICE_NAME = MVP)));
6. Save and Close the Folder Properties.
Configure the Oracle EBS Connection on the Job level
A Connection String Parameter should ONLY be defined at the Job level if users wish to override Execution Method or Folder level Connection Strings.
1.
2.
3.
4.
5.
Right click on a Job and select Properties from the drop-down list to open the Job Properties dialog.
Select the Parameters tab, and check for a Parameter named OEBSConnectionString. If this Parameter does not yet exist on the Job, click the Add button.
In the Add a Parameter wizard, name the Parameter OEBSConnectionString.
Ensure the Data Type is set to Text.
On the Parameter Value step, set the Default Value to the following, with "Host=Orchid64" and "SERVICE_NAME=MVP" adjusted to values that match the given environment.
User Id = {0}; Password = {1}; Data Source = (DESCRIPTION = (ADDRESS = (PROTOCOL = TCP)(HOST = Orchid64)(PORT = 1521))(CONNECT_DATA = (SERVICE_NAME = MVP)));
6. Save and Close the Job Properties.
Creating Oracle EBS Jobs in JAMS
JAMS offers OracleEBSConcurrent, OracleEBSJobSsh, and OracleEBSRequestSet Execution Methods to run Oracle EBS Jobs.
The OracleEBSConcurrent Execution Method gives users a series of automatically populated drop-down fields to run Concurrent Jobs, including the ability to view and set each parameter on the Concurrent Job
from within JAMS.
The OracleEBSJobSsh Execution Method gives users a fill in the blank style form to run Concurrent Jobs from within JAMS. The advantage of the fill in the blank form over the OracleEBSConcurrent Execution
Method is that field values in the Job Source may be defined as JAMS Parameters. By using Parameters in the Job Source, users can create a self-service Oracle Job from within JAMS.
30
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
The OracleEBSRequestSet Execution Method gives users a series of automatically populated drop-down fields to run Request Sets, including the ability to see each Concurrent Job (and modify the Concurrent Job's
Parameters) within the Request Set.
Creating OracleEBSConcurrent Jobs in JAMS
1. Select the desired folder for the OEBSConcurrent Job, then ensure the Job Definitions tab is selected.
2. Click the Add button from the Control Bar to open the Add a New JAMS Job Definition dialog.
3. In the dialog, give the new Job a Name, Description (optional), and Execution Method.
In this case, select OracleEBSConcurrent to create an Oracle EBS Concurrent Job.
4. By default, the full Job Definition dialog will open when the Job is initially saved. Click OK.
5. The Job Definition dialog will open.
6. Define Elements, Parameters, Security, Properties, and Documentation as desired.
7. On the Source. tab, set the Oracle User. This user should have access to the Oracle Database.
8. Select the Application User from the automatically populated drop-down list.
9. Select the Responsibility group from the automatically populated drop-down list.
10. Select the relevant Application from the automatically populated drop-down list.
11. Select the Concurrent Program to be run from the automatically populated drop-down list.
12. The Parameters section of the Source will automatically populate with the Concurrent Program's available Parameters.
13. Set Source Parameters as desired, ensuring that required Parameters have values.
14. Click Save and Close to finish editing the Job definition.
Creating OracleEBSJobSsh Jobs in JAMS
OracleEBSJobSsh Jobs in JAMS provide a fill-in-the-blank style form for users to configure their Concurrent Oracle Jobs in JAMS. The benefit of the fill-in-the-blank form over the automatically populated dropdown list of the OracleEBSConcurrent Execution Method is the parametrization of field values. By using Parameters in the Job Source, users can create a self-service Oracle Job from within JAMS.
Create an OracleEBSJobSsh Job in JAMS:
1. Select the desired folder for the OracleEBSJobSsh Job, then ensure the Job Definitions tab is selected.
2. Click the Add button from the Control Bar to open the Add a New JAMS Job Definition dialog.
3. In the dialog, give the new Job a Name, Description (optional), and Execution Method.
In this case, select OracleEBSJobSsh to create an Oracle EBS Ssh Job.
4. By default, the full Job Definition dialog will open when the Job is initially saved. Click OK.
5. The Job Definition dialog will open.
6. Define Elements, Parameters, Security, Properties, and Documentation as desired.
7. In the Source, specify the information on the Job to run in Oracle EBS. See the available fields and their Oracle counterparts below.
JAMS
Oracle
Job Name
Program Shortname
Application Short Name
Program Application Shortname
Responsibility Short name
Responsibility App Shortname
Responsibility Name
Responsibility Name
Username
Username
Parameters
Parameters
Note that Parameters in the Parameters field are space delimited.
8. Save and Close the Job definition.
Creating OracleEBSRequestSet Jobs in JAMS
1. Select the desired folder for the OracleEBSRequestSet Job, then ensure the Job Definitions tab is selected.
2. Click the Add button from the Control Bar to open the Add a New JAMS Job Definition dialog.
3. In the dialog, give the new Job a Name, Description (optional), and Execution Method.
In this case, select OracleEBSRequestSet to create an Oracle EBS Request Set Job.
4. By default, the full Job Definition dialog will open when the Job is initially saved. Click OK.
5. The Job Definition dialog will open.
6. Define Elements, Parameters, Security, Properties, and Documentation as desired.
7. On the Source tab, set the Oracle User. This user should have access to the Oracle Database.
8. Select the Application User from the automatically populated drop-down list.
9. Select the Responsibility group from the automatically populated drop-down list.
10. Select the relevant Application from the automatically populated drop-down list.
11. Select the Request Set to be run from the automatically populated drop-down list.
12. The Request Set Jobs section will populate with a list of the Concurrent Programs in the Request Set.
13. Select a Concurrent Program and then click the Parameters button to open the parameters of a Concurrent Program within the Request Set.
14. In the Parameters dialog, set Parameter values as desired, then click OK.
15. Click Save and Close to finish editing the Job.
31
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
PeopleSoft add-on: Installing and Configuring
32
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
PeopleSoft Integration Pack
The JAMS Integration Pack for PeopleSoft allows users to initiate PeopleSoft processes and take advantage of
PeopleSoft’s monitoring and report distribution capabilities using the sophisticated and reliable JAMS scheduling
software.
The JAMS Integration Pack acts as an intermediary between JAMS and PeopleSoft. When the adapter runs it
initiates communication with the PeopleSoft Process Scheduler and instructs PeopleSoft to execute the
PeopleSoft jobs as configured in JAMS. The process can then be monitored, canceled and restarted in either
PeopleSoft or JAMS.
Supported Process Types
The JAMS Integration Pack for PeopleSoft can initiate the following process types delivered by PeopleSoft:
Application Engine
COBOL SQL
CRW Online
Crystal
Crystal Check
nVision
nVision-Report
nVision-ReportBook
PS Job
SQR Process
SQR Report
XML Publisher
In addition, the JAMS Integration Pack for PeopleSoft can initiate custom process types that you have created.
For best results, these custom processes must be “API Aware".
For more information, please refer to the PeopleSoft Process Scheduler PeopleBook under “Using Process Request
APIs”.
Supported PeopleTools Versions
The JAMS Integration Pack for PeopleSoft works with PeopleTools versions 8.48 or newer.
To request certification for additional PeopleTools releases, please contact your JAMS customer service
representative.
Supported Operating Systems
The JAMS Integration Pack for PeopleSoft works with any Unix/Linux or Windows operating system that is
supported by Oracle.
Note: the Windows operating system must run Microsoft PowerShell.
JAMS Integration Overview and Process Flow
The JAMS Integration Pack for PeopleSoft consists of two parts:
1. The JAMS components that capture information about any PeopleSoft processes that you want to schedule
and . . .
2. An Application Engine process called MVP_SCHDPRCS that schedules the jobs through the PeopleSoft
Process Scheduler API, monitors and cancels the job when necessary.
The following diagram illustrates the detailed process flow of the JAMS Integration for PeopleSoft.
33
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Installing the JAMS Integration Pack for PeopleSoft
The JAMS Integration for PeopleSoft contains an Application Engine program and supporting app designer objects
to schedule the jobs. These objects are included in a project that must be installed and operating in the
PeopleSoft environment.
1. Launch the Application Designer and connect to your PeopleSoft instance in 2-tier Mode.
2. Navigate to Tools > Copy Project > From File.
34
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
3. From your JAMS Scheduler machine, copy the MVP_JAMS_ADDON_FOR_PS.ini and
MVP_JAMS_ADDON_FOR_PS.xml files from the Program Files\MVPSI\JAMS\Scheduler directory. Paste
them into a folder named, MVP_JAMS_ADDON_FOR_PS that is manually created on the PeopleSoft server.
Browse to the location of that newly created folder. The Project name “MVP_JAMS_ADDON_FOR_PS”
appears in the lower box. Click the Select button.
4. The Copy from File dialog box appears. Select the Copy button.
35
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
5. Set the default tablespace.
The JAMS Integration for PeopleSoft requires one table to maintain its scheduling process. Your DBA will
likely want to specify which tablespace to utilize, depending on your organization’s database platform.
Set the tablespace using the steps below:
Expand the “Records” node in the project tree.
Double-click MVP_SCHD_LOG to open the record definition.
Navigate to Tools > Data Administration > Set Tablespace . The Change Space window
appears.
Select the appropriate Platform and Tablespace Name depending on your organizations database
platform and click OK.
Save the record.
36
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
6. Build the Project to create the PS_MVP_SCHD_RCNTL table:
Navigate to Build > Project.
Select the Create Tables and Create Indexes checkboxes.
Choose the Execute SQL Now button.
Select the Build button
To complete the installation process, review the log file for errors.
Configuring the Execution Method
Before JAMS can execute a Job, additional information about your PeopleSoft environment will need to be
provided. To get started, follow the steps below.
1. Open the JAMS Client as an administrator.
2. Select the Execution Methods shortcut from the Menu.
3. Locate the listed PeopleSoft Job Execution Methods.
If your organization’s PeopleSoft Process Scheduler runs on Unix or Linux, open the
PeopleSoftJobSsh.
If your PeopleSoft Process Scheduler runs on Windows, open PeopleSoftJobWindows.
4. When the definition dialog opens, navigate to the Parameters tab.
5. Locate the parameter PS_ORACLE_HOME. Open the parameter definition dialog by double clicking the
parameter or highlight it and choose the Properties button.
6. Enter the correct information in the Default Value field.
37
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
8. Click the right arrow on the window header to move to the next parameter. Define parameters as
necessary to connect to the PeopleSoft environment.
9. Save and Close the Parameters dialog
10. Save and Close the Execution Method dialog.
Note: All but the "Additional_Param_#" parameters must be reviewed. Below is a reference table
that describes each parameter.
38
Parameter
Description
Example
DBInstance
Database
Instance/Name
EP91DMO
DBType
Database Type
ORACLEMSSQLDB2SYBASE
PS_ORACLE_HOME
Oracle Home
/u01/app/oracle/product/11.1.0/db_1
PS_ORACLE_SID
Oracle Database
Name
EP91DMO
PS_TUXDIR
Tuxedo Directory
/usr/local/psoft/Oracle/Middleware/tuxedo10gR3
PS_HOME
PeopleSoft Home. You
can use
$ORACLE_SID as a
variable.
/usr/local/psoft$ORACLE_SID
PS_CFG_HOME
Configuration Home
/usr/local/psoft/cfg850
PS_SQRDIR
SQR Directory. You
can use
$ORACLE_SID as a
variable.
/usr/local/psoft$ORACLE_SID/bin/sqr/ORA/bin
PS_SERVER_CFG
Server Configuration
$PS_CFG_HOME/appserv/prcs$ORACLE_SID/psprcs.cfg
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Home. You can use
the $PS_CFG_HOME
and $ORACLE_SID
variables.
PS_JAMS_TMP
JAMS Temp Folder
PS_RUNLOCATION
Run Location
/home/psoft/PS_CACHE/files/JAMS/
PSUNX
Setting Up a JAMS Job for PeopleSoft
Before setting up any Job in JAMS, the user running the process should log into PeopleSoft, navigate to the run
control page and enter the information required on the PeopleSoft page.
1. Select the desired folder for the PeopleSoft Job, then ensure the Job Definitions tab is selected.
2. Click the Add button from the Control Bar to open the Add a New JAMS Job Definition dialog.
3. In the dialog, give the new Job a Name, Description (optional), and Execution Method.
NOTE: Select PeopleSoftJobWindows or PeopleSoftJobSsh to create a PeopleSoft Job. If the
organization's PeopleSoft Process Scheduler runs on UNIX or Linux, choose the PeopleSoftJobSsh Execution
Method. If the Scheduler runs on Windows, select the PeopleSoftJobWindows Execution Method.
4. By default, the full Job Definition dialog will open when the Job is initially saved. Click OK.
5. The Job Definition dialog will open.
6. Define Elements, Parameters, Security, Properties, and Documentation as desired.
NOTE: An Execute As property should be configured with a user that has access to the PeopleSoft Server.
7. On the Source tab, populate the Run Control ID with the one that is already set up in PeopleSoft.
8. Enter the name of the PeopleSoft User who owns the setup Run Control.
9. Choose the Process Type from the dropdown and enter the Process Name.
10. Select the Output Type and Output Destination Format using the individual dropdowns. The Output
Destination is required only if the selected Output Type is File.
11. Save and Close the Job definition.
Working With Crystal Report Jobs
Crystal Reports jobs in PeopleSoft require that Query Bind Variables be passed to the job on the command line. If
scheduling a Crystal Report, use the following steps:
1. If the PeopleSoft process requires additional parameters, you must add these using the Parameters tab.
Most Crystal Reports in PeopleSoft require additional parameters. Use the parameter name
Additional_Parm_x for the name. For parameters 1 through 9, there is no leading zero. See the examples
below to identify which parameters to use.
2. Running the Crystal Report inside of PeopleSoft is a great way to identify which parameters need to be
passed. Once it has been run, open the process in the PeopleSoft Process Monitor (PeopleTools >
Process Scheduler > Process Monitor ).
3. Locate the process (Crystal in most cases) and select the Details link.
4. Click the Parameters link
39
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
5. Locate the Command Line and review all data, especially at the end of the command line. Most of the
time the required parameters come after the “ORIENTL” parameter. In the following example, the five
required parameters are: "US001" "2007-11-07" "2011-11-07" "VP1" "posted_voucher_listing". When adding
these parameters into JAMS make sure to exclude the double quotes.
6. In the following example, the Crystal APY1020 requires additional parameters. 40
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
7. Here’s an example of Parameter 1. Notice the Default Value is US001 without the double quotes.
8. Create the remaining parameters (2007-11-07" "2011-11-07" "VP1" "posted_voucher_listing").
9. Save and Close the Parameters dialog.
41
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
10. Save and Close the Job Definition.
11. When the JAMS Job is submitted, the five parameters will appear (as long as the parameters are not
hidden).
Note: The additional parameters do not necessarily have to be populated when creating the
JAMS Job, but the parameter name itself must be set up at that time.
42
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
SAP EEC add-on: Configuring JAMS on SAP EEC EHP 3 & 7
43
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
JAMS Instrumentation add-on
44
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
JAMS Management Pack for MS SCOM
45
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
The JAMS Management Pack for MS SCOM
The JAMS Management Pack provides monitoring of JAMS components and services using Microsoft SCOM 2007R2, 2012
and 2012 R2. The monitoring includes availability, health and performance data collection. In addition to these
monitoring capabilities, the Management Pack supports Agent tasks and Dashboard views. The Management Pack
supports monitoring of JAMS on the Windows operating system only. Support for other operating systems may be added
at a later date.
Preparing to Import the Management Pack
To ensure that target JAMS computers are managed by the SCOM Agents (preferably using LocalSystem account), the
account used by the SCOM Agent must have adequate permissions to access JAMS program directory, the system registry
and access JAMS data via its PowerShell provider.
Note: You can use local accounts on managed computers and/or dedicated domain accounts to execute
Management Pack rules and monitors; however, you will also need to configure the JAMS ‘Run As’ profile
account using SCOM’s operations console as outlined below.
It is recommended the target computer with the JAMS Scheduler role have the PowerShell feature enabled or installed.
Please refer to the JAMS Installation Guide for additional information. It is also recommended that you install the JAMS
Instrumentation Integration for each managed JAMS Scheduler machine in order to reduce overhead and improve
functionality of the Management Pack.
Importing the Management Pack
The Management Pack consists of a single file: MVP.JAMS.mp
For general import instructions go to the article: http://technet.microsoft.com/en-us/library/cc974494.aspx
1. Log on to the computer using an account that is a member of the Operations Manager Administrators role within
the Operations Manager management group.
2. From the Operations console, click Administration. When you run the Operations console on a computer that is
not a management server, the ‘Connect To Server’ dialog box appears. In the Server name text box type the
name of the management server that you want the Operations console to connect to.
3. Right-click the Management Packs node and then click Import Management Packs.
4. The Import Management Packs wizard opens. Click the Add button and then select Add from disk.
5. The Select Management Packs to import dialog box appears. Change to the directory that contains the JAMS
Management Pack file. Select MVP.JAMS and then click Open.
6. On the Select Management Packs page the management pack that you selected for import should be listed.
Choose Import.
7. The Import Management Packs page appears and displays the import progress. If there is a problem at any stage
of the import process select the management pack to view the status details. Click Close.
Discovery
After importing the JAMS Management Pack, SCOM runs a discovery process on all managed Windows computers in order
to locate the JAMS installations. By default SCOM discovers all JAMS installations on Windows. No additional
configuration should be necessary for most customer environments.
Customizing the Management Pack
The JAMS Management Pack is ‘sealed’, preventing any setting changes in the original Management Pack file. However,
you can still perform and save customizations such as overrides for monitors, alert rules and views, and save them to a
different management pack.
By default SCOM saves all customizations to the Default Management Pack. As a best practice you should instead create
a new management pack for each sealed management pack you want to customize.
For more information about management pack customizations and the Default Management Pack, link to the
article: http://go.microsoft.com/fwlink/?LinkId=217006
The Management Pack includes the following customizations:
JAMS Scheduler Performance Monitor. Note that there are 2 monitors targeting the JAMS Scheduler with and
without the Instrumentation Integration installed (JAMS Instrumented Scheduler and JAMS Non-Instrumented
Scheduler). Both monitors have identical thresholds for the number of currently executed or pending Job with
a specific status.
You can disable these monitors and/or provide the overrides for the frequency as well as warning and error
46
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
thresholds. The screenshot below illustrates the Scheduler Performance Monitor parameters that can be
overridden using the SCOM Operations Console.
There are 2 alert rules that are defined for the Instrumented Scheduler class:
-JAMS Scheduler Execution Warning
-JAMS Scheduler Execution Error
These rules can be enabled or overridden to produce Scheduler alerts based on the level of events logged to
MVPSI JAMS/Operational by the JAMS Instrumentation Integrations.
JAMS Scheduler (performance) collection rules can be disabled or the frequency (IntervalSeconds) can be
adjusted.
Note: there are separate set of rules for Instrumented and Non-Instrumented Scheduler classes.
New monitors and rules can be easily added using new performance counters and/or ETW events implemented
in the JAMS Instrumentation Integrations.
Note: corresponding providers are available only on Scheduler machines that have Instrumentation
Integrations installed. These JAMS Scheduler instances are discovered as instances of ‘JAMS
Instrumented Scheduler’ class derived from ‘JAMS Scheduler’ class.
The JAMS Management Pack creates ‘Run As’ profile named ‘Account for JAMS Collection Rules’ as shown on the
47
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
screenshot below. You can associate one or more SCOM accounts with this profile to define local or domain
accounts that should be used by the management pack rules and monitors on each computer. Refer to SCOM
documentation for further information on ‘Run As’ configuration.
Removing the Management Pack
For additional information on removing the Management Pack, go to the article: http://technet.microsoft.com/enus/library/cc974489.aspx
Configuring a JAMS Scheduler to Send Alerts
1. In the MVPSI\JAMS\Scheduler directory, rename the Event.SCOM.default to be Event.SCOM.config.
2. Add an Alert Element on a JAMS Folder or Job that defines the text that you want to send in the Alert. To apply
the alert to all folders, add the Alert element to the root folder.
JAMS looks for the following parameters before sending an alert to SCOM. These parameters can originate from the
Job’s execution method, the Job itself, or the folder the Job is located in.
SCOMPriority: sets the priority of the alert. This parameter should be one of three integer values, with 0 =
low, 1 = medium, and 2 = high.
SCOMSeverity: sets the severity of the alert. The parameter also should include one of three values, with 0 =
informational, 1= warning, and 2 = critical.
SCOMCustomField0 through SCOMCustomField9: these fields are passed to SCOM and intended for end-user
customizations. The values are strings with JAMS performing symbol substitution, allowing you to reference
any JAMS property using the standard <<JAMS.Name>> syntax.
View Information in the Operations Manager Console
48
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Once imported, the JAMS Management Pack creates a root folder, MVP JAMS, that can be accessed via the SCOM
Operations Console Monitoring pane using the following subfolders and views:
These Folders and Views display different aspects of monitoring data.
Root: MVP JAMS folder
Alerts: Alert View for all JAMS Alerts
Computer: State view for all computers within the JAMS computer group.
Tasks: Task view of all JAMS Scheduler and Agent tasks queued via the SCOM Operations console to run on
SCOM Agent computer.
Components folder
-Scheduler State View
-Agent State View
-Client State View
Health Monitoring Folder
-Agent Health dashboard view displays JAMS Agent State View and Alerts.
-Scheduler Health dashboard view displays JAMS Scheduler state views and alerts.
Performance Folder
-Scheduler Performance View
JAMS Management Pack Agent Tasks
The JAMS Management Pack provides a set of admin tasks that can be queued to run on a SCOM Agent machine; for
example, to start/stop the JAMS component services, query or submit JAMS Jobs, etc.
Some of these tasks are available via the Management Pack Alerts Knowledge links, while you can access JAMS Agent or
Scheduler tasks via the Operations console Actions pane in the Management Pack Agents and Schedulers status views.
The following tasks are available for JAMS Agents:
Start JAMS Agent Service
Stop JAMS Agent Service
The following task are available for the JAMS Scheduler:
Get Scheduler Jobs
Restart Jobs
Resume Jobs
Start JAMS Scheduler Executor Service
Start JAMS Scheduler Server Service
Start JAMS Scheduler Service
Start Job
49
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Stop JAMS Scheduler Executor Service
Stop JAMS Scheduler Server Service
Stop JAMS Scheduler Service
Stop Job
Submit Job
Suspend Job
Troubleshooting the Management Pack
If the Scheduler Performance Monitor and/or collection and alert rules are not working it may indicate that PowerShell
is not available or JAMS PowerShell module is not installed on the target system. Please check the SCOM Active Alerts
view and the SCOM application event log on the management server or management computers for the alerts or logged
event notifications indicating PowerShell is not properly installed on the target computer or script execution errors
such as insufficient Windows or JAMS permissions assigned to accounts used to run the management pack workflows.
By default these workflows use the account assigned to the SCOM Agent (such as LocalSystem), but you can customize
the ‘Run As’ settings as described in the topic: Importing and Customizing the JAMS Management Pack for MS SCOM.
Troubleshooting Alerts
If you are not receiving alerts from JAMS to SCOM please check the following:
Review the four steps made in the first section of this topic: Configuring a JAMS Scheduler to Send Alerts.
Check the security permissions on the jamstoscom msmq private queue. Make sure that your SCOM activity
user or Run As user has full control over the queue.
If you don't have a Run As account setup for JAMS in SCOM, the default Activity user(s) needs to have full
control over the jamstoscom queue.
50
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Running SAS Jobs with JAMS
51
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Running SAS Jobs with JAMS
Windows Command Procedure Method
JAMS can execute SAS programs using the Windows Command Procedure Execution Method.
Below is an example of an SAS job-source:
c:\YourSASPath\sas.exe
-autoexec d:\sas\autoexec.sas
-config d:\sas\config.sas
-nologo
-log d:\work\logs\pull_sample200102131244.log
-sysin d:\YourDir\YourProgram.sas
SAS Execution Method
As an alternative, you can create a SAS execution method from within JAMS. This allows the source tab of a Job
definition to contain the contents of your SAS program.
1. Select the Execution Methods shortcut from the Menu.
2. Click the Add button from the Control Bar to open the Add an Execution Method dialog.
3. In the Add an Execution Method dialog, give the Execution Method a Name, Description (optional), and
Base Method.
NOTE: Use the Command Base Method for SAS.
4. Click OK. By default, JAMS will open the full Execution Method Definition dialog when the Execution
Method is initially saved.
5. Edit the Parameters, Template, Properties, and Job Properties as necessary.
6. Save and Close the Execution Method.
JAMS VBScript Execution Method
SAS Projects (EGP files) can be saved as Visual Basic scripts from the SAS Enterprise Guide and executed using
the JAMS VBScript Execution Method.
52
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
JAMS Incident Management Pack for ServiceNow
53
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Symitar add-on: Configuring and Job Setup
54
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Symitar in JAMS
In This Topic:
Installing the Symitar Integration Pack
Creating a Symitar Job
Defining a Symitar Job using the Workflow Interface
Symitar Activities
Installing the Symitar Integration Pack
If the JAMS Integration Pack for Symitar is not installed, run the JAMS Installer and check the "JAMS Integration
Pack for Symitar" component in the Feature Selection step.
NOTE: Un Checking other components will uninstall those components.
NOTE: In some installations, the host.config file must be configured in order to allow a machine to
access the Symitar server.
Creating a Symitar Job
1.
2.
3.
4.
5.
6.
7.
8.
9.
Create a Job in the Desired folder and choose the Workflow Execution Method
Select the desired folder for the Symitar Job, then ensure the Job Definitions tab is selected.
Click the Add button from the Control Bar to open the Add a New JAMS Job Definition dialog.
In the dialog, give the new Job a Name, Description (optional), and Execution Method.
In this case, select Workflow to create the Symitar Job.
By default, the full Job Definition dialog will open when the Job is initially saved. Click OK.
The Job Definition dialog will open.
Define Elements, Parameters, Security, Properties, and Documentation as desired.
NOTE: An Execute As property should be configured with a user that has access to the Symitar Server.
Select the Source tab, and define the Job using the Workflow Interface.
(Keep reading this document for more information on the Workflow Interface and Symitar Activities)
Save and Close the Job Definition dialog.
Defining a Symitar Job using the Workflow Interface
Workflow Interface
The source for a Symitar Job displays the Workflow Interface. This interface is comprised of three panels: the
Toolbox panel, Activity panel, and Properties panel. Symitar Activities can be found in the Toolbox panel, under
the "SYM" group. Activities will be used to define the Symitar Job.
55
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Toolbox Panel
The Toolbox Panel contains dozens of grouped Activities that can be used in the workflow. These activities are
the building blocks of a Workflow Job. Activities may be used exclusively, or combined with other activities to
create a workflow.
Activity Panel
The Activity Panel is the Designer section of the workflow. Drag activities from the toolbox to this area to add
them to the workflow, or move those activities around in the workflow window. Right-click on items in this panel
to get additional options.
Properties Panel
Shows the available properties of any selected element or activity. The properties of each activity can be quickly
set from this panel.
Building Symitar Workflows
A single Symitar Activity can be utilized by dragging one of the available activities from the Toolbox Panel into
the Activity Panel and setting the properties for that Activity.
To utilize multiple activities in a workflow, JAMS requires a Parent Activity to contain other activities. Note that
JAMS will automatically add "Sequences" to the workflow if another parent activity is not set. Sequences may be
nested inside of other Sequences or Parent Activities in a workflow.
Automatically Add Sequences:
1. With at least one activity in the Activity panel, drag another activity from the toolbox panel to the Activity
panel.
2. Hover the new activity over any existing activity. Grey bars will appear to show possible placement
locations.
3. Release the activity in the desired location. A sequence will be added if necessary.
Note that moving existing activities will also cause the placement location bars to appear, and will also
result in the creation Sequences when necessary.
Passing Parameters to a Symitar Job
Typically, executing a Symitar job involves responding to a series of prompts; for example, what is the job
name?. . . the queue?, etc.
56
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
A Symitar job may include other prompts that are unique to the job. When starting a Symitar job, if JAMS
encounters an unexpected prompt, it looks for a workflow variable/JAMS parameter named "SymParam1". If this
parameter is found, JAMS inserts its value as the response to the prompt. However, if this variable/parameter is
not found, JAMS uses the default value defined in the Symitar job.
Note: When looking for a “SymParam”, JAMS searches first for a Workflow variable with that name. If
that variable doesn’t exist, it then looks for a JAMS Parameter with that name. Each time JAMS looks for
a parameter it increments the number, so the second parameter would be "SymParam2”, etc.
Symitar Activities
A small overview of properties and function of each Symitar Activity are listed here. When defining Symitar
Activities, it is important to keep in mind:
Symitar pathways will be case sensitive in UNIX or LINUX environments
DateTime values are formatted as YYYYMMDD
DataFiletoPC
Downloads a DataFile from the FTP Server to the PC. DataFile is downloaded from the SYMnnn/DATAFILES
directory, where nnn is a three-digit SYM Number (e.g., ‘007’).
Property
Description
JAMSUsername
The User ID for AIX Login. Any JAMS user.
LocalDirectory
The local directory is the download location for the SYM DataFile.
DisplayName
Use to modify the property name as displayed in the activity panel.
Password
The AIX password. Use when overriding the value in the SymConfig Activity.
As an alternative, if you wish to hide the password from viewing, (1) create a
user in JAMS, (2) set the "Logon As" to the AIX Username, (3) click the
password button and (4) enter the password for this account, and (5) then
use that JAMS User Name in the JAMSUserName workflow property.
ServerFileName
The name of the DataFile on the SYM Server in the '/SYMnnn/DATAFILES'
directory.
Servername
The name of the AIX server. Use when overriding the value set in the
SymConfig activity.
SymNumber
The Sym Number. Use when overriding the value in the SymConfig activity.
This parameter defaults to '000'.
UserName
The AIX UserName. Use when overriding the value in the SymConfig activity.
DeleteLetterFile
Deletes a LetterFile from the '/SYMnnn/LETTERSPECS' directory
57
Property
Description
JAMSUsername
The User ID for AIX Login. Any JAMS user.
DisplayName
Use to modify the property name as displayed in the activity panel.
Password
The AIX Password (Use when overriding the value in the SymConfig Activity).
As an alternative, if you wish to hide the password from viewing, create a
User in JAMS, set the "Logon As" to the AIX Username, click the password
button and enter the password for this account, and then use that JAMS User
Name in the JAMSUserName workflow property.
ServerFileName
The name of the LetterFile to delete from the '/SYMnnn/LETTERSPECS'
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Directory on the SYM Server.
ServerName
The name of the AIX Server. Use when overriding the value set in the
SymConfig activity.
SymNumber
The Sym Number. Use when overriding the value in the SymConfig Activity.
The parameter defaults to '000'.
UserName
The AIX UserName. Use when overriding the value in the SymConfig activity.
EmailReports
Send a report generated from ReportFileToPC as an email attachment. The report must be assigned to a
Workflow Variable of type SymReport.
Property
Description
BCCAddress
The address of user(s) to receive blind carbon copies of the email.
CCAddress
The address of user(s) to receive carbon copies of the email.
FromAddress
The address to be used to send the email.
Reports
The report(s) to be sent as attachments to the email.
Subject
The subject of the email to be sent.
ToAddress
The address of the user(s) to receive the email.
BodyMessage
The body of the message to be sent.
SMTPServer
The SMTP server to be used to email handling.
JAMSUsername
The User ID for AIX Login. Any JAMS user.
DisplayName
Use to modify the property name as displayed in the activity panel.
Password
The AIX Password (Use when overriding the value in the SymConfig Activity).
As an alternative, if you wish to hide the password from viewing, create a
User in JAMS, set the "Logon As" to the AIX Username, click the password
button and enter the password for this account, and then use that JAMS User
Name in the JAMSUserName workflow property.
ServerName
The name of the AIX Server. Use when overriding the value set in the
SymConfig activity.
SymNumber
The Sym Number. Use when overriding the value in the SymConfig Activity.
The parameter defaults to '000'.
UserName
The AIX UserName. Use when overriding the value in the SymConfig activity.
FileToPC
Downloads a SYM File from the FTP Server to the PC. The File is downloaded from the specified directory.
58
Property
Description
JAMSUsername
The User ID for AIX Login. Any JAMS user.
LocalDirectory
The download location for the SYM File.
DisplayName
Used to modify the property name as displayed in the activity panel.
Password
The AIX Password (Use when overriding the value in the SymConfig Activity).
As an alternative, if you wish to hide the password from viewing, create a
User in JAMS, set the "Logon As" to the AIX Username, click the password
button and enter the password for this account, and then use that JAMS User
Name in the JAMSUserName workflow property.
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
ServerDirectory
Server Directly beneath the '/SYMnnn/' folder
ServerFileName
The Name of the file on SYM server in the specified Directory.
ServerName
The Name of the AIX Server. Use when overriding the value in the SymConfig
Activity.
SymNumber
The SYM Number. Use when overriding the value in the SymConfig activity.
Defaults to '000'
UserName
The AIX Username. Use when overriding the value in the SymConfig activity.
LetterFiletoPC
Downloads a LetterFile from the FTP Server to the PC. The LetterFile is downloaded from the
SYMnnn/LETTERSPECS directory, where nnn is a three-digit SYM Number (e.g., ‘007’).
Property
Description
JAMSUsername
The User ID for AIX Login. Any JAMS user.
LocalDirectory
The local directory is the download location for the SYM LetterFile.
DisplayName
Used to modify the property name as displayed in the activity panel.
Password
Use when overriding the value in the SymConfig Activity. As an alternative, if
you wish to hide the password from viewing, (1) create a user in JAMS, (2)
set the "Logon As" to the AIX Username, (3) click the password button and
(4) enter the password for this account, and (5) then use that JAMS User
Name in the JAMSUserName workflow property.
ServerFileName
The name of the LetterFile on the SYM Server in the '/SYMnnn/LETTERSPECS'
directory.
ServerName
The name of the AIX server. Use when overriding the value set in the
SymConfig activity.
SymNumber
Use when overriding the value in the SymConfig activity. This parameter
defaults to '000'.
UserName
The AIX UserName. Use when overriding the value in the SymConfig activity.
PCToDataFile
Uploads a DataFile from the PC to the FTP server. The DataFile is uploaded to the SYMnnn/DATAFILES
directory, where nnn is a three-digit SYM Number (e.g., ‘007’).
59
Property
Description
JAMSUsername
The User ID for AIX Login. Any JAMS user.
LocalDirectory
The local directory of the Data File to send to the '/SYMnnn/DATAFILES'
directory on the SYM Server.
LocalFileName
The Local file name of the DataFile to upload to the '/SYMnnn/DATAFILES
Directory on the SYM server.
DisplayName
Used to modify the property name as displayed in the activity panel.
Password
Use when overriding the value in the SymConfig Activity. As an alternative, if
you wish to hide the password from viewing, (1) create a user in JAMS, (2)
set the "Logon As" to the AIX Username, (3) click the password button and
(4) enter the password for this account, and (5) then use that JAMS User
Name in the JAMSUserName workflow property.
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
ServerName
The name of the AIX Server. (Use when overriding the value set in the
SymConfig activity).
SymNumber
Use when overriding the value in the SymConfig Activity. This parameter
defaults to '000'
UserName
The AIX UserName. Use when overriding the value in the SymConfig activity.
PCToEditFile
Uploads an EditFile from a local location to a remote folder via FTP operation
Property
Description
Overwrite
Turn overwriting on or off
JAMSUsername
The User ID for AIX Login. Any JAMS user.
LocalDirectory
Local Directory of the Edit File to send to the '/SYMnnn/REPORT' directory on
the server
LocalFileName
Local File Name of the Edit File to send to the '/SYMnnn/REPORT' directory on
the server
DisplayName
Used to modify the activity name property as displayed in the activity panel.
Password
Use when overriding the value in the SymConfig Activity. As an alternative, if
you wish to hide the password from viewing, (1) create a user in JAMS, (2)
set the "Logon As" to the AIX Username, (3) click the password button and
(4) enter the password for this account, and (5) then use that JAMS User
Name in the JAMSUserName workflow property.
ServerName
The name of the AIX server. Use when overriding the value set in the
SymConfig activity.
SymNumber
The Sym Number. Use when overriding the value in the SymConfig activity.
The parameter defaults to '000'.
UserName
The AIX UserName. Use when overriding the value in the SymConfig activity.
PCToFile
Uploads a file from the PC to the specified directory on the SYM server.
60
Property
Description
JAMSUsername
The User ID for AIX Login. Any JAMS user.
LocalDirectory
The local directory of the file to send to the specified SYM directory
LocalFileName
The local File Name of the file to send to the specified SYM directory
DisplayName
Used to modify the activity name property as displayed in the activity Panel.
Password
Use when overriding the value in the SymConfig Activity. As an alternative, if
you wish to hide the password from viewing, (1) create a user in JAMS, (2)
set the "Logon As" to the AIX Username, (3) click the password button and
(4) enter the password for this account, and (5) then use that JAMS User
Name in the JAMSUserName workflow property.
ServerDirectory
Server directory beneath the '/SYMnnn/' folder where the file will be sent
ServerName
The name of the AIX server. Use when overriding the value set in the
SymConfig activity.
SymNumber
The Sym Number. Use when overriding the value in the SymConfig activity.
The parameter defaults to '000'.
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
UserName
The AIX UserName. Use when overriding the value in the SymConfig activity.
PCToLetterFile
Uploads a LetterFile from the PC to the FTP Server. The LetterFile is uploaded to the SYMnnn/LETTERSPECS
directory, where nnn is a three-digit SYM Number (e.g., ‘007’).
Property
Description
JAMSUsername
The User ID for AIX Login. Any JAMS user.
LocalDirectory
Local directory of the Letter File to send to the '/SYMnnn/LETTERSPECS'
Directory on the Server
LocalFileName
Local File Name of the Letter File to send to the '/SYMnnn/LETTERSPECS'
Directory on the Server
DisplayName
Used to modify the activity name property as displayed in the activity panel.
Password
Use when overriding the value in the SymConfig Activity. As an alternative, if
you wish to hide the password from viewing, (1) create a user in JAMS, (2)
set the "Logon As" to the AIX Username, (3) click the password button and
(4) enter the password for this account, and (5) then use that JAMS User
Name in the JAMSUserName workflow property.
ServerName
The name of the AIX server. Use when overriding the value set in the
SymConfig activity.
SymNumber
The Sym Number. Use when overriding the value in the SymConfig activity.
The parameter defaults to '000'.
UserName
The AIX UserName. Use when overriding the value in the SymConfig activity.
ReportFileToPC
Downloads a ReportFile from a remote location to a local folder via FTP
Property
Description
JAMSUsername
The User ID for AIX login. Any JAMS User.
LocalDirectory
The Local Directory where the Report File will be located.
DisplayName
Used to modify the property name as displayed in the Activity panel.
LocalFileName
The name for the local report file. The default is the source name.
Password
Use when overriding the value in the SymConfig Activity. As an alternative, if
you wish to hide the password from viewing, (1) create a user in JAMS, (2)
set the "Logon As" to the AIX Username, (3) click the password button and
(4) enter the password for this account, and (5) then use that JAMS User
Name in the JAMSUserName workflow property.
Report
The SymReport that identifies the report. This is returned by RunJobFile.
ServerName
The name of the AIX server. Use when overriding the value set in the
SymConfig activity.
SymNumber
The Sym Number. Use when overriding the value in the SymConfig activity.
The parameter defaults to '000'.
UserName
The AIX UserName. Use when overriding the value in the SymConfig activity.
Creating an in-memory copy of the desired report
1. Click the "Variables" tab, located at the bottom of the Activity Panel, then select Create Variable
2. Name the variable the desired report name
61
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
3. Click on the listed Variable Type. A drop-down list will appear. Select Browse for Types from the
dropdown list
4. In the dialog that appears, type "SymReport" into the search box or navigate to the SymReport
variable type. Select the SymReport variable type and click "OK"
5. Ensure the Scope is set to "Sequence"
6. Leave the "Default" column blank
7. Select the ReportFileToPC activity in the Activity Panel, and set the "Report" property to the name
of the created variable
RunJobFile
Runs a JobFile on the Symitar System. By default JobFiles are run in synchronous mode which means that the
program will wait for the JobFile to finish.
Property
Description
JAMSSymUserID
For this JAMS user, enter the SymUserId as the "logon as" name, and set the
password by clicking the "Set Password" button. When JAMS executes a job
file, it will assemble the JAMSSymUserID as "username.password" (sans
quotes).
JAMSUsername
The User ID for AIX Login. Any JAMS user.
BatchSequenceNumber
Returns the batch sequence number of the Job.
JobFileBatchQueue
A numeric value (0-3) that will determine the batch queue to run the JobFile.
Use 99 to find the first available empty queue. 0 will be used if 99 is specified
and all queues are busy.
JobFileName
The name of the JobFile to run.
ReportsProduced
Returns a collection of reports produced by the job.
SymOperatorId
Operator ID to log into SYMOP. In most cases this will be \"0000\" or the
same as the user's SymUserId
SymUserId
SYM specific userid. Must be in the format of symuserid.password. As an
alternative, if you want to hide your symuserid/password from viewing, (1)
create a user in JAMS, (2) set the “Logon As” to the symuserid, (3) click the
password button and enter the password for this symuserid, and then (4) use
that JAMS User Name in the JAMSSymUserID workflow property. JAMS will
then correctly format the symuserid and password.
DisplayName
Use to modify the property name as displayed in the Activity panel.
Password
The AIX Password (Use when overriding the value in the SymConfig Activity).
As an alternative, if you wish to hide the password from viewing, (1) create a
User in JAMS, (2) set the "Logon As" to the AIX Username, (3) click the
password button and enter the password for this account, and then (4) use
that JAMS User Name in the JAMSUserName workflow property.
ServerName
The name of the AIX server. Use when overriding the value set in the
SymConfig activity.
Sym
The Sym Number. Use when overriding the value in the SymConfig Activity.
This parameter defaults to '000'.
TelnetPort
Enter the port number. This parameter defaults to ‘23’.
Username
The AIX UserName. Use when overriding the value in the SymConfig activity.
SymConfig
Creates a parent-child relationship for all SYM activities nested within SymConfig and set the default values
for these child activities. If the child activities contain their own settings, those values will be used in place of
the values set in the SymConfig activity
62
©2018 MVP Systems Software, Inc. All Rights Reserved.
JAMS 7.X Installation Guide
Property
Description
JAMSUsername
The User ID for AIX Login. Any JAMS user.
DisplayName
Use to modify the property name as displayed in the Activity panel.
Password
The AIX password. As an alternative, if you wish to hide the password from
viewing, (1) create a user in JAMS, (2) set the "Logon As" to the AIX
Username, (3) click the password button and (3) enter the password for this
account, and then (4) use that JAMS User Name in the JAMSUserName
workflow property.
ServerFolderDirectory
The Path of the SYM Server File.
ServerName
The name of the AIX Server
ServerRunTimeoutInSecs
A numeric value (in seconds).
ServerTransferMode
ASCII or Binary.
SymNumber
The Sym Number.
UserName
The AIX UserName.
Still have questions about Symitar or Workflows? Try watching our JAMS Workflow Video.
NOTE: This video was recorded in JAMS V6. The sample Workflow principles shown there apply to JAMS V7.
63
©2018 MVP Systems Software, Inc. All Rights Reserved.