# Configuring document depots

The second step to configuring **Documents** consists of creating and configuring the document depots. To do so:

1. In the **Extensions**/**Documents** section, in the **Server** tab, click on **Documents** to open the configuration interface.
2. Click on **Create** to open the depot configuration wizard.
3. Enter a **Name** and a **Description** for the depot.
4. Select the Type of depot. Three options are available:

   **File system**: A directory located in the server's file system, which contains documents in the form of files.

   **Hyperlink**: A table in JMap's System database, which contains hyperlinks to URLs.

   **SharePoint**: A connection to the Microsoft SharePoint electronic document management system.

The steps to create a depot vary depending on the type of depot, but the subsequent steps are similar for all three types of depots.

## Creating a depot

### **File System**

1. Enter the information requested by the **Document depot wizard**.

   |                            |                                                                                                                             |
   | -------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
   | Primary depot location     | Indicates the location of the depot in the server's file system. Click on **Browse...** in order to browse the file system. |
   | Browsable                  | Select this option to allow JMap Pro users to browse the depot.                                                             |
   | Allow sub dirs creation    | Select this option to enable JMap Pro users to create subdirectories in the document depot.                                 |
   | Additional depot locations | Indicate alternative paths to access the depot. Click on to add alternative paths.                                          |
2. Click on **Finish** to create the depot and return to the depot configuration interface. The name of the depot is displayed in the table.
3. Click on the name of the depot to access its configuration interface.

   |   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
   | - | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
   | 1 | **General information**: This section displays information on the depot, including its name, its Id, its description, and its status.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
   | 2 | **Parameters**: This section displays detailed information on the depot's characteristics.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
   | 3 | **Information**: This section presents data related to the depot's synchronization.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
   | 4 | Click on to access the configuration interfaces for the [Metadata structure](file:///Users/gorzanco/Library/CloudStorage/GoogleDrive-gorzanco@k2geospatial.com/Disques%20partage%CC%81s/K06-Documentation%20\(technique%20&%20commerciale\)/02%20Extensions/Documents/8.0/EN/configure.md#configuring-the-metadata-structure), [Metadata form](file:///Users/gorzanco/Library/CloudStorage/GoogleDrive-gorzanco@k2geospatial.com/Disques%20partage%CC%81s/K06-Documentation%20\(technique%20&%20commerciale\)/02%20Extensions/Documents/8.0/EN/configure.md#configuring-the-metadata-form), [Search forms](file:///Users/gorzanco/Library/CloudStorage/GoogleDrive-gorzanco@k2geospatial.com/Disques%20partage%CC%81s/K06-Documentation%20\(technique%20&%20commerciale\)/02%20Extensions/Documents/8.0/EN/configure.md#configuring-the-search-forms), and [Permissions](file:///Users/gorzanco/Library/CloudStorage/GoogleDrive-gorzanco@k2geospatial.com/Disques%20partage%CC%81s/K06-Documentation%20\(technique%20&%20commerciale\)/02%20Extensions/Documents/8.0/EN/configure.md#configuring-permissions). |
   | 5 | When the metadata forms are configured, they are displayed in this section.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
   | 6 | These buttons allow you to **Edit**, [**Synchronize**](file:///Users/gorzanco/Library/CloudStorage/GoogleDrive-gorzanco@k2geospatial.com/Disques%20partage%CC%81s/K06-Documentation%20\(technique%20&%20commerciale\)/02%20Extensions/Documents/8.0/EN/configure.md#synchronizing-depots) or **Delete** the depot.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |

### **Hyperlink**

1. In the **Document depot wizard**, select **Hyperlink** as the Type, and click on **Finish** to create the depot and return to the depot configuration interface. The name of the depot will be displayed in the table.
2. Click on the name of the depot to access its configuration interface.

|   |                                                                                                                                                                                                                                                                                                                    |
| - | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 1 | **General information**: This section displays information on the depot, including its name, its Id, its description, and its status.                                                                                                                                                                              |
| 2 | **Parameters**: This section displays detailed information on the depot's characteristics.                                                                                                                                                                                                                         |
| 3 | **Information**: This section displays data related to the depot's synchronization.                                                                                                                                                                                                                                |
| 4 | Click on to access the configuration interface for [Permissions](file:///Users/gorzanco/Library/CloudStorage/GoogleDrive-gorzanco@k2geospatial.com/Disques%20partage%CC%81s/K06-Documentation%20\(technique%20&%20commerciale\)/02%20Extensions/Documents/8.0/EN/configure.md#configuring-permissions).            |
| 5 | These buttons allow you to **Edit**, [**Synchronize**](file:///Users/gorzanco/Library/CloudStorage/GoogleDrive-gorzanco@k2geospatial.com/Disques%20partage%CC%81s/K06-Documentation%20\(technique%20&%20commerciale\)/02%20Extensions/Documents/8.0/EN/configure.md#synchronizing-depots) or **Delete** the depot. |

### **SharePoint**

1. Enter the information requested by the **Document depot wizard**.

   |                         |                                                                                                                                                                     |
   | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
   | URL                     | Enter the URL of the library containing the documents in SharePoint.                                                                                                |
   | User                    | Indicate which user has permission to access the documents in SharePoint.                                                                                           |
   | Password                | Enter the password.                                                                                                                                                 |
   | Browsable               | Select this option to allow JMap Pro users to browse the depot.                                                                                                     |
   | Allow sub dirs creation | Select this option to enable JMap Pro users to create subdirectories in the document depot.                                                                         |
   | Metadata                | The metadata that is available is extracted from SharePoint and displayed on the left. Select the metadata that will be used to create and/or search for documents. |
2. Click on **Finish** to create the depot and return to the depot configuration interface. The name of the depot is displayed in the table.
3. Click on the name of the depot to access its configuration interface.

   |   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
   | - | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
   | 1 | **General information**: This section displays information on the depot, including its name, its Id, its description, and its status.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
   | 2 | **Parameters**: This section displays detailed information on the depot's characteristics.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
   | 3 | **Information**: This section presents data related to the depot's synchronization.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
   | 4 | Click on to access the configuration interfaces for the [Metadata form](file:///Users/gorzanco/Library/CloudStorage/GoogleDrive-gorzanco@k2geospatial.com/Disques%20partage%CC%81s/K06-Documentation%20\(technique%20&%20commerciale\)/02%20Extensions/Documents/8.0/EN/configure.md#configuring-the-metadata-form), [Search forms](file:///Users/gorzanco/Library/CloudStorage/GoogleDrive-gorzanco@k2geospatial.com/Disques%20partage%CC%81s/K06-Documentation%20\(technique%20&%20commerciale\)/02%20Extensions/Documents/8.0/EN/configure.md#configuring-the-search-forms), and [Permissions](file:///Users/gorzanco/Library/CloudStorage/GoogleDrive-gorzanco@k2geospatial.com/Disques%20partage%CC%81s/K06-Documentation%20\(technique%20&%20commerciale\)/02%20Extensions/Documents/8.0/EN/configure.md#configuring-permissions). |
   | 5 | When the metadata forms are configured, they are displayed in this section.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
   | 6 | These buttons allow you to **Edit**, [**Synchronize**](file:///Users/gorzanco/Library/CloudStorage/GoogleDrive-gorzanco@k2geospatial.com/Disques%20partage%CC%81s/K06-Documentation%20\(technique%20&%20commerciale\)/02%20Extensions/Documents/8.0/EN/configure.md#synchronizing-depots) or **Delete** the depot.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |

The metadata structure is provided by the SharePoint server, and you must not configure it. From the SharePoint metadata structure, you can directly configure the [metadata form](file:///Users/gorzanco/Library/CloudStorage/GoogleDrive-gorzanco@k2geospatial.com/Disques%20partage%CC%81s/K06-Documentation%20\(technique%20&%20commerciale\)/02%20Extensions/Documents/8.0/EN/configure.md#configuring-the-metadata-form) and the [search forms](file:///Users/gorzanco/Library/CloudStorage/GoogleDrive-gorzanco@k2geospatial.com/Disques%20partage%CC%81s/K06-Documentation%20\(technique%20&%20commerciale\)/02%20Extensions/Documents/8.0/EN/configure.md#configuring-the-search-forms).

## Configuring a depot

These steps are similar for all types of depots.

### **Configuring permissions**

You must configure the permissions for accessing the depot. To do so, in the depot configuration interface, click on and then on **Permissions**:

1. In the **Permissions** tab, click on to open the **Available users** window and add the user(s).
2. In the users table of the **Permissions** tab, select the users.
3. Tick the boxes of the permissions you wish to grant to the selected users. The following permissions are available:
   * Read: Allows a JMap Pro, JMap Web or JMap Survey user to open the list of documents or hyperlinks of the depot associated with an element, to open a document, and to download it.
   * Register documents: Allows a JMap Pro user to add a document or a hyperlink to the depot from the local server.
   * Delete: Allows the user of a JMap Pro application to delete a document or a hyperlink from the depot.
   * Associate: Allows a JMap Pro user to associate one or more layer elements with one or more elements or hyperlinks from the depot.
4. Click on **Save**.

### **Configuring the metadata structure**

This step only applies to File System depots. You must configure the depot's metadata structure, i.e. the attributes containing the metadata of each document. This information is stored in a table created by the depot's database system. From this structure, you can configure the search and metadata forms.

1. In the depot configuration interface, click on and then click on **Metadata structure**.
2. In the **Metadata structure** window, click on to add an attribute.
3. Enter the name of the attribute, select its SQL type, and select the check box if the attribute must be indexed.
4. Click on to add another attribute or click on to eliminate an attribute.
5. Click on **Save** to save the information and close the window.

### **Configuring the metadata form**

This form allows a JMap Pro user to add or edit the attribute values that constitute the metadata of a document when that user adds a new document to the depot.

1. In the configuration interface of the depot, click on and then click on **Metadata form** to open the **Form layout** interface. The JMap form components are available. The **Forms** section of the [JMap administrator manual](https://doc.k2geospatial.com/jmap/doc/7_istanbul/admin/en/forms.html#forms) provides details on this topic.
2. Select the form components.
3. Configure each component by selecting the relevant attribute and its characteristics.
4. Click on **Save** to record the information and close the window. The form attributes are displayed in the **Metadata form** section (section 5 in the figure above) in the depot configuration interface.

### **Configuring the search forms**

This form allows a JMap Pro or JMap Web user to search for documents associated with map elements using their metadata. The attributes available in the form are the attributes that were defined in the metadata structure. To configure a search form, follow these steps:

1. In the depot configuration interface, click on and then on **Search forms**.
2. Click on **Create** to create a new form.
3. Enter a name for the form and click on **Form layout** to open its configuration window. The **Forms** section of the [JMap administrator manual](https://doc.k2geospatial.com/jmap/doc/7_istanbul/admin/en/forms.html#forms) provides details on this topic.
4. Select the form components.
5. Configure each component by selecting the relevant attribute and its characteristics. The **Name** and **Description** attributes are available by default to create a basic search form.
6. Click on **Save** to record the information and close the window. The forms you created are displayed in the **Search forms** interface.
