Overview
Configuration is provided for establishing connections with Culture Amp service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this task, we’ll guide you step by step through creating a connection to the Culture Amp REST API using COZYROC’s REST Connection Manager.
Step 1. Run Visual Studio as an "Administrator".
Right–click on Connection Managers tab and select New Connection.
In the Add SSIS Connection Manager window, scroll down, choose REST Connection Manager, and click Add.
Step 2. From the Configuration drop-down menu, select Culture Amp.
Determine the type of endpoint you want to retrieve:
Standard endpoints (other than Survey Responses)
1- Set the Server URL to "https://api.cultureamp.com"
2- Choose OAuth 2 Client Credentials as the authentication type.
3- Provide the following credentials in the parameter grid:
client_id
client_secret
scope
Survey Response endpoints
1- Set the Server URL to your specific domain, e.g.: "https://cozyroctest.cultureamp.com".
2- Select Token as the authentication type.
4- Specify the username for the parameter Username.
3- Specify the token value for the parameter ApiToken.
Click Test Connection to verify that your connection is working correctly.
Congratulations! You have successfully established a connection to your Culture Amp instance.
In this guide, we’ll demonstrate how to read data from the Culture Amp service resource using the COZYROC REST Source component.
Step 1. Select an existing Data Flow Task or create a new one.
Step 2. Open the SSIS Toolbox and drag the COZYROC REST Source component into your Data Flow.
Step 3. Double-click the REST Source component and choose your Culture Amp connection from the first drop-down menu.
Next, select the desired Culture Amp resource from the second drop-down menu.
If required, specify any parameters in the grid below.
Step 4. Click on the Columns tab and select Culture Amp resource columns you want to read.
Step 5. Click Preview to verify that all required resource columns are included.
Congratulations! You have successfully learned how to read data from the Culture Amp service.
Configuration
Base URL address: https://[domain].cultureamp.com.
- OAuth 2 Client Credentials
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- client_id: Required. Specify client identifier.
- client_secret: Required. Specify client secret.
- scope: Required. Specify the desired scoped.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://docs.api.cultureamp.com/docs/partner-guide-authentication.
- Token
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- Username: Required. Specify the email address of the account used to generate the token.
- ApiToken: Required. Specify the API Token.
The following request parameters will be automatically processed during the authentication process:
-
CA-API-Username:
{{=connection.user.Username}} -
CA-API-Token:
{{=connection.user.ApiToken}}
Documentation: https://support.cultureamp.com/en/articles/9232738-reporting-api#h_8e720afde5.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/employees.Documentation: https://docs.api.cultureamp.com/reference/list-employees.
- [Read Single] action
-
Endpoint URL address:
/employees/{{=parameters.employeeId}}.
The result is extracted from:{{=[response.data]}}.The action has the following user-defined parameters:
- employeeId: Required. Please specify the Employee identifier.
Documentation: https://docs.api.cultureamp.com/reference/list-employees.
- id
A key field. Template: Guid.
- name
Template: ShortText.
- preferredName
Template: ShortText.
- birthDate
Template: Date.
- startDate
Template: Date.
- endDate
Template: Date.
- employeeIdentifier
Template: ShortText.
Template: ShortText.
- processedAt
Template: DateTime. A read-only field.
- links
Field components:
- An array.
-
Uses template:
Link.
- demographics
The gathered value is processed with
{{=connection.resourceManager['Employee | Demographic'].getData({ parameters: ['employeeId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
Demographic.
- manager_reviews
The gathered value is processed with
{{=connection.resourceManager['Employee | Manager Review'].getData({ parameters: ['employeeId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
ManagerReview.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/employees/{{=parameters.employeeId}}/demographics.The action has the following user-defined parameters:
- employeeId: Required. Please specify the Employee identifier.
Documentation: https://docs.api.cultureamp.com/reference/list-demographics-by-employee.
The resource includes the fields from the Demographic template.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/employees/{{=parameters.employeeId}}/manager-reviews.The action has the following user-defined parameters:
- employeeId: Required. Please specify the Employee identifier.
Documentation: https://docs.api.cultureamp.com/reference/list-manager-reviews-by-employee.
The resource includes the fields from the ManagerReview template.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/performance-cycles.Documentation: https://docs.api.cultureamp.com/reference/list-performance-cycles.
- [Read Single] action
-
Endpoint URL address:
/performance-cycles/{{=parameters.performanceCycleId}}.The action has the following user-defined parameters:
- performanceCycleId: Required. Please specify the performance cycle identifier.
Documentation: https://docs.api.cultureamp.com/reference/list-manager-reviews-by-employee.
- id
A key field. Template: Guid.
- name
Template: ShortText.
- state
Template: ShortText.
- processedAt
Template: DateTime. A read-only field.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- manager_reviews
The gathered value is processed with
{{=connection.resourceManager['Performance Cycle | Manager Review'].getData({ parameters: ['performanceCycleId=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
ManagerReview.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/performance-cycles/{{=parameters.performanceCycleId}}/manager-reviews.The action has the following user-defined parameters:
- performanceCycleId: Required. Please specify the performance cycle identifier.
Documentation: https://docs.api.cultureamp.com/reference/list-manager-reviews-by-performance-cycle.
The resource includes the fields from the ManagerReview template.
Based on resource template General.
- [Read] action
-
Endpoint URL address:
/manager-reviews.Documentation: https://docs.api.cultureamp.com/reference/list-manager-reviews.
- [Read Single] action
-
Endpoint URL address:
/manager-reviews/{{=parameters.managerReviewId}}.
The result is extracted from:{{=response.data}}.The action has the following user-defined parameters:
- managerReviewId: Required. Please specify the manager review identifier.
Documentation: https://docs.api.cultureamp.com/reference/get-manager-review.
The resource includes the fields from the ManagerReview template.
Based on resource template Survey.
- [Read] action
-
Endpoint URL address:
/surveys.Documentation: https://support.cultureamp.com/en/articles/9232738-reporting-api#h_d680f08322.
- id
A key field. Template: Guid.
- reporting_survey_id
Template: ShortText. The gathered value is processed with
{{=_.last(item.responses_url.split('/').slice(-2, -1))}}expression.- name
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- launched_at
Template: DateTime. A read-only field.
- closed_at
Template: DateTime.
- status
Template: ShortText.
- responses_url
Template: LongText.
- programs
Field components:
- An array.
- Contains the following components: name, id.
Based on resource template Survey.
- [Read] action
-
Endpoint URL address:
/survey/{{=Amp.UI.SurveyEditor.getValue(parameters)}}/responses.
The result is extracted from:{{=Amp.getSurveyData(response)}}.The action has the following user-defined parameters:
- surveyId: Required. Specify Survey identifier.
- start_date: Specify the start date (e.g) 2010-01- 01T06:00:00.999+00:00.
- end_date: Specify the end date (e.g) 2010-02- 01T06:00:00.999+00:00.
Documentation: https://support.cultureamp.com/en/articles/9232738-reporting-api.
- created_at
Template: DateTime. A read-only field.
- launched_at
Template: DateTime. A read-only field.
- closed_at
Template: DateTime.
- name
Template: ShortText.
- status
Template: ShortText.
- type
Template: ShortText.
- response_count
Template: Integer.
- [External]
-
The external fields URL address:
/survey/{{=Amp.UI.SurveyEditor.getValue(parameters)}}/responses. The external fields list is extracted from:{{=_.map( response.questions, function(q) { return { name: q.code, type: q.type } }) }}.- answers.{{=external.name}}
Template: {{=Amp.getFieldTemplate(external.type)}}.
- [Read] action
-
The result is extracted from:{{=response.data}}.
The result is paginated.The following request parameters will be automatically processed:
-
cursor:
{{=parameters.iterator}} -
_includeUserParameters:
{{=parameters}}
-
cursor:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
Based on resource template Base.
Based on resource template Base.
- [Read] action
-
The result is extracted from:{{=response}}.
The result is paginated.The following request parameters will be automatically processed:
-
cursor:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
cursor:
- Guid
Data type: DT_GUID
- ShortText
Data type: DT_WSTR ( length 250 )
- LongText
Data type: DT_WSTR ( length 4000 )
- Boolean
Data type: DT_BOOL
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Integer
Data type: DT_I4
- Number
Data type: DT_R8
- Choices
Template: ShortText. The gathered value is processed with
{{=value && value.join('')}}expression.- Demographic
Field components:
-
Uses template:
ShortText. - Contains the following components: name, value.
-
Uses template:
- ManagerReview
Field components:
-
Uses template:
Guid. - Contains the following components: managerReviewId, performanceCycleId, employeeId, managerId, performanceRating, openTextQuestions, multipleChoiceQuestions, reviewAcknowledged, status, links, processedAt, createdAt, updatedAt, completedAt.
-
Uses template:
- Link
Field components:
-
Uses template:
ShortText. - Contains the following components: rel, uri.
-
Uses template:
- Rating
Field components:
-
Uses template:
Guid. - Contains the following components: id, title, description, value, createdAt, updatedAt.
-
Uses template:
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.