Skip to main content

Jobs

Every component in JAMS supports or controls how a Job is defined or run. A JAMS Job includes Properties 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 to ensure that it executes at the right time and under the proper conditions.

Jobs Screen​

You can create, modify, or delete Jobs from the Jobs screen. The Jobs screen displays the Folder Navigator and Job Definitions. For each Job, you can view the following information by default:

  • Job Name – The name to identify the Job.
  • Enabled – The true or false setting to indicate if the Job can run automatically.
  • Description – The optional description to provide more information about the Job.
  • Method Name – The type of Execution Method that was selected for the Job.
  • Agent Name – The Agent that will be used to run the Job.
  • Execute As – The username that will be used to run the Job.
  • Last Change UTC - The date and time the Job was last changed based on UTC time.
  • Last Changed By – The user account that made the last change to the Job.

Adding a Job​

  1. Click Jobs from the main menu.
  2. Select a Folder from the Folder Navigator.
  3. Click Add from the top panel.
  4. In the Job Name field, enter a name for the new Job.
  5. In the Execution Method field, select an Execution Method for the Job from the drop-down list.
  6. If desired, give the Job a description.
  7. Click Save and Continue to Edit.
  8. Define the Job Source, Properties, and Security as desired.
  9. When the Job has been configured as desired, click Save.

Searching for a Job by Name​

The Job Search option lets you quickly locate a Job by entering a partial or full name, without manually expanding Folders or scrolling through the Job list. From the search results, you can navigate directly to a Job's edit page to view or modify it.

  1. Click Jobs from the main menu.
  2. Click Search Job Names in the toolbar at the top of screen.
  3. In the Filter field, enter the Job name and then click the magnifying glass icon .
    If the Job is found, it is displayed with its Folder path.
  4. Select the Job and click EDIT JOB. The Summary tab for the Job Definition is displayed.
  5. Make any edits as needed.
  6. Click Save.

Modifying a Job​

  1. Click Jobs from the main menu.

  2. Find the Job by selecting a Folder from the Folder Navigator or by using the Search Job Names option to search for the Job.

  3. Open the Job by doing one of the following:

    1. Click the name of the Job.
    2. Select the Job and then click Properties from the top panel.
    3. Select the Job and then click Properties from the Actions menu.

  4. Modify the Job, Source, Properties, and Security as desired.

  5. When the Job has been reconfigured as desired, click Save.

Deleting a Job​

  1. Click Jobs from the main menu.

  2. Find the Job by selecting a Folder from the Folder Navigator or by using the Search Job Names option to search for the Job.

  3. Delete the Job by doing one of the following:

    1. Select the Job and then click Delete from the top panel.
    2. Select the Job and then click Delete from the Actions menu.

  4. When you are prompted to confirm the deletion, click Delete.

Manually Submitting a Job to Run​

You can manually submit a Job to run from the Jobs screen. See Manually Submitting Jobs for more information.

Job Definition Tabs​

When you click a Job to open its properties, the Job has a standard set of tabs. Each tab is listed below.

Summary​

This tab includes basic Job information:

  • Folder – This property displays the name of the Folder where the Job is saved.
  • Job Name – This property displays the identifier for a JAMS Job and is like the filename for a command file. Please note the Job name must be unique to the Folder where it is saved.
  • Execution Method – This property displays the Execution Method that was selected for the Job.
  • Description – This optional property appears in menus, lists, and reports and provides a more detailed explanation for the current Job.
  • Last Change UTC – This property displays the date and time in UTC when the Job was last changed.

Source​

You can view or edit the source for the current Job. The Execution Method defines the type of interface that is displayed in this tab. The Source of a Job in JAMS can be a source code editor containing any number of code languages or a fill-in-the-blank style form. The source for many Execution Methods will be a source code editor that 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.

Properties​

A list of Properties is available below. These properties are available on any JAMS Job. Additional 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 property, use the ADD button in the Properties tab, select the desired Property, and then click Add in the Add Properties dialog.

