Task Properties

Property

Description

ActionCommand

Transact SQL statements to perform on data that the DataCommand query returned. You can use parameters in the statements with the same name as the columns that the DataCommand query returned.

Note: The statements run on the server at one time instead of looped on the client, so write the transactions and other statements accordingly.

ActionCommand

Only used when creating multiple files. Indicates the SQL statement to run on each row that the DataCommand query returned. You can use parameters in the statements with the same name as the columns that the DataCommand query returned. The system creates a file using this query for each row of the data command. To create one file, set Append=True.

Append

If set to True and the target file exists, the system adds the information to the file instead of overwriting it. (XML format does not permit appending; use another FileFormat to append.)

Arguments

Command-line arguments to pass to the executable.

Attachments

Files to attach to a generated email. Separate multiple files with semicolons. You can use the following placeholders: $CurrentLogFile, {0}=Current Database Instance Name

{1}=Current Date

Command

SQL command to run.

DataCommand

Query used to select data into the server-side, fast-forward cursor.

DataCommand

Only used when creating multiple files; query to select data for each action command.

Debug

True = full debugging text to write to the log.

False = minimum system messages recorded in file.

DeleteCommand

Contains a SQL DELETE statement.

DeleteFiles

Name of the files to delete; you can use wildcards. Separate multiple files with semicolons. For example, EndOfDay*.xml;Logs\SavedRecords\*.xls.

DeletedRecordsFileFormat

When SaveDeletedRecords=True, you can select the file format. For example, CommaDelimited, TabDelimited, Excel, or XML.

DestinationFolder

Folder to place the files you are moving or copying. If you only copy one file, you can specify the file name instead.

DestinationFtpLocation

FTP URL receiving copied files.

DontWriteEmptyFiles

If True and the files don’t contain any data, the system doesn’t create a file.

FailOnUnsuccessfulExitCode

If True and the exit code received is not equal to the

SuccessfulExitCode, the process fails.

FileFormat

File format to create: CommaDelimited, Tab Delimited, Excel, or XML.

FileName

Name of the executable file to run.

FileName

Name of the file to create. You can use the following placeholders: $Fieldname = field from current row (used for multiple file creation)

{0}=Current Database Instance Name

{1}=Current Task Name

{2}=Current Date (You can apply standard .NET formatting.)

{3}=File name extension (based on FileFormat type).

FileName

Name of the file to transform. You can use the following placeholders: $CurrentLogFile, {0}=Current Database Instance Name {1}=Current Date

From

Email address in the From field.

MailServer

SMTP mail server name

MessageText

Text to include in the body of the email. You can use the following placeholders:

$CurrentLogFile

{0}=Current Database Instance Name

{1}=Current Date

MoveFiles

True = Move files from one location to another instead of copying.

OverwriteExistingFiles

True = Overwrite existing files with the same name in destination folder.

Parameters

Allows you to pass a list of arguments or parameters to the SQL statement. The SQL statement uses the Name as a placeholder to accept the values listed.

PreCommand

Processing to occur before executing the main task.

PostCommand

Processing to occur after executing the main task.

Required

True = Immediately stop processing task list on Instance when the current task fails.

SaveDeletedRecords

True = Automatically create a file containing the deleted records.

SaveToFileName

Name to save the transformed file to. You can use the following placeholders: $CurrentLogFile, {0}=Current Database Instance Name {1}=Current Date

SourceFiles

Name of the files to copy. You can use wildcards. You can separate multiple files be withsemicolons. For example, EndOfDay*.xml;Logs\SavedRecords\*.xls. $CurrentLogFile = copy the current log file.

StoredProcedureName

Name of the stored procedure to run.

Subject

Text to include in the Subject Line of the email. You can use the following placeholders: $CurrentLogFile, {0}=Current Database Instance Name {1}=Current Date

SuccessfulExitCode

The expected exit code received from the executable file. Used with the FailOnUnSuccessfulExitCode property.

Timeout

Number of seconds that can elapse before ending the process.

To

A list of email addresses to receive the email notification, separated by commas or semicolons.

TransformedFileName

If the system transforms attachments, the system renames them to the file name specified. You can use the following placeholders:

$CurrentLogFile, {0}=Current Database Instance Name

{1}=Current Date

ValueList

A list of values to substitute into the Command. The SQL command runs once for each value.

ValueParameterDataType

Data type used for the value list. Choices are True/False, Date, Number, Text, or SQL statement.

ValueParameterName

Name of the parameter to substitute with the list of values.

XSLFileName

The path\filename of an XSL file to use to transform the attachments or files specified.