Difference between revisions of "AWBS Configuration Guide"

Latest revision as of 08:53, April 26, 2010

1. Install - Refer to the AWBS Installation Guide
2. Configure - Use this Configuration Guide
3. Customize - Refer to the Customization Section
4. 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.

Recommended: Test using a test user account. This makes cleaning out test data much easier than if you use the admin account.

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.

1. 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.
2. 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.
3. 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.
4. Configure Modules. Now configure all modules you enabled above.

Domain Registrars

Refer to the Domain Registration section for details

Hosting Modules

Refer to the Hosting Modules section for details.

Payment Processing Modules

Refer to the Payment Processors section for details.

Tax Rules

You can now set up multiple tax rules for your system. Please note that the tax rules are on a first match basis. Once a rule is matched no other tax rules will be applied to the same order.

Tax Rule Setup

The Tax Rule Setup can be found in the AWBS System Configuration. Look for the link:

Tax Rule Setup - Configure tax rules for use with the payment system

Once you have clicked the link you will be shown a list of existing tax rules and the option to edit those, or Add a new tax rule.

When editing or adding a new rule you have the following options:

• Rule Name: Set a name for the rule. This is for your own Reference.
• Rule active: Set whether this tax rule is active or not. Rules that are not active will not be used.
• Rule match type: Can be set to 2 character state or province, 2 character country code, or Applies to Everyone
• Rule match criteria: Enter what you want to match, Enter ALL for the Applies to Everyone selection above
• Tax rate: Set to your tax rate for this rule. Use decimal format, for example set to 0.100 if your tax rate is 10%

Addons

Refer to the Addons section for details.

Affiliate Program Configuration

Refer to the Affiliate Program Configuration 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.
If you wish to change the default Dynamic Converter logo (shown if you have a free account) to a text link, you can do this. Edit the bottom.php template file (usually located in /templates/common_files if you do not have a custom one in your theme folder). Then find the <?=$dynamicconverterlink?> statement and add this line on the line before it:

<div style="text-align:center;"><span id="dc_box" class="dcboxlink"></span></div>

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.

Helpdesk Modules

Refer to the Helpdesk Modules section for details.

SMS Configuration

See SMS Configuration for details.

SSL

Enom SSL

Configure and ensure you have a good connection to eNom as per the eNom configuration instructions.

(Registrar Setup, eNom page in the AWBS Configuration area.)

In the AWBS Configuration area, go to the Module Setup page, in the SSL Sales section, set Enom SSL Reselling to Active.

In the AWBS Configuration area, go to the System Options page, in the Misc, SSL Setup section, select your desired setting for 'Live SSL Processing' field. Setting this to True will process orders without your approval. If you set it to False, orders will be held in the pending queue until you approve them.

In the AWBS Configuration area, Other Package Types page, use the Add Record link to add a new package type to use for your SSL sales.

In the AWBS Configuration area, SSL Package Setup page, use the Add New link to add your SSL packages you want to offer.

Click Add New.

Check the Visible checkbox.

Enter your desired package name. No spaces are allowed in this field.

Select Enom SSL for the package registrar.

Select the package type you created above.

Enter a package description. This should be a brief description that will be used in the email correspondence.

Select the 'Enom SSL Order Activated' email template for both HTML and TEXT fields.

(be sure to view/edit that template to customize as desired before going live).

At this point, click the Save Record button to populate correctly the rest of the form.

Select the correct eNom SSL package in the Remote Product ID field.

Check the Has Signup Form checkbox.

Set the number of years for this package.

Set the retail price, Other fee, other fee name if applicable and a description for display on the order page of your website. The description can contain html code, be sure to use only single quotes instead of any double quotes that are in your code.

Click the Save Record button at the bottom of the page.

Click the Edit Form link. Add a text field for the customers to enter their ssl host. This is mostly for your reference and for the customer's reference when they are viewing their packages in their account. We recommend making this field required, as it is very helpful when trying to track down an order in the future.

Click the Save Record button.

NOTE:

Use the URL shown at the top of the Edit screen of the Other Package Type you configured for the SSL sales to place a link on your menu.

Or if you desire a direct link to order each package, use the link shown at the top of the edit screen of the SSL Package Setup page for each package.

