Contact Free trial Login

SAP SuccessFactors Connector 3.2 Reference - Mule 4

Support Category: Select

Anypoint Connector for SAP SuccessFactors (SuccessFactors Connector) provides full support to query, create, update, and delete entities using the OData API exposed by SuccessFactors.

Default Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

Time Zone

String

Date objects returned from SuccessFactors are converted to the specified timezone.

UTC

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Basic Authentication Connection Type

Parameters

Name Type Description Default Value Required

Proxy Configuration

One of:

Data Center’s EndPoint URL

String

Data Center’s EndPoint URL

x

Use Persistent Connections

Boolean

If false, each connection is closed after the first request is completed.

true

Max Connections

Number

The maximum number of outbound connections to keep open concurrently. By default, the number of connections is unlimited.

-1

Connection Idle Timeout

Number

The number of milliseconds that a connection can remain idle before it is closed. The value of this attribute is used only when persistent connections are enabled.

30000

Stream Response

Boolean

Whether or not to stream received responses, meaning processing continues as soon as all headers are parsed and the body is streamed as it arrives. When enabled, the response must eventually be read since, depending on the configured buffer size, it might not fit into memory and processing stops until space is available.

false

Response Buffer Size

Number

The space in bytes for the buffer where the HTTP response is stored.

-1

Connection Timeout

Number

30000

Company ID

String

The Company ID

x

User Name

String

The user name

x

Password

String

The password

x

Enable Session Reuse

Boolean

Boolean to enable the Session Reuse feature. By default, it is false.

false

TLS Configuration

TLS

Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol then the user needs to configure at least the keystore in the tls:context child element of the listener-config.

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Create Entity

<successfactors:create-entity>

This operation creates a new entity, the type of which is defined by the Entity Set Name.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use

x

Entity Set Name

String

The entity set name to which the created entity belongs

x

Properties

Object

The properties of the entity

#[payload]

Target Variable

String

The name of a variable in which to place the operation’s output

Target Value

String

An expression to evaluate against the operation’s output, which is stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

For Configurations

Throws

  • SUCCESSFACTORS:BadRequestException

  • SUCCESSFACTORS:CONNECTIVITY

  • SUCCESSFACTORS:INVALID_PAGE_SIZE

  • SUCCESSFACTORS:META_DATA_ERROR

  • SUCCESSFACTORS:NOT_FOUND

  • SUCCESSFACTORS:OPERATION_FAILED

  • SUCCESSFACTORS:PARSE_ERROR

  • SUCCESSFACTORS:RETRY_EXHAUSTED

  • SUCCESSFACTORS:UNAUTHORIZED

  • SUCCESSFACTORS:UNKNOWN

  • SUCCESSFACTORS:VALIDATION

Delete Entity

<successfactors:delete-entity>

This operation deletes the entry for a specified entity.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

Entity Set Name

String

Name of the entity set from which to delete the entity

x

Key Properties

Object

#[payload]

x

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • SUCCESSFACTORS:BadRequestException

  • SUCCESSFACTORS:CONNECTIVITY

  • SUCCESSFACTORS:INVALID_PAGE_SIZE

  • SUCCESSFACTORS:META_DATA_ERROR

  • SUCCESSFACTORS:NOT_FOUND

  • SUCCESSFACTORS:OPERATION_FAILED

  • SUCCESSFACTORS:PARSE_ERROR

  • SUCCESSFACTORS:RETRY_EXHAUSTED

  • SUCCESSFACTORS:UNAUTHORIZED

  • SUCCESSFACTORS:UNKNOWN

  • SUCCESSFACTORS:VALIDATION

Get Entity By ID

<successfactors:get-entity-by-id>

This operation retrieves an entity by its specified key from the resource path of the URI.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Select

String

Value of a $select System Query Option is a comma-separated list of selection clauses, each of which can be a Property name, Navigation Property name, or asterisk (*) character.

Expand

String

The syntax of an $expand query option is a comma-separated list of Navigation Properties.

Entity Set Name

String

Entity set name to search using the entity with the given key.

x

Key Properties

Object

