Installation and Getting Started Guide

Installation and Getting Started Guide

Licenses Elements in the IDVEState.schema.json file

Licenses Elements in the IDVEState.schema.json file

The Licenses elements and properties in
IDVEState.schema.json
specify an array of licenses that IDVE loads. Each license file has a .LIC extension.

SchemaVersion

Contains a set of properties that identify the version of the schema in which the license files are written.
Find the following elements under
Licenses/SchemaVersion
:
  • Major
  • Minor
  • Descriptive
  • Revision
The property values collectively constitute a single string that identifies the version of the schema. For example, the version number 1.0.0.0 includes individual values from the Major, Minor, Descriptive, and Revision properties.

General

Find the following elements under
Licenses/General
:
CustomerID
Identifies the Customer ID for the user who has the license.
LicenseID
Identifies the identity of the license.
IssueDate
Identifies the date of issue of the license.
StartDate
Identifies the beginning of the validity period of the license.
The license does not activate any functionality before the start date.
ExpirationDate
Identifies the end of the validity period of the license.
The license does not activate any functionality after the end date.
ExecutionContexts
Contains properties that indicate the run-time environments in which the engine can operate.
ExecutionContexts contains the following properties:
OS_Architectures
Identifies the operating systems on which the engine can run.
Environment
Identifies any additional restrictions on the run-time environments in which the engine can operate.
MaxNumCores
Identifies and limits the maximum number of active function servers.
If the number of function servers in the configuration exceeds limit, then the other function servers get into hot-standby mode and are can no longer process resources.
DeploymentType
Identifies whether the issued license is for development and testing or for production.

AddressVerification

Find the following elements under
Licenses/AddressVerification
:
MinVersion
Identifies the minimum required version of Address Verification for valid license.
The
AddressVerification
part of the license does not have any effect without the Address Verification version.
GeneralFeatures
Contains properties that indicate the depth of information that the engine can return in an address verification job.
GeneralFeatures contains the following properties:
VerificationLevel
Identifies the verification level that currently limits any address verification job that you run in the engine.
DetailedStatus
Indicates whether you can request element status values in an address verification job.
MultipleVariants
Indicates whether you can request more than one result variant in an address verification job.
SubItems
Indicates whether you can request sub-items in an address verification job.
CountrySpecificFeatures
Identifies the reference database files that current licenses permit the engine to read.
CountrySpecificFeatures contains the following properties:
ProcessType
Identifies the types of data processing operation for which the engine is eligible to read reference database files, based on the current licenses.
ProcessType
is a string property. For example, a value of Verify indicates that the engine can verify addresses.
ProcessSubTypes
Identifies the process modes in which the engine is eligible to read reference database files, based on the current licenses. For example, a value of
Batch
indicates that the engine can run in batch mode. The
ProcessSubTypes
property can return multiple process modes in an array.
Countries
Identifies the countries for which the engine is eligible to read reference database files, based on the current licenses. The file identifies the countries by ISO code. For example, a value of DEU indicates that the engine can process data from Germany. The
Countries
property can return multiple ISO codes in an array.
DataSets
Contains the three-digit IDs of the types of reference data set that the engine can read, based on the current licenses. The
DataSets
property can return multiple IDs in an array.
The properties under
CountrySpecificFeatures
apply collectively to define the reference database files that the engine can read. For example, a
ProcessSubTypes
value of
Batch
does not indicate that the engine can read any file of batch data, and a Countries value of DEU does not indicate that the engine can read any file of German data.

0 COMMENTS

We’d like to hear from you!