SuccessFactors 2022
SAP SuccessFactors is a major vendor of cloud-based human capital management software and talent management software. The company provides a cloud-based software for human capital management using the Software as a service (SaaS) model.
The SuccessFactors connector enables integration of the SAP SuccessFactors solution into the company’s IT environment for an uninterrupted data transmission.
In this particular connector version builder (wizard) was added and performance improvement was made.
CONFIGURATION
To configure the SuccessFactors 2022 connector, follow the instructions below:
- In the Main Menu, select Connections and press Create connection.
- On the Connector Selection Page select the SuccessFactors 2022 item from the Human Resources section.
- In the SuccessFactors Provider work area, fill in the following fields and press Create.
Field | Description |
---|---|
Connection* |
Enter a new connection alias (name) here. You should remember this name because you’ll need to choose it later while creating interface steps. |
Is Active |
Tick to enable/disable the checkbox to activate the connection for execution |
Cloud Agent* |
Choose an agent (LAN) you are working with and created before. . |
Implementation Type* |
Choose the connection implementation type between two supported values: default and Java. Choose Default for this connection. |
Is Source |
Enable the checkbox to ensure data import. This entity is available as a data source for Import (writing to Schema). |
Is Target |
Enable the checkbox to ensure data export. This entity is available as a data target that receives data from schema to the current data container. |
Timeout |
Set the time value in milliseconds to stop the system from connection attempts. Timeout is the length of time the IConduct platform waits for a response from the connection provider before returning a timeout error. |
Query | This box is intended for entering a query. You can test the defined query by clicking Test Query once the connection is saved. It’s recommended to test the query after the connection testing. |
DateTime Format |
This option is not used in this connector. |
Server URL* |
Write down the URL to your SuccessFactors system instance. Example: https://demo.successfactors.com/odata/v2 |
Username and password |
Write down the username and password for the SuccessFactors account. |
*- mandatory fields.
- After your connection is saved, you can test if it is successful by clicking Test Connection on the toolbar. If the created connection works, you will receive a success message.
USAGE
In order to use this connection it is required to create an IMPORT step. This version of the connector has a wizard inside, the so-called BUILDER. If you need, you can use QUERY instead. To use this builder you need to do such steps:
- Choose the query type (tables or objects) from the list. Some of them are default and some are custom-made. When your connector is online, it reads all metadata, puts it in the cache and gives you the list of objects.
Note: if you added a new object, but the connector doesn’t show it to you in the list, you need to click the button Clear Cache on the top. If it doesn’t help or you receive an error, you need to click the Open connection button and clear the cache in your previously created connector. Next time when you’re going to update the import step, it will do it a little bit slower, because it needs to create cache again.:
- After you choose the object, (e.g.: JobRequisition), you should wait for a while to allow to cache the object. You are going to see the “Object caching is in progress. Please wait” alert while caching. It may take a while. After being successfully cached you’re going to see the “Schema successfully loaded” alert downside.
- After being loaded, you can choose options. Such as Order By, Top, Skip, Key, Filter, Select, Expand. The main is Select or Expand.
The Select system query option allows clients to request a specific set of properties for each entity or complex type. This option is often used in conjunction with the Expand system query option.
- • Use Select if you want to do the import on chosen object level before (STEP 1). You have two possible options next: Select All or Select Specific.
• After choosing Select All you need to tick another checkbox Select All underneath to change the value from false to true.
• If you want to select some particular field/s, click Select Specific (don’t forget to unclick Select All before). Then you need to choose the field/s you need underneath on the particular level.
Note: Select Specific has a priority over Select All.
- To make sure everything is working fine, please click the Test Query button. It doesn’t give you all information, it just helps you to understand whether you’ve done everything correctly before.
- If you need to deep into the sublevel, you should use Expand option.
Expand option specifies the related resources to be included in line with retrieved resources. Each expanded item is evaluated relative to the entity containing the navigation property is expanded.
For example, if you chose the JobRequisition query type before, you would observe all sublevel fields of JobRequisition while doing Expand. After taking any option (let it be Hiring Manager) you can choose or Select or Expand.
So, you can expand sublevels of sublevels till there would be not any option to expand. You may look through your process by enjoying Query Preview on the right.
Note:For every object, there is or Select or Expand option if it is available.
So, you can expand sublevels of sublevels till there would be not any option to expand. You may look through your process by enjoying Query Preview on the right.
- You may use Filter options to get specific information. After clicking on this option, a special entry box for your filters appear.
Note: When you filter the values which don’t exist or are not available, you may receive an empty value as a result. If you receive the empty result, you have two options: it is empty at all (nothing with this parameter), or SuccessFactors API answers on this field as if there is nothing there.
The expression language that is used in Filter operators supports references to properties and literals. The literal values can be strings enclosed in single quotes, numbers and boolean values (true or false) or any of the additional literal representations. The operators supported in the expression language are shown in the following table:
Logical Operators
Operator (description) | Example |
---|---|
Eq (Equal) |
$filter=Address/City eq 'Redmond' |
Ne (Not equal) |
$filter=Address/City ne 'London' |
Get (Greater than) |
$filter=Price gt 20 |
Ge (Greater than or equal) |
$filter=Price ge 10 |
Lt (Less than) |
$filter=Price lt 20 |
Le (Less than or equal) |
$filter=Price le 100 |
And (Logical and) |
$filter=Price le 200 and Price gt 3.5 |
Or (Logical or) | $filter=Price le 3.5 or Price gt 200 |
Not (Logical negation) |
$filter=not endswith(Description,'employee') |
Arithmetic Operators
Operator (description) | Example |
---|---|
Add (Addition) |
$filter=Price add 5 gt 10 |
Sub (Subtraction) |
$filter=Price sub 5 gt 10 |
Mul (Multiplication) |
$filter=Price mul 2 gt 2000 |
Div (Division) |
$filter=Price div 2 gt 4 |
Mod (Modulo) |
$filter=Price mod 2 eq 0 |
Grouping Operators
Operator (description) | Example |
---|---|
( ) (Precedence grouping) |
$filter=(Price sub 5) gt 10 |
- You may use other possible options, such as:
Option | Description |
---|---|
Order By |
Allows clients to request resources in a particular order: ascending or descending. After choosing Order By to choose sub-option Direction with 2 possible values: asc or desc. |
Top |
Requests the number of items in the queried collection to be included in the result. |
Skip |
Requests the number of items in the queried collection that are to be skipped and not included in the result. |