Odata Web Interfaces

Information

• PLANTA project allows to exchange data by means of OData.
• For this purpose, web interfaces are used.

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)!

Activate Odata Web Interfaces

Procedure

• Open the Web Interfaces module.
• Open the required Odata interfaces.
• Activate the Active checkbox for the required Odata interface.
  • For this purpose, the OData Test Service Root interface MUST be activated.
  • Whether additional interfaces must be activated depends on the data source you want to use.
• Save.

To view all Odata interfaces you can filter by the name "odata*" via the Filter criteria.

Notes

• All requests are processed via the OData Test Service Root interface by default.
  • You can set up your own root service if required.
  • Here, the ODataServiceImplementation implementation must be stored as a GET implementation.
  • All further OData interfaces must use the same URL.
• In web interface, an API token is used for authentication by default.
  • For this purpose, an API token must be generated in the beginning in the Manage API-Tokens module and be assigned to the Root Service web interface.

Details

• The UUIDs are automatically allocated in the background and are always named <entity name>UUID.
• Via the relation, the foreign keys are also automatically created as UUIDs and are named <entity name of the external table>UUID.
• The fields contained in the Odata interface are configured in the corresponding web entity.

Configure the Odata Web Interfaces

Details

• In the Web Entity module, you can create new web entities for OData web interfaces and adjust existing web interfaces.
• You have to store customizing.weblink.ODataWebEntity as implementation.
• New data items can be added to the web entity as usual.

Further information on web entities

Example: Open data from Odata in Excel

Objective

• Data from the Odata web interfaces are to be displayed in MS Excel.

Preparation

• Open the Web Interfaces module.
• Activate the Active checkbox for the OData Test Service Root Odata interfaces and the other required interfaces.
• Save.

Procedure

• In MS Excel, select the Data → Retrieve data → From other sources → From Odata data feed option.
• In the URL field, insert the complete URL from the OData Test Service Rootweb interface.
  • Here, fill the variables within the URL accordingly.
• Click on OK.
• Select the required data in the navigator and process them further as required.