Note about compatibility: This module requires that PHP is enabled on the server. You should verify that your host offers PHP prior to installation.

Transcription

1 Soft Goods This module provides a means for selling downloadable products. The Concept... This module provides an interface for you to deliver downloadable products, such as zip, pdf, music and video files. After a customer places an order (with an approved payment method) he/she can be provided with a download link on the invoice and/or be sent an with the download link. Download links use unique strings, and can have expirations set on them (number of downloads and timeframe). And since the actual download files are stored in your mivadata directory, the files are not publicly accessible. Note about compatibility: This module requires that PHP is enabled on the server. You should verify that your host offers PHP prior to installation. Note about how the module works: This module uses a supporting.php file to deliver an accurate, unique link to the customer. Installing the Module... This module is installed as an Order Fulfillment module. Click here for installation steps. Accessing the Module... After installing the module, click on the Order Fulfillment link in your Miva Merchant Admin, and click on the Coupon Settings link in the right-hand screen. This is where you will make all configurations for the module.

2 Before You Start Before configuring the Soft Goods module, you need to open the download.php file (included in the zip file you received) in a text editor and edit the module path field at the top of the file. This line needs to be the full URL to the Soft Goods module file, and will look something like this: To verify the right url, you may need to FTP to your server to confirm the directory structure. Once you ve verified the full url, you need to upload this file to your site s public directory (this is the same directory where your site s home page like the index.html file is located). We recommend putting the file parallel to the index.html and Merchant2 folders so it can be called simply via Main Settings... Before serving downloadable files, you need to configure settings for Soft Goods. Enabled: This box must be checked in order for the module to actually function. We recommend leaving this unchecked until you are ready to test your settings. Path to Miva data directory: On a typical server installation of Miva Merchant, your data directory will be named mivadata or htsdata, and can normally be called as../mivadata/ or../htsdata/. However, some server setups may have alternative paths. The actual server path to the data directory must be put here. If you find a problem with this setting, you may need to contact your host, or refer to the troubleshooting section at the end of this documentation. Path to downloads: You ll need to create a directory on the server in which your downloadable files will be stored. The directory needs to be relative to your data directory. We recommend creating a directory named downloads as a sub-directory of your mivadata directory. Via FTP this would look like: mivadata/downloads. In the Path box, enter the name of the directory followed by a slash. For example: downloads/. URL to PHP script: Enter the URL to the download.php script you uploaded to the server. Commonly this would be something like

3 Max download attempts: Enter a positive number denoting the maximum number of download attempts a customer may make. Most sites set this at 2 or 3. Why would you want to allow more than one attempt to be made? Because some browsers may crash, not parse the url directly, or an interruption to the Internet may occur. Any time the max attempts is reached, the customer will need to contact you for assistance. Max minutes to download: Enter the maximum number of minutes a customer has to download the file. One full day equals 1440 minutes. We recommend giving at least one full day for download. You may want to offer 2 or 3 days, as some customers may place their order on a weekend and come back later to download the file. Approved payment modules: Because you likely would not want to offer an immediate download to someone who pays by check or PayPal (in case they use the e-check method), the module lets you decide which payment methods result in immediate download. If a customer pays with an unapproved method, you can quickly activate the download from a special listing. Error for invalid/expired: Enter text for the error you want displayed if a customer attempts to download a file that has been downloaded too many times, or if the attempt exceeds the maximum minutes to download. We recommend you include a message for how the customer should contact you if the error is reached and a no file has been downloaded. Log failed attempts: The module can log any failed download attempts, which can assist you in verifying legitimate download problems. Log file: The module will write the log file and name it as you wish. By default this file will be stored in the root of your mivadata directory. You can include a path if you d like it stored elsewhere. For example, you can create a directory named sglogs and set the Log file field to read: sglogs/logattempts.dat Note: The log file can get quite large, especially on highly active sites. We recommend purging the log regularly. You can always save a copy off the server should you need it for future reference.

4 Download Settings You can opt to display the download link right on the invoice, sent via , or both. Displaying the link on the invoice gives the customer instant access. Some stores only send the link via , using this method as a confirmation method that the customer used a valid address when ordering. You could also opt to not provide any links immediately, and manually send links as you verify each order individually. Invoice Screen Settings You can select to display download links above or below the invoice. You can also include a custom header message for the links, upload a clickable download icon, and include a footer below the links area. Settings Here you can set the FROM address, opt to carbon copy the to someone else (will copy for every single order), use a custom subject, header and footer.

