Cisco Tidal Enterprise Scheduler 6.2 User Guide

Overview

Before you can run TES, you need to run through the licensing procedure. This applies whether you are just trying out the software, or have already decided to implement TES. TES provides different types of licenses to fit your needs.

Note Ensure that your database is licensed in line with your database vendors licensing terms and conditions.

Extensions and modules that add extra functionality to TES may require separate licenses. For example, SACmd (TES command line interface), the job monitoring tool and intermaster dependencies all require individual licenses. For more information and current availability, contact your sales representative.

You can license TES with a Demo license or a Full license. During installation, the installer will prompt you for a demo code, and if you give it a code, then it will create this file for you. When your Demo license expires, or if you did not enter it during installation, you can manually license TES.

Master License Tab

This tab displays the following information about the master:

• Company Name – Your company name. No company name displays if you have a demo license. The company name displayed here is used in all Tes reports.
• Master License for machine – The licensed master machine name.
• Serial Number – The unique identification number of the master machine.
• Operating System – The operating system of the Tes master machine.
• Database – The type of database used. This field will show either Oracle or Microsoft SQL Server.
• Expiration – The license’s expiration date. You may need to renew your license before the expiration date.
• Options – Displays added purchased software options that complement Tes (e.g. fault tolerance).
• Connections – Contains the available connections associated with the license.

Licensed Agents Tab

The Licensed Agents tab displays information about the agents licensed to work with the master.

Note If your license has a floating agent provision or if you are running an unrestricted demo, you can define your own agents. Consequently, the Licensed Agents tab will display no information.

This tab displays the following information about the agents:

• Agent – The machine name for the licensed agent.
• Serial – The serial number of the licensed agent.
• Floating – Specifies if the license is floating or not.
• Operating System – The operating system type of the licensed agent. Tes supports MPE/iX, MVS, z/OS, OS/400, Windows and Unix platforms.
• Expiration – The license’s expiration date. You may need to renew your license before the expiration date.
• Max Jobs – The maximum number of jobs that you can run on the agent concurrently. You can configure a lower value for the agent from the Connections pane, but this value cannot exceed your licensed value.
• Jobs – Displays the current count of jobs, tracking the number of jobs to enforce the license restriction on an agent as shown in the Max Jobs column.
• CPU – The number of CPUs on an agent machine. If the number of CPUs on a machine exceeds the authorized number, the master disables the agent connection and logs a licensing error. The licensing discrepancy must be resolved by contacting the Licensing Administrator for Tidal Software before the agent connection can be re-established.

Warning Restart the Client Manager after a new license has been loaded.

Main Menu Bar

The Main Menu bar is accessible from any pane. However, some menu options are not available from all panes.

For more information about the main menus, see Main Menus.

Note Context menus, available when you right-click the Navigator pane or current pane, are context-sensitive. The menus change according to your current, active pane.

Navigator Pane

The Navigator pane lists all the components of the Tidal Web client in a hierarchal format. Each TES function has a different pane.

An arrow sign next to a folder indicates that there are folders hidden underneath. Click the plus sign to expand the listing. A solid arrow sign next to a folder indicates that the listing is expanded. Click the minus sign to collapse the listing.

This panel contains the following containers:

• Operations – A container for the Job Activity , Event Activity , Alerts , Logs , Schedules and Master Status panes. These panes are dynamic, displaying data that continually changes. TES updates the information in the pane to provide an accurate picture of the current state of your productions operations.
• Definitions – A container for the Jobs , Calendars , Actions , Events , Job Classes , Variables , Agent Lists , Queues , Resources and Fiscal Calendars panes. These panes list the definitions for various items that you create through TES .

In addition, Actions , Events and Agent Lists both have sub-panes that correspond to different types of actions, events and agent lists.

• Administration – A container for the Connections , Interactive Users , Runtime Users , LDAP Groups , Workgroups , Security Policies and Adapters panes. These panes concern the administration of your TES network and TES users.

Current Pane

The console pane that is currently active is considered the current pane.

Main Menus

File Menu

The File main menu has the following options:

• Images Repository – Displays the Images Repository tab. This tab allows for the selection of an alternative icon for a job or group. This image is displayed on the Jobs pane or Business Views window.
• Print – Displays the Reports pane to view and print the TES report that corresponds to the current pane.

Note The Print option on the File menu provides the same functionality as the Print button on the TES toolbar.

• Log Out – Logs you out of the Tidal Web client.

View Menu

The View main menu has the following options:

• Show Master Feedback – Displays or hides a confirmation dialog whenever a request is sent to the master.
• Auto Refresh – Automatically refreshes the Tidal Web client.
• Refresh – Updates all of the information in the TES database.
• Preferences – Displays the Preferences dialog for the current pane. The Preferences dialog is used to configure a pane. For more information about a Preferences dialog, see the documentation for the pane you wish to configure.

Activities Menu

The Activities main menu has the following options:

• Create Schedule – Displays the Create Schedule dialog to manually recreate a schedule for selected days.

Note After selecting Create Schedule, a dialog denotes the success or failure of the compilation.

• Insert Job Into Schedule – Inserts an unscheduled job into the schedule. (This option is only applicable if the job or group’s definition has the Unscheduled Allowed option set.)
• Pause Scheduler – Pauses the TES until you select the Resume Scheduler option. This is especially helpful when making changes or at other times when you need a temporary interruption of service.
• Resume Scheduler – Resumes TES after pausing TES.
• Pause Job Launching – Pauses job launching until you select the Resume Job Launching option. Jobs can be defined and scheduled but they cannot run until job launching resumes.
• Resume Job Launching – Resumes job launching after it is paused.
• Start Today’s Schedule – If the master was configured to wait until the previous schedule completes before starting a new schedule (on the Master tab of the System Configuration dialog), selecting this menu option overrides that setting and starts the new schedule whether the previous production schedule completed or not.
• Shutdown Scheduler – Stops the master service. Your master will be down until you restart the master service from either the Tidal Service Manager for a Windows master or from the command line for a Unix master. This option is only available to authorized users. For more information about the Tidal Service Manager , see Tidal Service Manager.
• System Configuration – Displays the System Configuration dialog. You can change system-wide parameters such as defaults, mail, logging options and master properties from this dialog.
• Register License – Displays the License Registration dialog.
• End Impersonation – Ends the impersonation of another user.

Reports Menu

