On this Page

    _summary

    (Merge only)

    Create data for Summary document.

    Description

    _summary is a pre-defined JavaScript object that can be used to create a data file that is to be merged with your Panes with the Job Section "Summary" as seen in Object Properties:

    Summary Section Pane

    The _summary object is an instance of the XmlFile Class. See the XmlFile Class (Write XML Files) for the description of the functions that are available for use. The physical XML file that backs the _summary object is a temporary file that is created automatically when Merge first starts up. As with all temporary files, it is deleted when the Merge run is complete. During the processing of the form and data you can use the _summary object's methods to emit data into that temporary file.

    It's likely that you will have been putting data into the file using _summary all through the processing, often in End-of-Document event scripts. You have one final chance to add data to the file, once all documents have been processed when the Start-of-Summary event script(s) are run. Once that event cycle is over, Merge will combine the summary data with the form, using only those Panes from the form where the Job Section has been designated as "Summary".

    The summary section output is a new document separate from all the Main Section documents. It will always begin on a new page.

    See Also

    XmlFile Class (Write XML Files)