OmniLink Merchant Services Development Guide · OmniLink Merchant Services Hierarchy and Work Flow...

OmniLink MerchantServicesDevelopment Guide

M00122600 EN

Introduction

Manuals

The following three manuals for OmniLink Merchant Services are provided.

Development Guide (this document)

This manual provides necessary information to configure a development environment for developing OmniLinkMerchant Services (cloud-based applications) and migration of developed services to production environments forsystem developers.

Setup Guide

This manual is for an installer who installs TM printers in stores. Provides necessary information for setting up theprinters to use the OmniLink Merchant Services.

Operation Guide

This document describes printer status monitoring performed daily, error handling procedures, and other aspectsof service operation.

Precautions

o Unauthorized duplication, copying, reproduction, or modification of any part or all of this document is strictlyprohibited.

o Contents of this manual are subject to change without prior notice. Contact us directly for the most recentinformation.

o Every effort is made to ensure that the contents of this manual are without error. Please contact us if any errorsor other issues are found.

o The previous statement notwithstanding, we will not be liable for any negative impact as a result of use.

o Epson shall not be liable for any damages caused as a result of using this product incorrectly, failing to complywith the content of this document, or having repair or modifications performed by third parties other thanEpson or those specified by Epson.

o Epson shall not be liable for any issues as a result of installing optional parts or consumables that are notgenuine Epson parts or parts certified by Epson.

Epson OmniLink Merchant Services Development Guide

Introduction

2

Usage Limitations

Please use our products in environments and systems designed with consideration to safety and disaster recoverysuch as fail-safe configurations and redundant designs, for example, if this product is used in applications in whicha high level of reliability and safety in functionality and precision is required such as in aircraft, trains, ships,automobiles and other transportation-related applications or in crime prevention equipment and safety equipment.

This product is not intended for use in applications that require extremely high levels of reliability and safety suchas in aerospace equipment, trunk-line communications equipment, nuclear power control equipment, and medicalequipment.

Consider your usage environment and requirements carefully before using this product in such applications.

Terms and Symbols Used in the Manuals

Terms

Definitions of the terms used in this document are as follows.

Service provider

A solutions provider who develops a cloud-based service using Epson Omnilink Merchant Service Web API anddelivers it to customers.

Deployment partner

An installer who installs and sets up TM printers in stores, and configures the production environment.

Service

A cloud-based application such as sales analysis, reward point program, etc., that is developed by a Serviceprovider.

Meaning of Symbols

The following symbols are used in this manual. Make sure to understand the meaning of these symbols beforeusing the product.

Describes usage precautions that must be observed. Incorrect handling due to the disregard of thisinformation may result in product failure or incorrect operation.

Note: Describes additional explanation or other useful information.

UIndicates related reference pages. If the reference section is in blue text, click the blue text to openthe relevant page.


Introduction

3

Contents

Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Manuals. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Precautions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Usage Limitations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Terms and Symbols Used in the Manuals. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Terms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3Meaning of Symbols. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

OmniLink Merchant Services Hierarchy and Work Flow. . . . . . . . . . . . . . . . . . . . . . . . . . 6OmniLink Merchant Services Hierarchy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Overview of Service Development. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8Service Development Work Flow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Configure the Development/Production Environment. . . . . . . . . . . . . . . . . . . . . . . . . . 11Sign in. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Signing Out. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Registering Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Registering Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Changing Group Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Deleting Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Managing Members. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Registering Members. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Deleting Members. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Assigning Members to Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Managing Stores. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Registering Stores. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Viewing Store Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Changing Store Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Deleting Stores. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Managing Printers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Registering Printers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Viewing Printer Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Changing Printer Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Deleting Printers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Using the Sample Receipt Function. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Connecting Printers to OmniLink Merchant Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Setup Process Flow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Connecting the TM Printers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Configuring the Network Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Connecting to the Cloud Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52Checking Connection to the Epson Cloud Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Checking Advanced Printer Driver Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Checking the Receipt Data Send Results. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Configuring Printers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61


Contents

4

Receipt mapping. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61QR Code Setting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82Contents Print Setting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Data Filtering and Masking Setting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Scanner Transmission Setting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Migrate to the Production Environment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Migrating the Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128Changing the Printer Setting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Appendix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132Rights and Available Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Rights. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132Rights and Correspondingly Available Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Updating Account Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Changing Email Addresses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135Changing Passwords. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137Changing Account Names. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Deleting Your Account. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141Viewing Operational Logs of Store/Printer Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143Writing Regular Expressions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Regular Expression Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Regular Expression Description Patterns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Description Patterns of Regular Expressions by Type of Printer Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . 146Example Regular Expressions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

Operating Environment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Supported POS Systems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Supported TM Printers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148Supported Browsers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Open Source Software License. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150OmniLink Merchant Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150TM-T88VI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150TM-T88VI-iHUB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150

Trademarks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151


Contents

5

OmniLink Merchant Services Hierarchy andWork Flow

OmniLink Merchant Services Hierarchy

The Team Administrator registered by Epson creates the groups necessary to use OmniLink Merchant Services andregisters members, stores that use services, and the printers installed in these stores.

Group creation

Create groups to manage stores. This enables multiple stores to be managed as one unit.

U “Registering Groups” on page 14

Registering members

Register members who use OmniLink Merchant Services. Member rights include Administrator, Technician, andDeveloper.

U “Managing Members” on page 19

Registration of members into groups

Register members into groups. Members in a group can view and manage information on the stores registered inthe group.

U “Assigning Members to Groups” on page 23

Registering stores

Register the stores that use services.

U “Managing Stores” on page 26

Registering printers

Register the printers installed in stores.

U “Managing Printers” on page 34


OmniLink Merchant Services Hierarchy and Work Flow

6

Team

Group N

Group 2

Group 1

Store 1

Printer 1 Printer 2 Printer N

Store 2


Store N




7

Overview of Service Development

The following section describes the services development procedure.

There are two server environments for OmniLink Merchant Services.

One is the service development environment (hereinafter, referred to as the sandbox environment). The other is theenvironment actually used to provide developed services to stores (hereinafter, referred to as the production envi‐ronment).

1. Service development using the sandbox environment

(1) Services are developed using the sandbox environment.

Using the sample receipt feature of the sandbox environment enables you to retrieve receipt data withoutconnecting actual printers to OmniLink Merchant Services.

Receipt data is retrieved using a Web API. Refer to Web API Reference Guide for more information onusing the Web API.

Stores must also be registered in the sandbox environment so that printers can be registered. These storesdo not need to be actual stores.

Note:

The data mapping rules for receipt data created in the sandbox environment do not automatically migrate tothe production environment.

We recommend that you make notes on data mapping rules configured in the sandbox environment to ensuresmooth migrations to the production environment.

