OData Connection

You can use the OData Connection shared resource to connect to an OData server.

General

In the General panel, you can specify the package that stores the OData Connection shared resource and the shared resource name.

The following table lists the fields in the General panel of the OData Connection shared resource:

Field Module Property? Description
Package No The name of the package where the new shared resource is added.
Name No The name to be displayed as the label for the shared resource in the process.
Description No A short description for this shared resource.

OData Connection Configuration

In the OData Connection Configuration panel, you can provide the necessary information to connect the plug-in with an OData server.

The following table lists the fields in the OData Connection Configuration panel of the OData Connection shared resource:

Field

Module Property?

Description
Root URL Yes The root URL of OData services.

For example:

https://services.odata.org/V4/OData/OData.svc/
Connection Timeout(msecs) Yes The maximum response time of the OData request.
HTTP Proxy No

Specifies the HTTP proxy server to be used to gain access outside of a firewall. The Proxy Configuration shared configuration resource specifies the configuration of the proxy server.

For more information, see the Proxy Configuration
Load Metadata No You can click Load Metadata to load metadata from the OData server.
Note:
  • When the metadata is loaded, the Load Metadata button is changed to Reload Metadata. You can click it to reload metadata from the OData server.
  • On clicking the Load Metadata button, the corresponding schema is generated in the Schemas folder for OData service v2.

Security

In the Security panel, you can select the authentication type of the OData server.

The following table lists the fields in the Security panel.

Field Module Property? Description
Authentication No The authentication of the OData server. Select an authentication type from the list:
  • No Auth: without authentication.
  • Basic Auth: basic authentication with username and password.
  • NTLM: Windows NTLM authentication.
Note: In this release, only the OData Query activity supports the usage of NTLM.
The following items are only displayed when Basic Auth is selected from the Authentication list.
User Name Yes The username of basic authentication.
Password Yes The password of basic authentication.
The following items are only displayed when NTLM is selected from the Authentication list.
Domain Yes The domain of the NTLM server.
User Name Yes The username of the NTLM server.
Password Yes The password of the NTLM server.
Workstation Yes The workstation of the NTLM server.
Use CSRF Protection No This checkbox is used for external services that need to fetch the token to correctly load the metadata.
Oauth Configuration Yes

This checkbox is enabled if you are accessing the plug-in using OAuth authentication.

When you enable this checkbox, the OAuthConfigurationResource panel is displayed.

For more information, see "OAuth Configuration Resource" topic in TIBCO Activematrix BusinessWorks™

To obtain the client ID and client secret, you need to first register an app with Azure Active Directory.

For more information, see the Microsoft Azure documentation.

SSL

In the SSL panel, you can configure SSL after selecting the Confidentiality checkbox. See the TIBCO ActiveMatrix BusinessWorks™ documentation for more details.

Metadata

In the Metadata tab, you can see all the metadata of the OData service after clicking Load Metadata or Reload Metadata.

Note: To update metadata dynamically after changing the URL in the Root URL field, you are required to click Reload Metadata, and then save the OData Connection share resource.