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

設定

Veeva Vault Connector のデフォルト設定。

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

Name (名前)

String (文字列)

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

x

Connection (接続)

この設定の接続種別。

x

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

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

Basic Connection (基本接続)

認証に基本接続を使用します。

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

Response Timeout (応答タイムアウト)

Number (数値)

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

30000

Burst API Limit Profile (バースト API 制限プロファイル)

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

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

Daily API Limit Profile (1 日の API 制限プロファイル)

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

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

Host (ホスト)

String (文字列)

ホスト。

Port (ポート)

Number (数値)

ポート。

Username (ユーザー名)

String (文字列)

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

Password (パスワード)

String (文字列)

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

NTLM Domain (NTLM ドメイン)

String (文字列)

NTLM ドメイン。

Vault URL

String (文字列)

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

x

Version (バージョン)

String (文字列)

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

v19.3

Client Id (クライアント ID)

String (文字列)

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

x

Username (ユーザー名)

String (文字列)

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

x

Password (パスワード)

String (文字列)

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

x

Reconnection (再接続)

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

OAuth 2.0/Open ID Connection Provider (OAuth 2.0/Open ID 接続プロバイダー)

OAuth 2.0 を使用して、ユーザーアカウントをホストするサービスにユーザー認証を委任します。詳細は、​「コネクタの OAuth 2.0 の設定」​または​「CloudHub でのコネクタの OAuth 2.0 の設定」​を参照してください。

OpenID プロバイダーを認証し、発行されたアクセストークンを Veeva セッション ID と交換します。

この接続種別を設定する方法の詳細は、​「OAuth 2.0/Open ID 接続プロバイダー」​を参照してください。

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

Response Timeout (応答タイムアウト)

Number (数値)

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

30000

Burst API Limit Profile (バースト API 制限プロファイル)

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

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

Daily API Limit Profile (1 日の API 制限プロファイル)

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

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

Host (ホスト)

String (文字列)

ホスト。

Port (ポート)

Number (数値)

ポート。

Username (ユーザー名)

String (文字列)

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

Password (パスワード)

String (文字列)

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

NTLM Domain (NTLM ドメイン)

String (文字列)

NTLM ドメイン。

Vault URL

String (文字列)

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

x

Version (バージョン)

String (文字列)

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

v19.3

Client Id (クライアント ID)

String (文字列)

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

x

OIDC Profile Id (OIDC プロファイル ID)

String (文字列)

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

x

Reconnection (再接続)

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

Consumer Key (コンシューマーキー)

String (文字列)

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

x

Consumer Secret (コンシューマーシークレット)

String (文字列)

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

x

Authorization Url (認証 URL)

String (文字列)

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

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

Access Token Url (アクセストークン URL)

String (文字列)

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

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

Scopes (スコープ)

String (文字列)

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

openidoffline_access

Resource Owner Id (リソースオーナー ID)

String (文字列)

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

Before (前)

String (文字列)

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

After (後)

String (文字列)

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

Listener Config (リスナー設定)

String (文字列)

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

x

Callback Path (コールバックパス)

String (文字列)

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

x

Authorize Path (認証パス)

String (文字列)

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

x

External Callback Url (外部コールバック URL)

String (文字列)

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

Object Store (オブジェクトストア)

String (文字列)

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

操作

Create Document Renditions

<veevavault:create-document-renditions>

CSV または JSON 形式で提供されたドキュメントメタデータを使用して、Veeva Vault でドキュメントレンディションを一括作成します。

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Metadata Format (メタデータ形式)

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

  • CSV

  • JSON

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

x

Document Metadata (ドキュメントメタデータ)

Binary (バイナリ)

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

#[payload]

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Output Encoding (出力エンコード)

String (文字列)

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

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

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

関連する設定

スロー

  • VEEVAVAULT:API_LIMIT_EXCEEDED

  • VEEVAVAULT:INVALID_KEY_FORMAT

  • VEEVAVAULT:INVALID_SESSION_ID

  • VEEVAVAULT:EXECUTION

  • VEEVAVAULT:CLIENT_PROTOCOL

  • VEEVAVAULT:INVALID_DATA

  • VEEVAVAULT:RESPONSE_TIMEOUT

  • VEEVAVAULT:IOEXCEPTION

  • VEEVAVAULT:PARAMETER_REQUIRED

  • VEEVAVAULT:CONNECTIVITY

  • VEEVAVAULT:INVALID_AUTH

  • VEEVAVAULT:INVALID_DOCUMENT

  • VEEVAVAULT:USERNAME_OR_PASSWORD_INCORRECT

  • VEEVAVAULT:RETRY_EXHAUSTED

  • VEEVAVAULT:JSON_EXCEPTION

  • VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED

  • VEEVAVAULT:OPERATION_NOT_ALLOWED

  • VEEVAVAULT:METHOD_NOT_SUPPORTED

  • VEEVAVAULT:NO_PERMISSION

  • VEEVAVAULT:INVALID_SPARK_MESSAGE

  • VEEVAVAULT:INVALID_TOKEN

  • VEEVAVAULT:MALFORMED_URL

  • VEEVAVAULT:INSUFFICIENT_ACCESS

  • VEEVAVAULT:INACTIVE_USER

  • VEEVAVAULT:SESSION_EXPIRED

Create Documents

<veevavault:create-documents>

CSV または JSON 形式で提供されたドキュメントメタデータを使用して、Veeva Vault で 1 つまたは複数のドキュメントを作成します。

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Metadata Format (メタデータ形式)

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

  • CSV

  • JSON

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

x

Document Metadata (ドキュメントメタデータ)

Binary (バイナリ)

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

#[payload]

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Output Encoding (出力エンコード)

String (文字列)

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

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

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

関連する設定