See Reports Pane for more information about the Reports main menu Job Last Status , Schedule Summary , Dependency Cross Reference and Event History selections.

Help Menu

The Help main menu has the following options:

• Help Topics – Displays the online help file for TES .
• About – Displays copyright information about the TES version.

Search Field

Enter text that you want to search for within the columns displayed.

Note This field at the top right of the grids will only search text columns that are not grayed out and are string-based. See Searchable Columns below.

Searchable Columns

The following table contains all columns that are searchable.

Create Schedule Dialog

The Create Schedule dialog displays by selecting Activities>Create Schedule from the main menu bar. You can also right-click in the Schedules pane and select the Create Schedule option (and other options) from the context menu to recompile a schedule but the options in the context menu do not provide as much control when creating a schedule. It is recommended to use the Create Schedule dialog when creating a schedule.

Use the Create Schedule dialog to recreate the production schedule invoking the compilation process for the dates specified. Only jobs whose calendars include the date(s) specified are included in the schedule.

This dialog contains the following elements:

• From – First date to include in the schedule.
• To – Last date to include in the schedule.
• Forecast Only – If selected, the master will recompile your schedule for the specified date. By default, the forecast date is tomorrow. A forecast is a schedule created as a model of what a potential production schedule may be. The forecast schedule is never used, as the master recompiles the production schedule at the beginning of the production day.

A forecast schedule is not automatically updated when jobs are modified. If a job within the forecast schedule is modified, the job’s runs within the forecast are deleted rather than modified. The information contained within the forecast schedule is only relevant for the moment that it was created. You must recompile a new forecast schedule to account for modifications to any job parameters since the original forecast was created. The production schedule is recompiled at the beginning of each production day for this reason.

• For today’s repeating jobs with no time window, start repeating ASAP – Normally repeating jobs with no time window begin at midnight. If you create the schedule after midnight, a portion or all of the repeating jobs may be excluded from the schedule unless you select the For today’s repeating Jobs with no time window, start repeating ASAP option. By choosing this option, all repeating occurrences are added. If you select this option, all repeating instances are added to the schedule and begin repeating as soon as possible.

For example: If a job repeats every five minutes, for a total of five times, and no time window is specified for the job, the job will normally run immediately after the automatic compilation at midnight. The result would run separate job occurrences at 12:00 AM, 12:05, 12:10, 12:15 and 12:20. If you manually create the schedule after 12:20 without this setting checked, none of the occurrences will be added to the schedule.

By selecting the For today’s repeating Jobs with no time window, start repeating ASAP option, all five occurrences will run after the schedule is re-created. For example, if you create the schedule at 4:00 PM, separate occurrences run at 4:00 PM, 4:05, 4:10, 4:15 and 4:20.

Job Activity Pane

The Job Activity pane is the key to monitoring and controlling job operations. Within the bounds of your security policy, you can view either the jobs and job groups that are owned by you and owned by any workgroups to which you belong or all the jobs and job groups on the master. For detailed information about the Job Activity pane , see Job Activity Pane Interface.

To display the Job Activity pane, select Operations>Job Activity from the Navigator pane.

Context Menu

Right-clicking in the Job Activity pane displays a context menu providing easy access to job control functions.

Display Customization

The Job Activity pane display can be customized to suit your monitoring needs. You can:

• Sort jobs alphabetically by any column or intelligently by a status order you specify.
• Filter jobs by job status, job name, agent assignment or owner. This can be used to view only the job occurrences that are important to you.
• Modify column widths to accommodate long or short text.
• Modify pane sizes. You can adjust any pane to accommodate the desired information.

Job Control

From the Job Activity pane , you can perform job control functions (rerun a job, check dependencies, hold a job, etc.). For example, if a job requires Operator release (such as when the job must ensure that an external resource is free before the job starts), you (as the Operator) can manually release the job from the Job Activity pane using the Release control command.

Connections Interface

From the Navigator pane, select Administration>Connections to display the Connections pane.

The Connections pane contains the following buttons:

• Add Connection – Displays a list of connection options. Selecting which type of connection to define opens the appropriate Connection Definition dialog for that connection.
• Edit Connection – Displays the Connection Definition dialog to edit an existing connection.

Note You must select a connection for the Edit and Delete connection buttons to activate in the Connections pane. If no connection is selected, these buttons are grayed out.

• Delete Connection – Removes the selected connection definition from the TES database.
• Refresh – Updates the data in the current pane.
• Print – Displays the Reports pane to view and print the connection definitions. For more information, see Monitoring Production .

The Connections pane contains the following columns:

• Status Light – The status light indicates the status of the connection.

– A green light indicates that the connection is healthy (but does not indicate whether a fault tolerance failover occurred).

– A yellow light in front of the backup master is normal when in fault tolerant mode and indicates that the backup master is in standby mode. A yellow status light also temporarily displays when a master first starts up but changes to green as the master comes online.

– A red light indicates that the connection has failed.

– A gray light indicates that a connection is disabled.

• Name – The name of the agent or master connection.
• Machine – The name of the computer where the component resides.
• Type – Indicates the type of connection, whether an agent, adapter, master, backup master, remote master or fault monitor.
• Platform – The operating system or type of adapter of the connection.
• Enabled – Indicates if the connection is enabled.
• Modified – Indicates the last time the connection definition was modified.
• Load – Indicates the percentage of the agent machine's CPU capacity currently being used.
• Time Difference

– If Type = Master , the number of minutes of difference between the master and the Client Manager.

– If Type = Agent , the number of minutes of difference between the master and the agent from the point of view of the master.

– If Type = Remote Master , the number of minutes of difference between the local master and the remote master.

• Floating – Indicates if the component has a floating or non-floating license.
• Active – Only applies to agents; indicates if the agent is active or not.
• Limit – Indicates the number of jobs the component is licensed to run simultaneously.
• Version – Indicates the version number of the listed component.
• Out Until – If the connection is offline on a scheduled basis, this column displays the time when the outage pane will end. This column is blank if no scheduled outage is occurring.
• Time Available – If the connection is scheduled to be offline, this column displays the number of minutes remaining before the outage pane begins. This column is blank if there is no scheduled outage.

Search Field

Enter text that you want to search for within the columns displayed into this field.

Note This field at the top right of the grids will only search text columns that are not grayed out and are string-based. See Searchable Columns.

Connections Preferences Dialog

