JAMS 7.x Help
Working with Jobs

Essentially, every component in JAMS supports or controls how a Job is defined or run. A JAMS Job includes a number of Soft Properties and Elements that modify how and when it should run, as well as actions that should be taken when the Job finishes. A JAMS Job may be configured with hundreds of properties and elements to ensure that it executes at the right time and under the proper conditions.

 

Adding a New Job

  1. To create a new Job, open the Definitions view from the Shortcut bar, then select the Job Definitions tab.
  2. Click the Add button in the Control Bar to open the Add a New JAMS Job Definition dialog.
  3. In the dialog, select the Folder where the Job should be created.
  4. Define a Name for the new Job.
  5. If desired, give the Job a Description.
  6. Select an Execution Method for the Job from the drop-down list.
  7. By default, the full Job Definition dialog will open when the Job is initially saved. Click OK.
  8. The Job Definition dialog will open.
  9. Define the Job's Source, Elements, Parameters, Security, Properties, and Documentation as desired.
  10. When the Job has been configured as desired, click Save and Close.

 

Modifying an Existing Job

  1. To make changes to an existing Job, open its Job Definition dialog from the Definitions View.
    To open the Job Definition dialog, users may Double-Click the Job, Select the Job and then click the Properties button in the Control Bar, or Right-click and select Properties from the Job Options menu.
  2. The Job Definition dialog appears.
  3. Modify the Job Information, Source, Elements, Parameters, Security, Properties, and Documentation as desired.
  4. When the Job has been reconfigured as desired, click Save and Close.

 

Deleting an Existing Job

  1. Open the Definitions view from the Shortcut bar, then select the Job Definitions tab.
  2. Select the desired Job, then click the Delete button in the Control Bar, or Right-Click the desired Job, then select Delete from the Job Options menu.
  3. A dialog will appear to confim the Job Deletion. If the desired Job was selected for deletion, click Yes. If the incorrect Job was selected, click No or Cancel.

 

Job Definition Tabs

Job

This tab includes basic Job information:

Source

This tab is where you can view or edit the source for the current Job. The Job's Execution Method defines what kinds of interface to display in this tab.

The Source interface of a Job in JAMS can be a source code editor containing any number of code languages, a fill-in-the-blank style form, a Sequence editor, or a Workflow editor.

 

The source for many Execution Methods will be a source code editor, which supports syntax highlighting and code coloring to enhance the readability of scripts.

Variable and Parameter references may be embedded in the Job's command file. This variable data can come from the Job's Parameters, JAMS Variables, or JAMS Predefined Symbols.

 

NOTE: The Source tab has an option to let you edit source code in the PowerShell ISE. If you make edits and close the PowerShell ISE, you need to save the Job, close it, and open it again to make additional edits to the source.

Keyboard shortcut commands for the Job Source Editor are shown in the table below. Use the header to expand the content.

Source Code Editor Keyboard Shortcuts

               
Parameters

A JAMS Parameter contains a single slice of data that (unlike a Variable) remains exclusive to the associated Job or Folder.

When JAMS interactively submits a Job with Parameters, the user is presented with a fill-in-the-blank form to define values for these parameters. When JAMS builds a Parameter form, the Parameters are placed in the order in which they are defined, unless the Parameters were given Sequence numbers.

If a Job uses a parsed Execution Method, you can embed Parameter names into the Job’s Source using the <<ParameterName>> specification. When the Job runs, it uses the value of the Parameter in place of this specification.

 

A JAMS Job may contain zero or more Parameters.

Add a Parameter
               
  1. In any Job Definition dialog, open the Parameters tab.
  2. Click the Add button to open the Add a Parameter dialog.
  3. In the dialog, define the Parameter Name, Data Type, and Default Value of the Parameter.

  1. By default, the full Parameter Definition dialog will open when the Job is initially saved. Click OK.
  2. The Parameter Definition dialog will open.
  3. Define additional Parmeter Properties as desired.
  4. Save and Close the Parameter Definition dialog.
  5. Save and Close the Job Definition dialog.

 

 

Parameter Properties

 Once the Parameter is configured in the Job definition it can be specified in the Source tab.

           
Elements

There are five Element categories in JAMS. These are Documentation, Event Handler, Prerequisitie, Result, and Trigger.

 

