How To Use BadgeOS

/How To Use BadgeOS
How To Use BadgeOS 2020-01-02T10:04:51-05:00

Following are the Instructions of how to use the BadgeOS plugin

Installation / Setup Instruction:

Following are the step by step instructions to set up the BadgeOS plugin:

  • Install BadgeOS plugin & activate it.
  • You will see a BadgeOS menu under Settings.

Achievement Types:

BadgeOS lets you define unlimited achievements to award to your users’ named achievement types.

You can configure as many achievement types as you like: Badges, Quests, etc, and in each achievement type, you can configure unlimited achievements to award your users for interacting with your site.

Following are the steps to add a new achievement type:

  • Navigate to BadgeOS > Achievement types.
  • Click Add New.
  • Add Title. 

Please note that the title supports only 20 characters.

  • Add Plural Name under Achievement Type Data section.
  • Check the option Show in Menu? under the Achievement Type Data section.

  • Publish the post.

How to Add Achievement Type Gif:

Achievements:

To add a new achievement follow these steps:

  • Navigate to the desired Achievement type.
  • Click Add New.
  • Add Title and Description.
  • Add the Required Steps. Required Steps option will show if Completing Steps is selected in Earned by.
  • Points Awarded

Inserted points will be awarded of the selected point types on the earning of the achievement. All created point types shows in the dropdown.

You can also use this option to deduct the selected points type on the earning of that specific achievement. You have to insert the desired negative value for example -50 for the Point Awarded field and select the point types from the dropdown.

  • Earned by

Earned by option shows how this achievement can be earned

All Earned by options are explained below:

  • Completing Steps

Select Earned by option as Completing steps. It displays the required steps to configure the achievement.

  • Minimum Number of Points

Select Earned by option as the Minimum number of points. This achievement can be achieved when a user achieved the selected number of points.

  • Submission (Reviewed)

Select Earned by option as Submission (Reviewed). Submission reviewed achievement can be achieved by submitting the submission but it should be approved by the admin first. All submissions can be found at BadgeOS > Submissions.

  • Submission (Auto-accepted)

Select Earned by option as Submission (Auto-accepted). Submission auto accepted achievement can be achieved by submitting the submission without any need to approve the submission by the admin. All submissions can be found in BadgeOS > Submissions.

Note: User can also save their submission as a draft by clicking Save Draft and can submit later.

  • Nomination

Select Earned by option as Nomination. This achievement can be earned by nominating the user. The user who nominates another user won’t earn the achievement but the user that is being nominated earned this achievement. The nomination requires the admin’s approval before earning. All nominations can be found at BadgeOS > Nominations.

  • Admin-awarded Only

Select Earned by option as Admin-awarded Only. This achievement can be earned only when admin award this achievement to the user from the user profile.

Award from the user profile


  • Sequential Steps

Sequential steps option will display if Earned by option is completing steps. Steps should be achieved in the sequence to earn the achievement.

Now user should log in first then comment on a post to earn the achievement

  • Show Earners

If this option is checked then it will display a list of users on the front-end who have earned this achievement.

Maximum Earnings

It defines the maximum number of achievements to be achieved. Insert the value in the field so this achievement can not be achieved more than the inserted value.

Note: Leave empty or insert -1 for unlimited earning of the achievement. 

Hidden

If the selected option is Hidden to User then it will hide the achievement from the user. The hidden achievement won’t list in the Achievement list and it will also be hidden on the BadgeOS Earned User Achievement widget even after earning the achievement. The hidden earned achievement can only be seen in the user profile from the admin panel.

Allow Attachment for Submission

This option can only be used with submissions. It allows attachment on the submission if checked

Attachment file can be attached with the submission

Attachment can be found at BadgeOS > Submissions open the submission and attachment file will be placed at the end of the submission.

Allow Attachment for Submission Comment

This option can only be used with submissions. It allows attachment to the comments of the submission.

Badge Sharing Option

Configuring this section you can makes the earned badge for this achievement shareable via Credly on social networks, such as Facebook, Twitter, LinkedIn, Mozilla Backpack, or the badge earner’s own blog or site.

