Internal Variables

Internal variables are predefined by NiceLabel Automation. Their values are assigned automatically and are available in read-only mode. The icon with lock symbol in front of the variable name distinguishes internal variables from user-defined variables. You can use internal variables in your actions in the same way as you would use the user-defined variables. The trigger related internal variables work as internal variables for each trigger.

Internal variable

Available in trigger

Description

ActionLastErrorDesc

All

Provides the description of the last occurred error. Use this value as feedback to host system to identify the fault cause.

ActionLastErrorID

All

Provides the last error ID. This is integer value. When value is 0, there was no error. You can use this value in conditions, evaluating if there was some error or not.

BytesOfReceivedData

TCP/IP

Provides the number of bytes received by the trigger.

ComputerName

All

Provides the name of the computer where the configuration runs.

ConfigurationFileName

All

Provides the path and file name of the current configuration (.MISX file).

ConfigurationFilePath

All

Provides the path of the current configuration file. Also see description for ConfigurationFileName.

DataFileName

All

Provides the path and file name of the working copy of received data. Each time the trigger accepts the data, it makes a backup copy of it to the unique file name identified by this variable.

Database

Database

Provides the database type as configured in the trigger.

Date

All

Provides the current date in the format as specified by system locale, such as 26.2.2018.

DateDay

All

Provides the current number of the day in a month, such as 26.

DateMonth

All

Provides the current number of the month in the year, such as 2.

DateYear

All

Provides the current number of the year, such as 2018.

DefaultPrinterName

All

Provides the name of printer driver, which is defined as default.

DriverType

Database

Provides the name of the driver used to connect to the selected database.

Hostname

TCP/IP

Provides the host name of device/computer connecting to the trigger.

HttpMethodName

HTTP

Provides the method name the user has provided in the HTTP request, such as GET or POST.

HttpPath

HTTP

Provides the path defined in the HTTP trigger.

HttpQuery

HTTP

Provides the contents of the query string as received by the HTTP trigger.

NumberOfRowsReturned

Database

Provides the number of rows that the trigger gets from a database.

LocalIP

TCP/IP

Provides the local IP address at which the trigger responds to. This is useful if you have a multi-homing machine with several network interface cards (NIC), and want to determine to which IP address the client connected to. This is useful for printer replacement scenarios.

PathDataFileName

All

Provides the path in the DataFileName variable, without the file name. Also see description for DataFileName.

PathTriggerFileName

File

Provides the path in the TriggerFileName variable, without the file name. Also see description for TriggerFileName.

Port

TCP/IP, HTTP, Web Service

Provides the port number as defined in the trigger.

RemoteHttpIp

HTTP

Provides the host name of device/computer connecting to the trigger.

RemoteIp

Web Service

Provides the host name of device/computer connecting to the trigger.

ShortConfigurationFileName

All

Provides the file name of the configuration file, without a path, Also see description for ConfigurationFileName.

ShortDataFileName

All

Provides the file name to the DataFileName variable, without the path. Also see description for DataFileName.

ShortTriggerFileName

File

Provides the file name to the TriggerFileName variable, without the path. Also see description for TriggerFileName.

SystemUserName

All

Provides the Windows name of the logged-in user.

TableName

Database

Provides the name of the table as used in the trigger.

Time

All

Provides the current time in the format as specified by system locale, such as 15:18.

TimeHour

All

Provides the current hour value, such as 15.

TimeMinute

All

Provides the current minute value, such as 18.

TimeSecond

All

Provides the current second value, such as 25.

TriggerFileName

File

Provides the file name that triggered actions. This is useful when you monitor a set of files in the folder, so you can identify which file exactly triggered actions.

TriggerName

All

Provides the name of the trigger as defined by the user.

Username

All

Provides the NiceLabel Automation user name of the currently logged in user. The variable has contents only if the user login is enabled.