Planning customer installation of UCS software and executing that plan


0. Principles


0.1. Since work in UCS dealership means that engineer must have skills listed in http://support.ucs.ru/en/node/7983 manual, software and hardware should be prepared properly after planning finished.
0.2. Planning of installation is important stage and is highly recommended to do.
0.3. Follow part 6 of this manual to check some basic rules.

1. General


1.1. Get information from customer

1.1.1. You have to get as much information as possible about object(s).

1.1.2. You have to get object(s) physical properties:

1.1.2.1. De facto address and place entry details.

1.1.2.2. Administrator contacts.

1.1.2.3. Building and room plan.

1.1.2.4. Object(s) trade name(s).

1.1.3. You have to get object(s) infrastructural properties:

1.1.3.1. Electricity available, voltage, socket type.

1.1.3.2. Power cable laying, network cable laying, sockets (both network and AC outlets, and even telephone in some cases) shown on floor plan.

1.1.3.3. Estimate distance from each device to necessary sockets for getting proper connecting cable length.

1.1.4. You have to get object(s) functional division scheme.

1.1.4.1. Draw automation plan (only for those premises to be automated) with designated functional areas (like: bar, kitchen, cashier room, external guest hall, etc.), specifying where to install which hardware.

1.1.5. You have to get object(s) legal entity attributes, usually corporation details.

1.1.5.1. Legal address (place of company registration).

1.1.5.2. Legal company name (for licensing).

1.1.5.3. Bank account details (for invoce issuing and settlements).

1.1.5.4. Telephone number (head office).

1.1.5.5. E-mail (head office).

1.2. Get information from software and hardware supplier(s)

1.2.1. You should use hardware that makes it possible to automate customer needs and fits customer requirements as well as solution(s) provided by UCS dealer.

1.2.2. For that, you should use software (solution) installation guide(s) and other manuals (including user manuals), plus marketing (advertising) documents, to find out software (solution) possibilities and reqirements.

1.2.3. Using comparative methods you should find out software and hardware to comply with automation purposes and customer economic conditions.

1.2.4. In many cases you offer hardware+software (solution) that has been tested and installed before using your experience.

1.3. Exchange information

1.3.1. Information exchange goes among customer, supplier, dealer (mediator).

1.3.2. If necessary,  you get information from internet and UCS head office (Moscow).

1.3.3. You are advised to coordinate solution(s) functionality and offer amount giving several alternatives to customer.

1.3.4. In some cases customer buys hardware on his own or has it already before software purchase. In this case you analyze that it fits software requirements.

1.4. To do before installation list

1.4.1. You must have network prepared in object(s) before any UCS software installation.

1.4.1.1. At least because almost all UCS applications utilize network protocols to communicate.

1.4.1.2. Each server (software) OS must have static IP addressing. The same recommended for other applications environments (for stations).

1.4.1.3. Object(s) network(s) must have valid IP routing.

1.4.1.4. Some applications require especially limited network settings. For example, Game-Keeper 3 arcade netwok must have address 172.31.32.0/255.255.0.0.

1.4.2. You must have third-party auxiliary software preinstalled in object(s) computers.

1.4.2.1. Example

purpose / type

recommended

comment

OS

for server: modern version of windows server(2008,2008R2,2012) / professional(7,8) / ultimate(7) / corporate(7) edition

for workstation: the same list, except server editions

x64 preferred
‘home’ versions do not fit
in general, most UCS software is windows-based

DBMS

Microsoft SQL server 2012 (for workstation - MSSQLS native client)

Firebird SQL server 2.5 (for workstation - DB express provider)

MSSQLS express edition possible for small chains (less than 5 objects) or for local (in-object) backoffice servers

DBMS depends on UCS software to be installed

Antivirus

Microsoft security essentials

or Nod32 without firewall

Firewall

Built-in windows

enabled (never turn off – just make exceptions)

Archiver 7zip you may choose any software which is able to open .rar,.zip,.7z archive types

Guardant key driver

5.50

www.guardant.com

Remote access Microsoft terminal server (client) or TeamViewer

1.4.2.2. Other auxiliary software should be installed and/or brought by UCS engineer depending on what software and hardware is going to be installed.

1.4.2.2.1. Device drivers.

1.4.2.2.2. DB viewer.

1.4.2.2.3. Network monitoring.

1.4.2.2.4. Process tester and information.

1.4.2.2.5. Other.

1.4.3. Prepare and save "installation scheme" document as follows from p.1.5.

1.4.4. Check date and time settings on each computer to be correct.

1.4.4.1. Time zone must be set correct.

1.4.4.2. Date and time must be real current and exact.

1.4.4.3. Make sure all your computers have NTP service (public or private) and time synced.

1.5. Installation scheme document

1.5.1. You should make one electronic or/and printed document with all those information about installation mentioned in this manual.

1.5.2. This document will be used during installation time for getting information and saving information at the same time.

1.5.3. After installtion finished, this document will be used for service and support purposes.

1.5.4. Document should have numbering of paragraphs similar to this manual.

1.5.5. Document may be kept actual on dealer side, provided to customer on request.


2. Hardware table


2.1. Data to collect or provide

2.1.1. You have to collect data about necessary device (hardware) from customer wish and software requirements.

2.1.2. In most cases you have to collect data on all the hardware that you must configure in UCS software to enable its targeted functionality (add drivers, change settings).

2.1.3. In some cases you have choice whether to mention some hardware as separate line in table or specify it as additional hardware for another one (in corresponding column of 'parent' device line). In this case follow common sense.

2.1.4. On  after installation started (during installation progress), you edit this table and input adjusted information, to fit actual data.

2.2. Table form

2.2.1. Example

# Device type Device model Quantity Additional device attached
Specific mode /
interface
Comment
Unique reference identifier for accounting /
inventory number
1 POS PC (touchscreen terminal) FEC Glaive RT665D 3 Magnetic stripe card reader*     PP01, PP02, PP03
2 Roll thermal printer Labau TM200Plus 5   Ethernet TCP receipt, service TP01, TP02, TP04, TP05, TP03
3 Barcode scanner Yongli XYL-820 1   USB   BS01
4 Computer "assembly" 1   CPU2*3Ghz,ROM300Gb,RAM4Gb manager PC PC01
5 Server "assembly" 1   CPU4*2Ghz,ROM2Tb,RAM8Gb main server SR01
6 Controller KDS UCS KDS.002.001 2
monitor Acer V243HQ,
keyboard KDS UCS.15.02.03
  kitchen KD01, KD02

2.2.2. Additionally you may add any other columns which you believe to be necessary for you.

2.2.3. It is better to fill in as much data as possible (your details influence proper system configuration).


3. Software table


3.1. Data to collect or provide

3.1.1. You have to collect data about necessary applications (software) from customer wish and enterprise (object) requirements.

3.1.2. Usually you provide solutions including a lot of separate modules being sold individually per piece in one package. You have to specify each module.

3.1.3. In this table it is allowed to specify extra information about software, even if it is mentioned already in other paragraphs of this document.

3.1.4. On  after installation started (during installation progress), you edit this table and input adjusted information, to fit actual data.

3.2. Table form

3.2.1. Example

# Software type Software name, module, version Quantity Additional modules to add
Specific mode /
interface /
server side
Comment
Unique reference identifier for accounting /
inventory number /
system (network) name
Licensing mode
1 Cashier station R-Keeper 7 cashier station 7.5.2.333 3 second screen fast food (XML) RK7 cash server   STA001, STA002, STA003 1c*Q.=3c, 3k
2 Manager station R-Keeper 7 manager station 7.5.2.333 1 web reports RK7 report server reports, references MAN001 1c, 1k
3 Accountant station UCS StoreHouse 4.94 1 inventory from POS SH4 server stock accounting and inventory STH001 1c, 1k
4 Personal client cards management station PersonalCards 3.20 1   Cardserver
customer relations system
'single' mode
PEC001 1c, 1k
5 Menu display board MenuBoard 20131003 1   RK7man plugin   MBO001 1l
6 Kitchen Display System UCS KDS.1.1.3.165 2
 
