Page History
Placeholders are primarily used for generic notes.ini variables (e.g. MC_DB=%notes_homeserver%!!panagenda\panagenda.nsf) and for a handful of special actions in the configuration database (e.g. Backup, Roaming and Location actions).
| Note |
|---|
| Placeholders are replaced when reading a corresponding notes.ini entry, respectively DURING THE EXECUTION of an Action. Contrary to references if resolving a placeholder fails, the respective Action is still executed. |
In the notes.ini/Notes preference file
explanationPlaceholders can be used in the following MC notes.ini variables:
MC_DB, MC_DB_Unavailable, MC_DB_NotResolvable, MC_WorkingDirectory, MC_NetworkDirectory, MC_ActionsXMLStubPath
Placeholder | Corresponding reference namespace/setting | |
|---|---|---|
| %notes%NOTES_homeserver%HOMESERVER% | notes:homeserver | Used to generically point each user to her/his respective mail server for the MarvelClient Configuration database in notes.ini, e.g. MC_DB=%notes_homeserver%!!panagenda\panagenda.nsf (= default) Only supported for notes.ini MC_DB, and MC_DB_Unavailable |
| %notes%NOTES_data%DATA% | notes:data_directory | Full path of HCL Notes data directory |
| %notes%NOTES_shareddata%SHAREDDATA% | notes:shareddata_directory | Shared data directory |
| %notes%NOTES_client%CLIENT% | notes:client_directory | Full path of HCL Notes client directory |
| %os%OS_systemSYSTEM_root%ROOT% | os:system_root | Operating system binaries directory (e.g. C:\Windows or /Applications) |
| %os%OS_system%SYSTEM% | os:system | The operating system folder |
| %os%OS_programPROGRAM_files%FILES% | os:program_files | Operating system program files directory |
| %os%OS_appAPP_data%DATA% | os:app_data | Operating System Application Data Directory |
| %os%OS_commonCOMMON_appAPP_data%DATA% | os:common_app_data | Common application data directory |
| %os%OS_localLOCAL_appAPP_data%DATA% | os:local_app_data | The users application data directory |
| %os%OS_userUSER_profile%PROFILE% | os:user_profile | Operating system user profile directory |
| %os%OS_temp%TEMP% | os:temp | The users temp directory |
| %env%ENV_*% | env:* | Replaced with the value of an operating system environment variable; available variables names and values depend on the respective target user's operating system environment. |
| %registry%REGISTRY_*% | registry:* | For example %registry_HKEY_CURRENT_USER\Software\panagenda\subkey% will resolve the value of "subkey" in the key "HKEY_CURRENT_USER\Software\panagenda" |
For Backup/Roaming keys
Placeholders are used for backup/roaming keys
...
explanationinstead of references for two reasons
- The action needs both the replaced and the original value (e.g. %OS_USER%) to see if a key matches a certain set
- For backup actions that target the filesystem the keys also define the folder names, these placeholders replace character that the OS would not allow in folder/file names
Placeholder | Corresponding reference namespace/setting | |
|---|---|---|
| %notes%NOTES_user%USER% %notes%NOTES_userUSER_abbreviated%ABBREVIATED% %notes%NOTES_userUSER_commonCOMMON_name%NAME% | notes:user notes:user_abbreviated notes:user_common_name | In filesystem backup actions this often defines the folder name. To guarantee valid filesystem paths spaces are replaced with underscores, slashes with a exclamation marks |
| %notes%NOTES_version%VERSION% | notes:version | e.g. 11.0.1 |
| %notes%NOTES_versionVERSION_major%MAJOR% | notes:version_major | |
| %os%OS_user%USER% | os:user | Operating system user |
| %os%OS_computer%COMPUTER% | os:computer | Name of host machine; replaced with "Citrix" if os:citrix=1 (also applies to other terminal server types) |
| %os%OS_computerCOMPUTER_org%ORG% | os:computer_org | Name of host machine (Citrix server name on Citrix and alike) |
| %os%OS_deviceDEVICE_type%TYPE% | os:device_type | the type of the computer, e.g. IPad Air 2 |
%os%OS_userUSER_hash%HASH% | Salted MD5 hash of os:user/os:computer/os:computer_org. Used in Application Usage action to anonymize data | |
%ini%INI_customCUSTOM_placeholder%PLACEHOLDER% | %ini_custom_placeholder% - gets replaced by contents of ini variable MC_custom_placeholder. This variable itself may contain placeholders. %mc_custom_placeholder% - gets replaced by contents of config variable mc:custom_placeholder. Subject to be used when so instructed by support | |
| %date%DATE_formatFORMAT_*% | %DATE_FORMAT_*%. Y=Year (4 digits), M=Month (1..12), W=Week (00..53), D=Day (01..31). replaced string also contains format prefix to avoid overlaps. example: %DATE_FORMAT_YW% = Y2017W37 |
For Location actions
...
Placeholder | Corresponding reference namespace/setting | |
|---|---|---|
| %LOOKUP_MAILSERVER% | notes:userdetails_mailserver | The users home/mail server in canonicalized form, e.g. CN=server/O=company |
| %LOOKUP_MAILLOCATION% | notes:userdetails_maillocation | The full path of the mail file on the user's home server, e.g. CN=server/O=company!!mail/user.nsf |
| %LOOKUP_MAILLOCATION_AUTODETECT% | notes:userdetails_maillocation or notes:userdetails_mailfile_local | This will lookup the full path of the mail file according to the type of location being managed: For locations pointing to a server mail file this will return %LOOKUP_MAILLOCATION% |
| %LOOKUP_MAILFILE% | notes:userdetails_mailfile | The path of the mail file on the user's home server, e.g. mail/user.nsf |
| %LOOKUP_MAILFILE_LOCAL% | notes:userdetails_mailfile_local | The path of the local mail file replica, e.g. mail/user.nsf |
| %LOOKUP_MAILFILE_AUTODETECT% | notes:userdetails_mailfile or notes:userdetails_mailfile_local | This will lookup the path of the mail file according to the type of location being managed: For locations pointing to the server mail file this will return %LOOKUP_MAILFILE% |
| %LOOKUP_MAILREPID% | notes:userdetails_mailrepid | The replica id, e.g. A12272D7:005F2ACB |
| %LOOKUP_INTERNETMAILADDRESS% | notes:userdetails_internetaddress | The users mail address |
| %LOOKUP_SHORTNAME% | notes:userdetails_shortname | The first short name of the user |
Topics
- References - Namespaces
- References - Syntax
- References in References
- Special References to Desktop Icon Actions