Inmagic Logo Web Products Schema Documentation for Inmagic CS/WebPublisher PRO 1.3

schema location:  InputSchema13.xsd
 
Elements 
Query 


element Query
diagram
children AC TN BU CS DF DL DT EF EL EN ES FN GI IB IC ID IR IX MF MQ MR NP OEX OF QY RF RL RN SP SE SN ST TI TR TX XC XE XM XP XS KeyFields MatchFields Recordset SortFields
attributes
Name  Type  Use  Default  Fixed  Annotation
detail  xs:string  optional      
documentation 
Specifies detail attribute value: qy (default), full, or off.
SOAPFormat  xs:string  optional      
documentation 
Specifies SOAPFormat attribute value: Y (Content Server default) or N (DB/Text WebPublisher PRO default).
SOAPFieldNameFormat  xs:string  optional      
documentation 
Specifies SOAPFieldNameFormat attribute value: Y (Content Server default) or N (DB/Text WebPublisher PRO default).
annotation
documentation 
Root element.

element Query/AC
diagram
type extension of xs:string
attributes
Name  Type  Use  Default  Fixed  Annotation
validation  xs:string  optional      
documentation 
Specifies validation attribute value: update, override, or none (default).
trim  xs:string  optional      
documentation 
Specifies trim attribute value: Y or N (default).
matchFound  xs:string  optional      
documentation 
Specifies what action to take if matching record is found: rejectRecord, appendFields, replaceRecord, deleteRecord, or replaceFields (default).
matchNotFound  xs:string  optional      
documentation 
Specifies what action to take if matching record is not found: rejectRecord or acceptRecord (default).
ignoreEmptyFields  xs:string  optional      
documentation 
Specifies whether empty fields should be ignored during an update: Y or N (default).
annotation
documentation 
Specifies the action the program will take.

element Query/TN
diagram
type xs:string
annotation
documentation 
Specifies textbase name.

element Query/BU
diagram
type xs:anyURI
annotation
documentation 
Specifies the base URL. Points to page used to generate search.

element Query/CS
diagram
type xs:boolean
annotation
documentation 
Specifies whether report/display pages use CSS.

element Query/DF
diagram
type restriction of xs:string
facets
minLength 0
maxLength 20
annotation
documentation 
Specifies the expanded display form name.

element Query/DL
diagram
type xs:boolean
annotation
documentation 
Specifies whether to show the form drop-down list on the expanded display page.

element Query/DT
diagram
type restriction of xs:string
facets
minLength 0
maxLength 50
annotation
documentation 
Specifies the document type used in the content setting for HTTP header information passed to browser.

element Query/EF
diagram
type restriction of xs:string
facets
minLength 0
maxLength 20
annotation
documentation 
Specifies the edit form name.

element Query/EL
diagram
type xs:boolean
annotation
documentation 
Specifies whether to show the form drop-down list on the edit page.

element Query/EN
diagram
type restriction of xs:string
facets
minLength 0
maxLength 250
annotation
documentation 
For index retrieval via XML, specifies term or word to use as starting point of index list to be returned.

element Query/ES
diagram
type xs:boolean
annotation
documentation 
Specifies whether to open the expanded display form in a new browser window.

element Query/FN
diagram
type xs:string
annotation
documentation 
For index retrieval via XML, specifies the field to be returned in the response. May also be used as alternative to KeyFields. For <AC>QUERY<AC>, use <FN>/</FN> to get a count of the records that match a search; no records will be returned.

element Query/GI
diagram
type xs:string
annotation
documentation 
Permits use of multiple textbases with the same name but different paths.

element Query/IB
diagram
type xs:integer
annotation
documentation 
Maintains report navigation information. For Inmagic software internal use only.

element Query/IC
diagram
type xs:nonNegativeInteger
annotation
documentation 
Specifies the maximum number of index entries or validation list entries returned when using XML output. If set to 0 (default), all entries will be returned.

element Query/ID
diagram
type restriction of xs:string
facets
minLength 0
maxLength 15
annotation
documentation 
Specifies the password you want to use.

element Query/IR
diagram
type xs:integer
annotation
documentation 
Maintains record display/edit navigation information. For Inmagic software internal use only.

element Query/IX
diagram
type xs:boolean
annotation
documentation 
For index retrieval via XML, specifies whether the Terms List (1) or Words List (0) is returned.

element Query/MF
diagram
type xs:string
annotation
documentation 
Specifies the message file name for message translation.

element Query/MQ
diagram
type restriction of xs:string
facets
minLength 0
maxLength 20
annotation
documentation 
Specifies name of query screen from which to read search textbase information for multiple textbase query.

