Show/Hide Toolbars

Licence Protector 5

 

Below is a complete description of all values of the project template. Values with an (D) are just set as default values in the project file and can be changed within the License Generator when creating a license file for a customer.

 

All entries are case sensitive – e.g. Absolutedays instead of AbsoluteDays would be wrong.

 

Tag

Description

Comment

<LicenceProtector> *

Surrounds the whole project configuration


<Default> *

Surrounds the global project definitions.


<ProjectName>

Name of the project. If this item is empty, the filename of the project file is used. The project name is used to administrate the numbers of projects within the License Generator, The project name should be unique.

If no explicit project is set in a Web Activation Call this ProjectName is used. So be sure to use the same name in the definition of your Web Activation configuration.  It should contain no spaces and is case sensitive

 

Example:

Demo project

<ProjectSecureKey> *

The PSK is used to encode and decode the license files of a project.

Please use a minimum of 6 characters, 15 and more are recommended. Note: The PSK must never be modified after having been applied, because otherwise you would not be able to read your license files.

Example:

What a beautiful morning

<SecurityLevel>

Possible values are BASIC and ADVANCED. In advanced mode the ReadKey and WriteKey are used.

Default is ADVANCED. BASIC is only for backward compatibility to version 1.x or 2.x. See details.

<WriteKey>

The Write Key is used in projects with security level ADVANCED to write the license file. It has to be created using the function “File, Create Project Keys” in the License Generator and has to match its Read Key.

It may be longer than 255 characters

.

<ReadKey>

The Read Key is used in projects with security level ADVANCED to open the license file. It has to be created using the function “File, Create Project Keys” in the License Generator and has to match its Write Key.


<CopyProtection> (D)

The default CopyProtection used in this project:

0 = None
1 = Copy Protection Volume ID

2 = Copy Protection MAC Address

3 = Copy Protection Hostname

4..n see chapter copy protection for the latest options

Example:

2

<Manufacturers> (D)

All companies which should be listed in the field Manufacturer in the  Licence Generator.

The first entry is the default value. Multiple entries have to be separated by a semicolon

Example:

Mirage Computer Systems GmbH;Another Company;And the third Company

<NextLicFileKey>

Next license File ID which is assigned to the license file. If you create licenses at different locations, we recommend that you use an own range of values for each location. Example: use 20000 for location 2 as starting value. The value range is between 1 and 2147483647

This value is automatically increased if a license file is created by a Licence Protector 5 Generator. Ensure to have write-access to the project file.

<NameLicenceFile> (D)

Name of the license file which is used as default name when saving the file

Example:

MyApplication

<CustomerName> (D)

Default value for the Customer information in the license file. This value is overwritten if interactively changed in License Generator.

Example:

Evaluation

<TagValue>

Special string value for the whole license file. There is also a TAG value per module available

Individual information can be stored here

<AllowSetVal>

Controls whether this license file may be altered with SetVal calls

Default is yes. See also command SetVal

<DefaultDiffPct>

Difference percentage used in Concurrent user modules. This value is used in a module if not explicitly set with <DiffPct>. It not set a built in default value is used

See also command DiffPct

<CheckInterval>

Sets the interval of the concurrent user heartbeat in seconds. Default value = -1 (automatic calculation depending on number of licenses)

See also command SetCheckInterval

<ConcurrentUserLevel>

Sets the concurrent user level 0 = Heartbeat, 1 = Light - Details

See also command ConcurrentUserLevel

<TamperDetection>

Switch to turn on or off the detection of manipulation of the license file.

Default is no. See also command TamperDetection

<TamperDetectionMode>

Sets the mode of the detection of manipulation:

off, auto, manual

Default is off

<TamperDetectionGraceTimes>

Allowed negative difference between the Run Numbers of the license file and the local Registry

Default is 0

<WebServiceURL>

The URL used to reach the Web Activation Service. Details

Example:

http://www.lptest/lpweb/lpws.asmx

