Value Parameter Elements - Reporting Dashboards - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - external

Reporting Dashboards

Platform
OnBase
Product
Reporting Dashboards
Release
Foundation 24.1
License

The Value parameter of the Web Viewer URL can be used to describe a date-time range. If the parameter requires a date-time value, it must be formatted as type:begin:end, for example: =5:5:0

Note:

In some environments, the colon (:) may be a reserved character. It is a best practice to use URL encoding for all URLs.

The following table describes each element of the Value runtime parameter (for details on the runtime parameter elements, see Runtime Parameter Elements).

Value Parameter Element

Possible Values

type

The type value represents the type of date range and must be one of the following numbers. The type determines the values for the begin and end parameters.

  • 0: none

  • 1: Previous workday

  • 2: Last business day

  • 3: Yesterday

  • 4: Today

  • 5: Specific day this week

  • 6: First day of the month

  • 7: Last day of the month

  • 1001: Last month (the first day of last month through the last day of last month)

  • 1002: Current month (the first day of this month through the current day)

  • 1003: Current week (Sunday through the current day)

  • 1004: Month to date (the first day of this month through the current day)

  • 1005: Year to date

  • 2001: Last days

  • 2002: Last weeks

  • 2003: Last months

  • 2004: Last hours

begin

type = 0

If the type is set to 0(none), enter the beginning date, converted to .NET ticks.

For example, to begin the date range at January 26, 2014 12:00:00 AM you must enter 635262912000000000 for the begin parameter.

begin

type = 5

If the type is set to 5(specific day this week), enter the number that represents the day of the week:

  • 0: Sunday

  • 1: Monday

  • 2: Tuesday

  • 3: Wednesday

  • 4: Thursday

  • 5: Friday

  • 6: Saturday

begin

type = 2001

If the type is set to 2001(last days), enter the number of days before the current day. Enter a whole number. For example, 5 starts the date range five days before the current day.

begin

type = 2002

If the type is set to 2002(last weeks), enter the number of weeks before the current week. Enter a whole number. For example, 2 starts the date range two weeks before the current week.

begin

type = 2003

If the type is set to 2003(last months), enter the number of months before the current month. Enter a whole number. For example, 3 starts the date range three months before the current month.

begin

type = 2004

If the type is set to 2004(last hours), enter the number of hours before the current time. Enter a whole number. For example, 3 starts the date range three hours before the current date-time.

begin

all other type values

Enter 0 if the type is set to 1, 2, 3, 4, 6, 7, 1001, 1002, 1003, 1004, or 1005.

end

type = 0

If the type is set to 0(none), enter the ending date, converted to .NET ticks.

For example, to end the date range at January 26, 2014 12:00:00 AM you must enter 635262912000000000 for the end parameter.

end

type = 2004

If the type is set to 2004(last hours), enter the number of minutes before the current time. Enter a whole number. For example, 10 ends the date range ten minutes before the current date-time.

end

all other type values

Enter 0 if the type is set to 1, 2, 3, 4, 5, 6, 7, 1001, 1002, 1003, 1004, 1005, 2001, 2002, or 2003.