XML Elements Used When Modifying Records

This is a partial list of XML elements pertinent to the activity of modifying textbase records. You can find a complete description of the XML interface to WebPublisher PRO in the Inmagic Web Products Schema Documentation. To access the schema documentation, go to the Product Documentation section of the Inmagic Customer Extranet at http://support.inmagic.com/downloads/extranet.html.

For item 1 below, the first level of bullets contains values for the AC element, and the second level describes attributes that you can add to the AC element when that value is present. Default values for the attributes are underlined, where appropriate.

Example of use: <AC validation="update" trim="Y">INSERT</AC>

1. AC is the action. Action values used to modify records are listed below.
    
• UPDATE - modify an existing record; use MatchFields to list names of field(s) that will identify record to modify. Optional attributes:
   
• validation - specifies what to do in the case of a validation violation:
   
• override - accept the record, but do not update the validation list.
   
• update - accept the record and update the validation list.
   
• none - reject the record.
   
• trim - specifies whether leading spaces should be removed: Y or N
   
• matchFound - specifies what action to take if matching record is found:
   
• rejectRecord - reject the record.
   
• appendFields - add the new text to the end of the existing field value.
   
• replaceRecord - replace the existing record with the fields included in the XML document; fields absent or empty will not be in the resulting record.
   
• deleteRecord - delete the matching record.
   
• replaceFields - replace the field values in the textbase with the field values in the form; only fields included in the XML document sent to WebPublisher PRO will be replaced.
   
• matchNotFound - specifies what action to take if matching record is not found:
   
• rejectRecord - reject any incoming records that do not match an existing record.
   
• acceptRecord - add new record.
   
• ignoreEmptyFields - used with matchFound="replaceFields", specifies whether empty fields should be ignored during an update (if ignored, they will not cause deletion of existing fields, otherwise they will): Y or N
   
• INSERT - add a new record. Optional attributes:
   
• validation - specifies what to do in the case of a validation violation:
   
• override - accept the record, but do not update the validation list.
   
• update - accept the record and update the validation list.
   
• none - reject the record.
   
• trim - specifies whether leading spaces should be removed: Y or N.
   
• DELETE - delete a record from the textbase.
   
• BATCH_MODIFY - modify all of the records found by the query specified in the QY element. Optional attributes:
   
• batchModAction - specifies what kind of batch modification to perform:
   
• insertEntry - insert a new entry before the entry specified in the batchModEntry attribute.
   
• appendEntry - append a new entry after the entry specified in the batchModEntry attribute.
   
• substEntry - replace an existing entry specified in the batchModEntry attribute with a new value.
   
• deleteEntry - delete the entry specified in the batchModEntry attribute.
   
• substText - replace specific text in the entry specified in the batchModEntry attribute.
   
• batchModEntry - specifies which entry or entries to modify:
   
• firstEntry - first entry in the field.
   
• lastEntry - last entry in the field.
   
• matching - entry matching value in the OE element.
   
• all - all entries.
   
• matchCase - used with batchModAction="substText" only; specifies whether to do a case-sensitive compare: Y or N.
   
• matchWholeWord - used with batchModAction="substText" only; specifies whether to match whole word(s): Y or N.
   
• BATCH_DELETE - delete the records found by the query specified in the QY element.
   
2. TN - textbase name.
    
3. OE - old entry, used with batchModEntry="matching".
    
4. EN - new entry.
    
5. QY - query command, used with BATCH_DELETE and BATCH_MODIFY to identify set of records to be processed.
    
6. KeyFields - parent of KeyField elements.
    
7. KeyField - 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.
    
8. FN - can be used in place of KeyFields for BATCH_MODIFY.
    
9. ID - password to be used when opening the textbase.
    
10. MatchFields - parent of the MatchField elements.
     
11. MatchField - name of a field on which records are matched.