Filling eNom SSL orders

New orders will be both in the job queue and show as pending other packages. Do not edit/alter the pending other package.

If configured to process live, the orders will be in the open queue and run automatically when the master_cron.php script runs.

If configured NOT to process live, the orders will be in the pending queue awaiting approval. Click the approve link to move the job to the open queue or the run link to process now.

NOTE: If there is a 'SOFT FAIL' at enom, that means the enom system is busy and the order could not complete. When this happens, the job will be reopened in the open queue and you'll see a message in the Return field that states; 'Enom is slow. Waiting for cert ID on next run.".

The next cron run or if the run link is clicked, the order will continue from where it timed out.

When the order processes successfully, the job will be moved to the closed queue and the status of the package in the other package manager will be set to closed.

The customer will receive the email with instructions on how to configure the cert to complete the order.

RapidSSL/Geotrust SSL

Enable GeoTrust/RapidSSL module

Go to configuration >> Module Setup >> SSL Sales section

Set GeoTrust/RapidSSl Reselling to active.

Click the Save Changes button.

Configure the GeoTrust/RapidSSL module

Go to configuraton >> System Options >> misc section

Complete the SSL Setup section with your reseller account information.

Set Live SSL Processing to true if you don't want orders to be held for approval.

Notes:

1. Email support@rapidssl.com, give them your reseller account username and ask for API access. Let them know you are running AWBS.

2. Test mode is not available. You can test by placing an order in live mode, but don't actually approve the order and it will cancel itself at your reseller account.

3. You can find the reseller ID by mousing over any of the 'Place Order' links in an active contract in your RapidSSL/Geotrust reseller account.

The value after ref= in the URL is your reseller ID.

Setup your package type

Go to configuration >> Other Package Setup section >> Other Package Types

Use the Add Record link to add in a new order type. (Or edit an existing type if not in use).

Keep user group set to Default, unless you only want the SSL products for sale to an existing user group, in which case select the group that will be able to order SSLs.

Enter a description for the type and click the Save Record button.

Setup your packages

Go to configuration >> Other Package Setup section >> SSL Package Setup

Click the Add new link.

Check the visible checkbox.

Enter the package name as desired (no spaces, avoid special characters)

Select the package type as created above.

Set HTML Activation Template and TEXT Activation Template as desired. Text email template is provided, select SSL Order Activated - Text template to use our default email template.

Set the Remote Product ID as per the product you are configuring for sale. Make sure the product you select is available via the API and allowed/available in your reseller contract at GeoTrust/RapidSSL.

Has Signup Form should be checked.

Allow Server Quantity Select should be set to 0.

Number of Years set to the number of years for this package.

Retail Price: set to the price you want to charge for this product for the number of years entered (total price, not per year).

Other Fee: enter a setup/activation fee if desired/applicable.

Enter the 'other fee' name if price entered above.

Enter a description in the text area field, can be basic html code, no html page tags please.

Click the Save button.

Review all settings, enter a display position if desired.

Click Edit Form link to view/edit order form if desired. Email address field is required as that is where their final order link will be sent. If you remove the email field, the order process will not function.

The domain name field is optional, for admin reference to assist with order tracking if needed.

Click the Save button.

Repeat above process to configure all products you want to offer.

Place order links on menu/site

To locate the correct menu link, go to configuration >> Other Package Setup section >> Other Package Types.

Click to edit the package type you setup for SSL sales. You will see a menu link to use there, copy and setup your menu link in the group1menu.php template file or if using an existing type, edit the global.php language file to edit the text on the link.

If you wish to link directly to a product for ordering, go to configuration >> Other Package Setup section >> SSL Package Setup.

Click to edit the product you want an order link for and you will see the link to use. Processing Orders/Info

New SSL orders will show up in the open job queue and run automatically (if invoice is paid) when the master_cron.php runs if configured to true for Live SSL Processing OR they will be in the pending queue if set to false for Live SSL Processing.

When a new order is processed, customer will receive the SSL Order Activated email, which will give them a unique link to the GeoTrust system for entering their CSR and completing their SSL order. Once their order is placed at Geotrust, then they will receive an approval email at the domain's admin contact email address. Once approved, they will receive their webcert via email at the email address entered at Geotrust for the SSL order.

