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:
- 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. - In the Reports section, click the report name.
The Customize tab for the selected report appears on the right side. - Enter a name for the report in the Report Name field. For example: Account Statement PDF.
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.
- Click the Additional Parameters icon to configure the additional parameters for the report.
- Select the report size from the Page Size drop-down list. By default, the A4 page size is displayed.
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.
- 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.
- 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.
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.
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.
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.
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.
Click the Select Columns drop-down and select the columns that needs to be shown on 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:
- In order to display collated headers for the selected columns, refer Displaying Collated Headers in Reports.
- In order to display grand and sub-totals for the selected columns, refer Displaying Grand and Sub-totals in Reports.
- Click the Group By drop-down and select the column(s) by which the report results are to be grouped.
- Click the Sort By drop-down list and select the column(s) by which the report results are to be sorted.
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.
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:
- To specify multiple filter criteria for the report, perform steps 12 and 13.
- 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.
A confirmation message appears.
- To execute the report, click Run.
Click Ok for the confirmation message.
The generated report appears on the Generated Reports tab.Wait till the report is generated, i.e. you must see the status as Published to Repository under the Running column.
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.
- If the status of the generated report is Generating Report, click the Refresh () icon to reload the generated report list.
- 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.
The Error Details provide a detailed information on the failure of report generation, as shown in the following screen shot: - To download the generated report, click the Download () icon.
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.
Refer the following pages:
Add Comment