Welcome to Folder Stats documentation
=======================================================
Version 1.0

*Last update on 20th Mars 2026*


.. toctree::
    :maxdepth: 2

Introduction
------------
**Folder Stats** is a powerful **M-Files add-on** that gives you instant visibility into your documents and workflows. It automatically creates **dynamic views** based on configurable search conditions, user group permissions, document counts, and delay-condition alerts—helping teams quickly identify where attention is needed.

Features
--------

- Create **dynamic views** using configurable search conditions
- Control access through **user group permissions**
- Monitor **document counts** in each view
- Flag views with **alert indicators** when items are delayed or pending
- Access a centralized overview through the **Folder Stats web client**

Web Client Overview
-------------------

The **Folder Stats web client** provides a real-time overview of all dynamic views that currently contain content. For each view, the interface displays:

- The **number of objects** contained in the view
- Any **active alerts** related to delays or conditions

This allows users to quickly identify areas that require attention.

Quick Access to M-Files
-----------------------

When a view requires attention, users can open it directly from the web client.
This launches a **temporary dynamic view in the M-Files Client**, giving immediate access to the relevant documents and tasks.

Benefits
--------

By surfacing critical information in one place, **Folder Stats** helps teams:

- Stay organized
- Respond faster to delays or workflow issues
- Maintain better visibility and control over document processes


Basic use cases
---------------
- If a given search criteria of objects count should be less than 10
- If a given search criteria of objects has documents older than a given date


M-Files VAF App
^^^^^^^^^^^^^^^
.. toctree::
    :maxdepth: 2
	
    src/vaf/installation.rst
    src/vaf/configuration.rst
    src/vaf/connection-config.rst
    src/vaf/profile-config.rst
    src/vaf/view-config.rst

Web client App
^^^^^^^^^^^^^^

.. note:: Web client documentation coming soon.


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`