SAP SuccessFactors Connector 3.2 リファレンス

SAP SuccessFactors 用 Anypoint Connector (SuccessFactors Connector) では、SuccessFactors によって公開されている OData API を使用してエンティティをクエリ、作成、更新、削除できます。

デフォルト設定

パラメーター

名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

この設定に指定する接続型。

x

Time Zone (タイムゾーン)

String (文字列)

SuccessFactors から返された日付オブジェクトは指定されたタイムゾーンに変換されます。

UTC

Expiration Policy (有効期限ポリシー)

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。インスタンスが期限切れとみなされた瞬間にインスタンスが期限切れになるという意味ではありません。必要に応じて、インスタンスがパージされます。

Basic Authentication Connection Type

パラメーター

名前 型 説明 デフォルト値 必須

Proxy Configuration (プロキシ設定)

次のいずれかになります。

Data Center’s EndPoint URL (データセンターのエンドポイント URL)

String (文字列)

データセンターのエンドポイント URL。新しいデータセンターがドロップダウンリストに表示されない場合は、新しいデータセンターの値を手動で入力できます。

x

Use Persistent Connections (永続接続を使用)

Boolean (ブール)

false​ の場合、各接続は最初の要求が完了すると終了します。

true

Max Connections (最大接続数)

Number (数値)

同時に開いておくことができるアウトバウンド接続の最大数。デフォルトでは、接続数は無制限です。

-1

Connection Idle Timeout (接続アイドルタイムアウト)

Number (数値)

接続が終了するまでのアイドル状態を維持できるミリ秒。この属性の値は、永続接続が有効になっている場合にのみ使用されます。

30000

Stream Response (応答のストリーミング)

Boolean (ブール)

受信応答をストリーミングする (すべてのヘッダーが解析されたらすぐに処理を続行し、本文が到着したらストリーミングする) 必要があるかどうか。設定されたバッファサイズによっては、メモリに収まらず、容量が空くまで処理が停止する可能性もあるため、有効になっている場合は徐々に応答を読み取る必要があります。

false

Response Buffer Size (応答バッファサイズ)

Number (数値)

HTTP 応答が保存されるバッファの容量 (バイト)。

-1

Connection Timeout (接続タイムアウト)

Number (数値)

30000

Company ID (会社 ID)

String (文字列)

会社 ID。

x

User Name (ユーザー名)

String (文字列)

ユーザー名。

x

Password (パスワード)

String (文字列)

パスワード。

x

Enable Session Reuse (セッション再利用を有効化)

Boolean (ブール)

セッション再利用​機能を有効にするブール。デフォルトでは、false になっています。

false

TLS Configuration (TLS 設定)

TLS

Mule アプリケーションの通信を保護するためにクライアント側とサーバー側の両方から使用できる TLS の設定を定義します。HTTPS プロトコルを使用すると、HTTP 通信が TLS または SSL を使用して保護されます。プロトコルとして HTTPS が設定されている場合、ユーザーは ​listener-config​ の ​tls:context​ 子要素で少なくともキーストアを設定する必要があります。

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。​true​ に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Create Entity

<successfactors:create-entity>

この操作では新しいエンティティを作成します。このエンティティの種別は ​[Entity Set Name (エンティティセット名)]​ によって定義されます。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Entity Set Name (エンティティセット名)

String (文字列)

作成されたエンティティが属すエンティティセット名。

x

Properties (プロパティ)

Object (オブジェクト)

エンティティのプロパティ。

#[payload]

Target Variable (対象変数)

String (文字列)

操作の出力を配置する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。出力は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Object (オブジェクト)

次の設定の場合

スロー

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

この操作では、指定されたエンティティのエントリを削除します。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Entity Set Name (エンティティセット名)

String (文字列)

エンティティを削除するエンティティセットの名前。

x

Key Properties (キープロパティ)

Object (オブジェクト)

#[payload]

x

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

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

この操作では、URI のリソースパスから指定されたキーでエンティティを取得します。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Select

String (文字列)

