Integrations

You can set up the integration of various add-ons to add more functionality to Varicent Incentives

Setting up the Varicent ELT integration (beta)

Note

This integration is currently in a beta release.

If you haven't already registered for a Varicent ELT account, please contact your CSM or open a Support ticket to do so.

Varicent ELT integration with Incentives can be done in two ways:

Through Model settings, on the Integrations tab
When you import data from Varicent ELT through the Composer module
When you import data from Varicent ELT through the Data module

To perform integration through Model settings Settings Icon , do the following:

In Incentives, from the admin panel, click Model settings → Integrations.
From the Varicent ELT tab, type in your Varicent ELT domain, username, and password.
Tip
You need to add 'api' to the domain name. For example, if you use https://elt.varicent.com, you need to type https://api.elt.varicent.com instead.
Enter your Varicent ELT API key, found in your Varicent ELT environment, under Account, Generate API keys.
Click Save.

Setting up Varicent Sales Planning integration

Note

For successful integration, the user has to be connected in both Varicent Sales Planning and Incentives.

If you haven't already registered for a Varicent Sales Planning account, please contact your CSM or open a Support ticket to do so.

To perform the above integration, do the following:

In Incentives, from the admin panel, click Model settings → Integrations.
From the Sales Planning tab, choose a tenant from the Sales Planning Tenant ID drop-down.
Click Save.

Getting Ask Varicent

Open a Support case to add Ask Varicent Assistant to your model so users can get help from Ask Varicent when in Sales Portal and Varicent Mobile.

This Ask Varicent Assistant instance comes with pre-designed dialog and integrates with Incentives to access your data and provide smart answers to questions.

You can get an overview of the basic functions of Ask Varicent in the Sales Portal with 'Ask Varicent' topics.Sales Portal with 'Ask Varicent'

From the Support portal, click Open a Case.
In the Title field, put "Ask Varicent Assistant Provisioning".
In the Description field, include this information:
1. Models
  Ask Varicent is integrated for each model you list.
2. Email addresses
  Each user you list is given access to the IBM Cloud account where you can see your Watson Assistant service.
3. Data center
  The default data center for the Ask Varicent assistant is in Dallas, US. If you want to use a different data center, specify that in your Support case. For a list of data centers, visit https://cloud.ibm.com/docs/assistant?topic=assistant-services-information.
4. You will receive a confirmation after the Ask Varicent Assistant is provisioned and integrated with your models.
Once you have received confirmation of provisioning, go to Incentives.
From the admin panel, click Model settings → Integrations.
Select Ask Varicent.
Enable the Assistant. You can also choose to customize the Ask Varicent assistant's name.

Changing the display name for Ask Varicent

This option lets you choose a custom display name for Ask Varicent.

To see these changes, you must have Ask Varicent enabled on your model. To add Ask Varicent to your model, read: Getting Ask Varicent.

From the admin panel, click Model settings → Integrations → Ask Varicent.
If it's not already selected, select the Enable Assistant checkbox.
Select the Use Custom Name checkbox.
Type the name you want to be displayed in Sales Portal.
Tip
The word 'Ask' will always appear before the name you type. For example, if you type 'Data' in the custom name field, it will display as 'Ask Data' in Sales Portal.
Click Save.

When you log in to Sales Portal, you will see your custom name when you click the Ask Varicent icon.

SAML 2.0 integration

You can use SAML 2.0 integration with Varicent Incentives.

SAML 2.0 integration with your IdP is configured across the Incentives tenant and applies to every model in the same tenant. SAML 2.0 integration can not be configured per model on the same tenant.

The login page requires that the user input a login ID, which determines if it's a native Incentives account or integrated with SAML 2.0, which in turn directs the application to the appropriate authentication method.

Integrating SAML 2.0 with the Admin Client application

You configure SAML 2.0 integration with your IdP and the Varicent Incentives Admin Client application.

To enable SAML 2.0 integration, log a ticket with Varicent Support and indicate in the subject line and description that you want to enable SAML 2.0 integration.

