User Guide of Adobe Commerce Product Attachment

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

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.

After the installation of Magento 2 Product Attachment, 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.

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.

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.

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.

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.

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.