• 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

• Description: Provides the ability to select one, or many assets.

  Note: The maximum number of assets selected for each report cannot exceed 1000.

• Control Type: Multi-select list
• BCS Parameter: asset_list
  • Possible Values: CSV list of <any_asset_id> values
  • Default Value: All available

• Description: Provides the ability to select all or specific asset categories and sub-categories.
  • Categories and sub-categories can be selected independently of each other.
  • Selecting an asset category will include all sub-categories for that value.
  • You can also select sub-categories individually.
• Control Type: Multi-select
• BCS Parameter: asset_category
  • Possible Values: 1 (Book), 2 (Courses), 3 (Custom Content), 4 (Instructor Led Training), 6 (Resources), 21 (Videos)
  • Default Value: All available
• BCS Parameter: asset_subcategory
  • Possible Values: See the tables below for a list of sub-categories available for each category. There are no sub-categories for the Instructor Led Training or Video categories.
  • Default Value: All available

• Description: Provides the ability to specify a completion status.
• Control Type: Single-select
• BCS Parameter: completion_status
  • Possible Values: 1 (completed), 2 (in progress), 5 (waived)
  • Default Value: Any

• 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

• 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

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)
  • Default Value: 3
• BCS Parameter: filter_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

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 the ability to include subgroups within the scope of the report.
• Control Type: Single-select check box
• BCS Parameter: select_subgroups
  • Possible Values: 0 (don’t select), 1 (select)
  • Default Value: Don't select

• Description: Provides the ability to specify user statuses.
• Control Type: Multi-select
• BCS Parameter: user_status
  • Possible Values: 1 (activated), 2 (deactivated)
  • Default Value: Activated

• 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:  Provides the ability to filter data based on user profile fields that have been configured and enabled on the User Profile page.
• Control Type:  Logical filter
• BCS Parameter: N/A

• Description: Includes timestamps in all date fields in the report.
• Control Type: Single-select check box
• BCS Parameter: show_date_with_time
  • Possible Values: 0 (don’t show), 1 (show)
  • Default Value: Show

• Description:  Provides ability to limit output to assets that have been assigned to the users through selected groups.

  Note: Do not use with the Display Option: List users within multiple groups in "Single Row."

• Control Type: Single-select check box
• BCS Parameter: show_group_myplan_assignments
  • Possible Values: 0 (do not select), 1 (select)
  • Default Value: Do not select

• 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
  • Default Value: GMT

• Description: The title of the asset.
• BCS Value: asset_title

• 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.

• BCS Value: sum_of_session_durations

• Description: The type of asset.
• BCS Value: asset_category

• Description: The ID of the learning asset, for example, COMM0101.
• BCS Value: asset_name

• Description: The average number of accesses per user. This is determined by taking "Accesses" and dividing it by "Unique Users."
• BCS Value: ave_launches_per_user

• Description: The average actual duration per completed asset. Only for assets for which duration is tracked and for which the status is completed. 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.
• BCS Value: ave_duration_per_user_who_completed

• Description: The average actual duration per user. Only for users that have activity that includes a duration for that asset. 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.
• BCS Value: ave_duration_per_user

• 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.
• BCS Value: asset_expected_duration

• 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.
• BCS Value: last_access

• Description: The total number of launches of this specific asset in the specified date range.
• BCS Value: count_of_launches

• Description: The total number of the users who have completed the asset, not including revoked completions.
• BCS Value: count_of_completing_users

• Description: The total number of students who have accessed the asset.
• BCS Value: count_of_accessing_users