Variables customized by users. The variable name must only contain underscores, letters, and numbers. The variable value can be a fixed value or dynamically determined using SQL statements during task execution.

System-predefined variables. The variable name starts with the "@@" characters.

Enter the name of the variable here.

The variable name must only contain underscores, letters, and numbers.

In the same context, variable names cannot be duplicated. For example, within the same task, the name of a task variable must be unique, and within the same template, the variable names must also be unique.

Select the source for the variable value here.

The variable value can be a fixed value set during configuration, or it can be dynamically queried using an SQL statement during task execution.

If the "Variable Value Source" is "Fixed Value", you can enter a value for the variable here.

If the "Variable Value Source" is "Generated by SQL Query", then you need to enter the SQL query here to retrieve the value of the variable.

If this option is selected, when using this variable in an HTML document (such as the body of an email), the variable value will be inserted directly into the HTML document as HTML code.

For example, the value of a variable is "<a href='https://www.sqlmessenger.com'>link to web<a/>":

This option is not selected, the variable value will be displayed as plain text

This option is selected, the variable value will be displayed as a hyper link

If this option is selected, the system will allow the value for this variable to be passed in from the TASK_PARAMS field in an external interface table. For example, the following SQL statement will initiate a task with ID 123 and pass a value for the task's variable "UserName":

INSERT INTO sqlmessenger_intf INSERT INTO sqlmessenger_intf
            (oper_type,
             task_id,
             task_params)
VALUES      ( 'T',--Operation type. "T" indicates to start a task.
              123,--Task ID to start
              'UserName=Andy'
--Pass "Andy" as the variable value to the task's variable "UserName".
); 

Note: When passing variable values from the external interface table, the task will use the passed values as the variable values for this run, and the configured values for these variables will be ignored.

Select whether to allow this variable to have an empty value. If this option is not selected, the task will be aborted when the variable's value is an empty string.

Available since v2.4.

If a variable value comes from a database field of datetime type, SQLMessenger converts the datetime to a string using the database’s default format. For example, SQL Server may convert a datetime to "2026-03-22 16:04:15.810".

When this option is selected, SQLMessenger converts the variable value to a string using the local date format. For instance, if the local date format is "DD.MM.YYYY", the variable value will be converted to "22.03.2026 16:04:15".

Note: This option is enabled by default for newly created task variables. For task variables created in older versions, this option is disabled by default.

When this option is selected, the system will perform a security check on the variable's value when it is used in an SQL statement. For example, if the value of variable "Month" is "202401;", the following statement will not be executed:

SELECT *
FROM   sales_stat
WHERE  sales_month = #month#; 

The value of the variable did not pass the SQL statement's security check

To avoid SQL statement execution failures caused by variable values containing special characters, you can modify the SQL query's parameter format to JDBC parameters, for example:

SELECT *
FROM   sales_stat
WHERE  sales_month = #[month]#; 

Using Variables in SQL Statements

Enter the name of the variable here.

The variable name must only contain underscores, letters, and numbers.

Variable names are case-insensitive and must be unique in the encrypted variable table.

Enter the value of the variable here.

Note: The variable value is only displayed when it is entered. After saving the task draft or publishing the task, the system will no longer display the value of the variable.

Specify domains (e.g., "microsoft.com" or "google.com") where the variable can be used.

If the variable is allowed to be used on multiple domains, please separate the domains with a semicolon ";".

When the variable is used, the system will compare the trailing characters of the host part in the URL called by the HTTP command with the domains configured here. If an attempt is made to use this variable on a domain other than those specified in "Apply To Domain", SQLMessenger will report an error and abort the HTTP command.

For example:

microsoft.com means the variable can be used on all URLs ending with "microsoft.com".

login.microsoft.com means the variable can be used on all URLs ending with "login.microsoft.com".

microsoft.com;azure.com means the variable can be used on all URLs ending with "microsoft.com" or "azure.com".