Provide your IdP metadata.
This must include the login URL, the logout URL, and the signing or encryption certificate.
We will send you the SP URL, which is the URL that you use to access Incentives, and the signing certificate.
You can choose the nameID format. By default, it is name-id-format-unspecified.
Choose whether to allow unencrypted SAML assertions or encrypted.

You can now set up each user's IdP identification.

Setting up IdP identification for admin users

If SAML 2.0 integration is enabled for Varicent Incentives, you must set up each user's IdP identification in the Admin Client application.

From the admin panel, click the model drop-down, and click Tenant settings.
Click Admin users → Overview tab.
In the Manage admins table, click the more options menu (...) for the admin you need to set IdP identification for, and then click Edit admin.
Enable the Use native login when SAML2.0 integration is enabled toggle.
Enter the user's SAML2.0 integration name ID.
Click Save.
Repeat steps 3 to 6 for each admin user.

Using native login with SAML 2.0 integration

If SAML 2.0 integration is configured with the Admin Client application, you can choose to use the native login instead of SSO authentication.

When SAML 2.0 integration is configured, all users must use SSO authentication to access Incentives by default. However, you can choose to allow specific users to use the native login instead.

From the admin panel, click the model drop-down, and click Tenant settings.
Click Admin users → Overview tab.
In the Manage admins table, click the more options menu (...) for the admin you want to enable original login for, and then click Edit admin.
Enable the Use native login when SAML2.0 integration is enabled toggle.
Click Save.

Salesforce.com and Sales Portal integration

You can make the Varicent Incentives Sales Portal accessible from a tab within Salesforce.

In your model, you must create a payee that has the same email address as the user logging into Salesforce.com. That payee must be added to a workflow group and enabled for web access. The Sales Portal must also be deployed.

In Salesforce.com, the email that the user has set up in the My Profile → Contact section must match the email they use to sign in to the Incentives Sales Portal.

Log in to Salesforce.com with a user ID that has administrative rights.
Click your user-name to access the drop-down menu, and select Setup.
From the App Setup section, click Create → Tabs.
Click New in the Web Tabs section.
This allows you to create a custom tab that displays Incentives content inside the Salesforce.com window.
You can select one of the following options:
Option
Description
Full page width
Uses the full page width to display the Incentives Sales Portal.
2 columns with Salesforce sidebar
This option displays the Salesforce.com sidebar.
Click Next after you have made your selection.
Define the content and display properties for the Incentives tab by completing the following steps:
1. In the Tab Content Definition section, select URL from the Tab Type menu.
2. In the Tab Label field, enter the text that you want displayed on the label.
3. In the Tab Name field, give the tab a unique name. This can be the same as the tab label.
4. Choose the color of your tab by selecting a Tab Style from the styles screen.
5. The Content Frame Height field allows you to indicate how tall (in pixels) the Incentives content frame will be.
  Specify a frame height of at least 800 pixels.

Option	Description
Full page width	Uses the full page width to display the Incentives Sales Portal.
2 columns with Salesforce sidebar	This option displays the Salesforce.com sidebar.

In the URL field, paste this string, replacing the parameters as needed:

https://URL/sforce_composite_login?SessionId={!API.Session_ID}&ServerURL={!API.Partner_Server_URL_540}&Tenant=TENANTNAME&Model=MODELNAME

Parameter	Description
`URL`	This is the URL users access the Sales Portal from. It usually follows a format of `companyname.spm.varicent.com/payeewebv2`.
`TENANTNAME`	This is the name of your tenant. If you don't know your tenant name, contact Support.
`MODELNAME`	This is the name of your model.

Parameter

Description

URL

This is the URL users access the Sales Portal from.

It usually follows a format of companyname.spm.varicent.com/payeewebv2.

TENANTNAME

This is the name of your tenant.

If you don't know your tenant name, contact Support.

MODELNAME

This is the name of your model.

Set the encoding to Unicode (UTF-8).
Click Save.

The Incentives Sales Portal is now accessible from the newly created tab. When you click the tab, you are logged into the Sales Portal as the user with the same email address as the Salesforce.com user using SSO.

