OFXAggregate Component

Properties   Methods   Events   Config Settings   Errors  

The OFXAggregate component supports parsing of XML aggregates that can be retrieved from other components.

Syntax

TiboOFXAggregate

Remarks

The OFXAggregate component supports simple XML aggregate traversal functionality. Simply set the Aggregate property to the value received from any aggregate property of any component in the package (e.g. the TxAggregate property from BankStatement or CCStatement). You can then use XPath to walk the Document Object Model (DOM) tree.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

Aggregate Property (OFXAggregate Component)

The full text of the current aggregate.

Syntax

property Aggregate: String read get_Aggregate write set_Aggregate;

Default Value

''

Remarks

Aggregate contains the full text of the XML aggregate currently being represented by the component's DOM. You may set this to a value obtained from any aggregate property of any other control (such as SignOnInfoAggregate from FIProfile). Once set, you can use XPath to walk the DOM tree. XElement and XText will retrieve the current element's name and contents, and XChildren can be used to get the number of children.

Namespaces Property (OFXAggregate Component)

This property includes a collection of namespaces in the current namespace stack.

Syntax

property Namespaces: TiboXMLNamespaceList read get_Namespaces write set_Namespaces;

Remarks

This property contains a collection of XML namespaces, which are standards for providing uniquely named elements and attributes in an XML instance.

This property is not available at design time.

XChildren Property (OFXAggregate Component)

This property includes a collection of child elements of the currently selected XML element.

Syntax

property XChildren: TiboXMLElementList read get_XChildren write set_XChildren;

Remarks

This property contains a collection of child elements of the currently selected XML element. The elements are provided in the collection in the same order they are found in the XML document.

This property is not available at design time.

XElement Property (OFXAggregate Component)

This property includes the name of the current element.

Syntax

property XElement: String read get_XElement write set_XElement;

Default Value

''

Remarks

The current element is specified through the XPath property.

XNamespace Property (OFXAggregate Component)

This property includes the namespace of the current element.

Syntax

property XNamespace: String read get_XNamespace write set_XNamespace;

Default Value

''

Remarks

The current element is specified through the XPath property.

XParent Property (OFXAggregate Component)

This property includes the parent of the current element.

Syntax

property XParent: String read get_XParent;

Default Value

''

Remarks

The current element is specified through the XPath property.

This property is read-only.

XPath Property (OFXAggregate Component)

This property provides a way to point to a specific element in the document.

Syntax

property XPath: String read get_XPath write set_XPath;

Default Value

''

Remarks

XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

BuildDOM must be set to True before parsing the document for the XPath functionality to be available.

Example. Setting XPath:

XPrefix Property (OFXAggregate Component)

This property includes the prefix of the current element.

Syntax

property XPrefix: String read get_XPrefix write set_XPrefix;

Default Value

''

Remarks

The current element is specified through the XPath property.

XText Property (OFXAggregate Component)

This property includes the text of the current element.

Syntax

property XText: String read get_XText write set_XText;

Default Value

''

Remarks

The current element is specified through the XPath property.

Config Method (OFXAggregate Component)

Sets or retrieves a configuration setting.

Syntax

function Config(ConfigurationString: String): String;

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

HasXPath Method (OFXAggregate Component)

Checks whether a certain XPath exists inside the aggregate.

Syntax

function HasXPath(XPath: String): Boolean;

Remarks

Used when there is no assurance that a certain XPath exists inside an aggregate.

Error Event (OFXAggregate Component)

Fired when information is available about errors during data delivery.

Syntax

type TErrorEvent = procedure (
  Sender: TObject;
  ErrorCode: Integer;
  const Description: String
) of Object;

property OnError: TErrorEvent read FOnError write FOnError;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

XMLElement Type

This type describes an element contained within the XML document.

Remarks

This type describes an XML element. The fields for this type describe the element Name, Prefix, and Namespace of the given element.

The elements are inserted into the array in the same order they are found in the document.

• Name
• Namespace
• Prefix
• XText

Fields

Constructors

constructor Create();

XMLNamespace Type

This type describes an XML namespace from the current namespace stack.

Remarks

This type describes an XML namespace from the current stack. It includes fields to denote the Prefix and the URI of the namespace being defined.

The default namespace exists at index 0. The Prefix field at index 0 is xmlns, and the Name field contains the default namespace.

• Prefix
• URI

Fields

Constructors

constructor Create();

constructor Create(valURI: String; valPrefix: String);

Config Settings (OFXAggregate Component)

XML Config Settings

<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
...

Base Config Settings

Trappable Errors (OFXAggregate Component)

XML Errors