No ratings
ManjuKumari
Saviynt Employee
Saviynt Employee

 

Disclaimer

The integration was either created by Saviynt or by Saviynt community users . The integration is available “as is” and fall under standard connectors support for REST, SOAP, JDBC, LDAP, PowerShell, Jar and Saviynt Connector Framework. 

 

Note: Contributor - Manju Kumari

 

Preface

This guide describes the integration between Saviynt Enterprise Identity Cloud (EIC) and Qualtrics .

Audience

This guide is intended for administrators and target application integration teams responsible for implementing a secure integration service with Qualtrics .

Introduction

Qualtrics is an online survey and data collection software platform. It is used across many domains in both academia and industry for online surveys and research. While users can manually download survey responses from Qualtrics through a browser, importing this data into R is then cumbersome.Qualtrics is web based software that allows the user to create surveys and generate reports without having any previous programming knowledge.

The Qualtrics connector enables you to seamlessly integrate with Qualtrics to manage user lifecycle and govern access to their Groups and Roles.

For more information about different connectors in EIC, see  Saviynt Enterprise Identity Cloud Connectors.

Note: This guide provides information about using the Qualtrics REST connector using REST API for performing operations listed in the Supported Features.

Supported Features

The Qualtrics integration supports the following features:

 
ManjuKumari_5-1683288901632.png

 

Supported Software Versions

 

 

Software

Version

EIC

Release v4.5 and later

 

Understanding the Integration between EIC and Qualtrics

You must create an integration between EIC and the collaboration platform hosted by the target application to perform import, provisioning, and deprovisioning tasks. The following components are involved in the integration:

  • The Complete Service Management platform Qualtrics combines ITSM with ESM and SIAM capabilities, enabling all internal departments, such as IT, HR, and Facilities, as well as external service providers and customers, to collaborate securely and seamlessly on one complete platform, reducing complexity and improving productivity.

  • Objects are imported as entitlement types into EIC.

  • Security System represents the connection between EIC and the target application.

    • It comprises of an endpoint, which is the target application for which you want EIC to manage the identity repository.

    • It provides application instance abstraction from connectivity including high-level metadata. For more information about creating a security system, see Creating a Security System.

  • Endpoint is an instance of an application within the context of a security system.

    • It is the target application or application from which the connector imports the data and performs provisioning or deprovisioning of identity objects, such as users, accounts, and entitlements.

    • It is mandatory to create an endpoint after creating the security system.
      You can associate a single security system with multiple endpoints if the deployment involves modelling of multiple isolated virtual applications (based on sets of specific entitlements according to certain categories) within a single application instance. For more information about creating an endpoint, see Creating an Endpoint for the Security System.

  • Connector is a software component that enables communication between EIC and the target application. It provides a simplified integration mechanism where in some instances you only need to create a connection with minimal connectivity information for your target application. The REST connector is used for importing, provisioning accounts and access through the REST APIs. For more information about creating a connection, see Creating a Connection.

  • Job Scheduler is a software component that executes a job based on the configured schedule to perform import or provisioning operations from EIC.
    When a provisioning job is triggered, it creates provisioning tasks in EIC. When these tasks are completed, the provisioning action is performed on the target application through the configured connector. If you want to instantly provision requests for completing the tasks without running the provisioning job, you must enable Instant Provisioning at the security system level and the Instant Provisioning Tasks global configuration. For more information about the jobs used by the connectors in the Qualtrics integration.

Integration Architecture

EIC uses a REST connection for integrating with Qualtrics for importing data and for performing provisioning and deprovisioning tasks.

The following diagram illustrates the integration architecture and communication with the target application

ManjuKumari_6-1683288964172.png

 

Setting Up the Integration

Prerequisites

Perform the following steps to Generate & Setup token authentication

  1. Log in to the Qualtrics portal using administrator credentials.

  2. An API key is a token that you provide when making API calls. Include the token in a header parameter called X-API-TOKEN. 

  3. You can now authorize requests using the access token.

  4. You can revoke the tokens at any time from the Qualtrics user interface.

 

Creating a Connection

Connection refers to the configuration setup for connecting EIC to target applications. For more information about the procedure to create a connection, see Creating a Connection.

Understanding the Configuration Parameters

While creating a connection, you must specify connection parameters that the connector uses to connect with the target application, define the type of operations to perform, the target application objects against which those operations are performed, and the frequency of performing them. In addition, you can view and edit attribute mappings between EIC and the target application, predefined correlation rules, and provisioning jobs and import jobs.

Configuration Parameters for Account and Access Import

The connector uses the following parameters for creating a connection and for importing account and access from the target application:

Connection Parameters
 

Parameter

Description

Example Configuration

Mandatory?

 

 

Connection Name 

Specify the name to identify the connection.

-

Yes

 

 

Connection Description

Specify the description for the connection.

-

No

 

 

Connection Type

  • Select the connection type as “Qualtrics (REST)”

  • If the “Qualtrics (REST) connection type is not present in your tenant then import the connection package using T2P

  • You can also create a new connection with type “REST” and use the JSONS specified in this document.

-

Yes

 

 

Default SAV Role 

Specify this parameter to assign the SAV role for the connection.

The SAV role is a role in EIC that assigns specific access to users.

This parameter is valid only for importing users.

Sample value: User assigned with the ROLE_ADMIN role, has access to all the sections of EIC.

-

No

 

 

Email Template

Specify this parameter to select an email template for sending notifications.

Email templates provide immediate trigger of emails to a user based on actions performed. Email informs user about the action performed and if critical, needs immediate action from the user.

-

No

 

 

ConnectionJSON

Specify this parameter to create a connection.

 

Note: Update INSTANCENAME & TOKEN as per your Qualtrics details.

Use the following format to connect to the Qualtrics application:

 
{
"authentications": {
"acctAuth": {
"authType": "oauth2",
"url": "https://@INSTANCENAME@.qualtrics.com/oauth2/token",
"httpMethod": "POST",
"httpParams": {},
"expiryError": "ExpiredAuthenticationToken",
"retryFailureStatusCode": [
401
],
"timeOutError": "Read timed out",
"errorPath": "error",
"maxRefreshTryCount": 5,
"tokenResponsePath": "",
"tokenType": "",
"authHeaderName": "X-API-TOKEN",
"accessToken": "@TOKEN@"
}
}
}

 

 

Yes

 
Import Parameters
 

Parameter

Description

 

Recommended Configuration

Mandatory?

AccountEntImport JSON

 
{
"accountParams": {
"connection": "acctAuth",
"processingType": "SequentialAndIterative",
"statusAndThresholdConfig": {
"statusColumn": "customproperty5",
"activeStatus": [
"active"
],
"deleteLinks": true,
"accountThresholdValue": 1000,
"correlateInactiveAccounts": false,
"inactivateAccountsNotInFile": true,
"deleteAccEntForActiveAccounts": true
},
"call": {
"call1": {
"callOrder": 0,
"stageNumber": 0,
"http": {
"url": "https://@INSTANCENAME@.qualtrics.com/API/v3/users",
"httpHeaders": {
"X-API-TOKEN": "${access_token}",
"Accept": "application/json"
},
"httpContentType": "application/json",
"httpMethod": "GET"
},
"listField": "result.elements",
"keyField": "accountID",
"colsToPropsMap": {
"accountID": "id~#~char",
"name": "username~#~char",
"displayName": "email~#~char",
"customproperty1": "divisionId~#~char",
"customproperty2": "firstName~#~char",
"customproperty3": "lastName~#~char",
"customproperty4": "userType~#~char",
"customproperty5": "accountStatus~#~char"
}
}
}
},
"entitlementParams": {
"connection": "acctAuth",
"processingType": "SequentialAndIterative",
"entTypes": {
"Group": {
"entTypeOrder": 0,
"entTypeLabels": {},
"call": {
"call1": {
"connection": "acctAuth",
"callOrder": 0,
"stageNumber": 0,
"http": {
"url": "https://@INSTANCENAME@.qualtrics.com/API/v3/groups",
"httpHeaders": {
"X-API-TOKEN": "${access_token}",
"Accept": "application/json"
},
"httpContentType": "application/json",
"httpMethod": "GET"
},
"listField": "result.elements",
"keyField": "entitlementID",
"colsToPropsMap": {
"entitlementID": "id~#~char",
"entitlement_value": "name~#~char"
},
"disableDeletedEntitlements": true
}
}
}
}
},
"acctEntParams": {
"connection": "acctAuth",
"entTypes": {
"Group": {
"call": {
"call1": {
"callOrder": 0,
"stageNumber": 0,
"processingType": "httpEntToAcct",
"http": {
"httpHeaders": {
"X-API-TOKEN": "${access_token}"
},
"url": "https://@INSTANCENAME@.qualtrics.com/API/v3/groups/${id}/members",
"httpContentType": "application/json",
"httpMethod": "GET"
},
"listField": "result.elements",
"entKeyField": "entitlementID",
"acctIdPath": "id",
"acctKeyField": "accountID"
}
}
}
}
}
}

 

Yes

 
Configuration Parameter for Provisioning
 

Parameter

Description

 

Recommended Configuration

Support for Binding Variables?

Support for Java Ternary Operations?

CreateAccountJSON

Specify this parameter to create an account in the target application.

 Note: update password

Use the following format to create accounts using the Qualtrics application:

 
{
"accountIdPath": "call1.message.result.id",
"responseColsToPropsMap": {},
"call": [
{
"name": "call1",
"connection": "acctAuth",
"url": "https://@INSTANCENAME@.qualtrics.com/API/v3/users",
"httpMethod": "POST",
"httpParams": "{\"username\":\"${user.username}\",\"firstName\":\"${user.firstname}\",\"lastName\":\"${user.lastname}\",\"userType\":\"${user.customproperty4}\",\"email\":\"${user.email}\",\"password\":\"${password}\",\"language\":\"es\"}",
"httpHeaders": {
"X-API-TOKEN": "${access_token}",
"Accept": "application/json"
},
"httpContentType": "application/json",
"successResponses": {
"statusCode": [
200,
201
]
}
}
]
}

The bindings supported are:

  • ServiceAccountOwnerMap

  • endpoints

  • accountName

  • userManager

  • approvers

  • arsTasks/task

  • managerAccount

  • password

  • requestid

  • response

  • connection

  • userAccount

  • requestAccessAttributes/reqAttrs

  • businessJustification

  • user

Yes

Update Account JSON

Specify this parameter to update an account in the target application.

Use the following format to update accounts using the Qualtrics application:

 
{
"call": [
{
"name": "call1",
"connection": "acctAuth",
"url": "https://@INSTANCENAME@.qualtrics.com/API/v3/users/${account.accountID}",
"httpMethod": "PUT",
"httpParams": "{\"firstName\":\"${user.firstname}\",\"lastName\":\"${user.lastname}\",\"email\":\"${user.email}\"}",
"httpHeaders": {
"X-API-TOKEN": "${access_token}",
"Accept": "application/json"
},
"httpContentType": "application/json",
"successResponses": {
"statusCode": [
200,
201
]
}
}
]
}

The bindings supported are:

  • ServiceAccountOwnerMap

  • endpoints

  • accountName

  • userManager

  • approvers

  • arsTasks/task

  • managerAccount

  • password

  • requestid

  • response

  • connection

  • userAccount

  • requestAccessAttributes/reqAttrs

  • businessJustification

  • user

Yes

AddAccessJSON

Specify this parameter to add access to an account.

 

Use the following format to add access using the Qualtrics application:

 
{
"call": [
{
"name": "Group",
"connection": "acctAuth",
"url": " https://@INSTANCENAME@.qualtrics.com/API/v3/groups/${entitlementValue.entitlementID}/members",
"httpMethod": "POST",
"httpParams": "{\"userId\":[\"${account.accountID}\"]}}",
"httpHeaders": {
"X-API-TOKEN": "${access_token}",
"Accept": "application/json"
},
"httpContentType": "application/json",
"successResponses": {
"statusCode": [
200,
201
]
}
}
]
}

The bindings supported are:

  • ServiceAccountOwnerMap

  • endpoints

  • accountName

  • userManager

  • approvers

  • arsTasks/task

  • managerAccount

  • password

  • requestid

  • response

  • connection

  • userAccount

  • requestAccessAttributes/reqAttrs

  • businessJustification

  • user

Yes

RemoveAccessJSON

Specify this parameter to remove access from an account.

Use the following format to remove access using the Talend application:

 
{
"call": [
{
"name": "Group",
"connection": "acctAuth",
"url": "https://@INSTANCENAME@.qualtrics.com/API/v3/groups/${entitlementValue.entitlementID}/members/${account.accountID}",
"httpMethod": "DELETE",
"httpHeaders": {
"X-API-TOKEN": "${access_token}",
"Accept": "application/json"
},
"httpContentType": "application/json",
"successResponses": {
"statusCode": [
200,
201
]
}
}
]
}

 

The bindings supported are:

  • ServiceAccountOwnerMap

  • endpoints

  • accountName

  • userManager

  • approvers

  • arsTasks/task

  • managerAccount

  • password

  • requestid

  • response

  • connection

  • userAccount

  • requestAccessAttributes/reqAttrs

  • businessJustification

  • user

Yes

EnableAccountJSON

Specify this parameter to Enable an account in the target application.

Use the following format to update accounts using the Talend application:

 
{
"call": [
{
"name": "call1",
"connection": "acctAuth",
"url": "https://@INSTANCENAME@.qualtrics.com/API/v3/users",
"httpMethod": "POST",
"httpParams": "{\"id\":\"${account.accountID}\",\"active\":\"true\"}",
"httpHeaders": {
"X-API-TOKEN": "${access_token}",
"Accept": "application/json"
},
"httpContentType": "application/json",
"successResponses": {
"statusCode": [
200,
201
]
}
}
]
}

The bindings supported are:

  • ServiceAccountOwnerMap

  • endpoints

  • accountName

  • userManager

  • approvers

  • arsTasks/task

  • managerAccount

  • password

  • requestid

  • response

  • connection

  • userAccount

  • requestAccessAttributes/reqAttrs

  • businessJustification

  • user

Yes

DisableAccountJSON

Specify this parameter to Disable an account in the target application.

Use the following format to update accounts using the Talend application:

 

{
"call": [
{
"name": "call1",
"connection": "acctAuth",
"url": "https://@INSTANCENAME@.qualtrics.com/API/v3/users",
"httpMethod": "POST",
"httpParams": "{\"id\":\"${account.accountID}\",\"active\":\"false\"}",
"httpHeaders": {
"X-API-TOKEN": "${access_token}",
"Accept": "application/json"
},
"httpContentType": "application/json",
"successResponses": {
"statusCode": [
200,
201
]
}
}
]
}

 

The bindings supported are:

  • ServiceAccountOwnerMap

  • endpoints

  • accountName

  • userManager

  • approvers

  • arsTasks/task

  • managerAccount

  • password

  • requestid

  • response

  • connection

  • userAccount

  • requestAccessAttributes/reqAttrs

  • businessJustification

  • user

Yes

RemoveAccountJSON

Specify this parameter to remove an account. 

 

Use the following format to remove an account using the Qualtrics application:

 
{
"call": [
{
"name": "call1",
"connection": "acctAuth",
"url": "https://@INSTANCENAME@.qualtrics.com/API/v3/users/${account.accountID}",
"httpMethod": "DELETE",
"httpHeaders": {
"X-API-TOKEN": "${access_token}",
"Accept": "application/json"
},
"httpContentType": "application/json",
"successResponses": {
"statusCode": [
200,
201,
204
]
}
}
]
}

