Back to Olo.com

Simphony POS: Olo Installation Guide


Audience:

Technical Teams, Account Managers, Engineers, & Product Teams

Description: 

This article will cover the Simphony POS requirements as they pertain to the version, environment, licensing, firewall configurations, Simphony EMC configurations, and Olo configuration IDs. These requirements need to be in place prior to the Olo installation. Once in place, the Olo Services are required to be installed on the designated Transaction Services Simphony client and tested.

Helpful Links: 

 

 

Simphony Version Requirements:

  • Simphony v2.8 or greater, except for Simphony 19.1.

Simphony Environment Requirements:

  • The designated Transaction Services Simphony client must have sufficient disk space to process orders. Olo recommends at least 1GB RAM and at least 5 GBs of free hard drive space. 
  • Transaction Services and CAPS (check and posting service) can utilize the same physical Simphony client. 
  • The firewall must be set up to allow for outbound communication from the designed Transaction Services Simphony client. Again, this can be the same physical Simphony client used for CAPS. The firewall requirements are documented in this article.
  • The client must have Microsoft .Net Framework 4.5 or greater installed.

Simphony Licensing Requirements:

  • A Transaction Services license is required in conjunction with an existing POS Client license. Please reach out to Oracle, or your POS support provider, for this license.

Olo Firewall Requirements:

  • Please review the Olo Firewall rules list here.
  • If using a Meraki firewall, or if the Olo services hang in Windows and won't fully start, resulting in a 1053 error, go here for additional firewall configuration requirements.

 Simphony EMC Configuration:

  • Verify the Transaction Services licensing has been activated in your environment.
    • Please consult with Oracle, or your POS support provider, for any assistance. 
  • Configure a Transaction Services (TS) client:
    • Log on to the EMC application.
    • Select a property to configure.
    • Click the Setup tab.
    • Click the Workstation link under Hardware/Interfaces.
    • Insert a new workstation as a POS API client (for example, TS API).
    • Double-click the record to open the created workstation in form view.
    • On the General tab under the General Settings section, select 3 - POSAPI Client
      from the Type drop-down list. This enables the workstation to run only TS inside the
      Service Host process without the POS client.
    • If the POS client needs to run on the same workstation that is run by a Service Host,
      you need to create two workstations: one for the POS workstation client and another
      for the TS client type. From the Service Host link, select the Service Host of the POS
      client when the drop-down list appears during Pos Api client WS type selection. This
      ensures that there will be two workstation identities—one WorkstationID for the POS
      client and another API_Workstation ID for the TS workstation.
    • Click Save.
  • Create an employee that will be used for all Olo orders:
    • This employee must be added to a property and have an operator record in the desired revenue center.
  • Check Info Lines must be enabled to print on order devices, order details, and customer receipts/guest checks.
    • Review settings in Setup | Order Devices | Options for Guest Check Info Lines

CAVEAT: Earlier versions of Simphony may have a variation of the above steps. Please consult with Oracle, or your POS Support Provider, for any programming assistance. 

 

Olo Configuration IDs:

**** Below is the MINIMUM requirements needed, please be advised that you will need to complete the Olo Configuration IDs form for Simphony here ****

 

Record

Required

YES / NO

Value Description
Employee record #

YES

Numeric  - i.e. "999"

"Olo API Emp"

This employee object number will be used as the record of all Olo orders. This employee must be added to the property and have an operator record in the desired revenue center.
Revenue Center record #

YES

Numeric 

This will be the revenue center used to record all Olo orders. This can be the same revenue center record number as your in-house sales or a separate revenue center. 

Order Type record # (s)

(one per type)

YES

Numeric

If you wish to have the desired order types for each Olo hand-off mode, please submit one per hand-off mode.

Examples of hand-off modes include PickUp, Delivery, Dispatch, Rails, Curbside, and Drive-Thru. 

Main and Sub Levels Used

YES 

Numeric 

1,2,3,5

Provide a list of all main and sub levels used for multiple priced items, if applicable.  

It is important to only list the levels that your system is using for main and sub levels.

Special Instructions

YES

Numeric

Provide the condiment menu item record used for custom messages to the kitchen.  

Guest Name

YES

Numeric

Provide the condiment menu item record used for custom messages to the kitchen. 

Olo Service Charge

YES

Numeric

Provide the service charge record number allocated to record all tips and delivery fees from Olo orders. 

This is not required is not tips are allowed and/or you are not doing in-house deliveries.

Olo Tender

YES

Numeric

For prepaid Olo orders, please provide a tender record for the recording of these transactions. This is separate from tenders used on Rail Marketplaces.

Service Total #

YES

Numeric

Provide the tender record used for "Service Total" or "Send". This will be used for orders that are being paid directly at the store and will be open on the POS. 

 

Install the Olo Agent:

Overview: Install the Olo Services and confirm that the services are running properly.
(Estimated time to complete: 7-10 minutes)

