Configuring a report group in Sigma Studio
To configure a report group in Sigma Studio, perform the following steps:
- On the home page of Sigma Studio, click Manage > Report Group.
The Create Report Group screen appears. - Enter a unique report group name in the Report Group Name field, e.g. ACCOUNT TRANSACTIONS.
Click the Report Group Format drop-down list and select a format of your choice, e.g. PDF.
Report Groups can only be created in the XLS and PDF formats. Only one of the format can be selected, either XLS or PDF.
Click the Data Entitlement option to select the data entitlements for the report group.
NOTE: For corporate banking user's the Data entitlement is a mandatory field. If not, while saving the created report group, it throws an error message indicating data entitlements are missing.
NOTE: · This is a mandatory field. If not while saving the created report group it throws a error message.- Click the Product, Sub-Product and Function Code drop-down lists to select the appropriate product, sub-product and function codes for providing the configured report group access and data entitlements to a selected user group, e.g. CANVAS, CANVAS and VSBLTY. For detailed information on configuring data entitlements in Sigma Studio, refer Enabling Role-based Access to Reports.
NOTE: · This is a mandatory field. IF NOT In the Create Report Group screen, click the Select Reports/Groups drop-down list and select the reports and groups of your choice to configure a new report group, e.g. ACCOUNT DETAILS and TRANSACTION DETAILS.
You must have already created individual reports and groups in Sigma Studio before you configure a report group. For detailed information on creating reports in Sigma Studio, refer Configuring Reports.
In Report Group, you can include reports and groups irrespective of their mapping to the solution package.
If a report used in the Report Group consist of filterable column(s), a Default Filter button is enabled in the screen to set default filters for the reports in Report Group.
Listed below are the Report Group's default filter attributes:
- Default filter configured for a column in Report Group will get applied to all the reports in the group only if that column is present as filterable column in the reports.
- When the report group is generated, the default filter configured in the report will be used if a default filter is not configured in the report group.
- Report Group default filters have priority over reports default filters.
- Click the Default Filter button to add default filter for the reports.
- In Default Filter Configuration screen, Click Select Filter drop-down and choose the default filterable column.
Select the filter condition from Select Criteria drop-down, enter the value and click + icon button to add the default filter for the report.
Toast message indicating the filter added successfully displays. The configured filter is also applied in the Select Filter field.Click outside the pop-up window to save the Default Filter configurations.
- In Default Filter Configuration screen, Click Select Filter drop-down and choose the default filterable column.
- Click the Publishers drop-down list to select the report group publisher, e.g. ARCHIVAL, FTP.
- Click the FTP in Publishers drop-down field to configure FTP server for Report Groups.
Select Publisher Data Source Id pop-up appears on the screen. - Click the Publisher Datasource lookup field and select the relevant FTP data source, e.g. FTPDS
- Click Report Custom FileName to add custom file name for the FTP report.
- Enter the '@' key in the Report Custom FileName field to view the list of variables available for the report custom file name.
- In the following example, the provided custom file name pattern is "REPORT_GROUP_NAME+'_'+DAY" and so the file name convention is "REPORTGROUPNAME_DAY."
- Enter the '@' key in the Report Custom FileName field to view the list of variables available for the report custom file name.
- Click the FTP in Publishers drop-down field to configure FTP server for Report Groups.
Click the Notification Channel drop-down list to select the notification channel for a report group. By default SMTP and SMS is selected as Notification Channel.
SMTP, SMS and SNS are the two available notification channels. SMTP indicates electronic mails, whereas SMS appears as a text message in mobile. SNS indicates the Amazon Simple Notification Service, which can be used to send the status of the generated report groups to the end users or report group consumers. If required, you can select all three of the SMTP, SMS and SNS notification channels for all the report groups. The Inbox notification channel is yet to be implemented in both Sigma Studio and Sigma Application.
- Click the Notification Channel of your choice to configure Notification Template and Custom File Name for the Report Group, e.g. SMTP.
Notification Template Configuration pop-up appears on screen, where you can choose Success And Failure Notification Template and configure Custom File Name for Report Group. Refer Notification Template for Reports for more information on notification channel and templates configuration. Refer to step 7(c) to configure Custom File name.
By default Send Failure Notification is enabled which automatically sends the Failure Notification when the Report Group is failed to execute.
- Click the Notification Channel of your choice to configure Notification Template and Custom File Name for the Report Group, e.g. SMTP.
- To enable password protection for the report group, click the Password Protected checkbox and provide a pattern for a password in Password Pattern field. To configure a password pattern proceed with the following steps
enter the function and attributes patterns in the Password Pattern field.
Enter '#' to view the list of functional patterns available for the password and select any from the list.
- s:getFirst can be used to read the starting characters from the selected attribute.
- s:getLast can be used to read the end characters from the selected attribute.
- d:day can be used to read days.
- d:month can be used to read the months in numbers. For example, 11 for the month November.
- d:monthabbr can be used to read the months in abbreviations. For example, Nov for the month November.
- d:monthfull can be used to read the months in words. For example, November for the month November.
- d:year can be used to read years.
- d:year2 can be used to read the last two digits of the year. For example, 21 for the year 2021.
Enter '@' to view the list of password attributes available for the functions. Select any one from the attribute list.
The following password attributes are available here:
- FIRST_NAME
- MIDDLE_NAME
- LAST_NAME
- DATE_OF_BIRTH
- LOGIN_ID
Select any one of the available checkboxes from the Generate Output As field to select the output of the report group, e.g. Single File.
Single File generates the selected reports as a single file. Individual File generates the selected reports as individual files. On selecting the Individual File option, the selected reports will individually get generated. For instance, if there are two reports in the selected report group, then the two reports will individually get generated as two different files in the Sigma Application. Multi Sheet generates the report group with multiple sheets.
- To compress the report group, select the Compress checkbox.
Provide a Custom File name for the compressed file of Report Group in the Custom Filename field. Refer to Step 7(c) to configure the Custom FileName.
Click the Publisher Relative Path field and enter the folder name in which the report needs to be saved. For example: /SIGMA REPORTS/ is given as the relative path here.
Press the '@' key in the Publisher Relative Path field to view the list of variables available for the publisher relative path.
In the Publisher Relative Path field, the specified folder will get automatically created with the provided folder name, e.g. /SIGMA REPORTS/. This folder will be placed within the Delivery folder in the Sigma workfolder. The Sigma workfolder can be found within your application project folder. On generating the report in Sigma Application, the generated report will be present in the specified relative path or folder (e.g. SIGMA REPORTS) within the Delivery folder in the Sigma workfolder on your application project.
Select Non Executable Group Report checkbox to make a configured Report Group as non-executable, non-editable and non-schedulable. But the reports in the Non Executable Group Report can be edited, executed and scheduled.
In the Sigma application, the reports/groups in the non-executable report groups are ordered in alphabetical order, and reports/groups can be generated individually.
To save the configured report group, click Save.
When you try to exit the Report Group screen, before saving your configured report group, a warning pop-up message appears, as shown in the following screen shot:
- Click Cancel, if you do not want to exit the Report Group screen.
- Click Ok, if you want to exit the Report Group screen.
A confirmation message, indicating a successful creation of the report group, appears.- Click Ok.