Skip to content

IFS Optimization Framework Configuration Assistant

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

Apart from the information required in Scheduling Optimization and Machine Learning Configuration, the assistant will also require the administrator username and password of the PSO account being configured. This is to remotely configure the PSO account.

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 accounts 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.

Authentication 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 'Secondary Url (external proxy 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.

The substitution variables #SYSTEM_URL# and #SECONDARY_URL# can be used to automatically retrieve the value from the corresponding System Parameter.
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.
Authentication Token URL 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.

Advanced Authentication Settings

This section is collapsed by default in the assistant. Click on the heading to expand.

IFS Cloud Callback URL Thumbprint The certificate thumbprint for the IFS Cloud Callback URL. The parameter is optional but it may be required if using a non-trusted certificate.

This value will be sent in the Broadcast Parameter url_cert_thumbprint to be used when PSO is returning data back to IFS Cloud.

See section on Certificate Thumbprints in the Administration Guide in the PSO documentation for more information.
Authentication Token URL Thumbprint The certificate thumbprint for the Authentication Token URL. The parameter is optional but it may be required if using a non-trusted certificate.

This value will be sent in the Broadcast Parameter auth_token_url_cert_thumbprint to be used when PSO is returning data back to IFS Cloud. It will also be set to the parameter OpenIdAuthorityThumbprint in PSO when using the configuration assistant. Entering a value here will automatically set the 'Open ID Authority Thumbprint' in the Open ID Settings section.

See section on Certificate Thumbprints in the Administration Guide in the PSO documentation for more information.

Authentication Client Credentials

Use Existing Client If selected the assistant will create the 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 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 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 Permissions

Synchronize Users and Permissions Synchronize relevant user accounts and permissions in IFS Cloud with PSO. This will activate the corresponding Users dataset for this configuration in Scheduling Optimization Datasets. Read more about the Users Integration.
PSO User Permission Set Permission set for PSO Workbench users to be synchronized with the Users dataset for this configuration. Read more about the Users Integration.
PSO Administrator Permission Set Permission set for PSO Workbench Administrator 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

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.
Workbench URL The URL for launching the PSO Workbench.

The assistant will attempt to generate a default value for this field based on the RESTful Gateway URL. However, if it is not generated correctly please provide the correct Workbench URL manually.
Account ID The Organization ID in the PSO installation that this IFS Cloud instance is configured to connect.

The substitution variable #IFS_REALM_NAME# can be used to automatically retrieve the value from the corresponding System Parameter 'Namespace', converted to upper case.
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 Credentials

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

Open ID Settings

Open ID Authority The URL that the PSO account will use to validate authentication tokens. It will be generated based on 'Authentication Token URL' provided in Authentication Settings. 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.
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 Restful Gateway URL.

This value will be added to the redirect URL list of the public IAM Client created/selected for PSO account.
Use Existing Client ID If selected the assistant will create the PSO 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 PSO 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 PSO 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 defined in Authentication Client Credentials.
Open ID Authority Thumbprint The certificate thumbprint for the Open ID Authority. The parameter is optional but it may be required if using a non-trusted certificate. The value is derived from 'Authentication Token URL Thumbprint' in the Advanced Authentication Settings section and cannot be edited here.

This value will be set to the parameter OpenIdAuthorityThumbprint in PSO when using the configuration assistant.

See section on Certificate Thumbprints in the Administration Guide in the PSO documentation for more information.