Web Products Schema Documentation for Inmagic CS/WebPublisher PRO v9.00

attribute form default:	unqualified
element form default:	qualified

element Query

attributes

Name   Annotation detail   documentation  Specifies detail attribute value: qy (default), full, or off. SOAPFormat   documentation  Specifies whether field names will be modified for better compliance with SOAP when returned as element names: Y (CS/WebPublisher PRO default) or N (DB/Text WebPublisher PRO default). "Y" will cause spaces and hyphens in field names to be represented as underbars. "N" will cause spaces in field names to be represented as hyphens. SOAPFieldNameFormat   documentation  Equivalent to SOAPFormat attribute; maintained for backwards compatibility.

annotation

documentation  Root element.

element Query/AC

facets	enumeration  QBE_QUERY enumeration  QUERY enumeration  MENU_QUERY enumeration  NEXT_RECORD enumeration  NEXT_BLOCK enumeration  PREV_RECORD enumeration  PREV_BLOCK enumeration  GET_RECORD enumeration  REFRESH_PAGE enumeration  CHANGE_DISPLAY enumeration  SEE_ALSO enumeration  TB_SEARCH enumeration  WP_DIAGNOSE enumeration  TB_SCHEMA_QUERY enumeration  RF_SCHEMA_QUERY enumeration  SCHEMA_INPUT enumeration  TB_SCHEMA_OUTPUT enumeration  APPLET_KEYS_BY_STG enumeration  APPLET_KEYS_BY_NUM enumeration  APPLET_SCROLL_KEYS enumeration  APPLET_KEYS_GREATEST enumeration  APPLET_STRINGS enumeration  INDEX_BY_KEY enumeration  INDEX_KEY_GREATEST enumeration  TB_FIELD_INFO enumeration  VALIDATION_LISTS enumeration  VALIDATION_LISTS_THES enumeration  TERM_INDEX enumeration  WORD_INDEX enumeration  DELETE_RECORD enumeration  DUPLICATE_RECORD enumeration  EDIT_RECORD enumeration  NEW_RECORD enumeration  INSERT enumeration  UPDATE enumeration  DELETE enumeration  BATCH_DELETE enumeration  BATCH_MODIFY
attributes	Name   Annotation validation   documentation  Used with AC= INSERT/UPDATE/BATCH_MODIFY, specifies what to do in the case of a validation violation: update (only pertains to list validation), override, or none (default), where "none" means that the record will be rejected. trim   documentation  Used with AC=INSERT/UPDATE, specifies whether leading spaces should be removed: Y or N (default). matchFound   documentation  Used with AC=UPDATE, specifies what action to take if matching record is found: rejectRecord, appendFields, replaceRecord, deleteRecord, or replaceFields (default). matchNotFound   documentation  Used with AC=UPDATE, specifies what action to take if matching record is not found: rejectRecord or acceptRecord (default). ignoreEmptyFields   documentation  Used with AC=UPDATE, specifies whether empty fields should be ignored during an update: Y or N (default). If empty fields are not ignored, they will cause the existing data in that field to be deleted. batchModAction   documentation  Used with AC=BATCH_MODIFY, specifies action to perform: appendEntry, insertEntry, deleteEntry, substEntry (default), or substText. batchModEntry   documentation  Used with AC=BATCH_MODIFY, specifies field entry to be modified: first, last, all, or matching. Default is "first", unless used with "substText", which requires "matching". matchCase   documentation  Used with AC=BATCH_MODIFY, specifies whether to do a case-sensitive compare for field content to be changed: Y or N (default). matchWholeWord   documentation  Used with AC=BATCH_MODIFY, specifies whether to match whole word(s) when looking for information to change: Y or N (default).
annotation	documentation  Specifies the action the program will take.

element Query/TN

type	xs:string
annotation	documentation  Specifies textbase name.

element Query/BU

type	xs:anyURI
annotation	documentation  Specifies the base URL. Points to page used to generate search.

element Query/CS

type	xs:boolean
annotation	documentation  Specifies whether report/display pages use CSS.

element Query/DF

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

element Query/DL

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

element Query/DT

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

type	restriction of xs:string
facets	minLength  0 maxLength  20
annotation	documentation  Specifies the edit form name.

element Query/EL

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

element Query/EN

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. For batch modify, specifies new entry.

element Query/OE

type	restriction of xs:string
facets	minLength  0 maxLength  250
annotation	documentation  Used with AC=BATCH_MODIFY and batchModEntry="matching", specifies the text or entry on which to match.

element Query/ES

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

element Query/FN

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

