One moment please...
 
 
Exact Synergy Enterprise   
 

Federated Identity Configurator

Introduction

Note:

  • This document is only relevant to the controlled release participants.
  • This is not available for Exact Cloud customers.

The Federated Identity Configurator is a stand-alone tool to create and manage the federated identity configuration files for Exact Synergy Enterprise (ESE), Exact Globe+, and Exact Lightweight Integration Server (ELIS). You should use this tool when configuring any of the above products to use federated identity authentication, and as part of the product update process. It should also be used to test and verify if authentication with the selected identity provider is working correctly.

How do I start the Federated Identity Configurator?

  1. Open the Cab folder of the Exact Synergy Enterprise or Exact Globe+ installation folder.
  2. Locate the file FIDConfigurator.exe.
  3. Start FIDConfigurator.exe.

Note:

  • The tool requires read and write access to the installed folders of Exact software. Therefore, it is recommended the tool be used with Administrator privileges.
  • You can use the tool directly from the installation folder, or you can copy it to your machine and use it locally.

How do I validate the federated identity configuration details?

  1. Start FIDConfigurator.exe. Run as administrator to ensure the tool has sufficient rights to create or edit the files. The Federated Identity Configurator screen will be displayed.
  2. Select the product you want to configure from the Products menu on the left.
  3. Type or select the installation directory of the product at Installation Folder. When a path is specified, the tool will validate the path. If the path is validated successfully, the configuration section and buttons will be enabled.
  4. At Identity Provider, select the identity provider for this product.
  5. Define all the necessary information from your account with the identity provider.
  6. Click Validate to validate the entered information. The validation screen will be displayed.
  7. The values from the product screen will be checked for common mistakes, such as formatting, typos, et cetera. The tool will warn you when a value is suspected to be wrong so that you can verify and correct it if needed.
  8. Type a username and password (from your federated identity account) to test if the configuration values are correct for authentication use.
  9. Click Validate.
  10. The test results may include error messages for a failed authentication, or expiry dates for a successful authentication.

How do I generate the federated identity configuration files?

  1. Start FIDConfigurator.exe. Run as administrator to ensure the tool has sufficient rights to create or edit the files. The Federated Identity Configurator screen will be displayed.
  2. Select the product you want to configure from the Products menu on the left.
  3. Type or select the installation directory of the product at Installation Folder. When a path is specified, the tool will validate the path. If the path is validated successfully, the configuration section and buttons will be enabled.
  4. At Identity Provider, select the identity provider for this product.
  5. Define all the necessary information from your account with the identity provider.
  6. Click Validate to validate the entered information. For more information, see How do I validate the federated identity configuration details?.
  7. Click Generate.
  8. The federated identity configuration files will be generated in the installation folder for the product. It will also be retained for future product updates.

Note:

  • All values are case-sensitive and in accordance to the FID configuration in the identity provider’s respective portal.
  • Depending on the product, you may need to restart product-related services after generating the files.
  • Only after a successful validation, the configuration files can be generated.

How do I use the tool during the update of a product?

If you are updating a product that has been configured for federated identity, you should also use the Federated Identity Configurator to ensure your configurations are retained. Before performing product update, ensure the configuration can be retained.

  1. Start FIDConfigurator.exe. Run as administrator to ensure the tool has sufficient rights to create or edit the files. The Federated Identity Configurator screen will be displayed.
  2. Select the product you want to update from the Products menu on the left.
  3. Type or select the installation directory of the product at Installation Folder. When a path is specified, the tool will validate the path. If the path is validated successfully, the configuration section and buttons will be enabled.
  4. At Identity Provider, select the identity provider for this product.
  5. Define all the necessary information from your account with the identity provider.
  6. Click Validate to validate the entered information. For more information, see How do I validate the federated identity configuration details?.
  7. Click Generate.
  8. When the message “Configuration successfully generated” is displayed, proceed to perform the update of your product(s).
  9. After you have completed the update of your product(s), start FIDConfigurator.exe again to re-apply the configuration.
  10. Select the product you have updated from the Products menu on the left.
  11. Type or select the installation directory of the product at Installation Folder.
  12. The federated identity configuration for the product will be displayed, along with the message "This environment was previously configured for FID. The details have been restored. Please click 'Generate' to restore".
  13. Click Validate.
  14. Click Generate to re-apply the configuration to the product.

Note: Depending on the product, you may need to restart product-related services after generating the files.

How do I test the connection between the client environment and server environment?

  1. Start FIDConfigurator.exe.
  2. Click Client/Server at the Tools menu on the left.
  3. Select the client environment at Connect from.
  4. Select the server environment at to.
  5. Define the username used to log in to the client environment and server environment at Username.
  6. Define the password used to log in to the client environment and server environment at Password.
  7. Click Validate.

Fields

Buttons

     
 Main Category: Attachments & notes  Document Type: Online help main
 Category:  Security  level: All - 0
 Sub category:  Document ID: 28.296.971
 Assortment:  Date: 19-02-2023
 Release: 261  Attachment:
 Disclaimer

Attachments
ESE-OH262-Federated Identity Configurator02.docx 29.8 KB View Download