e.net Diagnostics

Prerequisites

Prerequisites	Installation notes and considerations
e.net Solutions	An operator must be licensed to use the functional area to which the business object belongs.
Microsoft .NET Framework 2.0

Field	Description
File
Open XML	Browse and select an XML file. The file will populate the currently selected tab (either the Business Object Input or Business Object Parameter tab).
Save XML	Save the contents of the currently selected tab to the supplied file name.
Load Sample XML	Display the sample XML in the Business Object Input tab when a new business object name is entered. If the business object requires a parameter XML entry, the Business Object Parameter tab is also populated.
Save All XML	Save all instances of your XML at the same time to a specified folder.
Settings	Open the Settings window from where you can define your preferences and extensions.
Edit	This menu consists of Copy, Cut, Paste, Find, Replace, Highlight, and Select All options. The Find option locates and highlights the first occurrence of the required text. You use the Next button on the Find screen to locate and highlight the next occurrence. The Highlight option highlights all occurrences at the same time.
Data
Remove Comments	Strip out all the comment lines in the XML on the currently selected tab. This is typically used when an XML file contains many comments, which can make it difficult to follow the structure and content of the XML.
Tidy XML	Check that the XML on the currently selected tab is well formed. If the XML is well-formed, the display will be reformatted to make it easier to follow. This is useful when you receive XML from a third party and it is either one long string, or built up from information from different places.
Remove Inner Text	Strip out all the values in your XML, leaving just the element names. This is typically used to remove the values from the XML but to retain the structure.
CData Section	Wrap the highlighted value in a `CDATA` section. A `CDATA` section enables you to pass a value in your XML that contains a character that has a special meaning to XML (e.g. a less-than sign, a greater-than sign, or an ampersand).
Toggle Bookmark	Add or remove a bookmark on the current line. Bookmarks are useful when you have a very large XML file and need to move backwards and forwards through the XML.
Previous Bookmark	Move to the next bookmark up the file. If the current bookmark is the highest one up the file, this option will start at the bottom one.
Next Bookmark	Move to the next bookmark down the XML file. If this bookmark is the last one in the file it goes to the top one in the file.
Clear Bookmarks	Remove all bookmarks from the XML.
Export	Wrap the XML in either `C#`, `VB.NET` or `VBScript` syntax. This enables the XML to be used by the selected language. These options are available on the Business Object Input and Business Object Parameter tabs, and only if they contain text. No check is made to see that the XML is well-formed, or that it is valid (i.e. matches what is allowed by the schema).
Framework
Logon	Select this to call up the Logon window that will allow you to log onto SYSPRO e.net Solutions.
Express Logon	Logon to SYSPRO e.net Solutions using the last successful credentials used. This is useful when another system or harness invalidates the User ID of the harness you are currently working with. This option is only available once a Logon has already been performed.
Logoff	Log out of SYSPRO e.net Solutions.
Get Logon Profile	Call the `GetLogonProfile` method of the `Utilities` class, and return XML containing information about this operator, the company that they are logged on to, and the environment. This option is only available if the user is logged on.
History	Display the History pane to view details about the business object. The Time column contains the time that the business object was invoked. The Business object column contains the name of the business object. The Description column contains the description for the business object, or if the description is not known it contains Business object not found. The Version column contains the version number of the business object. The Class and Method columns contain the class and method of this business object. The Error message column contains the content of any exception that was thrown, as opposed to error (or warning) messages returned in the XML. The default group by sequence is the Date column, in which case the Date column name appears above the grid.
Invoke Business Object	Call the selected business object and display the XML in the Business Object Output tab. This option is only available when you have logged on to e.net Solutions.
Validate Schema	Ensure the XML conforms to the definition laid out in the schema.
Session	The User ID is automatically generated when you log onto SYSPRO. This User ID can be manually entered if required.

Settings

Field	Description
Preferences
Auto Load XML	Display the sample XML in the Business Object Input tab when a new business object name is entered. If the business object requires a parameter XML entry, the Business Object Parameter tab is also populated.
Specify Schema Path	Supply the location containing the samples to be loaded. If this is left blank, the default location is assumed to be the Schemas folder under the SYSPRO Base folder.
Use UTF8 characters (COM/DCOM only)	Select this option to use the `UTF-8` character set. If not selected the default `Windows-1252` character set is used.
History Retention	Each time a business object is run the date, time, business object name, business object description, business object version number, class, method, and any error message are stored. Specify how many of these records are to be kept. The default is 30 days. Remove the history by selecting the Clear button.
Theme	Choose a theme for the user interface.
Interface	Specify which COM object to use for e.net Solutions. The default is `Encore.dll` for backwards-compatibility. The decision of which communications type (i.e. COM/DCOM, Web services, or WCF) is made at login time.
Default Output	Specify the default type of output. The options are to display the output in a text editor, display the output in a web browser, or to write the output to an XML file (the latter prompts you for the file name and location at run time). This can be changed when the business object is executed.
Extensions	Add your own add-ins (or extensions) to the e.net Diagnostics menu. If any items are provided in the Extensions grid, a new Tools menu will appear between the Framework and Help menus. The nine columns containing the parameter checkboxes enable you to pass parameters from the e.net Diagnostics program to the executable that is being invoked. Although these executables are invoked from the e.net Diagnostics menu, they are run standalone and have no knowledge of the e.net Diagnostics program, its environment, or any of its settings. These checkboxes enable you to choose which settings must be passed to the executable as parameters when you click on the menu item.

Toolbar

This table does not display the toolbar options that also appear on the Menu.

Field	Description
Class	Select the class required.
Method	Select the method required.
Business Object	Enter the business object required. If the Browse, Fetch, NextKey or PrevKey class is used, then the business object is automatically entered.
Business Object Library	Select from the list of business objects organized within the module areas of the SYSPRO ERP system. Within each module folder is a list of all the business objects relating to that module's business logic with a brief description of the object, a class identification (Query, Transaction, or Setup) and a method identification (Browse, Query, Fetch, NextKey, PrevKey, Post, Add, Delete, Update, Build).

Logon

Field

Description

Logon Credentials

Credentials

Field	Description
COM/DCOM	Specify that e.net Diagnostics should attempt to connect to the e.net Solutions COM object. If e.net Diagnostics is installed on the SYSPRO application server, this will be via COM. If e.net Diagnostics is installed on a computer that does not contain SYSPRO, the DCOM client can be installed on this machine and (if configured correctly) the COM request is routed via DCOM to the COM object on the SYSPRO application server.
Web Services	The web service address configured against the Service URI prompt on the Service Settings tab is used to connect to the web service.
WCF Services	Uses the settings under the WCF Services section on the Service Settings tab to connect to the WCF services.

User name

Enter the user name you would use to login to SYSPRO.

Password

Enter an operator password, if one has been configured against the operator code.

Company

Enter the company ID. This defaults to the company id configured against the operator within SYSPRO.

Password

Enter a company password, if one has been configured against the company ID.

Debug Level

Field	Description
Debug	Automatically validate the XML string. This will check the form and structure of the XML against the XML Schema.
No debug	Perform no validation on the XML. This is generally used by SYSPRO developers.

Instance

Select the instance you would like to use to log onto SYSPRO e.net Solutions.

XML Parameters

This information allows the passing of parameters at the time of logon which changes the behaviour of SYSPRO e.net Solutions, such as token licenses.

Mask XML Parameters

Replace all the characters against the XML Parameters prompt with asterisks. Unchecking this option will display the characters as normal text.

Service Settings

View the connection details on this tab.

Logon

Log on to SYSPRO e.net Solutions.

Business Object Input/Parameter/Output

The three tabs: Business Object Input, Business Object Parameter and Business Object Output, display the XML that is supplied to, and returned by the business object.

Documentation

This tab only contains information if an element name is selected within either the Business Object Input or Business Object Parameter tabs.

When an element name is selected on one of these tabs, the documentation text for this element in the matching schema is extracted and displayed.

Additional information

This tab contains additional information about the selected element (e.g. whether it is mandatory, if whitespace must be preserved, the default value).

Notes and warnings

Save All XML considerations

When you select the Save All XML option from the File menu, the contents of the Business Object Input tab are saved to a file named BusinessObject_Document.XML and the contents of the Business Object Parameter tab to BusinessObject_Parameter.XML.

If one or both of the files already exist they will be overwritten without the operator being prompted. If the business object has been executed and the results are displayed in the Business Object Output tab, this is saved to the same location with the name BusinessObject_Output.xml.

If the XML was manually entered, and no business object name was supplied, the saved files would be called _Document.xml and _Parameter.xml.

Debug considerations

Debug mode is particularly useful when receiving XML from a third party that looks correct, but the business object does not appear to be working as expected. Quite often there is a spelling error in the opening (and matching closing) element name, and by enabling Debug mode, an exception will be thrown containing the offending element name.

Schema considerations

SYSPRO ships with samples of the document and parameter XML for each business object, as well as schemas that explain the structure, what the XML can and cannot contain.

These are stored in the \Base\Schemas folder. Examples of the possible output from the business object are also included.

Developer considerations

Any changes made to a business object while using this program will affect the database (i.e. information that you post is written to the database).

Login considerations

You must login successfully in order to call a business object. A value in the Session/GUID field indicates you have logged in successfully.