Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Scout/Tutorial/3.8/webservices/Create WsLogForm
Contents
Create Ws Log Form
On the client node, go to 'Forms'. Right click on the node to create the WsLog The Scout documentation has been moved to https://eclipsescout.github.io/. [1]. As the name of the form, enter WsLog
and choose to create the Form ID which is the primary key of the log entry[2]. Click next to choose from the artefacts which also should be created by Scout SDK [3]. Uncheck all permissions as The Scout documentation has been moved to https://eclipsescout.github.io/. is not part of this tutorial. As the WS log is read-only, also uncheck NewHandler
.
Create Form Fields
On the WsLogForm
node, go to the 'MainBox'. Right click on the MainBox to create the following 4 Form The Scout documentation has been moved to https://eclipsescout.github.io/.'s:
DateField Type: Date Field Name: Date Class name: DateField
ServiceField Type: String Field Name: Service Class name: ServiceField
PortField Type: String Field Name: Port Class name: PortField
OperationField Type: String Field Name: Operation Class name: OperationField
To display the SOAP message for request and response, we create a The Scout documentation has been moved to https://eclipsescout.github.io/. that contains to tabs: 'Request' and 'Response'.
SoapMessageBox Type: Tab Box Name: <leave empty as no label> Class name: SoapMessageBox
Because the tab box SoapMessageBox
should not have a label, go to that node and uncheck the Label Visible
property in Scout Property View.
To create the two tabs, right click on SoapMessageBox
[4]:
RequestBox Name: Request Class name: RequestBox
ResponseBox Name: Response Class name: ResponseBox
Associate CompanyForm with CompanyTablePage
To edit and create companies, you have to add an 'EDIT' and 'NEW' menu to the CompanyTablePage
.
On client node, go to the node 'Desktop' | 'Outlines' | 'MainOutline' | 'Child Pages' | 'CompanyTablePage' | 'Table' | 'Menus'. Click on the menu node to create the following 2 menus [5]:
NEW menu [6] Name: New company... Class Name: NewCompanyMenu Super Type: AbstractMenu Form to start: CompanyForm Form handler: NewHandler
EDIT menu [7] Name: Edit company... Class Name: EditCompanyMenu Super Type: AbstractMenu Form to start: CompanyForm Form handler: ModifyHandler
In the EDIT menu action, we also have to provide the CompanyNr
primary key as argument to the CompanyForm
. For that reason, double click the EditCompanyMenu
to modify the code in execAction()
as follows:
@Override protected void execAction() throws ProcessingException { CompanyForm form = new CompanyForm(); // Add the following line to set the primary key of the selected company to the form form.setCompanyNr(getCompanyNrColumn().getSelectedValue()); form.startModify(); form.waitFor(); if (form.isFormStored()) { reloadPage(); } }
Load and persist company data
Scout SDK already created CompanyProcessService
in order to load and persist company data.
You only have to implement those CRUD operations:
For that reason, go to the server node and open the CompanyProcessService
by double click on 'Process Services' | 'CompanyProcessService'. You will find the following method stubs:
prepareCreate
Is called by CompanyForm#NewHandler
prior to open a non-existing company. This is if a company is to be created to show some default values in the form. It is not used by this tutorial.
create
Is called by CompanyForm#NewHandler
to create a company record in database
load
Is called by CompanyForm#ModifyHandler
to load a company record from database
store
Is called CompanyForm#ModifyHandler
to update a company record in database
Please implement those method stubs as following:
public class CompanyProcessService extends AbstractService implements ICompanyProcessService { @Override public CompanyFormData prepareCreate(CompanyFormData formData) throws ProcessingException { // nop return formData; } @Override public CompanyFormData create(CompanyFormData formData) throws ProcessingException { formData.setCompanyNr(SQL.getSequenceNextval("GLOBAL_SEQ")); SQL.insert("" + "INSERT INTO COMPANY " + " (COMPANY_NR, " + " NAME, " + " SYMBOL) " + "VALUES (:companyNr, " + " :name, " + " :symbol)" , formData); return formData; } @Override public CompanyFormData load(CompanyFormData formData) throws ProcessingException { SQL.selectInto("" + "SELECT NAME, " + " SYMBOL " + "FROM COMPANY " + "WHERE COMPANY_NR = :companyNr " + "INTO :name, " + " :symbol " , formData); return formData; } @Override public CompanyFormData store(CompanyFormData formData) throws ProcessingException { SQL.update("" + "UPDATE COMPANY " + "SET NAME = :name, " + " SYMBOL = :symbol " + "WHERE COMPANY_NR = :companyNr" , formData); return formData; } }