Configuring a Simple Report

To create reports, perform the following steps in Sigma Studio:

1. Click Manage > Report.
   
   
   The Information Report screen appears.
   
   
   
   
2. In the Report Maintenance tab:
   1. Enter a unique ID for the report in the Report Id field.

   2. Enter a unique display name for the report in the Report Name field.

   3. Click the Data Source Name field and select a data source. Refer Creating Data Connections to create a database or webservice connection and datasource.

      To define who can access the reports in Sigma application, you need to set the appropriate entitlements. Sigma uses the combination of Product code, Sub Product code, and Function code as the entitlement. To set the entitlement for the report, click the Data Entitlements () icon. 

      The Entitlement Configuration screen appears.
      

      
      

      By default, the configuration is provided to be as CANVAS. This can be changed by selecting the alternatives in the drop-down list. Refer Enabling Role-based Access to Reports for more information on creating a new entitlement in Sigma Studio.

      

      
      

      In some scenarios, you may want a report to show relevant data to the authorized user who is viewing it. This brings in the need to apply data-level entitlements. Use the Mandatory Criteria configuration to  enable data-level entitlements. To create new criteria for a report, refer to Creating Report Criteria.

      Mandatory Criteria: This enables you to select whether the data entitlement column is mandatory or not during report execution in Sigma Application (Portal for Generating Reports).

      If the Mandatory Criteria option is enabled in Studio, Sigma Application validates whether the criteria column filter is applied before save, save and run, save as, and run operations. If not, an error is shown that indicates to select the mandatory criteria filter. 

      In this case, the user has to click the Select Filter drop-down in the Sigma Application, select the mandatory criteria column to filter the data set, and then click the Select Criteria drop-down list. Select the In the list of option to select any value for the criteria column.

      

   4. Click the Select Columns to Display field and select the columns for the report.

      When generating reports in the application, end users will be able to select only the columns selected here for the report. Similarly, the following fields behave in the same manner - Select Groupable Columns, Select Sortable Columns, and Select Filterable Columns.

      
      
      
      

   5. Click a selected column in the Select Columns to Display field to define the column attributes for the selected column.
      
      

      • In Column Attributes, you can define the column width of the selected column (e.g. AMOUNT) on the Column Width field in terms of millimeters or pixels.
        
        
        
        
      • If required, click the Select Parent Column drop-down list and select the relevant parent column. Ensure that you have proper data sets to establish the linkage between the selected parent column and the chosen child column.
        
        
        
        

      • If required, click the Select Group Header drop-down list and select the Group Header of your choice. None, Average, Minimum, Maximum, Sum and Count are the available group header options, which can be used to aggregate data in the selected column.
        
        

        Tips

        When using the data aggregation options for any columns in the report, ensure that those columns are positioned after the first column.

        
        
        
        
        

      • Click the Data Type drop-down list and select the Data Type of your choice.
        
        
        
        
      • If needed you can hide a column by turning off the Visible option. Hidden columns are not shown in the generated report in Sigma Application. However, hidden columns can still be used for filtering, grouping or sorting. By default, the Visible option is enabled.
        
        
        
        
      • Select the column alignment based on your needs and requirements. Note that the amount or number columns (float data type) are right-aligned and other columns are left-aligned automatically.
        
        
        
        
      • If required, select the Override Grand Total checkbox. In the Select Column drop-down list, ensure to select the same column, so as to override the grand total value for the column data values, e.g. AMOUNT. It is necessary that the Amount column comprises a Group Header attribute, e.g. Sum, so that the Override Grand Total gets applied for the selected Amount column. On applying the Override Grand Total attribute, the first record in the data set will be showcased as the Grand Total in the report output format.
        
        
      • If required, click the Select Linked Currency drop-down list and select the linked currency column. Ensure that you have a relevant currency column with appropriate with proper data sets to establish the linkage between the selected currency column and the chosen child column.
        
        
        
        
      • To mask or separate the PII data click Select Masking Format lookup field and select the masking or separate format refer, Masking or Separation of PII data in Reports.
        
        
      • For the columns with the Date data type, you can select the date format from the Select Date Format drop-down list. This is an optional field. The available date formats are: MM-dd-yyyy (Month-Date-Year), dd/MM/yyyy (Date/Month/Year), MM/dd/yyyy (Month/Date/Year), dd/MMM/yyyy (Date/Month Abbreviation/Year) and dd-MM-yyyy (Date-Month-Year).
        
        
        
        
      • For the columns with the DateTime and Timestamp data types, you can select the date format from the Select Date Format drop-down list and the time format from the Select Time Format drop-down list respectively. The available date formats are similar for the Date, DateTime and Timestamp data types. Similar to the Select Date Format, even the Select Time Format is also an optional field. The available time formats are: hh:mm:ss a (12-hour format) and HH:mm:ss (24-hour format).
        
        

   6. On the Report Maintenance tab, click the Select Allowed Formats field and select the formats in which the report can be generated. The following formats are supported: CSV, DOCX, HTML, PDF, XLS, TXT and XML.

      End users can generate reports in the application in the formats configured in the Select Allowed Formats field. For example, if CSV and HTML are selected for a report, end users can generate reports in the application only in the CSV and HTML formats.

      
      

   7. Click the Select Filterable Columns field and select the column(s) by which the report results are to be filtered.
      
      

   8. Click the Select Groupable Columns field and select the column(s) by which the report results are to be grouped.

      
      
      
      

      On clicking the Groupable column, the Override Grand Total, Show Group Header, Show Group Total and Suppress Group Header If Null options appear. You can either enable or disable the provided options based on your choice. If you select the Override Grand Total checkbox, the Select Column drop-down list appears. In the Select Column drop-down list, ensure to select the same column, so as to override the grand total value for the column data values, e.g. AMOUNT. It is necessary that the Amount column comprises a Group Header attribute, e.g. Sum, so that the Override Grand Total gets applied for the selected Amount column. The Show Group Header option displays the groupable column header, whereas the Show Group Total displays the sum or any other aggregation configured for the groupable column in the report. On selecting the Suppress Group Header If Null checkbox, the chosen group header attribute, (e.g. Sum) will not get applied for the selected group column if the fetched values of the group column either comprise null values or no data sets.
      
      

   9. Click the Select Sortable Columns field and select the column(s) by which the report results are to be sorted.
      
      
      
      

      The Additional Info tab provides options to configure the following:

      

      • Notification channel and templates. Refer Notification Template for Reports for more information on notification channel and templates configuration. Refer Configuring SNS channel for detailed information on the usage of the SNS notification channel.
      • Report file name convention. Refer Configuring a custom file name and directory for Reports in Studio for more information on report file name configuration.
      • Report file storage on FTP servers or on Cloud. Refer Configuring FTP Server for Reports for more information on FTP server configuration for reports. Refer Configuring S3 Storage Service for Reports for information on Amazon S3 cloud-based storage configuration.

