SSO Configuration
In the sso.conf file, under sso_Config, an applications section contains a section for configuration of each option corresponding to the Application Type field on the QuickLink Library page. The name of the config property under applications should match exactly with the Application Type display value from the QuickLink library page. The Application Type field is only displayed if the enabled property for the ssoForExternalApplication flag in the feature.conf file is true and External Application is selected in the Type field on the QuickLink Library. The values in the Application Type field depend on the enabled property (design flag) of each application in the sso.conf file. For example, the design flag for Pentaho in baseline has enabled set to false; therefore, the Pentaho option will not be available in the Application Type field.
The following application types are applicable to Advantage Intelligence. Refer to the "SSO Configuration" topic in the CGI Advantage System Administration Guide for information on properties for other Application Types.
To set up a QuickLink to Advantage Assistant, the following properties must be set up in the sso.conf file
|
Property |
Sub Property |
Default Value |
Description |
|---|---|---|---|
|
enabled |
|
false |
This is the design flag for adding Advantage Assistant to the Application Type field on the QuickLink Library. If the enabled property is true, then Assistant is listed as a value for the Application Type field on the QuickLink Library. If the enabled property is false, then Assistant is not listed as a value for the Application Type field on the QuickLink Library. |
|
base_url |
|
|
N/A |
|
header_method_type |
|
POST |
Indicates the Request Type (that is, GET or POST), which the Assistant application request supports. |
|
logout_url |
|
|
N/A |
|
securityKey |
|
|
N/A |
|
className |
|
adv.ui.externalApp.Assistant |
This value should not be changed. This class obtains the Assistant URL and tenant name from the server.conf file and encodes the tenantname using csf based authentication token. The token will be sent as part of the sso request. |
|
additionalParameters |
|
|
N/A |
If your site utilizes the EngageHub platform, then the following properties must be updated:
|
Property |
Sub Property |
Default Value |
Description |
|---|---|---|---|
|
enabled |
|
false |
This is the design flag for adding EngageHub to the Application Type field on the QuickLink Library (QUICKLNK). If the enabled property is true, then EngageHub is listed as a value for the Application Type field on the QuickLink Library. If the enabled property is false, then EngageHub is not listed as a value for the Application Type field on the QuickLink Library. |
|
base_url |
|
|
Provide the URL of the EngageHub application. This URL opens in a new window. |
|
header_method_type |
|
POST |
Indicates the Request Type (that is, GET or POST), which the EngageHub application request supports. This value should not be changed. |
|
logout_url |
|
|
N/A |
|
securityKey |
|
|
N/A |
|
className |
|
adv.ui.externalApp.EngageHub |
Class that executes Key Cloak token generation to log into EngageHub. This value should not be changed. |
|
additionalParameters |
|
|
This section contains any additional parameters, other than base_url that are required to access the Third-Party application. |
|
connectTokenAPI |
accesstoken |
This parameter is required to get the Connect access token. This value should not be changed. |
|
|
keyCloakTokenAPI |
keycloakToken/enUserId |
This parameter is required to get the Key Cloak token. This value should not be changed. |
|
|
appListAPI |
appList |
This parameter is required to retrieve the list of available applications. The value should not be altered. |