Bunchball Developer Wiki

 

AdminUI_SiteModule

Page history last edited by Vijay Myneni 1 week ago

In this module you can administer site-wide aspects of your Nitro deployment, such as your admin password, daily point limits, levels, and security settings.  The Site Module has these main views:

 

 

General View

 

In the General View, you can configure the following properties:

  • Name - the name of your site
  • API Key - this is your API Key.  You cannot edit this, it is provided here for your reference
  • API Secret Key - this is your Secret Key.  You cannot edit this, it is provided here for your reference
  • Daily Max Credits Per User - the maximum number of points that Nitro will award each user in one day.  Set this to 0 to turn off this limit.
  • New User Points - the amount of points to start out each new user with
  • Userlink Url - if you set this, in the News Feed, user's names/images can be linked to this url.  Use the {userId} token as a placeholder for where the user's id should go.
  • Achievement Callback Url - if you set this, this page will be called anytime a challenge is completed with the response of logAction. The request to you includes a signature so that you can authenticate it. 

    apiKey=FooSite&ts=1217531601&userId=johndoe&sig=12adfccc47eca94fdf0fa43098968839&data=<?xml version="1.0" encoding="UTF-8">
<Nitro>
  <Achievements points="10">
    <challengesAchieved>
      <ChallengeAchieved name="Watched 100 videos" pointCategory="default" points="10"/>
    </challengesAchieved>
  </Achievements>
</Nitro>
     
  • User Filter Prefix - if you set this, user names starting with this prefix will be filtered out of leaderboards and news feeds
  • Catalog Buy Back % - for the canvas widget.  determines the amount of the original sale price users get back when they sell an item. (new for 1.8)

Use the Update button to save changes to any of the above fields.  Use the Undo Changes button to cancel any edits.

 

New Admin

You can create new Admin accounts using the New Admin button.  You can create full admin accounts or read-only admin accounts.  Read-only admins won't be able to make any configuration changes.

 

Change Password

You can change your password with the Change Password button.  Enter in the new password in the dialog and click Submit.

 

 

Security View

 

In the security view you can set your allowed Content Urls and your allowed IP addresses.  

 

IP Whitelist

If you specify IP addresses here, only method calls coming from those IP addresses will be allowed.  To add an IP Address, use the Add button and enter in an address in one of three ways:

  • a single IP Address, like 192.168.0.1
  • a range of IP Addresses using "-", like 192.168.0.1-100
  • a host name, like "www.bunchball.com".  This will be resolved to the appropriate IP address by the server.

 

Content Urls

Content Urls are paths to Flash content that you have explicitly allowed to connect to the Nitro Service and make Nitro server calls via the Flash Connector.  Only Flash content that you list here will be allowed to do this.  Each content url will be assigned a content ID that you can look up here.  This ID must be provided as part of the authentication process in Flash, and must match the url that is hosting the Flash content using it.  Use the Add, Modify, and Remove to manage your list of content urls.  

 

 

Levels View

 

In the levels view you can define how levels work on your site.  There are two ways you can choose to assign levels to your users:

  • Points-based Leveling - your users automatically get assigned a level based on their Lifetime Balance
  • Custom Leveling - you can manually assign levels to users whenever you want using user.setLevel

 

With either method, you can use the REST Methods to look up a user's level, the user's next level, and the list of all site levels.

 

In this view, you can also create, modify, reorder, remove and view all of your site levels.  A level has the following properties:

  • Name - the name of the level (required)
  • Description - an optional description
  • IconUrl - a url to an image that can be used to represent the level graphically
  • Points - if you're using points-based leveling, this is how many points a user needs to earn to reach this level

 

 

Level Ordering

If you're using points-based leveling, your levels will automatically be ordered by the "points" field.  If you're using custom leveling, you can reorder your levels using the Reorder button.  Just drag and drop the levels into their new ordering in the Reorder Dialog.  Level ordering will determine the result of the user.getNextLevel API method, as will also be returned as an "order" parameter by the user.getLevelList method.

 

Note: In custom leveling, before a user is explictly assigned a level using user.setLevel they will be auto-assigned to whatever the first level in the ordering is.  So if you change the ordering such that the first level changes, all the users that haven't been assigned a level yet will get the new first level.  But anyone who was explictly assigned a level using setLevel will always keep the level they were assigned, even if you re-order the levels later.

 

 

Point Categories

 

In the point categories view you can define categories to award your users points in.  See Point Categories for more information.

 

You can also create, modify, remove and view all of your point categories.  A level has the following properties:

  • Name - the name of the cateogry (required)

 

Comments (0)

You don't have permission to comment on this page.

Printable version
 
Anonymous Create an account or Log in