Follow these steps:

  • Select Yes for Send to Credly when earned field.
  • Select Yes for Include Evidence field.
  • Select Yes for Include Testimonial field.
  • Set Expiration.
  • Select Yes if you want to allow the badge to be given by others for Allow Badge to be Given by Others field.
  • Select Credly Badge Category.

Note: You can configure global settings for Credly integration from Credly Integration under the BadgeOS menu.

Required Steps:

Required Steps option will show if Completing Steps is selected in Earned by.

  • Log in to Website:

From the required steps select login to the website and insert the value in the number of times field. This will be triggered when user login and the user will be awarded this specific achievement.
Use the “Label” field to optionally customize the titles of that step.

 

  • Not Login For X Days:

From the required steps select Not Login For X Days and insert the value in the days and the number of times field. This will be triggered when the user not logged in for X define days and the user will be awarded this specific achievement.
Use the “Label” field to optionally customize the titles of that step.

  • Comment on a post

From the required steps select Comment on a post and insert the value in the number of times field. This will be triggered when a user comments on any post and the user will be awarded this specific achievement.
Use the “Label” field to optionally customize the titles of that step.

  • Comment on a specific post

From the required steps select Comment on a specific post then paste the id of the post and insert the value in the number of times field. This will be triggered when a user comments on that specific post and the user will be awarded this specific achievement.
Use the “Label” field to optionally customize the titles of that step.


The ID of the post is located in the URL of that post

  • Publish a new post

From the required steps select Publish a new post and insert the value in the number of times field. This will be triggered when a user publishes a new post and the user will be awarded this specific achievement.

Use the “Label” field to optionally customize the titles of that step.

Note: Only admin, editor and the author can earn that achievement. 

If you are using any plugin which allows all users to create the post/page from the front-end, all users can earn that achievement by publishing a new post.

  • Publish a new page

From the required steps select Publish a new page and insert the value in the number of times field. This will be triggered when a user publishes a new page and the user will be awarded this specific achievement.

Use the “Label” field to optionally customize the titles of that step.

Note: Only Admins and Editors can publish the page.

If you are using any plugin which allows all users to create the post/page from the front-end, all users can earn that achievement by publishing a new page.

  • Register to the website

From the required steps select Register to the website. This will be triggered when a user registers into the website and the user will be awarded this specific achievement.

Use the “Label” field to optionally customize the titles of that step.

  • Daily visit website

From the required steps select Daily visit website. This will be triggered on the first login of the day and the user will be awarded this specific achievement.

Use the “Label” field to optionally customize the titles of that step.

  • Specific Achievement of Type

From the required steps select Specific Achievement of Type then select the achievement type and then achievement. This will be triggered when a specific achievement of the selected type is achieved and the user will be awarded this specific achievement.

Use the “Label” field to optionally customize the titles of that step.

  • Any Achievement of Type

From the required steps select Any Achievement of Type then select the achievement type. This will be triggered when any achievement of the selected type is achieved and the user will be awarded this specific achievement.

Use the “Label” field to optionally customize the titles of that step.

  • All Achievements of Type

From the required steps select All Achievement of Type then select the achievement type. This will be triggered when all achievements of the selected type are achieved and the user will be awarded this specific achievement.

Use the “Label” field to optionally customize the titles of that step.

How to Add Achievement Gif:

Submissions:

To add the submission form, follow these steps:

  • Add New Page.
  • Click Add BadgeOS Shortcode button. A pop up will appear.

Select the Submission form from the dropdown.

  • Select any created achievement from the drop-down of field Achievement ID.
  • Click Insert Shortcode.
  • Publish the page.

Frontend:

At the frontend, a text box will appear. Where the user can submit the submission and earn the select achievement. 

All the submitted submissions of Submission Reviewed and Submission Auto Accepted Achievements can be found at BadgeOS > Submissions. Here you can Approve or Deny the submission.

Submission List:

To add the submission list, follow these steps:

  • Add New Page.
  • Click Add BadgeOS Shortcode button. A pop up will appear.

  • Select the Submission List from the dropdown.

  • Configure the options for the submission list.
  • Click Insert Shortcode.
  • Publish the page.

