understanding canned reports · web view2020. 8. 20. · app administrator – has access to all...
TRANSCRIPT
Implementation Guide – Reports
Canned Reports
Table of ContentsUnderstanding Canned Reports.............................................................................3
Understanding the Terminology...........................................................................3
Creating a Canned Report.....................................................................................3
From Search Results page...................................................................................4
Creating Canned Report – Administration Console...............................................6
Procedure Overview.............................................................................................7
Scenario.................................................................................................................7
Creating Report Definition......................................................................................9
Report Admin Home Page...................................................................................9
Creating a Domain.............................................................................................10
Step 1 – Define Input..........................................................................................15
Define Output.....................................................................................................26
Default layouts & visuals....................................................................................26
Custom Layouts & Visuals.................................................................................32
Providing Authorization........................................................................................40
Step 2 – Authorize Roles to generate report......................................................40
Running Reports..................................................................................................44
Step 3 – Run Report...........................................................................................44
Report Execution Automation – Scheduling.........................................................50
Scheduling Report Execution.............................................................................51
Scheduling Report Delivery................................................................................55
Managing External Contacts................................................................................59
i
Canned Reports
Creating a Contact.............................................................................................61
Configuring Email Service....................................................................................63
Appendix..............................................................................................................67
Define Report Input............................................................................................67
Query Type – Summary..........................................................................................................67
IN operator..............................................................................................................................68
ii
Scenario
Understanding Canned Reports
A canned report is a pre-built report, based on the requirements of business user. Semantify provides an intuitive interface to create report.
Semantify provides wide range of industry standard report visuals in use for business intelligence. According to your business requirements, you can customize report layout and individual report visuals.
Understanding the Terminology
Prompt
A prompt is a report property that provides report users, an option to set report parameters prior to running the report. Prompts act as filters to customize the data in a report to suit user specific needs. For example, Sales Profit for a Financial Year (prompt).Based on the prompt value selection, the value is passed to a variable that is defined in the SQL statement for the report. On execution of the SQL query, the corresponding data appears on the report.
“~prompt~” – While using prompts in a SQL query, you must use ‘~’(tilde) character as prefix and suffix for the terms in double quotes
To help report users enter prompt values, you can specify a default value for a prompt. You can also configure a prompt to display a list of appropriate values from which the user can choose.
Metrics
Metrics represent the values that you want to view using a reference parameter. Metrics are what business users use to monitor and assess the performance of a business entity.For example, Sales Profit (metric) for a Financial Year. “#metric#” – While using metrics in a SQL query, you must use ‘#’(hash) character as prefix and suffix for the terms in double quotes
Creating a Canned Report
Semantify provides two ways of creating a canned report.
3
Scenario
From Search Results page From Administration Console
From Search Results page
You can allow users of a specific role to create ad-hoc canned reports after executing a search query.
If a role(s) is provided the right to create ad-hoc report, then the link – Create Canned Report appears on the search results page, as shown in Figure 1.
Figure 1: Canned Reports from Search Results page
When user clicks the link, Semantify generates the SQL query, selects the Prompts and Metrics. The report appears under the domain, Dynamic Canned Reports, as shown in Figure 2.
4
Scenario
Figure 2: Canned Report from Search Results page
Next, to view the report, you will need to run the report to view the report visuals, the procedure is explained in the Administration Console method of Canned report creation.
The only advantage of creating a report from Search Results page is that SQL query is generated by Semantify based on your search query, with automatic identification of prompts and metrics. Rest of the process to run a report and schedule report delivery is performed in the Administration Console.
5
Scenario
Creating Canned Report – Administration Console
Semantify Administration Console provides all the features and settings to manage Canned Reports.
1. Create Report Definition
Select Domain Define Report Define Report Layout
2. Provide Authorization of reports to Roles
3. Run a Report
4. Scheduling
Report Execution
Report Output Delivery (optional)
The following roles has the access to the Semantify Administration console:
App Administrator Report Administrator
The rights and privileges differ for each administrator.
App Administrator – Has access to all the settings to build and manage an App, including business model and Canned reports functionality.
Report Administrator – A Report Administrator has the following privileges:
Creates report structure and report layout Provides access rights to roles to run a report Configures report scheduling Enables Report delivery
Procedure Overview
6
Scenario
Scenario
To demonstrate the procedure to create a canned report, we will consider the following scenario.
A business user wants to view the Merchandise Amount spent using Credit Card by card holders of a bank, and the Balance to pay for a given time period.
For creating a canned report, the following prompts and metrics are identified:
Prompts Starting Month and Closing Month Merchandise Amount Merchandise Balance
Metrics Starting Month and Closing Month Merchandise Amount Product
SQL QueryThe SQL query to generate the report is shown in the following page.
7
Scenario
8
SELECT
bil. card_type_cd AS Product,
AVG(bil. mrc_amt ) AS MrcAmt,
AVG(bil. mrc_bal ) AS MrcBal
FROM
account2 acc
INNER JOIN billing2 bil
ON acc. account_id = bil. account_id
WHERE
bil.`perf_ym`
between '200601' and '200712'
AND bil.`mrc_amt` > 500
AND bil.`card_type_cd` IN ('101','102','103')
GROUP BY
bil.`card_type`
ORDER BY
bil.`card_type` ASC
SELECT
bil.`card_type_cd` AS "#Product#",
AVG(bil.`mrc_amt`) AS "#Mrc Amt#",
AVG(bil.`mrc_bal`) AS "#Mrc Bal#"
FROM
`account2` acc
INNER JOIN `billing2` bil
ON acc.`account_id` = bil.`account_id`
WHERE
bil.`perf_ym`
between "~Month From~" and "~Month To~"
AND bil.`mrc_amt` > "~Mrc Amt~"
AND bil.`card_type_cd` IN "~Product~"
GROUP BY
Marking Prompts (~) & Metrics (#) in the SQL query for the report.
The SQL query with the parameters of the report.
Creating Report Definition
Step 1 – Define Input
Creating Report Definition
For organizing the Canned Reports that you create, Semantify provides an organizational structure called Domains. Domains are similar to the folder/directory structure that you use to store you files in a computer/network. Domains facilitates categorizing canned reports based on the type and function of reports.
Report Admin Home Page
To begin the process of creating a Canned Report, login as a Report Admin, and select an App for which you wish to create Canned Reports, as shown in Figure 3.
Figure 3: Select App
9
Creating Report Definition
Step 1 – Define Input
Creating a Domain
The root of the Canned Reports storage location is called ‘Domain’. Under the Domain, you can create domains, such as ‘Sales’ to store the sales reports. If you do not wish to create a domain, a Canned Report appears in root Domain.
To create a domain
1. After selecting the App, click Structured Data, then Canned Reports and then click Define Domain, as shown in Figure 4.
10
Creating Report Definition
Step 1 – Define Input
Figure 4: Define Domain
Define Domain pane appears, as shown in Figure 5.
11
Creating Report Definition
Step 1 – Define Input
Figure 5: Define Domain pane
2. Click Define New Domain.New Domain options appears, as shown in Figure 6.
12
Creating Report Definition
Step 1 – Define Input
Figure 6: Define Domain
3. In the Name box, type a name for the box.
4. In Description box, you can enter brief description about the domain for your reference.
5. In the Parent Domain list box, select a domain, if you want to create the domain within another domain.
6. In the list, the domains do not appear in hierarchy, rather appear as a single list. For example, if the domains are in the hierarchy, Cards>Debit Cards>Visa, then in the list, hierarchy will not appear (though you can see in the Domain tree in the left section).
7. To view the hierarchy, click Select Domain, as shown in Figure 7.
13
Creating Report Definition
Step 1 – Define Input
Figure 7: Select Domain
8. In the Select Domain window, select a domain (sub-domain) where you want to keep the canned report.
9. Click Save Domain.The name of the domain appears in the list of domains. You can then assign one or more reports to the domain.
14
Creating Report Definition
Step 1 – Define Input
Step 1 – Define Input
Once, you are ready with the SQL query, you can start the process of creating a report.
The following steps describe the procedure to define report inputs:
1. After selecting the App, click Structured Data Canned Reports Define Input, as shown in Figure 8.
15
Creating Report Definition
Step 1 – Define Input
Figure 8: Define Input
Define Report Input pane appears, as shown in Figure 9.
16
Creating Report Definition
Step 1 – Define Input
Figure 9: Define Report Input
2. In the Select Dataset list box, select the dataset of the App.
3. Click Define New Report, and enter a name for the report, as shown in Figure 10.
Figure 10: Enter Report details
17
Creating Report Definition
Step 1 – Define Input
4. In the Domain list box, select the domain where you want to keep the report.
Domains are similar to a folder structure, i.e., to organize the reports. You can create a domain from the Define Domain menu.By default, reports are created under Domain (root domain). Refer Define Domain section for more information.
Report Status Active – Users can run a report. Inactive – Users cannot run a report. Invalid – Report definition is incomplete or have errors.
Color codes for Report status
Report valid, active and ready to access
Report Inactive Inactive and Invalid Report
5. To allow authorized report users to generate a report, select the option Active.
6. In the Query Type list box, select Summary or Advance Summary.If you have summarization functions, (the aggregate functions such as Count, Average) in the SQL query, then, you have two options to include summarization. Either you type in the SQL query or enter a raw SQL query and let Semantify implement summarization.
7. In the Query box, type the SQL query for the report.
8. Click Save Report.Semantify picks the prompts and metrics from the SQL query. You can view the prompts and metrics in the respective tabs.
9. To view prompts, click Prompts tab.The Prompts pane appears, as shown in Figure 11.
18
Creating Report Definition
Step 1 – Define Input
Figure 11: Prompts
10.To configure a prompt, click prompt name, ‘Performance Month From’.The prompt details appear, as shown in Figure 12.
19
Creating Report Definition
Step 1 – Define Input
Figure 12: Prompt details
11.Enter the following details in the prompt pane:i. Prompt Key – The name of the prompt to appear on the report (you
can enter a name of your choice).
ii. Description – Description of the prompt for reference. When a user runs a report, window appears with the list of prompts to select. If you enter the description, the ‘?’ symbol appears next to the prompt name. To know details of the prompt, user can click the ‘?’ mark.
iii. Business Term – The concept(entity) name in the Knowledge Base (Entities & Relations) that to which the prompt maps to, as shown in Figure 13.
20
Creating Report Definition
Step 1 – Define Input
Figure 13: Business Term
iv. Required – Select the check box, if you want to consider the prompt for the report now.
v. Value Type – Select the value type of the prompt from the following types, as shown in Figure 14.
21
Creating Report Definition
Step 1 – Define Input
Figure 14: Value Type
Value Type:Value – For the business terms that shows numerical values, e.g., Price Entity – For the business terms that are for reference, e.g., Product Name
vi. Default – Enter/Select a default value for the Value Type selected. For e.g., for the prompt, Product, the list of product names appears with check box to select, as shown in Figure 15.
22
Creating Report Definition
Step 1 – Define Input
Figure 15: Default value
12.After configuring the Prompt, click Confirm Prompt to save.
13.To configure report metrics, click Metrics tab.The metrics pane appears, as shown in Figure 16.
23
Creating Report Definition
Step 1 – Define Input
Figure 16: Metrics
14.Click a metric name.The following details of a metric appears, as shown in Figure 17.
Figure 17: Metric details
vii. Metric Name – The name of metric name as mentioned in the SQL query.
viii. Business Term – The concept(entity) name in the Knowledge Base (Entities & Relations) that to which the metric maps to, as shown in Figure 18.
24
Creating Report Definition
Step 1 – Define Input
Figure 18: Metric - Business Term
ix. Display Name – The name of the metric to appear on the report output.
x. Stat – Select the statistical value that is used in the SQL query for the metric, as shown in Figure 19.
Figure 19: Select Statistics
15.Click Save Metric.If all the parameters are correct, a valid report appears.
25
Creating Report Definition
Step 1 – Define Input
After defining report inputs, you can provide the authorization to the intended roles to run the report. However, the report will appear based on the Semantify default report page layout and grid type report.
26
Creating Report Definition
Step 1 – Define Input
Define Output
Once report definition and authorizations are done, you can design the report output. Defining a report output has the following two steps:
Report page layout Report visuals
If you want to re-organize the report layout, and add more report visuals, then the Define Output menu provides you the settings to configure a report a layout and the type of reports to appear on the layout.
After configuring the report parameters, select the report page layout and report formats.
Default layouts & visuals
The following steps describe the procedure to configure report layout and add report types:
1. On the Structured Data section, in the Canned Reports menu, click Define Output, as shown in Figure 20.
27
Creating Report Definition
Step 1 – Define Input
Figure 20: Define Output
Define Report Output pane appears, as shown in Figure 21.
28
Creating Report Definition
Step 1 – Define Input
Figure 21: Define Report Output
2. In the Reports section, select the report from a domain.
3. In the Layouts section, click and drag a layout into the layout pane, as shown in Figure 22.
29
Creating Report Definition
Step 1 – Define Input
Figure 22: Report Layout
4. Click Charts to select chart formats for the report, as shown in Figure 23.
30
Creating Report Definition
Step 1 – Define Input
Figure 23: Chart Types
5. Click and drag chart type to a cell in the layout.Create Chart Definition window appears, as shown in Figure 24.
31
Creating Report Definition
Step 1 – Define Input
Figure 24: Create Chart Definition
6. In the Create Custom Layout window, enter/select the following: Select Rows – Select the number of rows of cells in the layout. Row Height – Enter the height of each row (in points) Select Cols – Select the number of columns in the layout
7. Click Save.
8. After adding the charts to the cells, the report layout appears, as shown in Figure 25.
32
Creating Report Definition
Step 1 – Define Input
Figure 25: Report Layout with Charts
9. Click Save Report.
Custom Layouts & Visuals
Instead of using default layouts, you can create a layout based on your requirements.To create a custom layout
1. In the layouts sections, click and drag Custom icon to the layout area, as shown in Figure 26.
33
Creating Report Definition
Step 1 – Define Input
Figure 26: Custom
Create Custom Layout window appears, as shown in Figure 27.
34
Creating Report Definition
Step 1 – Define Input
Figure 27:Create Custom Layout
2. In the Create Custom Layout window, enter/select the following: Select Rows – Select the number of rows of cells in the layout. Row Height – Enter the height of each row (in points) Select Cols – Select the number of columns in the layout
3. Click Create.The report layout appears, as shown in Figure 28.
35
Creating Report Definition
Step 1 – Define Input
Figure 28: Custom Layout
The layout has 12 cells. You can delete cells to create a layout of your choice.
4. To delete a cell, click delete button, to rearrange the cells, as shown in Figure 29.
36
Creating Report Definition
Step 1 – Define Input
Figure 29: Re-arrange Cells
5. To add report visuals, click Charts.The list of chart icons appears, as shown in Figure 30.
37
Creating Report Definition
Step 1 – Define Input
Figure 30: Adding Charts
6. Click and drag a chart icon to a cell in the layout.Create Chart window appears, as shown in Figure 31.
38
Creating Report Definition
Step 1 – Define Input
Figure 31: Create Chart Definition
7. In the Chart Definition window, select the parameters for which you want to create a report.
8. To select multiple parameters, press and hold Shift key and then click parameters.
9. Click Save.The chart appears on the cell, as shown in Figure 32.
39
Creating Report Definition
Step 1 – Define Input
Figure 32: Adding charts to layout
10.Click Save Report.
40
Creating Report Definition
Step 1 – Define Input
Providing Authorization
Once you have created the Report structure, i.e., the prompts and metrics, you can provide the authorization to the intended roles to run the report.
Step 2 – Authorize Roles to generate report
The following steps describe the procedure to authorize intended roles to generate a report:
1. On the Structured Data menu, in the Canned Reports section, click Static Filters, and then click Report Filter, as shown in Figure 33.
Figure 33: Run Report
Report Filter pane appears, as shown in Figure 34.
41
Creating Report Definition
Step 1 – Define Input
Figure 34: Report Filter pane
In the Report Filter pane, in the Security Roles section, the list of roles names appears.
2. Click a role name.The list of reports that present in the system appears, as shown in Figure35.
Figure 35: Authorize Role
42
Creating Report Definition
Step 1 – Define Input
Two tabs appear on the pane.
AuthorizedIn the Authorized tab, the list of reports to which a user has access to appears with the option to remove access to a report.
UnauthorizedIn the Unauthorized tab, the list of reports to which a role does not have access to appear, with an option to provide access to a report.
To grant access to roles to run a report, in the Unauthorized pane, click Authorize, as shown in Figure 36.
Figure 36: Authorize
The report now appears in the Authorized tab pane, as show in Figure 37.
43
Creating Report Definition
Step 1 – Define Input
Figure 37: Authorized tab
To remove access to the report, click Unauthorize in the Status column.
44
Creating Report Definition
Step 1 – Define Input
Running Reports
Once the Report Admin provides authorization to the intended roles to run a report, the user having the roles can execute the report.
Step 3 – Run Report
The following steps describe the procedure to generate a report:
1. On the Structured Data menu, in the Canned Reports section, click Static Filters, and then click Report Filter, as shown in Figure 38.
45
Creating Report Definition
Step 1 – Define Input
Figure 38: Run Report
Report Filter pane appears, as shown in Figure 39.
46
Creating Report Definition
Step 1 – Define Input
Figure 39: Run Report pane
2. In Domain list, select your report and click Run Report.Run Report window appears, as shown in Figure 40.
47
Creating Report Definition
Step 1 – Define Input
Figure 40: Run Report
3. In the Run Report window, the logged in User should select the role from the list of Role Id list box.
4. Select the report prompts and click Run.The report execution status page appears, as shown in Figure 41.
48
Creating Report Definition
Step 1 – Define Input
Figure 41: Report Generation status
5. In the report executions details table, the following information appears: Report Name – Name of the report Role Name – Name of the role authorized to run the report Status – Status of report execution State – The status of report execution, such as in progress, completed Start Date – The date of start of report execution End Date – The end date of report executions Delivery Status – If a report delivery to contacts
6. To view the report, in the Test Executions table, in the View Report column, click View Report.The report page appears, as shown in Figure 42.
49
Creating Report Definition
Step 1 – Define Input
Figure 42: Report page
You can refine the list of reports that appear in the Text Executions section.
7. Click Filters.The set of options to filter the list of reports to appear, as shown in Figure 43.
Figure 43: Filter
50
Creating Report Definition
Step 1 – Define Input
You can select from the following filter options to refine the list of reports:
Existence
Active – To view list of active reports (reports available to run) Inactive – To view list of inactive reports (reports not available to
run) Valid – To view list of valid reports Invalid – To view list of invalid reports
State
Scheduled – To view list of reports that are scheduled to run In Progress – To view list of reports that are currently in execution Completed – To view list of reports that got executed Cancelled – To view list of reports whose execution got cancelled
Status
Success – To view list of reports that executed successfully Failure – To view list of reports that failed to execute Not Started – To view list of reports that are scheduled to run Started – To view list of reports whose execution started
Report Execution Automation – Scheduling
Semantify provides automation mechanism for report generation and report dispatch.
Using the report automation feature, you can schedule report generation at frequent intervals of time and also set schedules to dispatch report outputs through emails.
51
Creating Report Definition
Step 1 – Define Input
Scheduling Report Execution
Once you are ready with a Canned Report, you can set the schedule of report dispatch to the intended roles.
Semantify provides the following settings to define a Canned Report delivery schedule:
Start Date and End Date Role Prompts Recurrence
To define Canned Report schedule
1. On the Structured Data menu, click Canned Reports and then click Define Schedule, as shown in Figure 44.
52
Creating Report Definition
Step 1 – Define Input
Figure 44: Define Schedule
Define Report Schedule pane appears, as shown in Figure 45.
53
Creating Report Definition
Step 1 – Define Input
Figure 45: Define Report Schedule
The Define Report Schedule pane has the following sections, with the options to define a report delivery schedule:
Name – A name for the schedule Start Date/End Date – The duration of availability of the report to the
role Role Id – The group name to which the report access is scheduledPrompts
The list of prompts set in the report. You can select the values of the prompt for a particular schedule. For example, for November month report, select the month for the PeformanceMonth as November.
54
Creating Report Definition
Step 1 – Define Input
Figure 46: Set Prompts value
Recurrence
The recurrence option provides you the option to set the Canned Report schedule frequency.
You can define the delivery schedule using the following two options:
Using Simple option:
You can set the frequency of a Canned Report delivery in the intervals of Minutes, Hours, Days, Weeks, Months, or Years, as shown in Figure 47.
Figure 47: Simple options
To schedule, enter the number in the ‘for every’ box and select a time interval in the ‘Frequency’ list box.
Using Advanced option:
You can also set the schedule for a particular day, week, or week, as shown in Figure 48.
55
Creating Report Definition
Step 1 – Define Input
Figure 48: Advanced Scheduling option
To schedule for a specific duration, click ‘Advanced’ option and then select the option from the Month section, Day-Week or Day section.
In the Delivery Details section, as shown in Figure 49, in the All section, the list of delivery definitions appears.
Figure 49: Delivery Details
Select one or more intended delivery definitions from the All section and click the arrow to move the delivery definitions to the Selected section.
After setting the delivery schedule, click Save Schedule.
Scheduling Report Delivery
Once your report is ready, you can configure an automatic email service to deliver the report to the intended roles.
To define report delivery
1. In the Structured Data section, click Canned Reports menu and then click Define Delivery, as shown in Figure 50.
56
Creating Report Definition
Step 1 – Define Input
Figure 50: Define Delivery
Define Delivery pane appears, as shown in Figure 51.
57
Creating Report Definition
Step 1 – Define Input
Figure 51: Define Delivery pane
2. In the Reports section, click the Report that you created.The Delivery settings appears, as shown in Figure 52.
58
Creating Report Definition
Step 1 – Define Input
Figure 52: Delivery Settings
To configure report delivery mail to the intended roles, enter the following details:
Delivery Definition – The delivery settings that you create appear in the list box. The option facilitates reuse of previously created Delivery definitions.
Name – Name for the delivery settings File Format – Report file format that you want to mail to users File Name – Name of the Report Email Info
o To – Type the names of the contacts or contact group to which you wish to deliver the reports. You cannot type an email-id or a contact name in the box. On the contacts that are present in the system, appear based on the characters you type in. Refer Managing Contacts topic for details.
3. Click Save Delivery.
59
Creating Report Definition
Step 1 – Define Input
Managing External Contacts
A contact can get report output delivered to the email id only if email id is included in the contacts list in the system. A contact may belong to a contact group or exist as an individual contact.
A report admin when defines a report delivery, cannot type a contact or contact group that is not present in the Semantify system.
To create a group
1. In the System Admin menu, click Users and Roles, then click External contact, and then click Manage Contact Groups, as shown in Figure 53.
Figure 53: Manage Contact Groups
Add New Contact pane appears, as shown in Figure 54.
60
Creating Report Definition
Step 1 – Define Input
Figure 54: Contact Groups
4. Click Add New Contact Group.Add Contact Group form appears, as shown in Figure 55.
Figure 55: Add New Contact Group
5. In the Group Name box, enter name for the group of user.
6. Select Active check to enable the group. You can dispatch a canned report only to the users of an active group.
7. Click Create Group. The group name appears in the list of group names.
61
Creating Report Definition
Step 1 – Define Input
Creating a Contact
After creating a group, create a contact whom you wish to associate to a group. You can create a contact as and when required and later, associate to one or more groups.
To create a contact
1. In the System Admin menu, click Users and Roles, then click External Users and then click Manage Contacts, as shown in Figure 56.
Figure 56: Manage Contacts
Manage Contacts pane appears, as shown in Figure 57.Figure 57: Contacts
62
Creating Report Definition
Step 1 – Define Input
8. Click Add New Contact.Add New Contact form appears, as shown in Figure 58.
Figure 58: Add New Contact
9. In the Full Name box, enter name of the user.
10.In the Email Id box, enter the email id of the user.
11.Select the Active check box, to make the user available in Semantify environment.
12.Click Create Contact.The name of the user appears in the list of the user.
13.To associate the user with a group, from the list of users, click the icon in the list of Contact Groups, as shown in Figure 59.
Figure 59: Add Group
63
Creating Report Definition
Step 1 – Define Input
Contact pane appears, as shown in Figure 60.Figure 60: Contacts
14.In the list of Groups section, click a group name to which you wish to associate the user to.
15.Click the arrow box pointing to Groups Assigned section.
16.Click Assign Group.Group association confirmation message appears.
Configuring Email Service
For the delivery mechanism to work, you need to configure the email server settings. You can add one or more email service configurations, and based on the need, you can make use of an email configuration. However, you can use only one email setting at a time.
The following steps describe the procedure to configure email service:
1. In the System Admin menu, click Users and Roles, then click External Users and then click Mail Configuration, as shown in Figure 61.
64
Creating Report Definition
Step 1 – Define Input
Figure 61: Mail Configuration
Define Email Configuration pane appears, as shown in Figure 62.Figure 62: Define Email Configuration
17.To add a new email configuration, click Add New Email Configuration.Define Email Configuration pane appears, as shown in Figure 63.
65
Creating Report Definition
Step 1 – Define Input
Figure 63: Define Email Configuration
Enter the following details based on your organization’s email server:
i. Configuration name – Name for the email service
ii. Host Name – Email server host name
iii. Port – The port number of the email server
iv. From – Email id of the sender
v. Type – Select the security type, SSL or TSL
vi. Reply To – The email id to which end users can reply to the email from which they receive the reports
vii. User name – If a username is configured for the email service
viii. Password – Password for the username
66
Creating Report Definition
Step 1 – Define Input
ix. Active – To enable the email service
67
Appendix
Appendix
Define Report Input
Query Type – SummarySummary is the option to be selected when a SQL query is written with an aggregation, means, the SQL query was already written with Group BY clause.
In such kind of reports, System will not apply any more aggregation and execute the query as is and produce the result
Advanced Summary is the option to be selected when a SQL is written without included any kind of aggregation, means, SQL query was already written without Group BY.
In such kind of reports, System will apply the aggregation as requested in metrics
In both the cases, appropriate aggregate function needs to be chosen carefully.
For Example
Advanced Summary
SELECT
MJY38.`perf_ym` AS "#Perf YM#",
MJY38.`card_type` AS "#Card Type#",
MJY38.`mrc_amt` AS "#Mrc Amt#",
MJY38.`mrc_bal` AS "#Mrc Bal#",
MJY38.`account_id` AS "#Account#"
FROM
`billing2` MJY38
Summary.,
SELECT
MJY38.`perf_ym` AS "#Perf YM#",
68
Appendix
MJY38.`card_type` AS "#Card Type#",
AVG(MJY38.`mrc_amt`) AS "#Mrc Amt#",
AVG(MJY38.`mrc_bal`) AS "#Mrc Bal#",
COUNT(MJY38.`account_id`) AS "#Account#"
FROM
`billing2` MJY38
GROUP BY
MJY38.`perf_ym`,
MJY38.`card_type`
ORDER BY
MJY38.`perf_ym` ASC,
MJY38.`card_type` ASC
---------------------------------------------------------------------------
IN operatorWhen IN operator is used in the conditions of a SQL query, where in the conditions needs to be used as a prompt
In such cases IN has to be written wrappd with braces.
Consider below example.,
SQL with IN operator for prompt.,
SELECT
TAA65.`card_type_cd` AS "#CardType#",
TAA65.`perf_ym` AS "#PerfYm#",
AVG(TAA65.`mrc_amt`) AS "#MrcAmt#",
AVG(TAA65.`bt_amt`) AS "#BtAmt#"
FROM
`billing2` TAA65
69
Appendix
WHERE
TAA65.`card_type_cd` IN ("~Card Type~") AND
TAA65.`perf_ym` BETWEEN "~200508~" AND "~200612~"
GROUP BY
TAA65.`perf_ym`,
TAA65.`card_type_cd`
ORDER BY
TAA65.`perf_ym` ASC,
TAA65.`card_type_cd` ASC
70