スロー

  • VEEVAVAULT:API_LIMIT_EXCEEDED

  • VEEVAVAULT:INVALID_KEY_FORMAT

  • VEEVAVAULT:INVALID_SESSION_ID

  • VEEVAVAULT:EXECUTION

  • VEEVAVAULT:CLIENT_PROTOCOL

  • VEEVAVAULT:INVALID_DATA

  • VEEVAVAULT:RESPONSE_TIMEOUT

  • VEEVAVAULT:IOEXCEPTION

  • VEEVAVAULT:PARAMETER_REQUIRED

  • VEEVAVAULT:CONNECTIVITY

  • VEEVAVAULT:INVALID_AUTH

  • VEEVAVAULT:INVALID_DOCUMENT

  • VEEVAVAULT:USERNAME_OR_PASSWORD_INCORRECT

  • VEEVAVAULT:RETRY_EXHAUSTED

  • VEEVAVAULT:JSON_EXCEPTION

  • VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED

  • VEEVAVAULT:OPERATION_NOT_ALLOWED

  • VEEVAVAULT:METHOD_NOT_SUPPORTED

  • VEEVAVAULT:NO_PERMISSION

  • VEEVAVAULT:INVALID_SPARK_MESSAGE

  • VEEVAVAULT:INVALID_TOKEN

  • VEEVAVAULT:MALFORMED_URL

  • VEEVAVAULT:INSUFFICIENT_ACCESS

  • VEEVAVAULT:INACTIVE_USER

  • VEEVAVAULT:SESSION_EXPIRED

Create Object Records

<veevavault:create-object-records>

CSV または JSON 形式で提供されたオブジェクトメタデータを使用して、選択した Vault オブジェクトの一括オブジェクトレコードを作成します。

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Object Name (オブジェクト名)

String (文字列)

オブジェクト名。

x

Metadata Format (メタデータ形式)

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

  • CSV

  • JSON

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

x

Object Metadata (オブジェクトメタデータ)

Binary (バイナリ)

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

#[payload]

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Output Encoding (出力エンコード)

String (文字列)

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

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

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

関連する設定

スロー

  • VEEVAVAULT:API_LIMIT_EXCEEDED

  • VEEVAVAULT:INVALID_KEY_FORMAT

  • VEEVAVAULT:INVALID_SESSION_ID

  • VEEVAVAULT:EXECUTION

  • VEEVAVAULT:CLIENT_PROTOCOL

  • VEEVAVAULT:INVALID_DATA

  • VEEVAVAULT:RESPONSE_TIMEOUT

  • VEEVAVAULT:IOEXCEPTION

  • VEEVAVAULT:PARAMETER_REQUIRED

  • VEEVAVAULT:CONNECTIVITY

  • VEEVAVAULT:INVALID_AUTH

  • VEEVAVAULT:INVALID_DOCUMENT

  • VEEVAVAULT:USERNAME_OR_PASSWORD_INCORRECT

  • VEEVAVAULT:RETRY_EXHAUSTED

  • VEEVAVAULT:JSON_EXCEPTION

  • VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED

  • VEEVAVAULT:OPERATION_NOT_ALLOWED

  • VEEVAVAULT:METHOD_NOT_SUPPORTED

  • VEEVAVAULT:NO_PERMISSION

  • VEEVAVAULT:INVALID_SPARK_MESSAGE

  • VEEVAVAULT:INVALID_TOKEN

  • VEEVAVAULT:MALFORMED_URL

  • VEEVAVAULT:INSUFFICIENT_ACCESS

  • VEEVAVAULT:INACTIVE_USER

  • VEEVAVAULT:SESSION_EXPIRED

Delete Document Renditions

<veevavault:delete-document-renditions>

CSV または JSON 形式で提供されたドキュメントメタデータを使用して、Veeva Vault のドキュメントレンディションを一括削除します。

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Metadata Format (メタデータ形式)

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

  • CSV

  • JSON

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

x

Document Metadata (ドキュメントメタデータ)

Binary (バイナリ)

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

#[payload]

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Output Encoding (出力エンコード)

String (文字列)

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

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

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

関連する設定

スロー

  • VEEVAVAULT:API_LIMIT_EXCEEDED

  • VEEVAVAULT:INVALID_KEY_FORMAT

  • VEEVAVAULT:INVALID_SESSION_ID

  • VEEVAVAULT:EXECUTION

  • VEEVAVAULT:CLIENT_PROTOCOL

  • VEEVAVAULT:INVALID_DATA

  • VEEVAVAULT:RESPONSE_TIMEOUT

  • VEEVAVAULT:IOEXCEPTION

  • VEEVAVAULT:PARAMETER_REQUIRED

  • VEEVAVAULT:CONNECTIVITY

  • VEEVAVAULT:INVALID_AUTH

  • VEEVAVAULT:INVALID_DOCUMENT

  • VEEVAVAULT:USERNAME_OR_PASSWORD_INCORRECT

  • VEEVAVAULT:RETRY_EXHAUSTED

  • VEEVAVAULT:JSON_EXCEPTION

  • VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED

  • VEEVAVAULT:OPERATION_NOT_ALLOWED

  • VEEVAVAULT:METHOD_NOT_SUPPORTED

  • VEEVAVAULT:NO_PERMISSION

  • VEEVAVAULT:INVALID_SPARK_MESSAGE

  • VEEVAVAULT:INVALID_TOKEN

  • VEEVAVAULT:MALFORMED_URL

  • VEEVAVAULT:INSUFFICIENT_ACCESS

  • VEEVAVAULT:INACTIVE_USER

  • VEEVAVAULT:SESSION_EXPIRED

Delete Documents

<veevavault:delete-documents>

CSV または JSON 形式で提供されたドキュメントメタデータを使用して、Veeva Vault の 1 つまたは複数のドキュメントを削除します。

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Metadata Format (メタデータ形式)

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

  • CSV

  • JSON

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

x

Document Metadata (ドキュメントメタデータ)

Binary (バイナリ)

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

#[payload]

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Output Encoding (出力エンコード)

String (文字列)

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

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

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

関連する設定

