Blob storage for Resco Cloud

From Resco's Wiki
Jump to navigation Jump to search

Database space can be expensive. In Resco Cloud, you can use external storage for binary documents to save database space and money.

Select fields

Using the Admin Console, enable blob storage for fields that should be stored externally.

Enable field for external blob storage

  1. Select Data > Entities from the menu.
  2. Click the entity that stores binary documents, for example, Note (annotation).
  3. Click the field that should be stored externally to display its details, for example Document (documentbody).
  4. Enable Blob storage.
  5. Save all changes.

Repeat the procedure for all fields that you want to store outside of the database.

Set up the storage

Before you can use external storage, you have to connect your organization to it.

Blob storage for resco cloud configuration

  1. Select Settings > Organization from the menu.
  2. Click Blob Storage.
  3. Select the Blob Storage Type:
    • Use "Cloud Storage" to use external storage managed by Resco. This is the default option for new organizations.
    • Use "Amazon S3", "Azure Storage", "OneDrive", or "SharePoint" if you have cloud storage that you would like to use.
    • Use "None" to store all binary files directly in the database.
  4. When using your storage, you must also enter:
    • Connection details: provider-specific parameters necessary to access the storage.
    • Minimal Blob Size: Smaller documents stay in the database, while larger ones are stored externally.
  5. As Delete type, select how to handle deletions:
    • "Remove (Recycle Bin)": After deletion, the record is moved to a recycle bin (trackingdelete entity). Admins can restore these blobs.
      Blobs are normally stored as {OrganizationId}/{EntityName}/{id}-{AttributeName}.blob. Recyclable files are stored as {OrganizationId}/trackingdelete/{EntityName}/{id}-{AttributeName}.blob.
    • "Delete": The record is deleted from the external storage. It is not moved to the trackingdelete entity.
    • "Ignore": Blob will not be deleted on external storage.
  6. Save all changes.

Migrate documents

When you set up the storage for the first time or when you modify the minimal blob size, you can migrate your existing documents to the correct storage.

  1. Select Settings > Organization from the menu.
  2. Click Blob Storage.
  3. Click Transfer Blobs. If blob storage is configured and the organization has enabled some fields for blob storage, the server schedules the job 'ExportLocalBlobsToBlobStorage' that transfers all blobs of configured size from the database to the configured blob storage.
  4. Click Processes Center > Logs to check the status of the job.