DTDs for XML Gateway Business Service

This chapter lists the various inbound and outbound Document Type Definitions (DTDs) for the XML Gateway business service. It covers the following topics:

Outbound DTDs for the XML Gateway Business Service

The following sections contain examples of DTDs representing the %methodName% request sent from the XML Gateway to the external application.

Delete

The following DTD is for the Delete request:

<!ELEMENT siebel-xmlext-delete-req  (buscomp, remote-source, row)>
<!ELEMENT buscomp (#PCDATA)>
<!ATTLIST buscomp id NMTOKEN #REQUIRED>
<!ELEMENT remote-source ( #PCDATA )*>
<!ELEMENT row (value+)>
<!ELEMENT value (#PCDATA)*>
<!ATTLIST value field CDATA #REQUIRED>

Init

The following DTD is for the Init request:

<!ELEMENT siebel-xmlext-fields-req (buscomp, remote-source?)>
<!ELEMENT buscomp (#PCDATA)>
<!ATTLIST buscomp id NMTOKEN #REQUIRED >
<!ELEMENT remote-source (#PCDATA)*>

Insert

The following DTD is for the Insert request:

<!ELEMENT siebel-xmlext-insert-req (buscomp, remote-source?, row)>
<!ELEMENT buscomp (#PCDATA)>
<!ATTLIST buscomp id NMTOKEN #REQUIRED>
<!ELEMENT remote-source (#PCDATA)*>
<!ELEMENT row (value+)>
<!ELEMENT value (#PCDATA)*>
<!ATTLIST value field CDATA #REQUIRED>

Pre Insert

The following DTD is for the PreInsert request:

<!ELEMENT siebel-xmlext-preinsert-req (buscomp, remote-source?)>
<!ELEMENT buscomp (#PCDATA)>
<!ATTLIST buscomp id NMTOKEN #REQUIRED >
<!ELEMENT remote-source (#PCDATA)*>

Query

The following DTD is for the Query request:

<!ELEMENT siebel-xmlext-query-req (buscomp , remote-source?, max-rows?, search-
string?, match?, search-spec?, sort-spec? )>
<!ELEMENT buscomp (#PCDATA)>
<!ATTLIST buscomp id NMTOKEN #REQUIRED>
<!ELEMENT remote-source (#PCDATA)*>
<!ELEMENT max-rows (#PCDATA)>
<!ELEMENT search-string (#PCDATA)>
<!ELEMENT match (#PCDATA)>
<!ATTLIST match field CDATA #REQUIRED>
<!ELEMENT search-spec (node)>
<!ELEMENT node (#PCDATA | node)*>
<!ATTLIST node node-type (Constant | Identifier | Unary Operator | Binary Operator) 
#REQUIRED>
<!ATTLIST node value-type (TEXT | NUMBER | DATETIME | UTCDATETIME | DATE | TIME) 
#IMPLIED>
<!ELEMENT sort-spec (sort+)>
<!ELEMENT sort (#PCDATA)>
<!ATTLIST sort field CDATA #REQUIRED>

Update

The following DTD is for the Update request:

<!ELEMENT siebel-xmlext-update-req  (buscomp, remote-source?, row)>
<!ELEMENT buscomp (#PCDATA)>
<!ATTLIST buscomp id NMTOKEN #REQUIRED>
<!ELEMENT remote-source (#PCDATA)*>
<!ELEMENT row (value+)>
<!ELEMENT value (#PCDATA)*>
<!ATTLIST value changed ( true | false ) #REQUIRED>
<!ATTLIST value field CDATA #REQUIRED>

Inbound DTDs for the XML Gateway Business Service

The following sections contain examples of DTDs representing the %methodName% response sent from the external application to the XML Gateway.

Delete Response

The following DTD is for the Delete response:

<!ELEMENT siebel-xmlext-dekete-ret EMPTY >

Init Response

The following DTD is for the Init response:

<!ELEMENT siebel-xmlext-fields-ret (support+)>
<!ELEMENT support EMPTY >
<!ATTLIST support field CDATA #REQUIRED>

Insert Response

The following DTD is for the Insert response:

<!ELEMENT siebel-xmlext-preinsert-ret (row)>
<!ELEMENT row (value+)>
<!ELEMENT value (#PCDATA)*>
<!ATTLIST value field CDATA  #REQUIRED >

Pre Insert Response

The following DTD is for the PreInsert response:

<!ELEMENT siebel-xmlext-preinsert-ret (row)>
<!ELEMENT row (value)*>
<!ELEMENT value (#PCDATA)*>
<!ATTLIST value field CDATA  #REQUIRED >

Query Response

The following DTD is for the Query response:

<!ELEMENT siebel-xmlext-query-ret (row*)>
<!ELEMENT row (value+)>
<!ELEMENT value (#PCDATA)*>
<!ATTLIST value field CDATA #REQUIRED >

Update Response

The following DTD is for the Update response:

<!ELEMENT siebel-xmlext-update-ret (row)>
<!ELEMENT row (value+)>
<!ELEMENT value (#PCDATA)>
<!ATTLIST value field CDATA  #REQUIRED >