AddToRecord (XmlDoc subroutine) - Revision history

ELowell: /* Copying from multiple source records */

2014-04-07T21:03:10Z

Copying from multiple source records

← Older revision		Revision as of 21:03, 7 April 2014
Line 124:		Line 124:

	You can also use <var>LoadFromRecord</var> to modify the fieldgroup structure		You can also use <var>LoadFromRecord</var> to modify the fieldgroup structure
	within a record (using ~~V7R2~~ of <var class="product">Model 204</var>).		within a record (using V7R5 of <var class="product">Model 204</var>).
	For example, you could take the “outer” fields of one		For example, you could take the “outer” fields of one
	record and move them to be fieldgroup members in the target		record and move them to be fieldgroup members in the target
Line 173:		Line 173:
	/GRP = 1		/GRP = 1
	</pre>		</pre>

	====Removing update tracking fields from an XmlDoc====		====Removing update tracking fields from an XmlDoc====
	In the simple situation, the record copying operation provided by <var>LoadFromRecord</var>		In the simple situation, the record copying operation provided by <var>LoadFromRecord</var>

ELowell: /* Syntax terms */

2014-04-07T21:02:45Z

Syntax terms

← Older revision		Revision as of 21:02, 7 April 2014
Line 15:		Line 15:
	</td></tr>		</td></tr>
	<tr><th><var>DisableFieldConstraints</var></th>		<tr><th><var>DisableFieldConstraints</var></th>
	<td>This [[Methods#Named parameters\|name required]] argument is a <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var> value. If <var>True</var>, various field constraints (such as LENGTH-EQ, which ~~was introduced in~~ <var class="product">Model 204</var> ~~V7R2~~) are not checked when the fields are added to the record.		<td>This [[Methods#Named parameters\|name required]] argument is a <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var> value. If <var>True</var>, various field constraints (such as LENGTH-EQ, which is generally available as of <var class="product">Model 204</var> V7R5) are not checked when the fields are added to the record.

	The default is <var>False</var>.		The default is <var>False</var>.

Dme: /* Usage notes */

2012-08-12T17:42:44Z

Usage notes

← Older revision		Revision as of 17:42, 12 August 2012
Line 37:		Line 37:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
			<li>The <var>XmlDoc</var> structure used by <var>AddToRecord</var> is also created by the <var>[[NewFromRecord (XmlDoc function)\|NewFromRecord]]</var> and <var>[[ToXmlDoc (Record function)\|ToXmlDoc]]</var> functions.

	<li>Fields in the <var>XmlDoc</var> that are defined as CAT or CTO are ignored by <var>AddToRecord</var>.		<li>Fields in the <var>XmlDoc</var> that are defined as CAT or CTO are ignored by <var>AddToRecord</var>.

Dme: /* Syntax terms */

2012-08-01T02:02:32Z

Syntax terms

← Older revision		Revision as of 02:02, 1 August 2012
Line 30:		Line 30:
	<td>This name required argument is a <var>Boolean</var> value. If <var>True</var>, then: <ul> <li>If a field in the <var>XmlDoc</var> is not defined in the current file, the field is ignored. <li>If a fieldgroup in the <var>XmlDoc</var> is not defined in the current file, the fieldgroup, and all descendants of the fieldgroup element, are ignored. </ul>		<td>This name required argument is a <var>Boolean</var> value. If <var>True</var>, then: <ul> <li>If a field in the <var>XmlDoc</var> is not defined in the current file, the field is ignored. <li>If a fieldgroup in the <var>XmlDoc</var> is not defined in the current file, the fieldgroup, and all descendants of the fieldgroup element, are ignored. </ul>

	If <var>False</var>, any field or fieldgroup in the <var>XmlDoc</var> that is not defined in the current file throws an <var>[[#AddToRecordError ~~exception~~ class\|AddToRecordError]]</var> exception.		If <var>False</var>, any field or fieldgroup in the <var>XmlDoc</var> that is not defined in the current file throws an <var>[[AddToRecordError class\|AddToRecordError]]</var> exception.

	The default is <var>False</var>.		The default is <var>False</var>.

JAL2: /* Structure of XmlDoc for AddToRecord */

2012-04-10T20:49:49Z

Structure of XmlDoc for AddToRecord

← Older revision		Revision as of 20:49, 10 April 2012
Line 285:		Line 285:
	</th><td>If present, this attribute contains the name of the codepage whose base translation tables are used for converting the Unicode field names and field values (if not base 64 encoded) in the <var>XmlDoc</var> to EBCDIC.		</th><td>If present, this attribute contains the name of the codepage whose base translation tables are used for converting the Unicode field names and field values (if not base 64 encoded) in the <var>XmlDoc</var> to EBCDIC.
	</td></tr>		</td></tr>
	<tr><th>maxGroupID attribute of Record element		<tr><th nowrap>maxGroupID attribute of Record element
	</th><td>If present, this attribute contains the value of the maximum fieldgroup ID to be set (if greater than or equal to all of the fieldgroup IDs stored in the record) in the added record, if the <code>CopyIDs=True</code> argument is provided. This must be a non-negative integer value.		</th><td>If present, this attribute contains the value of the maximum fieldgroup ID to be set (if greater than or equal to all of the fieldgroup IDs stored in the record) in the added record, if the <code>CopyIDs=True</code> argument is provided. This must be a non-negative integer value.
	</td></tr>		</td></tr>

JAL2 at 20:12, 10 April 2012

2012-04-10T20:12:05Z

← Older revision		Revision as of 20:12, 10 April 2012
Line 2:		Line 2:
	This subroutine adds to the current record the fields and/or fieldgroups		This subroutine adds to the current record the fields and/or fieldgroups
	that are contained in the method <var>XmlDoc</var> object according to the structure		that are contained in the method <var>XmlDoc</var> object according to the structure
	created by the <var>[[#LoadFromRecord ~~subroutine in~~ XmlDoc ~~and~~ XmlNode ~~classes~~\|LoadFromRecord]]</var> subroutine.		created by the <var>[[LoadFromRecord (XmlDoc/XmlNode subroutine)\|LoadFromRecord]]</var> subroutine.
	<var>AddToRecord</var> must be contained within a “record loop” (for example, an <var>FRN</var>		<var>AddToRecord</var> must be contained within a “record loop” (for example, an <var>FRN</var>
	block), and must not be contained in a fieldgroup context.		block), and must not be contained in a fieldgroup context.

JAL2: /* Syntax terms */

2011-08-15T20:49:36Z

Syntax terms

← Older revision		Revision as of 20:49, 15 August 2011
Line 9:		Line 9:
	{{Template:XmlDoc:AddToRecord syntax}}		{{Template:XmlDoc:AddToRecord syntax}}

	==Syntax terms==		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>doc</th>		<tr><th>doc</th>

JAL2: moved AddToRecord (XmlDoc subroutine ) to AddToRecord (XmlDoc subroutine): typo

2011-06-02T20:57:44Z

moved AddToRecord (XmlDoc subroutine ) to AddToRecord (XmlDoc subroutine): typo

← Older revision	Revision as of 20:57, 2 June 2011
(No difference)

JAL2 at 20:55, 2 June 2011

2011-06-02T20:55:07Z

← Older revision		Revision as of 20:55, 2 June 2011
Line 12:		Line 12:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>doc</th>		<tr><th>doc</th>
	<td>The method object is an <var>XmlDoc</var> whose structure conforms to that created by the <var>LoadFromRecord</var> subroutine~~; see~~ [[#Structure of XmlDoc for AddToRecord\|"Structure of XmlDoc for AddToRecord"]].		<td>The method object is an <var>XmlDoc</var> whose structure conforms to that created by the <var>LoadFromRecord</var> subroutine. [[#Structure of XmlDoc for AddToRecord\|"Structure of XmlDoc for AddToRecord"]] describes the structure in detail.
	</td></tr>		</td></tr>
	<tr><th><var>DisableFieldConstraints</var></th>		<tr><th><var>DisableFieldConstraints</var></th>
	<td>This [[Methods#Named parameters\|name required]] argument is a <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var> value~~; if~~ <var>True</var>, ~~then~~ various field constraints (such as LENGTH-EQ, which was introduced in <var class="product">Model 204</var> V7R2) are not checked when the fields are added to the record.		<td>This [[Methods#Named parameters\|name required]] argument is a <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var> value. If <var>True</var>, various field constraints (such as LENGTH-EQ, which was introduced in <var class="product">Model 204</var> V7R2) are not checked when the fields are added to the record.

	The default is <var>False</var>.		The default is <var>False</var>.
	</td></tr>		</td></tr>
	<tr><th><var>CopyIDs</var></th>		<tr><th><var>CopyIDs</var></th>
	<td>This name required argument is a <var>Boolean</var> value~~; if~~ <var>True</var>, ~~then~~ the fieldgroup IDs are copied, if possible, from the <var>XmlDoc</var> (stored as the "groupID" attribute of "fieldgroup" elements) to the record, and the "maxGroupID" attribute value of the "Record" element is also used as the maximum fieldgroup ID in the record, if possible.		<td>This name required argument is a <var>Boolean</var> value. If <var>True</var>, the fieldgroup IDs are copied, if possible, from the <var>XmlDoc</var> (stored as the "groupID" attribute of "fieldgroup" elements) to the record, and the "maxGroupID" attribute value of the "Record" element is also used as the maximum fieldgroup ID in the record, if possible.
	On any given "fieldgroup" element, a "groupID" attribute may be 0, or missing, or not greater than the current maximum fieldgroup ID; in any of these cases, a new fieldgroup ID is generated for the fieldgroup occurrence.		On any given "fieldgroup" element, a "groupID" attribute may be 0, or missing, or not greater than the current maximum fieldgroup ID; in any of these cases, a new fieldgroup ID is generated for the fieldgroup occurrence.

Line 30:		Line 30:
	<td>This name required argument is a <var>Boolean</var> value. If <var>True</var>, then: <ul> <li>If a field in the <var>XmlDoc</var> is not defined in the current file, the field is ignored. <li>If a fieldgroup in the <var>XmlDoc</var> is not defined in the current file, the fieldgroup, and all descendants of the fieldgroup element, are ignored. </ul>		<td>This name required argument is a <var>Boolean</var> value. If <var>True</var>, then: <ul> <li>If a field in the <var>XmlDoc</var> is not defined in the current file, the field is ignored. <li>If a fieldgroup in the <var>XmlDoc</var> is not defined in the current file, the fieldgroup, and all descendants of the fieldgroup element, are ignored. </ul>

	If <var>False</var>, any field or fieldgroup in the <var>XmlDoc</var> that is not defined in the current file throws an <var>AddToRecordError</var> exception.		If <var>False</var>, any field or fieldgroup in the <var>XmlDoc</var> that is not defined in the current file throws an <var>[[#AddToRecordError exception class\|AddToRecordError]]</var> exception.

	The default is <var>False</var>.		The default is <var>False</var>.
Line 37:		Line 37:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	~~<li>The <var>AddToRecord</var>~~
	~~subroutine can throw an <var>[[#AddToRecordError exception class\|AddToRecordError]]</var> exception.~~

	<li>Fields in the <var>XmlDoc</var> that are defined as CAT or CTO are ignored by <var>AddToRecord</var>.		<li>Fields in the <var>XmlDoc</var> that are defined as CAT or CTO are ignored by <var>AddToRecord</var>.

Line 227:		Line 224:
	You can also create an <var>XmlDoc</var> to be used for <var>AddToRecord</var>; the rules for		You can also create an <var>XmlDoc</var> to be used for <var>AddToRecord</var>; the rules for
	the <var>XmlDoc</var> are described here.		the <var>XmlDoc</var> are described here.

	The outline of the <var>XmlDoc</var> is:		The outline of the <var>XmlDoc</var> is:
	<p class="code"><nowiki><Record [version="1"] [codepage="--codepage name--"]		<p class="code"><nowiki><Record [version="1"] [codepage="--codepage name--"]
Line 247:		Line 245:
	</nowiki></p>		</nowiki></p>


	The requirements for the <var>XmlDoc</var> are:		The requirements for the <var>XmlDoc</var> are:
	<table>		<table>

JAL2 at 20:42, 2 June 2011

2011-06-02T20:42:11Z

Show changes