(2) Contact Epson when service development is complete.

Epson registers services in the production environment and sends credentials for the productionenvironment.

2. Service evaluation in production environment

You should confirm that services developed using the sandbox environment operate normally in the produc‐tion environment.

After migrating your services from the sandbox environment to the production environement, a thouroughevaluation is advised to be performed to ensure proper operation.

Stores and devices must be registered in the production environment using the same procedure as the sandboxenvironment. Since sample receipt data is not available in the production environment, a printer must be on‐line and connected to OmniLink Merchant Services and new receipts printed in order to complete your evalua‐tion.

3. Publish Services

In order to make new services available, please send a request to [email protected] (North Americaregion) / [email protected] (Europe region).



8

Service Development Work Flow

Service provider(Administrator) Deployment partner(Administrator)

Deployment partner(Technician)

Sign in

U “Sign in” on page 11

Repeat during service development

Register test groups*

U “Registering Groups” on page 14

Register members (developers)

U “Managing Members” on page 19

Assign members to groups

U “Assigning Members to Groups”on page 23

Register test store*

U “Managing Stores” on page 26

Register test printers*

U “Managing Printers” on page 34

Develop service(s)

Issue sample receipts

U “Using the Sample ReceiptFunction” on page 44

Define data mapping rules asnecessary (receipt mapping)

U “Receipt mapping” on page 61

Confirm that receipt data is retrievedcorrectly



9

Service provider(Administrator) Deployment partner(Administrator)

Deployment partner(Technician)

Contact Epson when servicedevelopment is complete

*: Test groups and stores used for development must be registered.



10

Configure the Development/ProductionEnvironment

Epson provides two environments for OmniLink Merchant Services:

Sandbox environment: Used for development and testing of services.

Production environment: Used post-development to process live receipt data from in-store printers

Sign in

Make sure you have already received the invitation email from OmniLink Marchant Services.

A Access the OmniLink Management Console from the following URL, and sign in.

North America region

Sandbox Environment: https://sandbox.omnilinkworld.com/admin/login

Production Environment: https://service.omnilinkworld.com/admin/login

Europe region

Sandbox Environment: https://sandbox.omnilinkmerchantservices.eu/admin/login

Production Environment: https://service.omnilinkmerchantservices.eu/admin/login

B When signing in for the first time, enter your email address and the initial password described in theinvitation email and then click Sign in.


Configure the Development/Production Environment

11

C Read the terms of use and other information, and then select the check box to indicate your agreement.Next, enter a new password and name and then click Save.

Subsequent logins will be performed using the new password configured here.

The * indicates required field.

Item Description

Old Password Enter the initial password described in the invitation email.

New Password

Enter a new password that satisfies the following conditions.

o Within 8 to 32 characters

o Not identical to your email address

o Usable characters: Single-byte alpha-numeric characters and symbols (!#$%&*+=?@_-)

o Includes at least 2 of the following types: Lowercase alphanumeric characters,uppercase alphanumeric characters, numbers, and symbols

New Password (Confirm) Enter the password again for confirmation.

Name

Enter a name that satisfies the following conditions.

o Within 1 to 64 characters

o Includes at least 1 single-byte character

o Does not include commas

Home appears after signing in.



12

Signing Out

This section describes the signout procedure.

A Click at the upper-right of the screen.

B Click Sign out.



13

Registering Groups

Registering Groups

With OmniLink Merchant Services, multiple stores are managed as groups.

During developing services test stores and groups may be used. However, in the production environment, actualstores and groups must be registered.

Note:Up to 1,000 groups can be registered.

A Access the OmniLink Management Console and sign in. U “Sign in” on page 11

B From Team & Group, select the team and then click Add Group.

C Modify the group name and other values.



14

Item Description

Decline of dataclassification rate (%)

Specifies the rate of decline when comparing the current data classification rate with theaverage data classification rate for the past 7 days. A notification is sent when the dataclassification rate falls below the specified rate.

A notification is sent only once the number of prints exceeds the number specified withMinimum print count (sheets/day).

Minimum transaction count(sheets/day)

Specifies the minimum number of prints every 24 hours used as the trigger for notificationsof changes in the data classification rate. A notification is sent when the number of printsexceeds the specified number.

Changing Group Information

This section describes the procedure to change group information.


B From Team & Group , select the team and then select the group for which you want to change itsinformation.

C Click Group and Members.



15

D Check the currently registered information and then click Edit in Group.

E Modify the group name and other values.

Item Description

Decline of dataclassification rate (%)

Specifies the rate of decline when comparing the current data classification rate with theaverage data classification rate for the past 7 days. A notification is sent when the dataclassification rate falls below the specified rate.

A notification is sent when the number of prints exceeds the number specified withMinimum print count (sheets/day).

Minimum transaction count(sheets/day)

Specifies the minimum number of prints every 24 hours used as the trigger for notificationsof changes in the data classification rate. A notification is sent when the number of printsexceeds the specified number.



16

Deleting Groups

This section describes the procedure to deletes groups.

Groups with registered stores cannot be deleted. Delete the stores in a group before deleting the group.

Deleting a group clears the member assignment.


B From Team & Group , select the team and then select the group you want to delete.




17

D Click Delete in Group.

E Confirm the message and click Delete.



18

Managing Members

Registering Members

Register members who use OmniLink Merchant Services.

A member must belong to one team. Select the team and add members.


B From Team & Group, select the team and then click Team Members.

C Click .



19

D Configure the following setting items and click Save.


Item Description

ID (Email)Enter the member's email address.

The email address entered here will be used as the login ID.

ID (Email) (Confirm) Enter the email address again for confirmation.

AdministratorSelect this check box to give the user the Administrator right.

We recommend that you give all members the Administrator right during servicedevelopment.

When adding members for the first time, an email with the OmniLink Merchant Services URL and initialpassword is sent to the entered email address.

Members can sign in using the information in this invitation email after receiving it. U “Sign in” onpage 11

The invitation email will still be sent to the entered email address if an entered email address is alreadyregistered.



20

Deleting Members

This section describes the procedure to delete members in a team.


B From Team & Group, select the team and then click Team Members.

C Click the member you want to delete.

D Click Delete.



21

E Confirm the message and click Delete .



22

Assigning Members to Groups

Members can only access information on stores and printers when the members, stores, and printers are all in thesame group.

During developing services test members and groups may be used. However, in the production environment,actual members and groups must be registered.

The following rights are available to be assigned to members.

o Technician

o Developer

U “Rights and Available Features” on page 132


B From Team & Group , select the team and then the group to which you want to assign members.




23

D Click Edit in Members.

E Select the desired check boxes to give each member specific rights and then click Save.

Note:If the Administrator right is given to a member being assigned, both the Technician and Developer check boxes will beselected. In this case, just click Save.



24

F Check that the members have been assigned to the group.

What rights have been assigned to which members can be verified.



25

Managing Stores

Note:Up to 50,000 stores can be registered into one group.

Registering Stores

Register the stores using OmniLink Merchant Services and then select the services that will be used by these stores.

Actual stores do not need to be registered during service development. Register test store instead.


B From Team & Group , select the team and then select the group into which you want to register stores.

C Click .



26

D Enter the store information in the Store Information section.


Item Description

Brand Name Enter the brand name of the store. For chain stores, enter the chain store name.

Store Name Enter the store name.

Tags Store-related tags can be entered. Setting tags makes it easier to search stores onthe list screen.

Separate multiple tags with a comma.

Address 1 Enter the Street address.

Address 2 Enter the building name, etc.

CityEnter the address of the store.

State/Province

Country Select the country where the store is located.

Zip/Postal Code Enter the zip code or postal code.

Phone Enter the telephone number.



27

Item Description

Email Enter the email address.

Timezone Select the time zone of the country or region where the store is located.

Language - Region Select the language used on the POS device.

Currency Select the currency used on the POS device.

E In the Services section, select the check boxes assigned to the team and then click Save.

Viewing Store Information

Store information and printer information registered to stores can be viewed.


B From Team & Group , select the team and then select the group from which you want to view storeinformation.



28

C Click Stores if nothing appears on the Stores screen.

Store information appears in list format.

a

b

dc

e

Description

aUse to add store information.

U “Registering Stores” on page 26

bStore information appears in list format. Clicking the title of each column sorts the list in ascending/descendingorder.

Clicking a store displays detailed store information and the printers registered to the store.

cInformation on multiple stores and printers can be registered at the same time.

Refer to the Setup Guide for more information.

d Filter the display content based on store name, serial number of the printer, or other information.

e The display range can be changed once the number of stores exceeds 100.



29

Changing Store Information

This section describes the procedure to change store information.


B From Team & Group , select the team and then select the group for which you want to change storeinformation.

C Click the store where you want to change store information.



30

D Check the currently registered information and then click Edit.

E Edit the following setting items and click Save on the bottom of the screen.

See “Registering Stores” on page 26 for more information regarding the parameters that can be entered.Model and Serial # cannot be changed.



31

Deleting Stores

This section describes the procedure to delete registered stores.


B From Team & Group , select the team and then select the group from which you want to delete stores.

C Click the store you want to delete.



32

D Click Delete.




33

Managing Printers

Registering Printers

Even without actual printers, you can use the sample receipt feature to issue receipt data in the sandboxenvironment. To do so, use the following procedure to register test printers beforehand.

You can also register actual printers in the sandbox environment and print receipts to send receipt data to servers.

Note:Up to 100 printers can be registered to one store.


B From Team & Group , select the team and then select the group into which you want to register printers.

C Click the store to which you want to register printers.



34

D In the Devices section, click Add.

E Configure the following setting items and click Save on the bottom of the screen.

Item Description

Printer InformationEnter basic information of the TM printer.

U “Printer Information” on page 36

POS Information Select the currency, decimal separator, and the grouping separator that are used in the POSsystem.

NTP Enter the hostname of the NTP server.

Updating Printer SettingsSpecify the timing at which printer settings, such as receipt mapping and QR code settings,are applied.



35

Printer Information


Item Description

Model Select the TM printer model from the pull-down menu.

Serial # Enter the serial number of the TM printer.

Serial # (confirm) Enter the serial number of the TM printer again for confirmation.

Connected POS Name Enter the name of the POS device connected to the printer.

Location Enter the information of location where the TM printer is installed.

Description Enter note information for the printer.

Note:Make sure to enter the printer's serial number correctly. Registering the printer with a wrong serial number will result inerrors of data management. You can find the serial number on the label attached to the printer.



36

Viewing Printer Information

This section describes the procedure to view printer information.


B From Team & Group , select the team and then select the group from which you want to view printerinformation.

C Click the store with the printer information you want to view.

D In the Devices section, click the printer you want to view.



37

E Click Printer Setting.

F View the printer information.



38

Changing Printer Information

This section describes the procedure to change printer information.


B From Team & Group , select the team and then select the group from which you want to change printerinformation.

C Click the store with the printer information you want to change.

D In the Devices section, click the printer you want to change.



39


F Check the currently registered information and then click Edit.



40

G Edit the following setting items and click Save on the bottom of the screen.

See “Registering Printers” on page 34 for more information regarding the parameters that can be entered.Model and Serial # cannot be changed.

Deleting Printers

This section describes the procedure to delete printers.


B From Team & Group , select the team and then select the group from which you want to delete printerinformation.



41

C Click the store with the printer information you want to delete.

D In the Devices section, click the printer you want to delete.




42

F Click Delete.

G Confirm the message and click Delete.



43

Using the Sample Receipt Function

With the sample receipt function, you can uploaded editable receipt data to sandbox services.

Note:The sample receipt function can only be used in the sandbox environment.


B From Team & Group , select the team and then select the group that will be used to issue sample receipts.

C Click the store that will be used to issue sample receipts.

D In the Devices section, click the printer that will issue sample receipts.



44

E Click Test.

F Select either Restaurant or Retail for the category.



45

G Select the sample receipt you want to use.

H Edit the receipt data as necessary.

Note:The receipt ID is a random value. The date and time are automatically updated with the date/time of a sample selection.



46

I Click Upload Sample Receipt to upload receipt data to the server.

J Click OK.

Use the following procedure to verify that the uploaded sample receipt was received correctly.

K Click Summary.



47

L If Received appears for Transaction under Status, the date of Latest Transaction is the date that the samplereceipt was issued.

M Click to display the Latest Transaction information.



48

N Check that the receipt data sent in step 9 appears.

Click to return to the previous screen.

Click Reload to retrieve the Latest Transaction information again.



49

Connecting Printers to OmniLink Merchant Services

Set up the TM printers and configure the network settings to use the OmniLink Merchant Services.

This section does not need to be read if using the sample receipt function (U “Using the Sample ReceiptFunction” on page 44) in the sandbox environment to upload receipt data to servers instead of printing receiptsfrom actual printers.

Note:You can find the product name on the label attached to the printer.

Setup Process Flow

1. “Connecting the TM Printers” on page 51

Connect a TM printer to a POS device.

2. “Configuring the Network Settings” on page 51

Configure the TM printer to connect to the network.

3. “Connecting to the Cloud Server” on page 52

Configure settings to enable a connection to the Epson Cloud Server.

4. “Checking Connection to the Epson Cloud Server” on page 55

Print the status sheet from the printer and check that the printer is connected to Epson Cloud Server.



50

Connecting the TM Printers

Connect the TM printer to a POS system.

A Connect the AC adapter to the printer.

B Insert the power plug into the wall outlet.

C Connect the printer to a POS terminal.

D Connect the printer to the network via the LAN cable.

E Load the roll paper in the printer.

Configuring the Network Settings

Configure the network settings using TM-T88VI Utility.

For more details, see User‘s Manual of TM-T88VI Utility.



51

Connecting to the Cloud Server

Connect the TM printer to the sandbox or production environment.

A Start TM-T88VI Utility. Select Detailed Settings from TM-Intelligent, then click OmniLink MerchantServices.

B Select the OmniLink Merchant Services check box to enable OmniLink Merchant Services.



52

C Configure the proxy server settings if necessary.

1. Select Server Access from TM-Intelligent, then click Proxy.

2. Select the Proxy check box, and enter the URL, ID, password, and port of the proxy server. Then set theOmniLink Merchant Service option to Enabled.



53

D Click Set to apply the settings.

E Access the URL below using a web browser.

http://xxx.xxx.xxx.xxx/config_epson_cloud_service.cgi

Note:

o Replace the "xxx.xxx.xxx.xxx" with the IP address of the printer. Ex:) http://192.168.192.168/config_epson_cloud_service.cgi

