Setting

Definition

Transfer is active

Check this box to cause the transfer to become active.  When the ESI Secure File Transfer Client pulls its schedule from the MIE, it will only include records that have this box checked.

Transfer is owned by

The name of the user that "owns" this file transfer definition.  When the client pulls its schedule from the MIE, it will only include records that match the user whose credentials have been entered into the client.  It is important that the credentials used to log the client into the MIE match the value placed in this setting.

Direct SQL query will update this counter

If a counter is selected from the drop-down, then this job must also be set up at the client to perform Direct Database Access.  The query defined at the client will be used to retrieve a count, which will then be written directly to this counter's current value column.  The count retrieved depends on the SQL statement used.  For example, if the SQL statement contains any of the following functions: AVG(), MIN(), MAX(), COUNT(), SUM() - then the value returned by the query that is found in the first row, first column will be written to the counter.  Otherwise, the row count returned by the query will be written to the counter.

File to transfer

The path and file to transfer.  The path and file MUST be as viewed from the client machine that will be doing the transfers (where the client will be running).  Although the file transfer settings may be accessed from any machine that can access the web, it is important that this setting be made from the machine on which the client will be running.

Run this import job on every successful file transfer

If an import job is selected, the SFT client will queue the import job for processing each time a successful file transfer it made.  The import job is queued immediately upon successful transfer.  This allows the SFT client to control when the file is actually imported.  When this setting is used, there is no need to have a corresponding Timed Operations job as the import will happen based on the SFT's schedule.

Date to begin automatic transfers

When the client pulls its schedule from the MIE, it will only include records that contain a date value in this setting that has passed.  The time base for this setting is the MIE.

Date to stop automatic transfers

When the client pulls its schedule from the MIE, it will only include records that contain a data value in this setting that is still in the future.  The time base for this setting is the MIE.

Run transfer every

This specifies the frequency with which to run the file transfer.  If it has been at least this much time since the last file transfer attempt, or if no attempt has ever been made, a file transfer will be attempted once the client pulls its schedule.

Automatically exit the local SFT ...

If this setting is checked, then any SFT client that is set to run this job will compare the Windows user under which the local SFT client is running to the Windows user that "owns" the job.  If the values differ, the SFT client will immediately terminate and exit.  This setting is used to ensure the proper Windows user is processing important jobs, in the event that the SFT client gets installed under multiple user contexts - all logged in as the same MIE user (and therefore all trying to run the same jobs).  This happens occasionally when the SFT is installed to run on a server as various technicians end up installing SFT under their individual accounts.

NOTE:  When the Windows owner that owns the job is blank, the very first SFT client that checks in against the job will set the Windows owner.  This value can be changed via the user interface (or blanked out, which will cause the next SFT client that checks in to take ownership of the job).

Run on <day of week>

When checked, the SFT client will run this job on that day of the week.  If not checked, even if it is time to run the job again, the SFT client will wait until a day of the week that has been checked before running the job.  

Do not run start  / end (ESI only)

These two fields specify a window of time (within the day) between which the job cannot run.  This allows keeping database-intensive jobs from running within working hours, for instance.  These fields are only visible to ESI.

How to notify

When an SFT job has completed, the default (Always) is for the SFT client to notify the SFT job's owner by email with the results of the job. On Error will notify the owner only if an error occurs during the file transfer.  Never will turn notification off.  Note that when an import job has been selected to be queued directly by the SFT client after each successful file transfer, the notification setting will be passed to the import engine as well.  Generally when an import job has been selected and if notification is on, there will be two notifications - one by the SFT with the results of the file transfer, and then one by the import engine with the results of the import.