Tutorial: Web Interfaces - PUT

Information

• The following workflow provides basic knowledge required to create an interface in PLANTA Project using the functions delivered.
• The objective of this workflow is a web interface which updates project data.

Requirements

• Basic customizing knowledge
• Basic knowledge of REST

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 Web Entity

Objective

• To create a web entity which describes our data

Procedure

• Open the Configuration panel.
• Insert a new entity in the Web Entities submodule
  • via the Insert→ Web entity menu entry or
  • by clicking on the Insert button.
• Specify a name and and select table 461 in the Data table field.
• Insert three web attributes via the Insert → Web attribute context menu entry of the newly created web entity:
  • DI000690 Project name
• 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. In this example, name is entered in the field.
• Save.

Create Web Interface

Objective

• To create a web interface which processes incoming requests and updates the project

Procedure

• Open the Configuration panel.
• Create a new web interface
  • via the Insert→ Web interface menu entry or
  • by clicking on the Insert button.
• Fill the fields as follows:
  • The name is arbitrary.
  • The Active field must be activated before the interface is used.
  • Create a placeholder in the Url field, for example /project/{project_id}
  • Allocate an API key.
  • Select the DefaultServiceImplementation PUT implementation.
  • The entity which was newly created in the previous step is selected in the Web entity field.
• After you have selected the entity, you can configure the URL filter by clicking on the tool button.
  • Select data item 041317 "Project" in the dialog module.
  • Note: It is the functional, not the technical ID.

Test Web Interface

Objective

• To test the newly created web interface

Procedure

• Click on the earth button to open the Test Web Interface module.
• Select PUT as HTTP-method.
• Answer the query whether a template is to be copied in with Yes.
• For the URL filter, project "4711" is configured.
• Fill the copied template as follows:
  • {"name": "Example text"}
• Click on the Execute button.
  • The placeholder in the URL is automatically replaced by the transferred value and the API key is passed on in the HTTP header.
• If status code 200 is displayed, the query was successful and project 4711 is now named "Example text".