Skipnode Operation

Similar to all other Execute operations, the children nodes inherit the semantics of the operation from the parent nodes. If a node has the skipnode operation set, then the EAI Siebel Adapter will skip setting field values for all children unless a child has an explicit operation set that will override.

<?xml version="1.0" encoding="UTF-8"?>
<?Siebel-Property-Set EscapeNames="false"?>
<SiebelMessage MessageId="1-2RE" MessageType="Integration Object" 
IntObjectName="EAI Account"  IntObjectFormat="Siebel Hierarchical">
 	 <ListOfAccount>
	<Account operation="skipnode">
		<Name>foo</Name>
			<Location>cold storage</Location>
			<ListOfContact>
  				<Contact operation="upsert">
			<IntegrationId>1-123</IntegrationId>
    				<FirstName>firstname</FirstName>
    				<LastName>contact1</LastName>
  			<ListOfContact_Organization>
   				 <Contact_Organization>
      			<Organization operation="insert">MyOrganization</Organization>
      			</Contact_Organization>
			</ListOfContact_Organization>
  				</Contact>
  			<Contact operation="upsert">
		<IntegrationId>2-123</IntegrationId>
  				<FirstName>firstname</FirstName>
  				<LastName>contact2</LastName>
  				</Contact>
			</ListOfContact>
		</Account>
  	</ListOfAccount>
</SiebelMessage>

Based on this example, the account is skipped. However, the EAI Siebel Adapter will attempt to insert the two contacts.

EAI Siebel Adapter Business Service Method Arguments

Each of the EAI Siebel Adapter methods takes arguments that allow you to specify required and optional information to the adapter. You can locate the arguments for each method (and whether it can be used as an input argument, output argument, or both) in the following table.

Argument Query Query Page Sync Upsert Update Insert Delete Execute

BusObjCacheSize

Input

Input

Input

Input

Input

Input

Input

Input

DeleteByUserKey

not applicable

not applicable

not applicable

not applicable

not applicable

not applicable

Input

Input

ErrorOnNonExisting Delete

not applicable

not applicable

not applicable

not applicable

not applicable

not applicable

Input

Input

ExecutionMode

Input

Input

not applicable

Input

Input

Input

not applicable

Input

IntObjectName

not applicable

not applicable

not applicable

not applicable

not applicable

not applicable

Input

Input

LastPage

not applicable

Output

not applicable

not applicable

not applicable

not applicable

not applicable

Output

MessageId

Input

Input

Input

Input

Input

Input

Input

Input

NewQuery

not applicable

Input

not applicable

not applicable

not applicable

not applicable

not applicable

Input

NumOutputObjects

Output

Output

Output

Output

Output

Output

Output

Output

OutputIntObject Name

Input

Input

not applicable

not applicable

not applicable

not applicable

not applicable

Input

PageSize

not applicable

Input

not applicable

not applicable

not applicable

not applicable

not applicable

Input

PrimaryRowId

Input

not applicable

Output

Output

Output

Output

Input

Input/Output

QueryByUserKey

Input

not applicable

not applicable

not applicable

not applicable

not applicable

not applicable

Input

SearchSpec

Input

Input

not applicable

not applicable

not applicable

not applicable

Input

Input

SiebelMessage

Input/Output

Output

Input/Output

Input/Output

Input/Output

Input/Output

Input/Output

Input/Output

SortSpec

not applicable

Input

not applicable

not applicable

not applicable

not applicable

not applicable

Input

StartRowNum

not applicable

Input

not applicable

not applicable

not applicable

not applicable

not applicable

Input

StatusObject

not applicable

not applicable

Input

Input

Input

Input

Input

Input

ViewMode

Input

Input

Input

Input

Input

Input

Input

Input

The following table presents each argument of the EAI Siebel Adapter business service methods.

Argument Display Name Description

BusObjCacheSize

Business Object Cache Size

Default is 5. Maximum number of Business Objects instances cached by the current instance of the EAI Siebel Adapter. If set to zero, then the EAI Siebel Adapter does not use the cache.

DeleteByUserKey

Delete By User Key

A Boolean argument. Forces the EAI Siebel Adapter to use only the user keys to identify a record.

ErrorOnNonExisting Delete

Error On Non Existing Delete

A Boolean argument. Determines whether or not the EAI Siebel Adapter aborts the operation if no match is found.

ExecutionMode

Execution Mode

Used to set the direction of a query on a business component. Valid values are ForwardOnly and Bidirectional. The default is Bidirectional.

ForwardOnly is more efficient than Bidirectional, and is recommended in cases where you must process a large number of records in the forward direction only (such as for report generation). For operations that are likely to return more than 10000 records, use ForwardOnly to avoid errors.

For more information on executing queries, see the topic on the ExecuteQuery business component method in Siebel Object Interfaces Reference.

IntObjectName

Integration Object Name

Name of the integration object to delete.

LastPage

Last Page

Boolean indicating whether or not the last record in the query result set has been returned.

MessageId

Message Id

The MessageId can be used to specify the ID for the generated message. By default, the EAI Siebel Adapter generates a unique ID for each message. However, if you want to use the workflow instance ID, then you can use this argument to specify the ID.

NewQuery

New Query

Default is False. Boolean indicating whether a new query will be executed. If set to True, a new query is executed flushing the cache for that particular integration object.

NumOutputObjects

Number of Output Integration Objects

Number of output integration objects.

OutputIntObjectName

Output Integration Object Name

The name of the integration object that is to be output.

PageSize

Page Size

Default is 10. Indicates the maximum number of integration object instances to be returned.

PrimaryRowId

Object Id

The PrimaryRowId refers to the Id field in the Business Component, Row_Id at the table level.

PrimaryRowId is only returned as an output argument if you are passing in one integration object instance. If you are passing multiple integration object instances, then this argument is not returned as an output argument. To obtain the ID field when multiple integration objects are processed, use the StatusObject argument.

QueryByUserKey

Query By Key

A Boolean argument. Forces the EAI Siebel Adapter to use only the user keys to perform a query.

SearchSpec

Search Specification

This argument allows you to specify complex search specifications as free text in a single method argument. For information, see About Using Language-Independent Code with the EAI Siebel Adapter Business Service.

SiebelMessage

Siebel Message

The input or the output integration object instance.

SortSpec

Sort Specification

Default is the SortSpec of the underlying business component. This argument allows you to specify complex sort criteria as a free text in a single method argument, using any business component fields and standard Siebel sort syntax. For examples, see Using Siebel Tools.

StartRowNum

Starting Row Number

Default is 0 (first page). Indicates the row in the result set for the QueryPage method to start retrieving a page of records.

StatusObject

Status Object

This argument tells the EAI Siebel Adapter whether or not to return a status message.

ViewMode

View Mode

Default is All. Visibility mode to be applied to the Business Object. Valid values are: Manager, Sales Rep, Personal, Organization, Sub-Organization, Group, Catalog, and All. Note that the ViewMode user property on the integration object has priority over the ViewMode method argument.