Difference between revisions of "Calculated Field"

From SmartWiki
Jump to: navigation, search
(Formatting)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
{{MySQL Syntax}}
 
The ''Calculated Field'' in the [[Report Builder]] allows you to specify MySQL statements to be executed when generating the report.
 
The ''Calculated Field'' in the [[Report Builder]] allows you to specify MySQL statements to be executed when generating the report.
 +
 +
The field itself is a multiple line text area field, which means users can stretch out the box so that all text contained within the field can be immediately exposed. This is of assistance when there are long, complicated calculations against a column.
  
 
The following are some examples of statements that can be entered into the ''Calculated Field'' of the [[Report]] builder.
 
The following are some examples of statements that can be entered into the ''Calculated Field'' of the [[Report]] builder.
Line 15: Line 18:
 
===Dates===
 
===Dates===
  
Under Calculated Field section, you can use the following format for a date field
+
{{ReportBuilderDateFormatOption}}
 +
<br />
 +
 
 +
{{MYSQLDATETIMEFORMATS}}
 +
 
 +
===Calculate Business Day===
 +
To calculate number of business day had passed, you need to do the following:
 +
 
 +
1. Create a holiday calendar and add all the holiday within that calendar.
 +
 
 +
2. Use the following syntax within Calculated Field when you build your report
  
DATE_FORMAT([this], '%W, %M %D') -- Thursday, November 5th
+
'''Syntax'''
 +
SS_FUNC.countbusdays(date1,date2)
 +
 
 +
'''Example'''
 +
SS_FUNC.countbusdays(now(),[this])- 1
  
DATE_FORMAT([this], '%h:%i %p') -- 11:45 AM - 02:00 PM
 
  
{| border="1"
 
! Format
 
! Description
 
|-
 
|%a||Abbreviated weekday name
 
|-
 
|%b||Abbreviated month name
 
|-
 
|%c||Month, numeric
 
|-
 
|%D||Day of month with English suffix
 
|-
 
|%d||Day of month, numeric (01-31)
 
|-
 
|%e||Day of month, numeric (1-31)
 
|-
 
|%H||Hour (00-23)
 
|-
 
|%h||Hour (01-12)
 
|-
 
|%I||Hour (01-12)
 
|-
 
|%i||Minutes, numeric (00-59)
 
|-
 
|%k||Hour (0-23)
 
|-
 
|%l||Hour (1-12)
 
|-
 
|%M||Month name
 
|-
 
|%m||Month, numeric (00-12)
 
|-
 
|%p||AM or PM
 
|-
 
|%r||Time, 12-hour (hh:mm:ss AM or PM)
 
|-
 
|%S||Seconds (00-59)
 
|-
 
|%s||Seconds (00-59)
 
|-
 
|%T||Time, 24-hour (hh:mm:ss)
 
|-
 
|%W||Weekday name
 
|-
 
|%Y||Year, four digits
 
|-
 
|%y||Year, two digits
 
|}
 
  
 
==Conditional Statements==
 
==Conditional Statements==
Line 93: Line 61:
 
  THEN 'Thank for your submission' WHEN 'Status 3' THEN 'Congratulations' ELSE 'I have no comment' END
 
  THEN 'Thank for your submission' WHEN 'Status 3' THEN 'Congratulations' ELSE 'I have no comment' END
  
 +
==Formatting==
 +
 +
To add a line break between two values in the calculated field, use syntax such as the following:
 +
 +
<nowiki> concat([2],"<br>",[3])</nowiki>
  
 +
This will make the column display the value in column 2 of the Report Builder, followed by a line break, followed by the value in column 3.
  
 
==See Also==
 
==See Also==

Latest revision as of 16:04, 11 November 2014

This feature uses MariaDB syntax

The Calculated Field in the Report Builder allows you to specify MySQL statements to be executed when generating the report.

The field itself is a multiple line text area field, which means users can stretch out the box so that all text contained within the field can be immediately exposed. This is of assistance when there are long, complicated calculations against a column.

The following are some examples of statements that can be entered into the Calculated Field of the Report builder.


Sums

Add the values in column 10 and 11:

[10]+[11]
  • If the value in either column 10 or 11 is blank(null), using the above statement will result in incorrect calculations.

Sum column 10 and 11, using zero as the value if the either field is blank:

ifnull([10],0)+ifnull([11],0)

Dates

Report Builder Date Format Option

Under the Calculated Field section of the Report Builder, you can use the following format for a date field:

Syntax Output
DATE_FORMAT([this], '%W, %M %D') Thursday, November 5th
DATE_FORMAT([this], '%h:%i %p') 11:45 AM, 02:00 PM


Format Description
%M %d, %Y will return date in format of September 30, 2012
%a will return the truncated day of the week, e.g. Sun. for Sunday
%b will return the truncated name of the month, e.g. Sep for September
%c will return the month number in short format, e.g. 9 for September
%d will return the numeric day of month (01-31)
%e will return the numeric day of month (1-31)
%h will return hour (01-12)
%i will return minutes (00-59)
%j will return day of year (001-366)
%k will return hour (0-23)
%l will return hour (1-12)
%m will return the month number, e.g. 09 for September
%p will return AM/PM information, e.g. AM
%r will return the full time in 12-hour format, e.g. 12:00:00 AM
%s will return seconds (00-59)
%u will return the week number (00-53) where Monday is the first day of the week
%w day of the week (0=Sunday...6=Saturday)
%y will return the truncated year, e.g. 12 for 2012
%D will return the month ordinal, e.g. 30th
%H will return hour (00-23)
%M will return the month name, e.g. September
%T will return the full time in 24-hour format, e.g. 23:00:00
%U will return the week number (00-53) where Sunday is the first day of the week
%W will return the day of the week, e.g. Sunday
%Y will return the four-digit year, e.g. 2013

Calculate Business Day

To calculate number of business day had passed, you need to do the following:

1. Create a holiday calendar and add all the holiday within that calendar.

2. Use the following syntax within Calculated Field when you build your report

Syntax SS_FUNC.countbusdays(date1,date2)

Example SS_FUNC.countbusdays(now(),[this])- 1


Conditional Statements

To show different results depending on the value you can use 2 methods:

If

Syntax

  • if(conditional statement,value if true,value if false)

Examples

  • If the field value is Pending Approval' display the word Submitted, otherwise display the field value:
if([this]='Pending Approval','Submitted',[this])
  • If the field value (statusid in this example) is one of 6 different statusids, display the word Submitted', otherwise display the field value:
if([11] in (9681,10134,10028,9685,9683,9901),'Submitted',[this])

Case

Syntax

  • CASE value WHEN value 1 THEN result 1 WHEN value 2 THEN result 2 END

Example

CASE [this] WHEN 'Status 1' THEN 'Submission Cutoff is March 5th.' WHEN 'Status 2' 
THEN 'Thank for your submission' WHEN 'Status 3' THEN 'Congratulations' ELSE 'I have no comment' END

Formatting

To add a line break between two values in the calculated field, use syntax such as the following:

concat([2],"<br>",[3])

This will make the column display the value in column 2 of the Report Builder, followed by a line break, followed by the value in column 3.

See Also