# SailPoint SuccessFactors SaaS Connector Documentation

> SuccessFactors SaaS Connector Documentation

# Documentation

# Aggregating Additional SuccessFactors SaaS Attributes

Configure additional account schema attributes for the SuccessFactors SaaS connector.

## Aggregating Additional Schema Attributes Using SFAPI

This connector supports the aggregation of additional schema attributes.

In the SuccessFactors managed system, on the **Additional Attribute Mapping** panel, in the **Schema Attribute** field, enter the name of the additional attribute. In the **Navigation Path (SFAPI Path)** field, enter the navigation path of the attribute as defined in SFAPI (SuccessFactors Data API). For example:

```text
/person/employment_information/job_information/pay
```

> [!NOTE]
>
> The SFAPI is SuccessFactors Data API. It is a SOAP Web Service designed for importing and exporting data to and from your SuccessFactors SaaS instance.

To aggregate the value of the additional schema attributes for an account:

1. Add the entry key of the schema attribute and its respective path. For the navigation path, perform the following steps:

   - On the SuccessFactors managed system, go to **Admin Centre \> SFAPI Data Dictionary**.
   - Search for **CompoundEmployee** in the list.
   - Expand the **CompoundEmployee** entity that displays the attribute fields with their respective information.
   - Search for the attribute you want to add. Its path will be displayed in the **Name** field.

   For example:

   **Label**: `Nationality`

   **Path**: `/person/personal_information/nationality`

   This is the SFAPI path that must be copied and entered in the **Navigation Path (SFAPI Path)** field in the source UI.
