- 4 minutes to read

Files

Centralize reusable non-image content in the Nodinite File Library. Upload a file once and reference it anywhere you need documentation, runbooks, schemas, partner documents, or sample payloads without copying the same binary into multiple places.

  • ✅ Upload once and reuse the same file in Articles and Shared File custom metadata
  • ✅ Search shared files by name, title, description, and tags
  • ✅ Use token-based insertion with a stable name slug that works across Test and Production
  • ✅ Govern allowed file types and default link behavior with SharedFilePolicy
  • ✅ Keep shared assets separate from private Attachment uploads to avoid duplication

Get started with What is the File Library to understand the feature and use Add or manage Article when you want to insert file links into documentation.

graph TD FileLibrary["fa:fa-folder-open File Library"] Articles["fa:fa-newspaper Articles"] SharedFile["fa:fa-file Shared File\nCustom Metadata"] SharedFilePolicy["fa:fa-key SharedFilePolicy"] RepositoryModel["fa:fa-sitemap Repository Model"] FileLibrary -- Linked from --> Articles FileLibrary -- Referenced by --> SharedFile SharedFilePolicy -- Governs --> FileLibrary Articles -- Part of --> RepositoryModel SharedFile -- Enriches --> RepositoryModel

This diagram shows how the File Library provides reusable shared assets for Articles and Shared File custom metadata, while SharedFilePolicy governs upload and delivery behavior.

What is the File Library?

The File Library is the Files view on top of the shared asset backend in Nodinite. It stores non-image files such as PDF guides, Word documents, Excel spreadsheets, JSON examples, XML schemas, and ZIP packages as reusable Shared Asset entries.

Unlike a private Attachment, which stores a separate binary copy on each metadata value, a Shared File points to a single reusable file in the File Library. That design keeps documentation consistent, reduces duplication, and makes search and tag-based discovery practical across your Repository.

Key Features

Upload and Organize

Upload shared files once, then enrich them with a name, title, description, and tags. Teams can maintain one approved runbook, schema, or partner guide and reuse it everywhere instead of uploading multiple copies.

Search and Filter

Use search and tags to find files by name slug, title, description, or business context. This makes the File Library practical even when you manage many shared files across teams and environments.

New file links use token-based insertion with the {ndf} token and a stable name slug. Authors can paste the token into Markdown or let the editor insert a link automatically, while the renderer resolves the shared asset at display time.

Shared File Custom Metadata

The Shared File custom metadata type references the File Library instead of copying the binary data into each entity. This is ideal when multiple Integrations, Systems, Services, or C4 views should point to the same runbook, certificate guide, or specification.

SharedFilePolicy Governance

Use SharedFilePolicy to define which MIME types are allowed in the File Library and how shared file links behave when users open them. This helps you permit business documents and technical artifacts without turning the shared library into an unrestricted upload zone.

Use Cases

Runbooks and Recovery Guides

Keep one approved PDF or Word runbook in the File Library and reference it from multiple Articles and repository entities. When the procedure changes, update the shared file once instead of hunting for duplicated attachments.

Schemas and Sample Data

Store JSON examples, XML schemas, CSV test data, and other implementation assets beside the documentation that explains them. Token-based insertion keeps those links portable across environments.

Certificates and Partner Documents

Use Shared File metadata to point to certificate instructions, partner onboarding checklists, and signed interface agreements without mixing shared references with private Attachment storage.

How do I work with Files?

You can manage Files using the Nodinite Web ClientCS. Navigate to Repository → Files to access the File Library, upload shared files, add tags, and copy references.

When you want to use a shared file:

  • Insert it into Articles as a reusable link
  • Select it from a Shared File custom metadata field on a repository entity
  • Reuse the same shared asset in multiple places without duplicating the binary file

Next Step