StatusDescription
EnabledSelect or clear the checkbox to enable or disable the property.
ScheduleDescription
AgentThis property specifies the Agent where the Job will execute when the Job is submitted.
Batch QueueThis property specifies the Batch Queue that will be used when this Job is scheduled.
CalendarThis property specifies the Calendar to use for scheduling. When a Calendar is listed, the Job will have access to the Date Types, such as holidays, in the Calendar.
Retry CountThis property specifies the maximum number of retry attempts if the Job fails.
Retry IntervalThis property specifies the time interval, in Delta Time, between automatic retry attempts.
Scheduling PriorityThis property specifies the priority the Scheduler uses in determining when to start executing Jobs that are waiting on prerequisites. The first number indicates the inherited value from the parent object. (The default is 0.)
Default Submit DateThis property specifies the submit date used when the Job is manually submitted.
Default Submit TimeThis property specifies the submit time used when the Job is manually submitted.
RestartableThis property defines if the Job can be restarted after a failure.
SLA TimeThis property specifies the time of day a Job must complete by to meet a Service Level Agreement.
Submit on HoldSelect or clear this checkbox to submit the Job on Hold when it is scheduled by this Trigger. The Job will require manual intervention before it is allowed to run.
Suppress Menu DisplayThis property defines if this Job should be omitted from Submit Menus. Clear the checkbox to display this Job on the Submit Menus.
ExecuteDescription
Execute AsThis property specifies the set of Credentials the Job will execute as when it is submitted. This property is required for the Job to run properly.
Home DirectoryThis property specifies the full path to the initial current directory for the Job.
DebugThis property specifies if a Job will run in Debug Mode. When a Job runs in Debug Mode, it will not satisfy Dependencies or Triggers.
JDE CredentialThis property specifies the Credentials provided for JD Edwards Jobs within the Job or Folder. If this is not a JD Edwards Job, these credentials are not required.
Add-In CredentialThis property specifies the Credentials for third party add-ins, such as Banner, Oracle, or Peoplesoft.
Alternate CredentialsThis property specifies the alternate Credentials for a Job.
Crystal Reports CredentialThis property specifies the Credentials that are used for Crystal Reports.
Force 32bitWhen set to true, this Job will run as a 32 bit process, even on 64 bit machines. This option was included for backwards compatibility following V6 to V7 migrations and it should not be adjusted on a V7 Execution Method.
Force V2When set to true, this Job will run using V2.0 of the .NET Framework. This option was included for backwards compatibility following V6 to V7 migrations and it should not be adjusted on a V7 Execution Method. For more information, see Resolving Mixed Mode Assembly error message in PowerShell.
Host AsThis property specifies the Host As Credentials for some Execution Methods that start a host process. The Credentials connect to the Agent server using the Execute As Credentials.
Informatica CredentialThis property specifies the Informatica User to run the Job.
Informatica Polling IntervalThis property specifies the time interval, in Delta Time, between the automatic retry attempts for the Informatica Cloud Activity Log Status update REST call.
Informatica Retry CountThis property specifies the maximum number of automatic retry attempts for the Informatica Clous REST calls.
Informatica Retry IntervalThis property specifies the time interval, in Delta Time, between automatic retry attempts for Informatica Cloud REST calls.
Netezza CredentialThis property specifies the Credential to use to login in to Netezza.
No BOMSelect or clear the checkbox to enable or disable the Job’s source file from having a Unicode byte order mark.
OS Prompt PatternThis property specifies the regular expression that will match the operating system command when using the SSHPrompt Execution Method. This property sets the format of the prompt that JAMS is looking for, so it can recognize it and send the commands.
People Soft CredentialThis property specifies the Credential to use when connecting to PeopleSoft.
Run PriorityThis property specifies the execution priority for the Job. The priority is the sum of the Job’s priority and any priority value on the parent Folder.
Search PathThis property specifies a comma-separated list of paths that are searched when trying to resolve references.
SQL Agent CredentialThis property specifies the Credential for running SQL Agent Jobs.
SQL Stored Proc CredentialThis property specifies the Credential for running SQL Stored Procedure Jobs.
SSIS CredentialThis property specifies the Credential for running SSIS Jobs.
SSRS CredentialsThis property specifies the Credentials that are passed to the SSRS server when the Job is executing.
z/OS Ftp Retry IntervalThis property specifies the FTP retry interval between 500 and 5000 milliseconds.
z/OS Max Ftp RetryThis property specifies the maximum number of retries between 1 and 100 for FTP exceptions while connected.
z/OS Max Status RetryThis property specifies the maximum number of retries between 1 and 1000 to wait for the z/OS status response.
z/OS Status Retry IntervalThis property specifies the z/OS retry interval between 500 and 60000 milliseconds.
Job Concurrent LimitThis property specifies the maximum number of instances of this Job that may execute concurrently.
Single Instance ActionSelect an option to define the action to be taken if a Job retries to start while an instance of that Job is currently running. Options include Allow Multiple, Cancel Executing, Cancel Pending, and Wait.
Host Key CheckingThis property specifies the action JAMS should take if the SSH fingerprint does not match when connecting to an SSH server. You can enter the following options:
  • AcceptHostKey: Accepts the host key and adds the fingerprint to the cache of acceptable fingerprints. (This is not secure. Only use if you are sure of the identity of the server.)
  • CheckParameter: Checks for a boolean parameter named AcceptHostKey and accepts the key if the parameter value is true.
  • FailFirstJob: Fails the first Job and adds the fingerprint to the cache of acceptable fingerprints. (Default setting)