#[payload]

x

Target Variable

String

Name of a variable in which to place the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output, which is stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Object

For Configurations

Throws

  • SUCCESSFACTORS:CONNECTIVITY

  • SUCCESSFACTORS:RETRY_EXHAUSTED

Query

<successfactors:query>

This operation queries entities of a specified type.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Entity Set Name

String

Name of the entity set in which to query.

x

Filter

Order By Values

Array of Order By Value

Select

String

Specifies that a response from an OData service should return a subset of the Properties

Expand

String

The $expand parameter indicates a comma-separated list of Navigation Properties.

Page Size

Number

100

Top

Number

Skip

Number

Streaming Strategy

Configure the streaming strategy for the connector.

Target Variable

String

The name of a variable in which to place the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output, which is stored in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Output

Type

Array of Object

For Configurations

Update

<successfactors:update>

This operation replaces the existing data in an entity, so all property values in the entity either take the values provided in the request body or are reset to their default value if no data is provided in the request.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use

x

Entity Set Name

String

Entity set name. This value is dynamically loaded from the SuccessFactors OData description file.

x

Properties

Object

The properties that will be present on the new entity. These properties should contain the key of the entity.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

For Configurations

Throws

  • SUCCESSFACTORS:BadRequestException

  • SUCCESSFACTORS:CONNECTIVITY

  • SUCCESSFACTORS:INVALID_PAGE_SIZE

  • SUCCESSFACTORS:META_DATA_ERROR

  • SUCCESSFACTORS:NOT_FOUND

  • SUCCESSFACTORS:OPERATION_FAILED

  • SUCCESSFACTORS:PARSE_ERROR

  • SUCCESSFACTORS:RETRY_EXHAUSTED

  • SUCCESSFACTORS:UNAUTHORIZED

  • SUCCESSFACTORS:UNKNOWN

  • SUCCESSFACTORS:VALIDATION

Upsert Entity

<successfactors:upsert-entity>

This operation creates or updates an entity on SuccessFactors, the type of which is defined by the Entity Set Name property. This method returns the full SAP SuccessFactors upsert response after it finishes executing.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use

x

Entity Set Name

String

Entity set name. This value is dynamically loaded from SuccessFactors OData description file.

x

Properties

Object

Properties that will be present on the entity

#[payload]

Target Variable

String

Name of a variable on which to place the operation’s output

Target Value

String

An expression to evaluate against the operation’s output, which is stored in the target variable

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors

Output

Type

Object

For Configurations.

Throws

  • SUCCESSFACTORS:NOT_FOUND  

  • SUCCESSFACTORS:INVALID_PAGE_SIZE  

  • SUCCESSFACTORS:VALIDATION  

  • SUCCESSFACTORS:INVALID_INPUT  

  • SUCCESSFACTORS:TIMEOUT  

  • SUCCESSFACTORS:RETRY_EXHAUSTED  

  • SUCCESSFACTORS:UNKNOWN  

  • SUCCESSFACTORS:META_DATA_ERROR  

  • SUCCESSFACTORS:BAD_REQUEST  

  • SUCCESSFACTORS:SERVER_ERROR  

  • SUCCESSFACTORS:CONNECTIVITY  

  • SUCCESSFACTORS:UNAUTHORIZED  

  • SUCCESSFACTORS:PARSE_ERROR  

Types

TLS

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context

Trust Store

Key Store

Revocation Check

Trust Store

Field Type Description Default Value Required

Path

String

The location to resolve relative to the current classpath and file system (if possible) of the truststore.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the truststore.

Insecure

Boolean

If true, no certificate validations are performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

The location to resolve relative to the current classpath and file system (if possible) of the keystore

Type

String

Type of store used

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key to use. If not defined, the first key in the file is used by default.

Key Password

String

Password used to protect the private key

Password

String

Password used to protect the keystore

Algorithm

String

The algorithm used by the keystore

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Verify only the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected previously).

Soft Fail

Boolean

Avoid verification failure when the revocation server cannot be reached or is busy.

Custom OCSP Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the truststore), if present.