o For information on how to check the printer‘s IP address, see the User‘s Manual of TM-T88VI Utility.

F Change the end point of printers.


Sandbox Environment IP : sandbox.omnilinkworld.com

Production Environment IP: omnilinkworld.com

Port: 443

Europe region

Sandbox Environment IP: sandbox.omnilinkmerchantservices.eu

Production Environment IP: omnilinkmerchantservices.eu

Port: 443

G Reboot printer.



54

Checking Connection to the Epson Cloud Server

Print a status sheet from the TM printers and check that the connection destination has been set to the sandbox orproduction.

Note:For information on how to print the status sheet, see Technical Reference Guide of the corresponding printer.

Check the “OmniLink Merchant Service“ field on the status sheet.

When the printer is connected to the sandbox or production server, printed as shown below.

North America Region:

***

***

OmniLink Merchant Service

Server

:sandbox.omnilinkworld.com

Server Status

:Connection Enable

Last Upload Date

***

***


Server

:omnilinkworld.com

Server Status

:Connection Enable

Last Upload Date

Sandbox Environment Production Environment

Europe Region:

***

***


Server

:sandbox.omnilinkmerchantservices.eu

Server Status

:Connection Enable

Last Upload Date

***

***


Server

:omnilinkmerchantservices.eu

Server Status

:Connection Enable

Last Upload Date

Sandbox Environment Production Environment

If not printed as above, confirm the network settings of the printer. It may be necessary to power-cycle the printeronce or twice to allow it to establish an external connection.



55

Checking Advanced Printer Driver Settings

If using the Advanced Printer Driver, follow the procedure below to substitute the font types. Doing so enables theprinter to print characters not as images, but as text.

The procedure differs by version of the Advanced Printer Driver.

A In Control Panel, open Devices and Printers. Right-click the printer icon, then click Printing preferences.

B On the Printing preferences screen, click the Advanced Settings tab, and click Advanced Settings.



56

C Click Font Replacement.

D Select a substitute Device Font appropriate for each True Type Font, and click Set.



57

Checking the Receipt Data Send Results

After printing a receipt to the TM printer, the receipt data is forwarded to the sandbox or production server.

Once receipt data has been forwarded to the server, check to see if the receipt data has been parsed properly on theOmniLink Management Console.

This section does not need to be read if using the sample receipt feature (U “Using the Sample Receipt Function”on page 44) in the sandbox environment to upload receipt data to servers.


B From Team & Group , select the team and then select the group from which you want to check receipt data.

C Click the store from which you want to check receipt data.



58

D In the Devices section, click the printer used to check receipt data.

E If Received appears for Transaction under Status, the date of Latest Transaction is the date that the receiptwas printed.

F Click to display the Latest Transaction information.



59

G Check that the printed receipt appears in the Printed text area, and then click .

Click Reload to retrieve the Latest Transaction information again.

Note:

o If the receipt data is in the Printed text area, but the contents of the receipt are not displayed, check the POS systemto see if it prints text data. OmniLink Merchant Services does not support image data. If using the Advanced PrinterDriver refer to, U “Checking Advanced Printer Driver Settings” on page 56

o If no data appear in the Printed text area, check the RTC time settings of the printer. If the time is not correct, receiptdata is not sent. Use TM-T88VI Utility to configure the RTC time settings. For more details, see the User‘s Manual ofTM-T88VI Utility.



60

Configuring Printers

With OmniLink Management Console, the following print and data settings can be configured.

These settings can be saved with a version name so that different versions of configurations can be applied toindividual printers.

o “Receipt mapping” on page 61

o “QR Code Setting” on page 82

o “Contents Print Setting” on page 94

o “Data Filtering and Masking Setting” on page 105

o “Scanner Transmission Setting” on page 117

Receipt mapping

This section describes the procedure to map receipt data sent by the OmniLink Management Console inaccordance with the data mapping rules configured with the Data Mapping settings in OmniLink ManagementConsole.

Configure data mapping rules to confirm that receipt data is correctly mapped.

Refer to “Screens and Functions” on page 68 and configure data mapping rules using the procedure described in“Creating and Applying Versions” on page 61.

Creating and Applying Versions

A Print a receipt from the TM printer, and send the receipt data to the server.

B Access the OmniLink Management Console and sign in. U “Sign in” on page 11

C From Team & Group , select the team and then select the group from which you want to perform the receiptmapping process.



61

D Click the store from which you to perform the receipt mapping process.

E In the Devices section, click the printer for which you want to perform the receipt mapping process.

F Click Other Settings.



62

G Click Edit in Receipt Mapping.

Note:The version currently applied to the printer is displayed under Version Name.

H Configure the search criteria and then click Search.



63

Item Description

Select

Unmapped Displays unmapped receipt data.

Mapped Displays mapped receipt data.

By GUID Displays receipt data specified by GUID.

Sort Order Specifies the sort order of extracted receipt data.

Date Range

Specifies the period in which to extract receipt data.

Periods of up to the past 30 days can be specified.

After data mapping rules have been configured, receipt datafor the specified period will be mapped according to the newdata mapping rules.

I Select receipt data that you want to use to configure data mapping rules.

a

b

c

Description

a The display range can be changed once the number of stores exceeds 100.

