Epson OmniLink Merchant Services V3 User guide

OmniLink Merchant

Services

Development Guide

M00122600 EN

Introduction

Manuals

e following three manuals for OmniLink Merchant Services are provided.

Development Guide (this document)

is manual provides necessary information to congure a development environment for developing OmniLink

Merchant Services (cloud-based applications) and migration of developed services to production environments for

system developers.

Setup Guide

is manual is for an installer who installs TM printers in stores. Provides necessary information for setting up the

printers to use the OmniLink Merchant Services.

Operation Guide

is document describes printer status monitoring performed daily, error handling procedures, and other aspects

of service operation.

Precautions

o Unauthorized duplication, copying, reproduction, or modication of any part or all of this document is strictly

prohibited.

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

information.

o Every eort is made to ensure that the contents of this manual are without error. Please contact us if any errors

or other issues are found.

o e 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 comply

with the content of this document, or having repair or modications performed by third parties other than

Epson or those

specied

by Epson.

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

genuine Epson parts or parts

certied

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 recovery

such as fail-safe congurations and redundant designs, for example, if this product is used in applications in which

a high level of reliability and safety in functionality and precision is required such as in aircra, trains, ships,

automobiles and other transportation-related applications or in crime prevention equipment and safety equipment.

is product is not intended for use in applications that require extremely high levels of reliability and safety such

as in aerospace equipment, trunk-line communications equipment, nuclear power control equipment, and medical

equipment.

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

Terms and Symbols Used in the Manuals

Terms

Denitions 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 and

delivers it to customers.

Deployment partner

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

Service

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

provider.

Meaning of Symbols

e following symbols are used in this manual. Make sure to understand the meaning of these symbols before

using the product.

Describes usage precautions that must be observed. Incorrect handling due to the disregard of this

information may result in product failure or incorrect operation.

Note:

Describes additional explanation or other useful information.

U

Indicates related reference pages. If the reference section is in blue text, click the blue text to open

the relevant page.

Epson OmniLink Merchant Services Development Guide

Introduction

3

Contents

Introduction...................................................................... 2

Manuals.............................................................................. 2

Precautions........................................................................... 2

Usage Limitations....................................................................... 3

Terms and Symbols Used in the Manuals...................................................... 3

Terms............................................................................. 3

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

OmniLink Merchant Services Hierarchy and Work Flow.......................... 6

OmniLink Merchant Services Hierarchy...................................................... 6

Overview of Service Development........................................................... 8

Service Development Work Flow............................................................ 9

Congure

the Development/Production Environment.......................... 11

Sign in.............................................................................. 11

Signing Out........................................................................ 13

Registering Groups..................................................................... 14

Registering Groups................................................................... 14

Changing Group Information........................................................... 15

Deleting Groups..................................................................... 17

Managing Members.................................................................... 19

Registering Members................................................................. 19

Deleting Members................................................................... 21

Assigning Members to Groups............................................................. 23

Managing Stores....................................................................... 26

Registering Stores.................................................................... 26

Viewing Store Information............................................................. 28

Changing Store Information............................................................ 30

Deleting Stores...................................................................... 32

Managing Printers..................................................................... 34

Registering Printers.................................................................. 34

Viewing Printer Information............................................................ 37

Changing Printer Information........................................................... 39

Deleting Printers.................................................................... 41

Using the Sample Receipt Function......................................................... 44

Connecting Printers to OmniLink Merchant Services............................................ 50

Setup Process Flow................................................................... 50

Connecting the TM Printers............................................................ 51

Conguring

the Network Settings........................................................ 51

Connecting to the Cloud Server.......................................................... 52

Checking Connection to the Epson Cloud Server............................................. 55

Checking Advanced Printer Driver Settings................................................. 56

Checking the Receipt Data Send Results...................................................... 58

Conguring Printers.................................................................... 61

Epson OmniLink Merchant Services Development Guide

Contents

4

Receipt mapping..................................................................... 61

QR Code Setting..................................................................... 82

Contents Print Setting................................................................. 94

Data Filtering and Masking Setting...................................................... 105

Scanner Transmission Setting.......................................................... 117

Migrate to the Production Environment....................................... 128

Migrating the Service.................................................................. 128

Changing the Printer Setting............................................................. 128

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

Appendix...................................................................... 132

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

Rights............................................................................ 132

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

Updating Account Information........................................................... 135

Changing Email Addresses............................................................ 135

Changing Passwords................................................................. 137

Changing Account Names............................................................. 139

Deleting Your Account................................................................. 141

Viewing Operational Logs of Store/Printer Information......................................... 143

Writing Regular Expressions............................................................. 145

Regular Expression Format............................................................ 145

Regular Expression Description Patterns.................................................. 145

Description Patterns of Regular Expressions by Type of Printer Settings............................ 146

Example Regular Expressions.......................................................... 147

Operating Environment................................................................ 148

Supported POS Systems.............................................................. 148

Supported TM Printers............................................................... 148

Supported Browsers................................................................. 148

Open Source

Soware

License............................................................ 150

OmniLink Merchant Services.......................................................... 150

TM-T88VI........................................................................ 150

TM-T88VI-iHUB................................................................... 150

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

Epson OmniLink Merchant Services Development Guide

Contents

5

OmniLink Merchant Services Hierarchy and

Work Flow

OmniLink Merchant Services Hierarchy

e Team Administrator registered by Epson creates the groups necessary to use OmniLink Merchant Services and

registers members, stores that use services, and the printers installed in these stores.

Group creation

Create groups to manage stores. is 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, and

Developer.

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 in

the 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

Epson OmniLink Merchant Services Development Guide

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

Printer 1 Printer 2 Printer N

Store N

Printer 1 Printer 2 Printer N

Epson OmniLink Merchant Services Development Guide

OmniLink Merchant Services Hierarchy and Work Flow

7

Overview of Service Development

e following section describes the services development procedure.

ere

are two server environments for OmniLink Merchant Services.

One is the service development environment (hereinaer, referred to as the sandbox environment). e other is the

environment actually used to provide developed services to stores (hereinaer, 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 without

connecting actual printers to OmniLink Merchant Services.

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

using the Web API.

Stores must also be registered in the sandbox environment so that printers can be registered. ese stores

do not need to be actual stores.

Note:

e data mapping rules for receipt data created in the sandbox environment do not automatically migrate to

the production environment.

We recommend that you make notes on data mapping rules congured in the sandbox environment to ensure

smooth 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 production

environment.

2. Service evaluation in production environment

You sho ul d

conrm

that services developed using the sandbox environment operate normally in the produc‐

tion environment.

Aer migrating your services from the sandbox environment to the production environement, a thourough

evaluation 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 sandbox

environment. 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 contact@omnilinkworld.com (North America

region) / BS.Pre[email protected] (Europe region).

Epson OmniLink Merchant Services Development Guide

OmniLink Merchant Services Hierarchy and Work Flow

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 Receipt

Function” on page 44

Dene data mapping rules as

necessary (receipt mapping)

U “Receipt mapping” on page 61

Conrm that receipt data is retrieved

correctly

Epson OmniLink Merchant Services Development Guide

OmniLink Merchant Services Hierarchy and Work Flow

9

Service provider(Administrator)

Deployment partner

(Administrator)

Deployment partner

(Technician)

Contact Epson when service

development is complete

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

Epson OmniLink Merchant Services Development Guide

OmniLink Merchant Services Hierarchy and Work Flow

10

Congure the Development/Production

Environment

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

rst

time, enter your email address and the initial password described in the

invitation email and then click Sign in.

Epson OmniLink Merchant Services Development Guide

Congure 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 congured here.

e

* indicates required

eld.

Item Description

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

New Password

Enter a new password that satises 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 (Conrm) Enter the password again for conrmation.

Name

Enter a name that satises the following conditions.

o Within 1 to 64 characters

o Includes at least 1 single-byte character

o Does not include commas

Home appears aer signing in.

Epson OmniLink Merchant Services Development Guide

Congure the Development/Production Environment

12

Signing Out

is section describes the signout procedure.

A

Click at the upper-right of the screen.

B

Click Sign out.

Epson OmniLink Merchant Services Development Guide

Congure the Development/Production Environment

13

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, actual

stores 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.

Epson OmniLink Merchant Services Development Guide

Congure the Development/Production Environment

14

Item Description

Decline of data

classication rate (%)

Species the rate of decline when comparing the current data classication rate with the

average data classication rate for the past 7 days. A notication is sent when the data

classication

rate falls below the

specied

rate.

A notication is sent only once the number of prints exceeds the number specied with

Minimum print count (sheets/day).

Minimum transaction count

(sheets/day)

Species the minimum number of prints every 24 hours used as the trigger for notications

of changes in the data classication rate. A notication is sent when the number of prints

exceeds the specied number.

Changing Group Information

is

section describes the procedure to change group information.

A

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

B

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

information.

C

Click Group and Members.

Epson OmniLink Merchant Services Development Guide

Congure the Development/Production Environment

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 data

classication

rate (%)

Species the rate of decline when comparing the current data classication rate with the

average data classication rate for the past 7 days. A notication is sent when the data

classication

rate falls below the

specied

rate.

A notication is sent when the number of prints exceeds the number specied with

Minimum print count (sheets/day).

Minimum transaction count

(sheets/day)

Species the minimum number of prints every 24 hours used as the trigger for notications

of changes in the data classication rate. A notication is sent when the number of prints

exceeds the specied number.

Epson OmniLink Merchant Services Development Guide

Congure the Development/Production Environment

16

Deleting Groups

is 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.

A

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

B

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

C

Click Group and Members.

Epson OmniLink Merchant Services Development Guide

Congure the Development/Production Environment

17

D

Click Delete in Group.

E

Conrm the message and click Delete.

Epson OmniLink Merchant Services Development Guide

Congure the Development/Production Environment

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.

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 Te a m Memb er s.

C

Click .

Epson OmniLink Merchant Services Development Guide

Congure the Development/Production Environment

19

D

Congure

the following setting items and click Save.

e * indicates required eld.

Item Description

ID (Email)

Enter the member's email address.

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

ID (Email) (Conrm) Enter the email address again for conrmation.

Administrator

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

We recommend that you give all members the Administrator right during service

development.

When adding members for the rst time, an email with the OmniLink Merchant Services URL and initial

password is sent to the entered email address.

Members can sign in using the information in this invitation email aer receiving it. U “Sign in” on

page 11

e invitation email will still be sent to the entered email address if an entered email address is already

registered.

Epson OmniLink Merchant Services Development Guide

Congure the Development/Production Environment

20

Page is loading ...

Epson OmniLink Merchant Services V3 User guide

Epson OmniLink Merchant Services V3 User guide

Related papers

Other documents