Step 1: Confirm that you have access to the Olo Dashboard and the store is offline on the Olo Dashboard.

Step 2: Generate a Password for the current Vendor (store).

Step 3: Download the Installer (Micros Simphony).

Step 4: Run the Install program and follow the instructions in the Wizard.

Step 5: Check the Olo Configuration Setup.

Step 6: Start the Olo Services.

Step 7: Confirm store is online using the Olo Dashboard.

 

Install Procedure:

CAVEAT: Steps 1-3 can be done from any computer. However, you will have to transfer the Olo Simphony installer file to the designated Transaction Services Simphony client BEFORE starting Step 4.

 

Step 1: Confirm that you have access to the Olo Dashboard and the store is offline on the Olo Dashboard.

  • The purpose of this step is mainly to confirm that you have permission to view the store, and since the store will connect automatically and disappear from the “Offline Stores” list, it's a good way to confirm that your installation has succeeded.

  • Login to the Olo Dashboard and click the "Offline Stores" tab from the Home page. The store will be listed below.

           mceclip2.png

 

Step 2: Generate a Password for the current Vendor (store).

  • Since it takes 2 minutes for the password to register with the POS connection servers, it makes sense to generate it for the store before running the installation tool.  

    • Tip: If you forget to generate the password upfront and instead generate it right before entering it into the installation tool, you may see an Invalid Username or Password error. Simply wait a few minutes for the newly generated password to register and then try it again.

  • From the Offline Stores list, click on the store’s name, and then click on the POS Settings link.

           mceclip4.png

  • Click on the Reset Password tab.
    • If you don't see this tab, please contact our Help Center to grant the proper security access. If you have recently used the forgotten password link on Dashboard, your security access will need to be updated by Olo.

mceclip5.png

  • Please take note of the POS Username. This is the username you will use when installing the Olo services.

mceclip6.png

  •  Click the Generate a New Password button.
    • The warning message will appear any time that you create a new password. This is to stop you from disabling a store in case you select the wrong one.

mceclip7.png

  • A second warning message will appear. Press Continue to generate the password.

          mceclip12.png

  • A dialog box will appear with the password, but the password will not be visible until you hover your mouse over it.

          mceclip13.png

  • This is how the password appears when you hover your mouse over it.

           mceclip11.png

  • Copy this password on to your clipboard (ctrl + C) or paste it into Notepad.
    • You can keep this page open as you move to the store computer for installation.

Step 3: Download the Installer (Micros Simphony)

  • Go to the Brand section on the left control list.

           mceclip15.png

  • Select POS Downloads.

           mceclip17.png

  • Select Micros Simphony.

          mceclip18.png

  • Click the button to download the most current version of the Olo Simphony Agent.

          mceclip19.png

 

Step 4: Run the Install program and follow the instructions in the Wizard.

  • Run the installer package on the designed Transaction Services Simphony client
  • Click Next to begin the process.

          mceclip20.png

  • Click Next for the destination folder. 

          mceclip22.png

  • Enter the Olo Username (POS Username) and Olo Password (password generated from Step 2). Click Next.

          mceclip24.png

  • Click Install and then Finish when it's done. 

          mceclip26.png     mceclip27.png

 

Step 5: Check the Olo Configuration Setup.

  • Navigate to the Olo directory (default path is C:\Program Files (x86)\Olo\Olo Simphony Integration Service 1.0).
  • Launch the "Run Olo Simphony Test" batch file.

          mceclip30.png

  • A DOS prompt will appear and confirm the Olo Configuration setup was successful.

          mceclip32.png

Troubleshooting:

  • Message: " Error validating system: Incorrect username or password, User: XXXX"
    • This means that the username and/or password entered, during the installation, is incorrect. 

          mceclip31.png

    • To verify and/or make changes, navigate to the default path of "C:\Program Files (x86)\Olo\Olo Micros Integration Service 1.0\OloMicrosService" directory and open the "OloMicrosService.exe.Config" file in Notepad.
    • In the red highlighted words shown below, verify the username and/or password. If incorrect, please correct, save the file, and re-launch the "Run Olo Simphony Test" batch file (Step 5).

mceclip33.png

  • Message: " Validation error(s): " 
    • This means there is a required Olo Configuration missing. Please contact our Help Center for further assistance. 

          mceclip34.png

 

Step 6: Start the Olo Services.

  • Click on the Windows Start button.
  • Type "Services" and hit Enter
  • Right-click on the Olo Simphony Service and click Start.
  • Right-click on the Olo Update Service and click Start

 

Step 7: Confirm store is online using the Olo Dashboard.

  • Once the services are running, the store should be automatically connected and displayed as "Online" within a couple of mins.
  • Login to the Olo Dashboard, click the "Offline Stores" tab from the Home page, and confirm that the installed store is no longer listed.

           mceclip2.png

 

Didn't find what you need?

Submit a request to our Help Team and someone will
get back to you shortly.

Submit a request

Copyright © 2020 Olo. All rights are reserved.