User Tools
niota-docs:niota_variables
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
niota-docs:niota_variables [2025/12/03 16:12] admin |
niota-docs:niota_variables [2025/12/05 10:05] (current) admin |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ===== Placeholders ===== | ===== Placeholders ===== | ||
| - | Below a list of placeholders or system wildcard and the info where you can use this strings. If this string is used in other string, than the placeholder/the wildcard is replaced by the current value of this placeholder. | + | 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^log filename^callable strings^callable string^next^ | + | |
| - | |''$date''|System date formated YYYY.MM.DD|Y|-|-|-| | + | |
| - | |''$domain''|domain/connection|Y|-|-|-| | + | |
| - | |''$tableName''|current table name substitution|X|X|-|-| | + | |
| - | |''$userName''|current user's name|X|X|-|-| | + | |
| - | |''$firstName''|current user's firstname|X|X|-|-| | + | |
| - | |''$lastName''|current user's lastname|X|X|-|-| | + | |
| - | |''$fullUsername''|current user's fullname|X|X|-|-| | + | |
| - | |''$email''|current user's email address|X|X|-|-| | + | |
| - | |''$phone''|current user's phone number|X|X|-|-| | + | |
| - | |''$installation''|value of INSTALLATION_NAME constant|X|X|X|-| | + | |
| - | |''$client''|actual niota-client which was chosen before log in act|X|X|X|-| | + | |
| - | |''$connectionType''|type of the connection where that table is placed|X|X|X|-| | + | |
| - | |''$dbName''|database name. In the case of SQL Server it contains schema name too.\\ | + | |
| - | |''$fullDbName''|prefix which needs to fully qualify a table|X|X|X|-| | + | |
| - | |''$callableFullDbName''|prefix which needs to fully qualify the current callable object|X|X|X|-| | + | |
| - | |''$fullTableName''|the actual table name substitution (with db (and schema) name. In the case of Oracle it is equals with $tableName.)|X|X|X|-| | + | |
| - | |''$tableName''|actual table name substitution (without db name and schema name)|X|X|X|-| | + | |
| - | |''$catalogId''|catalog id of the table|X|X|X|-| | + | |
| - | |''$instanceName''|instance name of the table|X|X|X|-| | + | |
| - | |''$catalogInstanceId''|catalog id and instance name of the loaded (or master) table concatenated with a '.' (dot) character|X|X|X|-| | + | |
| - | |''$catalogId_1''|catalog id of the of the loaded (or master) table, master grid in a master-detail configuration|X|X|X|-| | + | |
| - | |''$catalogId_2''|catalog id of the 1st detail table|X|X|X|-| | + | |
| - | |''$catalogId_3''|catalog id of the 2nd detail table|X|X|X|-| | + | |
| - | |''$catalogId_4''|catalog id of the 3rd detail table|X|X|X|-| | + | |
| - | |''$instanceName_1''|instance name of the loaded (or master) table, master grid in a master-detail configuration|X|X|X|-| | + | |
| - | |''$instanceName_2''|instance name of the 1st detail table|X|X|X|-| | + | |
| - | |''$instanceName_3''|instance name of the 2nd detail table|X|X|X|-| | + | |
| - | |''$instanceName_4''|instance name of the 3rd detail table|X|X|X|-| | + | |
| - | |''$catalogInstanceId_1''|catalog id and instance name of the loaded (or master) table, master grid in a master-detail configuration|X|X|X|-| | + | |
| - | |''$catalogInstanceId_2''|catalog id and instance name of the 1st detail grid in a master-detail configuration|X|X|X|-| | + | |
| - | |''$catalogInstanceId_3''|catalog id and instance name of the 2nd detail grid in a master-detail configuration|X|X|X|-| | + | |
| - | |''$catalogInstanceId_4''|catalog id and instance name of the 3rd detail grid in a master-detail configuration|X|X|X|-| | + | |
| - | |''$catalogIdCurrent''|catalog id of the table where last row-selection happened. It can be the master or a detail grid.|X|X|X|-| | + | |
| - | |''$instanceNameCurrent''|instance name of the table where last row-selection happened. It can be the master or a detail grid.|X|X|X|-| | + | |
| - | |''$catalogInstanceIdCurrent''|catalog id and instance name of the table where last row-selection happened. It can be the master or a detail grid.|X|X|X|-| | + | |
| - | |''$rowWhere''|primary key values concatenated with AND operator - useable in SQL queries|X|X|X|-| | + | |
| - | |''$lang''|language setting of the user|X|X|X|-| | + | |
| - | |''$langSystem''|active admin area language|X|X|X|-| | + | |
| - | |''$langGrid''|active grid area language|X|X|X|-| | + | |
| + | ^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 ==== | ==== Substitutions in logfile filenname ==== | ||
| - | For example: log_$date.txt.\\ | ||
| - | Logfiles are saved into the application folder /log subfolder. | ||
| - | ==== Substitutions for callable objects ==== | + | {{:niota-docs:pasted:20251205-100500.png}} |
| - | === User related variables === | + | For example: admin_action_$yyyymm.log.\\ |
| + | Logfiles are saved into the application folder /log subfolder. | ||
| - | ''$userName'' - actual user's name\\ | ||
| - | ''$firstName'' - actual user's firstname\\ | ||
| - | ''$lastName'' - actual user's lastname\\ | ||
| - | ''$fullUsername'' - actual user's fullname\\ | ||
| - | ''$email'' - actual user's email address\\ | ||
| - | ''$phone'' - actual user's phone number\\ | ||
| === Database and catalog object related variables === | === Database and catalog object related variables === | ||
| - | ''$installation'' - current niota instance. Uses the value of INSTALLATION_NAME constant, defined in conf/my_formatting.php file\\ | + | ''$installation'' defined in conf/my_formatting.php file\\ |
| ''$client'' - actual niota-client which was chosen before log in act\\ | ''$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)\\ | + | ''$connectionType'' - type of the connection eg.: 'oci805'. |
| ''$domain'' - connection name\\ | ''$domain'' - connection name\\ | ||
| ''$dbName'' - database name. In the case of SQL Server it contains schema name too.\\ | ''$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\\ | ||
| - | |||
| - | === File upload related substitutions === | ||
| - | |||
| - | ''$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.1764774765.txt.gz · Last modified: 2025/12/03 16:12 by admin