Electronic Manual - AdvertisingSuite
© SunnyScript - www.sunnyscript.com

 
Table of contents
 
Installation and configuration [go] Directory structure
[go] File transfer to the server
[go] Configuration
Overview about website advertisements [go] Ad banners & Co.
[go] Beginner's questions
Administration panel [go] Admin menu
System implementation [go] Edit AdvertisingSuite parameters (part 1)
[go] Edit AdvertisingSuite parameters (part 2, payment methods)
[go] Manage site zones - overview
[go] Manage site zones - available settings
[go] Manage banner formats - overview
[go] Manage banner formats - available settings
[go] Implement banner slots to websites
Ad space management & advanced features [go] Ad banner content
[go] All about advertisers
[go] Disabling the advertiser lounge
[go] Keyword targeting
[go] Custom geographical zones
[go] Additional admin tools - statistics
[go] Manage system tables - restructure table, table parameters & layout
Office tools management [go] Manage the office behind
[go] Order and payment tracking
[go] Invoice management
[go] Table of daily statistics
[go] Send out mailings
[go] Database import and export tools
Advertiser lounge and template management [go] Access the advertiser lounge
[go] Advertiser lounge - basic overview
[go] Advertiser lounge customization with templates
[go] Available templates
[go] Customization of templates
Helpful hints and technical reference [go] Background processes
[go] Ad banner delivery vs. system resources
[go] Banner format creation
[go] Time based advertisements
[go] Banner selection and ranking criteria
[go] Affiliate management with YourAffiliates
[go] Forgot your admin password ?
[go] Advertiser lounge and template translations
[go] Advanced search features
Customer services [go] Need help ? Contact the SunnyScript service department !

Smart tip: This handbook is also designed to be printed... set your printer's page orientation to landscape format, so there is enough space to place hand-written notes on the left and right margin easily.
 


 
Installation and configuration
 
SunnyScript offers an optional available installation service, if you don't want to install the software yourself.
Please contact our customer service department by e-mail for detailed information and pricing.
 
Directory structure...

The software can be installed at any place that allows the execution of CGI software: Most server systems provide a special directory called "cgi-bin" where you have to install the application, while others are not limited to a particular location.

In a common environment, we recommend to create a new sub-directory within the existing "cgi-bin" folder to separate the software from other already installed products.

Required "template.en" directory:

Inside the directory you desired for installation, please create a new sub-directory called "template.en". It's used to hold the content of "template.en" directory delivered with your software package.

Required "data" directory:

Inside the directory you desired for installation, please create a new sub-directory called "data". It's used to hold the content of "data" directory delivered with your software package.

Adjust path to Perl:

Open all program files (*.pl and *.cgi) in a text editor and change the first line "#!/usr/bin/perl" that it reflects the correct path to Perl 5 (or higher version) on your system. This is required to let your server know where the Perl interpreter is located.

Usage note: On most systems, /usr/bin/perl is already the default path to Perl and so no modifications are required.
 

File transfer to the server...

Upload all files to the created directories. If a ftp client is used, ensure to set the "ASCII transfer mode" for file submissions.

Detailed file table: Scheme: [filename | suggested place to upload (short description); file permission]:
 
