Integration Platform Technologies: Siebel eBusiness Application Integration Volume II > EAI Siebel Adapter >

EAI Siebel Adapter Methods

The EAI Siebel Adapter uses DoInvokeMethod in order to provide an interface that performs the following methods:

The implementation of DoInvokeMethod creates CSSEAIMessageIn and CSSEAIMessageOut objects by parsing the input property sets and invokes Execute, which does the right thing depending on the method. If an output is generated, it is stored into the CSSEAIMessageOut object.

class CSSEAISiebelAdapter : public CSSService

{

public:

BOOL CanInvokeMethod(LPCSTR methodName);

ErrCode DoInvokeMethod(LPCSTR methodName,

const CSSPropertySetEx& inArgs,

CSSPropertySetEx& outArgs);

protected:

ErrCode Execute(CSSEAIMessageIn* pObjInst,

CSSEAIMessageOut*& pOutObjInst);

};

EAI Siebel Adapter 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 in Table 8.

Table 8.  EAI Siebel Adapter Method Arguments
Argument
Query
QueryPage
Sync
Upsert
Update
Insert
Delete
Execute
IntObjectName
-
-
-
-
-
'
''
Input
NumOutputObjects
Output
Output
Output
Output
Output
Output
Output
Output
OutputIntObjectName
Input
Input
-
-
-
-
-
Input
PrimaryRowId
Input
-
Output
Output
Output
Output
Input
Input/Output
QueryByUserKey
Input
-
-
-
-
-
-
Input
DeleteByUserKey
-
-
-
-
-
-
Input
Input
ErrorOnNonExistingDelete
-
-
-
-
-
-
Input
Input
SiebelMessage
Input/Output
Input/Output
Input/Output
Input/Output
Input/Output
Input/Output
Input/Output
Input/Output
SearchSpec
Input
Input
-
-
-
-
Input
Input
StatusObject
-
-
Input
Input
Input
Input
Input
Input
MessageId
Input
Input
Input
Input
Input
Input
Input
Input
BusObjCacheSize
Input
Input
Input
Input
Input
Input
Input
Input
LastPage
-
Output
-
-
-
-
-
Output
NewQuery
-
Input
-
-
-
-
-
Input
PageSize
-
Input
-
-
-
-
-
Input
StartRowNum
-
Input
-
-
-
-
-
Input
ViewMode
Input
Input
Input
Input
Input
Input
Input
Input
SortSpec
-
Input
-
-
-
-
-
Input

Table 9 presents each argument of EAI Siebel Adapter methods.

Table 9.  EAI Siebel Adapter Method Arguments
Argument
Display Name
Description
IntObjectName
Integration Object Name
The name of the integration object that is to be deleted.
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.
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 only use the user keys to perform query.
DeleteByUserKey
Delete By User Key
A Boolean argument. Forces the EAI Siebel Adapter to only use the user keys to identify a record.
ErrorOnNonExistingDelete
Error On Non Existing Delete
A Boolean argument. Determines whether or not the EAI Siebel Adapter should abort the operation if no match is found.
SiebelMessage
Siebel Message
The input or the output integration object instance.
SearchSpec
Search Specification
This argument allows you to specify complex search specifications as free text in a single method argument. See Search Specification for details.
StatusObject
Status Object
This argument tells EAI Siebel Adapter whether or not to return a status message.
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 process instance ID, then you can use this argument to specify the ID.
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.
LastPage
Last Page
Boolean indicating whether or not the last record in the query result set has been returned.
NewQuery
New Query
Default is False. Boolean indicating whether a new query should be executed. If set to True, a new query is executed flushing the cache for that particular integration object.
PageSize
Page Size
Default is 10. Indicates the maximum number of integration object instances to be returned.
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.
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.
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 Siebel Tools Reference.


 Integration Platform Technologies: Siebel eBusiness Application Integration Volume II 
 Published: 18 July 2003