From the main menu, select View>Preferences while viewing the Connections pane to display the Connections Preferences dialog.

From the Connections Preferences dialog, you can select which columns display in the Connections pane and arrange the order they appear.

• A checkmark to the left of a column title indicates that the column will be displayed in the pane. No checkmark indicates that column will not be displayed.
• To rearrange the order in which the columns are displayed, select the column and click the up or down arrow.

Navigator Context Menu

When you right-click in the Navigator pane while viewing the Connections pane, the Navigator context menu displays.

The Connections Navigator context menu contains the following options:

• Add Connection – Displays a list of the different connection types that can be defined. Has the same function as the Add Connection button. Selecting an option from the list displays the appropriate Connection Definition dialog for that connection.
• Preference – Displays the Preferences dialog for the Connections pane.
• Print – Displays the Reports pane to view and print your connection definitions. Has the same function as the Print button on the toolbar. For more information, see Monitoring Production .
• Export – Saves the data in the current pane as an HTML file.
• Refresh – Updates the data in the current pane.
• New Root Folder – Allows you to create a new root folder for the Navigator pane.

Connections Pane Context Menu

When you right-click in the Connections pane, the Connections pane context menu displays.

Note A connection must be selected in order for the Edit and Delete options to be available in the context menu.

The Connections pane context menu contains the following options:

• Add Connection – Displays a list of the types of connections that can be defined. Selecting a connection type displays the Connection Definition dialog for that type of connection.
• Edit Connection – Displays the Connection Definition dialog to edit a selected connection.
• Delete Connection – Deletes the selected connection’s definition.
• Refresh – Refreshes the Connections pane.
• Print – Prints a report of existing connections.
• Print Selected – Prints a report of selected connections.
• Disable – Temporarily inactivates the connection.
• Enable – Activates the connection from a disabled state (available only after having selected the Disable option, below). You can also enable a connection through the Enabled option in its definition dialog.
• Reconnect – Re-establishes a connection that failed. Reconnect is also available for an enabled connection that is not fully established.
• Test – Checks to see if the selected connection is working properly.

Note This option does not apply to all connection types.

Connection Definition Dialog

The Connection Definition dialog displays by adding or editing a licensed component to your TES network. The type of connection being defined displays at the top of the Connection dialog.

Common To All Tabs

• Name – The name that will be used to refer to the connection throughout TES panes and dialogs.
• Enabled Flag – Allows you to enable (activate) and disable (deactivate) agents. Jobs cannot run on agents that have been deactivated. If they try to run on agents that have been deactivated, they enter into the Agent Disabled status. Jobs already running on agents that are disabled will run to completion; however, their completion status will not be returned until the agent is re-enabled.

General Tab

The General tab contains the following elements:

• Job Limit – Displays the maximum number of jobs that TES can run on the agent.

Windows agents have a concurrent job execution limitation based on the amount of memory the agent has. It is recommended that you do not set the agent job limit to a value higher than this limitation. In most instances, it is recommended to limit agents to running no more than 80 concurrent jobs. In general, agents should have 5 MB of memory for each concurrent job. Some jobs may require additional memory to process depending upon the needs of the job.

• Default Runtime User – Specify a default runtime user for the agent being installed.

Connection Tab

On this tab, the machine name and port number are specified for the connection. The actual name of the fields varies according to the type of connection being defined.

Depending on the connection type, this tab contains the following elements:

• Machine Name – The host name of the computer. This name is case-sensitive and can be found in the DNS section of the TCP/IP protocol of your network configuration. Consult with your System or Network Administrator for help with DNS and TCP/IP.
• Master-to-Agent Port – The Master-to-Agent Port field displays when defining an agent connection. The port used to communicate with the cqd process of an agent machine. The default is 5912 . This number is specified during installation.
• Backup-to-Master Port – The Backup-To-Master Port field displays when defining a backup master connection. This port is used to communicate between the backup master and primary master for fault tolerance purposes. The default is 6704 . This number is specified during fault tolerance installation.
• Fault Monitor Master Port – The Fault Monitor Master Port field displays when defining a fault monitor connection. This port is used to communicate between the fault monitor computer and the primary master and backup master for fault tolerance purposes. The default is 6703 . This number is specified during fault tolerance installation.
• Agent-to-Master Port – The port used when defining a master connection. The default is 5591. This number is specified during installation.

Note Do not use port values that are in use by other software programs. Connection performance will be unpredictable.

• Host Environment Log (This option only appears for a master connection if you are using an adapter offered by Tidal Software.) – Sets the detail level for the logging in the adapter host environment. Like the logging levels set on the Logging tab of the System Configuration dialog, there are seven progressively more detailed levels of detail available that range from None to High Debug . The Severe level is the default option. When the log reaches 1 MB in size, it is archived and a new log file is started. The log file is named AdapterHost with a date and time stamp and a .log extension. After 25 log files are created, the oldest log file is deleted to make room for a new log file. These AdapterHost files are stored in the same directory as the master's log files at Program Files\Tidal\Scheduler\master\log .

There is also a Service log file named Service.log for each corresponding adapter. This log is located inside of the corresponding adapter GUID. For example, the SAP Service Log location would be:

C:\Program Files\TIDAL\Scheduler\Master\services\{51C57049-3215-44b7-ABE1-C012FF786010}\log.

Note Changing the level of the Host Environment Log will directly effect the debug level of every adapter.

• Remote Primary Master Machine Name – The Remote Primary Master Machine Name field displays when defining a remote master connection. Type the machine name of the remote master that is managing the intermaster dependency.

If you are defining a remote connection, then your Connection tab is slightly different. There are two machine name fields and a Communication Port field.

• Remote Backup Master Machine Name – The Remote Backup Master Machine Name field displays when defining a remote backup master connection. Type the name for the backup master if the remote master managing the intermaster dependency is in fault tolerance mode. If the remote master is not fault tolerant, leave this field blank.
• Communication Port – The Communication Port field displays when defining a remote master connection. This port is used to communicate between the local master and the remote master (and its backup machine if fault tolerance is being used). The default is 6215 . This communication port should be the same number that Client Manager(s) of the remote master use.

Outages Tab

This tab only appears in the Connections Definition dialog when defining an agent or adapter connection and allows you to add, edit, and delete an agent or adapter outage.

