User Guide of Adobe Commerce Product Attachment
Table of Content
Magento 2 Product Attachments module is equipped with product pages with a special attachments block where the admin can upload various files such as user guides, certificates, licenses, and many others.
Further, upload icons relative to the specific attachment type so that the customer can easily specify the attachment files.
Upload an unlimited number of file types like gif, png, jpg, and jpeg, and make product pages as informative as possible.
Meanwhile, there is often some essential additional data on the offerings that must be provided to the customers in the most convenient and transparent manner.
Adding files allows for making pages maximally informative & taking the deal further.
Also, you can check the product revision history in the admin backend using the Magento 2 Product Revision History extension, providing insights into the product edits made in the admin backend.
Watch the below video tutorial to understand the extension workflow :
Features
- The admin can upload Product attachments.
- Admin can assign and upload the attachment from the products Grid as well.
- The admin can see uploaded Product attachments in the Product attachment Grid.
- The admin can Enable or Disable uploaded Product attachments.
- Admin can upload Product attachment Icons.
- The admin can Enable or Disable uploaded Product attachment icons.
- The customer can see the product Attachments in the product details tab and product overview.
- The extension is compatible with the Hyva Theme.
- Admin can configure to display alias name instead of the attachment name.
- The admin can set the maximum number of attachments to display in the product overview.
- The admin set attachment size will be displayed at the front end or not.
- Admin can set the default color for the attachment title.
- The admin can save the Product Attachments according to Store.
- The admin can also assign the products at the time of the creation of the product attachment.
- Icon extension is visible under the Manage Product Attachments section
- The admin can add the new category attachments or use existing attachments.
- The customers can see the attachments for the respective order under My Order History section.
- Product attachment report view is available under the reports section.
- Product attachment visible in the mail invoice for the order.
- GraphQL has been implemented for the extension.
Note – If you want to add and map some custom options to your downloadable products then you can use our Magento 2 File Map with Custom options extension.
Installation
Customers will get a zip folder and they have to extract the contents of this zip folder on their system. The extracted folder has an src folder, inside the src folder you have the app folder.
You need to transfer this app folder into the Magento2 root directory on the server as shown below.
After the successful installation, you have to run these commands in the Magento2 root directory:
# Run Commands
You need to run the following commands:
php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy
php bin/magento indexer:reindex
php bin/magento cache:flush
Configuration For Multi-Lingual Support
For multilingual support, the admin will navigate through Store->Configuration->General ->Locale Options and select the locale as German (the language into which the admin want to translate his store content).
Module Translation
Further, if you want to translate their module language from English to German then follow the path app/code/Webkul/ProductAttachment/i18n in their unzipped Magento2 Preorder folder, and then you will get a CSV file with the name “en_US.csv”.
Now, rename that csv as to your region code and language code “de_DE.csv” and translate all right-side content after a comma in your language.
After editing the CSV, save it and then upload it to the path app/code/Webkul/ProductAttachment/i18n where you have installed Magento 2 on their server.
The module will get translated into your desired Language. It also supports RTL and LTR languages.
Moreover, the user can edit the CSV like the image below.
Module Configuration – Magento 2 Product Attachments Extension
After the installation of Magento 2 product attachments extension, the admin will find the configuration settings panel by navigating through Stores->Configuration->Product Attachment Configuration as per the snapshot below.
Meanwhile, under the Product Attachment Configuration option, there are three settings for configuring this module –
General settings
In the general settings, the admin can –
- Set the FTP path for File Uploading.
- Select the file types in the Attachment Allowed Extensions field.
Display Settings
In the display settings, the admin can-
- Enable the module by selecting “Yes” or Disable it by selecting “No”.
- Specify a Customer Group for which the attachment will be visible on the front end.
- Set as “Yes” to display the attachment block only if the product has been ordered, and “No” to display the attachment block always.
- Set Block Title for Attachments.
- This field will be set as “Yes” to display the Alias Name instead of the Attachment Name.
- Set as “Yes” to display the Attachment Size at the front end.
- The admin can set the Default Color for the attachment title.
- Set as ‘yes’ to display attachments in the Product Overview on the front end.
- Set Block Title for Attachments Overview.
- Enter the maximum number of attachments to display in the product overview.
Additional Settings
- Choose which attachment information to display on the product page – Attachment name, size, or image.
- Choose which attachment information to display on the category page – Attachment name, size, or image.
- Choose to enable the attachments in the customer’s order history under the My Orders Section for the respective orders.
- Allow to Add Attachments in E-mail Invoice.
After configuring the module, click on the “Save Config” button.
Magento 2 Product Attachment – Options
After configuring the module’s general and display settings. The admin from the Dashboard will navigate to Product Attachments Management to manage the product attachments and icons.
Manage Product Attachment
Under this, the admin can find the list of all existing product attachments along with the icon extension column displaying the icon for the respective file extension.
From here the admin can manage the product attachments. In order to update an attachment click on “Edit”. As shown below.
Admin can manage the existing attachments & also can add a new attachment by clicking on the “Add Attachment” button.
For adding a new attachment, product attachment information need to be entered by the admin-
- Need to add the Attachment Name.
- Enter the Alias Name.
- Upload the Attachment File.
- Enter Alt Text in order to effectively search the attachment file.
- Add a Description for the attachment.
- Can “Enable” or “Disable” the status of the attachment to make it visible on the front end?
- Choose the Store View to display the attachment.
- Enter a Sort Order to set the position for the attachment.
In the product assignment, the admin can select all the products the admin wants to assign to this attachment as shown below.
Manage Category Product Attachment
To manage the category product attachments navigate through Catalog->Catgories and open a category to which you want to add the attachment. Here, you will find one option Product Attachments.
Open It and this will be displayed as under.
Now, tap the Add New Attachment button. After that, for the product under the category add the product attachment details.
After that, come down to the Product Assignment tab and select the products.
Lastly, tap the Save button to save the product attachment. A success message for the same is also visible.
To assign existing product attachments, tap the Assign Existing Attachments button.
After tapping the same, a pop-up appears that consists of already created attachments. Select the required and tap the Upload Attachments button in the top right-hand corner.
After that, you can see a success message for the same.
The category attachments then get visible like the attached snapshot below.
Manage Attachment Icon
Under this tab the admin can manage the existing attachment icons as well can add a new icon for the attachments. When the file is uploaded, the icon on the front end indicates the file format to the customer. This informs the customers what file type they are about to download.
Edit the Icon
The admin can edit the existing icon by clicking on “Edit” as shown below –
Add New Icon
Here to add the icon for attachment, the admin needs to enter the –
- Name of the icon.
- The Alias Name.
- Attachment Extension file type
- Choose an Icon file to upload.
- Enter Alt Text for the icon.
- Select Status for the icon i.e. Enabled or Disabled.
Upload & Attach Files
The attachments can be associated with the products in two ways.
Here the admin can add attachments to the product just by clicking on the upload option available on every product from the grid only.
After clicking on the “Upload Files”, the next screen will open consisting of existing attachments. From here the admin will select the attachment which is required to be attached with the product, then select the dropdown “Assign selected files” and save it.
Also, from here the admin can directly add and upload an attachment. For this first click on “Upload Attachment” and then select the specific file to upload from the system
Then the selected file will show with other existing attachments just select the desired attachment and assign it to the product.
Upload from Product Page
This is the standard method in which the admin can upload files and restrict their access to specific customer groups from the product edit sheet.
Here the admin needs to provide the –
- Name for the attachment.
- Alias Name of the attachment.
- Browse the file from the system.
- Select the specific Customer Group.
- Can select “No” to Show the attachment to the customer every time whether the product is ordered or not, and if selected as “Yes” then the attachment will be visible only if the product has been ordered once.
- Can select whether to make the Attachment Visible or not and then Save the product.
- Color code for the attachment title.
Product Attachment View Reports
The admin can see the product attachment view reports as required. The admin can filter the data on a weekly, Monthly, or Yearly basis.
To check the same navigate through Reports->PRODUCT ATTACHMENT REPORTS->Product Attachment Views.
The graph at the admin end will be shown when a customer will see the attachment details on the product page.
Frontend Workflow
After successful configuration is done by the admin, let’s see the front end of the web store. Here on the product page, the customer can easily find the Product Attachment Overview and Product Attachment section.
Moreover, by clicking on the View Details option, the customer can see the attachment information as shown in the below screenshot.
Further, as the customer clicks on the attachment, the file will open in a new tab, from where the customer can take a preview of the attachment.
The customers can also see the product attachments for the respective product order under the My Order section.
Also, an email with the product attachments is visible to customers.
That is all for the Magento 2 Product Attachment still, have any issues feel free to add a ticket and let us know your views to make the module better at webkul.uvdesk.com