Configuring a Simple Report

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

1. Click Create > Report.
   
   
   
   The Information Report page appears.
   
   
2. In the Report Maintenance tab:
   1. Enter a unique ID for the report in the Report Id field.
   2. Enter a display name for the report in the Report Name field.

   3. Click the Data Source Name field and select a datasource. 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 page 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 Configuring Entitlements for more information on creating a new entitlement in Canvas Studio.

      Click outside the pop-up to save the entitlement configurations.

   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 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, 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 in CSV and HTML formats only.

   6. Click the Select Filterable Columns field and select the column(s) by which the report results are to be filtered.
   7. Click the Select Groupable Columns field and select the column(s) by which the report results are to be grouped.
   8. Click the Select Sortable Columns field and select the column(s) by which the report results are to be sorted.
      
      

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. Click Grand Total Position drop-down and select a position to align the column grand totals for the report.
   3. Click Grid Format drop-down and select a format in which grids on the report needs to be displayed.
   4. Is Password Protected?:
      
      1. Select YES on the Is Password Protected? field and a new field named Password Pattern appears on the tab. 
         

      2. 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.
         
         
         

         • 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.

         
         

   5. Enter the number of columns that needs to be frozen on the excel sheet on the No Of Columns to Freeze(XLS).
   6. Enter page margin width for the reports on the Page Margin field.
   7. In the Show Filter field, select whether the filtered columns needs to be displayed on the report or not.
   8. In the Show Report Title in Content field, select whether the report title needs to be displayed on the report or not.
   9. In the Repeat Group Header field, select whether the group header needs to be displayed at the each page of the report or not.
   10. Select the font for the report on the Font Family drop-down list.
   11. Click Sub Total Position drop-down and select the position to align the column sub-totals for the report.
       
       
4. Click Save.
   
   A confirmation message appears.
   
   

5. Click OK for the message.
   
   

   The new report is made available for the end users in the Information Reports workspace in the end application.

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