Nominations:

To add the Nomination form, follow these steps:

  • Add New Page.
  • Click Add BadgeOS Shortcode button. A pop up will appear.

  • Select the Nomination form from the dropdown.

  • Select any created achievement from the drop-down of field Achievement ID.
  • Click Insert Shortcode.
  • Publish the page.

All the submitted nominations from the nomination form of the Nomination Achievements can be found at BadgeOS > Nominations.

Nomination List:

To add the Nomination list, follow these steps:

  • Add New Page.
  • Click Add BadgeOS Shortcode button. A pop up will appear.
  • Select the Nomination List from the dropdown.

  • Configure the options for the nomination list.
  • Click Insert Shortcode.
  • Publish the page.

Log Entries:

All applied triggers saved as log entries on BadgeOS > Log Entries. 

To delete the log entries click Delete All Log Entries button.

Log entries can be enabled or disabled from the BadgeOS > Settings.

Point Types:

BadgeOS lets you define unlimited user points wallets named points types.

You can configure as many points types as you like: Credits, Gems, Coins, etc.

 To add a new point type follow these steps:

  • Select Point types from the BadgeOS menu and click Add New.
  • Add title and plural name for this point type.
  • Add a featured image from the meta box on the right side of the edit page.

Point Award

  • To award the points, define the required steps for this point type to be considered complete. By clicking the Add New Step.
  • Select an option from the drop-down for the Require field.
  • Enter the desired number for the Times field.
  • Click Save All Steps.

You can add multiple steps.

Point Deducts

  • To deduct the point,  define the required steps for this point type to be considered complete. By clicking the Add New Step.
  • Select an option from the drop-down for the Require field.
  • Enter the desired number for the Times field.
  • You can add multiple steps.
  • Click Save All Steps.

  • Publish the post.

You can add multiple steps.

Required Steps To Award and Deduct Point types

  • Log in to Website:

From the required steps select login to website then insert points and insert the value in the number of times field. This will be triggered when the user login.

  • Comment on a post:

From the required steps select Comment on a post then insert points and insert the value in the number of times field. This will be triggered when a user comments on any post.

  • Comment on a specific post:

From the required steps select Comment on a specific post then insert points and insert the value in the number of times field. This will be triggered when a user on a specific post.

  • Publish a new post:

From the required steps select Publish a new post then insert points and insert the value in the number of times field. This will be triggered when a user publishes a new post.

  • Publish a new page:

From the required steps select Publish a new page then insert points and insert the value in the number of times field. This will be triggered when a user publishes a new page.

  • Register to the website:

From the required steps select Register to the website then insert points and insert the value in the number of times field. This will be triggered when a user registers to the website.

  • Daily visit website:

From the required steps select the Daily visit website then insert points and insert the value in the number of times field. This will be triggered on the first login of the day.

Note: Selected points will be awarded/deducted after achieving the trigger.

How to Add Point Type Gif:

View Earned Points on the User Profile Page

The admin can view the earned points of any user on the user’s profile page.

The admin can also display the points, ranks, and achievements on the BuddyPress profile page. It requires BuddyPress plugin and BadgeOS Community add-on to be installed and activated.

Rank Type:

BadgeOS lets you define unlimited ranks that your users can reach named rank types.

You can configure as many rank types as you like: Grade, Level, etc, and in each rank type, you can configure unlimited ranks that your users can reach for interacting with your site.

Follow these steps to add a new rank type:

  • Select Rank types from the BadgeOS menu and click Add New.
  • Add title and plural names for this achievement.
  • Check Show in the Menu option.

  • Publish the post.

How to Add Rank Type Gif:

Add New Rank:

After adding a new rank type a new menu will appear in your admin area named Ranks.

Ranks are similar to achievements (Badges). The only difference is that the same achievement (badge) can be awarded multiple times while the same rank can be awarded only once.

