Versions Compared

Key

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

...


Info
titlePrerequisites

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

...

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

  1. Click Create > Report.
    Image Removed
    Image Added

    The Information Report page appears.
    Image Removed
    Image Added
  2. In the Report Maintenance tab, enter :
    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.

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

      The Entitlement Configuration page appears.

      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 Configuring Entitlements for more information on creating a new entitlement in Canvas Studio.


      Tip

      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.

      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.


    5. Click the Select

    Groupable Columns
    1. Allowed Formats field and select the

    column(s) by
    1. formats in which the report

    results are to
    1. can be

    grouped.To include group header in the report, click Group Header Template.
    Image Removed
    The Template Config page appears with the list of columns from the selected datasource on the left-hand side of the page.
    Image Removed
  3. By default, in the Template Config page, a section with single-column (stack) layout is displayed. To change the layout, click the respective column icons. You can change the layout from single-column (stack) to six-columns.
  4. Drag and drop the columns into the section.
  5. If you want to add additional sections in the group header, click Add Section and drag and drop the required columns into that section.
  6. Click Save (Image Removed) icon to save the group header changes and go back to Report Maintenance tab.
    Image Removed
    Click the Select Sortable
    1. generated. The following formats are supported: CSV, DOCX, HTML, PDF, XLS, 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 in CSV and HTML formats only.


    2. Click the Select Filterable Columns field and select the column(s) by which the report results are to be
    sorted
    1. filtered.
    2. Click the Select
    Filterable
    1. Groupable Columns field and select the column(s) by which the report results are to be
    filtered
    1. grouped.
    2. Click the Select
    Allowed Formats
    1. Sortable Columns field and select the
    formats in
    1. column(s) by which the report
    can
    1. results are to be
    generated. The following formats are supported: CSV, HTML, PDF, RTF, and XLS.
    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 in CSV and HTML formats only.

    If you want to use resource bundles for the report column headers (column labels) specified in Select Columns to Display field, enter the name of the resource bundle property name in the Resource Bundle field and click Add Labels.
    The Resource Bundle Entries page appears. By default, English language is selected in the Language drop-down list. You can select any other language for your application from the Language drop-down list.
    Image RemovedEnter the labels (captions) for each of the report headers in their respective fields and click Save.
    A confirmation message appears.
    Image Removed
  7. Click OK for the message.

  8. Select the template for the report from the Select Report Template drop-down list. By default, CANVAS_DEFAULT is available as the template.

  9. Select the font for the report from the Select Font drop-down list.

  10. Enter the number of records to be displayed per page in the report in the Records Per Page field.
    The following screen shot shows sample data for the report generation:
    Image Removed
    Info

    The sample data shown on the screen shot relates to a Sales Order Report for which data is retrieved from a datasource. The Sales Order report will display the order details, such as Order ID, Order Date, Customer ID, Product ID, Product Name, Quantity, Price, and Sales Amount. The report will be generated in HTML and PDF formats.

    Notice that the column names from the datasource contain underscores (e.g. Order_ID). Hence, a resource bundle called 'common' is used. This is a property file that contains the exact labels for each column name that you provided by clicking Add Labels. When the Sales Order report is generated, the column names will be replaced with the labels from the resource bundle.

    Click Submit
    1. sorted.

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

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

        Image Added

        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.


    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.

  12. Click Save.

    A confirmation message appears.
    Image Removed
    Image Added
  13. Click OK for the message.

    Info

    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 Canvas Sigma Studio, refer Editing Reports. For executing (generating) reports in the application, refer Running Reports (Report Generation) Generating Simple Report in Sigma. For scheduling reports in the application, refer Scheduling Reports.

Tip

Request approval for the reports can be enabled through Sigma Studio. Refer Administration for more information on initiating, approving, rejecting and re-submission of requests.