Difference between revisions of "Reporting - Query String Parameters"

From All n One's bxp software Wixi

Jump to: navigation, search
Line 97: Line 97:
  
  
'''URL Example'''
+
= URL Example =
  
 
The below URL is an example of a report being generated for 28 for today.
 
The below URL is an example of a report being generated for 28 for today.
Line 104: Line 104:
  
 
myform_reports.asp?intCampaign_Id=28&dteReport_From=Today_Start&dteReport_To=Today_End
 
myform_reports.asp?intCampaign_Id=28&dteReport_From=Today_Start&dteReport_To=Today_End
 +
 +
 +
[[Category:Module Specific:Data Profiling]]
 +
[[Category:Reporting]]

Revision as of 23:19, 3 February 2015

1 Overview

The reporting suite in bxp software contains a large amount of reports that you can use to filter your data and generate interesting graphs and charts.

Sometimes you may have a report that you pull very day and you need to turn it into a single button click.

How can this be achieved when you have to select the form and enter the dates.

This can be achieved by using query string parameters.


2 Query String Parameters

There are a few main values that need to be passed to the reports in order to generate the report.

The first is the ID or intCampaign_Id.

The ID field depending on the report will either be passed as ID or intCampaign_Id.

It will always be the number of the form that the data is located in, in the example below the number is 28.

Example

myform_reports.asp?ID=28

Or

myform_reports.asp?intCampaign_Id=28


2.1 Report Date Replace Parameteres

There are two fields that can be passed to a reporting page.

They are the date fields for to and from dates for the report to run.

In the query string they are represented as dteReport_From and dteReport_To.

These two fields can be passed 39 parameters that can be passed to each field.

  • Now
  • All_Start
  • All_End
  • Yesterday_Start
  • Today_Start
  • Tomorrow_Start
  • Yesterday_End
  • Today_End
  • Tomorrow_End
  • LastWeek_Start
  • ThisWeek_Start
  • NextWeek_Start
  • LastWeek_End
  • ThisWeek_End
  • NextWeek_End
  • LastMonWeek_Start
  • ThisMonWeek_Start
  • NextMonWeek_Start
  • LastMonWeek_End
  • ThisMonWeek_End
  • NextMonWeek_End
  • LastMonth_Start
  • ThisMonth_Start
  • NextMonth_Start
  • LastMonth_End
  • ThisMonth_End
  • NextMonth_End
  • LastQuarter_Start
  • ThisQuarter_Start
  • NextQuarter_Start
  • LastQuarter_End
  • ThisQuarter_End
  • NextQuarter_End
  • LastYear_Start
  • ThisYear_Start
  • NextYear_Start
  • LastYear_End
  • ThisYear_End
  • NextYear_End

These can be split into start dates and end dates after the underscore in each field there will either be the word start or end.

Example - Today

dteReport_From=Today_Start&dteReport_To=Today_End

Or - This Week

dteReport_From=ThisWeek_Start&dteReport_To=ThisWeek_End

Or - This Month

dteReport_From=ThisMonth_Start&dteReport_To=ThisMonth_End


3 URL Example

The below URL is an example of a report being generated for 28 for today.

The link is not an actual page in bxp software but is an example of how the report URL should look, everything after the question mark is valid bxp software code.

myform_reports.asp?intCampaign_Id=28&dteReport_From=Today_Start&dteReport_To=Today_End