KDS server*Q. 1 server for 1 client KDS001, KDS002 2l

3.2.2. Additionally you may add any other columns which you believe to be necessary for you.

3.2.3. It is better to fill in as much data as possible (your details influence proper system configuration).


4. Network scheme


4.1. Data to collect or provide

4.1.1. You are to get already prepared or at least designed network diagram.

4.1.2. Network must have active router (gate).

4.1.3. Network must have DNS server (correct name resolution).

4.1.4. Network should have static IP (v.4) address at least on each server (on every host recommended).

4.2. Draw scheme

4.2.1. Example

4.2.2. On the scheme you specify network IP address of each host.

4.2.2.1. In case come device has several addresses, you should specify each.

4.3. Prepare table of hosts

4.3.1. You are advised to list network hosts in a table form similar to below

host identifier host address hosted applications comment hosted on (hardware) MAC
POS1 10.100.10.7 STA001, CSE001 external IP address: 33.15.0.1 PP01  
POS2 10.100.10.8 STA002 RDP port: 6600 PP02  

5. Licensing and payments


5.1. Data to collect or provide

5.1.1. Purchase software licenses from UCS according to the offer and scheme.

5.1.2. Order Guardant keys or allocate them from your stock.

5.2. Draw scheme

5.2.1. Example

5.3. Make table

5.3.1. You have to specify licensing in separate table, in case it was not mentioned in software table.


6. Environment


6.1. Hardware

6.1. Buy and use professional stable hardware.

6.2. Make sure all hardware planned is already supported by chosen software.

6.2. Software

6.2.1. Since UCS software may run under different OS, settings for each OS will differ as well.

6.2.2. Windows

6.2.2.1. You must completely turn off UserAccoutControl (versions since Vista).

6.2.2.2. You would better prepare one folder for installation of all UCS applications, like "C:'UCS\", and install them to different subfolders.

6.2.2.2.1. You would better share this working folder over network (SMB protocol).

6.2.2.2.2. You need to give filesystem write and read permissions to protected administrator accounts and system only.

6.2.2.3. You have to add firewall exceptions for each UCS executable because most of them utilize network.

6.2.2.3.1. We recommend you use only Windows preinstalled firewall (not any other additional application).

6.2.2.3.2. We do not recommend you ever turn the firewall off! Use exceptions only. Firewall must be on and protect the OS.

6.2.2.4. You must start each UCS application as competent user (Administrator).

6.2.2.5. If you use modern OS (like Windows 8), you have to disable additional security settings: change local security policy entries (secpol.mcs->Security Options-> last 8 entries related to UAC) - disable them and set "No Prompt".

6.2.2.5.1. In other case it might be enough to grant elevation in the shortcut.

6.2.2.6. If you have got another security applications installed in the same OS, you must configure them to allow everything for UCS applications.

6.2.2.7. Antivirus must be installed with proper updates.

6.2.2.7.1. We recommend you use such a neutral antivirus software as Microsoft security essentials or Eset Nod32 antivirus.

6.2.2.7.2. Install antivirus to every OS where you do run UCS programs, even if it has no internet.

6.2.2.8. When you choose OS version, it must be proper business (professional) edition. Do not use "home" software.

6.2.2.9. Network

6.2.2.9.1. Before starting UCS ini files configuration (basic application settings), you have to prepare well-organized  working IP (TCP+UDPi ready) network.

6.2.2.9.2. Your hosts in local network which are going to be used for UCS applications (and most important - all servers) must have static IP addresses.

6.2.2.9.3. You must discover free TCP port range(s) in your OS to use them in application settings. Set your own logical port pool.

6.2.2.10. Explorer

6.2.2.10.1. In case of front office, and in some other cases (like self service), it is worth limiting use of OS interface and functions by user.

6.2.2.10.2. You can replace Windows explorer.exe in registry shell parameter (startup) with your script (.bat). Path is HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Winlogon

6.3. Logic

6.3.1. It is recommended to use unifying settings for every installation you do.