スロー

  • VEEVAVAULT:API_LIMIT_EXCEEDED

  • VEEVAVAULT:INVALID_KEY_FORMAT

  • VEEVAVAULT:INVALID_SESSION_ID

  • VEEVAVAULT:EXECUTION

  • VEEVAVAULT:CLIENT_PROTOCOL

  • VEEVAVAULT:INVALID_DATA

  • VEEVAVAULT:RESPONSE_TIMEOUT

  • VEEVAVAULT:IOEXCEPTION

  • VEEVAVAULT:PARAMETER_REQUIRED

  • VEEVAVAULT:CONNECTIVITY

  • VEEVAVAULT:INVALID_AUTH

  • VEEVAVAULT:INVALID_DOCUMENT

  • VEEVAVAULT:USERNAME_OR_PASSWORD_INCORRECT

  • VEEVAVAULT:RETRY_EXHAUSTED

  • VEEVAVAULT:JSON_EXCEPTION

  • VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED

  • VEEVAVAULT:OPERATION_NOT_ALLOWED

  • VEEVAVAULT:METHOD_NOT_SUPPORTED

  • VEEVAVAULT:NO_PERMISSION

  • VEEVAVAULT:INVALID_SPARK_MESSAGE

  • VEEVAVAULT:INVALID_TOKEN

  • VEEVAVAULT:MALFORMED_URL

  • VEEVAVAULT:INSUFFICIENT_ACCESS

  • VEEVAVAULT:INACTIVE_USER

  • VEEVAVAULT:SESSION_EXPIRED

Delete Object Records

<veevavault:delete-object-records>

CSV または JSON 形式で提供されたオブジェクトメタデータを使用して、選択した Vault オブジェクトのオブジェクトレコードを一括削除します。

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Object Name (オブジェクト名)

String (文字列)

オブジェクト名。

x

Metadata Format (メタデータ形式)

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

  • CSV

  • JSON

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

x

Object Metadata (オブジェクトメタデータ)

Binary (バイナリ)

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

#[payload]

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Output Encoding (出力エンコード)

String (文字列)

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

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

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

関連する設定

スロー

  • VEEVAVAULT:API_LIMIT_EXCEEDED

  • VEEVAVAULT:INVALID_KEY_FORMAT

  • VEEVAVAULT:INVALID_SESSION_ID

  • VEEVAVAULT:EXECUTION

  • VEEVAVAULT:CLIENT_PROTOCOL

  • VEEVAVAULT:INVALID_DATA

  • VEEVAVAULT:RESPONSE_TIMEOUT

  • VEEVAVAULT:IOEXCEPTION

  • VEEVAVAULT:PARAMETER_REQUIRED

  • VEEVAVAULT:CONNECTIVITY

  • VEEVAVAULT:INVALID_AUTH

  • VEEVAVAULT:INVALID_DOCUMENT

  • VEEVAVAULT:USERNAME_OR_PASSWORD_INCORRECT

  • VEEVAVAULT:RETRY_EXHAUSTED

  • VEEVAVAULT:JSON_EXCEPTION

  • VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED

  • VEEVAVAULT:OPERATION_NOT_ALLOWED

  • VEEVAVAULT:METHOD_NOT_SUPPORTED

  • VEEVAVAULT:NO_PERMISSION

  • VEEVAVAULT:INVALID_SPARK_MESSAGE

  • VEEVAVAULT:INVALID_TOKEN

  • VEEVAVAULT:MALFORMED_URL

  • VEEVAVAULT:INSUFFICIENT_ACCESS

  • VEEVAVAULT:INACTIVE_USER

  • VEEVAVAULT:SESSION_EXPIRED

Export Documents

<veevavault:export-documents>

Vault の FTP ステージングサーバーにエクスポートする一連のドキュメントを照会します。

Async スコープを使用して、ドキュメント ID を含むペイロードを渡すことで、​Export Documents​ 操作を個別の非同期フローで使用します。非同期で使用した場合、メインフローのプロセスが続行されている間、​Export Documents​ 操作は個別のフロースレッドで実行され、指定されたポーリング間隔を待機し、ジョブが正常に終了するまでジョブの状況をポーリングします。

エクスポートされたドキュメントは、フォルダーの FTP ステージング領域 (階層構造は ​{root}/{userId}/{jobId}/{documentIds}/{versions}​) に保存されます。

次の例は、ジョブの結果を応答として返す ​Export Documents​ 操作を示しています。

[
  {
	"file": "/41601/249051/0_1/TestDocument.docx",
	"user_id__v": 1885110,
	"id": 249051,
	"responseStatus": "SUCCESS",
	"minor_version_number__v": 1,
	"major_version_number__v": 0
  },
  {
	"file": "/41601/249050/0_1/TestDocument.docx",
	"user_id__v": 1885110,
	"id": 249050,
	"responseStatus": "SUCCESS",
	"minor_version_number__v": 1,
	"major_version_number__v": 0
  },
  {
	"file": "/41601/249052/0_1/TestDocument.docx",
	"user_id__v": 1885110,
	"id": 249052,
	"responseStatus": "SUCCESS",
	"minor_version_number__v": 1,
	"major_version_number__v": 0
  }
]

この例には次の属性が含まれます。

  • file
    "/{jobId}/{documentId}/{major-minor-version}/{filename}"​ の形式を使用します。これは、Vault FTP サーバーのステージング領域の絶対ファイルパス位置です。

  • user_id__v
    コネクタ内でログイン情報が設定されているユーザーの Vault システムでのユーザー ID。フォルダーが Vault FTP サーバーのステージング領域のルート位置に作成され、その下にエクスポートされたファイルが配置されます。フォルダーは、文字 ​u​ のプレフィックスを持つユーザー ID の名前を使用して作成されます。例: /uXXXXXXX/{jobId}/{documentId}/{major-minor-version}/{filename}\)​。

  • id
    エクスポートされたドキュメントファイルのドキュメント ID。

  • major_version_number__v
    エクスポートされたドキュメントファイルのメジャーバージョン番号。

  • minor_version_number__v
    エクスポートされたドキュメントファイルのマイナーバージョン番号。

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Metadata Format (メタデータ形式)

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

  • CSV

  • JSON

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

x

Document Metadata (ドキュメントメタデータ)

Binary (バイナリ)

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

#[payload]

Source (ソース)

Boolean (ブール)

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

true

Renditions (レンディション)

Boolean (ブール)

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

