External locations (IRPCExternalLocationsAdmin)

View as Markdown

Administers the vault's external sources: file folders and mail boxes from which the server imports or links content.

Use this interface to add, modify and delete external locations in a vault.

An external location is a definition of a local or remote location that contains files and folders. M-Files includes the files in such a location in the document vault and monitors the location for file additions and removals.

Overview

An external location (ExternalLocation) is a file source (a folder the server imports files from, or links them in place) or a mail source (a mail box the server imports messages from, see MailProtocol). The server's background monitor checks each location every update_interval seconds. M-Files Admin calls this service. The locations are also the items of the built-in value list 5.

• Session and rights. Every method requires a vault session and the vault right manage_external_locations; a normal user gets "Access denied.". AddExternalLocation and ModifyExternalLocation of a file source also require the server right run_code (system administrator), because the server reads that folder under its own account. Mail sources need only the vault right.
• Calls: GetExternalLocations, AddExternalLocation, ModifyExternalLocation, RemoveExternalLocation, RefreshExternalLocation (check now) and ImportFilesFromLinkedLocation (turn linked files into imported ones).

Methods