<AllowChangeWASURL>

Controls if the set URL to the Web Activation Service can be manually changed by the user.

Default is no. See Online Activation

<ShowWAStartPage>

If Web Activation calls are used this setting controls if the Web Activation client start page is shown

Default is true.  See also command ShowWAStartPage and Online Activation

<ShowWAProgressPage>

If Web Activation calls are used this setting controls if the Web Activation client progress page is shown

Default is true.  See also command ShowWAProgressPage and Online Activation

<ShowWAResultPage>

If Web Activation calls are used this setting controls if the Web Activation client result page is shown

Default is true.  See also command ShowWAResultPage and Online Activation

<LicenceVerification>

Sets the mode of the online license verification. Possible values are:

off = turned off

on = Ongoing Verification

frozen = License is locked

deactivated = Verification is deactivated

 

That mode controls the behaviour of the CheckLicence call. Details Regular Online Checks

Default is off.  See also command LicenceVerification

<EndVerification>

Controls on which date the ongoing license Verification is stopped. A value of +10 would calculate 10 days from now,

Absolute dates can also be used.

Default is open end.

 

<Reseller>

Name of a Reseller

This name can be changed in the License Generator and is also stored on the Activation Server 6

<AppVersion>

Version number of the application

The version number can be can be changed in theLicense Generator and is also stored on the Activation Server 6. Details

<UseAlwaysAllModulesForCPSwOn>

true / false

true - one Unlock Key activates all modules

 

false (default) - one Unlock Key activates one module

 

Only modules where the activation status is set to required are unlocked

<MainModuleID>

Module ID of the main module

If empty, the first module is the main module

<AnonymizedMetrics>

true

True / False. Default is true. Configuration in Activation Server Settings

<SignalState>

on

off, on, offline, noautoresend. Default is on

<SystemSignals>

fist;acmm;acam;daam;damm;fivd;eist

List of metrics events. Default is none. Configuration in Activation Server Settings

First application start ='fist' (no module ID). Does not matter if demo mode or not

First Validate as Demo = 'fivd'  (on module level)

First Validate (no demo) = 'fiva'

First Activation of Main Module = 'acmm'

First Activation of any Module = 'acam'

First Deactivation(Lock) of Main Module = 'damm'

First Deactivation(Lock) of any Module = 'daam'

<BackupInterval>

30

0 = off (default). Set the backup interval instead of using SetBackupInterval

<WebRequestTimeoutInSec>

30

empty or 0 = default. Set the timeout in seconds instead of using

SetWebRequestTimeoutInSec

<LicenceModules>

Surrounds all modules inside this project


<Module>

Surrounds a module definition


<ModuleID>

Unique number for each module. May occur only 1 time per project file. It is used as a parameter in most DLL calls.

Format of the ModuleID is up to 6 characters containing only characters A-Z (only upper case) and digits 0 to 9. The ModuleID is case insensitive.

 

Example:

D1001

<ModuleName>

Name of the module. This name is used in License Viewer and should be self-descriptive

Example:

ERP-Module

<ModuleType>

Type of a module. Explained in chapter Module Type
U or 1 = license per user
S or 2 = license per Computer
C or 3 = Counter Module
Y or 4 = Yes/No Module
I or 5 = ITEM Counter
R or 6 = Concurrent user license

Example:

Y

<Value> (D)

Default for number of licenses in the module. A module of type 4 (Yes/No) is set to yes or no.

Example:

10 (e.g. user licenses in a type 1 module)

Yes (in a type 4 module)

<Days> (D)

Default for Number of days in the module. This value starts to count after the first Validate to that module („Module initialisation“)

Example:

10

10 days after the first Validate()-call this module will expire.

<ValidUntilDay> (D)

Default value. Explicitly set or calculated date of expiry of this module.

The difference between a fix date set with <ValidUntilDay> to 30 days from today to a value 30 in the field <Days> is that with <ValidUntilDay> the module will expire in 30 days regardless when the software will be installed. When 30 is set in <Days> then the module will expire 30 days after the module is first Validated.

