Veeva Vault Connector 1.5 リファレンス - Mule 4

Number (数値)

コネクタが Veeva Vault の応答を待機する最大時間 (ミリ秒単位)。この時間が経過すると、Response Timeout 例外がスローされます。

30000

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

Veeva Vault バースト API 制限超過が設定されているバースト API 制限プロファイル設定。デフォルトで有効化されます。

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

Veeva Vault の 1 日の API 制限超過が設定されている 1 日の API 制限プロファイル設定。デフォルトで有効化されます。

String (文字列)

ホスト。

Number (数値)

ポート。

String (文字列)

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

String (文字列)

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

String (文字列)

NTLM ドメイン。

String (文字列)

接続に必要な Veeva Vault インスタンスの URL。

x

String (文字列)

必要な Veeva Vault インスタンスのバージョン。

v19.3

String (文字列)

各リクエストヘッダーと共に Vault インスタンスに送信する必要があるクライアント ID。

x

String (文字列)

接続に必要な Veeva Vault インスタンスのユーザー名。

x

String (文字列)

接続に必要な Veeva Vault インスタンスのパスワード。

x

[Reconnection]

コネクタ操作で外部サーバーへの接続に失敗した場合に使用する再接続戦略を設定します。

Number (数値)

コネクタが Veeva Vault の応答を待機する最大時間 (ミリ秒単位)。この時間が経過すると、Response Timeout 例外がスローされます。

30000

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

Veeva Vault バースト API 制限超過が設定されているバースト API 制限プロファイル設定。デフォルトで有効化されます。

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

Veeva Vault の 1 日の API 制限超過が設定されている 1 日の API 制限プロファイル設定。デフォルトで有効化されます。

String (文字列)

ホスト。

Number (数値)

ポート。

String (文字列)

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

String (文字列)

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

String (文字列)

NTLM ドメイン。

String (文字列)

接続に必要な Veeva Vault インスタンスの URL。

x

String (文字列)

必要な Veeva Vault インスタンスのバージョン。

v19.3

String (文字列)

各リクエストヘッダーと共に Vault インスタンスに送信する必要があるクライアント ID。

x

String (文字列)

新しい OIDC プロファイルの作成時に Veeva によって生成される OIDC プロファイル ID。

x

[Reconnection]

コネクタ操作で外部サーバーへの接続に失敗した場合に使用する再接続戦略を設定します。

String (文字列)

サービスプロバイダーに登録されている OAuth コンシューマーキー。

x

String (文字列)

サービスプロバイダーに登録されている OAuth コンシューマーシークレット。

x

String (文字列)

サービスプロバイダーの認証エンドポイントの URL。

https://{IdentityProvider}/oauth2/v2.0/authorize

String (文字列)

サービスプロバイダーのアクセストークンエンドポイントの URL。

https://{IdentityProvider}/oauth2/v2.0/token

String (文字列)

OAuth ダンス時に要求する OAuth スコープ。この値のデフォルトはアノテーションのスコープです。

openid ​offline_access

String (文字列)

認証コード許可種別で使用するリソースオーナー ID。

String (文字列)

OAuth ダンスを開始する直前に実行するフローの名前。

String (文字列)

アクセストークンを受信した直後に実行するフローの名前。

String (文字列)

アクセストークンコールバックエンドポイントで要求をリスンする HTTP リスナー設定。

x

String (文字列)

アクセストークンコールバックエンドポイントのパス。

x

String (文字列)

OAuth ダンスをトリガーするローカル HTTP エンドポイントのパス。

x

String (文字列)

コールバックエンドポイントがプロキシの背後にあるか、間接 URL でアクセスする場合にコールバックエンドポイントにアクセスするために OAuth プロバイダーで使用する URL。

String (文字列)

各リソースオーナーのデータを保存するオブジェクトストアを設定します。設定されていない場合、Mule ではデフォルトのオブジェクトストアが使用されます。

String (文字列)

使用する設定の名前。

x

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

Metadata format (メタデータ形式)。

x

Binary (バイナリ)