This tab lists the time windows when the agent/adapter will not be available. The actual parameters of the outage are defined from the Outage Definition dialog. Tes will use the information entered here to manage jobs that may not complete before an outage window begins. From a system configuration viewpoint, use the Defaults tab to configure how Tes handles jobs at risk of failing due to a planned outage.

Resources Tab

This tab only appears in the Connections Definition dialog when defining an agent connection and displays all the system resources and current values collected for the connection.

Options Tab

This tab only appears in the Connections Definition dialog when defining an agent connection and allows you to add, edit, or delete name/value connection parameters.

Variables Tab

This tab only appears in the Connections Definition dialog when defining a remote master.

This tab lists the various names and types of variables published by the specified remote master. The actual value of a variables is only determined when needed as the job processes. The list of variables published by the remote master is regularly updated and cached by the subscribing master with the intermaster dependency.

Connections and Agents Procedures

Changing the name of the computer displayed in TES

To change the name of the computer:

Step 1 From the Connections pane, double-click the licensed computer to edit or select the computer and click the Edit button . The licensed computer’s Connection Definition displays.

Step 2 In the Name field, change the computer’s name. This name is used when referring to the computer on TES panes and dialogs.

Step 3 Click OK .

Changing the Machine Hostname of the Computer

To change the hostname of the computer:

Step 1 From the Connections pane, double-click the licensed computer to edit, or select the computer and click the Edit button to display the licensed computer’s Connection Definition dialog.

Step 2 Click the Connection tab.

Step 3 In the Machine Name field, update the computer’s name.

This name can be found in the DNS section of the TCP/IP protocol of your network configuration. See your System Administrator for more information.

Changing Connection Port Numbers

You can update communication port numbers for licensed connections if they conflict with other programs that use the same numbers.

To change the connection port numbers:

Step 1 From the Connections pane, double-click the desired connection or select the connection and click the Edit button to display the licensed computer’s Connection Definition dialog.

Step 2 Click the Connection tab.

Step 3 Different fields are displayed, according to the type of connection selected:

– Master – The Agent-to-Master Port field is used when defining a master connection. The default is 5591 . This number is specified during installation. Update this port if it conflicts with other programs.

– Agent – The Master-to-Agent Port field is used when defining an agent connection. Update this port number if it conflicts with other programs. The default is 5912 .

– Backup Master – The Backup-To-Master Port field is used when defining a backup master connection. Update this port if it conflicts with other programs. The default is 6704 .

– Fault Monitor – The Fault Monitor Master Port field is used when defining a fault monitor connection. Update this port if it conflicts with other programs. The default is 6703 .

The Fault Monitor Client Port field is a JMS port used by the Client Manager to communicate with the Fault Monitor. The default is 6705 .

– Remote Master – The Communication Port field on this tab is used for communicating between the local master and the remote master. There is always one remote master that will use this port but this port is also available to the remote backup master if the remote master is in fault tolerant mode. The default port for this connection is 6215 , so change the value if there is a conflict. This same JMS Port is also used for the Client Manager to Master communication.

Deleting an Agent Connection

To delete an agent connection:

Step 1 From the Connections pane, select the agent to delete.

Step 2 Click the Delete button on the TES toolbar.

Tidal Service Manager

The Tidal Service Manager is a central point of control for stopping and starting TES services on the Windows platform. Any Enterprise component on the Windows platform running as a service can be manipulated from the service manager. Through the Tidal Service Manager, you can also configure various aspects of how the component service runs.

Displaying the Tidal Service Manager

Click the Windows Start button, and select Programs>Tidal Software>Tidal Service Manager.

This dialog contains the following elements:

• Service – Choose the TES service you wish to start or stop.
• Start – Click to start a service.
• Stop – Click to stop a service.

The selected service’s status displays at the bottom of the Tidal Service Manager.

Service Configuration Dialog

Clicking the Browse button while in the initial dialog of the Tidal Service Manager opens a Service Configuration dialog where settings for the master or other services can be adjusted.

Service Tab

The Service tab contains the following elements:

• Name – The name of the Windows system service.
• Display Name – The label for the service displayed in the main dialog of the Tidal Service Manager.
• Path – The full path to the binary file associated with the service.
• Parameters – The parameters, if any, applied to executing the binary.
• Startup – Configures how the service starts. There are three options:

– Automatic – The service starts upon every reboot.

– Manual – The service is only started when you manually start it, for example, through the Tidal Service Manager.

– Disabled – The service will not start as long as the Disabled option is selected.

Logon Tab

The Logon tab contains the following elements:

• System Account (LocalSystem) – The service runs under the standard system account for services.

– Allow Service to interact with Desktop – The service runs with the local desktop.

• Other Account – When the Other Account option is selected, you must type the name of the account under which you want the service to run.

– Password – Type the password for the account specified in the Other Account field.

– Confirm Password – Retype the password.

Dependencies Tab

The Dependencies tab is only available when the service is stopped. You create services dependencies on this tab. Select a service listed in the Available Services column and click the arrow button to move it to the Depends On column.

Master

Controlling the Master

Normally, after installation and after a reboot, the TES master is automatically started. On Unix, the master is NOT automatically started. You can check the status, start, and stop the master service manually from the Tidal Service Manager for a Windows master or from the command line for a Unix master .

Note If you are using an Oracle or MSSQL Server, ensure that your database is running prior to starting the master service.

Checking the Status of the Master

To check the status of the master:

Unix

The Unix master does not use the Tidal Service Manager so the command line is used to check the status of the master. From the command line of the master machine type:

Windows

Step 1 On the machine with the master installation, click the Windows Start button and then select Programs>Tidal Software>Tidal Service Manager to display the Tidal Service Manager .

Step 2 Verify that the Scheduler Master displays in the Service field.

The master status displays at the bottom of the Tidal Service Manager.

Starting the Master

To start the master:

Unix

The Unix master does not use the Tidal Service Manager so the command line is used to start the master. From the command line of the master machine type:

Windows

Step 1 On the machine with the master installation, click the Windows Start button and then select Programs>Tidal Software>Tidal Service Manager to display the Tidal Service Manager.

Step 2 Verify that the Scheduler Master displays in the Service field.

Step 3 Click Start .

Stopping the Master

To stop the master:

Unix

The Unix master does not use the Tidal Service Manager so the command line is used to stop the master. From the command line of the master machine type:

Windows

Step 1 On the machine with the master installation, click the Windows Start menu button, then select Programs>Tidal Software>Tidal Service Manager to display t he Tidal Service Manager .

Step 2 Verify that the Scheduler Master displays in the Service field.

Step 3 Click Stop .

Defining a Master Timezone

You can define timezones where target application environments are based. This allows you to schedule a job or job group across a different timezone. For example, if the Master associated with your job is based in the PST timezone and you want the job to run in an alternative timezone, you can select the defined timezone. The Master internal process will self-adjust the scheduled time or DST (Daylight Savings Times) period differences.

To configure the Master timezone for a job:

Step 1 From the Activity menu, select System Configuration to display the System Configuration dialog.

Step 2 Click the Timezone tab.

Step 3 Click Add or Edit to display the Timezone for Job Definition dialog.

Step 4 In the Name field, enter a unique name to represent job timezone.

Note If the Use Agent Time Zone is selected, the following step does not apply.

Step 5 From the Timezone list, select the timezone ID.

Note As of TES 6.0.3, this option has been relocated from the Master tab to the new Timezone tab.

The following fields pre-populate depending on the Timezone list selection:

– Timezone Full Name – Java build-in timezone long name.

– Master Timezone Offset – The time differences between Master timezone and selected Java timezone.

– UTC/GMT Timezone Offset – The time differences between standard
UTC/GMT and selected Java timezone.

– Current in DST Timezone Period – Checked if current in Daylight Saving Time (DST) period for this selected timezone.

– DST Time Differences – The amount of time to be added to selected timezone if it is in DST period.

Step 6 Click OK .

See Timezone Tab for further instruction.

Agents

You can start and stop agents in your network at any time.

Note Before starting or stopping the agent, check the agent’s status using the Tidal Service Manager.

Changing an Agent’s Job Limit

You can change an agent’s job limit to specify the number of jobs that can run on it concurrently. You can also control the number of jobs running concurrently using queues. Refer to Controlling Production , to learn more ways of controlling job execution.

To change an agents job limit:

Step 1 From the Navigator pane, select Administration>Connections to display the Connections pane with the licensed computers.

Step 2 Double-click the agent to edit or select the agent and click the Edit button on the TES toolbar to display the agent’s connection definition.

Step 3 Click the General tab if it is not showing.

Step 4 In the Job Limit field on the General tab, change the job limit to the desired value. See your agent-related documentation on setting the job limit.

Step 5 Click OK .

Checking Agent Status

To check the agent status:

Step 1 On the agent machine, click the Windows Start button and then select Programs>Tidal Software>Tidal Service Manager to display the Tidal Service Manager .

Step 2 In the Service drop-down list, select the agent you wish to check so that it displays in the Service field.

Step 3 At the bottom of the Tidal Service Manager, the status of the selected service displays.

Enabling/Disabling an Agent

You can disable an agent if you do not want it to run jobs submitted by TES. If a job tries to run on a disabled agent, its status changes to Agent Disabled .

To enable or disable an agent:

Step 1 From the Navigator pane, select Administration>Connections to display t he Connections pane.

Step 2 Double-click the agent to edit or select the agent and click the Edit button on the TES toolbar to display the agent’s connection definition .

Step 3 Do one of the following:

– To enable the agent, select the Enabled option.

– To disable the agent, clear the Enabled option.

Step 4 Click OK .

Starting the Agent

To start the agent:

Step 1 Click the Windows Start button and then select Programs>Tidal Software>Tidal Service Manager .

Step 2 Select the correct agent if it is not displayed in the Service field and click the Start button. The light will turn green when the agent starts.

Note The Agent for Unix does not use the Tidal Service Manager so the command line is used to start, stop and check the status of the agent. Use the following commands:
To start: ./tagent <agent name> start
To stop: ./tagent <agent name> stop
To check status: ./tagent <agent name> status

Stopping the Agent

To stop the agent:

Step 1 Click the Windows Start button and then select Programs>Tidal Software>Tidal Service Manager .

Step 2 Select the correct agent if it is not displayed in the Service field and click the Stop button. The light will turn red when the agent stops.

Client Manager

Controlling the Client Manager

You can check the status, start, and stop the client manager manually from the Tidal Service Manager or from the command line.

Checking the Status of Client Manager

To check the status of Client Manager:

Unix

The Unix Client Manager does not use the Tidal Service Manager so the command line is used to check the status of Client Manager. From the command line type:

Windows

Step 1 On the machine with the master installation, click the Windows Start button and then select Programs>Tidal Software>Tidal Service Manager to display the Tidal Service Manager .

Step 2 Verify that the Client Manager displays in the Service field.

The Client Manager status displays at the bottom of the Tidal Service Manager.

Starting Client Manager

To start the Client Manager:

Unix

The Unix Client Manager does not use the Tidal Service Manager so the command line is used to start Client Manager. From the command line of the master machine type:

Windows

Step 1 On the machine with the Client Manager installation, click the Windows Start button and then select Programs>Tidal Software>Tidal Service Manager to display the Tidal Service Manager.

Step 2 Verify that Client Manager displays in the Service field.

Step 3 Click Start .

Stopping Client Manager

To stop Client Manager:

Unix

The Unix Client Manager does not use the Tidal Service Manager so the command line is used to stop the master. From the command line of the Client Manager machine type:

Windows

Step 1 On the machine with the Client Manager installation, click the Windows Start menu button, then select Programs>Tidal Software>Tidal Service Manager to display t he Tidal Service Manager .

Step 2 Verify that Client Manager displays in the Service field.

Step 3 Click Stop .

Overview

Before using TES on a regular basis, you should spend some time in the System Configuration dialog. By tailoring TES’s configuration to your needs, you will receive greater benefits from using the product.

You can configure the following options:

• Job and job group definition default field values. This lets you specify many of the default field values, such as the default agent, job priority, and concurrency that is automatically entered each time you create a new job or job group.
• Timezones where target application environments are based. You can schedule a job or job group across a different timezone.
• Mail parameters for email messaging services. This lets you define your email service so that TES can use it.
• The audits, errors and diagnostic logging messages to include and/or exclude. As you become more familiar with TES , you might want to filter the messages that appear in the Logs pane, but initially we recommend keeping all default settings.
• How job occurrences are sorted when the status sort is selected. This feature helps you to sort job occurrences based on the status order you choose, helping you more clearly organize jobs in the Job Activity pane.

System Configuration Dialog

Select Activities>System Configuration from the menu bar of the Tidal Web client to display the System Configuration dialog.