To add a new rank follow these steps:

  • Select the created rank type from WP Dashboard > BadgeOS > Ranks, click Add New.
  • Add title and description.
  • Add a featured image from the meta box on the right side of the edit page.
  • If you want to award the rank if the user reaches a specific number of points of a specific point type, select “Yes” from the field Allow reach with points?, A new field Points to Unlock will be enabled.
  • Enter the desired number of points in the field Points to Unlock, also select the points type from the drop-down.

Rank Requirement

  • To award the rank, define the required steps for this point type to be considered complete. By clicking the Add New Step.
  • Select an option from the drop-down for the Require field.
  • Enter the desired number for the Times field.
  • Click Save All Steps.
  • Select the rank priority from the Rank Details meta box,  if you set to “0” it will be awarded to all the users as a default rank. The rank priority defines the order a user can achieve ranks. Users will need to get lower priority ranks before getting this one.
  • Publish the post.

How to Add Rank Gif:

Settings:

BadgeOS plugin settings can be configured from BadgeOS > Settings. Different options can be found here for the configuration of the plugin.

Minimum Role to Administer the BadgeOS plugin:

The admin can select the minimum role to administer the BadgeOS plugin.

Minimum Role to Administer Submissions/Nominations:

The admin can select the minimum role to administer the submissions and nominations.

Send Email When Submissions/nominations are Received:

If this option is enabled, the system will automatically send an email to the admin when submissions or nominations received.

Notification Email Addresses:

Here the admin can enter the email addresses for the notification. 

Delete Data on Uninstall:

If this option is enabled, it will delete all BadgeOS database entries on uninstall including posts, setting options, user meta.

Debug Mode:

This option can be used to show the detail error information. When enabled it will show some meta-data values on the user’s profile edit page.

Log Entries:

Log entries can be enabled or disabled from this option.

Rank Post Type:

Here the admin can customize the ranks type slug name.

Rank Step Post Type:

Here the admin can customize the rank step post type slug name.

Point Type:

Here the admin can customize the point type slug name.

Point Award:

Here the admin can customize the point award slug name.

Point Deduct:

Here the admin can customize the point deduct slug name.

Default Point Type:

Using this option, you can select the default point type. It is necessary to select the default point type.

BadgeOS Add-on Licenses:

In this section, the admin can insert the license keys of activated BadgeOS premium add-ons and check their activation status.

BadgeOS DB Upgrade:

To update the users’ existing achievements and points in the BadgeOS table, click on the “Upgrade 3.0 DB” button.

BadgeOS Upgrade Achievement:

To update the existing achievement points with the point types, click on the “Upgrade Achievements” button below.

Credly Integration

Credly integration settings can be configured from BadgeOS > Credly Integration. Different options can be found here for the configuration of the integration.

With Credly Integration enabled here, badges or achievements you create on this BadgeOS site can automatically be created on your Credly account. As select badges are earned using BadgeOS, the badge will automatically be issued via Credly to the earner so they can easily share it on Facebook, LinkedIn, Twitter, Mozilla Backpack, their website, blog, Credly profile or other location. 

To enable badges sharing with Credly, enable the option ‘Enable Badge Sharing via Credly’. 

Enter your Credly account username and password to access your API key.

If you have an API key already, click at Click here.

 Click the Save Settings. 

BadgeOS add-ons are listed here. These add-ons extend the functionality of BadgeOS.

Click Browse All Add-on button to view details of all paid and free BadgeOS add-ons.

Visit the BadgeOS Help/Support page to get help and support from the BadgeOS team. Plus you can find all the BadgeOS shortcodes from this page. All the BadgeOS shortcodes are listed here with all the attributes.

Achievements Tools

Using the Achievement tool option the admin can award or revoke the achievements in bulk.

Award Achievements in Bulk:

Award Achievements in Bulk option allows you to award the achievements in bulk to your users.

Achievements to Award:

Here you can choose the achievement(s) to award. You can select multiple achievements.

Award to All Users:

Check this point to award the selected achievement(s) to all users.

Users to Award:

Here you can choose users to award the selected achievement(s). You can select multiple users.

Once you select all the above-desired options, click the Award Achievements button to award the selected achievement(s).

