Key Stats Procedures - Revision history

Philip Lacey at 11:43, 6 May 2016

2016-05-06T11:43:21Z

Philip Lacey at 11:41, 6 May 2016

2016-05-06T11:41:01Z

Patrick Jenkins at 18:32, 15 December 2015

2015-12-15T18:32:08Z

Patrick Jenkins at 18:31, 15 December 2015

2015-12-15T18:31:45Z

Patrick Jenkins at 18:27, 15 December 2015

2015-12-15T18:27:21Z

Philip Lacey: /* Js_Client_Conversion */

2015-08-25T10:10:14Z

‎Js_Client_Conversion

Philip Lacey: /* Procedures explained */

2015-08-25T10:10:03Z

‎Procedures explained

Patrick Jenkins at 10:56, 3 August 2015

2015-08-03T10:56:19Z

Patrick Jenkins: Created page with " == Overview == The bxp module Key Stats has recently received an update, this update allows Key Stats report creators to create complex Sql statements and layouts by simply..."

2015-08-03T10:55:41Z

Created page with " == Overview == The bxp module Key Stats has recently received an update, this update allows Key Stats report creators to create complex Sql statements and layouts by simply..."

New page

== Overview ==

The bxp module Key Stats has recently received an update, this update allows Key Stats report creators to create complex Sql statements and layouts by simply adding parameters to a query.

== Procedures explained ==

bxp currently has the following key stats procedures added to it, with more being added all the time.

* Js_Client_Conversion
* Mass_HiddenObject
* Form_Calendar_View

=== Js_Client_Conversion ===

This procedure draws to screen javascript functions that can be called by the report creators own JS code, to perform conversions of the clients bxp user id to the following:

* Username
* Status
* Department
* Role
* Cost Center
* Email

To execute the Key stats Procedure simply set the query field to be ''Js_Client_Conversion" and then enter in a comma separated string for the type of JS function you wish to create into the SQL query section of the stat creation page

i.e. Username,Status,Department,Role,CostCenter,Email

=== Mass_HiddenObject ===

This procedure draws hidden objects that have the values set to the fields of a custom sQL statement, similar to the hidden list functionality already present. However unlike the hidden list functionality were it can only generate one object to the page, this procedure can generate X objects to the page from one Key Stat. To execute the Key stats Procedure simply set the query field to be ''Mass_HiddenObject" and enter the following into the SQL query section of the stat creation page:

