Business Object Harness.
Once the Business Object Harness has been downloaded and installed; you can start using it.
| Info |
|---|
If you don’t like reading, you can watch the video. |
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
premium_BUSINESS_OBJECTS_HARNESS_product_userguide_UG - v0.2.pdf |
Try it!
The first time the application is used the WebAPI location will be assumed to be localhost (the current server). If running the Harness on the WMS Server, it will fire up to the main screen immediately. If not, you may be presented with the below screen, indicating the application was unable to connect to the DATASCOPE WMS WebAPI.
If you are presented with this screen, simply enter the correct IP Address or Name and Port of the WMS WebAPI and click the Ok OK button. The system will then try and make a connection to the WMS WebAPI with the new details.
Once the application has successfully connected, the new details will be saved to the registry for future use. Should you wish to reset/delete this, the registry location of the setting are is located as per below:
HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\DATASCOPEHARNESS
Simply delete this key and re-run the application, and the above prompt will come up appear again. Alternatively, you can edit the registry value to a different location.
Once the application is running, the WebAPI location can also be edited in the Settings section of the Ribbon bar as shown below:
Screen overview
The main application screen looks like the one below, with each section explained for each of the corresponding numbers.
This is the main login for the application. Before any processing can begin a valid WMS GUID needs to be obtained by logging in with a WMS/SYSPRO licensed operator. When selecting the Logon button, take note of the GUID at the bottom of the screen where you will see a successful Logon.
Once the login process has been successful, this section with the available Modules, Functional Areas, and Business Objects will become active. Select the required Module, Functional Area, and Object Name and select Load XML
The first column is loaded with the selected Business Object that has been selected in step 2 above. This section will provide a summary of the object, along with its Namespace within the DATASCOPE.SDK DLL etc.
This section of the screen shows all the properties associated with the business object, along with a color, indicating if the property is Mandatory or Optional. The column provides the Name, Description and Default Value of each property. The Value column is where the operator can enter the values they wish to pass into the object for that property. Properties with a specific set of options are provided as a drop-down list. Complex objects will have a button provided to add some details. (See Complex Parameters section later in this document for more details)
Select Post, so fire the E.Net Post, to see the results in the right-hand side of the grid.
After selecting Post, the results of the values loaded in Step 3 will load in this section. Any errors will be visible here.
This section displays the XML Object Result
The status bar at the bottom of the screen, indicates some key information about the system, starting with the currently logged in GUID, Server SDK/WebAPI versions and the local SDK Version.
Logon
Before you can start using the application, you need to successfully authenticate to obtain a GUID. This GUID will then be used to post the Business Objects. The login is performed using the Login section of the ribbon bar as per the below screen:
Simply select the Company you would like to login to, followed by a valid operator, along with its password and company password (if any). Clicking the Logon button will then attempt to login to the system using the WebAPI.
On a successful login the GUID at the bottom right of the screen should change from Red to Green as well as indicate the GUID that was obtained from the login.
Not yet logged in.
Error message will be presented in the form of a Message Box, similar to the below:
Posting an Object
The first step to posting an object is to select and add the object to the main content window. Multiple objects can be added and are displayed in the form of a tab for each of the objects.
To select an object, you will need to know the Module, Functional Area and finally the Name of the object, this is also shown in the Business Object Sheet found on the DSP Portal, as shown below:
These fields correspond to the Business Object selection shown below on the ribbon bar, make the selection and then click the Load XML button. This will add the object to the data grid in the main content window.
Once the data has loaded the system will display the properties associated with the Business Object that was selected, as shown below example:
The columns Name, ShortDescription and Default Value as for information purposed only. The final column value is there the values for each of the properties can be entered.
The rows with the blue background are Mandatory properties and the ones in grey are optional.
To post the object, simply enter the property values you require and press the Post button at the bottom right of the screen. This will then fire the post through to the WebAPI and provide feedback in the form of a Message box, as shown below:
Error message will be possible in the feedback box above.
The messages that are obtained are also added to the XML Object Result screen at the left panel of the screen, as shown below. This will keep a history of the posts that have been performed on the object.
Complex Parameters
Some Objects have what is called Complex parameters. This is where the parameter can have multiple values or a list of values. In this case the XML Object Results will look as follows:
Simply click the button to add the details for that specific parameter, in this example we need to enter the Stock code, Lot, Expiry and Quantity:
