VaultLifecycle

Reports & System Status

The VaultLifecycle Reports page provides operational health reports for your REFRACT Platform deployment, including the System Status Check PDF and platform update checks.

The Reports page in VaultLifecycle provides operational and diagnostic reports for your REFRACT Platform deployment. Reports are generated on demand and do not require any additional Azure infrastructure.


System Status Check

The System Status Check generates a health and status PDF report covering the key components of your REFRACT Platform deployment. It is available from the Reports page in the VaultLifecycle workspace and can be downloaded as a PDF for sharing with support teams or internal stakeholders.

What the report includes

SectionDescription
Dispatcher connectivityConfirms the Azure Function endpoint is reachable and returning expected responses.
Storage configurationValidates that configured Azure Blob Storage containers are accessible with the configured credentials.
SharePoint listChecks that the VaultPDF Activity list is present and correctly structured.
License statusReports the current license state, expiry, and feature entitlements.
Service configurationSummarises active products, queue settings, and feature flags resolved at runtime.
Platform update checkCompares the installed engine version against the latest stable release and surfaces release notes if an update is available. See Platform Update Checks below.

No data leaves your environment

The System Status Check reads only from your own Dispatcher API and SharePoint environment. The only outbound call made during report generation is the lightweight manifest fetch described below - no document content or business data is transmitted.

Generating the report

  1. Open the VaultLifecycle workspace in SharePoint.
  2. Select Reports from the left navigation.
  3. Click Download PDF on the System Status Check card.
  4. The report is generated and downloaded directly to your browser.

Platform Update Checks

During System Status Check report generation, REFRACT Platform may retrieve publicly available release metadata from Vault-operated documentation services.

The request fetches a small JSON manifest from:

https://docs.vaultpdf.io/releases/manifest.json

The manifest is a structured JSON file versioned with a schemaVersion field. The fields consumed during the status check are:

FieldDescription
schemaVersionManifest schema version. Currently "1.0".
platform.latestVersionThe current stable platform release version string (e.g. "1.0.0").
platform.releaseDateThe date the latest stable platform release was published.
platform.securityUpdateBoolean flag indicating whether the latest release contains a security fix.
platform.releaseNotesUrlURL to the full release notes page for the latest stable version.
platform.downloadUrlGitHub Releases download URL for the platform package.
adapters.*.versionLatest stable version for each adapter (Business Central, Dynamics Sales, Power Platform).
adapters.*.releaseNotesUrlRelease notes URL for each adapter.
adapters.*.downloadUrlGitHub Releases download URL for each adapter package.

What is transmitted

The request is a standard HTTPS GET to a public URL. No request body is sent. The only information that leaves your environment is:

  • The IP address of your Azure Function (standard HTTP request behaviour)
  • No document content, customer business data, workflow data, audit data, or generated files are transmitted as part of this process

How the result is used

The installed engine version is compared against latestStable. The Software Update section always appears in the System Status Check report. If the manifest fetch succeeds, it shows the current version, latest stable version, security flag, and a direct link to the release notes. If the manifest cannot be reached for any reason, each field that could not be retrieved is shown as UNAVAILABLE - the section is never hidden and the rest of the report is unaffected.

Outbound internet access

The Azure Function hosting your Dispatcher must be able to reach https://docs.vaultpdf.io on port 443 for update data to be populated. If egress is restricted, all Software Update fields display as UNAVAILABLE. No other report section is affected.


Release Notes

Full release notes for each REFRACT Platform version are published at:

https://docs.vaultpdf.io/releases/manifest.json   ← version manifest
https://docs.vaultpdf.io/docs/releases             ← latest release notes

See the Release Notes section for the full version history.

On this page