EFT Context Variables

EFT uses context variables to pull data from the database. The variable contains specific information about an Event. You can use the variables below in Event Rules, e-mail notifications, Commands, and Advanced Workflows.

In the AWE module, variables cannot contain periods; therefore, in each variable that contains a period, the period is replaced with an underscore. For example, % CONNECTION.LOCAL_IP% is % CONNECTION_LOCAL_IP% in the AWE module.

How to Use the Variables

In the Variables box, click a property that you want to insert.

For example, if you click Event Time in the left column the label "Event Time" and the time are displayed. If you select %EVENT.TIME% in the right column, the time will be displayed without a text label.

For example, when you create an Event Rule, you can configure an e-mail to be sent when the Event occurs. In the Edit Mail Template dialog box, you can send the default e-mail or you can add one or more variables listed in the Variables box at the bottom of the e-mail. Each of the variables defined in EFT is described below; however, not all of the variables described below are available in the e-mail notification. In the e-mail notification, you can specify to display the text along with the value of the variable (e.g., File Creation Date: 8/28/2007), or just the value of the variable (e.g., 8/28/2007).

Suppose you configured this e-mail notification:

You then uploaded a file on August 28, 2007 at 10:01:56. The e-mail would appear similar to the following:

This message was sent to you automatically by EFT on the following Event: File Uploaded.

Event Time: 28 Aug 07 10:01:56

File Creation Date: 8/28/2007

File Creation Time: 10:01:56

Event Date Stamp: 20070828

Event Time Stamp: 100156

 

In Event Rules and Commands with a defined path or filename, do not use variables that add invalid filename characters, such as a slash, colon, parenthesis, etc.

For example, you cannot use %FS.FILE_CREATE_DATE% and %FS.FILE_CREATE_TIME% for file naming, because the output of these variables is DD/MM/YYYY and HH:MM:SS and the forward slash (/) and colon (:) are not valid characters for filenames.

In most cases, the file created date and time is the same as the Event triggered time, therefore you can use %EVENT.DATESTAMP% (YYYYMMDD) and %EVENT.TIMESTAMP% (HHMMSS) when renaming files (because they do not use invalid characters), and %FS.FILE_CREATE_DATE% and %FS.FILE_CREATE_TIME% for e-mail notifications.

For example, suppose an OnUpload Event Rule causes an Offload Action that moves myfile.txt to the following path:

C:/Inetpub/EFTRoot/Site1/Usr/jsmith/%EVENT.DATESTAMP%_%FS.FILE_NAME%


The resulting path is:

C:/Inetpub/EFTRoot/Site1/Usr/jsmith/20070728_myfile.txt

Advanced Workflow Variables

Text Displayed

Variable

Description

Advanced Workflow Name

%AWE.TASK_NAME%

Workflow name

Advanced Workflow Log Path

%AWE.LOG_PATH%

Workflow log path

Advanced Workflow Error Code

%AWE.ERROR_CODE%  

Workflow error code

Advanced Workflow Error Description

 %AWE.ERROR_DESCRIPTION%

Workflow error description

Advanced Workflow Error Line

%AWE.ERROR_LINE%

Workflow error line

Advanced Workflow Result Code

%AWE.RESULT_CODE%

Workflow result code displayed in the Windows Event Log and others

Advanced Workflow Result Description

%AWE.RESULT_DESCRIPTION%

Workflow result description displayed in the Windows Event Log and others

Advanced Workflow Execution Time (ms)

%AWE.EXECUTION_TIME_MS%

Workflow execution time (ms)

AS2 Variables

Text Displayed

Variable

Value Contained in Variable

AS2 Content Type

%AS2.CONTENT_TYPE%

Transfer's content type: Application,  EDIFACT, XML, Mutually defined EDI, Binary, Plaintext

AS2 Direction

%AS2.DIRECTION%

Direction of the transfer

AS2 EFT ID

%AS2.EFT_ID%

EFT ID used in this transfer

AS2 Host

%AS2.HOST%

Address of the host being sent to (outbound) or received from (inbound)

AS2 Local MIC

%AS2.LOCAL_MIC%

Local AS2 message identification code (MIC)

AS2 MDN

%AS2.MDN%

Message Disposition Notification. The Internet messaging format used to convey a receipt.

AS2 Message ID

%AS2.MESSAGE_ID%

AS2 message identifier

AS2 Partner ID

%AS2.PARTNER_ID%

Transaction partner's AS2 ID

AS2 Payload

%AS2.PAYLOAD%

Name of the file (or an array of file names if MA is used) being transferred over the AS2 session

AS2 Remote MIC

%AS2.REMOTE_MIC%

Remote AS2 message identification code (MIC)

AS2 Transaction Error

%AS2.TRANSACTION_ERROR%

Error (if any) in the AS2 transaction

AS2 Transaction Result

%AS2.TRANSACTION_RESULT%

Overall transaction result (In Progress, Failure, or Success) of the in-context AS2 transaction

AS2 Transaction Verbose

%AS2.TRANSACTION_VERBOSE%

Verbose message for the AS2 transaction

Cloud Variables

Text Displayed

Variable

Description

Cloud Object Content Length

%CLOUD.OBJ_META_CONTENT_LENGTH%

Object's size in bytes

Cloud Object Content MD5

%CLOUD.OBJ_META_CONTENT_MD5%

Base64-encoded 128-bitMD5 digest of the object

Cloud Object Date

%CLOUD.OBJ_META_DATE%

Object's date from meta data

Cloud Object Last Modified

%CLOUD.OBJ_META_LAST_MODIFIED%

Object's date last modified

Cloud Object Version ID

%CLOUD.OBJ_META_VERSION_ID%

From x-amz-version-id, which is the object version

Cloud Object Key Name

%CLOUD.OBJ_KEY_NAME%

Exact object name (e.g., 4my$-organization, or my.great_photos-2014/jan/myvacation.jpg

File Change

%CLOUD.MONITOR_OPERATION%

Operation of file change (create, delete, and rename)

Connection Variables

Text Displayed

Variable

Description

HTTP Query String
(EFT Enterprise only)

%CONNECTION.HTTP.QUERY_STRING%

HTTP header string

HTTP Headers List
(EFT Enterprise only)

%CONNECTION.HTTP.HEADERS_LIST%

HTTP header list

Local IP

%CONNECTION.LOCAL_IP%

Local IP address used to connect

Local Port

%CONNECTION.LOCAL_PORT%

Local port used to connect

Protocol

%CONNECTION.PROTOCOL%

Protocol used to connect

Remote IP

%CONNECTION.REMOTE_IP%

Remote IP address used to connect

Using Web Transfer Client

%CONNECTION.USING_WEB_TRANSFER_CLIENT%

Indicates whether the user connected via the Web Transfer client

Event Variables

Text Displayed

Variable

Description

Event Date Stamp

%EVENT.DATESTAMP%

Date that the Event was triggered, e.g., 20070828
(suitable for file naming)

Event Full Name

%EVENT.EVENTNAME%

User-defined name for the Event Rule (e.g., My File Renamed Event Rule)

Event Name

%EVENT.NAME%

Server-defined name for the Event trigger (e.g., File Renamed)

Event Reason

%EVENT.REASON%

Action completed successfully or Action Failed

Event Time

%EVENT.TIME%

Date and time that the Event was triggered, e.g., 28 Aug 07 10:01:56
(This variable is not suitable for file naming because of the colons; use %EVENT.DATESTAMP% and %EVENT.TIMESTAMP%  when using variables for a filename.)

Event Time Stamp (including milliseconds)

%EVENT.TIMESTAMP_PRECISE%

Time to the millisecond when Event was triggered (e.g., Event Time Stamp (including milliseconds): 154207233)

Event Timestamp

%EVENT.TIMESTAMP%

Time that the Event was triggered, e.g., 100156
(suitable for file naming)

Event Transaction ID
(EFT Enterprise only)

%EVENT.TRANSACTION_ID%

The Transaction ID as logged by the database EFT is connected to (with ARM). This ID can be used to backtrack and find it in the database manually or to generate queries to the database.

Folder Monitor Failure Reason

%EVENT.MONITORFAILUREREASON%

Reason why the Folder Monitor Rule failed.

Folder Monitor Health

%EVENT.MONITORHEALTH%

Health of network share

File System Variables

Text Displayed

Variable

Description

Report File

%FS.REPORT_FILE%

The full path of the report generated by the Generate Report Action, including the file name. This variable can be used in copy/move, OpenPGP, and custom commands that have a failure Event defined, but should not be used for custom command actions that do not have a failure Event defined.)

In some cases, it may be more appropriate to use %FS.REPORT_CONTENT% because this variable represents a copy of the contents of the file rather than a link to the file, which is only good so long as the file exists. For example, since the file will be deleted when EFT stops processing the Event Rule, do not use this variable in e-mail notifications; use %FS.REPORT_CONTENT% instead.

Report Content

%FS.REPORT_CONTENT%

Contents of the report generated by the Generate Report Action. This variable is typically used after creation of an HTML report, in an email notification action, where it is desirable to embed the HTML contents of the report as the email body.

Report File Name

%FS.REPORT_FILENAME%

The name of a report file created by a Generate Report action. This variable is typically used after creation of a PDF report file, in an email notification, to provide the destination path for the report file after a Copy/Move action deposits it in a more permanent location.

Virtual Path

%FS.VIRTUAL_PATH%

Original virtual location of the file

Physical Path

%FS.PATH%

Original physical location of the file

File Change

%FS.MONITOR_OPERATION%

File change that triggered the Event (added, removed, etc.) Used in Folder Monitor rules

Virtual Folder Name

%FS.VIRTUAL_FOLDER_NAME%

The structure of the virtual folders

Physical Folder Name

%FS.FOLDER_NAME%

Name of the physical folder

Base File Name

%FS.BASE_FILE_NAME%

Name of the file without the extension

File Name

%FS.FILE_NAME%

Name of the file with the extension

File Size

%FS.FILE_SIZE%

Size of the file involved in the Event

File Creation Date

%FS.FILE_CREATE_DATE%

Date the file was created, in the format YYYY/MM/DD, e.g., 8/28/2007 (not suitable for file naming because of the slashes)

File Creation Time

%FS.FILE_CREATE_TIME%

Time the file was created, in the format HH:MM:SS, e.g., 10:01:56 (not suitable for file naming because of the colons)

Virtual Destination Path

%FS.DST_VIRTUAL_PATH%

Virtual destination path of the file involved in the Event

Physical Destination Path

%FS.DST_PATH%

Physical destination path of the file

Physical Destination Folder Name

%FS.DST_FOLDER_NAME%

Physical destination folder

Destination File Name

%FS.DST_FILE_NAME%

Destination file name

Compressed File Physical Path

%FS.COMPRESSED_PATH%

Physical path to the compressed file

Compressed File Name

%FS.COMPRESSED_FILE_NAME%

Name of the compressed file with the extension

Compressed File Base Name

%FS.COMPRESSED_BASE_FILE_NAME%

Name of the compressed file without the extension

Remote Agent Context Variables

The Remote Agent Context Variables can be used in Event Rules. Each of the variables is described below. For more information about using context variables in EFT, refer to EFT Context Variables (List).

Text Displayed

Variable

Description

Remote Agent Name

%AGENT.NAME%

Computer name of remote system running the Remote Agent, enumerated if there is more than one Agent with that name.

Remote Agent Version

%AGENT.VERSION%

Version of Remote Agent update

Remote Agent Last Update Time Stamp

%AGENT.LAST_UPDATE_TIMESTAMP%

Date of last Remote Agent update

Remote Agent Next Update Time Stamp

%AGENT.NEXT_UPDATE_TIMESTAMP%

Date of next scheduled Remote Agent update

Remote Agent NetBIOS Name

%AGENT.COMPUTER_NAME%

Computer name of remote system running the agent

Remote Agent Template

%AGENT.TEMPLATE%

Template name associated with the Agent

Remote Agent Status

%AGENT.STATUS%

Status of Remote Agent (e.g., Active, Pending, Approved, Denied, Banned)

RAM Environment Variables

The RAM can make use of environment variables in RAM Event Rules.

Scheduler (Timer) Rule Variables

The %SOURCE.FILE_NAME% variable is available in the list box of Destination Folder page of the Copy/Move Action and Download Action wizards if the Rule is a Timer/Scheduler Rule.

If one of these non-file-trigger Rules contains an %FS.FILE_NAME% variable, it will be converted to %SOURCE.FILE_NAME% and a WARNING will record the change in the EFT.log.  

The %SOURCE.FILE_NAME% and %SOURCE.BASE_FILE_NAME% can be used in a Timer Rule to download a mask of files (e.g., *.xml), and then FTP offload each of those files to a remote server with a *.TMP extension (%SOURCE.BASE_FILE_NAME%.TMP). After each file transfer is complete, you can then rename each individual file back to its original name (%SOURCE.FILE_NAME%).

Variable

Description

%SOURCE.BASE_FILE_NAME%

Source file name without extension

%SOURCE.FILE_NAME%

Source file name with extension

Server Variables

Text Displayed

Variable

Description

Log Location

%SERVER.LOG_LOCATION%

Location of the log file

New Log File Name

%SERVER.LOG_NEW_NAME%

New name of the log file

New Log File Path

%SERVER.LOG_NEW_PATH%

New path of the log file

Old Log File Name

%SERVER.LOG_OLD_NAME%

Old name of the log file

Old Log File Path

%SERVER.LOG_OLD_PATH%

Old path of the log file

Log Type

%SERVER.LOG_TYPE%

Either Standard or Verbose, per the setting on the Logs Tab

Node Name

%SERVER.NODE_NAME%

Computer name on which EFT is running

Server Running

%SERVER.STATUS%

Indicates whether the EFT service was running when the Event was triggered. (Yes or No)

Private Key ring path

%SERVER_PRIVATE_KEYRING_PATH%

Pass the location of the private key ring to the AWE module

Public Key ring path

%SERVER_PUBLIC_KEYRING_PATH%

Pass the location of the private key ring to the AWE module

Install Directory

%SERVER.INSTALL_DIRECTORY%

Directory in which the server is installed

Site Variables

Text Displayed

Variable

Description

Account Management URL

%SITE.ACCOUNT_MANAGEMENT_URL%

Site account management URL,
https://
../manageaccount:<port> (if port is not equal to 443)

Site Name

%SITE.NAME%

Site name.

Site Running

%SITE.STATUS%

Indicates whether the Site was running when the Event was triggered. (Yes or No)

DMZ Gateway Address

%SITE.DMZ_ADDRESS%

Displays the IP address of the DMZ Gateway

DMZ Gateway Port

%SITE.DMZ_PORT%

Displays the port of the DMZ Gateway

User Variables

Text Displayed

Variable

Description

User can connect using FTP

%USER.ALLOW_FTP%

Indicates whether user is allowed to connect using FTP (Yes or No)

User can connect using SFTP

%USER.ALLOW_SFTP%

Indicates whether user is allowed to connect using SFTP (Yes or No)

User can connect using SSL

%USER.ALLOW_SSL%

Indicates whether user is allowed to connect using SSL (Yes or No)

User can change password

%USER.CAN_CHANGE_PASSWORD%

Indicates whether the user is allowed to change the login password (Yes or No)

Comment

%USER_COMMENT%

Text in the Comment box, if defined in the User Account Details dialog box

Custom 1

%USER.CUSTOM1%

Text in the Custom 1 box, if defined in the User Account Details dialog box

Custom 2

%USER.CUSTOM2%

Text in the Custom 2 box, if defined in the User Account Details dialog box

Custom 3

%USER.CUSTOM3%

Text in the Custom 3 box, if defined in the User Account Details dialog box

Description

%USER.DESCRIPTION%

Description of the user account, as defined on the General tab

E-mail Address

%USER.EMAIL%

E-mail address of the user, if defined in the User Account Details dialog box. You can pass multiple addresses to the Advanced Workflow Engine using this variable.

User is enabled

%USER.ENABLED%

Indicates whether user account is enabled

