/
Configuring Mail Template File

Configuring Mail Template File

Kyvos Reporting can be configured to send a mail message to recipients when:

  • A report is executed in asynchronous mode (notifying success or failure)

  • The report is sent as an email (attachment or link)

  • The report execution request is rejected.

  • A Job is executed (notifying success or failure)

  • Memory Exceeding a Set Level

  • As part of the Report Approval Process, a comment is added, the report’s status is changed, or the report gets published

The content of these messages comes from corresponding template files.  These files are located on the Report Server at path: <Install folder>Kyvos Reporting\ReportEngine\Config\messages\mails.

These files are:

  • AsynchronousFailureMessage.txt

  • AsynchronousSuccessMessage.txt

  • attachemailmessage.txt

  • ExecutionRejectionMessage.txt

  • JobErrorMessage.txt

  • JobSuccessMessage.txt

  • linkemailmessage.txt

  • MemoryExceededMessage.txt

  • ReportApprovalProcessCommentAddMessage.txt

  • ReportApprovalProcessReportPublishMessage.txt

  • ReportApprovalProcessStatusUpdationMessage.txt

  • orgexpirymessage.txt

Content of Mail Message template files

The first line of the file contains the subject.  The subject has to be a one-liner, and the line must start with the insensitive keyword ‘Subject:.’  Specify the message in the second line, beginning with the insensitive keyword ‘Message:’

If these keywords are not found in the file, Kyvos Reporting assumes the file's content as a message and takes the default value for the subject.

Subject: Scheduled job ‘<%JOB_NAME%>’ notification – Success Message: Hello, This is an auto-generated notification by the Report Server. The scheduled reports are delivered successfully. Details of delivered reports are as follows: <%JOB_DETAILS%> <%LINK%> Regards System Administrator

In the above example, words enclosed by <% and %> are system parameters.  At run time, these parameters will be replaced by actual values.  All the system parameters available for a mail message are already used in pre-configured mail messages.

Locale-specific messages

If the mail messages are specific to the user's locale, they are recommended to be kept inside a locale-specific folder inside the mail folder, for example, ReportServerdistconfigmessagesmailsen_us.

Note

Locale-specific messages are unavailable for Memory Exceeded and Execution Rejection mail messages.

Email Recipients

AsynchronousFailureMessage.txt: To the user who executed the report, send it to the mail ID specified on the user’s My Preferences page.

AsynchronousSuccessMessage.txt: To the user who executed the report, send it to the mail ID specified on the user’s My Preferences page.

Attachemailmessage.txt: To the users whose IDs are specified on the Email dialog.

ExecutionRejectionMessage.txt: To the super administrator, sent on the super administrator’s My Preference page.

JobErrorMessage.txt: To ID specified on the Job details page.

JobSuccessMessage.txt: To ID specified on the Job details page.

linkemailmessage.txt: To the users whose IDs are specified in the email dialog.

MemoryExceededMessage.txt: To the super administrator, sent on the super administrator’s My Preference page.

ReportApprovalProcessCommentAddMessage.txt: To all the users who are a part of the report approval process.  These users are authorized to comment, approve, or reject a report.  Mail will be sent to the IDs set by these users on their My Preferences page.

ReportApprovalProcessReportPublishMessage.txt: To all the users who are a part of the report approval process.  These users are authorized to comment, approve, or reject a report.  Mail will be sent to the IDs set by these users on their My Preferences page.

ReportApprovalProcessStatusUpdationMessage.txt: To all the users who are a part of the report approval process.  These users are authorized to comment, approve, or reject a report.  Mail will be sent to the IDs set by these users on their My Preferences page.

orgexpirymessage.txt: This is for the administrator user only in the case of a SAAS-enabled product license.

Note

Administrators can retain their customized email templates and the setup/default templates in separate files on upgrade. 

Related content

Copyright Kyvos, Inc. All rights reserved.