Push Templates

Overview

When an event detected by an stream or batch detection rule is related to an employees, an .explanation requests are sent to the employee via email and SMS. Messages are also sent to reviewers (users). The template for these email and SMS can be managed in this page.

When an employee clicks on the hyperlink included in the email/SMS, they are directed to the explanation submission page defined in the push template, where they can write and submit their explanations. Explanation reviewers can also check and review the explanation content through the hyperlink included in the email/SMS.

Templates can be created in three supported languages: Korean, English, and Chinese.

Text Macros for Templates

The template supports text macros that allow predefined content to be inserted into the email subject, body, or SMS body. Below are the macros available for use in the template.

Macro	Description
$category	Classification name
$emp_key	Employee ID of the employee who is required to submit an explanation
$emp_name	Name of the employee who is required to submit an explanation
$emp_title	Job title of the employee who is required to submit an explanation
$url	Unique address of the explanation page in URI format, including the web access address
$expire_date	Deadline for explanation submission (`yyyy-MM-dd` format)
$expire_time	Deadline time for explanation submission (`HH:mm:ss` format)
$user_note	Content entered in the Remarks property of the Real-time/Batch detection scenarios

Separation of Communication Ports

In versions prior to 4.0.2404.0, the web console and the explanation submission/review page used the same communication port. Starting from version 4.0.2404.0, the communication ports for the web console and the explanation submission/review page have been separated (Refer to: SNR#2286). Consequently, the communication port for the explanation submission/review page will be assigned differently based on the upgrade/installation method.

Upgrading from a previous version to 4.0.2404.0:

The previously configured web access address and port number will be retained for backward compatibility.

Note

The explanation reception function of the existing web port will be maintained, but it is recommended to separate the web port to enhance security.

Fresh installation of version 4.0.2404.0:

The port number will be specified using the logpresso.sonar.explanation_port JVM option (default value if unspecified: 18443).

# Use port 12345 for the explanation request/review page communication port
-Dlogpresso.sonar.explanation_port=12345

Web Endpoint

The web endpoint is the access address used for the hyperlinks provided in the explanation request email/SMS and review request email/SMS, linking to the explanation submission/review page.

To set the web access address, enter it in the format https://IP address:port number and click Save.

IP Address: The IP address of the Logpresso server. In a cluster configuration, specify the virtual IP address of the control node.
Port Number: The port number specified by the logpresso.sonar.explanation_port JVM option.

Below is an example of setting the web access address in an environment where the hostname can be resolved to an IP address.

Note

If DNS services are provided in the network, you can use a hostname or FQDN instead of an IP address.

Push Template: Email Template

In the Email Template's Write tab, you can write the template to be applied to explanation requests and review requests.

First, select the language (Korean, English, Chinese) from the top right corner, then create the template (default: Korean).
Clicking Reset will clear the entered content.
Clicking Default will populate the template with the built-in default template, provided for each specified language.
Clicking Save will save the created content.
Macro variables are automatically replaced with actual values when the email is sent.

In the Preview tab, you can view the email template rendered in HTML format based on the entered content.

Push Template: SMS Template

In the SMS Notification, you can write the template to be applied to explanation requests and review requests via SMS.

First, select the language (Korean, English, Chinese) from the top right corner, then create the template (default: Korean).
Clicking Reset will clear the entered content.
Clicking Default will populate the template with the built-in default template, provided for each specified language.
Clicking Save will save the created content.
Macro variables are automatically replaced with actual values when the SMS is sent.