Account Expiration Date

%USER.EXPIRATION_DATE%

Indicates the date (in the default system locale) when the user account expired. Date , or Never
(See note below.)

Fax Number

%USER.FAX%

Fax number of the user, if defined in the User Account Details dialog box

Full Name

%USER.FULL_NAME%

Full name of the user, if defined on the User Account Details dialog box

Groups

%USER.GROUPS%

Groups in which the user is a member

Home Folder

%USER.HOME_FOLDER%

User's home folder

Home IP

%USER.HOME_IP%

IP address of the user

Home Folder is Root

%USER.HOME_IS_ROOT%

Indicates whether the Treat Home Folder as Root check box is selected. (Yes or No)

Invalid login attempts

%USER.INVALID_LOGINS%

Number of invalid login attempts by the user

User is locked out

%USER.IS_LOCKED_OUT%

Indicates whether user account is locked

Last Login Date

%USER.LAST_LOGIN%

Provides the date and time (in the default system locale) the user last logged in to EFT

Logon Name

%USER.LOGIN%

Login username of the user

Pager Number

%USER.PAGER%

Pager number of the user, if defined in the User Account Details dialog box

Logon Password

%USER.PASSWORD%

Login password of the user

Password Expiration Date

%USER.PASSWORD_EXPIRATION%

Provides the date and time (in the default system locale when the user account is set to expire, or Never
(See note below.)

Phone Number

%USER.PHONE%

Phone number of the user, if defined in the User Account Details dialog box

Quota Max

%USER.QUOTA_MAX%

Max disk space specified for the user

Quota Used

%USER.QUOTE_USED%

Amount of disk space in use by the user

User Must Change Password at Next Login

%USER.RESET_PASSWORD_AT_FIRST_LOGIN%

Indicates whether user is required to reset the account password at first log in (Yes or No).  
(See note below.)

Settings Template

%USER.SETTINGS_LEVEL%

Settings Template of the user

 

For %USER.EXPIRATION_DATE%, %USER.RESET_PASSWORD_AT_FIRST_LOGIN% and %USER.PASSWORD_EXPIRATION%, if the ASM is disabled (not in Activated or Trial state), No or Never is displayed.

Workspaces-Related Variables

The variables below are for use in Event Rules. The Workspaces notifications use different variables.

Text Displayed

Variable

Value Contained in Variable

Workspace Virtual Path

%WORKSPACE.VIRTUAL_PATH%

Virtual path of the Workspace

Workspace Physical Path

%WORKSPACE.PATH%

Physical path of the Workspace

Workspace Name

%WORKSPACE.NAME%

Name of the Workspace Folder

Workspace Participants List

%WORKSPACE.PARTICIPANTS%

Participants sharing the Workspace

Workspace Owner

%WORKSPACE.OWNER%

Owner of the Workspace

Workspace Owner Email Address

%WORKSPACE.OWNER_EMAIL%

Email address of the owner of the Workspace; the variable is case sensitive when used in the To, Cc, or Bcc fields of email notifications.

Workspace User

%WORKSPACE.USER_NAME%

Username of the Workspace participant

Workspace User Permissions

%WORKSPACE.USER_PERMISSIONS%

User permissions of the Workspace

Workspace User Email Address

%WORKSPACE.USER_EMAIL%

User email of the participant

Workspace User Account Exists

%WORKSPACE.USER_ACCOUNT_EXISTS%

Identifies whether the user account exists (or needs to be created)

Transfer Properties Variables

Text Displayed

Variable

Value Contained in Variable

Transfer rate

%TRANSFER.RATE_KBPS%

Average speed of transfer (total bytes transferred/total seconds to transfer) Displayed in kilobytes per second (KBps).

Transferred bytes

%TRANSFER.BYTES%

Total number of bytes in the transfer.

NOTE: By default FTP uses built-in compression (MODE Z); therefore, it is possible for transferred bytes to be less than the file size. Moreover, the values for FTPS, SFTP, and HTTP could differ from file size due to internal compression and protocol overheads.

Transfer seconds

%TRANSFER.SECONDS%

Total number of seconds it took to transfer