break


Datafile Software

break


There are a number of different versions of this, used in different types of XML input and output templates. They are needed in order to switch the focus of the XML processor either between master and detail file, or between types of record (ledger transactions).

break="fff" — This is used in a Datafile template for input XML files (such as a purchase order responses) that are to be matched against existing master/detail file application records. fff is the mnemonic used for the header and detail files, such as "POH” or "POD”.

The first use is to mark the element that represents the start of the detail record in the schema. For a purchase order response, for example, the attribute would be:

break="POD"

It has a second use here to resolve any cases where the input element that carries the master file prime index code is defined within trailer elements following the details, not in header elements. It is used to mark the element in which the prime index code — the purchase order number, for example — is to be found. (This data might in fact be found in a child element of the one marked.) The attribute would then be:

break="POH"

break="DFD" — This is used in a Datafile template for complex input XML files that are to create or add to a single database, as when importing sales orders. It marks the point in the XML template at which a new record (in this example, a new order line) is to be created in the database when this element is met in the XML file. Note that earlier element "header” data already processed is copied into each record too. Associated attributes are "save” and "restore”, which manage the header elements.

break="PLT/x[/start|end]" — This is a special case of the break attribute required when importing purchase ledger transactions direct into the purchase ledger (a similar version may be required if sales transactions ever need to be imported).

It is assumed that the incoming XML file is structured on a hierarchical header/detail basis. Since the ledgers work on a transactional basis, the "break” attribute here is used to distinguish between items that are copied to the type 1/3 records and those that are copied to the type 9 record — "x” above represents the transaction type.

Where the header items precede the details in the hierarchy, then break="PLT/x", where x equals "1” for invoices, and "3” for credit notes, is all that is required at the header level, followed by break="PLT/9" for the element that starts the analysis records. However, where reference data required for the type 1/3/4 record is contained in a trailer section as well as in a header section, the attributes break="PLT/x/start" and break="PLT/x/end" must be used to group the necessary reference items together. This can be the case where such information follows after the analysis-level data in the XML file.

Note that items specified for the header level are also copied to analysis records.
Custom Fields

Article ID: 1821
Created On: Mon, Jul 9, 2012 at 3:47 PM
Last Updated On: Thu, Jun 22, 2023 at 4:55 PM

Online URL: https://kb.datafile.co.uk/article/break-1821.html