Web Interface MOD009CRT

Access

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

Information

• In this module, web interfaces are configured and created.
• A web interface defines the endpoint at which you can interact with PLANTA.
• You can store an implementation and a web entity for each method (GET, PUT, POST, DELETE).
  • The implementation defines the behavior of the interface when it is opened.
  • The web entity describes the data with which the interface interacts.
• Via the Edit web entities command in the context menu of an entity, all web interfaces which have been configured with this entity are opened in the Web Entities module for editing.
• Via the View log button you can open the Requests module with the logging of the web interface.

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 Interface

Procedure

• Insert new web interface:
  • via the Insert→ Web interface menu entry or
  • by clicking on the Insert button.
• Fill the fields in the header area 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 /load/{resource}.
  • Depending on your selection, the Log level field specifies whether logging is to be carried out, and if so, how detailed it is supposed to be.
  • Select the required GET implementation (or PUT, POST, DELETE).
  • Select the required entity.
    • After you have selected the entity you can configure the URL filter by clicking on the button.
• Save.
• Select the required authentication method in the Authentication field. Depending on whether a token or an API key method was selected, you have to carry out the following steps: 
  • For a token authentication you either have to assign an existing token of the web interface or generate and assign a new one. To do so, use the Manage tokens button to switch to the module of the same name.
  • For an API key authentication, allocate an API key in the field of the same name.
  • Both authentication options only make sense with configured HTTPS since otherwise the key can easily be read.
• Via the button you can test the interface in the Test Web Interface module.

Edit Existing Web Entity

Procedure

• Insert form for web entities:
  • via the Insert→ Web interface menu entry or
  • by clicking on the Insert button.
• Select the required web interface from the UUID listbox.
• Change the required values.
• Save.