Activating and Managing Cypress Licenses

This topic describes the Cypress license structure and provides steps for obtaining a license file to use to activate your Cypress Server. It also discusses the types of Cypress user licenses and how to manage them.

The Cypress License Structure

This topic provides an overview of the Cypress software license structure and details the tools within the user interface for managing licenses. This is for informational purposes only. The software, support, and upgrade agreements for Cypress are the only legally binding documents between the parties.

Each license has a set number of user licenses based on the license type and your purchase agreement. Controls are provided within the Administration Tools module to allow you to view and manage Cypress user licenses across your enterprise.

Cypress typically offers these types of user licenses:

Named user license, which allows a specific user or users to access a DocuVault from any computer in the network or any authorized users to access a DocuVault from a specific computer or computers.

There are two types of named users:

a. Logon user allows a registered user to access Cypress when logging on to any computer in the network.

b. Computer allows any authorized user to access Cypress when logging on to the registered computer.

You must select the named user and click the Delete button to free the license for expired or disabled named users.

Concurrent user license, which creates a pool of licenses per DocuVault that are available to users for connecting to a DocuVault, regardless of the name of the computer or logged-on user. Concurrent user licenses are released as soon as a document is printed to a DocuVault rather than when the application used to print the document is closed.
Capture driver license only, which allows users to print (i.e., print, e-mail, fax, etc.) to Cypress from their Windows desktops, but not access other Cypress features (e.g., Inboxes, document query and retrieval, etc.).

You can create any combination of named, concurrent, and capture driver licenses.

Cypress License Requirements

All licensed customers use a license file that is based on their use criteria registered when they purchase the Cypress software. Cypress uses these types of licenses:

•

90-day Trial license

•

Production license

•

Emergency license

•

Evaluation license

•

Demo license

•

License renewal grace period

90-day Trial License

The 90-day trial license includes all modules and unlimited access during a new installation or upgrade to Cypress Version 7.2 or later. Within the 90-day time period, you must receive a license file to continue using Cypress. See Obtaining Your Cypress License File.

Demo License

The demo license is used by ASG staff for the purpose of demonstrating Cypress software. All modules are enabled and the demo license contains predefined device/user counts. The demo license expiration date can be specified for up to 365 days after the license generation date.

Emergency License

The emergency license is a temporary license for emergency situations such as license expiration and system failure. The expiration date can be specified for up to 90 days in the license file. ASG Customer Support can assist you with recovering Cypress on a different machine. This type of license cannot be used for license activation.

Evaluation License

The evaluation license allows you to activate a brand new installation of Cypress for selected modules (may include all modules). The expiration date can be specified for up to 90 days after the license generation date. To update the evaluation license, you must be issued a production license.

Production License

The production license is for customers who have purchased Cypress for production use. There are two types of production licenses: annual and perpetual. The annual license expires in a preset number of days or on a specified expiration date. The perpetual license never expires.

License Renewal Grace Period

The Cypress Server provides a 10-day license renewal grace period after the Cypress license (trial, evaluation, emergency, demo, or annual) expiration.

This license renewal grace period is designed to reduce the service interruption caused by the license expiration. ASG strongly recommends that you renew the license before it expires without using the grace period. However, if the license does expire, be sure to contact ASG to renew the license and update the Cypress Server before the end of the grace period.

Within the 10-day license renewal grace period, the Cypress Server will automatically terminate itself and log a related event in the Windows application event log, once a day (around 12:00 AM local time) until the license is renewed. Users can restart the Cypress Server (after the termination) and continue to run it.

After this 10-day grace period, the Cypress Server will no longer run without a valid license.

Sample Event Log Messages

For Day 1 to 9

Message E-257.50:

Please contact ASG Support to renew the license and update this Cypress server as soon as possible.

Cypress server has terminated itself, because the Cypress License (type 5) for this server has expired.

You can restart Cypress server and continue to run it within the 10-day License Renewal Grace Period (3 days remaining),

however the Cypress server will automatically terminate itself once a day during this period,

until the license is renewed.

For Day 10

Message E-257.51:

Please contact ASG Support to renew the license and update this Cypress server as soon as possible.

Cypress server has terminated itself, because the Cypress License (type 5) for this server has expired.

You can restart Cypress server and continue to run it for one more day.

This is the last day of the 10-day License Renewal Grace Period for this server.

After 10 Days

Message E-257.52:

Please contact ASG Support to renew the license and update this Cypress server as soon as possible.

The Cypress License (type 5) for this server has expired, and the 10-day License Renewal Grace Period is over.

Other Messages

This message will pop up at the UI start as well as when displaying the Admin\Info tab during the grace period:

Please contact ASG Support to renew the license and update this Cypress server as soon as possible.

Your Cypress License has expired. The Cypress Server is currently running within the 10-day license

renewal grace period (x days remaining).

In addition, a negative number will be used in the Day Count field of the Admin\Info\License property page to indicate the number of days that have been used of the 10-day license renewal grace period.

Obtaining Your Cypress License File

To obtain your Cypress license file, you must perform these steps:

q	1. Determining If You Need to Obtain a New License File
q	2. Generating an Authorization Code
q	3. Providing the Authorization Codes to ASG Product Distribution
q	4. Obtaining a License File from ASG Product Distribution
q	5. Using a License File to Activate Cypress

Determining If You Need to Obtain a New License File

These events require a new Cypress license file:

•

Upon initial installation of the software to extend the authorization period beyond 90 days.

•

When the authorization period has expired.

•

When your machine name or hardware has changed.

•

When you are nearing your annual license renewal date.

•

When you are upgrading to a new version of Cypress.

•

When you are modifying your license agreement.

When you are near your annual license renewal date or upgrading or modifying your license agreement, open a support ticket using your usual method.

When upgrading, ASG recommends that you generate the authorization codes and obtain your license file prior to upgrading your installation.

Generating an Authorization Code

This topic describes the procedure for generating an authorization code using the license code generator utility (CypressACGen.exe).

You must generate an authorization code for each machine on which you will be running Cypress Version 7.2 or later.

To generate an authorization code

Locate CypressACGen.exe in the Cypress directory (i.e., C:\Program Files\Cypress\CypressACGen.exe).

For upgrades: copy the file to each Cypress server (test and production) you are upgrading. Alternatively, share the file to each server.

Right-click CypressACGen.exe, and select Run as to display the Run As dialog.

Select a user who has full privileges (elevated) as a local administrator, and click OK

The utility creates a text file that contains the code.

Locate and open the CypressAC.txt file to obtain the authorization code, for example:

If desired, record the authorization code for future use.

Authorization Code: _______________________________________________

This code will allow you to receive a license file from ASG Product Distribution.

Providing the Authorization Codes to ASG Product Distribution

Send the authorization codes from step 6. to ASG Product Distribution at: pd@asg.com.

After receiving your authorization codes, ASG Product Distribution will issue a single license file that you can use to activate all of your servers.

Obtaining a License File from ASG Product Distribution

ASG Product Distribution creates a license file that contains the authorization codes you provided. After you receive and save the file on your server’s hard disk, you can complete the activation process through the installation wizard or manually using the hub_service command.

Using a License File to Activate Cypress

You can activate your Cypress Server by specifying the license file during the installation process. You can also activate it manually using the hub_service update_license command.

In order to successfully perform license tasks, you must configure Cypress Server to use a domain/local user account that is a member of the Administrator’s group on the machine on which Cypress Server is running. For more information, see the Post-installation Setup topic in the ASG-Cypress Installation and Upgrade topic.

To specify your license file during installation

You must run the Cypress installation program as administrator (i.e., a user with full privileges (elevated) as a local administrator) to specify the license file during installation.

When the License File dialog displays during installation, select the Activate Cypress with a license file radio button. Then, click Browse to locate and select your license file.

To update your license using the hub_service update_license command

For Windows Server 2008: If user account control (UAC) is enabled, you must respond to an elevation prompt to successfully start or stop the Cypress Hub Service.

Save the license file on your server’s hard disk.

Make sure that the Cypress Hub Service is terminated by selecting Start } Programs } Cypress Server } Stop Hub in the Windows task bar.

Select Command Prompt from the Start menu. For example:

Start } Programs } Accessories } Command Prompt

Right-click Command Prompt, and select Run as to display the Run As dialog.

Select a user who has full privileges (elevated) as a local administrator, and click OK.

A command prompt window opens.

Change the directory path to the Cypress Server directory.

Open a command prompt window (by selecting Start } Programs } Command Prompt on most systems), and change the directory path to the Cypress Server directory.

For Windows Server 2008: You must perform this step using run as administrator.

Execute the license file you received from ASG by entering this command in the prompt window:

hub_service update_license <filename>

where <filename> is the name of the license file you received from ASG, complete with the fully qualified directory path.

For example:

hub_service update_license d:\temp\MI0004_990415.dat

If a directory or file name contains a space as part of the name, place the entire path information in double quotation marks (“ ”). For example:

hub_service update_license “d:\my temp\MI0004_990415.dat”

After the program has finished running, restart the Cypress Hub Service by selecting Start } Programs } Cypress Server } Start Hub in the Windows task bar.

Running in Emergency Mode without an Emergency License

When the Cypress Server is running under a production license (either perpetual or annual) or a demo license, the Cypress administrator may switch it to run in emergency mode, to handle some emergency cases, for 45 days without downloading and using the emergency license file.

Emergency mode can be enabled by using a special Cypress Server /emergency start parameter. It works the same as applying an emergency license, but is only valid for 45 days.

Before the 45-day emergency mode expires, a new license (perpetual, annual, demo, or emergency) is required to update the Cypress Server to exit from the emergency mode and run under the newly-updated license. The new license must be newer (i.e. with a larger license sequence number) than the one in use before the temporary emergency mode is applied.

To enter emergency mode

If your current Cypress Server is using a perpetual, annual or demo license, you can enable emergency mode for the Cypress Server with either of these methods:

Open the cmd window as an administrator, then enter this net utility command (assuming that the Cypress Server has been stopped):

net start cypress /emergency

Launch the Service snap-in for the Microsoft Management Console (mmc), select the Cypress Server, then follow these steps:

Right-click to select Properties.

In the General Tab, stop the Cypress Server if it is still running.

In the Start parameters field of the General Tab, enter /emergency.

Click the Start button to run the Cypress Server under emergency mode.

To verify the license status

Launch the Cypress UI.

Select the Administration module.

Select the Info tab and then the License tab.

Look at the Type and Day Count fields.

To exit from emergency mode

Before the 45-day emergency mode expires, you need to contact ASG Customer Support to get a new perpetual, annual, demo (or even emergency) license to update your Cypress Server to run under the specified license status again.

The new license sequence number must be newer (i.e. with a larger license sequence number) than the one in use before the temporary emergency mode was applied.

Managing User Licenses

Most customers consider the number and type of Cypress user licenses that are/will be required before installing and configuring the system. As your organization grows and more users are given access to DocuVaults; however, you might find it necessary to closely manage or re-evaluate the Cypress license structure.

Creating a Cypress Users List

You can create a list of users who have accessed a specific DocuVault or DocuVaults with the license_utility utility, which can produce an ASCII file or encrypted list.

To create a list of Cypress users

Using a text editor, create a list of DocuVaults whose users you would like to see. List the DocuVaults in this format:

DocuVault Name@IP Address or DNS Name

Separate the DocuVault names with commas, and enclose each DocuVault name in quotation marks. You can save the text file to any directory on the Cypress Server.

•

This is an example of a typical text file with an IPv4 IP address:

“CompanyABC@CYPABC”, “Production_1@255.1.1.255”

•

This is an example of a typical text file with an IPv6 IP address:

“CompanyDEF@CYPDEF”, “Production_2000:db8::1428:57ab”

If your system supports IPv6, you can use IPv6 IP addresses. Cypress supports both formats.

From the Cypress Server, open a command prompt window and change the working directory to your Cypress Server directory.

Determine the directory in which the license count utility should create the user list and the name of the user list file. Because this list of users will be encrypted, avoid using file extensions that you would usually associate with a simple text file (e.g., .txt or .log).

Enter this command at the prompt:

license_utility <DocuVault file> <encrypted user list>

where:

<DocuVault file> is the fully qualified path to your DocuVault file.

<encrypted user list> is the fully qualified path to your encrypted user list.

If you want to review the list of users, determine what the license utility should name the decrypted user list and enter this command to decrypt the user list:

license_utility d <encrypted user list> <decrypted user list>

where:

<encrypted user list> is the fully qualified path to your encrypted user list.

<decrypted user list> is the fully qualified path to the location where you want the decrypted user list.

Use the decrypted user list only internally. If you must contact ASG Customer Support about your licensing, always send the encrypted user list.

Adding a Client Machine as a Named User

You can add new client machines to Cypress as named users to ensure access (e.g., Cypress Administrators, high-level users, etc.) regardless of licensing. You can do this for all license types by adding the machine to the Client List in the Cypress Administration module.

To add a client machine as a named user

Open the Administration module, and click the Info tab.

From the Info dialog, select the License tab and click the License Usage button. The License Usage dialog is displayed.

If it is not selected, select the Named User tab.

The Named User tab contains these columns:

Column

Description

Named User

Name of the named user, which can be a registered user or a registered computer.

Type

Type of license.

Status

Status of the named user.

Creation Date

Date the named user was created.

Last Access Time

Last access time for the specified user.

Created By

Method used to create the named user:

•

Access
Named user was created automatically by accessing the Cypress Server.

•

Manual
Named user was created manually by the Cypress administrator.

To add a Named User, click the Add button. The Add Licensed Client pop-up window displays.

Enter the name of the new client machine in the Client Name field.

Click OK to add the new machine.

To reduce administration, named user licenses are automatically populated when a new user accesses Cypress unless your license is a mix of named user and concurrent user/capture driver licenses.

In a mixed named user and concurrent user/capture driver license environment, if a user appears as Active in this list, a concurrent user/capture driver license will be used for a concurrent user and the licenses will allow access of both the concurrent user/printer driver and the named user.

Removing Client Machine Access to Cypress

During IP address conversions or user location change, you might find it necessary or desirable to remove certain client machines as named users. You accomplish this by deleting the machine from the Client List dialog in the Cypress Administration Tools module.

To remove a client machine’s access to Cypress

Open the Administration Tools module, and click the Info tab.

From the Info dialog, select the License tab and click the License Usage button. The License Usage dialog is displayed.

If it is not selected, select the Named Licenses tab.

Select the named user you want to remove, and click the Delete button.

You can remove a named user using the License Usage dialog if the user was created more than 30 days ago. This applies to users added manually and those added automatically by Cypress.

A system-created named user will be automatically deleted if the user is inactive for 30 days.

Reviewing Your Active Connections and License Usage

You can monitor active connections through the Current Client List dialog. Additionally, the License Usage dialog allows you to add and delete your named licenses as well as monitor your concurrent and device license usage.

Reviewing Your Active Connections

You can review your active connections from the License tab.

To review active connections

Open the Administration Tools module, and click the Info tab.

From the Info dialog, select the License tab and click the Active Connections button. The Current Client List dialog is displayed.

The Current Client List dialog contains these columns:

Column

Description

Address

User IP address

User

User name

Client Type

Client that is connecting to the server:

•

Printer Driver

•

Inbox

•

Query

•

CPF UI

•

CPF Prog

•

CSP

•

Server

•

Imaging

•

DVA

•

ODBC

•

JDBC

•

TCI Adptr

•

Unknown

Creation Date

Date and time the connection was established.

Reviewing Your License Usage

The License Usage dialog includes these three tabs:

•

Named Licenses tab. This tab lists your named users.

From this tab, you also can add or delete named users. See Managing User Licenses for more information.

•

Concurrent Licenses tab. This tab displays the peak concurrent license count, including the date and time the peak usage was recorded.

•

Device Licenses tab. This tab displays the total number of licensed devices and the number of devices being used currently.

To review your named users

Open the Administration Tools module, and click the Info tab.

From the Info dialog, select the License tab and click the License Usage button. The License Usage dialog is displayed, with the Named User tab selected by default.

The Named User tab contains these columns:

Column

Description

Named User

Name of the named user, which can be a registered user or a registered computer.

Type

Type of license.

Status

Status of the named user.

Creation Date

Date the named user was created.

Last Access Time

Last access time for the specified user.

Created By

Method used to create the named user:

•

Access
Named user was created automatically by accessing the Cypress Server.

•

Manual
Named user was created manually by the Cypress administrator.

To review concurrent usage information

Open the Administration Tools module, and click the Info tab.

From the Info dialog, select the License tab and click the License Usage button. The License Usage dialog is displayed.

Select the Concurrent Licenses tab.

The screen displays the concurrent user count and the date and time when it was reached, as shown in this example:

To review device usage information

Open the Administration Tools module, and click the Info tab.

From the Info dialog, select the License tab and click the License Usage button. The License Usage dialog is displayed.

Select the Device Licenses tab.

The screen displays the number of licensed devices and the number of them being used currently, as shown in this example:

License Rejection Notification

When a user’s access to Cypress is rejected due to administrative configuration or because the maximum number of licenses has been reached, an error message similar to this example is displayed when the user tries to connect to the DocuVault:

Contact ASG Customer Support for assistance with your license requirements.