false

All Versions (すべてのバージョン)

Boolean (ブール)

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

false

Polling Interval (ポーリング間隔)

Number (数値)

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

10

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Output Encoding (出力エンコード)

String (文字列)

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

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

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

関連する設定

スロー

  • VEEVAVAULT:API_LIMIT_EXCEEDED

  • VEEVAVAULT:INVALID_KEY_FORMAT

  • VEEVAVAULT:INVALID_SESSION_ID

  • VEEVAVAULT:EXECUTION

  • VEEVAVAULT:CLIENT_PROTOCOL

  • VEEVAVAULT:INVALID_DATA

  • VEEVAVAULT:RESPONSE_TIMEOUT

  • VEEVAVAULT:IOEXCEPTION

  • VEEVAVAULT:PARAMETER_REQUIRED

  • VEEVAVAULT:CONNECTIVITY

  • VEEVAVAULT:INVALID_AUTH

  • VEEVAVAULT:INVALID_DOCUMENT

  • VEEVAVAULT:USERNAME_OR_PASSWORD_INCORRECT

  • VEEVAVAULT:RETRY_EXHAUSTED

  • VEEVAVAULT:JSON_EXCEPTION

  • VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED

  • VEEVAVAULT:OPERATION_NOT_ALLOWED

  • VEEVAVAULT:METHOD_NOT_SUPPORTED

  • VEEVAVAULT:NO_PERMISSION

  • VEEVAVAULT:INVALID_SPARK_MESSAGE

  • VEEVAVAULT:INVALID_TOKEN

  • VEEVAVAULT:MALFORMED_URL

  • VEEVAVAULT:INSUFFICIENT_ACCESS

  • VEEVAVAULT:INACTIVE_USER

  • VEEVAVAULT:SESSION_EXPIRED

Get Audit Details

<veevavault:get-audit-details>

特定の監査種別の監査の詳細をすべて取得します。この操作の後に For-Each/Splitter 要素を配置して、各 JSON データ (ページ) を順次フェッチします。

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Audit Type (監査種別)

String (文字列)

監査種別。

x

Start Date (開始日)

String (文字列)

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

End Date (終了日)

String (文字列)

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

Fetch Size (フェッチサイズ)

Number (数値)

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

1000

Batch Size (バッチサイズ)

Number (数値)

バッチごとのページ数。

10

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

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

[Binary] ペイロードおよび [​HTTP Response Attributes (HTTP 応答属性)​] 属性のメッセージの配列

関連する設定

スロー

  • VEEVAVAULT:API_LIMIT_EXCEEDED

  • VEEVAVAULT:USERNAME_OR_PASSWORD_INCORRECT

  • VEEVAVAULT:INVALID_KEY_FORMAT

  • VEEVAVAULT:INVALID_SESSION_ID

  • VEEVAVAULT:JSON_EXCEPTION

  • VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED

  • VEEVAVAULT:OPERATION_NOT_ALLOWED

  • VEEVAVAULT:METHOD_NOT_SUPPORTED

  • VEEVAVAULT:NO_PERMISSION

  • VEEVAVAULT:EXECUTION

  • VEEVAVAULT:INVALID_SPARK_MESSAGE

  • VEEVAVAULT:INVALID_TOKEN

  • VEEVAVAULT:MALFORMED_URL

  • VEEVAVAULT:CLIENT_PROTOCOL

  • VEEVAVAULT:INVALID_DATA

  • VEEVAVAULT:RESPONSE_TIMEOUT

  • VEEVAVAULT:IOEXCEPTION

  • VEEVAVAULT:PARAMETER_REQUIRED

  • VEEVAVAULT:INVALID_AUTH

  • VEEVAVAULT:INSUFFICIENT_ACCESS

  • VEEVAVAULT:INVALID_DOCUMENT

  • VEEVAVAULT:INACTIVE_USER

  • VEEVAVAULT:SESSION_EXPIRED

Get Document Renditions Types

<veevavault:get-document-renditions-types>

JSON 形式のドキュメント ID メタデータを使用して、ドキュメントレンディション種別を取得します。

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Document Metadata (ドキュメントメタデータ)

Binary (バイナリ)

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

#[payload]

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Output Encoding (出力エンコード)

String (文字列)

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

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

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

関連する設定

スロー

  • VEEVAVAULT:API_LIMIT_EXCEEDED

  • VEEVAVAULT:INVALID_KEY_FORMAT

  • VEEVAVAULT:INVALID_SESSION_ID

  • VEEVAVAULT:EXECUTION

  • VEEVAVAULT:CLIENT_PROTOCOL

  • VEEVAVAULT:INVALID_DATA

  • VEEVAVAULT:RESPONSE_TIMEOUT

  • VEEVAVAULT:IOEXCEPTION

  • VEEVAVAULT:PARAMETER_REQUIRED

  • VEEVAVAULT:CONNECTIVITY

  • VEEVAVAULT:INVALID_AUTH

  • VEEVAVAULT:INVALID_DOCUMENT

  • VEEVAVAULT:USERNAME_OR_PASSWORD_INCORRECT

  • VEEVAVAULT:RETRY_EXHAUSTED

  • VEEVAVAULT:JSON_EXCEPTION

  • VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED

  • VEEVAVAULT:OPERATION_NOT_ALLOWED

  • VEEVAVAULT:METHOD_NOT_SUPPORTED

  • VEEVAVAULT:NO_PERMISSION

  • VEEVAVAULT:INVALID_SPARK_MESSAGE

  • VEEVAVAULT:INVALID_TOKEN

  • VEEVAVAULT:MALFORMED_URL

  • VEEVAVAULT:INSUFFICIENT_ACCESS

  • VEEVAVAULT:INACTIVE_USER

  • VEEVAVAULT:SESSION_EXPIRED

Get Documents

<veevavault:get-documents>