CRL File

Field Type Description Default Value Required

Path

String

Path to the CRL file

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often to reconnect (in milliseconds)

Count

Number

The number of reconnection attempts to make.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often to reconnect (in milliseconds)

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Order By Value

Field Type Description Default Value Required

Field

String

The field by which to order.

x

Direction

Enumeration, one of:

  • ASCENDING

  • DESCENDING

The direction by which to order. Default is ASCENDING

ASCENDING

Repeatable In-memory Iterable

Field Type Description Default Value Required

Initial Buffer Size

Number

This is the amount of instances to initially allow to be kept in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand and that to raise a STREAM_MAXIMUM_SIZE_EXCEEDED error when the buffer gets full. Default value is 100 instances.

Max Buffer Size

Number

This is the maximum amount of memory to use. If more than that is used then raise a STREAM_MAXIMUM_SIZE_EXCEEDED error. A value lower or equal to zero means no limit.

Repeatable File Store Iterable

Field Type Description Default Value Required

Max In Memory Size

Number

This is the maximum number of instances to keep in memory. If more than that is required, then it starts to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Non-repeatable Stream

In some cases, you may want to disable the repeatable stream functionality and use non-repeatable streams, which can have less performance overhead, memory use, and cost.

Default

Field Type Description Default Value Required

Host

String

Host where the proxy requests are sent.

x

Port

Number

Port where the proxy requests are sent.

x

Username

String

The username to authenticate against the proxy.

Password

String

The password to authenticate against the proxy.

Non Proxy Hosts

String

A list of comma separated hosts against which the proxy should not be used.

NTLM

Field Type Description Default Value Required

Ntlm Domain

String

The domain to authenticate against the proxy.

x

Host

String

Host where the proxy requests are sent.

x

Port

Number

Port where the proxy requests are sent.

x

Username

String

The username to authenticate against the proxy.

Password

String

The password to authenticate against the proxy.

Non Proxy Hosts

String

A list of comma separated hosts against which the proxy should not be used.

Addition

Field Type Description Default Value Required

Value To Add

Number

The value to add. Accepts a double.

x

Field Name

String

The name of the field on which to operate.

x

Division

Field Type Description Default Value Required

Divider

Number

The value by which the field value will be divided. This value should never be 0.

x

Field Name

String

The name of the field on which to operate.

x

Module

Field Type Description Default Value Required

Divider

Number

The value by which the field value will be divided. This value should never be 0.

x

Field Name

String

The name of the field on which to operate.

x

Multiplication

Field Type Description Default Value Required

Multiplier

Number

The value by which to multiply the value of the field.

x

Field Name

String

The name of the field on which to operate.

x

Subtraction

Field Type Description Default Value Required

Value To Substract

Number

The value to subtract. Accepts a double.

x

Field Name

String

The name of the field on which to operate.

x

In

Field Type Description Default Value Required

Values

Array of String

The list of values against which the field value will be checked.

x

Field Name

String

The name of the field on which to operate.

x

Like

Field Type Description Default Value Required

Value

String

The expression to evaluate against the field value.

x

Field Name

String

The name of the field on which to operate.

x

Query Value

Field Type Description Default Value Required

Value

String

Equal To

Field Type Description Default Value Required

Compared Value

String

x

Field Name

String

x

Greater Than

Field Type Description Default Value Required

Compared Value

String

x

Field Name

String

x

Lesser Than

Field Type Description Default Value Required

Compared Value

String

x

Field Name

String

x

Grouping

Field Type Description Default Value Required

Operator

x

Field Name

String

x

Ends With

Field Type Description Default Value Required

Ends With Value

String

The string value with which the field value should end.

x

Field Name

String

The name of the field on which to operate.

x

Starts With

Field Type Description Default Value Required

Starts With Value

String

The string value with which the field value should start.

x

Field Name

String

The name of the field on which to operate.

x

To Lowercase

Field Type Description Default Value Required

Field Name

String

x

To Uppercase

Field Type Description Default Value Required

Field Name

String

x

Trim

Field Type Description Default Value Required

Field Name

String

x