Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt

Use this file to discover all available pages before exploring further.

Administrators can view the details of any registered data object at /settings/data-manager/:apiName. This route renders ObjectDetailPage from src/platform/data-manager/pages/ObjectDetailPage.tsx.

​
Overview

The Object Details page displays metadata and configuration for a specific platform object identified by its apiName URL parameter. It is organized in tabs: object overview (fields, types), Page Layouts (LayoutsTab), Permissions (ObjectPermissionsTab), and Raw Data (RawDataTab, shown only when isTableSupported(apiName) returns true). Object metadata is fetched via useObjectByApiName(). Custom field definitions are loaded via useCustomFieldDefinitions(). An EditObjectMetadataDialog allows editing the object’s label and icon. Lineage visualization is provided by LineageVisualization. A FavoriteToggle allows bookmarking the object for quick access.

​
Who it’s for

No explicit permission gate on this route. Parent route /settings/data-manager also has no explicit wrapper.

​
Before you start

  • Navigate to Settings > Data Manager (/settings/data-manager) to browse available objects.

​
Steps

  1. Navigate to Settings > Data Manager and select an object from the list, or go directly to /settings/data-manager/:apiName.
  2. Browse the object’s Fields tab to review standard and custom fields.
  3. Select the Page Layouts tab to manage layouts for this object.
  4. Select the Permissions tab to review object-level access rules.
  5. Select Raw Data (if available) to inspect live records in the object’s table.

​
Key concepts

apiName — The machine-readable identifier for the object, such as pf_contact or rh_resident. Used as the URL segment and as the key for field and layout configurations. isTableSupported — A guard function that determines whether raw data browsing is available for a given object. Custom fields — Organizations can extend standard objects with additional fields. Custom field definitions are loaded alongside standard fields from STANDARD_FIELDS.

Platform Foundation

Platform Foundation overview.

Governance & parity

This page documents shipped product behavior. It is not medical, legal, or billing advice. Verify against your organization’s policies and applicable regulations before using it for clinical, compliance, or billing decisions. Protected health information (PHI) shown in the product is governed by your tenant’s access controls and is never exposed in this documentation.
  • src/routes/platform.tsx
  • src/platform/data-manager/pages/ObjectDetailPage.tsx
  • src/platform/data-manager/hooks/useObjectMetadata.ts