Accept Host KeySelect or clear the checkbox to accept or deny the Host Key.
CompletionDescription
Notify E-MailSelect the email addresses that are combined with the addresses in any email notification event.
Bad Regex PatternThis property specifies a regular expression pattern that indicates a failed execution.
Cancel When ShutdownSet this property to true to have any executing instances of this Job be canceled when the JAMS Executor service is stopped.
Compare ConditionSelect the type of comparison that will be performed.
Compare ValueThis property sets the value that will be used in the comparison.
Completion BearingThis property specifies the acceptable Completion Severity for a Job.
Exit Code HandlingSelect the method for how JAMS should evaluate a Job's exit code. Available options include ZeroIsGood, OneIsGood, PositiveIsGood, OddIsGood, EvenIsGood, SpecificGood, and SpecificBad.
Good Regex PatternThis property specifies a regular expression pattern that indicates a successful execution for this Job.
Minimum SeveritySelect the minimum acceptable completion severity. Available options include Success, Info, Warning, Error, and Fatal.
Notify UserSelect or clear the checkbox or enable or disable including the user that submitted the Job when sending notifications.
Report LocationThis property specifies the location for OpenVMS reports.
Retain OptionThis property specifies how the Job will be displayed in the Monitor after it completes. If set to Always, completed Jobs will never leave the Monitor.
Retain TimeSelect the method for displaying the Job in the Monitor when it completes. Available options include Default, Timed, Error, and Always. 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 InformationalThis property specifies a comma-separated list of integer values for Informational Job completion exit codes.
Specific ValuesThis property specifies a comma-separated list of integers for the Job completion exit codes.
Specific WarningThis property specifies a comma-separated list of integers for Warning Job completion exit codes.
IntervalDescription
Status Check IntervalThis property sets the time interval in seconds between status checks.
LogDescription
Include MS Dynamics LogSelect the checkbox to include MS Dynamics Job Logs. Clear the checkbox to exclude the MS Dynamics Job Logs.
Keep LogsSelect the checkbox to keep the batch log files when the Job completes on OpenVMS. Clear the checkbox to exclude the log files.
Log FilenameThis property specifies the default name for a log file.
Timestamp LogsSelect the checkbox to add a timestamp to batch log files with the extension format “yyyyMMdd_HHmmssfff.log”. Clear the checkbox to not add the timestamp.
MicroFocusDescription
MicroFocus ServerThis property specifies the name of the MicroFocus Server.
MicroFocus Bin PortThis property specifies the port for the MicroFocus bin.
MicroFocus Submit TypeThis property specifies the submit type for MicroFocus. The available options are JES2, JES3, or VSE.
SourceDescription
Template LibraryThis property specifies the full file specification that contains the JAMS templates that are used when parsing the Job.
EncodingDescription
Input EncodingThis property specifies the input encoding for the Job. You can enter character types, such as UTF-8 or ASCII.
Output EncodingThis property specifies the output encoding for the Job. You can enter character types, such as UTF-8 or ASCII.
AzureDescription
Azure ConnectionThis property stores to the Connection Store item for connecting to Azure.
Azure CredentialThis property stores the client secret value used to authenticate to Azure.
NotifyDescription
Halted LevelThis property specifies the level that can be used by event handlers to classify events.
Halted MessageThis property specifies the notification message when a Sequence is halted.
Halted Notify Event ClassSelect the event class that this event will generate when it occurs. Available options include None, Normal, Low, Moderate, High, Urgent, and Critical.
Notify OtherThis property specifies a comma-separated list of usernames. This list is merged with the list from the Folder Definition.
Notify UsersThis property specifies a comma-separated list of usernames in Active Directory. This list is merged with the list from the Folder Definition.
Print LocationThis property specifies the device and directory for reports that are produced by Jobs in this Folder.
Print QueueThe property specifies the default print queue for Jobs in this Folder.
SQLDescription
SQL ConnectionThis property specifies the Agent Definition that points to the SQL Server.
AirflowDescription
Airflow ConnectionThis property stores to the Connection Store item for connecting to Airflow.
Airflow CredentialThis property stores to the secrets used to authenticate to Airflow.
Airflow Status Check IntervalThis property sets the time interval in seconds between status checks.
Amazon EC2Description
Amazon EC2 ConnectionThis property stores to the Connection Store item for connecting to an Amazon EC2 instance.
Amazon EC2 CredentialThis property stores to the secrets used to authenticate to an Amazon EC2 instance.
Amazon EC2 Instance IdThis property stores to the Amazon EC2 Instance Id.
Amazon EC2 RegionThis property stores to the Amazon EC2 Region.
AutomateDescription
Automate CredentialThis property specifies the Credentials that are used to access the Automate server.
Azure BlobDescription
Azure Blob ConnectionThis property stores to the Connection Store item for connecting to an Azure Blob.
File TransferDescription
Archiver CredentialsThis property specifies the Credential to use when performing a zip operation on a file.
File Transfer ConnectionThis property specifies the Connection that JAMS will use for this Job.
FTP CredentialThis property specifies the Credential for the FTP Job.
SFTP UserThis property specifies the Credential for an SFTP Job.
GoAnywhereDescription
GoAnywhere CredentialThis property specifies the Credentials that are used to connect to a GoAnywhere server.

