The documentation from version 39.5.17 of PLANTA project can be found in the new PLANTA Online Help.

Web Entities MOD009CRU New from DB 39.5.10

Access path

Information

  • In this module, web entities are configured and created.
  • A web entity
    • describes the object which interacts with the web interfaces (e.g. the values returned by a GET request).
    • has a name and points to a data table.
    • has n web attributes, each pointing to a data item from the data table.
      • Web attributes have a name and optionally a transformer class which transforms the respective value.
  • Via the Edit assigned web interfaces command in the context menu of an entity, all web interfaces which have been configured with this entity are opened in the Web Interfaces module for editing.

Notes

From DB 39.5.14

  • In order to be able to use the interface, the PLANTA link web services must be activated and configured in the web.conf:
  • If the web services are not activated, the buttons for the execution of different actions for which the web services are required, are not displayed at some positions.
  • NEW Web interfaces use the Fully Qualified Domain Name (FQDN) as an address by default. If it is not available, the host name of the machine is used. If it is not available, the IP of the machine is used. You can define an explicit host name with the planta_link_hostname global setting.

Please pay attention to upper and lower case spelling in all fields in the web interface modules!

From DB 39.5.11

  • In order to be able to use the interface, the PLANTA link web services must be activated and configured in the web.conf:
  • If the web services are not activated, the buttons for the execution of different actions for which the web services are required, are not displayed at some positions.

Please pay attention to upper and lower case spelling in all fields in the web interface modules!

Up to DB 39.5.11

  • In order to be able to use the interface, the PLANTA link web services must be activated and configured:
  • If the web services are not activated, the buttons for the execution of different actions for which the web services are required, are not displayed at some positions.

Please pay attention to upper and lower case spelling in all fields in the web interface modules!

Create New Web Entity

From DB 39.5.16

Procedure
  • Insert a new entity:
    • via the Insert Web Entity context menu entry
    • by clicking on the Insert button.
  • or by clicking on the Insert button.
  • Select the required table in the Data table field.
  • Insert the required web attributes via the Insert Web attribute context menu entry of the newly created web entity
    • The Column types are automatically read out and displayed.
    • The name of the attribute is arbitrary but must comply with the Java name conventions for identifiers and must not occur more than once within an entity.
    • It is possible to open the Configure Parameters dialog module, in which the parameters of the selected transformer can be adjusted, for the selected transformers by clicking on the Configure transfomer parameters tool button.
      • For a date, DateTransformer is automatically selected in the Transformer field. * The DateTransformer enables you to configure the date format.
  • NEW The Mandatory field PUT and Mandatory field POST fields declare an attribute to be obligatory for a PUT or POST request. If this attribute is missing in a PUT or POST request, the request fails with status code 400.
  • Save.

Note

  • If there is an additional attribute which does not exist in the PUT or POST request, the request fails with status code 400.

Up to DB 39.5.16

Procedure
  • Insert a new entity:
    • via the Insert Web Entity context menu entry
    • by clicking on the Insert button.
  • or by clicking on the Insert button.
  • Select the required table in the Data table field.
  • Insert the required web attributes via the Insert Web attribute context menu entry of the newly created web entity
    • The Column types are automatically read out and displayed.
    • The name of the attribute is arbitrary but must comply with the Java name conventions for identifiers and must not occur more than once within an entity.
    • For a date, DateTransformer is automatically selected in the Transformer field.
    • You can adjust the parameters of the transformer by clicking on the tool symbol.
      • The DateTransformer enables you to configure the date format.
  • The mandatory field declares an attribute as obligatory. If it misses in a PUT or POST request, the request fails with status code 500.
  • Save.

Note

  • If there is an additional attribute which does not exist in the PUT or POST request, the request fails with status code 500.

See also: Web Interface Workflows: GET, PUT, POST, DELETE

Edit Existing Web Entity

Procedure
  • Insert form for web entities:
    • via the Insert Web Entity context menu entry or
    • by clicking on the Insert button.
  • Select the required web entity in the UUID listbox.
  • Change the required values.
  • Save.

See also: Here you can find an overview of all PLANTA link contents

         PLANTA project









 
  • Suche in Topic-Namen

  • Suche in Topic-Inhalten
This site is powered by the TWiki collaboration platform Powered by Perl