element Query/MR
diagram
type restriction of xs:integer
facets
minInclusive 0
annotation
documentation 
Specifies the maximum number of records displayed per page.

element Query/NP
diagram
type restriction of xs:integer
facets
minInclusive 0
maxInclusive 2
annotation
documentation 
Specifies location of navigational controls (for example, form drop-down lists, Next/Previous buttons).

element Query/OEX
diagram
type extension of xs:string
annotation
documentation 
Specifies XML output encoding (default is ISO-8859-1).

element Query/OF
diagram
type restriction of xs:integer
facets
minInclusive 0
maxInclusive 255
annotation
documentation 
For index retrieval via XML, specifies term or word offset to use as starting point of index list to be returned.

element Query/QY
diagram
type extension of xs:string
annotation
documentation 
Specifies query criteria (field name) for search.

element Query/RF
diagram
type restriction of xs:string
facets
minLength 0
maxLength 20
annotation
documentation 
Specifies the report form name.

element Query/RL
diagram
type xs:boolean
annotation
documentation 
Specifies whether to show the form drop-down list on the report page.

element Query/RN
diagram
type xs:integer
annotation
documentation 
Specifies record number in the current set.

element Query/SP
diagram
type xs:integer
annotation
documentation 
Specifies the record set page to return from the specified search.

element Query/SE
diagram
type xs:integer
annotation
documentation 
Specifies entry in the current set.

element Query/SN
diagram
type restriction of xs:string
facets
minLength 0
maxLength 20
annotation
documentation 
Specifies textbase set name for menu screen queries.

element Query/ST
diagram
type xs:integer
annotation
documentation 
Maintains edit record navigation information. For Inmagic software internal use only.

element Query/TI
diagram
type xs:integer
annotation
documentation 
Textbase index. Used with Multiple Textbase Query (MQ). Specifies which textbase the record comes from.

element Query/TR
diagram
type xs:nonNegativeInteger
annotation
documentation 
Specifies the maximum number of records that will be returned when using HTML output.

element Query/TX
diagram
type xs:nonNegativeInteger
annotation
documentation 
Specifies the maximum number of records displayed when using XML output. Default is 1000. If set to 0, all records will be returned.

element Query/XC
diagram
type xs:string
annotation
documentation 
Specifies the name of the CGI program to use.

element Query/XE
diagram
type restriction of xs:integer
facets
minInclusive 0
maxInclusive 2
annotation
documentation 
Specifies how XML errors are returned if an XSL file is specified.

element Query/XM
diagram
type xs:boolean
annotation
documentation 
Specifies whether to return XML output.

element Query/XP
diagram
type restriction of xs:string
facets
minLength 0
maxLength 50
annotation
documentation 
Specifies the "expires" setting for the HTTP header information passed to the browser.

element Query/XS
diagram
type xs:string
annotation
documentation 
Specifies which XSL file to use to transform XML output.

element Query/KeyFields
diagram
children KeyField
annotation
documentation 
The parent of the KeyField elements.

element Query/KeyFields/KeyField
diagram
type xs:string
annotation
documentation 
Specifies a field to be returned in the XML response.

element Query/MatchFields
diagram
children MatchField
annotation
documentation 
The parent of the MatchField elements.

element Query/MatchFields/MatchField
diagram
type xs:string
annotation
documentation 
Specifies the name of the field on which records are matched.

element Query/Recordset
diagram
children Record
annotation
documentation 
The parent of the Record elements.

element Query/Recordset/Record
diagram
type restriction of xs:anyType
attributes
Name  Type  Use  Default  Fixed  Annotation
annotation
documentation 
Retrievable unit of information in a textbase.

element Query/SortFields
diagram
children SortField
attributes
Name  Type  Use  Default  Fixed  Annotation
sort  xs:string  optional      
documentation 
Specifies sort method to use: specify, relevance, unsorted, or textbase (default).
annotation
documentation 
The parent of the SortField elements. Specifies the type of sort the program will use to sort.

element Query/SortFields/SortField
diagram
type extension of xs:string
attributes
Name  Type  Use  Default  Fixed  Annotation
type  xs:string  optional      
documentation 
Specifies the SortField type: sort (default) or alternate.
reverse  xs:string  optional      
documentation 
Specifies whether SortField is sorted in reverse: Y or N (default).
annotation
documentation 
Specifies the fields the program will use to sort.


XML Schema documentation generated with
XMLSPY Schema Editor http://www.altova.com/xmlspy