User Guide JAMS Scheduler 7.3 Copyright Terms and Conditions Copyright Help/Systems LLC and its group of companies. The content in this document is protected by the Copyright Laws of the United States of America and other countries worldwide. The unauthorized use and/or duplication of this material without express and written permission from HelpSystems is strictly prohibited. Excerpts and links may be used, provided that full and clear credit is given to HelpSystems with appropriate and specific direction to the original content. HelpSystems and its trademarks are properties of the HelpSystems group of companies. All other marks are property of their respective owners. 202108110755 JAMS 7.X User Guide Table of Contents JAMS 7.X Client Features 3 Jobs In JAMS 4 Working with Jobs 5-19 Scheduling Recurring Jobs 20-22 Execution Methods 23-27 Submitting Jobs Manually 28-29 Sequence Jobs 30-34 Managing Sequence Parameters 35-38 Sequence Tasks 39-47 Workflow Jobs 48-51 Workflow Activities 52-59 Migrating JAMS Objects 60-61 File Transfer Features 62-67 Variables 68 Working with Variables 69-71 Elements 72 Documentation Elements 73-74 EventHandler Elements 75-79 Prerequisite Elements 80-83 Result Elements 84-86 Trigger Elements 87-92 Folders 93 Working with Folders 94-104 Dates and Times 105 Date Properties 106-107 Creating Special Date Definitions 108-111 Specifying Dates Using Natural Language 112-114 Named Times in JAMS 115-118 Dashboards and Reports 119 Custom Dashboards 120-129 Creating New Report Templates and Customizing Existing Reports 130-131 Manually Generating Reports 132-133 Integrating Reports with Automated JAMS Jobs 134-135 SQL Server Reporting Services (SSRS) 136-137 Monitors and Views 138 1 JAMS 7.X User Guide Using the Monitor 139-142 Working with Projected Schedules 143-144 Resources, and Queues 145 Using Resources 146-147 Resource Properties 148-149 Using Queues 150 JAMS Scheduler Features 151 JAMS Scheduler Services 152-154 Configuring the JAMS Scheduler 155 Logon as Batch 156 Upgrading JAMS 157 Upgrading JAMS Using a Primary-Failover Environment 158 Upgrading JAMS 7.x 159-169 2 JAMS 7.X User Guide JAMS 7.X Client Features 3 JAMS 7.X User Guide Jobs In JAMS 4 JAMS 7.X User Guide 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. 5 JAMS 7.X User Guide 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 6 JAMS 7.X User Guide 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: Job Name - This property incorporates the unique identifier for a JAMS Job and is analogous to the filename for a command file. Description - This optional property appears in menus, lists and reports and provides a more detailed explanation for the current Job. Last Changed - The Last Changed property displays the user (Credential) who last modified this Job along with the date and time of the modification. 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. 7 JAMS 7.X User Guide 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 Command Shortcut Clipboard Copy CTRL+C, CTRL+INSERT Paste CTRL+V, SHIFT+INSERT Cut CTRL+X, SHIFT+DEL Select All CTRL+A File Operations Save As CTRL+S Open CTRL+O Printing Print CTRL+P Positioning Go to line CTRL+G Go to start CTRL+Home Go to end CTRL+End Search and Replace Find CTRL+F Find Next F3 8 JAMS 7.X User Guide Find Selected CTRL+F3 Replace CTRL+H Undo and Redo Undo CTRL+Z Redo CTRL+Y Bookmarks Toggle unnamed bookmarks CTRL+F2, CTRL+K->CTRL+K Go to next bookmark F2, CTRL+K->CTRL+N Go to previous bookmark F3, CTRL+K->CTRL+P Toggle named bookmark CTRL+[index of bookmark] Go to named bookmark CTRL+SHIFT+[index of bookmark] Tabs Add leading tab Tab with multiple line selection Remove leading tab SHIFT+Tab Outlining Switch on outlining and collapse all CTRL+M->CTRL+O Switch off outlining CTRL+M->CTRL+P Toggle outlining CTRL+M->CTRL+M White Space Show white space CTRL+SHIFT+W Note: the Source Editor text colors can be customized using a configuration file described in the following article: How to Customize the Source Editor. 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. 9 JAMS 7.X User Guide 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. 10 JAMS 7.X User Guide 4. Save and Close the Parameter Definition dialog. 5. Save and Close the Job 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 Description Type DataType Use the dropdown to specify a data type for the Parameter. Text Integer Date Time DateTime Float Unknown 11 JAMS 7.X User Guide Boolean Length If the Parameter's data type is set to Text or Integer, specify the maximum length within this property. User Description Interface Allow Entry When this attribute is enabled, the user can make an entry to 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.