> For the complete documentation index, see [llms.txt](https://docs-jmapserver-lima.k2geospatial.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs-jmapserver-lima.k2geospatial.com/e/extensions/documents/configuring-jmap-documents/configuring-document-depots.md).

# Configuring Document Depots

The second step in configuring JMap Documents is to create and configure document repositories. To do this:&#x20;

1. In the **Documents** configuration interface, press **Create** to open the repository configuration window.&#x20;
2. Enter a **Name** and **Description** for the repository.&#x20;
3. Select the **Depot Type**. You have three choices: \
   \- **File system**: This is a directory located in the server's file system containing documents in the form of files. \
   \- **Hyperlink**: This is a table in the JMap System DB containing hyperlinks to URLs.\
   \- **SharePoint**: This is a connection to Microsoft's SharePoint electronic document management system.&#x20;

The creation of the repository differs depending on the repository type, but the subsequent steps are similar for all three repository types.

## Creating a depot

### File system

1. Inform the settings indicated by the **Document Depot Wizard**.

   <table data-header-hidden><thead><tr><th width="221.01809954751133"></th><th></th></tr></thead><tbody><tr><td>Primary depot location</td><td>Specifies the location of the repository in the server's file system. Press <strong>Browse...</strong> to navigate the file system.</td></tr><tr><td>Browsable</td><td>Check this option to allow a JMap Pro application user to navigate the repository.</td></tr><tr><td>Allow sub dirs creation</td><td>Check this option so that the user of a JMap Pro application can create subfolders in the document repository.</td></tr><tr><td>Additional depot locations</td><td><p>Specify other alternative paths to access the repository. </p><p>Press <img src="/files/m12HdG9qqioY11M5GBf8" alt=""> to add alternative paths.</p></td></tr></tbody></table>
2. Press **Finish** to create the repository and return to the repository configuration interface. The repository name is displayed in the table.
3. Click the repository name to access its configuration interface.<br>

   <table data-header-hidden><thead><tr><th width="224.37226277372264"></th><th></th></tr></thead><tbody><tr><td>General information</td><td>Shows information about the repository, such as its name, ID, description, and status.</td></tr><tr><td>Parameters</td><td>Provides detailed information on the characteristics of the repository.</td></tr><tr><td>Information</td><td>Presents data related to repository synchronization.</td></tr></tbody></table>
4. Press the buttons to access the [Metadata structure](#configuring-the-metadata-structure), [Metadata form](#configuring-the-metadata-form), [Search forms](#configuring-search-forms) and [Permissions](#permissions) configuration interfaces.&#x20;
5. Press the buttons to **Edit**, [Synchronize](/e/extensions/documents/configuring-jmap-documents/managing-repositories.md#synchronizing-repositories) or **Delete** the repository.

### **Hyperlink**

1. In the **Document Depot Wizard** select the **Hyperlink** repository type and press **Finish** to create the repository and return to the repository configuration interface. The repository name is displayed in the table.
2. Click the repository name to access its configuration interface.

   <table data-header-hidden><thead><tr><th width="224.37226277372264"></th><th></th></tr></thead><tbody><tr><td>General information</td><td>Shows information about the repository, such as its name, ID, description, and status.</td></tr><tr><td>Parameters</td><td>Provides detailed information on the characteristics of the repository.</td></tr><tr><td>Information</td><td>Presents data related to repository synchronization.</td></tr><tr><td>Permissions</td><td>Press the button to enter the Permissions configuration interface.</td></tr></tbody></table>
3. Press the buttons to **Edit**, [Synchronize](/e/extensions/documents/configuring-jmap-documents/managing-repositories.md#synchronizing-repositories) or **Delete** the repository.

### **SharePoint**

1. Inform the settings indicated by the **Document Depot Wizard**.

   <table data-header-hidden><thead><tr><th width="246.93975903614455"></th><th></th></tr></thead><tbody><tr><td>URL</td><td>Specify the URL of the library that contains the documents in SharePoint.</td></tr><tr><td>User</td><td>Specify the user with permission to access documents in SharePoint.</td></tr><tr><td>Password</td><td>Specify the password.</td></tr><tr><td>Browsable</td><td>Check this option to allow a JMap Pro application user to navigate the repository.</td></tr><tr><td>Allow sub dirs creation</td><td>Check this option so that the user of a JMap Pro application can create subfolders in the document repository.</td></tr><tr><td>Metadata</td><td>Available metadata is retrieved from SharePoint and displayed on the left. <br>Select the metadata to use for document creation and/or search.</td></tr></tbody></table>
2. Press **Finish** to create the repository and return to the repository configuration interface. The repository name is displayed in the table.&#x20;
3. Click the repository name to enter its configuration interface.

   <table data-header-hidden><thead><tr><th width="224.37226277372264"></th><th></th></tr></thead><tbody><tr><td>General information</td><td>Shows information about the repository, such as its name, ID, description, and status.</td></tr><tr><td>Parameters</td><td>Provides detailed information on the characteristics of the repository.</td></tr><tr><td>Information</td><td>Presents data related to repository synchronization.</td></tr></tbody></table>
4. Press the buttons to access the [Metadata structure](#configuring-the-metadata-structure), [Metadata form](#configuring-the-metadata-form), [Search forms](#configuring-search-forms) and [Permissions](#permissions) configuration interfaces.&#x20;
5. Press the buttons to **Edit**, [Synchronize](/e/extensions/documents/configuring-jmap-documents/managing-repositories.md#synchronizing-repositories) or **Delete** the repository.

The metadata structure comes from the SharePoint server and you do not need to configure it. From the SharePoint metadata structure you can directly configure the [metadata form](#configuring-the-metadata-form) and [search forms](#configuring-search-forms).

## Configuring a depot

These steps are similar for all depot types.

### **Permissions**

You must configure the repository access permissions. To do this, in the repository configuration interface, press **Permissions.**

This section has two tabs: **Permissions** and **Owners**. The owners are the only ones who can manage the administrative permissions for the repository, manage the list of owners and delete it.

A list of users and groups with permissions appears in the **Permissions** tab. Click on ![](https://docs-jmapserver-lima.k2geospatial.com/~gitbook/image?url=https%3A%2F%2F2224254070-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FDUF1p2rT0hfE3QBlbbvE%252Fuploads%252F3KaDFt9YF0qzIwNBwAHo%252Fajouter.png%3Falt%3Dmedia%26token%3Dd3e3f51e-5214-4536-b702-4ce2653e254f\&width=300\&dpr=4\&quality=100\&sign=89cced3f\&sv=1) to add new users or groups.

{% hint style="info" %}
Available users and groups are configured in the JMap Server section of JMap Admin. Refer to the [Users and Groups ](https://docs-jmapserver-lima.k2geospatial.com/e/administrator/jmap-server-administrator-manual/jmap-server/security/users-and-groups)section for more information about managing users in JMap Server.
{% endhint %}

Repositories have only user permissions.

<table data-header-hidden><thead><tr><th width="207"></th><th></th></tr></thead><tbody><tr><td>Read</td><td>Allows the user of a JMap Pro, JMap NG or JMap Survey application to open the list of documents or hyperlinks in the repository associated with an element, open a document and download it.</td></tr><tr><td>Save documents</td><td>Allows the user of a JMap Pro application to add a document or hyperlink to the repository from the local server.</td></tr><tr><td>Delete</td><td>Allows the user of a JMap Pro application to delete a document or hyperlink from the repository. </td></tr><tr><td>Associate Files</td><td>Allows the user of a JMap Pro application to associate one or more elements of a layer with one or more elements or hyperlinks of the repository.</td></tr></tbody></table>

### Configuring the metadata structure

{% hint style="warning" %}
This step is for **File System** type repositories only.
{% endhint %}

You must configure the repository metadata structure, that is, the attributes that contain the metadata for each document. This information is stored in a table created by the repository database system. From this structure you can configure the search and metadata forms.

1. In the repository configuration interface, press **Metadata structure**.
2. &#x20;In the **Metadata structure** window, press ![](/files/m12HdG9qqioY11M5GBf8) to add an attribute.&#x20;
3. Specify the attribute name, SQL type and check the relevant box if the attribute should be indexed.&#x20;
4. Press ![](/files/m12HdG9qqioY11M5GBf8) to add another attribute or press ![](/files/WBpyivedZIyNqwaEXwOA) to remove an attribute.&#x20;
5. Press **Save** to save the information and close the window.

### Configuring the metadata form

This form allows the user of a JMap Pro application to add or modify the values ​​of the attributes that constitute the metadata of a document, when adding a new document to the repository.

1. In the repository configuration interface, press **Metadata form** to open the **Form layout** interface. JMap form components are available. The Form Layout section of the [JMap Server Administrator's Manua](https://docs-jmapserver-lima.k2geospatial.com/e/administrator/jmap-server-administrator-manual/resources-layers/configuring-layers/forms/configuring-forms#form-layout)l provides details on this topic.&#x20;
2. Select the form components.&#x20;
3. Configure each component by selecting the relevant attribute and its characteristics.&#x20;
4. Press **Save** to save the information and close the window. The form attributes are displayed in the **Metadata form** section in the repository configuration interface.

### Configuring search forms

This form allows the user of a JMap Pro or JMap NG application to search for documents associated with map elements from their metadata.

&#x20;The attributes available in the form are those defined in the [metadata structure](#configuring-the-metadata-structure).&#x20;

To configure a search form:

1. In the repository configuration interface, press **Search forms**.&#x20;
2. Press **Create** to create a new form.&#x20;
3. Specify a name for the form and press **Form layout** to open its configuration window. The Form Layout section of the [JMap Server Administrator's Manua](https://docs-jmapserver-lima.k2geospatial.com/e/administrator/jmap-server-administrator-manual/resources-layers/configuring-layers/forms/configuring-forms#form-layout)l provides details on this topic. &#x20;
4. Select the form components.&#x20;
5. Configure each component by selecting the relevant attribute and its characteristics. **Name** and **Description** attributes are available by default to form a basic search form.&#x20;
6. Press **Save** to save the information and close the window. The created forms are displayed in the **Search forms** interface.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs-jmapserver-lima.k2geospatial.com/e/extensions/documents/configuring-jmap-documents/configuring-document-depots.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
