SAP SuccessFactors Query activity

Introduction

An SAP SuccessFactors Query activity, using its SAP SuccessFactors connection, retrieves object data from SAP SuccessFactors and is intended to be used as a source to provide data in an operation.

Create an SAP SuccessFactors Query activity

An instance of an SAP SuccessFactors Query activity is created from an SAP SuccessFactors connection using its Query activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Create an activity instance in Component reuse.

An existing SAP SuccessFactors Query activity can be edited from these locations:

• The design canvas (see Component actions menu in Design canvas).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).

Configure an SAP SuccessFactors Query activity

Follow these steps to configure an SAP SuccessFactors Query activity:

• Step 1: Enter a name and select object
  Provide a name for the activity and select an object.

• Step 2: Select a sub-object
  Select a sub-object.

• Step 3: Define a filter string
  Set conditions for a query on the selected objects.

• Step 4: Review the data schemas
  Any request or response schemas are displayed.

Step 1: Enter a name and select object

In this step, provide a name for the activity and select an object. Each user interface element of this step is described below.

• Name: Enter a name to identify the activity. The name must be unique for each SAP SuccessFactors Query activity and must not contain forward slashes / or colons :.

• Select an Object: This section displays objects available in the SAP SuccessFactors endpoint.

  • Selected Object: After an object is selected, it is listed here.

  • Search: Enter any column's value into the search box to filter the list of objects. The search is not case-sensitive. If objects are already displayed within the table, the table results are filtered in real time with each keystroke. To reload objects from the endpoint when searching, enter search criteria and then refresh, as described below.

  • Refresh: Click the refresh icon or the word Refresh to reload objects from the SAP SuccessFactors endpoint. This may be useful if objects have been added to SAP SuccessFactors. This action refreshes all metadata used to build the table of objects displayed in the configuration.

  • Selecting an Object: Within the table, click anywhere on a row to select an object. Only one object can be selected. The information available for each object is fetched from the SAP SuccessFactors endpoint:

    • Name: The name of the object

  Tip

  If the table does not populate with available objects, the SAP SuccessFactors connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

• Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

• Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Select a sub-object

In this step, select a sub-object. Each user interface element of this step is described below.

• Select a Sub-object: This section displays sub-objects available in the SAP SuccessFactors endpoint.

  • Selected Object: The object selected in the previous step is listed here.

  • Selected Sub-object: After a sub-object is selected, it is listed here.

  • Search: Enter any column's value into the search box to filter the list of sub-objects. The search is not case-sensitive. If sub-objects are already displayed within the table, the table results are filtered in real time with each keystroke. To reload sub-objects from the endpoint when searching, enter search criteria and then refresh, as described below.

  • Refresh: Click the refresh icon or the word Refresh to reload sub-objects from the SAP SuccessFactors endpoint. This may be useful if sub-objects have been added to SAP SuccessFactors. This action refreshes all metadata used to build the table of sub-objects displayed in the configuration.

  • Selecting a Sub-object: Within the table, click anywhere on a row to select a sub-object. Only one sub-object can be selected. The information available for each sub-object is fetched from the SAP SuccessFactors endpoint:

    • Name: The name of the sub-object.

    • Description: The description of the sub-object.

  Tip

  If the table does not populate with available sub-objects, the SAP SuccessFactors connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

• Back: Click to temporarily store the configuration for this step and return to the previous step.

• Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 3: Define a filter string

In this step, a query's Filter String is defined for a query using available object fields and query settings. Each user interface element of this step is described below.

The interface used in this step of the configuration of an SAP SuccessFactors Query activity depends on the tab selected:

• Basic: This option allows you to build the Filter String with guided fields.

• Advanced: This option hides the guided fields and allows you to modify the Filter String directly.

Basic

If the Basic tab is selected, this interface is presented:

• Object Fields: Select the fields to be used in the query based on the selected object class.

  • Search: Enter any part of a field name into the search box to filter the list of fields for the selected object. The search is not case-sensitive. The listed results are filtered in real time with each keystroke.

  • Refresh: Click the refresh icon or the word Refresh to reload fields of the object from the SAP SuccessFactors endpoint.

  • Select All in Object Class: When using the search box to filter, you can use this checkbox to select all visible fields at once.

  • Select Fields: Select the checkboxes of the fields you want included in the query to have them automatically added to the Filter String. You can also select all the fields at once using the parent checkbox.

  • Page Size: Enter a page size to enable result pagination. The number of results on a page will total up to the specified size. A link to the next page of results will also be included in the response.

  • Include Count: Select to include the number of results from a query as part of the response.

  • Full Text Search: Enter search terms to query for objects in the selected object class. The SAP SuccessFactors endpoint handles how the search is interpreted for an object class.

  • Skip: Enter a number of results to skip in the query response.

  • Top: Enter a maximum number of results to receive in the query response.

  • Conditional Clauses: To add conditionals, use these fields as input to help construct the clauses, which then appear in the Filter String.

    • Object: Use the dropdown to select the object class to use for the conditional.

    • Field: Use the dropdown to select the field from the object class to use for the conditional.

    • Operator: Use the dropdown to select an appropriate operator:

      Comparison
      Equals
      Greater Than
      Greater Than or Equals
      Less Than
      Less Than or Equals

    • Value: Enter the desired value to compare against the previous dropdown selections.

    • Remove: Click the delete icon to remove the conditional from the table.

    • Add: Click to add a new conditional to the table and Filter String.

    • Remove All: Click to remove all conditionals from the table and Filter String.

  • Filter String: As you fill out the other fields in the Basic tab, the filter string statement in this text box is automatically populated with the selected fields, conditions, and query options.

    Important

    Due to a connector limitation, if more than one filter is present in the Filter String, the operation will fail at run time.

• Test Query: Click to validate the query.

• Back: Click to temporarily store the configuration for this step and return to the previous step.

• Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Advanced

If the Advanced tab is selected, this interface is presented:

• Object Fields: Select the fields to be used in the query based on the selected object class.

  • Page Size: Enter a page size to enable result pagination. The number of results on a page will total up to the specified size. A link to the next page of results will also be included in the response.

  • Filter String: Edit the filter string statement directly.

    Important

    Due to a connector limitation, if more than one filter is present in the Filter String, the operation will fail at run time.

  • Test Query: Click to validate the query. If the query is valid, a sample of up to 10 records retrieved from the query is displayed in a table. If the query is not valid, relevant error messages are displayed. If you edit the filter string while in Advanced mode, the query must be valid and validated through this button in order to enable the Next button.

• Back: Click to temporarily store the configuration for this step and return to the previous step.

• Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 4: Review the data schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

• Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

  The SAP SuccessFactors connector uses the SAP SuccessFactors HXM Suite OData API v2. Refer to the API documentation for information on the schema nodes and fields.

  The Query activity uses JSON in its response schema.

• Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the SAP SuccessFactors endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

• Back: Click to temporarily store the configuration for this step and return to the previous step.

• Finished: Click to save the configuration for all steps and close the activity configuration.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next steps

After configuring an SAP SuccessFactors Query activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

SAP SuccessFactors Query activities can be used as a source with these operation patterns:

• Transformation pattern
• Two-target archive pattern (as the first source only)
• Two-target HTTP archive pattern (as the first source only)
• Two-transformation pattern (as the first source only)

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.