Master Tab

The Master tab configures actions managed by the master. This tab contains the following elements:

• Future Days to Include in Schedule – Controls the number of future days to include in the production schedule when the master does its daily compilation. Larger values let you schedule jobs farther into the future. Lower values reduce compilation time.

Note When you change the Future Days to Include in Schedule value, the new value will not take effect until the production schedule is compiled. Compilation will take place at midnight, by default.

• Operator Alert Retention (in days) – The number of days to keep operator alert information in the Job Activity pane .

Note By default, alerts are kept for seven days. Alerts that are older than the Operator Alert Retention value are purged daily.

• Trigger History Retention (in days) – Sets the default number of days to maintain event trigger history on the Trigger History tab of the Event Details dialogs. The maximum length of time to keep trigger history information is 9,999 days but this length of time requires very large amounts of hardware and resources and hampers performance. The default setting is for 30 days.
• Use Passwords to Run Windows Jobs – Enables (if checked) Windows agents to use Windows passwords. Windows agents can be configured to use a per-job password. Each scheduled job can be configured to run under a specific username and password (runtime users). The job inherits the permissions and resources of the assigned user account. This means that all runtime users require valid passwords. Any jobs that log on as users with invalid or missing passwords will fail with a status of Error Occurred .

TES stores the passwords in encrypted form within its own database. At no time is an unencrypted password echoed to the screen or made otherwise accessible to any user. Passwords are also encrypted when passed from a master to an agent.

TES stores the passwords using 64-bit block cipher encryption within its own database. At no time is an unencrypted password echoed to the screen or made otherwise accessible to any user. Passwords are also encrypted when passed from a master to an agent.

• Automatic Daily History Cleanup – When this option is selected, TES automatically purges the database everyday. By default, the purge is executed at the beginning of the new production day.

Note The master will log any errors when purge is performed automatically.

When this option is not selected, TES will not automatically purge your database of old information history.

• FTP Local User Mandatory – Requires that a local (or runtime) user be selected on the Run tab of FTP job definitions. Using a runtime user adds additional security to FTP jobs. The default is to not use a runtime user (unselected). If this option is selected, any previous FTP jobs that were defined without assigning a local user, will error out until a local user is assigned to the job.
• None (except Launched/Active Jobs) – Do not transfer any jobs from the current production schedule to the next production schedule unless the jobs have already launched or are in active status. (On an individual basis, jobs can be prevented from carrying forward by selecting the Disable carryover option from the Options tab of the Job Definition dialog.)
• Successors only (unless disabled for job) – Transfers to the following production schedule any successor jobs from active jobs in the current production schedule unless the Disable carryover option was selected in a job’s definition.
• All Unfinished Jobs (unless disabled for job) – Transfers any jobs that did not run in the current production schedule to the following production schedule unless the Disable carryover option was selected in a job’s definition.
• Wait until previous schedule completes before starting new schedule – This option prevents any jobs from a new production schedule regardless of their priority from running until all of the jobs from the previous schedule are completed or canceled. If the production day rollover is held up while waiting for the previous day’s jobs to complete, a warning is recorded in the Audit log. To rollover to a new production schedule after selecting this option, you must either cancel the previous day’s jobs that are still running or change the jobs’ status to completed.
• Days to Carry Over – Use this option to specify the number of days to carry over unfinished jobs. When the number you specify is reached, TES will no longer include the unrun jobs in the next production schedule.
• Production Day Offset [+/– hh:mm] – The Production Day Offset value adjusts the beginning of the production “day” to start the specified number of hours/minutes before or after midnight of the “real” day. For example, if you enter a +03:00 , your calendar for the day will not start until 3:00 am.

Note If the production day offset is modified, you must recompile the current and future production schedule for the changes to take effect. If a negative offset is specified, the master should be restarted and then the current and future production schedules must be recompiled.

• Compile Offset [+/– hh:mm] – This option adjusts your compile time to start the specified number of hours/minutes before or after the beginning of the production day. The default compile time is midnight, because midnight is the default time for the beginning of the production day. If you have set a Production Day Offset value (above) the Compile Offset value will be adjusted from the new beginning of the production day.
• Week Begins – This option affects the starting date of all subset calendars that use weekly definitions. After changing the value in this field, select Recalculate from the Calendars pane context menu to have the changes take effect. For more information, see Calendars Interface, in this manual.

Defaults Tab

Displays default settings for job definitions. The Defaults tab also configures whether job events, system events, actions, variables and calendars will default to public availability.

This tab contains the following elements:

• Agent Name – Sets the default agent for the Agent Name setting in the Job/Group Definition dialogs.
• Job History Retention (in days) – Sets the default number of days of job history to keep. The Job History Retention setting can be individually configured for jobs on the Options tab of the Job/Group Definition dialogs. The maximum length of time to keep job history information is 9,999 days but this length of time requires very large amounts of hardware and resources and hampers performance.
• Job Priority – Sets the default for the Job Priority setting in the Job/Group Definition dialogs.
• If job is currently running – Sets the default for the If job is currently running setting (concurrency) in the Job Definition dialog. There are four options:

– Run Anyway – Run another job instance even if the previous instance is still running.

– Skip – Do not run another job instance if the previous instance is running.

– Defer until Normal – Run another job instance only if the current job instance completes with a Normal status.

– Defer until Complete – Run another job instance only after the current job instance completes.

• Base time needed to run job on – Sets the default basis for evaluating whether jobs will complete before a scheduled outage. Whether jobs have adequate time to run can be based on either of the following factors:

– Estimated Duration – The estimated duration for the command or executable as specified in the job definition. If the job has run more than once with the same command or executable, the estimated duration is the historical average of the job's previous run times. You can also manually set the estimated duration time of a job in its definition.

– Maximum Duration – The maximum duration for the command or executable as specified in the job definition.

• If not enough time before outage – Sets the default for the If not enough time before outage setting in the Job Definition dialog. There are three options:

– Run Anyway – Run the job anyway.

– Skip – Do not run the job.

– Defer – Wait and run the job after the connection outage has ended.