$select​ システムクエリオプションの値は選択句のカンマ区切りリストであり、各選択句はプロパティ名、ナビゲーションプロパティ名、またはアスタリスク (*) 文字にすることができます。

Expand (拡張)

String (文字列)

$expand​ クエリオプションの構文はナビゲーションプロパティのカンマ区切りリストです。

Entity Set Name (エンティティセット名)

String (文字列)

エンティティと特定のキーを使用して検索するエンティティセット名。

x

Key Properties (キープロパティ)

Object (オブジェクト)

#[payload]

x

Target Variable (対象変数)

String (文字列)

操作の出力が配置される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。出力は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Object (オブジェクト)

次の設定の場合

スロー

  • SUCCESSFACTORS:CONNECTIVITY

  • SUCCESSFACTORS:RETRY_EXHAUSTED

Query

<successfactors:query>

この操作では、指定された種別のクエリエンティティを取得します。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Entity Set Name (エンティティセット名)

String (文字列)

照会するエンティティセットの名前。

x

Filter (検索条件)

Order By Values (並び替え基準)

Select

String (文字列)

OData サービスからの応答でプロパティのサブセットを返す必要があることを指定します。

Expand (拡張)

String (文字列)

$expand​ パラメーターは、ナビゲーションプロパティのカンマ区切りリストを示します。

Page Size (ページサイズ)

Number (数値)

100

Top (上位)

Number (数値)

Skip (スキップ)

Number (数値)

Streaming Strategy (ストリーミング戦略)

コネクタのストリーミング戦略を設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を配置する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。出力は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

型

Array of Object (オブジェクトの配列)

次の設定の場合

Update (更新)

<successfactors:update>

この操作では、エンティティの既存のデータを置き換えるため、エンティティのすべてのプロパティ値は、リクエストボディで提供される値になります。要求でデータが提供されない場合はデフォルト値になります。

パラメーター

名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Entity Set Name (エンティティセット名)

String (文字列)

エンティティセット名。この値は、SuccessFactors OData 記述ファイルから動的に読み込まれます。

x

Properties (プロパティ)

Object (オブジェクト)

新しいエンティティに提供されるプロパティ。これらのプロパティには、エンティティのキーが含まれている必要があります。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

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

この操作では SuccessFactors でエンティティを作成または更新します。このエンティティの種別は ​[Entity Set Name (エンティティセット名)]​ プロパティによって定義されます。このメソッドでは実行を完了した後の完全な SAP SuccessFactors 更新/挿入応答を返します。

パラメーター

Name (名前) 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

​x

Entity Set Name (エンティティセット名)

String (文字列)

エンティティセット名。この値は、SuccessFactors OData 記述ファイルから動的に読み込まれます。

​x

Properties (プロパティ)

Object (オブジェクト)

エンティティで表示されるプロパティ。

#[payload]

Target Variable (対象変数)

String (文字列)

操作の出力が配置される変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。出力は対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

​Type (型)​

Object (オブジェクト)

設定。

スロー

  • 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​  

型

TLS

項目 型 説明 デフォルト値 必須

Enabled Protocols (有効化されたプロトコル)

String (文字列)

このコンテキストで有効化されたプロトコルのカンマ区切りリスト。

Enabled Cipher Suites (有効化された暗号化スイート)

String (文字列)

このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。

Trust Store (トラストストア)

Key Store (キーストア)

Revocation Check (取り消し確認)

トラストストア

項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

トラストストアで、現在のクラスパスおよびファイルシステムに対して相対的に解決される場所 (可能な場合)。

Password (パスワード)

String (文字列)

トラストストアを保護するために使用するパスワード。

Type (型)

String (文字列)

使用するストアの型。

Algorithm (アルゴリズム)

String (文字列)

トラストストアで使用するアルゴリズム。

Insecure (安全ではない)

Boolean (ブール)

true の場合、証明書の検証が行われず、攻撃に対して脆弱な接続がレンダリングされます。各自の責任で使用してください。

Key Store (キーストア)

項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