Veeva Vault からドキュメントの詳細を取得します。次のいずれかを実行できます。

  • ドキュメントプロパティ (ドキュメント種別、サブタイプ、分類) を指定して、ドキュメントの詳細を取得します。

    ドキュメントプロパティが指定されている場合、​Get Documents​ 操作によって VQL クエリが動的にビルドされます。その後、この VQL クエリが Vault で実行され、ドキュメントの詳細が取得されます。

  • ドキュメントプロパティ (ドキュメント種別、サブタイプ、分類) をフェッチして、ドキュメントの詳細を取得します。

    ドキュメントプロパティが指定されていない場合、​/api/{version}/metadata/objects/documents/properties​ を使用してドキュメントプロパティメタデータがフェッチされ、​[Document Properties (ドキュメントプロパティ)]​ リストに追加または挿入されたドキュメントメタデータプロパティに基づいて VQL クエリがビルドされます。メタデータプロパティが指定されていない場合、クエリ可能なすべてのドキュメントプロパティが VQL クエリで使用および実行されます。

この操作の後に For-Each/Splitter 要素を配置して、各ドキュメントのデータ (ページ) を順次フェッチします。

この操作では、Mule 標準ページネーションに基づくページングメカニズムが提供されます。詳細は、​「ストリーミングおよびページネーション」​を参照してください。

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

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

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

Type (型)

String (文字列)

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

SubType

String (文字列)

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

Classification (分類)

String (文字列)

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

ドキュメントプロパティ

String の配列

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

WHERE Clause (Where 句)

String (文字列)

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

Fetch Size (フェッチサイズ)

Number (数値)

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

1000

Batch Size (バッチサイズ)

Number (数値)

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

10

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

[Binary] ペイロードおよび [​HTTP Response Attributes (HTTP 応答属性)​] 属性のメッセージの配列

関連する設定

スロー

  • VEEVAVAULT:API_LIMIT_EXCEEDED

  • VEEVAVAULT:USERNAME_OR_PASSWORD_INCORRECT

  • VEEVAVAULT:INVALID_KEY_FORMAT

  • VEEVAVAULT:INVALID_SESSION_ID

  • VEEVAVAULT:JSON_EXCEPTION

  • VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED

  • VEEVAVAULT:OPERATION_NOT_ALLOWED

  • VEEVAVAULT:METHOD_NOT_SUPPORTED

  • VEEVAVAULT:NO_PERMISSION

  • VEEVAVAULT:EXECUTION

  • VEEVAVAULT:INVALID_SPARK_MESSAGE

  • VEEVAVAULT:INVALID_TOKEN

  • VEEVAVAULT:MALFORMED_URL

  • VEEVAVAULT:CLIENT_PROTOCOL

  • VEEVAVAULT:INVALID_DATA

  • VEEVAVAULT:RESPONSE_TIMEOUT

  • VEEVAVAULT:IOEXCEPTION

  • VEEVAVAULT:PARAMETER_REQUIRED

  • VEEVAVAULT:INVALID_AUTH

  • VEEVAVAULT:INSUFFICIENT_ACCESS

  • VEEVAVAULT:INVALID_DOCUMENT

  • VEEVAVAULT:INACTIVE_USER

  • VEEVAVAULT:SESSION_EXPIRED

Get Object Records

<veevavault:get-object-records>

オブジェクトメタデータ項目を使用してオブジェクトレコードの詳細を取得し、VQL クエリを動的にビルドして Vault で実行し、オブジェクトの詳細を取得します。この操作の後に For-Each/Splitter 要素を配置して、各オブジェクトレコード (ページ) を順次フェッチします。

この操作では、Mule 標準ページネーションに基づくページングメカニズムが提供されます。詳細は、​「ストリーミングおよびページネーション」​を参照してください。

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Object Name (オブジェクト名)

String (文字列)

オブジェクト名。

x

Object Fields (オブジェクト項目)

String の配列

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

WHERE Clause (Where 句)

String (文字列)

Where 句。

Fetch Size (フェッチサイズ)

Number (数値)

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

1000

Batch Size (バッチサイズ)

Number (数値)

バッチごとのページ数。

10

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

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

[Binary] ペイロードおよび [​HTTP Response Attributes (HTTP 応答属性)​] 属性のメッセージの配列

関連する設定

スロー

  • VEEVAVAULT:API_LIMIT_EXCEEDED

  • VEEVAVAULT:USERNAME_OR_PASSWORD_INCORRECT

  • VEEVAVAULT:INVALID_KEY_FORMAT

  • VEEVAVAULT:INVALID_SESSION_ID

  • VEEVAVAULT:JSON_EXCEPTION

  • VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED

  • VEEVAVAULT:OPERATION_NOT_ALLOWED

  • VEEVAVAULT:METHOD_NOT_SUPPORTED

  • VEEVAVAULT:NO_PERMISSION

  • VEEVAVAULT:EXECUTION

  • VEEVAVAULT:INVALID_SPARK_MESSAGE

  • VEEVAVAULT:INVALID_TOKEN

  • VEEVAVAULT:MALFORMED_URL

  • VEEVAVAULT:CLIENT_PROTOCOL

  • VEEVAVAULT:INVALID_DATA

  • VEEVAVAULT:RESPONSE_TIMEOUT

  • VEEVAVAULT:IOEXCEPTION

  • VEEVAVAULT:PARAMETER_REQUIRED

  • VEEVAVAULT:INVALID_AUTH

  • VEEVAVAULT:INSUFFICIENT_ACCESS

  • VEEVAVAULT:INVALID_DOCUMENT

  • VEEVAVAULT:INACTIVE_USER

  • VEEVAVAULT:SESSION_EXPIRED

Get Picklists

<veevavault:get-picklists>

選択リストで設定されているすべての使用可能な値を取得します。

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Picklist Name (選択リスト名)

String (文字列)

選択リスト名。

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Output Encoding (出力エンコード)

String (文字列)

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

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

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

関連する設定

