1

Installation and User Guide for

Magento 2 Competition or Prize Draw with Social

Booster Extension

2

Table of Contents

1. Installation ...........................................................................................................................................3

Upload Package ......................................................................................................................3

Install Extension ......................................................................................................................3

2. Configuration Settings for Competition .............................................................................................3

General Settings .....................................................................................................................3

Social Booster - Facebook Settings ......................................................................................4

Social Booster - Twitter Settings ...........................................................................................5

Email ........................................................................................................................................5

3. Create/Edit/Delete Custom form fields .............................................................................................6

View Custom Field Screen .....................................................................................................6

4. Create/Edit Competition.....................................................................................................................8

Create Competition .................................................................................................................9

Add Fields in Competition Form .......................................................................................... 11

Add Custom Fields ............................................................................................................... 11

Design .................................................................................................................................... 12

Facebook Settings ................................................................................................................ 13

Twitter Sharing ...................................................................................................................... 14

Email Template for Competition Entry Email ...................................................................... 15

Choose Winner ..................................................................................................................... 15

5. Competition Entrants ....................................................................................................................... 16

View Entrants ........................................................................................................................ 16

6. Front-end Site View .......................................................................................................................... 17

Competition Form ................................................................................................................ 17

Social Sharing Links on the Form ...................................................................................... 19

Competition Entry Confirmation Email ............................................................................... 19

Newsletter Subscription Confirmation Email ..................................................................... 20

Competition Winner Confirmation Email ............................................................................. 20

3

1. Installation

Upload Package: Upload the content of the module to your root folder. This will

not overwrite the existing Magento folder or files, only the new contents will be

added.

Install Extension: After the successful upload of the package, run below

commands on Magento 2 root directory.

composer require scommerce/core

php bin/magento setup:upgrade

php bin/magento setup:di:compile

php bin/magento setup:static-content:deploy

2. Configuration Settings for Competition

Go to Admin > Stores > Configuration > Scommerce Configuration > Competition

General Settings

Enabled – Select “Yes” or “No” to enable or disable the module.

License Key – Please add the license for the extension which is provided in

the order confirmation email. Please note license keys are site URL specific.

If you require license keys for dev/staging sites then please email us at

core@scommerce-mage.com

Enable Captcha on Competition Form – Please select “Yes” or “No” to

enable/disable captcha on the competition form.

Subscription to Newsletter on Form Submission – Please select “Yes” or

“No” to enable/disable newsletter subscription on the competition form.

4

Social Booster - Facebook Settings

Enable (Yes/No) – Please select “Yes” or “No” to Facebook sharing for

competitions global level.

Facebook Fan Page – Please add full URL of your Facebook page for

example www.facebook.com/scommercemage.

Facebook App ID – Please add Facebook application Id this can be

obtained by creating app by clicking on the following URL

