> For the complete documentation index, see [llms.txt](https://gsfcorp.gitbook.io/macula/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gsfcorp.gitbook.io/macula/administration-guide-v1.33.0/purpose-and-operation-description-of-folders.md).

# Purpose and Operation Description of Folders

### Overview

Macula *Folders* feature allows users to manage User *access* on a very granular level. It is a very powerful tool, but like every powerful tool, it requires some planning ahead.

Though *Folders* are not strictly connected with the physical network implementation, we recommend considering it when planning your *Folder* structure. The abstract idea is to create a hierarchical tree-like structure and grant access to different-level administrators.

{% hint style="info" %}
*Folders* replace *Organizations*. If you have previously configured *Organizations*, they will be automatically converted to the top-level *Folders* with related resources:
{% endhint %}

<figure><img src="https://412599993-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeNXnJx0OpvxnmpWqOBNm%2Fuploads%2FmUcE3g0IEwCebBIwAX0g%2Fimage.png?alt=media&amp;token=70011ecd-8d15-4126-a77b-31ea716dae66" alt=""><figcaption></figcaption></figure>

#### Interface overview

You will find *Folders* inside the *Console -> Configuration* pane, after enabling it in the *Console* settings. It consists of two panels, the *Folder tree* panel and the *Resources* panel.

<figure><img src="https://412599993-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeNXnJx0OpvxnmpWqOBNm%2Fuploads%2FHIRGc2plzOmHmcpRCwap%2Fimage.png?alt=media&amp;token=5eae586d-f889-40c3-a11e-deb81c9aa64f" alt=""><figcaption></figcaption></figure>

* The *Folder* tree panel provides overview and access to the folder structure. You will be able to review and edit all the structures accessible to your *User*. Buttons at the top of the panel provide controls to create + *New* Folder, *Edit, Move to folder,* and *Delete* folders. You also can edit folders by double-clicking the corresponding item.
* The *Resources* panel displays content of the selected *Folder*. By Clicking the *Title*, *ID* or the *free space* over the resource icons you can sort *Resources* correspondingly.

<div align="center"><figure><img src="https://412599993-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeNXnJx0OpvxnmpWqOBNm%2Fuploads%2FvXAB1Eq6Y5wNIa5YCcKw%2Fimage.png?alt=media&amp;token=dd7f36f5-9283-4322-873d-9a61aa6abafe" alt=""><figcaption></figcaption></figure></div>

·         The *Folder* structure affects all the *Resources*, so for easier navigation you can turn *ON* or *OFF* tree-view *Folders* panel by clicking the *Folder* ![](https://412599993-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeNXnJx0OpvxnmpWqOBNm%2Fuploads%2FFMylC2lbXtc9il0lgapF%2Fimage.png?alt=media\&token=f1c22d1f-9797-4002-8851-526ceda618b7) button.

<figure><img src="https://412599993-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeNXnJx0OpvxnmpWqOBNm%2Fuploads%2Fl8nlfPM4keCWTIEXf7kg%2Fimage.png?alt=media&amp;token=ff9d98ab-a889-4c65-a3fd-3e68de0bda14" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
You will *enable/disable* tree-view for all the resources by *enabling/disabling* it in any particular resource panel.
{% endhint %}

* You can see to which *Folder* the particular resource belongs inside the main panel of the selected resource. You also can add *Linked folders* column to the table view by clicking the *Table view* button.

<figure><img src="https://412599993-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeNXnJx0OpvxnmpWqOBNm%2Fuploads%2FpmyC6QNS8sUge4qBUixm%2Fimage.png?alt=media&amp;token=bd73dee2-407f-45b6-88a0-12525ce4b7d3" alt=""><figcaption></figcaption></figure>

#### Creating Folders

The first step to implement Folders is to enable it inside the Console. Go to:

* *Hamburger* menu -> *Settings* -> *General* -> *Enable folders* checkbox.

<figure><img src="https://412599993-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeNXnJx0OpvxnmpWqOBNm%2Fuploads%2FkfeJMmvuODmVTAii917u%2Fimage.png?alt=media&amp;token=63ddfdcd-7c7d-41cf-989f-90a5cd377d17" alt=""><figcaption></figcaption></figure>

The next step is to create previously thought-through folder structure:

* Configuration -> Folders -> +New folder

<figure><img src="https://412599993-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeNXnJx0OpvxnmpWqOBNm%2Fuploads%2Fp56CYI5L0qqbK2kJsDYy%2Fimage.png?alt=media&amp;token=27acac0c-e876-4ea4-92f5-fb5641e432c5" alt=""><figcaption></figcaption></figure>

* Provide a meaningful *Title*, then select the parent folder by clicking the “*Change*…” button, pick the parent folder and confirm your choice with the “*OK*” button.

<figure><img src="https://412599993-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeNXnJx0OpvxnmpWqOBNm%2Fuploads%2FLR9D9zxlrpVgwV0gqtI7%2Fimage.png?alt=media&amp;token=a816403c-568c-4ba6-b272-14f8b67259c8" alt=""><figcaption></figcaption></figure>

Continue until the complete structure is created.

{% hint style="info" %}
Folders can’t have same names, so think of naming conventions you want to adhere to, when creating a similar subfolder for the different branches.
{% endhint %}

#### Moving resources

When the basic folder structure is created, you can spread your resources across your hierarchy tree. Almost any resource can be moved to a particular *Folder* or *Linked* with multiple *Folders*. Let’s do it on the *Channels* example, go to:

* *Configuration* -> resource (example: *Channels*) - select one or multiple entries and click the “*Move to folder*” button

<figure><img src="https://412599993-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeNXnJx0OpvxnmpWqOBNm%2Fuploads%2FH8ZdaoI8Tn4uPatvKojw%2Fimage.png?alt=media&amp;token=e90411fc-efc6-4ac6-8758-e148eb859902" alt=""><figcaption></figcaption></figure>

* Select *Folder* from the new popup window and confirm your choice.

<div align="center"><figure><img src="https://412599993-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeNXnJx0OpvxnmpWqOBNm%2Fuploads%2Fmbvl7yKT2U6FqskNM1y3%2Fimage.png?alt=media&amp;token=dafb1839-7c3c-4983-8318-07f4b24539a9" alt=""><figcaption></figcaption></figure></div>

Continue with all the resources you want to moderate access to.

#### Granting access rights

To limit *Access rights* accordingly to the *Folders* structure, go to:

* *Configuration* -> *Users* -> *Folder access* and provide access to the *Folder*

<figure><img src="https://412599993-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeNXnJx0OpvxnmpWqOBNm%2Fuploads%2FUoDhX0ygxO52D53U5CHf%2Fimage.png?alt=media&amp;token=957b5fbf-f627-4aa8-9eaa-be369263a7e6" alt=""><figcaption></figcaption></figure>

Inside the new popup window select *Folder access* and mark the checkbox starting with the top-level *Folder* you want the *User* to have access to.

<figure><img src="https://412599993-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeNXnJx0OpvxnmpWqOBNm%2Fuploads%2F3ikhancFqQLzU9VJyySQ%2Fimage.png?alt=media&amp;token=5a56737b-e6bd-4414-8087-7aa004dc5315" alt=""><figcaption></figcaption></figure>

#### Sharing Resources from different folders (Link folder)

*Resources* such as *Recording profiles* or *Schedules* may need to be accessed by more than one *User*, so you also can share a single *Resource* with multiple *Folders* by linking it. To do so, go to:

* *Configuration* -> resource -> *Move to folder* arrow down button -> *Link folder*

<figure><img src="https://412599993-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeNXnJx0OpvxnmpWqOBNm%2Fuploads%2Fs4vcJxcovJYLlujCrZmX%2Fimage.png?alt=media&amp;token=50067bac-5e65-4fff-b4ed-60874b0f6b79" alt=""><figcaption></figcaption></figure>

* From the new popup window select the *Folder* you want to share resources with and confirm by clicking the *“OK”* button.

<figure><img src="https://412599993-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeNXnJx0OpvxnmpWqOBNm%2Fuploads%2FFIY1fEZ7Tu8jJDVLdOkz%2Fimage.png?alt=media&amp;token=d2818960-2266-488d-9f5f-bb0ea95553ff" alt=""><figcaption></figcaption></figure>

Grant access permissions for the *Folder* and its subfolders by checking corresponding checkboxes.

<figure><img src="https://412599993-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeNXnJx0OpvxnmpWqOBNm%2Fuploads%2FPATohK6CCDperiAQQ7GR%2Fimage.png?alt=media&amp;token=3c2cfb6a-6d15-457b-b931-d91058ec733f" alt=""><figcaption></figcaption></figure>

That’s it! Now the user with access to the “IT Security” *Folder* will be able to see the Linked resource from the “IT Infra”.

{% hint style="danger" %}
To delete *Folder* and its *Subfolders* you need to remove all the associated resources from it.
{% endhint %}

{% hint style="danger" %}
All the *User privileges* stay actual. If the *User* does not have permissions to the particular resource, it will stay inaccessible even in the shared *Folder*!
{% endhint %}

{% hint style="danger" %}
Some specific server *Events and Actions* require access to the server itself or they will stay invisible for the local administrators.
{% endhint %}

{% hint style="danger" %}
Shared resources such as *Recording profiles*, *Schedules*, or *Events and Actions* must be linked with all the subadmins in order to allow them make corresponding changes inside allowed resources. For example: IT admin from demo structure will not be able to use *Recording profiles* even with accessible channels, unless the global admin links the *Recording profile* with IT admin. As a global admin you can link common resources with the particular *Folder* to allow changes only to IT admin, or link to the root folder - *System* to make it accessible to all the local admins.
{% endhint %}