type	xs:string
annotation	documentation  Specifies a prefix for the textbase name, to permit use of multiple textbases with the same name but different paths.

element Query/IC

type	xs:nonNegativeInteger
annotation	documentation  Used with AC=TERM_INDEX, WORD_INDEX, VALIDATION_LISTS, or VALIDATION_LISTS_THES, specifies the maximum number of entries returned. If set to 0 (default), all entries will be returned.

element Query/ID

type	restriction of xs:string
facets	minLength  0 maxLength  15
annotation	documentation  Specifies the password to use when opening the textbase.

element Query/IR

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

element Query/IX

type	restriction of xs:integer
facets	minInclusive  0 maxInclusive  3
annotation	documentation  For index retrieval via XML, specifies whether the Words list (0) or Terms list (1) is returned. For validation list retrieval via XML, specifies standard validation list (2), or thesaurus used for validation (4).

element Query/MF

type	xs:string
annotation	documentation  Specifies the message file name for message translation.

element Query/MQ

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

element Query/MR

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

element Query/NP

type	restriction of xs:integer
facets	minInclusive  0 maxInclusive  4
annotation	documentation  Used with HTML output (XM=0), specifies location of navigational controls (for example, form drop-down lists, Next/Previous buttons): 1 (top), 2 (bottom), 3 (both), 4 (neither).

element Query/OEX

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

element Query/QY

type	extension of xs:string
annotation	documentation  Specifies query criteria (command-query style, example: "find name=smith").

element Query/RF

type	restriction of xs:string
facets	minLength  0 maxLength  20
annotation	documentation  Specifies the report form name.

element Query/RL

type	xs:boolean
annotation	documentation  Used for HTML output (XM=0), specifies whether to show the form drop-down list on the report page.

element Query/RN

type	xs:integer
annotation	documentation  Specifies offset of the record in the current set.

element Query/SP

type	xs:integer
annotation	documentation  Specifies the record set page to return from the specified search.

element Query/SE

type	xs:integer
annotation	documentation  Specifies offset of the current set in the .WPO file.

element Query/SN

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

element Query/ST

type	xs:integer
annotation	documentation  Maintains edit record navigation information. For Inmagic software internal use only.

element Query/TI

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

element Query/TR

type	xs:nonNegativeInteger
annotation	documentation  Used with HTML output (XM=0), specifies the maximum number of records that will be returned.

element Query/TX

type	xs:nonNegativeInteger
annotation	documentation  Used with XML output (XM=1), specifies the maximum number of records that will be returned. Default is 1000. If set to 0, all records will be returned.

element Query/XC

type	xs:string
annotation	documentation  Specifies the name of the CGI program to use.

element Query/XE

type	restriction of xs:integer
facets	minInclusive  0 maxInclusive  3
annotation	documentation  Used with XML output (XM=1) when a transform is specified (XS), specifies how XML errors are returned: 0 (force HTML), 1 (force XML), 2 (transform and return HTML), 3 (transform and return XML).

element Query/XM

type	xs:boolean
annotation	documentation  Specifies whether to return XML output.

element Query/XP

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

type	xs:string
annotation	documentation  Used with XML output (XM=1), specifies the XSL file to use to transform the output.

element Query/KeyFields

annotation

documentation  The parent of the KeyField elements.

element Query/KeyFields/KeyField

type	xs:string
annotation	documentation  Used with XML output (XM=1), specifies a field to be returned. To specify a secondary textbase field to be returned from a query, use this syntax: SecondaryFieldName.PrimaryLinkFieldName.

element Query/MatchFields

annotation

documentation  The parent of the MatchField elements.

element Query/MatchFields/MatchField

type	xs:string
annotation	documentation  Specifies the name of the field on which records are matched.

element Query/Recordset

annotation

documentation  The parent of the Record elements.

element Query/Recordset/Record

type	restriction of xs:anyType
annotation	documentation  The parent of the field elements. Textbase field names, modified if needed to conform to XML element-name syntax, are used for the element names. One such element is returned for each entry in a repeating field.

element Query/SortFields

attributes	Name   Annotation sort   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

type	extension of xs:string
attributes	Name   Annotation type   documentation  Specifies the SortField type: sort (default) or alternate. reverse   documentation  Specifies whether SortField is sorted in reverse: Y or N (default).
annotation	documentation  Specifies a field the program will use to sort, when the SortFields type attribute is set to "specify". Up to five SortField elements can be included, in descending order of importance. To specify a secondary textbase field, use this syntax: SecondaryFieldName.PrimaryLinkFieldName.

XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy