Servers Manager

Last modified by Aurelie Bertrand on 2026/07/16 10:22

The Server URL manager allows you to manage file servers.
You can add, edit, or delete file servers.

FileServer_manager_en.png

ℹ The icon in front of the file server name indicates whether it is valid.

Adding a file server

To add a new file server:

  1. Click the + button, then select the server type from the displayed list.
    ➡ The Add a file server box appears with the selected type.
    FileServer_manager_add_en.png
  2. Select the server Type from the drop-down list.
  3. Enter the Server name.
  4. In the URL field, enter the server address. This address depends on the server type used. For example:
  5. Fill in the File path. For example:
    • /.* retrieves all documents
    • doc/.* retrieves documents in the doc directory
    • ${user.uid}/.* retrieves documents in the ${user.uid} directory
  6. Check the Explore subfolders box if you want to be able to search for files in subfolders.
    Enter the Subfolder level to which you want to limit the exploration.
  7. Check the Read-only box if you want this server to be usable in read-only mode. Users will not be able to add or update documents on this server.
  8. If the file server is not restricted to a role (field Role), you can check the Public box if you want to allow a user without the Studio > Manage common elements permission to add, overwrite, or delete a document there. See the Public server section below for more details.
  9. Enter the Username and Password used to connect to the document server (optional).
  10. In the Role field, select the role to which you want to restrict full access to the server, or None to allow full access for all roles. The field can also be used as a search bar in case of a large number of roles.
  11. To the right of Share, click Select alloewed roles if you want to restrict the server's visibility to certain roles.
  12. For certain server types, additional configuration parameters must be filled in:
    Server typeParameterDescription
    SambaAccess via SMB2/SMB3 protocolSMB1 is the default supported protocol. Check the box to use the SMB2/SMB3 protocol.

    FTP

    FTPS

    		Port
    FTP mode

    Encryption

    See the FTP(S) Document Server page for a detailed description.

    SFTPPortEnter the port number.
    Google Drive

    Service account
    P12 file
    Shared with
    Convert to Google format

    		See the Google Drive settings configuration paragraph for a detailed description.
    HDFSCSRF prevention headerIf CSRF protection is enabled in the HDFS configuration, specify the header.
    Only compatible with HADOOP 2.8.0 and above.
  13. You can finally click the Test connection button.

❗The document server identifier, used to uniquely identify it, can also be edited.
However, it should only be modified in specific situations, notably to simplify migrating from a development environment to a production environment (see documentation Backup and restore).

Public server

Checking the Public box allows a user with the Data model designer permission group to add, overwrite, or delete a document on a file server not restricted to a role.
The Public option is enabled by default on the first server startup (after installation) for the "Common datasources" and "User docs" file servers. If you make these servers non-public, they will remain non-public after an update or restart.
The option is disabled by default for other existing servers.
The option is disabled by default for a newly created file server as well as file servers restricted to a role.

The table below summarizes the capabilities of a user with the Data model designer permission group.

Action WITHOUT the "Studio > Manage common items" permission WITH the "Studio > Manage common items" permission
Access to managers (files and servers)✅ Yes✅ Yes
Adding / deleting / renaming / uploading files on a public server✅ Yes✅ Yes
Downloading from a non-public server✅ Yes✅ Yes
Adding / deleting / modifying files on a non-public server❌ No✅ Yes
Creating a server✅ Yes, but only for its roles (Public box unchecked and grayed out)✅ Yes, without restriction
Duplicating / editing / deleting a server✅ Yes, but only for a role-restricted server for which it has write rights✅ Yes (all servers)

Authentication for an HDFS server

In the general case, unsecured authentication is used to connect to an HDFS server.
Only the username needs to be specified in the connection configuration (no password).
The username parameter is sent in HTTP requests.

If Apache Sentry (or an authentication proxy) is used to authenticate with HDFS, a basic authentication mechanism is used.
The username and password must then be specified in the connection configuration.
The username and password are sent in an HTTP header.

Duplicating / Editing / Deleting a file server

You can also:

  • Duplicate a file server: select the original server, click the Duplicate button, and modify the settings as desired.
  • Edit a file server: select the server to modify, click the Edit button, and modify the settings as desired.
  • Delete a file server: select the server to delete and click the Delete.

You can also access these functions as well as the dependency analysis tool by right-clicking on a server in the list. The dependency analysis tool allows you to check dependencies on the server.
FileServer_manager_context_menu_en.png