Web Interface Workflow: PUT New from DB 39.5.10

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

Create Web Entity

Objective

• To create a web entity which describes our data

Procedure

• Open the Configuration
• Insert a new entity in the Web Entities submodule
  • Click on the Insert button
  • Specify a name and select table 461 in the Data table field.
• Insert the required web attributes via the Insert Web attribute context menu entry of the newly created web entity
  • DI000690 Project name
• 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. This value is entered manually 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
• Create a new web interface
  • via the Insert Web Interface context 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 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 Run button.
  • The placeholder in the URL is automatically replaced by the transferred value and the API key is handed on in the HTTP header.
• If the status code 200 is displayed, the query was successful and the project 4711 has the new title "Example text".