# Local Files

## Specs

| Label                     | Value                         |
| ------------------------- | ----------------------------- |
| **Version**               | 1.0.0 (updated on 2026-05-16) |
| **Developer**             | Labii Inc.                    |
| **Type**                  | Section                       |
| **Support Configuration** | Yes                           |

## Overview

The Local Files widget lets users store large files outside Labii's managed file storage by pointing the widget to a folder on a local disk or NAS that is accessible from the Labii desktop app. This approach is useful when files are too large for routine upload workflows or when laboratories already maintain instrument output, imaging data, or archived documents on local infrastructure. The widget surfaces those files directly inside a Labii record so users can browse them in either a preview-focused or list-focused interface, open files with the appropriate local application, and remove files when needed.

{% hint style="warning" %}
Local files are not versioned by Labii. You are responsible for keeping local files safe and preventing unexpected deletion. This storage option may not meet regulatory requirements.
{% endhint %}

## Use Cases

* **Large Instrument Output**: Keep microscopy images, sequencing runs, mass spectrometry exports, or other large instrument files on local or NAS storage while linking them to the relevant Labii records.
* **Departmental Shared Storage**: Let multiple team members review files stored in a common laboratory network share without duplicating them into Labii-managed storage.
* **Desktop-Based Workflows**: Open locally stored files in their native desktop applications directly from the widget for analysis, editing, or review.
* **Archive Access**: Reference legacy files that already live in an existing local folder structure without reorganizing or re-uploading them into another repository.
* **Storage Cost Control**: Reserve Labii-managed storage for regulated or versioned content while using local infrastructure for high-volume, low-governance file collections.

## Interface

### Read-only View

The Local Files widget supports two read-only display modes: **Preview** and **List**. Both modes read files from the configured local or NAS folder path and show the available files inside the record.

<figure><img src="/files/EkqAKl61d05EEXu3Hyta" alt=""><figcaption></figcaption></figure>

* **Preview View**: Displays each file as a card-style item with preview content when supported. This view is helpful when users need to visually inspect files such as images or documents before opening them.
* **List View**: Displays files in a compact table-like layout focused on file name, size, location, and related metadata. This view is better when users need to scan many files quickly.
* **Open File**: Users can open a file from the widget. The file is opened through the Labii desktop app using the associated local application on the user's computer.
* **Delete File**: Users can delete a file entry directly from the widget when it is no longer needed.
* **Hide Preview Option**: When enabled in widget configuration, previews are suppressed so users can focus on the file list without rendering preview content.

<figure><img src="/files/VjZsp9f3ZMK17wfCtf0k" alt=""><figcaption></figcaption></figure>

### Edit View

The Local Files widget does not provide a separate content editor for file data inside the record itself. Instead, users manage local files through the configured folder path and interact with them from the read-only interface.

* **Folder-Based Management**: Files are added or maintained in the configured local or NAS folder outside the record.
* **Desktop Editing**: To change a file, open it from the widget, edit it in the corresponding local application, and save it back to the same folder.
* **Immediate Availability**: Updated files become available in the widget based on the current contents of the configured folder.

## Configuration

The Local Files widget requires a folder path that the Labii desktop app can access. Optional settings control preview behavior and how files are displayed.

### Initial Setup

<figure><img src="/files/9u8QfNrP8TX7SbwN1APw" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}
Click the **Configure** button in the widget header.
{% endstep %}

{% step %}
Set **Local or NAS folder path** to a folder that is available to the Labii desktop app. You can either browse for a folder or manually enter a local or NAS path.
{% endstep %}

{% step %}
Adjust optional settings for preview visibility and display mode.
{% endstep %}

{% step %}
Click **Save** to apply the configuration.
{% endstep %}
{% endstepper %}

### Required Settings

* **Local or NAS folder path**: Select a browser folder or enter a local/NAS folder path for the Labii desktop app. This is the storage location the widget reads from.

### Optional Settings

* **Should hide preview**: Check this option to hide file previews.
* **View**: Select how files are displayed.
  * **Preview**: Show files in preview mode.
  * **List**: Show files in list mode.

{% hint style="info" %}
Use **List** view for folders with many files. Use **Preview** view when users need to visually inspect supported file types before opening them.
{% endhint %}

### Advanced Configuration

{% stepper %}
{% step %}
If you use a NAS path, confirm that the Labii desktop app can access the share from every workstation that needs to use the widget.
{% endstep %}

{% step %}
Standardize the folder structure and permissions so the same path remains valid across records and users.
{% endstep %}
{% endstepper %}

{% hint style="warning" %}
If the configured path becomes unavailable, renamed, or disconnected, the widget cannot display or open the stored files until access is restored.
{% endhint %}

## Additional Functions

### Open Local Files

{% stepper %}
{% step %}
Open the record containing the Local Files widget.
{% endstep %}

{% step %}
Locate the target file in **Preview** or **List** view.
{% endstep %}

{% step %}
Click **Open File** to launch the file through the Labii desktop app.
{% endstep %}
{% endstepper %}

### Delete Local Files

{% stepper %}
{% step %}
Find the file you want to remove from the widget.
{% endstep %}

{% step %}
Click **Delete**.
{% endstep %}

{% step %}
Confirm the removal if prompted. The file is removed from the local storage location represented by the widget.
{% endstep %}
{% endstepper %}

### Switch Display Mode

Administrators can change the widget between **Preview** and **List** view from the configuration panel to match the type and volume of files stored in the selected folder.

## Best Practices

### Path Management

* Use stable local or NAS paths that are unlikely to change after the widget is deployed.
* Store related files in a dedicated folder for each workflow, project, or record type so users can find content quickly.
* Keep file and folder names descriptive and consistent so list view remains easy to scan.

### File Safety

* Treat the configured folder as an external storage system and maintain separate backup and retention procedures for it.
* Limit delete permissions to trusted users because deletions are not protected by Labii version history.
* Coordinate with IT to ensure NAS shares have appropriate redundancy, access control, and disaster recovery.

### Compliance and Governance

* Use this widget only when local or NAS storage aligns with your laboratory's data governance requirements.
* For regulated workflows that require version history, auditability, or stronger platform-managed controls, prefer widgets that store files directly in Labii.
* Document ownership of the local storage location so users know who is responsible for access, backup, and recovery.

{% hint style="success" %}
The Local Files widget works best when laboratories need convenient access to large external files but already have a reliable local or NAS storage strategy managed outside Labii.
{% endhint %}

## Related Widgets

* [**Files**](/widgets/section-widgets/office/file/files.md): Use when files should be uploaded into Labii-managed storage with preview, versioning, and additional platform features.
* [**File Preview**](/widgets/section-widgets/office/file/file-preview.md): Use when you only need to display a single file preview from the Labii file system.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.labii.com/widgets/section-widgets/office/file/local-files.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
