Squirrel CPM (.Net) (CPM2) - Squirrel Tech Web...

Squirrel CPM (.Net) (CPM2) Store Installation and Setup Guide | March 29, 2012

Squirrel CPM Store | March 29, 2012 | pg 2

Squirrel CPM Store

Record of Revisions

Date Reference:

Page, Paragraph

Rev # Squirrel Build Comments

Feb 2010 Initial Release V6.0+

Nov 2011

Requirements, Install Squirrel CPM, Appendix A – Message Queuing, Appendix B – Creating a Store Database,

Merge Data: NOTE: before you merge configuration data from Corporate, make sure you exit and save out of any open Squirrel Browser setup screen. If you exit/save a Browser setup screen after a merge, you will overwrite the merged corporate configuration data with the data you just saved.

1 V6.0+

Dec 2011

Section 2.1.2 Router Configuration: NOTE: the Cisco RVL200 VPN Router Implementation Guide is available on the Squirrel Techweb.

2

Jan 12/12

Section 1.5 About Box: NOTE: the CPM version must match the version of Squirrel POS that it is running with.

3

Mar 29/12

Section 2.1.1. Requirements: Event Viewer - Application and System event Logs must be set to “Overwrite as Needed” prior to installation of CPM.

4

For further information about this manual or other Squirrel Systems products, contact us at 8585 Baxter Place, Burnaby, BC V5A 4V7 or call 1-800-388-6824. Outside the U.S. and Canada, call 604-412-3300.

Copyright ©2009 Squirrel Systems Corporation. All rights reserved.

Squirrel Professional is a trademark of Squirrel Systems.

All other products are trademarks or registered trademarks of their respective holders, all rights reserved. Reference to these products is not intended to imply affiliation with or sponsorship of Squirrel Systems.


Proprietary Notice

This document contains confidential and trade secret information, which is proprietary to Squirrel Systems, and is protected by laws pertaining to such materials. This document, the information in this document, and all rights thereto are the sole and exclusive property of Squirrel Systems, are intended for use by customers and employees of Squirrel Systems, and are not to be copied, used, or disclosed to anyone, in whole or in part, without the express written permission of Squirrel Systems. For authorization to copy this information, please call Squirrel Systems Product Support at 1-800-288-8160 or 604-412-3308 in British Columbia.

Disclaimer

