Difference between revisions of "AWBS Configuration Guide"

Revision as of 13:40, May 19, 2008

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

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.

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.

Helpdesk Modules

AWBS Internal Helpdesk

In the AWBS Configuration, Module Setup page, make sure you have the Internal Helpdesk selected.

In the System Options page of the configuration, make sure you have 'internal' as the Support Desk Link setting.

Any time there are any open tickets in the system, you will see the Open Support checkmark flashing red on the admin home page. Click that link or use the helpdesk link on the left menu to enter the helpdesk.

Tickets awaiting a response from your support staff will be green in color. Tickets that have been answered are red.

Click the icon beside any ticket to respond. Click the various links at the top to sort as desired.

Using the close link to the right of a ticket will close it without any response or email being sent to the client.

Use the Helpdesk Response Setup link on the left menu to setup responses that are commonly used repeatedly to save your staff time.

Each admin user can setup a signature that will be added to all their responses in the helpdesk. To setup a signature, go to the user manager, select that user and enter the user's record, click the Edit link in the client information box and you will find a place to setup the helpdesk signature.

Anytime a ticket is opened, responded to, or closed via the cron (system options, auto close tickets), the user will receive an email and the support copy-to email account (from company info page of configuration) will receive an email.

Note: Avoid using the browser's refresh key while in the helpdesk, it can make duplicate entries.

As of AWBS version 2.4.0, email piping is supported.

To setup helpdesk email piping:

Setup an email forwarder from your email address configured as support email in the Company Info page of the AWBS Configuration.

Forward the email to your includes/getEmail.php file.

Example: | php -q /your/path/to/awbs/includes/getEmail.php

In the Extended System Configuration, add this key:

   key: namakecf

   value: 1

   description: All emails to pipe that cannot be inserted into the

helpdesk will be put into the contact form table

The E-mail Piping will forward e-mails received at the support email address to the Helpdesk if the sending email address matches any AWBS user account email primary email address.

Any E-mail that arrives that does not have a matching e-mail address will be piped to the Contact Us form if the namakecf key is set to a value of 1.

cPanel Specific Instructions:

1. Login to cPanel and go to email forwarding

2. Click Add Forwarder

3. Set the first box to the mail box configured as support mail in the Company Info page of the Configuration area of AWBS.

4. Set the second box to "| php -q /your/path/to/awbs/includes/getEmail.php" (without quotes - substitute your correct path)

5. If you wish orphan emails to be entered in to the contact form area,

add a new Extended System Config key:

   key: namakecf

   value: 1

   description: All emails to pipe that cannot be inserted into the helpdesk will be put into the contact form table

Cerberus Helpdesk Module

Cerberus Configuration:

From the includes/cerberus directory of your AWBS files, you will find cer_plugin.login.awbs.php, importfunctions-ion.php and importfunctions-zend.php files. (If running AWBS v2.2.2, you may obtain the files from http://www.awbs.com/misc_files/awbs-cerberus-plugin.zip )

If you are using the zend encoded version of AWBS, rename importfunctions-zend.php to importfunctions.php If you are using the IonCube encoded version of AWBS, rename importfunctions-ion.php to importfunctions.php

Connect to the FTP server for your cerberus helpdesk admin area (cerberus-gui)

Upload cer_plugin.login.awbs.php and importfunction.php to /cerberus-api/plugins/ folder

Connect to the FTP server for your cerberus support center (cerberus-support-center)

Upload cer_plugin.login.awbs.php and importfunction.php to /cerberus-api/plugins/ folder

Login to the cerberus Admin Area (cerberus-gui)

Goto Configuration

Click Support Center

Click Plugins**

Click AWBS login handler

Set enabled to True

Enter the mysql details that it requires

Click Submit

Click on Configuration

Click on Support Center

Click on Profiles

Click on the profile that you want to use with the AWBS plugin

Select AWBS from the login drop down box

click Submit

• • You should take note of your Plugin ID here to save time.

AWBS Configuration:

In the Module Setup page of AWBS Configuration, enable Cerberus. Save.

In the AWBS Configuration, System Options page, complete the Cerberus Setup section. If you do not have a database prefix, leave the 'Cerberus DB Prefix' field empty.

For Cerberus Plugin ID;

Login to your Cerberus Helpdesk, click the configuration link on the top menu, click the Support Center link on the left menu, click the Plugins link on the left menu. Locate your 'AWBS v2.x Login Handler'. Your plugin ID is the number of the Plugin, i.e. if you have 5 Plugins, and the 'AWBS v2.x Login Handler' is the 5th one from the top, the Plugin ID is 5. If it is the first plugin you have it will be Plugin ID 1. Testing:

To test, simply login to your AWBS site as admin and click the helpdesk (or Open Support) link. You will then be logged into Cerberus as the Plugin user. Your customers will be logged into the Cerberus system when they click the support link(s) on your site.

Kayako Helpdesk Module

In the kayako/includes/LoginShare directory, you will see a file called awbsimportfunctions.zip . You need to unzip this to a temporary directory, and change to your encoded directory (zend or ion). In there you will see a file called importfunctions.php . Move that to the kayako/includes/LoginShare directory, and call it awbsfunctions.php . Without this, you won't be able to use the LoginShare properly.

Now, go to your kayako/admin panel . Click on Groups, then the settings icon for the group you want to use. In most cases, it will be default. In that window, change the LoginShare setting to use AWBS

Still in your kayako/admin panel, go down to LoginShare . Click on AWBS and fill in the important stuff there (db host, pass, login, all that).

Next, in your awbs admin area, go to configuration >> modules setup. Change Kayako from disabled to active.

Next, go into your configuration >> system options . In there, you will now see a kayako area. Make sure you fill that out completely and properly.

Next go into your admin's user account. Click on change contact information, and at the bottom, you will see the user's kayako information. Make sure that this is set appropriately. You will need to do this with each admin you want to have access to the helpdesk.

Keep in mind, as well, that you need to create those admin users that you're assigning to helpdesk logins. Otherwise, the login will (obviously) be rejected.

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.

Payment Processing Modules

Refer to the Payment Processors section for details.