Joom Donation Installation & Configuration

When you purchase Joom Donation extension from our site , you will receive an email contain download link to download the extension . Click on the link, you will download a file called jdonation_unzip_first.zip . Unzip this file you will see a component, several modules and plug-ins . The sections below explain the functionalities of each file, how to install and configure important parameters .

Joom Donation component

1. File name : com_jdonaiton.zip
2. Functionalities : This is the main component which perform all the important tasks : Display Donation Form, Process Donation , Display donors list....
3. Installation :
   • Login to back-end of your site
   • Access to Extensions=>install/uninstall menu item
   • Browse for the file com_jdonation.zip
   • Click on Upload and Install button .
4. Configuration :There are many parameters which you can change , that makes Joom Donation become a very flexible extension and can be used in many areas, not just for donation . Most of the parameters are self-explained, I will only explain the most important parameters :
   • Integration : If you are using Community builder on your site, set it to Community Builder . If you are using JomSocial on your site, set it to JomSocial . If there are no Community Builder or JomSocial installed on your site, set it to No integration . For explanation of the integration between Joom Donation and Community builder or CB , please look at the product description .
   • Activate campaign feature : If set to Yes , administrator can add campaigns from back-end . Then donor can see list of campaigns on donation form and they can choose the campaign they want to donate for to make donation.
   • Activate HTTPS : If your site support SSL and you are using Authorize.net payment gateway , set it to Yes . Otherwise, set it to No
   • Registration integration : If set to yes, we will display username and password textbox on donation form to allow donor register to become member of your site . If it is set to Yes – Requires, donor is forced to enter username and password . If it is set to Yes-Not requires , then donors can enter username and password or leave them empty .
   • Show term and condition checkbox : If set to yes , we will display a term checkbox on donation form and force user to accept term and condition when they make donation .
   • Term and condition article : Choose the article which explain term and condition .
   • Convenience fee : Some payment gateways like Paypal requires fee for each transaction . So If donors donate $10, you won’t receive $10 . By setting Convenience fee,  donors will have the responsibility to pay for payment fee .
   • Payment methods : Choose the payment methods you want to use on your site .
   • Admin email subject, Admin email body : The notification email subject and body which admin will received when someone make donation .
   • User email subject, user email body is the email subject and email body which donor will receive after making donation to your site .
   • Recurring payment email subject, Recurring payment email body: That is the email subject and email body which administrator will receive when a recurring payment happens.
   • Confirmation message : The message displays on confirmation page
   • Thank you message : The message displayed when donors successfully donate to your site .
   • Cancel message : The message displayed if someone cancel their donation .
   • Payment tabs : This tab allows you to enter merchant account of the payment gateways you use for your site .
   • Fields tabs : This tab allows you to choose show / hide , requires / not requires any fields on donation form .
   • CB Fields mapping tab :  If you are using CB on your site, enter the mapping of fields between donation form and CB custom fields here. For example, if you enter cb_firstname into first name textbox, the First name on donation form will be auto filled by the data stored in cb_firstname field on the logged in user .
   • JomSocial Fields mapping tab : Work the same with CB fields mapping . Enter field code JomSocial custom fields here (Note , Field Code, not field name)
   • Donate for members setting tabs : If you allow your site member to receive donations , there are several config options which you should look at :
     • Who will receive payment : If you set it to Site administrator, money will be transferred to site administrator account . Otherwise , money will be transferred directly into member account .
     • Percent commission : Incase site owner receive money and pay for members , site owner can get some commission . For example, if you set this parameter to %30,  If someone donate for a member , the member will only see %70 of donation amount for each donation record .
     • Paypal ID Field : The field name (in CB) or field code (in JomSocial) which store paypal account of member .
     • Merchant ID Field and Transaction Key Field : The field names (in CB) or Field Codes (in JomSocial) store API Login And Transaction Key of authorize.net account of site members .

Donation Module