Documentation Description
Documentation Used to configure Documentation elements shown on Jobs. Documentation supports Markdown.
Link Used to configure hyperlinks for the Documentation of a Job or Folder.
Event Handler Description
Notification Job Used to configure a notification Job to run based on the completion severity or status of a Job
Recovery Job Configures a Recovery Job to run if the given Job completion does not exceed recovery severity.
Repeat Executes the same entry of the Job at a defined interval for a defined time window.
Resubmit Submits a new entry of the Job at a defined interval for a defined time window.
Runaway Determines when the Job becomes a Runaway Job, and what action is taken if the Job becomes Runaway.
Send E-Mail Used to an e-mail based on the completion severity or status of a Job.
Short Defines the minimum elapsed time for successful completion of a Job, and what action is taken if the Job does not meet that minimum time.
Stalled Defines the maximum elapsed time for the Job before it is considered stalled.
Prerequisite Description
Date Specific Dependency Requires that another Job completed on a natural-language specified date before this Job is allowed to start.
File Dependency A file that must be present, absent or available before this Job is allowed to start.
Job Dependency A Job that must satisfy the defined completion severity before this Job will be allowed to start.
Precheck Job A Job that must succeed before this Job will be allowed to start.
Remote Job Dependency A remote Job that must satisfy the defined completion severity before this Job will be allowed to start.
Resource Requirement A resource requirement that must be satisfied before this Job will be allowed to start.
Variable Dependency A variable dependency that must be satisfied before this Job will be allowed to start.
Time Window A time window where this Job will be allowed to start, and the action taken if the window is missed.
Result Description
CR Job Report Configures a CR Job Report to submit on completion of the Job.
Email Report Configures an Email Report to submit on completion of the Job
JDE Report Configures a JD Edwards Print Report to submit on completion of the Job.
MS Dynamics Email Report Configures a Microsoft Dynamics E-mail Report to submit on completion of the Job.
MS Dynamics File Report Configures a Microsoft Dynamics File Report to submit on completion of the Job.
MS Dynamics Print Report Configures a Microsoft Dynamics Print Report to submit on completion of the Job.
SSRS Print Report Configures an SSRS Print Report to submit on completion of the Job.
Trigger Description
File Trigger Triggers a Job to run based on the availability of a file or group of files. Users may define And Groups to require the presence of multiple files before the Job is triggered.
Job Completion Trigger Triggers a Job to run based on the completion severity of a defined Job Completion Trigger.
Mail Trigger Triggers a Job to run based on the receipt of a mail message.
Schedule Trigger Uses natural date language and comma separated date lists to trigger a Job to run. Users may define multiple Schedule Triggers on a single object.
Variable Trigger Triggers a Job to run when a variable is changed or set to a specific value.
       

 

Security
       

The Security tab acts as an access control list, capable of handling many Access Control Entries (ACE).

NOTE: In JAMS V7.0.1367 and later, removing all ACEs on an object behaves the same as Windows would. When all ACEs are removed from an object, only the GrantAdministratorsBypass group will have access to that object. Previously, removing all ACEs from an object would give all Authenticated Users access to that object.

While Jobs will inherit security from their Folder, a Job’s security setting may be configured to override any folder-level security.

Each ACE can specify the following rights on a Job:

 

History

This tab contains historical Job statistics and completion data broken down using a variety of performance measures.

NOTE: Using the Reset button in the History Tab will remove historical completion statistics and impact the percent completion calculations seen in the Monitor.

 

Properties

A list of Soft Properties are available below. These properties are available on any JAMS Job. Additional Soft Properties may be available depending on a Job's Execution Method.

Until a value is set for a property, it will not display in the Properties tab. To display a soft property, use the Add button in the Properties Tab, select the desired Property, then click OK in the Add Property dialog.

Completion Description
Bad Regex Pattern A regular expression pattern that indicates a failed execution.
Exit Code Handling Specifies how JAMS should evaluate a Job's exit code.
Good Regex Pattern A regular expression pattern that indicates a successful execution for this Job. 
Minimum Severity The minimum acceptable completion severity.
Retain Option Selects how the Job will be displayed in the Monitor after it completes. If set to Always, completed Jobs will never leave the Monitor.
Retain Time When the Retain Option is set to Timed, this property is used to specify (in minutes) the amount of time to display the completed Job in the Monitor.
Specific Informational A comma separated list of integer values for Informational Job completion exit codes.
Specific Values A comma separated list of integer for the Job completion exit codes.
Specific Warning A comma separated list of integer for Warning Job completion exit codes.
E-Mail Description
CC Address A comma separated list of e-mail addresses that will be cc'd on the e-mail. 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.
Message Body The body of the e-mail message. Users may enter Markdown language in the Message Body.
To Address A comma separated list of e-mail addresses that the e-mail will be sent to. You can remove inherited addresses by prefixing the address with a minus sign (-). You can remove all inherited addresses by entering -*.
Execute Description
Execute As Select the credentials this Job should use when executing.
SSRS Credentials The credentials that will be passed to the SSRS Server when executing.
Application This value is passed to the Win32 Create Process function as the value for the Application Name argument.
Command This value is passed to the Win32 Create Process function as the value for the Command Line argument.
Home Directory Specifies the full path to the initial current directory for the Job. 
Options Description
Force 32 Bit When set to true, this Job will run as a 32 bit process, even on 64 bit machines.
Force V2 When set to true, the Job will run using V2.0 of the .NET Framework.
No BOM When set to true, the Job's source file will not have a Unicode byte order mark.
OSPromptPattern A regular expression that will match the operating system command prompt.
Pass Parameters When set to true, Job parameters will be passed to a PowerShell Job as PowerShell parameters.
Schedule Description
Agent Used to specify the Agent where the Job will execute.
Batch Queue Specifies the batch queue for a Job.
Submit on Hold When enabled, this Job will enter the schedule in an "On Hold" status, requiring user input.
Submit Date The default Submit Date for this Job, when manually submitted.
Job Concurrent Limit The maximum number of instances of this Job that may execute concurrently.
Single Instance Action Defines the action to be taken if a Job tries to start while an instance of that Job is already running.
Status Description
Enabled This can be used to enable or disable a Job, Trigger or Event Handler.
General Description
Debug Determines if Job(s) will run in Debug Mode. When a Job runs in Debug Mode, it will not satisfy Dependencies or Triggers.
Include MS Dynamics Log If the Job is a MS Dynamics Job, indicates whether the Job will include MS Dynamics Job Logs.
Credentials Select a set of credentials from the drop-down list for the given object.
JDE Credential Credentials provided for JD Edwards Jobs within the Job or Folder. If this is not a JD Edwards Job, these credentials are not required.
CompletionBearing Determines the acceptable Completion Severity configuration for a Job.
DataType Determines the Data Type used for this object.
DefaultDate The default submit date used when this Job is manually submitted.
DefaultSubmitTime The default submit time to use when this Job is manually submitted.
Delete
File Transfer Agent The File Transfer Agent JAMS will connect to for this Job.
From The origin or sender of this object.
Interval The interval (in Delta Time) between checks for new mail on the defined mail server.
KeepLogs Determines whether the batch log files are deleted after the current Job completes. (Only applies to OpenVMS platforms).
LogFileName Displays or sets the Log File Name for this Job.
Log Location The default log location. This can include a filename and extension to set the default values.
MS Dynamics Credential The credentials to use when running a MS Dynamics Job.
Notify Severity The maximum completion severity required to send a notification.
Notify User Include the user that submitted the Job when sending notifications?
Options
Port Specifies the Port JAMS will attempt to connect to. Zero (0) is the default.
PrintLocation The directory where Print Files should be placed.
PrintQueue The Print Queue that will be used for Reports.
Protocol The protocol to use when connecting to a mail server. Typical mail server protocols include IMAP and POP3.
RemoteJobName The name of the Remote Job.
RemoteScheduler The name of the Remote Machine where the Remote Job executes.
Restartable Defines whether the Job can be restarted.
Retry Count Defines the maximum number of automatic retry attempts if the Job fails.
Retry Interval the interval, in Delta Time, between automatic retry attempts.
Run Priority The execution priority for the Job. A Job's Priority is the sum of the Job's priority AND priority values on parent folders.
Scheduling Priority The Scheduling Priority for the Job. 
Search Path A comma separated list of paths which are searched when trying to resolve relative references.
SLA Time The time of day a Job must complete by to meet a Service Level Agreement.
Submit Time The default Submit Time for the Job, when manually submitted.
Suppress Menu Display Defines if this Job should be omitted from Submit Menus. Set to False (unchecked) to display this Job on Submit Menus.
Template Library The full file specification that contains the JAMS Templates used when parsing the Job.
Timestamp Logs If enabled, batch log files will be timestamped with the extension format ".LOG_yyyymmdd_hhmmsscc".
To The destination or recipient of this object.
Host Key Checking Defines what JAMS should do if the SSH fingerprint does not match when connecting.
Accept Host Key An indicator that a host key is accepted
SSH Prompt A regular expression pattern to handle SSH prompts.
SSH Timeout The SSH connection timeout, defined in seconds.
SSL Cipher Suite Comma separated list of SSL Cipher Suites to allow.
SSL Version Comma separated list of the SSL Versions to allow.
SSL Minimum Key Size The minimum accepted key size. When set to zero (0), will default to 1024.
SSH Compression The compression level to use with the SSH connection.
SSH Minimum Key Size The minimum accepted decimal key size. When set to zero (0), will default to 1024.
SSH Mac Algorithm The SSH Mac Algorithm used.
SSH Key Exchange The SSH Key Exchange Algorithm used.
SSH Host Key The SSH Host Key Algorithm used.
SSH Encryption Comma separated list of SSH Encryption Algorithms used.
Documentation

The Documentation Tab displays the Documentation Elements assembled from the Job and any parent Folders.

Job Documentation may be edited from the Elements of the Job or Folder where the Documentation is inherited from.

 


 

 

See Also

Folders

Getting Started with JAMS 7.x

 

 


Copyright Help/Systems LLC and its group of companies.
All trademarks and registered trademarks are the property of their respective owners.

Topic updated: 2/27/2020

Send comments on this topic.