Description: Provides the ability to filter on one or two fields that exist in the report definition. You can define either an AND or an OR statement when using two filters. The field selector drop-down will include all fields that are available in the report definition.
Control Type: Logical filter
BCS Parameter: you cannot specify custom filters when running this report via BCS
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)
Description: Allows the user to select one event and then filter that event by date.
Control Type: Single-select
BCS Parameter: date_filter_field
Possible Values: first_access_date, last_access_date, completion_date, enrollment_date
Static Dates
To enter static dates, use the following parameters with a specific date for the filter_start_date and filter_end_date parameters:
BCS Parameter: filter_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: filter_end_date (optional)
Possible Values: <date_value in the format MM/DD/YYYY>
Default Value: 'now', or the last successful database refresh
Note: Default start and end dates will only be used if a date_filter_field value is entered and the date values are left blank. In this instance, the date values are dynamic and will update each time the report is run.
Dynamic Dates
For dynamic dates that change each time the report is run, use the following parameters:
BCS Parameter: filter_date_period (required)
Possible Values: 1 (Days), 2 (Weeks), 3 (Months), 4 (Years)
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
Filter to Date
If you are using filter_date periods, filter_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 filter_to_date=false, the report will only include activity for the requested periods.
BCS Parameter: filter_to_date (optional)
Possible Values: true or false
Default Value: true
Example:
If filter_to_date = true, the end date is always the date the report is run, up to and including the most recent database refresh.
If filter_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.
Description: Provides a list of standard time zones so you can display the times in your local time zone. This does not affect the actual UTC time of the activity. Default value is UTC.
Control Type: Single-select
BCS Parameter: time_zone
Possible Values: see BCS SubmitReport Time Zones for a list of acceptable values
Description: Provides the ability to select one, or many users or groups.
Note: The maximum number of users or groups selected for each report cannot exceed 1000.
Control Type: Multi-select
BCS Parameter: user_list
Possible Values: CSV list of <username> values
Default Value: All
BCS Parameter: group_list
Possible Values: CSV list of <group_orgcode> values
Default Value: All
Note: In some templates the Group or the User filter may not be available. For instance, if the report is group specific then the user filter may be disabled.
Description: Used to determine how records that contain field(s) that could have multiple values (such as a user that exists in multiple groups) present or stored the data in the report. If multiple rows are selected, a record will be provided for every instance.
Control Type: Single-select
BCS Parameter: show_multiple_groups
Possible Values: 1 (multiple rows), 2 (single row)
Description: Displays the completion status of the user for an asset as of the last day of the date range. Values include: Blank, In Progress, Waived, or Completed.
Description: The user's first access to the course during the report's time span. If the course was not launched (no access) during the date range of the report, this field will return no data.
Description: The user's last access during the report's time span. If the course was not launched (no access) during the date range of the report, this field will return no data.
Description: The current status of the Skillsoft Bootcamp Course. Possible values include: Enrolled (but not started); % completed (if enrolled, started but not completed); Completed; Withdrawn.
Description: The total cumulative duration for all launches in the specified date range for assets for which duration is tracked. Displayed in hh:mm format for Previewed reports, and reports exported to PDF and HTML. Displayed in minutes for reports exported to CSV and Excel.
Note: Duration for passive assets such as Word or PDF documents is not tracked.
Description: For courses, this is the expected duration of the asset. For videos, audio books, and recorded sessions, this is the actual run time. Displayed in hh:mm format for Previewed reports, and reports exported to PDF and HTML. Displayed in minutes for reports exported to CSV and Excel.
Only Show Assets Assigned Through Selected Groups' Learning Plan