Use an explicit date in the format set in your Windows settings e.g. 5/16/2005 or use a term +X to calculate the date as today plus X days. E.g. +30 calculates a date 30 days from today

<Demoversion> (D)

Default value. A yes or no value to set the mode of this module

Example:

Yes

<WebActivation> (D)

Default value for Web Activation. Valid values are:

0 or none

1 or required

2 or done

3 or erroneous

See Web Activation for further details.

Example:

Required

<TagValueModule> (D)

Default value. Special value to detect a software hack - for details see developer documentation


<LoadAsDefault>

A yes/no value to control whether this module is shown when the project is loaded in License Generator or not. With this feature you can load all modules normally needed in a project automatically


<IsSerial>

Defines, if a module is a Serial Number

Valid values are:

yes

no

Details see - define Serial Number

<AllowDeactivate>

A yes/no value that is only applicable for module type 1, 2 and 5. Defines, whether a user or ITEM can be deactivated in order to free a license.


<ForceOnlineCheck>

Only useful for key generation in the Automatic License Generator. A yes/no value to control whether generated keys should be checked with the Web Activation server


<AbsoluteLics>

A Yes/No Value. Only useful for key generation in the Automatic License Generator. If set to Yes the number of licenses in Value is not added to the present number of licenses in the license file, it overwrites the number of licenses with the absolute value.

This value is overridden if the value <AbsoluteLics> is set in the product configuration file or in the order file

Example: In a license file there are 5 licenses for a Module X. A key for 3 licenses with AbsoluteLics set to no will increase the number of licenses to a total of 8 licenses. The same key with AbsoluteLics set to yes will set the total number of licenses to 3.

 

Default is not set.

<AbsoluteDays>

A Yes/No value. Only useful for key generation in the Automatic License Generator. If set to Yes the number of days in Value is not added to the present number of days in the license file, it overwrites the number of days with the absolute value.

This value is overridden if the value <AbsoluteDays> is set in the product configuration file or in the order file

If set to yes a key will set the maximum number of days to <Days> unattached if there are already existing number of days in the license file.

 

Default is not set.

 

 

<EasyGoWorkflow>

Define a workflow

More Details

<ActivationStateAfterCPon>

Default action if an Unlock Key is applied. Changes the status of the value activation to
 

0 =  no change
1 = Activation Required, delete time limitation

2 = Activation done, delete time limitation

11 = Activation required, don't change time limitation

12 = Activation done, don't change time limitation

This entry defines the action if an Unlock Key or a key to enable copy protection is entered (either in the License Viewer or with ApplyActivationKey). A standard action would be to delete the time limitation, delete the demo version flag, set status of activation to done

 

12

 

More details

 

 

<SubGraceDays>

Number of days for the grace period in case the online validation with CheckModuleSubscription fails

0 = no grace days

<ModuleVerification>

Sets the mode of the online license verification. Possible values are:

off = turned off

on =  regular online verification is enabled

frozen = license is locked

deactivated = regular online verification is deactivated (see EndModuleVerification)

 

That mode controls the behavior of the CheckModuleSubscription and CheckModule call. Details Regular Online Checks

Default is off.  See also command GetVerificationOfModule

<EndMOduleVerification>

Controls on which date the ongoing license Verification is stopped. A value of +10 would calculate 10 days from now,

Absolute dates can also be used

Default is open end.

<configs>

1 [1,1]

Surrounds all configuration values

Store configuration values and data. See details in the chapter Store data in the license file

<config>

2 [1,n]

Surrounds a configuration definition


<name>

3 [1,1]

Unique name of a configuration value

A unique name to store a value

 

Example:

BasicConfiguration

<visible>

3 [0,1]

A Yes/No value.Defines, if the config value is visible in the License Viewer



[1,1]

Configuration value. Can be any ASCII Text

This is a text