File Downloads User Guide

Transcription

1 User Guide

2 Important Notice reserves the right to make corrections, modifications, enhancements, improvements, and other changes to its products and services at any time and to discontinue any product or service without notice. Customers should obtain the latest relevant information before placing orders and should verify that such information is current and complete. All products are sold subject to ' terms and conditions of sale supplied at the time of order acknowledgment. warrants performance of its products to the specifications applicable at the time of sale in accordance with ' standard warranty. Testing and other quality control techniques are used to the extent deems necessary to support this warranty. Except where mandated by government requirements, testing of all parameters of each product is not necessarily performed. assumes no liability for applications assistance or customer product design. Customers are responsible for their products and applications using components. To minimize the risks associated with customer products and applications, customers should provide adequate design and operating safeguards. does not warrant or represent that any license, either express or implied, is granted under any patent right, copyright, mask work right, or other intellectual property rights relating to any combination, machine, or process in which products or services are used. Information published by regarding third-party products or services does not constitute a license from to use such products or services or a warranty or endorsement thereof. Use of such information may require a license from a third party under the patents or other intellectual property of the third party, or a license from under the patents or other intellectual property of. Resale of products or services with statements different from or beyond the parameters stated by for that product or service voids all express and any implied warranties for the associated product or service and is an unfair and deceptive business practice. is not responsible or liable for any such statements. All company and brand products and service names are trademarks or registered trademarks of their respective holders. Copyright 2009 User Guide 2

3 Table of Contents 1 Extension Description 4 2 Extension Installation 5 3 Extension Usage 7 4 Support 26 5 Getting Help with Magento 27 User Guide 3

4 Extension Description File Downloads & Product Attachments Magento extension provides unified functionality for file downloads and media content sharing available from within Product pages, CMS pages, Static blocks and even 3rd party Magento extensions. Easy-to-use File Manager allows file uploading and instant attaching of the uploaded file to one or many products. Category Manager enables you to keep files structured and organized in the backend. Files also can be attached to a product in a very convenient way under Attachments tab on a product page in Magento Admin panel. Files are hierarchicaly organized there in a tree-type structure, each file under its parent category. Files can be easily added to any CMS Page or Static block with Magento block directive. Every file can have its own access permissions. For example, you can deny access to a file for non-registered visitors or grant access to a specified customer group(s). Every file has downloads counter and the total number of downloads can be limited. User Guide 4

5 Extension Installation 1 Log out from Magento Admin panel if you are logged in 2 Unpack the contents of the extension folder from the package file purchased from to your Magento root folder 3 Log into Magento Admin Panel 4 If Cache Control is enabled in Magento go to System > Cache Management section, select Refresh under All Cache drop-down menu and press Save Cache Settings 5 Now go to System > Configuration > tab > Extensions & Support section. If you see File Downloads & Product Attachments in the list of installed extensions you are done. Installation to a custom template/theme If you use a custom template or theme you should copy the extension s layouts, templates and skin files to your custom template or theme. The folders that should be copied: app/design/frontend/default/default/layout/ app/design/frontend/default/default/template/ skin/frontend/default/default/css/ skin/frontend/default/default/images/ User Guide 5

6 You should copy them to app/design/frontend/<your-template>/<your-theme>/layout/ app/design/frontend<your-template>/<your-theme>/template/ skin/frontend/<your-template>/<your-theme>/css/ skin/frontend/<your-template>/<your-theme>/images/ Please note that all these folders already exist in your store and you have to merge them with the folders on your server. Do not overwrite them. User Guide 6

7 Extension Usage 1 First, log into Magento Admin panel and go to System > Configuration > tab > CMS > File Downloads & Product Attachments section to configure the extension User Guide 7

8 Enabled enable/disable product attachments. If enabled, the files will be displayed at the product pages. Display File Size displays file size near each file at the product page. File size Precision displays file size in Kilobytes or Megabytes. Recommended value us Auto. Group Files by Category this setting groups downloadable files by their categories on the front-end and display a category name as well. Sort Order you can change a sort order of the files on the front-ed. The following options are available: Alphabetical, Upload Date, Size, Downloads. User Guide 8

9 How to download message if downloadable files are not hidden from the customers who are not allowed to download, this message will be shown. You can enter the message, which will notify them that the files are allowed for downloading only for logged-in customers. HTML is allowed here. Name Size this setting limits the display of file name at the category page on the front-end and adds if the name exceeds this limit. Enable Files on Categories Pages display downloadable files on categories pages. Add Files to New Order s you can add downloadable files to the s customers received when purchase products from your store. Customers will be able to download the files directly from the s. Display Number of Downloads displays on the front-end how many times the file was downloaded. Hide Files you can hide the files from the customers who are not allowed to download them. If it is set to No, these customers will see the files as a plain text and won t be able to download them. Product Block Position Specifies the place where the block with downloadable files should appear. It can be: Before product description, after product description and after product price (recommended value). User Guide 9

10 Product Downloads Title the title of the block with files at the product pages on the front-end. File Download Title the title of the block with files at the CMS pages on the front-end. Number of Files for One-time Processing during Import limits the number of files processed at once when you are uploading the files directly from your server. It makes the process of uploading step-by-step and allows to upload unlimited number of files despite of your server configuration. 2 Go to CMS > File Downloads > Manage Categories section to manage (create/edit/delete) file categories. Here you can add new categories, edit existent ones, disable/enable particular categories, filter and sort categories using standard Magento functionality. The following information is available for every category: Category ID; Category Name; Category Description (you can add notes about each category); Number of files assigned to a category and its status (enabled/disabled). To add new category you need to specify its name, description (optional) and status (enabled by default). These categories will be visible in Attachments tab when product editing and they will be available for selection when file adding. User Guide 10