b Receipt data appears here. Clicking here displays the receipt mapping screen.

c

Extract receipts based on the entered text string.

o Include: Displays only receipts that include the entered text string.

o Exclude: Displays only receipts that do not include the entered text string.

o Clear: Clears the entered text string.



64

J Configure data mapping rules following the Data Mapping screen instructions.

Note:

o Refer to Workflow Overview at the upper-right of the screen for information on the procedure to configure datamapping rules.

o Refer to “Screens and Functions” on page 68 for more information.

K After configuring data mapping rules, click Remap All and select the range to be mapped.

Clicking Remap All maps receipt data in accordance with the configured data mapping rules.



65

L Confirm the message and then click Remap.

M Confirm the message and then click OK.

The configured content is saved as a new version.

The name of the version is configured in the [Printer serial number]-[Name of configuration]-[Registereddate and time] format.

If necessary, use the following procedure to change the version name and add a Comment.

N Click Manage Versions.

O Select the previously registered version and then click Edit.



66

P Enter the Name and Comment and then click Save.

Q Confirm that receipt data is retrieved correctly via services.



67

Screens and Functions

This section describes the configuration of the Data Mapping screen.

Note:Moving the mouse pointer over the icon in the header of each section displays a description of that section.

o “Properties” on page 68

o “Data Mapping” on page 72

o “Receipt/Report/Shift” on page 75

PropertiesThe settings properties for data mapping rules are divided into the following three tabs: Receipt, Report, and Shift.



68

Receipt

This tab displays settings properties of receipt data mapping rules.

Item Description

Printed at Date and time this receipt was printed or the transaction occurred (local time).

Products A list of purchased products.

Receipt ID The receipt identifier issued by the shop's POS system (does not identify a receipt globally).

Total Total value of transaction after taxes are applied.

Consumer ID Consumer ID.

Discounts List of receipt global discounts.

Guests Number of guests.

Is Refund True if the receipt is a refund.

Is Void True, if this receipt has been made void.

Extra Items User can define the property. (Max. 8 items can be defined)



69

Item Description

Payment methods Breakdown of sales total by payment method.

Sales typeA sales type descriptor indicating one of eat IN, eat OUT, drive THRU, CATERING, orDELIVERY.

Staff Identifying information of the staff member who handled the transaction.

Subtotal Total value of transaction before taxes are applied.

Taxes List of tax entries.

Report

This tab displays settings properties of report data mapping rules regarding a particular day's transactions.

Item Description

Date The date to which this report applies.

Gross Total value of transactions before deductions.

Net Total value of transactions after deductions.

Printed at Date and time this report was printed/generated.

Guests Total number of guests.

Taxes List of tax entries.



70

Shift

This tab displays settings properties of shift data mapping rules regarding shift information of the staff members.

Item Description

Date Date the shift was worked.

Staff Information identifying the staff member who worked this shift.

Start time Time the shift started.

End time Time the shift ended.

Hours worked Hours worked.

Role Role (e.g. Manager).



71

Data MappingThis section is used to configure data mapping rules for the settings properties selected in “Properties” on page 68.

Mapped properties display the results of mapping.

Configuring Data Mapping Rules

Refer to Workflow Overview at the upper-right of the screen for information on the procedure to configure datamapping rules.



72

Setting Screen

a b

d

c

e

f

Description

a Cancels the selected property settings.

b Clears the configured rules selected in section e .

cMaps receipt data per the configured rules.

Data can be mapped after the required parameters marked by the icon have been configured.

If data is mapped successfully, the software transitions to the Mapping.

dDisplays the selected property settings.

The icon indicates required parameters.

Click and select the desired parameters and then select values on the “Receipt/Report/Shift” on page 75 tabs.

e Displays the values selected on the “Receipt/Report/Shift” on page 75 tabs.

f Displays a description of the settings selected in section d .

Mapping Successful Screen

a b

d

c

e



73

Description

a Cancels the selected property settings.

b Resets property settings.

c Applies configured data mapping rules.

d Displays the contact form.

e Displays mapping results.

Mapping Failed Screen

a

b

c

Description

a Confirm the value specified for each setting. Select Yes if the value is correct or select No if it is not.

b This section can be edited if No is selected for section a .

c Displays the resolution method in accordance with the selection of section a .



74

Receipt/Report/ShiftThese tabs display receipt data that you want to use to configure data mapping rules.

This section is used to specify settings values when configuring data mapping rules in “Data Mapping” on page 72.

Right-click to specify values for the data mapping settings as described in “Data Mapping” on page 72.



75

Changing the Applicable Version

The applicable version can be changed.

The applicable version can be selected from versions registered in the corresponding group and that have been usedby that printer in the past.


B From Team & Group , select the team and then the group for which you want to change the version.

C Click the store for which you want to change the version.

D In the Devices section, click the printer for which you want to change the version.



76

E Click Other Settings.

F Click Edit in Receipt Mapping.




77

G Click Load Version.

H Enter the name of the desired version name and then click .

I From the list, select the desired version and then click Load.

The version is applied, and then the screen is closed.



78

Copying Versions to Other Groups

The version can be copied to another group so that the same version can be used for the other group.


B From Team & Group, select the team and then the group for which you want to copy the version from.

C Click the store for which you want to copy the version from.

D In the Devices section, click the printer for which you want to copy the version from.



79


F Click Edit in Receipt Mapping.




80

G Click Manage Versions.

H Select the version to copy and then click Copy to Another Group.



81

I Enter the Name and Comment, select the check box of the group you want to copy to and then click Copy.

The version will be copied to the specified group and then can be used in the group.

QR Code Setting

The TM printer can print a QR code that includes a unique ID. The ID is used to associate the physical receipt withOmniLink Merchant Services data.



B From Team & Group , select the team and then select the group for which you want to configure QR codesettings.



82

C Click the store for which you want to configure QR code settings.

D In the Devices section, click the printer for which you want to configure QR code settings.




83

F Click Edit in QR Code.


G Check the currently registered information and then click Edit.



84

H Configure the following setting items and click Save on the bottom of the screen.

Item Description

Print QR Enable/disable printing of QR codes.

Base URL Enter the URL embedded in the QR codes.

Regex pattern to triggerQR-Code

Use a regular expression to enter the conditions by which a QR code is printed.

U “Writing Regular Expressions” on page 145

Regex pattern to extract"Total"

Use a regular expression to enter the conditions by which the total amount is extracted ifembedding the total receipt amount in QR codes.


Regex pattern to extract"Transaction ID"

Use a regular expression to enter the conditions by which the ID is extracted if embeddingthe receipt ID in QR codes.


HeaderEnter a custom text string to be printed above the QR code.