The bindings supported are:

  • ServiceAccountOwnerMap

  • endpoints

  • accountName

  • userManager

  • approvers

  • arsTasks/task

  • managerAccount

  • password

  • requestid

  • response

  • connection

  • userAccount

  • requestAccessAttributes/reqAttrs

  • businessJustification

  • user

Yes

 


Importing Connection Package

connection package helps you build the connection with pre-defined JSONs, this can be used if your tenant does not already have out of the box connection templates available. Here are the steps to import the Qualtrics connection package.

  • Download the connection package.

  • Navigate to Admin → Transport → select Import Package.

  • Browse the downloaded package and Import.

  • Navigate to Admin → Connections → Select “Qualtrics ” Connection.

  • Edit the connection with your Qualtrics tenant details.

Creating a Security System

The security system represents the connection between EIC and the target application. For more information on creating a security system, see Creating a Security System.

Creating an Endpoint for the Security System

Endpoint refers to the target application used to provision accounts and entitlements (access). For more information on creating an endpoint, see Creating Endpoints.

Using the Qualtrics Integration

You can use the Qualtrics integration for performing import and provisioning operations after configuring it to meet your requirements. 

Guidelines for Using the Integration

You must apply the following guidelines for configuring import: 

  • Run account import before running the access import.

  • Map all Qualtrics attributes to EIC account attributes using ImportAccountEntJSON.

You must apply the following guidelines for configuring provisioning:

  • Use Java ternary operators if you want to add conditions in the provisioning parameters. You can use Java operations to tweak any attributes by using if-else conditions, substrings, or operators in the JSON for provisioning.

Configuring Import Operations

  • Full account import: When configuring the connection for the first time, first perform full import to import all existing accounts from the target application to EIC. To perform full import, the invoke API gets response from the target application and maps the attributes in the target application with attributes in EIC. As part of this process, the deleted accounts are also identified and marked as suspended from import service.

  • Full Access import: When configuring the connection for the first time, first perform full import to import all existing access from the target application to EIC. To perform full import, the invoke API gets response from the target application and maps the attributes in the target application with attributes in EIC. As part of this process, the deleted entitlements are also identified and marked as inactive.

The import jobs are automatically created in EIC after you create a connection for the Qualtrics integration. For more information about creating jobs, see Data Jobs.

Importing Accounts and Accesses

You must import accounts after the users are available in EIC.

To import accounts: 

  1. Specify the connection and import parameters. For more information, see Account and Access import.
    Note: Ensure that the connection type is selected as REST.

  2. Configure the Application Data Import (Single Threaded) job to import accounts and access. For more information, see Data Jobs.

Configuring Provisioning and Deprovisioning

Provisioning is automatically enabled when a connection is configured. For detailed information about performing provisioning tasks, see Access Request System.

To provision objects to the target application:

  1. Specify the connection and provisioning parameters. For more information, see Configuration Parameters for Provisioning.
    Note: Ensure that the connection type is selected as REST.

  2. Configure the Provisioning job (WSRETRY). For more information, see Provisioning Jobs.

When a provisioning job is triggered, it creates provisioning tasks in EIC. When these tasks are completed, the provisioning action is performed on the target application through the connector.

Troubleshooting

To troubleshoot common problems with connectors, answer frequently asked questions, and provide solutions to a few common issues you might encounter while configuring or working with connectors, see Common Troubleshooting Guide for Connectors.

To troubleshoot common problems or obtain answers for frequently asked questions for REST connectors, see the REST Connector Guide.

Note: Ensure that you record the token expiry duration during the initial token generation. The connection may fail, if the token is not refreshed.

 

Version history
Last update:
‎05/12/2023 03:35 AM
Updated by:
Contributors