Review email templates/settings in your GeoTrust/RapidSSL account.

It is recommended to disable the QuickInvite email, Order Acknowledgement email and the Receipt email delivery in your reseller account if selling via AWBS, as AWBS will send all those emails to the customer.

AWBS does NOT send renewal notices for SSL orders, so leave those active and configure as desired in your reseller account.

News

AWBS Default News

Most themes will display 2 public news articles on the home page and 2 private news articles on the member home page.

If the show all link on the member home page is clicked, all private news will display to the logged in user.

To add or edit news articles, login to AWBS with admin rights. Click on the News Manager link on the left menu.

Use the Add Record link at the top to add a new news article.

Click the icon to the right of an existing article to edit it.

Set new articles to Open, select public if you want it to appear on the home page of the AWBS site, select private if you want only logged in members to see it. Closed articles will not display.

Enter the topic (headline) and the news article content and save.

Note: System news is not used in the AWBS Default News system.

Basic html tags can be used, such as hyperlinks, bold tags, etc.

If you are not using a template theme that displays the news, here is the code needed to display news articles;

<?php if($userssnews=="1"){
$thispage="index";
include(WORKDIR."/includes/rss/rssinc.php");
}else{ ?>
<br><br><b>:: <?=$news[0][topic]?> ~ <?=$news[0][date]?></b>
 <br><?=$news[0][news]?>
 <br><br><b>:: <?=$news[1][topic]?> ~ <?=$news[1][date]?></b>
 <br><?=$news[1][news]?>
<?php } ?>

Adjust the line breaks and bold tags as desired, etc as per your desired look.

This example shows 2 news articles, if you want more than 2 repeat the sections shown above but increment the number in the brackets like this;

<?php if($userssnews=="1"){
$thispage="index";
include(WORKDIR."/includes/rss/rssinc.php");
}else{ ?>
<br><br><b>:: <?=$news[0][topic]?> ~ <?=$news[0][date]?></b>
 <br><?=$news[0][news]?>
 <br><br><b>:: <?=$news[1][topic]?> ~ <?=$news[1][date]?></b>
 <br><?=$news[1][news]?>
 <br><br><b>:: <?=$news[2][topic]?> ~ <?=$news[2][date]?></b>
 <br><?=$news[2][news]?>
 <br><br><b>:: <?=$news[3][topic]?> ~ <?=$news[3][date]?></b>
 <br><?=$news[3][news]?>
<?php } ?>

RSS Newsfeed System

Enable RSS News in the Configuration >> Extended System Configuration page.

userssnews set to a value of 1

To add or edit news articles, login to AWBS with admin rights. Click on the News Manager link on the left menu.

Use the Add Record link at the top to add a new news article.

Click the icon to the right of an existing article to edit it.

Set new articles to Open, select public if you want it to appear on the home page of the AWBS site, select private if you want only logged in members to see it, system is public for the RSS Newsfeed but only displays on the member home page. The system news is intended for your hosting customers so they can use the RSS news to keep up with any important information such as server maintenance schedules, etc.

Closed articles will not display.

Enter the topic (headline) and the news article content in the rss section and save.

Basic html tags can be used, such as hyperlinks, bold tags, etc. Be vary careful with special characters when using the RSS news system.

The includes/rss/rssinc.php and rssconfig.php files are open for editing as desired as well as the files within the rssnews/lastrss directory.

RSS cron: /tools/rssgen.php

   - Cron should run once daily or you can force RSS rebuild from the AWBS Utilities in the Configuration area.

   - chmod 777 the /rssnews/lastrss/cache directory to enable RSS caching

<?php
$base="http://www.yourawbssite.com";
$securebase="https://www.yourawbssite.com";
//$homeurl="";
$adminmail="admin@yourawbssite.com";
$admincopy="admin@yourawbssite.com";
$salesmail="sales@yourawbssite.com";
$salescopy="sales@yourawbssite.com";
$supportmail="support@yourawbssite.com";
$supportcopy="support@yourawbssite.com";
$billingmail="billing@yourawbssite.com";
$billingcopy="billing@yourawbssite.com";
//$companyname="";
//$companyaddress1="";
//$companyaddress2="";
//$companycity="";
//$companystate="";
//$companycountry="";
//$companyzip="";
//$companyphone="";
//$companyfax="";
//$pagetitle="";
//$pagedesc="";
//$pagekeywords="";
//$pagealign=""; //left, right or center
//$templatedir=""; //name of the template directory
//$maintmode=""; //True or False
?>

$server_designation="Unique_id";

Setting: coupons Value: 1

Coupon Code: Enter a unique coupon code with no spaces or special characters.
This is what the customer will enter into the coupon code box in the cart when they are ordering.

Coupon Description: Enter a description for this coupon. Customers will see this in their member area.

Valid Start Date: Required, enter a date in the correct date format.

Valid End Date: Required, enter an expire date in the correct date format.

# of Allowed Uses: Enter the number of times you want this coupon to be able to be used. 
If you do not want a limit, enter a 0 (zero).

Active: Check this box if you want to activate this coupon code.

Recurring Discount: Check this box if you want customers to get this discount off each term they pay for
 their recurring package in the future.

Coupon Type: Select percentage or Fixed Amount as desired.

Coupon Amount: If you selected a percentage in coupon type, enter the percentage of the discount
 in the example format.

If you selected fixed amount in the coupon type, enter the fixed amount for the discount.

Valid Package Type: Select the applicable selection as per your coupon target.

Specific Package: If you selected All Domains or Specific type package in the Valid Package Type setting,
 select the TLD or specific package you want this coupon to apply to.

$date_short = "%m-%d-%Y";
$date_long = "%m-%d-%Y %H:%M";

// date format for admin area
$date_short = "%Y-%m-%d";
$date_long = "%Y-%m-%d %H:%M";

Example: you have some web designer customers who don't want to start their own hosting business,  
you give them special 'resller' rates to utilize your hosting services for their customers. 
Create a new user group, make a new hosting order type selecting the new user group, a new set of hosting
plans reflecting the special pricing assigned to the new hosting order type, change the new user
group menu links to reflect the new hosting plans with discounted prices.

Quantity In Stock: Enter 9876 if the item/service is not based on stock quantities. Otherwise enter the number of the
 item you have to sell.
Diabled: Check if you want this package disabled.
Visible: Check if you want this package visible on the packages.php page.
Package Name: Enter a name for this package. Do not use any spaces in the name.
Package Type: Select the correct package type as per your desired package type setup above.
Package Desc: Enter a description for this package.
HTML Activation Template: Select the correct HTML email template you want sent when the package is activated.
If you don't use HTML email templates, select the one you will use for the TEXT Activation Template field.
TEXT Activation Template: Select the correct email template you want sent when this package is activated.
Has License: Check if you are using the AWBS License module and this package should generate a license.
License Key1-3: Enter license keys used for the licensing creation if applicable.
Has Signup Form: Check if you wish to setup form fields to gather information during the order process.
Has Download: Check if this package will have a download configured with it.
Has Custom Queue: Select appropriate custom queue behavour if applicable.
Download Group: Set correct download group if applicable.
Allow Quantity Select: 0 to disable, set a max number if you have stock on this item and you want a limit per customer.
Recurring Billing: Check if this will be invoiced based on a term. Leave unchecked for one time purchase.
Term: Select correct term if Recurring Billing is checked above.
Tax EXEMPT: Check if this package will never be taxed.
Retail Price: Set your price for this item/service as per what your customers will pay on the site.
Other Fee: Set a price for an other fee, such as setup fee, etc.

Example of how the download groups are used: If you have a package that needs 5 downloadable files,
put all 5 of those downloads into one download group and assign that package to use that download group.

Category: Select the correct category for this download.
Group: Select the correct download group.
Active: Check if this is an active download.
Free file: Check if you want all customers to see this, regardless of their active packages.
Archive Record: Check if you want to archive this, will put the download into the Download Archives area of the member
 download area.
Release Date: Set the release date of this download. This date can be used to limit the download availability to only
 those with active support. (will be a new field in the other package if you have it set with Has Download checked)
Pathname: Enter full path to the file. (Not the filename, just the path to it's location.)
Filename: Enter the filename of the file. 
Description: Enter a description to be viewed in the member download area.