AWBS Configuration Guide
- Install - Refer to the AWBS Installation Guide
- Configure - Use this AWBS Manual
- Customize - Refer to the AWBS Customization Guide
- Test
Many tend to customize before configuring. This can make things difficult. If you configure and then customize, you will eliminate anything that can be setup as desired in the configuration area during your customization process.
You may be testing throughout the process, but final testing should be done when all customization is complete to make sure your site/system is ready for the public.
Contents
Getting Started
Installation is complete, now what?
Surf to your AWBS site and login using the super admin account you created during the installation process. You will be redirected to the administration area of AWBS and prompted for the admin directory secuirty login (if directory security was setup correctly).
You should see our 'getting started' page. Use that as a guide to get the basics configured. Then click the link at the top 'do not show this page again' to use the normal admin home page.
- Module Setup. First, go to the configuration area and click the Module Setup link. Enable all modules you will be using and disable any you won't be using. Save.
- Website/Company Info. Click the Website/Company Info link and enter all information as per your preferences. Most information on this page will be used in invoices to your customers, etc. The fields with a * are required, do not leave those empty. Save.
- System Options. Click the System Options link. Read through all system options setting your company preferences. If you are not sure about some things you can come back later and set them up as desired, but you should go through it all to see what settings are available and to get the basics setup as per your preferences.
- Configure Modules. Now configure all modules you enabled above.
Affiliate Modules
AWBS Internal Affiliate System
Go to System Setup >> Module Setup >> Affiliate Modules section. Set to Internal Affiliate module.
Go to System Setup >> System Options >> Misc section, make sure 'Enable Affiliate System' is set to 'True'.
Go to System Setup >> Affiliate Defaults page. Set your affiliate default settings here.
You can configure to pay by percentage or a fixed amount. Select the correct radial selection.
Max Payout (or fixed amount): enter a max payout per transaction or if using fixed amount above, enter the amount to pay affiliates for their referrals. The max payout is a cap and will be the maximum amount an affiliate can earn on one sale.
Percentage (not for fixed amount): enter the percentage your affiliates will earn on each sale if you have selected percentage above.
Hold days: enter the number of days after the affiliate sale to hold the payment. Most companies use 90 days, as that is the limit for a chargeback on a credit card.
Pay on recurring: check this box if you want affiliates to earn credit for each recurring bill the referred customer pays. This applies to all recurring hosting and other items offered on your site.
Affiliates will be paid by live credits being put in their account when the Hold days are up.
Any user in your system can signup to be an affiliate by clicking on the 'Affiliate Info' link on the member home page drawdown menu.
They will be asked to agree to the affiliate terms of service before they can become an affiliate. Make sure the default terms page for affiliates has the information you want.
Here are the templates you may want to edit: ( template files are found in templates/[your_theme_directory] )
affilfaq.php - this page contains a set of Frequently Asked Questions for affiliates. Edit the template to edit/add/remove faqs.
affiltos.php - this page contains a copy of the terms of service that is viewable after an affiliate has signed up.
afiltos.php - this page contains the affiliate terms of service that needs to be agreed to when signing up to be an affiliate. The terms on this page should match the terms on the affiltos.php page
affiliate.php - this is the affiliate home/info page where the affiliates will see their stats, their affiliate link and banners you want to provide them with.
The page is setup with 6 banner images by default; banner1.gif - banner4.gif are 110x60 banners. banner5.gif and banner6.gif are 468x60 banners.
The easiest thing for you to do to get started is make banners in the above dimensions then save them as the above image names in your template theme images directory.
If you have other banner sizes or want to change the positioning of the banners, etc, edit the affiliate.php template as desired.
After an affiliate has signed up, they will be pending approval. When an affiliate is pending, you will see the 'Pending Affil's' in the Quick Alerts box of the admin home page turn red. Click the link to enter the Affiliate Manager. Click the icon to the right of any affiliate to change the affiliates status to active.
Each affiliate can be setup with their own percentage or amount on a per user basis here as well.
View affiliate sales by clicking on the Affiliate Sales link.
iDevAffiliate System
From the AWBS Configuration home page, click on the Module Setup link.
In the 3rd Party Affiliate Modules section, select iDevAffiliate.
Click the Save Changes button.
From the Configuration home page, click on the System Options link.
Scroll down to the iDevAffiliate Setup section.
Enter the correct path to your iDevAffiliate installation.
Enter the url to your iDevAffiliate installation.
Check the iDevAffiliate Pay Recurring checkbox if you wish to pay your affiliates for recurring sales.
Enter your iDevAffiliate admin username and password and database information as requested.
Click the Save Changes button.
Login to your iDevAffiliate system as admin.
In the iDevAffiliate Setup, Configuration & Tools area, click on the Cart Integration link.
Select the Use Automatic Integration Method choice and click the Continue To Next Page button.
Select Advanced Webhost Billing as the Product To Integrate.
Refer to iDevAffiliate documentation for details on Option Variable Setup if desired.
Click Update And Continue To Next Page button.
Make sure your iDevAffiliate system is configured as desired.
Test by creating a user in AWBS and then signup to be an affiliate. Place test orders as a different test user from the affilate link from your affiliate test user.
JROX Affiliate
(coming)
Domain Registrars
Refer to the Domain Registration section for details
Bpath Hypersubmit (SEO) Module
Enable the SEO module in the Module Setup page of the AWBS Configuration area.
Navigate to the Site Enhancements section and select the Active radial next to Bpath Hypersubmit.
Click the 'Save Changes' button at the bottom of the Module Setup page.
From the Configuration main page, click the System Options link.
Locate the Misc section and go to the SEO Setup section.
Either the Private Label SEO Reseller Program account or the SEO API Partner program account can be used with AWBS.
Select your account type. (only one can be configured).
If using the API Partner account, complete all information that shows (API Only) next to them.
Complete the SEO Reseller or API ORDER URL field for both types of accounts.
No further configuration is necessary if you are using an SEO Reseller Account.
Example menu link:
<a href="<?=$base?>/packages.php?spt=<?php echo $seo_config["config8"]; ?>" class="menu"><?=LMENU27?></a>
Set Live SEO Processing to False if you want new orders to wait for approval in the pending queue. Set it to True if you want them to process immediately (they will go to the open queue and run without approval).
SEO API Partner accounts require package setup in AWBS as follows:
From the AWBS Configuration main page, click the Other Package Types link found in the Other Package Setup section.
Use the Add Record link at the top to create a new package type for your SEO package sales.
From the AWBS Configuration main page, click the SEO Package Setup link found in the Other Package Setup section.
Use the Add New link at the top to create your SEO packages as per your desired offerings.
Be sure to select your new SEO package type as configured in the previous step on the Package Type field.
Select the SEO Order Activated email template (be sure to edit as desired before going live)
Select the correct Remote Product ID.
Click the Save Record button.
NOTE: Saving the record will populate the Signup Form with the default settings, edit as desired by clicking the Edit Form link.
Enter your retail price, other fee if you charge one, a name for the other fee if you charge one, and the description for display on the web page. HTML code can be entered in the description field, be sure to not use any quotes (can use single quotes)
Click the Save Record button.
Repeat as needed to add all packages offered.
Filling SEO API Partner orders
When a new order is placed on your site for one of your SEO packages, you will find a new job in the open queue if configured to process live, or in the pending queue if configured not to process live.
There will also be a pending other package. Do not alter the other package from the Other Package Manager, unless you need to alter/correct the URL to Submit (cannot be changed once the order is placed at Bpath).
Navigate to the Queue Manager in the AWBS Administration area.
Click the Run link to process the order.
Or if you want it to be processed automatically when the master_cron.php script runs click the approve link if it is in the pending queue, or do nothing if it is in the open queue.
The package will be set to a closed status in the other package manager and the customer will receive the email configured in the package when the queue job runs and is successful.
NOTES:
The customer will be able to manage their SEO package and edit settings at any time by going to their member home page and clicking on view/edit by 'SEO Packages in your account' link.
Administrators will see SEO packages in the Other Package Manager of the admin area.
Domain Tools
In AWBS;
In the Module Setup page, set Domain Tools to Active in the Site Enhancements section.
Go to the System Options page, to the Misc section.
In the Domain Tools Setup section, complete all fields. All fields are required.
At domaintools.com
Click on Members Area. (You can sign up there if you don't have a domain tools account.)
Login to your domaintools.com account.
Click on XML API link on top menu.
Scroll down til you see D. How do I get started?
Click on the link that says Generate a Partner ID and API Key.
Once you have completed the Application Form, you will then get your Partner ID and API Key to use in the AWBS configuration area.
Dynamic Converter
At the Dynamic Converter Site
Add your AWBS site URL to the Domain list
Other settings as follows:
Same currency display = blank Before currency display = ( After currency display = ) Include Before & After with Same currency display = Off Commify amount = On Show decimals = On Don't link prices = On Print base amount = On Base currency symbol = blank Base thousand character = , Base decimal character = . Base currency display format = $100.00 Converted currency display format = $100.00 Before currency display in a dropdown menu = ( After currency display in a dropdown menu = ) Replace detected dropdown prices with selected format = On Currency selection title = Select Currency Currency selection help text = Select which currency to convert to Auto detect prices = On Do you use the tax rules? Yes Do you use the currency selection dropdown placeholder? Yes Do you convert prices in dropdown options? No Do you use any override account options? Yes Can your visitors change their currency by using the currency selection box? No
In the AWBS Configuration Area
Go to the Module Setup page, enable the Dynamic Converter module. Go to the System Options page, enter your DC Account ID into the Dynamic Converter Setup section and save.
Google Analytics
The Google Analytics Module integrates the Google Statistic tracking into your AWBS system without you having to add the code to your Templates.
First enable the Google Analytics Module in the Module Setup page of AWBS.
If you already have a Google Analytics account you can skip this step, if not goto http://www.google.com/analytics/ and sign up for an account. Make sure you fill out the relevant info required for Google to track your site. Upon completing your signup you will be provided a code like this by Google:
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"> </script> <script type="text/javascript"> _uacct = "UA-1234567-1"; <- ** THIS IS THE LINE YOU NEED TO TAKE NOTE OF! urchinTracker(); </script>
In the above code your Google Analytics ID is the ID between the quotes after _uacct =
In your AWBS site, open Website/Company Information under the General heading. Scroll to the bottom once this page opens and you will see a Google Analytics Section.
Enter your Analytics ID from the code you received from Google. In our example this would be: UA-1234567-1
If you enabled the E-Commerce Tracking at Google, you can also put a checkmark for that option in your AWBS. The Tracking Code can be left at default, or you can customize it to your own liking according to Googles specifics.
Your site will start being tracked by Google Analytics within 5 - 45 Minutes (Depending on how loaded their system is)
Template Monster
The Template Monster module integrates your Template Monster affiliate account with your AWBS website.
Enable the Template Monster module from the module setup page of the AWBS configuration area.
You will find it in the 'Site Enhancements' section.
Click the Save Changes button.
Go to the System Options page of the AWBS Configuration area.
In the Misc section, set your Template Monster Preset, as found in your Template Monster account. Enter the preset code for the desired preset.
Click the Save Change button.
A new link in the 'Other Services' section of the default side menu will show once you have the Template Monster module enabled.
reCAPTCHA
Enable the reCAPTCHA module from the Module Setup page of the AWBS Configuration. You will find it in the Site Enhancements section.
On the System Options page of the AWBS Configuration area, enter both your reCAPTCHA Public Key and reCAPTCHA Private key obtained from within your reCAPTCHA account at recaptcha.net.
