Skip to main content

How Files are Loaded in Octostar

This document explains how files are loaded into the browser when users interact with Octostar. Understanding this behavior helps identify potential loading issues and allows for configuration of file loading order or priority.

1. When opening a workspace​

When a user opens a workspace, the following files are loaded into the browser memory:

  • Manifest Files: manifest.yaml for each app defined in the workspace, including stylers (a type of app with its own manifest.yaml).
  • Templates:
    • Homepage Template: Loaded if defined.
    • Workspace Template: Loaded if defined.

2. Templates​

Templates are loaded under these conditions:

  • File Viewer or Template Editor: When a user opens a template in these tools.
  • Record Viewer: When a user opens an entity whose concept is bound to a template (i.e., the entity shares the same concept as the template).

3. Schemas​

Schema files are loaded when:

  • Record Viewer: A user opens an entity.
  • Linkchart: A user selects a node.

The specific files loaded for the entity's concept are:

  • schema.{concept}.yaml
  • schema-ui.{concept}.yaml

These files support the React JSON Schema Form used in the record editor.

4. Relationship Queries​

The relationship_queries.yaml file is loaded when:

  • Linkchart Interaction: A user selects a node.
  • Record Viewer: A user opens an entity.
  • Other Relationship Actions: Any action involving relationships.

This file is stored in the Administrative Workspace and defines relationship configurations.

5. On-Demand File Loading​

Files not preemptively loaded will be loaded into the browser memory when the user opens them for the first time.