Contact Us 1-800-596-4880
  1. Homepage
  2. SAP SuccessFactors Connector (3.1)

  3. SAP SuccessFactors Connector Reference

All Connectors

SAP SuccessFactors Connector 3.1 Reference - Mule 4

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

Release Notes: SAP SuccessFactors Connector Release Notes

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

Basic Authentication

The connection types that can be provided to this configuration.

x

Expiration Policy

Expiration Policy

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

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. If the new data centers don’t appear in the dropdown list, you can manually enter the value of the new data center.

x

Use Persistent Connections

Boolean

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

true

Max Connections

Number

The maximum number of outbound connections to keep open at the same time. 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 only used when persistent connections are enabled.

30000

Stream Response

Boolean

Whether or not received responses should be streamed, meaning processing will continue as soon as all headers are parsed and the body streamed as it arrives. When enabled, the response MUST be eventually read since depending on the configured buffer size it may 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 Session Reuse feature. By default, it is false.

false

TLS Configuration

TLS

Protocol to use for communication. Valid values are HTTP and HTTPS. Default value is HTTP. When using HTTPS the HTTP communication is going to be secured using TLS / SSL. If HTTPS was configured as protocol then the user needs to configure at least the keystore in the tls:context child element of this listener-config.

Reconnection

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

Associated Operations

Create Entity

<successfactors:create-entity>

Creates a new Entity Create Operation.

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 is part of

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 and to store the outcome of that expression 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 given entity.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Entity Set Name

String

The name of 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>

Retrieves an Entity Composing the OData URI.

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 search for using the entity with the given key.

x

Key Properties

Object

#[payload]

x

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 and to store the outcome of that expression 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>

Queries entities of a determined type.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Entity Set Name

String

The type of entity to list.

x

Filter

One of:

Order By Values

Array of Order By Value

Page Size

Number

100

Top

Number

Skip

Number

Streaming Strategy

Configure to use repeatable streams.

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 and to store the outcome of that expression 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

The type of entity being updated. This value is dinamically loaded from 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

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

Trust Store

Key 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 trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

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 key store.

Type

String

The type of store used.

Alias

String

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

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify 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 before).

Soft Fail

Boolean

Avoid verification failure when the revocation server can not 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 trust store), if present.

CRL File

Field Type Description Default Value Required

Path

String

The 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 in milliseconds to reconnect.

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

Order Type

Enumeration, one of:

  • ASCENDING

  • DESCENDING

Property

String

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 amount 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

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

Field Name

String

x

Division

Field Type Description Default Value Required

Field Name

String

x

Module

Field Type Description Default Value Required

Field Name

String

x

Multiplication

Field Type Description Default Value Required

Field Name

String

x

Subtraction

Field Type Description Default Value Required

Field Name

String

x

In

Field Type Description Default Value Required

Field Name

String

x

Like

Field Type Description Default Value Required

Field Name

String

x

Query Value

Field Type Description Default Value Required

Value

String

And

Field Type Description Default Value Required

Operators

Array of One of:

x

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

Not

Field Type Description Default Value Required

Negative

One of:

x

Or

Field Type Description Default Value Required

Operators

Array of One of:

x

Grouping

Field Type Description Default Value Required

Operator

One of:

x

Field Name

String

x

Ends With

Field Type Description Default Value Required

Value

String

x

Field Name

String

x

Starts With

Field Type Description Default Value Required

Value

String

x

Field Name

String

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

See Also

MuleSoft Help Center

Back to top
View on GitHub