To change the style of font, add the commands as shown in the Sample table below.

FooterEnter a custom text string to be printed below the QR code.

To change the style of font, add the commands as shown in the Sample table below.

Horizontal distance unitfrom left

Set the position from the left horizontal edge at which the QR code is printed.

Size of one module (pixels) Specify the size of 1 module in which the QR code is configured.

Error correction level Select the level (intensity) of QR code error correction.



85

Sample

Sample text and commands Print image

Bold \x1B\x45\x01This is a bold text. \x1B\x45\x00\x0A This is a bold text.

Centering \x1B\x61\x01This is a centering text. \x0A\x1B\x61\x00 This is a centering text.

Underline \x1B\x2D\x01This is a underline text. \x1B\x2D\x00\x0A This is a underlined text.

Note:

o To change the style of font, “\x0A“ is required at the end of the command string.

o By adding a QR code, it will take longer to print a receipt. If the POS application monitors the time spent on printinga receipt, a timeout error may occur. If a timeout error occurs, make the QR code smaller, or reduce the number ofcharacters in the header or the footer.


The version name at this time is automatically registered in the [Printer serial number]-[Name ofconfiguration]-[Registered date and time] format.


I Click Manage Versions.

J Select the previously registered version and then click Edit.



86

K Enter the Name and Comment and then click Save.








87






88






89










90






91






92






93

Contents Print Setting

The printing of image content sent to the printer beforehand can be triggered with matching conditions, such as bytime that a receipt is printed or by product name.



B From Team & Group , select the team and then select the group for which you want to configure contentprint settings.

C Click the store for which you want to configure content print settings.

D In the Devices section, click the printer for which you want to configure content print settings.



94


F Click Edit in Contents Print.




95


H Configure the following setting items and click Save on the bottom of the screen.

Item Description

Print contents Enable/disable printing of content.

Available Enable/disable this content.



96

Item Description

Regex to print image Enter a regular expression into the text box that describes the conditions by which imagecontent is printed.


Image Click Upload Image to upload the print image.

A preview of the image appears in black-and-white in the format when actually printed onreceipts. The following image types and sizes are supported.

o Image size: Max. 500 pixels in width and 700 pixels in height

o Image format: PNG, JPEG, BMP

Click Remove Image to delete an uploaded image.

Note:By adding an image using the Contents Print function, it will take longer to print a receipt. If the POS applicationmonitors the time spent on printing a receipt, a timeout error may occur. If a timeout error occurs, reduce the image size.


The version name is automatically registered in the [Printer serial number]-[Name ofconfiguration]-[Registered date and time] format.

If necessary, use the following procedure to change the version name and add a comment.




97









98






99





100








101









102





103





104



Data Filtering and Masking Setting

Sending of receipt data to the server can be enabled/disabled depending on the content of the receipt printed by aprinter.

Certain text strings, such as personal information, can be masked before this data is sent to the server.



B From Team & Group , select the team and then select the group for which you want to configure datafiltering and masking settings.



105

C Click the store for which you want to configure data filtering and masking settings.

D In the Devices section, click the printer for which you want to configure data filtering and masking settings.




106

F Click Edit in Data Filtering and Masking.





107

H Configure the following setting items and click Save.

Item Description

Enable data filtering andmasking

Set whether to filter or mask the data to be sent to the server.

Filter type Specify what receipt data is sent.

o None (send all): Send all receipt data to the server.

o Inclusive: Send only receipt data that matches the conditions configured with Regexpattern to trigger filtering to the server.

o Exclusive: Do not send receipt data that matches the conditions configured with Regexpattern to trigger filtering to the server.

Regex pattern to triggerfiltering

Use a regular expression to enter the conditions by which the receipts to be sent areidentified.


Regex patterns to identifystrings to be masked

Use a regular expression to enter the conditions by which specific text strings are convertedinto some other specified text string.


Click to enter up to 5 patterns.

Click to delete the added patterns.



If necessary, use the following procedure to change the version name and add a comment.



108





109









110






111






112










113






114






115






116

Scanner Transmission Setting

Sending of data read by a scanner connected to a printer to the server can be enabled/disabled (filtering).

We recommend that you use filtering to prevent the sending of data not intended to be sent.



B From Team & Group , select the team and then select the group for which you want to configure scannertransmission settings.

C Select the store for which you want to configure scanner transmission settings.

D In the Devices section, click the printer for which you want to configure scanner transmission settings.



117


F Click Edit in Scanner Transmission.




118


H Configure the following setting items and click Save.

Item Description

Scanner transmission Enable/disable the sending of scanned data to the server.

Filter scanned data Enable/disable the sending of data that satisfies the conditions configured with Regexpattern to filter scanned data to the server.



119

Item Description

Regex pattern to filterscanned data

Use a regular expression to enter the conditions by which the sending of scanned data issent to the server.









120









121






122






123










124






125






126






127

Migrate to the Production Environment

When your service (application) is fully integrated and tested using the sandbox environment, migrate it to theproduction environment to use printers installed in stores and process their actual data.

Furthermore, if the service was developed using a printer that is to be installed at the store, the connectiondestination cloud server setting of the printer that was used also needs to be changed from the sandboxenvironment to the production environment.

Note:Data in the database of the sandbox environment cannot be migrated to the production environment.

Migrating the Service

A Change the destination cloud server of your service (application) from the sandbox server to the productionserver.

B Replace your credentials for the sandbox with the credentials for the production server.

Note:For information on how to get the credentials for the production server, please send an email [email protected] (North America region) / [email protected] (Europe region).

Changing the Printer Setting

A Access the URL below using a web browser.

http://xxx.xxx.xxx.xxx/config_epson_cloud_service.cgi

Note:Replace the "xxx.xxx.xxx.xxx" with the IP address of the printer.

B Change the end point of printers.


IP: omnilinkworld.com

Port: 443

Europe region

IP: omnilinkmerchantservices.eu

Port: 443



128

C Reboot printer.

D Print a status sheet and check that the connection destination server has been set to omnilinkworld.com"(North America region) or "omnilinkmerchantservices.eu" (Europe region).

For information on how to print the status sheet, see “Checking Connection to the Epson Cloud Server” onpage 55.



129

Troubleshooting

Problem Check Description

Cannot print.

Is the roll paper loaded in theprinter?

Is the roll paper loaded in thecorrect direction?

Is printer power on?

Load the roll paper in the correct direction.

For information on how to set up the printer, see the User'sManual of the printer.

Turn the printer on.

"Enable" is notprinted inConnection Test.

Is it possible to see web pages viathe Internet on any other deviceson the same network?

Check the network settings (“Configuring the NetworkSettings” on page 51). To use the OmniLink MerchantServices, the printers must be connected to the Internet.

