Displaying Janus SOAP XML document objects - Revision history

Ekern at 15:27, 21 April 2023

2023-04-21T15:27:54Z

← Older revision		Revision as of 15:27, 21 April 2023
Line 62:		Line 62:

	<span class="f_Para">If you are watching </span><span class="term">%l</span><span class="f_Para">, which is not an object variable, you find that its value is shown as a Unicode binary string when the </span><span class="term">%l = %d:x:serial</span><span class="f_Para"> statement is executed. </span>		<span class="f_Para">If you are watching </span><span class="term">%l</span><span class="f_Para">, which is not an object variable, you find that its value is shown as a Unicode binary string when the </span><span class="term">%l = %d:x:serial</span><span class="f_Para"> statement is executed. </span>

	[[File:xmldocwatch2_zoom65.gif\|368x227px\|xmldocwatch2]]		[[File:xmldocwatch2_zoom65.gif\|368x227px\|xmldocwatch2]]

Ekern at 15:27, 21 April 2023

2023-04-21T15:27:38Z

← Older revision		Revision as of 15:27, 21 April 2023
Line 69:		Line 69:
	# <span class="f_ListNum1">Click the </span><var>Value</var><span class="f_ListNum1"> button. </span>		# <span class="f_ListNum1">Click the </span><var>Value</var><span class="f_ListNum1"> button. </span>
	:: You see the serialized form of the XmlDoc in the </span><var>Value </var><span class="f_ListContinue">window.</span>		:: You see the serialized form of the XmlDoc in the </span><var>Value </var><span class="f_ListContinue">window.</span>

	[[File:valuewindowb3_zoom65.gif\|463x333px\|valueWindowB3]]		[[File:valuewindowb3_zoom65.gif\|463x333px\|valueWindowB3]]

Ekern at 15:27, 21 April 2023

2023-04-21T15:27:15Z

Ekern at 17:58, 4 April 2023

2023-04-04T17:58:59Z

← Older revision		Revision as of 17:58, 4 April 2023
Line 30:		Line 30:
	<p class="syntax"><a>		<p class="syntax"><a>
	Hello		Hello
	<b>moe</b>		<nowiki><b>moe</b></nowiki>
	<c>larry</c>		<c>larry</c>
	</a></p>		</a></p>

Ekern at 17:58, 4 April 2023

2023-04-04T17:58:13Z

← Older revision		Revision as of 17:58, 4 April 2023
Line 30:		Line 30:
	<p class="syntax"><a>		<p class="syntax"><a>
	Hello		Hello
	<b>moe</>		<b>moe</b>
	<c>larry</c>		<c>larry</c>
	</a></p>		</a></p>

Ekern at 17:57, 4 April 2023

2023-04-04T17:57:46Z

← Older revision		Revision as of 17:57, 4 April 2023
Line 5:		Line 5:

	<span class="f_Para">[[Displaying temporarily the value of a program data item\|Requesting]] the value of </span><span class="f_CodeExample">%x</span><span class="f_Para"> merely reports </span>''whether''<span class="f_Para"> the object has content: </span>		<span class="f_Para">[[Displaying temporarily the value of a program data item\|Requesting]] the value of </span><span class="f_CodeExample">%x</span><span class="f_Para"> merely reports </span>''whether''<span class="f_Para"> the object has content: </span>
			<p class="syntax">Not null XmlDoc</p>
	[[File:xmldocb2_zoom55.gif\|495x401px\|xmldocB2]]<span class="f_CodeExample"> </span><span class="f_Para"> </span>		<!-- [[File:xmldocb2_zoom55.gif\|495x401px\|xmldocB2]]<span class="f_CodeExample"> </span><span class="f_Para"> </span> -->

	<span class="f_Para">If the program in the preceding example contained a subsequent assignment statement to a string variable like the following, you could display the XmlDoc content by watching for or requesting the value of </span><span class="term">%longstring</span><span class="f_Para">: </span>		<span class="f_Para">If the program in the preceding example contained a subsequent assignment statement to a string variable like the following, you could display the XmlDoc content by watching for or requesting the value of </span><span class="term">%longstring</span><span class="f_Para">: </span>
