Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "Scout/Tutorial/3.8/webservices/Create WsLogForm"

< Scout‎ | Tutorial‎ | 3.8
(Associate WsLogForm with WsLogTablePage)
m (add ScoutPage)
 
(23 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
{{ScoutPage|cat=Tutorial 3.8}}
 +
 
== Create Ws Log Form ==
 
== Create Ws Log Form ==
On the client node, go to 'Forms'. Right click on the node to create the WsLog {{ScoutLink|Concepts|Form}} [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_1.png]. As the name of the form, enter <code>WsLog</code> and choose to create the Form ID which is the primary key of the log entry[http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_2.png]. Click next to choose from the artefacts which also should be created by Scout SDK [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_3.png]. Uncheck all permissions as {{ScoutLink|Concepts|Security|Authorization}} is not part of this tutorial. As the WS log is read-only, also uncheck <code>NewHandler</code>.
+
On the client node, go to 'Forms'. Right click on the node to create the WsLog{{ScoutLink|Concepts|Form}} [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_1.png]. As the name of the form, enter <code>Ws Log</code> and choose to create the Form ID which is the primary key of the log entry[http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_2.png]. Click next to choose from the artifacts which also should be created by Scout SDK [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_3.png]. Uncheck all permissions as {{ScoutLink|Concepts|Security|Authorization}} is not part of this tutorial. As the WS log is read-only, also uncheck <code>NewHandler</code>.
  
 
Because the form does only display read-only data, change the <code>ModifyHandler</code> as follows:
 
Because the form does only display read-only data, change the <code>ModifyHandler</code> as follows:
Line 44: Line 46:
 
  Class name: OperationField
 
  Class name: OperationField
  
To display the [http://en.wikipedia.org/wiki/SOAP SOAP message] for request and response, we create a {{ScoutLink|Concepts|TabBox}} that contains to tabs: 'Request' and 'Response'.
+
To display the [http://en.wikipedia.org/wiki/SOAP SOAP message] for request and response, we create a {{ScoutLink|Concepts|TabBox}} that contains the two tabs 'Request' and 'Response', respectively.
  
 
  '''SoapMessageBox'''
 
  '''SoapMessageBox'''
Line 51: Line 53:
 
  Class name: SoapMessageBox
 
  Class name: SoapMessageBox
  
Because the tab box <code>SoapMessageBox</code> should not have a label, go to that node and uncheck the <code>Label Visible</code> property in Scout Property View. Next, we will create the two tabs. Therefore, right click on <code>SoapMessageBox</code>[http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_4.png] and create the following two boxes:
+
Because the tab box <code>SoapMessageBox</code> should not have a label, go to that node and uncheck the <code>Label Visible</code> property in the 'Advanced Properties' section of the Scout Property View. Next, we will create the two tabs. Therefore, right click on <code>SoapMessageBox</code>[http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_4.png] and create the following two boxes:
  
 
  '''RequestBox'''
 
  '''RequestBox'''
Line 65: Line 67:
 
Right click on <code>RequestBox</code> to create the 'Request' String field [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_5.png]:
 
Right click on <code>RequestBox</code> to create the 'Request' String field [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_5.png]:
 
  '''RequestField'''
 
  '''RequestField'''
 +
Type: String Field
 
  Name: <leave empty as no label>
 
  Name: <leave empty as no label>
  Class name: StringField
+
  Class name: RequestField
  
Right click on <code>RequestBox</code> to create the 'Response' String field [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_6.png]:
+
Right click on <code>ResponseBox</code> to create the 'Response' String field [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_6.png]:
 
  '''ResponseField'''
 
  '''ResponseField'''
 +
Type: String Field
 
  Name: <leave empty as no label>
 
  Name: <leave empty as no label>
  Class name: StringField
+
  Class name: ResponseField
  
 
In both fields, adjust their properties in Scout Property View as following [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_7.png]:
 
In both fields, adjust their properties in Scout Property View as following [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_7.png]:
Line 84: Line 88:
 
== Associate WsLogForm with WsLogTablePage ==
 
== Associate WsLogForm with WsLogTablePage ==
 
To view a log record, you have to add a 'VIEW' menu to the <code>WsLogTablePage</code>.
 
To view a log record, you have to add a 'VIEW' menu to the <code>WsLogTablePage</code>.
On client node, go to the node 'Desktop' | 'Outlines' | 'MainOutline' | 'Child Pages' | 'WsLogTablePage' | 'Table' | 'Menus'. Right-click on the menu node to create the following menu:
+
On client node, go to the node 'Desktop' | 'Outlines' | 'StandardOutline' | 'Child Pages' | 'WsLogTablePage' | 'Table' | 'Menus'. Right-click on the menu node to create the following menu:
  
 
  '''VIEW menu [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_8.png]'''
 
  '''VIEW menu [http://wiki.eclipse.org/Image:Org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_8.png]'''
Line 93: Line 97:
 
  Form handler: ModifyHandler
 
  Form handler: ModifyHandler
  
Also, we also have to provide the <code>WsLogNr</code> primary key as argument to the <code>WsLogForm</code>. For that reason, double click the <code>ViewWsLogMenu</code> to modify the code in <code>execAction()</code> as follows:
+
We also have to provide the <code>WsLogNr</code> primary key as argument to the <code>WsLogForm</code>. For that reason, double click the <code>ViewWsLogMenu</code> to modify the code in <code>execAction()</code> as follows:
  
 
<source lang="java">
 
<source lang="java">
Line 101: Line 105:
 
          
 
          
 
   // Add the following line to set the primary key of the selected log record to the form
 
   // Add the following line to set the primary key of the selected log record to the form
   form.setWsLogNr(getWsLogNrColumn().getSelectedValue());
+
   form.setWSLogNr(getWsLogNrColumn().getSelectedValue());
 
          
 
          
 
   form.startModify();
 
   form.startModify();
Line 111: Line 115:
 
</source>
 
</source>
  
== Load and persist company data ==
+
== Load WS Log data ==
Scout SDK already created <code>CompanyProcessService</code> in order to load and persist company data.
+
Scout SDK already created <code>WsLogProcessService</code> in order to load WS log data.
You only have to implement those [http://en.wikipedia.org/wiki/Create,_read,_update_and_delete CRUD] operations:
+
Because we are only reading but not updating log entries, you can remove all operations except <code>load</code>.
  
For that reason, go to the server node and open the <code>CompanyProcessService</code> by double click on 'Process Services' | 'CompanyProcessService'. You will find the following method stubs:
+
Please implement the load-method stub as following:
 
+
  '''prepareCreate'''
+
  Is called by <code>CompanyForm#NewHandler</code> 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 <code>CompanyForm#NewHandler</code> to create a company record in database
+
 
+
  '''load'''
+
  Is called by <code>CompanyForm#ModifyHandler</code> to load a company record from database
+
 
+
  '''store'''
+
  Is called <code>CompanyForm#ModifyHandler</code> to update a company record in database
+
 
+
Please implement those method stubs as following:
+
  
 
<source lang="java">
 
<source lang="java">
public class CompanyProcessService extends AbstractService implements ICompanyProcessService {
+
public class WsLogProcessService extends AbstractService implements IWsLogProcessService {
  
 
   @Override
 
   @Override
   public CompanyFormData prepareCreate(CompanyFormData formData) throws ProcessingException {
+
   public WsLogFormData load(WsLogFormData 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("" +
 
     SQL.selectInto("" +
         "SELECT NAME, " +
+
         "SELECT EVT_DATE, " +
         "      SYMBOL " +
+
         "      SERVICE, " +
         "FROM  COMPANY " +
+
        "      PORT, " +
         "WHERE  COMPANY_NR = :companyNr " +
+
        "      OPERATION, " +
         "INTO  :name, " +
+
        "      REQUEST, " +
         "      :symbol "
+
        "      RESPONSE " +
 +
         "FROM  WS_LOG " +
 +
         "WHERE  WS_LOG_NR = :wSLogNr " +
 +
         "INTO  :date, " +
 +
        "      :service, " +
 +
        "      :port, " +
 +
        "      :operation, " +
 +
        "      :request, " +
 +
         "      :response"
 
         , formData);
 
         , formData);
 
     return 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;
 
  }
 
}
 
 
</source>
 
</source>
  
  
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_1.png|thumb|Create Company Form]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_1.png|thumb|Create WsLogForm]]
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_2.png|thumb|Create Company Form]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_2.png|thumb|Create WsLogForm]]
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_3.png|thumb|Create Form artefacts]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_3.png|thumb|Create WsLogForm artefacts]]
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_4.png|thumb|Create Form Field]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_4.png|thumb|Create Tab Box]]
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_5.png|thumb|Set datatype for Form Field]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_5.png|thumb|Create Request tab]]
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_6.png|thumb|Set properties of Form Field]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_6.png|thumb|Create Response tab]]
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_7.png|thumb|Set properties of Form Field]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_7.png|thumb|Update properties of Request / Response fields]]
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_8.png|thumb|Create menu on CompanyTablePage]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_8.png|thumb|Create view menu on WsLogTablePage]]
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_9.png|thumb|Create the NEW menu]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_10.png|thumb|Create the EDIT menu]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_11.png|thumb|Disable webservice specific fields]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_12.png|thumb|Load and persist data in CompanyProcessService]]
+
[[Image:org.eclipse.scout.tutorial.jaxws.CreateWsLogForm_13.png|thumb|Set maxLength to symbol field]]
+

