Siebel Connector for PeopleSoft > Database Adapter > Methods and Arguments >

Data Type

The three types of databases that are used with the Connector support different sets of data types. These differences are indicated in Table 4.

Table 4. Databases and Data Types
Database
Supported Data Types
IBM DB2
varchar, char, bigint, integer, smallint, decimal, real, timestamp, data, and time
Microsoft SQL Server
varchar, char, bigint, int, smallint, tinyint, bit, decimal, numeric, money, smallmoney, float, real, and datetime
Oracle
varchar2, char, number, and date

Query

The Database Adapter uses the Query method to query data from an external database based on an SQL integration object and returns the corresponding integration object instances.

Query takes a QBE (Query By Example) instance as input and returns one or more output objects. If the component field values are set in the input, the values will be used in the where clause of the generated SQL. A blank search specification at the root level will query for all the rows from the table corresponding to the root component.

Parent-child relationships are determined by foreign key definitions in the integration object. The Adapter expects the foreign key of a child component to refer to a target key in the parent component. For more information about target keys, see Background on Database Adapter Integration Objects in the Database Wizard chapter.

Arguments

Query arguments are summarized in Table 5.

Table 5. Query Arguments
Parameter Name
Display Name
Optional
Type
Data Type
Comment
NumOutputObjects
Number of Output Integration Objects
No
Output
Number
Number of output integration objects.
ExtDBODBCDataSource
External DB Data Source
Yes
Input
String
 
ExtDBPassword
External DB Password
Yes
Input
String
 
ExtDBTableOwner
External DB TableOwner
Yes
Input
String
 
ExtDBUserName
External DB UserName
Yes
Input
String
 
SiebelMessage
Siebel Message
No
Input/Output
Hierarchy
Input/Output property set should have a Siebel Message as its child.

Delete

The Delete method is used to delete a hierarchy on the external database that is based upon an integration object. Delete takes a QBE instance as input and deletes the entire hierarchy rooted at the specified root component instance. The search specification is only allowed at the root level. If no search specification is provided, Delete removes all rows from the table corresponding to the root component. The CascadeDelete property is specified in the integration object definition at each component level. If this property is set, that component is also deleted when its parent is deleted. Here too, parent-child relationships are determined by the foreign key definition in each component.

Arguments

The arguments for the Delete method are defined in Table 6.

Table 6. Delete Argument
Parameter Name
Display Name
Optional
Type
Data Type
Description
ExtDBODBCDataSource
External DB Data Source
Yes
Input
String
 
ExtDBPassword
External DB Password
Yes
Input
String
 
ExtDBTableOwner
External DB Table Owner
Yes
Input
String
 
ExtDBUserName
External DB UserName
Yes
Input
String
 
SiebelMessage
Siebel Message
No
Input
Hierarchy
Child property set

Upsert

The Upsert method is used to insert or update data into the external database based on the input integration object instances. Upsert performs an UPDATE or an INSERT at each component level, depending upon whether the row already exists in the database. The input to the upsert method is the actual integration object instance data.

The Database Adapter uses a combination of two algorithms to upsert data, depending upon the ratio of the number of database rows to the number of component instances in the input instance. This optimization is turned on by default. If the number of database rows is small, it is efficient to query for all rows (of a given parent) and try to match them in memory. If there are a large number of database rows, it is more efficient to query the database for each input component instance, to determine whether the corresponding rowset exists in the database.

Upsert supports multiple user key specification to find the matching row in the database. Each user key is tied in sequence to determine whether the rowset exists in the database. If none of the specified user key fields have their values set, an error is returned. A null value for any of the user key fields is valid.

Arguments

The arguments for the Upsert method are defined in Table 7.

Table 7. Upsert Arguments
Parameter Name
Display Name
Optional
Type
Data Type
Description
ExtDBODBCDataSource
External DB Data Source
Yes
Input
String
 
ExtDBPassword
External DB Password
Yes
Input
String
 
ExtDBTableOwner
External DB Table Owner
Yes
Input
String
 
ExtDBUserName
External DB UserName
Yes
Input
String
 
SiebelMessage
Siebel Message
No
Input
Hierarchy
Child property set

Synchronize

Synchronize makes the values of an external database match the values of an integration object instance by performing an Update, Insert, or Delete on the external tables. The Synchronize method is similar to Upsert except that deletes are performed on database rows where corresponding component instances are not present in the input integration objects.

Arguments

The arguments for the Synchronize method are defined in Table 8.

Table 8. Synchronize Arguments
Parameter Name
Display Name
Optional
Type
Data Type
Description
ExtDBODBCDataSource
External DB Data Source
Yes
Input
String
 
ExtDBPassword
External DB Password
Yes
Input
String
 
ExtDBTableOwner
External DB Table Owner
Yes
Input
String
 
ExtDBUserName
External DB UserName
Yes
Input
String
 
SiebelMessage
Siebel Message
No
Input
Hierarchy
Input/output property set should have a Siebel Message as its child

Execute

The Database Adapter Execute method is used to perform the operations listed below on an integration object. Any operation can be specified at the component level by using the Op Code.

When Execute performs a Delete or Synchronize on a component, all operations below that component are invalid and are ignored.

Arguments

The arguments for the Execute method are described in Table 9.

Table 9. Execute Arguments
Parameter Name
Display Name
Optional
Type
Data Type
Description
ExtDBODBCDataSource
External DB Data Source
Yes
Input
String
 
ExtDBPassword
External DB Password
Yes
Input
String
 
ExtDBTableOwner
External DB Table Owner
Yes
Input
String
 
ExtDBUserName
External DB UserName
Yes
Input
String
 
SiebelMessage
Siebel Message
No
Input
Hierarchy
Input/output property set should have a Siebel Message as its child

Op Codes

Operation codes indicate the type of operation to be performed on an integration component. These codes are specified in the component instance; otherwise, they are inherited from the parent's component instance. Processing an integration component, the Database Adapter detects the operation code and performs the action indicated by the code. For example, when the upsert code is detected, the Database Adapter performs an UPSERT operation, starting at that component level in the hierarchy.

Operation codes are used with the Execute method to specify the operation at the component level.


 Siebel Connector for PeopleSoft 
 Published: 18 April 2003