3. If you want to alter the parameter settings for the report, click Report Parameters tab.
   
   
   

   You can configure the parameters for the reports (if required) by performing the following actions:
   
   

   1. User Parameter:
      You can pass user parameters to the report by performing the following steps:  
      
      
      1. Enter a unique parameter name on the User Parameter field and click plus sign to add it to the existing parameters.
         
         
         
      2. In Add Labels, enter a value for the user parameter under Report Params tab. Click Save to save the resource bundle.
         
         
         

      3. Click Template Designer ( ) icon on the Report Maintenance tab. Select the template layout, click Add Content and add the following key anywhere on the content to pass the user parameter:
         

         ${Header.UserParams.DATE}  //DATE indicates the User Parameter name.

         
         
         

   2. For the group headers of a groupable column to appear on a repeated basis for each and every segregated group, click the Repeat Group Header drop-down list and select the Yes option.

   3. To remove the column headers for a report in a specific format, click the Remove Column Header in drop-down list and select the report format of your choice, e.g. PDF.

      The Remove Column Header in option is not applicable for the XML format. 

   4. Click the Grand Total Position drop-down list and select a position to align the column grand totals for the report.
   5. Is Password Protected?:
      

      1. Select YES on the Is Password Protected? field and a new field named Password Pattern appears on the tab.
         

         • Click '@' to view the list of attributes available for the report password.
         • Click '#' to view the list of function variables available for the report password.

           Click the Password Pattern field and enter a pattern in such a way that, this password pattern must be provided by the user on the login section while trying to access the generated report.
           
           
           

   6. To generate the report with no data sets, click the Generate Output for no data and select the Yes option. On selecting the No option, the report with no data sets, will not get generated in the Sigma Application.
   7. Enter the number of columns that needs to be frozen on the excel sheet on the No Of Columns to Freeze(XLS).
   8. Enter page margin width for the reports in the Page Margin field.
   9. In the Show Filter field, select whether the filtered columns need to be displayed on the report or not.
   10. In the Show Xlsx Filter field, select whether the filtered columns need to be displayed on the excel report or not.
   11. Click the Show Xlsx Properties drop-down list and select Yes to display the report details and properties on the excel report. On selecting the No option, the report details and properties will not get displayed on the excel report.
   12. In the Show Report Title in Content field, select whether the report title needs to be displayed on the report or not.
   13. In the Repeat Group Header field, select whether the group header needs to be displayed at the each page of the report or not.
   14. Select the font for the report on the Font Family drop-down list.
   15. Click Sub Total Position drop-down and select the position to align the column sub-totals for the report.
       
   16. In the Column Grand Total Position, select the After Rows option to display the grand total of a particular column at the end of the grid row in the report. On selecting the Before Rows option, the column grand total will get displayed on the top of the grid row in the report.
   17. In the Column Sub Total Position, select the Below Rows option to display the sub-total of a particular column at the end of the grid row in a report. On selecting the Above Rows option, the column sub-total will get displayed on the top of the grid row in the report.
   18. In the Print End of Report Message, select the Yes option to showcase the End of Report message on the generated report. If you do not want the End of Report message to be displayed on the generated report, then you must select the No option.
   19. Click the Compress Report File drop-down list and select Yes to download the report in ZIP format. By default, this option is set to No.
       
       
       
       

