Install the Jamroom Ad Manager
 |
Note: As of Jamroom 3.3.x, the Jamroom Ad Manager has been integrated into the Jamroom core as part of the Jamroom Payment Pack. This installation guide only applies to users running Jamroom 3.2.x and older. All 1.x versions of the Jamroom Ad Manager WILL NOT run on Jamroom 3.3.x. |
Overview
The Jamroom AdManager is a new Advertisement Management System designed specifically for Jamroom to make it easy to display and manage advertisements for your Jamroom. The system allows the master admin and admin-selected users to create advertisements, set up advertisement types and categories for the advertisements, and track advertisements clicks. The Jamroom AdManager also gives the master admin to create Advertisement Quotas that can be used to limit the number of advertisements users in that Advertisement Quota can create, as well as control other settings. Advertisements in the Jamroom AdManager are displayed in templates using the {jr_advert} smarty function.
The Jamroom Ad Manager is available as a special download from the Jamroom Marketplace "Add-Ons" section:
Download the Jamroom Ad Manager from the Jamroom Marketplace.
Uploading the Required Files
Installing the Jamroom AdManager is a fairly short procedure, and shouldn't take longer then a few minutes to get setup and start creating advertisements. Please make sure and follow these directions in order to ensure the Jamroom AdManager is setup and properly enabled in your Jamroom.
- The first step in the install is to make sure and download the latest version of the Jamroom AdManager from the Jamroom Marketplace download page.
-
Next, uncompress the downloaded archive (it will be named something like "jamroom-admanager-1.0.0.zip" - note that the version number may be different) into a folder on your local hard drive. You will see that a sub-folder is created that is named the same as the download - i.e. “jamroom-admanager-1.0.0”.
-
Next, upload the contents of this folder directly in to your Jamroom directory, using an FTP client like FileZilla. If uploaded correctly, you will see the scripts from the AdManager are now inside your Jamroom directory - i.e. “jamroom/advert.php”. You do not need to worry about overwriting any files already installed in your Jamroom, since all of the files in the Jamroom AdManager do not exist in your Jamroom install.
All of the files required by the Jamroom AdManager have now been installed.
Creating the Jamroom AdManager admin and user buttons
Now that you have installed the Jamroom AdManager, the next step is to create a link to the AdManager control panel that can be used by the master admin and select users.
- First, we want to create a Custom Button that will be displayed in the Master admin control panel that links to the Jamroom AdManager:
- Click on the "Create Button" link from the Jamroom Config menu, and enter the following values:
- Button Label - enter "AdManager" (or whatever text you would like to appear on the button).
- Button URL - enter "advert.php" for the URL
- Button Quota - select "Master Admin Only"
- Save your new Custom Button by clicking on the "Create Button" submit button.
- Now, when logged in as the master admin, you should see an "AdManager" link in the Extras section of the Master Admin menu.
- After you have created the master admin AdManager button, create a second button using all of the same settings above, except change the Button Quota setting to the quota (or quotas) that you want the AdManager button visible to.
Installing the Jamroom AdManager
After you have uploaded the files for the AdManager, you will need to initiate the AdManager database installation.
- Click on your new AdManager button. You will be prompted to install (or validate if you have recently upgraded) your AdManager.
- Once the install has completed, you will be notified on screen. Click the Refresh link, and you will be directed to the AdManager control panel!
- Next, you will need to create a new User Custom Form field if you would like to allow users to contribute advertisements to your system:
- Click on the Jamroom Config button in the admin control panel, and then click on Custom Form Fields
- Click on User Profile
- Create a new field at the bottom of the screen:
- Enter USER_ADVERTISER_QUOTA for the title
- Change the type to Input Field (admin only)
- Save your new new field by clicking on the "Save Changes" button.
Congratulations! The Jamroom AdManager is now successfully installed! You can begin creating advertisements!
Using the Jamroom AdManager
Now that you have installed the Jamroom AdManager, and created the Button link, the next step is to create your advertisements.
After clicking on the AdManager button, you will be presented with the Advertisement Management screen for the AdManager control panel, which allows you to view all of the advertisements for your system. While in this screen, you can create and modify advertisements, as well as sort and/or filter your advertisements by any category.
 |
Note: the master admin can always see all advertisements for all users. Users will only be able to see their own advertisements. |
To create a new advertisement:
- From the Advertisement Management screen, click on the Create Advertisement button
- Enter the following information for your advertisement in the appropriate fields:
- Advertisement Name - an identifying name for your advertisement
- Advertisement URL - the url you would like the advertisement to redirect to
- Advertisement Content - the content of your advertisement (HTML is permitted)
- Advertisement Description - a description for your advertisement
- Advertisement Type - the type of advertisement, i.e. banner, skyscraper, text, etc.
- Advertisement Category - the category of the advertisement
- Status - the status of an advertisement (approved, pending, denied) - Only advertisements that have been approved will be available to be displayed in your templates. The admin will also see a comment field if viewing a user-created advertisement that can be used to explain why an advertisement has been denied.
|
Note: Admin-created advertisements are always automatically approved. If you would like all advertisements to be approved (including user-created advertisements), you can do so in each Advertisement Quota |
- Save your new new field by clicking on the "Save Advertisement" button.
Managing Advertisement Quotas:
- From the Advertisement Management screen, click on the Manage Advertisement Quotas button
- To create a new Advertisement Quota, click on the Create Quota:
- Advertisement Quota Name - an identifying name for your new advertisement quota
- Advertisement Quota Description - a description for your advertisement quota
- Advertisement Quota Max Ads - the maximum number of advertisements a user in this advertisement quota can create (use 0 to allow an unlimited number of advertisements)
- Require Admin Approval - set to "Yes" to require the admin to approve all user-created advertisements; set to "No" to automatically approve all user-created advertisements
- Save your new new field by clicking on the "Save Advertisement Quota" button.
Allowing users to create advertisements
Now that you have successfully set up and configured the AdManager, you can begin to allow specified users to create their own advertisements.
- From the admin control panel, click on the Modify User button
- Search for and select the user you would like to permit to create advertisements.
- Find the User Advertiser Quota field, and insert the Advertisement Quota ID you would like that user to be a part of.
- Save User's Advertisement Quota by clicking on the "Update User" button.
The selected User will now be able to create their own advertisements!
Changing the Advertisement Click Timer settings
By default the timer for an advertisement click to be counted is 180 seconds, or 3 minutes. To change this:
You're all set! You can now begin creating system advertisements and allowing your users to create their own advertisements!
|
