SAP SuccessFactors Connector 4.1 Reference - Mule 4

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

The timezone with which the Date objects returned from SuccessFactors are converted.

UTC

Name

The identifier of this element used to reference it in other components

x

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.

Proxy Configuration

Proxy configuration.

Data Center’s EndPoint URL

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

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

true

Max Connections

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

-1

Connection Idle Timeout

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

Connection Idle Timeout Time Unit

Connection idle timeout unit for the request

SECONDS

Stream Response

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

false

Response Buffer Size

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

-1

Connection timeout

Connection timeout for the request

30

Connection Timeout Unit

Connection timeout unit for the request

SECONDS

Default headers

Default HTTP headers to include in the message.

Default query parameters

Default Query parameters to include in the request.

Company ID

The Company ID

x

User Name

The user name

x

Password

The password

x

Enable Session Reuse

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

false

TLS Configuration

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.

Proxy Configuration

Proxy configuration.

Object Store

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

Data Center’s EndPoint URL

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

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

true

Max Connections

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

-1

Connection Idle Timeout

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

Connection Idle Timeout Time Unit

Connection idle timeout unit for the request.

SECONDS

Stream Response

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

false

Response Buffer Size

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

-1

Connection timeout

Connection timeout for the request.

30

Connection Timeout Unit

Connection timeout unit for the request.

SECONDS

Default headers

Default HTTP headers to include in the message.

Default query parameters

Default Query parameters to include in the request.

Client Id

The client ID to use for OAuth.

x

User Id

The user ID used for OAuth.

x

The private key from the X.509 certificate.

The private key obtained from the X.509 certificate generated by SuccessFactors.

x

The company id.

The company ID used in SuccessFactors.

x

The token url

The token URL that is passed to the identity provider to generate the OAuth Bearer token. The defaults is https://api4.successfactors.com/oauth/token.

The authorization url

The identity provider URL to use to retrieve the SAML assertion. The default is https://api4.successfactors.com/oauth/idp.

Scopes

The scopes.

TLS Configuration

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, at a minimum, the user must configure the keystore in the tls:context child element of the listener-config.

HTTP

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.

Configuration

String

Name of the configuration to use.

x

Config Ref

The name of the configuration to be used to execute this component

x

Entity Set Name

Entity set name to which the created entity belongs.

x

Properties

Properties of the entity.

#[payload]

Target Variable

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

Target Value

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Type

Attributes Type

Configuration

String

Name of the configuration to use

x

Config Ref

The name of the configuration to be used to execute this component

x

Entity Set Name

Name of the entity set from which to delete the entity

x

Key Properties

#[payload]

x

Reconnection Strategy

A retry strategy in case of connectivity errors

Configuration

String

Name of the configuration to use.

x

Select

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

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

Config Ref

The name of the configuration to be used to execute this component

x

Entity Set Name

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

x

Key Properties

#[payload]

x

Target Variable

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

Target Value

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors

Type

Attributes Type

Configuration

String

The name of the configuration to use.

x

Entity Set Name

Name of the entity set in which to query.

x

Filter

Filters to apply to the query.

Order By Values

Which fields the query is ordered by and their direction.

Select

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

Expand

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

Page Size

Chunk size of each query page.

100

Top

Maximum amount of records to retrieve.

Skip

Amount of records to skip before retrieving records.

Pagination Type

CLIENT

Config Ref

The name of the configuration to be used to execute this component

x

Streaming Strategy

Configure the streaming strategy for the connector.

Target Variable

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

Target Value

An expression that evaluates the operation’s output. The expression outcome is stored in the Target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Type

Configuration

String

Name of the configuration to use.

x

Config Ref

The name of the configuration to be used to execute this component

x

Entity Set Name

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

x

Properties

The properties that are 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.

Type

Attributes Type

Enabled Protocols

A comma-separated list of protocols enabled for this context

Enabled Cipher Suites

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

Trust Store

Key Store

Revocation Check

Path

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

Password

The password used to protect the trust store.

Type

The type of store used.

Algorithm

The algorithm used by the truststore.

Insecure

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

Path

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

Type

Type of store used

Alias

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

Password used to protect the private key

Password

Password used to protect the keystore

Algorithm

The algorithm used by the keystore

Only End Entities

Verify only the last element of the certificate chain.

Prefer Crls

Try CRL instead of OCSP first.

No Fallback

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

Soft Fail

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

Url

The URL of the OCSP responder.

Cert Alias

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

Path

Path to the CRL file

Fails Deployment

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.

Max Idle Time

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

A time unit that qualifies the maxIdleTime attribute

Field

The field by which to order.

x

Direction

The direction by which to order. Default is ASCENDING

ASCENDING

Initial Buffer Size

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

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

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.

In Memory Objects

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

The unit in which maxInMemorySize is expressed

Host

Host where the proxy requests are sent.

x

Port

Port where the proxy requests are sent.

x

Username

The username to authenticate against the proxy.

Password

The password to authenticate against the proxy.

Non Proxy Hosts

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

Ntlm Domain

The domain to authenticate against the proxy.

x

Host

Host where the proxy requests are sent.

x

Port

Port where the proxy requests are sent.

x

Username

The username to authenticate against the proxy.

Password

The password to authenticate against the proxy.

Non Proxy Hosts

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

Value

Operators

x

Compared Value

x

Field Name

x

Compared Value

x

Field Name

x

Compared Value

x

Field Name

x

Negative

x

Operators

x

Operator

x

Field Name

x

Field Name

x

Field Name

x

Field Name

x