Properties File Updater Service (com.ibi.agents.XDPropertyUpdater)

Syntax:

com.ibi.agents.XDPropertyUpdater

iIT Service Object:

misc: Properties file updater

Description:

This service updates a properties file with one or more properties. The properties file can be read by the _property() iWay Functional Language (iFL) function, or by any appropriate tool.

Parameters:

Parameter

Description

Path*

The full path to the properties file to be updated. The suffix .properties is appended if it is not included in the file name. If the file does not exist, then it will be created.

Call at EOS?

In a streaming environment, End of Stream (EOS) is the short message that is sent after the last document, which signifies the EOS. This parameter determines whether this service should be called for the EOS message. By default this parameter is set to false.

The properties themselves are user parameters, each constituting of a name/value pair. The values are evaluated by iFL before the file is updated. If the evaluation results in a null value, then the property is deleted from the file.

Edges:

The following table lists and describes the line edges that are returned by the Properties File Updater service (com.ibi.agents.XDPropertyUpdater).

Edge

Description

success

The properties file was updated.

fail_notfound

The properties file was not found and could not be created.

fail_parse

iFL could not be parsed.

fail_operation

The properties file could not be read or written.

Example:

When using the Properties File Updater service (com.ibi.agents.XDPropertyUpdater) as an object in a process flow, this service focuses on the user parameters that are defined within the input document. You can pass any input document to this service.

Consider the following user parameters, which consist of simple name/value pairs:

The Properties File Updater service will create or update these specific user parameters in the input document.

A typical use case would be to use XPath to set the values of the user parameters. For example, if your input document looked like the following:

<props><first>John</first><second>Chris</second><third>Mary</third></props>

You might define the user parameters as follows: