Using Xtend with the Debugger: Difference between revisions
No edit summary |
No edit summary |
||
Line 17: | Line 17: | ||
1. <span class="f_ListNum2">Download </span><span class="f_ListNum1">to your workstation two Xtend installation files (one for the Xtend GUI and one for the Model 204 subsystem and web port). </span> | 1. <span class="f_ListNum2">Download </span><span class="f_ListNum1">to your workstation two Xtend installation files (one for the Xtend GUI and one for the Model 204 subsystem and web port). </span> | ||
2. <span class="f_ListNum1">Set up a Model 204 subsystem (XTEND) to control </span><var>Xtend</var><span class="f_ListNum1"> processing. </span> | 2. <span class="f_ListNum1">Set up a Model 204 subsystem (XTEND) to control </span><var>Xtend</var><span class="f_ListNum1"> processing. </span> | ||
:: Notes for doing this are provided in the </span><span class=" | :: Notes for doing this are provided in the </span><span class="term">XtendInstall.HLP</span><span class="f_ListContinue"> file in the XtendInstall folder. See the "Xtend Apsy" section.</span> | ||
3. <span class="f_ListNum1">From the PC, run the </span><var>Xtend</var><span class="f_ListNum1"> installer executable (</span><span class=" | 3. <span class="f_ListNum1">From the PC, run the </span><var>Xtend</var><span class="f_ListNum1"> installer executable (</span><span class="term">XtendInstall.exe</span><span class="f_ListNum1">), which will populate the XTEND subsystem files. </span> | ||
4. <span class="f_ListNum1">In the Online, run the XTEND.JANUS.DEFINE procedure in the XTENDPRC procedure file to start the </span><var>Xtend</var><span class="f_ListNum1"> Janus Web port. </span> | 4. <span class="f_ListNum1">In the Online, run the XTEND.JANUS.DEFINE procedure in the XTENDPRC procedure file to start the </span><var>Xtend</var><span class="f_ListNum1"> Janus Web port. </span> | ||
:: The default port number for the non_SSL port is </span><span class=" | :: The default port number for the non_SSL port is </span><span class="term">7878</span><span class="f_ListContinue">; for the secure port it is </span><span class="term">7879</span><span class="f_ListContinue">. Change these numbers if necessary for your site.</span> | ||
=== Install and configure the Xtend GUI === | === Install and configure the Xtend GUI === | ||
# <span class="f_ListNum2">If you will use </span>< | # <span class="f_ListNum2">If you will use </span><var>Janus Debugger</var><span class="f_ListNum2"> and have configured a proxy server for the Internet Explorer browser, update the proxy settings to provide a </span><span class="f_ListNum1">bypass for connections to the </span><var>Xtend</var><span class="f_ListNum1"> web port. </span> | ||
## <span class="f_ListNum2">From the </span>< | ## <span class="f_ListNum2">From the </span><var">Tools</var><span class="f_ListNum2"> menu, select </span><var">Internet Options</var><span class="f_ListNum2">; then select the </span><var">Connections</var><span class="f_ListNum2"> tab, and click the </span><var">LAN Settings</var><span class="f_ListNum2"> button. </span> | ||
## <span class="f_ListNum2">Locate the </span>< | ## <span class="f_ListNum2">Locate the </span><var">Proxy Server</var><span class="f_ListNum2"> area, and click the </span><var">Advanced</var><span class="f_ListNum2"> button. </span> | ||
## <span class="f_ListNum2">In the </span>< | ## <span class="f_ListNum2">In the </span><var">Exceptions</var><span class="f_ListNum2"> area, in the list box labeled "Do not use proxy server for addresses beginning with," specify the URL of the </span><var>Xtend</var><span class="f_ListNum2"> web server port you [[Using Xtend with the Debugger#Install and configure Xtend in your Online |defined]]. </span> | ||
## <span class="f_ListNum2">Click </span>< | ## <span class="f_ListNum2">Click </span><var">OK</var><span class="f_ListNum2"> as needed to close the multiple dialog boxes.</span> | ||
# <span class="f_ListNum1">Set up a remote connection to </span><var>Model 204</var><span class="f_ListNum1"> from the </span><var>Xtend</var><span class="f_ListNum1"> GUI.</span> | # <span class="f_ListNum1">Set up a remote connection to </span><var>Model 204</var><span class="f_ListNum1"> from the </span><var>Xtend</var><span class="f_ListNum1"> GUI.</span> | ||
## <span class="f_ListNum2">Open the </span><var>Xtend</var><span class="f_ListNum2"> GUI executable file (</span><span class=" | ## <span class="f_ListNum2">Open the </span><var>Xtend</var><span class="f_ListNum2"> GUI executable file (</span><span class="term">Xtend.exe</span><span class="f_ListNum2">), and select </span><var">Options</vavr><span class="f_ListNum2"> from the </span><var">View</var><span class="f_ListNum2"> menu. </span> | ||
## <span class="f_ListNum2">In the </span>< | ## <span class="f_ListNum2">In the </span><var">Options</var><span class="f_ListNum2"> dialog box, select the </span><var">Remote</var><span class="f_ListNum2"> tab. </span> | ||
## <span class="f_ListNum1">In the grid in the main work area, specify a name for this connection and supply a </span><var>Model 204</var><span class="f_ListNum1"> user ID, host name, and the web server port </span><span class="f_ListNum2">you [[Using Xtend with the Debugger#Install and configure Xtend in your Online |defined]]</span><span class="f_ListNum1">, </span><span class="f_ListNum2">and click the </span>< | ## <span class="f_ListNum1">In the grid in the main work area, specify a name for this connection and supply a </span><var>Model 204</var><span class="f_ListNum1"> user ID, host name, and the web server port </span><span class="f_ListNum2">you [[Using Xtend with the Debugger#Install and configure Xtend in your Online |defined]]</span><span class="f_ListNum1">, </span><span class="f_ListNum2">and click the </span><var">Apply</var><span class="f_ListNum2"> button. </span> | ||
## <span class="f_ListNum2">If you will use </span><var>TN3270 Debugger,</var><span class="f_ListNum2"> select the name (Caption) of the remote connection you just defined from the </span><span class=" | ## <span class="f_ListNum2">If you will use </span><var>TN3270 Debugger,</var><span class="f_ListNum2"> select the name (Caption) of the remote connection you just defined from the </span><span class="term">Default edit online when using TN3270 Debugger</span><span class="f_ListNum2"> drop down list, then click the </span><var">OK</var><span class="f_ListNum2"> button. </span> | ||
## <span class="f_ListNum2">Optionally, review and update the settings in the other </span>< | ## <span class="f_ListNum2">Optionally, review and update the settings in the other </span><var">Options</var><span class="f_ListNum2"> tabs. </span> | ||
# <span class="f_ListNum1">Add the names of the procedure files (and their privileges) whose procedures you will be editing with </span><var>Xtend</var><span class="f_ListNum1">. </span> | # <span class="f_ListNum1">Add the names of the procedure files (and their privileges) whose procedures you will be editing with </span><var>Xtend</var><span class="f_ListNum1">. </span> | ||
# <span class="f_ListNum2">Select </span>< | # <span class="f_ListNum2">Select </span><var">Administrator Functions</var><span class="f_ListNum2"> from the </span><var">Admin</var><span class="f_ListNum2"> menu; then select the </span><var">Files</var><span class="f_ListNum2"> tab.</span> | ||
## <span class="f_ListNum2">In the </span>< | ## <span class="f_ListNum2">In the </span><var">File</var><span class="f_ListNum2"> columns, name the procedure files that contain the procedures you want to make accessible from </span><var>Xtend</var><span class="f_ListNum2">; in the </span><var">Privileges</var><span class="f_ListNum2"> column, select a privilege level.</span> | ||
## This information can alternatively be specified in the XTEND subsystem itself. </span> | ## This information can alternatively be specified in the XTEND subsystem itself. </span> | ||
## <span class="f_ListNum2">Click the </span>< | ## <span class="f_ListNum2">Click the </span><var">Save Details</var><span class="f_ListNum2"> button, followed by the </span><var">Close</var><span class="f_ListNum2"> button. </span> | ||
'''Note:'''<span class="f_ListNote"> For procedure files that have explicit passwords, you must either add the file name to the XTEND subsystem files listed in the Subsystem File Use screen in the </span><var>Model 204</var><span class="f_ListNote"> Subsystem Management facility, or you must modify a subroutine in the XTENDPRC procedure file (as described in </span><span class="f_ListContinue">the </span><span class=" | '''Note:'''<span class="f_ListNote"> For procedure files that have explicit passwords, you must either add the file name to the XTEND subsystem files listed in the Subsystem File Use screen in the </span><var>Model 204</var><span class="f_ListNote"> Subsystem Management facility, or you must modify a subroutine in the XTENDPRC procedure file (as described in </span><span class="f_ListContinue">the </span><span class="term">XtendInstall.HLP</span><span class="f_ListContinue"> file</span><span class="f_ListNote">).</span> | ||
# <span class="f_ListNum1">Test your connection.</span> | # <span class="f_ListNum1">Test your connection.</span> | ||
## <span class="f_ListNum2">In the </span>< | ## <span class="f_ListNum2">In the </span><var">Procedure List</var><span class="f_ListNum2"> dialog box, select the tab that is labeled with the name of your remote connection. </span> | ||
<span class="f_ListContinue2">A list of your procedures is retrieved and displayed.</span> | <span class="f_ListContinue2">A list of your procedures is retrieved and displayed.</span> | ||
## <span class="f_ListNum2">Display a test procedure's code (double click the procedure name), make some update, then save the updated procedure by clicking the Save File icon on the toolbar.</span> | ## <span class="f_ListNum2">Display a test procedure's code (double click the procedure name), make some update, then save the updated procedure by clicking the Save File icon on the toolbar.</span> | ||
Line 51: | Line 51: | ||
=== Update the Debugger Client configuration file === | === Update the Debugger Client configuration file === | ||
<span class="f_Para">Once </span><var>Xtend</var><span class="f_Para"> is installed and configured for debugging, you enable the Debugger(s) to invoke it by adding an entry to the Debugger Client configuration file </span><span class=" | <span class="f_Para">Once </span><var>Xtend</var><span class="f_Para"> is installed and configured for debugging, you enable the Debugger(s) to invoke it by adding an entry to the Debugger Client configuration file </span><span class="term">(debuggerConfig.xml)</span><span class="f_Para">. This file is installed in the same directory as the Debugger Client executable file, and it is [[Customize debuggerConfig file|initially configured]] as part of the Debugger Client installation.</span> | ||
<span class="f_Para">To update the file: </span> | <span class="f_Para">To update the file: </span> | ||
# <span class="f_ListNum1">Open the </span><span class=" | # <span class="f_ListNum1">Open the </span><span class="term">debuggerConfig.xml</span><span class="f_ListNum1"> file in a text editor.</span> | ||
# <span class="f_ListNum1">Add an </span><span class=" | # <span class="f_ListNum1">Add an </span><span class="term"><editor></span><span class="f_ListNum1"> element (bounded by an </span><span class="term"><editor></span><span class="f_ListNum1"> start tag and an </span><span class="term"><\editor></span><span class="f_ListNum1"> end tag) at the same level (as a sibling of) the existing </span><span class="term"><serverList></span><span class="f_ListNum1"> element.</span> | ||
: Include these <span class=" | : Include these <span class="term"><editor></span><span class="f_ListContinue"> subelements, and specify values for them as described in the </span><span class="term">Comment</span><span class="f_ListContinue"> section below: </span> | ||
<div style="text-align: left; text-indent: 0; padding: 0 0 0 0; margin: 24px 0 24px 30px;"> | <div style="text-align: left; text-indent: 0; padding: 0 0 0 0; margin: 24px 0 24px 30px;"> | ||
Line 101: | Line 101: | ||
<span class="f_Para">In the Debugger Client, edit a procedure. </span> | <span class="f_Para">In the Debugger Client, edit a procedure. </span> | ||
1. <span class="f_ListNum1">Restart the Debugger Client.</span> | 1. <span class="f_ListNum1">Restart the Debugger Client.</span> | ||
2. <span class="f_ListNum1">Load a procedure in the </span>< | 2. <span class="f_ListNum1">Load a procedure in the </span><var">Source Code</var><span class="f_ListNum1"> tab of the Debugger Client:</span> | ||
* < | * <var>Janus Debugger</var><span class="f_ListBul2">: From your web browser, invoke a URL that includes a procedure. </span> | ||
* <span class="f_Product">TN3270 Debugger</span><span class="f_ListBul2">: Issue the [[ | * <span class="f_Product">TN3270 Debugger</span><span class="f_ListBul2">: Issue the [[TN3270 DEBUG Syntax|TN3270 DEBUG ON]] command; then include a procedure from the </span><var>Model 204</var><span class="f_ListBul2"> command line. </span> | ||
3. <span class="f_ListNum1">Right click a line of code, select </span>< | 3. <span class="f_ListNum1">Right click a line of code, select </span><var">Line Information </var><span class="f_ListNum1">from the context menu, then click the </span><var">Edit</var><span class="f_ListNum1"> button on the pop up that opens.</span> | ||
<var>Xtend</var><span class="f_ListContinue"> should open, displaying in its working area the procedure that contains the code line that you right clicked. If it fails to do so, and you verified earlier that, by itself, </span><var>Xtend</var><span class="f_ListContinue"> successfully transfers files from the </span><var>Model 204</var><span class="f_ListContinue"> Online, begin your troubleshooting in the Debugger Client </span><span class=" | <var>Xtend</var><span class="f_ListContinue"> should open, displaying in its working area the procedure that contains the code line that you right clicked. If it fails to do so, and you verified earlier that, by itself, </span><var>Xtend</var><span class="f_ListContinue"> successfully transfers files from the </span><var>Model 204</var><span class="f_ListContinue"> Online, begin your troubleshooting in the Debugger Client </span><span class="term">debuggerConfig.xml</span><span class="f_ListContinue"> file settings for the </span><span class="term"><editor></span><span class="f_ListContinue"> element. </span> | ||
[[Category:Debugger Home]] | [[Category:Debugger Home]] |
Revision as of 14:28, 8 November 2022
To use Xtend while debugging, you define a Janus Web Server port and an APSY subsystem in the Online, as well as configuring the Xtend GUI and the Debugger Client on your workstation. Once this is complete, you can use Xtend with the Debugger, as described above in Using a local editor.
You must use version 2.11 or higher of Xtend. The details provided below are for version 2.11 using Janus Web Server.
The configuration steps below are described in this section. They assume the Debugger installation has been completed and tested, as described in Product Installation. The Xtend product installation and setup is also documented in greater detail in Help files provided with the product.
- Install and configure Xtend in your Model 204 Online
- Install and configure the Xtend GUI
- Update the Client configuration file
- Test the configuration
Install and configure Xtend in your Online
Skip to the next subsection (Install and configure the Xtend GUI) if Xtend is already installed at your site.
1. Download to your workstation two Xtend installation files (one for the Xtend GUI and one for the Model 204 subsystem and web port). 2. Set up a Model 204 subsystem (XTEND) to control Xtend processing.
- Notes for doing this are provided in the XtendInstall.HLP file in the XtendInstall folder. See the "Xtend Apsy" section.
3. From the PC, run the Xtend installer executable (XtendInstall.exe), which will populate the XTEND subsystem files. 4. In the Online, run the XTEND.JANUS.DEFINE procedure in the XTENDPRC procedure file to start the Xtend Janus Web port.
- The default port number for the non_SSL port is 7878; for the secure port it is 7879. Change these numbers if necessary for your site.
Install and configure the Xtend GUI
- If you will use Janus Debugger and have configured a proxy server for the Internet Explorer browser, update the proxy settings to provide a bypass for connections to the Xtend web port.
- From the <var">Tools menu, select <var">Internet Options; then select the <var">Connections tab, and click the <var">LAN Settings button.
- Locate the <var">Proxy Server area, and click the <var">Advanced button.
- In the <var">Exceptions area, in the list box labeled "Do not use proxy server for addresses beginning with," specify the URL of the Xtend web server port you defined.
- Click <var">OK as needed to close the multiple dialog boxes.
- Set up a remote connection to Model 204 from the Xtend GUI.
- Open the Xtend GUI executable file (Xtend.exe), and select <var">Options</vavr> from the <var">View menu.
- In the <var">Options dialog box, select the <var">Remote tab.
- In the grid in the main work area, specify a name for this connection and supply a Model 204 user ID, host name, and the web server port you defined, and click the <var">Apply button.
- If you will use TN3270 Debugger, select the name (Caption) of the remote connection you just defined from the Default edit online when using TN3270 Debugger drop down list, then click the <var">OK button.
- Optionally, review and update the settings in the other <var">Options tabs.
- Add the names of the procedure files (and their privileges) whose procedures you will be editing with Xtend.
- Select <var">Administrator Functions from the <var">Admin menu; then select the <var">Files tab.
- In the <var">File columns, name the procedure files that contain the procedures you want to make accessible from Xtend; in the <var">Privileges column, select a privilege level.
- This information can alternatively be specified in the XTEND subsystem itself.
- Click the <var">Save Details button, followed by the <var">Close button.
Note: For procedure files that have explicit passwords, you must either add the file name to the XTEND subsystem files listed in the Subsystem File Use screen in the Model 204 Subsystem Management facility, or you must modify a subroutine in the XTENDPRC procedure file (as described in the XtendInstall.HLP file).
- Test your connection.
- In the <var">Procedure List dialog box, select the tab that is labeled with the name of your remote connection.
A list of your procedures is retrieved and displayed.
- Display a test procedure's code (double click the procedure name), make some update, then save the updated procedure by clicking the Save File icon on the toolbar.
- In your Online, check that the updated procedure has replaced the original.
- If your connection test is successful, close Xtend.
Update the Debugger Client configuration file
Once Xtend is installed and configured for debugging, you enable the Debugger(s) to invoke it by adding an entry to the Debugger Client configuration file (debuggerConfig.xml). This file is installed in the same directory as the Debugger Client executable file, and it is initially configured as part of the Debugger Client installation.
To update the file:
- Open the debuggerConfig.xml file in a text editor.
- Add an <editor> element (bounded by an <editor> start tag and an <\editor> end tag) at the same level (as a sibling of) the existing <serverList> element.
- Include these <editor> subelements, and specify values for them as described in the Comment section below:
Subelement | Comment |
<program></program> |
The identifier of the Xtend program executable file (case does not matter). For example: <program>xtend</program>. Note: If the Windows system variable Path does not include the folder path that points to the Xtend executable (for example, C:\Program Files\Xtend), either add it to the Windows variable now, or specify the folder path before the executable file name in the <program> value. To locate the Path variable specification on a Windows 7 workstation, find the Control Panel (say, Start menu > Settings > Control Panel), then select System > System advanced settings > Advanced tab > Environment Variables button > System variables > Path, then click Edit to see the full specification of the Path variable. |
- When complete, your configuration file should have a structure like the following:
<debuggerConfig version="1.0"> <serverList> . . . </serverList> <proxy> . . . </proxy> <editor> <program>xtend</program> </editor> . . . </debuggerConfig>
- 3. Save and close the file.
Test the configuration
In the Debugger Client, edit a procedure. 1. Restart the Debugger Client. 2. Load a procedure in the <var">Source Code tab of the Debugger Client:
- Janus Debugger: From your web browser, invoke a URL that includes a procedure.
- TN3270 Debugger: Issue the TN3270 DEBUG ON command; then include a procedure from the Model 204 command line.
3. Right click a line of code, select <var">Line Information from the context menu, then click the <var">Edit button on the pop up that opens.
Xtend should open, displaying in its working area the procedure that contains the code line that you right clicked. If it fails to do so, and you verified earlier that, by itself, Xtend successfully transfers files from the Model 204 Online, begin your troubleshooting in the Debugger Client debuggerConfig.xml file settings for the <editor> element.