11 3 Go to CMS > File Downloads > Manage Files section to manage (add/edit/delete) files and assign them to products. Manage Files shows the following details: ID file ID, it should be used when you manually add download blocks to CMS page Category category of a file Name file name that is specified by admin and is shown on the front-end File Name a physical file name, i.e. the file name how it is stored on your computer. This name is taken for Name column if the last one is not entered or if the files are uploaded via Multi Upload option Type file type (determined automatically) Size file size (determined automatically) Downloads number of downloads of a file. You can reset this number at any time. For this just choose necessary file on the User Guide 11

12 files grid and choose Reset Downloads in the Action dropdown. Products number of products the file is assigned to. Status a status of a file (can be enabled/disabled). If a file is disabled, it won t be shown on front-end Actions: - Edit edit a file - Download you can download a file using this link - Get Link you can get direct link to a file. It can be used if you need to send this link to your customer directly. Add file To add new file you need to press Upload file button. You will see the following page: User Guide 12

13 You need to enter necessary details regarding file you are going to upload in File tab: Category you need to choose a category the file should belong to (mandatory field) Name file name (mandatory field) Description you can enter file description. This description will be shown on front-end near a file User Guide 13

14 Downloads Limit you can determine the limit for downloads of a file. If this limit is exceeded customers won t be able to download this file. Stores you can select store views, where you want to display the downloadable file. Customers Groups you can choose customer groups who can download the files. Customers of groups that are not chosen here won t see the files. Files you can upload a file here URLs you can specify the URL for a file of a document you want to be opened in a new browser tab. If you specify the URL for a video file you also should add embed code so that this video will be played directly on the product page Embed Code it s required if you want the video file is played directly on the product page. Embed code can be found on the video page. For example, User Guide 14

15 Status you can specify the status of a file (enabled/disabled) Products tab allows you to assign files to any products: Here you can filter product using standard Magento functionality, choose necessary products and save your choice. The products chosen here will show downloadable files at their product pages (if visitor/customer suits file conditions described above). Since the v1.4.0 you can filter products by category. Multi Upload You can find the Multi Upload button just near the Add file button. The form for multi upload is presented below: User Guide 15

16 Category you should select category for uploaded files Description you can enter file description. This description will be shown on front-end near a file Downloads Limit you can determine the limit for downloads of a file. If this limit is exceeded customers won t be able to download this file. Stores you can select store views, where you want to display the downloadable file. User Guide 16

17 Customers Groups you can choose customer groups who can download the files. Customers of groups that are not chosen here won t see the files. Add Files you can select any number of files for uploading. The upload process is shown below this button. You can cancel the process at any time by clicking on Cancel link near appropriate file. Status you can specify the status of a file (enabled/disabled) 4 Go to Manage Products > choose particular product > Edit > Attachments tab to assign files to products. User Guide 17

18 You can choose the files you want to assign to current product. You can also expand/collapse hierarchical category tree. You can upload files directly from the Attachments tab if you click on Add new file(s) button: User Guide 18

19 User Guide 19

20 How to upload files directly from the server Since the v1.4.0 the extension allows uploading files directly from your server. It s useful if you need to upload hundreds of files or if you need to upload large size files. First, you should upload the files to the media/downloads_import/ folder. If you copy the files directly to the downloads_import folder, these files will be uploaded to the default category. If you need to separate them by categories, you should create the folders with the names equal to the IDs of the categories inside the downloads_import folder. Then copy the files into the necessary folders. Once all the files are copied to the necessary folders on the server, go to the System Configuration MAGEWORX CMS File Downloads & Product Attachments and run import process. You will see a log with detailed reports of all processed actions: User Guide 20

21 If any error occurred, you will see a reason. Front-end You can see the screenshot below how the download block looks on the front-end. Product page: User Guide 21

22 Video file at the product page: User Guide 22

23 Category Page: How to add download block to CMS/Static pages To add download block with files to any CMS/Static page you need to add the following code to page source (CMS > Static Pages or Static Blocks): {{block type="downloads/link" id=5 title="documentation"}} or {{block type="downloads/link" id="5,6,7" title="files"}} where id ID numbers of files you need to display; title title of a block with files at CMS page. User Guide 23

24 How to show all files of particular category on CMS page or static block To show all downloadable files of a particular category on CMS page or in a static block you need to add the following code to page source (CMS > Static Pages or Static Blocks): {{block type="downloads/category_link" id=5 title="documentation"}} User Guide 24

25 How to show all files of all categories on CMS page or static block: To show all downloadable files of all categories on CMS page or in static block you need to add the following code to page source (CMS > Static Pages or Static Blocks): {{block type="downloads/category_link" id=all title="documentation"}} User Guide 25

26 Support offers FREE lifetime support and updates for any extension developed for Magento. If you need support related to extension usage, feel free to contact us at Or send us a message directly from your Magento Admin Panel. To do it, go to System > Configuration section, tab Extensions & Support > Get Support. User Guide 26

27 Getting Help with Magento offers outstanding services developing custom tailored solutions for Magento platform to attain your ecommerce objectives. Our professional impassioned team provides profound and custom oriented development of your project in a short timeframe. You are most welcome to contact us at sales@mageworx.com User Guide 27