IFS CPQ Integration¶
The purpose of this page is to provide details needed to set up IFS CPQ integration. This CPQ solution is provided by integrating IFS Cloud with an external application. Following are the main areas requiring configuration.
- IFS Connect setup for integration with CPQ
- Integration parameter configuration required for CPQ business flows
- Single Sign-On (SSO) setup
- Integration user setup
- Managing CPQ users
- Launching CPQ
IFS Connect¶
The necessary IFS Connect elements for IFS CPQ are already available with minimal configuration to do.
The Routing Address must be updated with CPQ API client credentials provided during provisioning for the respective CPQ customer environment. This setup is required to invoke REST API calls to CPQ within business flows.
- Navigate to Rest Addresses page in IFS Cloud.
- Select the routing address Routing_Addresses_CPQ.
- Update the following fields in the REST Address Data section.
- Client Id
- Client Secret
More on IFS Connect here.
Integration Parameters¶
Integration Parameters are required to execute business flows in CPQ.
Follow the below steps to configure Integration Parameters.
- Navigate to Integration Parameters for CPQ page.
- Edit and configure the required parameter values.
The following parameters must be configured.
- MANUFACTURER_ID – CPQ environment name / customer name
- URL_DOMAIN – Custom domain created in CPQ for SSO
- ADMIN_CONTACT_ID – ID of an admin user in CPQ used for user management
- CPQ_END_USER_ROLE – Role assigned to standard users in CPQ
- CPQ_ADMIN_USER_ROLE – Role assigned to design studio users in CPQ
The parameter values for MANUFACTURER_ID, URL_DOMAIN and ADMIN_CONTACT_ID must be fetched from CPQ after configurations are done.
The paramters CPQ_END_USER_ROLE, CPQ_ADMIN_USER_ROLE will have default values to which roles in CPQ will be created. If different names are used in CPQ, then integration parameters should be updated.
Integration User¶
An IAM client named IFS_cpq is available for the external CPQ app to access IFS APIs such as CPQ Configuration Service.
This client must be used by CPQ to obtain access tokens when communicating with IFS APIs.
An integration user CPQ_SERVICE_USER is linked to this client and granted required projection access. However all companies and sites the customer will be using for this solution must be granted accees prior to using the solution. Follow the below steps to grant access to companies and sites.
Configure Companies¶
- Navigate to User Companies page.
- Select user CPQ_SERVICE_USER.
- Click Add Companies.
- Add all relevant companies for the integration.
Configure Sites¶
- Navigate to Sites Per User page.
- Select user CPQ_SERVICE_USER.
- Connect all sites for a company or add specific sites manually.
Users and Permissions¶
Assign Permission Sets¶
IFS CPQ supports two permission sets for the below user roles.
- Standard User → CPQ_User
- Admin User → CPQ_ADMIN
Follow the below steps to assign the relevant permission set.
- Navigate to User page.
- Open User Permissions subpage.
- Go to Direct Grants tab.
- Click Grant Permission Sets.
- Select the appropriate permission set.
Note: Ensure the user has a valid email address, Enable IFS Login set to Yes and a linked person record.
Create CPQ Users¶
Users must be created in CPQ prior to using the solution. The IFS CPQ solution will only be enabled for active CPQ Users.
Note: Ensure ADMIN_CONTACT_ID integration parameter is configured before proceeding.
Follow the below steps to Manage CPQ Users.
- Navigate to CPQ Users page.
- Add a desired user you want to grant access to.
Enable Admin User toggle if admin privileges are required.
After adding users. User status will be the following:
- User Status → Created
- Synchronization Status → Out of Sync
After you add all the desired users click Synchronize Users to:
- Create users in CPQ
- Synchronize existing users
Disable / Enable Users¶
- Disabling a user → Archives the user in CPQ
- Enabling a user → Unarchives the user in CPQ
Configuration During CPQ Provisioning¶
Additional configurations are required during CPQ provisioning. These are typically handled by a CPQ consultant.
This includes:
- Setting up Auth0 connection for SSO
- Whitelisting IFS domains to enable loading CPQ in IFS Cloud plugin
- Configuring webhooks and other configurations to invoke IFS APIs
Single Sign-On (SSO)¶
This integration supports Single Sign-On (SSO), allowing users to authenticate once in IFS and automatically gain access to CPQ using Authorization Code Flow.
To set up SSO the following configurations are needed.
Auth0 Connection in CPQ¶
An Auth0 connection must be configured to exchange authentication tokens between IFS and CPQ. This will be done as part of provisioning.
An IFS IAM Client with direct access grants and OIDC discovery URL is required.The standard IAM Client IFS_cpq_auth_sso is used for this purpose.
You will need to provide CPQ with:
- Client ID
- Client Secret
- OIDC Discovery URL
The OIDC discovery URL follows this format:
https://<BASE_URL>/auth/realms/<NAMESPACE>/.well-known/openid-configuration
Note: The OIDC configuration endpoint must be publicly accessible.
Custom Domain in CPQ¶
This step also should be performed during provisioning.
A custom domain needs to be created in CPQ, and this domain needs to be linked to the above configuration done in Auth0. Any request routing through this sub domain will be validated for a valid IFS Authentication token.
All requests routed through this csutom domain will validate IFS authentication tokens. This custom domain will be used by IFS Cloud when loading CPQ via the plugin, so that a logged in IFS Cloud user will be able to access CPQ without logging into CPQ.
- Navigate to System Settings in CPQ.
- Go to Platform custom domain & authentication section.
Add a custom domain with:
- SSL certificate
- SSO enabled
Note: The configured custom domain must be updated in the URL_DOMAIN integration parameter to enable SSO in the IFS plugin.
Launch CPQ¶
Ensure all configurations are completed before proceeding with the launch.
Prerequisites¶
- URL_DOMAIN parameter is correctly configured
- Browser cookies are enabled
- Above integration configuration steps are done
Steps to Verify¶
- Log in using a configured CPQ Admin user.
- Navigate to CPQ Management → CPQ Setup → Configurator Setup for CPQ
- You should see the Configurators page loaded within the IFS plugin, automatically authenticated using IFS credentials.