Banner Manager

Description

The Banner Manager plug-in is a full Ad Server plug-in for images, HTML and flash banners, as well as serving AdSense or other 3rd party textual/image ads. It will help you easily organize, show and track statistics for ads/banners on your Vivvo website.

All banners can be a part of a zone, for easier grouping and displaying on different areas of the webpage. A zone consists of a banner or number of banners in different areas on the webpage. In case you add more than one banner to a zone, they will rotate randomly.

After creating a zone with banners or integration code, the code for including zones on Vivvo website is automatically generated and you only need to paste it on desired place in you template files.

How to Install?

This plug-in can run properly only with Vivvo v4.0.3 or later.

You need to access the Plug-ins section. Click on the Plug-ins link which is located in Main menu at the top of your administrator panel.

menu

You should have all the installed plug-ins listed on your left-hand side.

left menu

A list of all plug-ins currently registered to the system is displayed on the right hand side of the screen.

right menu

To install Banner manager plug-in you need to click on the install icon on the right side of the plug-ins name.

Banner manager install

This will take you to the page with the installation link: Click here to Install the plug-in

Banner manager install step 1

After you run the installation, you will be informed that the plug-in was successfully installed.

You may easily go back to the Plug-ins page, by following the link: Click here to go to Plug-in

Banner manager install step 2

How to Uninstall?

To uninstall Banner manager plug-in you need to click on the uninstall icon on the right side of the plug-in name.

Banner manager uninstall

This will take you to the page with the link for uninstall: Click here to uninstall the plug-in

Banner manager uninstall step 1

You will be informed that the plug-in was successfully uninstalled and you may return to the Plug-ins page by clicking the link: Click here to return to Plug-in home page.

Banner manager uninstall step 2

Access

The path to the Submit story plug-in:

Click on the Plug-ins link (which is located in Main menu at the top of your administrator panel).

Choose Banner manager from the list of all installed plug-ins (on the left side of the screen).

User level

This plug-in can be accessed only by users with administrator-level privileges.

Actions

Quick link tab

This is the main tab that will be opened any time you access the plug-ins page.

Banner manager quick link

Add new banner - Loads the three-step wizard, which will lead you through the process of creating a banner and adding to one of your zones.

Show all banners - Opens the window with all existing banners. You can delete, edit, preview banners, change the status, reorder banners or move them to the other zone.

Add new zone - Loads the form for creating a new zone where your banners will be placed and grouped for displaying.

Add new integration code - Loads the form for adding integration code (AdSense for example).

Zones tab

Open Zones tab if you want to add a new zone or to preview and edit previously added zones. The same is doable with integration code.

Banner manager zones

Search tab

Use search tab to search through your banners entering some criteria. You can search by:

Banner manager search

Name - enter the name of the banner you are looking for. You may also enter a part of its name if you are unsure about its full name.

Search in zone - you may want to perform search only through one particular zone

Banner lifespan - refine search by banner lifespan

Search status - search only for active or inactive banners

Search categories - search for banners displayed in some particular, or a few categories (use ctrl+click for selecting more than one category)

User - show in results banners owned by one particular user

Click on the Search now button to get the results.

Statistics tab

In this tab you can generate statistics for your banners activity.

Banner manager statistics

Quick date - the fastest way to generate statistics for the last week, month or a year with only a click

Date from and Date to - generate statistics for some particular time period

Choose - preview statistics for one banner only or statistics for the whole zone

Banners - you can directly select from the list of all previously created banners

User - generate statistics for particular owner

Download as .csv file - check this box if you want to save generated statistics on your hard drive

When you selected all desired criteria click on Generate statistics button.

Add new banner

Click on the Add new banner link from the Quick links tab to open the Step 1 where you will select some basic information about the banner you want to add:

Step 1

Add banner step 1

Name - enter the appropriate name for your banner. This field is required.

Zone - select from a drop-down menu one of previously created zones or leave the banner independent. You can later move the banner to another zone.

