Skip to content

File Management

The Content page serves as a secure file store powered by the West Connectivity Content Micro-Service. Click "UPLOAD" and follow the prompts to upload your files. Each content item has an ID, a MIME type, a size (in bytes), and a Uploaded time.

The files can be filtered by file type, name, and upload time. Simply click "APPLY" after setting up the conditions.

Note
  • The content size should not exceed 512 MB (536,870,912 bytes)
  • The default total number of files is 100, it can be adjusted in the content service settings

Multiple Upload

The content service supports uploading multiple files via either multiple selection or by dragging and dropping files onto the content user interface (UI) page.

Upload and Access Content by Provisioned Device

In Connector, those files can be accessed by your devices through the device API. Devices may list available content, get content info, download and upload content using the HTTP Device APIs.

The files uploaded by the device will be displayed on the content user interface (UI) page, filtered by Device Files of "File types".

There are no restrictions on the types of content that can be made available to devices. Files can include anything from audio and video content to configuration data, as long as the correct Content-Type is specified.

Content Synchronization

Note

The Content Synchronization feature should align with your platform's infrastructure. If multiple storage buckets are available, a dual storage setup is allowed. Primary storage is ideally local, with secondary storage utilizing cloud services like AWS S3 or Azure Blob. For further configuration details, please consult your infrastructure team or directly contact us.

Should your platform infrastructure be configured with Primary and Secondary storage buckets, enable the Content Synchronization setting by selecting "Mix" from the "Content Storage Options" on the Content Service SETTINGS page. Refer to the Setting section for a detailed explanation about this option.

With the correct settings, any uploaded file will be stored in your primary bucket, indicated by an illuminated primary storage icon for this file on the content list page. Subsequently, the file syncs to the secondary storage, confirmed by the lighting of the secondary storage icon.

Content Deletion

Manual Deletion

Content deletion works as follows: Files uploaded via the user interface (UI) can be deleted through the UI operations. However, files uploaded by a provisioned device cannot be deleted through the UI. To delete files uploaded by such a device, use the HTTP Device API with the correct credentials.

Note

When a secondary storage bucket is properly set up for Content Synchronization, the deletion will only occur for files in the primary storage. Deleting files stored in the secondary storage manually is not permitted.

File Retention

The content service allows setting the 'Retention Policy' under Settings, leading to file deletion in accordance with the specified retention rules.

Note

The retention rule setting can be independently applied for both Primary and Secondary storage.

Setting

You can navigate to the Content Service settings page either through the Services menu or by selecting the "SETTINGS" option on the Content service user interface (UI) page.

Here are the explanations for each setting item:

  • Content storage options - Choose from one of the three possible options:
    • Primary - This selection saves uploaded content exclusively in the "Primary" storage.
    • Secondary - Opt for this if you want to store your content solely in the "Secondary" storage.
    • Mix - This option allows uploaded content to be initially saved in "Primary" storage, and subsequently synchronized to "Secondary" storage. Furthermore, any updates made to the content, such as changes to the 'Content Tag', will also be mirrored in the "Secondary" storage.
  • Primary Storage - The primary storage bucket
    • Type - Defines the storage type, which can be Local or Cloud. Please note that this setting cannot be modified
    • Tiering policy - This is the setting for the number of days after which the uploaded file will be transferred to a more economical cold storage.
    • Retention Policy - Implement a file retention policy by defining the retention duration and specifying the file name prefix
  • Secondary Storage - The secondary storage bucket
    • Type - Defines the storage type, which can be Local or Cloud. Please note that this setting cannot be modified
    • Tiering policy - This is the setting for the number of days after which the uploaded file will be transferred to a more economical cold storage.
    • Retention Policy - Implement a file retention policy by defining the retention duration and specifying the file name prefix
  • Whitelisted File Types - Specify the validated file types that are permitted for upload
  • Total File Quota - The maximum allowable number of files for upload
Note

For Retention Policy, If left blank, the content file will be stored indefinitely.
For Tiering Policy, This setting does not apply if the Storage Bucket is not Azure Blob.

OTA Firmware Update

The content service is allowed to upload standard firmware files such as 'xxx.bin' and 'xxx.zip'. With correct settings, users can swiftly request HTTP Device APIs to access the firmware files stored in the content storage.

For content that updates over time, such as new firmware versions, it is recommended to include a version tag in the ID. Whether using this approach or updating the content in place with a timestamp, devices need a way to identify their current version. West Connectivity suggests storing this information in a Resource. Additionally, if the resource is cloud-modifiable, the device can be notified when new firmware is available.