Skip to content

VirtoCommerce/vc-module-assets

Repository files navigation

Virto Commerce Assets Management Module

CI status Quality gate Reliability rating Security rating Sqale rating

Overview

The Virto Assets Management module is a base module that provides a powerful, flexible, and extensible platform for managing assets in Virto Commerce. With this module, you can easily search, organize, and retrieve assets stored in different locations, including file systems, Azure storage, and other custom asset storage solutions.

The module is designed to be highly configurable and extensible, allowing developers to easily add new asset storage providers or customize existing ones to meet the unique needs of their business. It defines a set of common abstractions for asset search, retrieval, and manipulation, making it easy for developers to work with assets regardless of their underlying storage location.

Note: You cannot work with the Platform files directly; the only way to do so is through the Assets abstraction.

Virto Commerce has out-of-the box providers:

Key Features

  1. Upload files
  2. Read files
  3. Search files

Asset Management also has a user interface that constitutes File Manager or File Dictionary. All Platform modules have access to this dictionary through the programming interface, and all folders in Assets are created with Platform modules. Each Platform module works with its own folder located in Assets.

Assets

Uploading a File to Asset Management

To upload a file, select a folder from the list of assets (e.g., Catalog) and then click the Upload button, as the screen capture below shows:

Upload file

You can upload the file using one of the following ways:

  1. Drag and drop the file
  2. Browse the file
  3. Enter an external URL for the file

Note: You cannot upload your file intro the root.

Asset Modules

There are three modules that provide the Assets Management feature:

  1. vc-module-assets: Provides basic infrastructure for asset storage and includes core assets abstractions, base provider class, and UI elements.
  2. vc-module-azureblob-assets: Provides Azure Blob Storage implementation.
  3. vc-module-filesystem-assets: Provides File System implementation.

To switch between the implementations, follow these steps:

  1. Open appsettings.json for the Virto Commerce Platform instance.
  2. Navigate to the Assets node:
    "Assets": {
        "Provider": "FileSystem",
        "FileSystem": {
            "RootPath": "~/assets",
            "PublicUrl": "http://localhost:10645/assets/"
        },
        "AzureBlobStorage": {
            "ConnectionString": "",
            "CdnUrl": ""
        }
    }
  1. Modify the following settings:
    • Set the Provider value to FileSystem or AzureBlobStorage
    • Provide ConnectionString in case you are going to use the AzureBlobStorage implementation option

Documentation

References

License

Copyright (c) Virto Solutions LTD. All rights reserved.

Licensed under the Virto Commerce Open Software License (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://virtocommerce.com/opensourcelicense

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.