Table of Contents
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 ID | Name | callable object | UI header bar | logfile | helpfile path | log message |
|---|---|---|---|---|---|---|
Name of | Description | C | U | L | H | M |
$application | ID of selected application | - | - | X | X | - |
$callableFullDbName | qualified database name of current callable object | X | - | - | - | - |
$catalogId | ID of the table | X | - | - | - | - |
$catalogId_1 | ID of main grid | X | - | - | - | - |
$catalogId_2 | ID of 1st detail table | X | - | - | - | - |
$catalogId_3 | ID of 2nd detail table | X | - | - | - | - |
$catalogId_4 | ID of 3rd detail table | X | - | - | - | - |
$catalogIdCurrent | ID where last row-selection happened | X | - | - | - | - |
$catalogInstanceId | ID.instance name (CIID) | X | - | - | - | - |
$catalogInstanceId_1 | catalog id.instance name main grid | X | - | - | - | - |
$catalogInstanceId_2 | catalog id and instance name of the 1st detail | X | - | - | - | - |
$catalogInstanceId_3 | catalog id and instance name of the 2nd detail | X | - | - | - | - |
$catalogInstanceId_4 | catalog id and instance name of the 3rd detail | X | - | - | - | - |
$catalogInstanceIdCurrent | CIID name where last row-selection happened | X | - | - | - | - |
$claim | product claim | - | X | - | - | - |
$client | selected client | X | X | X | - | - |
$company | company name | - | X | - | - | - |
$connection | name of connection | - | - | X | - | - |
$connectionType | type of the connection | X | - | - | - | - |
$date | System date formated YYYY.MM.DD | X | - | X | - | - |
$dbName | database name | X | - | - | - | - |
$domain | domain/connection | X | - | X | - | - |
$email | user's email address | X | - | - | - | - |
$firstName | user's firstname | X | X | - | - | - |
$fullDbName | qualified database name | X | - | - | - | - |
$fullTableName | full qualified tablename (with db (and schema) name | X | - | - | - | - |
$fullUsername | user's fullname | X | X | - | - | - |
$installation | value of INSTALLATION_NAME constant | X | X | X | X | - |
$instanceName | instance name of the table | X | - | - | - | - |
$instanceName_1 | instance name of the main grid | X | - | - | - | - |
$instanceName_2 | instance name of the 1st detail table | X | - | - | - | - |
$instanceName_3 | instance name of the 2nd detail table | X | - | - | - | - |
$instanceName_4 | instance name of the 3rd detail table | X | - | - | - | - |
$instanceNameCurrent | instance name where last row-selection happened | X | - | - | - | - |
$lang | language setting of the user | X | X | - | - | - |
$langSystem | active admin area language | X | X | - | - | - |
$langGrid | active grid area language | X | - | - | - | - |
$lastName | user's lastname | X | X | - | - | - |
$msgGuid | GUID of the message | X | - | - | - | - |
$product | software product name | X | X | - | - | - |
$phone | user's phone number | X | X | - | - | - |
$rowWhere | primary key values concatenated with AND operator | X | - | - | - | - |
$sessionId | current session ID | X | X | - | - | - |
$tableName | table name(without db name and schema name) | X | - | - | - | - |
$uca | content of user communication area | X | - | - | - | - |
$userName | user's name | X | X | X | X | - |
$uploadPath | path of the file | - | - | - | - | - |
$uploadFolder | path of the target folder | - | - | - | - | - |
$uploadFile | only the file name (with extension) | - | - | - | - | - |
$year | year of system date | - | - | X | - | - |
$yyyymm | year+month of system date | - | - | X | - | - |
| qualified placeholders | ||||||
$par.{<parameter name>} | substitute with the value of the parameter | X | - | - | - | - |
$col.{<colName>} | column value of the selected row | X | - | - | - | - |
$sys.Date | current date in format 'YYYY-MM-DD' | X | X | - | - | - |
$sys.Timestamp | current timestamp in format 'YYYY-MM-DD-HH:MM:SS' | X | X | - | - | - |
Substitutions in logfile filenname
For example: admin_action_$yyyymm.log.
Logfiles are saved into the application folder /log subfolder.
Database and catalog object related variables
$installation defined in conf/my_formatting.php file
$client - actual niota-client which was chosen before log in act
$connectionType - type of the connection eg.: 'oci805'.
$domain - connection name
$dbName - database name. In the case of SQL Server it contains schema name too.