Joined: 20 Aug 2003
Posts: 5341
Location: Nottingham, UK
Posted: 03/09/10 10:07
Jamroom Acclaim Module
Revision History
* 06/03/10 V1.0.0 Original Release
* 17/08/10 V1.0.1 Bug fix to the 'total vault sales' calculation
Overview
* paAcclaim is a Jamroom Module that can be installed on Jamroom systems version 4 and above
* The module calculates Artist and Member popularity, or their 'Acclaim' by calculating a value between 0 and 100 based on a number of parameters
* The current list of parameters optionally included is Song Hifi Streams, Song Hifi Downloads, Song Lofi Streams, Song Lofi Downloads, Video Streams, Video Downloads, Fans, Vault Items Sold, Page Views, Comment Count and Rating Count
* All of the above parameters are individually 'weighted' by admin so that the results can be tailored to the site's objectives. Overall Member and Artist results can also be scaled
* The basic calculation is to get the site's maximum value for each parameter, then position every Artist/Member based on that maximum value, summed for every parameter
* The result and position for each Artist/Member is stored in custom fields in the band_info table so that it can be included as part of a normal ranking call
* Daily results for all Artist and Members are archived in another custom database table and module ranking is included so as to show this table, or parts of it, on your site
* As well as normal Jamroom ranking calls, this module accepts 'date' (YYYYMMDD or Unixtime) and 'belting' (see below)
* The module performs this calculation for all artists and updates tables daily
* Configuration tools are included to allow site admins to optimise the weightings and scaling
Module Installation
* Copy the paAcclaim.php file and the 'modules' folder to your Jamroom directory
* Log into Jamroom as admin, go to the Module Config page and enable this module
* Installation should now be complete, however, if not running Jamroom V4.1.5 or later, you may need to run the Integrity Check to install this module correctly
Upgrading This Module
* Overwrite all your previously uploaded module files with those in the latest release.
* Log into your Jamroom site as 'Admin' and if prompted to do so, run the Integrity Check
Module Configuration
* Click on the Settings link for this module in the module configuration page to go to a page where you can configure all aspects of this module
* Configurable options are weighting values, artist/member scaling, and 'belting' settings
* The configuration page is self documented. Check the help links associated with all option fields for full details of option functionality
Database Schema
* This module adds three fields to the settings table and two database tables
Module Usage
* In your skin and theme templates use {jr_ranking ....} as in the following example -
* {jr_ranking mode="paAcclaim" order="6" show="10" date="20100303"} - Returns the top ten on 3rd March 2010
* order values are 1 - Acclaim Value DESC, 2 - Acclaim Value ASC, 3 - Date DESC, 4 - Date ASC, 5 - Position DESC, 6 - Position ASC
* You can also use {jr_ranking mode="band" ....} to get at the band_acclaim and band_acclaim_position fields in the band_info table
Belting
* These are 'Acclaim Belts' that you can set up in the module configuration and consist of a name, upper and lower limits
* Once set, use belting="Belt Name" in the paAcclaim ranking call to return artists/members within those limits
Buy
Visit the Jamroom Marketplace to purchase and download this module.
The PaAcclaim Module is licenced per Jamroom installation, ie. you may install the purchased copy on one Jamroom site only.
Questions?
* Post any questions etc. here on the Module's Jamroom Forum Thread
Joined: 01 May 2009
Posts: 619
Location: NastiNati
Posted: 03/10/10 10:42
I would be interested in this but in the demo i did not see nothing for Vault Items Sold ... That would be the main feature i would need ... And i am imaging the other varibles could be removed in the row.tpl?
Joined: 20 Aug 2003
Posts: 5341
Location: Nottingham, UK
Posted: 03/10/10 11:46
beazyboy:
I would be interested in this but in the demo i did not see nothing for Vault Items Sold ... That would be the main feature i would need ... And i am imaging the other varibles could be removed in the row.tpl?
I've updated the Control Panel screenshot on the demo site to show the vault sale controls.
Yes - to show vault sales you'd need to edit the 'row_template.tpl' and use a mode="vault" ranking call. The Acclaim variables in the band_info table would still be available for display.
hth
Pa
Joined: 01 May 2009
Posts: 619
Location: NastiNati
Posted: 08/06/10 08:58
I just purchased this module ... i need some help setting this up, I would like to display top selling artist ... i am not understanding how to configure the belting or artist scaling, i set Vault Items Sold to 100 and everything else to 0... tried playing with the settings and the results are always incorrect ... I already checked out the demo site, but what im trying to do isnt really explained on there, a detailed example would be highly appreciated , Thank You
This is what im trying to achieve but in descending order , I have no clue what order this is... I have Artist Scaling set to 100 ... and all options are set to 0 but Vault Items Sold which i put at 100
Joined: 20 Aug 2003
Posts: 5341
Location: Nottingham, UK
Posted: 08/08/10 04:43
Hi
Sorry for the delay - I'm away on holiday and have just quickly checked in, but no time to look into this properly. Please give me another day or so.
Thanks
Pa
Joined: 20 Aug 2003
Posts: 5341
Location: Nottingham, UK
Posted: 08/17/10 10:45
Version 1.0.1 released.
Bug fix to the 'Total Vault Sales' calculation part of this module.
Thanks to beazyboy for his help in fixing this.
All users of this module can download the latest version from the Jamroom Marketplace.
Cheers
Pa
Joined: 20 Aug 2003
Posts: 5341
Location: Nottingham, UK
Posted: 03/27/11 21:30
Ah yes - Looks like that should have been taken out of the demo page.
IIRC during development of this module I included a slightly modified copy of the jr_graph function in order to show graphical results. But ultimately I didn't include it in the 'commercial' package as I didn't want to sell on what was basically a JR core file.
If you need this as part of the module, let me know and I'll advise you on how its done.
hth
Pa