Check the status sheet referring to“Connecting to the Cloud Server”on page 52 to see if the printer isconnected to the correct server.

o Print the status sheet again after a few minutes. It maytake time to establish connection with the production.

o Check the network settings of the printer. Afterchanging the settings the printer may have to berebooted to establish a connection with an externalnetwork.

Settings of OmniLinkManagementConsole are notreflected to theprinters.

Did you turn off the printer andthen turn it back on?

After changing the settings of OmniLink ManagementConsole, turn the printer off and then back on. Otherwise, thechanges will not take effect on the printer.

Receipt data is notsent to the cloudserver.

Does the printer cut receipt afterprinting?

Receipt data is not sent to the cloud server if the cutoperation is not performed.

Configure the POS system to let the printers cut receipt afterprinting.

Is the date setting in the datamapping rules appropriate?

Such as MM/DD/YY is misread asDD/MM/YY?

Configure the date setting in the data mapping rulesproperly in Data Mapping Settings.

Is there any problem inconnecting with the cloud server?

Check the network settings of the printer, router settings,and other network-related settings.

Cannot access theproductionenvironment.

Cannot get receiptdata from theproductionenvironment.

Are you using the appropriateWebAPI credentials for theproduction environment?

Web API credentials for the sandbox environment cannot beused for the production environment.

Get your Web API credentials for the productionenvironment, then use the credentials to access theproduction environment.

Receipt data hasbeen successfullysent to the cloudserver, but thecontents of thereceipt are notdisplayed.

Does the POS system print textdata?

If the POS system has used the EPSON Advanced PrinterDriver (APD), change the settings of the driver. (“CheckingAdvanced Printer Driver Settings” on page 56)

If the POS system has not used the APD, check the POSsystem to see if it prints text data.

OmniLink Merchant Services does not support image data.


Troubleshooting

130

Problem Check Description

The QR code is notprinted asconfigured inOmniLinkManagementConsole (“QR CodeSetting” on page 82).

Is the “QR Code Setting” onpage 82 reflected to the printer?

Reboot the printer.

It is necessary to restart it for reflecting the settings of theOmniLink Management Console.

Note:

o Using the latest firmware of the printer is recommended. For information on the latest version of the firmware pleasemake an inquiry by emailing [email protected] (North America region) / [email protected] (Europeregion).

o User is logged out if another user logs into OmniLink Management Console with the same login ID at the same time.

o If you have any trouble with this system, please email us at the following address.North America region: [email protected] region: [email protected]


Troubleshooting

131

Appendix

Rights and Available Features

OmniLink Merchant Services has 3 user rights. The features available vary by right.

Rights

The following table describes the three user rights.

Type Target group Description

Administrator o Deployment partneradministrators

o Service provideradministrators

This user has access to all OmniLink Merchant Services features.

This user is assigned to users that manage and control the servicein whole.

Technician Deployment partnerusers

This user can install printers in stores, configure settings to senddata to the OmniLink Merchant Services server, and so on.

Developer Service provider users This user can view store and printer information.

Rights and Correspondingly Available Features

The following table describes the specific features available to each user right.

: Available, Blank: Not available

Feature Administrator Technician Developer

Administratormanagement

Administrator accountregistration

Administrator rightassignment

Administrator rightremoval


Appendix

132


Group management/members

Register groups

Change groupinformation

Delete groups

Register members

Delete members

Assign members

Configure receiptmapping errornotification conditions

Store management Register stores

View store information

Change storeinformation

Delete stores

Batch registration ofstores

Select services for use

Printer information Register printers

View printer information

Change printerinformation

Delete printers

Batch registration ofprinters

Receipt mapping Create versions

Edit versions

View versions

Apply versions


Appendix

133


QR Code Setting Create versions

Edit versions

View versions

Apply versions

Contents Print Setting Create versions

Edit versions

View versions

Apply versions

Data Filtering andMasking Setting

Create versions

Edit versions

View versions

Apply versions

Scanner TransmissionSetting

Create versions

Edit versions

View versions

Apply versions

Operational logs View operational logs

Printer monitoring Monitor networkconnectivity

Monitor receiptmapping status

Monitor print counts

Print history View print history

Download print historyas CSV files

Update printerfirmware/SSLcertificate

Update firmware/SSLcertificate


Appendix

134

Updating Account Information

Changing Email Addresses

The email addresses used for signins can be changed.


B Click at the upper-right of the screen.

C Click My Account.


Appendix

135

D Click Edit next to ID (Email).

E Enter a new email address and click Save.

F A confirmation email will be sent to the new email address. Log in using the URL described in the email andenable the new email by following the on-screen instructions.


Appendix

136

Changing Passwords

This section describes the procedure to change passwords.



C Click My Account.

D Click Edit next to Password.


Appendix

137

E Configure the following setting items and click Save.

Item Description

Old Password Enter the old password.

New Password Enter the new password.

New Password (Confirm) Enter the password again for confirmation.

F Sign out and then sign in again using the new password.


Appendix

138

Changing Account Names

This section describes the procedure to change your account name.



C Click My Account.

D Click Edit in Account Information.


Appendix

139

E Enter the new name and then click Save.


Appendix

140

Deleting Your Account

This section describes the procedure to delete your account.



C Click My Account.

D Click Delete.


Appendix

141



Appendix

142

Viewing Operational Logs of Store/PrinterInformation

This section outlines the procedure to view the operational history of additions, changes, and deletions to store andprinter information.


B From Team & Group , select the team and then select the group for which you want to view operational logs.


D View the last 5 entries in the operational log in the Activity section.


Appendix

143

E Click Show All.

F View the last 14 days of the operations log.

b

a

Description

a The last 14 days of operational history regarding store and printer information (adds/changes/deletes) appearshere.

b The display range can be changed once the number of stores exceeds 100.


Appendix

144

Writing Regular Expressions

This section describes the regular expressions used when configuring QR code, content print, and other printersettings.

Printers may not operate as intended depending on how regular expressions are written. Make sure to verifyoperation before using configurations in production environments.

Regular Expression Format

Regular expressions must be described in conformation of the following standards as defined in POSIX1003.2.

o Basic regular expressions: Basic Regular Expression (BRE)

o Extended regular expressions: Extended Regular Expression (ERE)

Note:https://www.regular-expressions.info/posix.html

Regular Expression Description Patterns

The following two types of regular expression description patterns are used with OmniLink Merchant Services.

o Pattern 1: Identification of receipts

o Pattern 2: Identification of location of receipt data

Pattern 1: Identification of receipts

A determination of “True“ is made if the entire text string matches the regular expression (full match).

Example Definitions of Regular Expression Patterns

