Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Note
iconfalse
titlePrerequisites

Delivery of report notification via email and SMS requires the respective servers to be setup and configured. To configure the email server for reports notification, refer /wiki/spaces/sigma2021/pages/2698543106.

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:


Anchor
createnotification
createnotification
Creating Notification Templates

Perform the following steps in Sigma Studio to create notification templates for report when it is sent to the that can be used when reports need to be sent to end-users as SMS or mail or as an inbox message:

  1. Click Manage > Notification Template.
    Image Removed
    Image Added

    The Notification Template screen appears, as shown in the following screenshot:
    Image Removed
    Image Added

  2. Select the GCIF. Here, HIGHSCORE is selected as default value.
    Image RemovedSelect the Notification Channel from the dropdownchannel from the Notification Channel drop-down list. In this example SMS is SMTP is chosen as the Channel.
    Image Removed
    Image Added

  3. Enter a template name in Template Name field.
    Image Removed
    Image Added

  4. Select the Notification Type for the reports based on the report's SUCCESS or the FAILURE.
  5. Provide a short message for the template in Short Message field. You can also add parameter by selecting those on the Add Params dropdown.
    Image Removedthe relevant parameters from the Add Params drop-down list.

    Image Added

    NOTE:
    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.

    Image Added

  6. Provide the actual message for the template in Long Message field.
    Image Removed
    Image Added

  7. Click the Save icon to save the template.

    Warning

    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 screen shot:

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


    Image RemovedImage Added

    A confirmation message appears.



  8. Click Ok.

    The created notification template appears on the left side.

    Image Added

  9. You can similarly configure a failure notification template by following the aforementioned steps but ensure that the Notification Type is selected as Failure.
    Image RemovedMake sure to follow the steps as shown below while creating reports:
    In  
    1. Once the failure notification template is configured, click the Save Image Added icon to save it.

      Image Added 

Anchor
rptnotification
rptnotification
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, SMS is SMTP is chosen as the channel in this example.
      Image Removed
      Image Added

    2. Click on the selected channel, e.g. SMTP.
      Image Removed
      Image Added
      A
      The Notification Template Configuration pop-up appears.
      Image Removed
      Image Added

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

      Image Added

    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.

      Note

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


      Image Added

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

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

      Image Added