Documentation Index

Fetch the complete documentation index at: https://help.docfusioncloud.com/llms.txt

Use this file to discover all available pages before exploring further.

How to connect to OData

Prev Next

DocFusion's connector for OData allows the importing of OData entities as a data source for document templates. The data source is added to a template's data model, and imported fields are converted to properties.


    OData (Open Data Protocol) is a data access protocol that is built on core online protocols like HTTP and commonly accepted methodologies like REST.
   

    

Add the OData property

Click the Data Model command in the View section of the DocFusion ribbon bar. The Data Model pane opens.

In the Data Model pane's toolbar, click Create OData Property. The connector dialog opens. 

   

Authenticate

Connect to the OData service by specifying the Service URL and clicking Connect. The authentication window opens. 

Select the Authentication Type then provide the necessary details to connect. E.g.: Basic authentication requires a valid username and password. 

Next, click Login. It may take a few moments to establish a connection. You will then be returned to the connector dialog.


Status icon alongside the Service URL indicates the success or failure of your server connection, along with a relevant error message if any.

   

Configure the data source

Select the OData Entity Set you want to use as a data source. Your selection populates the list of available fields below.

Next, specify the Occurrences. Select Single when you want to return only one row of data from the OData entity with the fields that you select. Alternatively, select Multiple when you expect the OData data-source to return a dataset (tabular data) containing multiple rows of data for the fields that you select. 

Now, use the Is Included checkboxes in the table to select those data fields that you would like import to your templates data model as properties of the data source.

  

     

When you're done, click Save. You will be returned to the Data Model pane where you can verify that the selected data fields were added to the template's schema in the Data Model.