Latest revision as of 02:56, 17 October 2012

The Scout documentation has been moved to https://eclipsescout.github.io/.

Create Ws Log Form

On the client node, go to 'Forms'. Right click on the node to create the WsLogThe Scout documentation has been moved to https://eclipsescout.github.io/. [1]. As the name of the form, enter Ws Log and choose to create the Form ID which is the primary key of the log entry[2]. Click next to choose from the artifacts 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.

Because the form does only display read-only data, change the ModifyHandler as follows:

public class ModifyHandler extends AbstractFormHandler {
 
  @Override
  public void execLoad() throws ProcessingException {
    IWsLogProcessService service = SERVICES.getService(IWsLogProcessService.class);
    WsLogFormData formData = new WsLogFormData();
    exportFormData(formData);
    formData = service.load(formData);
    importFormData(formData);
 
    // disable whole form 
    setEnabledGranted(false);
  }
}

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 the two tabs 'Request' and 'Response', respectively.

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 the 'Advanced Properties' section of the Scout Property View. Next, we will create the two tabs. Therefore, right click on SoapMessageBox[4] and create the following two boxes:

RequestBox
Name: Request
Class name: RequestBox
ResponseBox
Name: Response
Class name: ResponseBox

Finally, add two String fields to hold request and response to the boxes.

