Argument Templates

Argument templates are a set of predefined text substitution commands which can be used when providing arguments to a LogViewPlus command or parser. Argument templates are written with the syntax ${TEMPLATE}. When an argument template is found, LogViewPlus will replace the template with its in memory value. This allows LogViewPlus to provide arguments such as "the currently selected log file" to the target process.

LogViewPlus supports the following argument templates. Some templates may be dependent on the type of command being executed. For example the ${REPORT_FILE} template is specific to report command execution. For more information, please see the table provided at the bottom of this page.

Argument templates can be divided into four groups: Current, Target, Report and Notification.

Current Templates - Represents the currently selected log file.

${CURRENT_PATH} - The full path to the currently selected log file.

${CURRENT_DIRECTORY} - The full path of the directory containing the currently selected log file.

${CURRENT_NAME} - The file name of the currently selected log file.

${CURRENT_EXTENSION} - The file name extension of the currently selected log file. Note that the extension will not be prefixed with a period. An example extension might be "log" for any *.log file.

${CURRENT_SELECTION} - This argument template will save each selected log entry as a temporary file. The full path to the temporary file will then be inserted into the template. If multiple log entries are selected, then multiple paths will be inserted into the template.

${CURRENT_MESSAGES} - This template is similar to CURRENT_SELECTION, but rather than saving the entire log entry to a temporary file, only the log message (as parsed by LogViewPlus) will be saved to the temporary file.

Target Templates - Represents the file currently being opened.

${TARGET_PATH} - The full path to the target file.

${TARGET_DIRECTORY} - The full path of the directory containing the target file.

${TARGET_NAME} - The file name of the target file.

${TARGET_EXTENSION} - The file name extension of the target file. Note that the extension will not be prefixed with a period. An example extension might be "log" for any *.log file.

Report Templates - Represents the CSV file which was produced prior to the report command execution.

${REPORT_PATH} - The full path to the report file.

${REPORT_DIRECTORY} - The full path of the directory containing the report file.

${REPORT_NAME} - The file name of the report file.

${REPORT_EXTENSION} - The file name extension of the report file. Note that the extension will not be prefixed with a period. An example extension might be "log" for any *.log file.

Notification Templates - Represent data from the log entry which caused the notification to be executed.

${FILTER_NAME} - The name of the filter which contains the notification.

${FILTER_NOTES} - Any notes which are set on the notification filter.

${LOG_ENTRY_FULL} - The full log entry which triggered the notification.

${LOG_ENTRY_LINE_NUMBER} - The log file line number containing the log entry which triggered the notification.

${LOG_ENTRY_MESSAGE} - The message of the log entry which triggered the notification.

${LOG_ENTRY_PRIORITY} - The priority of the log entry which triggered the notification.

${LOG_FILE_NAME} - The file name of the log file being monitored.

${LOG_FILE_FULL_NAME} - The full path of the log file being monitored.

Template availablilty is determined by the action being executed. The table below shows which templates are available based on command type:

Command Type
Available Templates
External Command
Current
Open Actions
Current, Target
Report Command
Current, Report
Notification
Notification
Custom Parser
Target
Custom Reader
Target

For example, External Commands will only be provided with the templates listed in the 'Current Templates' section.

< >