skip to Main Content

This tutorial will guide you step by step in how to create a basic Achievement with an action helper that has an image displayed feature. The image display feature is used in the rules for action helpers.

Step 1: Action helpers

In your CompetitionLabs space, navigate to Settings → Action Helpers

Step 1.1: EDIT

You can update your existing Action helpers. If you want to update the existing ones navigate to the Action helper of your choice and press on the edit action icon button.

Step 1.2: CREATE

You can create a new Action helper. If you want to create a new one navigate to Add action helper action button.

Step 2: Adding an image to the Action Helpers

From Step 1 you are navigated to the Action Helpers Create/Edit screen where you fill out the information of the Action helper.

     Action Helper fields

Name String

Set Name to – Win

Key String

Set the key to  – win

If you have an action helper with this key already created you can name it differently by your choice. In this tutorial we will display the Key – win

Description String

Win action helper

Metadata Object
  1. Key –  has to contain a text – img
  2. Value – has to be a link to the image that you want to be displayed- https://complabs.atlassian.net/wiki/download/thumbnails/696090637/trophy.png?version=1&modificationDate=1557221627227&cacheVersion=1&api=v2&width=100&height=100

Image example »

Note that it is really important that the key is all in small case letters (img) and the Value must be a link to the image for it to be displayed. You can use the URL that is given or of your choice.

Step 3: Products

In your CompetitionLabs space, navigate to Products.

Step 3.1: EDIT

You can update your existing Product. If you want to update an existing one navigate to the Product of your choice and press on the edit action icon button.

Step 3.2: CREATE

You can create a new Product. If you want to create a new one navigate to Add Product action button.

Step 4: Adding the action helper to the Product

From Step 3 you are navigated to the Product Create/Edit screen where you fill out the information of the Product. If the product already exists just add the Action Adjustment factor Win that we created. An example is shown below of a new Product creation.

     Products fields

Name String

Set Name to – New Game

Providers String

N/A

Product Type String

Set Product type to – slot game

Description String

N/A

Adjustment factor Integer

Set the value to 1

Product ref id String

Set the Product ref id to – new_game

Action Adjustment factors String

By selecting Action you can already preview the Action helper with the image. Select the created Win Action helper.

In the Adjustment factor insert a value 1

Metadata Object

N/A

You can read about the Products documentation in detail in Products section.

Step 5: Achievement creation

Achievement creation step will only present the bare minimum for the achievement creation. If you want a detailed explanation in how to create a simple reward/notification achievement you can read it in ACADEMY BASICS → Achievements → Example Achievement tutorials → Simple reward/notification Achievement (Sign-up & Get Welcome Badge) or click here to be redirected to the link.

In your CompetitionLabs space, navigate to Achievements → ListTo start creating an achievement press the Create action button and you will be redirected to the achievement creation page.

     Step 1: Achievement settings

Status Enum

Set status to – Draft

Icon String

Select any preferable icon

Name String

Congratulations you won.

Description String

A value indicating how many achievements have been issued.

Initial State Enum

Set state to – Hidden.

Move on to the next step by clicking Next.

     Step 2: Achievement scheduling

Available from DateTime

Pick a date and time when your Achievement is valid and it is available.

Available until DateTime

N/A

Occurrence Enum

Once.

 

Move on to the next step by clicking Next.

     Step 3: Achievement entrants

Member Groups Array[String]

Leave as is – ALL.

 

Move on to the next step by clicking Next.

     Step 4: Achievement dependent on

Category String

N/A

Dependent On Array[Object]

N/A

Metadata Object

N/A

Move on to the next step by clicking Next.

     Step 5: Achievement rewards

Rewards Array[Object]

N/A

 

Move on to the next step by clicking Next.

     Step 6: Achievement rules

An example below is shown of how Rules with an action that has an image attached to it looks like

  1. The Main rules fact is “The count of events where the nested condition(s) evaluate to TRUE for the event” the Main rules operator is “is” and the Main rules constant is “1“. The condition match of the Main rule is “ALL” and the evaluation criteria – “TRUE“. After that you need to add a Sub rule.
  2. The Sub rules fact is “The product” the Sub rules operator is “is” and the Sub rules constant is “New Game“. The condition match of the Sub rule is “ALL” and the evaluation criteria – “TRUE“.
  3. The Sub rules fact is “The action” the Sub rules operator is “is” and the Sub rules constant is “Win“. The condition match of the Sub rule is “ALL” and the evaluation criteria – “TRUE“.

When selecting the action you can already preview the image inserted in the action in Action Helpers.

This can be done even without a product selection.

Move on to the next step by clicking Next.

     Step 7: Achievement translations

Languages Array[Object]

N/A

 

Move on to the next step by clicking Next.

     Step 8: Achievement summary

Summary

You can expand the Rules and preview the action with the image that was preselected earlier.

 

To finish creating the achievement press Finish and a second pop up screen appears for a confirmation of the achievements creation. Press Confirm and you have created an Achievement.

With this you have went step by step in how to add an image to the Action Helper and implement it in the product and achievement.

Back To Top