Sharing and Embedding for Education Service Yield Reporting

Data sources include public market yield benchmarks from licensed financial data service providers, and self-developed course-associated revenue

What the data for this category looks like

Data sources include public market yield benchmarks from licensed financial data service providers, and self-developed course-associated revenue calculation datasets from education service platforms. Full data updates are completed within 1 hour following daily A-share market close. Data can be pulled by individual course or individual student batch. Two document forms are supported: structured reports and embedded displays. Structured reports include fields such as course annualized yield, contemporaneous benchmark yield, student average holding period, and cumulative class duration. Yield is measured in percentage, holding period in calendar days, and cumulative duration in hours.

What constraints these characteristics impose on the sharing and embedding workflow

The daily update schedule requires that the cache duration of embedded components must not exceed 24 hours. Otherwise, expired data will be displayed. The multi-dimensional field structure requires that share links support passing filter parameters such as course ID and student batch to enable precise content delivery. The two document forms require embedding solutions to adapt to different containers. Iframe embedding must support adaptive height adjustment. Direct link sharing must provide format switching options. The audience permission hierarchy for education services requires that sharing and embedding functions support content filtering based on user roles. The solution must also support guest access without login, to prevent content from failing to load due to permission verification failures.

How to configure settings

Configuration ItemRecommended ValueRationale
embed_cache_expire86400 secondsMatches the daily update schedule, prevents display of outdated data before cache expiration
share_filter_enableEnabledSupports passing course ID and student batch parameters to enable precise content filtering
share_permissionGrouped by roleAdapts to the layered permission requirements of instructors and students for education services
iframe_auto_heightEnabledAdapts to content containers of varying heights on course pages, avoids scroll bars
auth_modeGuest access + role verificationCompatible with public sharing and student-only access scenarios, aligns with access requirements for education services
download_format_supportPDF, CSVMatches the two document forms of structured reports and embedded displays

The parameter values provided on this page are common starting points for configuration. Actual values are affected by material form, data volume, and business rules. Specific issues require specific analysis. It is recommended to test on your own samples before finalizing settings.

Three common configuration mistakes

  • Issue: No response when clicking the share button in an overseas SaaS deployment environment, and the console returns a 403 error code. Cause: The share_cors_allowlist parameter is not configured, and cross-origin requests from the target domain are not allowed.
  • Issue: Embedded yield data has not been updated for more than 24 hours. Cause: The embed_cache_expire configuration value is set to greater than 86400 seconds, and the cache is not refreshed in time.
  • Issue: In open source version 4.8.14, the embedding component cannot implement student-only guest access. Cause: This version does not include a built-in guest identity verification module. Upgrade to a version that supports this function.

How to verify configurations are set correctly

  • Access the test link of the embedding component, pass the specified course ID parameter, and confirm that the displayed content matches the yield data of the corresponding course.
  • Check the console logs of the embedding component, confirm that there are no cross-origin request interception prompts, and that the share_cors_allowlist configuration is effective.
  • Wait 24 hours, then refresh the embedded page, and confirm that the data has been updated to the latest daily yield report.
  • Switch test accounts with different roles, confirm that instructor accounts can view full data, and student accounts can only view course data for their corresponding batches.

Question material comes from public community discussions. Configuration values are common starting points and should be measured against your own samples. Verified on 2026-09-14.