4. If you want to set default configurations for the report, click Default Configurations tab.

   Default configurations are predefined configurations that are configured in the studio which are readily available in the Sigma application. Users can use the default configurations as they are or can create an instance and modify them according to their business needs.

   
   

   1. Enter a default report name in the Report Title field. 
   2. Select a default report format for the report from the Report Format drop-down field.
   3. Select a default page size from the Page Size drop-down field.
   4. Choose the default Page Layout of your choice. By default Landscape is chosen as the Page Layout.
   5. Enter the default font size for the report in the Font Size field. By default 12 is chosen as the font size.
      
      
   6. By enabling the Print Serial No checkbox you can include serial number for the records in the report.
      
      
      
      1. After the Print Serial No is enabled specify the serial number alignment in the Serial No Alignment drop-down field, which has Left Align, Centre Align and Right Align.
      2. Specify the width of the serial number column in the Serial No Width In mm field.
          
         
   7. Click Select Columns to display drop-down field and select the default column(s) for the report. 
   8. Click the Group By drop-down field and select the default column(s) by which the report results are to be grouped. 

   9. Click the Sort By drop-down field and select the default column(s) by which the report results are to be sorted.

      The columns available in the Select Column to display, Group By, Sort By drop-down fields are configured in the Report Maintenance tab.

      
      

      If a filterable column is chosen in the Report Maintenance tab of a report, then the Base Filter button is enabled in the Default configuration tab, which enables you to choose default filterable columns.

   10. Click Base Filter button to add default filter to the report.
       
       
       
       1. In Base Filter Configuration screen, Click Select Filter drop-down and choose the default filterable column. 
          
          
       2. Select the filter condition from Select Criteria drop-down, either select or specify the value and click + button to add the default filter for the report. 
          
          

5. Click Save to save the report.

   When you try to exit the Information Report screen, before saving your configured report, a warning pop-up message appears, as shown in the following screen shot:
   

   • Click Cancel, if you do not want to exit the Information Report screen.
   • Click Ok, if you want to exit the Information Report screen.

   
   
   
   A confirmation message, indicating a successful save of the report, appears.
   
   
   
   

6. Click Ok.

   The new report is made available for the end users on the Information Reports workspace in the Sigma Application.

To edit the report created in Sigma Studio, refer Editing Reports. For executing (generating) reports in the Sigma Application, refer Generating a Report. For scheduling reports in the Sigma Application, refer Scheduling Reports.