Parameters​

A JAMS Parameter contains a single slice of data that (unlike a Variable) remains exclusive to the associated Job or Folder. A JAMS Job may contain zero or more Parameters. When JAMS interactively submits a Job with Parameters, a fill-in-the-blank form is displayed to define values for these Parameters. Once the Parameter is configured in the Job definition, it can be specified in the Source tab.

By default, the Parameters are displayed in the order they were created. However, you can change the order as described in the section below.

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.

Adding a Parameter​

  1. From the Jobs screen, click the name of a Job to open its properties.
  2. Click the Parameters tab.
  3. Click ADD from the top right corner of the Parameters table. An Add a New Parameter screen is displayed.
  4. In the Parameter Name field, enter a name for the Parameter.
  5. In the Data Type field, select the type/format of the Parameter. For example, you can select Text or Boolean.
  6. In the Default Value field, enter a default value.
  7. Click Save and Continue to Edit.
  8. Define additional Parameter Properties as desired. See the table below for more information on the available options.
  9. Click Save.

Modifying a Parameter​

  1. From the Jobs screen, click the name of a Job to open its properties.

  2. Click the Parameters tab.

  3. Do one of the following:

    • Under the Parameter Name field, click the name of the Parameter to edit it.
    • Click a row in the table and click PROPERTIES from the top right corner of the Parameters table.
    • Click a row in the table, click the under the Actions column, and select Properties.

  4. Define additional Parameter Properties as desired. See the table below for more information on the available options.

  5. Click Save.

Changing the Order of the Parameters​

You can reorder the list of Parameters, so they are displayed in the desired order.

  1. From the Jobs screen, click the name of a Job to open its properties.

  2. Click the Parameters tab.

  3. Do one of the following:

    • Click a row in the table and click REORDER from the top right corner of the Parameters table.
    • Click a row in the table, click the under the Actions column, and select Reorder.

  4. Drag and drop the listed Parameters to reorder them.

  5. Click Save.

Deleting a Parameter​

  1. From the Jobs screen, click the name of a Job to open its properties.

  2. Click the Parameters tab.

  3. Do one of the following:

    • Click a row in the table and click DELETE from the top right corner of the Parameters table.
    • Click a row in the table, click the under the Actions column, and select Delete.

  4. When you are prompted to confirm the deletion, click Delete.

  5. Click Save.

Parameter Properties​

NameDescription
Parameter NameThis property defines the name of the Parameter. Each Parameter name must be unique within a particular Job.
ValueDescription
Default FormatThe format string that defines how the Parameter will be formatted. Default formats vary depending on the Parameter's Data Type.
Default ValueThe property specifies the default value for this Parameter. The default value for dates may be entered as a specific date or you can use JAMS English language date text such as Today, Last Monday, or First Monday of Month.
EncryptSelect the checkbox to encrypt the value of the Parameter.
VariableOptionally, you can acquire the Default Value for the Parameter using a JAMS Variable. Use the Browse button to search for and select an existing variable.
DataTypeDescription
DataTypeUse the drop-down to specify a data type for the Parameter.
  • Text
  • Integer
  • Date
  • Time
  • DateTime
  • Float
  • Unknown
  • Boolean
