4
Siebel Methods

This chapter describes how the Oracle Application Server Integration Adapter for Siebel 2000 uses Siebel methods to communicate with Business Objects in a Siebel system.

This chapter discusses the following topic:

Siebel Business Component Record Sets

Siebel Business Component methods operate on lists of Business Component records, or record sets. The Query method returns a record set, while Insert and Update operate on an input record set.

The record set itself is mapped by Oracle Application Server ProcessConnect to an array. This array will contain elements of a record type corresponding to the Siebel Business Component.

Querying a Siebel Business Component

You can submit a Query to the Siebel Business Component to retrieve a set of records that satisfy a search criteria. Query interaction takes a searchExpression parameter and an optional sortExpression parameter. For example, you may want to retrieve all Account records that match a certain pattern for the Name, such as "[Name] like \""A*"\" to retrieve all account records whose Name field begins with the letter A. You can also specify an optional sort expression that tells how you want the results sorted. It is a simple, comma-delimited list of fields, such as: "Name, Location" to sort first by Name and then by Location. By default, the records are sorted in ascending order.

The Oracle Application Server Integration Adapter for Siebel 2000 also supports querying for records based a specific view mode. By using QueryWithViewMode method, you can specify a Siebel view mode as one of the parameters. View Modes are one of the security features provided by Siebel. Siebel 6.2.1 has support of 4 levels of views for Business Objects.

0 - Sales Rep
1 - Manager
2 - Personal
3 - All

The number of records returned by QueryWithViewMode method for a Business Component, depends on the specified view mode level. This method enables the user to retrieve the records based on different view modes. For this reason it is recommended to expose QueryWithViewMode method to only authorized users. If view mode is not provided, Oracle Application Server ProcessConnect does not set a default view mode. In this case, Siebel System calculates view mode based on some internal rules. Similarly for the Query method that does not have the view mode parameter, no default view mode is set on the Business Objects.

Inserting Siebel Business Component Records

You can insert new records for a Siebel Business Component using Insert interaction. Insert interaction expects an array of records to be inserted as input and returns an array of the record IDs for the newly inserted records. Each record is a complex type with a set of fields that are defined on the Siebel Business Component. Most fields are optional for Siebel Business Component Records. Exactly which fields are required and which fields serve as keys for the Business Component Records can be investigated using your Siebel system documentation.

Updating Siebel Business Component Records

You can update the existing records of a Siebel Business Component using Update interaction. The Update interaction takes an array containing the records you wish to update. For each record that you want to update, you must specify the record ID for the field 'Id' and set the fields you desire to update. If you do not know the record ID, you can call a Query Interaction to retrieve the record and extract the record ID from the retuned record.

Deleting Siebel Business Component Records

You can delete the existing records of a Siebel Business Component using Delete interaction. The Delete interaction takes an array containing the record IDs of the records to be deleted. If you do not know the record ID, you can call a Query Interaction to retrieve the record and extract the record ID from the retuned record.

4 Siebel Methods