Skip to content

IFS Optimization Framework Configuration Assistant

The IFS Optimization Framework Configuration Assistant allows connecting an IFS Cloud instance with a PSO tenant without having to use multiple pages and services to configure IAM Clients, Scheduling Optimization and Machine Learning configurations and PSO tenants manually. However, manual configuration of these is still possible.

Apart from the information needed in Scheduling Optimization and Machine Learning Configuration, the assistant will need administrator username and password of the PSO tenant being configured. This is to remotely configure the PSO tenant.

The assistant will attempt to autodetect most of the values from the IFS Cloud instance where possible. However, the user will need to verify and correct them during the configuration process.

The assistant can only be used for configuring PSO tenants that are not already configured with an IFS Cloud instance.

Tasks performed by the assistant

Read more about Scheduling Optimization and Machine Learning.

Read more about Scheduling Optimization and Machine Learning Configuration.

Step 1 - IFS Cloud

Configuration ID Unique ID for the configuration when creating a new configuration. If an existing configuration is being modified this field will show the existing Configuration ID.

IFS Cloud Callback Settings

IFS Cloud Callback URL The URL of the server that hosts the SchedulingServices projection. Application will use it to infer the URL of the projection.

By default this field will get the value from system parameter 'System Url'. If the default URL is not reachable from the PSO server it must be changed to a URL that is reachable from the PSO server.
Security Realm The Security Realm used for authenticating users for the IFS Cloud instance.

By default this field will get the value from system parameter 'Namespace'. If it is not correct please change it to the correct value.
Token Endpoint The URL of the token endpoint for validating client credentials and obtaining authentication tokens.

The value for this field will be automatically set based on the IFS Cloud Callback URL and Security Realm values. It can be changed to a different value if required.

Callback Credentials

Use Existing Client If selected the assistant will create the Callback Client ID using an existing IAM Client. If not selected it will create a new IAM Client and a connected user with the relevant permissions.

This client will be used by the Scheduling Broadcast Manager in PSO to communicate with IFS Cloud, and also when IFS Scheduling Optimization is calling the PSO RESTful gateway.
Select Callback Client ID This field will be available when 'Use Existing Client' is selected. An existing Client ID must be selected from the list.

NOTE: All private clients of type 'Custom Client' will be shown in the list. It is recommended to select a client that was created specifically for Scheduling Optimization and Machine Learning Configuration.

NOTE: If a different client is selected, the assistant will update this client with the settings needed for it to work with Scheduling Optimization and Machine Learning Configuration.
New Callback Client ID This field will be available when 'Use Existing Client' is not selected. A unique ID must be entered for the new client.

NOTE: The Client ID entered should not already be used by an existing IAM Client or an IFS Cloud user account.

Synchronize Users and Roles

Synchronize Users and Roles Synchronize relevant user accounts and roles in IFS Cloud with PSO. This will activate the Users Scheduling Model dataset in Scheduling Optimization Datasets. Read more about the Users Integration.
Admin User Role Permission set for PSO Workbench Administrator users to be synchronized with the Users dataset for this configuration. Read more about the Users Integration.
Runtime User Role Permission set for PSO Workbench users to be synchronized with the Users dataset for this configuration. Read more about the Users Integration.

Step 2 - IFS Optimization Server

IFS Optimization Server

PSO Restful Gateway URL The RESTful gateway URL of the PSO installation.

Ex:-
https://<pso server address>/automation/gateway
https://<pso server address>/IFSSchedulingRESTfulGateway

The path after the domain may depend on the setting used when installing the PSO server.
PSO Workbench URL The URL for launching the PSO Workbench.

The assistant will attempt to generate a default value for this field based on the PSO Restful Gateway URL. However, if it is not generated correctly please provide the correct Workbench URL manually.
PSO Account ID The Organization ID in the PSO installation that this IFS Cloud instance is configured to connect.
Profile ID The Profile ID used in PSO. The profile can be used to define a specific set of parameters in PSO to be used together with specific Scheduling models.

The Profile ID is defined both on dataset level and configuration level. If the Profile ID is left blank on the dataset it will use the Profile ID from the configuration. Read more about Scheduling Optimization Datasets.

The Profile ID is also passed in the Users integration as some parameters (e.g. for the PSO Workbench) are set for the user, and not for the specific dataset. The same logic as above is applied when retrieving the Profile ID to use here. Read more about the Users Integration.

PSO Administrator Account

PSO Administrator User ID The User ID of the PSO tenant administrator account. This will be used by the assistant to remotely configure the PSO tenant.
PSO Administrator Password The password of the PSO tenant administrator account. This will be used by the assistant to remotely configure the PSO tenant.

Open ID Settings

Open ID Authority The URL that the PSO tenant will use to validate authentication tokens. It will be generated based on 'Token Endpoint' provided in step 1. However, it can be edited here by the user.

This value will be set to the parameter OpenIdAuthority in PSO when using the configuration assistant.
PSO Redirect URL The URL pattern of the PSO Server URL to which the login dialog will redirect after a successful login. Default value will be set based on PSO Restful Gateway URL.

This value will be added to the redirect URL list of the public IAM Client created/selected for PSO tenant.
Use Existing Client ID If selected the assistant will create the Automation Client ID using an existing IAM Client. If not selected it will create a new IAM Client with the relevant settings.

This client is used when PSO authenticate with IFS Cloud. This value will be set to the parameter OpenIdClientId in PSO when using the configuration assistant.
Select Automation Client ID This field will be available when 'Use Existing Client' is selected. An existing Client ID must be selected from the list.

NOTE: All public clients of type 'Custom Client' will be shown in the list. It is recommended to select a client that was created specifically for Scheduling Optimization and Machine Learning Configuration.

NOTE: If a different client is selected, the assistant will update this client with settings needed for it to work with Scheduling Optimization and Machine Learning Configuration.
New Automation Client ID This field will be available when 'Use Existing Client' is not selected. A unique ID must be entered for the new client.

NOTE: The Client ID entered should not already be used by an existing IAM Client. It must also be different from the Client ID used for the Callback client.