BXP Table Name
[[##SEP##]]Fields (separated by ,'s)
[[##SEP##]]Where clause Order by clause group by clause Limit

Example
CDA_5[[##SEP##]]intCDA_5_Id,strCDA_5_field_0_4,strCDA_5_field_0_5,strCDA_5_field_0_8,strCDA_5_field_0_11,strCDA_5_field_0_12,strCDA_5_field_0_10[[##SEP##]]WHERE strCDA_5_field_0_4 = 'True' Order BY intCDA_5_Id Group By strCDA_5_field_0_11 Limit 10

=== Form_Calendar_View ===

This procedure draws a calendar view to the page that displays events, all of the events must be in a form but can also be apart of the bxp appointment manager, this procedure allows for the calendar to be limited by a where clause allowing a person to view a calendar of items that are just assigned to themselves. The calendar can also be colour coded to highlight different events

BXP Form Name

[[##SEP##]]Event Description field

[[##SEP##]]Event start date time field

[[##SEP##]]Event end date time field

[[##SEP##]]Allow click through to record

[[##SEP##]]alternative start date

[[##SEP##]]Field that contains event colour code

[[##SEP##]]Where clause Order by clause group by clause Limit

Example

CDA_8

[[##SEP##]]strCDA_8_field_0_1

[[##SEP##]]strCDA_8_field_0_3

[[##SEP##]]strCDA_8_field_0_4

[[##SEP##]]true

[[##SEP##]]2015-07-05

[[##SEP##]]strCDA_8_field_0_9

[[##SEP##]]WHERE strCDA_8_field_0_5 = 'True' Order BY intCDA_8_Id Group By strCDA_8_field_0_12 Limit 10

@@ Line 101: / Line 101: @@
-=== Div_Table_Export ===
+=== Div_Email_Export ===
-This procedure allows for a custom button to be drawn on screen that when clicked simply exports the contents of a div to an excel file.
+This procedure allows for a custom button to be drawn on screen that when clicked simply exports the contents of a div to be sent as a rich text email.
 <syntaxhighlight lang="text">

@@ Line 13: / Line 13: @@
 * Form_Calendar_View
 * Div_Table_Export
@@ Line 30: / Line 31: @@
 i.e. UserName,Status,Department,Role,CostCenter,Email
 === Mass_HiddenObject ===
@@ Line 46: / Line 48: @@
 CDA_5[[##SEP##]]intCDA_5_Id,strCDA_5_field_0_4,strCDA_5_field_0_5,strCDA_5_field_0_8,strCDA_5_field_0_11,strCDA_5_field_0_12,strCDA_5_field_0_10[[##SEP##]]WHERE strCDA_5_field_0_4 = 'True' Order BY intCDA_5_Id Group By strCDA_5_field_0_11 Limit 10
 </syntaxhighlight>
 === Form_Calendar_View ===
@@ Line 75: / Line 78: @@
 [[##SEP##]]WHERE strCDA_8_field_0_5 = 'True' Order BY intCDA_8_Id Group By strCDA_8_field_0_12 Limit 10
 </syntaxhighlight>
 === Div_Table_Export ===
@@ Line 94: / Line 119: @@
 [[##SEP##]]50px
 [[##SEP##]]Master_Button
 </syntaxhighlight>

@@ Line 76: / Line 76: @@
 </syntaxhighlight>
-=== Form_Calendar_View ===
+=== Div_Table_Export ===
 This procedure allows for a custom button to be drawn on screen that when clicked simply exports the contents of a div to an excel file.

@@ Line 22: / Line 22: @@
 * Department
 * Role
-* Cost Center
+* CostCenter
 * Email
@@ Line 29: / Line 29: @@
 i.e. UserName,Status,Department,Role,CostCenter,Email
 === Mass_HiddenObject ===

@@ Line 12: / Line 12: @@
 * Mass_HiddenObject
 * Form_Calendar_View
@@ Line 36: / Line 37: @@
 <syntaxhighlight lang="text">
 BXP Table Name
 [[##SEP##]]Fields (separated by ,'s)
 [[##SEP##]]Where clause Order by clause group by clause Limit
 </syntaxhighlight>
@@ Line 44: / Line 43: @@
 Example
+<syntaxhighlight lang="text">
 CDA_5[[##SEP##]]intCDA_5_Id,strCDA_5_field_0_4,strCDA_5_field_0_5,strCDA_5_field_0_8,strCDA_5_field_0_11,strCDA_5_field_0_12,strCDA_5_field_0_10[[##SEP##]]WHERE strCDA_5_field_0_4 = 'True' Order BY intCDA_5_Id Group By strCDA_5_field_0_11 Limit 10
+</syntaxhighlight>
 === Form_Calendar_View ===
@@ Line 52: / Line 51: @@
 This procedure draws a calendar view to the page that displays events, all of the events must be in a form but can also be apart of the bxp appointment manager, this procedure allows for the calendar to be limited by a where clause allowing a person to view a calendar of items that are just assigned to themselves. The calendar can also be colour coded to highlight different events
 BXP Form Name
 [[##SEP##]]Event Description field
 [[##SEP##]]Event start date time field
 [[##SEP##]]Event end date time field
 [[##SEP##]]Allow click through to record
 [[##SEP##]]alternative start date
 [[##SEP##]]Field that contains event colour code
 [[##SEP##]]Where clause Order by clause group by clause Limit
 Example
+<syntaxhighlight lang="text">
 CDA_8
 [[##SEP##]]strCDA_8_field_0_1
 [[##SEP##]]strCDA_8_field_0_3
-[[##SEP##]]strCDA_8_field_0_4
+=== Form_Calendar_View ===
-[[##SEP##]]true
+This procedure allows for a custom button to be drawn on screen that when clicked simply exports the contents of a div to an excel file.
-[[##SEP##]]2015-07-05
+<syntaxhighlight lang="text">
-[[##SEP##]]strCDA_8_field_0_9
+Example
-[[##SEP##]]WHERE strCDA_8_field_0_5 = 'True' Order BY intCDA_8_Id Group By strCDA_8_field_0_12 Limit 10
+<syntaxhighlight lang="text">

@@ Line 18: / Line 18: @@
 This procedure draws to screen javascript functions that can be called by the report creators own JS code, to perform conversions of the clients bxp user id to the following:
-* Username
+* UserName
 * Status
 * Department
@@ Line 28: / Line 28: @@
-i.e. Username,Status,Department,Role,CostCenter,Email
+i.e. UserName,Status,Department,Role,CostCenter,Email