LengthIf the Parameter's data type is set to Text or Integer, specify the maximum length within this property.
User InterfaceDescription
Allow EntryWhen this attribute is enabled, the user can make an entry to this Parameter when submitting the Job.
HelpTextThe entered text displays when a user hovers over the Parameter entry field on manual submissions.
HideThis attribute determines if the Parameter is displayed when this Job is submitted. If you have "Manage" access to the current Job, hold down the ALT key when submitting the Job and all hidden Parameters will be displayed.
Must FillWhen enabled, this attribute requires the user to completely fill this Parameter to its Maximum Length as set on the Data Type tab.
PromptWhen a Job is interactively submitted, a form is created which is used to prompt the user for the Job’s Parameter values. The entered text represents the prompt to the user submitting the Job.
RequiredWhen checked, this attribute requires users to enter a value for this Parameter.
SequenceA read-only integer used by the system to calculate the sort order of the Parameters when presented to users when submitting a Job.
UppercaseWhen this option is checked, all entered data is converted to uppercase.
ValidationDataThe value used when attempting to validate the Parameter value.
ValidationTypeThis property allows you to select the type of validation JAMS can perform on the Parameter value. The validation types are:
  • None: No validation is performed.
  • Directory: This validation is used on text parameters. A button is placed next to the parameter's text box that opens a dialog allowing the user to browse the file system for a directory.
  • SaveFile: This is used on text parameters. A button is placed next to the parameter's textbox that opens a dialog allowing the user to browse for a file, which may or may not exist.
  • OpenFile: This is used on text parameters. A button is placed next to the parameter's textbox that opens a dialog allowing the user to browse the file system for a file, which must exist.
  • MaskedEdit: This validation type uses a mask to distinguish between proper and improper user input. The mask is set in the Validation Data property.
  • Range: This validation type is used to validate Parameter values based on a defined range. For example, you can set the Range as 0-10 for the Integer Parameter. The Job submission requests the Parameter value, and if the value is outside 0-10, an alert message about an incorrect Parameter value appears in the Submit screen.
  • Regex: This validation type allows for validating Parameter values using a regex expression. For example, you can enter the expression "^[0-9]*$" as the Validation Data. In this case, only numbers will be allowed as a Parameter value.
  • Select: This option is used for displaying the values from the Validation Data field as a drop-down list.

History​

The History tab displays information about the most recent executions of the Job. This includes the Status, Job Name, Entry ID, Final Severity, and the Final Status from the Job entry. The default is 90 days, but this can be configured in the History Lookback Period property on the Configuration screen. See Configuration for more information.

References​

The References tab lets you view which objects are referencing a Job as well as where they are located.

PropertyDescription
TypeThis property lists the type of object in JAMS that is using the Job.
Referring NameThis property lists the name of the object in JAMS that is using this Job. For example, this field can list the name of a Job.
Folder PathThis property displays the path to the Folder that contains the object that is using this Job.
Element TypeThis property displays the type of internal element for the object that is using this Job.
Property NameThis property displays the area where the object is used. This can include TriggerJob, DependsOnJob, or SinceJob.
DescriptionThis property displays the optional description of the object that is using this Job.

Security​

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

note

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 from the drop-down arrow for the ACE:

  • Abort: allows the user to access the JAMS Job Monitor to abort or restart an occurrence of this Job.
  • Change: permits modification of the Job’s definition provided the user also has Change access to Job Definitions, which is located in the Access Control list.
  • Control: permits modification of the current Job’s Access Control List.
  • Debug: allows submission of this Job, but only if the /DEBUG qualifier is used on the JAMS SUBMIT command. This qualifier submits the Job under the submitter's username rather than the username specified in the Job or Folder Definitions.
  • Delete: permits deletion of the current Job definition provided the user also has Delete access to Job Definitions.
  • Inquire: allows inquiry into the current Job definition provided that the user also has Inquire access to Job Definitions.
  • Manage: permits the user to use the JAMS Job Monitor to hold, reschedule, release or delete an occurrence of the current Job.
  • Monitor: allows the current Job to appear in the Job Monitor.
  • Submit: grants the right to submit the current Job.

Statistics​

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

note

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

Completion​

The Completion tab displays the latest completion date and time for each completion type for the Job.