User - enter the name of person who owns this banner

Target - select if you want a new window to be opened on a click or not

Link - enter the link for your banner

Banner type - select the format of the banner. It can be image (JPG, JPEG, GIF, PNG), flash (SWF) or HTML code.

Banner lifespan - determine criteria for banner expiration. The banner can show for unlimited period of time, it can be removed on a specific day, after a number of clicks or impressions.

Click on the Next button to continue. The Step 2 where you add the banner and set its lifespan will show up, it differs depending on type of banner and lifespan selected in previous form.

Step 2

If you get any error when uploading banners, you need to delete /banners folder located in VIVVO_ROOT/files/ from your server and create it manually. This issue is related with PHP mkdir function that depends on Apache user privileges - that user owns newly created folder so you cannot manipulate it.

If your banner is in image format:

File - browse an image from location where it is stored

Add image banner


If your banner is in flash format:

File - browse an SWF file from location where it is stored

Convert - check this box if you want banner that contain embedded links to be converted into Vivvo CMS format. If you do not want to convert banners they will still work properly but the statistics for this banner will not be generated.

Add flash banner

Width - enter the width of the banner

Height - enter the height of the banner


If you banner is HTML code:

HTML - enter or paste some HTML code

Add HTML banner

Start date - enter the date (using appropriate date format) when the banner begins to show up on your website

Start date


If you selected date as a lifespan criteria:

End date - enter the date (using appropriate date format) when the banner should stop showing on the website

End date


If you selected clicks as a criteria:

Number of clicks - enter the number of clicks before the banner expires

Number of clicks


If you selected impressions as a criteria:

Number of impressions - enter how many times the banner will show up on your website before it expires

Number of impressions

Click on Next button and you will be provided to the Step 3 where you select categories and status.

Step 3

Add banner step 3

Category - select a category where your banner should show up. You may also select more than one category using ctrl+click.

Status - select if you want your banner to be active or inactive.

Click on Save button and the message "Banner is added successfully" should appear.

Show all banners

To have a possibility to change some banner preferences, change status, preview or delete it you need to click on Show all banners link on Quick link tab.

Preview banner Preview banner - To have the banner previewed in the pop-up window you just need to click on the preview icon on the right side of the banners name.

Edit banner Edit banner - To change banners preferences, choose the edit icon next to the preview banner icon. The form that follows is identical as for creating banner. By clicking Save button on the last step, all changes for selected banner will be saved and applied.

Delete banner - You can permanently remove banner by checking the box next to its name and selecting Delete from 'Select action' drop-down menu. You can also delete more than one banner at the same time.

Add new zone

Loads the form for creating a new zone where your banners will be placed and grouped:

Add new zone

Name - enter the name for your zone

Status - set status of the zone to active or inactive

Click on the Save button and if you properly created a zone the message: "Zone is added successfully" will appear.

Add new integration code

You can add integration code zone with AdSense code for example.

Add new integration code

Name - enter the name for integration code

Code - paste the code from your AdSense (or some other) account

Status - set status of the integration code to active or inactive

Edit zone

Open the Zones tab and from the list of previously created zones click on the name of the zone you want to edit. You can copy generated code for integration to your template pages, change the name and status of the zone, delete it, preview banners in this zone and remove them from the zone (it will not be removed from the system).

Edit zone

Edit integration code

To preview or edit previously added integration code just click on its name in the Zones tab. You can copy generated code for integration to your pages, change the code, its name and status or delete it.

Edit zone

Use generated code in templates

After Banner manager has generated code for a zone, you need to paste it in your template file to have banners showing and rotating on your website. You may insert infinite number of zones to show in different pages and areas of your pages.

You can learn how to change template files referring to our User manual.

Commonly used templates we recommend for banner placement are: homepage/default.tpl (show banners on the homepage), article/default.tpl (show on the article pages), category/default.tpl (show on category pages).

Get additional help on template files and explanation of template system in the Developer manual.