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

Web Interface Workflow: POST 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 creates new tasks.

Requirements

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:
- generic_service = true
- generic_service_interface and generic_service_port contain reasonable data.
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!

In order to be able to use the interface, the PLANTA link web services must be activated and configured in the web.conf:
- generic_service = true
- generic_service_interface and generic_service_port contain reasonable data.
- Macro 009CW6 has been run once and the service has been restarted.
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!

In order to be able to use the interface, the PLANTA link web services must be activated and configured:
- generic_service = true
- The generic_service_interface and generic_service_port parameters contain reasonable data.
- Macro 009CW6 was run once and the service has been restarted.
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!

Objective

Procedure

Open the Configuration panel
Insert a new entity in the Web Entities submodule
- via the Insert Web Entity context menu entry
- or by clicking on the Insert button.
Specify a name and select table 463 in the Data table field.
Insert three web attributes via the Insert Web attribute context menu entry of the newly created web entity:
- DI001097 Project ID with the name project
- DI000807 Task name with the name name
- DI008851 ID parent task with the name parent
Save.

Objective

To create a web interface which processes incoming requests and creates our tasks

Procedure

Open the Configuration panel
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: /task
- Allocate an API key
- Select the DefaultServiceImplementation POST implementation
- The entity created newly in the previous step is selected in the Web entity field

Objective

Procedure

Click on the button to open the Test Web Interface module
Select POST as HTTP method
Answer the query whether a template is to be copied in with Yes
Configure project 4711 for the URL filter.
- To create the record correctly, the technical ID of the project must be determined. In this case: 000008.
Fill the copied template as follows:
- {"project": "000008", "name": "Summary task", "parent": ""}
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.
As a response to a successful query, the server responds with the automatic numbers of the created record as follows.
- {"task_id": "12"}
The ID can be used for a further query with the following Request:
- {"project": "000008", "name": "Task", "parent": "12"}
If the schedule of the project is opened now, it contains two new structured tasks.