入力ストリームとしてのドキュメントメタデータ。ペイロードの形式は、​[Metadata Format (メタデータ形式)]​ 項目で指定された形式である必要があります。

#[payload]

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

String (文字列)

この操作で出力されるペイロードのエンコード。

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

String (文字列)

操作の出力を保存する変数の名前。

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

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

String (文字列)

使用する設定の名前。

x

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

Metadata format (メタデータ形式)。

x

Binary (バイナリ)

入力ストリームとしてのドキュメントメタデータ。ペイロードの形式は、​[Metadata Format (メタデータ形式)]​ 項目で指定された形式である必要があります。

#[payload]

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

String (文字列)

この操作で出力されるペイロードのエンコード。

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

String (文字列)

操作の出力を保存する変数の名前。

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

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

String (文字列)

使用する設定の名前。

x

String (文字列)

オブジェクト名。

x

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

Metadata format (メタデータ形式)。

x

Binary (バイナリ)

Vault で一括オブジェクトレコードを作成するための入力ストリームとしての CSV または JSON 形式の Vault オブジェクトメタデータ。

#[payload]

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

String (文字列)

この操作で出力されるペイロードのエンコード。

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

String (文字列)

操作の出力を保存する変数の名前。

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

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

String (文字列)

使用する設定の名前。

x

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

Metadata format (メタデータ形式)。

x

Binary (バイナリ)

Vault から複数のドキュメントレンディションを削除するための入力ストリームとしての CSV または JSON 形式のドキュメントメタデータ。

#[payload]

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

String (文字列)

この操作で出力されるペイロードのエンコード。

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

String (文字列)

操作の出力を保存する変数の名前。

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

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

String (文字列)

使用する設定の名前。

x

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

Metadata format (メタデータ形式)。

x

Binary (バイナリ)

Vault から単一または複数のドキュメントを削除するための入力ストリームとしての CSV または JSON 形式のドキュメントメタデータ。

#[payload]

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

String (文字列)

この操作で出力されるペイロードのエンコード。

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

String (文字列)

操作の出力を保存する変数の名前。

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

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

String (文字列)

使用する設定の名前。

x

String (文字列)

オブジェクト名。

x

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

Metadata format (メタデータ形式)。

x

Binary (バイナリ)

Vault で一括オブジェクトレコードを作成するための入力ストリームとしての CSV または JSON 形式の Vault オブジェクトメタデータ。

#[payload]

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

String (文字列)

この操作で出力されるペイロードのエンコード。

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

String (文字列)

操作の出力を保存する変数の名前。

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

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

String (文字列)

使用する設定の名前。

x

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

Metadata format (メタデータ形式)。

x

Binary (バイナリ)

Vault からドキュメントをエクスポートするための入力ストリームとしての CSV または JSON 形式のドキュメントメタデータ。

#[payload]

Boolean (ブール)

ソースファイルを除外するには、​false​ に設定します。

true

Boolean (ブール)

レンディションを含めるには、​true​ に設定します。

false

Boolean (ブール)

すべてのバージョンまたは最新バージョンを含めるには、​true​ に設定します。

false

Number (数値)

ジョブが正常に終了するまで、指定した間隔 (秒単位) で Vault をポーリングします。

10

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

String (文字列)

この操作で出力されるペイロードのエンコード。

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

String (文字列)

操作の出力を保存する変数の名前。

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

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

String (文字列)

使用する設定の名前。

x

String (文字列)

監査種別。

x

String (文字列)

監査情報を取得する開始日。過去 30 日より前の日付を指定することはできません。日付は ​YYYY-MM-DDTHH:MM:SSZ​ 形式である必要があります。日時は UTC です。時間を指定しない場合、デフォルトで、指定した日付の深夜 (T00:00:00Z) に設定されます。

String (文字列)

監査情報を取得する終了日。過去 30 日より前の日付を指定することはできません。日付は ​YYYY-MM-DDTHH:MM:SSZ​ 形式である必要があります。日時は UTC です。時間を指定しない場合、デフォルトで、指定した日付の深夜 (T00:00:00Z) に設定されます。

