including license activation - alachisoft

© Copyright 2015 Alachisoft

NCache 4.6 Windows Installation Guide

Including License Activation


© Copyright 2015 Alachisoft

Table of Contents 1. Preface ............................................................................................................................................................................................ 3

2. Getting Started ............................................................................................................................................................................ 4

1.1. What to Install during Evaluation? ............................................................................................................................ 4

1.2. Installation Options ......................................................................................................................................................... 4

Developer ...................................................................................................................................................................................... 4

1.3. Where to Install NCache? ............................................................................................................................................. 4

1.4. System Recommendations ........................................................................................................................................... 5

2. Command Line Installation..................................................................................................................................................... 6

2.1. Install NCache .................................................................................................................................................................... 6

2.2. Uninstall NCache .............................................................................................................................................................. 7

3. Interactive Windows Installation .......................................................................................................................................... 8

4. Evaluation Period Expiration and Extension ................................................................................................................. 18

4.1. Indications of NCache Being Expired .................................................................................................................... 18

4.2. Extending Evaluation Period ..................................................................................................................................... 18

5. NCache Purchased License GUI Activation ................................................................................................................... 21

5.1. Online Activation ........................................................................................................................................................... 24

5.2. Manual Activation ......................................................................................................................................................... 27

6. Deactivate NCache Purchased License ........................................................................................................................... 36

6.1. Online Deactivation ...................................................................................................................................................... 38

6.2. Manual Deactivation .................................................................................................................................................... 41

7. Command Line Activation ................................................................................................................................................... 46

8. Licensing Model ....................................................................................................................................................................... 48


© Copyright 2015 Alachisoft | 3

1. Preface

Welcome to NCache version 4.6! NCache is a flexible and feature rich 100% .NET caching solution that provides

high performance and scalability to handle any transaction load. NCache features and APIs are designed to cache

data for applications of any size – from small to enterprise-wide global installations.

This NCache documentation contains step-by-step illustrations and tools designed to help you quickly install

NCache and activate your license so you can start incorporating NCache into your applications.

Support

Alachisoft provides various sources of technical support for NCache. Please refer to

http://www.alachisoft.com/support.html to select a support resource you find suitable for your issue.

To request additional features in the future, or if you notice any discrepancy regarding this document, please drop

an email to [email protected].

Document Conventions

The following conventions in text have been used throughout this document:

Convention Description

bold Specifies terms of importance for the reader.

courier Specifies file, class, interface names.

monospace Specifies command line snippets.

Specifies additional and vital information for the user.

http://www.alachisoft.com/support.html

mailto:[email protected]



2. Getting Started

NCache provides a Windows Installer Package (.msi) to let you easily install NCache. However, before you install

NCache, you need to keep the following in mind.

1.1. What to Install during Evaluation?

NCache Enterprise: Regardless of which NCache edition you ultimately end up using, you should do your

evaluation with NCache Enterprise. This is because you will be able to see all the features that NCache offers in full

and then decide whether you need to downgrade to NCache Professional or stay with NCache Enterprise.

1.2. Installation Options

Whether you install NCache Enterprise or Professional, you’re given the following installation options when you

run the .msi file:

Cache Server

This is a full installation of NCache and contains everything that the other two options provide plus cache

clustering capability. You must install this on any server where you’re going to host the cache, regardless of

whether you have dedicated or shared cache servers.

Remote Client

This installs the remote client libraries and client cache on all your web/app servers so you can access the cache

across the network. Please note that you need remote client libraries to access the cache across the network.

Developer

This installs the NCache API, online help/documentation, and a local stand-alone cache without any clustering

capability. Please note that you cannot access a remotely hosted cache from a developer install machine. You can

access only a local cache.

1.3. Where to Install NCache?

Production, Staging, QA, or Development Servers: Install NCache Enterprise Edition on the following:

Cache Servers (Dedicated or Shared)

If you have 4 or more web/app servers in your environment hosting your application, then we recommend a

dedicated caching tier of 2 servers. A dedicated cache cluster should have a minimum of 2 servers for replication

and then a ratio of 5:1 between your web/app servers and the cache servers. For smaller environments, even using

your web/app servers as cache servers is fine, as long as you have enough memory available on these machines.

NCache Remote Clients (Application or Web Servers)

Any web/app server that is not hosting the cache server but instead will access it remotely across the network is

considered NCache remote client. You need to install the “remote client” portion of NCache on these machines.



1.4. System Recommendations

Windows 2008/2012 Server (64-bit) as Cache Servers

It is highly recommended that you use 64-bit Windows 2008 or 2012 Server platform for cache servers.

Adequate RAM in Cache Servers

NCache puts a minimum of 15% overhead on top of your data. However, this overhead may grow to be a lot more

than 15% if you’re using indexes since each index uses memory. Please keep this in mind while deciding how

much memory to have in your cache servers. The total memory you need depends on how much data you plan to

store in cache.

Two 1Gbit Network Interface Cards in Cache Servers

If you have two NIC's in cache servers, it allows you to configure NCache so that it uses one of the NIC's for cache

clustering and the second one for client/server communication. This improves your throughput greatly.

Dual-CPU, Quad-Core or higher

NCache is a highly multi-threaded software and takes full advantage of extra cores and CPUs. The most common

configuration for NCache is a dual-CPU quad-core machine. You may need stronger processing power if you have

higher transaction loads and/or larger amount of data being stored in NCache. Please consult NCache technical

support to get a specific recommendation for your needs.

Disk

NCache does not make heavy use of disk space. Hence, you do not need any extra ordinary disk space in your

cache server machines.



2. Command Line Installation

NCache provides a command line installation that you can either run from Command Prompt or add to your script

files (.bat files). To install NCache form Command Prompt, use the msiexec.exe utility. Below is the syntax for

using msiexec.exe to install NCache:

2.1. Install NCache

Open Command Prompt.

Enter the following command:

Msiexec /I <Installation Package Path> EDITION=”0|3” KEY="INSTALL_KEY_EMAILED_TO_YOU" USERFIRSTNAME="John" USERLASTNAME="Smith" COMPANYNAME="Alachisoft" EMAILADDRESS="[email protected]" INSTALLDIR=”<Target Dir>” /qn

Switch/Properties Purpose Default Value

/I <.msi Package Path>

(Required)

Path where you have downloaded ncache.enterprise.x64.msi

file from the Alachisoft website.

Empty

EDITION

Specifies the installation type. Possible values are:

0 (Cache Server)

2 (Developer)

3 (Remote Client)

0 (Cache Server)

KEY (Required)

Installation Key: You will have received this via email from

Alachisoft when you downloaded NCache. If not, then visit

http://www.alachisoft.com/download-ncache.html to register

and obtain one.

Empty

USERFIRSTNAME Your first name “”

USERLASTNAME Your last name “”

COMPANYNAME Your company name “”

EMAILADDRESS (Required) Your email address “”

INSTALLDIR Directory where you want NCache to be installed. Most

commonly, this should be C:\Program Files\NCache.

Local Directory\

Current Directory

/qn Quiet mode: Install NCache without any user intervention. Empty

http://www.alachisoft.com/download-ncache.html



Press Enter.

The installation process starts. Once the installation process is complete, NCache will be successfully

installed in the specified directory.

Examples

Installing a cache server:

msiexec.exe /I "C:\NCacheSetup\NCache.clr20.msi" EDITION=0

KEY=INSTALL_KEY_EMAILED_TO_YOU USERFIRSTNAME="John" USERLASTNAME="Smith"

COMPANYNAME="Alachisoft" EMAILADDRESS="[email protected]" INSTALLDIR="C:\Program

Files\NCache" SETPERMISSION="1" /qn

Installing NCache on a Developer Workstation:





Installing a Remote Client:





2.2. Uninstall NCache

To uninstall NCache through command line, use the following syntax:

msiexec.exe /x <Installation Package Path> /qn

An example is given below.

C:\> msiexec.exe /x "C:\NCacheSetup\NCache.clr20.msi" /qn



3. Interactive Windows Installation

NCache can also be installed via an interactive Windows installer. Double click on "NCache.clr20.msi" from the

Windows Explorer. This launches the interactive Windows Installer. Below are the screen snapshots of the

installation process.

We recommend you to run your evaluation using the NCache Enterprise Edition. You can later decide whether to

downgrade to NCache Professional, based on your needs.

1. In the Windows Explorer, double click the .msi file: ncache.enterprise.x64

2. The following Welcome to the NCache Installation Wizard screen appears:

3. Click Next.

4. The next screen asks you to accept the license agreement. By clicking I accept the terms in the License

Agreement, you are making a legal commitment to abide by the Alachisoft Software License Agreement for

NCache. You cannot proceed without accepting the license agreement.



5. The Select NCache Installation Type appears.

6. Select the edition of NCache which you want to install. The rule of thumb is that except for your developer

workstations, where you have Visual Studio 2005, 2008 or 2010 installed, you should install NCache Enterprise

elsewhere.

7. Click Next.



8. Evaluation Information dialog appears which asks for the installation key. This is the key which you have

received from Alachisoft.

9. If you do not have an installation key, please click on Get Installation Key button which takes you to

Alachisoft website to register and obtain an installation key.

Even when you have purchased NCache and have a license key, you must provide the INSTALL KEY here (and not

the purchased license key). You will get an opportunity later to specify your purchased license key when you

activate your licenses.



10. If you’re already registered, just enter your email address and an installation key will be emailed to you.

Otherwise, register by specifying information and an installation key will be emailed to you.



11. In User Information dialog, you need to enter your name, company name, and email address. This

information will be displayed as part of NCache to indicate your identity.

12. Click Next.



13. By default, NCache is installed in “C:\Program Files\NCache” folder. However, if you want to change this

location, you can specify a different one below.

14. Click Next.



15. In the next dialog box, you can see all the components that will be installed automatically. You can unselect

some of the components if you wish. However, it is strongly recommended that you keep everything as

default.

16. After selection, click Next.



17. You will then be prompted to start installation process by pressing the Install button.



18. Installation process will begin.

19. After everything is done, you see the final screen indicating a successful finish of NCache installation.



20. Click Finish to exit the installation setup.



4. Evaluation Period Expiration and Extension

By default, when you install NCache, it is installed as an “Evaluation Copy” and is valid for 60 days. At the end of

these 60 days, NCache will stop working.

4.1. Indications of NCache Being Expired

You will be able to notice that NCache evaluation period has expired from the following indications:

1. NCache API will no longer work. You will not be able to add items to cache or fetch them.

2. NCache Manager splash screen will show NCache evaluation period expired.

3. NCache Manager Window title will show “Expired”.

4. NCache Manager HELP->ABOUT dialog will show NCache as being expired.

5. You will not be able to add an expired cache server to a cache cluster from NCache Manager.

6. You will not be able to start cache on an expired cache server.

4.2. Extending Evaluation Period

If any of the above happens, then it is time for you to either purchase NCache licenses or if you need an extension

to your evaluation period, you can get an Extension Key from Alachisoft Sales. Please send an email to

[email protected] (or to your account manager if you're already in touch with him/her) and ask for an

extension key. You will be provided a 30-day extension key.

Once you have obtained the extension key, please follow the steps given below to extend your evaluation period:

1. Run NActivate Wizard from "%Install Directory%/NCache/bin/NActivate" path with administrative

privileges.

2. Select Extend evaluation period option and click Next.




3. A new dialog box will appear. Enter the extension key provided to you by Alachisoft Sales and click Finish.

If this key is valid, you will be prompted with a Success message. If the key is not valid, you will be

prompted accordingly.



A 30-day extension is valid from the original installation date and not from the day you are trying to extend.

So, if you waited for 15 extra days after the initial 60 day evaluation period to extend it, you will only get 15

extra days extension.



5. NCache Purchased License GUI Activation

If you have purchased NCache licenses, you can activate them by following the steps given below:

1. Run the NActivateWizard Tool from "%Install Directory%/NCache/bin/NActivate" path with

administrative privileges.

2. NCache License Manager will open.

3. Check Activate Purchased License Key and click Next.

4. The following Licensing screen appears if you are using Windows platform:



In case you are using Virtual Machine, the same screen will be displayed, but with the message "Operating

System is installed on an emulated hardware profile like VMWare, Hyper-V etc".

5. Click Next.

If Enterprise Edition of NCache is installed, "Production License" option will be displayed.

If Developer Edition of NCache is installed, "Developer License" option will be displayed.



In this dialog box, there are two different options to choose from: Online Activation and Manual Activation.



5.1. Online Activation

Online activation is the fastest way to activate but requires that your machine has Internet access.

1. Enter the required information in this form. License Key, First Name, Last Name and Email are compulsory

fields.

2. Enter your purchased license key to proceed.

3. Click Next.

4. You will see the final screen for activating your license. Click Activate Now.



5. The NCache license will be activated.



If the license is not activated, it will display an error message. License activation can fail for a number of reasons:

Your firewall does not allow HTTP POST from Activation Program to the Alachisoft License Server.

You do not have Internet access.

Your license key is invalid.

You have already used up the purchased CPUs or nodes. If this happens, then please review your NCache

license usage and then contact Alachisoft Sales.




5.2. Manual Activation

However, if your computer does not have Internet access (which is the case in many production servers behind the

firewall), then you should opt for manual activation.

1. Select Manual and click Next.

2. The following screen will appear.



3. This dialog box shows two options:

I. If you already have the activation code, then check Step2 - Proceed with activation.

II. If you do not have the activation code, check Step1 - Generate activation code info.

4. Click Next.

5. The following dialog box will appear.



6. Please enter the required information in this form. License Key, First Name, Last Name and Email are

compulsory fields. Enter your purchased license key to proceed.

7. Click Next.

8. A screen showing a long encrypted text appears.



9. Press Copy to copy this text to the clipboard.

10. You can obtain the Activation Key through either of the two ways:

I. Paste this in an email and send that email to Alachisoft Support. This is an Activation Request Code

that you need to obtain an Activation Authentication Key.

II. Or you can also obtain the Activation Key directly by clicking on the link given below:

NCache Email Activation.

11. Paste the Activate Request Code into the text box on this page and click Verify.


http://www.alachisoft.com/admin/ncache/console/emailact.php



12. Activation Data Verification form will appear.



13. There will be an Activate! button at the bottom of the page shown above. Click this button and it displays a

page with the Activation Authentication key as shown below:



14. The Generated Activation Key is generated.

15. Copy this key to your clipboard.

16. Go back to NActivate Wizard and select Manual activation option.

17. Click Next.

18. Check Step2 - Proceed with activation.

19. Click Next.



20. Paste the Activation Key that you received from Alachisoft and paste in the box below.



21. Click Finish. NCache will be activated on your machine and you will be prompted with a success message.



6. Deactivate NCache Purchased License

NCache license can be deactivated by following the steps given below:

1. Run the NActivateWizard Tool from "%Install Directory%/NCache/bin/NActivate" path with

administrative privileges.

2. NCache License Manager will open.

3. Check Deactivate NCache License.

4. Click Next.

5. In the next dialog box, enter the deactivation code provided to you by Alachisoft and click Next.



6. The next dialog box shows two options for deactivation – Online and Manual.



6.1. Online Deactivation

Online deactivation is the fastest way to deactivate but requires that your machine has Internet access.



1. Click Deactivate Now.

2. Your license will be deactivated and you will be prompted with a success message as follows:



3. Click Finish to exit NCache License Manager.



6.2. Manual Deactivation

However, if your computer does not have Internet access (which is the case in many production servers behind the

firewall), then you should opt for manual deactivation.

1. Select Manual and click Next.

2. A dialog box will appear. Click Yes to continue.



3. A screen showing a long encrypted text appears.

4. This is the Deactivate Request Code. Press Copy to copy this text to the clipboard. Paste it on the link given

below to proceed.

NCache Manual Deactivation

5. Paste the Deactivate Request Code into the text box on this page and click Verify.

http://www.alachisoft.com/admin/ncache/console/emaildeact.php



6. Deactivation Data Verification form will appear.



7. There will be a Deactivate! button at the bottom of the page shown above.

8. Click this button and it displays a page with Deactivation Confirmation as shown below.



9. NCache on your machine is now deactivated.



7. Command Line Activation

NCache can also be activated via command line. This will help the users to automate the process of NCache

Activation. The tool NActivate.exe is a console application and can be found inside

%INSTALLATION_PATH%/NCache/bin/NActivate folder.

Enter the following command to activate your copy of NCache:

nactivate /k R4179Gba-b1f296-78F6U590 /f Paul /l Jones /e [email protected] [option[...]]

Your copy of NCache is successfully activated. You can customize the activation process through the following

properties:

Switch/Properties Purpose

/k(Required) --licensekey Specifies the License key you received from Alachisoft

/f(Required) --firstname Specifies first name of the user

/l(Required) --lastname Specifies last name of the user

/e(Required) --email Specifies last name of the user

/comp --company Specifies user’s company name

/a --address Specifies address of the user

/city --city Specifies city name of the user

/s -state Specifies state of the user

/c[ountry] --country Specifies country of the user

/z --zip Specifies postal/zip code of the user

/p --phone Specifies phone number of the user

/nologo --nologo Suppresses displaying the logo banner

/? --licensekey Displays command syntax and options for the utility



Examples

The following command activates the NCache on a machine.

nactivate /k R4179Gba-b1f296-78F6U590 /f Paul /l Jones /e [email protected]

The following command displays command syntax and options for the utility. Logo banner is displayed as

a part.

nactivate /?

The following command displays command syntax and options for the utility suppressing the display of

logo banner.

nactivate /? /nologo



8. Licensing Model

Please note that the licensing model of NCache has been shifted to core based licensing instead of processor

based licensing for Windows platform and Virtual Machines.

The model is as follows for a single physical machine:

Number of cores detected Number of licenses

required

1-4 1

5-8 2

9-12 3

13 onwards 4

In case you are using a Virtual Machine:

Number of cores detected Number of licenses

required

1-8 2

9-12 3

13 onwards 4

Note that you can purchase a maximum of 4 licenses for a single machine.

However, in case you increase the number of your cores to a number where the requirement for an additional

license becomes valid, you get a friendly warning (can be viewed through Event Viewer tool in Windows) that you

need to purchase a new license as your core count has exceeded its range limit.

Let’s suppose you were using NCache with 8 cores and increase the core number to 9. NCache will not stop

working or interrupt your application, but it will be detected that a new license is required.



For this, you can request to reactivate your NCache License through the GUI NActivateWizard tool or Command

Line Tool NActivate.exe.

Selecting this option will lead you through the same process as activating the NCache Purchase License.

including license activation - alachisoft

Documents