o Pattern 1-1: Includes “AAA“ (all lines)(?s)^.*AAA.*$

o Pattern 1-2: Includes “AAA“ and “BBB“ (all lines)(?s)^(?=.*AAA)(?=.*BBB).*$

o Pattern 1-3: Does not include “CCC“ (all lines)(?s)^(?!.*CCC).*$

o Pattern 1-4: Includes “AAA“ but does not include “CCC“ (all lines)(?s)^(?=.*AAA)(?!.*CCC).*$

o Pattern 1-5: Does not include “AAA“ or “BBB“ (all lines)(?s)^(?!.*(AAA|BBB)).*$


Appendix

145

Pattern 2: Identification of location of receipt data

The second group of regular expression values is used.

If the “Description pattern“ in the following table contains “2. Identification of location of receipt data“, you mustdescribe a regular expression that retrieves values into the second group.

Example Definitions of Regular Expression Patterns

o Pattern 2-1: Retrieves all text string to the right of “XXX“(XXX) *(.*)

o Pattern 2-2: Retrieves the first text string to the right of “XXX“(XXX) *([a-zA-Z0-9.]*)

o Pattern 2-3: Retrieves the first text string on the next line after “XXX“(XXX).*\n *([a-zA-Z0-9.]*)

Note:

o The “AAA“, “BBB“, “CCC“, and “XXX“ in the examples above can also be expressed using regular expressions.For example, to set this to a 5 digits of numbers between 0 and 4, you can express this as [0-4]{5}.

o Multiline mode regular expressions starting with (?m) are not supported.

Description Patterns of Regular Expressions by Type of Printer Settings

Setting name Setting item name Description pattern

QR Code

Regex pattern to trigger QR-Code 1. Identification of receipts

Regex pattern to extract "Total" 2. Identification of location of receipt data

Regex pattern to extract "Transaction ID" 2. Identification of location of receipt data

Contents Print Regex pattern to print content 1. Identification of receipts

Data Filtering andMasking

Regex pattern to trigger filtering 1. Identification of receipts

Regex pattern to identify strings to bemasked

2. Identification of location of receipt data

Scanner Transmission Regex pattern to filter scanned data 1. Identification of receipts


Appendix

146

Example Regular Expressions

Contents Print

o Regex pattern to print contentInsert coupons between 07:00 and 09:59 only (Pattern 1-1)(?s)^.*0[7-9]:[0-5][0-9].*$

Insert coupons only from 20:00 to 20:59, only on Fridays (Pattern 1-2)(?s)^(?=.*Friday)(?=.*20:[0-5][0-9]).*$

Data Filtering and Masking

o Regex pattern to trigger filtering (inclusive filter)Send only receipts that include “Thank you“ text but not “REPRINT“ text to the server and do not send otherdata (Pattern 1-4)(?s)^(?=.*Thank you)(?!.*REPRINT).*$

o Regex pattern to trigger filtering (exclusive filter)Do not send receipts with “CARD READ“ text to the server and send all other data (Pattern 1-3)(?s)^(?!.*CARD READ).*$

o Regex patterns to identify strings to be maskedMask all text to the right of “HolderName: “ (Pattern 2-1)(HolderName:) *(.*)

Scanner Transmission

o Regex pattern to filter scanned dataSend only scanned barcode/QR code data that has an 8- or 13-digit value starting with 49 (Pattern 1-1)(?s)^.*49([0-9]{6}$|[0-9]{11}$).*$


Appendix

147

Operating Environment

Supported POS Systems

This service can be used for POS systems that use TM-T88VI or TM-T88VI-iHUB printers and satisfy thefollowing conditions.

o The content of receipts printed by the printers is text data.

o The printers are set to cut receipt paper after printing.

Note:Use is not possible with a POS system that sends only graphic data or rasterized data.

Supported TM Printers

Printer name Firmware version Interface

TM-T88VI 40.50 ESC/POS and later

o Serial

o USB

o Ethernet

o Wi-Fi

TM-T88VI-iHUB 50.50 ESC/POS and later

o USB

o Ethernet

o Wi-Fi

Note:

o This service requires a stable internet connection between the printer and the Epson Cloud Server.

o This service uses port 443. Make sure that port 443 is allowing connection to the Epson Cloud Server.

Limitations

True Type fonts cannot be used with the Advanced Printer Driver. Use device fonts instead.

Supported Browsers

Use of OmniLink Management Console is required for configuring the service environment.

OmniLink Management Console is an Epson website that is used for accepting applications for OmniLink servicesfrom stores, and used for managing information about the stores and their TM printers.

OmniLink Management Console supports the latest versions of the following web browsers.

o Microsoft Internet Explorer 11


Appendix

148

o Microsoft Edge

o Google Chrome

o Mozilla Firefox

o Apple Safari


Appendix

149

Open Source Software License

The OmniLink Merchant Services use open source software other than software owned by Epson.

The following is the information of the open source software.

OmniLink Merchant Services

The full text of license agreement contract is available on the following website.


https://omnilinkworld.com/license/document/copyrightinfo.html

Europe region

https://omnilinkmerchantservices.eu/license/document/copyrightinfo.html

TM-T88VI

This product uses open source software in addition to Epson proprietary software.

For information of the open source software used in this product, see the following URL.

http://xxx.xxx.xxx.xxx/licenses.html

Note:For “xxx.xxx.xxx.xxx“ in the above URL, input your printer‘s IP address.

TM-T88VI-iHUB

This product uses open source software in addition to Epson proprietary software.

For information of the open source software used in this product, see the following URL.

http://xxx.xxx.xxx.xxx/webconfig/licenses.html

Note:For “xxx.xxx.xxx.xxx“ in the above URL, input your printer‘s IP address.


Appendix

150

Trademarks

EPSON is a registered trademark of Seiko Epson Corporation.

EXCEED YOUR VISION is a registered trademark or trademark of Seiko Epson Corporation.

OmniLink is a trademark of Epson America, Inc.

Microsoft and Internet Explorer are registered trademarks of Microsoft Corporation in the United States and/orother countries.

Google Chrome is a trademark of Google Inc.

Firefox® is a registered trademark of Mozilla Foundation.

Safari® is a trademark of Apple Inc. registered in the United States of America and other countries.

QR Code is a registered trademark of Denso Wave Incorporated.

All other trademarks are the property of their respective owners and used for identification purpose only.

© Seiko Epson Corporation 2019. All rights reserved.


Appendix

151

Date post:	22-May-2020
Category:	Documents
Upload:	others
View:	7 times
Download:	0 times

OmniLink Merchant Services Development Guide · OmniLink Merchant Services Hierarchy and Work Flow...

Documents