Info
titlePrerequisites

To create reports, you must have already created database or webservice connection and data source to fetch application data. Refer Creating Data Connections for more information on creating connection and data source.


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

  1. Click Manage > Report.
    Image Removed
    Image Added
    The Information Report page appears.
    Image Removed
    Image Added

  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 data source. Refer Creating Data Connections to create a database or webservice connection and datasource.

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

      Image Added

      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.

      Info

      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 (Image Modified) icon. 

      The Entitlement Configuration page appears.

      Image Removed

      Tip


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

      Info

      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.


      Image RemovedImage Added

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

      Note
      • In Column Attributes, you can define the column width of the selected column (e.g. ACCOUNT_NO) 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 could used to determine the sum and count-based calculations for the selected column.



      • Click the Data Type drop-down list and select the Data Type of your choice.



      • You can disable the Visible toggle option to hide the selected column from the report. By default, the Visible toggle option is enabled.



      • Select the column alignment based on your needs and requirements.



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


    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.

      Note

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


      Image RemovedImage Added

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

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

      Note
      Click the Select Sortable Columns field and select the column(s) by which the report results are to be sorted.
    If you want to alter the parameter settings for the report, click Report Parameters tab.
    Image RemovedYou can configure
    1. On clicking the Groupable column, the Show Group Header and Show Group Total options appear. You can either enable or disable both of the Show Group Header and the Show Group Total options based on your choice. 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.

      Image Added


      Image Added

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

      Image Added

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

    Image Added

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

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

    Click Template Designer ( Image Removed) 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:

    Code Block
    ${Header.UserParams.DATE}  //DATE indicates the User Parameter name.
    Image Removed

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

        Image Added
      2. In Add Labels, enter a value for the user parameter under Report Params tab. Click Save to save the resource bundle.

        Image Added
      3. Click Template Designer ( Image Added) 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:

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

        Image Added

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

        Note
        • 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.
          Image Removed

          Image Added


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

  4. Click Save.

    Warning

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



  5. Click Ok.

    Info

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


...