Filename...
Description...
Filename...
Description...
* cgi-bin (program & data files); 755 template.en/* template.en (templates); 666
    data/* data (basic data files); 666

Important notes: Please double-check file permissions and transfer mode, otherwise the software may not work as intended. Depending upon the server configuration, different file permissions than the ones stated above may be necessary.

Smart tip: Our installation helper install.cgi makes it easier... just call it from your web browsing software (requires correct installation of this script) and it automatically checks your entire installation, adjusts permissions and fixes typical errors.
 

Configuration...

After you have uploaded all files, you may wish to start the admin panel first time to initialize the system parameters. In order to do so, please call admin.cgi with your favorite web browsing software:
 
Action to perform...
URL to call (location varies on your system, of course)...
Open admin panel http://www.sunnyscript.com/cgi-bin/as/admin.cgi

Before you proceed, it is highly recommended to set an administration password. After this is done, access to the admin panel is granted only by using "admin" as login together with the chosen password.

Now click on the button "Edit system parameters" and configure the shown parameters according your needs.

Usage note: Since all parameters are automatically filled with correct values, modifications on your side may not be required.

Directories and files:
 
Name of parameter to set...
Description...
CGI files directory
Example: /usr/www/cgi-bin/as
Absolute path to the location of AdvertisingSuite on your server.
"binarydata" directory *
Example: /usr/www/cgi-bin/as/bindata
Absolute path to the location that holds binary database content (ads).

* Technical note: The software tries to create this directory at a web-accessible place (certain cgi-bin locations doesn't allow to deliver multimedia content). If you experience problems in content delivery, please move it manually to a suited location.

Platform specific settings:
 
Name of parameter to set...
Description...
Mailing program (for Unix only)
Example: /usr/bin/sendmail
Absolute path to Sendmail (or compatible) application on your server.
SMTP server
Example: smtp.sunnyscript.com
SMTP server for handling mails; when left blank, the default mail application is used. This setting is required for non-Unix systems, otherwise optional.
Don't use flock
Example: Unchecked
"flock" is normally supported directly by the operating system; should it be unavailable for any reason (e.g. on Win9x, WinMe), mark this checkbox.
Don't use fork
Example: Unchecked
"fork" is normally supported directly by the operating system; should it be unavailable for any reason, mark this checkbox.
Forked process respawn interval (seconds)
Example: 60
Respawn interval for processes; recommended range: 30 to 60 seconds.
Admin e-mail address
Example: admin@sunnycript.com
E-mail address of the system administrator (e.g. webmaster).

URLs:
 
Name of parameter to set...
Description...
Binary directory URL
Example: http://www.sunnyscript.com/cgi-bin/as/bindata
URL to the location that holds binary database content.
URL of CGI files directory
Example: http://www.sunnyscript.com/cgi-bin/as
URL to the location of AdvertisingSuite on your server.
URL of checkout script (should be secure)
Ex.: https://www.sunnyscript.com/cgi-bin/as/checkout.cgi
URL pointing to the checkout part of AdvertisingSuite. In order to enable SSL encryption, change the transfer protocol to HTTPS.
URL of user's help document (optional)
Example: http://www.sunnyscript.com/myhelp.htm
URL to an optional help document (not included); may also consist of an e-mail link (e.g. "mailto:support@sunnyscript.com").

Usage note: Should contain a link to your company's terms of business, customer service details or any other related document.

Compression settings:
 
Name of parameter to set...
Description...
Use internal gzip compression
Example: Checked
Use the internal compression utility (to pack statistical reports) or unmark this checkbox and specify external utility as followed.
External compression utility command
Example 1: gzip -fq $file_from
Example 2: c:\winrar.exe a $file_to $file_from
Absolute path to a file compression application on your server.

Technical note: In some cases, the variables $file_to and $file_from are required to determine source and target files (see available literature).

External compressed file extension
Example: gz
File extension used by the external compression utility.

Various parameters:
 
Name of parameter to set...
Description...
Authentication time (in seconds)
Example: 10800
Time frame keeping user authentications active (after expiration, people must log in again); recommended range: 1 to 12 hours.

After you have verified all settings carefully, click on the button "Save parameters" to take over modifications to the system. It is also possible to bring back previous values with the "Let the script restore defaults" button.
 

Congratulations - you have successfully installed the software :-)

 
Overview about website advertisements
Ad banners & Co. ...

What kinds of ad banners are available ?

Image based ads:

This is the most popular type of ad banners, consisting of one (animated) graphical element holding the whole ad information. Dozens of different file types are available, but GIF, JPG, PNG and BMP formats are the suited ones for advertisements.

Text based ads:

The opposite to image banners are text based ones. Although they are considered as being not very eye-catching, a well-done text ad can lead to the same attention, but with a widely reduced transmission time (no large binary content).

Multimedia banners:

Also known as "JavaScript banners", "rich-text banners" or "interactive banners", combining graphical and text based elements mostly together with any kind of interactive content (like miniature forms or "mouse over" actions).

3rd-party banners:

AdvertisingSuite manages the ad space as well as the content delivery - but in some cases you may wish to show ad banners from other sources, like link exchanges or commercial services.

Which banner types / dimensions are the right for my website ?

This decision is fully up to yours: AdvertisingSuite is not limited to a particular banner type for a specific slot (ad space); so if it is requested by your advertisers, a multimedia banner can be placed in the same slot a text based one was shown before.

Where on my website should I place ad banners ?

On smaller websites, banner slots placed at the pages' top and bottom can do the job fine. Larger or complex sites may make it recommended to create different site zones seen on popularity, visibility and content perspectives.

Each site zone comes with its own preferences regarding banner placement and charging methods (e.g. ads on the index page are generally more expensive than such on sub-pages).

Tip: You achieve higher click-through rates (and satisfied clients) when placing not more than two to five banners per webpage; otherwise it becomes too overloaded and visitors will pay less attention to each single advertisement.

Can I serve different websites (located on different servers) ?

Yes, AdvertisingSuite is able to deliver banners to multiple websites, even if they are not located on the same server. So this entitles our software also to work as an ad server for smaller networks.
 

Beginner's questions...

How to implement AdvertisingSuite-powered banners to my website ?

Banner slots are easily added by placing some HTML tags to your documents; a HTML generator tool can create these codes automatically to make the entire task convenient and to avoid spelling errors.

What is the advertiser lounge ?

The advertiser lounge is used to allow your clients managing their ad campaigns (including payment handling).

However if you desire to manage the ad space by yourself, you can also disable the usage of the advertiser lounge. For more information about all features, please refer to the chapter "Advertiser lounge and template management".

Can I also rotate images / content ?

Of course, you can rotate images as well as any multimedia content, like product spots (e.g. to point out a particular highlighted article or service) and clickable headlines (e.g. on news services).
 


 
Administration panel

The administration panel is a convenient way to work interactively with AdvertisingSuite. You can start the admin panel by calling admin.cgi with your favorite web browsing software:
 
Action to perform...
URL to call (location varies on your system, of course)...
Open admin panel http://www.sunnyscript.com/cgi-bin/as/admin.cgi

How to access the advertiser lounge (registered clients area, advertiser registrations):
 

Action to perform...
URL to call (location varies on your system, of course)...
Access advertiser lounge http://www.sunnyscript.com/cgi-bin/as/login.cgi             or
http://www.sunnyscript.com/cgi-bin/as/my.cgi
 
Admin menu...

This screen allows the following actions:
 
Main menu options...
Description...
Manage system tables
 
Table...
Description...
... of registered advertisers Database containing advertiser profiles.
... of banners Database containing banners.
... of custom geographical zones Database containing custom geo. zones.
... of daily statistics Database containing daily statistics.
... of orders Database containing orders.
... of invoices Database containing invoices.
 
Additional admin tools
 
Section...
Description...
Additional services Generate banner slot HTML codes.
Statistics View activity statistics.
 
Quick statistics View summarized system statistics.
Edit AdvertisingSuite parameters Modify general parameters and manage system preferences.
Change password Change admin password.
Other administrative features
 
Section...
Description...
Edit system parameters Modify system related parameters.
Edit templates Edit the layout templates.
Import / export data Import and export databases.
 

The top menu line provides additional selections (depending on the current system status):
 

Top menu options...
Description...
Admin Go to the main admin menu.
Settings Adjust software parameters.
Statistics Review activity statistics.
Home Browse the currently active system table.
Search Search the currently active system table.
Login / Logout Login or logout as administrator.
Moderate Approve or decline user modifications.
Restructure Modify structures and parameters of the currently active database.
Add / Clone / Update / Delete Add, clone, update or delete profiles / records.
 

 
System implementation
Edit AdvertisingSuite parameters (part 1)...

First of all you must configure basic system settings which take effect to the behavior of the software. Click on the button "Edit AdvertisingSuite parameters" when you're in the admin menu. 

General settings:
 

AdvertisingSuite asks...
Description...
Name of site Name of your website (e.g. "My sample company").
URL of site URL of your website (e.g. "http://www.sunnyscript.com"), as it will be displayed at the advertiser lounge and within mailings.
Footer to be added to each e-mail Default footer being added to all outgoing e-mails; suited especially for showing your business card or advertisements.
Date format Specify the date format applicable for the advertiser lounge.

Default setting: DD. MMMM YYYY
Example for default: 01. January 2525

Available components for this parameter:
 

Component...
Description...
Date format parts
D 2-digit day (without leading zero).
DD 2-digit day (with leading zero).
DDD Abbreviation of the weekday.
DDDD Complete name of the weekday.
M 2-digit month (without leading zero).
MM 2-digit month (with leading zero).
MMM Abbreviation of the month.
MMMM Complete name of the month.
YY 2-digit year.
YYYY 4-digit year.

Some sample combinations:

DD. MMM YYYY               -> 01. Jan. 2525
DDD, MM. D. YYYY           -> Wed., 01. 1. 2010
YY-MM-DD                   -> 25-01-01

Usage note: Additional text is taken over unmodified (e.g. "Today, DD. MM YYYY").

Security settings:
 

AdvertisingSuite asks...
Description...
E-mail blocking
In some cases you may wish to block particular e-mail addresses from creating advertiser profiles (e.g. e-mail addresses coming from free mail providers to prevent abuse).
Accept all e-mail addresses Mark this button in order to allow all e-mail addresses for creation of advertiser profiles.
Block these e-mail addresses Activate "Block these e-mail addresses" and specify a list of domains and/or e-mail addresses (one per line) not allowed to be used by people creating advertiser profiles.
IP blocking
In order to avoid abuse by known bad sources or to not consider own banner access, it is possible to block IP addresses from being counted for impressions and click-throughs.
Ignore impressions / clicks
from these IPs or segments
Specify a list of IP addresses (one per line) not counted (however banners are displayed correctly). Also partial IP addresses (use *, e.g. 123.456.78.*) are allowed.

Keep this field empty to allow all IP addresses being counted.

Bad words blocking
Prevent the usage of obscene words in advertisements set up by advertisers.
Do not accept text with
these substrings
Specify a list of words or strings (one per line) not allowed for ad banner content. The provided input is not handled case sensitive (so any kind of spelling is detected).

"Welcome new advertiser" message:
 

AdvertisingSuite asks...
Description...
Send welcome message Mark this button to send welcome messages to new advertisers.

Currency settings:
 

AdvertisingSuite asks...
Description...
Currency prefix Type in the prefix of the desired currency (e.g. "$" for usage in "$12.34 USD").
Currency suffix Type in the suffix of the desired currency (e.g. " EUR" for usage in "12.34 EUR").
Currency decimals Specify the number of decimal places in desired currency (commonly two).
Currency 3-digits separator Decide for a character you want to use in order to separate amounts every three digits (e.g. $1'499.80 USD or 2.700,40 EUR).

Admin's notification:
 

AdvertisingSuite asks...
Description...
Send receipt to admin Marked to send a notification to admin for each new incoming order.

Order logging settings:
 

AdvertisingSuite asks...
Description...
Orders log file
Required by YourAffiliates
Absolute path of the log file location used by YourAffiliates (or other compatible affiliate managers) to track sale based commissions. Leave it empty to disable tracking.

Sample setting: /usr/www/cgi-bin/ya/data/sales.db

Orders log file format Select either "New release format" or "New release format, moderated" when using YourAffiliates ("Old release compatibility" is intended for elder releases of this product).
How long keep "affiliate cookie"
on user's computer (in hours)
If you use AdvertisingSuite to place affiliate cookies (see "Helpful hints and technical reference"), then you can set the time period to hold cookies on visitor's computer.

Recommended value: 48 hours. Parameter is optional.

Order security settings:
 

AdvertisingSuite asks...
Description...
Time to keep cart on server (hours) Specify the time period, shopping carts (containing ad budgets) of your advertisers will be held in the system. Recommended range: 1 to 5 hours.

Technical note: As longer you keep the carts alive, as more diskspace is temporarily required (about 1 KB per cart).

Max. time to await payment
confirmation from card processor
It defines the time period the system waits for order confirmations from the credit card processor. Recommended value: 12 hours.

Usage note: Applicable for the payment method "Credit card real-time processing" only (described closer below).

Order restrictions:
 

AdvertisingSuite asks...
Description...
Order sub-total
Minimum order value Type in the minimum transferable amount of money per order.
Format: 12.34 (without any currency prefix or suffix)
Maximum order value Type in the maximum transferable amount of money per order.
Format: 12.34 (without any currency prefix or suffix)
Payment location restrictions
Show standard country list Select this option and a pre-defined list of countries will be shown.
Accept payments from following
locations only
Type in a list of locations from which you will accept payments. Use a two-char location code and full name separated by pipe, one pair per line.

Format: <Two-char abbreviation>|<Full location name>

For example:

UK|United Kingdom
FR|France
DE|Germany

Usage note: There is no need to keep attention to specific conventions, you can invent your own list of locations depending upon your requirements.

Payment methods: See next part of this chapter.

Advertiser control panel layout:
 

AdvertisingSuite asks...
Description...
Advertiser lounge layout
Hide "Account balance" form Mark this button to disallow advertisers checking their remaining credits.

Please refer to the chapter "Ad space management and advanced features", part "Disabling the advertiser lounge" for more information.

Hide "Deposit" form Mark this button to disallow advertisers transfering money to their accounts.

Please refer to the chapter "Ad space management and advanced features", part "Disabling the advertiser lounge" for more information.

Payment screen layout
Product name used on cart Product label shown during the checkout process and on invoices for money deposits.
Default value: "Deposit".
Menu layout
Menu items separator Characters that will appear between the top menu items (standard value: " | ").
Main menu entries Right box (available selections): Choose entry and click on "Add" to select it.

Left box (current selections): Click on "Delete" to remove an entry or use "Up" and "Down" buttons to change entry order.

Alternatively you can type in a comma delimited list of entries manually.

"Home", "Profile update", "Add banner", "Logout", "Help" entry text Labels (linking text) used for top menu entries.

You can also insert image tags according valid HTML standard. "Help" allows also an e-mail address, like "mailto:support@sunnyscript.com".

Banner rotation settings:
 

AdvertisingSuite asks...
Description...
Targeting methods allowed to users
Determine the targeting methods available to advertisers.
Allow ... hours of day targeting Advertisers are able to select the hours of day (0 to 24) for banner appearance.
Allow ... weekdays of day targeting Advertisers are able to select the weekdays (Monday to Friday) for banner appearance.
Allow  ... days of month targeting Advertisers are able to select the days of month (1 to 31) for banner appearance.
Allow  ... geo. zones targeting Advertisers are able to select the geographical zones for banner appearance.
Allow  ... site zones targeting * Advertisers are able to select matching site zones for banner appearance.
Allow  ... keyword targeting ** Advertisers are able to specify required keywords for banner appearance.
Geographical zones targeting settings
These parameters takes effect only when "Allow ... geo. zones targeting" is enabled.
Use internal database
for country-by-IP search
Mark this option to use our internal database for conversions of country and continent searches based upon IP addresses (to "translate" IPs into geographical zones).

Technical note: It is recommended to update this database on a yearly basis. Please contact our customer service department for details.

Use custom geographical zones db Enable this option to use your own database for targeting (see table of geo. zones).

* Requires that you have different site zones specified (see below within this chapter).
** Works only with compatible software; please refer to the chapter "Ad space management & advanced features".

Technical note: The admin is allowed to set all targeting methods regardless of these preference settings.

Important note: Please be careful when allowing advertisers selecting targeting methods; on low-traffic websites (about 2500 requests per day) you should enable only "weekdays" or "days of month" targeting to get satisfying results.

Surcharges for banner impressions targeting:

For each targeting method you can set a percentage surcharge which applies as soon as the advertiser will use it.
 

AdvertisingSuite asks...
Description...
Surcharge applies to Select the base for calculating targeting surcharges.
 
Available selection...
Description...
Not applicable No surcharge applies for special targeting.
Click-through charge Click-through charge as base.
Impr. and click-through charge Impression and click-through charges as base.
 
Surcharge for ... targeting (%) Type in the percentage amount charged for the concerned targeting method.

For example: "10", "2.5" or "5.99"

Mailings:
 

AdvertisingSuite asks...
Description...
Low balance warning
Sends a notification message to the advertiser as soon as its account's balance reaches a given limit.
Send "low balance" warning mail Mark this button to send out "low balance" notifications.
"Low balance" warning bottom limit Specify the amount to reach before sending warning messages; recommended range: 5 to 25 currency units (EUR, others may vary).
Format: 12.34 (without any currency prefix or suffix)
Zero balance note
Sends a notification message to the advertiser as soon as its account's balance becomes empty (banner delivery stopped).
Send "no balance" warning mail Mark this button to send out "no balance" notifications.
Critical situations alert *
Notifies you in case of technical problems by e-mail; alerts are also stored in error.log located at the "logs" directory of AdvertisingSuite (you may like to check and clear this file from time to time).
Send e-mail alerts in critical sit. Mark this button to receive alert notifications for critical situations.

Usage note: It is also possible to add e-mail addresses pointing to mobile phones or pagers, so you are notified without time loss.

Mailings to advertiser
Sends daily usage statistics to the advertiser (if requested for the concerned banner). You can select the extent of provided statistics (just summarized overview or detailed with impressions and click-through log files).

* Technical note: In order to avoid receiving too many alerts, you will only get one alert related to the same-typed error within 24 hours. However each single alert is logged for later referencing purposes.

Emergency situation handling:

In the case that a banner impression or click-through is not able to be processed for any reason (e.g. banner was deleted in the meantime), an emergency banner with a special URL is called instead of.
 

AdvertisingSuite asks...
Description...
Redirect erroneous clicks
to this URL
URL to forward people to in emergency situations.
Code (ID) of emergency
graphical banner
ID of an existing graphical banner to be shown in emergency situations.
Text or HTML code of emergency
rich-text banner
Text and/or HTML codes used as rich-text banner shown in emergency situations.

Technical note: In case that both could apply, the graphical and the rich-text emergency banner, the graphical banner has priority.

Usage notes: Do not remove the banner used as emergency graphical banner; the banner record should be marked as "owned by admin". Emergency banner impressions and click-throughs are not counted or charged to the advertiser.

Data maintenance:

Each time data maintenance runs, the following actions are performed:
 
* Process collected statistical data (will be stored in the daily statistics table).
* Clean the daily statistics table.
* Remove outdated accounts and banners.

Important note: Executing data maintenance is required and needs "fork" function to be enabled (see "System parameters"). If it is disabled due to technical limitations of the server, please follow instructions below.
 

AdvertisingSuite asks...
Description...
Store records in daily statistics table
this number of days
Number of days to keep the "daily statistics" table data stored (this table contains the processed raw data, like usage statistics).

After removal, all statistical information for the concerned time period is lost (so it is advisable to use a generous limit).

Recommended range: 180 days (~ 1/2 year) to 1095 days (~ 3 years).

Remove profiles with no or negative balance after these days Number of days to keep profiles having null or negative balances; keep the field empty in order to disable automatic removement of unused accounts.

Recommended range: 90 days to 180 days.

Data maintenance with disabled "fork" function:

Schedule the file cron_run.pl (the file is located in the software directory of AdvertisingSuite) to be ran regularly by your server (recommended scheduling: each hour). You may use Cron or your server's scheduling tool in order to manage this task.

Technical note: Even when starting data maintenance in this way, ensure to fill in the parameters above.

By the way: If you are new at scheduling server actions, please contact your webhoster for details or refer to available literature. Alternatively you may use the Cron editor we provide (call cron_edt.pl from the command line, e.g. "perl5 cron_edt.pl").

Site zones and banner formats:

Please refer to the after part after next of this chapter for more details about site zones and banner formats.
 

Edit AdvertisingSuite parameters (part 2, payment methods)...

Go to the screen "Edit AdvertisingSuite parameters" and take a look at the part "Payment methods". Alternatively you can click on "Settings" located in the upper left corner of the screen (where available).

These payment methods are accepted when allowing advertisers adding funds into their accounts via the advertiser lounge.

Offline payment:

This payment option applies, when you handle payment processing outside (orders are only taken, no invoices generated).
 

AdvertisingSuite asks...
Description...
Allow buyer choose "Offline
checkout"
Mark this checkbox to enable the "Offline checkout" payment method.
Allow buyer cancel an order Check it to allow the customer to cancel an order until order processing has started. Customers will see a "Cancel order" link on their order receipts.

If an order was cancelled through the customer, you get notified by e-mail and the field "Order cancelled" (table of orders) is set to "Yes" for the concerned order.

Usage note: Disable "User can cancel order" in the table of orders as soon as you started order processing and don't wish the customer to cancel its order anymore.

Important note: Please be careful using this option.

Send invoice:

This payment option will create a customizable invoice for each order.
 

AdvertisingSuite asks...
Description...
Allow buyer choose "Send invoice" Mark this checkbox to enable the "Send invoice" payment method.
Allow buyer cancel an order Check it to allow the customer to cancel an order until order processing has started. Customers will see a "Cancel order" link on their order receipts.

If an order was cancelled through the customer, you get notified by e-mail and the field "Order cancelled" (table of orders) is set to "Yes" for the concerned order.

Usage note: Disable "User can cancel order" in the table of orders as soon as you started order processing and don't wish the customer to cancel its order anymore.

Important note: Please be careful using this option.

Credit card real-time processing:

This payment option requires a "merchant account" registered at a payment processor. In this way, you can handle credit card payments electronically through an online payment system.

Usage note: If you process credit cards by yourself (e.g. via terminal or an electronic cash register), please refer to the payment option "Credit card manual processing" as described later.

Passing back order details from the credit card processor to AdvertisingSuite:

After a payment has been processed (no matter, if accepted or declined), the payment processor must hand over the results back to AdvertisingSuite. For this application, the program passback.cgi is intended.

Instruct your credit card processor to transfer all data to passback.cgi of your AdvertisingSuite installation:
 

Action to perform...
URL to provide to payment processor (location varies on your system, of course)...
Hand over payment processing results to AdvertisingSuite http://www.sunnyscript.com/cgi-bin/as/passback.cgi

And here you can see how to configure AdvertisingSuite to work together with a payment processor...
 

AdvertisingSuite asks...
Description...
Allow buyer choose "Credit card
realtime processing"
Mark this checkbox to enable the "Credit card realtime processing" payment method.
Generate invoice for each
transaction
AdvertisingSuite can add an invoice to the table of invoices for each single transaction.
 
Possible settings...
Description...
Do not generate Disable this feature.
Generate, but internal use only Invoice is generated, but invisible to the customer.
Generate and show to buyers Invoice is generated and link to a printable version is shown to the customer.
 
Order confirmation message
This message confirms the order arrival ("queued for processing").
Send confirmation message to user Select at which stage in order processing an order confirmation is sent to the customer.
 
Possible settings...
Description...
Send receipt in payment
confirmation message
Don't send a confirmation before payment was surely handled by the payment processor.
Send separate receipt Send an order confirmation as soon as the order arrived (payment may be not done so far).
 
Payment gateway configuration
Important note: All parameter settings described here must be provided by the payment processor; set them very carefully.
Name of credit card processor Type in the name of the payment processor.
Payment gateway URL AdvertisingSuite sends all order details to this URL for payment processing.
Payment URL request method Select the submission method (GET or POST).
Form variables AdvertisingSuite will send these variable/value pairs to the payment gateway URL.

Format: <Name of variable>=<Submitted value>
(put only one pair into a single line)

Sample 1: $cart_id=$cart_id
Submit the variable $cart_id and its assigned value.
Sample 2: account=abc123
Submit a variable called account and its fix value abc123.
Sample 3: ordertotal=$total
Take over the value from $total to a new variable.
Sample 4: name=$first_name $last_name
Put two system variables into a new one.

Different payment processors have different requirements in variable names and values being passed through to them.

The following variable names are reserved and holding system data (their values can be taken over according the samples above):
 

Variable name...
Description...
$total * Total sale amount to charge from the credit card (contains numerical value only, format: 12.34).
$cart_id * Cart ID as assigned by AdvertisingSuite.
$first_name, $last_name,
$company, $country,
$state, $zip, $city,
$address1, $address2,
$phone, $_email, ...
Various customer details, as taken from the table of registered users.

Usage note: Also custom fields you invented can be taken over by specifying their names here.

* Important note: These fields are required being submitted to the payment processor.

Payment confirmation "pass back" configuration
After the transaction has been handled (successfully or not) by the payment processor, they need to call passback.cgi in order to inform AdvertisingSuite about the payment status.
Important note: All parameter settings described here must be provided by the payment processor; set them very carefully.
Form field, which holds
shopping cart ID (mandatory)
Provide the name of the variable containing the shopping cart ID of the order (as it was originally delivered by AdvertisingSuite).

Important note: It is required to find the order belonging to the concerned transaction.

Form field, which holds
total amount paid (optional)
Provide the name of the variable containing the total amount as it was charged from the customer's credit card for the concerned order. Accepted format: 12.34.

Technical note: Leave the field empty, if this information is not available.

Form field, which holds
transaction ref. number (optional)
Provide the name of the variable containing the transaction reference number.

Technical note: Leave the field empty, if this information is not available.

Form field, which holds
transaction status (recommended)
Provide the name of the variable containing the transaction status (whether the payment was done successfully or failed).

Important note: It is recommended to let AdvertisingSuite know the payment status.

Value of successful transaction
status
Specify the value, the "transaction status" field must contain, to consider a payment transaction as being done successfully (value must match the submitted one).
Log values of passed back fields Specify a comma-delimited list of all variables passed back to AdvertisingSuite which will be logged in a special file for later reference:

Successful transactions are stored in...
data/transactions.db (suited for database or spreadsheet import)
data/transactions_readable.txt (suited for humans; convenient to read)

Declined transactions are stored in...
data/transactions_err.db (suited for database or spreadsheet import)
data/transactions_err_readable.txt (suited for humans; convenient to read)

Technical note: Leave it empty to disable this feature.

Payment confirmation security
Important note: All parameter settings described here must be provided by the payment processor; set them very carefully.
Allowed request method Select the allowed submission methods of the payment details (GET, POST or both).
Allowed referring URL (optional) If this parameter is set, passback.cgi is allowed to be called from a specific origin only (the URL you name here). Intended to limit access and avoid security injuries.
Action on violation of referring
URL rule (optional)
When passback.cgi is called from an other than the above specified referring URL, one of these actions will be performed:
 
Possible settings...
Description...
Accept payment, but notify admin Payment will be accepted, but a warning message is sent to the administrator.
Decline payment and notify admin * Payment will be declined and a warning message is sent to the administrator.
Decline payment * Payment is declined without notice.

* Important note: Although the payment is not accepted by AdvertisingSuite, it may be already processed - so it is recommended to use these options with care only.

If order sum and passed back paid
total sum doesn't match, then...
If the calculated order total ($total) differs from the charged amount, one of these actions will be performed:
 
Possible settings...
Description...
Accept payment, but notify admin Payment will be accepted, but a warning message is sent to the administrator.
Decline payment and notify admin * Payment will be declined and a warning message is sent to the administrator.
Decline payment * Payment will be declined without notice.

* Important note: Although the calculated amount differs from the paid one, it may be already processed - so it is recommended to use these options with care only.

Script for additional verification
of passed back values
Advanced users only: A verification script (written in Perl) can be placed in here to carry out additional checks before accepting a particular payment.

You can access variables with via $in{VARNAME} hash and access order fields (as in the table of orders) via $order{FIELDNAME} hash.

Technical note: If you push errors to @errors array, payment is declined. If you push warnings to @warnings array, payment is accepted, but a warning message is sent to the admin to notify about a possible security hazard or processing error.

Credit card manual processing:

This payment option is suited to accept credit cards for manual processing (e.g. via terminal or an electronic cash register).
 

AdvertisingSuite asks...
Description...
Allow buyer choose "Credit card" Mark this checkbox to enable the "Credit card" payment method.
Accept these pre-defined
card types
Decide for the credit cards you wish to accept; choose multiple entries by holding the CTRL key (or appropriate) when selecting.
Accept also these card types Add further credit cards for being accepted (e.g. direct debit cards or customer cards).

Format: <Card name>|<Digit length>|<MOD10 test>|<Valid prefix>

<Card name>*: Label of the credit card as it should appear during checkout.
<Digit length>*: Length of the card numbers.
<MOD10 test>: "1" to allow MOD10 check or "0" to disable it (default).
<Valid prefix>: Fix prefix of the card numbers to accept.

Examples:

My Personal Card|16|1|812
Your Card|15

* Important note: Card name and digit length are mandatory, other fields are optional.

How to store credit card numbers Submitted credit card numbers can be stored in these different ways:
 
Possible settings...
Description...
Split (Increased security) Stores one part of number in the table of orders and submits the other part with admin's order notification.
Database (Convenient way) Shows the entire number in the table of orders.
E-mail (Convenient way) Shows the entire number in admin's order notification.
 
Ask "CVV2/CVC2/CID code" Enable this option in order to request the card verification code provided by some credit card suppliers. This may decrease the risk of fraudulent orders.
Generate invoice for each
transaction
AdvertisingSuite can add an invoice to the table of invoices for each single transaction.
 
Possible settings...
Description...
Do not generate Disable this feature.
Generate, but internal use only Invoice is generated, but invisible to the customer.
Generate and show to buyers Invoice is generated and link to a printable version is shown to the customer.
 
Allow buyer cancel an order Check it to allow the customer to cancel an order until order processing has started. Customers will see a "Cancel order" link on their order receipts.

If an order was cancelled through the customer, you get notified by e-mail and the field "Order cancelled" (table of orders) is set to "Yes" for the concerned order.

Usage note: Disable "User can cancel order" in the table of orders as soon as you started order processing and don't wish the customer to cancel its order anymore.

Important note: Please be careful using this option.

Validate credit card number
with MOD10 algorithm
This verifies the syntax of provided credit card numbers according a pre-set algorithm.

Checking includes these steps:

1. Syntax verification with MOD10 algorithm.
2. Verification of the card type (each card type has special characteristics).
3. Verification of the expiration date (expired cards are not accepted).

Important note: This validation cannot give you any guarantee that the credit card is a valid one. You should not provide goods or services until the payment was processed.

Payment details by phone or fax:

This payment option is suited when using a 3rd-party payment system working with reference IDs or when you desire to get credit card details sent by fax. Following applications may be handled with this payment method:

* 3rd-party payment systems where customer receives (after successful payment) a confirmation ID that needs to be submitted by the customer to you (either by phone or fax). For example, paying by phone bill or credit card acceptance via call center.

* 3rd-party payment systems where customer pays cash and receives a confirmation ID that needs to be submitted by the customer to you for collecting payment. For example, money transfer companies or special banking transfer services.

* High-risk environments (e.g. blacklisted countries with high rates of credit card abuse) requiring you to take credit cards only by fax, perhaps together with a photocopy of the original credit card for verification purposes.
 

AdvertisingSuite asks...
Description...
Allow buyer choose "Payment
details by phone or fax"
Mark this checkbox to enable the "Payment details by phone or fax" payment method.
Generate invoice for each
transaction
SunnyShop can add an invoice to the table of invoices for each single transaction.
 
Possible settings...
Description...
Do not generate Disable this feature.
Generate, but internal use only Invoice is generated, but invisible to the customer.
Generate and show to buyers Invoice is generated and link to a printable version is shown to the customer.
 
Deduct ordered quantity from
products with limited quantity
When having products with a limited quantity (system field _quantity set in product records), mark this button to deduct the ordered quantity from the remaining total.

Please refer to the next chapter for details regarding this feature.

Allow buyer cancel an order Check it to allow the customer to cancel an order until order processing has started. Customers will see a "Cancel order" link on their order receipts.

If an order was cancelled through the customer, you get notified by e-mail and the field "Order cancelled" (table of orders) is set to "Yes" for the concerned order.

Usage note: Disable "User can cancel order" in the table of orders as soon as you started order processing and don't wish the customer to cancel its order anymore.

Important note: Please be careful using this option.

Prepaid code:

With this payment option you can allow customers to pay with a special code (e.g. issued by a telephone payment system or by yourself, like gift certificates or as activation code after arrival of cheques).

Technical note: Prepaid codes are kept in the system unless their balances reaches zero. This is done to allow your members buying prepaid codes in advance and then spend them for different subscriptions from time to time.
 

AdvertisingSuite asks...
Description...
Allow buyer choose "Prepaid code" Mark this checkbox to enable the "Prepaid code" payment method.
Enter valid prepaid codes and
corresponding amounts
AdvertisingSuite will accept the prepaid codes as specified here.

Format: <Prepaid code>:<Value>:<Expiration date>

<Prepaid code>: Prepaid code, allowed chars: A-Z, a-z, 0-9 and "-" (case-sensitive).
<Value>: Amount of the prepaid code; format: 12.34.
<Expiration date>: Date, until prepaid code stays valid; format: YYYY-MM-DD.
 

Sample input...
Description...
123-aBc:50
0987654321:9.80
star1:30:2010-12-31
50 EUR value.
9.80 EUR value.
30 EUR value; valid until 31. December 2010.

Usage notes: Unlimited code variations can be provided; any currency is possible.

If an expiration date is set, the concerned prepaid code will be removed automatically at the specified date (regardless of its remaining balance).

Generate invoice for each
transaction
AdvertisingSuite can add an invoice to the table of invoices for each single transaction.
 
Possible settings...
Description...
Do not generate Disable this feature.
Generate, but internal use only Invoice is generated, but invisible to the customer.
Generate and show to buyers Invoice is generated and link to a printable version is shown to the customer.
 
 
Manage site zones - overview...

In order to manage site zones, click on the button "Edit AdvertisingSuite parameters" when you're in the admin menu.

What is a site zone ?

Site zones divide your website (or the documents intended to place advertisements on) into different categories, each having its own preferences, like ad charges or targeting methods.

Sample applications: Site zones for top and bottom (general: high attractive, less attractive) banners, website themes and areas, site locations (index page, sub-pages).

Are site zones required in all cases ?

As you may have noticed, there is one site zone ("*") pre-defined. It is mandatory for the system, because the software must need to know what you charge for advertisements - and since this is set in site zones, you need at least one of them.

How to create a new site zone entry ?

Type in the name of the new site zone (keep it short; use alphanumerical chars only) and click on the button "Create new".

How to edit / remove a site zone entry ?

Select the site zone from the list, click on "Delete" or "Edit" and follow the provided instructions.

Usage note: Temporarily unused site zones should be limited to the admin only (see below), instead of being removed.

How to change the sorting of site zones ?

Select the one you wish to move around and click on either "Move up" or "Move down" button to change its position (this affects the site zone's position within the advertiser lounge).
 

Manage site zones - available settings...

Site zone identification:
 
AdvertisingSuite asks...
Description...
Site zone code The site zone code is the abbreviation for the site zone as used in banner slot codes (refer to the last part of this chapter to learn more about banner slots).

Use only alphanumerical characters (A-Z, a-z and 0-9).

Site zone name Name of the current site zone, as it will be displayed at the advertiser lounge.
Site zone description Short description, as it will be displayed at the advertiser lounge.
Allow only admin to place ads Mark this button in order to disable this site zone for being shown at the advertiser lounge; only the admin can place ad banners for this zone.

Technical note: In order to disable site zone selection for advertisers in general, disallow them on the screen "Edit AdvertisingSuite parameters".

Charging method:

Specify the details for charging advertisements at this site zone.
 

AdvertisingSuite asks...
Description...
Charge variable rate per 1000 impr. Charge a fee each time the banner got displayed on the base of 1000 impressions.

Format: <Cost per 1000 impressions>:<Banner format>
(put only one pair into a single line)

<Cost per 1000 impr.>: Amount of money charged per 1000 impressions.
<Banner format>: Banner format code where this charge applies.