Known Considerations & Limitations for Integrations

Note: This page lists a number of situations that is important to be aware of in order to work efficiently with Integrations. There are actually more situations that can be considered as considerations or limitations than listed here.

Odata documents containing Lookups with no enum values

Lookups are defined based on entities (of basic data), for which enum values are retrieved dynamically from the base table of the corresponding entity.

If we consider the below example:

 

CustomerInfoContact entity is exposed as an entityset in ProjectMonitoringHandling projection.

When no records are found in base table of ContactDepartment entity, enum value list for the Lookup would become empty. Lookups are exposed as EnumTypes in Odata documents in IFS. According Odata protocol, EnumTypes with no enum values invalidate the Odata document of that particular API, ProjectMonitoringHandling in this case.

In such scenarios, in order to use the Odata document for integrations, it is required to add a dummy record to the base table of the entity which is modeled as the Lookup (ContactDepartment in above example), so that enum value list would not become empty.

However, this limitation does not apply for integrations using OpenAPI documents, as empty enum value lists in Lookups do not invalidate the OpenAPI spec.

Odata documents containing Enumeration Lookups with special characters

There is a predefined set of of special characters which are supported for Enumeration type lookups in OData document used for integrations. Following is the list of special charcters which are allowed to be inserted for Lookup Enums.

Once these characters are present in Lookup enums, they are encoded as below to make sure the corresponding Odata document of the API is valid according to Odata specification.

Note: If you insert any other special character other than the items in the following list would invalidate the OData document of particular API, as the encoding support is not implemented.