(https://developers.facebook.com/apps) after login to your Facebook

account.

Select “Yes” to enable the

Facebook settings

Please add the URL of

Facebook fan page

Please add the Facebook

App Id

Select “Yes” to enable the

module

Enter the license key for the

module

Select “Yes” to enable

Captcha on Competition

form

Select “Yes” to enable the

Newsletter Subscription on

Competition form

5

Social Booster - Twitter Settings

Enable (Yes/No) – Please select “Yes” or “No” to Twitter for competitions on

global level.

Twitter Account – Please add unique id of your twitter account. For

example our twitter account is http://www.twitter.com/scommerce/mage so

you just need to put Scommerce Mage.

Email

Enable (Yes/No) – Please select “Yes” or “No” for competition email.

Email Sender (Textbox) – Please add email sender for competition email.

Email Template for competition entry email – Please select dropdown to

select default global level competition entry email template from the available

list of templates. A default template will be added with the extension install.

Select “Yes” to enable the

Facebook settings

Select “Yes” to enable the

Facebook settings

Select “Yes” to enable the

Facebook settings

Select “Yes” to enable the

Facebook settings

Select “Yes” to enable the

Facebook settings

6

3. Create/Edit/Delete Custom form fields

You can create, update and delete custom fields from Admin > Competition > Custom

Fields. The grid will have below columns:

ID – This will be custom field code.

Field code – This will be custom field code.

Field Title – This will be custom field title.

Field Type – This will be custom field type.

Action – Edit/Delete

View Custom Field Screen - Click on "Add New Custom Field" will redirect you

to detailed view custom field page and by filling all the required details you can

create a new custom field. It will have below tabs: -

Field Information

Field Code (text box) – This will be mandatory and unique. No spaces or

special character will be allowed, and it will be all lower cases just like attribute

code and will not be editable once created.

7

Display Name/Title (text box) – Name/Title for the custom field which will be

displayed on front end in competition form.

Type (drop down) – This will be a drop down to select the type of the field, and

it won't be editable once created.

Text

Text area

Checkbox

Radio Button

Dropdown

Multi Select

Date Picker

Maximum Character allowed (text box) – This will be only visible, if the type is

Text or Text area. User will be able to define max character for the field.

Options(grid) – This will be only visible, only if the type is Checkbox or Radio or

Dropdown or Multiselect. User will be able to relative options here. The grid will

have the following columns: -

Is Default

Value

Label default store view

All other available store views

Delete/Remove (action)

Answer (text box) – This will be an optional field for adding answer. If the type

is date picker then the date format for answer should be correct.

8

4. Create/Edit Competition

You can update, delete and create a new competition from Admin > Competition >

Competitions.

The grid will have below columns: -

ID – This will be competition ID. System generated

Name – This will be competition name/title

URL Key – This will be competition URL Key

Store View – This will be a store view drop down for to select stores for competition.

Status – Competition status (active/disabled)

Start date – Start date for the competition

End date – End date for the competition

Created date – Created date for the competition

Updated date – Updated date for the competition

9

Action – Edit/Delete

Create Competition - Click on "Add New Competition" will redirect you to

detailed competition page. It will have below tabs: -

General

Competition Name - Enter the competition name. The name will appear on the

front-end competition form.

Competition URL - Enter the URL. This URL will be used to open the completion

form on the front-end.

Competition Description - Add the description. This description will appear on

the front-end competition form.

Competition Store – Multi select filled with values.

Include Name in Form – Dropdown, Include Name in Form (Yes/No)

Competition Status – Drop Down, Competition Status (Active/Disabled)

Competition Meta Title - Enter meta title

Competition Meta Description – Add meta description.

Competition Meta Keywords – Keywords

Competition Start Date – Date picker

Competition End Date – Date picker

Competition form Submit Button Label

10

11

Add Fields in Competition Form - To add fields in competition form go to

Admin > Competition > Competitions > Add Fields in Competition Form. It will

have the fields: -

ID

Field Title

Field Type

Action

Sort Order

Add Custom Fields - You can add fields from Admin > Competition >

Competitions > Add Fields in Competition Form > Click on "Add Fields" >

Select fields and Click on "Add Selected Fields". This screen will have all the

available custom fields in a grid form and user will be able to select fields to add to

the competition form.

Checkbox to select fields

Field Code

Field Name/Title

12

Field Type

Field Position – This will be editable numeric field and will decide the display

position for the competition form. This is specific to competition form.

Design - This tab will display two drop downs with all the static block where user

will be able to select static block for the competition entry page and success page

from Admin > Competition > Competitions > Add Fields in Competition Form >

Design.

Static block for Competition Entry Page – Please select static block

for competition entry page on front end.

Static block for Competition Entry Thank you page – Please select

static block for competition entry page on the front end.

13

Facebook Settings – This tab will only be visible, if enabled from Admin >

Stores > Configuration > Scommerce Configuration > Competition > Social

Booster-Facebook settings

Enabled (yes/no) – Please select “Yes” or “No” for Facebook sharing for

the competition.

Facebook Share Name – Please add name/title for the promotion which

appears in bold on the sharing popup. For more info see

https://fbdevwiki.com/wiki/FB.ui

Facebook Image upload for sharing pop up – Please upload image

for the promotion which appears on the sharing poup. For more info see

https://fbdevwiki.com/wiki/FB.ui

Facebook Share Caption – Please add caption for the promotion which

appears above share description and below the name of the promotion

on the sharing popup. For more info see http://fbdevwiki.com/wiki/FB.ui

Facebook Share Description – Please add description for the

promotion which will appears above share description and below the

name of the promotion on the sharing popup. For more info see

http:fbdevwiki.com/wiki/FB.ui

14

Twitter Sharing – This tab will only be visible, if enabled from Admin >Stores >

Configuration > Scommerce Configuration > Competition > Social Booster-

Twitter Settings

Enabled (yes/no) – Please select “Yes” or “No” for Twitter sharing on

competition form.

Twitter Text – Please add description of your promotion which appears

on the sharing popup.

Hashtags – Please add hashtag of your promotion which appears on the

sharing popup at the end of the description.

15

Email Template for Competition Entry Email – This will be a dropdown to

select default competition level competition entry email template from the available

list of templates. If nothing selected, then it will pick up template defined in section

Admin > Stores > Configuration > Scommerce Configuration > Email.

Choose Winner – It generates winners only when the competition has ended.

This will be determined by competition end date and will have below two elements.

Number of winners – Please add number of winners you would like to

generate for the competition.

Generate Winner Button – To generate a winner, click on "Generate

Winner" button. It resets manually generated winners and selects a new

winner randomly. This is a random process, and doesn't validate any

answer or entries.

16

5. Competition Entrants - You can generate winner manually from Entrants grid by

selecting "Mark Winner" under "Actions" from Admin > Competition > Entrants. Also you

can delete and view entrants by selecting "View" from "Actions" . The grid will have below

columns:-

User Email

Username

Competition Name

Store

Winner

Date Entered

Action

View Entrants – To view entrants details go to Admin > Competition > Entrants

> Select "View", it opens View Entrants page from where you can select winner ma

by selecting "Yes" from Mark Winner drop-down. It selects winner manually and it

doesn't validate any answer or entries.

17

6. Front-end Site View

Competition Form - When you create a competition from Admin >

Competition > Competitions, then based on defined URL key it opens the

competition on the front-end site with the social sharing options, which you can

see in the below screen grab.

18

19

Social Sharing Links on the Form - After entering into the competition

when you share the competition on the social sites, it increases the possibility to

win the competition. It allows you to enter five entries in the same prize draw

competition by following / liking / sharing the prize draw or competition on

Facebook and Twitter, also you can enable/disable the social sharing options

from the back-end.

Competition Entry Confirmation Email - It sends an email to users to

confirm their entry into the prize draw or competition.

20

Newsletter Subscription Confirmation Email - When you select "Yes" for

" Subscription to Newsletter on Form Submission " from Admin > Stores >

Configuration > Scommerce Configuration > Competition, then it sends

newsletter subscription confirmation email to users.

Competition Winner Confirmation Email

Please contact core@scommerce-mage.com for any queries.