X4 Produktdokumentation

Java Properties File Reader

This adapter reads a Java properties text file and stores all or selected properties in a hash table that is globally available to all Technical Processes during server runtime.

Each property is assigned a unique key. The adapter can also read the global hash table and output its contents in an XML document either completely or after a regex filter.

Properties

Operation

Determines which operation the adapter executes

Possible values:

  • ReadFromFile: Read properties text file and store properties completely or with a RegEx filter in a global hash table.

  • ReadFromMap: Read global hash table and output its contents in an XML document

Parameters

file

Path to the properties text file in the repository or absolute path in the file system of the X4 server

Possible values:

  • Any repository path (e.g. %USER_COLLECTION%/Project/Folder/sample.properties)

  • Any absolute path (e.g. C:\Data\sample.properties)

fileKey

Key that is prefixed to the properties read in to make them uniquely identifiable. For example, a property sample.property is supplemented with the key x4propkey and stored in the hash table as x4propkey.sample.property.

Possible values: Any string (e.g. x4propkey).

filterRegex

Regular expression by which the properties are to be filtered (only for ReadFromFile operation); multiple filter expressions can be specified separated by semicolons (;).

Possible values: Any regular expression (e.g. .*sample.*)

Status values

1

The operation was executed successfully.

0

The operation was executed successfully, but without any result.

-1

The operation failed due to a technical error.