Skip to content
English
Sign in
Contact us
  • There are no suggestions because the search field is empty.

📄Myplace - Bepoz Setup Guide

This document has been created with the purpose to instruct implementations on how to do the technical setup of Bepoz and SQL in preparation for the MyPlace back panel configuration.

 

Prerequisites

Before initiating the setup, there are some requirements to be completed.

  • Check the Bepoz version (4.5.2+ is required)

  • Confirm usage of existing or new “Account Groups”.

  • The customer has created a port forwarding rule in the HO’s router pointing to the Bepoz server.

  • The server has a static IP address.

Checklist of info that needs to be kept

This is the list of information that needs to be provided to the Special Projects Team.

  • Public IP Address

  • Port Number

  • Till ID

  • MAC Secret Key

  • Payment Name

  • Operator ID
  • Account Groups

 


Name

ID

Template Account Number

Card Lenght

Card Pattern
(min, max, prefix
)

 

 

 

 

 

 

 

 

 

 

 

Procedure

1. Request additional till license

Send email account

2. Operator Setup

  • Go to Bepoz Back-office → Maintenance → Operator

  • Create a new operator under the staff group (or anything similar)

    • To create a new operator, right-click on an existing operator and click ‘Copy Highlighted Operator as New Operator’

    • Set operator number to MYPLACE

    • Rename it to be ‘MyPlace App Operator’

    • Click OK

  • Record the Operator ID

 

Online Payment Setup

For multi-venues, the payment name must be created to all venues using the same payment number and name.

  • Go to Bepoz Back-office → System Setup → Venue, Store & Tills

  • Click on ‘Edit Venue Settings → Go to the tab ‘Names’

  • In the ‘Credit Card Currencies’ add a new payment name as ‘App Payment’ and tick the ‘Hide Button’ checkbox.


 

2. Create a new API Till

Navigate to “Venues, Stores & Tills:

  • Go to Bepoz Back Office → System Setup → Venue, Stores & Tills

  • → Right-click on the Main Server → Select ‘Copy this work station” → Rename the workstation to be ‘MyPlace API Till”

  • UNTICK ‘Is WorkStation’

  • Till Mode: API Till

  • Make sure Account Group is set to “All Accounts”


  • Record the Till ID

 

Store Procedure Extension Setup (.dll)

Go to the Bepoz programs folder and copy/replace the storedProc.dll with the latest version.

 

 XML API Job Setup

  • Go to Bepoz Back Office → System Setup → Scheduled Jobs

  • Click on ‘Add Job’.

    • Job Name: MyPlace XMLAPI [port_number] *9291 as default

    • Venue: All Venues – If multivenue site, select the venue this setup is for.

    • DLL Name: Jobxml_api.Dll

    • Class Name: XML_API

  • Schedule Job

    • Click on ‘Add’

    • TICK ‘start date’

    • UNTICK ‘end date’

    • TICK ‘every day’

    • TICK ‘on start up only’

    • Click on ‘OK’

  • DON’T TICK ‘Bypass MAC Security’.

  • MAC Key

  • Connection Port

    • 9292 or any other port not in use (internal use only)

  • Failure Retries Count: 30

  • Failure Retries Interval (sec): 30

  • Till:

    • Select the API Till created earlier (MyPlace API Till)


 

StoredProc API Job Setup

  • Go to Bepoz Back Office → System Setup → Scheduled Jobs

  • Click on ‘Add Job’.

    • Job Name: MyPlace StorProc [port_number]

    • DLL Name: Job_storproc.Dll

    • Class Name: Job StoredProc

  • Schedule Job

    • Click on ‘Add’

    • TICK ‘start date’

    • UNTICK ‘end date’

    • TICK ‘every day’

    • TICK ‘on start up only’

    • Click on ‘OK’

  • TICK ‘Bepoz Passthrough’.

  • MAC Key:

    • Use the same MAC key for the XML job and StoredProc job.

  • XML API Path:

    • http://127.0.0.1:9292 (Connection port used in the XML API Job setup)

  • Listen Port: Port number used for the port forwarding rule

 

Account Setup

This step will depend on how the customer want the membership structure to be.

 

Account Groups

  • Go to Bepoz Back-office → Maintenance → Accounts

  • Create account group(s) or use existing account groups.

     

Template Accounts

  • Card length and pattern

Card Prefix Setup

Create a new card prefix setup or confirm the card prefix is already configured.

To create a new card prefix

  • Go to Bepoz Back-office → System Setup → Card Prefixes

  • Click on “Add CardPrefix”

    • Enter prefix. E.g. %APP

    • Enter 0 to apply to all venues

  • Edit the Card prefix you just created.

    • Change Card Type to Account Card

    • Enter Strip Characters (e.g. 4 if using %APP as a prefix)

    • Enter how many characters to be used after the prefix (e.g. 8 → *this is the length of the account card number)

 

Firewall Setup

Go to Windows Firewall advanced settings to add a port exception.

  • Go to ‘Inbound Rules’

    • Add new rule

      • Enter port

      • Allow connection

      • Tick all options (domain, private, public)

      • Enter name – e.g. MyPlace App 9290

  • Go to ‘Outbound Rule’

    • Add new rule

      • Enter port

      • Allow connection

      • Tick all options (domain, private, public)

      • Enter name – e.g. MyPlace App 9290

Run the SQL Scrips

  • Run the BepozUPD.exe program.

  • Select option “M”

  • Wait for the scripts to download and install

  • Make sure all scripts have been installed and there is no error message.


 

Run the SQL Scrips (Alternative Option)

  • Run the “SQL Server Management Studio” Program on the Bepoz server PC.

    • Click on “Connect” button in “Connect to server” window

    • Expand the Database folder and highlighted the Bepoz database name.

  • Click “New Query”

    • Make sure to create the query for the database being used by Bepoz.

  • Copy scripts from Create SQL Stored Procedures Scripts - MyPlace Onboarding - Confluence (atlassian.net) and paste them into the query box.

    • Click “Execute” button to run the scripts

  • After creating the scripts, you also want to update them, in case this database already have a outdated version of the script.

 

Apply Changes to the System

  • Confirm if the Extra Till License is ready.

    • Apply the Extra POS Licence

      • Go to Bepoz back-office

      • Authorisation (in the top nav.)

      • Click on ‘Request by Internet’

      • Make sure the message shows the new auto code. If not, report to Admin.

      • Close the authorisation screen.

  • Restart the Smart Controller Program

  • Check if the ‘MyPlace API Till’ is available

  • Go to ‘Job Process’ tab

  • Make sure the XML API Job is running

  • Make sure the StorProc Job is running

  • If the jobs aren’t running, restart the Smart Controller again.

 

Troubleshooting

Bepoz Connection

  • To check the setup is correct, go to the back panel settings page.

  • If the connection is still down.

    • Check if the port is open

      • Go to yougetsignal.com.au

      • Enter the Public IP address & Port number (both provided by the customer)

      • Click on ‘Check’.

      • The message should say â€˜Port OPEN’.

        • If not, review other firewall rules or contact customer