Right click on RequestBox to create the 'Request' String field [5]:

RequestField
Type: String Field
Name: <leave empty as no label>
Class name: RequestField

Right click on ResponseBox to create the 'Response' String field [6]:

ResponseField
Type: String Field
Name: <leave empty as no label>
Class name: ResponseField

In both fields, adjust their properties in Scout Property View as following [7]:

  • Set Grid H to 5
  • Set Grid W to 0 (FULL_WIDTH)
  • Set Label Visible to false
  • Set Max Length to inf (Integer.MAX_VALUE)
  • Set Multiline Text to true
  • Set Wrap Text to true

Associate WsLogForm with WsLogTablePage

To view a log record, you have to add a 'VIEW' menu to the WsLogTablePage. On client node, go to the node 'Desktop' | 'Outlines' | 'StandardOutline' | 'Child Pages' | 'WsLogTablePage' | 'Table' | 'Menus'. Right-click on the menu node to create the following menu:

VIEW menu [8]
Name: View WS Log...
Class Name: ViewWsLogMenu
Super Type: AbstractMenu
Form to start: WsLogForm
Form handler: ModifyHandler

We also have to provide the WsLogNr primary key as argument to the WsLogForm. For that reason, double click the ViewWsLogMenu to modify the code in execAction() as follows:

@Override
protected void execAction() throws ProcessingException {
  WsLogForm form = new WsLogForm();
 
  // Add the following line to set the primary key of the selected log record to the form
  form.setWSLogNr(getWsLogNrColumn().getSelectedValue());
 
  form.startModify();
  form.waitFor();
  if (form.isFormStored()) {
    reloadPage();
  }
}

Load WS Log data

Scout SDK already created WsLogProcessService in order to load WS log data. Because we are only reading but not updating log entries, you can remove all operations except load.

Please implement the load-method stub as following:

public class WsLogProcessService extends AbstractService implements IWsLogProcessService {
 
  @Override
  public WsLogFormData load(WsLogFormData formData) throws ProcessingException {
    SQL.selectInto("" +
        "SELECT EVT_DATE, " +
        "       SERVICE, " +
        "       PORT, " +
        "       OPERATION, " +
        "       REQUEST, " +
        "       RESPONSE " +
        "FROM   WS_LOG " +
        "WHERE  WS_LOG_NR = :wSLogNr " +
        "INTO   :date, " +
        "       :service, " +
        "       :port, " +
        "       :operation, " +
        "       :request, " +
        "       :response"
        , formData);
    return formData;
  }


Create WsLogForm
Create WsLogForm
Create WsLogForm artefacts
Create Tab Box
Create Request tab
Create Response tab
Update properties of Request / Response fields
Create view menu on WsLogTablePage

Back to the top