Working with Folders
A JAMS Folder contains a group of Jobs. Folders can be defined to organize Jobs by department (Accounting, IS, Sales), by function (EDI, Web, Security, Audit), or any other way that is meaningful to your organization. The Folders can also be used to set default properties that will be inherited by Jobs below that point in the Folder hierarchy, unless overridden at a lower level. Security ACLs can also be defined and inherited in a similar way.
Folder Navigator screen
Within the Definitions shortcut, you can use the Folder Navigator to view, create, modify, or delete Folders in JAMS. Each Folder has a right-click menu that allows you to perform tasks.
Viewing All Folders
- Click Definitions from the Shortcuts menu.
- Under Folder Navigator, view the existing Folders.
Adding a Folder
- Click Definitions from the Shortcuts menu.
- In the Folder Navigator, right-click the parent Folder and select Add Folder.
- Enter a name for the Folder.
- Select the Edit the new Folder’s properties after adding checkbox.
- Click Ok.
- Click the Schedule tab to add/review any Schedule Items.
- Click the Properties tab to modify any Properties.
- Click the Parameter tab to add a Parameter.
- Click the Security tab to adjust the user accounts or groups that have access to the Folder.
- Click Save and Close.
Modifying a Folder
- Click Definitions from the Shortcuts menu.
- In the Folder Navigator, right-click the Folder and select Properties.
- Click the Schedule tab to add/review any Schedule Items.
- Click the Properties tab to modify any Properties.
- Click the Parameter tab to add a Parameter.
- Click the Security tab to adjust the user accounts or groups that have access to the Folder.
- Click Save and Close.
Deleting a Folder
You can delete an empty Folder if it is no longer being used. Any objects, including Jobs or other Folders, within the Folder must be removed before you can delete it.
- Click Definitions from the Shortcuts menu.
- In the Folder Navigator, right-click the Folder and select Delete Folder.
- When you are prompted to confirm the deletion, click Yes.
Resetting a Trigger
You can use the Reset Trigger option when the Folder has a Trigger with a Fired state. This is useful if the Trigger has been disabled due to reaching the Fast Fire Limit, which is the number of times a Trigger can fire. For example, you can select the Run this job based | on a file option from the Schedule tab, and the Job will run and will be set to the Fired state.
- Click Definitions from the Shortcuts menu.
- In the Folder Navigator, do one of the following:
- Right-click the Folder and select Reset Trigger.
- Double-click a Job and select the Schedule tab. Right-click the Trigger and select Reset Trigger.
Folder Definition Tabs
Folder
This tab contains basic Folder Information:
- Folder Name - This property is the unique identifier for the Folder.
- Description - The Description property can provide a more detailed explanation for the Folder. The Description property appears in menus, lists and reports.
- Last Changed - The Last Changed property displays the user who last modified this Folder, including the date and time of the modification.
- Reset Statistics - When a Job executes, it creates statistics based on the most recent run as well as the average of previous runs. The Reset Statistics button can be used when moving from a development to a production cycle to clear erroneous Job and Sequence statistics and begin with a clean slate.
Schedule
You can set several types of Schedule Items on a Folder. Any Jobs within the Folder will inherit these Schedule Items. However, you can override them at the Job-level. The Schedule tab has a natural language format to let you specify the options below. The + button lets you configure each option. See Schedules for more information.
| Option | Schedule Menu |
|---|---|
| Triggers | Run this job |
| Dependencies | This Job depends on a |
| Job Status | Set this Job's status to |
| Events and Notifications | When an event occurs |
Properties
The Soft Properties listed below are available for any JAMS Folder (or Job).
Until a value is set for a property, it will not display in the Properties tab. To display a soft property, use the + button in the Properties tab, select the desired Property, and then click OK in the Add Property dialog.
| Status | Description |
|---|---|
| Enabled | Select or clear the checkbox to enable or disable the property. |
| Schedule | Description |
|---|---|
| Agent | This property specifies the Agent where the Job will execute when the Job is submitted. |
| Batch Queue | This property specifies the Batch Queue that will be used when this Job is scheduled. |
| Calendar | This 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 Count | This property specifies the maximum number of retry attempts if the Job fails. |
| Retry Interval | This property specifies the time interval, in Delta Time, between automatic retry attempts. |
| Scheduling Priority | This 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.) |
| SLA Time | This property specifies the time of day a Job must complete by to meet a Service Level Agreement. |
| Submit on Hold | Select or clear this checkbox to submit the Job on Hold when it is scheduled. The Job will require manual intervention before it is allowed to run. |
| Suppress Menu Display | This property defines if this Job should be omitted from the Submit menus. Clear the checkbox to display this Job on the Submit Menus. |
| Execute | Description |
|---|---|
| Execute As | This property specifies the set of Credentials the Job will execute as when it is submitted. |
| Home Directory | This property specifies the full path to the initial current directory for the Job. |
| Debug | This 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 Credential | This 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 Credential | This property specifies the Credentials for third party add-ins, such as Banner, Oracle, or Peoplesoft. |
| Alternate Credential | This property specifies the alternate Credentials for a Job. |
| Crystal Reports Credential | This property specifies the Credentials that are used for Crystal Reports. |
| Force 32 bit | When 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 JAMS V6 to V7 migrations and it should not be adjusted on a V7 Execution Method. |
| Force V2 | When set to true, this Job will run using V2.0 of the .NET Framework. This option was included for backwards compatibility following JAMS 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 As | This 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 Credential | This property specifies the Informatica User to run the Job. |
| Informatica Polling Interval | This 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 Count | This property specifies the maximum number of automatic retry attempts for the Informatica Cloud REST calls. |
| Informatica Retry Interval | This property specifies the time interval, in Delta Time, between automatic retry attempts for Informatica Cloud REST calls. |
| Netezza Credential | This property specifies the Credential to use to log in to Netezza. |
| No BOM | Select or clear the checkbox to enable or disable the Job’s source file from having a Unicode byte order mark. |
| OS Prompt Pattern | This 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. |
| Oracle DB Credential | This property specifies the Credential for connecting to an Oracle database. |
| Oracle EBS Credential | This property specifies the Credential to use when running an Oracle EBS Job. |
| People Soft Credential | This property specifies the Credential to use when connecting to PeopleSoft. |
| Run Priority | This 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. |
| SQL Agent Credential | This property specifies the Credential for running SQL Agent Jobs. |
| SQL Stored Procedure Credential | This property specifies the Credential for running SQL Stored Procedure Jobs. |
| SSIS Credential | This property specifies the Credential for running SSIS Jobs. |
| SSRS Credentials | This property specifies the Credentials that are passed to the SSRS server when the Job is executing. |
| Search Path | This property specifies a comma-separated list of paths that are searched when trying to resolve references. |
| Z/OS Ftp Retry Interval | This property specifies the FTP retry interval between 500 and 5000 milliseconds. |
| Z/OS Max Ftp Retry | This property specifies the maximum number of retries between 1 and 100 for FTP exceptions while connected. |
| Z/OS Max Status Retry | This property specifies the maximum number of retries between 1 and 1000 to wait for the z/OS status response. |
| Z/OS Status Retry Interval | This property specifies the z/OS retry interval between 500 and 60000 milliseconds. |
| Job Concurrent Limit | This property specifies the maximum number of instances of this Job that may execute concurrently. |
| Single Instance Action | Select 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 Checking |
This 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:
|
| Accept Host Key | Select or clear the checkbox to accept or deny the Host Key. |
| Completion | Description |
|---|---|
| Notify E-Mail | Select the email addresses that are combined with the addresses in any email notification event. Email addresses from the Default Notify Email Address option in Configuration shortcut, the property on the Job, and the property on the Schedule Item are added if they are defined. |
| Bad Regex Pattern | This property specifies a regular expression pattern that indicates a failed execution. |
| Compare Condition | Select the type of comparison that will be performed. |
| Compare Value | This property sets the value that will be used in the comparison. |
| Completion Bearing | This property specifies the acceptable Completion Severity for a Job. |
| Exit Code Handling | Select 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 Pattern | This property specifies a regular expression pattern that indicates a successful execution for this Job. |
| Minimum Severity | Select the minimum acceptable completion severity. Available options include Success, Info, Warning, Error, and Fatal. |
| Notify User | Select or clear the checkbox or enable or disable including the user that submitted the Job when sending notifications. |
| Report Location | This property specifies the location for OpenVMS reports. |
| Retain Option | This 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 Time | Select 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 Informational | This property specifies a comma-separated list of integer values for Informational Job completion exit codes. |
| Specific Values | This property specifies a comma-separated list of integers for the Job completion exit codes. |
| Specific Warning | This property specifies a comma-separated list of integers for Warning Job completion exit codes. |
| Log | Description |
|---|---|
| Log Location | This property specifies the default location for a log file. |
| Include MS Dynamics Log | Select the checkbox to include MS Dynamics Job Logs. Clear the checkbox to exclude the MS Dynamics Job Logs. |
| Keep Logs | Select the checkbox to keep the batch log files when the Job completes on OpenVMS. Clear the checkbox to exclude the log files. |
| Timestamp Logs | Select 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. |
| MicroFocus | Description |
|---|---|
| MicroFocus Server | This property specifies the name of the MicroFocus Server. |
| MicroFocus Fin Port | This property specifies the port for the MicroFocus bin. |
| MicroFocus Submit Type | This property specifies the submit type for MicroFocus. The available options JES2, JES3, or VSE. |
| Source | Description |
|---|---|
| Template Library | This property specifies the full file specification that contains the JAMS templates that are used when parsing the Job. |
| Encoding | Description |
|---|---|
| Input Encoding | This property specifies the input encoding for the Job. You can enter character types, such as UTF-8 or ASCII. |
| Output Encoding | This property specifies the output encoding for the Job. You can enter character types, such as UTF-8 or ASCII. |
| Notify | Description |
|---|---|
| Halted Level | This property specifies the level that can be used by event handlers to classify events. |
| Halted Message | This property specifies the notification message when a Sequence is halted. |
| Halted Notify Event Class | Select the event class that this event will generate when it occurs. Available options include None, Normal, Low, Moderate, High, Urgent, and Critical. |
| Notify Other | This property specifies a comma-separated list of usernames and is merged with the list from the Folder Definition. |
| Notify User | This property specifies a comma-separated list of usernames in Active Directory. This list is merged with the list from the Folder Definition and used to find the email associated with the username. |
| Print Location | This property specifies the device and directory for reports that are produced by Jobs in this Folder. |
| Print Queue | The property specifies the default print queue for Jobs in this Folder. |
| SQL | Description |
|---|---|
| SQL Connection | This property specifies the Agent Definition that points to the SQL Server. |
| Automate | Description |
|---|---|
| Credentials | This property specifies the Credentials that are used to access the Automate server. |
| Banner | Description |
|---|---|
| Banner Connection | This property specifies the Banner Connection from the Connection Store. |
| Banner User | This property specifies the Credential for connecting to Banner. |
| Printer Name | This property specifies the name of the printer to use. |
| Banner Job Type | This property specifies the type of Banner Job to run. |
| Form Name | This property specifies the name of the Banner form to use. |
| Submit Time | This property specifies the submit time for the Banner Job. |
| Include .log File | Select the checkbox to include the Banner .log file in the JAMS Job Log. Clear the checkbox to exclude the .log file. |
| Banner Script Name | This property specifies that name of the Banner script to run. |
| Include .lis File | Select the checkbox to include the Banner .log file in the JAMS Job Log. Clear the checkbox to exclude the .log file. |
| Log File Polling Interval | This property sets the polling time for the Banner .log and .lis files. The default is 30 seconds. It is recommended that this value be set to a value that slightly exceeds the expected runtime of the Job. |
| MIME Type | This property specifies the type of file used to format reports/output files. Select PDF or Plain Text. |
| Special Print | This property specifies the field that may be used to pass information to 3rd-party applications. |
| PDF Font | This property specifies the type of font to use for PDF reports. |
| PDF Font Size | This property specifies the size of the font to use for PDF reports. |
| Environment Type | This property specifies the type of environment for the Banner instance to either Unix or Windows. By default, this option is set to Unix. If the Oracle database instance is running on Windows rather than Unix, set this option to Windows. |
| File Transfer | Description |
|---|---|
| Archiver Credentials | This property specifies the Credential to use when performing a zip operation on a file. |
| FTP Credentials | This property specifies the Credential for the FTP Job. |
| File Transfer Connection | This property specifies the Connection that JAMS will use for this Job. |
| SFTP User | This property specifies the Credential for an SFTP Job. |
| GoAnywhere | Description |
|---|---|
| GoAnywhere Credential | This property specifies the Credential that is used for connecting to GoAnywhere. |
| SAP | Description |
|---|---|
| SAP Connection | This property specifies the Connection that is used for connecting to SAP. |
Parameters
A JAMS Parameter contains a single slice of data that, unlike a Variable, remains exclusive to the associated Job or Folder. Parameters defined on a Folder are inherited by all objects in that Folder.
When submitting a Job with Parameters, you will see a fill-in-the-blank form to define values for these Parameters. 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 Folder may contain zero or more Parameters.
Add a Parameter
- Right-click a Folder and select Properties.
- Click the Parameters tab.
- Click +.
- Select Add Parameter.
- In the dialog, define the Parameter Name, Data Type, and Default Value of the Parameter.
- Click OK.
- Define additional Parameter Properties as desired.
- Click Save and Close.
- Click Save and Close on the Folder Definition dialog.
Parameter Properties
| Name | Description |
|---|---|
| ParamName | This property defines the name of the Parameter. Each Parameter name must be unique within a particular Job. |
| Data Type | Description |
|---|---|
| DataType |
Use the dropdown to specify a data type for the Parameter.
|
| Length | If the Parameter's data type is set to Text or Integer, specify the maximum length within this property. |
| User Interface | Description |
|---|---|
| Allow Entry | When this attribute is enabled, the user can enter this Parameter when submitting the Job. |
| HelpText | The entered text displays when a user hovers over the Parameter entry field on manual submissions. |
| Hide | This 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 Fill | When enabled, this attribute requires the user to completely fill this Parameter to its Maximum Length as set on the Data Type tab. |
| Prompt | When 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. |
| Required | When checked, this attribute requires users to enter a value for this Parameter. |
| Sequence | An integer is used to sort the Parameters when presented to end-users. |
| Uppercase | When checked, this attribute converts all entered data to uppercase. |
| ValidationData | This value is used when attempting to validate the Parameter value. |
| ValidationType |
This property allows you to select the type of validation JAMS can perform on the Parameter value. The validation types are:
|
| Value | Description |
|---|---|
| Default Format | This property is a format string that defines how the Parameter will be formatted. Default formats vary depending on the Parameter's Data Type. |
| Default Value | The 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. |
| Encrypt | Select the checkbox to encrypt the Parameter value. |
| Variable | Optionally, you can acquire the Default Value for the Parameter using a JAMS Variable. Use the File Browser button to search for and select an existing variable. |
References
The References tab lets you view which Jobs are referencing the Folder as well as where the Job is located.
Documentation
The Documentation tab lets you add more information to a Job. You can add an entry for a description or instructions or a link to an existing file. See Documentation Items for more information.
Security
The Security tab displays Properties that act as an access control list with one-to-many Access Control Entries (ACE) for the current Folder as well as for any Job contained within the Folder.
NOTE: Removing all ACEs on a JAMS object behaves the same as Windows would. When all ACEs are removed from an object, only the GrantAdministratorsBypass group will have access to the object. Previously, removing all ACEs from an object would give all Authenticated Users access to that object.
Each ACE can specify the following rights:
- Abort allows the user to access the JAMS Job Monitor to abort or restart an occurrence of a Job within the Folder.
- Add Jobs allows the addition of new Job definitions to this Folder.
- Change permits modification of the Folder definition provided the user also has Change access to Folder definitions.
- Change Jobs allows the modification of existing Job definitions in this Folder.
- Control permits modification of the current Folder’s Access Control List.
- Debug allows submission of Jobs within this Folder, 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 Folder Definition.
- Delete permits deletion of the current Folder definition provided the user also has DELETE access to Folder definitions.
- Delete Jobs allows the deletion of existing Job definitions within the Folder.
- Inquire permits inquiry into the current Folder definition provided that the user also has INQUIRE access to Folder definitions.
- Inquire Jobs permits inquiry into the current Folder definition as well as all contained Jobs.
- Manage allows the user to control the JAMS Job Monitor to hold, reschedule, release or delete an occurrence of a Job in this folder.
- Monitor allows Jobs to appear in the Job Monitor.
- Submit grants the right to submit a Job within the Folder.
Enable Inheritance
This dropdown property controls how the Folder inherits settings from its subfolders and Jobs. The inheritance options include:
- This folder only
- This folder, subfolders and jobs
- This folder and subfolders
- This folder and jobs
- Subfolders and jobs only
- Subfolders only
- Jobs only