Note

If you receive the Salesforce authentication is disabled error message, follow these steps:

Open a Support ticket.
Provide your Salesforce production URL:
- If you're familiar with Salesforce Apex or Salesforce Flow tools, you can use either to find this information from the Partner_Server_URL_540 variable you used to create the web tab
- If you're unfamiliar with accessing this variable, Incentives Support can help you

Setting up a Varicent Tab on Salesforce Mobile

To access Varicent tabs on the Salesforce mobile app, you must create a Visualforce page and configure it with a link to Sales Portal. Then, you can create a Visualforce tab so users can find it in the Salesforce mobile app.

By default, the view is the same as Sales Portal on desktop, but you can choose to disable the navigation bar and link to a specific report instead.

What's different in Salesforce Mobile?

There are some cases where Incentives web tabs on Salesforce mobile behave differently or are limited in some way when compared to the desktop experience. You should keep this in mind when setting up this integration.

You cannot download files. This includes trying to download files from the Message Center or trying to export reports to PDF or Microsoft Excel.
Some fonts may not display correctly on some mobile devices. This depends on the operating system. For example, iOS does not support Tahoma.
For a list of iOS-supported fonts, see: https://developer.apple.com/fonts/system-fonts/.
If a particular font is not available on the user's device, Inter will be used instead. This is same font used in the admin application.
The user is authenticated every time the web tab is accessed. This can make it seem like reports take longer to load when compared to the desktop application.
On iOS devices, the Freeze header option on data grids does not work.
Some report content can appear cut-off if there is limited padding on the report.
Performance can vary depending on the mobile device and OS. Generally, a newer device will load Incentives reports faster than an older one. The difference in loading times is more noticeable in reports with a large amount of data.

Creating a Visualforce page

Log in to Salesforce.
Click your username and then click Setup.
From the sidebar, under the Develop section, click Visualforce Pages.
Click New.
Enter a label and page name.
Select the Available for Lightning Experience, Lightning Communities, and the mobile app checkbox.

In the Visualforce Markup section, replace the default code with this code:

<apex:page showHeader="false" standardStylesheets="false" sidebar="false" applyHtmlTag="false" applyBodyTag="false" docType="html-5.0" >    
    <apex:pageblock >        
        <apex:iframe src="https://rti.spm.varicent.com/payeeweb/sforce_composite_login?SessionId={!$Api.Session_ID}&ServerURL={!$Api.Partner_Server_URL_210}&Tenant=rti&Model=rtiprod" scrolling="true" id="theIframe" style='position:absolute; top:0px; left:0px; width:100%; height:100%; z-index:999'/>    
    </apex:pageblock>
</apex:page>

Update apex:iframe src , replacing https://rti.spm.varicent.com/payeeweb/ with the URL of your company's Sales Portal instance.
Update serverURL, replacing {!$Api.Partner_Server_URL_210} with the URL of the Visualforce page you set up.
Update Tenant , replacing rti with your Incentives tenant name.
Update Model , replacing rtiprod with your Incentives model name.

Click Save.

If you want users to be able to see the same reports that they would have access to on desktop, proceed to Creating a VisualForce tab.

If you want users to be able to see specific reports only, follow the directions in Creating a direct link to a Varicent web tab.

Creating a direct link to a Varicent web tab

By creating a link to a specific web tab, instead of users arriving at the home page that they would see on desktop, a direct link disables the navigation bar so they can only access the report you specify.

With this set up, users are also unable to make inquiries on reports.

To create a direct link, you'll add an extra piece of code on Step 7 of Creating a Visualforce page after the Model name.

The code varies slightly depending on whether you use Payee Web Classic or the newer version of Sales Portal and what type of web tab you're linking to.

You can find the ID or number of the tab you want to link to by going to that report in Sales Portal and checking the part of the URL that follows payeeweb or payeewebv2. If you're setting up a Direct Link web tab, you can get the ID directly from Portal Access.

For web form tabs in Payee Web Classic, add this code: &nextPath=webforms/index.html?tabId=#, replacing # with the tabID for the web form you want to link to.