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/04 12:17] admin |
niota-docs:niota_variables [2025/12/05 10:05] (current) admin |
||
|---|---|---|---|
| Line 5: | Line 5: | ||
| ^Placeholder ID^Name^callable object^UI header bar^logfile^helpfile path^log message^ | ^Placeholder ID^Name^callable object^UI header bar^logfile^helpfile path^log message^ | ||
| |''Name of ''|Description |C|U|L|H|M| | |''Name of ''|Description |C|U|L|H|M| | ||
| + | |''$application''|ID of selected application |-|-|X|X|-| | ||
| |''$callableFullDbName''|qualified database name of current callable object |X|-|-|-|-| | |''$callableFullDbName''|qualified database name of current callable object |X|-|-|-|-| | ||
| |''$catalogId''|ID of the table |X|-|-|-|-| | |''$catalogId''|ID of the table |X|-|-|-|-| | ||
| Line 18: | Line 19: | ||
| |''$catalogInstanceId_4''|catalog id and instance name of the 3rd detail |X|-|-|-|-| | |''$catalogInstanceId_4''|catalog id and instance name of the 3rd detail |X|-|-|-|-| | ||
| |''$catalogInstanceIdCurrent''|CIID name where last row-selection happened |X|-|-|-|-| | |''$catalogInstanceIdCurrent''|CIID name where last row-selection happened |X|-|-|-|-| | ||
| + | |''$claim''|product claim |-|X|-|-|-| | ||
| |''$client''|selected client |X|X|X|-|-| | |''$client''|selected client |X|X|X|-|-| | ||
| + | |''$company''|company name |-|X|-|-|-| | ||
| + | |''$connection''|name of connection |-|-|X|-|-| | ||
| |''$connectionType''|type of the connection |X|-|-|-|-| | |''$connectionType''|type of the connection |X|-|-|-|-| | ||
| |''$date''|System date formated YYYY.MM.DD |X|-|X|-|-| | |''$date''|System date formated YYYY.MM.DD |X|-|X|-|-| | ||
| |''$dbName''|database name |X|-|-|-|-| | |''$dbName''|database name |X|-|-|-|-| | ||
| - | |''$domain''|domain/connection |X|-|-|-|-| | + | |''$domain''|domain/connection |X|-|X|-|-| |
| |''$email''|user's email address |X|-|-|-|-| | |''$email''|user's email address |X|-|-|-|-| | ||
| - | |''$firstName''|user's firstname |X|-|-|-|-| | + | |''$firstName''|user's firstname |X|X|-|-|-| |
| |''$fullDbName''|qualified database name |X|-|-|-|-| | |''$fullDbName''|qualified database name |X|-|-|-|-| | ||
| |''$fullTableName''|full qualified tablename (with db (and schema) name |X|-|-|-|-| | |''$fullTableName''|full qualified tablename (with db (and schema) name |X|-|-|-|-| | ||
| - | |''$fullUsername''|user's fullname |X|-|-|-|-| | + | |''$fullUsername''|user's fullname |X|X|-|-|-| |
| - | |''$installation''|value of INSTALLATION_NAME constant |X|-|-|-|-| | + | |''$installation''|value of INSTALLATION_NAME constant |X|X|X|X|-| |
| |''$instanceName''|instance name of the table |X|-|-|-|-| | |''$instanceName''|instance name of the table |X|-|-|-|-| | ||
| |''$instanceName_1''|instance name of the main grid |X|-|-|-|-| | |''$instanceName_1''|instance name of the main grid |X|-|-|-|-| | ||
| Line 35: | Line 39: | ||
| |''$instanceName_4''|instance name of the 3rd detail table |X|-|-|-|-| | |''$instanceName_4''|instance name of the 3rd detail table |X|-|-|-|-| | ||
| |''$instanceNameCurrent''|instance name where last row-selection happened |X|-|-|-|-| | |''$instanceNameCurrent''|instance name where last row-selection happened |X|-|-|-|-| | ||
| - | |''$lang''|language setting of the user |X|-|-|-|-| | + | |''$lang''|language setting of the user |X|X|-|-|-| |
| - | |''$langSystem''|active admin area language |X|-|-|-|-| | + | |''$langSystem''|active admin area language |X|X|-|-|-| |
| |''$langGrid''|active grid area language |X|-|-|-|-| | |''$langGrid''|active grid area language |X|-|-|-|-| | ||
| - | |''$lastName''|user's lastname |X|-|-|-|-| | + | |''$lastName''|user's lastname |X|X|-|-|-| |
| |''$msgGuid''|GUID of the message |X|-|-|-|-| | |''$msgGuid''|GUID of the message |X|-|-|-|-| | ||
| - | |''$phone''|user's phone number |X|-|-|-|-| | + | |''$product''|software product name |X|X|-|-|-| |
| + | |''$phone''|user's phone number |X|X|-|-|-| | ||
| |''$rowWhere''|primary key values concatenated with AND operator |X|-|-|-|-| | |''$rowWhere''|primary key values concatenated with AND operator |X|-|-|-|-| | ||
| - | |''$sessionId''|current session ID |X|-|-|-|-| | + | |''$sessionId''|current session ID |X|X|-|-|-| |
| |''$tableName''|table name(without db name and schema name) |X|-|-|-|-| | |''$tableName''|table name(without db name and schema name) |X|-|-|-|-| | ||
| |''$uca''|content of user communication area |X|-|-|-|-| | |''$uca''|content of user communication area |X|-|-|-|-| | ||
| - | |''$userName''|user's name |X|-|-|-|-| | + | |''$userName''|user's name |X|X|X|X|-| |
| |''$uploadPath''|path of the file |-|-|-|-|-| | |''$uploadPath''|path of the file |-|-|-|-|-| | ||
| |''$uploadFolder''|path of the target folder |-|-|-|-|-| | |''$uploadFolder''|path of the target folder |-|-|-|-|-| | ||
| |''$uploadFile''|only the file name (with extension) |-|-|-|-|-| | |''$uploadFile''|only the file name (with extension) |-|-|-|-|-| | ||
| + | |''$year''|year of system date |-|-|X|-|-| | ||
| + | |''$yyyymm''|year+month of system date |-|-|X|-|-| | ||
| |qualified placeholders||||||| | |qualified placeholders||||||| | ||
| |''$par.{<parameter name>}''|substitute with the value of the parameter |X|-|-|-|-| | |''$par.{<parameter name>}''|substitute with the value of the parameter |X|-|-|-|-| | ||
| - | |''$col.{colName}''|column value of the selected row |X|-|-|-|-| | + | |''$col.{<colName>}''|column value of the selected row |X|-|-|-|-| |
| - | |''$sys.Date''|current date in format 'YYYY-MM-DD' |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|-|-|-|-| | + | |''$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.\\ | + | |
| + | {{:niota-docs:pasted:20251205-100500.png}} | ||
| + | |||
| + | For example: admin_action_$yyyymm.log.\\ | ||
| Logfiles are saved into the application folder /log subfolder. | Logfiles are saved into the application folder /log subfolder. | ||
| - | |||
| - | ==== Substitutions for callable objects ==== | ||
| === 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.1764847038.txt.gz · Last modified: 2025/12/04 12:17 by admin