Generating a Report

The reports created in Sigma Studio will be available for use by the end users of the application. For representation purpose, the Sigma Application is considered as the end application. The reports created in Sigma Studio will be available in the "Information Reports" workspace in the Sigma Application. To configure such reports in Sigma Studio, refer Configuring a Simple Report.

To execute or generate the reports, perform the following steps:

  1. Log-in to the Sigma application and click the Information Reports workspace. In the Sigma Application, the Information Reports workspace is displayed by default after logging on to the application.



    The Information Reports workspace opens with Reports section on the left-hand side, which shows the list of reports created in Sigma Studio. In our example, we created the Account Statement report in Sigma Studio.

  2. In the Reports section, click the report name.

    The Customize tab for the selected report appears on the right side.



  3. Enter a unique name for the report in the Report Name field. For example: Account Statement.
  4. Choose the report format from the drop-down. For example: PDF.

    The report formats in the drop-down are based on the formats chosen while creating the report in Sigma Studio. In our example, we selected CSV, DOCX, HTML, PDF, XLS, and XML formats for the Account Statement report in Sigma Studio.

  5. Click the Additional Parameters icon  to configure the additional parameters for the report.



  6. Select the report size from the Page Size drop-down list. By default, the A4 page size is displayed.
  7. Select the layout for the report. By default, Landscape is the selected layout or page orientation.

    The landscape icon () indicates the Landscape layout, whereas the portrait icon () indicates the Portrait layout.

  8. Specify the font size in the Font Size field. You can increase or decrease the font size by clicking the up or down arrows respectively.
  9. If you want to include serial number for the records in the report, toggle on the Serial No field. By default, the serial number option is deselected.
    1. You can specify the serial number alignment in the Serial No Alignment drop down field, which has Left Align, Centre Align and Right Align.

    2. You can specify the width of the serial number column in the Serial No Width In mm field.



  10. Enable the Show Report Title toggle option to display the report title in the contents of the report.

    The default report title will appear on the page header of the report, even if the Show Report Title toggle option is either enabled or disabled.

  11. The Remove Column Header option gets displayed based on the report configuration. By default it is set to Yes and the column headers are hidden in the generated report. To view the column headers in the generated report, select No from the Remove Column Header drop-down list.




  12. For the excel-based reports, you can select the file extension of your choice from the Excel File Extension drop-down list.

    The available file extensions for the Excel format are: XLS and XLSX. The XLSX format appears as the default Excel File Extension.

    • A maximum of one-lakh (one hundred thousand) records can be generated in XLS-based reports.
    • The XLS-based report generation fails when the number of records exceeds that limit. For the XLSX-based reports, there is no restriction in the number of records. However, if the number of records exceeds ten-lakh (one million), a new sheet is created within the same Excel file to display the remaining records.
    • A maximum of thirty two thousand seven hundred (32700) characters are allowed in a cell for both XLS and XLSX report.
    • XLS reports when password protected must be opened in Microsoft Excel only.




  13. The report can be mailed as an attachment for all the formats. To mail the report as attachment to the selected contacts or contact groups, select the Mail Report as Attachment option.



  14. Click the Select Columns drop-down list and select the columns that need to be shown in the report.

    The columns in the Select Columns drop-down are based on the columns chosen while creating the report in Sigma Studio.

    To quickly select all the columns for the report, click the Select All () icon. To remove all the selected columns, click the Remove All () icon. To select specific columns, select the checkbox adjacent to the column names as shown in the following screen shot:

  15. Click the Group By drop-down and select the column(s) by which the report results are to be grouped.
  16. Click the Sort By drop-down list and select the column(s) by which the report results are to be sorted.
  17. If suppose, you want to filter the report results based on some parameters, select the filter from the Select Filter drop-down list in the Filter Criteria section.

    The columns in the Select Filter drop-down list is based on the configuration of Select Filterable Columns field while creating the report in Sigma Studio.

  18. Select the filter condition from the Select Criteria drop-down, either select or specify the sub-criteria and click Add.

    The options in the Select Criteria drop-down list is based on the filter selected in the Select Filter drop-down list. A sample filter and criteria are shown in the following screen shot:

  19. To specify multiple filter criteria for the report, perform steps 12 and 13.
  20. Perform any of the following:
    • To execute the report, click Run.
      or
    • To create a duplicate of the report, click Save As. To save the report as a base report, click Save As Base.

      On making use of the Save As Base option, the report will get saved as a base report and no separate or new instance of the same base report will get created. But if you make use of the Save As option, a new instance of the report will get created. 

      If this error is occurs, then click the Select Filter field to apply the column filter to the report 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, you have to click the Select Filter drop-down in the Sigma Portal, 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.




      A confirmation message appears.



  21. Click Ok for the confirmation message.

    The generated report appears on the Generated Reports tab.

    Once CORPORATE BANKING is enabled, the report entitlements are mandatory by default. The criteria values should be selected while generating the report or report group. Otherwise a report or report group will fail with a message indicating that report generation is failed. Hovering on the exclamation () icon displays the failure message. 

  22. Wait till the report is generated, i.e. you must see the status as Published to Repository under the Running column.

    Once the report gets generated successfully, the time consumed for each of the generation process will be displayed in the form of the status bar. Queued, Data Fetch, Generation and Publish are the report generation processes and the subsequent time range will be displayed on the status bar, once the report gets generated successfully.



  23. On generating the reports with selected contacts or contact groups, the status of the generated report is displayed as Notification(s) sent, since the generated report will be sent as an e-mail to the selected contacts or contact groups.

    For detailed information on configuring contacts and contact groups in Sigma Studio, refer Creating Contacts and Contact Groups. For detailed information on configuring the email server for reports, refer /wiki/spaces/sigma2021/pages/2698543106.

    For the reports configured with user contacts or any notification-based report, the report generation status bar will display the consumed time for each of the generation process. Queued, Data Fetch, Generation, Publish and Notification are the report generation processes and the subsequent time range will be displayed on the status bar, once the report gets generated successfully.




  24. If the status of the generated report is Generating Report, click the Refresh () icon to reload the generated report list.



  25. If the report fails to get generated, then the status of the generated report is Failed. Click the  icon to view the Error Details failure message, which displays a detailed message that resulted in the failure of report generation.

    You can select the time period and status to view the generated instances of the report for the selected time period. For instance, if you select the 24 Hours time period and the Failed status, then the failed report instances for the 24 Hours time period will get displayed in the Generated Reports tab. Similarly, you can select the other durations of 3 Days and 7 Days to view the generated report instances for the 3 day and 7 day duration periods respectively. On selecting the Running status, the queued reports will get displayed in the Generated Reports tab.



    You can access the Generated Reports tab and navigate to the page of your choice by entering the page number of your choice in the Pagination text field, as shown in the following screen shot:




    The Error Details provide a detailed information on the failure of report generation, as shown in the following screen shot:  



  26. To download the generated report, click the Download () icon.



  27. To execute the report again, click the Execute () icon.

    When you execute the report again, the report will be re-generated and a new report file will get created.


    The following screen shot shows a sample Account Statement report in the PDF format.

You can view the filters and  parameters that were used for generating the report by clicking on the report filters () icon in the Generated Reports tab as shown in the following screen shot:
The values mapped to the criteria configured for the report , will be available here by default.


You can search the Criteria for report or report group based on the filter criteria value applied in the Search Criteria Value field.

Refer the following pages: