License Administration Concepts
This section discusses the following topics:
•
License Models
•
License Enforcement
•
Message Logging
License Models
PSQL products offer two license models: concurrent user and capacity-based. The concurrent user model counts users, while the capacity-based model measures the data in use. In both models, once a set limit is reached, whether users or data, no additional database activity is allowed. For the user count model, no new users can access any data. For the data capacity model, no new data access requests are accepted. Once user count or data usage fall below the limit, new activity is allowed.
Concurrent User License Model
With the concurrent user license model, each product key specifies a licensed user count. A user count allows the specified number of concurrent connections to the PSQL database engine. Users are counted by network address. The IP address is used for TCP/IP. The IPX address is used for SPX/IPX.
Each computer that accesses the PSQL as a client session counts as one user. Multiple applications on a single client computer are counted as one user, not separate users. Internally, PSQL assigns each machine a serial number and counts all connections with the same serial number as coming from one machine. A machine with multiple NICs, for example, is recognized as one machine. Each Terminal Server session also counts as one user.
Collectively, all applications that access the database engine using the same network protocol and address and running on the same machine as the engine are counted as one user.
A user is counted for each unique incoming protocol from the same client computer session. If one application uses TCP/IP and another application uses SPX/IPX, two users are counted if both applications run on the same machine. If different address formats of the same protocol are used, only one user is counted. For example, if one application uses IPv4 and another uses IPv6, only one user is counted if both applications run on the same machine. IPv4 and IPv6 are just different address formats of TCP/IP.
Obtaining a User Count
An initial user count is provided as part of the product key. This product key is issued by Actian Corporation or by your application vendor if the PSQL database engine is embedded in an application.
You may also increase the user count beyond the initial amount provided by the product key. See Increasing User Count.
Capacity-based License Model
The capacity model shifts the emphasis from how many users to how much work the database server performs. The model is based on the process capacity of the engine determined by the amount of data in use. This amount is the total size of data files authorized to be opened concurrently.
Data in Use
Data in use is defined as the total size of all concurrently open data files. A data file is a file created by an application to provide the data processed by that application. Data in use limit is the maximum permitted amount of all concurrently open data files as granted by a license agreement.
The value for data in use increases when a data file is first opened. Subsequent opens to an already open data file do not add to the total. Data in use also increases if an open file increases in size. Operations on an already open file continue to be permitted even if the size of the open file increases beyond the data in use limit.
The value for data in use decreases when a data file is closed by the final user to have the file open. Since more than one user can access the same data file, all opens must be closed before data in use decreases.
Messages pertaining to data in use are logged to the various PSQL logging repositories. See Message Logging.
The database engine uses various files for its own internal processes, such as PSQL system files, metadata files, dbnames.cfg, and default databases. Files used for internal processes do not increase the value for data in use.
Estimating Data in Use
You can determine what size license you need for your business based on information about your data usage. PSQL provides Capacity Usage Viewer to provide that information.
Capacity Usage Viewer is a utility that records peak daily data use. It renders those figures into a graph that displays your use over time. Capacity Usage Viewer enables you to select time periods ranging from All to Last week. You can also zoom in to view the data for a customized time period.
To estimate your capacity requirements, select a time period that includes maximum and minimum licensing requirements. For example, if your business has quarterly cycles, include at least 90 days worth of data. By reviewing data usage usage over time, you can ensure that the license capacity meets or exceeds your peak usage requirements.
Refer to Capacity Usage Viewer for detailed information about how to access and use Capacity Usage Viewer.
*Note: Monitor can also help you estimate session count and data in use. See Monitor in this guide and Monitoring in Advanced Operations Guide.
Behavior When Data Use Limit Is Reached
The following summarizes the expected behaviors when the limits are reached for data in use.
•
The database engine denies requests for new file opens and returns status code 161 to the application. (Status code 161 is returned if the file to be opened exceeds 110% of the data in use limit. A slight buffer above 100% is provided because an increase in data in use can also result from the growth of currently open data files.)
•
Subsequent opens to an already open data file are permitted. That is, if a file is already open and data in use reaches or exceeds its limit, other users can still access the open file.
•
Note that data in use also increases if an open file increases in size. Operations on an already open file continue to be permitted even if the size of the open file increases beyond the data in use limit.
•
The value for data in use decreases when a data file is closed by the final user to have the file open. Since more than one user can access the same data file, all opens must be closed before data in use decreases.
•
Messages pertaining to data in use are logged to the various PSQL logging repositories. For example, a message first alerts you when data in use reaches 90% of the data in use limit.
Corrective Action When Data in Use Limit Is Reached
The following suggested corrective actions actions may be taken when the data in use limit is reached in order to continue working with the engine.
•
Authorize an increase key for data in use. An increase key can be authorized at any time and does not require that you close data files or stop the database engine. The increase is immediately available. See Increasing Data in Use Limit
•
You may try closing some of the currently open data files. However, this action requires that you know which data files are safe to close without resulting in incorrect data, incomplete records or aborted transactions
Obtaining an Initial Data in Use Limit
Initial data in use limits are provided in the product key. The key is issued by Actian Corporation or by your application vendor if the PSQL database engine is embedded in an application.
You may also increase the data in use beyond the initial amount provided by the product key. See Increasing Data in Use Limit.
License Enforcement
Licensing for PSQL is enforced by use of product keys, which you manage using the License Administrator utility. The utility allows you to authorize and deauthorize keys and view license information. It has both a graphical and command line interface. You authorize a key for one of two purposes:
•
Authorize a Product
•
Increase User Count or Data in Use
Authorize a Product
Product authorization is a key validation process that associates certain machine information with the license for a product, called the “product key.” This association results in a unique installation identification that ensures the copy of software is legitimate and on the appropriate machine.
When you authorize a product key, the unique installation ID is sent to Actian Corporation to verify the authenticity of the key and ensure it is not being used for multiple installations. This process authorizes the product for use. When the product key is authorized or deauthorized, your remaining authorizations are displayed.
Note that after you have authorized a product key on a machine, certain changes to the machine can disable the key. If you need to make changes to the machine, deauthorize the key first. Doing so disassociates the product key from its unique installation ID. After you complete the hardware configuration changes, you can again authorize the product key.
Authorization Access Through a Proxy Server
If you are using a proxy server to reach the PSQL license service, you must configure it to allow product authorization. You can configure the proxy server before you install PSQL or you can skip product authorization during installation, then configure the proxy server, and then authorize.
This section covers the following topics:
•
Windows Proxy Servers
•
Linux and OS X Proxy Servers
•
Offline Authorization Without Internet Access
•
Key Status, or State
•
Failed Validation and Failed-Validation Period
•
Repairing a Disabled or Failed Key
Windows Proxy Servers
We recommend that you use Windows Internet Explorer to configure proxy servers. If your proxy server was not configured using Internet Explorer, we recommend that you use Internet Explorer to configure it again. If you are unable to use Internet Explorer, then you can use the steps given here. These steps involve editing the Windows Registry.
In a 64-bit Windows operating system, two keys in the Registry can store proxy server settings:
•
HKEY_LOCAL_MACHINE\Software\Pervasive Software\ELS
•
HKEY_LOCAL_MACHINE\Software\Wow6432Node\Pervasive Software\ELS
Depending on the PSQL edition (Server, Client, Vx Server, or Workgroup), the ELS proxy server settings can be created in either location. Licensing manager looks for its proxy server settings first in the HKEY_LOCAL_MACHINE\Software\Wow6432Node\Pervasive Software\ELS\ key. If it cannot locate them there, it looks in the HKEY_LOCAL_MACHINE\Software\Pervasive Software\ELS\ key.
If you are editing Registry settings for proxy servers, you first need to find the correct location.
1
Begin by looking for a Wow6432Node. If it exists, edit the proxy server Registry settings in the Pervasive Software\ELS\ key.
2
If you find no Wow6432Node, move to the Software directory and edit the proxy server Registry settings in the Pervasive Software\ELS\ key.
3
Modify the Windows Registry by adding the following to the Pervasive Software\ELS\ key:
String Value
proxy_host
DWORD Value
proxy_port
String Value
proxy_userid
String Value
proxy_passwd
Note: The proxy_host and proxy_port values are the only ones required by PSQL. Depending on the configuration of your proxy server, you may also need to add proxy_userid and proxy_passwd.
4
Authorize PSQL using License Administrator. See To Authorize a Key for the GUI and To Authorize a Key for the CLI.
*Caution: Editing the Registry is an advanced procedure. Improper edits can cause your operating system to fail to start or behave incorrectly. If necessary, obtain the services of a qualified technician to do the editing. Actian Corporation does not accept responsibility for a damaged registry.
Linux and OS X Proxy Servers
On Linux and OS X systems, to configure a proxy server to allow license authorization, you must edit the els.ini file. PSQL does not support any other method of authorization through a Linux or OS X proxy server.
1
Locate els.ini. In a default installation, you can find it in /usr/local/psql/etc.
2
Manually edit els.ini to include the following:
proxy_host
proxy_port
proxy_userid
proxy_passwd
Note: The proxy_host and proxy_port values are the only ones required by PSQL. Depending on the configuration of your proxy server, you may also need to add proxy_userid and proxy_passwd.
3
Authorize PSQL Vx Server using the License Administrator CLI utility. See To Authorize a Key.
Offline Authorization Without Internet Access
If you install PSQL on a system without Internet access, you may authorize the product key using offline authorization. Offline authorization involves three tasks:
1
On the machine without internet connectivity, generate an Authorization Request Data file. This file has the extension .ath.
2
Upload the file to an authorization server from a machine with internet access. In response, an Authorization Key Data file is downloaded in the form of a product key file. This file has the extension .pky.
3
Place the .pky file on the machine without Internet connectivity to authorize PSQL.
The quickest and simplest method for authorizing PSQL is using online or remote authorization. Whenever possible, try to authorize your PSQL product using one of these methods. The PSQL installation, for example, allows you to authorize online as part of the installation process.
Key Status, or State
The status of a product key is displayed in the License Administrator as the state. Key states include the following:
•
Active – Key is authorized and available for use.
•
Inactive – Key is no longer in use. This state is reserved for situations where the key is incompatible with the current engine. Examples would include previous versions of PSQL, such as v10 and prior on v11, or a Workgroup key on a Server engine, or 32 bit key on a 64-bit engine.
•
Expired – Key is no longer available for use. Temporary keys move to the Expired state once their evaluation period has passed.
•
Disabled – Key is no longer available for use. If a key is disabled because of a failed validation, it can be restored to active by fixing the problem and then performing a validation on the key.
•
Failed Validation – Key is usable but only for a set number of days. See Failed Validation and Failed-Validation Period.
Failed Validation and Failed-Validation Period
If a key fails validation, you have a set number of days to remedy any condition that caused it to fail. This period of time, referred to as the “failed-validation period,” is reported in the Expiration Date column of License Administrator, as shown in GUI Visual Reference. If the condition for the failed validation is not corrected by the date, the key changes state to disabled.
After you implement changes to correct the failed validation, perform a Validation action. See To Perform a Validation. The validation, among other actions, verifies the current machine signature and key combination. If the conditions were corrected, the state of the key changes to active.
More than one condition at a time can cause a failed validation. You can correct what you think is the sole condition, yet the key remains in the failed validation state. If so, refer to the PVSW.LOG file for more information. That log file contains all of the conditions causing the failed validation. See PSQL Event Log (pvsw.log) in Advanced Operations Guide.
If the changes that caused the failed validation are due to intentional hardware upgrades performed without first deauthorizing the key, the next step is to repair the key.
Repairing a Disabled or Failed Key
License Administrator provides the functionality to perform a repair on a key that is disabled or has failed validation. Moreover, it not only repairs the key, it automatically deauthorizes the key and then authorizes it again on the same machine.
You can perform a repair using either the graphical user interface (see License Administrator Graphical User Interface) or the command line interface (see License Administrator Command Line Interface).
If the problem is more significant than a change in hardware, for example, the machine on which a key is installed no longer boots, you cannot repair the key. In that case, contact support for assistance.
Increase User Count or Data in Use
Situations can arise in which you want to increase user count or data in use from the initial amount provided by the permanent product key. You increase the amount by authorizing an increase key. Multiple increase keys can be authorized on a product key.
When you authorize the key, the increase is available immediately. You do not need to restart the database engine.
To authorize an increase key, you must already have a permanent product key present on the system. The software vendor ID number for an increase key must match the vendor ID number for an installed permanent key. Increase keys obtained from Actian Corporation are universal. That is, they are compatible with any permanent key from any vendor.
Increasing User Count
You increase the user count by authorizing a user count increase (UCI) key. See To Authorize a Key and To Determine a Total User Count. UCI keys are provided by Actian Corporation or an application vendor.
If you deauthorize a permanent product key, all user count increase keys associated with that permanent key are also deauthorized. If you deauthorize a UCI key, only the user count increase associated with that UCI key is deauthorized.
Trial versions of the software include a trial license that have a set user count that cannot be increased.
Increasing Data in Use Limit
Actian Corporation or an application vendor offers a key to increase the data in use limit. You immediately increase the value of the data in use limit when you authorize the key. A restart of the database engine is not required. A permanent key must be present to authorize an increase key. An increase key cannot be authorized onto a temporary key. See To Authorize a Key and To Determine the Data in Use Limit.
If you deauthorize the permanent product key, all increase keys associated with that permanent key are also deauthorized. If you deauthorize an increase key, only the data in use increase associated with that key is deauthorized.
Note that the database engine logs a message to the PSQL logging repositories when the limit for data in use is increased. The message contains the current limit and usage. See also Message Logging. You can monitor the current, peak, and maximum values of data in use with the Monitor utilities. See Monitoring in Advanced Operations Guide.
Trial versions of the software include a trial license that have a set value for data in use that cannot be increased.
Message Logging
Messages pertaining to licensing are logged to the various logging repositories used by PSQL, such as Notification Viewer. See Reviewing Message Logs in Advanced Operations Guide.