1. Application Services Interface Reference
  2. Data Synchronization Input Method Arguments for ASIs

Data Synchronization Input Method Arguments for ASIs

The following table describes the arguments of the various methods. For more information about the input arguments, see Integration Platform Technologies: Siebel Enterprise Application Integration.

Argument Display Name Type DataType Description

Interface Integration Object

None

Input/Output

Integration Object

  • The integration object or set of integration objects that is either passed to or returned to the method.

  • The name of the method argument can be anything, but you should use SiebelMessage if the ASI is to be used in a workflow process with other EAI services.

  • The integration object attribute must specify the name of the interface integration object.

LastPage

Last Page

Output

Boolean

Indicates whether the last record has been returned by the QueryById method.

PageSize

Page Size

Input

Number

The default is 10. This argument indicates the number of records to be returned for the QueryPage method.

PrimaryRowID

Object ID

Input

String

The ID that corresponds to the Siebel business component row ID for the primary integration component. This argument is only applicable to the QueryById method.

StartRowNum

Starting Row Number

Input

Number

The default is 0. The row number to start retrieving records for the QueryPage method.

RowID

IntegrationId

UserKey

None

Output

Status key

See the Using Status Keys section of this topic for more information about this output argument.

ViewMode

None

Input

String

Specifies the visibility mode applied to the parent integration object. Applicable only to the QueryPage method.

Using Status Keys

A status key is an integration component key of the type Status key. Status keys are similar to unique keys (see Unique Keys in Integration Objects), and need to be defined for the output arguments. It is recommended that each component contain a set of these three unique keys:

  • Row ID. The Siebel Row ID.

  • Integration ID. A cross-reference that links the Siebel application to the corresponding record in the external application.

  • User Key. Corresponds to the U1 index of the underlying table.

For more information about status keys, see Integration Platform Technologies: Siebel Enterprise Application Integration.

Handling Error Messages

If a method cannot find the integration object as specified by the method arguments, a SiebelMessage returns containing an empty list of integration objects.

However, if an error occurs during the execution of a method:

  • The Business Service returns an error.

  • A SOAP message is returned if the method is invoked as a Web service. See Handling Errors for ASIs for more information about Web services error messages.