Installation and Getting Started Guide

Installation and Getting Started Guide

FileSets Elements in the IDVEState.schema.json file

FileSets Elements in the IDVEState.schema.json file

The FileSets elements provide information about the reference datasets that the engine opens. The
IDVEConfig.json
file helps you determine the datasets that the engine can open.
Find the following elements in the FileSets group:
FileSetsInfo
Identifies the current status of the file sets. The status is the same as that in the
FileSetsInfo.json
on disk.
FileSetsInfo contains the following properties:
FileSetAState
Identifies the state of FileSetA. The property can have one of the following values:
  • InUse. Indicates that FileSetA is currently loaded by the engine.
  • Unused. Indicates that no files from FileSetA are loaded.
  • ReadyToUse: Indicates that a user has triggered a hot-swap operation through a manual update to the
    FileSetsInfo.json
    file and that the engine is about to load FileSetA. To trigger the hot-swap operation, update the FileSetA property in the
    FileSetsInfo.json
    file from Unused to ReadyToUse. Alternatively, you can trigger a hot-swap through an API call.
    If you use an API call to trigger the hot swap, the state value changes from Unused to PreparingForUse and does not record a value of ReadyToUse.
  • PreparingForUse: Indicates that the engine is loading the files in FileSetA. Once the files are loaded, the property is set to InUse.
  • StillInUse: Indicates that the engine has switched from FileSetA to FileSetB in a hot-swap operation, but one or more address jobs that began on FileSetA have yet to complete.
FileSetBState
Identifies the state of FileSetB. The property can have one of the following values:
  • InUse. Indicates that FileSetB is currently loaded by the engine.
  • Unused. Indicates that no files from FileSetB are loaded.
  • ReadyToUse: Indicates that a user has triggered a hot-swap operation through a manual update to the
    FileSetsInfo.json
    file and that the engine is about to load FileSetB. To trigger the hot-swap operation, update the FileSetB property in the
    FileSetsInfo.json
    file from Unused to ReadyToUse. Alternatively, you can trigger a hot-swap through an API call.
    If you use an API call to trigger the hot swap, the state value changes from Unused to PreparingForUse and does not record a value of ReadyToUse.
  • PreparingForUse: Indicates that the engine is loading the files in FileSetB. Once the files are loaded, the property is set to InUse.
  • StillInUse: Indicates that the engine has switched from FileSetB to FileSetA in a hot-swap operation, but one or more address jobs that began on FileSetB have yet to complete.
FileSetA
Identifies the data files in the FileSetA folder. Each file has a .MD6 extension, and provides the following information:
  • FilePath. Identifies the path to the data file on the disk.
  • Status. Identifies the status of the file. The status can be Active or NotLicensed.
  • UpdateVersion. Identifies the internal version number of the file.
  • UUID. Uniquely identifies the file. Each file has its own UUID.
  • Created. Identifies the date and time of file creation.
  • CountryISO3. Identifies the country for which the file contains data.
  • Type. Contains additional information about the data file type.
  • Description. Contains additional information about the data file type.
  • DataSetID. Denotes the data set ID value.
  • FunctionMinVersion. Denotes the oldest version of Address Verification with which you can use the file.
  • PreloadExtent. Identifies the amount of the data that is preloaded into memory. The value can be Full, Partial, or None.
  • PreloadSizeBytes. Identifies the amount of data that is preloaded into memory.
FileSetB
Identifies the data files in the FileSetB folder. Each file has a .MD6 extension, and provides the following information:
  • FilePath. Identifies the path to the data file on the disk.
  • Status. Identifies the status of the file. The status can be Active or NotLicensed.
  • UpdateVersion. Identifies the internal version number of the file.
  • UUID. Uniquely identifies the file. Each file has its own UUID.
  • Created. Identifies the date and time of file creation.
  • CountryISO3. Identifies the country for which the file contains data.
  • Type. Contains additional information about the data file type.
  • Description. Contains additional information about the data file type.
  • DataSetID. Denotes the data set ID value.
  • FunctionMinVersion. Denotes the oldest version of Address Verification with which you can use the file.
  • PreloadExtent. Identifies the amount of the data that is preloaded into memory. The value can be Full, Partial, or None.
  • PreloadSizeBytes. Identifies the amount of data that is preloaded into memory.

0 COMMENTS

We’d like to hear from you!