スロー

  • VEEVAVAULT:API_LIMIT_EXCEEDED

  • VEEVAVAULT:INVALID_KEY_FORMAT

  • VEEVAVAULT:INVALID_SESSION_ID

  • VEEVAVAULT:EXECUTION

  • VEEVAVAULT:CLIENT_PROTOCOL

  • VEEVAVAULT:INVALID_DATA

  • VEEVAVAULT:RESPONSE_TIMEOUT

  • VEEVAVAULT:IOEXCEPTION

  • VEEVAVAULT:PARAMETER_REQUIRED

  • VEEVAVAULT:CONNECTIVITY

  • VEEVAVAULT:INVALID_AUTH

  • VEEVAVAULT:INVALID_DOCUMENT

  • VEEVAVAULT:USERNAME_OR_PASSWORD_INCORRECT

  • VEEVAVAULT:RETRY_EXHAUSTED

  • VEEVAVAULT:JSON_EXCEPTION

  • VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED

  • VEEVAVAULT:OPERATION_NOT_ALLOWED

  • VEEVAVAULT:METHOD_NOT_SUPPORTED

  • VEEVAVAULT:NO_PERMISSION

  • VEEVAVAULT:INVALID_SPARK_MESSAGE

  • VEEVAVAULT:INVALID_TOKEN

  • VEEVAVAULT:MALFORMED_URL

  • VEEVAVAULT:INSUFFICIENT_ACCESS

  • VEEVAVAULT:INACTIVE_USER

  • VEEVAVAULT:SESSION_EXPIRED

Invoke REST API

<veevavault:invoke-rest-api>

汎用 Veeva Vault REST API を呼び出します。

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Output Encoding (出力エンコード)

String (文字列)

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

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

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

Method (メソッド)

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

  • GET

  • DELETE

  • POST

  • PUT

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

GET

Path (パス)

String (文字列)

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

/

Body (本文)

Any (いずれか)

要求メッセージの本文。

#[payload]

Headers (ヘッダー)

Object (オブジェクト)

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

URI パラメーター

Object (オブジェクト)

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

クエリパラメーター

Object (オブジェクト)

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

Request Streaming Mode (要求ストリーミングモード)

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

  • AUTO

  • ALWAYS

  • NEVER

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

関連する設定

スロー

  • VEEVAVAULT:API_LIMIT_EXCEEDED

  • VEEVAVAULT:INVALID_KEY_FORMAT

  • VEEVAVAULT:INVALID_SESSION_ID

  • VEEVAVAULT:EXECUTION

  • VEEVAVAULT:CLIENT_PROTOCOL

  • VEEVAVAULT:INVALID_DATA

  • VEEVAVAULT:RESPONSE_TIMEOUT

  • VEEVAVAULT:IOEXCEPTION

  • VEEVAVAULT:PARAMETER_REQUIRED

  • VEEVAVAULT:CONNECTIVITY

  • VEEVAVAULT:INVALID_AUTH

  • VEEVAVAULT:INVALID_DOCUMENT

  • VEEVAVAULT:USERNAME_OR_PASSWORD_INCORRECT

  • VEEVAVAULT:RETRY_EXHAUSTED

  • VEEVAVAULT:JSON_EXCEPTION

  • VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED

  • VEEVAVAULT:OPERATION_NOT_ALLOWED

  • VEEVAVAULT:METHOD_NOT_SUPPORTED

  • VEEVAVAULT:NO_PERMISSION

  • VEEVAVAULT:INVALID_SPARK_MESSAGE

  • VEEVAVAULT:INVALID_TOKEN

  • VEEVAVAULT:MALFORMED_URL

  • VEEVAVAULT:INSUFFICIENT_ACCESS

  • VEEVAVAULT:INACTIVE_USER

  • VEEVAVAULT:SESSION_EXPIRED

Query

<veevavault:query>

指定した VQL クエリを Vault で実行し、ページ分割されたデータ入力ストリームで結果を取得します。Query 操作の後に For-Each/Splitter 要素を配置して、各レコードを順次フェッチします。

この操作では、Mule 標準ページネーションに基づくページングメカニズムが提供されます。詳細は、​「ストリーミングおよびページネーション」​を参照してください。

VQL クエリで ​LIMIT/PAGESIZE​ と ​OFFSET/PAGEOFFSET​ を指定しないでください。これらのパラメーターは内部に組み込まれています。
名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

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

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

VQL Query (VQL クエリ)

String (文字列)

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

x

Input parameters (入力パラメーター)

Object (オブジェクト)

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

Fetch Size (フェッチサイズ)

Number (数値)

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

1000

Batch Size (バッチサイズ) (非推奨)

Number (数値)

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

10

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

[Binary] ペイロードおよび [​HTTP Response Attributes (HTTP 応答属性)​] 属性のメッセージの配列

関連する設定

スロー

  • VEEVAVAULT:API_LIMIT_EXCEEDED

  • VEEVAVAULT:USERNAME_OR_PASSWORD_INCORRECT

  • VEEVAVAULT:INVALID_KEY_FORMAT

  • VEEVAVAULT:INVALID_SESSION_ID

  • VEEVAVAULT:JSON_EXCEPTION

  • VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED

  • VEEVAVAULT:OPERATION_NOT_ALLOWED

  • VEEVAVAULT:METHOD_NOT_SUPPORTED

  • VEEVAVAULT:NO_PERMISSION

  • VEEVAVAULT:EXECUTION

  • VEEVAVAULT:INVALID_SPARK_MESSAGE

  • VEEVAVAULT:INVALID_TOKEN

  • VEEVAVAULT:MALFORMED_URL

  • VEEVAVAULT:CLIENT_PROTOCOL

  • VEEVAVAULT:INVALID_DATA

  • VEEVAVAULT:RESPONSE_TIMEOUT

  • VEEVAVAULT:IOEXCEPTION

  • VEEVAVAULT:PARAMETER_REQUIRED

  • VEEVAVAULT:INVALID_AUTH

  • VEEVAVAULT:INSUFFICIENT_ACCESS

  • VEEVAVAULT:INVALID_DOCUMENT

  • VEEVAVAULT:INACTIVE_USER

  • VEEVAVAULT:SESSION_EXPIRED

Spark Validator

<veevavault:spark-message-validator>

署名と公開キーを使用して、Vault からトリガーされた Spark メッセージの検証と確認を行います。検証と確認が正常に終了したら、Spark メッセージを Mule フローでビジネス要件に従ってさらに処理できます。詳細は、 「Spark Messaging feature and functionalities and setup (Spark メッセージングの機能およびセットアップ)」​を参照してください。

Spark Validator​ 操作の結果には、Spark 属性 (省略可能) と Spark メッセージ (Vault から受信した場合) が含まれます。

Vault から Spark メッセージをトリガーする前に、Veeva Vault サポートのサポートチケットを申請して、Spark メッセージの再送信または再試行の間隔を必ず増やしてください (例: 10 秒)。デフォルトでは期間は 3 秒として設定されていますが、​Spark Validator​ 操作でメッセージの検証と確認を完了するのに必要な時間を下回っています。
Veeva Systems によると、公開キー (00001.pem) の期限は 2 年ごとに切れます。ユーザーは有効期限に関する通知を事前に受け取ります。Mule アプリケーションフローで ​Spark Validator​ 操作を使用している場合は、公開キーの有効期限後に、​[Public Key Path (公開キーのパス)]​ 項目で設定されたパスから公開キーファイルを削除する必要があります。キーの削除を実行している間に新しい公開キーが作成されます。これを行わない場合、Spark メッセージの検証が ​INVALID_SPARK_MESSAGE​ として失敗します。Spark メッセージの検証を正常に終了するには、デフォルトのパスで CloudHub にデプロイされた Mule アプリケーションを再起動する必要があります。
名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Include Spark Headers (Spark ヘッダーを含める)

Boolean (ブール)

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

false

Public Key Path (公開キーのパス)

String (文字列)

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

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

Spark Headers (Spark ヘッダー)

Object (オブジェクト)

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

#[attributes.headers]

Spark Message (Spark メッセージ)

Input Stream (入力ストリーム)

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

#[payload]

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Output Encoding (出力エンコード)

String (文字列)

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

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

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

Binary (バイナリ)

Attributes Type (属性型)

Object (オブジェクト)

関連する設定

スロー

  • VEEVAVAULT:API_LIMIT_EXCEEDED

  • VEEVAVAULT:INVALID_KEY_FORMAT

  • VEEVAVAULT:INVALID_SESSION_ID

  • VEEVAVAULT:EXECUTION

  • VEEVAVAULT:CLIENT_PROTOCOL

  • VEEVAVAULT:INVALID_DATA

  • VEEVAVAULT:RESPONSE_TIMEOUT

  • VEEVAVAULT:IOEXCEPTION

  • VEEVAVAULT:PARAMETER_REQUIRED

  • VEEVAVAULT:CONNECTIVITY

  • VEEVAVAULT:INVALID_AUTH

  • VEEVAVAULT:INVALID_DOCUMENT

  • VEEVAVAULT:USERNAME_OR_PASSWORD_INCORRECT

  • VEEVAVAULT:RETRY_EXHAUSTED

  • VEEVAVAULT:JSON_EXCEPTION

  • VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED

  • VEEVAVAULT:OPERATION_NOT_ALLOWED

  • VEEVAVAULT:METHOD_NOT_SUPPORTED

  • VEEVAVAULT:NO_PERMISSION

  • VEEVAVAULT:INVALID_SPARK_MESSAGE

  • VEEVAVAULT:INVALID_TOKEN

  • VEEVAVAULT:MALFORMED_URL

  • VEEVAVAULT:INSUFFICIENT_ACCESS

  • VEEVAVAULT:INACTIVE_USER

  • VEEVAVAULT:SESSION_EXPIRED

Unauthorize

<veevavault:unauthorize>

特定のリソースオーナー ID のアクセストークン情報をすべて削除して、認証ダンスを再度実行しない限り、そのユーザー向けの操作を実行できないようにします。

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Resource Owner Id (リソースオーナー ID)

String (文字列)

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

関連する設定

Update Documents

<veevavault:update-documents>

CSV または JSON 形式で提供されたペイロードの編集可能なメタデータを使用して、一括ドキュメントを更新します。

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Metadata Format (メタデータ形式)

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

  • CSV

  • JSON

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

x

Document Metadata (ドキュメントメタデータ)

Binary (バイナリ)

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

#[payload]

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Output Encoding (出力エンコード)

String (文字列)

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

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

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

関連する設定

スロー

  • VEEVAVAULT:API_LIMIT_EXCEEDED

  • VEEVAVAULT:INVALID_KEY_FORMAT

  • VEEVAVAULT:INVALID_SESSION_ID

  • VEEVAVAULT:EXECUTION

  • VEEVAVAULT:CLIENT_PROTOCOL

  • VEEVAVAULT:INVALID_DATA

  • VEEVAVAULT:RESPONSE_TIMEOUT

  • VEEVAVAULT:IOEXCEPTION

  • VEEVAVAULT:PARAMETER_REQUIRED

  • VEEVAVAULT:CONNECTIVITY

  • VEEVAVAULT:INVALID_AUTH

  • VEEVAVAULT:INVALID_DOCUMENT

  • VEEVAVAULT:USERNAME_OR_PASSWORD_INCORRECT

  • VEEVAVAULT:RETRY_EXHAUSTED

  • VEEVAVAULT:JSON_EXCEPTION

  • VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED

  • VEEVAVAULT:OPERATION_NOT_ALLOWED

  • VEEVAVAULT:METHOD_NOT_SUPPORTED

  • VEEVAVAULT:NO_PERMISSION

  • VEEVAVAULT:INVALID_SPARK_MESSAGE

  • VEEVAVAULT:INVALID_TOKEN

  • VEEVAVAULT:MALFORMED_URL

  • VEEVAVAULT:INSUFFICIENT_ACCESS

  • VEEVAVAULT:INACTIVE_USER

  • VEEVAVAULT:SESSION_EXPIRED

Update Object Records

<veevavault:update-object-records>

CSV または JSON 形式のオブジェクトメタデータを使用して、オブジェクトレコードを一括で更新します。

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Object Name (オブジェクト名)

String (文字列)

オブジェクト名。

x

Metadata Format (メタデータ形式)

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

  • CSV

  • JSON

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

x

Object Metadata (オブジェクトメタデータ)

