Skip to main content

LMS Document Service Troubleshooting

Symptoms​

Material or certificate document operations report unavailable, timeout, rejection, empty response, missing reference, or missing file.

Scope​

Training's typed HTTP boundary to Document Service.

Cause​

Likely causes​

Dependency configuration absent; downstream unavailable; timeout/rejection; empty response; invalid local reference; missing downstream file; or partial external/local completion.

Safe diagnostic steps​

  1. Identify store versus download and material versus certificate.\n2. Record status/error category and sanitized correlation/time.\n3. Confirm local reference presence category only.\n4. Confirm dependency health through approved monitoring, not direct commands.

Resolution​

Safe resolution​

Retry only under approved policy when the operation is safe. Do not expose content, change references, or perform manual compensation. Escalate partial-completion cases.

Validation​

Using synthetic data, confirm the expected reference-presence category and supported download outcome.

Evidence to collect​

Collect only environment category, time window, capability/route, status or error category, sanitized correlation reference, lifecycle state category, and recent approved change context.

Escalation​

Jointly escalate to Training and Document ownership; include Gateway/frontend if the error is presentation-specific.

Source References​

  • microservices/src/training-service/Application/DocumentServiceClient.cs
  • microservices/src/training-service/Api/TrainingEndpoints.cs

Summary​

This Draft page provides non-destructive, source-backed diagnosis and stops where recovery authority is not confirmed.

Audience​

LMS users, support, operations, engineering, QA, architecture, security, and implementation teams.

Overview​

Use supported reads and sanitized evidence. Never expose personal learning data, credentials, configuration values, infrastructure details, or operational commands.

See Also​

Keywords​

  • LMS troubleshooting
  • Safe diagnostics

Revision Information​

  • Status: Draft
  • Last reviewed: 2026-07-17
  • Review cycle: Quarterly