Line 28:		Line 28:

	<span class="f_Para">For the example code above, if you specify </span><span class="term">%x:serial</span><span class="f_Para"> in the Entity name input</span><span class="f_ListBul1"> box</span><span class="f_Para"> and click the </span><var>Value</var><span class="f_Para"> button (at any point after the execution of the </span><span class="term">%x:loadxml</span><span class="f_Para"> statement cited at the beginning of this section), the following </span><var>Value </var><span class="f_Para">window displays: </span>		<span class="f_Para">For the example code above, if you specify </span><span class="term">%x:serial</span><span class="f_Para"> in the Entity name input</span><span class="f_ListBul1"> box</span><span class="f_Para"> and click the </span><var>Value</var><span class="f_Para"> button (at any point after the execution of the </span><span class="term">%x:loadxml</span><span class="f_Para"> statement cited at the beginning of this section), the following </span><var>Value </var><span class="f_Para">window displays: </span>
			<p class="syntax"><a>
	[[File:valuewindow4_zoom65.gif\|463x265px\|valueWindow4]]<span class="f_Para"> </span>		Hello
			<b>moe</>
			<c>larry</c>
			</a></p>
			<!-- [[File:valuewindow4_zoom65.gif\|463x265px\|valueWindow4]]<span class="f_Para"> </span> -->

	<span class="f_Para">The Serialize feature formats the return value of the Serial call as if you specified the following form of the method (which calls for a single string with EBCDIC characters, carriage return/line feed character sequences, and 3 space indentation of nested elements):</span>		<span class="f_Para">The Serialize feature formats the return value of the Serial call as if you specified the following form of the method (which calls for a single string with EBCDIC characters, carriage return/line feed character sequences, and 3 space indentation of nested elements):</span>
Line 57:		Line 61:
	<span class="f_CodeExample"> ...</span></p>		<span class="f_CodeExample"> ...</span></p>

	<span class="f_Para">If you are watching </span><span class="term">%l</span><span class="f_Para">, which is not an object variable, you find that its value is shown as a Unicode binary string when the </span><span class="term">%l = %d:x:serial</span><span class="f_Para"> statement is executed: </span>		<span class="f_Para">If you are watching </span><span class="term">%l</span><span class="f_Para">, which is not an object variable, you find that its value is shown as a Unicode binary string when the </span><span class="term">%l = %d:x:serial</span><span class="f_Para"> statement is executed. </span>
			<!-- [[File:xmldocwatch2_zoom65.gif\|368x227px\|xmldocwatch2]]<span class="f_Para"> </span> -->
	[[File:xmldocwatch2_zoom65.gif\|368x227px\|xmldocwatch2]]<span class="f_Para"> </span>

	<span class="f_Para">However, you can use the Debugger's Serial method feature and </span><span class="f_ListNum1">request a detailed view of the XmlDoc object variable </span><span class="term">x</span><span class="f_Para">: </span>		<span class="f_Para">However, you can use the Debugger's Serial method feature and </span><span class="f_ListNum1">request a detailed view of the XmlDoc object variable </span><span class="term">x</span><span class="f_Para">: </span>
Line 65:		Line 68:
	# <span class="f_ListNum1">Specify </span><span class="term">%d:x:serial</span><span class="f_ListNum1"> in the </span><span class="f_Para">Entity name input</span><span class="f_ListBul1"> box below the main window</span><var>.</var><span class="f_ListNum1"> </span>		# <span class="f_ListNum1">Specify </span><span class="term">%d:x:serial</span><span class="f_ListNum1"> in the </span><span class="f_Para">Entity name input</span><span class="f_ListBul1"> box below the main window</span><var>.</var><span class="f_ListNum1"> </span>
	# <span class="f_ListNum1">Click the </span><var>Value</var><span class="f_ListNum1"> button. </span>		# <span class="f_ListNum1">Click the </span><var>Value</var><span class="f_ListNum1"> button. </span>
	:: You see the serialized form of the XmlDoc in the </span><var>Value </var><span class="f_ListContinue">window:</span>		:: You see the serialized form of the XmlDoc in the </span><var>Value </var><span class="f_ListContinue">window.</span>
			<!-- [[File:valuewindowb3_zoom65.gif\|463x333px\|valueWindowB3]]<span class="f_ListContinue"> </span> -->
	[[File:valuewindowb3_zoom65.gif\|463x333px\|valueWindowB3]]<span class="f_ListContinue"> </span>

	=== Serial method formatting defaults ===		=== Serial method formatting defaults ===

Ekern: Created page with "TOC XML document objects can be used in SOUL applications. Ordinarily, to inspect the contents of an XmlDoc or XmlNode object, it must be serialized b..."

2022-11-02T14:39:12Z

Created page with "__TOC__ XML document objects can be used in SOUL applications. Ordinarily, to inspect the contents of an XmlDoc or XmlNode object, it must be serialized b..."

New page

__TOC__
XML document objects can be used in SOUL applications. Ordinarily, to inspect the contents of an XmlDoc or XmlNode object, it must be serialized by one of the XML serializing methods like Serial, Xml, or Print. In either the Janus Debugger or the TN3270 Debugger, if you are debugging a request in which a line like the following is executed:

%x:loadxml('<a>Hellomoe<c>larry</c></a>')

[[Displaying temporarily the value of a program data item|Requesting]] the value of %x merely reports ''whether'' the object has content: 

[[File:xmldocb2_zoom55.gif|495x401px|xmldocB2]] 

If the program in the preceding example contained a subsequent assignment statement to a string variable like the following, you could display the XmlDoc content by watching for or requesting the value of %longstring: 

%longstring = %x:serial(,'EBCDIC') 

When no such serializing statement is present, the '''Serialize''' feature lets you implicitly call the Janus SOAP XML Serial method to view the contents of an XmlDoc or XmlNode object. 

You can invoke the feature multiple ways for XmlDoc variable %doc: 

* Display the expanded value of %doc:serial in a <var>Value</var> window. 
** Enter %doc:serial in the Entity name input box below the main window<var>.</var> 
** Click the <var>Value</var> button. 
:: ''Or'':
** Add %doc to the <var>Watch Window</var> (by right clicking the<var> Source Code</var> line containing %doc and selecting the <var>Add Watch</var> option, or by entering %doc in the text box above the <var>Watch Window</var> and clicking the <var>Add Watch</var> button).
** right click %doc in the <var>Watch Window</var> and select the <var>Serialize</var> option. 

* Display the value of %doc:serial in the <var>Watch Window:</var> 
** Enter %doc:serial in the Entity name input box<var>.</var> 
** Click the <var>Watch</var> button. 

For the example code above, if you specify %x:serial in the Entity name input box and click the <var>Value</var> button (at any point after the execution of the %x:loadxml statement cited at the beginning of this section), the following <var>Value </var>window displays: 

[[File:valuewindow4_zoom65.gif|463x265px|valueWindow4]] 

The Serialize feature formats the return value of the Serial call as if you specified the following form of the method (which calls for a single string with EBCDIC characters, carriage return/line feed character sequences, and 3 space indentation of nested elements):

Serial(, 'EBCDIC CRLF Indent 3')

The Serial method defaults are UTF-8 instead of EBCDIC, and no added line end or indentation characters. So for user convenience, the Debugger is internally providing its own Serial method defaults (which you can adjust, as described in the [[Displaying Janus SOAP XML document objects|"Serial method formatting defaults"]] subsection). 

=== Debugger Serial method compared to source code Serial methods ===
The Debugger's internal Serial method handling is independent of Serial method calls actually specified in the source code you are debugging. For example, in the following excerpt, the User Language object pointed to by %d (of type document) contains a variable member named x that is an XmlDoc: 

class document 
 public 
 variable x is object XmlDoc 
 constructor new 
 subroutine addStooge(%iFirst is longstring, - 
 %iLast is longstring) 
 end public 
 ...
%d is object document 
%d = new 
%l is longstring
 
