External Document Storage

> Administration > Account Management > External Document Storage

If the enterprise has an external Content Management System (CMS), the platform can use it for Document Storage for File Fields and Image Fields of AgileApps Live.

Caveat

This functionality is recommended to be used by only new tenants created post 10.6 upgrade. Enabling it in existing tenants created before 10.6 version will make the File and Image fields usage unavailable. So, the feature is not advised to be used by tenants existing before 10.6 version.

Compatibility

Any server framework which uses standard OpenCMIS specifications can be used as an External Document Storage for AgileApps File and Image Fields. You can find a list of such server frameworks at https://chemistry.apache.org/java/opencmis.html. Some prominent names are Alfresco 4.X & 5.X, LogicalDOC, Lutece.

Configuration

Configuration to Content Management System can be set by users with 'Manage Company Capabilities' enabled in their access profile. Configuration can be set by clicking on the > Administration > Account Management > External Document Storage .

Following fields are available for providing connection and authentication information to CMS

• Enabled (Checkbox to enable External Document Storage)
• AtomPub URL (e.g., Alfresco AtomPub URL is http://host:port/alfresco/cmisatom)
• Username - username that should be used to connect to the CMIS server.
• Password - password that should be used to connect to the CMIS server.
• Repository Id - This is the Unique identifier for your CMIS server repository version. Repository Id for Alfresco can be found by using the following URL,

http://<your-host-name>:<alfresco-port>/alfresco/service/enterprise/admin/admin-repositoryinfo

Repository id for Alfresco looks like 3e901a5d-b9d8-4aae-9b65-f6818dfa64bc

• Root Folder Id - Root Folder Id is not a required field and if dedicated root folder id is not provided for the tenant, Repository's default root folder will be used to store the documents. If you have multiple tenants or sandboxes in AgileApps server, it is recommended to have a dedicated root folder for each tenant.

In Alfresco, you can create a Folder at http://<your-host-name>:<alfresco-port>/share/page/repository. After creation of the Folder, mouse over the folder name in Alfresco UI to access the 'View Details' of that folder. Click on the 'View Details' link and copy the share link of the current page (Found on the right side bar). The folder id is the 'nodeRef' value present in the share link. This folder id needs to be configured in the 'Root Folder id' in AgileApps External Document Storage configuration.

eg. folder id looks like workspace://SpacesStore/4d02a41e-eda3-417b-8116-caf05f618b50

If External Document Storage is enabled, URL, Username, Password and Repository Id are required fields. Root Folder Id is not a required field and if dedicated root folder is not provided for this tenant, Repository's root folder will be used to store the documents.

Platform Behavior and User Experience

After the configuration has been set, files and images uploaded to the File Fields and Image Fields are stored in the CMS. The path used to store the documents is in the format {objectId}/{recordId}/{fieldTableColumn}/FileName under the root folder.

Clicking on file field and image field values in the record page, downloads the files from CMS server and shows it to the user.

Files from CMS are deleted when

• a file/image is removed from the AAL record by editing the record and removing it
• an object record with file/image fields is deleted forever from Recycle Bin.
• a file or image field is deleted from the Object Fields page (Customization in setup).
• an object is deleted forever from Recycle Bin (Customization in setup)
• When a tenant is deleted and if the Root Folder Id is set in the configuration, then the given root folder and its contents are removed from CMS.
• If root folder Id is not specified then the files are not deleted when deleting tenant. This approach is used to not accidentally delete the files in case if the default repository root folder is used for many tenants.