Product Attachments Plugin Documentation

The Product Attachment plugin is a lightweight solution for attaching downloadable files, external links, and embedded videos to your nopCommerce product pages. It uses category-based mapping to automatically assign attachments to products within selected categories, along with priority control and override display logic to manage which attachments are shown. Administrators can also manually manage attachments directly from the product edit page.

PRE-REQUISITES

·       This plugin requires the Nop-Station Core plugin to be installed and enabled.

INSTALLATION

·       Ensure the Nop-Station Core plugin is installed and enabled.

·       Navigate to Administration → Configuration → Local plugins

·       Locate the Product Attachment plugin (Group: Nop-Station).

·       Click Install.

·       To make the plugins functional, Restart the application.

Note: The plugin automatically installs required permissions, localization resources, and email message templates during installation.

Admin Panel Operations

CONFIGURATION

·       Access the configuration page via Admin → Nop Station → Product Attachment → Configuration

The configuration page is organized into collapsible cards. Click on a card header to expand or collapse it.

General Settings

·       Enabled: Enable or disable the plugin functionality.

·       Enable OTP login: Allows customers to log in using a one-time password sent to their email.

·       Max file size (MB): Maximum file size in megabytes for uploaded attachments. Max limit is 28 MB.

·       Allowed file extensions: Comma-separated list of allowed file extensions (e.g., .pdf,.zip,.docx).

Display Settings

·       Section title: Title displayed above the attachments section on the product detail page.

·       Widget zone: Where the attachments section appears on the product page. See available zones below.

·       Open links in new window: External links open in a new browser tab.

·       Show file type icons: Display file type icons (e.g., PDF, ZIP) next to each attachment.

·       Enable video embedding: Allow video embedding as an optional add-on for attachments.

Managing Attachments

Navigate to Admin → Nop Station → Product Attachments → Manage Attachments

Creating an Attachment

On the manage attachment page, Click Add new. Now from the create attachment page, Fill in the Info section:

·       Name (required): A descriptive name for the attachment.

·       Description: A short description shown to customers.

·       Limited to Store: You can select on which store this product will be shown, if not selected it will be visible to all stores.

Configure Source & Media

The plugin supports two source types:

·       File Upload: Upload a file directly to the store. Supported extensions are governed by the "Allowed file extensions" setting.

·       External Link: Provide a URL of an externally hosted file. Customers are redirected to the URL when they click the attachment.

·       Video Embedding (Add-on): If the Enable video embedding setting is enabled, then you can additionally add a video embed, check the Has video embed option in the Source & Media section of the attachment form. Then configure:

o   Video embed code (required): The HTML iframe code (e.g., from YouTube or Vimeo).

o   Video embed width: Width in pixels (overrides the embed default).

o   Video embed height: Height in pixels (overrides the embed default).

o   Center video embed: Center the video player within its container.

Category-Based Mapping

This is the core feature of the plugin.

·       When creating or editing an attachment, select one or more nopCommerce product categories in the Categories field.

·       The attachment will automatically appear on all products that belong to any of the selected categories.

·       If All products is checked instead, the attachment appears on every product regardless of category.

·       Example: If you select the "Electronics" category, the attachment will appear on all products in the Electronics category.

Priority & Override Display

These two features work together to provide powerful display control:

·       Priority: A numeric value where lower numbers = higher priority. When multiple attachments are available for a product, priority determines the order.

·       Override Display: When enabled on an attachment, it suppresses all other attachments on matching product pages. If multiple attachments have "Override display" enabled, only those with the lowest priority value are shown. If no attachments have "Override display" enabled, all published attachments are shown in their display order.

Editing & Deleting Attachments

·       Edit: Click the Edit button from attachment to open its edit form.

·       Delete: Use the Delete button on the edit page or select multiple attachments and click Delete selected for bulk deletion.

Search & Filter: Filter the attachment list by name, published status, or store.

Product-Level Attachment Management

From the admin product edit page, a new Attachments tab is added by the plugin. From this tab, you can:

·       Link existing: Click Link existing attachment to search and select already-created attachments to associate with this specific product.

·       Add new: Click Add attachment to create a brand-new attachment (redirects to the attachment creation page).

·       Display order: Adjust the display order of linked attachments for this specific product.

·       Unlink: Remove the manual link between an attachment and this product (the attachment itself is not deleted).

Customer (Storefront) Experience

On product detail pages, customers see an attachments section (title and position are configurable) displaying:

·       Attachment name and optional description.

·       File type icons next to each attachment (if enabled). The plugin includes built-in SVG icons for:

o   PDF files (.pdf)

o   Archives (.zip, .rar, .7z)

o   Images (.jpg, .jpeg, .png, .gif, .svg, .bmp, .webp)

o   Videos (.mp4, .avi, .mov)

o   Documents (.doc, .docx, .xls, .xlsx, .ppt, .pptx, .txt, .csv)

o   Audio (.mp3, .wav)

o   External links (dedicated link icon)

·       File downloads: Clicking on a file upload attachment triggers a direct file download.

·       External links: Clicking opens the external URL (in a new tab if configured).

·       Video embeds: Embedded video players are displayed inline on the product page.

Troubleshooting

·       Plugin cannot be installed

o   Ensure the Nop-Station Core plugin is installed and present in the plugins folder. Check the System Log for dependency errors.

o   Attachments not visible on product page

o   Ensure the plugin is enabled, the attachment is published, and it's either mapped to the product's category, marked as "All products", or manually linked to the product.

·       File upload fails

o   Check that the file size doesn't exceed the Max file size (MB) setting and the file extension is in the Allowed file extensions list.

o   Override display hiding all attachments

o   Check if any attachment linked to the product has "Override display" enabled. Only attachments with the lowest priority value among overrides are shown.

·       Video embed not appearing

o   Ensure Enable video embedding is turned on in Display Settings. Verify the embed code is valid HTML (e.g., an iframe tag).

o   Icons not showing

o   Ensure Show file type icons is enabled in Display Settings. The plugin uses built-in SVG icons no additional icon setup is required.

Support

For support inquiries, please contact the nopStation team or refer to the documentation linked in the plugin menu.

Book a Meeting