Provides summary information about the inGenius users and their activity in the system for a specified period.
- Description: Allows the user to determine the date range for all activity for the report.
- Control Type: Multi-option
Use the following parameters to set start and end dates.
- BCS Parameter: report_start_date (optional)
- Possible Values: <date_value in the format MM/DD/YYYY>
- Default Value: the first day of the preceding calendar month
- BCS Parameter: report_end_date (optional)
- Possible Values: <date_value in the format MM/DD/YYYY>
- Default Value: 'now', or the last successful database refresh
Use the following parameters to set dates for a number of previous intervals, such as, "previous 3 months."
- BCS Parameter: report_date_period (required)
- Possible Values: 1 (Days), 2 (Weeks), 3 (Months), 4 (Years)
- Default Value: 3
- BCS Parameter: report_date_period_count (required)
- Possible Values: valid numeric value with the following maximum value for each report_date_period:
Days - 9999
Weeks - 999
Months - 999
Years - 99
- Default Value: 1
- BCS Parameter: report_to_date (optional)
If you are using report_date periods, report_to_date=true will include all activity for the requested periods plus activity in the current period up to the current date and time. If report_to_date=false, the report will only include activity for the requested periods.
- Possible Values: true or false
- Default Value: true
- Example:
- If report_to_date = true, the end date is always the date the report is run, up to and including the most recent database refresh.
- If report_to_date = false, the end date is the last day of the previous interval. For instance, if today is December 31, the ‘Previous [n] Months’ ends on November 30 and the ‘Previous [n] Years’ ends on December 31 of the prior year.
- BCS Parameter: display_units (optional and used in chart templates only)
- Possible Values: 1 (Year), 2 (Quarter), 3 (Months), 4 (Weeks), 5 (Days)
- Default Value: 3