キーストアで、現在のクラスパスおよびファイルシステムに対して相対的に解決される場所 (可能な場合)。

Type (型)

String (文字列)

使用するストアの型。

Alias (別名)

String (文字列)

キーストアに多数の非公開キーが含まれている場合は、この属性によって使用するキーの別名を示します。定義しない場合、ファイルにある最初のキーがデフォルトで使用されます。

Key Password (キーパスワード)

String (文字列)

非公開キーを保護するために使用するパスワード。

Password (パスワード)

String (文字列)

キーストアを保護するために使用するパスワード

Algorithm (アルゴリズム)

String (文字列)

キーストアで使用するアルゴリズム。

Standard Revocation Check (標準の取り消し確認)

項目 型 説明 デフォルト値 必須

Only End Entities (最後のエンティティのみ)

Boolean (ブール)

証明書チェーンの最後の要素のみを確認します。

Prefer Crls (CRL を優先)

Boolean (ブール)

最初に OCSP ではなく CRL を試みます。

No Fallback (代替なし)

Boolean (ブール)

第 2 の確認方法 (以前に選択されていない方法) を使用しません。

Soft Fail (ソフトフェール)

Boolean (ブール)

取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。

Custom OCSP Responder (カスタム OCSP レスポンダー)

項目 型 説明 デフォルト値 必須

Url

String (文字列)

OCSP レスポンダーの URL。

Cert Alias (証明書の別名)

String (文字列)

(トラストストアに含まれている) OCSP 応答の署名証明書の別名 (存在する場合)。

CRL File (CRL ファイル)

項目 型 説明 デフォルト値 必須

Path (パス)

String (文字列)

CRL ファイルへのパス。

Reconnection (再接続)

項目 型 説明 デフォルト値 必須