1. File name : mod_jdonation.zip .
2. Functionality : Allow users to choose payment method, enter donation amount and process Donate button to start making donation . Click here to view screenshot .
3. Installation:
   • Login to back-end of your site
   • Access to Extensions=>install/uninstall menu item
   • Browse for the file mod_jdonation.zip
   • Click on Upload and Install button .
4. Configuration : The module has one parameter called Donation Type. Posible values are their meaning are explained below :
   • Enter donation Amount into textbox : This setting makes donation module only display textbox which allow donors to enter amount they want to donate .
   • Choose from pre-defined amount : This setting make donation module only displays pre-defined amounts which administrator entered from back-end in radio format . Donors can only choose one value from pre-defined amounts to donate, they can not enter the amount they want .
   • Both : This setting will make donation module displays both pre-defined amounts and amount textbox. Donors can choose from pre-defined amounts or enter the amount they want to donate to start making donation .

Campaigns Module

1. File name : mod_jd_campaigns.zip .
2. Functionality : Display list of campaigns and it's information so that donors can choose one campaign to donate . Click here to view screenshot .
3. Installation:
   • Login to back-end of your site
   • Access to Extensions=>install/uninstall menu item
   • Browse for the file mod_jd_campaigns.zip
   • Click on Upload and Install button .
4. Configuration : The module has some parameters show / hide campaign's information : Show campaign title, show start date, show end date, Goal, Donated amount . These parameters are self-explained and you can easy to understand what they mean .

Donors Module

1. File name : mod_jdonors.zip .
2. Functionality : Allow users to choose payment method, enter donation amount and process Donate button to start making donation . Click here to view screenshot .
3. Installation:
   • Login to back-end of your site
   • Access to Extensions=>install/uninstall menu item
   • Browse for the file mod_jdonors.zip
   • Click on Upload and Install button .
4. Configuration : The module has some parameters . They are self-explained and easy to understand .

Thermometer Module

1. File name : mod_jd_thermometer.zip
2. Functionality : Display donation process (target, current donated amount) for selected campaigns in a nice thermometer. Click here to view screenshot .
3. Installation:
   • Login to back-end of your site
   • Access to Extensions=>install/uninstall menu item
   • Browse for the file mod_jd_thermometer.zip
   • Click on Upload and Install button .
4. Configuration : The module has some parameters . They are self-explained and easy to understand .

Donation Form Plugin

1. File name : jdform.zip .
2. Functionality : This plugin is used to display donation form on an article .
3. Installation:
   • Login to back-end of your site
   • Access to Extensions=>install/uninstall menu item
   • Browse for the file jdform.zip
   • Click on Upload and Install button .
4. Usage : In any article, Using the syntax {jdform campaign_id}, for example {jdform 2} . This will display a form on the article which allow donors to donate for campaign with id=2 .
   

CB Donation History Plugin

1. File name : plug_cb_jdonation.zip .
2. Functionality : Display donation history of a user in his CB profile.
3. Requirement : This plugin is a community builder plugin, not a Joomla(TM) plugin so it requires Community builder to be installed on your site . If your site doesn't use Community Builder , don't install this plugin .
4. Installation:
   • Login to back-end of your site .
   • Access to Components=>Community Builder=>Plugins mangement menu item.
   • Click on install plugin link .
   • Browse for the plug_cb_jdonation.zip
   • Click on Upload and Install button .

JomSocial Donation History Plugin

1. File name : plug_jomsocial_jdonation.zip .
2. Functionality : Display donation history of a user in his JomSocial profile.
3. Requirement : This plugin is JomSocial plugin, not a Joomla(TM) plugin so it requires JomSocial to be installed on your site . If your site doesn't use JomSocial , don't install this plugin .
4. Installation:
   • Login to back-end of your site
   • Access to Extensions=>install/uninstall menu item
   • Browse for the file plug_jomsocial_jdonation.zip
   • Click on Upload and Install button .