Success Factors Connector This connector allows to integrate the Success Factor service. It covers all the service provided by SF. This is a generic service that enforces the use of Entities in all the major operations and query consults in SFQL (Success Factors Query Language). Also has a separate set of operations to work with asynchronous jobs.

Additional Info

Requires Mule Enterprise License

Yes  

Requires Entitlement

No  

Mule Version

3.7.0 or higher

Configs

Configuration

<successfactors:config>

Connection Management

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

username

String

A username

x 

password

String

A password

x 

companyId

String

The companyId used to access the SF service

x 

fetchAllEntities

Boolean

Tick this checkbox if you wish to work with the complete list of entities available in your organization.
WARNING: By enabling this, the initialization of list of entities available for most operations will be very SLOW (15 minutes or more).
It is recommended that you disable this option, and fill in the list of entities, only with the entities you wish to work with.

false

 

entityList

List<String>

List of entities that will be gathered for DataSense.

 

wsdlLocation

String

The wsdl location of the service definition. The connector is working with the 1.1 SOAP specification endpoint.

x 

proxyHost

String

The hostname of the HTTP proxy to use.

 

proxyPort

Integer

The port number of the HTTP proxy. Default value is 3128.

3128

 

proxyUsername

String

The username for the HTTP proxy. Optional.

 

proxyPassword

String

The password for the HTTP proxy. Optional.

 

Processors

List entities

<successfactors:list-entities>

List all the entities in your company instance.

XML Sample

<successfactors:list-entities config-ref="Success_Factors__Configuration"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

List<String>

A list of String that contains the names of the entities

Describe entities

<successfactors:describe-entities>

Returns metadata about the list of entities specified in the type parameter (both field and entity information).

XML Sample

<successfactors:describe-entities config-ref="Success_Factors__Configuration">
        <successfactors:types ref="#[payload]"/>
    </successfactors:describe-entities>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

types

List<String>

The list of entities from which you want to obtain detailed information

#[payload]

 

Returns

Return Java Type Description

List

A list of DescribeResult that has detailed information of each entity

Insert

<successfactors:insert>

  DataSense enabled

Inserts the objects of the specified entity type. The operation will resume if one row has failed to insert.

XML Sample

<successfactors:insert config-ref="Success_Factors__Configuration" type="Goal$1">
        <successfactors:input ref="#[payload]"/>
    </successfactors:insert>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The entity type to be inserted.

x 

input

Map<String,Object>

The processor's input, containing the list of entities to be inserted and extra parameters for configuration.

#[payload]

 

Returns

Return Java Type Description

InsertResult

The result of the operation

Update

<successfactors:update>

  DataSense enabled

Updates the objects of the specified entity type. The operation will resume if one row has failed to update.

XML Sample

<successfactors:update config-ref="Success_Factors__Configuration" type="user">
        <successfactors:input ref="#[payload]"/>
    </successfactors:update>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The entity type to be updated.

x 

input

Map<String,Object>

The processor's input, containing the list of entities to be updated and extra parameters for configuration.

#[payload]

 

Returns

Return Java Type Description

UpdateResult

The result of the operation

Upsert

<successfactors:upsert>

  DataSense enabled

Inserts or updates the objects of the specified entity type. If the row doesn't exist, perform the insert operation, if the row exists, perform the update operation. The operation will resume if one row has failed to upsert.

XML Sample

<successfactors:upsert config-ref="Success_Factors__Configuration" type="user">
        <successfactors:input ref="#[payload]"/>
    </successfactors:upsert>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The entity type to be upserted.

x 

input

Map<String,Object>

The processor's input, containing the list of entities to be updated/inserted and extra parameters for configuration.

#[payload]

 

Returns

Return Java Type Description

UpsertResult

The result of the operation

Delete

<successfactors:delete>

  DataSense enabled

Deletes the SFObjects specified by the type and the objects. The operation will resume if one row has failed to delete.

XML Sample

<successfactors:delete config-ref="Success_Factors__Configuration" type="Goal$1">
        <successfactors:input ref="#[payload]"/>
    </successfactors:delete>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

type

String

The entity type to be deleted.

x 

input

Map<String,Object>

The processor's input, containing the list of entities to be deleted and extra parameters for configuration.

#[payload]

 

Returns

Return Java Type Description

DeleteResult

The result of the operation

Query

<successfactors:query>

  Paged Operation

Queries the SuccessFactors platform with the given query string in SFQL (SuccessFactors Query Language). For a detailed grammar description, please check the related section in this reference guide.

XML Sample

<successfactors:query config-ref="Success_Factors__Configuration" queryString="SELECT email,externalId,firstName,lastName,username FROM user"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

queryString

String

The query in SFQL format

#[payload]

 

params

Map<String,String>

The extra parameters for the query. Optional.

 

pagingConfiguration

PagingConfiguration

The PagingConfiguration object with the needed parameters for paged queries.

x 

Returns

Return Java Type Description

ProviderAwarePagingDelegate<Map<String,Object>,SuccessFactorsConnector>

The QueryPagingDelegate that handles the calls to SuccessFactors to run the query.

Submit query job

<successfactors:submit-query-job>

Submit the asynchronous query job to the SuccessFactors platform with the given query string in SFQL (SuccessFactors Query Language). TaskStatus includes “taskId” which is used to identify a submitted job.

XML Sample

<successfactors:submit-query-job config-ref="Success_Factors__Configuration" queryString="SELECT email,externalId,firstName,lastName,username FROM user"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

queryString

String

The query in SFQL format

#[payload]

 

params

List

Extra parameters for configuration

 

Returns

Return Java Type Description

TaskStatus

The status of the task created

Get job status

<successfactors:get-job-status>

Get the execution status of the submitted asynchronous job.

XML Sample

<successfactors:get-job-status taskId="TASK-123" config-ref="Success_Factors__Configuration"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

taskId

String

The id of the task to obtain the status information

#[payload]

 

Returns

Return Java Type Description

TaskStatus

The status of the task requested

Get job result

<successfactors:get-job-result>

Download the result of submitted asynchronous query job.

XML Sample

<successfactors:get-job-result config-ref="Success_Factors__Configuration">
            <successfactors:params taskId="TASK-123" format="csv"/>
    </successfactors:get-job-result>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

params

GetJobResult

Extra parameters for configuration

#[payload]

 

Returns

Return Java Type Description

DataHandler

A DataHandler to obtain the information generated by the task

List jobs

<successfactors:list-jobs>

List all Jobs which are in running or waiting to run.

XML Sample

<successfactors:list-jobs config-ref="Success_Factors__Configuration"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

List

A list with the status of all the Jobs

Cancel job

<successfactors:cancel-job>

Download the result of submitted asynchronous query job.

XML Sample

<successfactors:cancel-job taskId="TASK-123" config-ref="Success_Factors__Configuration"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

taskId

String

The id of the task to cancel the execution

#[payload]

 

Returns

Return Java Type Description

TaskStatus

The status of the task stopped