Squirrel Systems provides this documentation as is without warranty of any kind, either express or implied. This document could include technical inaccuracies or typographical errors. Squirrel Systems may make improvements and/or changes at any time to the product(s) and/or program(s) described in this document. Changes are made periodically to the information herein; these changes will be incorporated in new editions of the document (please check the Squirrel Techweb frequently for such updates.


Table of Contents

1 Overview ........................................................................................................................................... 6

1.1 The StoreSite.Net Icon .................................................................................................................. 6

1.2 The Squirrel CPM (StoreSite) Interface ........................................................................................ 6

1.3 Event Viewer ................................................................................................................................. 8

1.4 DOS ............................................................................................................................................... 8

1.5 About Box ...................................................................................................................................... 8

2 Installation and Setup ........................................................................................................................ 9

2.1 Preparing for Installation ............................................................................................................... 9

2.1.1 Requirements: ....................................................................................................................... 9

2.1.2 Router Configuration: ............................................................................................................ 9

2.2 Installation and Setup .................................................................................................................... 9

2.2.1 Install SquirrelCPM.............................................................................................................. 10

2.2.2 Copy Corporate Certificates ................................................................................................ 12

2.2.3 Import Certificates ............................................................................................................... 13

2.2.4 Install the SquirrelCPM Store Service ................................................................................. 15

3 Squirrel CPM Store Setup ............................................................................................................... 18

3.1 Setup Config Options .................................................................................................................. 19

3.2 Setup Utilities .............................................................................................................................. 20

3.2.1 Event Viewer ....................................................................................................................... 20

3.2.2 DOS Prompt ........................................................................................................................ 22

4 Squirrel CPM Tasks ........................................................................................................................ 22

4.1 Ping Store Service ...................................................................................................................... 23

4.2 Ping Corporate Service ............................................................................................................... 24

4.3 Make Databases ......................................................................................................................... 25

4.3.1 Make DB_Gen ..................................................................................................................... 25

4.3.2 DB_Xactions ........................................................................................................................ 26

4.4 Merge Data .................................................................................................................................. 28

5 Database States .............................................................................................................................. 29

5.1 DB_Gen ....................................................................................................................................... 29

5.2 DB_Xactions................................................................................................................................ 30

6 Appendix A – Message Queuing..................................................................................................... 31

7 Appendix B - Creating a Store Database ........................................................................................ 33

8 Appendix C - Uninstall/Reinstall the Store Service ......................................................................... 35


8.1 Uninstall the Store Service .......................................................................................................... 35

8.2 Reinstall the Store Service .......................................................................................................... 36

9 Appendix D - Remove Certificates .................................................................................................. 38


1 Overview

Squirrel CPM is Squirrel’s latest version of Corporate POS Manager. There are some similarities between the old Corporate POS Manager and CPM. Most of the screens used during setup look the same and users still have to use the Squirrel browser to edit the configurations. The method of communication and moving data has changed. Squirrel CPM uses WCF protocol and is a service based program. This service exists on both the store and corporate machines and uses certificates rather than user passwords. Another unique feature is the use of staging databases to hold configuration or transaction data. This gives the user more room to verify incoming or outgoing data and allows third party software to better communicate with the isolated information. Each CPM setup requires some configuration in order to get started but this depends on how many stores exist in the Corporate chain, and the complexity of the Squirrel configuration. CPM even has a setup program that allows the user to quickly install or remove the program from the machine. These areas include installing or removing the CPM service, stored procedures and the corporate or storeSite.exe which is what the user interacts with. Corp users are able to ping stores, send configuration data, send pricing data, download store event logs, upload and download files, execute scripts and launch other executables. Store side configuration has less to deal with in that they can ping service, merge data and create their staging databases. The idea is to give Corporate more control and simplify the procedures at store sites.

1.1 The StoreSite.Net Icon The StoreSite program must be installed and the Squirrel CPM Store Service must be running in order to access the StoreSite.Net icon. For installation instructions please see Section 2 – Installation and Setup.

Right-click the StoreSite.Net icon in the service tray to access the StoreSite interface as well as other utilities for the CPM environment. Keep in mind that you can also launch the utilities from the CPM main screen.

NOTE: if the icon displays with a red spot it indicates that the SquirrelCPM Store Service is stopped.

1.2 The Squirrel CPM (StoreSite) Interface The StoreSite program must be installed and the Squirrel CPM Store Service must be running in order to access the Squirrel CPM (StoreSite) interface. For installation instructions please see Section 2 – Installation and Setup.


Squirrel CPM’s StoreSite is the main user interface for the Squirrel CPM program. Launching this screen gives you the access to all Squirrel CPM functionality that is allowed at the store location. The most common function is to merge corporate configuration data into the Squirrel database. Corporate may ask you to ping the corporate service when troubleshooting, but corporate will be able to execute all of your tasks pertaining to Squirrel CPM remotely.

The Menu bar in the top left corner of the screen gives you access to Config, Utils and Help. Config and Utils are discussed below. Help gives you access to the About screen that displays Information about the version of the CPM program and some of the technologies used to power this type of program. The icons below the Menu Bar are for two of the most commonly used Utilities: the DOS prompt and Event Viewer (discused below).

The screen is divided into two main areas which will be explained in detail in upcoming sections of the document: a Setup area and a Tasks area.

In addition, on the Setup side there is a Database States box that displays the arrival of data from corporate. This is explaned in more detail in the Tasks section of this document.

The Progress box in the bottom of the Setup section contains a rotating icon that is grayed out and has a Ready message that indicates that the Store Service is idle. When a task is executed the Ready message changes to Running Task and the image rotates until the task is complete.

The status bar at the bottom of the main CPM screen displays store information taken from the Squirrel database. This area contains the following:

• Database name • Squirrel version • PC name • Store IP • Corporate IP • Store Number


1.3 Event Viewer This option displays the events attributed to the CPM service only. For XP Events you must access the screen via Administrative Tools or the Run command.

1.4 DOS This option opens the command prompt and defaults to the c:\SquirrelCPM\Program directory.

1.5 About Box This option displays the current technologies used in the CPM environment, but more importantly shows the CPM version which is necessary to support troubleshooting. NOTE: the CPM version must match the version of Squirrel POS that it is running with.


2 Installation and Setup

2.1 Preparing for Installation Prior to the installation of the Squirrel CPM store service, ensure the PC and the router meets the following requirements:

2.1.1 Requirements: • Windows 7, Microsoft XP, Server 2003 (32 bit) or Server 2008 (32 bit) • Local administrative access • Message Queuing – see Appendix A for more details • MSOffice for exporting to Excel • Minimum Squirrel V6.0 (installed with the default database if this is a new site) • SQL 2005 w/ Squirrel V6.0; SQL 2008 w/ Squirrel V7.0+ • Event Viewer - Application and System event Logs must be set to “Overwrite as Needed”

prior to installation of CPM • A Store database is required – if this is an existing Corporate POS Manager site, do a

database backup; if this is a new site or an existing Standalone site, a Store database must be created (see Appendix B for more details). NOTE: if an existing Corporate POS Manager site has ‘automerge’ configured, the task must be removed before Squirrel CPM is installed.

NOTE: after CPM is configured, Squirrel Database Maintenance and Archive Manager must be configured to back up the database and manage the log file.

2.1.2 Router Configuration: • Squirrel does not support router setup provided by your ISP, but you must purchase a

static IP for your router. • The two main areas CPM is concerned with is port forwarding and accepting pings. • Both corporate and store MUST have the correct router setup in order to have a

seamless CPM communication over the internet. In some cases you will have to upgrade the firmware if using an older device.

• Ports must be open on the router but also in the firewall program you are using • Store ports should always be at 8082

NOTE: the Cisco RVL200 VPN Router Implementation Guide is available on the Squirrel Techweb.

2.2 Installation and Setup Once all of the Requirements are met and the router is properly configured you can proceed with Squirrel CPM installation and setup.

NOTE: the user who is performing the installation, including importing Certificates and installing the Store Service, must have Administrative rights to the PC.


2.2.1 Install SquirrelCPM

1. Insert the Squirrel Optional Modules cd and double click the SquirrelCPM.exe file.

2. If you have not created a Store database, the following message will appear. Click Yes.

3. MSMQ (Message Queuing) must be installed for Squirrel CPM to communicate. If you have installed MSMQ as per the Requirements page, click Yes to continue installing Squirrel CPM. If you have not installed MSMQ, click No to stop the installation and refer to Appendix A to install MSMQ (Message Queuing).

4. The Squirrel CPM Setup Wizard Welcome screen appears. Click Next>.


5. Read and accept the License Agreement and click Next>.

6. Click Install.

• The .NET Framework will be repaired. This may take a few minutes.


7. When the installation is complete, click Finish.

8. A message reminds you to refer to this document to complete Squirrel CPM setup, click OK.

2.2.2 Copy Corporate Certificates Certificates are created at Corporate and must be obtained by the Store along with a Password to Import them. Certificates are used to communicate with Corporate.

1. Copy\unzip the Certificate files provided by Corporate to the C:\SquirrelCPM\Certificates directory


NOTE: the files must go into the C:\SquirrelCPM\Certificates directory on the Store or the CPM program will be unable to Import them.

2.2.3 Import Certificates The Certificates from Corporate must now be imported into the Store.

1. Launch the SquirrelCPM setup utility from C:\SquirrelCPM \Program

2. Click the Certificiates button


3. Click Import and enter the Password given to you by Corporate – enter it again to Confirm it – click OK.

4. The Certificates are Imported. Click OK.

NOTE: if you forget to copy the Certificates from Corporate, or if you copy them to the wrong directory, the following message will display. Click OK and copy the Certificates to the correct directory and try again


2.2.4 Install the SquirrelCPM Store Service To install the Store Service for the first time:

1. Launch the SquirrelCPM setup utility from C:\SquirrelCPM \Program if it is not already running

2. Click the Services button


3. Click the Install button and then click Yes to confirm

NOTE: if you attempt to Install the Service without first Importing the Certificates, the following message will display. Click OK and Import the Certificates. And then Install again.

4. When the Store CPM Store Service in installed a StoreSite.Net icon appears in the service tray and you’re taken back to SquirrelCPM Setup screen – click OK


NOTE: if the icon doesn’t display, go to the SquirrelCPM\Program directory and click on StoreSiteNET.exe


3 Squirrel CPM Store Setup

Squirrel CPM’s StoreSite program allows you to configure the IP address of the corporate PC so you can send transaction data to corporate. It also gives you access to the Event Viewer and DOS command utilities.

1. Right-click the StoreSite icon in the service tray and select StoreSite to launch the SquirrelCPM interface

2. The Squirrel CPM (StoreSite) screen displays. The Setup options are on the left hand side of the

screen. You can expand or collapse the Config Options using these icons:


3.1 Setup Config Options

1. Double click on Corporate Setup under Setup, Config Options. The Corporate Setup screen displays.


2. Enter the IP address of the corporate router in the Computer Name field

3. Enter the name of the domain in Domain Name if the corporate PC is on a Domain

4. Click the X in the top corner of the Corporate Setup screen to exit and click Yes to save the data.

3.2 Setup Utilities There are two utilities available in Store Squirrel CPM: Event Viewer and the DOS command.

3.2.1 Event Viewer Squirrel CPM can display information from the event viewer. Keep in mind that when you launch the event viewer from the Config tab the information displayed is localized to CPM events only.


1. Double click Event Viewer in the Setup section under the Utils tab or click the Event Viewer

icon.

2. The Event Viewer screen appears. Select a record to view details of it in the lower part of the screen.

3. Click the Export to Excel button to export the log file to an Excel spreadsheet.

4. Click the X to exit or select another record to delete

NOTE: You can launch the full XP Event Viewer from the Util dropdown menu on the main screen of Squirrel CPM.


3.2.2 DOS Prompt This option opens the command prompt and defaults to the C:\SquirrelCPM\Program directory.

1. Double click DOS cmd in the Setup section under the Utils tab or click the DOS icon.

• You can stop and start the Corporate Service manually from the command prompt. • To start the SquirrelCPM Store Service type: onstore • To stop the SquirrelCPM Store Service type: offstore

4 Squirrel CPM Tasks


The Task Type dropdown list is the only place where you can access and execute all available tasks in the Squirrel CPM Store program.

When a task is executed the result is posted to the main Squirrel CPM screen. Some tasks are actually performed from corporate (i.e. a forced merging of configuration data). If an error is returned, you will see a readable message in the output area that details the problem.

4.1 Ping Store Service You can ping the Squirrel CPM Store Service to test to see if it is communicating.


1. Click the button to send a ping message to the store service.

2. The task information displays on the screen. There should be a Ping OK message to indicate that the service is communicating.

3. You can click to erase the information if desired.

4.2 Ping Corporate Service You can ping the Squirrel CPM Corporate Service to test to see if it is communicating.

1. Click the arrow beside Task Type to display the lists of tasks.

2. Click the arrow beside Ping and select Corporate


3. The ping message appears in the task pane. There should be a ‘Ping OK’ message to indicate that the store is able to communicate with corporate.

4. You can click to erase the information if desired.

4.3 Make Databases

4.3.1 Make DB_Gen DB_Gen is the staging database used to hold generation (configuration) information transported from corporate. This database only exists on the store side and can be created by both store and corporate. Information in this database gets merged into the Squirrel database at the store(s) location.

TO CREATE THE DB_GEN DATABASE FROM THE STORE:


1. Click the arrow beside Task Type and select Misc > Make Dabases > DB_Gen. Click Yes to Confirm.

2. The database appears in the Database States box.

4.3.2 DB_Xactions DB_Xactions is the staging database that holds Squirrel transaction data and must exist at both corporate and store in order to work. This database can be created on both sides, but corporate can create DB_Xactions for every store remotely.


TO CREATE THE DB_XACTIONS DATABASE FROM THE STORE:

1. Click the arrow beside Task Type and select Misc > Make Dabases > DB_Xactions. Click Yes to

Confirm.

2. The database appears in the Database States box.


4.4 Merge Data Corporate sends configuration or pricing data to the stores whenever they make changes. A popup message indicates that data has arrived and a date and time-stamped file appears in the Database States area under the DB_Gen staging database where the data is kept until it is merged. Merging data at the Store can happen a few different ways:

• Corporate can force the merge to occur • Store can merge the data manually through the CPM interface

When data arrives from corporate a message pops up by the service tray to let you know that data has arrived. Click the X to stop it from appearing.

NOTE: before you merge configuration data from Corporate, make sure you exit and save out of any open Squirrel Browser setup screen. If you exit/save a Browser setup screen after a merge, you will overwrite the merged corporate configuration data with the data you just saved.

TO MERGE THE DATA MANUALLY:

The arrival of data is indicated under Database States

1. Click the arrow beside Task Type on the SquirrelCPM screen and select Merge Data; click Yes to confirm.


2. Ensure the message displayed after the merge indicates success.

NOTE: the Data Arrival message under Database States does not disappear after the data is merged. It is time and date stamped for easy reference. This information is overwritten each time data is sent to the store.

5 Database States

5.1 DB_Gen The database state for DB_Gen is the area where information gets posted telling you when configuration data has arrived from corporate. Messages appear under the DB_Gen title and include the date and time of arrival.


5.2 DB_Xactions The database state for DB_Xactins is the area where information gets posted telling you when transaction data has been pulled by corporate. Messages appear under the DB_Xactions title and include the date and time the data was sent.


6 Appendix A – Message Queuing

Message Queuing is required for Squirrel CPM.

TO INSTALL MESSAGE QUEUING:

1. Open the Control Panel and select Programs and Features

2. Select Turn Windows features on or off from the left hand side.


3. Scroll down and select Microsoft Message Queue (MSMQ) Server. This will automatically select Microsoft Message Queue (MSMQ) Server Core. DO NOT select any of the other MSMQ options or the MSMQ DCOM Proxy.

• The installation might take a few minutes.

4. Click Restart Now to complete the installation.


7 Appendix B - Creating a Store Database

You must make a brand new empty database into which you transport the configuration files from Corporate.

1. Create a new SQL database (if there is an existing Squirrel database on this pc, delete it and re-add)

2. Run create 1 on the model database

3. Run create 1 on the tempdb database

4. Run create 2, 3 and 4 on the new Store database

5. Right click on the Store database and select Properties. From the Options tab on the left, confirm the following settings:

• Collation is SQL Latin1_General_CP1_CI_AS for English sites • Compatibility level must be set to 2000 (80) • Auto Close and Auto Shrink must be set to False


6. Run Dataconvert – it asks which kind of database you are creating – choose Store and enter the Store Number. Remember this is considered a Store Shell database until you merge a Store file from corporate.

7. Open the Squirrel Browser and select Advanced Setup and then Site Setup. Enter a Site Name and the Store Number that you entered during Dataconvert. The Store number cannot be changed after a merge takes place.

8. Corporate will send a configuration. See section 4.4 Merge Data for information regarding merging the configuration into the new Store database.


8 Appendix C - Uninstall/Reinstall the Store Service

Sometimes it is necessary to uninstall and reinstall the store service for troubleshooting or upgrades.

8.1 Uninstall the Store Service If it is necessary to uninstall the sqStoreService:


2. Click the Uninstall button and click Yes to confirm the Uninstall.


8.2 Reinstall the Store Service If it is necessary to re-install the sqStoreService:


2. Click the Upgrade button and click Yes to confirm the Upgrade


• The program is uninstalled and then installed.

3. Click OK to exit when it’s completed.

4. Click Yes to Confirm the Exit.


9 Appendix D - Remove Certificates

Sometimes it is necessary to remove the Certificates:


2. Click on the Advanced tab

3. Click on

4. Click Yes to confirm the Delete.

5. Click OK to exit and click Yes to confirm the Exit.

Squirrel CPM (.Net) (CPM2) - Squirrel Tech Web...

Documents

Transcript of Squirrel CPM (.Net) (CPM2) - Squirrel Tech Web...