Overview
Configuration is provided for establishing connections with SuccessFactors 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
This guide provides a step-by-step walkthrough for creating a connection to the SAP SuccessFactors REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account." Right-click on the "Connection Managers" Tab and Select "New Connection." In the "Add SSIS Connection Manager" section, scroll down and select "Connection Managers for REST Connection" and click "Add."
Step 2. From the drop-down menu Configuration select SAP SuccessFactors and set the api server in the server host field.
Step 3. Provide values for parameters company_id, client_id, and assertion in the grid below.
Step 4. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your SAP SuccessFactors instance.
This guide demonstrates how to read data from the SAP SuccessFactors service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double-click on the "REST Source" component and select SAP SuccessFactors connection from the combo. Select from available SAP SuccessFactors resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select the SAP SuccessFactors resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from the SAP SuccessFactors service.
This guide explains how to write data to the SAP SuccessFactors service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop the COZYROC "REST Destination" component.
Step 3. Double-click on the "REST Destination" component and select SAP SuccessFactors connection from the combo. Also, select resource action and the SAP SuccessFactors resource you want to work on.
Step 4. Go to the Mapping tab and map the input columns for the process you’re configuring.
To provide input for additional resource composite objects, update the input above and map the corresponding columns.
That's it! You've now learned how to write data into the SAP SuccessFactors resource.
Configuration
Base URL address: https://[API-Server]/odata/v2.
- OAuth
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- company_id: Required. Specify the company identifier.
- client_id: Required. Specify the api key linked to your OAuth2 client app.
- assertion: Required. Specify the the Base64-encoded assertion obtained from here: https://help.sap.com/docs/SAP_SUCCESSFACTORS_PLATFORM/d599f15995d348a1b45ba5603e2aba9b/4e27e8f6ae2748ab9f23228dd6a31b06.html.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://help.sap.com/docs/SAP_SUCCESSFACTORS_PLATFORM/d599f15995d348a1b45ba5603e2aba9b/d9a9545305004187986c866de2b66987.html.
- [Read] action
-
The external resource list URL address: {{=connection.serverHost}}.
The external resource list is extracted from: {{=OData.getEntitySets({ d: response })}}.
Based on resource template Entity.
- [Read] action
-
The result is paginated.The action has the following user-defined parameters:
- $select: Selects a subset of properties to include in the response. Optional.
- $filter: Specifies inclusion or exclusion criteria for returning matches in the search results. Optional
- $orderby: Specifies a custom sort order for the search results. Optional
The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
$skiptoken:
{{=parameters.iterator}}
- [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 PATCH 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.
- [Read EntitySet] action
-
Endpoint URL address:
/{{=resource.external.name}}.
The result is extracted from:{{=OData.getResponse(response)}}.The action has the following user-defined parameters:
- $expand: Select expandable properties. Optional.
The following request parameters will be automatically processed:
-
$top:
{{=parameters.batchSize}}
- [Read EntitySingle] action
-
Endpoint URL address:
/{{=resource.external.name}}({{=parameters.id}}).
The result is extracted from:{{=OData.getResponse(response)}}.The action has the following user-defined parameters:
- id: Required. Specify the entity identifier.
- $expand: Select expandable properties. Optional.
- [Read Singleton] action
-
Endpoint URL address:
/{{=resource.external.name}}.
The result is extracted from:{{=OData.getResponse(response)}}.The action has the following user-defined parameters:
- $expand: Select expandable properties. Optional.
- [Read Function] action
-
Endpoint URL address:
/{{=resource.external.name}}({{=OData.setFunctionParameters(parameters)}}).
The result is extracted from:{{=OData.getResponse(response)}}.The action has the following user-defined parameters:
- $expand: Select expandable properties. Optional.
- [Create] action
-
Endpoint URL address:
.
The result is extracted from:{{=OData.executeAction('create', resource, batch, parameters)}}.The action has the following user-defined parameters:
- IgnoreNullValue: Specify to ignore NULL values and not send for processing.
- $expand: Select expandable properties. Optional.
The following request parameters will be automatically processed:
-
Prefer:
odata.continue-on-error
Documentation: https://learn.microsoft.com/en-us/odata/client/batch-operations.
- [Update] action
-
Endpoint URL address:
.
The result is extracted from:{{=OData.executeAction('update', resource, batch, parameters)}}.The action has the following user-defined parameters:
- IgnoreNullValue: Specify to ignore NULL values and not send for processing.
- IgnoreUnchanged: Specify to avoid sending fields where input data matches existing data.
- AlternateKey: Specify alternative key identifier column. Optional.
- $expand: Select expandable properties. Optional.
The following request parameters will be automatically processed:
-
Prefer:
odata.continue-on-error
Documentation: https://learn.microsoft.com/en-us/odata/client/batch-operations.
- [Upsert] action
-
Endpoint URL address:
.
The result is extracted from:{{=OData.executeAction('upsert', resource, batch, parameters)}}.The action has the following user-defined parameters:
- IgnoreNullValue: Specify to ignore NULL values and not send for processing.
- IgnoreUnchanged: Specify to avoid sending fields where input data matches existing data.
- AlternateKey: Specify alternative key identifier column. Optional.
- $expand: Select expandable properties. Optional.
The following request parameters will be automatically processed:
-
Prefer:
odata.continue-on-error
Documentation: https://learn.microsoft.com/en-us/odata/client/batch-operations.
- [Delete] action
-
Endpoint URL address:
.
The result is extracted from:{{=OData.executeAction('delete', resource, batch)}}.Documentation: https://learn.microsoft.com/en-us/odata/client/batch-operations.
- @odata.etag
Template: ShortText.
- [External]
-
The external fields list is extracted from:
{{=OData.getFields(resource, parameters)}}.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTimeOffset
Data type: DT_DBTIMESTAMP
- Double
Data type: DT_R8
- Boolean
Data type: DT_BOOL
- BigInt
Data type: DT_I8
- Integer
Data type: DT_I4
- Money
Data type: DT_CY
- Uniqueidentifier
Data type: DT_GUID
- Decimal
Data type: DT_DECIMAL
- Date
Data type: DT_DBDATE Before setting, the value is processed with
{{=value && dateFormat(value, 'yyyy-mm-dd')}}expression.- Image
Data type: DT_IMAGE
- Binary
Data type: DT_BYTES
- Byte
Data type: DT_UI1
- DateTime
Data type: DT_DBTIMESTAMP
- Float
Data type: DT_R4
- Single
Data type: DT_R4
- Guid
Data type: DT_GUID
- Int16
Data type: DT_I2
- SByte
Data type: DT_BYTE
- Time
Data type: DT_DBTIME
- Point
Field components:
- Contains the following components: long, lat.
- GeographyPoint
Field components:
-
Uses template:
ShortText. - Contains the following components: type, coordinates, crs.
-
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.