pagesize

Integer that tells the EAI Siebel Adapter business service how many records to return. If you query for all the Siebel contacts whose last name starts with the letter A and you do not want to get too many records (for performance reasons), then you can restrict the number of records returned. You restrict the number of records returned by setting the pagesize parameter to a reasonable number. All records that match the search criteria are returned.

For example, pagesize=20 returns only twenty contact records, even if more exist in the Siebel database. If fewer records exist that match that search criteria, then all records are returned (but no more than twenty).

NOTE:  It is recommended that you retrieve the lowest number of records required for any one call. The more records that are returned, the larger the message and the slower the response.

startrow

Used when there is a need to start returning records at a specific row. For example, startrow=100 starts at row 100 of the record set. The first number in a record set is zero, therefore, this request starts at record 99 (given you start counting from one for the first record).

This parameter is useful for paging through a record set N records at a time. For example, if there are 100 records in a record set, but you want to retrieve only ten at a time, then enter startrow=0 and pagesize=10 on the first call, then startrow=10 on the next call, then startrow=21 on the next call, and so on.

viewmode

Maps to the different Siebel view modes. This parameter restricts record access similarly to how views are restricted in Siebel Business Applications. These restrictions include:

• SalesRep
• Manager
• Personal
• All
• Organization
• SubOrgainziation
• Group
• Catalog

searchexpr

Specifies search criteria. The syntax is similar to the syntax used in Siebel Workflow.

For example, to search the Account integration component for accounts whose names begin with the letter A, construct a search expression searchexpr=[Account.Name] LIKE 'A*' using the following syntax: [Integration Component Name.Integration Component Field] LIKE 'SomeValue'. You can also search for more than one criterion searchexpr=[Account.Name] LIKE 'A*' AND [Account.Location] = 'Downtown' uses two integration component fields (Name and Location).

sortexpr

Specifies how to sort the records and is equivalent to use with business components. The syntax is sortexpr=Integration Component Field, Another Integration Component Field, and so on.

For example, the expression: sortexprt=Last Name (DESCENDING), First Name sorts first by the Last Name with the alphabetically last one first, then by the First Name field in ascending order.

updatemode

Tells the EAI Siebel Adapter the type of operation to execute. The options are:

• sync. This mode supports update and insert. Records that do not match the incoming record are deleted. For example, consider an instance of one parent and three children in the Siebel database. If a sync call is made where the message matches only two of the three records in the Siebel database, then the sync operation deletes the third, unmatched child record from the database.
• upsert. This mode supports update and insert and is similar to sync, however, records are not deleted.
• update. This mode supports update. Records that do not match the incoming record are deleted.
• insert. This mode supports insert. Records that do not match the incoming record are deleted.
• mixed. This mode supports delete, update, and insert. You determine the actual operation from the operation element in the message body.

For more information about EAI Siebel Adapter operations, see Integration Platform Technologies: Siebel Enterprise Application Integration.

TIP:   The updatemode parameter is specific to Siebel RESTful Services.