2. Add the same attribute name entry in the source account schema. For more information on adding account schema attribute, refer to [Adding Attributes to a Source Schema](<https://documentation.sailpoint.com/saas/help/accounts/schema.html#editing-an-account-schema>).

> [!NOTE]
>
> - Ensure that the names of additional attributes and details are added in both the source account schema and the source UI fields, respectively.
> - This would aggregate the attributes that are returned from the Compound Employee API from the following entities:
>
>   - person
>   - personal\_information
>   - address\_information
>   - email\_information
>   - phone\_information
>   - employment\_information
>   - job\_information

### Additional Information

To aggregate additional information types associated with supported entities such as `personal_information`, `address_information`, `email_information`, or `phone_information`, you can configure a path in the attribute mapping.

For example, there are two address information types in the following node. The first is type `home` and second is type `Payroll`.

```xml
<address_information>
    <address_type>home</address_type>
    <country>ARG</country>
</address_information>

<address_information>
      <address_type>Payroll</address_type>
      <country>AUS</country>
</address_information>
```

If you want to fetch the country for `Payroll`, then set the navigation path / SFAPI path as follows:

```text
/person/address_information[address_type= "Payroll"]/country
```

This connector aggregates the `PrimaryEmailAddress`. To aggregate a different type of email address, set the navigation path as follows:

```text
/person/email_information[email_type="O"]/email_address
```

where `O` indicates the `Office` email address type.

### Additional Attributes with XPath

This connector supports the SFAPI path value in XPath 2.0 format to aggregate additional attributes.

The supported additional attributes are part of following entities:

| Entity | Employees | Users |
| --- | --- | --- |
| User | No | Yes |
| Compound Employee API sub-structures | Yes | Yes |

To aggregate the value of additional account schema attributes for Compound Employee API sub-structures, you must add the attribute name to the account schema and the corresponding navigational path. The following Compound Employee API substructures are standard:

- person
- personal\_information
- address\_information
- phone\_information
- email\_information
- person\_relation
- employment\_information
- job\_information
- compensation\_information
- paycompensation\_recurring
- paycompensation\_non\_recurring
- payment\_information
- accompanying\_dependent
- alternative\_cost\_distribution
- job\_relation
- direct\_deposit
- national\_id\_card
- deduction\_recurring
- deduction\_non\_recurring
- global\_assignment\_information
- ItDeclaration
- dependent\_information
- personal\_documents\_information
- EmployeeDataReplicationElement
- associated\_employee\_information
- emergency\_contact\_primary
- DRTMPurgeStatusOverview

You can include additional sub-structures by providing the sub-structure name in the **Include Compound Employee API Entities** field on the SuccessFactors managed system. To add multiple entities, separate the names with commas. For example: WorkOrder, SecondaryAssignments.

This connector can aggregate additional account schema attributes for user management. These attributes belong to the user entity whose `Navigation Target` property is blank.

User attributes must use the `user` prefix. For example, `user.city`.

To include additional attributes in aggregation processes using XPath:

1. On the SuccessFactors managed system, go to **Admin Center**.
2. Search for and select **SFAPI Data Dictionary**.

   The SFAPI Data Dictionary page displays.
3. Search for and expand the **CompoundEmployee** entity to display the attribute fields.
4. Find the required attribute and the path displayed under the Name field and copy the path. For example:

   **Label**: `Nationality`

   **Name (Path)**: `/person/personal_information/nationality`

   The Name path is the required field value for Navigation Path (SFAPI Path).
5. On the SuccessFactors managed system, in the **Additional Attribute Mapping** sub-panel, set the following:

   | Attributes | Description |
   | --- | --- |
   | Include Compound Employee API Entities | Enter the name of Compound Employee API extended sub-structures/Entities (separated by comma) to query for additional attributes. |
   | Attribute Mapping | Define the schema attribute name along with navigation path that connector will aggregate from the SuccessFactors managed system. |

### Specifying Values from Multiple Sub-Structures

By default, this connector aggregates the values without applying logic. It fetches the value that matches the specified SFAPI path. If an attribute value includes multiple sub-structures and you want to aggregate the data from a specific entity, you can provide the XPath 2.0 value.

**Use Case 1:**

You want to aggregate the country value for `address_type`, but `address_type` has multiple values, such as `home` or `payroll`. To specify the payroll address, set the **Navigation Path (SFAPI Path)** as follows:

```text
/person/address_information[address_type= "Payroll"]/country
```

**Use Case 2:**

By default, this connector aggregates the `PrimaryEmailAddress`. If you want to return specific email addresses, such as the `Office` type email address, set the **Navigation Path (SFAPI Path)** as follows:

```text
/person/email_information[email_type="O"]/email_address
```

where `O` represents that the email address is an **Office** type.

**Use Case 3:**

An employee is being promoted and you want to aggregate information based on the future position to trigger approvals by the future manager. In this use case, the employee has two sets of job information - the current and future. To fetch the future manager information, set the **Navigation Path (SFAPI Path)** as follows:

```text
/person/employment_information/job_information[xs:date(start_date) ge current-date()]/manager_person_id_external
```

**Use Case 4:**

A user has concurrent assignments and you want aggregate the primary position. To aggregate only the primary position, set the **Navigation Path (SFAPI Path)** as follows:

```text
/person/employment_information[not(SecondaryAssignmentPeriod)]/job_information[xs:date(start_date) le current-date() and xs:date(end_date) ge current-date()]/position
```

## Future Actions

The Future Actions attribute stores information about Future Actions in the following JSON format:

```text
{"Actions": [{"ActionType" : "<ActionCode>","ActionReason" : "<Action Reason value>","ActionStartDate" : "<Start date>","ActionEndDate" : "<End date>"}]}
```

For example, you can use the following:

```text
{"Actions": [{"ActionType" : "SCWK","ActionReason" : "Start CWK","ActionStartDate" : "2018-08-26","ActionEndDate" : "2018-09-08"}]}
```

> [!NOTE]
>
> The Future Actions attribute aggregates future employment actions only.

## Adding Custom Attributes From SFAPI Data Dictionary

This connector can aggregate additional schema attributes.

In the SuccessFactors source UI, on the **Additional Attribute Mapping** panel, in the **Schema Attribute** field, enter the name of the additional attribute. In the **Navigation Path (SFAPI Path)** field, enter the navigation path of the attribute as defined in SFAPI (SuccessFactors Data API). For example:

```text
/person/employment_information/job_information/pay
```

> [!NOTE]
>
> SFAPI is short for SuccessFactors Data API. It is a SOAP Web Service designed for importing and exporting data to and from your SuccessFactors SaaS instance.

To aggregate the value of the additional schema attributes for an account:

1. Add the entry key of schema attribute and its respective path. For the navigation path, perform the following steps:

   - On the SuccessFactors managed system, navigate to **Admin Centre \> SFAPI Data Dictionary**.
   - Search the **CompoundEmployee** in the list.
   - Expand the **CompoundEmployee** entity that displays the attribute fields with their respective information.
   - Search for the attribute you want to add. Its path will be displayed in the **Name** field.

   For example:

   **Label**: `Nationality`

   **Path**: `/person/personal_information/nationality`

   This is the SFAPI path that must be copied and entered in the **Navigation Path (SFAPI Path)** field in the source UI.
2. Add the same attribute name entry in the SuccessFactors source account schema. For more information on adding account schema attribute, refer to [Adding Attributes to a Source Schema](<https://documentation.sailpoint.com/saas/help/accounts/schema.html#editing-an-account-schema>).

> [!NOTE]
>
> Ensure that the names of additional attributes and details are added in both the source account schema and the source UI fields, respectively. Doing so aggregates the attributes that are returned using the Compound Employee API from the following entities:
>
> - person
> - personal\_information
> - address\_information
> - email\_information
> - phone\_information
> - employment\_information
> - job\_information

### Additional Information

If there are multiple information types associated with supported entities like `personal_information`, `address_information`, `email_information`, `phone_information`, then to aggregate the data from the specific type of information, you can configure a path in the attribute mapping.

For example, there are two address information types in the following node. The first is "home" and second is "Payroll".

```xml
<address_information>
    <address_type>home</address_type>
    <country>ARG</country>
</address_information>

<address_information>
      <address_type>Payroll</address_type>
      <country>AUS</country>
</address_information>
```

If you want to fetch the country from `Payroll`, set the **Navigation Path (SFAPI Path)** as follows:

```text
/person/address_information[address_type= "Payroll"]/country
```

This connector aggregates the "PrimaryEmailAddress". To aggregate different type of email address, set the **Navigation Path (SFAPI Path)** as follows:

```text
/person/email_information[email_type="O"]/email_address
```

where `O` indicates the email address for `Office`.

### Additional Attributes with XPath

This connector supports the SFAPI path value in XPath 2.0 format to aggregate the additional attributes.

The supported additional attributes are part of following entity:

To aggregate the value of additional account schema attributes for Compound Employee API sub-structures, you must add the attribute name to the account schema and the corresponding navigational path. The following Compound Employee API substructures are standard:

- person
- personal\_information
- address\_information
- phone\_information
- email\_information
- person\_relation
- employment\_information
- job\_information
- compensation\_information
- paycompensation\_recurring
- paycompensation\_non\_recurring
- payment\_information
- accompanying\_dependent
- alternative\_cost\_distribution
- job\_relation
- direct\_deposit
- national\_id\_card
- deduction\_recurring
- deduction\_non\_recurring
- global\_assignment\_information
- ItDeclaration
- dependent\_information
- personal\_documents\_information
- EmployeeDataReplicationElement
- associated\_employee\_information
- emergency\_contact\_primary
- DRTMPurgeStatusOverview

You can include additional sub-structures by providing the sub-structure name in the **Include Compound Employee API Entities** field on the SuccessFactors source UI. To add multiple entities, separate the names with commas. For example: WorkOrder, SecondaryAssignments.

The SuccessFactors SaaS connector provides support for the aggregation of additional account schema attributes for user management that belongs to the user entity with Navigation Target property as blank.

User attributes must use the user prefix. For example, user.city.

On the SuccessFactors managed system:

1. Go to **Admin Center**.
2. Search for and select **SFAPI Data Dictionary**. The SFAPI Data Dictionary page is displayed.
3. Search for and expand the CompoundEmployee entity to display the attribute fields.
4. Find the required attribute and the path displayed under the Name field and copy the path. For example:

   **Label**: `Nationality`

   **Name (Path)**: `/person/personal_information/nationality`

   The name path is the required field value for Navigation Path (SFAPI Path).
5. On the SuccessFactors source UI, in the **Additional Attribute Mapping** sub-panel, set the following:

   | Attributes | Description |
   | --- | --- |
   | Include Compound Employee API Entities | Enter the name of Compound Employee API extended sub-structures/Entities (separated by comma) to query for additional attributes. |
   | Attribute Mapping | Define the schema attribute name along with navigation path that connector will aggregate from the SuccessFactors managed system. |

### Specifying Values from Multiple Sub-Structures

By default, the SuccessFactors SaaS connector aggregates the values without applying logic. It fetches the value that matches the specified SFAPI path. If an attribute value is including multiple sub-structures and you want to aggregate the data from a specific entity, you can provide the XPath 2.0 value.

**Use Case 1:**

If you want to aggregate the country value for `address_type` but `address_type` could have multiple values such as home or payroll. To specify the payroll address, set the **Navigation Path (SFAPI Path)** as follows:

```text
/person/address_information[address_type= "Payroll"]/country
```

**Use Case 2:**

By default, this connector aggregates the `PrimaryEmailAddress`. If you want to return specific email addresses, such as the `Office` type email address, set the **Navigation Path (SFAPI Path)** as follows:

```text
/person/email_information[email_type="O"]/email_address
```

where `O` represents that the email address is for `Office`.

**Use Case 3:**

An employee is being promoted and you want to aggregate information based on the future position to trigger approvals by the future manager. In this use case, the employee has two sets of job information - the current and future. To fetch the future manager information, set the **Navigation Path (SFAPI Path)** as follows:

```text
/person/employment_information/job_information[xs:date(start_date) ge current-date()]/manager_person_id_external
```

**Use Case 4:**

A user has concurrent assignments and you want aggregate the primary position. To aggregate the primary position, set the **Navigation Path (SFAPI Path)** as follows:

```text
/person/employment_information[not(SecondaryAssignmentPeriod)]/job_information[xs:date(start_date) le current-date() and xs:date(end_date) ge current-date()]/position
```

## Adding Attributes From ODATA API Data Dictionary

The SuccessFactors SaaS connector can aggregate additional account schema attributes to manage users that belong to the user entity. The connector can aggregate additional account schema attributes for user and employee data using the `/User`, `/EmpJob`, and `/EmpEmployment` ODATA APIs.

> [!NOTE]
>
> - This feature supports `employee` and `user` types.
> - `User` attributes must use the `User` prefix. For example, `User.city`.
> - `EmpJob` attributes must use the `EmpJob` prefix. For example, `EmpJob.managerId`.
> - `EmpEmployment` attributes must use the `EmpEmployment` prefix. For example, `EmpEmployment.isContingentWorker`.
> - The connector can aggregate nested ODATA attributes. For example, `User.city.pincode`.

Find the supported attributes you want to add:

1. In SuccessFactors, go to **Admin Center**.
2. Search for and select **ODATA API DATA Dictionary**.
3. Search for **User**, **EmpJob**, or **EmpEmployment**. This displays the list of supported attributes.
4. Copy the attribute name.

   > **Note**
   >
   > In the ODATA API Dictionary, the attribute must be configured as `sap:visible true` to be included in aggregation.

Add the attribute name to the account schema:

1. In SailPoint, go to **Connections \> Sources** and then select **SuccessFactors SaaS** from the list.
2. Go to **Import Data** and then select **Account Schema**.
3. Select **Add New Attribute**.
4. In the **Name**, add the name of the attribute copied from SuccessFactors.
5. Select **Save**.

# Configuring SuccessFactors SaaS Advanced Settings

Update existing SuccessFactors picklist mappings and add additional attributes.

## Picklist Mapping Configuration

SuccessFactors picklist mapping is for Update operations only.

> [!NOTE]
>
> **Screenshot**
>
> [![Advanced Settings](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/advanced_settings.png>)](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/advanced_settings.png>)

1. Enter the **Picklist Mapping** as required for your tenant configuration. For example, `BusinessEmail=<Picklist OptionID>` or `BusinessPhone=<Picklist OptionID>`. For more information, refer to [Provisioning of Email, Phone, and Username Attributes](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/provisioning.html#provisioning-of-email-phone-and-username-attributes>).
2. Press **Enter**.
3. Repeat steps 1 and 2 until all values have been entered.
4. Select **Save**.

## Include Compound Employee API Entities

> [!NOTE]
>
> **Screenshot**
>
> [![Include Compound Employee API Entities](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/include_compound_employee_api_entities.png>)](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/include_compound_employee_api_entities.png>)

> [!NOTE]
>
> Ensure that the defined and validated attributes you want to add are in the **Include Compound Employee API Entities** field on the managed system as well as in the connector configuration.

Older SuccessFactors connectors have predefined values for **Include Compound Employee API Entities**. To add new attributes to the managed system, make sure the attribute used as a column in the SOAP query returns a valid result. If the SOAP query response is valid, then that attribute can be added to the **Include Compound Employee API Entities** field. Separate multiple entries with a comma.

For example, if the `SecondaryAssignments` attribute is added to **Include Compound Employee API Entities**, then the following query execution in the SOAP tool returns a valid result:

```text
select person,personal_information,address_information,email_information,phone_information,employment_information,job_information,compensation_information,paycompensation_recurring,paycompensation_non_recurring,accompanying_dependent,alternative_cost_distribution,job_relation,BenefitsIntegrationOneTimeInfo,BenefitsIntegrationRecurringInfo,deduction_recurring,deduction_non_recurring,global_assignment_information,ItDeclaration,personal_documents_information,associated_employee_information,person_relation,payment_information,direct_deposit,EmpCostAssignment,national_id_card,dependent_information,emergency_contact_primary,DRTMPurgeStatusOverview,SecondaryAssignments from CompoundEmployee where isContingentWorker in('true','false') and user_id IN('xyz',) ORDER BY start_date DESC
```

## Exclude Compound Employee API Entities

> [!NOTE]
>
> **Screenshot**
>
> [![Exclude Compound Employee API Entities](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/exclude_compound_employee_api_entities.png>)](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/exclude_compound_employee_api_entities.png>)

Use this feature to exclude Personally Identifiable Information (PII) data from your aggregation results. Adding an entry to this field will cause all the associated attributes of the employee API entry to be excluded from your aggregation results. For example, if you enter `personal_information` in the list, then attributes associated to personal information, such as first name and last name, are not aggregated.

- In the **Exclude Compound Employee API Entities** field, enter the entity you want to be excluded from your aggregation results and then press the Enter key. You can enter multiple entries using this method.

  > **Caution**
  >
  > If you add an unsupported entity or misspell the entity, your aggregation will fail.

  Only the following entries are supported:

  - personal\_information
  - address\_information
  - email\_information
  - phone\_information

## Additional Attribute Mapping

> [!NOTE]
>
> **Screenshot**
>
> [![Attribute Mapping](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/attribute_mapping.png>)](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/attribute_mapping.png>)

You can customize the aggregation of attributes or add custom attributes by defining the attribute name and its navigation path which the connector uses to aggregate from the source. For more information on SuccessFactors schema attributes and SFAPI, refer to [Aggregating Additional Schema Attributes Using SFAPI](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/additional_attribute_aggregation.html#aggregating-additional-schema-attributes-using-sfapi>).

> [!IMPORTANT]
>
> Aggregation scope adjustments set in the source (such as offset) do not apply to additional attributes. The connector only fetches additional attribute values based on the XPATH conditions set in the **Navigation Path (SFAPI Path)** field.

1. Enter a name for the **Schema Attribute**.

   > **Note**
   >
   > Ensure that names of schema attributes added under attribute mapping are also added in the source account schema.
2. Enter the attribute **Navigation Path (SFAPI Path)** as defined in the SFAPI. For example: `/person/employment_information/job_information/pay`.
3. Repeat steps 1 and 2 until all values have been entered.
4. To query for additional attributes, enter the name of the compound employee API extended sub-structures/entities (separated by a comma) in the **Include Compound Employee API Entities** field.
5. Select **Save**.

## Fetch Labels for Codes Associated with Additional Attributes

The connector can fetch labels associated with the codes that are fetched for additional schema attributes. For example, consider a scenario in which you have an additional attribute, `EmployeeStatus`. An allowed setting for `EmployeeStatus` is `A` which means the employee status is active. You can configure the connector to fetch the **Active** label in association with the `A` setting for the `EmployeeStatus` attribute, since **Active** is the available selection under the `employee-status` picklist.

> [!NOTE]
>
> The value is available from either a picklist or a foundation object.

The instructions on this page enable you to aggregate labels for additional attributes fetched with SFAPI as well as `/User`, `/EmpJob`, and `/EmpEmployment` ODATA APIs.

> [!NOTE]
>
> **Screenshot**
>
> [![Attribute Label Maps](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/attr_label_maps.png>)](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/attr_label_maps.png>)

To configure the connector to fetch a label from a picklist:

1. In the **Schema Attribute** field, enter the name of the attribute whose values require a label.
2. In the **Data Source Path** field, enter the Legacy Picklist ID from the SuccessFactors managed system, prepended with `pk_` as the separator.

   For example, if the Legacy Picklist ID is `employee-status`, your entry would be `pk_employee-status`.

   To get the Legacy Picklist ID:

   1. Go to the SuccessFactors managed system.
   2. Go to the Admin Center.
   3. Search for the Picklist Center, where the source displays a list of all picklist codes.
   4. Select respective Picklist Code.
   5. Select active version and go to details.
   6. Get the Legacy Picklist ID.
3. (Optional) Select **Add Another** to configure more additional attributes for aggregation and their associated labels.
4. Select **Save**.

To configure the connector to fetch a label from a foundation object:

1. In the **Schema Attribute** field, enter the name of the attribute whose values require a label.
2. In the **Data Source Path** field, enter the foundation object name from SuccessFactors managed system, prepended with `fo_` as the separator. It should be written in the following format:

   ```text
   fo_<Object_Name>?$format=json&$select=<code_field,label_field>
   ```

   For example:

   ```text
   fo_focompany?$format=json&$select=companycode,companyname
   ```

   > **Note**
   >
   > - The sequence of the `code_field` and the `label_field` must be as it is displayed in the provided format. The `code_field` must precede its respective `label_field`.
   > - You can get your system's foundation object names and its applicable fields from your SuccessFactors administrator.
3. (Optional) Select **Add Another** to configure more additional attributes for aggregation and their associated labels.
4. Select **Save**.

### Example Configuration

The following table exemplifies two attribute label mappings, one which uses a Legacy Picklist ID and another that uses a foundation object.

| Example Type | Schema Attribute | Data Source |
| --- | --- | --- |
| Legacy Picklist ID | Attr\_1 | `pk_employee-status` |
| Foundation Object | Attr\_2 | `fo_FODepartment?$format=json&$select=externalCode,name_defaultValue`. In this example, the foundation object name is FODepartment, and its respective code is `externalCode`. The label associated with that code is `name_defaultValue`. |

# Filtering SuccessFactors SaaS Account Aggregation

Use account aggregation filters to limit the employee and user records that the source aggregates.

## Filtering Employment Based on assignment\_class

The SuccessFactors connector supports filtering specific employment records during employee and user aggregation based on the assignment\_class attribute. To apply a filter based on assignment\_class, submit the change to the VA using the SailPoint V3 Sources REST API.

```text
PATCH  https://<orgName>.api.cloud.sailpoint.com/v3/sources/<SuccessFactorSourceId>
```

> [!NOTE]
>
> For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication](<https://developer.sailpoint.com/docs/api/authentication/>) and [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1/>) in the SailPoint Developer Community.

### assignment\_class Filter

**Description:** This attribute is used to filter specific employment records during employee and user aggregation.

**Resolution:** Use this filter to pull only those employment records that match the desired assignment\_class value.

**Example:** If you want to fetch employment records where the assignment\_class is "ST", use the following format:

```json
[
 {
  "op": "add",
  "path": "/connectorAttributes/employmentFilter",
  "value": {
      "employment.assignment_class": "ST"
  }
 }
]
```

## Aggregation Query Filter

The Aggregation Query Filter is used to filter employees when the **Account Type to Manage** setting is set to **Employees**.

> [!NOTE]
>
> The Aggregation Query Filter is only applicable for the `EmpJob` entity and only property names with a `sap:filterable` value of `true` can be used in the filter query.

### Viewing the EmpJob Entity

To view the EmpJob entity in your SuccessFactors tenant:

1. Go to **Admin Center \> ODATA API DATA dictionary \> Entity**.
2. In the **Name** field, search for `EmpJob`.

   [![EmpJob](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/empjob.png>)](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/empjob.png>)

### Query Examples

Use the following examples to configure your own aggregation queries.

> [!NOTE]
>
> All values in a query should be enclosed in quotation marks. For example, `"value"`.

For more information on the available operators, refer to the **$filter** section of the [SAP SuccessFactors API Reference guide](<https://help.sap.com/docs/SAP_SUCCESSFACTORS_PLATFORM/d599f15995d348a1b45ba5603e2aba9b/ded5808b5edb4bc9a8acfb5e9fe1b025.html>).

- To filter employees from a specific department and division:

  ```text
  department eq "50000300" and division eq "EXEC"
  ```
- To filter employees from company A and company B:

  ```text
  company in "A", "B"
  ```
- To filter employees based on their start date:

  ```text
  startDate gt datetime"2023-06-06T00:00:00"
  startDate lt datetime"2023-06-06T00:00:00"
  ```

  > **Note**
  >
  > The date format is the two-letter timezone abbreviation datetime:
  >
  > ```text
  > yyyy-MM-dd-THH:MM:SS
  > ```

### Finding Proper Values (externalCode) for Query Filter Parameters

In the ODATA API, some properties require external code values to fetch the data.

For example:

```text
company eq "8500"
```

In this example, `8500` is an external code for the BestRun Australia company.

To get external codes for any property from your SuccessFactors tenant:

1. Go to the **Admin Center**.
2. Go to **Manage Data**.
3. Search for the property name. For example, `Division`, `Department`, or `Position`.
4. The adjacent dropdown list contains all the associated values with labels and their codes in parentheses.

   For example, in the following screenshot, **Corporate** is the label and **CORP** is its associated code so the filter query would be `businessUnit eq "CORP"`

   [![Code Search](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/code_search.png>)](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/code_search.png>)

#### Property Names and Navigation Path for the External Code

The following table lists property names and their associated navigation path to get the external code:

| Property Name | Navigation Path for External Code |
| --- | --- |
| jobCode | Admin Center \> Tools \> Manage Data \> Job Classification |
| company | Admin Center \> Tools \> Manage Data \> Legal Entity |
| division | Admin Center \> Tools \> Manage Data \> Division |
| department | Admin Center \> Tools \> Manage Data \> Department |
| countryOfCompany | Admin Center \> Tools \> Manage Data \> Country/Region |
| position | Admin Center \> Tools \> Manage Data \> Position |
| payGrade | Admin Center \> Tools \> Manage Data \> Pay Grade |
| location | Admin Center \> Tools \> Manage Organization, Pay and Job Structures \> Location |
| eventReason | Admin Center \> Tools \> Manage Organization, Pay and Job Structures \> Event Reason |
| businessUnit | Admin Center \> Tools \> Manage Data \> Business Unit |
| costCenter | Admin Center \> Tools \> Manage Data \> Cost Center |
| payScaleArea | Admin Center \> Tools \> Manage Data \> Pay Scale Area |
| payScaleGroup | Admin Center \> Tools \> Manage Data \> Pay Scale Group |
| payScaleType | Admin Center \> Tools \> Manage Data \> Pay Scale Type |

#### Property Names and Navigation Path for the External Code from Picklist Center

The following table lists the properties and their associated navigation path for the external code from the Picklist Center:

| Property Name | Navigation Path for External Code |
| --- | --- |
| employeeClass | Admin Center \> Tools \> Picklist Center \> EmployeeClass \> Option ID of one of the picklist values |
| employmentType | Admin Center \> Tools \> Picklist Center \> employmentType \> Option ID of one of the picklist values |
| event | Admin Center \> Tools \> Picklist Center \> event. Option ID of one of the picklist values |
| emplStatus | Admin Center \> Tools \> Picklist Center \> employee-status \> Option ID of one of the picklist values |

### Validating Query Filters

To validate query filters during test connection processes:

1. In the SailPoint SuccessFactors SaaS connector configuration page, go to **Aggregation Settings \> Filter Criteria For Employees**.
2. Enter the query filter statement you want to validate in the **Aggregation Query Filter** field.
3. Select **Validate Aggregation Query Filter**.

   The query validation occurs when the test connection operation is performed.

# Configuring SuccessFactors SaaS Aggregation Settings

Provide the information the source uses to manage and filter SuccessFactors employees or users. Select an account type to indicate whether the source manages employees or users. For more information about aggregation, refer to [Loading Account Data](<https://documentation.sailpoint.com/saas/help/accounts/loading_data.html>).

## Aggregating Employees

> [!NOTE]
>
> **Screenshot**
>
> [![Employees account type selected](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/employee_aggregation.png>)](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/employee_aggregation.png>)
>
> [![Aggregate Primary Employment](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/employee_aggregation_1.png>)](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/employee_aggregation_1.png>)
>
> [![Aggregate future employees, inactive employees, pre-hire, and query filter](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/employee_aggregation_filters.png>)](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/employee_aggregation_filters.png>)
>
> [![Time Zone](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/employee_aggregation_3.png>)](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/employee_aggregation_3.png>)
>
> [![Delta Aggregation](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/employee_aggregation_4.png>)](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/employee_aggregation_4.png>)

> [!NOTE]
>
> Not applicable for users.

1. Select the **Employees** radio button to aggregate SuccessFactors employees.
2. (*Optional*) Enable **Aggregate Primary Employment** to include Primary Employment attributes in employee aggregation. This applies to active and future-dated employees. Primary employment is for when an employee has concurrent employment in your system.

   If you disable **Aggregate Primary Employment**, the source aggregates the most recent employment attributes.

   **Aggregate Primary Employment** is disabled by default.

   > **Note**
   >
   > **Aggregate Primary Employment** is not applicable for additional attributes or custom attributes mapped in the source using XPaths from the SFAPI data dictionary.
3. (*Optional*) Enable **Aggregate Future Employees** if you want to aggregate future hires.

   - Default - 30 (days)
   - **0** - Aggregates no future hires
   - **\-1** - Aggregates all future hires
   - Positive integers - Aggregates all future hires within the specified number of days
4. (*Optional*) Select **Aggregate Inactive Employees** if you want to aggregate inactive employee records.

   - Default - 30 (days)
   - **0** - Aggregates only active employees
   - **\-1** - Aggregates all inactive employees
   - Positive integers - Aggregates inactive employees within the specified number of days
5. Enable **Aggregate Pre-Hire** if you want to include Pre-Hire identities who are not yet active employees in account aggregations.
6. (*Optional*) In the **Aggregation Query Filter** field, enter a query filter for employees. The aggregation query filter is only applicable for the EmpJob entity and only property names with a `sap:filterable` value of `true` can be used in the filter query. Refer to [Aggregation Query Filter](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/aggregation_filters.html#aggregation-query-filter>) for more information and examples.
7. (*Optional*) Enable **Validate Aggregation Query Filter** to validate the entered query filter during a test connection processes.
8. (*Optional*) Select the tenant's preferred **Time Zone**.

   > **Important**
   >
   > Ensure that the SAP SuccessFactors HRIS sync job is synchronized to get the correct results for account aggregation. For more information, refer to [HRIS Sync Jobs](<https://help.sap.com/docs/SAP_SUCCESSFACTORS_EMPLOYEE_CENTRAL/b14dd15ca58f43e0856184a740a4b212/67a3c90148ff4945ae37efb9eb9ed60f.html>) in the SAP Help Portal.
   >
   > If the timezone selected on the source and the tenant are different, the aggregated data may be inconsistent.

   > **Note**
   >
   > The linked document is not maintained by SailPoint and is subject to change without notice.
9. (*Optional*) Select **Delta Aggregation** if you want to aggregate new accounts or accounts that have changed since the last aggregation. For more information, refer to [Delta Aggregation](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/delta_aggregation.html>).
10. Select **Save**.

## Aggregating Users

> [!NOTE]
>
> **Screenshot**
>
> [![Users account type selected](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/aggregation_settings_users.png>)](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/aggregation_settings_users.png>)
>
> [![Aggregate Primary Employment for users](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/aggregation_settings_users_1.png>)](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/aggregation_settings_users_1.png>)
>
> [![Aggregate Inactive Users](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/aggregation_settings_users_2.png>)](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/aggregation_settings_users_2.png>)
>
> [![Aggregate active and inactive external users](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/aggregation_settings_users_3.png>)](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/aggregation_settings_users_3.png>)
>
> [![Delta Aggregation for users](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/aggregation_settings_users_4.png>)](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/aggregation_settings_users_4.png>)

> [!NOTE]
>
> Not applicable for Employees.

1. Select the **Users** radio button to aggregate SuccessFactors users.
2. (*Optional*) Enable **Aggregate Primary Employment** to include Primary Employment attributes in user aggregation. This applies to active and future-dated users.

   If you disable **Aggregate Primary Employment**, the source aggregates the most recent employment attributes. By default, **Aggregate Primary Employment** is disabled.

   > **Note**
   >
   > **Aggregate Primary Employment** is not applicable for additional attributes or custom attributes mapped in the source using XPaths from the SFAPI data dictionary.
3. (*Optional*) Enable **Aggregate Inactive Users** to aggregate users whose end date is in the past.

   > **Note**
   >
   > If you don't enable **Aggregate Inactive Users**, the system aggregates all active users.
4. (*Optional*) Enable **Aggregate Active External Users** to include active external users in account aggregation.
5. (*Optional*) Enable **Aggregate Inactive External Users** to include inactive external users in account aggregation.
6. (*Optional*) Enable **Delta Aggregation** if you want to aggregate new accounts or accounts that have changed since the last aggregation. For more information, refer to [Delta Aggregation](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/delta_aggregation.html>).
7. Select **Save**.

# Connecting SailPoint and SuccessFactors SaaS

To connect SailPoint and SuccessFactors SaaS, perform the following tasks:

## Enable SOAP API in SuccessFactors SaaS

1. In SuccessFactors, sign in to the **Provisioning Access Console**. Select your company, and go to **Company Settings**.

   > **Note**
   >
   > Refer to the SuccessFactors product documentation for more information.
2. Under **Web Services** enable the following items:

   - **SFAPI** - SFAPI is SuccessFactors' Data API. It is a SOAP Web Service designed to import and export data to and from your SuccessFactors deployment. For more information about SFAPI, refer to [SAP Support Portal](<https://support.sap.com/>).
   - Employee Central SOAP API
   - To provide information about global assignments, such as dependents accompanying an employee on a global assignment:

     - Enable Global Assignment Management
     - Enable Dependents Management

## Register a Client Application in SuccessFactors

Register SailPoint with the managed system so it can access the SuccessFactors REST APIs. This process involves registering a client application, generating a certificate, and obtaining Client ID attributes. For detailed information about registering a client application in SuccessFactors, refer to [Registering Your Client Application in the SAP Help Portal](<https://help.sap.com/docs/SAP_SUCCESSFACTORS_PEOPLE_ANALYTICS/6d67a922bf7c4a79b1e3088247341d28/77c5e140ac3d47ba80e1e58d33abc477.html>).

> [!NOTE]
>
> The linked document is not maintained by SailPoint and is subject to change without notice.

1. Register your client application with SuccessFactors by going to **Admin Center \> Company Settings \> Manage OAuth2 Client Applications \> Register Client Application**.
2. Provide information for the mandatory fields such as **Application Name**, **Description**, and **Application URL**.

   For example, the application name value can be "SailPointApp" and the URL can be `https://SailPointApp`
3. Select **Generate X.509 Certificate** and enter the values as required.
4. Select **Generate** and download a copy of the **X.509** certificate on your computer.
5. Open the **X.509** certificate file. The **X.509** certificate includes:

   - Private key
   - Certificate
6. Copy the characters between `-----BEGIN ENCRYPTED PRIVATE KEY-----` and `-----END ENCRYPTED PRIVATE KEY-----` and paste it in the **Private Key** field. This private key is used as a configuration parameter for test connection operations.
7. Select **Register**.

> [!NOTE]
>
> Save the generated API Key. The key is used as the Client ID configuration parameter for test connection operations.

To connect SailPoint with SuccessFactors, perform the following tasks:

## Adding the Source in SailPoint

To connect to SailPoint, perform the following steps. Once the connection is made, you can configure it to meet your company's needs.

> [!IMPORTANT]
>
> By default, the provisioning feature is **disabled**, and the connector only supports read-only operations. To support provisioning operations, you must manually enable the feature in the source configuration.

**To configure a new source:**

1. Sign in to SailPoint.
2. Go to **Admin \> Connections \> Sources**.
3. Select **Create New**.
4. Search for the connector by entering the name in the search box, and then select **Configure**.
5. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters.
6. In the **Description** field, provide additional details about the source to help distinguish it from similar sources. This field allows a maximum of 2,000 characters.
7. In the **Source Owner** field, begin typing the name of an owner. Matches appear after you type two or more letters. For more information, refer to [Assigning a Source Owner](<https://documentation.sailpoint.com/saas/help/sources/index.html#assigning-a-source-owner>).
8. (Optional) Select a governance group to grant its members [source](<https://documentation.sailpoint.com/saas/help/common/users/user_levels.html#source-sub-admin-user-level>) or [role](<https://documentation.sailpoint.com/saas/help/common/users/user_levels.html#role-sub-admin-user-level>) sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](<https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html>).
9. If this source represents a primary system containing your organization's personnel records, select the **Authoritative Source** checkbox. For more information, refer to [Creating Identity Profiles](<https://documentation.sailpoint.com/saas/help/setup/identity_profiles.html>).
10. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Continue to configure your connected source there.

## Base Configuration

Provide the base configuration parameters. Information you entered in the Create New Source dialog is automatically entered into the fields in the Base Configuration page. You can edit this information if necessary.

1. Enter a unique name and description for the source.
2. In the **Source Owner** dropdown list, select the identity that owns this source.

   - To find a source owner, begin entering their name.
3. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider.

   > **Note**
   >
   > To add a credential provider, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](<https://documentation.sailpoint.com/connectors/help/credential_providers.html>).
4. Configure the authentication to allow SailPoint to connect to the source. Refer to [Connection Settings](<#connection-settings>) for more information.
5. (Optional) In the **Governance Group for Source Management** dropdown list, select a governance group to associate with this source. For more information about governance groups, refer to [Associating Governance Groups with a Source](<https://documentation.sailpoint.com/saas/help/common/users/governance_groups.html#associating-a-governance-group-with-a-source>).
6. (Optional) Choose whether to enable or disable provisioning for the source. Provisioning is disabled by default.

   - **Enable Provisioning** - Set the toggle to **Enabled** to allow the source to create, update, and deactivate accounts in the connected source system.
   - **Disable Provisioning** - Set the toggle to **Disabled** to disable provisioning for the source. Disabling provisioning will prevent the creation, updating, or deactivating of accounts on this source.
7. Select **Save**.

## Connection Settings

Provide the information required for the source to connect and interact with the source.

> [!NOTE]
>
> **Screenshot**
>
> [![Connection Settings](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/connection_settings.png>)](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/connection_settings.png>)

1. Enter the unique **Base URL** to connect to the SuccessFactors system through an API. For example:

   `https://<hostname.successfactors.com>:<port>`

   1. The Base URL is usually the API Service endpoint of your company instance and it tends to be similar to `https://api<number>.sapsf.com`. For reference: [List of SAP SuccessFactors API Servers | SAP Help Portal](<https://help.sap.com/docs/SAP_SUCCESSFACTORS_PLATFORM/d599f15995d348a1b45ba5603e2aba9b/af2b8d5437494b12be88fe374eba75b6.html>).
   2. This connector will try to add the string "api" at the beginning of the base URL in case the already added base URL doesn't start with "api".
2. Select an **Authentication Type** from the drop-down menu.
3. Select a **Grant Type** from the drop-down menu.
4. Enter the **Company ID** for user provisioning.

   During licensing of the SuccessFactors solution, you are provided a unique company ID. The OData API uses the company ID attribute to validate your access token.
5. Enter the **Client ID** the authorization client issued you during the registration process. You receive the client ID when you [Register a Client Application in SuccessFactors SaaS](<#register-a-client-application-in-successfactors>).

   > **Note**
   >
   > The Client ID is required for OAuth 2.0 authentication.
6. Enter the SuccessFactors **User ID** that has the appropriate permissions as described in [Required Permissions](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/index.html#required-permissions>).
7. Enter the extracted **Private Key** from the X.509 certificate that was generated when you [Register a Client Application in SuccessFactors SaaS](<#register-a-client-application-in-successfactors>).

   > **Note**
   >
   > Private key information is required for OAuth 2.0 authentication for accessing SuccessFactors OData API.
8. Select **Save**.

## Configuring Additional Features

After establishing the connection, configure the source based on your requirements:

- [Configuring Aggregation Settings](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/aggregation_settings.html>)
- [Configuring Picklists](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/picklist_configuration.html>)
- [Configuring Advanced Settings](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/advanced_settings.html>)

## Additional Settings

Configure optional settings to modify the aggregation page size, API server URL, and API timeout.

> [!NOTE]
>
> **Screenshot**
>
> [![Additional Settings](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/additional_settings.png>)](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/additional_settings.png>)

1. In **Time Zone** Select the SuccessFactors Server Time Zone to use for all connector operations. If UTC is chosen, the connector will operate using the UTC time zone.
2. Enter **Page Size** to specify the number of records fetched in a single call. You must use a number between 200 and 800 records. The default value is 200 records.
3. Enter the **API Server URL** if the SuccessFactors API URL is different than the Base URL using the format `https://<host>:<port>`.
4. Enter the SuccessFactors **API Timeout** duration in minutes. The default value is `5` minutes.
5. Select **Save**.

## Review and Test

Perform a test to confirm the connection to SailPoint.

1. Go to **Review and Test**.
2. Confirm that the entries in each field are correct.

   If you note any mistakes, return to the section and make corrections.
3. Select **Test Connection**.

## SailPoint Application Onboarding

SailPoint application onboarding enables you to easily onboard new applications and create sources following the successful onboarding of a discovery source. To use this feature, continue to **Discovered Applications** in the SailPoint user interface.

For more information, refer to [Application Onboarding](<https://documentation.sailpoint.com/saas/help/ai/app_onboarding/index.html>) in the SailPoint SaaS documentation.

# Delta Aggregation

The SuccessFactors SaaS connector supports delta aggregation for accounts. Delta aggregation aggregates new accounts or accounts that have changed since the last aggregation. For more information, refer to [Configuring Delta Aggregations for Supported Sources](<https://documentation.sailpoint.com/saas/help/accounts/loading_data.html#configuring-delta-aggregations-for-supported-sources>).

- In delta aggregation, any attribute changes that come under the effective-dated entities of Employees or Users with Employment are aggregated.
- The delta for SuccessFactors gets populated based on the `last_modified_on` field, which is used in SuccessFactors Employee Central - Compound Employee API. The delta aggregation can capture a delta max for the last 90 days. This means that any data change done prior to 90 days of the last successful account aggregation timestamp are not captured and a full account aggregation is required.
- The connector fetches only the attributes included in `querymode=delta` from the Compound Employee API.
- If there is any change in the configuration of the application, run a full account aggregation before running delta aggregation.

# Enabling a Welcome Message

> [!NOTE]
>
> This option is only available for User Management.

To send a welcome message to newly created users in SuccessFactors:

1. Go to **Admin Center \> Platform Feature Settings**.
2. Enable the **Send Welcome Message**.
3. Select **Save**.

# Aggregating SuccessFactors SaaS Groups and Roles

Configure group and role aggregation for the SuccessFactors SaaS connector.

## Aggregating SuccessFactors SaaS Groups

By default, the following account and entitlement schema attributes are present for new sources. For existing sources, schema attributes may be missing and you must add them manually. For more information, refer to [Adding Attributes to a Source Schema](<https://documentation.sailpoint.com/saas/help/accounts/schema.html#editing-an-account-schema>).

Account Schema Attributes:

- Groups
- Roles

Attributes for the Group Entitlement Object:

- GroupName
- GroupID
- GroupType
- CreatedBy
- LastModifiedDate
- IsStaticGroup
- Roles

Attributes for the Role Entitlement Object:

- RoleName
- RoleID
- Groups

### Additional Attributes Configuration

You can configure the values of the following additional attributes using the REST API:

```text
POST <url>/api/source/update/<sourceID>
```

Where:

- `<url>` - The URL for your SailPoint tenant
- `<sourceID>` - The Source ID (number) obtained through the UI

> [!NOTE]
>
> For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication](<https://developer.sailpoint.com/docs/api/authentication/>) and [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1/>) in the SailPoint Developer Community.

In the body of the POST, use form-data for different attributes, as follows:

#### batchSizeUserRole

This attribute determines the number of requests required to get role details for multiple users using a single SuccessFactors OData batch operation.

- **Key** - `connector_batchSizeUserRole`
- **Value** - For example, you can use `20`. The maximum value is `100`.

#### batchSizeUserGroup

This attribute determines the number of requests required to get group details for multiple users using a single SuccessFactors OData batch operation.

- **Key** - `connector_batchSizeUserGroup`
- **Value** - For example, you can use `10`. The maximum value is `100`.

#### includeWorkflowGroups

Set this attribute value to `true` to aggregate the workflow group in the entitlement aggregation process.

- **Key** - `connector_includeWorkflowGroups`
- **Value** - `true`

#### includeInactiveGroupsOfRole

Set this attribute value as `true` to aggregate the inactive roles assigned to a group.

- **Key** - `connector_includeInactiveGroupsOfRole`
- **Value** - `true`

# Integrating SailPoint with SuccessFactors SaaS

> [!NOTE]
>
> **Integration**
>
> This is an integration and requires additional licensing or subscriptions to utilize it. For more information, contact your customer success manager.

Connecting SailPoint to your SAP SuccessFactors Employee Central module allows you to seamlessly automate your joiner, mover, and leaver functions. This guide provides the information you need to configure bidirectional usage of SuccessFactors SaaS in SailPoint either as a managed resource or a source of identity data. You can use this connector to manage both users and employees.

Employee Central and user management modules must be enabled in SuccessFactors to use this SailPoint connector. For additional prerequisites, refer to [Prerequisites](<#prerequisites>).

> [!NOTE]
>
> To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes](<https://community.sailpoint.com/release-notes/saas>) page.

## Supported Features

The SuccessFactors SaaS connector supports the following features:

- Full account aggregation
- Single account aggregation
- Full entitlement aggregation
- Add entitlement(s) (only Static groups)
- Remove entitlement(s) (only Static groups)
- Delta aggregation for employees / users with employment
- Multiple group objects.

  The `Group` and `Role` entitlement objects are supported.

  > **Note**
  >
  > Role entitlements are SuccessFactors permission roles from Manage Permission Roles (RBP).
- Onboarding User aggregation and provisioning

  > **Note**
  >
  > User aggregation only supports Onboarding users with `e` status (`active_external_suite`) or `d` status (`inactive_external_suite`). For more information on provisioning Onboarding users, refer to [Default Update Account Attributes](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/provisioning.html#default-update-account-attributes>).
- Onboarding Pre-Hire aggregation and provisioning under account types Employees

  > **Note**
  >
  > To fetch Pre-Hire onboarding 2.0 should be enabled in SuccessFactors.
- Create account provisioning
- Update account provisioning
- Enable and disable accounts through provisioning
- Change account password

For more information on features, refer to [Source Features](<https://community.sailpoint.com/knowledge/Identity-Security-Cloud-Source-Features>).

The SuccessFactors SaaS connector supports the following features based on account types:

| Operations | Users | Employees |
| --- | --- | --- |
| Aggregation | Yes | Yes |
| Get Account | Yes | Yes |
| Create | Yes | No |
| Update\* | Yes | Yes |
| Delete | No | No |
| Enable/Disable Users | Yes | No |
| Set Password | Yes | No |
| Add/Remove Entitlements (Static Group) | Yes | Yes |

### Aggregated Data

SailPoint aggregates the following information:

- person
- personal\_information
- address\_information
- email\_information
- phone\_information
- employment\_information
- job\_information

## Prerequisites

- To perform connection tasks, you must have the following permissions:

  | Category | Permission |
  | --- | --- |
  | Meta Data Framework | Admin access to MDF OData API |
  | Manage Integration Tools | Manage OAuth2 Client Application |

> [!NOTE]
>
> The SuccessFactors SaaS connector may have certain restrictions to external IP addresses. As a result, it may not be able to make the API calls required for some connector features. Work with your SAP administrators to remove these restrictions as required.

> [!IMPORTANT]
>
> Employee Central and user management modules must be enabled in SuccessFactors to use the SailPoint connector.

## Required Permissions

Certain operations may require specific permissions for the SuccessFactors service account. The operations are listed below along with the necessary permissions.

| Operation | Required Permissions |
| --- | --- |
| Test Connection | [Test Connection Permissions](<#test-connection-permissions>) |
| Aggregation | [Test Connection](<#test-connection-permissions>) and [Aggregation Permissions](<#aggregation-permissions>) |
| Provisioning | [Test Connection](<#test-connection-permissions>), [Aggregation](<#aggregation-permissions>), and [Provisioning Permissions](<#provisioning-permissions>) |

### Assigning Permissions to a Role in SuccessFactors

These steps provide the basic information for assigning permissions to a role in SuccessFactors. For current detailed information about role-based permissions, refer to the [SuccessFactors User Assistance Documentation](<https://apps.support.sap.com/sap/support/knowledge/en/2116024>).

1. In the **Permission Settings** section, select the **Permission** button to specify the permission you want to assign to the role.

   The **Permission Settings** window displays.
2. The available permission categories are listed on the left side of the page. Select a permission category to view the different available permissions.
3. Select the permissions you'd like to grant to the role.
4. Select **Done** when you finish marking your selections.
5. Select **Save Changes**.

### Test Connection Permissions

| Category | Permission |
| --- | --- |
| General User Permission | SFAPI User Login |
| Employee Central API | Employee Central HRIS SOAP API |

### Aggregation Permissions

> [!NOTE]
>
> - The **Manage Role-Based Permission Access** permission is needed to fetch Roles and Group objects. If you do not want to provide the **Manage Role-Based Permission Access** permission, Roles and Groups attributes need to be removed from the account schema object.
> - The **Manage User** to **Employee Export** permission does not need to be provided on the service account if you only want to aggregate users from the SuccessFactors system and not the employees. If this is the case you must add the **General User Permission** to **Company Info Access \> User Search** mandatory permission.

| Category | Permission |
| --- | --- |
| Manage User | Employee Export |
| Metadata Framework | Admin Access to MDF OData API |
| Manage System Properties | Picklist Management and Picklists Mappings Set Up |
| Employee Central API | Employee Central Foundation OData API (read-only) |
| Employee Central API | Employee Central HRIS OData API (read-only) |
| NA | Manage Role-Based Permission Access |
| General User Permission | Company Info Access \> User Search. For more information, refer to [Aggregating External Users](<#aggregating-external-users>). |

### Provisioning Permissions

| Category | Permission |
| --- | --- |
| Employee Central Import Settings | Import Employee Data |
| Employee Central API | Employee Central HRIS OData API (editable) |

### Providing Permissions to Service Accounts

To perform entitlement aggregation, follow these steps in SuccessFactors to provide **Manage Role-Based Permission Access** to the service account:

1. In SuccessFactors, go to **Admin Center** and search for **Manage Role-Based Permission Access**.
2. Select **Add User**.
3. Search through **User Name** and select the required user.
4. Select **Grant Permission**.

### Aggregating External Users

To aggregate external users, add the User Search permission to the role along with all required permissions. Once you have granted permissions to the given role, perform the following steps:

1. Go to **Admin Center** and search for **Manage Permission Roles**.
2. Select the permissions role you created.
3. Go to the **grant this role to** section.
4. Select **Add for external target population**.
5. Go to **Define whom you want to grant this role permission to**, and then select **Permission Group**.
6. Go to **Specify the target population whom the above granted users have permission to access**, and then in the **Target Population** section, select the **User Type** as **External Onboarding User**.
7. Select **Everyone (External Onboarding User)**.
8. Select **Done** and **Save** the changes.

# Machine Account Attributes

Machine account attributes are used in provisioning configurations for machine accounts.

After you have [created the required machine account subtypes](<https://documentation.sailpoint.com/saas/help/machine/account_configuration.html#creating-machine-account-subtypes>), you can use the machine account attributes to provision machine accounts in your SailPoint tenant.

Refer to [Machine Identity Security Overview](<https://documentation.sailpoint.com/saas/help/machine/index.html>) for more information.

## Machine Account Provisioning Attributes

| Field (key) | Label | Type | Required | Initial value/notes |
| --- | --- | --- | --- | --- |
| Userid | Userid | string | Yes | Static placeholder: Enter a unique Userid for the machine account. Requestor must supply a unique SuccessFactors User ID. |
| Username | Username | string | Yes | Static placeholder: Enter a unique Username for the machine account. Requestor must supply a unique SuccessFactors username. |
| password | password | secret | No | Generator: Create Password. Password is auto-generated unless overridden via Password Settings. |
| User.Status | User.Status | string | Yes | Default static value: active. Sets the SuccessFactors user status at creation. |

# Configuring SuccessFactors SaaS Picklists

SailPoint aggregates data from the SuccessFactors connector based on the picklist configuration. SailPoint provides a default picklist but you can add additional custom or standard attributes.

A picklist is a configurable set of options or selection lists used to populate a data input field having one or more predefined values in the SuccessFactors system.

> [!NOTE]
>
> Assign the following permissions to the service user along with the existing permissions to download the picklist-values.csv file.
>
> Admin Center Permissions:
>
> - Monitor Scheduled Jobs
> - Manage Scheduled Jobs

> [!NOTE]
>
> **Screenshot**
>
> [![Picklist Configuration](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/picklist_configuration.png>)](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/img/picklist_configuration.png>)

> [!CAUTION]
>
> The figure shows the default values to fetch data. You cannot change the **Event Name &amp; Status** or **Picklist Configuration Name** fields. Changing these values may cause the connector to not work properly. If you need to modify the **Option IDs** or **Picklist IDs** from the default to match your tenant configuration, refer to [Exporting and Verifying the Picklist Values](<#exporting-and-verifying-the-picklist-values>).

If you delete a default entry or need to modify an entry to match your default tenant configuration, complete the following steps:

1. Select **Add Another** to add a default value that may have been deleted.
2. Do one of the following:

   - For **ODATA Options ID Mapping**, enter the **Event Name &amp; Status** for lifecycle events or employee status based on which connector aggregates the data, and the **Option ID** associated with the event and employee status picklist.
   - For **Picklist ID Mapping**, enter the **Picklist Configuration Name** and associated SuccessFactors **Picklist ID**.
3. To **Aggregate Termination Date by Employee Status**, enter the status codes separated by a comma. For more information on termination statuses, refer to [Termination Date](<#termination-date>).
4. Select **Save**.

## Default Event Name and Status Values

Use the following table to re-enter the default values for **Event Names &amp; Status**.

> [!NOTE]
>
> The following values are provided as examples. The values may be different for your organization. Provide the values that apply to your environment.

| Event Name &amp; Status | Option IDs |
| --- | --- |
| SCWK | 30768 |
| EmplStatus-InActiveOptionIds | 4601,4602,4598,4600 |
| Hire | 3669 |
| Rehire | 3676 |
| EmplStatus-ActiveOptionIds | 4595,4603,4596,4597,4599 |

For example:

```xml
<entry key="odataEventOptionIdMap">
    <value>
        <Map>
            <entry key="EmplStatus-ActiveOptionIds" value="4595,4603,4596,4597,4599"/>
            <entry key="EmplStatus-InActiveOptionIds" value="4601,4602,4598,4600"/>
            <entry key="Hire" value="3669"/>
            <entry key="Rehire" value="3676"/>
            <entry key="SCWK" value="30768"/>
        </Map>
    </value>
</entry>
```

## Default Picklist Configuration Name Values

Use the following table to re-enter your organization's default Picklist Option ID names by matching the values in the Picklist ID column with those in the Picklist Configuration Name column.

> [!NOTE]
>
> The **Picklist Configuration Name** can't be changed or added in the Default Picklist Configuration map, whereas the **Picklist ID** should match the values present in your environment.

| Picklist Configuration Name | Picklist ID |
| --- | --- |
| employeeTypePicklist | employee-type |
| employeeStatusPickList | employee-status |
| employeeClassPickList | EMPLOYEECLASS |

For example:

```xml
<entry key="picklistConfigMap">
    <value>
        <Map>
            <entry key="employeeClassPickList" value="EMPLOYEECLASS"/>
            <entry key="employeeStatusPickList" value="employee-status"/>
            <entry key="employeeTypePicklist" value="employee-type"/>
        </Map>
    </value>
</entry>
```

## Picklist Sets and Values

The following tables list the default picklist sets and values used in this connector.

### For Life Cycle Events

| ^picklistId | OptionID | external\_code | en\_US |
| --- | --- | --- | --- |
| Event | 3669 | H | Hire |
| Event | 3676 | R | Rehire |
| Event | 30768 | SCWK | SCWK |

### For Employee Status

| ^picklistId | OptionID | external\_code | en\_US |
| --- | --- | --- | --- |
| employee-status | 4595 | A | Active |
| employee-status | 4596 | U | Unpaid Leave |
| employee-status | 4597 | P | Paid Leave |
| employee-status | 4598 | R | Retired |
| employee-status | 4599 | S | Suspended |
| employee-status | 4600 | T | Terminated |
| employee-status | 4601 | F | Furlough |
| employee-status | 4602 | O | Discarded |
| employee-status | 4603 | D | Dormant |

## Exporting and Verifying the Picklist Values

Export the picklist values from your SuccessFactors managed system and compare the values to the default values listed on [Configuring Picklists](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/picklist_configuration.html>). If the default values set in the SuccessFactors connector are not aligning with the managed system values, then the corresponding account is not aggregated.

> [!NOTE]
>
> For the most up-to-date and detailed instructions for obtaining picklist values, refer to [Exporting Picklists in the SAP Help Portal](<https://help.sap.com/viewer/aeb30e94eab54aa798af9c3f3b4bf40c/2105/en-US/fd1aec0ede1747b59562d4d96c8f96dd.html>).

Perform the following procedure to export picklist values:

1. In SuccessFactors, go to **Admin Center**.
2. Search for and select **Import and Export Data**.

   The **Import and Export Data** page displays.
3. In the **Select the action to perform** dropdown, select **Export Data**.
4. In the **Select Generic Object** dropdown, select Picklist or Picklist-Values. Keep the default settings for the other settings.
5. Select **Export**.

   A new job request is submitted for the picklist export.
6. Search for and select **Scheduled Job Manager**.

   The **Scheduled Job Manager** page displays.
7. Refresh your browser until the job is complete and is present in the jobs list. Once the job is complete, select the **Download Status** of the respective job name to download the .zip file.
8. Extract the downloaded .zip file.

   This .zip file contains the Picklist-Values.csv.

   - **For Life Cycle Events** - Search for the **event** associated with the `picklistId` and use the `OptionId` value as required.
   - **For Employee Status** - Search for the **Employee Status** associated with the `picklistId` and use the `OptionId` value as required.

> [!NOTE]
>
> If the default values set in this connector don't align with the managed system values as described, then the corresponding account is not aggregated.

## Employee Status

In the SuccessFactors source, the identity status connected to an account is based on the employee status as specified. The default statuses are:

| Enabled | Disabled |
| --- | --- |
| Active | Furlough |
| Dorman | Discarded |
| Unpaid Leave | Retired |
| Paid Leave | Terminated |
| Suspended |  |

> [!IMPORTANT]
>
> If additional employee statuses other than the default values are present on the SuccessFactors managed system, they must be added to `EmplStatus-ActiveOptionIds` or `EmplStatus-InactiveOptionIds`. Otherwise, the records corresponding to the missing option ID are not aggregated.

## Termination Date

By default, this connector aggregates termination dates for the following employee statuses:

- **F** - Furlough
- **R** - Retired
- **T** - Terminated

To aggregate termination dates based on other PicklistID employee statuses - such as **Suspended** and **Discarded** - add the comma-separated list of external code values to the **Aggregate Termination Date by Employee Status** field on the **Picklist Configuration** page. For a full list of the Employee Status codes, refer to [Picklist Sets and Values](<#picklist-sets-and-values>).

To find external code values associated with the PicklistID employee status:

1. In the SuccessFactors managed system, go to the **Admin Center**.
2. Search for "Picklist Center".
3. Select the option **Export all picklist(s)** to generate a .csv file containing the picklist values.

## Improving Performance for Get Account Operations

Make the following changes to improve performance when you run a Get Account operation:

- Skip authorization/permissions checks during Get Account operations.
- Reference data mapping for the following attributes is saved after the aggregation. These saved values are used during Get Account operations:

  > **Note**
  >
  > If there are any changes to the values of any of the following attributes, perform the aggregation again.

  - EmployeeClass
  - EmployeeType
  - business phone
  - employeeStatus
  - AssignmentType
  - division
  - businessunit
  - company
  - cost center

# Provisioning

The SuccessFactors SaaS connector supports provisioning, allowing you to create and manage accounts and entitlements in SuccessFactors directly from SailPoint.

**Prerequisite:** Your system is configured for provisioning.

When SailPoint provisions new accounts to the source, it uses the attributes on the **Create Account** page as instructions or a template for what to include in the account. This page is also referred to as the *provisioning policy*.

When new access is granted on a source where a user does not already have an account, SailPoint automatically includes account creation in the provisioning. This applies whether provisioning is started from an access request or from an automated role or lifecycle state assignment.

For direct-connect sources, SailPoint automatically creates the account from this configuration. If the source is not configured as a direct-connect source, SailPoint creates and assigns a provisioning task to the source owner and includes the values for the source owner to use in manually creating the account.

> [!IMPORTANT]
>
> This section describes the default **Create Account** configuration. SailPoint recommends that you work with Services to define a provisioning configuration specific to your company's needs. Be sure to verify large changes to the provisioning policy before implementation. Failure to do so might cause provisioning to fail.

This topic contains information about the attributes supported by the connector's provisioning processes.

The attributes in the following list are only applicable for Users.

> [!CAUTION]
>
> Do not delete default User-specific attributes that you are provisioning from the account schema as they are required for provisioning operations.

- Username
- User.Status
- User.FirstName
- User.Email
- User.EmailType

  > **Note**
  >
  > Type of email address for the external user. If no value is provided, the attributes defaults to **O**. The possible values are:
  >
  > - **P** - Personal
  > - **B** - Business
  > - **O** - Other

## Default Update Account Attributes

The Update operation is supported for the attributes listed in the following table.

> [!NOTE]
>
> Onboarding Users in SAP SuccessFactors can have different statuses from one another. By default, the connector supports Onboarding Users with `d` and `e` statuses for the attributes listed as **Yes** in the **Onboarding Users** column below.

| Attribute | Users | Onboarding Users | Employees | Description |
| --- | --- | --- | --- | --- |
| Username | Yes | Yes | Yes | The user's username |
| User.Status | Yes | Yes | No | The user's status |
| User.FirstName | Yes | Yes | No | The user's first name |
| User.LastName | Yes | Yes | No | The user's last name |
| User.Email | Yes | Yes | No | The user's email address |
| User.EmailType | Yes | Yes | No | Type of email address for the external user. If no value is provided, the attributes defaults to **O**. The possible values are as follows: **P** - Personal, **B** - Business, **O** - Other. This attribute is mandatory and only applicable for Active or Inactive external users. |
| PrimaryEmailAddress | Yes | No | Yes | The user or employee's primary email address |
| BusinessPhone | Yes | Yes | Yes | The user or employee's business phone number |
| BusinessExtension | Yes | Yes | Yes | The user or employee's business phone number extension |
| BusinessPhoneCountryCode | Yes | Yes | Yes | The user or employee's business phone number country code |
| Person ID External | Yes | No | Yes | The person's unique identifier |
| IsContingentWorker | Yes | No | Yes | Indicates whether the Employee is Contingent Worker or not |
| Salutation | Yes | No | No | The person's salutation |
| FirstName | Yes | No | No | The person's first name |
| LastName | Yes | No | No | The person's last name |
| Date Of Birth | Yes | No | No | The person's date of birth |
| Gender | Yes | No | No | The person's gender |
| Country | Yes | No | No | The person's country of residence |
| Nationality | Yes | No | No | The person's nationality |
| Fax | Yes | No | No | The person's fax number |
| ServiceDate | Yes | No | No | The person's service start date |

> [!NOTE]
>
> For a user that does not have any employment data associated, the following attributes can't be updated:
>
> - Primary email address
> - Business Phone
> - Country code
> - Extension

## Provisioning of Email, Phone, and Username Attributes

The SuccessFactors connector can provision the following attributes:

- Business Phone
- BusinessExtension
- BusinessPhoneCountryCode
- Username
- PrimaryEmailAddress

The SuccessFactors connector considers the user's primary email address and business phone number as primary modes of communication.

### Configure the Connector to Provision Email, Phone, and Username Attributes

Provisioning the email address and phone number is based on the OData Queries that use the Picklist Option ID as an input.

> [!NOTE]
>
> The picklist mapping is for the attribute update only. For multiple entries, press **Enter** to separate them. For example:
>
> ```text
> PrimaryEmailAddress=<Associated Picklist optionID>
> BusinessPhone=<Associated Picklist optionID>
> ```

To enter picklist mappings of these attributes for provisioning:

1. In the SailPoint source configuration, go to **Advanced Settings**.
2. In the **Picklist Mapping** field, enter the picklist mapping of attribute.

### Attribute Configuration in the SuccessFactors Connector

If you want to change the Picklist Option ID, update the `picklistMapping` attribute using the REST API:

```text
POST <url>/sources/<sourceID>
```

Where:

- **\<url\>** - The URL for the customer's SailPoint tenant
- **\<sourceID\>** - The Source ID (number) obtained through the UI

In the body of the POST, use form-data as follows:

- **Key** - `connector_picklistMapping`
- **Value** - `["PrimaryEmailAddress=optionID","BusinessPhone=optionID"]`

For example,

```text
["PrimaryEmailAddress=8448","BusinessPhone=10605"]
```

> [!NOTE]
>
> For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication](<https://developer.sailpoint.com/docs/api/authentication/>) and [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1/>) in the SailPoint Developer Community.

### Attribute Synchronization and Target Mapping

You must get the source ID before synchronizing attributes. The source ID is displayed at the end of the URL in your browser address. The source ID is also known as the front-end ID for a source.

For more information, refer to [Best Practices: Attribute Sync](<https://community.sailpoint.com/knowledge/Best-Practices-Attribute-Sync>).

You can add the user name, phone numbers, and email attributes and map these source attributes to identity attributes.

> [!NOTE]
>
> This API does not apply to flat file sources.

Then you can map those identity attributes to the SuccessFactors target system attributes using the REST API:

```text
POST <url>/sources/<sourceID>
```

Where:

- **\<url\>** - The URL for the customer's SailPoint tenant
- **\<sourceID\>** - The Source ID (number) obtained through the UI

In the body of the POST, use form-data as follows:

- **Key** - `connector_featureString`
- **Value** - `SEARCH, PROVISIONING, SYNC_ PROVISIONING, MANAGER_LOOKUP`

> [!NOTE]
>
> For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication](<https://developer.sailpoint.com/docs/api/authentication/>) and [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1/>) in the SailPoint Developer Community.

To get and set the attribute synchronization mapping:

1. Make a GET request with the following command:

   ```text
   GET <url>/sources/<source_ID>/attribute-sync-config
   ```
2. Set the target value with the following command:

   ```text
   PUT <url>/sources/<sourceID>/attribute=sync-config
   ```

To set up the `PrimaryEmailAddress`, `BusinessPhone`, and `Username` as target attributes, use the following command in the body:

```json
{
    "attributes": [
        {
            "name": "email",
            "displayName": "att_email",
            "enabled": true,
            "target": "PrimaryEmailAddress"
        },
        {
            "name": "workPhone",
            "displayName": "Work Phone Number",
            "enabled": true,
            "target": "BusinessPhone"
        },
        {
            "name": "uid",
            "displayName": "uid",
            "enabled": true,
            "target": "Username"
        },
        {
            "name": "PhoneCountryCode",
            "displayName": "PhoneCountryCode",
            "enabled": true,
            "target": "BusinessPhoneCountryCode"
        },
        {
            "name": "PhoneExtension",
            "displayName": "PhoneExtension",
            "enabled": true,
            "target": "BusinessExtension"
        }
    ]
}
```

## Provisioning Additional Attributes Using the ODATA API

The SuccessFactors connector can provision additional attributes for `/User`, `/EmpJob`, and `/EmpEmployment` ODATA APIs. Currently, this is supported only in the Update operation.

> [!NOTE]
>
> - User attributes must use the `User` prefix. For example, `User.city`.
> - EmpJob attributes must use the `EmpJob` prefix. For example, `EmpJob.managerId`.
> - EmpEmployment attributes must use the `EmpEmployment` prefix. For example, `EmpEmployment.isContingentWorker`.

To find the supported attributes you want to add:

1. In the SuccessFactors managed system, go to **Admin Center**.
2. Search for and then select, **ODATA API DATA Dictionary**.
3. Search for `User`, `EmpJob`, or `EmpEmployment`.

   A list of supported attributes displays.
4. Check `column sap:upsertable`, the value should be `true`.
5. Copy the attribute names.

# Schema Reference

The application schema is used to configure the objects returned from a connector.

> [!NOTE]
>
> - The **Account Schema** tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as **Entitlement** or **Multi-Valued**. Refer to [Managing Source Account Schemas](<https://documentation.sailpoint.com/saas/help/accounts/schema.html>) for more information.
> - The schema attributes that are not present by [default](<#default-account-schema>) must be defined as strings if not specified.

The SuccessFactors SaaS connector uses the following default correlation and object configurations.

## Default Correlation Configuration

Before you aggregate accounts from this source, you can map account attributes with their corresponding identity attributes based on your requirements.

You can customize the correlation configuration. Refer to [Assigning Source Accounts to Identities](<https://documentation.sailpoint.com/saas/help/accounts/correlation.html>) for more information.

When you first create the SuccessFactors SaaS source, the default correlation mapping is:

| Account Attribute | Operation | Identity Attribute |
| --- | --- | --- |
| PersonID | Equals | Employee Number |
| PrimaryEmailAddress | Equals | Work Email |

## Default Account Schema

Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location.

The set of account attributes each source stores and how they're organized is known as the account's *schema*. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to [Managing Source Account Schemas](<https://documentation.sailpoint.com/saas/help/accounts/schema.html>) for more information.

### Default Account ID

SailPoint requires that certain attributes remain in your configuration. These attributes are referred to as *account IDs*.

> [!CAUTION]
>
> Changing the attribute marked as the account ID after aggregating accounts can result in duplicate accounts being created. To avoid this, either reset the accounts on this source before editing the account ID attribute or edit the account ID attribute before aggregating accounts.
>
> To resolve issues caused by changing account IDs, reconfigure them to their default values.

The following table lists the default account IDs for this connector:

| Account ID | Schema Object Type |
| --- | --- |
| PersonID | Account |
| GroupID | Group |
| RoleID | Role |

### Default Account Attributes

The SuccessFactors SaaS connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified.

| Attribute Name | Description |
| --- | --- |
| PersonID | The person's unique identifier. This is an Account ID which must not be changed. |
| Username | The person's username |
| Userid | The person's user ID |
| Salutation | The person's salutation |
| FormalName | The person's formal name |
| FirstName | The person's first name |
| MiddleName | The person's middle name |
| LastName | The person's last name |
| PreferredName | The person's preferred name |
| Department | The person's department name |
| Division | Represents the division name in the organization data |
| Company | The company under which the Employee belongs |
| Location | The person's work location name |
| Country | Name of the person's country |
| PositionNumber | The position number associated with the Employee |
| JobTitle | The job title associated with the Employee |
| EmployeeType | The Employee type |
| EmployeeStatus | The Employee's active Status |
| PrimaryEmailAddress | The person's primary email address |
| Job Classification | The person's job classification |
| CostCenterID | Cost center ID associated with the Employee |
| IsContigentWorker | Indicates whether the Employee is Contingent Worker or not |
| FLSA | FLSA status code |
| AssignmentType | The person's assignment type |
| ManagerID | The person's manager's unique identifier |
| CostCenter | The cost center associated with the Employee |
| EmployeeClass | The Employee's class designation |
| IsFullTime | Indicates whether the Employee is Full Time or Part Time |
| ServiceDate | The person's service start date |
| JobInfoLastModified | Date when Job Information was last modified |
| Position Entry Date | Position start date for Employee |
| LastDateWorked | Last date the Employee worked |
| BusinessPhone | The person's business phone number |
| BusinessPhoneCountryCode | The person's business phone country code |
| BusinessExtension | The person's business extension |
| Cell | The person's primary cell |
| CellCountryCode | The person's primary cell code |
| Fax | The person's fax number |
| FutureActions | Stores Information about Future Actions in the following JSON format: {"Actions": \[{"ActionType" : "\\\<ActionCode\>","ActionReason" : "\\\<Action Reason value\>","ActionStartDate" : "\\\<Start date\>","ActionEndDate" : "\\\<End date\>"}\]}. For example, {"Actions": \[{"ActionType" : "SCWK","ActionReason" : "Start CWK","ActionStartDate" : "2018-08-26","ActionEndDate" : "2018-09-08"}\]}. This attribute aggregates the ManagerID value along with existing future employment details. |
| Person ID External | The person's External ID |
| BusinessUnit | The person's business unit name |
| Termination Date | Populates the Termination Date for Employees and WorkOrder End Date for Contingent Workers. |
| Groups | Groups associated with the person. |
| Roles | Roles associated with the person. |

**Users-Only Attributes**

| Attribute Name | Description |
| --- | --- |
| User.Status | Status of the user |
| User.FirstName | First name of the user |
| User.LastName | Last name of the user |
| User.Email | Email address of the user |

## Default Entitlement Attributes

Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to [Managing Entitlements](<https://documentation.sailpoint.com/saas/help/access/entitlements.html>) for more information.

> [!CAUTION]
>
> Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations.

The attributes listed on this page define Group and Role type objects.

### Default Group Attributes

The SuccessFactors SaaS connector also supports groups. The following attributes must be configured on the managed system and in the SailPoint source schema to manage groups.

| Attribute Name | Description |
| --- | --- |
| GroupName | Name of the group |
| GroupID | ID of the group. This is an Account ID which must not be changed. |
| GroupType | The group's type |
| CreatedBy | User ID of the group's creator |
| LastModifiedDate | Date the group was last modified |
| IsStaticGroup | Indicates if the group is static or dynamic |
| Roles | Roles associated to the access group |

### Default Role Attributes

The SuccessFactors SaaS connector supports roles. The following attributes must be configured on the managed system and in the SailPoint source schema to manage roles.

| Attribute Name | Description |
| --- | --- |
| RoleName | Name of the role |
| RoleID | Internal ID of the role |
| Groups | Access groups associated to the role |

# Troubleshooting

If you encounter any of the following issues or errors, SailPoint recommends that you follow the guidance provided below to resolve the error before contacting SailPoint Support.

For issues or errors that are not addressed in this connector guide, refer to the following resources for troubleshooting information:

- [SailPoint Identity Services Documentation](<https://documentation.sailpoint.com/saas/help/index.html>)
- [SailPoint Support Knowledge Base](<https://support.sailpoint.com/csm?id=kb_view2&amp;kb_id=05ff44289f011200550bf7b6077fcfa3>)
- [SailPoint Developer Community](<https://developer.sailpoint.com/>)

## Debug Logs

For information about managing additional source settings, including debug logging and downloading connector logs, refer to [Managing Additional Settings](<https://documentation.sailpoint.com/saas/help/sources/managing_additional_settings.html>).

## Transport Error 401 Error

```text
org.apache.axis2.AxisFault: Transport error: 401 Error: HTTP/1.1 401 Unauthorized
```

This error can happen when the incorrect ClientID is entered in the source configuration.

**Resolution** - Correct the configuration details to resolve the issue.

## Unable to verify SAML assertion signature

```text
Unable to verify the signature of the SAML assertion
```

**Resolution** - The Client ID and Private key values should be correctly provided. These values must be a part of the same OAuth2 Client Applications.

## Unable to authenticate client - Invalid user

```text
Unable to authenticate the client (Login failed - Invalid user)
```

**Resolution** - Ensure that the User ID value is correct.

## Unable to authenticate client - Login failed - IP address is prohibited

A test connection fails with the following message:

```text
Unable to authenticate the client (Login failed - login from IP address <ip_address> is prohibited. You can set an API login exception to allow login from this IP address)
```

This connector may have restrictions to the IP addresses used to access the APIs required to support connector functions.

**Resolution** - Allow the necessary IP addresses per the following SAP knowledge base articles:

- [2161058 - Error in SuccessFactors API: "Attempted login from unauthorized ip"](<https://userapps.support.sap.com/sap/support/knowledge/en/2161058>)
- [Restricting API Access by IP Addresses or IP Address Ranges](<https://help.sap.com/docs/SAP_SUCCESSFACTORS_PLATFORM/d599f15995d348a1b45ba5603e2aba9b/265b5fa29d0a426d943cba2ae57e079b.html>)

> [!NOTE]
>
> The linked documents are not maintained by SailPoint and are subject to change without notice.

## Server is down or connection parameters are incorrect

Test Connection fails with the following error message:

```text
"[ ConnectorException ] [ Error details ] Exception occurred while iterate operation, refer logs for more details. Server is DOWN or Connection parameters are incorrect."
```

**Resolution** - Verify the connection parameters and check with your network team for the firewall restrictions.

## Timeout issue

```text
java.lang.RuntimeException: java.lang.InterruptedException: Timeout
```

**Resolution** - Use the REST API to add the `aggregateTimeout` attribute.

```text
POST <url>/api/source/update/<sourceID>
```

- `<url>` - The URL for the customer's SailPoint tenant
- `<sourceID>` - The Source ID (number) obtained through the UI

In the body of the POST, use form-data as follows:

- **Key** - `connector_aggregateTimeout`
- **Value** - Add as time in milliseconds

> [!NOTE]
>
> For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication](<https://developer.sailpoint.com/docs/api/authentication/>) and [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1/>) in the SailPoint Developer Community.

## Waiting for response from client

```text
java.lang.RuntimeException - java.lang.RuntimeException: java.lang.InterruptedException: Timeout waiting for response to message 3 from client 84a5de19-2861-4ca5-a8a1-ed4481e43e60 after 180 seconds
```

**Resolution** - Increase the timeout value using the REST API:

```text
POST <url>/api/source/update/<sourceID>
```

- `<url>` - The URL for the customer's SailPoint tenant
- `<sourceID>` - The Source ID (number) obtained through the UI

In the body of the POST, use form-data as follows:

- **Key** - `connector_aggregateTimeout`
- **Value** - Add as time in milliseconds, for example you can use 1000.

## Read timed out and entity value missing or no associated data found

The SuccessFactors connector displays the following error:

```text
"sailpoint.connector.ConnectorException: java.net.SocketTimeoutException: Read timed out" and "Possible suggestions : \n additional entity value is missing or \n No associated Data Found"
```

**Resolution** - Correct the XPaths for additional attributes added in the connector configuration. The semantics or syntax may be incorrect. For more information, refer to [Aggregating Additional Schema Attributes Using SFAPI](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/additional_attribute_aggregation.html#aggregating-additional-schema-attributes-using-sfapi>).

## Zero accounts are returned even after successful account aggregation

**Resolution** - Your source permissions and additional picklist values are not completely aligned with recommended practices:

- Ensure that the service account has all the Required Permissions.
- The Picklist ID value is different than the default values used. To change this value, refer to [Exporting and Verifying the Picklist Values](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/picklist_configuration.html#exporting-and-verifying-the-picklist-values>).
- Ensure the picklist values are correct or configured as described in [Configuring Picklists](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/picklist_configuration.html>).

## Fewer accounts than expected are returned even after successful account aggregation

The picklist values may differ from the default values in the connector.

**Resolution** - Ensure that the picklist values are correct or configured as described in [Configuring Picklists](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/picklist_configuration.html>).

## Aggregation fails with message about user unable to manage roles

```text
User '[<userId>]' does not have permission to manage roles.
```

**Resolution** - Ensure that the **Manage Role-Based Permission Access** permission is assigned to the user. For more information, refer to Required Permissions.

## Exception during aggregation of Object Type account on Application SF

```text
Unable to create iterator sailpoint.connector.InsufficientPermissionException:
[ InsufficientPermissionException ] [ Possible suggestions ] Provide the required permissions for the user. [ Error details ] "error" : { "code" : "COE_GENERAL_FORBIDDEN", "message" :{ "lang" : "en-US", "value" : "[COE0020]User [UserId] attempted to access dynamic group module [permission] without proper access privilege." }
```

**Resolution** - Ensure that the **Manage Role-Based Permission Access** permission is assigned to the service account user when the Roles and Groups attributes are added to the account schema object. For more information, refer to Required Permissions.

## Aggregation fails even though required permissions are set

```text
Entity FOLocation is not found. Please check the entity in Admin Center > OData API Data Dictionary or contact your system administrator
```

**Resolution** - Perform the following:

1. In SuccessFactors, go to **Admin Center** and search for **OData API Metadata Refresh And Export**.
2. Select **Refresh**.
3. Wait for the task to be completed.

## Error messages for user accessing dynamic group module and lacking permissions

```text
User [userId] attempted to access dynamic group module [permission] without proper access privilege.
```

and

```text
User "[userId]" does not have permission to manage roles
```

**Resolution** - Ensure the **Manage Role-Based Permission Access** permission is correctly assigned.

## Additional Entity Value is Missing or No associated Data Found

If the entities are not defined in the SuccessFactors managed system, then this error message displays:

```text
Additional Entity Value is Missing or No associated Data Found

"Got exception while parsing the active list
sailpoint.connector.ConnectorException: SFWebServiceFaultException
Exception during aggregation. Reason: java.lang.RuntimeException: sailpoint.connector.ConnectorException: SFWebServiceFaultException
java.lang.RuntimeException: sailpoint.connector.ConnectorException: SFWebServiceFaultException
```

**Resolution** - Ensure that defined and validated attributes are added to **Include Compound Employee API Entities** on the managed system. For more information, refer to [Including Compound Employee API Entities](<https://documentation.sailpoint.com/connectors/successfactors/saas/help/advanced_settings.html#include-compound-employee-api-entities>).

> [!NOTE]
>
> After the update, make sure to remove these values from the **Include Compound Employee API Entities** field as this field should contain only the nodes defined on the managed system.

## Aggregation fails with REST status code 404

```text
Authorization failed for REST: status code=404 Version of rest URL
```

**Resolution** - When specifying the target population to whom granted users have permission to access, exclude granted users from having the permission access to themselves. To do this, deselect the **Exclude granted users from having the permission access to themselves** checkbox.

## Identity information is missing following delta aggregation

Following a delta aggregation process, identity information such as `username` is missing.

**Cause** - The Compound API's standard query mode supports the Identity Information segment, but the delta mode does not. In delta mode, the system aggregates only the information included in `querymode=delta` for Compound Employee as part of delta aggregation processes.

**Resolution** - As a workaround, update `PerPerson` (biographical information) in parallel with an employee's Identity Information.

## Unknown format conversion exception

During aggregation the connector displays the following error:

```text
Caused by: java.util.UnknownFormatConversionException: Conversion = '1" during aggregation.
```

This issue occurs due to a picklist migration issue where two picklists with the same ID exists on both the MDF and Legacy sides (prior to the migration), but do not match. The migration keeps them separate and appends a suffix to their IDs.

**Resolution** - Complete the following:

- Refer to the [SAP documentation](<https://userapps.support.sap.com/sap/support/knowledge/E/2909791>) for more information on the causes of the error and the steps to resolve the issue.
- Update the `picklistConfigMap` entry in the source XML using the REST APIs.

  > **Note**
  >
  > For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication](<https://developer.sailpoint.com/docs/api/authentication/>) and [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1/>) in the SailPoint Developer Community.

## Entitlement aggregation fails with connector process failure

```text
[ConnectorError] error receiving response from connector: stream client connection is broken (connector process may have crashed):
```

**Resolution**: Reduce the value of the `connector_batchSizeUserGroup` and `connector_batchSizeUserRole` attributes using the SailPoint REST API. These attributes determines the number of roles/groups being fetched at a time. The default value for each attribute is `100`, and you can enter from `1` to `100`.

```json
[
    {
        "op": "add",
        "path": "/connectorAttributes/connector_batchSizeUserGroup",
        "value": "<value>"
    }
]

[
    {
        "op": "add",
        "path": "/connectorAttributes/connector_batchSizeUserRole",
        "value": "<value>"
    }
]
```

> [!NOTE]
>
> For more information on SailPoint's REST APIs, refer to [Best Practices: REST API Authentication](<https://developer.sailpoint.com/docs/api/authentication/>) and [REST API - Update Source (Partial)](<https://developer.sailpoint.com/docs/api/update-source-v-1/>) in the SailPoint Developer Community.

> [!IMPORTANT]
>
> SailPoint does not recommend provisioning attributes that are excluded from aggregation using the entity filters.

## Picklist Mapping is required field and cannot be blank

```text
connector.InvalidConfigurationException: PickList Mapping is required field and cannot be blank.
```

**Resolution** - Ensure that the picklist is configured with the correct values.

## No application attributes are configured for attribute synchronization

```text
IllegalStateException: No application attributes are configured for attribute synchronization
```

**Resolution** - Ensure that the identity attributes are synchronized with account attributes correctly.

## No data exists for the provided user

The following error message displays during provisioning and GET operations:

```text
sailpoint.connector.InvalidRequestException: No data exists for the provided user, please check nativeIdentity identityName(for e.g TestUser1)
```

**Resolution** - Perform the following:

1. Check the target population in the group that is assigned to the service account role.
2. Ensure that the **Manage Role-Based Permission Access** permission is assigned to service account user when the Roles and Groups attributes are added to the account schema object.

## Older employment information data is displayed for an account after Provisioning

**Resolution** - Check if the permissions have been properly set for the service account. Remove any extra permissions that are not mentioned in Required Permissions.

## Duplicate username HTTP 500 error

SuccessFactors `Username` provisioning fails with the following error message:

```text
Error in provisioning the httpcode: 500 error messsage: DUPLICATE_USERNAME : Failed to add/update user
```

**Resolution** - SuccessFactors allows you to update the `Username` attribute to a new and unique value, but not to a value that was previously assigned to it. For more information, refer to [SAP Notes](<https://me.sap.com/notes/0002217113>).

## Provisioning error message: "Ensure configuration parameters are with valid format": cannot be cast to class java.lang.string

Provisioning processes fail, and the connector returns the following error message:

```text
"Ensure configuration parameters are with valid format" :cannot be cast to class java.lang.string
```

**Resolution** - Ensure the source configuration parameters are correct and also in the right format syntactically. This can be confirmed by comparing the source config with a brand new default source.

## Invalid Session Error

```text
[ ConnectorException ] [ Possible suggestions ] Ensure configuration parameters are correct with a valid format, Ensure active network connectivity between Source and Target system. [ Error details ] java.lang.RuntimeException: Authorization failed for SOAP INVALID_SESSION error message- Invalid SFAPI session!
```

This error occurs when there is an issue with the SuccessFactors managed target system.

**Resolution** - One of the resolutions is to ensure that the Base Company URL is the API URL for the SuccessFactors managed target system, and not the WEB URL. For example:

- Web URL - `https://salesdemo4.successfactors.com`
- API URL - `https://apisalesdemo4.successfactors.com`

## Inconsistent or abnormal connector behavior for a particular duration

For example, receiving incorrect account statuses, not aggregating any accounts, or connection failures.

**Resolution** - Verify that there were no abnormalities, connection issues, or updates on the target system during the duration that you are seeing the inconsistent or abnormal behavior by checking with the SuccessFactors administrator and network team.