%d:addstooge('Moe", 'Howard')
 ...
%l = %d:x:serial
 ...

If you are watching %l, which is not an object variable, you find that its value is shown as a Unicode binary string when the %l = %d:x:serial statement is executed: 

[[File:xmldocwatch2_zoom65.gif|368x227px|xmldocwatch2]] 

However, you can use the Debugger's Serial method feature and request a detailed view of the XmlDoc object variable x: 

# Specify %d:x:serial in the Entity name input box below the main window<var>.</var> 
# Click the <var>Value</var> button. 
:: You see the serialized form of the XmlDoc in the <var>Value </var>window:

[[File:valuewindowb3_zoom65.gif|463x333px|valueWindowB3]] 

=== Serial method formatting defaults ===
The preceding <var>Value</var> window display also shows again the effect of the implicit Debugger Serial parameters CRLF and Indent 3. These formatting defaults (for XmlDoc and XmlNode objects) are specified in the Debugger [[Customize debuggerConfig file|Client configuration file]] (debuggerConfig.xml): 

<serialParms>CRLF INDENT 3</serialParms>

You can change this formatting, for example, to increase the indentation: 

<serialParms>CRLF INDENT 10</serialParms>

To suppress this feature (never have the Debugger add parameters to serial), specify no value:

<serialParms></serialParms>

'''See Also:'''
: [[Watching object variables|Watching object variables]]

[[Category:Debugger Home]]

← Older revision		Revision as of 15:27, 21 April 2023
Line 6:		Line 6:
	<span class="f_Para">[[Displaying temporarily the value of a program data item\|Requesting]] the value of </span><span class="f_CodeExample">%x</span><span class="f_Para"> merely reports </span>''whether''<span class="f_Para"> the object has content: </span>		<span class="f_Para">[[Displaying temporarily the value of a program data item\|Requesting]] the value of </span><span class="f_CodeExample">%x</span><span class="f_Para"> merely reports </span>''whether''<span class="f_Para"> the object has content: </span>
	<p class="syntax">Not null XmlDoc</p>		<p class="syntax">Not null XmlDoc</p>
	~~<!--~~ [[File:xmldocb2_zoom55.gif\|495x401px\|xmldocB2]]~~<span class="f_CodeExample"> </span><span class="f_Para"> </span> -->~~		[[File:xmldocb2_zoom55.gif\|495x401px\|xmldocB2]]

	<span class="f_Para">If the program in the preceding example contained a subsequent assignment statement to a string variable like the following, you could display the XmlDoc content by watching for or requesting the value of </span><span class="term">%longstring</span><span class="f_Para">: </span>		<span class="f_Para">If the program in the preceding example contained a subsequent assignment statement to a string variable like the following, you could display the XmlDoc content by watching for or requesting the value of </span><span class="term">%longstring</span><span class="f_Para">: </span>
Line 33:		Line 33:
	<c>larry</c>		<c>larry</c>
	</a></p>		</a></p>
	~~<!--~~ [[File:valuewindow4_zoom65.gif\|463x265px\|valueWindow4]]~~<span class="f_Para"> </span> -->~~		[[File:valuewindow4_zoom65.gif\|463x265px\|valueWindow4]]

	<span class="f_Para">The Serialize feature formats the return value of the Serial call as if you specified the following form of the method (which calls for a single string with EBCDIC characters, carriage return/line feed character sequences, and 3 space indentation of nested elements):</span>		<span class="f_Para">The Serialize feature formats the return value of the Serial call as if you specified the following form of the method (which calls for a single string with EBCDIC characters, carriage return/line feed character sequences, and 3 space indentation of nested elements):</span>
Line 62:		Line 62:

	<span class="f_Para">If you are watching </span><span class="term">%l</span><span class="f_Para">, which is not an object variable, you find that its value is shown as a Unicode binary string when the </span><span class="term">%l = %d:x:serial</span><span class="f_Para"> statement is executed. </span>		<span class="f_Para">If you are watching </span><span class="term">%l</span><span class="f_Para">, which is not an object variable, you find that its value is shown as a Unicode binary string when the </span><span class="term">%l = %d:x:serial</span><span class="f_Para"> statement is executed. </span>
	~~<!--~~ [[File:xmldocwatch2_zoom65.gif\|368x227px\|xmldocwatch2]]~~<span class="f_Para"> </span> -->~~		[[File:xmldocwatch2_zoom65.gif\|368x227px\|xmldocwatch2]]

	<span class="f_Para">However, you can use the Debugger's Serial method feature and </span><span class="f_ListNum1">request a detailed view of the XmlDoc object variable </span><span class="term">x</span><span class="f_Para">: </span>		<span class="f_Para">However, you can use the Debugger's Serial method feature and </span><span class="f_ListNum1">request a detailed view of the XmlDoc object variable </span><span class="term">x</span><span class="f_Para">: </span>
Line 69:		Line 69:
	# <span class="f_ListNum1">Click the </span><var>Value</var><span class="f_ListNum1"> button. </span>		# <span class="f_ListNum1">Click the </span><var>Value</var><span class="f_ListNum1"> button. </span>
	:: You see the serialized form of the XmlDoc in the </span><var>Value </var><span class="f_ListContinue">window.</span>		:: You see the serialized form of the XmlDoc in the </span><var>Value </var><span class="f_ListContinue">window.</span>
	~~<!--~~ [[File:valuewindowb3_zoom65.gif\|463x333px\|valueWindowB3]]~~<span class="f_ListContinue"> </span> -->~~		[[File:valuewindowb3_zoom65.gif\|463x333px\|valueWindowB3]]

	=== Serial method formatting defaults ===		=== Serial method formatting defaults ===

Displaying Janus SOAP XML document objects - Revision history

Ekern at 15:27, 21 April 2023

Ekern at 15:27, 21 April 2023

Ekern at 15:27, 21 April 2023

Ekern at 17:58, 4 April 2023

Ekern at 17:58, 4 April 2023

Ekern at 17:57, 4 April 2023

Ekern: Created page with "__TOC__ XML document objects can be used in SOUL applications. Ordinarily, to inspect the contents of an XmlDoc or XmlNode object, it must be serialized b..."

Ekern: Created page with "TOC XML document objects can be used in SOUL applications. Ordinarily, to inspect the contents of an XmlDoc or XmlNode object, it must be serialized b..."