Number (数値)

ページあたりの制限数またはレコード数。

1000

Number (数値)

バッチごとのページ数。

10

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

String (文字列)

操作の出力を保存する変数の名前。

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

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

String (文字列)

使用する設定の名前。

x

Binary (バイナリ)

JSON 形式ペイロードのドキュメント ID メタデータ (例: {"documentId": "534"}​)。

#[payload]

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

String (文字列)

この操作で出力されるペイロードのエンコード。

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

String (文字列)

操作の出力を保存する変数の名前。

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

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

String (文字列)

使用する設定の名前。

x

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

String (文字列)

型を取得するためのドキュメント種別。

String (文字列)

型を取得するためのドキュメントサブタイプ。

String (文字列)

分類を取得するためのドキュメント分類。

Array of String (文字列の配列)

VQL クエリを構築するためのドキュメントプロパティのリスト。

String (文字列)

VQL クエリを動的にビルドするために追加する WHERE 句。

Number (数値)

1 ページあたりのレコード数を制限するフェッチサイズ。

1000

Number (数値)

指定されたバッチ数でのページ数に対応するバッチサイズ。

10

String (文字列)

操作の出力を保存する変数の名前。

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

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

String (文字列)

使用する設定の名前。

x

String (文字列)

オブジェクト名。

x

Array of String (文字列の配列)

動的 VQL クエリに含めるオブジェクト項目のリスト。

String (文字列)

Where 句。

Number (数値)

ページあたりの制限数またはレコード数。

1000

Number (数値)

バッチごとのページ数。

10

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

String (文字列)

操作の出力を保存する変数の名前。

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

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

String (文字列)

使用する設定の名前。

x

String (文字列)

選択リスト名。

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

String (文字列)

この操作で出力されるペイロードのエンコード。

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

String (文字列)

操作の出力を保存する変数の名前。

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

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

String (文字列)

使用する設定の名前。

x

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

String (文字列)

この操作で出力されるペイロードのエンコード。

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

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

要求を送信する HTTP メソッド。

GET

String (文字列)

要求を送信するパス (例: /vobjects/{object_name}/actions/{action_name}​)。

/

Any (任意)

要求メッセージの本文。

#[payload]

Object (オブジェクト)

メッセージに含まれる必要がある HTTP ヘッダー。

Object (オブジェクト)

Path​ 項目で指定された URI パラメーター。

Object (オブジェクト)

要求に含まれる必要があるクエリパラメーター。

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

要求をストリーミングで送信する必要があるかどうか。

String (文字列)

操作の出力を保存する変数の名前。

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

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

String (文字列)

使用する設定の名前。

x

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

String (文字列)

Veeva API ドキュメントで必須と指定されている VQL クエリ。

x

Object (オブジェクト)

#[{'name': 'Hemant', 'nickname': payload, 'company': vars.company}]​ の形式の入力パラメーター。

Number (数値)

ページあたりの制限数またはレコード数。

1000

Number (数値)

返される ​[Fetch Size (フェッチサイズ)]​ 要素のバッチの数。この項目は非推奨です。

10

String (文字列)

操作の出力を保存する変数の名前。

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

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

String (文字列)

使用する設定の名前。

x

Boolean (ブール)

Vault から受信した Spark ヘッダーを Spark Validator 出力に含めるためのフラグ。

false

String (文字列)

署名付きの受信 Spark メッセージを確認するために使用する公開キー (00001.pem) ファイルを保存するディレクトリパス。指定しない場合、Vault から取得します。

${mule.home}/apps/${app.name}/publickeys

Object (オブジェクト)

Vault から受信し、Spark メッセージに埋め込まれる Spark ヘッダー。

#[attributes.headers]

Input Stream (入力ストリーム)

Vault から受信した Spark メッセージ本文。

#[payload]

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

String (文字列)

この操作で出力されるペイロードのエンコード。

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

String (文字列)

操作の出力を保存する変数の名前。

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

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

String (文字列)

使用する設定の名前。

x

String (文字列)

アクセスを無効にするリソースオーナーの ID。

String (文字列)

使用する設定の名前。

x

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

Metadata format (メタデータ形式)。

x

Binary (バイナリ)

Vault で単一または複数のドキュメントを更新するための入力ストリームとしての CSV または JSON 形式の編集可能なドキュメントメタデータ。

#[payload]

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

String (文字列)

この操作で出力されるペイロードのエンコード。

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

String (文字列)

操作の出力を保存する変数の名前。

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

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

String (文字列)

使用する設定の名前。

x

String (文字列)

オブジェクト名。

x

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

Metadata format (メタデータ形式)。

x

Binary (バイナリ)

Vault で一括オブジェクトレコードを作成するための入力ストリームとしての CSV または JSON 形式の Vault オブジェクトメタデータ。

#[payload]

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

String (文字列)

この操作で出力されるペイロードのエンコード。

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

String (文字列)

操作の出力を保存する変数の名前。

String (文字列)

操作の出力を評価する式。式の結果は ​[Target Variable (対象変数)]​ 項目に保存されます。

#[payload]

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

Boolean (ブール)

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

使用する再接続戦略。

Number (数値)

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

Number (数値)

Mule アプリケーションで実行できる再接続の試行回数。

Number (数値)

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

Number (数値)

動的設定インスタンスがアイドル状態を続けられる最大時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。

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

[Max Idle Time (最大アイドル時間)]​ 項目の時間単位。

Number (数値)

データストリームに割り当てるメモリの初期容量。ストリーミングされたデータがこの値を超える場合は、​[Buffer Size Increment (バッファサイズ増分)]​ の単位で ​[Max In Memory Size (最大メモリ内サイズ)]​ 値を上限としてバッファが拡張されます。

Number (数値)

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

Number (数値)

バッファの最大サイズ。バッファサイズがこの値を超える場合、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。​0​ 以下の値は無制限を意味します。

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

[Initial Buffer Size (初期バッファサイズ)]​ 項目、​[Buffer Size Increment (バッファサイズ増分)]​ 項目、​[Buffer Unit (バッファ単位)]​ 項目の単位。

Number (数値)

ストリームのデータで使用できるメモリの最大量。メモリ量がこの値を超えると、コンテンツはディスクにバッファされます。パフォーマンスを最適化する方法は、次のとおりです。

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

[In Memory Size (メモリ内サイズ)]​ 項目の単位。

Number (数値)

データストリームに割り当てるメモリの初期容量。ストリーミングされたデータがこの値を超える場合は、​[Buffer Size Increment (バッファサイズ増分)]​ の単位で ​[Max In Memory Size (最大メモリ内サイズ)]​ 値を上限としてバッファが拡張されます。

Number (数値)

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

Number (数値)

バッファの最大サイズ。バッファサイズがこの値を超える場合、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。​0​ 以下の値は無制限を意味します。

Number (数値)

メモリ内に保持されるインスタンスの最大数。これ以上の量が必要な場合、ディスク上のコンテンツがバッファされます。

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

[In Memory Size (メモリ内サイズ)]​ 項目の単位。

Number (数値)

応答の HTTP 状況コード。旧 http.status。

x

String (文字列)

応答の HTTP の理由を示す語句。旧 http.reason。

x

Object (オブジェクト)

メッセージ内の HTTP ヘッダーのマッピング。旧 properties (プロパティ)。

x

Number (数値)

Veeva Vault API しきい値制限。このしきい値に達するかこのしきい値を超えた場合、コネクタは指定された時間待機します。

200

Number (数値)

しきい値に値に達したか、しきい値が残りの API コール数を超えた場合にコネクタが待機する時間。

5

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

[Wait Time (待機時間)]​ 項目の時間単位。

MINUTES

Number (数値)

許容される 1 日の API コール数の制限を設定する API 制限しきい値。API 制限しきい値に達すると、コネクタは、API コールを呼び出す要求ごとに ​API_LIMIT_EXCEED​ 例外をスローします。

10000