Bookshelf v7.7: FINS CAP Buscomp Data Loader Business Service

This business service can be used to load data from a Siebel business component into a Siebel property set. Additionally, once this data is loaded into a property set, it can be cached and shared across all login sessions.

About LoadData Method

Use the LoadData method to load Buscomp data into a property set. The property set follows the vector format. Table 18 describes the input and output parameters for this method.

NOTE: The Search Spec, Sort Spec, Hierarchical Key, Key Field, Value Field, and Aggregate field arguments can be defaulted by defining these as user properties on the source business component. The BC user property should be pre-fixed with FINS Data Loader to identify these fields.

For example, the default search spec can be defined as the Buscomp user property: FINS Data Loader Search Spec.

Table 18. LoadData Method Parameters
Parameter Name	Direction	Description
BusComp	Input	The name of a Siebel BC.
IsCachedData	Input	If true, the resulting vector is cached within the OM. Further requests to load data from the same business component are handled through the cache. Cached data is retrieved based on the business component name. If a second retrieval request uses different search spec, fields, format, and so on, the original cached data should be released first.
Search Spec	Input	The search spec applied to the business component when loading data. Since the FINS CAP Data Loader Service works outside the context of a business object, the search spec should include the appropriate user key fields.
Hierarchical Key [n]	Input	Hierarchical keys are used to define the hierarchy within the vector. These keys identify the unique key at each level. Multiple hierarchical keys can be specified by defining [n] = 1, 2, 3 ... n Refer to the ProductRate vector illustrated under Defining Properties for a Business Rule Process. In the ProductRate vector, Region and Product fields represent the hierarchical keys.
Sort Spec	Input	The sort specification applied to the business component when loading data. It is important to match the Sort Spec and the hierarchical keys when creating the vector. When a business component is accessed through the FINS CAP Buscomp Data Loader Service, sorting will control the shape of the parent/child tree structure. Records are processed sequentially and are aware of only the last parent node key. When children nodes are added to a parent node, they continue to be added until a new value is retrieved for the hierarchical key. When a new key value is discovered a new parent node is immediate created, and children assembled under that parent, and this process continues until all records are collected. If a key equal to a previously processed node is retrieved after a different node key has been processed, a new node is produced rather than adding to the original.
Field [n]	Input	The name of Buscomp fields whose values are retrieved as the leaf propertyset properties. The property name is the field name, and the property value is the field value. [n]=1,2,... This represents one approach to how Buscomp fields can be retrieved. See Example of LoadData Method Using Field [n].
Key Field & Value Field	Input	Used to retrieve data as Key/value pair and store as a property in the leaf propertyset. The field value of the Key Field is the name of the property and the value of Value Field is stored as the value of the property. This is an alternative approach to Field [n] to retrieve data. See Example of LoadData Method Using Key Field and Value Field. Duplicate Key/Value pairs are not allowed. If duplicates are found when the vector is created, the new entry replaces the old entry.
Aggregate Field[n]	Input	Fields that will be aggregated if duplicates occur. Multiple aggregate fields can be specified by defining [n] = 1, 2, 3 ... n This parameter is particularly useful with the Key Field/Value Field data retrieval approach. For example, a contact can have multiple income records with different types. If Aggregate Field is defined, the data loader service automatically sums the income and stores this as a single income key/value pair.
Vector	Output	The resultant vector output.

Example of LoadData Method Using Field [n]

Golden Gate Bank defines its product rates in the Buscomp Financial Product. The fields in the Buscomp and some sample data are:


Region	Product	Balance	Rate
West	Checking	10000	0.2
West	Saving	29000	2.1
West	N Market	87560	2.5
East	Checking	40000	0.24

To retrieve the data and store it in a format as defined by the ProductRate Vector sample diagram shown in Table 16, use the following arguments for LoadData method:

The data is stored into a vector named productRateVector. Then, the rate of the Checking product in the East region can be retrieved as:

Example of LoadData Method Using Key Field and Value Field

Golden Gate Bank decides to implement its product rates using a different schema. Instead of one record for one product as shown in Example of LoadData Method Using Field [n], they would like to store the data using name-value pairs for each product. The advantage of this approach is that new attributes can be easily added without schema changes. The data is stored in Financial Product Attribute buscomp in the following manner:


Region	Product	Attribute Name	Attribute Value
West	Checking	Balance	10000
West	Checking	Rate	0.2
West	Saving	Balance	29000
East	Saving	Rate	2.1

To retrieve the data and store it in a format as defined by the ProductRate Vector sample diagram shown in Table 16, use the following arguments for LoadData method:

About ClearCache Method

Use this method to explicitly clear all the cached data held by the data loader business service. This method has no input/output arguments.