niota

fascinating. logical.

User Tools

Site Tools


niota-docs:niota_variables

This is an old revision of the document!


Placeholders

Below a list of placeholders or system wildcard and the info where you can use this strings. If this string is used in another string, then the placeholder/the wildcard is replaced by the current value of this placeholder. You can not set the value of the placeholder on your own. It's set only be the system itself. Therefore it's just a placeholder, not a variable.

Placeholder IDNamecallable objectUI header barlogfilehelpfile pathlog message
Name of Description CULHM
$callableFullDbNamequalified database name of current callable object X----
$catalogIdID of the table X----
$catalogId_1ID of main grid X----
$catalogId_2ID of 1st detail table X----
$catalogId_3ID of 2nd detail table X----
$catalogId_4ID of 3rd detail table X----
$catalogIdCurrentID where last row-selection happened X----
$catalogInstanceIdID.instance name (CIID) X----
$catalogInstanceId_1catalog id.instance name main grid X----
$catalogInstanceId_2catalog id and instance name of the 1st detail X----
$catalogInstanceId_3catalog id and instance name of the 2nd detail X----
$catalogInstanceId_4catalog id and instance name of the 3rd detail X----
$catalogInstanceIdCurrentCIID name where last row-selection happened X----
$clientselected client XXX--
$connectionTypetype of the connection X----
$dateSystem date formated YYYY.MM.DD X-X--
$dbNamedatabase name X----
$domaindomain/connection X----
$emailuser's email address X----
$firstNameuser's firstname X----
$fullDbNamequalified database name X----
$fullTableNamefull qualified tablename (with db (and schema) name X----
$fullUsernameuser's fullname X----
$installationvalue of INSTALLATION_NAME constant X----
$instanceNameinstance name of the table X----
$instanceName_1instance name of the main grid X----
$instanceName_2instance name of the 1st detail table X----
$instanceName_3instance name of the 2nd detail table X----
$instanceName_4instance name of the 3rd detail table X----
$instanceNameCurrentinstance name where last row-selection happened X----
$langlanguage setting of the user X----
$langSystemactive admin area language X----
$langGridactive grid area language X----
$lastNameuser's lastname X----
$msgGuidGUID of the message X----
$phoneuser's phone number X----
$rowWhereprimary key values concatenated with AND operator X----
$sessionIdcurrent session ID X----
$tableNametable name(without db name and schema name) X----
$ucacontent of user communication area X----
$userNameuser's name X----
$uploadPathpath of the file -----
$uploadFolderpath of the target folder -----
$uploadFileonly the file name (with extension) -----
qualified placeholders
$par.{<parameter name>}substitute with the value of the parameter X----
$col.{colName}column value of the selected row X----
$sys.Datecurrent date in format 'YYYY-MM-DD' X----
$sys.Timestampcurrent timestamp in format 'YYYY-MM-DD-HH:MM:SS' X----

Substitutions in logfile filenname

For example: log_$date.txt.
Logfiles are saved into the application folder /log subfolder.

Substitutions for callable objects

$installation - current niota instance. Uses the value of INSTALLATION_NAME constant, defined in conf/my_formatting.php file
$client - actual niota-client which was chosen before log in act
$connectionType - type of the connection where that table is placed where the callable object was executed (eg.: 'oci805'. Makes no sense in the dynamic menu)
$domain - connection name
$dbName - database name. In the case of SQL Server it contains schema name too.
$fullDbName - prefix which needs to fully qualify a table. Oracle: db_username, SQL Server: db_name.schema_name, Teradata, MySQL: db_name. Ends without a dot character.
$callableFullDbName - prefix which needs to fully qualify the current callable object
$fullTableName - the actual table name substitution (with db (and schema) name. In the case of Oracle it is equals with $tableName.)
$tableName - actual table name substitution (without db name and schema name)
$catalogId - catalog id of the table
$instanceName - instance name of the table
$catalogInstanceId - catalog id and instance name of the loaded (or master) table concatenated with a '.' (dot) character
$catalogId_1 - catalog id of the of the loaded (or master) table, master grid in a master-detail configuration
$catalogId_2 - catalog id of the 1st detail table
$catalogId_3 - catalog id of the 2nd detail table
$catalogId_4 - catalog id of the 3rd detail table
$instanceName_1 - instance name of the loaded (or master) table, master grid in a master-detail configuration
$instanceName_2 - instance name of the 1st detail table
$instanceName_3 - instance name of the 2nd detail table
$instanceName_4 - instance name of the 3rd detail table
$catalogInstanceId_1 - catalog id and instance name of the loaded (or master) table, master grid in a master-detail configuration
$catalogInstanceId_2 - catalog id and instance name of the 1st detail grid in a master-detail configuration
$catalogInstanceId_3 - catalog id and instance name of the 2nd detail grid in a master-detail configuration
$catalogInstanceId_4 - catalog id and instance name of the 3rd detail grid in a master-detail configuration
$catalogIdCurrent - catalog id of the table where last row-selection happened. It can be the master or a detail grid.
$instanceNameCurrent - instance name of the table where last row-selection happened. It can be the master or a detail grid.
$catalogInstanceIdCurrent - catalog id and instance name of the table where last row-selection happened. It can be the master or a detail grid.
$rowWhere - primary key values concatenated with AND operator - useable in SQL queries
$lang - language setting of the user
$langSystem - active admin area language
$langGrid - active grid area language

Variables (mainly) for calling a callable object

$par.{<parameter name>} - substitute with the value of the parameter - only in case of parameter set bind to callable object
$uca - content of user communication area - in case of callable object

Variables (mainly) for messaging feature

$sessionId - current session, given by the web server
$msgGuid - GUID of the message
callableFullDbName - database name of the callable object. It contains schema name also in the case of MSSQL

$uploadPath - path of the file
$uploadFolder - path of the target folder
$uploadFile - only the file name (with extension)

Possible substitutions also for line level stored procedures

$col.{colName} - substituted with column value of the selected row (eg.: delete from example_table where column_name like '$col.{example_column}' )

Available system information

$sys.Date = current date in format 'YYYY-MM-DD'
$sys.Timestamp = current timestamp in format 'YYYY-MM-DD-HH:MM:SS'

niota-docs/niota_variables.1764848429.txt.gz · Last modified: 2025/12/04 12:40 by admin