Providers¶
Important: For a successful integration, you require knowledge of the target system and its metadata.
The provider stores the data types (OData entity types), properties and OData methods for integrating with both apps and IFS Cloud deployments..
Authentication for providers in IFS Cloud¶
Portals support two authentication and authorization mechanisms for IFS Cloud providers:
Integration User Credentials
Used for non-authenticated portals, such as the
Personalized Portaluse case. Access to IFS Cloud is performed using a dedicated integration user configured in IFS Cloud.Single Sign-On (SSO)
Used for authenticated portals. End users authenticate via Single Sign-On (SSO). These users must exist in the configured Identity Provider (IdP) within the Nexus User Management system.
All versions of a provider will use the same username/password or SSO credentials.
Creating IFS Applications providers¶
For both IFS Cloud and IFS Applications 10, you need to create a provider for each projection that you want to use.
Note: You cannot create a provider if the translation service is not deployed in the environment.
You can obtain the URI of the endpoint by using the API Explorer or the Developer Tools:
Start by obtaining the URI of the projection:
- Go to the IFS Applications 10 or IFS Cloud deployment.
- Identify the entity you are interested in, such as Work Orders.
- Find an existing work order.
- Press F12 to show the developer tools pane.
- On the Preview tab, examine one of the requests to find the uri of the endpoint.
- Copy the uri starting
https:and ending with.svc. - Create the provider.
Concurrency checks, etags and IFS Applications/Cloud providers¶
Depending on the implementation, you may need to select the Concurrency Checks option for the provider. This is necessary, for example, if there are any database constraints implemented in IFS Cloud.
Note: The error
Error with external service: Reason Phrase = Precondition Requiredis shown if concurrency checks are enabled in IFS Cloud but not in the provider.Note: The IFS etag is automatically included in provider responses when data is read from any odata provider and, when Concurrency Checks is enabled, is included in update requests to the provider.
IFS Applications provider data types and properties¶
The provider stores all the entity types and properties exposed by the projection used when you created the provider. You can add any of these entity types and properties studio apps. Once you have created a studio app, you can explore the provider metadata using the metadata viewer.
When configuring actions, there are two parameter types, suggested and optional:
| Suggested parameters | IFS Cloud or oData properties that are not nullable are defined by portal Studio as suggested parameters. For these properties the Parameter Properties dialog shows Required? as true. These parameters are required for the Portal Studio action to succeed. |
| Optional parameters | IFS Cloud or oData properties that are nullable are defined as optional parameters. For these properties the Parameter Properties dialog shows Required? as false. These parameters are not necessarily required for the Portal Studio action to succeed, however at the endpoint there may be some underlying relationship between properties which is not known to the Portal Studio provider. You therefore need to check the oData or IFS Cloud metadata to verify this. |

Figure: Nullable and non-nullable properties
Working with IFS Applications provider methods¶
To create, update or delete an entity instance, you must include all the key properties required by the target system. For updates and deletes, this includes the key(s) to uniquely identify the instance of the entity. Note that the properties you see when configuring actions are studioservicestype properties and whether they are required will depend on the context:
- To add properties to the action that you are configuring, click Manage Properties and select the required and optional properties needed by the method. Then map each property to the fields in the studio app that hold the new values.
- To exclude unwanted properties, select the Ignore check box.
- To pass null for any property, select the Use Null check box.
Using lookup codes¶
When testing a Portal Studio app that uses a lookup code from an IFS Applications provider be aware that it can take a long time for the values to load. Lookup will be much quicker once the values are cached.
Limitations¶
In Portal Studio, an action can sort the data in the response. The property to sort by can be configured in the action. If it is not configured then sorting is on the first column in the data grid. However, IFS Cloud and IFS Applications 10 do not allow sorting on fields that are the CLOB data type. Portal Studio typically handles these properties as very long strings.
This means that when you configure an action for either IFS Cloud or IFS Applications 10, then sorting by one of these properties results in the error: "ORA-00932: inconsistent datatypes: expected - got CLOB". If this occurs then you should change the property that is used for sorting.