A chart of asset completions over specified date ranges.
- Description: Allows the user to determine the date range and display units for all activity for the report.
- Control Type: Multi-option
To use this control, set the Display Units to the desired value. Then determine the length of time included in the results by setting either the Previous option or the From / To dates. Make sure the length of time included in the results does not exceed the value determined by the Display Units option. For more information, see Modify Chart Activity Dates.
Display Units
The display_units value available in all charts impacts the length of time that can be included in the report results. The length of time included in the results is determined by the report_date_period and the report_date_period_count values, or the report_start_date and report_end_date. For each display_unit, there is a maximum amount of time that can be included in the results.
The following list depicts the maximum length of time that can be included in the results for each Display Unit:
- Days - 16
- Weeks - 16
- Months - 12
- Quarters - 12
- Years - 4
Use the following parameter to set the display units:
- BCS Parameter: display_units
- Possible Values: 1 (Year), 2 (Quarter), 3 (Months), 4 (Weeks), 5 (Days)
- Default Value: 3
Previous Option
Use the following parameters to determine the number of previous intervals, such as, "previous 3 months." Ensure the combined value for these parameters does not exceed the maximum length of time set by the display_unit limits.
- BCS Parameter: report_date_period (required if using this option)
- Possible Values: 1 (Days), 2 (Weeks), 3 (Months), 4 (Years)
- Default Value: 3
- BCS Parameter: report_date_period_count (required if using this option)
- Possible Values: Any numeric value that, when combined with the report_date_period value, does not exceed the maximum length of time for the selected display_unit.
- Default Value: 3
To Date Option
- This option is only available if you are using the Previous option. Setting 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.
- 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: report_to_date (optional)
- Possible Values: true or false
- Default Value: true
Start and End Dates (From / To Option)
Use the following parameters to set start and end dates. The length of time returned by the dates cannot exceed the maximum length of time for the selected display_unit.
- BCS Parameter: report_start_date (required if using this option)
- 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 (required if using this option)
- Possible Values: <date_value in the format MM/DD/YYYY>
- Default Value: 'now', or the last successful database refresh