Notification Template for Reports

You can create templates for notifications that needs to be sent to end-users (report consumers) when adhoc or scheduled reports are generated. Templates can be set for both email and SMS notifications. You can create templates for both success and failed report generation cases.

Refer the following sections:

• Creating Notification Templates
• Mapping Notification Template to Report

Creating Notification Templates

Perform the following steps in eMACH.ai-Sigma Studio to create notification templates that can be used when reports need to be sent to end-users as SMS or mail:

1. Click Manage > Notification Template.
   
   
   The Notification Template screen appears, as shown in the following screenshot:
   
   
   
   
2. Select the channel from the Notification Channel drop-down list. In this example, SMTP is chosen as the channel.
   
   
3. Enter a template name in the Template Name field.
   
   
   
   
4. Select the Notification Type for the reports based on the report's SUCCESS or FAILURE.

5. You can also add parameter by selecting the relevant parameters from the Add Params drop-down list.
   
   

   To include any additional parameters not listed in the Add Params drop-down for the Short and Long Message fields, simply add the required dynamic parameter using the "$" symbol followed by the parameter name without any spaces in curly brackets , as shown in the screenshot below.

   These additional dynamic parameters will only be reflected in the new notification template and not in the existing default notification templates.

   

   Criteria Value - This parameter will get applied only for the instance that gets generated via report bursting based on the value chosen in 'Generate for Criteria/Group' field. If Individual Criteria is chosen, that criteria value will get applied. If Criteria Group is chosen, the corresponding Criteria Group mapping name will get applied. This parameter is available both in short and long messages. Refer Configuring a report bursting , for detailed information on 'Generate for Criteria/Group' field.

6. Provide a short message for the template in the Short Message field.
   
   
7. Provide the actual message for the template in the Long Message field.
   
   
   
   

8. Click the Save icon to save the template.

   When you try to exit the Notification Template screen, before saving the configured notification template, a warning pop-up message appears, as shown in the following screenshot:

   
   

   • Click No, if you do not want to exit the Notification Template screen.
   • Click Yes, if you want to exit the Notification Template screen.

   
   
   
   A confirmation message appears.
   
   
   
   

9. Click Ok.
   
   The created notification template appears on the left side.
   
   
   
   
10. You can similarly configure a failure notification template by following the aforementioned steps but ensure that the Notification Type is selected as Failure. 
    
    1. Once the failure notification template is configured, click the Save  icon to save it.
       
        

Mapping Notification Template to Report

1. Perform the following steps to map the notification template for a report:
   
   1. Open the report configuration and in Additional Info tab, select the notification channel in Notification Channel field. Here, SMTP is chosen as the channel in this example.
      
      
      
      
   2. Click the selected channel, e.g. SMTP.
      
      
      
      The Notification Template Configuration pop-up appears.
      
      
      
      

   3. Select the configured success and failure Notification Templates from the Success Notification Template and Failure Notification Template drop-down lists respectively.
      
      

      • Click the Parameter Configuration icon, to map the report filters, SQL parameter, Procedure IN and OUT parameters and additional parameter used for the report in the notification template, when parameter is defined in the notification template as mentioned above.

      • Click Save button to save the configuration.
        
        

        Upon saving the configuration, the parameter configuration icon will display a green color, indicating a successful save. Conversely, if the icon displays a red color, it signifies that the configuration has not been saved.

        

   4. For enabling the failure notifications to be sent to the email addresses of the configured contacts and contact groups, select the Send Failure Notification checkbox.

      
      
      
      

   5. Enter the custom filename in Report Custom FileName field. To add report custom file name refer Configuring Custom File Name.
      
      
       

      Perform a click on the outside of the Notification Template configuration pop-up to save the applied configurations.

   6. On the Additional Info tab, click the Save option to save the report.