Fails Deployment (デプロイメントに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Count (数)

Number (数値)

再接続の試行回数。

blocking (ブロック)

Boolean (ブール)

false​ の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

Reconnect Forever (繰り返し再接続)

項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

blocking (ブロック)

Boolean (ブール)

false​ の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

Expiration Policy (有効期限ポリシー)

項目 型 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値。

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

maxIdleTime 属性の時間単位

Order By Value (並び替え基準)

項目 型 説明 デフォルト値 必須

Fields (項目)

String (文字列)

並び替えの基準となる項目。

x

Direction (方向)

Enumeration (列挙)。次のいずれかになります。

  • ASCENDING

  • DESCENDING

並び替えの方向。デフォルトは ASCENDING です。

ASCENDING

Repeatable In-memory Iterable (反復可能なメモリ内イテラブル)

項目 型 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

これは、ストリームをコンシュームし、ストリームへのランダムアクセスを提供するために、最初にメモリ内に保持することが許容されるインスタンスの量です。ストリームのデータ量がこのバッファサイズを超える場合は、bufferSizeIncrement 属性に従って、maxInMemorySize を上限としてバッファが拡張されます。デフォルト値は 100 インスタンスです。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。デフォルト値は 100 インスタンスです。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Repeatable File Store Iterable (反復可能なファイルストアイテラブル)

項目 型 説明 デフォルト値 必須

Max In Memory Size (最大メモリ内サイズ)

Number (数値)

メモリ内に保持されるインスタンスの最大数。これを超えると、ディスクへのコンテンツのバッファが開始されます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位

反復不可能ストリーム

場合によって、反復可能ストリーム機能を無効にして反復不可能ストリームを使用することが必要になることがあります。これにより、パフォーマンスオーバーヘッド、メモリ使用量、およびコストが軽減される可能性があります。

Default (デフォルト)

項目 型 説明 デフォルト値 必須

Host (ホスト)

String (文字列)

プロキシ要求が送信されるホスト。

x

Port (ポート)

Number (数値)

プロキシ要求が送信されるポート。

x

Username (ユーザー名)

String (文字列)

プロキシに対して認証するユーザー名。

Password (パスワード)

String (文字列)

プロキシに対して認証するパスワード。

Non Proxy Hosts (非プロキシホスト)

String (文字列)

プロキシを使用してはならないホストのカンマ区切りのリスト。

NTLM

項目 型 説明 デフォルト値 必須

Ntlm Domain (NTLM ドメイン)

String (文字列)

プロキシに対して認証するドメイン。

x

Host (ホスト)

String (文字列)

プロキシ要求が送信されるホスト。

x

Port (ポート)

Number (数値)

プロキシ要求が送信されるポート。

x

Username (ユーザー名)

String (文字列)

プロキシに対して認証するユーザー名。

Password (パスワード)

String (文字列)

プロキシに対して認証するパスワード。

Non Proxy Hosts (非プロキシホスト)

String (文字列)

プロキシを使用してはならないホストのカンマ区切りのリスト。

Addition (加算)

項目 型 説明 デフォルト値 必須

Value To Add (加算する値)

Number (数値)

加算する値。 double を受け入れます。

x

Field Name (項目名)

String (文字列)

操作を実行する項目の名前。

x

Division (区分)

項目 型 説明 デフォルト値 必須

Divider (除数)

Number (数値)

項目値を除算する値。この値は 0 にできません。

x

Field Name (項目名)

String (文字列)

操作を実行する項目の名前。

x

Module (モジュール)

項目 型 説明 デフォルト値 必須

Divider (除数)

Number (数値)

項目値を除算する値。この値は 0 にできません。

x

Field Name (項目名)

String (文字列)

操作を実行する項目の名前。

x

Multiplication (乗算)

項目 型 説明 デフォルト値 必須

Multiplier (乗数)

Number (数値)

項目の値を乗算する値。

x

Field Name (項目名)

String (文字列)

操作を実行する項目の名前。

x

Subtraction (減算)

項目 型 説明 デフォルト値 必須

Value To Substract (減算する値)

Number (数値)

減算する値。double を受け入れます。

x

Field Name (項目名)

String (文字列)

操作を実行する項目の名前。

x

In (含まれる)

項目 型 説明 デフォルト値 必須

Values (値)

Array of String (文字列の配列)

項目値をチェックする対象の値のリスト。

x

Field Name (項目名)

String (文字列)

操作を実行する項目の名前。

x

Like (部分一致)

項目 型 説明 デフォルト値 必須

Value (値)

String (文字列)

項目値に対して評価する式。

x

Field Name (項目名)

String (文字列)

操作を実行する項目の名前。

x

Query Value (クエリ値)

項目 型 説明 デフォルト値 必須

Value (値)

String (文字列)

Equal To (等しい)

項目 型 説明 デフォルト値 必須

Compared Value (比較値)

String (文字列)

x

Field Name (項目名)

String (文字列)

x

Greater Than (より大きい)

項目 型 説明 デフォルト値 必須

Compared Value (比較値)

String (文字列)

x

Field Name (項目名)

String (文字列)

x

Lesser Than (より小さい)

項目 型 説明 デフォルト値 必須

Compared Value (比較値)

String (文字列)

x

Field Name (項目名)

String (文字列)

x

Grouping (グループ化)

項目 型 説明 デフォルト値 必須

Operator (演算子)

x

Field Name (項目名)

String (文字列)

x

Ends With (次で終わる)

項目 型 説明 デフォルト値 必須

Ends With Value (値で終わる)

String (文字列)

項目値の末尾にする必要がある文字列値。

x

Field Name (項目名)

String (文字列)

操作を実行する項目の名前。

x

Starts With (次で始まる)

項目 型 説明 デフォルト値 必須

Starts With Value (値で始まる)

String (文字列)

項目値の先頭にする必要がある文字列値。

x

Field Name (項目名)

String (文字列)

操作を実行する項目の名前。

x

To Lowercase (小文字にする)

項目 型 説明 デフォルト値 必須

Field Name (項目名)

String (文字列)

x

To Uppercase (大文字にする)

項目 型 説明 デフォルト値 必須

Field Name (項目名)

String (文字列)

x

Trim (切り取り)

項目 型 説明 デフォルト値 必須

Field Name (項目名)

String (文字列)

x