Binary (バイナリ)

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

#[payload]

Output Mime Type (出力 MIME タイプ)

String (文字列)

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

Output Encoding (出力エンコード)

String (文字列)

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

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

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

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

関連する設定

スロー

  • VEEVAVAULT:API_LIMIT_EXCEEDED

  • VEEVAVAULT:INVALID_KEY_FORMAT

  • VEEVAVAULT:INVALID_SESSION_ID

  • VEEVAVAULT:EXECUTION

  • VEEVAVAULT:CLIENT_PROTOCOL

  • VEEVAVAULT:INVALID_DATA

  • VEEVAVAULT:RESPONSE_TIMEOUT

  • VEEVAVAULT:IOEXCEPTION

  • VEEVAVAULT:PARAMETER_REQUIRED

  • VEEVAVAULT:CONNECTIVITY

  • VEEVAVAULT:INVALID_AUTH

  • VEEVAVAULT:INVALID_DOCUMENT

  • VEEVAVAULT:USERNAME_OR_PASSWORD_INCORRECT

  • VEEVAVAULT:RETRY_EXHAUSTED

  • VEEVAVAULT:JSON_EXCEPTION

  • VEEVAVAULT:ATTRIBUTE_NOT_SUPPORTED

  • VEEVAVAULT:OPERATION_NOT_ALLOWED

  • VEEVAVAULT:METHOD_NOT_SUPPORTED

  • VEEVAVAULT:NO_PERMISSION

  • VEEVAVAULT:INVALID_SPARK_MESSAGE

  • VEEVAVAULT:INVALID_TOKEN

  • VEEVAVAULT:MALFORMED_URL

  • VEEVAVAULT:INSUFFICIENT_ACCESS

  • VEEVAVAULT:INACTIVE_USER

  • VEEVAVAULT:SESSION_EXPIRED

Reconnection (再接続)

操作の再接続戦略を設定します。

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

Fails Deployment (デプロイに失敗)

Boolean (ブール)

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

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

標準再接続戦略を設定し、再接続の頻度と、コネクタソースまたは操作で実行できる再接続の試行回数を指定します。

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

Frequency (頻度)

Number (数値)

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

Count (数)

Number (数値)

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

Reconnect Forever (繰り返し再接続)

Mule アプリケーションが実行されている間はコネクタソースや操作によって指定された頻度で再接続が試行される Forever 再接続戦略を設定します。

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

Frequency (頻度)

Number (数値)

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

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

有効期限ポリシー戦略を設定します。

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

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

Number (数値)

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

Time Unit (時間単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)

データが最大バッファサイズを超えた場合に要求が失敗するメモリ内ストリーミング戦略を設定します。ユースケースで最適なバッファサイズは、必ずパフォーマンステストを実施して決めてください。

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

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

Number (数値)

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

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

Number (数値)

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

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

Number (数値)

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

Buffer Unit (バッファ単位)

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

  • BYTE

  • KB

  • MB

  • GB

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

Repeatable File Store Stream (反復可能なファイルストアストリーム)

反復可能なファイルストアストリーミング戦略を設定します。この戦略では、ストリームコンテンツの一部がメモリ内に格納されます。ストリームのコンテンツが、設定されたバッファサイズよりも大きい場合、Mule はバッファのコンテンツをディスクにバックアップしてからメモリをクリアします。

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

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

Number (数値)

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

  • バッファサイズを大きくすると、Mule がバッファをディスクに書き込む回数を減らせます。これによってパフォーマンスが高まりますが、より多くのメモリが必要になるため、アプリケーションが処理できる同時要求数が制限されます。

  • バッファサイズを小さくすると、メモリの負荷は低減しますが、応答時間が長くなります。

Buffer Unit (バッファ単位)

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

  • BYTE

  • KB

  • MB

  • GB

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

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

反復可能なメモリ内イテラブル型を設定します。

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

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

Number (数値)

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

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

Number (数値)

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

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

Number (数値)

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

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

ファイルストアイテラブル型を設定します。

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

In Memory Objects (メモリ内オブジェクト)

Number (数値)

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

Buffer Unit (バッファ単位)

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

  • BYTE

  • KB

  • MB

  • GB

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

HTTP Response Attributes (HTTP 応答属性)

設定の HTTP 応答属性を設定します。

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

Status Code (状況コード)

Number (数値)

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

x

Reason Phrase (理由を示す語句)

String (文字列)

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

x

Headers (ヘッダー)

Object (オブジェクト)

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

x

Burst Api Limit Config (一括 API 制限設定)

Veeva Vault API の指定されたバースト API 制限が、設定されたしきい値に達するか超えた場合、​[Burst API Limit Profile (バースト API 制限プロファイル)]​ を使用します。

[Burst API Limit Profile (バースト API 制限プロファイル)]​ の値が [​Burst api limit config (Default)​ (バースト API 制限の設定)] (デフォルト) に設定されている場合、コネクタは、設定されたしきい値に対して Veeva Vault API レスポンスヘッダー (​X-VaultAPI-BurstLimitRemaining​) のバースト API 制限を評価します。残りのバースト API 制限が設定されたしきい値に達するか超えた場合、コネクタは指定された時間待機して ​[Burst Limit Remaining (残りのバースト制限)]​ の計数を再開します。

詳細は、 「API Rate Limit Headers (API レート制限ヘッダー)」​を参照してください。

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

API 制限

Number (数値)

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

200

Wait Time (待機時間)

Number (数値)

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

5

Max Wait Unit (最大待機単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

MINUTES

Daily Api Limit Config (1 日の API 制限設定)

[Daily API Limit Profile (1 日の API 制限プロファイル)]​ では、1 日の残りの API 制限コール数に対して評価される API 制限しきい値を設定します。1 日の API 制限コール数が、指定された API 制限しきい値に達するか超えた場合、例外がスローされます。 [Daily API Limit Profile (1 日の API 制限プロファイル)]​ は、デフォルトで無効になっています。

詳細は、 「API Rate Limit Headers (API レート制限ヘッダー)」​を参照してください。

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

API 制限

Number (数値)

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

10000