| QWK | QwkIssue |
Documentation for version 1.031004.
Copyright © 2004-2005, QwkSoft . Licensed to 4TheBest.net.
This module allows you to issue licenses or other unique code to customers when they purchase products.
The licenses are presented in the invoice footer and sent to the customer in email. The email can optionally include other invoice information, allowing you to use it as a replacement for the usual customer notification emails.
A pool of licenses are associated with a resource, and that resource is associated with a product, attribute and / or option. Multiple resources can be associated with a single product, attribute or option. Multiple licenses can be issued from the same pool for a single product, attribute or option.
For example, you can configure the module so that purchase of one product A causes a single license to be issued, while a the purchase of product B ( a license bundle ) causes five licenses to be issued, and the purchase of product C ( a bigger bundle ) causes ten licenses to be issued.
Alternatively, you could configure product A such that selecting option 1 causes one license to be issued, while selecting option 2 causes five licenses to be issued.
The QwkSoft License Issuer distribution contains 3 files: qwkissue.mvc, qwkissue_f.mvc and qwkissue.html (this documentation file). Install the *.mvc files in your domain and store as usual for Miva Merchant modules. Please refer to the documentation for your version of Miva Merchant for more information.
note: if you are using a non-compiled version of Miva Merchant you will need the non-compiled version of this module. That distribution contains *-nc.mv files in place of *.mvc files.QwkSoft License Issuer is a Store Utility module. It also uses a Order Fulfillment module that must be installed in the store, but has no databases or settings of its own. Store Utilities Screen
This module places 9 tabs on the Store Utilities screen. This screen can be reached from the left navigation bar by selecting Stores->your store name-> and then selecting this module.
(Some tabs may not be visible at all times)
View, add or edit Settings record.
The settings on this tab control the overall behavior of the module.
This is the default download URL, the place where the customer can go to download a resource. This value can be displayed on the invoice footer and in the confirmation email sent to customers. It can be overridden at the resource level.
This is the default label for the download URL. This value can be displayed on the invoice footer and in the confirmation email sent to customers. It can be overridden at the resource level.
This is the default contact email. This value can be displayed on the invoice footer and in the confirmation email sent to customers. It can be overridden at the resource level.
This is the default label for the contact email. This value can be displayed on the invoice footer and in the confirmation email sent to customers. It can be overridden at the resource level.
Determines when this module sends notification email.
| Options | |
| Never | |
| When one or more licenses are issued | |
| Always | |
If this box is checked the email specified on the HTML Email is sent to customer and the email included a flag that tells the customers email client that the mail is being sent in HTML format. If this box is not checked, the email format specified on the Text Email tab is used.
A copy of the customer notification email will be sent to this address, if one is specified.
The email address which the customer notification email will appear to be from. Also where replies to the notification email will be sent by default.
The subject of the customer notification email.
The body of the customer email.
There are two tokens available:
| %invoice% | Invoice information block. |
| %resource% | Resource (license) information block, as defined on the Text Email or HTML Email tab. |
The Invoice Footer. Appears on the invoice screen if any licenses are issued.
One token is available: type=table #datalist row col col %resource% Resource (license) information block, as defined on the Invoice tab. #/datalist
Lists Resource records.
Click the [add] link on the right side of the header line to add a new record.
Click the [edit] link on the right side of a line to edit the record.
Check one or more boxes in the delete column on the left of the list and click the update button at the bottom of the list to delete the selected records.
View, add or edit Resource record.
Resources are the things that licenses are issued for. For example, if you have two different pieces of software that need licenses, you would specify a resource for each.
An internal code to identify the resource.
A description of the resource. What the customer sees on invoices.
This is the download URL, the place where the customer can go to download this resource. This value can be displayed on the invoice footer and in the confirmation email sent to customers. If omitted, the default will be used.
This is the label for the download URL. This value can be displayed on the invoice footer and in the confirmation email sent to customers. If omitted, the default will be used.
This is the contact email. This value can be displayed on the invoice footer and in the confirmation email sent to customers. If omitted, the default will be used.
This is the label for the contact email. This value can be displayed on the invoice footer and in the confirmation email sent to customers. If omitted, the default will be used.
The number of licenses available for this resource. This field is not modifiable.
View, add or edit Invoice record.
Replaces the token %resource% in the invoice footer, but only if there are one or more resource lines.
| token | meaning |
| %resource_list% | One or more resource lines, as defined below. |
Replaces the token %resource_list% in the Resource Block above, repeating for each resource.
| token | meaning |
| %name% | The resource name |
| %code% | The resource code |
| %license_block% | The License Block as defined below. |
| %download_block% | The Download Block as defined below. |
| %contact_block% | The Contact Block as defined below. |
Replaces the token %license_block% in Resource Line above, but only if there are one or more licenses in the license list
| token | meaning |
| %license_list% | One or more License Lines, as defined below. |
Replaces the token %license_list% in the License Block above, repeating for each license.
| token | meaning |
| %license% | The license number |
Replaces the token %download_block% in Resource Line above, but only if Download Line as defined below is not blank.
| token | meaning |
| %download_line% | The Download Line as defined below. |
| %dl_label% | The Download Label for the resource |
| %default_dl_label% | The default Download Label |
| %dl_url% | The Download URL for the resource |
| %default_dl_url% | The default Download URL |
Replaces the token %download_line% in Download Block above.
| token | meaning |
| %dl_url% | The Download URL for the resource |
| %default_dl_url% | The default Download URL |
Replaces the token %contact_block% in Resource Line above, but only if Contact Line as defined below is not blank.
| token | meaning |
| %contact_line% | The Contact Line as defined below. |
| %con_label% | The Contact Label for the resource |
| %default_con_label% | The default Contact Label |
| %con_mail% | The Contact Email for the resource |
| %default_con_mail% | The default Contact Email |
Replaces the token %contact_line% in Contact Block above
| token | meaning |
| %con_mail% | The Contact for the resource |
| %default_con_mail% | The default Default Contact Email |
Check this box if you'd like to restore all fields to their default values.
Enter an order number to preview how the invoice footer would look with that order.
View, add or edit Text_Email record.
Replaces the token %resource% in Text Email, but only if there are one or more resource lines.
| token | meaning |
| %resource_list% | One or more resource lines, as defined below. |
Replaces the token %resource_list% in the Resource Block above, repeating for each resource.
| token | meaning |
| %name% | The resource name |
| %code% | The resource code |
| %license_block% | The License Block as defined below. |
| %download_block% | The Download Block as defined below. |
| %contact_block% | The Contact Block as defined below. |
Replaces the token %license_block% in Resource Line above, but only if there are one or more licenses in the license list
| token | meaning |
| %license_list% | One or more License Lines, as defined below. |
Replaces the token %license_list% in the License Block above, repeating for each license.
| token | meaning |
| %license% | The license number |
Replaces the token %download_block% in Resource Line above, but only if Download Line as defined below is not blank.
| token | meaning |
| %download_line% | The Download Line as defined below. |
| %dl_label% | The Download Label for the resource |
| %default_dl_label% | The default Download Label |
| %dl_url% | The Download URL for the resource |
| %default_dl_url% | The default Download URL |
Replaces the token %download_line% in Download Block above.
| token | meaning |
| %dl_url% | The Download URL for the resource |
| %default_dl_url% | The default Download URL |
Replaces the token %contact_block% in Resource Line above, but only if Contact Line as defined below is not blank.
| token | meaning |
| %contact_line% | The Contact Line as defined below. |
| %con_label% | The Contact Label for the resource |
| %default_con_label% | The default Contact Label |
| %con_mail% | The Contact Email for the resource |
| %default_con_mail% | The default Contact Email |
Replaces the token %contact_line% in Contact Block above
| token | meaning |
| %con_mail% | The Contact for the resource |
| %default_con_mail% | The default Default Contact Email |
View, add or edit Html_Email record.
Replaces the token %resource% in HTML email, but only if there are one or more resource lines.
| token | meaning |
| %resource_list% | One or more resource lines, as defined below. |
Replaces the token %resource_list% in the Resource Block above, repeating for each resource.
| token | meaning |
| %name% | The resource name |
| %code% | The resource code |
| %license_block% | The License Block as defined below. |
| %download_block% | The Download Block as defined below. |
| %contact_block% | The Contact Block as defined below. |
Replaces the token %license_block% in Resource Line above, but only if there are one or more licenses in the license list
| token | meaning |
| %license_list% | One or more License Lines, as defined below. |
Replaces the token %license_list% in the License Block above, repeating for each license.
| token | meaning |
| %license% | The license number |
Replaces the token %download_block% in Resource Line above, but only if Download Line as defined below is not blank.
| token | meaning |
| %download_line% | The Download Line as defined below. |
| %dl_label% | The Download Label for the resource |
| %default_dl_label% | The default Download Label |
| %dl_url% | The Download URL for the resource |
| %default_dl_url% | The default Download URL |
Replaces the token %download_line% in Download Block above.
| token | meaning |
| %dl_url% | The Download URL for the resource |
| %default_dl_url% | The default Download URL |
Replaces the token %contact_block% in Resource Line above, but only if Contact Line as defined below is not blank.
| token | meaning |
| %contact_line% | The Contact Line as defined below. |
| %con_label% | The Contact Label for the resource |
| %default_con_label% | The default Contact Label |
| %con_mail% | The Contact Email for the resource |
| %default_con_mail% | The default Contact Email |
Replaces the token %contact_line% in Contact Block above
| token | meaning |
| %con_mail% | The Contact for the resource |
| %default_con_mail% | The default Default Contact Email |
Lists Licenses records.
Check one or more boxes in the delete column on the left of the list and click the update button at the bottom of the list to delete the selected records.
Click <-prev or next-> in the footer to move backwards or forward a page. Enter a new value in the field label "page" to change the number of records per page.
View, add or edit Licenses_Add record.
Type a list of license numbers here. You can separate licenses with a comma and / or put them on separate lines.
Enter licensing information here.
Enter the license number that you were issued when you purchased this software.
Check this box if you have read and and agree to the EULA. You must agree to the EULA to use this software.
This module places a tab on the Product edit screen. This screen can be reached from the left navigation bar by selecting Stores->your store name->Products then selecting a product from the in the main ( right ) frame by clicking on the edit button.
(Some tabs may not be visible at all times)
This is where you specify which resources are associated with the product, and how many licenses to issue.
If the product has checkbox, select or radio attributes you can also associate resources with those. In the case of checkboxes, the license(s) specified will be issued if the box is checked. In the case of select and radio attributes the license(s) to be issued are specified on an option by option basis.
The Resource to issue licenses for.
The number of resources to issue.