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 String Aggregate = { read=FAggregate, write=FSetAggregate };

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.

Data Type

String

NamespaceCount Property (OFXAggregate Component)

The number of records in the Namespace arrays.

Syntax

__property int NamespaceCount = { read=FNamespaceCount, write=FSetNamespaceCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• NamespacePrefix
• NamespaceURI

The array indices start at 0 and end at NamespaceCount - 1.

This property is not available at design time.

Data Type

Integer

NamespacePrefix Property (OFXAggregate Component)

This property contains the Prefix for the Namespace .

Syntax

__property String NamespacePrefix[int NamespaceIndex] = { read=FNamespacePrefix, write=FSetNamespacePrefix };

Default Value

""

Remarks

This property contains the NamespacePrefix for the Namespace.

The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is not available at design time.

Data Type

String

NamespaceURI Property (OFXAggregate Component)

This property contains the namespace URI associated with the corresponding Prefix .

Syntax

__property String NamespaceURI[int NamespaceIndex] = { read=FNamespaceURI, write=FSetNamespaceURI };

Default Value

""

Remarks

This property contains the namespace URI associated with the corresponding NamespacePrefix. This URL is usually pointing to the XML schema for the namespace.

The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is not available at design time.

Data Type

String

XChildCount Property (OFXAggregate Component)

The number of records in the XChild arrays.

Syntax

__property int XChildCount = { read=FXChildCount, write=FSetXChildCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• XChildName
• XChildNamespace
• XChildPrefix
• XChildXText

The array indices start at 0 and end at XChildCount - 1.

This property is not available at design time.

Data Type

Integer

XChildName Property (OFXAggregate Component)

The Name property provides the local name (without a prefix) of the element.

Syntax

__property String XChildName[int XChildIndex] = { read=FXChildName };

Default Value

""

Remarks

The XChildName property provides the local name (without a prefix) of the element.

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only and not available at design time.

Data Type

String

XChildNamespace Property (OFXAggregate Component)

This property contains the namespace of the element.

Syntax

__property String XChildNamespace[int XChildIndex] = { read=FXChildNamespace };

Default Value

""

Remarks

This property contains the namespace of the element.

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only and not available at design time.

Data Type

String

XChildPrefix Property (OFXAggregate Component)

This property contains the prefix of the element (if any).

Syntax

__property String XChildPrefix[int XChildIndex] = { read=FXChildPrefix };

Default Value

""

Remarks

This property contains the prefix of the element (if any). If the element does not have a prefix, this property is empty.

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only and not available at design time.

Data Type

String

XChildXText Property (OFXAggregate Component)

This property contains the inner text of the element.

Syntax

__property String XChildXText[int XChildIndex] = { read=FXChildXText };

Default Value

""

Remarks

This property contains the inner text of the element.

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only and not available at design time.

Data Type

String

XElement Property (OFXAggregate Component)

This property includes the name of the current element.

Syntax

__property String XElement = { read=FXElement, write=FSetXElement };

Default Value

""

Remarks

The current element is specified through the XPath property.

Data Type

String

XNamespace Property (OFXAggregate Component)

This property includes the namespace of the current element.

Syntax

__property String XNamespace = { read=FXNamespace, write=FSetXNamespace };

Default Value

""

Remarks

The current element is specified through the XPath property.

Data Type

String

XParent Property (OFXAggregate Component)

This property includes the parent of the current element.

Syntax

__property String XParent = { read=FXParent };

Default Value

""

Remarks

The current element is specified through the XPath property.

This property is read-only.

Data Type

String

XPath Property (OFXAggregate Component)

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

Syntax

__property String XPath = { read=FXPath, write=FSetXPath };

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:

Data Type

String

XPrefix Property (OFXAggregate Component)

This property includes the prefix of the current element.

Syntax

__property String XPrefix = { read=FXPrefix, write=FSetXPrefix };

Default Value

""

Remarks

The current element is specified through the XPath property.

Data Type

String

XText Property (OFXAggregate Component)

This property includes the text of the current element.

Syntax

__property String XText = { read=FXText, write=FSetXText };

Default Value

""

Remarks

The current element is specified through the XPath property.

Data Type

String

Config Method (OFXAggregate Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

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

bool __fastcall HasXPath(String XPath);

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

typedef struct {
  int ErrorCode;
  String Description;
} TiboOFXAggregateErrorEventParams;
typedef void __fastcall (__closure *TiboOFXAggregateErrorEvent)(System::TObject* Sender, TiboOFXAggregateErrorEventParams *e);
__property TiboOFXAggregateErrorEvent OnError = { 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.

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