Existing Clients¶

This topic describes the process of migrating clients running prior POS versions to version 7.0 or greater.

Background¶

Kensium POS 7.0 operates through a web browser, with minimal client (Register) installation requirements outside of the eShipJet Printer service for receipt and label printing. Installation requirements instead focus on server-deployment, favoring server deployment using Docker containers.

This installation approach is significantly different than the Windows-based software that was installed on each Register workstation for previous versions of POS.

As a result, there are several considerations when migrating a customer using an older version of POS to the latest version.

Migration Sequence¶

The general sequence to migrating is as follows:

Confirm Prerequisites → Migrate Corporate → Migrate Stores → Migrate Registers

Prerequisites¶

A. Customer Requirements¶

An upgrade of an existing client follows most of the same first steps as a new client. See the First Steps topic for details, in particular:

Note

Note the importance of the Organization ID. This value is used throughout deployment and configuration.

B. Docker Requirements¶

Confirm that the client's existing server infrastructure meets the minimum server requirements for the Docker container system, as described in Docker Installation.

All existing Corporate Server and Store Servers should be checked against the Docker requirements.

If any servers do not meet the requirements, discuss with the client whether server upgrades are possible. In most cases, existing server-class computers that have been maintained with the latest Windows operating system updates should meet Docker requirements.

If the server infrastructure meets Docker requirements, or the client is willing to upgrade to meet those requirements, the recommended Server - Docker deployment method can be used. Otherwise, the Server - Legacy approach must be used.

C. Third Party Integrated Services¶

Kensium POS supports several third-party integrations with ERPs, payment systems, and taxation services. Older versions of POS may be running out-of-date versions of the third party service, or even services that are no longer supported.

The client's existing service integrations must be compared against the list of currently supported Integrations.

Important

Prior to performing the upgrade, ensure that the client's ASI integration has run and all transactions have been posted successfully (any posting errors must be resolved).

Migration Steps¶

D. Migrate Corporate Server¶

Assuming a standard Docker-based deployment:

Copy the existing (Corporate) database, and rename it as KensiumPOS_{OrganizationId} (note that there is no version information in the name, as the database will be upgraded as POS versions are released).
Download and Install Docker to the server environment.
Review DNS & Networking to understand the options for DNS and SSL management.
Review SQL Server Install to understand the options for SQL deployment. In most cases, we should use an external database for existing clients.
Prepare Environment Variables for the Docker environment. Choose Corporate as the site mode if deploying a multiple-store client, or Both if deploying to a single site (where there are no separate store sites).
Deploy and run the Docker containers for POS.
Verify the site to ensure that there are no errors, and (in particular) that data migrations have run successfully.
Run the Upgrade Analysis Script to detect any data integrity issues.
Rectify data issues (if needed).
Launch POS Admin and view diagnostics.
Apply POS Admin settings and rectify diagnostic warnings and errors.

E. Configure Integrations¶

Configure the integrations with the client's third-party services. These include:

Credit Card Payment provider
Taxation service
Email service

See Integrations for a full list of supported services.

F. Upgrade ASI¶

The general steps are:

Configure the appropriate ASI.
Perform a full ASI down-sync.
Verify that there are no errors.

See one of the following topics for details, appropriate to the ERP :

G. Upgrade Comms Server¶

If deploying to a multi-store network environment, upgrade the Comms Server component.

H. Migrate Store Servers¶

Each Store server running older versions of POS must also be individually updated.

Assuming a standard Docker-based deployment:

Copy the existing Store database, and rename it as KensiumPOS_{OrganizationId}_{StoreId}.*
Download and Install Docker to the server environment.
Review SQL Server Install to understand the options for SQL deployment (in particular, review the store-specific notes).
Prepare Environment Variables for the Docker environment. Choose Store as the site mode.
Deploy and run the Docker containers for POS.
Verify the site to ensure that there are no errors, and (in particular) that data migrations have run successfully.
Run the Upgrade Analysis Script to detect any data integrity issues.*
Rectify data issues (if needed).*
Launch POS Admin and view diagnostics.
Apply POS Admin settings and rectify diagnostic warnings and errors.
Upgrade the Comms Client component.
Run the Comms Client to perform a full down sync.

Note

*If store history is not required, a blank database with the same name can be created for step 1 (and steps 7 and 8 can then be skipped).

I. Migrate Registers¶

Launch the Kensium POS application web site appropriate for the environment ({StoreId}.{OrganizationId}.kensium-pos.com for multi-store deployments, or just {OrganizationId}.kensium-pos.com for a single deployment).
Create shortcut to webpage on the desktop.
Connect the Register using the correct Register ID.
Install EShipJet Printer Services to enable printing (Windows only, currently).
Setup printers and other hardware in Register Preferences.
Uninstall the older Register version.

Downloadable Checklist¶

An Excel checklist file that references the steps in this topic can be downloaded here. TODO