Revoke Achievements in Bulk:

Revoke Achievements in Bulk option allows you to revoke the achievements in bulk from your users.

Achievements to Revoke:

Here you can choose the achievement(s) to revoke. You can select multiple achievements.

Revoke to All Users:

Check this point to revoke the selected achievement(s) from all users.

Users to Revoke:

Here you can choose users to revoke the selected achievement(s). You can select multiple users.

Once you select all the above-desired options, click the Revoke Achievements button to revoke the selected achievement(s).

Credits Tools

Using the Credit tool option the admin can award or revoke the credit/points in bulk.

Award Credits in Bulk:

Award Credit in Bulk option allows you to award the credit in bulk to your users.

Select Credit Type:

Here you can choose the credit type(s) to award. You can select multiple credit types.

Credit Amount:

Enter the amount of credit to award.

Award to All Users:

Check this point to award the selected credit type(s) to all users.

Users to Award:

Here you can choose users to award the selected credit type(s). You can select multiple users.

Once you select all the above-desired options, click the Award Credit button to award the selected credit type(s).

Revoke Credits in Bulk:

Revoke Credits in Bulk option allows you to revoke the credits in bulk from your users.

Credits to Revoke:

Here you can choose the credit type(s) to revoke. You can select multiple credit types.

Revoke to All Users:

Check this point to revoke the selected credit type(s) from all users.

Users to Revoke:

Here you can choose users to revoke the selected credit type(s). You can select multiple users.

Once you select all the above-desired options, click the Revoke Credits button to revoke the selected credit type(s).

Ranks Tools

Using the Rank tool option the admin can award or revoke the rank(s) in bulk.

Award Ranks in Bulk:

Award Ranks in Bulk option allows you to award the ranks in bulk to your users.

Ranks to Award:

Here you can choose the rank(s) to award. You can select multiple ranks.

Award to All Users:

Check this point to award the selected rank(s) to all users.

Users to Award:

Here you can choose users to award the selected rank(s). You can select multiple users.

Once you select all the above-desired options, click the Award Ranks button to award the selected rank(s).

Revoke Ranks in Bulk:

Revoke Ranks in Bulk option allows you to revoke the rank(s) in bulk from your users.

Ranks to Revoke:

Here you can choose the rank(s) to revoke. You can select multiple achievements.

Revoke to All Users:

Check this point to revoke the selected rank(s) from all users.

Users to Revoke:

Here you can choose users to revoke the selected rank(s). You can select multiple users.

Once you select all the above-desired options, click the Revoke Ranks button to revoke the selected rank(s).

System Tools

Server Info:

All the information about the server, PHP Configuration, WordPress and BadgeOS will be listed here.

Widget

BadgeOS User Earned Achievement Widget can be included in any widget area. To do so, follow these steps:

  • Navigate to Appearance from WP Dashboard. 
  • Select Widget.
  • Search BadgeOS User Earned Achievement Widget.
  • Drag or drop BadgeOS User Earned Achievement to the desired sidebar.
  • Enter Title.
  • Enter Number to display (i.e 10, mean only recent 10 earned achievements will be shown at the selected sidebar). Enter 0 for displaying all earned achievements.
  • Check Rank Types for Display only the following User Rank Types option to display the selected  Rank Types in the sidebar. 
  • Select Point Type for Select Point Type option. Total points of selected point type will be displayed on the front-end.
  • Check Achievement Types for Display only the following User Achievement Types option to display the selected  Achievement Types in the sidebar. 
  • Click Save.

Frontend:

Shortcodes:

Check the shortcodes from Dashboard > BadgeOS > Help / Support.

Also, you can add the BadgeOS shortcodes into the pages and posts by clicking on the Add BadgeOS Shortcode button on the editor.

All Available Shortcodes:

Achievement List – [badgeos_achievements_list]

Output a list of achievements.

  • Attributes:
  • type – Single, or comma-separated list of, achievement type(s) to display. Accepts: all, badges Default: all
  • limit – Number of achievements to display. Default: 10
  • show_filter – Display filter controls. Accepts: True, False Default: true
  • show_search – Display a search input. Accepts: True, False Default: true
  • orderby – Parameter to use for sorting. Accepts: Menu Order, Achievement ID, Achievement Title, Published Date, Last Modified Date, Achievement Author, Random Default: menu_order
  • order – Sort order. Accepts: Ascending, Descending Default: ASC
  • user_id – Show only achievements earned by a specific user.
  • include – Comma-separated list of specific achievement IDs to include.
  • exclude – Comma-separated list of specific achievement IDs to exclude.
  • wpms – Show achievements from all network sites. Accepts: True, False Default: false

Example: [badgeos_achievements_list limit="10" show_filter="true" show_search="true" orderby="menu_order" order="ASC" wpms="false"]


Single Achievement – [badgeos_achievement]

Render a single achievement.

  • Attributes:
  • id – The ID of the achievement to render.

Example: [badgeos_achievement id=""]


Nomination Form – [badgeos_nomination]

Render a nomination form for a specific achievement.

  • Attributes:
  • achievement_id – Achievement ID to award.

Example: [badgeos_nomination achievement_id=""]


Nominations List – [badgeos_nominations]

Display a filterable list of nominations.

  • Attributes:
  • limit – Number of nominations to display. Default: 10
  • status – Nomination statuses to display. Accepts: All, Approved, Denied, Pending Default: all
  • show_filter – Display filter controls. Accepts: True, False Default: true
  • show_search – Display a search input. Accepts: True, False Default: true

Example: [badgeos_nominations limit="10" status="all" show_filter="true" show_search="true"]


Submission Form – [badgeos_submission]

Render a submission form.

  • Attributes:
  • achievement_id – Achievement ID to award.

Example: [badgeos_submission achievement_id=""]


Submissions List – [badgeos_submissions]

Display a filterable list of submissions

  • Attributes:
  • limit – Number of submissions to display. Default: 10
  • status – Display only submissions of this status. Accepts: All, Approved, Denied, Pending Default: all
  • show_filter – Display filter controls. Accepts: True, False Default: true
  • show_search – Display a search input. Accepts: True, False Default: true
  • show_attachments – Display submission attachments. Accepts: True, False Default: true
  • show_comments – Display submission comments. Accepts: True, False Default: true

Example: [badgeos_submissions limit="10" status="all" show_filter="true" show_search="true" show_attachments="true" show_comments="true"]


Credly Assertion Page – [credly_assertion_page]

Adds support for Credly’s “Custom Assertion Location” feature, available to Credly Pro members only. After placing this shortcode on a page, copy that page’s URL and append “?CID={id}” to the end (e.g. https://badgeos.org/assertion/?CID={id}). Paste this full URL in the “Custom Assertion Location” field in your Credly Account Settings. All of your Credly badges will be linked back to this site where the official badge information is displayed automatically.

  • Attributes:
  • width – Content width. Default: 560
  • height – Content height. Default: 1000
  • CID – Optional Credly Badge ID to display instead of dynamically passed ID.

Example: [credly_assertion_page width="560" height="1000" CID=""]

Manually Award or Revoke Achievements:

Administrators that meet the minimum role to administer BadgeOS can award or revoke any achievement or step from the user edit profile.

Simply, scroll to the Award an Achievement section on the user’s profile and select the Achievement Type to Award.

On the action column, you will see two actions Award Achievement or Revoke Achievement.

Award Achievement: By clicking this action the achievement will be awarded to the user.

Revoke Achievement: Just visible if the user already has earned this achievement, by clicking this action the achievement will be revoked to the user.

Manually Award or Revoke Ranks:

Administrators that meet the minimum role to administer BadgeOS can award or revoke any rank from the user edit profile.

Simply, scroll to the Award Ranks section on the user’s profile and click Display Ranks to Award.

On the action column, you will see two actions Award Rank or Revoke Rank.

Award Rank: By clicking this action the achievement will be awarded to the user.

Revoke Rank: Just visible if the user already has earned this achievement, by clicking this action the achievement will be revoked to the user.