• Unscheduled allowed – Sets the default for the Unscheduled Allowed setting in the Job Definition dialog.
• Disable carryover – Prevents any jobs that did not run during the current production schedule from being carried over to the next production schedule. If you wish to carry over jobs to the next production schedule, refer to the Carryover Options for Unfinished Schedule section on the Master tab to configure which jobs should carry over to the next day’s production schedule.
• For Unix, source user’s profile – Allows you to execute Unix user profiles. This global option provides for the execution of all variables in a Unix user’s profile. This option is available in individual job definitions on the Options tab so that job instances do not have to default to a source user’s profile. Without this option, any Unix user profile variables that are referenced by scripts will not be executed, causing a job to fail in TES.
• Save Output Option – Sets the default handling of job output. There are three options:

– Discard – Does not save the job output. (Default)

– Append – Saves the complete output from each job instance, adding the output to the previous job instance’s output.

– Replace – Saves the complete output from each job instance, overwriting the previous job instance’s output.

• Summary Only for ERP Jobs – This option only applies to some adapter jobs. Selecting this option saves the job output in a summary form. This option is useful when ERP jobs have long job output and you do not want the entire output file. Not available if the Discard option is selected.
• Override 'Rerun each time dependency is met' for disabled jobs – If a job is disabled, the system will override the option to rerun the job each time a dependency is met.
• Public – Sets the public option default where public option is used. Public items are available to all users of TES with an appropriate security policy.

Mail Tab

The Mail tab of the System Configuration dialog displays email settings. TES uses actions to send email to users about job scheduling information.

Note For more information about using email with TES, see Actions and Alerts and your TES Installation & Configuration Guide.

This tab contains the following elements:

• Mail System – The email system used by your network. You can choose from the following email system types:

– None – No mail system is selected.

– Internet Mail SMTP – Simple Mail Transfer Protocol.

• Address Separator – You may want to notify more than one person when an action occurs. Use the address separator when listing several email addresses so TES can distinguish between individual addresses. You may use any character that the designated mail system recognizes as a separator as long as the separator is a single character. Most of the time you would use a comma or a semi-colon as a separator.
• Timeout – If no response, enter the time (in milliseconds) you want the mail to timeout.

Logging Tab

The Logging tab configures the length of time to keep audit and error messages. You can also choose to suppress messages from a specific source. More information on diagnostic logging is available in Troubleshooting . For more information about logging and log messages, see Monitoring Production.

This tab contains the following elements:

• Audits – The length of time to keep audit information. The maximum length of time to keep audit information is 9,999 days but this length of time requires very large amounts of hardware and resources and hampers performance. The default is 7 days.
• Errors – The length of time to keep error information. The maximum length of time to keep audit information is 9,999 days but this length of time requires very large amounts of hardware and resources and hampers performance. The default is 30 days.
• Audits option – Select this option to activate audit logging. When checked, auditing information will be collected and can appear in the Logs pane. The following is a list of available auditing sources.

– Master – Displays audit messages that originate from the master.

– Client – Displays audit messages that originate from all Tidal Web clients connected to the master.

– Agent Manager – Displays audit messages that originate from licensed agents that run jobs. The Agent Manager: CQD category displays messages dealing with the underlying agent communications protocol.

– Fault Tolerance – Displays audit messages from the Fault Monitor machine.

– Dependency Manager – Displays messages about when dependencies for jobs and job groups are met.

– Job Manager – Displays messages about the status of jobs.

– Action Manager – Displays messages about all configured actions.

– Queue Manager – Displays messages about queue activity.

– Agent Messenger: CQD – Displays messages regarding the agent communications protocol, CQD. The Agent Manager category displays other messages originating from licensed agents.

Note Because of the volume of CQD diagnostic messages, you can clear the Agent Messenger: CQD source for messages while still gathering information regarding your agent(s) from the Agent Manager source.

Often the error messages displayed in the Tidal Web client that are generated by a problem, provide an indication of the source of the problem revealing which component should be monitored. If no source is indicated in the error message, check the messages in the system log for clues to the source of the problem. Once the source of the problem is identified, you can enable diagnostic logging for that system component. Be careful when using the diagnostic logging function as logging messages can consume a large amount of disk space very quickly. Carefully monitor the size of the log file being created as excessive logging consumes system resources as well as disk space. Try to repeat the scenario that produced the problem, so system activity can be recorded for Technical Services to interpret. Once the problem occurs again, contact Technical Services and send them the logging file.

If you are enabling diagnostics before contacting Technical Services, start at the Info level and Technical Services will provide additional instructions after receiving the diagnostic files.

The following components are monitored:

• Scheduler Log – Records system level messages regarding the master.
• Client Manager Log – Records messages about Client Manager activity.
• Agent Manager Log – Records messages from agents running jobs.
• Compiler Log – Records messages about the status of production schedules being compiled.
• Job Manager Log – Records messages about the status of jobs.
• Event Manager Log – Records messages about events defined in TES.
• Queue Manager Log – Records messages about queue activity.
• Database Log – Records messages relating to the state of the database.
• Communications Log – Records messages concerning all defined connections and sockets. Be aware that setting this component to a high level of logging results in a large amount of information that consumes large amounts of disk space.

Each component has a drop-down list with seven levels of progressively more detailed logging. Each level includes the messages of the previous levels of logging. The levels of logging are:

• None – No logging for the component.
• Severe – Logs only serious problems for that component. (default)
• Warning – Logs potential problems for the component as well as messages from the Severe logging level.
• Info – Logs status messages about the normal operation as well as messages from lower logging levels.
• Low Debug – Logs important debugging messages as well as messages from lower logging levels.
• Medium Debug – Logs an increasing amount of debugging information as well as messages from lower logging levels.
• High Debug – Logs the largest amount of debugging information as well as messages from lower logging levels.

Audits Tab

Lists all the audit messages TES can issue. All audit messages can be viewed from the Logs console view. From this tab, you can include or exclude audit messages for TES to record.

Job audit messages can be viewed by individual job from the Job Details dialog for that job (accessed from the Job Activity pane). The first audit message listed (with the 1000 ID number) is blank because it is available for creating a custom audit message.

This tab contains the following elements:

• Msg ID – The ID number associated with the specific audit message.
• Exclude – Excludes the audit message from being issued by TES.
• Message – The text of the audit message. Message strings consist of two string types–the message text and the substitution string placeholders. Substitution string placeholders are denoted by a double-percent sign and the string number. For example, the first substitution string place holder is %%1 , and the second, %%2 .

Double-click the message to display the Audit Message dialog.

• Instead of individually selecting or excluding audit messages, you can right-click the Audits field to display a context menu providing all or nothing options as noted below:

– Exclude Selected Messages – The selected audit messages will be issued.

– Exclude All Messages – None of the audit messages listed on this tab will be issued.

– Include Selected Messages – The selected audit messages listed on this tab will be issued.

– Include All Messages – All of the audit messages listed on this tab will be issued.

– Log Selected As Windows Event(s) – The selected audit messages listed on this tab will be logged as Windows Events.

– Log All As Windows Events – All audit messages listed on this tab will be logged as Windows Events.

– No Windows Event Logging For Selected – The selected audit messages listed on this tab will not have Windows Event logging.

– No Windows Event Logging – All audit messages will not have Windows Event logging.

For more information about audit messages, see Monitoring Production.

Errors Tab

Lists all the error messages TES can issue. Error messages can be viewed from the Logs pane . The first error message listed (with the 2000 ID number) is blank because it is available for creating a custom error message. Here you can instruct TES to exclude specific error messages.

(For more information about error messages, see Monitoring Production.)

This tab contains the following elements:

• Msg ID – The ID number associated with the specific audit message.
• Exclude – Excludes the error message from being issued by TES.
• Message – The text of the error message. Message strings consist of two string types–the message text and substitution string placeholders. Substitution string placeholders are denoted by a double-percent sign and the string number. For example, the first substitution string place holder is %%1 and the second, %%2 .

Double-click the message to display the Error Message dialog.

• Instead of individually selecting or excluding error messages, you can right-click the Errors field to display a context menu providing all or nothing options as noted below:

– Exclude Selected Messages – The selected error messages will be issued.

– Exclude All Messages – None of the audit error listed on this tab will be issued.

– Include Selected Messages – The selected error messages listed on this tab will be issued.

– Include All Messages – All of the error messages listed on this tab will be issued.

– Log Selected As Windows Event(s) – The selected error messages listed on this tab will be logged as Windows Events.

– Log All As Windows Events – All error messages listed on this tab will be logged as Windows Events.

– No Windows Event Logging For Selected – The selected error messages listed on this tab will not have Windows Event logging.

– No Windows Event Logging – All error messages will not have Windows Event logging.

Job Status Order Tab

Lists the job statuses and lets you change the job status order used for sorting jobs and job groups by status in the Job Activity pane .

This tab contains the following elements:

• Job Status Sort Order – To change the job status sort order, select the status you want to move up or down, and click the up and down arrow buttons.

The sort order defaults to alphabetical, but you may want to change that if there is a sort order that makes more sense to you. For example, jobs always enter the Launched status before they enter the Active status. Thus, you may want to place Active after Launched in this list.

Fault Tolerance Tab

The Fault Tolerance tab of the System Configuration dialog allows you to turn on fault tolerance and configure the settings.

Note The Fault Tolerance tab is not displayed if you are not licensed for fault tolerance.

This tab contains the following elements:

• Enable Failover – Turns on fault tolerance. The default is disabled.

The following fields do not display unless the Enable Failover option is selected.

– Machine Name (Backup Master) – The name of the machine the backup master is on.

– Backup-To-Master Port – The port number for the backup master to primary master connection.

– Machine Name (Fault Monitor) – The name of the machine the fault monitor is on.

– Fault Monitor Master Port – The port number for the fault monitor to master connection.

– Fault Monitor Client Port – The port number for the fault monitor to Client Manager connection.

Timezone Tab

The Timezone tab of the System Configuration dialog allows you to define timezones where target application environments are based. This allows you to schedule a job or job group across a different timezone. See also, Working with timezones.

This tab contains the following elements:

• Use Master Time Zone – Selecting this option indicates that TES will assume any times specified in job scheduling should be in accordance with the master machine’s time zone. If you want a job-based timezone, you must select this option.
• Use Agent Time Zone – Selecting this option indicates that TES will assume any times specified in job scheduling should be in accordance with the agent machine’s time zone. This means that a job running at the same time on all of the agents will appear from the master to run at different times because of the different times zones that agents may reside in.

Note It is not recommended to use the Agent Time Zone option with the Production Day Offset option unless you thoroughly understand the scheduling complexities. Using the master time zone means that the agents reference the same time zone when launching jobs but using the agent’s time zone means that each agent launches jobs according to the time zone that the agent resides in. Due to the time zone differences, from the agents’ perspective a 11 am job launches correctly but from the master’s perspective the 11 am job may launch at noon, 1 pm, 2 pm, etc.
Adding a production day offset to a system network spread over a large geographic area encompassing multiple time zones vastly complicates scheduling. A production day offset may entail that jobs will be launching on different days from the master’s perspective. Tidal Software’s consulting services can help resolve complicated scheduling issues.

To configure the Master timezone for a job:

Step 1 From the Activity menu, select System Configuration to display the System Configuration dialog.

Step 2 Click the Timezone tab.

Step 3 Click Add or Edit to display the Timezone for Job Definition dialog.

Step 4 In the Name field, enter a unique name to represent job timezone.

Step 5 From the Timezone list, select the timezone ID.

Step 6 The following fields pre-populate depending on the Timezone list selection:

– Timezone Full Name – Java build-in timezone long name.

– Master Timezone Offset – The time differences between Master timezone and selected Java timezone.

– UTC/GMT Timezone Offset – The time differences between standard
UTC/GMT and selected Java timezone.

– Current in DST Timezone Period – Checked if current in Daylight Saving Time (DST) period for this selected timezone.

– DST Time Differences – The amount of time to be added to selected timezone if it is in DST period.

Step 7 Click OK .

Other Tab

The Other tab controls how schedules are compiled, sets time zones, length of alert retention, offsets and job carryover.

This tab contains the following elements:

• Confirm Job Enable – Displays a confirmation message whenever a job is enabled.
• Confirm Job Disable – Displays a confirmation message whenever a job is disabled.
• Allow Job Rerun on any Completed Normally and Completed Abnormally states – Allow jobs to be rerun on when the job state is either Completed Normally or Completed Abnormally .
• Send message text with quotes – When using HP OpenView, send all messages with quotes around the text.
• Wait.... seconds for connection to recover before alerting on “Lost connection to agent/adapter” – Specified interval in seconds after a connection is lost to either an agent or an adapter before the system event Lost connection to agent/adapter is triggered. The default value is a zero delay.
• Remove the browse button for command and file monitors – If selected, the ellipsis button is removed from the Job Definition dialog Command and File Monitor fields.