5 Creating Downloadable Products To assign products as downloadable, you first need to upload (via FTP) the product s associated file to the downloads directory (inside your store s data directory). 1. In the Admin, locate the product you want to set as downloadable and open it for editing. 2. Click on the Soft Goods tab. 3. Check off the Enabled box (required for download links to work). 4. If you are serving a file for the purchase of the product itself, enter the file s full name (ie. wonderful.zip). If you put the file in a sub-directory of the downloads directory, you ll need toreference it like: books/wonderful.zip (note that you need no slash at the beginning as you had put the slash at the end of the downloads/ directory in the module s Main Settings. 5. If you want to include a custom message to appear on the download , you can do so and it will only appear in the if this particular product is purchased. 6. Soft Goods can serve download files based on one attribute selection only. For example, if you offer a product in both printed and e-book formats and use an attribute for the customer to select which one he/she wants, you can set the e-book option as the downloadable item. However, you cannot use a combination of attributes to offer the download. You can, though, use one attribute for a format with multiple options and set a different file to be downloaded for each format (such as.wav,.mp3, etc.). Attribute Templates are not supported. Any attributes you want to use for downloadable products must be entered manually for the product, or if using an attribute template you must use the copy function. To serve downloads based on an attribute, check off the Enable Attribute-Based Files box select the attribute from the list. 7. Click the Update button. 8. If configuring downloads based on the attributes, enter the file s full name for each applicable attribute option, and click Update.

6 Errors When Assigning Files The most common error when assigning files is one stating that the file cannot be found. This is usually attributed to one of many things: The file has not been uploaded to the server. The file name is not correct (check case, spaces, file extension). The file is not in the proper directory. The path to the store s data directory is not correct (check the Soft Goods module s Main Settings). If you receive an error when assigning a file, you will need to fix it at this point. Testing the Download Link To test a download link, first make sure that the download is Enabled on the Soft Goods tab for the product. 1. Click the Create Download URL. 2. Enter the address to which you want the sent. 3. Make sure Approved is checked, and click the Update button. Once you receive the , click the download link. Errors Downloading Files If errors occur when clicking a link to download a file, consider the following: PHP must be installed on the server. The download.php file MUST contain the proper URL to the Soft Goods script file. The download file must reside the proper location on the server (the same location defined on the Soft Goods tabs for the product). The path to the store s data directory must be correct.

7 Working Live with Soft Goods Once you ve tested everything and have downloaded several files via links successfully, it s time to put the module into action. To turn on the module, click on the Soft Goods tab under Order Fulfillment, check off the Enabled box, and click Update. If you ever encounter serious issues with the fulfillment of files properly, you can uncheck the Enabled box at any time. Working With Unapproved Payments If a customer places an order with an unapproved payment method (a method not set for offering immediate downloads), you ll need to manually send the download link. To quickly send download links via for these types of orders, in the Soft Goods module admin, click the Unapproved Downloads link. Here you can check off the order number(s) that are now approved and click the Update button. Resending Download Links If the customer did not receive the initial or click the link on the invoice screen, or if the download link expired before the item could be downloaded, you ll need to resend the download link. There are two ways to do this: In the Soft Goods admin, click the Reorder Downloads link, enter the order number, and click Update. This will work so long as files are associated with the product(s) ordered. In product s admin area, click the Soft Goods link, then click the Create Download URL link, enter the address and click Update. If you need to send a link for a product not already set as downloadable, you ll need to use this method. Manually Sending Download Links If you need to send a link and there s no associated order for the product in the store, you can do so by clicking the Soft Goods link in the product s admin area and clicking the Create Download URL link. Database Maintenance From time to time you ll want to clear all the expired records from the downloads database. This file can get quite large for highly active stores. If you need to maintain a copy of these records, you can download the database files from your mivadata directory.

8 Importing Download File Associations You can bulk import file associations, saving you time from having to manually assign them via the Admin. Doing this requires that you have installed the Soft Goods Import module. Formatting the Import File The import file can be created in a database or spreadsheet program, such as Microsoft Excel. You will then need to save the file as a delimited file, and the PIPE delimiter is recommended. Product-Wide Files For product-wide files (you re not using attributes), the file needs to contain at least three columns: the Product Code, and Enabled option, and the Filename (with any subdirectory path). The Enabled column must contain a 0 or a 1 with 1 meaning that downloads are enabled for the product, and 0 meaning they are not. There is no need to include codes for any products that will not be downloadable. Example of file A typical file for importing would look something like: file.zip file2.zip file3.zip Or, if you re using sub-directories: books/file.zip cds/file2.zip books/file3.zip You can also include a column for a product-specific download message (optional). If including a message, your file would look like: books/file.zip You will have 60 days to view this file cds/file2.zip If you like this, then checkout books/file3.zip You will have 60 days

9 Attribute Option Files To import file assignments for attribute options, the file will need to include the Product Code, the Enabled option, the Enabled Attribute-Based Files option, the Attribute Code, the Attribute Option and the file name. When importing this type of assignment, the attributes must already be applied to the products and cannot be dynamically updatable by an attribute template. Attribute options and files need to follow a specific format and need to be separated by a comma. For example, if you offer music files in both.wav and.mp3 format, your import file would look something like this: Format MP3:cds/file.zip,WAV:cds/file2.zip And here s a breakdown of the fields: 1000 the product code 1 product enabled for downloads 1 product attribute options enabled for downloads Format the Attribute Code MP3:cds/file.zip the Option Code for.mp3 format, followed by the subdirectory and the file name WAV:cds/file.zip the Option Code for.wav format, followed by the subdirectory and the file name Importing the File To import the flat file, in your Miva Merchant Admin Menu, navigate to: Stores Your Store Utilities Import Data Soft Goods Import Use the upload button to upload the file, and select the delimiter of the file. During import you ll be prompted to select which fields in the file pertain to which fields that are required by the Soft Goods module.

10 Installing Soft Goods 1. In the Miva Merchant Admin Menu, click the next to Modules. 2. Click Add Module. 3. Use the upload button to upload the DEN_SOFTGOODS.mvc (or.mv if running MM version 4.13 or lower) to the store. 4. Once uploaded, click the Add button. 5. Click the next to your store s link. 6. Click the Order Fulfillment link. 7. In the right-hand screen, check off the box next to Soft Goods and click Update. 8. At the top of the screen, click the Soft Goods link. 9. Enter your license key and agree to the terms. 10. Click Update. If you are running the Open Look & Feel (OpenUI), which is required for Miva Merchant versions 4.14 and higher, installation is complete. Installing the Import File 1. In the Miva Merchant Admin Menu, click the next to Modules. 2. Click Add Module. 3. Use the upload button to upload the DEN_SGIMPT.mvc (or.mv if running MM version 4.13 or lower) to the store. 4. Once uploaded, click the Add button. Updating/Upgrading Soft Goods From time to time updates may be made to fix issues or add more features. To see if there are updates available for this module, you can click the upgrades link in the module s admin at any time. If one is available, you can download the file and follow the instructions on updating the module.

11 Troubleshooting Soft Goods Besides the troubleshooting scenarios outlined in this documentation, here are some additional issues some users face, and information on fixing them. "Module not found. Invalid URL to Soft Goods module." This error normally means that the URL to the DEN_SOFTGOODS.mvc file is not set correctly in the download.php file. If you are a current user of this module and recently upgraded to a new version of Miva Merchant, you must update the directory (4.2x, etc.) in the download.php file. If you are sure the $module_path setting in download.php is correct, below is a list of other (though rare) known causes of this error. There may be a permissions problem with the DEN_SOFGOODS.mv(c) module. Try accessing the URL in your browser. A totally blank page should appear. If you instead get a page not found error, check to make sure that the permissions on the file (and it s folder) are correct. The 'allow_url_fopen' setting may be disabled in the PHP configuration file. You will need to contact your hosting provider to make sure this setting is enabled. The server may be behind a firewall that blocks URL calls from PHP to the same domain. Try using 'localhost' in place of yourdomain.com in the $module_path setting, or contact your hosting provider. "File not found. Invalid path or filename." The most common cause of this error is an invalid path to the Miva data directory set in the Soft Goods Global Settings tab. If you are having trouble finding the correct path to use, it may help to create a small info.php file with only the following content: <?php phpinfo();?> Name this file info.php and upload it to the server s root HTML directory (where the index.html file is located). This file will print out various php configuration settings. You ll want to search for 'DOCUMENT_ROOT'. This should display the path to your documents (HTML) directory and from that you can usually tell what the actual path to the Miva data directory would be. You can often also use a path relative to the download.php script, i.e.../mivadata/. Or, you may need to contact your host. Other causes include an invalid path to the downloads folder, a permissions problem, or an invalid filename.

12 Obtaining Support Standard support for this module is offered free of charge via the Support Desk. Standard support covers initial installation issues, confliction issues and standard usage of the module. Some issues may be considered advanced, such as requests that require custom coding or configuration. Services are offered for this type of support or work. Please inquire. Before contacting support, please double-check your settings against this document, and visit the Module s FAQ section.