Creating a new provider¶
Note: This describes how to create a provider for an external data source, such as IFS Applications/IFS Cloud. Only IFS technical users can create the system providers.
To generate a new provider for an external data source:
- Go to Home > Providers.
- Click Create Provider.
On the Provider Details tab:
Field Description Provider Name Enter a descriptive name that will make it easier to identify the provider when configuring CE Studio apps and templates. You can edit this later. Service type Select the Field Service Management, OData or IFS Applications as the service type. The IFS Applications type covers both IFS Applications 10 and IFS Cloud. Credentials Object Select the credentials for the target environment. You create these in the Admin Portal on the Credentials Manager > Manage Credentials page. This contains both the endpoint URL and the credentials needed to connect to that environment. Endpoint URL Depending on the service type, enter the URL of the deployment or the URL of the projection. For endpoint URLs for:
• IFS Applications/IFS Cloud, see Cloud Providers
Note: You cannot create the provider if there is an issue with the endpoint or a network problem.Service The service name without the URL of the endpoint.
For IFS Cloud,MainCaseHandling.svcis an example of a service name.
For IFS Field Service Management,M5WebService.asmx/ProcessXMLis an example of a service name.Description Additional information about the provider. You can edit this later. Concurrency Checks Use this where the deployment does not enforce concurrency on operations such as update, upsert and patch. When selected, the provider will attempt to handle concurrency for these types of operation. 4. Go to the Single Sign-On Details tab. How you complete the tab depends on whether the tenant uses Azure Active Directory single sign-on. If the tenant is configured to use Azure Active Directory single sign-on for user authentication:
Field Description Use SSO Select Use SSO to configure this provider for single sign-on.
This means that all users will sign on using their SSO credentials. All users of Agent Desktop and CE Studio must have a user account in the client's Azure AD deployment.
If a user group is associated with the SSO deployment then only users belonging to the user group must sign on with their SSO credentials.
Note: To create a SSO deployment, you need to raise a request in IFS Service Center. To view the SSO deployment or configure a user group for the SSO deployment, go the Admin Portal and the Studio > SSO Deployment page.SSO Deployment Select the SSO deployment from the list.
SSO deployments are configured by IFS, from information provided by the tenant. It associates the tenant's Azure AD deployment with any providers they create.
Note: Contact IFS Support if the expected SSO deployment is not in the list.Default User Name, Default Password Backend services that send requests to the target system use the default integration user.
Examples of backend services can include the reporting service and queue progression. Both may be configured to create, read, update, and delete data in the target system.
The integration user needs to be set up in FSM or IFS Applications 10/IFS Cloud.
Note: You can update the credentials later. Go to the Providers page, click Edit next to the provider name, and then go to the Single Sign-On Details tab. After updating the credentials, you must create a new provider version.- If the tenant is not configured for Azure Active Directory single sign-on: Field Description Use SSO Clear the Use SSO check box if the tenant is not set up to use Azure Active Directory.
This means that all users of Agent Desktop and CE Studio will sign on automatically using the same user name and password (the integration user). This user must exist in the FSM or IFS Applications 10/IFS Cloud deployment.There can be a separate integration user for each locale supported by the deployment.Default User Name, Default Password Enter the user name and password for the integration user account that you want to use in FSM or IFS Applications. Locale, User Name, Password You can add a default integration user for each locale supported by the deployment – the locale to use is taken from the locale of the signed-in user:
1. Click Add Sign-on Credentials.
2. Select the locale.
3. Enter the default user name and password for the locale.5. Click Continue. The button is unavailable if any information is missing on either of the tabs.
Note: You cannot create the provider if there is an issue with the endpoint or a network problem. In this situation, the status of the provider will show as !. Try again later to create the provider. 6. This is version 1 of the provider.Make the provider version live. You can only use a provider which has a live version.
There are two ways of accessing this version from an app or template.
- Either you access the version as the active (live) version of the provider
- Or you access the version as a numbered version (version 1).
You'll use the live version if you want an automatic upgrade policy for your app or template or the numbered version for manual upgrades.
Note: You will now have the option to select the time zone setting when creating IFS Cloud providers. See Time zones