Web Entities MOD009CRU

Access

• PLANTA link role → Web Interfaces → Configuration panel → Web Entities

Information

• In this module you can configure and create web entities.
• 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.

Details

• The Web Entities module cannot be closed as long as it is opened as a submodule of Web Configuration.

Notes

• To be able to use web interfaces you have to activate and configure the PLANTA link webservices in the web.conf:
  • generic_service = true
  • generic_service_interface and generic_service_port contain meaningful data
• If you have not activated the webservices, the buttons for carrying out different actions which require webservices will not be displayed.
• Web interfaces use the Fully Qualified Domain Name (FQDN) as an address by default. If the FQDN is not available, the host name of the machine will be used. If the host name is not available either, the IP of the machine will be used. An explicit host name can be defined using the global planta_link_hostname setting.

All fields in the web interface modules are case sensitive (observe upper/lower case spelling)!

Create New Web Entity

Procedure

• Insert a new entity:
  • via the Insert→ Web entity menu entry or
  • by clicking on the Insert button.
• Assign a name
• 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 in the Name field 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.
• The Mandatory field PUT and Mandatory field POST fields declare an attribute 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.
  • Attributes can either be declared as mere Mandatory field PUT or Mandatory field POST, or they can be declared as both Mandatory field PUT and Mandatory field POST.
• If the Read only checkbox is activated for an attribute, it can be read but not written.
• 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.

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 from the UUID listbox.
• Change the required values.
• Save.