Add Job

You can add or update Scheduler jobs through the Add Job page which can be accessed by clicking Scheduler > Jobs > Add Job.

The Add Job page is divided into the following sections:

Required Information

The Required Information section in this page defines the fields that are required to execute a Scheduler job. The following table lists the field:

Field Description
Enabled Defines whether the job is enabled or disabled.

Disabled jobs are display with the Next Fire Time field on the Manage Jobs page, but will not be executed.

Job Name Defines the job name.

This name is used when managing the Scheduler request.

Group Name Defines whether you want to associate this job with a group.

By default, the job is assigned to the group named Default. Scheduler groups support you to search for groups in the Manage Jobs page.

The valid values for this field are as follows:
  • None: indicates that this job is not associated with a group.
  • Assign to Existing Group: assigns this job to a pre-existing group. A drop-down list is displayed listing the available pre-existing groups.
  • Create and Assign Group: assigns this job to a new group. A text box is displayed for you to enter the new group name.
Description Define a description for the job.
Job Type Defines the type of job to be executed by the Scheduler.
The supported job types are as follows:
  • Platform Transfer: schedules a predefined Platform transfer that can be found on the Manage Platform Transfers page.
  • Internet Transfer: schedules a predefined Internet Server transfer that can be found on the Manage Platform Transfers page.
  • Non-Event Transfer Alert: schedules an event to occur if the transfer of a file done by Internet Server or Platform Server fails. For example, a file transfer fails because the source file is not found.
  • Execute Command: executes a batch command or script.
  • Execute Java Class: executes a Java Class.
  • Send Email: schedules an email to be sent out to one or more email recipients.
  • Batch Job: executes a batch job.
  • Purge DB Tables: purges records from database tables.
  • Purge Log Files: purges old log and trace files.
  • Key Expiration Notification: configures an email to be sent out when a system or public key expires.
Batch Name Defines whether you want to associate this job with a batch.

A batch supports you to execute multiple jobs at the same time. When a job is associated with a batch, the Scheduling Information section on this page is removed; the job is executed when the batch is executed.

Note: This field is not displayed when the Job Type field is set to Batch Job.
The valid values for this field are as follows:
  • None: indicates that this job is not associated with a batch.
  • Assign to Existing Batch: assigns this job to a pre-existing batch. A drop-down list is displayed listing the available pre-existing batches.
  • Create and Assign Batch: assigns this job to a new batch. A text box is displayed for you to enter the new batch name.
Department Assigns a department to the job.

Super administrators can assign any department to the job by using this field.

Department administrators can assign their own departments or any departments that they can manage to the job by using this field. By default, the departments to which the department administrators belong are assigned to the job.

If the user (a non-administrator user) creating the job is in a department, this field is disabled; the department of the user is automatically assigned to the job.

Authorized User Id Performs a check when a request is executed through a Platform Server or JMS request.

This field, along with "Authorized Group Id", is used to authorize users to execute a job. If "Authorized User Id" or Authorized Group Id" is defined, the user executing the job must be the user defined as the "Authorized User Id" or a member of the Group defined as the "Authorized Group Id".

If these two fields are not defined, then any user with the necessary rights can execute this job.

Authorized Group Id Performs a check when a request is executed through a Platform Server or JMS request.

This field, along with "Authorized User Id", is used to authorize users to execute a job. If "Authorized User Id" or Authorized Group Id" is defined, the user executing the job must be the user defined as the "Authorized User Id" or a member of the Group defined as the "Authorized Group Id".

If these two fields are not defined, then any user with the necessary rights can execute this job.

Note: Note: Users assigned to a department cannot create job types of "Execute Command", "Execute Java Class", "Purge DB Tables" or "Purge Log Files". Likewise, jobs with these job types cannot be assigned to a department.
Note: Users assigned to a department cannot create job types of Execute Command, Execute Java Class, Purge DB Tables, or Purge Log Files. Likewise, jobs with these job types cannot be assigned to a department.

Platform Transfer

If you choose Job Type as Platform Transfer in the Required Information section, then the Platform Transfer section is displayed.

The Platform Transfer section defines the parameters necessary to execute a Platform transfer. The following table lists these parameters:

Parameter Description
Transfer Defines a predefined Platform transfer.

The drop-down list displays the transfer ID and the transfer description. When you select a predefined transfer, the values associated with the predefined transfer are displayed. You can override these parameter values by inputting a value.

Run Transfer As Defines the TIBCO MFT Command Center user to be used to schedule the transfer.
Transfer Direction Defines whether this is a send request or a receive request.
Server Name Defines the Platform Server where the request will be executed.

Servers defined with a server type of Platform Server are listed in the drop-down list.

Initiator File Name Defines the Platform Server initiator file name.
Responder Host Type Defines whether the responder host name is a node or an IP name.
Responder Host Name Defines the responder host IP name or node name.
Responder Port Number Defines the responder port number.

This is only used when the Responder Host Type field is set to IPName.

Responder File Name Defines the Platform Server responder file name.
Initiator User Id Defines the initiator user ID.
Initiator Password Defines the initiator password.
Confirm Initiator Password Confirms the initiator password.
Responder User Id Defines the responder user ID.
Responder Password Defines the responder password.
Confirm Responder Password Confirms the responder password.
Wait For Completion Defines whether you will wait for the transfer to complete.
The valid values are as follows:
  • Yes: Wait for the transfer to complete. Threads will be submitted to check on the transfer status until the transfer is complete or the wait timeout has been exceeded. The return code is the return code of the transfer.
  • No: Do not wait for the transfer to complete. The return code is 0 if the transfer is scheduled successfully.
  • Synchronous: The transfer is scheduled and the thread waits until the transfer is complete. It is recommended to use this option only for short running transfers of less than 30 seconds. If you use this option frequently, you may need to increase the number of scheduler threads, since threads will be used from the time the request is scheduled until the time the request completes.
Wait Timeout Defines how long the scheduler waits for a transfer to complete when the Wait For Completion field is set to Yes.

If this interval expires before the transfer is completed, the transfer is considered a failure.

Internet Transfer

If you choose Job Type as Internet Transfer in the Required Information section, then the Internet Transfer section is displayed.

The Internet Transfer section defines the parameters necessary to execute an Internet transfer. The following table lists these parameters:

Parameter Description
Transfer Direction Defines whether this is an upload (sending file to server) or download (receiving file from server) transfer.
JMS, File or Virtual Alias Defines whether the JMS Queue or File Name field points to a JMS queue, a file or a Virtual Alias. If Virtual Alias is selected, the parameters change to reflect parameters required by a Virtual Alias to Virtual Alias transfer.
Run Transfer As Defines the Internet Server user to be used to execute the transfer.

When the user is selected, the Virtual Alias drop-down list is updated with all transfers that the user is authorized to access.

Virtual Alias Defines the virtual alias authorized for the selected user.

Select a virtual alias for the transfer to use.

Source Virtual Alias Displayed when the user sets JMS, File or Virtual Alias to Virtual Alias. Defines the Virtual Alias where the source file or files to be uploaded are located.
Target Virtual Alias Displayed when the user sets JMS, File or Virtual Alias to Virtual Alias. Defines the Virtual Alias where the Target file or files will be uploaded to.
Server Name Defines the Internet Server where the request will be executed.
Note: You must add a server definition for Internet Servers that will execute transfers; the Server Type parameter must be set to Internet Server.
JMS Queue or File Name Defines the JMS queue or file name associated with the request.
Remote File Name Defines the remote file name associated with the transfer.
Data Type Defines the data type as Text or Binary.
Message Delimiter Defines whether records are delimited by LF, CRLF, or have no delimiters.
Wait For Completion Defines whether you wait for the transfer to complete.
The valid values are as follows:
  • Yes: wait for the transfer to complete. The return code is the return code of the transfer.
  • No: do not wait for the transfer to complete. The return code is 0 if the transfer is scheduled successfully.
  • Synchronous: wait until the transfer is complete. It is recommended to use this option only for short running transfers of less than 30 seconds. If you use this option frequently, you may need to increase the number of scheduler threads, since threads are used from the time the request is scheduled until the time the request completes.
Wait Timeout Defines how long the scheduler waits for a transfer to complete when the Wait For Completion field is set to Yes.

If this interval expires before the transfer is completed, the transfer is considered a failure.

JMS Input Selector Defines the selector that is used to filter JMS messages when reading from a JMS queue (in other words, a download request).

This parameter is ignored when writing to a JMS queue (in other words, an upload request).

This parameter uses the standard JMS Selector format: property name='property value'. It is important that the selector property value is enclosed in single quotation marks.

Output JMSType Property Defines the JMSType output property that is set when writing data to a JMS queue (in other words, an upload request).

This parameter is ignored when reading from a JMS queue (in other words, a download request).

Note: Only the value of the JMSType property should be entered in this field.
JMS Output Property Defines the output property that is set when writing data to a JMS queue (in other words, an upload request).

This parameter is ignored when reading from a JMS queue (in other words, a download request).

This parameter is entered in the format of JMS property name=JMS property value. Unlike the JMS Input Selector field , the property value should not be enclosed in quotation marks.

Note: Only one JMS property can be defined.
JMS Max Message Size Defines the maximum size of any individual message written to the JMS queue.

This parameter is ignored when reading from a JMS queue (in other words, a download request).

Valid values for this parameter are 1K - 999K and 1M - 10M; where K stands for kilobytes and M stands for megabytes. Therefore, the maximum JMS message that can be written is 10 megabytes.

Non-Event Transfer Alert

If you choose Job Type as Non-Event Transfer Alert in the Required Information section, then the Non-Event Transfer Alert section is displayed.

The Non-Event Transfer Alert section defines the parameters necessary to execute a non-event transfer alert. Non-event transfers support you to detect that a transfer has not been executed within a predefined interval. The non-event alert is defined on the Add Transfer Non-Event Alert page which can be accessed by clicking Management > Alerts > Add Transfer Non-Event Alert.

The following table lists the parameters in the Non-Event Transfer Alert section:

Parameter Description
Alert Description Defines the non-event alert.
Check successful completion for Defines how many minutes, hours, or days before the alert schedule time should be checked for transfer completion.

Execute Command

The Execute Command section defines the parameters necessary to execute a command. The following table lists these parameters:

Parameter Description
Execute Command Defines whether you want to execute the command locally on TIBCO MFT Command Center or remotely on TIBCO MFT Platform Server.
The following parameters are for executing a command locally:
Full Path of Command Defines the fully qualified path name of the command, executable file, or script to execute.
Note: When locally executing a UNIX Shell command such as ls or cp, the entire command must be entered in this field in the following format: -c ls -la /tmp.
Command Parameters Defines parameters that are to be passed to the command, executable file, or script.
The following parameters are for executing a command on a Platform Server:
Run Command As Defines the TIBCO MFT Command Center user to be used to schedule the transfer command.
Full Path of Command Defines the fully qualified path name of the command, executable file, or script to execute.
Command Parameters Defines parameters that are to be passed to the command, executable file, or script.
Server Name Defines the Platform Server where the command will be executed.
Platform User Id Defines the Platform Server user ID.
Platform Password Defines the Platform Server password.
Confirm Platform Password Confirms the Platform Server password.

Execute Java Class

If you choose Job Type as Execute Java Class in the Required Information section, then the Execute Java Class section is displayed.

The Execute Java Class section defines the parameters necessary to execute a Java Class. The Class must implement the com.proginet.scheduler.jobsScheduledAction interface and contain a non-argument constructor. An example of a Class can be found in the <MFT_Install>/server/webapps/cfcc/example/scheduler directory on the server.

The following table lists the parameters in this section:

Parameter Description
Full Java Class Name Defines the full package and Class name to be executed.
Parameters Defines parameters that are to be passed to the Java Class.

Send Email

If you choose Job Type as Send Email in the Required Information section, then the Send Email section is displayed.

The Send Email section defines the parameters necessary to send an email.

The following table lists the parameters in this section:

Parameter Description
Recipients Defines the recipients.

Multiple Recipients must be delimited by a semicolon.

Sender Email Address Defines the email address of the sender that will be set in the email.
Subject Defines the email subject.
Message Format Defines whether the message will be formatted as text or HTML.
Email Text Defines the contents of the email.

Batch Job

If you choose Job Type as Batch Job in the Required Information section, then the Batch Job section is displayed.

The Batch Job section defines the parameters necessary to execute a batch job. A batch job is a way to group multiple requests together so that they can be executed at the same time with the same scheduling trigger.

The following table lists the parameter in this section:

Parameter Description
Batch To Execute Defines the batch job to be executed.

Purge DB Tables

If you choose Job Type as Purge DB Tables in the Required Information section, then the Purge DB Tables section is displayed.

The Purge DB Tables section defines the parameters necessary to purge database tables.

The following table lists the parameters in this section:

Parameter Description
Delete Internet Server Audit Older Than Internet Server audit records written before the number of days defined will be deleted.

If this parameter is set to 0, no records will be deleted.

Delete Platform Server Audit Older Than Platform Server audit records written before the number of days defined will be deleted.

If this parameter is set to 0, no records will be deleted.

Delete Alert Audit Older Than Alert audit records written before the number of days defined will be deleted.

If this parameter is set to 0, no records will be deleted.

Delete Login Audit Older Than Login audit records written before the number of days defined will be deleted.

If this parameter is set to 0, no records will be deleted.

Delete Events Older Than Events written before the number of days defined will be deleted.

If this parameter is set to 0, no records will be deleted.

Delete Error Events Older Than Error events written before the number of days defined will be deleted.

If this parameter is set to 0, no records will be deleted.

Delete Checkpoints Older Than Checkpoints older than the number of days defined will be deleted.

If this parameter is set to 0, no records will be deleted.

Delete Admin Changes Older Than Admin changes older than the number of days defined will be deleted.

If this parameter is set to 0, no records will be deleted.

Delete Statistics Older Than Statistics older than the number of days defined will be deleted.

If this parameter is set to 0, no records will be deleted.

Records deleted per SQL Request Configured number of records to be deleted on each SQL request.

Valid values are from 1 to 1000 and the default value is 500.

Lowering this value may cause the purge functions to take longer, but it may use less CPU on the database server.

Purge Log Files

If you choose Job Type as Purge Log Files in the Required Information section, then the Purge Log Files section is displayed.

The Purge Log Files section defines the parameters necessary to purge log files.

The following table lists the parameters in this section:

Parameter Description
Delete Web Server logs Older Than Web server logs written before the number of days defined will be deleted.

If this parameter is left blank or is set to 0, no logs will be deleted.

Delete MFT Logs Older Than MFT logs written before the number of days defined will be deleted.

This includes files in the audit, message, trace, and webAdmin folders.

If this parameter is left blank or is set to 0, no logs will be deleted.

Key Expiration Notification

If you choose Job Type as Key Expiration Notification in the Required Information section, then the Key Expiration Notification section is displayed.

The Key Expiration Notification section defines the parameters necessary to notify one or more users when a private key or public key is about to expire.

The following table lists the parameters in this section:

Parameter Description
Email Address Defines one or more email addresses to be notified when a key is about to expire.

Use a semicolon to delimit multiple email addresses.

Expire In Defines the number of days before expiration when expiring keys will be checked.

When this parameter is not defined or is set to 0, no checking will be performed.

Include Disabled Keys Defines whether expiration checking will be performed on disabled keys.

Select the check box to include checking on disabled keys.

Send Email To Public Key Owner Defines whether to send an email to the owner of public keys.

This is in addition to the email recipients defined in the Email Address field.

Keys To Monitor Defines the types of keys to be monitored.

Select the check box to monitor the various keys. By default, all types of keys are monitored.

Scheduling Information

The Scheduling Information section defines the parameters necessary to trigger scheduled jobs to be executed.

The following table lists the parameters in this section:

Parameter Description
Schedule Frequency Defines when and how often jobs are to be executed.

When you click a radio button, parameters for that option will be displayed to the right.

Not Scheduled Defines whether the job is scheduled to execute.
Execute Once Defines the job to be executed for one time.
Supported schedule triggers are as follows:
  • Execute Now: executes the request immediately.
  • Execute On: selects a date and time when the request will be executed.
  • Store job after execution: keeps the job on the scheduler after the job is executed.
  • Remove job after execution: deletes the job from the scheduler after the job is executed
By Minute Defines the interval in minutes at which the job will be executed.
Supported schedule triggers are as follows:
  • Between: defines the time period (start and stop) within which the job is executed.
  • Every: defines the interval in minutes at which the job is executed.
  • Days: defines the days of the week when the job is executed.
By Hour Defines the interval in hours at which the job will be executed.
Supported schedule triggers are as follows:
  • Between: defines the time period (start and stop) within which the job will be executed.
  • Every: defines the interval in hours at which the job will be executed.
  • Days: defines the days of the week when the job will be executed.
By Day Defines the day and time when the job will be executed.
Supported schedule triggers are as follows:
  • Execute Job At: defines the time when the job will be executed.
  • Days: defines the days of the week when the job will be executed.
By Month Defines the day and time within each month when the job will be executed.
Supported schedule triggers are as follows:
  • Execute Job At: defines the time when the job will be executed.
  • Days: defines the days of the month when the job will be executed. The Days parameter is mutually exclusive with the parameter that supports you to specify a logical day of the month.
  • Supports you to specify a variety of logical days. This parameter is mutually exclusive with the Days parameter.
  • Months: supports you to select the months when the job will be executed.
By Calendar

Allows you to use an inclusion calendar to define when a job will execute. Schedule triggers:

Execute Job At: Specify the time the job will execute.

Use Calendar: Allows you to select an Inclusion Calendar that defines the days the job will execute.

Range of Recurrence Defines the start and end date of the schedule trigger.

Jobs will not be initiated before the start date and/or after the end date.

Do not Run on Calendar Day(s) Selects a calendar that defines days on which the job will not be executed.
Time Zone Defines the time zone used to schedule the request.

The default value is Use server time zone.

Priority Defines the priority of jobs from 1 to 10 where 10 represents the highest priority.

The priority is used to determine the order in which jobs should be executed.

Misfire Policy Defines the misfire policy.

A misfire occurs when the scheduler cannot execute the job during the defined interval. This might be because the threads are busy or the Scheduler service is down or on hold.

Supported schedule triggers are as follows:
  • Do not execute: misfires will not be executed.
  • Execute one misfire: if multiple misfires occur for this job, misfires will be executed for one job execution only. It will be executed immediately when the Scheduler detects the misfire. If the misfire cannot be executed, another misfire will be scheduled until the misfire is executed.
  • Execute all misfires: if multiple misfires occur for this job, a misfire will be executed for each job.

Additional Information

The Additional Information section defines additional information associated with scheduled jobs.

The following table lists the parameters in this section:

Parameter Description
Exclusive Defines whether a job will be executed exclusively.

when Yes is specified, only one iteration of this job will be run at a time. When No is specified, multiple iterations of this job can be executed at the same time.

Recoverable Defines whether a job is recoverable.

A recoverable job is one that will be re-executed after a schedule operation fails. When a job is set as recoverable, it is possible that the job will be run two times.

Dependency/Chain Job Defines a job to be executed based on job completion.
The valid values are as follows:
  • Execute on success: defines a job to be executed if this job is completed successfully.
  • Execute on failure: defines a job to be executed if this job fails.