# mulesoft Veevavault Connector - Full Documentation # Anypoint Studio を使用した Veeva Vault Connector 1.2 の設定 Veeva Vault Connector を Anypoint Studio の Mule プロジェクトに追加し、Mule フローの入力元を設定して、コネクタを設定します。 Studio でコネクタを追加および設定する手順は、次のとおりです。 1. Mule プロジェクトを作成します。 2. コネクタを Mule プロジェクトに追加します 3. コネクタのフローの入力元を設定します。 4. コネクタのグローバル要素を設定します。 Studio で初めて Anypoint Connector を設定する場合は、​[「Anypoint Studio を使用したコネクタの設定」](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)​を参照してください。 ## [](#mule-プロジェクトを作成する)Mule プロジェクトを作成する Anypoint Studio で、コネクタを追加および設定する新しい Mule プロジェクトを作成します。 1. Anypoint Studio で、メインメニューから ​**\[File (ファイル)\] > \[New (新規)\] > \[Mule Project (Mule プロジェクト)\]**​ を選択します。 2. Mule プロジェクトの名前を入力して、​**\[Finish (完了)\]**​ をクリックします。 ## [](#mule-プロジェクトへのコネクタの追加)Mule プロジェクトへのコネクタの追加 Veeva Vault Connector を Mule プロジェクトに追加すると、XML コードにコネクタの名前空間とスキーマの場所が自動的に入力され、プロジェクトの ​`pom.xml`​ ファイルに必要な連動関係が追加されます。 1. \[Mule Palette (Mule パレット)\] ビューで、​**\[(X) Search in Exchange ((X) Exchange 内を検索)\]**​ をクリックします。 2. **\[Add Modules to Project (モジュールをプロジェクトに追加)\]**​ で、検索項目に「veeva」と入力します。 3. **\[Available modules (使用可能なモジュール)\]**​ で ​**\[Veeva Vault Connector - Mule 4\]**​ をクリックし、​**\[Add (追加)\]**​ をクリックします。 4. **\[Finish (完了)\]**​ をクリックします。 Studio でコネクタを Mule プロジェクトに追加しても、Studio ワークスペースの他のプロジェクトはそのコネクタを使用できません。 ## [](#フローの入力元の設定)フローの入力元の設定 コネクタを Mule プロジェクトに追加したら、フローの入力元 (​**HTTP リスナー**​ (HTTP Connector)、​**スケジューラー**​など) を設定します。 ## [](#コネクタの設定)コネクタの設定 Mule アプリケーションで Veeva Vault Connector を使用するには、アプリケーションのすべての Veeva Vault Connector 操作で使用できるグローバル Veeva Vault 要素を設定します。 1. グローバル Veeva Vault 要素を作成するには、Studio キャンバスの下部にある ​**\[Global Elements (グローバル要素)\]**​ タブをクリックし、​**\[Create (作成)\]**​ をクリックします。 2. **\[Choose Global Type (グローバル種別を選択)\]**​ ウィンドウで、​**\[Connector Configuration (コネクタ設定)\]**​ を展開し、​**\[Veeva Vault Config (Veeva Vault 設定)\]**​ をクリックして ​**\[OK\]**​ をクリックします。 3. \[Veeva Vault Config (Veeva Vault 設定)\] ウィンドウの ​**\[General (一般)\]**​ タブで次の設定値を入力します。 ![veevavault connector basic authentication general](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-basic-authentication-general.png)
項目 説明

Name (名前)

後ほど参照するために設定の名前を入力します。

Vault URL

Veeva Vault インスタンスの URL を入力します。

Username (ユーザー名)

Veeva Vault インスタンスのユーザー名を入力します。

Password (パスワード)

ユーザー名に対応するパスワードを入力します。

Version (バージョン)

Veeva Vault インスタンスのバージョンを入力します。

Client Id (クライアント ID)

追跡目的で各要求と共に送信するクライアント ID をヘッダーに {organization}-{company|team} の形式で入力します。
クライアント ID には「mulesoft」のプレフィックスと「client-vaultconnector」のサフィックスが内部的に付けられます (例: mulesoft-abcpharma-clinicalprod-client-vaultconnector​)。

前の画像では、プレースホルダーの値は、プロジェクトのフォルダー (​`src/main/resources`​) にある設定ファイルを参照します。ログイン情報をグローバル設定プロパティにハードコードすることもできますが、その値が含まれる設定ファイルを代わりに参照した場合、メンテナンスを簡略化し、プロジェクトの再利用性を向上できます。これらの値を別個のファイルに保存しておくと、アクセスログイン情報が異なるさまざまな環境 (本番、開発、QA など) にデプロイする必要がある場合に便利です。 次の例は、​`src/main/resources/config`​ フォルダーの下の ​`configuration.yaml`​ ファイルのスニペットを示しています。 ```yaml #Veeva Vault details veeva: vaultURL: "https://xxxx-xxxx.veevavault.com" username: "someone@example.com" password: "xxxxxxx" version : "v20.1" clientId: "mulesoft-abcpharma-clinicalprod-client-vaultconnector" ``` この接続設定では基本認証が実行されます。つまり、Veeva Vault インスタンスに接続するために必要な Vault URL、ユーザー名、およびパスワードパラメーターを受け入れて、セッションを取得します。取得したセッションは、Mule アプリケーションで設定された各操作で要求を送信するために使用されます。 4. \[Veeva Vault Config (Veeva Vault 設定)\] ウィンドウの ​**\[Advanced (詳細)\]**​ タブでバースト API 制限を設定します。 ![veevavault connector basic authentication advanced](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-basic-authentication-advanced.png) **Burst API Limit Profile (バースト API 制限プロファイル)** \[Burst API Limit Profile (バースト API 制限プロファイル)\] 設定は、Veeva Vault API の指定されたバースト API 制限が、設定されたしきい値に達するか、超えた場合に機能します。 **\[Burst API limit config (バースト API 制限の設定)\]**​ が有効になっている場合 (デフォルト)、コネクタは、指定された API 制限しきい値に対して Veeva Vault API のレスポンスヘッダー (​`X-VaultAPI-BurstLimitRemaining`​) 値を評価します。残りのバースト API 制限がこのしきい値に達するかこのしきい値を超えた場合、コネクタは指定された時間待機して ​**\[Burst Limit Remaining (残りのバースト制限)\]**​ の計数を再開します。 次に、アプリケーションログの例を示します。これは、​`2019-06-06 10:34:45,096`​ の警告メッセージの後、​`2019-06-06 10:39:45,098`​ の次のメッセージで示されているように再実行まで 5 分間待機していることを示しています。 WARN 2019-06-06 10:34:45,096 \[\[MuleRuntime\].io.27: \[veevavault-connector-demo\].get-documents-operationFlow.BLOCKING @2dd2ffaf\] \[event: 99716950-8818-11e9-90e2-d61515f42856\] org.mule.extension.veevavault.internal.service.HttpRequestService: Burst API Limit remaining calls \[1997\] has exceeded/reached an API Limit Profile threshold set as \[1997\]. As per API Limit Profile, Veeva Vault Connector will wait for \[5\] MINUTES. WARN 2019-06-06 10:39:45,098 \[\[MuleRuntime\].io.27: \[veevavault-connector-demo\].get-documents-operationFlow.BLOCKING @2dd2ffaf\] \[event: 99716950-8818-11e9-90e2-d61515f42856\] org.mule.extension.veevavault.internal.operations.VeevaVaultOperations: Properties or Fields is not available for api \[/api/v18.2/metadata/objects/documents/types/site\_management\_\_c\] , will use input list \[\[name\_\_v, type\_\_v, subtype\_\_v, classification\_\_v, lifecycle\_\_v, status\_\_v, study\_\_v, product\_\_v, id\]\] if configured to build VQL query INFO 2019-06-06 10:39:45,098 \[\[MuleRuntime\].io.27: \[veevavault-connector-demo\].get-documents-operationFlow.BLOCKING @2dd2ffaf\] \[event: 99716950-8818-11e9-90e2-d61515f42856\] org.mule.extension.veevavault.internal.pagination.GetDocumentsPagingProvider: Query Build :: SELECT name\_\_v, type\_\_v, subtype\_\_v, classification\_\_v, lifecycle\_\_v, status\_\_v, study\_\_v, product\_\_v, id FROM documents WHERE name\_\_v= 'F22611234--6764' INFO 2019-06-06 10:39:46,024 \[\[MuleRuntime\].io.27: \[veevavault-connector-demo\].get-documents-operationFlow.BLOCKING @2dd2ffaf\] \[event: 99716950-8818-11e9-90e2-d61515f42856\] org.mule.extension.veevavault.internal.service.HttpRequestService: Response received for sync http request :: 'https://\[vault-domain\]/api/v18.2/query?q=SELECT+name\_\_v%2C+type\_\_v%2C+subtype\_\_v%2C+classification\_\_v%2C+lifecycle\_\_v%2C+status\_\_v%2C+study\_\_v%2C+product\_\_v%2C+id+FROM+documents+WHERE+name\_\_v%3D+%27F22611234--6764%27++LIMIT+1000+OFFSET+0' in 925 milliseconds.
項目 説明

API Limit Threshold (API 制限しきい値)

Veeva Vault API しきい値制限を入力します。このしきい値に達するかこのしきい値を超えた場合、コネクタは指定された時間待機します。デフォルトは ​200​ です。

Wait Time (待機時間)

API 制限しきい値に達するか API 制限しきい値を超えた場合にコネクタが待機する時間を入力します。デフォルトは ​5​ です。

Time Unit (時間単位)

待機時間の時間単位を選択します。デフォルトは ​MINUTES​ です。

**Daily API Limit Exceed Profile (1 日の API 制限超過プロファイル):** \[Daily API Limit Exceed Profile (1 日の API 制限超過プロファイル)\] 設定 (​**\[Connector Configuration (コネクタ設定)\] > \[Advanced (詳細)\] タブ**​) は、Veeva Vault API の 1 日の API 制限が、設定されたしきい値に達するかしきい値を超えた場合に使用されます。1 日の制限とは、1 日の連続期間における任意の 24 時間枠内の総 API コール数です。 **\[Daily API Limit Exceed Profile (1 日の API 制限超過プロファイル)\]**​ が有効になっている場合 (デフォルト)、コネクタは、指定されたしきい値に対して Veeva Vault API のレスポンスヘッダー (​**X-VaultAPI-DailyLimitRemaining**​) を評価し、1 日の API 制限を超えていることを示す例外をスローします。1 日の制限がリセットされるか、翌日に繰り越されるまで、ジョブまたは要求が作成されるたびに例外が引き続きスローされます。 次のサンプルログは、​**2019-06-06 10:47:31,698**​ に警告が発生し、​**2019-06-06 10:47:31,699**​ にエラーが発生したことを示しています。 WARN 2019-06-06 10:47:31,698 \[\[MuleRuntime\].io.44: \[veevavault-connector-demo\].get-documents-operationFlow.BLOCKING @108e7f43\] \[event: 624cfa50-881a-11e9-90e2-d61515f42856\] org.mule.extension.veevavault.internal.service.HttpRequestService: Veeva Daily API Limit remaining calls \[10000\] has exceeded/reached an Daily API Limit Profile threshold set as \[10000\]. As per API Limit Profile, Veeva Vault Connector will throw an exception. ERROR 2019-06-06 10:47:31,699 \[\[MuleRuntime\].io.44: \[veevavault-connector-demo\].get-documents-operationFlow.BLOCKING @108e7f43\] \[event: 624cfa50-881a-11e9-90e2-d61515f42856\] org.mule.extension.veevavault.internal.service.HttpRequestService: Exception caught while processing Sync request ::: https://xxxxx-xxxxx.veevavault.com/api/v20.1/metadata/vobjects/site\_\_v, Exception ::: \\{"responseStatus":"FAILURE","errors":\[\\{"type":"API\_LIMIT\_EXCEED","message":"The Veeva Vault Connector has reached/exceeded daily API limit remaining calls \[10000\]. The configured daily api limit threshold is \\(10000\\)"}\\\]} ERROR 2019-06-06 10:47:31,767 \[\[MuleRuntime\].io.44: \[veevavault-connector-demo\].get-documents-operationFlow.BLOCKING @108e7f43\] \[event: 624cfa50-881a-11e9-90e2-d61515f42856\] org.mule.runtime.core.internal.exception.OnErrorPropagateHandler: \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* Message : An error occurred from the Veeva Vault API. Error Code: API\_LIMIT\_EXCEED. Original Error Message: The Veeva Vault Connector has reached/exceeded daily API limit remaining calls \[10000\]. The configured daily api limit threshold is (10000). Error type : VEEVAVAULT:API\_LIMIT\_EXCEED \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
項目 説明

API Limit Threshold (API 制限しきい値)

API しきい値制限を入力します。指定された制限に達するか制限を超えた場合、コネクタは指定された時間待機します。デフォルトは ​10000​ です。

**Response Timeout (応答タイムアウト):** コネクタが Veeva Vault の応答を待機する最大時間 (ミリ秒単位)。この最大時間を超えると、タイムアウト例外がスローされます。デフォルト値は 30,000 ミリ秒です。
項目 説明

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

コネクタが Veeva Vault インスタンスからの応答を待機するタイムアウト値を入力します。デフォルト値は 30 秒です。

## [](#次のステップ)次のステップ Studio で使用する Veeva Vault Connector を設定したら、​[「追加設定情報」](https://docs.mulesoft.com/jp/veevavault-connector/1.2/veevavault-connector-config-topics)​トピックで詳細な設定手順を参照してください。 ## [](#関連情報)関連情報 - [Anypoint Studio のダウンロードおよびインストール](https://docs.mulesoft.com/studio/to-download-and-install-studio) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Anypoint Studio を使用した Veeva Vault Connector 1.3 の設定 Anypoint Studio (Studio) エディターは、Mule アプリケーション、プロパティ、および設定ファイルの設計と更新に役立ちます。 Studio でコネクタを追加および設定する手順は、次のとおりです。 1. [Mule プロジェクトを作成します](#create-mule-project)​。 2. [コネクタを Mule プロジェクトに追加します](#add-connector-to-project)​。 3. [コネクタのフローのソースを設定します](#configure-source)​。 4. [フローにコネクタの操作を追加します](#add-connector-operation)​。 5. [コネクタのグローバル要素を設定します](#configure-global-element)​。 [「アプリケーションログの表示」](#view-app-log)​で説明されているように、コネクタを実行するときに、リアルタイムでアプリケーションログを表示して問題を確認できます。 Studio で初めてコネクタを設定する場合は、​[「Anypoint Studio を使用したコネクタの設定」](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)​を参照してください。このトピックを参照した後、コネクタ項目についての詳細情報が必要な場合は、​[「Veeva Vault リファレンス」](https://docs.mulesoft.com/jp/veevavault-connector/1.3/veevavault-connector-reference)​を参照してください。 ## [](#create-mule-project)Mule プロジェクトを作成する Studio で、コネクタを追加および設定する新しい Mule プロジェクトを作成します。 1. Studio で、​**\[File (ファイル)\] > \[New (新規)\] > \[Mule Project (Mule プロジェクト)\]**​ を選択します。 2. Mule プロジェクトの名前を入力して、​**\[Finish (完了)\]**​ をクリックします。 ## [](#add-connector-to-project)コネクタを Mule プロジェクトに追加する Veeva Vault Connector を Mule プロジェクトに追加して、XML コードにコネクタの名前空間およびスキーマの場所を自動的に入力し、プロジェクトの ​`pom.xml`​ ファイルに必須の連動関係を追加します。 1. **\[Mule Palette (Mule パレット)\]**​ で、​**\[(X) Search in Exchange ((X) Exchange 内を検索)\]**​ をクリックします。 2. **\[Add Dependencies to Project (連動関係をプロジェクトに追加)\]**​ で、検索項目に「​`veeva vault`​」と入力します。 3. **\[Available modules (使用可能なモジュール)\]**​ で \[Veeva Vault\] をクリックします。 4. **\[Add (追加)\]**​ をクリックします。 5. **\[Finish (完了)\]**​ をクリックします。 Studio でコネクタを Mule プロジェクトに追加しても、Studio ワークスペースの他のプロジェクトはそのコネクタを使用できません。 ## [](#configure-source)ソースの設定 ソースは、指定された条件が満たされたときにフローを開始します。 次のソースのいずれかを Veeva Vault Connector で使用するように設定できます。 - HTTP リスナー 設定されたホストとポートで要求を受信するたびにフローを開始する - スケジューラー 時間ベースの条件が満たされたときにフローを開始する たとえば、HTTP Listener ソースを設定する手順は、次のとおりです。 1. **\[Mule Palette (Mule パレット)\]**​ で、​**\[HTTP\] > \[Listener\]**​ を選択します。 2. **\[Listener\]**​ を Studio キャンバスにドラッグします。 3. **\[Listener (リスナー)\]**​ 設定画面で、必要に応じて ​**\[Display Name (表示名)\]**​ 項目の値を変更します。 4. **\[Path (パス)\]**​ 項目の値を指定します。 5. **\[Connector configuration (コネクタ設定)\]**​ 項目の横にあるプラス記号 (​**+**​) をクリックして、アプリケーション内の HTTP Listener ソースのすべてのインスタンスで使用できるグローバル要素を設定します。 6. **\[General (一般)\]**​ タブで、コネクタの接続情報を指定します。 7. **\[TLS\]**​ タブで、必要に応じてコネクタの TLS 情報を指定します。 8. **\[Advanced (詳細)\]**​ タブで、必要に応じて再接続戦略を含む再接続情報を指定します。 9. **\[Test Connection (接続をテスト)\]**​ をクリックして、Mule が指定されたサーバーに接続できることを確認します。 10. **\[OK\]**​ をクリックします。 ## [](#add-connector-operation)フローにコネクタの操作を追加する フローにコネクタの操作を追加するときは、そのコネクタで実行するアクションを指定しています。 Veeva Vault Connector の操作を追加する手順は、次のとおりです。 1. **\[Mule Palette (Mule パレット)\]**​ で、​**\[Veeva Vault\]**​ を選択し、目的の操作を選択します。 2. その操作を Studio キャンバスの入力元の横にドラッグします。 ## [](#configure-global-element)コネクタのグローバル要素を設定する コネクタを設定する場合、アプリケーション内のそのコネクタのすべてのインスタンスで使用できるグローバル要素を設定します。グローバル要素を設定するには、コネクタが対象の Veeva Vault システムにアクセスするために必要な認証ログイン情報を指定する必要があります。Veeva Vault Connector では、基本認証がサポートされています。 Veeva Vault Connector のグローバル要素を設定する手順は、次のとおりです。 1. Studio キャンバスで操作を選択します。 2. 操作の ​**\[General (一般)\]**​ 設定画面で、​**\[Add (追加)\]**​ アイコンをクリックして、グローバル要素設定項目にアクセスします。 3. **\[General (一般)\]**​ タブの ​**\[Connection (接続)\]**​ で、​[\[Veeva Vault Config (Veeva Vault 設定)\]](#basic-auth)​ 方法を選択して基本認証を設定します。 ANT スタイルのプロパティプレースホルダーを含む設定ファイルを参照するか (推奨)、グローバル設定プロパティに認証ログイン情報を入力できます。プロパティプレースホルダーを使用する利点とその設定方法については、​[「Anypoint Connector 設定」](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview)​を参照してください。 4. **\[Advanced (詳細)\]**​ タブで、必要に応じて再接続戦略を含む再接続情報を指定します。 5. **\[Test Connection (接続をテスト)\]**​ をクリックして、Mule が指定されたサーバーに接続できることを確認します。 6. **\[OK\]**​ をクリックします。 ### [](#basic-auth)基本認証 **\[Global Element Properties (グローバル要素のプロパティ)\]**​ 画面の ​**\[General (一般)\]**​ タブで次の情報を入力し、基本認証を設定します。
項目 説明

名前

設定名

Vault URL

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

Username (ユーザー名)

セッションの初期化に使用するユーザー名

Password (パスワード)

ユーザーの認証に使用するパスワード

Client Id (クライアント ID)

追跡の目的で各リクエストヘッダーと共に Veeva Vault インスタンスに送信するクライアント ID (​{organization}-{company/team}​ の形式)。

クライアント ID には、​mulesoft​ プレフィックスと ​client-vaultconnector​ サフィックスが含まれます。例: mulesoft-abcpharma-clinicalprod-client-vaultconnector​。

次の画像は、​**\[General (一般)\]**​ タブでの基本認証の設定例を示しています。 ![「General (一般)」 タブで入力される基本認証の認証項目](/mulesoft/current/ja-jp/veevavault-connector/1.3/_images/basic-auth.png) **\[Global Element Properties (グローバル要素のプロパティ)\]**​ 画面の ​**\[Advanced (詳細)\]**​ タブで次の情報を入力し、基本認証のバースト API 制限を設定します。
項目 説明

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

コネクタが Veeva Vault の応答を待機する最大時間 (ミリ秒単位)。この最大時間を超えると、タイムアウト例外がスローされます。デフォルトは 30,000 ミリ秒 (30 秒) です。

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

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

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

次の例は、​2019-06-06 10:34:45,096​ の警告メッセージが含まれているアプリケーションログの例を示しています。​2019-06-06 10:39:45,098​ の次のメッセージで示されているように 5 分間プロセスが停止しています。

WARN 2019-06-06 10:34:45,096 [[MuleRuntime].io.27: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @2dd2ffaf] [event: 99716950-8818-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.service.HttpRequestService: Burst API Limit remaining calls [1997] has exceeded/reached an API Limit Profile threshold set as [1997]. As per API Limit Profile, Veeva Vault Connector will wait for [5] MINUTES.

WARN 2019-06-06 10:39:45,098 [[MuleRuntime].io.27: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @2dd2ffaf] [event: 99716950-8818-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.operations.VeevaVaultOperations: Properties or Fields is not available for api [/api/v18.2/metadata/objects/documents/types/site_management__c] , will use input list [[name__v, type__v, subtype__v, classification__v, lifecycle__v, status__v, study__v, product__v, id]] if configured to build VQL query

INFO 2019-06-06 10:39:45,098 [[MuleRuntime].io.27: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @2dd2ffaf] [event: 99716950-8818-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.pagination.GetDocumentsPagingProvider: Query Build :: SELECT name__v, type__v, subtype__v, classification__v, lifecycle__v, status__v, study__v, product__v, id FROM documents WHERE name__v= 'F22611234--6764'

INFO 2019-06-06 10:39:46,024 [[MuleRuntime].io.27: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @2dd2ffaf] [event: 99716950-8818-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.service.HttpRequestService: Response received for sync http request :: 'https://[vault-domain]/api/v18.2/query?q=SELECT+name__v%2C+type__v%2C+subtype__v%2C+classification__v%2C+lifecycle__v%2C+status__v%2C+study__v%2C+product__v%2C+id+FROM+documents+WHERE+name__v%3D+%27F22611234--6764%27++LIMIT+1000+OFFSET+0' in 925 milliseconds.

API Limit Threshold (API 制限しきい値)

[Burst API Limit Profile (バースト API 制限プロファイル)]​ の Veeva Vault API 制限しきい値。指定された制限に達するか超えた場合、コネクタは指定された時間待機します。デフォルトは ​200​ です。

Wait Time (待機時間)

[API Limit Threshold (API 制限しきい値)]​ に達するか超えた場合にコネクタが待機する時間。デフォルトは ​5​ です。

Time Unit (時間単位)

待機時間の時間単位。デフォルトは ​MINUTES​ です。

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

Veeva Vault API の 1 日の API 制限が、設定されたしきい値に達するか超えた場合に使用される [Daily API limit exceed profile (1 日の API 制限超過プロファイル)] 設定。1 日の制限とは、任意の 24 時間枠内の総 API コール数です。

次の例は、​2019-06-06 10:47:31,698​ の警告メッセージと ​2019-06-06 10:47:31,699​ のエラーメッセージが含まれているアプリケーションログを示しています。

WARN 2019-06-06 10:47:31,698 [[MuleRuntime].io.44: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @108e7f43] [event: 624cfa50-881a-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.service.HttpRequestService: Veeva Daily API Limit remaining calls [10000] has exceeded/reached an Daily API Limit Profile threshold set as [10000]. As per API Limit Profile, Veeva Vault Connector will throw an exception.

ERROR 2019-06-06 10:47:31,699 [[MuleRuntime].io.44: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @108e7f43] [event: 624cfa50-881a-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.service.HttpRequestService: Exception caught while processing Sync request ::: https://xxxxx-xxxxx.veevavault.com/api/v20.1/metadata/vobjects/site__v, Exception ::: \{"responseStatus":"FAILURE","errors":[\{"type":"API_LIMIT_EXCEED","message":"The Veeva Vault Connector has reached/exceeded daily API limit remaining calls [10000]. The configured daily api limit threshold is \(10000\)"}\]}

ERROR 2019-06-06 10:47:31,767 [[MuleRuntime].io.44: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @108e7f43] [event: 624cfa50-881a-11e9-90e2-d61515f42856] org.mule.runtime.core.internal.exception.OnErrorPropagateHandler:

**********************************************************************************

Message : An error occurred from the Veeva Vault API.
Error Code: API_LIMIT_EXCEED.
Original Error Message: The Veeva Vault Connector has reached/exceeded daily API limit remaining calls [10000]. The configured daily api limit threshold is (10000).
Error type : VEEVAVAULT:API_LIMIT_EXCEED

**********************************************************************************

API Limit Threshold (API 制限しきい値)

[Daily API Limit Profile (1 日の API 制限プロファイル)]​ の Veeva Vault API 制限しきい値。指定された制限に達するか超えた場合、コネクタは指定された時間待機します。デフォルトは ​10000​ です。

次の画像は、​**\[Advanced (詳細)\]**​ タブでの基本認証の設定例を示しています。 ![「Advanced (詳細)」 タブで入力される基本認証の認証項目](/mulesoft/current/ja-jp/veevavault-connector/1.3/_images/basic-auth-adv.png) ## [](#view-app-log)アプリケーションログの表示 問題を確認するため、アプリケーションログを次の方法で表示できます。 - アプリケーションを Anypoint Platform から実行している場合、アプリケーションログ出力は Anypoint Studio のコンソールウィンドウに表示されます。 - コマンドラインから Mule を使用してアプリケーションを実行している場合、アプリケーションログ出力はオペレーティングシステムのコンソールに表示されます。 アプリケーションのログファイル (​`log4j2.xml`​) でログファイルパスがカスタマイズされていない場合、デフォルトの場所 ​`MULE_HOME/logs/.log`​ でアプリケーションログにアクセスすることもできます。ログパスは、アプリケーションログファイル ​`log4j2.xml`​ で設定できます。 ## [](#次のステップ)次のステップ [「追加設定情報」](https://docs.mulesoft.com/jp/veevavault-connector/1.3/veevavault-connector-config-topics)​で、詳細な設定手順を参照してください。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Anypoint Studio を使用したコネクタの設定](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio) - [Veeva Vault Connector リファレンス](https://docs.mulesoft.com/jp/veevavault-connector/1.3/veevavault-connector-reference) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Anypoint Studio を使用した Veeva Vault Connector 1.4 の設定 Anypoint Studio (Studio) エディターは、Mule アプリケーション、プロパティ、および設定ファイルの設計と更新に役立ちます。 Studio でコネクタを追加および設定する手順は、次のとおりです。 1. [Mule プロジェクトを作成します](#create-mule-project)​。 2. [コネクタを Mule プロジェクトに追加します](#add-connector-to-project)​。 3. [コネクタのフローのソースを設定します](#configure-source)​。 4. [フローにコネクタの操作を追加します](#add-connector-operation)​。 5. [コネクタのグローバル要素を設定します](#configure-global-element)​。 [「アプリケーションログの表示」](#view-app-log)​で説明されているように、コネクタを実行するときに、リアルタイムでアプリケーションログを表示して問題を確認できます。 Studio で初めてコネクタを設定する場合は、​[「Anypoint Studio を使用したコネクタの設定」](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)​を参照してください。このトピックを参照した後、コネクタ項目についての詳細情報が必要な場合は、​[「Veeva Vault リファレンス」](https://docs.mulesoft.com/jp/veevavault-connector/1.4/veevavault-connector-reference)​を参照してください。 ## [](#create-mule-project)Mule プロジェクトを作成する Studio で、コネクタを追加および設定する新しい Mule プロジェクトを作成します。 1. Studio で、​**\[File (ファイル)\] > \[New (新規)\] > \[Mule Project (Mule プロジェクト)\]**​ を選択します。 2. Mule プロジェクトの名前を入力して、​**\[Finish (完了)\]**​ をクリックします。 ## [](#add-connector-to-project)コネクタを Mule プロジェクトに追加する Veeva Vault Connector を Mule プロジェクトに追加して、XML コードにコネクタの名前空間およびスキーマの場所を自動的に入力し、プロジェクトの ​`pom.xml`​ ファイルに必須の連動関係を追加します。 1. **\[Mule Palette (Mule パレット)\]**​ で、​**\[(X) Search in Exchange ((X) Exchange 内を検索)\]**​ をクリックします。 2. **\[Add Dependencies to Project (連動関係をプロジェクトに追加)\]**​ で、検索項目に「​`veeva vault`​」と入力します。 3. **\[Available modules (使用可能なモジュール)\]**​ で \[Veeva Vault\] をクリックします。 4. **\[Add (追加)\]**​ をクリックします。 5. **\[Finish (完了)\]**​ をクリックします。 Studio でコネクタを Mule プロジェクトに追加しても、Studio ワークスペースの他のプロジェクトはそのコネクタを使用できません。 ## [](#configure-source)ソースの設定 ソースは、指定された条件が満たされたときにフローを開始します。 次のソースのいずれかを Veeva Vault Connector で使用するように設定できます。 - HTTP Listener (HTTP リスナー) 設定されたホストとポートで要求を受信するたびにフローを開始する - スケジューラー 時間ベースの条件が満たされたときにフローを開始する たとえば、HTTP Listener ソースを設定する手順は、次のとおりです。 1. **\[Mule Palette (Mule パレット)\]**​ で、​**\[HTTP\] > \[Listener\]**​ を選択します。 2. **\[Listener\]**​ を Studio キャンバスにドラッグします。 3. **\[Listener (リスナー)\]**​ 設定画面で、必要に応じて ​**\[Display Name (表示名)\]**​ 項目の値を変更します。 4. **\[Path (パス)\]**​ 項目の値を指定します。 5. **\[Connector configuration (コネクタ設定)\]**​ 項目の横にあるプラス記号 (​**+**​) をクリックして、アプリケーション内の HTTP Listener ソースのすべてのインスタンスで使用できるグローバル要素を設定します。 6. **\[General (一般)\]**​ タブで、コネクタの接続情報を指定します。 7. **\[TLS\]**​ タブで、必要に応じてコネクタの TLS 情報を指定します。 8. **\[Advanced (詳細)\]**​ タブで、必要に応じて再接続戦略を含む再接続情報を指定します。 9. **\[Test Connection (接続をテスト)\]**​ をクリックして、Mule が指定されたサーバーに接続できることを確認します。 10. **\[OK\]**​ をクリックします。 ## [](#add-connector-operation)フローにコネクタの操作を追加する フローにコネクタの操作を追加するときは、そのコネクタで実行するアクションを指定しています。 Veeva Vault Connector の操作を追加する手順は、次のとおりです。 1. **\[Mule Palette (Mule パレット)\]**​ で、​**\[Veeva Vault\]**​ を選択し、目的の操作を選択します。 2. その操作を Studio キャンバスの入力元の横にドラッグします。 ## [](#configure-global-element)コネクタのグローバル要素を設定する コネクタを設定する場合、アプリケーション内のそのコネクタのすべてのインスタンスで使用できるグローバル要素を設定します。グローバル要素を設定するには、コネクタが対象の Veeva Vault システムにアクセスするために必要な認証ログイン情報を指定する必要があります。Veeva Vault Connector では、基本認証がサポートされています。 Veeva Vault Connector のグローバル要素を設定する手順は、次のとおりです。 1. Studio キャンバスで操作を選択します。 2. 操作の ​**\[General (一般)\]**​ 設定画面で、​**\[Add (追加)\]**​ アイコンをクリックして、グローバル要素設定項目にアクセスします。 3. **\[General (一般)\]**​ タブの ​**\[Connection (接続)\]**​ で、設定する認証方式を選択します。 - [Basic Connection (基本接続)](#basic_auth) - [OAuth 2.0/Open ID Connection Provider (OAuth 2.0/Open ID 接続プロバイダー)](#oauth2-oidc-connection) ANT スタイルのプロパティプレースホルダーを含む設定ファイルを参照するか (推奨)、グローバル設定プロパティに認証ログイン情報を入力できます。プロパティプレースホルダーを使用する利点とその設定方法については、​[「Anypoint Connector 設定」](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview)​を参照してください。 4. **\[Advanced (詳細)\]**​ タブで、必要に応じて再接続戦略を含む再接続情報を指定します。 5. **\[Test Connection (接続をテスト)\]**​ をクリックして、Mule が指定されたサーバーに接続できることを確認します。 6. **\[OK\]**​ をクリックします。 ### [](#basic_auth)Basic Connection (基本接続) **\[Global Element Properties (グローバル要素のプロパティ)\]**​ 画面の ​**\[General (一般)\]**​ タブで次の情報を入力し、基本認証を設定します。
項目 説明

Name (名前)

設定名

Vault URL

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

Username (ユーザー名)

セッションの初期化に使用するユーザー名

Password (パスワード)

ユーザーの認証に使用するパスワード

Client Id (クライアント ID)

追跡の目的で各リクエストヘッダーと共に Veeva Vault インスタンスに送信するクライアント ID (​{organization}-{company/team}​ の形式)。

クライアント ID には、​mulesoft​ プレフィックスと ​client-vaultconnector​ サフィックスが含まれます。例: mulesoft-abcpharma-clinicalprod-client-vaultconnector​。

次の画像は、​**\[General (一般)\]**​ タブでの基本認証の設定例を示しています。 ![「General (一般)」 タブで入力される基本認証の認証項目](/mulesoft/current/ja-jp/veevavault-connector/1.4/_images/basic-auth.png) **\[Global Element Properties (グローバル要素のプロパティ)\]**​ 画面の ​**\[Advanced (詳細)\]**​ タブで次の情報を入力し、基本認証のバースト API 制限を設定します。
項目 説明

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

コネクタが Veeva Vault の応答を待機する最大時間 (ミリ秒単位)。この最大時間を超えると、タイムアウト例外がスローされます。デフォルトは 30,000 ミリ秒 (30 秒) です。

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

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

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

次の例は、​2019-06-06 10:34:45,096​ の警告メッセージが含まれているアプリケーションログの例を示しています。​2019-06-06 10:39:45,098​ の次のメッセージで示されているように 5 分間プロセスが停止しています。

WARN 2019-06-06 10:34:45,096 [[MuleRuntime].io.27: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @2dd2ffaf] [event: 99716950-8818-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.service.HttpRequestService: Burst API Limit remaining calls [1997] has exceeded/reached an API Limit Profile threshold set as [1997]. As per API Limit Profile, Veeva Vault Connector will wait for [5] MINUTES.

WARN 2019-06-06 10:39:45,098 [[MuleRuntime].io.27: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @2dd2ffaf] [event: 99716950-8818-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.operations.VeevaVaultOperations: Properties or Fields is not available for api [/api/v18.2/metadata/objects/documents/types/site_management__c] , will use input list [[name__v, type__v, subtype__v, classification__v, lifecycle__v, status__v, study__v, product__v, id]] if configured to build VQL query

INFO 2019-06-06 10:39:45,098 [[MuleRuntime].io.27: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @2dd2ffaf] [event: 99716950-8818-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.pagination.GetDocumentsPagingProvider: Query Build :: SELECT name__v, type__v, subtype__v, classification__v, lifecycle__v, status__v, study__v, product__v, id FROM documents WHERE name__v= 'F22611234--6764'

INFO 2019-06-06 10:39:46,024 [[MuleRuntime].io.27: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @2dd2ffaf] [event: 99716950-8818-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.service.HttpRequestService: Response received for sync http request :: 'https://[vault-domain]/api/v18.2/query?q=SELECT+name__v%2C+type__v%2C+subtype__v%2C+classification__v%2C+lifecycle__v%2C+status__v%2C+study__v%2C+product__v%2C+id+FROM+documents+WHERE+name__v%3D+%27F22611234--6764%27++LIMIT+1000+OFFSET+0' in 925 milliseconds.

API Limit Threshold (API 制限しきい値)

[Burst API Limit Profile (バースト API 制限プロファイル)]​ の Veeva Vault API 制限しきい値。指定された制限に達するか超えた場合、コネクタは指定された時間待機します。デフォルトは ​200​ です。

Wait Time (待機時間)

[API Limit Threshold (API 制限しきい値)]​ に達するか超えた場合にコネクタが待機する時間。デフォルトは ​5​ です。

Time Unit (時間単位)

待機時間の時間単位。デフォルトは ​MINUTES​ です。

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

Veeva Vault API の 1 日の API 制限が、設定されたしきい値に達するか超えた場合に使用される [Daily API limit exceed profile (1 日の API 制限超過プロファイル)] 設定。1 日の制限とは、任意の 24 時間枠内の総 API コール数です。

次の例は、​2019-06-06 10:47:31,698​ の警告メッセージと ​2019-06-06 10:47:31,699​ のエラーメッセージが含まれているアプリケーションログを示しています。

WARN 2019-06-06 10:47:31,698 [[MuleRuntime].io.44: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @108e7f43] [event: 624cfa50-881a-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.service.HttpRequestService: Veeva Daily API Limit remaining calls [10000] has exceeded/reached an Daily API Limit Profile threshold set as [10000]. As per API Limit Profile, Veeva Vault Connector will throw an exception.

ERROR 2019-06-06 10:47:31,699 [[MuleRuntime].io.44: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @108e7f43] [event: 624cfa50-881a-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.service.HttpRequestService: Exception caught while processing Sync request ::: https://xxxxx-xxxxx.veevavault.com/api/v20.1/metadata/vobjects/site__v, Exception ::: \{"responseStatus":"FAILURE","errors":[\{"type":"API_LIMIT_EXCEED","message":"The Veeva Vault Connector has reached/exceeded daily API limit remaining calls [10000]. The configured daily api limit threshold is \(10000\)"}\]}

ERROR 2019-06-06 10:47:31,767 [[MuleRuntime].io.44: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @108e7f43] [event: 624cfa50-881a-11e9-90e2-d61515f42856] org.mule.runtime.core.internal.exception.OnErrorPropagateHandler:

**********************************************************************************

Message : An error occurred from the Veeva Vault API.
Error Code: API_LIMIT_EXCEED.
Original Error Message: The Veeva Vault Connector has reached/exceeded daily API limit remaining calls [10000]. The configured daily api limit threshold is (10000).
Error type : VEEVAVAULT:API_LIMIT_EXCEED

**********************************************************************************

API Limit Threshold (API 制限しきい値)

[Daily API Limit Profile (1 日の API 制限プロファイル)]​ の Veeva Vault API 制限しきい値。指定された制限に達するか超えた場合、コネクタは指定された時間待機します。デフォルトは ​10000​ です。

次の画像は、​**\[Advanced (詳細)\]**​ タブでの基本認証の設定例を示しています。 ![「Advanced (詳細)」 タブで入力される基本認証の認証項目](/mulesoft/current/ja-jp/veevavault-connector/1.4/_images/basic-auth-adv.png) ### [](#oauth2-oidc-connection)OAuth 2.0/Open ID Connection Provider (OAuth 2.0/Open ID 接続プロバイダー) Unresolved include directive in modules/ROOT/pages/veevavault-connector-studio.adoc - include::connectors::partial$oauth2-description.adoc\[\] Veeva Vault では、いくつかの OAuth プロバイダー (Azure AD、Ping Federate、および OIDC (OpenID Connect) をサポートするその他のプロバイダーなど) がサポートされています。
現在、Okta や、PKCE を必要とするその他のプロバイダーはサポートされていません。
Veeva Vault Connector の OAuth プロバイダーを設定します。次の手順は、OAuth プロバイダーと通信するための Veeva サービスの設定方法を示しています。 1. \[Veeva Vault Admin (Veeva Vault 管理)\] パネルで、​**\[Settings (設定)\]**​ タブに移動します。 2. **\[Domain Settings (ドメイン設定)\]**​ で、​**\[OAuth 2.0 / OpenID Connect Profiles (OAuth 2.0 / OpenID Connect プロファイル)\]**​ を選択します。 3. **\[作成\]**​ をクリックします。 4. プロファイルを設定します。​**\[Label (表示ラベル)\]**​ および ​**\[Name (名前)\]**​ の値を入力して ​**\[Status (状況)\]**​ を ​`[Active (アクティブ)]`​ に設定し、​**\[Authorization Server Provider (認証サーバープロバイダー)\]**​ に使用しているプロバイダーを設定するか、プロバイダーがリストにない場合は ​`[Other (その他)]`​ を選択します。また、​**\[Perform strict Audience Restriction validation (静的オーディエンス制限検証を実行)\]**​ チェックボックスをオンにすることもできます。 5. **\[AS Metadata (AS メタデータ)\]**​ の情報を入力します。すべての OpenID Connect プロバイダーの URL には、このメタデータが含まれていて、​`/.well-known/openid-configuration`​ で終了します。次に例を示します。 - Okta: `https://{OKTA_INSTANCE}.okta.com/.well-known/openid-configuration` - Azure: `https://login.microsoftonline.com/{TENANT}/v2.0/.well-known/openid-configuration` - PingFederate: `https://{YOUR_INSTANCE}/.well-known/openid-configuration` このメタデータを使用して ​**\[AS Metadata (AS メタデータ)\]**​ を設定するには、​**\[Upload AS Metadata (AS メタデータとしてアップロード)\]**​ ボタンをクリックして ​**\[Provide Authorization Server Metadata URL (認証サーバーメタデータ URL を指定)\]**​ オプションを選択します。これにより、上記の URL を ​**\[AS Metadata (AS メタデータ)\]**​ に貼り付けることができます。 ![上記の手順で入力された項目が表示されている \[OAuth 2.0 / OpenID Connect Profile configuration (OAuth 2.0/OpenID Connect プロファイル設定)\] ウィンドウ](_images/oauth-veeva-config-profile.png) 6. **\[Save (保存)\]**​ をクリックします。これで、作成されたプロファイルを表示できます。 ![プロファイルを作成した後の新しいウィンドウの \[Vault Session ID URL (Vault セッション ID URL)\] および \[AS Metadata URL (AS メタデータ URL)\] 項目](_images/oauth-veeva-config-session-id.png) 後でコネクタを設定するときに使用するために ​**\[Vault Session ID URL (Vault セッション ID URL)\]**​ をメモします。OpenID で Veeva を完全に設定するには、この新しいプロファイルを使用するユーザーをプロビジョニングする必要があります。詳細は、 [『Provision Users to Use SSO (SSO を使用するユーザーのプロビジョニング)』](https://platform.veevavault.help/en/gr/13977/)​を参照してください。 これで、OAuth 2.0 で Veeva Vault Connector を設定できます。 **\[Global Element Properties (グローバル要素のプロパティ)\]**​ 画面の ​**\[General (一般)\]**​ タブで次の情報を入力し、OAuth 2.0/Open ID 接続を設定します。
項目 説明

Name (名前)

設定名

Vault URL

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

Version (バージョン)

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

Client Id (クライアント ID)

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

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

新しい OIDC プロファイルの作成時に Veeva によって生成される OIDC プロファイル ID。OIDC プロファイル ID を設定するには、Veeva の OIDC プロファイルで ID を使用します。OIDC プロファイルには、​Vault セッション ID URL​ (例: https://login.veevavault.com/auth/oauth/session/_00000000-aaaa-bbbb-cccc-111111111111​。​_00000000-aaaa-bbbb-cccc-111111111111​ は OIDC プロファイル ID) が含まれています。​[OIDC Profile ID (OIDC プロファイル ID)]​ 項目では、この値を使用します。

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

サービスプロバイダーに登録されている OAuth コンシューマーキー。利用している ID プロバイダー (例: PoneOne、PingFederate) でクライアントアプリケーションをすでに登録してある場合の IdP クライアント ID です。

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

サービスプロバイダーに登録されている OAuth コンシューマーシークレット。利用している ID プロバイダー (例: PoneOne、PingFederate) でクライアントアプリケーションをすでに登録してある場合の IdP クライアントシークレットです。

Authorization Url (認証 URL)

OAuth 2.0 認証 URL (例: PingFederate の場合は ​https://{your-instance}/as/authorization.oauth2​)。

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

OAuth 2.0 トークン URL (例: https://{your-instance}/as/token.oauth2​)。

Scopes (スコープ)

必要に応じて OAuth 2.0 スコープをセットアップできますが、重要なスコープである ​openid​ と ​offline_access​ は事前に設定されています。

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

IdP 設定によっては、空白のままにしておくこともできます。

Listener Config (リスナー設定)

新しい HTTP リスナーを作成するか、すでに作成してある場合は既存の HTTP リスナーを使用します (例: http://localhost:8081/​)。

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

アプリケーションのコールバックパス。​callback​ に設定すると、フルコールバックパスは ​http://localhost:8081/callback​ になります。忘れずに IdP のリダイレクト URL にコールバックパスを追加してください。

Authorize Path (認証パス)

認証パス。OAuth 2.0 ダンスの開始時には、このパスにリダイレクトされます。たとえば、​authorize​ はフルパスが ​http://localhost:8081/authorize​ であることを意味します。

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

直接 ​http://localhost:8081/callback​ に設定できます。

Veeva Vault Connector の OAuth 2.0 設定の XML を次に示します。 ```xml ``` 上記の例では、Salesforce 認証プロバイダーを使用しており、次の形式でリソースフォルダーに ​`application.properties`​ ファイルを作成する必要があります。 http.port = 8080 oauth2.callback\_uri = http://localhost:8080/callback veeva.instance = your-veeva-instance veeva.client.id = your-veeva-client-id veeva.oidc.profile = your-oidc-id azure.tenant = azure-tenant-id azure.appid = azure-app-id azure.client.id = azure-oauth-client-id azure.client.secret = azure-oauth-client-secret
Azure AD は、​{app_id}/.default​ としてスコープを設定する必要がある特殊なケースです。他の OAuth プロバイダーでは、他のスコープが必要でなければ、定義済みの ​openid offline_access​ スコープを使用できます。
## [](#view-app-log)アプリケーションログの表示 問題を確認するため、アプリケーションログを次の方法で表示できます。 - アプリケーションを Anypoint Platform から実行している場合、アプリケーションログ出力は Anypoint Studio のコンソールウィンドウに表示されます。 - コマンドラインから Mule を使用してアプリケーションを実行している場合、アプリケーションログ出力はオペレーティングシステムのコンソールに表示されます。 アプリケーションのログファイル (​`log4j2.xml`​) でログファイルパスがカスタマイズされていない場合、デフォルトの場所 ​`MULE_HOME/logs/.log`​ でアプリケーションログにアクセスすることもできます。ログパスは、アプリケーションログファイル ​`log4j2.xml`​ で設定できます。 ## [](#次のステップ)次のステップ [「追加設定情報」](https://docs.mulesoft.com/jp/veevavault-connector/1.4/veevavault-connector-config-topics)​で、詳細な設定手順を参照してください。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Anypoint Studio を使用したコネクタの設定](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio) - [Veeva Vault Connector リファレンス](https://docs.mulesoft.com/jp/veevavault-connector/1.4/veevavault-connector-reference) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Anypoint Studio を使用した Veeva Vault Connector 1.5 の設定 Anypoint Studio (Studio) エディターは、Mule アプリケーション、プロパティ、および設定ファイルの設計と更新に役立ちます。 Studio でコネクタを追加および設定する手順は、次のとおりです。 1. [Mule プロジェクトを作成します](#create-mule-project)​。 2. [コネクタを Mule プロジェクトに追加します](#add-connector-to-project)​。 3. [コネクタのフローのソースを設定します](#configure-source)​。 4. [フローにコネクタの操作を追加します](#add-connector-operation)​。 5. [コネクタのグローバル要素を設定します](#configure-global-element)​。 [「アプリケーションログの表示」](#view-app-log)​で説明されているように、コネクタを実行するときに、リアルタイムでアプリケーションログを表示して問題を確認できます。 Studio で初めてコネクタを設定する場合は、​[「Anypoint Studio を使用したコネクタの設定」](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio)​を参照してください。このトピックを参照した後、コネクタ項目についての詳細情報が必要な場合は、​[「Veeva Vault リファレンス」](https://docs.mulesoft.com/jp/veevavault-connector/latest/veevavault-connector-reference)​を参照してください。 ## [](#create-mule-project)Mule プロジェクトを作成する Studio で、コネクタを追加および設定する新しい Mule プロジェクトを作成します。 1. Studio で、​**\[File (ファイル)\] > \[New (新規)\] > \[Mule Project (Mule プロジェクト)\]**​ を選択します。 2. Mule プロジェクトの名前を入力して、​**\[Finish (完了)\]**​ をクリックします。 ## [](#add-connector-to-project)コネクタを Mule プロジェクトに追加する Veeva Vault Connector を Mule プロジェクトに追加して、XML コードにコネクタの名前空間およびスキーマの場所を自動的に入力し、プロジェクトの ​`pom.xml`​ ファイルに必須の連動関係を追加します。 1. **\[Mule Palette (Mule パレット)\]**​ で、​**\[(X) Search in Exchange ((X) Exchange 内を検索)\]**​ をクリックします。 2. **\[Add Dependencies to Project (連動関係をプロジェクトに追加)\]**​ で、検索項目に「​`veeva vault`​」と入力します。 3. **\[Available modules (使用可能なモジュール)\]**​ で \[Veeva Vault\] をクリックします。 4. **\[Add (追加)\]**​ をクリックします。 5. **\[Finish (完了)\]**​ をクリックします。 Studio でコネクタを Mule プロジェクトに追加しても、Studio ワークスペースの他のプロジェクトはそのコネクタを使用できません。 ## [](#configure-source)ソースの設定 ソースは、指定された条件が満たされたときにフローを開始します。 次のソースのいずれかを Veeva Vault Connector で使用するように設定できます。 - HTTP リスナー 設定されたホストとポートで要求を受信するたびにフローを開始する - スケジューラー 時間ベースの条件が満たされたときにフローを開始する たとえば、HTTP Listener ソースを設定する手順は、次のとおりです。 1. **\[Mule Palette (Mule パレット)\]**​ で、​**\[HTTP\] > \[Listener\]**​ を選択します。 2. **\[Listener\]**​ を Studio キャンバスにドラッグします。 3. **\[Listener (リスナー)\]**​ 設定画面で、必要に応じて ​**\[Display Name (表示名)\]**​ 項目の値を変更します。 4. **\[Path (パス)\]**​ 項目の値を指定します。 5. **\[Connector configuration (コネクタ設定)\]**​ 項目の横にあるプラス記号 (​**+**​) をクリックして、アプリケーション内の HTTP Listener ソースのすべてのインスタンスで使用できるグローバル要素を設定します。 6. **\[General (一般)\]**​ タブで、コネクタの接続情報を指定します。 7. **\[TLS\]**​ タブで、必要に応じてコネクタの TLS 情報を指定します。 8. **\[Advanced (詳細)\]**​ タブで、必要に応じて再接続戦略を含む再接続情報を指定します。 9. **\[Test Connection (接続をテスト)\]**​ をクリックして、Mule が指定されたサーバーに接続できることを確認します。 10. **\[OK\]**​ をクリックします。 ## [](#add-connector-operation)フローにコネクタの操作を追加する フローにコネクタの操作を追加するときは、そのコネクタで実行するアクションを指定しています。 Veeva Vault Connector の操作を追加する手順は、次のとおりです。 1. **\[Mule Palette (Mule パレット)\]**​ で、​**\[Veeva Vault\]**​ を選択し、目的の操作を選択します。 2. その操作を Studio キャンバスの入力元の横にドラッグします。 ## [](#configure-global-element)コネクタのグローバル要素を設定する コネクタを設定する場合、アプリケーション内のそのコネクタのすべてのインスタンスで使用できるグローバル要素を設定します。グローバル要素を設定するには、コネクタが対象の Veeva Vault システムにアクセスするために必要な認証ログイン情報を指定する必要があります。Veeva Vault Connector では、基本認証がサポートされています。 Veeva Vault Connector のグローバル要素を設定する手順は、次のとおりです。 1. Studio キャンバスで操作を選択します。 2. 操作の ​**\[General (一般)\]**​ 設定画面で、​**\[Add (追加)\]**​ アイコンをクリックして、グローバル要素設定項目にアクセスします。 3. **\[General (一般)\]**​ タブの ​**\[Connection (接続)\]**​ で、設定する認証方式を選択します。 - [Basic Connection (基本接続)](#basic_auth) - [OAuth 2.0/Open ID Connection Provider (OAuth 2.0/Open ID 接続プロバイダー)](#oauth2-oidc-connection) ANT スタイルのプロパティプレースホルダーを含む設定ファイルを参照するか (推奨)、グローバル設定プロパティに認証ログイン情報を入力できます。プロパティプレースホルダーを使用する利点とその設定方法については、​[「Anypoint Connector 設定」](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview)​を参照してください。 4. **\[Advanced (詳細)\]**​ タブで、必要に応じて再接続戦略を含む再接続情報を指定します。 5. **\[Test Connection (接続をテスト)\]**​ をクリックして、Mule が指定されたサーバーに接続できることを確認します。 6. **\[OK\]**​ をクリックします。 ### [](#basic_auth)Basic Connection (基本接続) **\[Global Element Properties (グローバル要素のプロパティ)\]**​ 画面の ​**\[General (一般)\]**​ タブで次の情報を入力し、基本認証を設定します。
項目 説明

名前

設定名

Vault URL

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

Username (ユーザー名)

セッションの初期化に使用するユーザー名

Password (パスワード)

ユーザーの認証に使用するパスワード

Client Id (クライアント ID)

追跡の目的で各リクエストヘッダーと共に Veeva Vault インスタンスに送信するクライアント ID (​{organization}-{company/team}​ の形式)。

クライアント ID には、​mulesoft​ プレフィックスと ​client-vaultconnector​ サフィックスが含まれます。例: mulesoft-abcpharma-clinicalprod-client-vaultconnector​。

次の画像は、​**\[General (一般)\]**​ タブでの基本認証の設定例を示しています。 ![\[General (一般)\] タブで入力される基本認証の認証項目](_images/basic-auth.png) **\[Global Element Properties (グローバル要素のプロパティ)\]**​ 画面の ​**\[Advanced (詳細)\]**​ タブで次の情報を入力し、基本認証のバースト API 制限を設定します。
項目 説明

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

コネクタが Veeva Vault の応答を待機する最大時間 (ミリ秒単位)。この最大時間を超えると、タイムアウト例外がスローされます。デフォルトは 30,000 ミリ秒 (30 秒) です。

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

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

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

次の例は、​2019-06-06 10:34:45,096​ の警告メッセージが含まれているアプリケーションログの例を示しています。​2019-06-06 10:39:45,098​ の次のメッセージで示されているように 5 分間プロセスが停止しています。

WARN 2019-06-06 10:34:45,096 [[MuleRuntime].io.27: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @2dd2ffaf] [event: 99716950-8818-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.service.HttpRequestService: Burst API Limit remaining calls [1997] has exceeded/reached an API Limit Profile threshold set as [1997]. As per API Limit Profile, Veeva Vault Connector will wait for [5] MINUTES.

WARN 2019-06-06 10:39:45,098 [[MuleRuntime].io.27: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @2dd2ffaf] [event: 99716950-8818-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.operations.VeevaVaultOperations: Properties or Fields is not available for api [/api/v18.2/metadata/objects/documents/types/site_management__c] , will use input list [[name__v, type__v, subtype__v, classification__v, lifecycle__v, status__v, study__v, product__v, id]] if configured to build VQL query

INFO 2019-06-06 10:39:45,098 [[MuleRuntime].io.27: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @2dd2ffaf] [event: 99716950-8818-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.pagination.GetDocumentsPagingProvider: Query Build :: SELECT name__v, type__v, subtype__v, classification__v, lifecycle__v, status__v, study__v, product__v, id FROM documents WHERE name__v= 'F22611234--6764'

INFO 2019-06-06 10:39:46,024 [[MuleRuntime].io.27: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @2dd2ffaf] [event: 99716950-8818-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.service.HttpRequestService: Response received for sync http request :: 'https://[vault-domain]/api/v18.2/query?q=SELECT+name__v%2C+type__v%2C+subtype__v%2C+classification__v%2C+lifecycle__v%2C+status__v%2C+study__v%2C+product__v%2C+id+FROM+documents+WHERE+name__v%3D+%27F22611234--6764%27++LIMIT+1000+OFFSET+0' in 925 milliseconds.

API Limit Threshold (API 制限しきい値)

[Burst API Limit Profile (バースト API 制限プロファイル)]​ の Veeva Vault API 制限しきい値。指定された制限に達するか超えた場合、コネクタは指定された時間待機します。デフォルトは ​200​ です。

Wait Time (待機時間)

[API Limit Threshold (API 制限しきい値)]​ に達するか超えた場合にコネクタが待機する時間。デフォルトは ​5​ です。

Time Unit (時間単位)

待機時間の時間単位。デフォルトは ​MINUTES​ です。

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

Veeva Vault API の 1 日の API 制限が、設定されたしきい値に達するか超えた場合に使用される [Daily API limit exceed profile (1 日の API 制限超過プロファイル)] 設定。1 日の制限とは、任意の 24 時間枠内の総 API コール数です。

次の例は、​2019-06-06 10:47:31,698​ の警告メッセージと ​2019-06-06 10:47:31,699​ のエラーメッセージが含まれているアプリケーションログを示しています。

WARN 2019-06-06 10:47:31,698 [[MuleRuntime].io.44: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @108e7f43] [event: 624cfa50-881a-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.service.HttpRequestService: Veeva Daily API Limit remaining calls [10000] has exceeded/reached an Daily API Limit Profile threshold set as [10000]. As per API Limit Profile, Veeva Vault Connector will throw an exception.

ERROR 2019-06-06 10:47:31,699 [[MuleRuntime].io.44: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @108e7f43] [event: 624cfa50-881a-11e9-90e2-d61515f42856] org.mule.extension.veevavault.internal.service.HttpRequestService: Exception caught while processing Sync request ::: https://xxxxx-xxxxx.veevavault.com/api/v20.1/metadata/vobjects/site__v, Exception ::: \{"responseStatus":"FAILURE","errors":[\{"type":"API_LIMIT_EXCEED","message":"The Veeva Vault Connector has reached/exceeded daily API limit remaining calls [10000]. The configured daily api limit threshold is \(10000\)"}\]}

ERROR 2019-06-06 10:47:31,767 [[MuleRuntime].io.44: [veevavault-connector-demo].get-documents-operationFlow.BLOCKING @108e7f43] [event: 624cfa50-881a-11e9-90e2-d61515f42856] org.mule.runtime.core.internal.exception.OnErrorPropagateHandler:

**********************************************************************************

Message : An error occurred from the Veeva Vault API.
Error Code: API_LIMIT_EXCEED.
Original Error Message: The Veeva Vault Connector has reached/exceeded daily API limit remaining calls [10000]. The configured daily api limit threshold is (10000).
Error type : VEEVAVAULT:API_LIMIT_EXCEED

**********************************************************************************

API Limit Threshold (API 制限しきい値)

[Daily API Limit Profile (1 日の API 制限プロファイル)]​ の Veeva Vault API 制限しきい値。指定された制限に達するか超えた場合、コネクタは指定された時間待機します。デフォルトは ​10000​ です。

次の画像は、​**\[Advanced (詳細)\]**​ タブでの基本認証の設定例を示しています。 ![\[Advanced (詳細)\] タブで入力される基本認証の認証項目](_images/basic-auth-adv.png) ### [](#oauth2-oidc-connection)OAuth 2.0/Open ID Connection Provider (OAuth 2.0/Open ID 接続プロバイダー) Unresolved include directive in modules/ROOT/pages/veevavault-connector-studio.adoc - include::connectors::partial$oauth2-description.adoc\[\] Veeva Vault では、いくつかの OAuth プロバイダー (Azure AD、Ping Federate、および OIDC (OpenID Connect) をサポートするその他のプロバイダーなど) がサポートされています。
現在、Okta や、PKCE を必要とするその他のプロバイダーはサポートされていません。
Veeva Vault Connector の OAuth プロバイダーを設定します。次の手順は、OAuth プロバイダーと通信するための Veeva サービスの設定方法を示しています。 1. \[Veeva Vault Admin (Veeva Vault 管理)\] パネルで、​**\[Settings (設定)\]**​ タブに移動します。 2. **\[Domain Settings (ドメイン設定)\]**​ で、​**\[OAuth 2.0 / OpenID Connect Profiles (OAuth 2.0 / OpenID Connect プロファイル)\]**​ を選択します。 3. **\[作成\]**​ をクリックします。 4. プロファイルを設定します。​**\[Label (表示ラベル)\]**​ および ​**\[Name (名前)\]**​ の値を入力して ​**\[Status (状況)\]**​ を ​`[Active (アクティブ)]`​ に設定し、​**\[Authorization Server Provider (認証サーバープロバイダー)\]**​ に使用しているプロバイダーを設定するか、プロバイダーがリストにない場合は ​`[Other (その他)]`​ を選択します。また、​**\[Perform strict Audience Restriction validation (静的オーディエンス制限検証を実行)\]**​ チェックボックスをオンにすることもできます。 5. **\[AS Metadata (AS メタデータ)\]**​ の情報を入力します。すべての OpenID Connect プロバイダーの URL には、このメタデータが含まれていて、​`/.well-known/openid-configuration`​ で終了します。次に例を示します。 - Okta: `https://{OKTA_INSTANCE}.okta.com/.well-known/openid-configuration` - Azure: `https://login.microsoftonline.com/{TENANT}/v2.0/.well-known/openid-configuration` - PingFederate: `https://{YOUR_INSTANCE}/.well-known/openid-configuration` このメタデータを使用して ​**\[AS Metadata (AS メタデータ)\]**​ を設定するには、​**\[Upload AS Metadata (AS メタデータとしてアップロード)\]**​ ボタンをクリックして ​**\[Provide Authorization Server Metadata URL (認証サーバーメタデータ URL を指定)\]**​ オプションを選択します。これにより、上記の URL を ​**\[AS Metadata (AS メタデータ)\]**​ に貼り付けることができます。 ![上記の手順で入力された項目が表示されている \[OAuth 2.0/OpenID Connect Profile configuration (OAuth 2.0/OpenID Connect プロファイル設定)\] ウィンドウ](_images/oauth-veeva-config-profile.png) 6. **\[Save (保存)\]**​ をクリックします。これで、作成されたプロファイルを表示できます。 ![プロファイルを作成した後の新しいウィンドウの \[Vault Session ID URL (Vault セッション ID URL)\] および \[AS Metadata URL (AS メタデータ URL)\] 項目](_images/oauth-veeva-config-session-id.png) 後でコネクタを設定するときに使用するために ​**\[Vault Session ID URL (Vault セッション ID URL)\]**​ をメモします。OpenID で Veeva を完全に設定するには、この新しいプロファイルを使用するユーザーをプロビジョニングする必要があります。詳細は、 [『Provision Users to Use SSO (SSO を使用するユーザーのプロビジョニング)』](https://platform.veevavault.help/en/gr/13977/)​を参照してください。 これで、OAuth 2.0 で Veeva Vault Connector を設定できます。 **\[Global Element Properties (グローバル要素のプロパティ)\]**​ 画面の ​**\[General (一般)\]**​ タブで次の情報を入力し、OAuth 2.0/Open ID 接続を設定します。
項目 説明

名前

設定名

Vault URL

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

Version (バージョン)

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

Client Id (クライアント ID)

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

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

新しい OIDC プロファイルの作成時に Veeva によって生成される OIDC プロファイル ID。OIDC プロファイル ID を設定するには、Veeva の OIDC プロファイルで ID を使用します。OIDC プロファイルには、​Vault セッション ID URL​ (例: https://login.veevavault.com/auth/oauth/session/_00000000-aaaa-bbbb-cccc-111111111111​。​_00000000-aaaa-bbbb-cccc-111111111111​ は OIDC プロファイル ID) が含まれています。​[OIDC Profile ID (OIDC プロファイル ID)]​ 項目では、この値を使用します。

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

サービスプロバイダーに登録されている OAuth コンシューマーキー。利用している ID プロバイダー (例: PoneOne、PingFederate) でクライアントアプリケーションをすでに登録してある場合の IdP クライアント ID です。

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

サービスプロバイダーに登録されている OAuth コンシューマーシークレット。利用している ID プロバイダー (例: PoneOne、PingFederate) でクライアントアプリケーションをすでに登録してある場合の IdP クライアントシークレットです。

Authorization Url (認証 URL)

OAuth 2.0 認証 URL (例: PingFederate の場合は ​https://{your-instance}/as/authorization.oauth2​)。

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

OAuth 2.0 トークン URL (例: https://{your-instance}/as/token.oauth2​)。

Scopes (スコープ)

必要に応じて OAuth 2.0 スコープをセットアップできますが、重要なスコープである ​openid​ と ​offline_access​ は事前に設定されています。

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

IdP 設定によっては、空白のままにしておくこともできます。

Listener Config (リスナー設定)

新しい HTTP リスナーを作成するか、すでに作成してある場合は既存の HTTP リスナーを使用します (例: http://localhost:8081/​)。

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

アプリケーションのコールバックパス。​callback​ に設定すると、フルコールバックパスは ​http://localhost:8081/callback​ になります。忘れずに IdP のリダイレクト URL にコールバックパスを追加してください。

Authorize Path (認証パス)

認証パス。OAuth 2.0 ダンスの開始時には、このパスにリダイレクトされます。たとえば、​authorize​ はフルパスが ​http://localhost:8081/authorize​ であることを意味します。

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

直接 ​http://localhost:8081/callback​ に設定できます。

Veeva Vault Connector の OAuth 2.0 設定の XML を次に示します。 ```xml ``` 上記の例では、Salesforce 認証プロバイダーを使用しており、次の形式でリソースフォルダーに ​`application.properties`​ ファイルを作成する必要があります。 http.port = 8080 oauth2.callback\_uri = http://localhost:8080/callback veeva.instance = your-veeva-instance veeva.client.id = your-veeva-client-id veeva.oidc.profile = your-oidc-id azure.tenant = azure-tenant-id azure.appid = azure-app-id azure.client.id = azure-oauth-client-id azure.client.secret = azure-oauth-client-secret
Azure AD は、​{app_id}/.default​ としてスコープを設定する必要がある特殊なケースです。他の OAuth プロバイダーでは、他のスコープが必要でなければ、定義済みの ​openid offline_access​ スコープを使用できます。
## [](#view-app-log)アプリケーションログの表示 問題を確認するため、アプリケーションログを次の方法で表示できます。 - アプリケーションを Anypoint Platform から実行している場合、アプリケーションログ出力は Anypoint Studio のコンソールウィンドウに表示されます。 - コマンドラインから Mule を使用してアプリケーションを実行している場合、アプリケーションログ出力はオペレーティングシステムのコンソールに表示されます。 アプリケーションのログファイル (​`log4j2.xml`​) でログファイルパスがカスタマイズされていない場合、デフォルトの場所 ​`MULE_HOME/logs/.log`​ でアプリケーションログにアクセスすることもできます。ログパスは、アプリケーションログファイル ​`log4j2.xml`​ で設定できます。 ## [](#次のステップ)次のステップ [「追加設定情報」](https://docs.mulesoft.com/jp/veevavault-connector/latest/veevavault-connector-config-topics)​で、詳細な設定手順を参照してください。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Anypoint Studio を使用したコネクタの設定](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio) - [Veeva Vault Connector リファレンス](https://docs.mulesoft.com/jp/veevavault-connector/latest/veevavault-connector-reference) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Veeva Vault Connector 1.2 Veeva Vault 用 Anypoint Connector (Veeva Vault Connector) を使用すると、Veeva Vault REST API を使用して Mule フローを Veeva Vault プラットフォームに接続できます。 互換性と解決された問題に関する情報は、​[「Veeva Vault Connector リリースノート」](https://docs.mulesoft.com/jp/release-notes/connector/veeva-vault-release-notes-mule-4)​を参照してください。 設定する操作に応じて、このコネクタは [Veeva Vault REST API、Bulk API、ストリーミング API](https://developer.veevavault.com/api/19.1/#authentication)​ と連動します。各 API コールは JSON または CSV 要求を使用して、HTTPS 接続経由で JSON 入力ストリーム応答を返します。必要なすべてのリクエストヘッダー、エラー処理、および HTTPS 接続設定は、コネクタに組み込まれています。 Mule アプリケーションで Veeva Vault Connector をアウトバウンドコネクタとして使用して、次の Veeva Vault オブジェクトに対する CRUD (create、retrieve、update、delete) 操作、クエリ操作、エクスポート操作、および Spark Validator 操作を実行できます。 - ドキュメント 作成、取得、更新、削除、エクスポート - ドキュメントレンディション 作成、取得、削除 - Vault Object (Vault オブジェクト) 作成、取得、更新、削除 - 選択リスト: 取得 - 監査履歴: 取得 - Query ドキュメント、Vault オブジェクト、ワークフローに対してクエリを実行するための VQL クエリ - Spark validator (Spark Validator) Veeva Vault からトリガーされた署名付き Spark メッセージの検証と確認を行います - Invoke Rest API 特定のコネクタ操作が存在しない場合に、 [Veeva Vault Rest APIs (Veeva Vault Rest API)](https://developer.veevavault.com/api/20.1/#documents)​ を呼び出す操作。 [API レート制限](https://developer.veevavault.com/docs/#api-rate-limits)​を超過しないように、REST API を個別に使用するのではなく、可能な限り一括で使用してください。 基本認証とログイン情報を使用して Veeva Vault インスタンスに接続し、操作を実行するように Veeva Vault Connector を設定できます。 ## [](#始める前に)始める前に このコネクタを使用するには、以下に精通している必要があります。 - Veeva Vault - [Vault クエリ言語 (VQL)](https://developer.veevavault.com/vql/#introduction-to-vault-queries) - 概念、Mule フローの要素、グローバル要素を含め、Mule Runtime Engine (Mule)。 - Anypoint Connector - Anypoint Studio アプリケーションを作成する前に、次の作業を行う必要があります。 - Anypoint Platform アカウントを用意する。 - Veeva Vaul 対象リソースにアクセスするための Veeva Vaul アカウントを用意する。 - Anypoint Studio を使用した Mule アプリケーションの作成方法を理解する ## [](#対象者)対象者 - 初心者ユーザー Mule アプリケーションを作成するには、​[「Studio 設定」](https://docs.mulesoft.com/jp/veevavault-connector/1.2/veevavault-connector-studio)​を参照してください。 [「追加設定情報」](https://docs.mulesoft.com/jp/veevavault-connector/1.2/veevavault-connector-config-topics)​トピックは Veeva Vault Connector の理解を深めるために役立ちます。 [「例」](https://docs.mulesoft.com/jp/veevavault-connector/1.2/veevavault-connector-examples)​トピックには、コネクタを使用するための 1 つ以上のユースケースがあります。 - パワーユーザー [「XML と Maven のサポート」](https://docs.mulesoft.com/jp/veevavault-connector/1.2/veevavault-connector-xml-maven)​、​[「追加設定情報」](https://docs.mulesoft.com/jp/veevavault-connector/1.2/veevavault-connector-config-topics)​、および​[「例」](https://docs.mulesoft.com/jp/veevavault-connector/1.2/veevavault-connector-examples)​トピックを参照してください。 ## [](#exchange-のテンプレートと例の使用)Exchange のテンプレートと例の使用 [Anypoint Exchange](https://www.mulesoft.com/exchange/)​ は、アプリケーションのスタートポイントとして使用できるテンプレートと、完全なソリューションを具体的に示した例を提供しています。 Veeva Vault Connector で使用可能なテンプレートは次のとおりです。 - [ファイルシステムから Veeva Vault](https://anypoint.mulesoft.com/exchange/org.mule.examples/filesystem-to-veeva-vault-template/) - [Veeva Vault からファイルシステム](https://anypoint.mulesoft.com/exchange/org.mule.examples/veevavault-connector-project-templates/) - [Spark メッセージのエンドツーエンドソリューション](https://anypoint.mulesoft.com/exchange/org.mule.examples/spark-message-solution-template/) ## [](#次のステップ)次のステップ 前提条件を満たし、テンプレートおよびサンプルを試したら、​[Anypoint Studio](https://docs.mulesoft.com/jp/veevavault-connector/1.2/veevavault-connector-studio)​ でアプリケーションを作成できます。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Veeva Vault Connector](https://www.mulesoft.com/exchange/?search=veevavault&type=connector) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Veeva Vault Connector 1.2 の XML と Maven のサポート Anypoint Studio の XML エディターまたはテキストエディターから XML で Mule アプリケーションを手動でコーディングする場合、参照ステートメントを XML Mule フローおよび Apache Maven POM ファイルに追加することで、アプリケーションでコネクタにアクセスできます。
Studio を使用して、このトピックで説明されている手動プロセスを回避できます。コネクタを Anypoint Studio にインストールすると、Studio は自動的に XML コードにコネクタの名前空間およびスキーマの場所を入力し、pom.xml ファイルに連動関係を追加します。
## [](#コネクタの名前空間の追加)コネクタの名前空間の追加 次のコードを設定 XML のヘッダーの ​`mule`​ タグ内に貼り付けます。 ```xml http://www.mulesoft.org/schema/mule/veevavault http://www.mulesoft.org/schema/mule/veevavault/current/mule-veevavault.xsd ``` 次の例は、XML 内に名前空間ステートメントが配置される方法を示しています。 ```xml ``` ## [](#pom-ファイルの連動関係の追加)POM ファイルの連動関係の追加 pom.xml Apache Maven ファイルは Anypoint Studio によって生成され、Mule アプリケーションの連動関係が含まれます。Mule アプリケーションを手動でコーディングする場合、次の XML スニペットを POM ファイルに含めてこのコネクタにアクセスできるようにします。 ```xml org.mule.extension mule-veevavault-connector x.x.x mule-plugin ``` コネクタの ​`version`​ が、使用しているバージョンと一致していることを確認します。 最新の ​`pom.xml`​ ファイル情報を取得する手順は、次のとおりです。 1. [Anypoint Exchange](https://www.mulesoft.com/exchange/)​ に移動します。 2. Exchange で、​**\[Login (ログイン)\]**​ をクリックし、Anypoint Platform のユーザー名とパスワードを指定します。 3. Exchange で、「​`hdfs`​」を検索します。 4. **\[Dependency Snippets (連動関係スニペット)\]**​ をクリックします。 ### [](#maven-連動関係情報)Maven 連動関係情報 XML でアプリケーションを手動で作成する場合は、プロジェクトの pom.xml を設定する必要があります。 org.mule.tools.maven mule-maven-plugin ${mule.maven.plugin.version} true org.json json anypoint-exchange-v2 Anypoint Exchange https://maven.anypoint.mulesoft.com/api/v2/maven default mulesoft-releases MuleSoft Releases Repository https://repository.mulesoft.org/releases/ default ## [](#次のステップ)次のステップ 名前空間および ​`pom.xml`​ ファイルを完了したら、​[例](https://docs.mulesoft.com/jp/veevavault-connector/1.2/veevavault-connector-examples)​を試すことができます。 ## [](#関連情報)関連情報 [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Veeva Vault Connector 1.2 の例 提供されているサンプルプロジェクトを MuleSoft プロジェクトの開始ポイントとして使用できます。 ## [](#vault-でのドキュメントの作成)Vault でのドキュメントの作成 次の例では、外部ソース (データベース) からフェッチしたドキュメントメタデータを使用してドキュメントを一括で作成します。Vault でドキュメントを作成する前に、Veeva Vault FTP サーバーを使用してドキュメントファイルをアップロードします。ドキュメントの ​`created`​ 状況がデータベースに挿入されます。 Mule フローを作成する手順は、次のとおりです。 1. \[Mule Palette (Mule パレット)\] から ​**HTTP Listener**​ をドラッグし、プロジェクトキャンバスにドロップします。 2. 使用する環境に応じて HTTP リスナーを設定します。 3. **Database Select**​ 操作をドラッグして、テーブルからドキュメントメタデータをフェッチします。 4. 接続ログイン情報を使用して、Database Connector を設定します。 5. **\[Flow Reference (フロー参照)\]**​ 要素をドラッグして、サブフロー ​`upload-files-on-vault-ftp-server`​ を参照します。 6. **Transform Message**​ コンポーネントをドラッグして、ドキュメントメタデータを CSV 形式に変換します。 7. VeevaVault コネクタパレットから ​**Create Documents**​ 操作をドラッグします。 8. Veeva Vault 接続の値を入力します。 - Username (ユーザー名) - Password (パスワード) - Vault URL - Vault バージョン - Vault クライアント ID 9. **Database Bulk Insert**​ 操作をドラッグして、ドキュメント作成済み状況データをデータベーステーブルに挿入します。 10. **Logger**​ コンポーネントをドラッグして、コンソールまたはログファイルに情報を記録します。 11. **Logger**​ コンポーネントを含むサブフローを作成して、サブフローの情報を記録します。 12. `Read file`​ 操作と FTPS ​`Write`​ 操作を含む ​**For-Each**​ スコープをドラッグして、ファイルを Veeva Vault FTP サーバーに書き込みます。 13. Veeva Vault FTP サーバーのログイン情報を使用して FTPS Connector を設定します。 ## [](#studio-のフロー)Studio のフロー ![veevavault connector create documents example](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-create-documents-example.png) ![veevavault connector upload documents example](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-upload-documents-example.png) ## [](#xml-コード)XML コード 次のサンプル XML コードは、Create Documents 操作のフローを示しています。 ```xml SELECT * FROM createdocuments { lifecycle__v: payload01.lifecycle__v, study__v: payload01.study__v, subtype__v: payload01.subtype__v, name__v: payload01.name__v ++ '--' ++ randomInt(10000) as String, type__v: payload01.type__v, classification__v: payload01.classification__v, product__v: payload01.product__v, file: payload01.file as String }]]> { 'id': $.id as String, 'external_id__v': $.external_id__v as String, 'responseStatus': $.responseStatus }]]]> INSERT into documents (id, external_id__v, responseStatus) VALUES (:id: external_id__v, :responseStatus) ``` ## [](#ドキュメントの詳細を取得する)ドキュメントの詳細を取得する この例では、種別、サブタイプ、分類に基づいてドキュメントの詳細を取得してデータベースに保存します。 Mule フローを作成する手順は、次のとおりです。 1. \[Mule Palette (Mule パレット)\] から ​**HTTP Listener**​ をドラッグし、プロジェクトキャンバスにドロップします。 2. 使用する環境に応じて HTTP リスナーを設定します。 3. VeevaVault コネクタパレットから ​**Get Documents**​ 操作をドラッグアンドドロップします。 4. Veeva Vault 接続の値を入力します。 - Username (ユーザー名) - Password (パスワード) - Vault URL - Vault バージョン - Vault クライアント ID 5. 各更新ボタンをクリックして、ドキュメント種別、サブタイプ、および分類のリストをフェッチします。 6. 各ドロップダウンリストからドキュメント種別、サブタイプ、および分類を選択します。 7. ビジネス要件に応じてドキュメントプロパティを \[Document Properties (ドキュメントプロパティ)\] リストに追加し、プロパティ名を VQL クエリに組み込んで、VQL クエリを動的にビルドします。 8. Veeva Vault ​**Get Documents**​ 操作の後に ​**For-Each**​ スコープをドラッグします。 9. **Transform Message**​ コンポーネントと Database Connector ​**Insert**​ 操作をそれぞれのパレットからプロジェクトにドロップします。 10. ビジネス要件に従って、DataWeave を使用して変換を設定します。 11. データをテーブルに挿入するように Database ​**Insert**​ クエリを設定します。 12. **For-Each**​ の後に ​**Set Payload**​ トランスフォーマーをドラッグして、トリガーされたソースに戻るペイロードを設定します。 13. **Logger**​ コンポーネントをドラッグして、コンソールまたはログファイルに情報を記録します。 ![veevavault connector get documents example](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-get-documents-example.png) ## [](#xml-コード-2)XML コード ```xml INSERT INTO [.underline]#createdocuments# (name__v, type__v, subtype__v, classification__v, lifecycle__v, product__v, status__v, study__v, file) VALUES (:name__v, :type__v, :subtype__v, :classification__v, :lifecycle__v, :product__v, :status__v, :study__v, :file) ``` ## [](#ドキュメントまたはオブジェクトデータのフェッチ)ドキュメントまたはオブジェクトデータのフェッチ この Mule フローでは、VQL クエリを使用して Veeva Vault からドキュメントまたはオブジェクトデータを取得します。 Mule フローを作成する手順は、次のとおりです。 1. \[Mule Palette (Mule パレット)\] から ​**HTTP Listener**​ をドラッグし、プロジェクトキャンバスにドロップします。 2. 使用する環境に応じて HTTP リスナーを設定します。 3. Veeva Vault Connector パレットから Veeva Vault ​**Query**​ 操作をドラッグします。 4. Veeva Vault 接続の値を入力します。 - Username (ユーザー名) - Password (パスワード) - Vault URL - Vault バージョン - Vault クライアント ID 5. ビジネス要件に従って VQL クエリを定義します。 6. VQL クエリで使用する場合は、入力プレースホルダーを追加して、実行時に VQL で動的に組み込みます。 7. Veeva Vault ​**Query**​ 操作の後に ​**For-Each**​ スコープをドラッグします。 8. **Transform Message**​ 操作と ​**File - Write**​ 操作をそれぞれのパレットからドロップします。 9. ペイロードを変換するビジネスニーズに応じて、Dataweave を使用して変換を設定します。 10. 作業ファイルのパスを使用して、File Connector を設定します。 11. 指定したファイルにペイロードデータを書き込むように ​**Write**​ 操作を設定します。 12. **For-Each**​ の後に ​**Set Payload**​ トランスフォーマーをドラッグして、トリガーされたソースに戻るペイロードを設定します。 13. **Logger**​ コンポーネントをドラッグして、コンソールまたはログファイルに情報を記録します。 ![veevavault connector query example](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-query-example.png) ## [](#xml-コード-3)XML コード ```xml SELECT id, name__v, type__v, subtype__v, classification__v, lifecycle__v, status__v, study__v, product__v from :table WHERE name__v= 'F22611234--6764' ``` ## [](#spark-メッセージの検証)Spark メッセージの検証 この Mule フローでは、Vault からトリガーされた Spark メッセージを検証します。 Mule フローを作成する手順は、次のとおりです。 1. \[Mule Palette (Mule パレット)\] から ​**HTTP Listener**​ をドラッグし、プロジェクトキャンバスにドロップします。 2. HTTPS Connector 用の JKS 証明書には、Veeva Vault との TLS 接続を介して Spark メッセージを受信するための HTTPS リスナー用の .jks ファイルが必要です。 以下は、.jks ファイルを作成するための手順です (​`/bin`​ ディレクトリにある Java Keytool を使用できます)。次に例を示します。 1. `/bin`​ ディレクトリから次のコマンドを実行します。 ​\`keytool -genkey -keyalg RSA -alias mule -keystore spark-listener.jks -storepass password -validity 360 -keysize 2048\` これにより、現在のディレクトリに ​\`spark-listener.jks\`​ ファイルが作成されます。 2. ​`src/main/resources`​ プロジェクトディレクトリの ​`spark-listener.jks`​ ファイルをコピーしてインポートします。HTTPS リスナーを次のように設定します。 1. **\[General (一般)\]**​ タブで、次のように設定します。 - Protocol (プロトコル): HTTPS - Host (ホスト): 0.0.0.0 - Port (ポート): 8082 2. **\[TLS\] タブ > \[Key Store (キーストア)\]**​ で、以下を設定します。 - Type (種別): JKS - Path (パス): spark-listener.jks - Alias (別名): mule - Key Password (キーパスワード): password - Password (パスワード): password 3. Veeva Vault パレットから ​**Spark Validator**​ 操作をプロジェクトキャンバスにドラッグします。 4. Veeva Vault 接続の値を入力します。 - Username (ユーザー名) - Password (パスワード) - Vault URL - Vault バージョン - Vault クライアント ID 5. Spark Validator パラメーターを次のように設定します。 - Include Spark Header (Spark ヘッダーを含める): `FALSE` - Public Key Path: `${file.keyPath}`​ 公開キーファイル (00001.pem) の保存場所へのパスを使用して、​`configuration.yaml`​ の ​`file.keyPath`​ プロパティを定義します。 - Spark Headers (Spark ヘッダー): `#[attributes.headers]` - Spark Message (Spark メッセージ): `#[payload]` 6. **Set Payload**​ 操作をプロジェクトキャンバスにドラッグし、​**Value**​ 項目で以下を定義します。 \---- output application/json --- { "payload" : payload, "attributes": attributes } ---- 7. **Logger**​ コンポーネントをプロジェクトキャンバスにドラッグして、次のメッセージを使用してペイロードを記録します。 Spark Message :: #\[payload\] ![veevavault connector spark validator example](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-spark-validator-example.png) ## [](#xml-コード-4)XML コード ```xml ``` ## [](#rest-api-を呼び出して単一のドキュメントを作成します)REST API を呼び出して単一のドキュメントを作成します。 Mule フローを作成する手順は、次のとおりです。 1. \[Mule Palette (Mule パレット)\] から ​**HTTP Listener**​ をドラッグし、プロジェクトキャンバスにドロップします。 2. HTTP リスナーを使用している環境に応じた値で設定します。 3. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[File Connector\] > \[Read\]**​ 操作をプロジェクトキャンバスにドラッグし、Vault ドキュメントに関連付けられたファイルのコンテンツから読み取るようにファイルパスを設定します。 4. **\[Mule Palette (Mule パレット)\]**​ から、Veeva Vault ​**Invoke Rest API**​ 操作をキャンバス上にドラッグします。 5. Veeva Vault 接続の値を入力します。 - Username (ユーザー名) - Password (パスワード) - Vault URL - Vault バージョン - Vault クライアント ID 6. 次のパラメーターを設定します。 Method: POST, Path: "/objects/documents", Headers: Key: "Accept" Value: "application/json" Key: "Content-Type" Value: "multipart/form-data; boundary=abcdefg" URI Parameters: Leave it empty. Query Parameters: Leave it empty. Body: %dw 2.0 output multipart/form-data boundary='abcdefg' --- { parts: { file: { headers: { "Content-Disposition": { "name": "file", "filename": attributes.fileName }, "Content-Type": payload.^mimeType }, content : payload }, name\_\_v: { headers: { }, content: 'Test Document' }, type\_\_v: { headers: { }, content: 'Trial Management' }, subtype\_\_v: { headers: { }, content: 'Meetings' }, classification\_\_v: { headers: { }, content: 'Kick-off Meeting Material' }, lifecycle\_\_v: { headers: { }, content: 'Base Doc Lifecycle' }, study\_\_v: { headers: { }, content: '0ST000000000301' }, comments\_\_c: { headers: { }, content: 'Test Document' } } } 7. PUT リクエストも同様に設定することができます。 Method: PUT, Path: "/objects/documents/{doc\_id}", Headers: Key: "Accept" Value: "application/json" Key: "Content-Type" Value: "application/x-www-form-urlencoded" URI Parameters: Key: "doc\_id" Value: "259592" Query Parameters: Leave it empty. Body: %dw 2.0 output application/x-www-form-urlencoded --- { "id": "259592", "name\_\_v": "Kick-off Meeting Material Updated", "product\_\_v": "00P000000000403", "study\_\_v": "0ST000000000202", "notes\_\_v": "Notes Updated" } 注意: Vault REST API を呼び出すには、要件に従って上記のパラメーターを設定します。 8. **Logger**​ コンポーネントをプロジェクトキャンバスにドラッグして、次のメッセージを使用してペイロードを記録します。 Invoke Veeva API response :: #\[payload\] ![image](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-invoke-rest-api-example.png) ## [](#xml-コード-5)XML コード ## [](#関連情報)関連情報 [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Veeva Vault Connector 1.2 の追加設定情報 Veeva Vault Connector は次の操作と設定をサポートしています。 **ドキュメント** - [Create Documents](#create_documents) - [Get Documents](#get_documents) - [Delete Documents](#delete_documents) - [Update Documents](#update_documents) - [Export Documents](#export_documents) **ドキュメントレンディション** - [Create Document Renditions](#create_document_renditions) - [Get Document Renditions Types](#get_document_renditions_types) - [Delete Document Renditions](#delete_document_renditions) **Vault オブジェクト** - [Create Object Records](#create_object_records) - [Get Object Records](#get_object_records) - [Delete Object Records](#delete_object_records) - [Update Object Records](#update_object_records) **VQL クエリ** - [Query](#query) **選択リスト** - [Get Picklists](#get_picklists) **監査** - [Get Audit Details](#get_audit_details) **Spark メッセージング** - [Spark Validator](#spark_validator) **Invoke Rest API** - [Invoke Rest API](#invoke_rest_api) ## [](#connector-configuration-コネクタ設定)Connector Configuration (コネクタ設定) ![image](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-basic-configuration.png) [「接続設定」](https://docs.mulesoft.com/jp/veevavault-connector/1.2/veevavault-connector-reference#veevavault-connector-connection-config)​の手順に従います。 ## [](#create_documents)Create Documents Create Documents 操作を使用すると、CSV または JSON 形式で提供されたドキュメントメタデータを使用して 1 つまたは複数のドキュメントを作成できます。ドキュメントファイルを、作成したドキュメントに添付するドキュメントコンテンツと共に Vault FTP サーバー位置にアップロードしていることを確認します。 ### [](#create-documents-の設定)Create Documents の設定 ![veevavault connector create documents](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-create-documents.png)
項目 説明

Metadata Format (メタデータ形式)

[CSV] または [JSON] を選択して、ドキュメントメタデータの形式を指定します。

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

CSV または JSON 形式の必須のメタデータが含まれているドキュメントメタデータのペイロード。ペイロードの形式が、​[Metadata Format (メタデータ形式)]​ 項目で指定された形式であることを確認します。

入力

次は、Vault でのドキュメントの作成に必要なドキュメントメタデータを示しています。Vault で必要とされる必須メタデータがペイロードに含まれていることを確認します。

veevavault connector create documents input

Output (出力)

Create Documents 操作の出力状況または Vault からの応答。

veevavault connector create documents output

注意: 操作の応答状況 (SUCCESS または FAILURE) については、​「コネクタ操作の SUCCESS および FAILURE 応答」​を参照してください。

## [](#get_documents)Get Documents Get Documents 操作を使用すると、選択したドキュメント種別、サブタイプ、分類に基づいてドキュメントの詳細を取得できます。選択した種別、サブタイプ、分類を使用して、この操作でドキュメントプロパティメタデータをフェッチし、VQL クエリを動的にビルドします。その後、この VQL クエリが Vault で実行され、ドキュメントの詳細が取得されます。この操作の後に ​`For-Each/Splitter`​ 要素を配置して、各ドキュメントのデータ (ページ) を順次フェッチします。 この操作では、Mule 標準ページネーションに基づくページングメカニズムが提供されます。詳細は、​[「ストリーミングおよびページネーション」](#streaming_and_pagination)​を参照してください。 ドキュメント種別、サブタイプ、分類は省略可能です。何も選択しない場合、API ​`(/api/{version}/metadata/objects/documents/properties)`​ を使用してドキュメントプロパティメタデータがフェッチされ、​**\[Document Properties (ドキュメントプロパティ)\]**​ リストに追加または挿入されたドキュメントメタデータプロパティに基づいて VQL クエリがビルドされます。メタデータプロパティが提供されていない場合、クエリ可能なすべてのドキュメントプロパティが VQL で使用され、実行されます。 ### [](#get-documents-の設定)Get Documents の設定 ![image](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-get-documents.png)
項目 説明

Type (種別) (省略可能)

更新アイコン (​VeevaVault refresh icon​) をクリックして、Vault のドキュメント種別を取得します。リストからドキュメント種別を選択して、ドキュメントプロパティを取得します。

Subtype (サブタイプ) (省略可能)

更新アイコン (​VeevaVault refresh icon​) をクリックして、Vault のドキュメントサブタイプを取得します。リストからドキュメントサブタイプを選択して、ドキュメントプロパティを取得します。

Classification (分類) (省略可能)

更新アイコン (​VeevaVault refresh icon​) をクリックして、Vault のドキュメント分類を取得します。リストからドキュメント分類を選択して、ドキュメントプロパティを取得します。

Document Properties (ドキュメントプロパティ) (省略可能)

ビジネス要件に従ってドキュメントプロパティを挿入します。このプロパティは、Vault で実行する VQL クエリをビルドするために使用されます。

WHERE Clause (Where 句)

ビジネス要件に従って VQL​ WHERE 句 (キーワード WHERE を使用しない) 条件を挿入すると、WHERE 句が追加され、Vault で実行する VQL クエリが動的にビルドされます。例: classificationv = ‘study_set_up_worksheetc’​。

Fetch Size (フェッチサイズ)

1 ページあたりのレコード数を指定します。デフォルトは値 1000 です。

Batch Size (バッチサイズ)

バッチごとのページ数を指定します。デフォルトは値 10 です。

Input (入力)

なし

Output (出力)

Vault から取得したクエリ可能なドキュメントプロパティのリストが表示されます。ドキュメントプロパティリストが提供されている場合、指定したプロパティの詳細が取得され、操作の出力に表示されます。デフォルトは、クエリ可能なすべてのプロパティのリストです。

image
## [](#delete_documents)Delete Documents Delete Documents 操作を使用すると、Bulk API を CSV または JSON 形式の入力メタデータと共に使用して 1 つまたは複数のドキュメントを削除できます。 ### [](#delete-documents-の設定)Delete Documents の設定 ![image](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-delete-documents.png)
項目 説明

Metadata Format (メタデータ形式)

[CSV] または [JSON] を選択して、ドキュメントメタデータの形式を指定します。

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

CSV または JSON 形式 (​[Metadata Format (メタデータ形式)]​ で指定された値と同じ形式) の必須のメタデータが含まれているドキュメントメタデータのペイロード。

入力

次は、Vault でのドキュメントの削除に必要なドキュメントメタデータのリストを示しています。

image

Output (出力)

Delete Documents 操作の出力状況または Vault からの応答。

image

注意: 操作の応答状況 (SUCCESS または FAILURE) については、​「コネクタ操作の SUCCESS および FAILURE 応答」​を参照してください。

## [](#update_documents)Update Documents Update Documents 操作を使用すると、CSV または JSON 形式でペイロードに提供された編集可能なメタデータを使用して、一括ドキュメントを更新できます。 ### [](#update-documents-の設定)Update Documents の設定 ![image](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-update-documents.png)
項目 説明

Metadata Format (メタデータ形式)

[CSV] または [JSON] を選択して、ドキュメントメタデータの形式を指定します。

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

CSV または JSON 形式の編集可能な必須のメタデータが含まれているドキュメントメタデータのペイロード。ペイロードの形式は、​[Metadata Format (メタデータ形式)]​ 項目で指定された形式である必要があります。

入力

次は、Vault でドキュメントを更新するための編集可能なドキュメントメタデータのリストです。ペイロードにはこの Vault の編集可能なメタデータのみが含まれている必要があります。

image

Output (出力)

Create Documents 操作の出力状況または Vault からの応答。

image
## [](#export_documents)Export Documents Export Documents 操作を使用すると、Vault の FTP ステージングサーバーにエクスポートするための一連のドキュメントを照会できます。Async スコープを使用して、ドキュメント ID を含むペイロードを渡すことで、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` エクスポートされたドキュメントファイルのマイナーバージョン番号。 ### [](#export-documents-の設定)Export Documents の設定 ![image](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-export-documents.png)
項目 説明

Metadata Format (メタデータ形式)

[CSV] または [JSON] を選択して、CSV または JSON 形式で指定したドキュメント ID のメタデータを受け入れます。

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

ドキュメントメタデータのペイロードには、CSV または JSON 形式のドキュメント ID が含まれます。ペイロードの形式は、​[Metadata Format (メタデータ形式)]​ 項目で指定された形式である必要があります。

ソース

(省略可能) ソースファイルを除外するには、​false​ に設定します。デフォルトは ​true​ です。

Renditions (レンディション)

(省略可能) レンディションを含めるには、​true​ に設定します。デフォルトは ​false​ です。

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

(省略可能) すべてのバージョンまたは最新バージョンを含めるには、​true​ に設定します。デフォルトは ​false​ です。

Polling Interval (ポーリング間隔)

(省略可能) ジョブが正常に終了するまで、指定した間隔 (秒単位) で Vault をポーリングします。デフォルトは 30 秒です。

Input (入力)

Vault から FTP ステージングサーバーへのドキュメントのエクスポートに必要な入力ドキュメントメタデータ。Vault で必要とされる必須メタデータがペイロードに含まれていることを確認します。

veevavault connector export documents input

Output (出力)

ドキュメントのエクスポートジョブの状況応答が ​[Output (出力)]​ タブの下に表示されます。

veevavault connector export documents output

注意: 操作の応答状況 (SUCCESS または FAILURE) については、​「コネクタ操作の SUCCESS および FAILURE 応答」​を参照してください。

## [](#create_document_renditions)Create Document Renditions Create Document Renditions 操作を使用すると、ドキュメントレンディションを一括で追加できます。この操作を使用する前に Vault が移行モードになっている必要があります。標準の UTF-8 でエンコードされた値を含む、最大サイズ 1 GB の CSV 入力データを取り込みます。 ### [](#create-document-renditions-の設定)Create Document Renditions の設定 ![veevavault connector create document renditions](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-create-document-renditions.png)
項目 説明

Metadata Format (メタデータ形式)

[CSV] または [JSON] を選択して、ドキュメントメタデータの形式を指定します。

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

CSV または JSON 形式の必須のメタデータが含まれているドキュメントメタデータのペイロード。ペイロードの形式は、​[Metadata Format (メタデータ形式)]​ 項目で指定された形式である必要があります。

Input (入力)

ペイロードで必要なドキュメントメタデータが ​[Input (入力)]​ タブの下に表示されます。

veevavault connector create document renditions input

Output (出力)

操作の出力または応答が ​[Output (出力)]​ タブの下に表示されます。

veevavault connector create document renditions output

注意: 操作の応答状況 (SUCCESS または FAILURE) については、​「コネクタ操作の SUCCESS および FAILURE 応答」​を参照してください。

## [](#get_document_renditions_types)Get Document Renditions Types Get Document Renditions Types 操作を使用すると、ドキュメントレンディション種別の詳細を取得できます。 ### [](#get-document-renditions-types-の設定)Get Document Renditions Types の設定 ![image](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-get-document-renditions-types.png)
項目 説明

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

CSV または JSON 形式のドキュメント ID がペイロードに含まれます。

Input (入力)

ペイロードで必要なドキュメント ID がドキュメントレンディションの詳細の取得操作の ​[Input (入力)]​ タブの下に表示されます。

image

Output (出力)

次のような操作の出力または応答が ​[Output (出力)]​ タブの下に表示されます。

image

注意: 操作の応答状況 (SUCCESS または FAILURE) については、​「コネクタ操作の SUCCESS および FAILURE 応答」​を参照してください。

## [](#delete_document_renditions)Delete Document Renditions Delete Document Renditions 操作を使用すると、CSV または JSON 形式の入力メタデータを使用して、ドキュメントレンディションを一括で削除できます。 ### [](#delete-document-renditions-の設定)Delete Document Renditions の設定 ![image](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-delete-document-renditions.png)
項目 説明

Metadata Format (メタデータ形式)

[CSV] または [JSON] を選択して、ドキュメントメタデータの形式を指定します。

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

CSV または JSON 形式 (​[Metadata Format (メタデータ形式)]​ 項目で指定された形式) の必須のメタデータが含まれているドキュメントメタデータのペイロード。

Input (入力)

Vault でのドキュメントの作成に必要なドキュメントメタデータ。Vault で必要とされる必須メタデータがペイロードに含まれていることを確認します。

image

Output (出力)

Delete Document Renditions 操作の出力状況または Vault からの応答。

image

注意: 操作の応答状況 (SUCCESS または FAILURE) については、​「コネクタ操作の SUCCESS および FAILURE 応答」​を参照してください。

## [](#create_object_records)Create Object Records Create Object Records 操作を使用すると、CSV または JSON 形式で提供されたオブジェクトメタデータを使用して、選択した Vault オブジェクトの一括オブジェクトレコードを作成できます。 ### [](#create-object-records-の設定)Create Object Records の設定 ![image](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-object-records.png)
項目 説明

Object Name (オブジェクト名)

VeevaVault 更新アイコン (​VeevaVault refresh icon​) をクリックして、Vault オブジェクトリストを取得します。リストからオブジェクト名を選択して、選択したオブジェクトのレコードを作成します。

Metadata Format (メタデータ形式)

[CSV] または [JSON] を選択し、指定した形式でオブジェクトメタデータを受け入れます。

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

CSV または JSON 形式の必須のメタデータが含まれているオブジェクト項目のペイロード。ペイロードの形式が、[Metadata Format (メタデータ形式)] 項目で指定された形式であることを確認します。

Input (入力)

次は、オブジェクトレコードの作成に必要なオブジェクトメタデータのリストを示しています。

image

Output (出力)

作成したオブジェクトレコードに関する、操作の出力または Vault から取得した応答。

image

注意: 操作の応答状況 (SUCCESS または FAILURE) については、​「コネクタ操作の SUCCESS および FAILURE 応答」​を参照してください。

## [](#get_object_records)Get Object Records Get Object Records 操作を使用すると、オブジェクトメタデータ項目を使用してオブジェクトレコードの詳細を取得し、VQL クエリを動的にビルドして Vault で実行し、オブジェクトの詳細を取得できます。この操作の後に ​`For-Each/Splitter`​ 要素を配置して、各オブジェクトレコード (ページ) を順次フェッチします。 この操作では、Mule 標準ページネーションに基づくページングメカニズムが提供されます。詳細は、​[「ストリーミングおよびページネーション」](#streaming_and_pagination)​を参照してください。 ### [](#get-object-records-の設定)Get Object Records の設定 ![image](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-get-object-records.png)
項目 説明

Vault Object (Vault オブジェクト)

更新アイコン (​VeevaVault refresh icon​) をクリックして、Vault から Vault オブジェクトリストを取得します。リストからオブジェクトを選択して、オブジェクトレコードの詳細を取得します。

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

(省略可能) ビジネス要件に従ってオブジェクト項目を挿入します。この項目は、Vault で実行する VQL クエリをビルドするために使用されます。

WHERE Clause (Where 句)

ビジネス要件に従って VQL​ ​WHERE​ 句 (キーワード ​WHERE​ を使用しない) 条件を挿入すると、WHERE 句が追加され、Vault で実行する VQL クエリが動的にビルドされます。例: study_country__v = ‘0SC000000000101’

Fetch Size (フェッチサイズ)

1 ページあたりのレコード数を指定します。デフォルトは値 1000 です。

Batch Size (バッチサイズ)

バッチごとのページ数を指定します。デフォルトは値 10 です。

Input (入力)

なし

Output (出力)

オブジェクト項目リストに追加するオブジェクトレコード項目のリスト。オブジェクト項目リストが提供されている場合、指定した項目の詳細が出力として返されます。デフォルトは、すべての項目のリストです。

image
#### [](#delete_object_records)Delete Object Records Delete Object Records 操作を使用すると、CSV または JSON 形式の入力メタデータを使用して、1 つまたは複数のオブジェクトレコードを Bulk API で削除できます。 ### [](#delete-object-records-の設定)Delete Object Records の設定 ![image](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-object-records.png)
項目 説明

Object Name (オブジェクト名)

更新アイコン (​VeevaVault refresh icon​) をクリックして、Vault オブジェクトリストを取得します。リストからオブジェクト名を選択して、選択したオブジェクトのオブジェクトレコードを削除します。

Metadata Format (メタデータ形式)

[CSV] または [JSON] を選択し、指定した形式でドキュメントメタデータを受け入れます。

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

CSV または JSON 形式の必須のメタデータが含まれているオブジェクト項目のペイロード。ペイロードの形式が、​[Metadata Format (メタデータ形式)]​ 項目で指定された形式と同じであることを確認します。

Input (入力)

オブジェクトレコードの削除に必要なオブジェクトメタデータのリスト。

image

Output (出力)

削除したオブジェクトレコードに関する、操作の出力または Vault から取得した応答。

image

注意: 操作の応答状況 (SUCCESS または FAILURE) については、​「コネクタ操作の SUCCESS および FAILURE 応答」​を参照してください。

## [](#update_object_records)Update Object Records Update Object Records 操作を使用すると、指定した Vault オブジェクトのオブジェクトレコードを更新できます。 ### [](#update-object-records-の設定)Update Object Records の設定 ![image](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-object-records.png)
項目 説明

Object Name (オブジェクト名)

更新アイコン (​VeevaVault refresh icon​) をクリックして、Vault オブジェクトリストを取得します。リストからオブジェクト名を選択して、オブジェクトのレコードを更新します。

Metadata Format (メタデータ形式)

[CSV] または [JSON] を選択し、指定した形式でオブジェクトメタデータを受け入れます。

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

CSV または JSON 形式の必須のメタデータが含まれているオブジェクト項目のペイロード。ペイロードの形式が、​[Metadata Format (メタデータ形式)]​ 項目で指定された形式と同じであることを確認します。

Input (入力)

オブジェクトレコードの作成に必要なオブジェクトメタデータのリスト。

image

Output (出力)

操作の ​[Output (出力)]​ タブの下に、更新されたオブジェクトのオブジェクト状況が出力として表示されるか、Vault から取得した応答が表示されます。

image

注意: 操作の応答状況 (SUCCESS または FAILURE) については、​「コネクタ操作の SUCCESS および FAILURE 応答」​を参照してください。

## [](#query)Query Query 操作を使用すると、指定した VQL クエリを Vault で実行し、ページ分割されたデータ入力ストリームで結果を取得できます。Query 操作の後に ​`For-Each/Splitter`​ 要素を配置して、各レコードを順次フェッチします。 注意: VQL クエリで ​`LIMIT`​ と ​`OFFSET`​ を指定しないでください。これらのパラメーターは内部に組み込まれています。 この操作では、Mule 標準ページネーションに基づくページングメカニズムが提供されます。詳細は、​[「ストリーミングおよびページネーション」](#streaming_and_pagination)​を参照してください。 ### [](#query-の設定)Query の設定 ![image](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-query.png)
項目 説明

VQL クエリ

Vault に送信する VQL​ クエリを入力します。

注意:​ VQL クエリで ​LIMIT​ と ​OFFSET​ を指定しないでください。

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

この入力パラメーターで、パラメーターを VQL クエリに動的に渡します。パラメーターは名前-値のペアである必要があります。ペイロードまたは変数の値を渡すことができます。次に例を示します。

#[
	{
		'table': 'site__v',
	}
]

デフォルトパラメーターは ​#[{}]​ です。

Fetch Size (フェッチサイズ)

1 ページあたりのレコード数を指定します。デフォルトは値 1000 です。

Batch Size (バッチサイズ)

バッチごとのページ数を指定します。デフォルトは値 10 です。

Input (入力)

なし

Output (出力)

指定した VQL クエリ項目が操作の ​[Output (出力)]​ タブに表示されます。指定した VQL クエリが返され、結果にはページ分割されたデータが含まれます。

image
### [](#入力パラメーターを使用した-vql-クエリの保護)入力パラメーターを使用した VQL クエリの保護 Vault からドキュメント、オブジェクト、ワークフロー情報を取得するには Query 操作を使用します。その操作の主な概念は、VQL クエリを提供し、DataWeave を使用してパラメーターを提供することです。 前述の例では、入力パラメーターはキー - 値のペアで提供されます。このペアは、DataWeave スクリプトを埋め込むことで作成できます。このキーをコロン文字 (:) と組み合わせて、名前によりパラメーター値を参照します。VQL クエリでパラメーターを使用するには、この方法をお勧めします。 別の方法として、​`SELECT id, name​_v, study_​v FROM documents WHERE name__v = #[payload] `​ を直接記述できますが、これは非常に危険なため、お勧めできません。 入力パラメーターを使用して ​`SELECT`​ ステートメントの ​`WHERE`​ 句を設定する利点は次のとおりです。 - クエリが VQL インジェクション攻撃の影響を受けなくなる。 - コネクタが他の方法では不可能な最適化を実行でき、アプリケーションの全体的なパフォーマンスが向上する。 ## [](#get_picklists)Get Picklists Get Picklists 操作を使用すると、選択リストで設定されているすべての使用可能な選択リスト値を取得できます。 ### [](#get-picklists-の設定)Get Picklists の設定 ![image](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-get-picklists.png)
項目 説明

Picklist Name (選択リスト名)

更新アイコン (​VeevaVault refresh icon​) をクリックして、Vault から選択リストを取得します。リストから選択リスト名を選択して、選択リスト値を取得します。

Input (入力)

なし

Output (出力)

名前と表示ラベルを含む選択リスト値が Get Picklists 操作の ​[Output (出力)]​ タブに表示されます。

image

## [](#get_audit_details)Get Audit Details Get Audit Detail 操作を使用すると、指定した監査種別の監査の詳細を取得できます。この操作では、Mule 標準ページネーションに基づくページングメカニズムが提供されます。 詳細は、​[「ストリーミングおよびページネーション」](#streaming_and_pagination)​を参照してください。 ### [](#get-audit-details-の設定)Get Audit Details の設定 ![image](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-get-audit-details.png)
項目 説明

Audit Type (監査種別)

更新アイコン (​VeevaVault refresh icon​) をクリックして、Vault の監査種別を取得します。監査の詳細を取得する必要がある、対象の監査種別をリストから選択します。

Start date (開始日)

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

End date (終了日)

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

Fetch Size (フェッチサイズ)

1 ページあたりのレコード数を指定します。デフォルトは値 1000 です。

Batch Size (バッチサイズ)

バッチごとのページ数を指定します。デフォルトは値 10 です。

Input (入力)

なし

Output (出力)

次のように、選択した監査種別の詳細が Vault からページネーション形式で取得されます。各レコードをフェッチするには、必ず ​For each/Splitter​ 要素を使用します。

image
## [](#spark_validator)Spark Validator Spark Validator 操作では、署名と公開キーを使用して、Vault からトリガーされた Spark メッセージの検証と確認を行います。検証と確認が正常に終了したら、Spark メッセージを Mule フローでビジネス要件に従ってさらに処理できます。詳細は、「 [Spark メッセージングの機能](https://developer.veevavault.com/sdk/#spark-messaging)​およびセットアップ」を参照してください。 Spark Validator 操作の結果には、Spark 属性 (省略可能) と Spark メッセージ (Vault から受信した場合) が含まれます。 **注意**​: Vault から Spark メッセージをトリガーする前に、Veeva Vault サポートのサポートチケットを申請して、Spark メッセージの再送信または再試行の間隔を必ず増やしてください (例: 10 秒)。デフォルトでは 3 秒として設定されていますが、この時間は、Spark Validator でメッセージの検証と確認を完了するのに必要な時間を下回っています。 **注意**​: Veeva Systems によると、公開キー (00001.pem) の期限は 2 年ごとに切れます。ユーザーは有効期限に関する通知を事前に受け取ります。Mule アプリケーションフローでこの操作を使用している場合は、公開キーの有効期限後に、​**\[Public Key Path (公開キーのパス)\]**​ 項目で設定されたパスから公開キーファイルを削除する必要があります。キーの削除を実行している間に新しい公開キーが作成されます。これを行わない場合、Spark メッセージの検証が ​**INVALID\_SPARK\_MESSAGE**​ として失敗します。Spark メッセージの検証を正常に終了するには、デフォルトのパスで CloudHub にデプロイされた Mule アプリケーションを再起動する必要があります。 ### [](#spark-validator-の設定)Spark Validator の設定 ![image](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-spark-validator.png)
項目 説明

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

Vault から受信した Spark ヘッダーを Spark Validator 出力に含めるためのフラグ。デフォルトは ​FALSE​ です。

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

署名付きの受信 Spark メッセージを確認するために使用する公開キー (00001.pem) ファイルの保存場所へのパス。デフォルトは、​“${mule.home}/apps/${app.name}/publickeys”​ です。

Spark Headers (Spark ヘッダー)

Vault から受信した Spark ヘッダー。デフォルトは、​#[attributes.headers]​ です。

Spark Message (Spark メッセージ)

Vault から受信した Spark メッセージ本文。デフォルトは ​#[payload]​ です。

Input (入力)

Spark Validator で必要とされる入力。

image::veevavault-connector-spark-validator-input.png[image,width=285,height=330]

Output (出力)

Spark Validator 操作から返された出力。

image::veevavault-connector-spark-validator-output.png[image,width=280,height=265]

### [](#invoke_rest_api)Invoke Rest API Invoke Rest API 操作を使用すると、Veeva Vault Rest API を呼び出すことができます。応答は、ヘッダーで指定されている ​**Accept**​ 値に応じて JSON (デフォルト) または XML 形式で返されます。 #### [](#invoke-rest-api-の設定)Invoke Rest API の設定 ![image](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-invoke-rest-api.png)
項目 説明

Method (メソッド)

Veeva Vault Rest API を呼び出すメソッド。デフォルトは ​GET​ です。

Path (パス)

Veeva Vault Rest API を呼び出す URI パス。例: /objects/documents/{doc_id}

Body (本文)

Veeva Rest API を呼び出す要求と一緒に送信する本文。デフォルトは ​#[payload]​ です。

Headers (ヘッダー)

要求と一緒に送信するキー-値形式のヘッダー。要求でヘッダーが必要ない場合は空白にしてください。デフォルトは​空のリスト​です。

URI Parameters (URI パラメーター)

パスの値を解決するためのキー-値形式の URI パラメーター。パスに URI パラメーターがない場合は空白にしてください。デフォルトは​空のリスト​です。

Query Parameters (クエリパラメーター)

要求と一緒に送信するキー-値形式のクエリパラメーター。要求でクエリパラメーターが必要ない場合は空白にしてください。デフォルトは​空のリスト​です。

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

要求でストリーミングモードを使用するかどうか。デフォルトでは、ペイロードの種別がストリームの場合、ストリーミングを使用して要求が送信されます。ドロップダウンリストからストリーミングオプションを選択します。

Input (入力)

なし

Output (出力)

[Headers (ヘッダー)]​ セクションで指定されているヘッダーの ​Accept​ 値に応じて JSON (デフォルト) または XML 形式で返される応答。

Invoke Rest API 操作の典型的な用途は、デフォルトの GET メソッドを使用した Veeva Vault Rest API の呼び出しです。デフォルトでは、GET メソッドは要求でペイロードを送信しないため、HTTP 要求の本文は空です。他のメッセージでは、要求の本文としてメッセージペイロードが送信されます。 要求の送信後、コネクタはヘッダーで指定されている ​**Accept**​ 値に応じて JSON (デフォルト) または XML 形式で返される応答を受信します。ペイロードは、アプリケーションのフローの次の要素に渡されます。 #### [](#パラメーターの追加)パラメーターの追加 デフォルトでは、Invoke Rest API 操作は Mule メッセージペイロードを要求の本文として送信しますが、これは DataWeave スクリプトまたは式を使用してカスタマイズできます。要求の本文に加えて、以下を設定できます。 - ヘッダー - クエリパラメーター - URI パラメーター #### [](#ヘッダー)ヘッダー **\[General (一般)\] > \[Request (要求)\] > \[Query Parameters (クエリパラメーター)\]**​ で、プラスアイコン (+) をクリックしてヘッダーを要求に追加します。たとえば、ヘッダー名 ​`HeaderName1`​ および ​`HeaderName2`​ とヘッダー値 ​`HeaderValue1`​ および ​`HeaderValue2`​ を追加します。 DataWeave 式を使用できます。例: #\[{'HeaderName1' : 'HeaderValue1', 'HeaderName2' : 'HeaderValue2'}\]. #### [](#uri-パラメーター)URI パラメーター 要求のパスにプレースホルダー (​`/objects/documents/{doc_id}`​ など) を使用する場合は、URI パラメーターを設定します。URI パラメーターを設定するには、​**\[Path (パス)\]**​ 項目にプレースホルダーを中括弧で囲んで入力します。​**\[URI Parameters (URI パラメーター)\]**​ を選択し、\[+\] をクリックして名前と値を入力します。 #### [](#クエリパラメーター)クエリパラメーター **\[General (一般)\] > \[Request (要求)\] > \[Query Parameters (クエリパラメーター)\]**​ で、プラスアイコン (+) をクリックしてパラメーターを要求に追加します。パラメーターの名前と値を入力するか、DataWeave 式を使用して名前と値を定義します。 #### [](#post-要求での-form-フォーム-パラメーターの送信)POST 要求での form (フォーム) パラメーターの送信 POST 要求でパラメーターを送信する方法: 1. **\[General (一般)\] > \[Request (要求)\]**​ で、​**POST**​ メソッドを選択します。 2. **\[Body (本文)\]**​ に、Mule メッセージのペイロードを入力します。 例を示します。 1. **application/x-www-form-urlencoded**​ で送信するパラメーターの名前と値を入力します。 #\[output application/x-www-form-urlencoded --- {'key1':'value1', 'key2':'value2'}\] 2. **multipart/form-data**​ では、ヘッダーの ​**Content-Type**​ 値に DataWeave 出力と同じ境界属性値が含まれていることを確認してください。例: `multipart/form-data; boundary=abcdefg`​。 %dw 2.0 output multipart/form-data boundary='abcdefg' --- { parts: { file: { headers: { "Content-Disposition": { "name": "file", "filename": attributes.fileName }, "Content-Type": payload.^mimeType }, content : payload }, name\_\_v: { headers: { }, content: 'Test Document' }, type\_\_v: { headers: { }, content: 'Trial Management' }, subtype\_\_v: { headers: { }, content: 'Meetings' }, classification\_\_v: { headers: { }, content: 'Kick-off Meeting Material' }, lifecycle\_\_v: { headers: { }, content: 'Base Doc Lifecycle' }, study\_\_v: { headers: { }, content: '0ST000000000301' }, comments\_\_c: { headers: { }, content: 'Test Document' } } } ## [](#connector_operations_success_and_failure_response)コネクタ操作の SUCCESS および FAILURE 応答 Veeva Vault Connector 操作の応答は、Veeva Vault API の成功または失敗応答とエラーに基づきます。 コネクタは ​`SUCCESS`​ 応答を ​`HIGH LEVEL`​ で返し、​`SUCCESS`​ または ​`FAILURE`​ を ​`LOW LEVEL`​ で返します。つまり、コネクタ操作が正常に終了しても、要求に渡された関連のない一部のデータのために一部のドキュメントまたはオブジェクトレコードの作成または更新が失敗していることがあります。 ### [](#例)例 **SUCCESS を含む SUCCESS 応答**​: { "responseStatus": "SUCCESS", "data": \[{ "id": 239026, "name\_\_v": "E22611234--38483", "responseStatus": "SUCCESS" }, { "id": 239025, "name\_\_v": "Kick-off Meeting Material Updated12341234--81032", "responseStatus": "SUCCESS" } \] } **FAILURE を含む SUCCESS 応答**​: { "data": \[ { "external\_id\_\_v": "TEST-238924", "rendition\_type\_\_v": "imported\_rendition\_\_c", "id": 238924, "responseStatus": "FAILURE", "minor\_version\_number\_\_v": 1, "errors": \[ { "type": "INVALID\_DATA", "message": "Document not found \[238924/0/1\]." } \], "major\_version\_number\_\_v": 0 }, { "external\_id\_\_v": "TEST-238925", "rendition\_type\_\_v": "imported\_rendition\_\_c", "id": 238925, "responseStatus": "FAILURE", "minor\_version\_number\_\_v": 1, "errors": \[ { "type": "INVALID\_DATA", "message": "Document not found \[238925/0/1\]." } \], "major\_version\_number\_\_v": 0 } \], "responseStatus": "SUCCESS" } Veeva Vault API で ​`FAILURE`​ 応答が返されると、Veeva Vault 操作で例外がスローされます。次に例を示します。 **ERROR を含む FAILURE 応答** { "responseStatus": "FAILURE", "errors": \[ { "type": "INVALID\_DATA", "message": "Unknown relationship \[reviewer\_\_v\]" } \] } Veeva Vault API から ​`FAILURE`​ 応答を受信すると、コネクタ操作で例外がスローされ、Mule フロー内の ​**Error Handling**​ コンポーネントでキャッチされます。 \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* Message : An error occurred from the Veeva Vault API. Error Code: INVALID\_DATA. Original Error Message: Unknown relationship \[reviewer\_\_v\]. Error type : VEEVAVAULT:INVALID\_DATA \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* エラー処理コンポーネントでキャッチされるエラーコードを次に示します。 - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ## [](#streaming_and_pagination)ストリーミングおよびページネーション コネクタ内のすべての操作 (Download Document を除く) が、操作の出力に基づく各結果を含むペイロードとして InputStream を返します。このため、デフォルトでは、Mule ではストリーミング戦略が適用されます。詳細は、​[Mule ストリーミング戦略](https://docs.mulesoft.com/mule-runtime/latest/streaming-about)​を参照してください。ストリーミング戦略の設定項目は、コネクタ操作の ​**\[Advanced (詳細)\]**​ タブにあります。 ![image](/mulesoft/current/ja-jp/veevavault-connector/1.2/_images/veevavault-connector-streaming-pagination.png) コネクタ内の次の操作では、Mule 標準ページネーションに基づくページネーションメカニズムが提供されます。 - [Get Documents](#get_documents) - [Get Object Records](#get_object_records) - [Query](#query) - [Get Audit Details](#get_audit_details) ページ分割操作を使用していますが、必ず ​`For-Each/Splitter`​ 要素を配置して各オブジェクト (メタデータは JSON 形式) を一度に取得してください。ページネーション操作には、​**\[Fetch Size (フェッチサイズ)\]**​ 項目と ​**\[Batch Size (バッチサイズ)\]**​ 項目があります。 - **Fetch Size (フェッチサイズ)**​ フェッチサイズは、1 つのページで取得できるレコードの制限数です。操作は、フェッチサイズの数の JSON オブジェクトレコードを含むページを返します。 場合によって、Veeva API でレコードサイズに基づいてフェッチサイズ (各ページのレコード数) が自動計算され、その計算で標準レコードサイズを超えることがあります。操作は、各ページで計算されたレコード数を返します。 - **Batch Size (バッチサイズ)**​ バッチサイズは各バッチで返されるページ数であり、各ページにはフェッチサイズの数のレコードが含まれます。操作はバッチごとに多数のレコード (JSON 形式のメタデータ) を返し、計算は次の例のように行われます。 Fetch Size set as \*1000\* Batch Size set as \*10\* If the total records in the vault are \*100,000\*, then: Number of pages = Total records/Fetch Size = 100000/1000 = 100 pages. Number of pages per batch = Number of pages/Batch Size = 100/10 = 10 pages per batch. Number of Records per batch = Number of pages per batch \* Fetch Size = 10 \* 1000 = 10,000 records. Therefore, the number of records returned per batch would be 10,000 records. 反復可能ストリームはバッファサイズをバイト単位で測定します。オブジェクトを処理するときに、ランタイムはインスタンス数を使用してバッファサイズを測定します。 反復不可能ストリームのコネクタ操作では、ストリームはバッチごとのレコード数として返されます。反復可能ストリームでは、すべてのレコードが一度に返されるため、反復可能自動ページングでメモリ内のバッファサイズを計算する場合は、メモリ不足にならないように、各インスタンスが使用するメモリ量を見積もる必要があります。 ## [](#次のステップ)次のステップ コネクタの設定が完了したら、​[例](https://docs.mulesoft.com/jp/veevavault-connector/1.2/veevavault-connector-examples)​を試すことができます。 ## [](#関連情報)関連情報 - [Veeva Vault Connector リファレンス](https://docs.mulesoft.com/jp/veevavault-connector/1.2/veevavault-connector-reference) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Veeva Vault Connector 1.2 リファレンス 設定する操作に応じて、Veeva Vault 用 Anypoint Connector (Veeva Vault Connector) は [Veeva Vault REST API、Bulk API、ストリーミング API](https://developer.veevavault.com/api/19.1/#authentication)​ と連動します。 ## [](#connection_configuration)接続設定
名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

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

X

Vault URL

String (文字列)

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

X

Username (ユーザー名)

String (文字列)

セッションの初期化に使用するユーザー名。

X

Password (パスワード)

String (文字列)

ユーザーの認証に使用するパスワード。

X

Version (バージョン)

String (文字列)

Veeva Vault API バージョン。

v20.1

Client Id (クライアント ID)

String (文字列)

追跡の目的で各リクエストヘッダーと共に Veeva Vault インスタンスに送信するクライアント ID。形式は ​{organization}-{component/team}​ です (例: abcpharma-clinicalprod​)。要求を送信する前に、クライアント ID の先頭に ​mulesoft​、末尾に ​client-vaultconnector​ が付けられます (例: mulesoft-abcpharma-clinicalprod-client-vaultconnector​)。

X

### [](#応答タイムアウト-advanced-詳細-タブ)応答タイムアウト (\[Advanced (詳細)\] タブ)
名前 型 説明 デフォルト値 必須

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

Integer (整数)

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

30000 ms

X

### [](#burst-api-limit-profile-バースト-api-制限プロファイル-advanced-詳細-タブ)Burst API Limit Profile (バースト API 制限プロファイル) (\[Advanced (詳細)\] タブ) `` \[Burst API Limit Profile (バースト API 制限プロファイル)\] 設定は、Veeva Vault API の指定されたバースト API 制限が、設定されたしきい値に達するか、超えた場合に機能します。 **\[Burst API limit config (バースト API 制限の設定)\]**​ が有効になっている場合 (デフォルト)、コネクタは、指定された API 制限しきい値に対して Veeva Vault API のレスポンスヘッダー (​`X-VaultAPI-BurstLimitRemaining`​) 値を評価します。残りのバースト API 制限がこのしきい値に達するかこのしきい値を超えた場合、コネクタは指定された時間待機して ​**\[Burst Limit Remaining (残りのバースト制限)\]**​ の計数を再開します。 詳細は、 [「API Rate Limit Headers (API レート制限ヘッダー)」](https://developer.veevavault.com/docs/#api-rate-limits)​を参照してください。
名前 型 説明 デフォルト値 必須

API Limit Threshold (API 制限しきい値)

Integer (整数)

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

200

X

Wait Time (待機時間)

Integer (整数)

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

5

X

Time Unit (時間単位)

  • DAYS

  • HOURS

  • MINUTES

  • SECONDS

  • MILLISECONDS

  • NANOSECONDS

MINUTES

X

### [](#daily-api-limit-profile-1-日の-api-制限プロファイル-advanced-詳細-タブ)Daily API Limit Profile (1 日の API 制限プロファイル) (\[Advanced (詳細)\] タブ) `` \[Daily API Limit Profile (1 日の API 制限プロファイル)\] では、1 日の残りの API 制限コール数を評価するための API 制限しきい値を設定します。1 日の API 制限コール数が、指定されたしきい値制限に達するかしきい値制限を超えた場合、例外がスローされます。デフォルトでは、これは無効になっています。詳細は、​**[「API Rate Limit Headers (API レート制限ヘッダー)」](https://developer.veevavault.com/docs/#api-rate-limits)​を参照してください。**
名前 型 説明 デフォルト値 必須

API Limit Threshold (API 制限しきい値)

Integer (整数)

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

10000

X

## [](#操作)操作 - [Create Documents](#create_documents) - [Create Document Renditions](#create_document_renditions) - [Create Object Records](#create_object_records) - [Delete Document Renditions](#delete_document_renditions) - [Delete Documents](#delete_documents) - [Delete Object Records](#delete_object_records) - [Export Documents](#export_documents) - [Get Audit Details](#get_audit_details) - [Get Document Renditions](#get_document_renditions_types) - [Get Documents](#get_documents) - [Get Object Records](#get_object_records) - [Get Picklists](#get_picklists) - [Invoke REST API](#invoke_rest_api) - [Query](#query) - [Spark Validator](#spark_validator) - [Update Documents](#update_documents) - [Update Object Records](#update_object_records) ### [](#create_documents)Create Documents `` この操作では、CSV または JSON 形式で提供されたドキュメントメタデータを使用して Veeva Vault でドキュメントを作成します。 #### [](#パラメーター)パラメーター
名前 型 説明 デフォルト値 必須

Metadata Format (メタデータ形式)

Enum (列挙) (文字列):

  • CSV

  • JSON

メタデータ形式 (CSV または JSON)。

X

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

Input Stream (入力ストリーム)

CSV または JSON 形式の入力ストリームとしてのドキュメントメタデータ。次にメタデータを示します。

veevavault connector create documents input

X

#### [](#設定)設定 [Connection Configuration (接続設定)](#connection_configuration) #### [](#スロー)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#create_document_renditions)Create Document Renditions `` CSV または JSON 形式で提供されたメタデータを使用して Vault でドキュメントレンディションを作成します。 #### [](#パラメーター-2)パラメーター
名前 型 説明 デフォルト値 必須

Metadata Format (メタデータ形式)

Enum (列挙) (文字列)

  • CSV

  • JSON

メタデータ形式 (CSV または JSON)。

X

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

Input Stream (入力ストリーム)

選択された [Metadata Format (メタデータ形式)] オプションに対応する CSV または JSON 形式の入力ストリームとしてのドキュメントメタデータ。次にメタデータを示します。

veevavault connector create document renditions input

X

#### [](#設定-2)設定 [Connection Configuration (接続設定)](#connection_configuration) #### [](#スロー-2)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#create_object_records)Create Object Records `` Create Object Records では、CSV または JSON 形式のオブジェクトメタデータを使用して、Vault でオブジェクトレコードを一括で作成します。 #### [](#パラメーター-3)パラメーター

名前

型

説明

デフォルト値

必須

Object Name (オブジェクト名)

String (文字列)

リストから選択可能なすべての Vault オブジェクトのリスト。次に例を示します。

veevavault connector create object records object name

X

Metadata Format (メタデータ形式)

String (文字列)

メタデータ形式 (CSV または JSON)。

X

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

Input Stream (入力ストリーム)

選択された [Metadata Format (メタデータ形式)] オプションに対応する CSV または JSON 形式の入力ストリームとしてのオブジェクトメタデータ。次の画像でメタデータを示します。

veevavault connector create object records input

X

#### [](#設定-3)設定 [Connection Configuration (接続設定)](#connection_configuration) #### [](#スロー-3)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#delete_document_renditions)Delete Document Renditions `` CSV または JSON 形式で提供されたドキュメントレンディションメタデータに基づいて Vault からドキュメントレンディションを削除します。 #### [](#パラメーター-4)パラメーター
名前 型 説明 デフォルト値 必須

Metadata Format (メタデータ形式)

Enum (列挙) (文字列)

  • CSV

  • JSON

CSV または JSON のメタデータ形式。

X

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

Input Stream (入力ストリーム)

選択された [Metadata Format (メタデータ形式)] オプションに対応する CSV または JSON 形式の入力ストリームとしてのドキュメントメタデータ。

X

#### [](#設定-4)設定 [Connection Configuration (接続設定)](#connection_configuration) #### [](#スロー-4)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#delete_documents)Delete Documents `` この操作では、CSV または JSON 形式で提供されたメタデータドキュメント ​**ID**​ に基づいて Vault からドキュメントを削除します。 #### [](#パラメーター-5)パラメーター
名前 型 説明 デフォルト値 必須

Metadata Format (メタデータ形式)

Enum (列挙) (文字列)

  • CSV

  • JSON

CSV または JSON のメタデータ形式。

X

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

Input Stream (入力ストリーム)

選択された [Metadata Format (メタデータ形式)] オプションに対応する CSV または JSON 形式の入力ストリームとしてのドキュメントメタデータ。次にメタデータを示します。

veevavault connector delete documents input

X

#### [](#設定-5)設定 [Connection Configuration (接続設定)](#connection_configuration) #### [](#スロー-5)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#delete_object_records)Delete Object Records `` この操作では、CSV または JSON 形式のオブジェクト ID メタデータを使用して、Vault でオブジェクトレコードを一括で削除します。 #### [](#パラメーター-6)パラメーター
名前 型 説明 デフォルト値 必須

Object Name (オブジェクト名)

String (文字列)

リストから選択可能なすべての Vault オブジェクトのリスト。次に例を示します。

veevavault connector create object records object name

X

Metadata Format (メタデータ形式)

Enum (列挙) (文字列)

CSV

JSON

CSV または JSON のメタデータ形式。

X

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

Input Stream (入力ストリーム)

選択された [Metadata Format (メタデータ形式)] オプションに対応する CSV または JSON 形式の入力ストリームとしてのオブジェクトメタデータ。

X

#### [](#設定-6)設定 [Connection Configuration (接続設定)](#connection_configuration) #### [](#スロー-6)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#export_documents)Export Documents `` この操作を使用すると、Vault の FTP ステージングサーバーにエクスポートするための一連のドキュメントを照会できます。 #### [](#パラメーター-7)パラメーター
名前 型 説明 デフォルト値 必須

Metadata Format (メタデータ形式)

Enum (列挙) (文字列)

  • CSV

  • JSON

CSV または JSON のメタデータ形式。

X

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

Input Stream (入力ストリーム)

選択された ​[Metadata Format (メタデータ形式)]​ オプションに対応する CSV または JSON 形式の入力ストリームとしてのドキュメントメタデータ (ドキュメント ID)。次の画像でメタデータを示します。

veevavault connector export documents input

#[payload]

X

Source (ソース)

Boolean (ブール)

ソースファイルを除外します。

True

Renditions (レンディション)

Boolean (ブール)

レンディションを含めます。

False

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

Boolean (ブール)

すべてのバージョンまたは最新バージョンを含めます。

False

Polling Interval (ポーリング間隔)

Integer (整数)

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

30

#### [](#設定-7)設定 [Connection Configuration (接続設定)](#connection_configuration) #### [](#スロー-7)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED #### [](#get_audit_details)Get Audit Details `` Get Audit Details 操作では、指定した監査種別の監査の詳細を取得します。 #### [](#パラメーター-8)パラメーター
名前 型 説明 デフォルト値 必須

Audit Type (監査種別)

String (文字列)

Vault での選択可能な監査種別のリスト。次に例を示します。

image

X

Start Date (開始日)

String (文字列)

監査情報の取得を開始する日付。日付は ​YYYY-MM-DDTHH:MM:SSZ​ 形式である必要があります。

End Date (終了日)

String (文字列)

監査情報の取得を停止する日付。日付は ​YYYY-MM-DDTHH:MM:SSZ​ 形式である必要があります。

Fetch Size (フェッチサイズ)

Integer (整数)

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

100

Batch Size (バッチサイズ)

Integer (整数)

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

10

#### [](#設定-8)設定 [Connection Configuration (接続設定)](#connection_configuration) #### [](#スロー-8)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#get_document_renditions_types)Get Document Renditions Types `` Get Document Renditions Types では、ドキュメントレンディションの詳細を取得します。 #### [](#パラメーター-9)パラメーター
名前 型 説明 デフォルト値 必須

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

Input Stream (入力ストリーム)

ドキュメントメタデータには、CSV または JSON 形式の ​documentID​ のみが入力ストリームとして含まれます。次にメタデータを示します。

image

X

#### [](#設定-9)設定 [Connection Configuration (接続設定)](#connection_configuration) #### [](#スロー-9)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#get_documents)Get Documents `` Get Documents では、選択したドキュメント種別、サブタイプ、分類の各オプションに基づいて Vault からドキュメントの詳細を取得します。VQL クエリのビルドの基盤となるドキュメントプロパティを提供するオプションがありますが、提供しない場合、ドキュメントプロパティは種別、サブタイプ、分類に基づいてフェッチされます。 #### [](#パラメーター-10)パラメーター
名前 型 説明 デフォルト値 必須

型

String (文字列)

選択可能なすべてのドキュメント種別のリスト。

Subtype (サブタイプ)

String (文字列)

Vault での選択可能なすべてのドキュメントサブタイプのリスト。

Classification (分類)

String (文字列)

Vault での選択可能なすべてのドキュメント分類のリスト。

Document Properties (ドキュメントプロパティ)

List<String>

ビジネス要件に基づいてドキュメントプロパティをリストに挿入します。提供されていない場合、すべてのクエリ可能なドキュメントプロパティが選択されて VQL クエリがビルドされ、内部的に呼び出されてドキュメントの詳細が取得されます。

WHERE Clause (Where 句)

String (文字列)

WHERE 句を VQL クエリに追加して VQL クエリを動的にビルドできます。

Fetch Size (フェッチサイズ)

Integer (整数)

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

100

Batch Size (バッチサイズ)

Integer (整数)

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

10

#### [](#設定-10)設定 [Connection Configuration (接続設定)](#connection_configuration) #### [](#スロー-10)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#get_object_records)Get Object Records `` Get Object Records では、CSV または JSON 形式のオブジェクト ID メタデータを使用して、Vault でオブジェクトレコードを一括で取得します。 #### [](#パラメーター-11)パラメーター
名前 型 説明 デフォルト値 必須

Object Name (オブジェクト名)

String (文字列)

選択可能なすべての Vault オブジェクトのリスト。次に例を示します。

image

X

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

List<String>

ビジネス要件に基づいてオブジェクト項目をリストに挿入できます。提供されていない場合、使用可能なすべてのアクティブなオブジェクト項目が選択されて VQL クエリがビルドされ、内部的に呼び出されてオブジェクトレコードの詳細が取得されます。

WHERE Clause (Where 句)

String (文字列)

WHERE 句を VQL クエリに追加して VQL クエリを動的にビルドします。

Fetch Size (フェッチサイズ)

Integer (整数)

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

100

Batch Size (バッチサイズ)

Integer (整数)

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

10

#### [](#設定-11)設定 [Connection Configuration (接続設定)](#connection_configuration) #### [](#スロー-11)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED #### [](#get_picklists)Get Picklists `` Get Picklists 操作では、選択リストで設定されているすべての使用可能な値を取得します。 #### [](#パラメーター-12)パラメーター
名前 型 説明 デフォルト値 必須

Picklist Name (選択リスト名)

String (文字列)

Vault での選択可能な監査種別のリスト。次に例を示します。

image

X

#### [](#設定-12)設定 [Connection Configuration (接続設定)](#connection_configuration) #### [](#スロー-12)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#invoke_rest_api)Invoke REST API Invoke REST API 操作は、 [Veeva Vault Rest API](https://developer.veevavault.com/api/20.1/#documents)​ を呼び出し、ヘッダーで指定されている ​**Accept**​ 値に応じて JSON (デフォルト) または XML 形式で応答を返します。 [API レート制限](https://developer.veevavault.com/docs/#api-rate-limits)​を超過しないように、REST API を個別に使用するのではなく、可能な限り一括で使用することが重要です。 #### [](#パラメーター-13)パラメーター
名前 型 説明 デフォルト値 必須

Method (メソッド)

String (文字列)

REST API を呼び出すメソッドのリスト。

image

GET

X

Path (パス)

String (文字列)

要求を送信する URL パス

image

X

Body (本文)

Input Stream (入力ストリーム)

要求 (GET メソッド要求以外) と一緒に送信される要求メッセージの本文。デフォルトはペイロードです。

#[payload]

ヘッダー

Map (マップ)

要求と一緒に送信するキー-値形式のヘッダー。要求でヘッダーが必要ない場合は空白 (デフォルト) にしてください。

image

URI パラメーター

Map (マップ)

パスの値を解決するためのキー-値形式の URI パラメーター。パスに URI パラメーターがない場合は空白 (デフォルト) にしてください。

image

クエリパラメーター

Map (マップ)

要求と一緒に送信するキー-値形式のクエリパラメーター。要求でクエリパラメーターが必要ない場合は空白 (デフォルト) にしてください。

image

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

Stream (ストリーム)

ストリーミングモードで送信する要求。デフォルトでは、ペイロードの種別がストリームの場合、ストリーミングを使用して要求が送信されます。ドロップダウンリストから次のいずれかを選択します。

  • ALWAYS

  • AUTO

  • NEVER

#### [](#設定-13)設定 [Connection Configuration (接続設定)](#connection_configuration) #### [](#スロー-13)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#query)Query `` Query 操作を使用して、指定した VQL クエリを Vault で実行し、ページネーション形式で結果を取得します。ページネーションは Veeva Vault の API に基づきます。 #### [](#パラメーター-14)パラメーター
名前 型 説明 デフォルト値 必須

VQL Query (VQL クエリ)

String (文字列)

Veeva Vault の VQL 仕様に従って、実行する VQL クエリを定義します。詳細は、​ VQL クエリのドキュメント​を参照してください。次に例を示します。

SELECT id, name​v, study​v FROM :table​

X

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

Map<String, Object>

文字列とオブジェクトのマップ。この中の各項目が、挿入される行を表します。マップにはパラメーター名がキーとして含まれ、値はバインド先のパラメーターです。次に例を示します。

{

'table': 'site__v'

}

#[{}]

Fetch Size (フェッチサイズ)

Integer (整数)

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

100

Batch Size (バッチサイズ)

Integer (整数)

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

10

#### [](#設定-14)設定 [Connection Configuration (接続設定)](#connection_configuration) #### [](#スロー-14)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#spark_validator)Spark Validator `` Spark Validator 操作では、署名と、Vault から取得した公開キーを使用して Spark メッセージの検証と確認を行います。 #### [](#パラメーター-15)パラメーター
名前 型 説明 デフォルト値 必須

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

Boolean (ブール)

Spark ヘッダーを Spark メッセージ検証機能の出力に含めるためのフラグ。

FALSE

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

String (文字列)

公開キー (00001.pem) ファイルを保存するディレクトリパス。指定しない場合、Vault から取得します。

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

Spark Headers (Spark ヘッダー)

Object (オブジェクト)

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

#[attributes.headers]

Spark Message (Spark メッセージ)

Input Stream (入力ストリーム)

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

#[payload]

#### [](#設定-15)設定 [Connection Configuration (接続設定)](#connection_configuration) #### [](#スロー-15)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED - VEEVAVAULT:INVALID\_SPARK\_MESSAGE - VEEVAVAULT:INVALID\_KEY\_FORMAT ### [](#update_documents)Update Documents `` Update Documents 操作では、CSV または JSON 形式で提供された編集可能なドキュメントメタデータを使用して Vault でドキュメントを更新します。 #### [](#パラメーター-16)パラメーター
名前 型 説明 デフォルト値 必須

Metadata Format (メタデータ形式)

Enum (列挙) (文字列)

  • CSV

  • JSON

CSV または JSON のメタデータ形式。

X

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

Input Stream (入力ストリーム)

選択された [Metadata Format (メタデータ形式)] オプションに対応する CSV または JSON 形式の入力ストリームとしての編集可能なドキュメントメタデータ。次にメタデータを示します。

image

X

#### [](#設定-16)設定 [Connection Configuration (接続設定)](#connection_configuration) #### [](#スロー-16)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#update_object_records)Update Object Records `` Update Object Records では、CSV または JSON 形式の編集可能なオブジェクトメタデータを使用して、Vault でオブジェクトレコードを一括で更新します。 #### [](#パラメーター-17)パラメーター
名前 型 説明 デフォルト値 必須

Object Name (オブジェクト名)

String (文字列)

選択可能なすべての Vault オブジェクトのリスト。次に例を示します。

image

X

Metadata Format (メタデータ形式)

Enum (列挙) (文字列):

  • CSV

  • JSON

メタデータ形式 (CSV または JSON)。

X

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

Input Stream (入力ストリーム)

選択された ​[Metadata Format (メタデータ形式)]​ オプションに対応する CSV または JSON 形式の入力ストリームとしてのオブジェクトメタデータ。次にメタデータを示します。

image

X

#### [](#設定-17)設定 [Connection Configuration (接続設定)](#connection_configuration) #### [](#スロー-17)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ## [](#関連情報)関連情報 - [Veeva Vault Connector の概要](https://docs.mulesoft.com/jp/veevavault-connector/1.2/) - [Veeva Vault Connector リリースノート](https://docs.mulesoft.com/jp/release-notes/connector/veeva-vault-release-notes-mule-4) - [Anypoint Exchange の Veeva Vault Connector](https://anypoint.mulesoft.com/exchange/org.mule.extension/mule-veevavault-connector/) # Veeva Vault Connector 1.3 Veeva Vault 用 Anypoint Connector (Veeva Vault Connector) を使用すると、Veeva Vault REST API を使用して Mule フローを Veeva Vault プラットフォームに接続できます。 設定する操作に応じて、このコネクタは [Vault REST、Bulk API、ストリーミング API](https://developer.veevavault.com/api/19.1/#authentication)​ と連動します。各 API コールは JSON 要求または CSV 要求を使用して、HTTPS 接続経由で JSON 入力ストリーム応答を返します。必要なすべてのリクエストヘッダー、エラー処理、および HTTPS 接続設定は、コネクタに組み込まれています。 互換性と解決された問題に関する情報は、「Veeva Vault Connector リリースノート」を参照してください。 ## [](#始める前に)始める前に このコネクタを使用するには、以下に精通している必要があります。 - Veeva Vault - [Vault クエリ言語 (VQL)](https://developer.veevavault.com/vql/#introduction-to-vault-queries) - Anypoint Connector - Mule Runtime Engine (Mule) - Mule フローの要素とグローバル要素 - Anypoint Studio を使用した Mule アプリケーションの作成方法 アプリケーションを作成する前に、以下が必要です。 - Veeva Vault の対象リソースにアクセスするためのログイン情報 - Anypoint Platform - Anypoint Studio バージョン 7.3.5 以降 ## [](#コネクタの一般的なユースケース)コネクタの一般的なユースケース Mule アプリケーションで Veeva Vault Connector をアウトバウンドコネクタとして使用して、次の Veeva Vault オブジェクトに対する CRUD (create、retrieve、update、delete) 操作、クエリ操作、エクスポート操作、および Spark Validator 操作を実行できます。 - ドキュメント 作成、取得、更新、削除、エクスポート - ドキュメントレンディション 作成、取得、削除 - Vault Object (Vault オブジェクト) 作成、取得、更新、削除 - 選択リスト Retrieve - 監査履歴 Retrieve - Query VQL クエリを使用して、ドキュメント、Vault オブジェクト、ワークフローを照会します。 - Spark validator Veeva Vault からトリガーされた署名付き Spark メッセージの検証と確認を行います。 - Invoke Rest API 特定のコネクタ操作が存在しない場合に、 [Veeva Vault Rest API](https://developer.veevavault.com/api/20.1/#documents)​ を呼び出します。 [API レート制限](https://developer.veevavault.com/docs/#api-rate-limits)​を超過しないように、API を個別に使用するのではなく、一括で使用してください。 ## [](#接続種別)接続種別 Veeva Vault 接続では、ログイン情報を使用して Veeva Vault インスタンスに接続し、操作を実行する基本認証種別を使用します。 認証種別の設定についての詳細は、​[「コネクタのグローバル要素の設定」](https://docs.mulesoft.com/jp/veevavault-connector/1.3/veevavault-connector-studio#configure-global-element)​を参照してください。 ## [](#exchange-テンプレートおよび例)Exchange テンプレートおよび例 [Anypoint Exchange](https://www.mulesoft.com/exchange/)​ は、アプリケーションのスタートポイントとして使用できるテンプレートと、完全なソリューションを具体的に示した例を提供しています。 Veeva Vault Connector で使用可能なテンプレートは次のとおりです。 - [File System to Veeva Vault](https://anypoint.mulesoft.com/exchange/org.mule.examples/filesystem-to-veeva-vault-template/) - [Veeva Vault からファイルシステム](https://anypoint.mulesoft.com/exchange/org.mule.examples/veevavault-connector-project-templates/) - [Spark メッセージのエンドツーエンドソリューション](https://anypoint.mulesoft.com/exchange/org.mule.examples/spark-message-solution-template/) ## [](#次のステップ)次のステップ 前提条件を満たしたら、​[Anypoint Studio](https://docs.mulesoft.com/jp/veevavault-connector/1.3/veevavault-connector-studio)​ でアプリケーションを作成してコネクタを設定できます。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Exchange を使用したコネクタ、テンプレート、およびサンプルの検出](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Veeva Vault Connector リファレンス](https://docs.mulesoft.com/jp/veevavault-connector/1.3/veevavault-connector-reference) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Veeva Vault Connector 1.3 - XML と Maven のサポート XML で Mule アプリケーションを手動でコーディングすることもできますが、Anypoint Studio を使用した方が効率的です。 - Mule Runtime Engine (Mule) アプリケーションを (Anypoint Studio の XML エディターまたはテキストエディターから) 手動でコーディングする場合、参照ステートメントを XML Mule フローと Apache Maven ​`pom.xml`​ ファイルの両方に追加することで、アプリケーションからコネクタにアクセスできます。 - Anypoint Studio でコネクタを追加すると、Studio は自動的に XML コードにコネクタの名前空間およびスキーマの場所を入力し、​`pom.xml`​ ファイルに連動関係を追加します。 ## [](#コネクタの名前空間の追加)コネクタの名前空間の追加 次のコードを設定 XML のヘッダーの ​`mule`​ タグ内に貼り付けます。 ```xml http://www.mulesoft.org/schema/mule/veevavault http://www.mulesoft.org/schema/mule/veevavault/current/mule-veevavault.xsd ``` 次の例は、XML 内に名前空間ステートメントが配置される方法を示しています。 ```xml ``` ## [](#pom-ファイルの連動関係の追加)POM ファイルの連動関係の追加 Apache Maven ​`pom.xml`​ ファイルは Anypoint Studio によって生成され、Mule アプリケーションの連動関係が含まれます。Mule アプリケーションを手動でコーディングする場合、次の XML スニペットを ​`pom.xml`​ ファイルに含めてこのコネクタにアクセスできるようにします。 ```xml org.mule.extension mule-veevavault-connector x.x.x mule-plugin ``` ``​ を使用しているコネクタに対応するバージョンに置き換えます。 最新の ​`pom.xml`​ ファイル情報を取得する手順は、次のとおりです。 1. [Anypoint Exchange](https://www.mulesoft.com/exchange/)​ に移動します。 2. Exchange で、​**\[Login (ログイン)\]**​ をクリックし、Anypoint Platform のユーザー名とパスワードを指定します。 3. Exchange で、「​`connector-template-files`​」を検索します。 4. コネクタを選択します。 5. 画面の右上付近にある ​**\[Dependency Snippets (連動関係スニペット)\]**​ をクリックします。 ## [](#次のステップ)次のステップ 名前空間および ​`pom.xml`​ ファイルを完了したら、​[例](https://docs.mulesoft.com/jp/veevavault-connector/1.3/veevavault-connector-examples)​を試すことができます。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Veeva Vault Connector 1.3 の例 次の例は、Anypoint Studio でコネクタを設定する方法を示しています。 - [Veeva Vault でのドキュメントの作成](#create-documents-on-the-vault) - [ドキュメントの詳細を取得する](#retrieve-document-details) - [ドキュメントまたはオブジェクトデータのフェッチ](#fetch-document-or-object-data) - [Spark メッセージを検証する](#validate-a-spark-message) - [REST API を呼び出して単一ドキュメントを作成する](#invoke-rest-api) ## [](#create-documents-on-the-vault)Veeva Vault でのドキュメントの作成 次の例では、外部ソース (データベース) からフェッチしたドキュメントメタデータを使用してドキュメントを一括で作成します。Veeva Vault でドキュメントを作成する前に、Veeva Vault FTP サーバーを使用してドキュメントファイルをアップロードします。ドキュメントの ​`created`​ 状況がデータベースに挿入されます。 次のスクリーンショットは、この例の Studio アプリケーションフローを示しています。 ![Create Documents 操作の Mule フロー](/mulesoft/current/ja-jp/veevavault-connector/1.3/_images/veevavault-connector-create-documents-example.png) ![Upload Documents 操作の Mule フロー](/mulesoft/current/ja-jp/veevavault-connector/1.3/_images/veevavault-connector-upload-documents-example.png) ### [](#最初のフローを作成する)最初のフローを作成する 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[HTTP\]**​ を選択して ​**\[Listener\]**​ ソースをキャンバスにドラッグします。 2. 使用する環境に応じて HTTP リスナーを設定します。 3. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Database (データベース)\]**​ を選択して ​**\[Select\]**​ 操作をキャンバスにドラッグし、テーブルからドキュメントメタデータをフェッチします。 4. 接続ログイン情報を使用するように Database Connector を設定します。 5. \[SQL Query Text (SQL クエリテキスト)\] 項目に「​`>SELECT * FROM createdocuments`​」と入力します。 6. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Flow Reference\]**​ コンポーネントをキャンバスにドラッグし、サブフロー ​`upload-files-on-vault-ftp-server`​ を参照します。 7. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[For Each\]**​ スコープを次の要素が含まれるキャンバスにドラッグします。 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Transform Message\]**​ コンポーネントをキャンバスにドラッグし、ドキュメントメタデータを CSV 形式に変換します。 2. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Veeva Vault\]**​ を選択して ​**\[Create Documents\]**​ 操作をキャンバスにドラッグします。 3. Veeva Vault 接続の次の値を入力します。 - **Username (ユーザー名)** - **Password (パスワード)** - **Vault URL** - **Vault version (Vault バージョン)** - **Vault client ID (Vault クライアント ID)** 4. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Database (データベース)\]**​ を選択して ​**\[Bulk insert\]**​ 操作をキャンバスにドラッグし、ドキュメント作成済み状況データをデータベーステーブルに挿入します。 8. 接続ログイン情報を使用するように Database Connector を設定します。 9. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグし、コンソールまたはログファイルに情報を記録します。 ### [](#2-つ目のフローを作成する)2 つ目のフローを作成する 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグし、このサブフローの情報を記録します。 2. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[For Each\]**​ スコープを次の要素が含まれるキャンバスにドラッグします。 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグします。 2. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[FTPS\]**​ を選択して ​**\[Read\]**​ 操作をキャンバスにドラッグします。 3. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグします。 4. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[FTPS\]**​ を選択して ​**\[Write\]**​ 操作をキャンバスにドラッグし、ファイルを Veeva Vault FTP サーバーに書き込みます。 3. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して別の ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグします。 4. Veeva Vault FTP サーバーのログイン情報を使用するように FTPS Connector を設定します。 ### [](#例の-xml)例の XML この例の 2 つのフローをすばやく Mule アプリケーションに読み込むには、次のコードを Studio XML エディターに貼り付けます。 ```xml SELECT * FROM createdocuments { lifecycle__v: payload01.lifecycle__v, study__v: payload01.study__v, subtype__v: payload01.subtype__v, name__v: payload01.name__v ++ '--' ++ randomInt(10000) as String, type__v: payload01.type__v, classification__v: payload01.classification__v, product__v: payload01.product__v, file: payload01.file as String }]]> { 'id': $.id as String, 'external_id__v': $.external_id__v as String, 'responseStatus': $.responseStatus }]]]> INSERT into documents (id, external_id__v, responseStatus) VALUES (:id: external_id__v, :responseStatus) ``` ## [](#retrieve-document-details)ドキュメントの詳細を取得する この例では、ドキュメント種別、サブタイプ、分類に基づいてドキュメントの詳細を取得してデータベースに保存します。 次のスクリーンショットは、この例の Studio アプリケーションフローを示しています。 ![Get Documents 操作の Mule フロー](/mulesoft/current/ja-jp/veevavault-connector/1.3/_images/veevavault-connector-get-documents-example.png) 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[HTTP\]**​ を選択して ​**\[Listener\]**​ ソースをキャンバスにドラッグします。 2. 使用する環境に応じて HTTP リスナーを設定します。 3. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Veeva Vault\]**​ を選択して ​**\[Get Documents\]**​ 操作をキャンバスにドラッグします。 4. Veeva Vault 接続の次の値を入力します。 - **Username (ユーザー名)** - **Password (パスワード)** - **Vault URL** - **Vault version (Vault バージョン)** - **Vault client ID (Vault クライアント ID)** 5. 各更新ボタンをクリックして、ドキュメント種別、サブタイプ、および分類のリストをフェッチします。 6. 各ドロップダウンリストからドキュメント種別、サブタイプ、および分類を選択します。 7. ビジネス要件に応じてドキュメントプロパティを \[Document Properties (ドキュメントプロパティ)\] リストに追加し、プロパティ名を VQL クエリに組み込んで、VQL クエリを動的にビルドします。 8. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[For Each\]**​ スコープを次の要素が含まれるキャンバスにドラッグします。 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Transform Message\]**​ コンポーネントをキャンバスにドラッグします。 2. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Database (データベース)\]**​ を選択して ​**\[Insert\]**​ 操作をキャンバスにドラッグします。 3. 接続ログイン情報を使用して、Database Connector を設定します。 9. ビジネス要件に従って、DataWeave を使用して変換を設定します。 10. データをテーブルに挿入するように ​**Insert**​ 操作を設定します。 11. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Set Payload\]**​ トランスフォーマーをキャンバスにドラッグし、トリガーソースに返すペイロードを設定します。 12. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグし、コンソールまたはログファイルに情報を記録します。 ### [](#例の-xml-2)例の XML この例のフローをすばやく Mule アプリケーションに読み込むには、次のコードを Studio XML エディターに貼り付けます。 ```xml INSERT INTO [.underline]#createdocuments# (name__v, type__v, subtype__v, classification__v, lifecycle__v, product__v, status__v, study__v, file) VALUES (:name__v, :type__v, :subtype__v, :classification__v, :lifecycle__v, :product__v, :status__v, :study__v, :file) ``` ## [](#fetch-document-or-object-data)ドキュメントまたはオブジェクトデータのフェッチ この例では、VQL クエリを使用して Veeva Vault からドキュメントまたはオブジェクトデータをフェッチします。 次のスクリーンショットは、この例の Studio アプリケーションフローを示しています。 ![Query 操作の Mule フロー](/mulesoft/current/ja-jp/veevavault-connector/1.3/_images/veevavault-connector-query-example.png) 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[HTTP\]**​ を選択して ​**\[Listener\]**​ ソースをキャンバスにドラッグします。 2. 使用する環境に応じて HTTP リスナーを設定します。 3. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Veeva Vault\]**​ を選択して ​**\[Query\]**​ 操作をキャンバスにドラッグします。 4. Veeva Vault 接続の次の値を入力します。 - **Username (ユーザー名)** - **Password (パスワード)** - **Vault URL** - **Vault version (Vault バージョン)** - **Vault client ID (Vault クライアント ID)** 5. ビジネス要件に従って VQL クエリを定義します。 6. VQL クエリで使用する場合は、入力プレースホルダーを追加して、実行時に VQL で動的に組み込みます。 7. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[For Each\]**​ スコープを次の要素が含まれるキャンバスにドラッグします。 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Transform Message\]**​ コンポーネントをキャンバスにドラッグします。 2. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[File (ファイル)\]**​ を選択して ​**\[Write\]**​ 操作をキャンバスにドラッグします。 8. ビジネス要件に従って、DataWeave を使用して変換を設定します。 9. 作業ファイルのパスを使用して、File Connector を設定します。 10. 指定したファイルにペイロードデータを書き込むように ​**Write**​ 操作を設定します。 11. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Set Payload\]**​ トランスフォーマーをキャンバスにドラッグし、トリガーソースに返すペイロードを設定します。 12. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグし、コンソールまたはログファイルに情報を記録します。 ### [](#例の-xml-3)例の XML この例のフローをすばやく Mule アプリケーションに読み込むには、次のコードを Studio XML エディターに貼り付けます。 ```xml SELECT id, name__v, type__v, subtype__v, classification__v, lifecycle__v, status__v, study__v, product__v from :table WHERE name__v= 'F22611234--6764' ``` ## [](#validate-a-spark-message)Spark メッセージを検証する この例では、Veeva Vault の Spark メッセージをトリガーし、Spark メッセージを検証します。 次のスクリーンショットは、この例の Studio アプリケーションフローを示しています。 ![Spark Validator 操作の Mule フロー](/mulesoft/current/ja-jp/veevavault-connector/1.3/_images/veevavault-connector-spark-validator-example.png) 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[HTTP\]**​ を選択して ​**\[Listener\]**​ ソースをキャンバスにドラッグします。 2. HTTP Connector 用の JKS 証明書には、Veeva Vault との TLS 接続を介して Spark メッセージを受信するための HTTP リスナー用の ​`.jks`​ ファイルが必要です。 次の手順は、​`/bin`​ ディレクトリにある Java Keytool を使用して ​`.jks`​ ファイルを作成する方法を示しています。 3. `/bin`​ ディレクトリから次のコマンドを実行します。 ​\`keytool -genkey -keyalg RSA -alias mule -keystore spark-listener.jks -storepass password -validity 360 -keysize 2048\` これにより、現在のディレクトリに ​\`spark-listener.jks\`​ ファイルが作成されます。 4. `src/main/resources`​ プロジェクトディレクトリの ​`spark-listener.jks`​ ファイルをコピーしてインポートします。 5. HTTP リスナーを次のように設定します。 1. **\[General (一般)\]**​ タブで、次のように設定します。 - Protocol (プロトコル): HTTPS - Host (ホスト): 0.0.0.0 - Port (ポート): 8082 2. **\[TLS\]**​ タブで、次のように設定します。 - Type (種別): JKS - Path (パス): spark-listener.jks - Alias (別名): mule - Key Password (キーパスワード): password - Password (パスワード): password 6. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Veeva Vault\]**​ を選択して ​**\[Spark Validator\]**​ 操作をキャンバスにドラッグします。 7. Veeva Vault 接続の次の値を入力します。 - **Username (ユーザー名)** - **Password (パスワード)** - **Vault URL** - **Vault version (Vault バージョン)** - **Vault client ID (Vault クライアント ID)** 8. **Spark Validator**​ パラメーターを次のように設定します。 - Include Spark Header (Spark ヘッダーを含める): `FALSE` - Public Key Path (公開キーのパス): `${file.keyPath}` 公開キーファイル (00001.pem) の保存場所へのパスを使用して、​`configuration.yaml`​ の ​`file.keyPath`​ プロパティを定義します。 - Spark Headers (Spark ヘッダー): `#[attributes.headers]` - Spark Message (Spark メッセージ): `#[payload]` 9. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Set Payload\]**​ 操作をキャンバスにドラッグし、​**\[Value (値)\]**​ 項目で次のように定義します。 \---- output application/json --- { "payload" : payload, "attributes": attributes } ---- 10. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグし、次のメッセージを使用してペイロードを記録します。 Spark Message :: #\[payload\] ### [](#例の-xml-4)例の XML この例のフローをすばやく Mule アプリケーションに読み込むには、次のコードを Studio XML エディターに貼り付けます。 ```xml ``` ## [](#invoke-rest-api)REST API を呼び出して単一ドキュメントを作成する この例では、REST API を呼び出して、単一ドキュメントを作成します。 次のスクリーンショットは、この例の Studio アプリケーションフローを示しています。 ![Invoke REST API 操作の Mule フロー](/mulesoft/current/ja-jp/veevavault-connector/1.3/_images/veevavault-connector-invoke-rest-api-example.png)
Veeva Vault REST API を呼び出すには、要件に従ってパラメーターを設定する必要があります。
1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[HTTP\]**​ を選択して ​**\[Listener\]**​ ソースをキャンバスにドラッグします。 2. 使用する環境に応じて HTTP リスナーを設定します。 3. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[File (ファイル)\]**​ を選択して ​**\[Read\]**​ 操作をキャンバスにドラッグし、Veeva Vault ドキュメントに関連付けられたファイルのコンテンツから読み取るようにファイルパスを設定します。 4. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Veeva Vault\]**​ を選択して ​**\[Invoke REST API\]**​ 操作をキャンバスにドラッグします。 5. Veeva Vault 接続の次の値を入力します。 - **Username (ユーザー名)** - **Password (パスワード)** - **Vault URL** - **Vault version (Vault バージョン)** - **Vault client ID (Vault クライアント ID)** 6. POST 要求を設定します。 Method: POST, Path: "/objects/documents", Headers: Key: "Accept" Value: "application/json" Key: "Content-Type" Value: "multipart/form-data; boundary=abcdefg" URI Parameters: Leave it empty. Query Parameters: Leave it empty. %dw 2.0 output multipart/form-data boundary='abcdefg' --- { parts: { file: { headers: { "Content-Disposition": { "name": "file", "filename": attributes.fileName }, "Content-Type": payload.^mimeType }, content : payload }, name\_\_v: { headers: { }, content: 'Test Document' }, type\_\_v: { headers: { }, content: 'Trial Management' }, subtype\_\_v: { headers: { }, content: 'Meetings' }, classification\_\_v: { headers: { }, content: 'Kick-off Meeting Material' }, lifecycle\_\_v: { headers: { }, content: 'Base Doc Lifecycle' }, study\_\_v: { headers: { }, content: '0ST000000000301' }, comments\_\_c: { headers: { }, content: 'Test Document' } } } 7. PUT 要求を設定します。 Method: PUT, Path: "/objects/documents/{doc\_id}", Headers: Key: "Accept" Value: "application/json" Key: "Content-Type" Value: "application/x-www-form-urlencoded" URI Parameters: Key: "doc\_id" Value: "259592" Query Parameters: Leave it empty. %dw 2.0 output application/x-www-form-urlencoded --- { "id": "259592", "name\_\_v": "Kick-off Meeting Material Updated", "product\_\_v": "00P000000000403", "study\_\_v": "0ST000000000202", "notes\_\_v": "Notes Updated" } 8. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグし、次のメッセージを使用してペイロードを記録します。 Invoke Veeva API response :: #\[payload\] ### [](#例の-xml-5)例の XML この例のフローをすばやく Mule アプリケーションに読み込むには、次のコードを Studio XML エディターに貼り付けます。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Veeva Vault Connector 1.3 の追加設定情報 ## [](#invoke_rest_api)Invoke Rest API **Invoke Rest API**​ 操作は、リクエストボディとして Mule メッセージペイロードを送信します。 リクエストボディに加えて、DataWeave スクリプトまたは式を使用して以下を設定できます。 - [Header (ヘッダー)](#headers) - [URI Parameters (URI パラメーター)](#uri-parameters) - [Query Parameters (クエリパラメーター)](#query-parameters) ### [](#headers)ヘッダーを設定する 1. Anypoint Studio で、​**\[General (一般)\] > \[Request (要求)\] > \[Query Parameters (クエリパラメーター)\]**​ に移動します。 2. プラスアイコン (+) をクリックしてヘッダーを要求に追加します。 たとえば、DataWeave 式を使用して、ヘッダー名 ​`HeaderName1`​ および ​`HeaderName2`​ とヘッダー値 ​`HeaderValue1`​ および ​`HeaderValue2`​ を追加します。 #\[{'HeaderName1' : 'HeaderValue1', 'HeaderName2' : 'HeaderValue2'}\]. ### [](#uri-parameters)URI パラメーターを設定する 要求のパスにプレースホルダー (​`/objects/documents/{doc_id}`​ など) を使用する場合は、URI パラメーターを設定します。 1. Anypoint Studio で、​**\[Path (パス)\]**​ 項目にプレースホルダーを中括弧で囲んで入力します。 2. **\[URI Parameters (URI パラメーター)\]**​ を選択します。 3. プラス記号 (+) をクリックして、名前と値を入力します。 ### [](#query-parameters)クエリパラメーターを設定する 1. Anypoint Studio で、​**\[General (一般)\] > \[Request (要求)\] > \[Query Parameters (クエリパラメーター)\]**​ に移動します。 2. プラスアイコン (+) をクリックして、パラメーターを要求に追加します。パラメーターの名前と値を入力するか、DataWeave 式を使用して名前と値を定義します。 #### [](#post-要求での-form-フォーム-パラメーターの送信)POST 要求での form (フォーム) パラメーターの送信 POST 要求でパラメーターを送信する方法: 1. **\[General (一般)\] > \[Request (要求)\]**​ で、​**POST**​ メソッドを選択します。 2. **\[Body (本文)\]**​ に、Mule メッセージのペイロードを入力します。 1. **application/x-www-form-urlencoded**​ などで送信するパラメーターの名前と値を入力します。 #\[output application/x-www-form-urlencoded --- {'key1':'value1', 'key2':'value2'}\] 2. **multipart/form-data**​ で、​**Content-Type**​ 値に DataWeave 出力と同じ境界属性値が含まれていることを確認してください。例: `multipart/form-data; boundary=abcdefg`​。 %dw 2.0 output multipart/form-data boundary='abcdefg' --- { parts: { file: { headers: { "Content-Disposition": { "name": "file", "filename": attributes.fileName }, "Content-Type": payload.^mimeType }, content : payload }, name\_\_v: { headers: { }, content: 'Test Document' }, type\_\_v: { headers: { }, content: 'Trial Management' }, subtype\_\_v: { headers: { }, content: 'Meetings' }, classification\_\_v: { headers: { }, content: 'Kick-off Meeting Material' }, lifecycle\_\_v: { headers: { }, content: 'Base Doc Lifecycle' }, study\_\_v: { headers: { }, content: '0ST000000000301' }, comments\_\_c: { headers: { }, content: 'Test Document' } } } ## [](#connector_operations_success_and_failure_response)コネクタ操作の SUCCESS および FAILURE 応答 Veeva Vault Connector 操作の応答は、Veeva Vault API の成功または失敗応答とエラーに基づきます。 コネクタは ​`SUCCESS`​ 応答を ​`HIGH LEVEL`​ で返し、​`SUCCESS`​ または ​`FAILURE`​ を ​`LOW LEVEL`​ で返します。つまり、コネクタ操作が正常に終了しても、要求に渡された関連のない一部のデータのために一部のドキュメントまたはオブジェクトレコードの作成または更新が失敗していることがあります。 ### [](#例)例 **SUCCESS を含む SUCCESS 応答**​: { "responseStatus": "SUCCESS", "data": \[{ "id": 239026, "name\_\_v": "E22611234--38483", "responseStatus": "SUCCESS" }, { "id": 239025, "name\_\_v": "Kick-off Meeting Material Updated12341234--81032", "responseStatus": "SUCCESS" } \] } **FAILURE を含む SUCCESS 応答**​: { "data": \[ { "external\_id\_\_v": "TEST-238924", "rendition\_type\_\_v": "imported\_rendition\_\_c", "id": 238924, "responseStatus": "FAILURE", "minor\_version\_number\_\_v": 1, "errors": \[ { "type": "INVALID\_DATA", "message": "Document not found \[238924/0/1\]." } \], "major\_version\_number\_\_v": 0 }, { "external\_id\_\_v": "TEST-238925", "rendition\_type\_\_v": "imported\_rendition\_\_c", "id": 238925, "responseStatus": "FAILURE", "minor\_version\_number\_\_v": 1, "errors": \[ { "type": "INVALID\_DATA", "message": "Document not found \[238925/0/1\]." } \], "major\_version\_number\_\_v": 0 } \], "responseStatus": "SUCCESS" } Veeva Vault API で ​`FAILURE`​ 応答が返されると、Veeva Vault Connector 操作で例外がスローされます。次に例を示します。 **ERROR を含む FAILURE 応答** { "responseStatus": "FAILURE", "errors": \[ { "type": "INVALID\_DATA", "message": "Unknown relationship \[reviewer\_\_v\]" } \] } Veeva Vault API から ​`FAILURE`​ 応答を受信すると、コネクタ操作で例外がスローされ、Mule フロー内の ​**Error Handling**​ コンポーネントでキャッチされます。 \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* Message : An error occurred from the Veeva Vault API. Error Code: INVALID\_DATA. Original Error Message: Unknown relationship \[reviewer\_\_v\]. Error type : VEEVAVAULT:INVALID\_DATA \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* **Error Handling**​ コンポーネントでキャッチされるエラーコードを次に示します。 - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ## [](#streaming_and_pagination)ストリーミングおよびページネーション **Download Document**​ を除くすべてのコネクタ操作で、操作の出力に基づく各結果を含むペイロードとして入力ストリームが返されます。このため、デフォルトでは、Mule ではストリーミング戦略が適用されます。詳細は、​[Mule ストリーミング戦略](https://docs.mulesoft.com/mule-runtime/latest/streaming-about)​を参照してください。ストリーミング戦略の設定項目は、コネクタ操作の ​**\[Advanced (詳細)\]**​ タブにあります。 ![image](/mulesoft/current/ja-jp/veevavault-connector/1.3/_images/veevavault-connector-streaming-pagination.png) コネクタ内の次の操作では、Mule 標準ページネーションに基づくページネーションメカニズムが提供されます。 - **Get Documents** - **Get Object Records** - **Query** - **Get Audit Details** ページ分割操作を使用していますが、各オブジェクトを取得するには必ず ​`For-Each/Splitter`​ 要素を含めてください。ページネーション操作には、​**\[Fetch Size (フェッチサイズ)\]**​ 項目と ​**\[Batch Size (バッチサイズ)\]**​ 項目があります。 - **Fetch Size (フェッチサイズ)**​ 1 つのページで取得できるレコードの制限数。操作は、フェッチサイズの数の JSON オブジェクトレコードを含むページを返します。 場合によって、Veeva API でレコードサイズに基づいてフェッチサイズ (各ページのレコード数) が自動計算され、その計算で標準レコードサイズを超えることがあります。操作は、各ページで計算されたレコード数を返します。 - **Batch Size (バッチサイズ)**​ 各バッチで返されるページの数。各ページには、フェッチサイズの数のレコードが含まれます。操作はバッチごとに多数のレコード (JSON 形式のメタデータ) を返し、計算は次の例のように行われます。 Fetch Size set as \*1000\* Batch Size set as \*10\* If the total records in the vault are \*100,000\*, then: Number of pages = Total records/Fetch Size = 100000/1000 = 100 pages. Number of pages per batch = Number of pages/Batch Size = 100/10 = 10 pages per batch. Number of Records per batch = Number of pages per batch \* Fetch Size = 10 \* 1000 = 10,000 records. Therefore, the number of records returned per batch would be 10,000 records. 反復可能ストリームはバッファサイズをバイト単位で測定します。オブジェクトを処理するときに、ランタイムはインスタンス数を使用してバッファサイズを測定します。 反復不可能ストリームの、コネクタ操作では、ストリームはバッチごとのレコード数として返されます。反復可能ストリームでは、すべてのレコードが一度に返されるため、反復可能自動ページングでメモリ内のバッファサイズを計算する場合は、メモリ不足にならないように、各インスタンスが使用するメモリ量を見積もる必要があります。 ## [](#次のステップ)次のステップ コネクタの設定が完了したら、​[例](https://docs.mulesoft.com/jp/veevavault-connector/1.3/veevavault-connector-examples)​を試すことができます。 ## [](#関連情報)関連情報 - [Veeva Vault Connector リファレンス](https://docs.mulesoft.com/jp/veevavault-connector/1.3/veevavault-connector-reference) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Veeva Vault Connector 1.3 リファレンス ## [](#connection_configuration)Configuration (設定)
名前 型 説明 デフォルト値 必須

名前

String (文字列)

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

X

Vault URL

String (文字列)

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

X

Username (ユーザー名)

String (文字列)

セッションの初期化に使用するユーザー名。

X

Password (パスワード)

String (文字列)

ユーザーの認証に使用するパスワード。

X

Version (バージョン)

String (文字列)

Veeva Vault API バージョン。

v20.1

Client Id (クライアント ID)

String (文字列)

追跡の目的で各リクエストヘッダーと共に Veeva Vault インスタンスに送信するクライアント ID。形式は ​{organization}-{component/team}​ です (例: abcpharma-clinicalprod​)。要求を送信する前に、クライアント ID の先頭に ​mulesoft​、末尾に ​client-vaultconnector​ が付けられます (例: mulesoft-abcpharma-clinicalprod-client-vaultconnector​)。

X

### [](#応答タイムアウト-advanced-詳細-タブ)応答タイムアウト (\[Advanced (詳細)\] タブ)
名前 型 説明 デフォルト値 必須

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

Integer (整数)

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

30000 ms

X

### [](#burst-api-limit-profile-バースト-api-制限プロファイル-advanced-詳細-タブ)Burst API Limit Profile (バースト API 制限プロファイル) (\[Advanced (詳細)\] タブ) `` 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 レート制限ヘッダー)」](https://developer.veevavault.com/docs/#api-rate-limits)​を参照してください。
名前 型 説明 デフォルト値 必須

API Limit Threshold (API 制限しきい値)

Integer (整数)

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

200

X

Wait Time (待機時間)

Integer (整数)

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

5

X

Time Unit (時間単位)

  • DAYS

  • HOURS

  • MINUTES

  • SECONDS

  • MILLISECONDS

  • NANOSECONDS

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

MINUTES

X

### [](#daily-api-limit-profile-1-日の-api-制限プロファイル-advanced-詳細-タブ)Daily API Limit Profile (1 日の API 制限プロファイル) (\[Advanced (詳細)\] タブ) `` **\[Daily API Limit Profile (1 日の API 制限プロファイル)\]**​ では、1 日の残りの API 制限コール数に対して評価される API 制限しきい値を設定します。1 日の API 制限コール数が、指定された API 制限しきい値に達するか超えた場合、例外がスローされます。 **\[Daily API Limit Profile (1 日の API 制限プロファイル)\]**​ は、デフォルトで無効になっています。 詳細は、 [「API Rate Limit Headers (API レート制限ヘッダー)」](https://developer.veevavault.com/docs/#api-rate-limits)​を参照してください。
名前 型 説明 デフォルト値 必須

API Limit Threshold (API 制限しきい値)

Integer (整数)

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

10000

X

## [](#操作)操作 - [Create Documents](#create_documents) - [Create Document Renditions](#create_document_renditions) - [Create Object Records](#create_object_records) - [Delete Documents](#delete_documents) - [Delete Document Renditions](#delete_document_renditions) - [Delete Object Records](#delete_object_records) - [Export Documents](#export_documents) - [Get Audit Details](#get_audit_details) - [Get Documents](#get_documents) - [Get Document Renditions](#get_document_renditions_types) - [Get Object Records](#get_object_records) - [Get Picklists](#get_picklists) - [Invoke REST API](#invoke_rest_api) - [Query](#query) - [Spark Validator](#spark_validator) - [Update Documents](#update_documents) - [Update Object Records](#update_object_records) ### [](#create_documents)Create Documents `` CSV または JSON 形式で提供されたドキュメントメタデータを使用して、Veeva Vault で 1 つまたは複数のドキュメントを作成します。ドキュメントファイルを、作成したドキュメントに添付するコンテンツと共に Vault FTP サーバーの場所にアップロードする必要があります。 #### [](#パラメーター)パラメーター
名前 型 説明 デフォルト値 必須

Metadata Format (メタデータ形式)

Enum (列挙) (文字列):

  • CSV

  • JSON

ドキュメントメタデータの形式。

X

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

Input Stream (入力ストリーム)

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

X

#### [](#設定)設定 [Configuration (設定)](#connection_configuration) #### [](#スロー)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#create_document_renditions)Create Document Renditions `` CSV または JSON 形式で提供されたドキュメントメタデータを使用して、Veeva Vault でドキュメントレンディションを一括作成します。 この操作を使用する前に Vault が移行モードになっている必要があります。この操作では、標準の UTF-8 でエンコードされた値を含む、最大サイズ 1 GB の CSV 入力データを取り込みます。 #### [](#パラメーター-2)パラメーター
名前 型 説明 デフォルト値 必須

Metadata Format (メタデータ形式)

Enum (列挙) (文字列):

  • CSV

  • JSON

ドキュメントメタデータの形式。

X

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

Input Stream (入力ストリーム)

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

X

#### [](#設定-2)設定 [Configuration (設定)](#connection_configuration) #### [](#スロー-2)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#create_object_records)Create Object Records `` CSV または JSON 形式で提供されたオブジェクトメタデータを使用して、選択した Vault オブジェクトの一括オブジェクトレコードを作成します。 #### [](#パラメーター-3)パラメーター

名前

型

説明

デフォルト値

必須

Object Name (オブジェクト名)

String (文字列)

Veeva Vault 更新アイコンをクリックして、Vault オブジェクトリストを取得します。リストからオブジェクト名を選択して、選択したオブジェクトのレコードを作成します。

X

Metadata Format (メタデータ形式)

Enum (列挙) (文字列):

  • CSV

  • JSON

オブジェクトメタデータの形式。

X

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

Input Stream (入力ストリーム)

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

X

#### [](#設定-3)設定 [Configuration (設定)](#connection_configuration) #### [](#スロー-3)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#delete_documents)Delete Documents `` CSV または JSON 形式で提供されたドキュメントメタデータを使用して、Veeva Vault の 1 つまたは複数のドキュメントを削除します。 #### [](#パラメーター-4)パラメーター
名前 型 説明 デフォルト値 必須

Metadata Format (メタデータ形式)

Enum (列挙) (文字列):

  • CSV

  • JSON

ドキュメントメタデータの形式。

X

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

Input Stream (入力ストリーム)

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

X

#### [](#設定-4)設定 [Configuration (設定)](#connection_configuration) #### [](#スロー-4)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#delete_document_renditions)Delete Document Renditions `` CSV または JSON 形式で提供されたドキュメントメタデータを使用して、Veeva Vault のドキュメントレンディションを一括削除します。 #### [](#パラメーター-5)パラメーター
名前 型 説明 デフォルト値 必須

Metadata Format (メタデータ形式)

Enum (列挙) (文字列):

  • CSV

  • JSON

ドキュメントメタデータの形式。

X

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

Input Stream (入力ストリーム)

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

X

#### [](#設定-5)設定 [Configuration (設定)](#connection_configuration) #### [](#スロー-5)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#delete_object_records)Delete Object Records `` CSV または JSON 形式で提供されたオブジェクトメタデータを使用して、選択した Vault オブジェクトのオブジェクトレコードを一括削除します。 #### [](#パラメーター-6)パラメーター
名前 型 説明 デフォルト値 必須

Object Name (オブジェクト名)

String (文字列)

Veeva Vault 更新アイコンをクリックして、Vault オブジェクトリストを取得します。リストからオブジェクト名を選択して、選択したオブジェクトのレコードを削除します。

X

Metadata Format (メタデータ形式)

Enum (列挙) (文字列):

  • CSV

  • JSON

オブジェクトメタデータの形式。

X

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

Input Stream (入力ストリーム)

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

X

#### [](#設定-6)設定 [Configuration (設定)](#connection_configuration) #### [](#スロー-6)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#export_documents)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` エクスポートされたドキュメントファイルのマイナーバージョン番号。 #### [](#パラメーター-7)パラメーター
名前 型 説明 デフォルト値 必須

Metadata Format (メタデータ形式)

Enum (列挙) (文字列):

  • CSV

  • JSON

オブジェクトメタデータの形式。

X

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

Input Stream (入力ストリーム)

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

#[payload]

X

Source (ソース)

Boolean (ブール)

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

true

Renditions (レンディション)

Boolean (ブール)

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

false

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

Boolean (ブール)

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

false

Polling Interval (ポーリング間隔)

Integer (整数)

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

30

#### [](#設定-7)設定 [Configuration (設定)](#connection_configuration) #### [](#スロー-7)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED #### [](#get_audit_details)Get Audit Details `` 指定された監査種別の監査の詳細を取得します。 この操作では、Mule 標準ページネーションに基づくページングメカニズムが提供されます。詳細は、​[「ストリーミングおよびページネーション」](https://docs.mulesoft.com/jp/veevavault-connector/1.3/veevavault-connector-config-topics#streaming_and_pagination.adoc)​を参照してください。 #### [](#パラメーター-8)パラメーター
名前 型 説明 デフォルト値 必須

Audit Type (監査種別)

String (文字列)

Veeva Vault 更新アイコンをクリックして、Vault の監査種別を取得します。監査の詳細を取得する必要がある、対象の監査種別をリストから選択します。

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 (フェッチサイズ)

Integer (整数)

1 ページあたりのレコード数を指定します。

100

Batch Size (バッチサイズ)

Integer (整数)

バッチごとのページ数を指定します。

10

#### [](#設定-8)設定 [Configuration (設定)](#connection_configuration) #### [](#スロー-8)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#get_documents)Get Documents `` Veeva Vault からドキュメントの詳細を取得します。次のいずれかを実行できます。 - ドキュメントプロパティ (ドキュメント種別、サブタイプ、分類) を指定して、ドキュメントの詳細を取得します。 ドキュメントプロパティが指定されている場合、​**Get Documents**​ 操作によって VQL クエリが動的にビルドされます。その後、この VQL クエリが Vault で実行され、ドキュメントの詳細が取得されます。 - ドキュメントプロパティ (ドキュメント種別、サブタイプ、分類) をフェッチして、ドキュメントの詳細を取得します。 ドキュメントプロパティが指定されていない場合、​`/api/{version}/metadata/objects/documents/properties`​ を使用してドキュメントプロパティメタデータがフェッチされ、​**\[Document Properties (ドキュメントプロパティ)\]**​ リストに追加または挿入されたドキュメントメタデータプロパティに基づいて VQL クエリがビルドされます。メタデータプロパティが指定されていない場合、クエリ可能なすべてのドキュメントプロパティが VQL クエリで使用および実行されます。 この操作の後に For-Each/Splitter 要素を配置して、各ドキュメントのデータ (ページ) を順次フェッチします。 この操作では、Mule 標準ページネーションに基づくページングメカニズムが提供されます。詳細は、​[「ストリーミングおよびページネーション」](https://docs.mulesoft.com/jp/veevavault-connector/1.3/veevavault-connector-config-topics#streaming_and_pagination.adoc)​を参照してください。 #### [](#パラメーター-9)パラメーター
名前 型 説明 デフォルト値 必須

型

String (文字列)

選択可能なすべてのドキュメント種別のリスト。

Subtype (サブタイプ)

String (文字列)

選択可能なすべてのドキュメントサブタイプのリスト。

Classification (分類)

String (文字列)

選択可能なすべてのドキュメント分類のリスト。

Document Properties (ドキュメントプロパティ)

List<String>

ビジネス要件に基づいてドキュメントプロパティをリストに挿入します。提供されていない場合、すべてのクエリ可能なドキュメントプロパティが選択されて VQL クエリがビルドされ、内部的に呼び出されてドキュメントの詳細が取得されます。

WHERE Clause (Where 句)

String (文字列)

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

Fetch Size (フェッチサイズ)

Integer (整数)

1 ページあたりのレコード数を指定します。

100

Batch Size (バッチサイズ)

Integer (整数)

バッチごとのページ数を指定します。

10

#### [](#設定-9)設定 [Configuration (設定)](#connection_configuration) #### [](#スロー-9)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#get_document_renditions_types)Get Document Renditions Types `` ドキュメントレンディションの詳細を取得します。 #### [](#パラメーター-10)パラメーター
名前 型 説明 デフォルト値 必須

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

Input Stream (入力ストリーム)

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

X

#### [](#設定-10)設定 [Configuration (設定)](#connection_configuration) #### [](#スロー-10)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#get_object_records)Get Object Records `` オブジェクトメタデータ項目を使用してオブジェクトレコードの詳細を取得し、VQL クエリを動的にビルドして Vault で実行し、オブジェクトの詳細を取得します。この操作の後に For-Each/Splitter 要素を配置して、各オブジェクトレコード (ページ) を順次フェッチします。 この操作では、Mule 標準ページネーションに基づくページングメカニズムが提供されます。詳細は、​[「ストリーミングおよびページネーション」](https://docs.mulesoft.com/jp/veevavault-connector/1.3/veevavault-connector-config-topics#streaming_and_pagination.adoc)​を参照してください。 #### [](#パラメーター-11)パラメーター
名前 型 説明 デフォルト値 必須

Object Name (オブジェクト名)

String (文字列)

選択可能なすべての Vault オブジェクトのリスト。

X

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

List<String>

ビジネス要件に基づいてオブジェクト項目をリストに挿入します。指定されていない場合、使用可能なすべてのアクティブなオブジェクト項目が選択されて VQL クエリがビルドされ、内部的に呼び出されてオブジェクトレコードの詳細が取得されます。

WHERE Clause (Where 句)

String (文字列)

Vault で実行する VQL クエリを動的にビルドするために追加される LINKK SKK VQL WHERE 句 (キーワード WHERE を使用しない)。例: study_country__v = ‘0SC000000000101​。

Fetch Size (フェッチサイズ)

Integer (整数)

1 ページあたりのレコード数を指定します。

100

Batch Size (バッチサイズ)

Integer (整数)

バッチごとのページ数を指定します。

10

#### [](#設定-11)設定 [Configuration (設定)](#connection_configuration) #### [](#スロー-11)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED #### [](#get_picklists)Get Picklists `` 選択リストで設定されているすべての使用可能な値を取得します。 #### [](#パラメーター-12)パラメーター
名前 型 説明 デフォルト値 必須

Picklist Name (選択リスト名)

String (文字列)

Vault での選択可能な監査種別のリスト。

X

#### [](#設定-12)設定 [Configuration (設定)](#connection_configuration) #### [](#スロー-12)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#invoke_rest_api)Invoke REST API [Veeva Vault Rest API](https://developer.veevavault.com/api/20.1/#documents)​ を呼び出し、ヘッダーで指定されている ​**Accept**​ 値に応じて JSON (デフォルト) または XML 形式で応答を返します。 [API レート制限](https://developer.veevavault.com/docs/#api-rate-limits)​を超過しないように、REST API を個別に使用するのではなく、可能な限り一括で使用することが重要です。 #### [](#パラメーター-13)パラメーター
名前 型 説明 デフォルト値 必須

Method (メソッド)

String (文字列)

REST API を呼び出すメソッドのリスト。

GET

X

Path (パス)

String (文字列)

要求を送信する URI パス。

X

Body (本文)

Input Stream (入力ストリーム)

要求 (GET メソッド要求以外) と一緒に送信される要求メッセージの本文。

#[payload]

ヘッダー

Map (マップ)

要求と一緒に送信するキー-値形式のヘッダー。要求でヘッダーが必要ない場合は、このパラメーターを空白 (デフォルト) にしてください。

URI パラメーター

Map (マップ)

パスの値を解決するためのキー-値形式の URI パラメーター。パスに URI パラメーターがない場合は、このパラメーターを空白 (デフォルト) にしてください。

クエリパラメーター

Map (マップ)

要求と一緒に送信するキー-値形式のクエリパラメーター。要求でクエリパラメーターが必要ない場合は、このパラメーターを空白 (デフォルト) にしてください。

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

Stream (ストリーム)

ストリーミングモードで送信する要求。デフォルトでは、ペイロードの種別がストリームの場合、ストリーミングを使用して要求が送信されます。以下のオプションから選択できます。

  • ALWAYS

  • AUTO

  • NEVER

#### [](#設定-13)設定 [Configuration (設定)](#connection_configuration) #### [](#スロー-13)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#query)Query `` 指定した VQL クエリを Vault で実行し、ページ分割されたデータ入力ストリームで結果を取得します。Query 操作の後に For-Each/Splitter 要素を配置して、各レコードを順次フェッチします。 この操作では、Mule 標準ページネーションに基づくページングメカニズムが提供されます。詳細は、​[「ストリーミングおよびページネーション」](https://docs.mulesoft.com/jp/veevavault-connector/1.3/veevavault-connector-config-topics#streaming_and_pagination.adoc)​を参照してください。
VQL クエリで ​LIMIT​ と ​OFFSET​ を指定しないでください。これらのパラメーターは内部に組み込まれています。
#### [](#パラメーター-14)パラメーター
名前 型 説明 デフォルト値 必須

VQL Query (VQL クエリ)

String (文字列)

Veeva Vault の VQL 仕様に基づいて定義して実行する VQL クエリ。例: SELECT id, name​v, study​v FROM :table​。詳細は、 VQL クエリのドキュメント​を参照してください。

X

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

Map<String, Object>

文字列とオブジェクトのマップ。この中の各項目が、挿入される行を表します。マップにはパラメーター名がキーとして、バインド先のパラメーターが値として含まれます。次に例を示します。

{

'table': 'site__v'

}

#[{}]

Fetch Size (フェッチサイズ)

Integer (整数)

1 ページあたりのレコード数を指定します。

100

Batch Size (バッチサイズ)

Integer (整数)

バッチごとのページ数を指定します。

10

#### [](#設定-14)設定 [Configuration (設定)](#connection_configuration) #### [](#スロー-14)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#spark_validator)Spark Validator `` 署名と公開キーを使用して、Vault からトリガーされた Spark メッセージの検証と確認を行います。検証と確認が正常に終了したら、Spark メッセージを Mule フローでビジネス要件に従ってさらに処理できます。詳細は、 [「Spark Messaging feature and functionalities and setup (Spark メッセージングの機能およびセットアップ)」](https://developer.veevavault.com/sdk/#spark-messaging)​を参照してください。 **Spark Validator**​ 操作の結果には、Spark 属性 (省略可能) と Spark メッセージ (Vault から受信した場合) が含まれます。
Vault から Spark メッセージをトリガーする前に、Veeva Vault サポートのサポートチケットを申請して、Spark メッセージの再送信または再試行の間隔を必ず増やしてください (例: 10 秒)。デフォルトでは期間は 5 秒として設定されていますが、​Spark Validator​ 操作でメッセージの検証と確認を完了するのに必要な時間を下回っています。
Veeva Systems によると、公開キー (00001.pem) の期限は 2 年ごとに切れます。ユーザーは有効期限に関する通知を事前に受け取ります。Mule アプリケーションフローで ​Spark Validator​ 操作を使用している場合は、公開キーの有効期限後に、​[Public Key Path (公開キーのパス)]​ 項目で設定されたパスから公開キーファイルを削除する必要があります。キーの削除を実行している間に新しい公開キーが作成されます。これを行わない場合、Spark メッセージの検証が ​INVALID_SPARK_MESSAGE​ として失敗します。Spark メッセージの検証を正常に終了するには、デフォルトのパスで CloudHub にデプロイされた Mule アプリケーションを再起動する必要があります。
#### [](#パラメーター-15)パラメーター
名前 型 説明 デフォルト値 必須

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]

#### [](#設定-15)設定 [Configuration (設定)](#connection_configuration) #### [](#スロー-15)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED - VEEVAVAULT:INVALID\_SPARK\_MESSAGE - VEEVAVAULT:INVALID\_KEY\_FORMAT ### [](#update_documents)Update Documents `` CSV または JSON 形式で提供されたペイロードの編集可能なメタデータを使用して、一括ドキュメントを更新します。 #### [](#パラメーター-16)パラメーター
名前 型 説明 デフォルト値 必須

Metadata Format (メタデータ形式)

Enum (列挙) (文字列):

  • CSV

  • JSON

オブジェクトメタデータの形式。

X

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

Input Stream (入力ストリーム)

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

X

#### [](#設定-16)設定 [Configuration (設定)](#connection_configuration) #### [](#スロー-16)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ### [](#update_object_records)Update Object Records `` CSV または JSON 形式で提供されたペイロードの編集可能なオブジェクトメタデータを使用して、指定された Vault オブジェクトのオブジェクトレコードを更新します。 #### [](#パラメーター-17)パラメーター
名前 型 説明 デフォルト値 必須

Object Name (オブジェクト名)

String (文字列)

選択可能なすべての Vault オブジェクトのリスト。

X

Metadata Format (メタデータ形式)

Enum (列挙) (文字列):

  • CSV

  • JSON

オブジェクトメタデータの形式。

X

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

Input Stream (入力ストリーム)

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

X

#### [](#設定-17)設定 [Configuration (設定)](#connection_configuration) #### [](#スロー-17)スロー - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Veeva Vault Connector 1.4 Veeva Vault 用 Anypoint Connector (Veeva Vault Connector) を使用すると、Veeva Vault REST API を使用して Mule フローを Veeva Vault プラットフォームに接続できます。 設定する操作に応じて、このコネクタは [Vault REST、Bulk API、ストリーミング API](https://developer.veevavault.com/api/19.1/#authentication)​ と連動します。各 API コールは JSON 要求または CSV 要求を使用して、HTTPS 接続経由で JSON 入力ストリーム応答を返します。必要なすべてのリクエストヘッダー、エラー処理、および HTTPS 接続設定は、コネクタに組み込まれています。 互換性と解決された問題に関する情報は、「Veeva Vault Connector リリースノート」を参照してください。 ## [](#始める前に)始める前に このコネクタを使用するには、以下に精通している必要があります。 - Veeva Vault - [Vault クエリ言語 (VQL)](https://developer.veevavault.com/vql/#introduction-to-vault-queries) - Anypoint Connector - Mule Runtime Engine (Mule) - Mule フローの要素とグローバル要素 - Anypoint Studio を使用した Mule アプリケーションの作成方法 アプリケーションを作成する前に、以下が必要です。 - Veeva Vault の対象リソースにアクセスするためのログイン情報 - Anypoint Platform - Anypoint Studio バージョン 7.3.5 以降 ## [](#コネクタの一般的なユースケース)コネクタの一般的なユースケース Mule アプリケーションで Veeva Vault Connector をアウトバウンドコネクタとして使用して、次の Veeva Vault オブジェクトに対する CRUD (create、retrieve、update、delete) 操作、クエリ操作、エクスポート操作、および Spark Validator 操作を実行できます。 - ドキュメント 作成、取得、更新、削除、エクスポート - ドキュメントレンディション 作成、取得、削除 - Vault Object (Vault オブジェクト) 作成、取得、更新、削除 - 選択リスト Retrieve - 監査履歴 Retrieve - Query VQL クエリを使用して、ドキュメント、Vault オブジェクト、ワークフローを照会します。 - Spark validator Veeva Vault からトリガーされた署名付き Spark メッセージの検証と確認を行います。 - Invoke Rest API 特定のコネクタ操作が存在しない場合に、 [Veeva Vault Rest API](https://developer.veevavault.com/api/20.1/#documents)​ を呼び出します。 [API レート制限](https://developer.veevavault.com/docs/#api-rate-limits)​を超過しないように、API を個別に使用するのではなく、一括で使用してください。 ## [](#接続種別)接続種別 Veeva Vault 接続では、ログイン情報を使用して Veeva Vault インスタンスに接続し、操作を実行する基本認証種別を使用します。 認証種別の設定についての詳細は、​[「コネクタのグローバル要素の設定」](https://docs.mulesoft.com/jp/veevavault-connector/1.4/veevavault-connector-studio#configure-global-element)​を参照してください。 ## [](#exchange-テンプレートおよび例)Exchange テンプレートおよび例 [Anypoint Exchange](https://www.mulesoft.com/exchange/)​ は、アプリケーションのスタートポイントとして使用できるテンプレートと、完全なソリューションを具体的に示した例を提供しています。 Veeva Vault Connector で使用可能なテンプレートは次のとおりです。 - [File System to Veeva Vault](https://anypoint.mulesoft.com/exchange/org.mule.examples/filesystem-to-veeva-vault-template/) - [Veeva Vault からファイルシステム](https://anypoint.mulesoft.com/exchange/org.mule.examples/veevavault-connector-project-templates/) - [Spark メッセージのエンドツーエンドソリューション](https://anypoint.mulesoft.com/exchange/org.mule.examples/spark-message-solution-template/) ## [](#次のステップ)次のステップ 前提条件を満たしたら、​[Anypoint Studio](https://docs.mulesoft.com/jp/veevavault-connector/1.4/veevavault-connector-studio)​ でアプリケーションを作成してコネクタを設定できます。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Exchange を使用したコネクタ、テンプレート、およびサンプルの検出](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Veeva Vault Connector リファレンス](https://docs.mulesoft.com/jp/veevavault-connector/1.4/veevavault-connector-reference) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Veeva Vault Connector 1.4 - XML と Maven のサポート XML で Mule アプリケーションを手動でコーディングすることもできますが、Anypoint Studio を使用した方が効率的です。 - Mule Runtime Engine (Mule) アプリケーションを (Anypoint Studio の XML エディターまたはテキストエディターから) 手動でコーディングする場合、参照ステートメントを XML Mule フローと Apache Maven ​`pom.xml`​ ファイルの両方に追加することで、アプリケーションからコネクタにアクセスできます。 - Anypoint Studio でコネクタを追加すると、Studio は自動的に XML コードにコネクタの名前空間およびスキーマの場所を入力し、​`pom.xml`​ ファイルに連動関係を追加します。 ## [](#コネクタの名前空間の追加)コネクタの名前空間の追加 次のコードを設定 XML のヘッダーの ​`mule`​ タグ内に貼り付けます。 ```xml http://www.mulesoft.org/schema/mule/veevavault http://www.mulesoft.org/schema/mule/veevavault/current/mule-veevavault.xsd ``` 次の例は、XML 内に名前空間ステートメントが配置される方法を示しています。 ```xml ``` ## [](#pom-ファイルの連動関係の追加)POM ファイルの連動関係の追加 Apache Maven ​`pom.xml`​ ファイルは Anypoint Studio によって生成され、Mule アプリケーションの連動関係が含まれます。Mule アプリケーションを手動でコーディングする場合、次の XML スニペットを ​`pom.xml`​ ファイルに含めてこのコネクタにアクセスできるようにします。 ```xml org.mule.extension mule-veevavault-connector x.x.x mule-plugin ``` ``​ を使用しているコネクタに対応するバージョンに置き換えます。 最新の ​`pom.xml`​ ファイル情報を取得する手順は、次のとおりです。 1. [Anypoint Exchange](https://www.mulesoft.com/exchange/)​ に移動します。 2. Exchange で、​**\[Login (ログイン)\]**​ をクリックし、Anypoint Platform のユーザー名とパスワードを指定します。 3. Exchange で、「​`connector-template-files`​」を検索します。 4. コネクタを選択します。 5. 画面の右上付近にある ​**\[Dependency Snippets (連動関係スニペット)\]**​ をクリックします。 ## [](#次のステップ)次のステップ 名前空間および ​`pom.xml`​ ファイルを完了したら、​[例](https://docs.mulesoft.com/jp/veevavault-connector/1.4/veevavault-connector-examples)​を試すことができます。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Veeva Vault Connector 1.4 の例 次の例は、Anypoint Studio でコネクタを設定する方法を示しています。 - [Veeva Vault でのドキュメントの作成](#create-documents-on-the-vault) - [ドキュメントの詳細を取得する](#retrieve-document-details) - [ドキュメントまたはオブジェクトデータのフェッチ](#fetch-document-or-object-data) - [Spark メッセージを検証する](#validate-a-spark-message) - [REST API を呼び出して単一ドキュメントを作成する](#invoke-rest-api) ## [](#create-documents-on-the-vault)Veeva Vault でのドキュメントの作成 次の例では、外部ソース (データベース) からフェッチしたドキュメントメタデータを使用してドキュメントを一括で作成します。Veeva Vault でドキュメントを作成する前に、Veeva Vault FTP サーバーを使用してドキュメントファイルをアップロードします。ドキュメントの ​`created`​ 状況がデータベースに挿入されます。 次のスクリーンショットは、この例の Studio アプリケーションフローを示しています。 ![Create Documents 操作の Mule フロー](/mulesoft/current/ja-jp/veevavault-connector/1.4/_images/veevavault-connector-create-documents-example.png) ![Upload Documents 操作の Mule フロー](/mulesoft/current/ja-jp/veevavault-connector/1.4/_images/veevavault-connector-upload-documents-example.png) ### [](#最初のフローを作成する)最初のフローを作成する 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[HTTP\]**​ を選択して ​**\[Listener\]**​ ソースをキャンバスにドラッグします。 2. 使用する環境に応じて HTTP リスナーを設定します。 3. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Database (データベース)\]**​ を選択して ​**\[Select\]**​ 操作をキャンバスにドラッグし、テーブルからドキュメントメタデータをフェッチします。 4. 接続ログイン情報を使用するように Database Connector を設定します。 5. \[SQL Query Text (SQL クエリテキスト)\] 項目に「​`>SELECT * FROM createdocuments`​」と入力します。 6. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Flow Reference\]**​ コンポーネントをキャンバスにドラッグし、サブフロー ​`upload-files-on-vault-ftp-server`​ を参照します。 7. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[For Each\]**​ スコープを次の要素が含まれるキャンバスにドラッグします。 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Transform Message\]**​ コンポーネントをキャンバスにドラッグし、ドキュメントメタデータを CSV 形式に変換します。 2. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Veeva Vault\]**​ を選択して ​**\[Create Documents\]**​ 操作をキャンバスにドラッグします。 3. Veeva Vault 接続の次の値を入力します。 - **Username (ユーザー名)** - **Password (パスワード)** - **Vault URL** - **Vault version (Vault バージョン)** - **Vault client ID (Vault クライアント ID)** 4. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Database (データベース)\]**​ を選択して ​**\[Bulk insert\]**​ 操作をキャンバスにドラッグし、ドキュメント作成済み状況データをデータベーステーブルに挿入します。 8. 接続ログイン情報を使用するように Database Connector を設定します。 9. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグし、コンソールまたはログファイルに情報を記録します。 ### [](#2-つ目のフローを作成する)2 つ目のフローを作成する 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグし、このサブフローの情報を記録します。 2. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[For Each\]**​ スコープを次の要素が含まれるキャンバスにドラッグします。 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグします。 2. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[FTPS\]**​ を選択して ​**\[Read\]**​ 操作をキャンバスにドラッグします。 3. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグします。 4. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[FTPS\]**​ を選択して ​**\[Write\]**​ 操作をキャンバスにドラッグし、ファイルを Veeva Vault FTP サーバーに書き込みます。 3. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して別の ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグします。 4. Veeva Vault FTP サーバーのログイン情報を使用するように FTPS Connector を設定します。 ### [](#例の-xml)例の XML この例の 2 つのフローをすばやく Mule アプリケーションに読み込むには、次のコードを Studio XML エディターに貼り付けます。 ```xml SELECT * FROM createdocuments { lifecycle__v: payload01.lifecycle__v, study__v: payload01.study__v, subtype__v: payload01.subtype__v, name__v: payload01.name__v ++ '--' ++ randomInt(10000) as String, type__v: payload01.type__v, classification__v: payload01.classification__v, product__v: payload01.product__v, file: payload01.file as String }]]> { 'id': $.id as String, 'external_id__v': $.external_id__v as String, 'responseStatus': $.responseStatus }]]]> INSERT into documents (id, external_id__v, responseStatus) VALUES (:id: external_id__v, :responseStatus) ``` ## [](#retrieve-document-details)ドキュメントの詳細を取得する この例では、ドキュメント種別、サブタイプ、分類に基づいてドキュメントの詳細を取得してデータベースに保存します。 次のスクリーンショットは、この例の Studio アプリケーションフローを示しています。 ![Get Documents 操作の Mule フロー](/mulesoft/current/ja-jp/veevavault-connector/1.4/_images/veevavault-connector-get-documents-example.png) 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[HTTP\]**​ を選択して ​**\[Listener\]**​ ソースをキャンバスにドラッグします。 2. 使用する環境に応じて HTTP リスナーを設定します。 3. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Veeva Vault\]**​ を選択して ​**\[Get Documents\]**​ 操作をキャンバスにドラッグします。 4. Veeva Vault 接続の次の値を入力します。 - **Username (ユーザー名)** - **Password (パスワード)** - **Vault URL** - **Vault version (Vault バージョン)** - **Vault client ID (Vault クライアント ID)** 5. 各更新ボタンをクリックして、ドキュメント種別、サブタイプ、および分類のリストをフェッチします。 6. 各ドロップダウンリストからドキュメント種別、サブタイプ、および分類を選択します。 7. ビジネス要件に応じてドキュメントプロパティを \[Document Properties (ドキュメントプロパティ)\] リストに追加し、プロパティ名を VQL クエリに組み込んで、VQL クエリを動的にビルドします。 8. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[For Each\]**​ スコープを次の要素が含まれるキャンバスにドラッグします。 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Transform Message\]**​ コンポーネントをキャンバスにドラッグします。 2. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Database (データベース)\]**​ を選択して ​**\[Insert\]**​ 操作をキャンバスにドラッグします。 3. 接続ログイン情報を使用して、Database Connector を設定します。 9. ビジネス要件に従って、DataWeave を使用して変換を設定します。 10. データをテーブルに挿入するように ​**Insert**​ 操作を設定します。 11. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Set Payload\]**​ トランスフォーマーをキャンバスにドラッグし、トリガーソースに返すペイロードを設定します。 12. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグし、コンソールまたはログファイルに情報を記録します。 ### [](#例の-xml-2)例の XML この例のフローをすばやく Mule アプリケーションに読み込むには、次のコードを Studio XML エディターに貼り付けます。 ```xml INSERT INTO [.underline]#createdocuments# (name__v, type__v, subtype__v, classification__v, lifecycle__v, product__v, status__v, study__v, file) VALUES (:name__v, :type__v, :subtype__v, :classification__v, :lifecycle__v, :product__v, :status__v, :study__v, :file) ``` ## [](#fetch-document-or-object-data)ドキュメントまたはオブジェクトデータのフェッチ この例では、VQL クエリを使用して Veeva Vault からドキュメントまたはオブジェクトデータをフェッチします。 次のスクリーンショットは、この例の Studio アプリケーションフローを示しています。 ![Query 操作の Mule フロー](/mulesoft/current/ja-jp/veevavault-connector/1.4/_images/veevavault-connector-query-example.png) 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[HTTP\]**​ を選択して ​**\[Listener\]**​ ソースをキャンバスにドラッグします。 2. 使用する環境に応じて HTTP リスナーを設定します。 3. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Veeva Vault\]**​ を選択して ​**\[Query\]**​ 操作をキャンバスにドラッグします。 4. Veeva Vault 接続の次の値を入力します。 - **Username (ユーザー名)** - **Password (パスワード)** - **Vault URL** - **Vault version (Vault バージョン)** - **Vault client ID (Vault クライアント ID)** 5. ビジネス要件に従って VQL クエリを定義します。 6. VQL クエリで使用する場合は、入力プレースホルダーを追加して、実行時に VQL で動的に組み込みます。 7. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[For Each\]**​ スコープを次の要素が含まれるキャンバスにドラッグします。 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Transform Message\]**​ コンポーネントをキャンバスにドラッグします。 2. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[File (ファイル)\]**​ を選択して ​**\[Write\]**​ 操作をキャンバスにドラッグします。 8. ビジネス要件に従って、DataWeave を使用して変換を設定します。 9. 作業ファイルのパスを使用して、File Connector を設定します。 10. 指定したファイルにペイロードデータを書き込むように ​**Write**​ 操作を設定します。 11. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Set Payload\]**​ トランスフォーマーをキャンバスにドラッグし、トリガーソースに返すペイロードを設定します。 12. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグし、コンソールまたはログファイルに情報を記録します。 ### [](#例の-xml-3)例の XML この例のフローをすばやく Mule アプリケーションに読み込むには、次のコードを Studio XML エディターに貼り付けます。 ```xml SELECT id, name__v, type__v, subtype__v, classification__v, lifecycle__v, status__v, study__v, product__v from :table WHERE name__v= 'F22611234--6764' ``` ## [](#validate-a-spark-message)Spark メッセージを検証する この例では、Veeva Vault の Spark メッセージをトリガーし、Spark メッセージを検証します。 次のスクリーンショットは、この例の Studio アプリケーションフローを示しています。 ![Spark Validator 操作の Mule フロー](/mulesoft/current/ja-jp/veevavault-connector/1.4/_images/veevavault-connector-spark-validator-example.png) 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[HTTP\]**​ を選択して ​**\[Listener\]**​ ソースをキャンバスにドラッグします。 2. HTTP Connector 用の JKS 証明書には、Veeva Vault との TLS 接続を介して Spark メッセージを受信するための HTTP リスナー用の ​`.jks`​ ファイルが必要です。 次の手順は、​`/bin`​ ディレクトリにある Java Keytool を使用して ​`.jks`​ ファイルを作成する方法を示しています。 3. `/bin`​ ディレクトリから次のコマンドを実行します。 ​\`keytool -genkey -keyalg RSA -alias mule -keystore spark-listener.jks -storepass password -validity 360 -keysize 2048\` これにより、現在のディレクトリに ​\`spark-listener.jks\`​ ファイルが作成されます。 4. `src/main/resources`​ プロジェクトディレクトリの ​`spark-listener.jks`​ ファイルをコピーしてインポートします。 5. HTTP リスナーを次のように設定します。 1. **\[General (一般)\]**​ タブで、次のように設定します。 - Protocol (プロトコル): HTTPS - Host (ホスト): 0.0.0.0 - Port (ポート): 8082 2. **\[TLS\]**​ タブで、次のように設定します。 - 型: JKS - Path (パス): spark-listener.jks - Alias (別名): mule - Key Password (キーパスワード): password - Password (パスワード): password 6. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Veeva Vault\]**​ を選択して ​**\[Spark Validator\]**​ 操作をキャンバスにドラッグします。 7. Veeva Vault 接続の次の値を入力します。 - **Username (ユーザー名)** - **Password (パスワード)** - **Vault URL** - **Vault version (Vault バージョン)** - **Vault client ID (Vault クライアント ID)** 8. **Spark Validator**​ パラメーターを次のように設定します。 - Include Spark Header (Spark ヘッダーを含める): `FALSE` - Public Key Path (公開キーのパス): `${file.keyPath}` 公開キーファイル (00001.pem) の保存場所へのパスを使用して、​`configuration.yaml`​ の ​`file.keyPath`​ プロパティを定義します。 - Spark Headers (Spark ヘッダー): `#[attributes.headers]` - Spark Message (Spark メッセージ): `#[payload]` 9. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Set Payload\]**​ 操作をキャンバスにドラッグし、​**\[Value (値)\]**​ 項目で次のように定義します。 \---- output application/json --- { "payload" : payload, "attributes": attributes } ---- 10. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグし、次のメッセージを使用してペイロードを記録します。 Spark Message :: #\[payload\] ### [](#例の-xml-4)例の XML この例のフローをすばやく Mule アプリケーションに読み込むには、次のコードを Studio XML エディターに貼り付けます。 ```xml ``` ## [](#invoke-rest-api)REST API を呼び出して単一ドキュメントを作成する この例では、REST API を呼び出して、単一ドキュメントを作成します。 次のスクリーンショットは、この例の Studio アプリケーションフローを示しています。 ![Invoke REST API 操作の Mule フロー](/mulesoft/current/ja-jp/veevavault-connector/1.4/_images/veevavault-connector-invoke-rest-api-example.png)
Veeva Vault REST API を呼び出すには、要件に従ってパラメーターを設定する必要があります。
1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[HTTP\]**​ を選択して ​**\[Listener\]**​ ソースをキャンバスにドラッグします。 2. 使用する環境に応じて HTTP リスナーを設定します。 3. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[File (ファイル)\]**​ を選択して ​**\[Read\]**​ 操作をキャンバスにドラッグし、Veeva Vault ドキュメントに関連付けられたファイルのコンテンツから読み取るようにファイルパスを設定します。 4. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Veeva Vault\]**​ を選択して ​**\[Invoke REST API\]**​ 操作をキャンバスにドラッグします。 5. Veeva Vault 接続の次の値を入力します。 - **Username (ユーザー名)** - **Password (パスワード)** - **Vault URL** - **Vault version (Vault バージョン)** - **Vault client ID (Vault クライアント ID)** 6. POST 要求を設定します。 Method: POST, Path: "/objects/documents", Headers: Key: "Accept" Value: "application/json" Key: "Content-Type" Value: "multipart/form-data; boundary=abcdefg" URI Parameters: Leave it empty. Query Parameters: Leave it empty. %dw 2.0 output multipart/form-data boundary='abcdefg' --- { parts: { file: { headers: { "Content-Disposition": { "name": "file", "filename": attributes.fileName }, "Content-Type": payload.^mimeType }, content : payload }, name\_\_v: { headers: { }, content: 'Test Document' }, type\_\_v: { headers: { }, content: 'Trial Management' }, subtype\_\_v: { headers: { }, content: 'Meetings' }, classification\_\_v: { headers: { }, content: 'Kick-off Meeting Material' }, lifecycle\_\_v: { headers: { }, content: 'Base Doc Lifecycle' }, study\_\_v: { headers: { }, content: '0ST000000000301' }, comments\_\_c: { headers: { }, content: 'Test Document' } } } 7. PUT 要求を設定します。 Method: PUT, Path: "/objects/documents/{doc\_id}", Headers: Key: "Accept" Value: "application/json" Key: "Content-Type" Value: "application/x-www-form-urlencoded" URI Parameters: Key: "doc\_id" Value: "259592" Query Parameters: Leave it empty. %dw 2.0 output application/x-www-form-urlencoded --- { "id": "259592", "name\_\_v": "Kick-off Meeting Material Updated", "product\_\_v": "00P000000000403", "study\_\_v": "0ST000000000202", "notes\_\_v": "Notes Updated" } 8. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグし、次のメッセージを使用してペイロードを記録します。 Invoke Veeva API response :: #\[payload\] ### [](#例の-xml-5)例の XML この例のフローをすばやく Mule アプリケーションに読み込むには、次のコードを Studio XML エディターに貼り付けます。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Veeva Vault Connector 1.4 の追加設定情報 ## [](#invoke_rest_api)Invoke Rest API **Invoke Rest API**​ 操作は、リクエストボディとして Mule メッセージペイロードを送信します。 リクエストボディに加えて、DataWeave スクリプトまたは式を使用して以下を設定できます。 - [Header (ヘッダー)](#headers) - [URI Parameters (URI パラメーター)](#uri-parameters) - [Query Parameters (クエリパラメーター)](#query-parameters) ### [](#headers)ヘッダーを設定する 1. Anypoint Studio で、​**\[General (一般)\] > \[Request (要求)\] > \[Query Parameters (クエリパラメーター)\]**​ に移動します。 2. プラスアイコン (+) をクリックしてヘッダーを要求に追加します。 たとえば、DataWeave 式を使用して、ヘッダー名 ​`HeaderName1`​ および ​`HeaderName2`​ とヘッダー値 ​`HeaderValue1`​ および ​`HeaderValue2`​ を追加します。 #\[{'HeaderName1' : 'HeaderValue1', 'HeaderName2' : 'HeaderValue2'}\]. ### [](#uri-parameters)URI パラメーターを設定する 要求のパスにプレースホルダー (​`/objects/documents/{doc_id}`​ など) を使用する場合は、URI パラメーターを設定します。 1. Anypoint Studio で、​**\[Path (パス)\]**​ 項目にプレースホルダーを中括弧で囲んで入力します。 2. **\[URI Parameters (URI パラメーター)\]**​ を選択します。 3. プラス記号 (+) をクリックして、名前と値を入力します。 ### [](#query-parameters)クエリパラメーターを設定する 1. Anypoint Studio で、​**\[General (一般)\] > \[Request (要求)\] > \[Query Parameters (クエリパラメーター)\]**​ に移動します。 2. プラスアイコン (+) をクリックして、パラメーターを要求に追加します。パラメーターの名前と値を入力するか、DataWeave 式を使用して名前と値を定義します。 #### [](#post-要求での-form-フォーム-パラメーターの送信)POST 要求での form (フォーム) パラメーターの送信 POST 要求でパラメーターを送信する方法: 1. **\[General (一般)\] > \[Request (要求)\]**​ で、​**POST**​ メソッドを選択します。 2. **\[Body (本文)\]**​ に、Mule メッセージのペイロードを入力します。 1. **application/x-www-form-urlencoded**​ などで送信するパラメーターの名前と値を入力します。 #\[output application/x-www-form-urlencoded --- {'key1':'value1', 'key2':'value2'}\] 2. **multipart/form-data**​ で、​**Content-Type**​ 値に DataWeave 出力と同じ境界属性値が含まれていることを確認してください。例: `multipart/form-data; boundary=abcdefg`​。 %dw 2.0 output multipart/form-data boundary='abcdefg' --- { parts: { file: { headers: { "Content-Disposition": { "name": "file", "filename": attributes.fileName }, "Content-Type": payload.^mimeType }, content : payload }, name\_\_v: { headers: { }, content: 'Test Document' }, type\_\_v: { headers: { }, content: 'Trial Management' }, subtype\_\_v: { headers: { }, content: 'Meetings' }, classification\_\_v: { headers: { }, content: 'Kick-off Meeting Material' }, lifecycle\_\_v: { headers: { }, content: 'Base Doc Lifecycle' }, study\_\_v: { headers: { }, content: '0ST000000000301' }, comments\_\_c: { headers: { }, content: 'Test Document' } } } ## [](#connector_operations_success_and_failure_response)コネクタ操作の SUCCESS および FAILURE 応答 Veeva Vault Connector 操作の応答は、Veeva Vault API の成功または失敗応答とエラーに基づきます。 コネクタは ​`SUCCESS`​ 応答を ​`HIGH LEVEL`​ で返し、​`SUCCESS`​ または ​`FAILURE`​ を ​`LOW LEVEL`​ で返します。つまり、コネクタ操作が正常に終了しても、要求に渡された関連のない一部のデータのために一部のドキュメントまたはオブジェクトレコードの作成または更新が失敗していることがあります。 ### [](#例)例 **SUCCESS を含む SUCCESS 応答**​: { "responseStatus": "SUCCESS", "data": \[{ "id": 239026, "name\_\_v": "E22611234--38483", "responseStatus": "SUCCESS" }, { "id": 239025, "name\_\_v": "Kick-off Meeting Material Updated12341234--81032", "responseStatus": "SUCCESS" } \] } **FAILURE を含む SUCCESS 応答**​: { "data": \[ { "external\_id\_\_v": "TEST-238924", "rendition\_type\_\_v": "imported\_rendition\_\_c", "id": 238924, "responseStatus": "FAILURE", "minor\_version\_number\_\_v": 1, "errors": \[ { "type": "INVALID\_DATA", "message": "Document not found \[238924/0/1\]." } \], "major\_version\_number\_\_v": 0 }, { "external\_id\_\_v": "TEST-238925", "rendition\_type\_\_v": "imported\_rendition\_\_c", "id": 238925, "responseStatus": "FAILURE", "minor\_version\_number\_\_v": 1, "errors": \[ { "type": "INVALID\_DATA", "message": "Document not found \[238925/0/1\]." } \], "major\_version\_number\_\_v": 0 } \], "responseStatus": "SUCCESS" } Veeva Vault API で ​`FAILURE`​ 応答が返されると、Veeva Vault Connector 操作で例外がスローされます。次に例を示します。 **ERROR を含む FAILURE 応答** { "responseStatus": "FAILURE", "errors": \[ { "type": "INVALID\_DATA", "message": "Unknown relationship \[reviewer\_\_v\]" } \] } Veeva Vault API から ​`FAILURE`​ 応答を受信すると、コネクタ操作で例外がスローされ、Mule フロー内の ​**Error Handling**​ コンポーネントでキャッチされます。 \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* Message : An error occurred from the Veeva Vault API. Error Code: INVALID\_DATA. Original Error Message: Unknown relationship \[reviewer\_\_v\]. Error type : VEEVAVAULT:INVALID\_DATA \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* **Error Handling**​ コンポーネントでキャッチされるエラーコードを次に示します。 - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ## [](#streaming_and_pagination)ストリーミングおよびページネーション **Download Document**​ を除くすべてのコネクタ操作で、操作の出力に基づく各結果を含むペイロードとして入力ストリームが返されます。このため、デフォルトでは、Mule ではストリーミング戦略が適用されます。詳細は、​[Mule ストリーミング戦略](https://docs.mulesoft.com/mule-runtime/latest/streaming-about)​を参照してください。ストリーミング戦略の設定項目は、コネクタ操作の ​**\[Advanced (詳細)\]**​ タブにあります。 ![image](/mulesoft/current/ja-jp/veevavault-connector/1.4/_images/veevavault-connector-streaming-pagination.png) コネクタ内の次の操作では、Mule 標準ページネーションに基づくページネーションメカニズムが提供されます。 - **Get Documents** - **Get Object Records** - **Query** - **Get Audit Details** ページ分割操作を使用していますが、各オブジェクトを取得するには必ず ​`For-Each/Splitter`​ 要素を含めてください。ページネーション操作には、​**\[Fetch Size (フェッチサイズ)\]**​ 項目と ​**\[Batch Size (バッチサイズ)\]**​ 項目があります。 - **Fetch Size (フェッチサイズ)**​ 1 つのページで取得できるレコードの制限数。操作は、フェッチサイズの数の JSON オブジェクトレコードを含むページを返します。 場合によって、Veeva API でレコードサイズに基づいてフェッチサイズ (各ページのレコード数) が自動計算され、その計算で標準レコードサイズを超えることがあります。操作は、各ページで計算されたレコード数を返します。 - **Batch Size (バッチサイズ)**​ 各バッチで返されるページの数。各ページには、フェッチサイズの数のレコードが含まれます。操作はバッチごとに多数のレコード (JSON 形式のメタデータ) を返し、計算は次の例のように行われます。 Fetch Size set as \*1000\* Batch Size set as \*10\* If the total records in the vault are \*100,000\*, then: Number of pages = Total records/Fetch Size = 100000/1000 = 100 pages. Number of pages per batch = Number of pages/Batch Size = 100/10 = 10 pages per batch. Number of Records per batch = Number of pages per batch \* Fetch Size = 10 \* 1000 = 10,000 records. Therefore, the number of records returned per batch would be 10,000 records. 反復可能ストリームはバッファサイズをバイト単位で測定します。オブジェクトを処理するときに、ランタイムはインスタンス数を使用してバッファサイズを測定します。 反復不可能ストリームの、コネクタ操作では、ストリームはバッチごとのレコード数として返されます。反復可能ストリームでは、すべてのレコードが一度に返されるため、反復可能自動ページングでメモリ内のバッファサイズを計算する場合は、メモリ不足にならないように、各インスタンスが使用するメモリ量を見積もる必要があります。 ## [](#次のステップ)次のステップ コネクタの設定が完了したら、​[例](https://docs.mulesoft.com/jp/veevavault-connector/1.4/veevavault-connector-examples)​を試すことができます。 ## [](#関連情報)関連情報 - [Veeva Vault Connector リファレンス](https://docs.mulesoft.com/jp/veevavault-connector/1.4/veevavault-connector-reference) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Veeva Vault Connector 1.4 リファレンス ## [](#config)設定 Veeva Vault Connector のデフォルト設定。
名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

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

x

Connection (接続)

この設定の接続種別。

x

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

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

### [](#config_basic-connection)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 (再接続)

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

### [](#config_oauth2-oidc-connection)OAuth 2.0/Open ID Connection Provider (OAuth 2.0/Open ID 接続プロバイダー) Unresolved include directive in modules/ROOT/pages/veevavault-connector-reference.adoc - include::connectors::partial$oauth2-description.adoc\[\] OpenID プロバイダーを認証し、発行されたアクセストークンを Veeva セッション ID と交換します。 この接続種別を設定する方法の詳細は、​[「OAuth 2.0/Open ID 接続プロバイダー」](https://docs.mulesoft.com/jp/veevavault-connector/1.4/veevavault-connector-studio#oauth2-oidc-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

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 スコープ。この値のデフォルトはアノテーションのスコープです。

openid ​offline_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](#createDocumentRenditions) - [Create Documents](#createDocuments) - [Create Object Records](#createObjectRecords) - [Delete Document Renditions](#deleteDocumentRenditions) - [Delete Documents](#deleteDocuments) - [Delete Object Records](#deleteObjectRecords) - [Export Documents](#exportDocuments) - [Get Audit Details](#getAuditDetails) - [Get Document Renditions Types](#getDocumentRenditionsTypes) - [Get Documents](#getDocuments) - [Get Object Records](#getObjectRecords) - [Get Picklists](#getPicklists) - [Invoke REST API](#invokeRestApi) - [Query](#query) - [Spark Validator](#sparkMessageValidator) - [Unauthorize](#unauthorize) - [Update Documents](#updateDocuments) - [Update Object Records](#updateObjectRecords) ### [](#createDocumentRenditions)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 (バイナリ)

#### [](#関連する設定)関連する設定 - [設定](#config) #### [](#スロー)スロー - 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 ### [](#createDocuments)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 (再接続戦略)

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

#### [](#出力-2)出力

型

Binary (バイナリ)

#### [](#関連する設定-2)関連する設定 - [設定](#config) #### [](#スロー-2)スロー - 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 ### [](#createObjectRecords)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 (再接続戦略)

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

#### [](#出力-3)出力

型

Binary (バイナリ)

#### [](#関連する設定-3)関連する設定 - [設定](#config) #### [](#スロー-3)スロー - 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 ### [](#deleteDocumentRenditions)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 (再接続戦略)

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

#### [](#出力-4)出力

型

Binary (バイナリ)

#### [](#関連する設定-4)関連する設定 - [設定](#config) #### [](#スロー-4)スロー - 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 ### [](#deleteDocuments)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 (再接続戦略)

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

#### [](#出力-5)出力

型

Binary (バイナリ)

#### [](#関連する設定-5)関連する設定 - [設定](#config) #### [](#スロー-5)スロー - 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 ### [](#deleteObjectRecords)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 (再接続戦略)

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

#### [](#出力-6)出力

型

Binary (バイナリ)

#### [](#関連する設定-6)関連する設定 - [設定](#config) #### [](#スロー-6)スロー - 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 ### [](#exportDocuments)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 (再接続戦略)

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

#### [](#出力-7)出力

型

Binary (バイナリ)

#### [](#関連する設定-7)関連する設定 - [設定](#config) #### [](#スロー-7)スロー - 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 ### [](#getAuditDetails)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 (再接続戦略)

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

#### [](#出力-8)出力

型

[Binary] ペイロードおよび [Void] 属性のメッセージの配列。

#### [](#関連する設定-8)関連する設定 - [設定](#config) #### [](#スロー-8)スロー - 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 ### [](#getDocumentRenditionsTypes)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 (再接続戦略)

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

#### [](#出力-9)出力

型

Binary (バイナリ)

#### [](#関連する設定-9)関連する設定 - [設定](#config) #### [](#スロー-9)スロー - 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 ### [](#getDocuments)Get Documents `` Veeva Vault からドキュメントの詳細を取得します。次のいずれかを実行できます。 - ドキュメントプロパティ (ドキュメント種別、サブタイプ、分類) を指定して、ドキュメントの詳細を取得します。 ドキュメントプロパティが指定されている場合、​**Get Documents**​ 操作によって VQL クエリが動的にビルドされます。その後、この VQL クエリが Vault で実行され、ドキュメントの詳細が取得されます。 - ドキュメントプロパティ (ドキュメント種別、サブタイプ、分類) をフェッチして、ドキュメントの詳細を取得します。 ドキュメントプロパティが指定されていない場合、​`/api/{version}/metadata/objects/documents/properties`​ を使用してドキュメントプロパティメタデータがフェッチされ、​**\[Document Properties (ドキュメントプロパティ)\]**​ リストに追加または挿入されたドキュメントメタデータプロパティに基づいて VQL クエリがビルドされます。メタデータプロパティが指定されていない場合、クエリ可能なすべてのドキュメントプロパティが VQL クエリで使用および実行されます。 この操作の後に For-Each/Splitter 要素を配置して、各ドキュメントのデータ (ページ) を順次フェッチします。 この操作では、Mule 標準ページネーションに基づくページングメカニズムが提供されます。詳細は、​[「ストリーミングおよびページネーション」](https://docs.mulesoft.com/jp/veevavault-connector/1.4/veevavault-connector-config-topics#streaming_and_pagination.adoc)​を参照してください。
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

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

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

Type (型)

String (文字列)

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

SubType

String (文字列)

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

Classification (分類)

String (文字列)

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

ドキュメントプロパティ

Array of 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 (再接続戦略)

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

#### [](#出力-10)出力

型

[Binary] ペイロードおよび [Void] 属性のメッセージの配列。

#### [](#関連する設定-10)関連する設定 - [設定](#config) #### [](#スロー-10)スロー - 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 ### [](#getObjectRecords)Get Object Records `` オブジェクトメタデータ項目を使用してオブジェクトレコードの詳細を取得し、VQL クエリを動的にビルドして Vault で実行し、オブジェクトの詳細を取得します。この操作の後に For-Each/Splitter 要素を配置して、各オブジェクトレコード (ページ) を順次フェッチします。 この操作では、Mule 標準ページネーションに基づくページングメカニズムが提供されます。詳細は、​[「ストリーミングおよびページネーション」](https://docs.mulesoft.com/jp/veevavault-connector/1.4/veevavault-connector-config-topics#streaming_and_pagination.adoc)​を参照してください。
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Object Name (オブジェクト名)

String (文字列)

オブジェクト名。

x

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

Array of 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 (再接続戦略)

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

#### [](#出力-11)出力

型

[Binary] ペイロードおよび [Void] 属性のメッセージの配列。

#### [](#関連する設定-11)関連する設定 - [設定](#config) #### [](#スロー-11)スロー - 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 ### [](#getPicklists)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 (再接続戦略)

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

#### [](#出力-12)出力

型

Binary (バイナリ)

#### [](#関連する設定-12)関連する設定 - [設定](#config) #### [](#スロー-12)スロー - 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 ### [](#invokeRestApi)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 (再接続戦略)

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

#### [](#出力-13)出力

型

Binary (バイナリ)

Attributes Type (属性型)

#### [](#関連する設定-13)関連する設定 - [設定](#config) #### [](#スロー-13)スロー - 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)Query `` 指定した VQL クエリを Vault で実行し、ページ分割されたデータ入力ストリームで結果を取得します。Query 操作の後に For-Each/Splitter 要素を配置して、各レコードを順次フェッチします。 この操作では、Mule 標準ページネーションに基づくページングメカニズムが提供されます。詳細は、​[「ストリーミングおよびページネーション」](https://docs.mulesoft.com/jp/veevavault-connector/1.4/veevavault-connector-config-topics#streaming_and_pagination.adoc)​を参照してください。
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 (再接続戦略)

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

#### [](#出力-14)出力

型

[Binary] ペイロードおよび [Void] 属性のメッセージの配列。

#### [](#関連する設定-14)関連する設定 - [設定](#config) #### [](#スロー-14)スロー - 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 ### [](#sparkMessageValidator)Spark Validator `` 署名と公開キーを使用して、Vault からトリガーされた Spark メッセージの検証と確認を行います。検証と確認が正常に終了したら、Spark メッセージを Mule フローでビジネス要件に従ってさらに処理できます。詳細は、 [「Spark Messaging feature and functionalities and setup (Spark メッセージングの機能およびセットアップ)」](https://developer.veevavault.com/sdk/#spark-messaging)​を参照してください。 **Spark Validator**​ 操作の結果には、Spark 属性 (省略可能) と Spark メッセージ (Vault から受信した場合) が含まれます。
Vault から Spark メッセージをトリガーする前に、Veeva Vault サポートのサポートチケットを申請して、Spark メッセージの再送信または再試行の間隔を必ず増やしてください (例: 10 秒)。デフォルトでは期間は 5 秒として設定されていますが、​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 (再接続戦略)

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

#### [](#出力-15)出力

型

Binary (バイナリ)

Attributes Type (属性型)

Object (オブジェクト)

#### [](#関連する設定-15)関連する設定 - [設定](#config) #### [](#スロー-15)スロー - 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)Unauthorize `` 特定のリソースオーナー ID のアクセストークン情報をすべて削除して、認証ダンスを再度実行しない限り、そのユーザー向けの操作を実行できないようにします。
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

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

String (文字列)

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

#### [](#関連する設定-16)関連する設定 - [設定](#config) ### [](#updateDocuments)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 (再接続戦略)

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

#### [](#出力-16)出力

型

Binary (バイナリ)

#### [](#関連する設定-17)関連する設定 - [設定](#config) #### [](#スロー-16)スロー - 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 ### [](#updateObjectRecords)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 (再接続戦略)

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

#### [](#出力-17)出力

型

Binary (バイナリ)

#### [](#関連する設定-18)関連する設定 - [設定](#config) #### [](#スロー-17)スロー - 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-再接続)Reconnection (再接続) 操作の再接続戦略を設定します。
項目 Type (型) 説明 デフォルト値 必須

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

Boolean (ブール)

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

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

### [](#reconnect)Reconnect (再接続) 標準再接続戦略を設定し、再接続の頻度と、コネクタソースまたは操作で実行できる再接続の試行回数を指定します。
項目 Type (型) 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

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

Count (数)

Number (数値)

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

### [](#reconnect-forever)Reconnect Forever (繰り返し再接続) Mule アプリケーションが実行されている間はコネクタソースや操作によって指定された頻度で再接続が試行される Forever 再接続戦略を設定します。
項目 Type (型) 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

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

### [](#ExpirationPolicy)Expiration Policy (有効期限ポリシー) 有効期限ポリシー戦略を設定します。
項目 Type (型) 説明 デフォルト値 必須

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

Number (数値)

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

Time Unit (時間単位)

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

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

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

### [](#repeatable-in-memory-stream)Repeatable In Memory Stream (反復可能なメモリ内ストリーム) データが最大バッファサイズを超えた場合に要求が失敗するメモリ内ストリーミング戦略を設定します。ユースケースで最適なバッファサイズは、必ずパフォーマンステストを実施して決めてください。
項目 Type (型) 説明 デフォルト値 必須

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)Repeatable File Store Stream (反復可能なファイルストアストリーム) 反復可能なファイルストアストリーミング戦略を設定します。この戦略では、ストリームコンテンツの一部がメモリ内に格納されます。ストリームのコンテンツが、設定されたバッファサイズよりも大きい場合、Mule はバッファのコンテンツをディスクにバックアップしてからメモリをクリアします。
項目 Type (型) 説明 デフォルト値 必須

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

Number (数値)

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

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

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

Buffer Unit (バッファ単位)

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

  • BYTE (バイト)

  • KB

  • MB

  • GB

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

### [](#repeatable-in-memory-iterable)Repeatable In Memory Iterable (反復可能なメモリ内イテラブル) 反復可能なメモリ内イテラブル型を設定します。
項目 Type (型) 説明 デフォルト値 必須

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)Repeatable File Store Iterable (反復可能なファイルストアイテラブル) ファイルストアイテラブル型を設定します。
項目 Type (型) 説明 デフォルト値 必須

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

Number (数値)

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

Buffer Unit (バッファ単位)

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

  • BYTE (バイト)

  • KB

  • MB

  • GB

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

### [](#HttpResponseAttributes)HTTP Response Attributes (HTTP 応答属性) 設定の HTTP 応答属性を設定します。
項目 Type (型) 説明 デフォルト値 必須

Status Code (状況コード)

Number (数値)

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

x

Reason Phrase (理由を示す語句)

String (文字列)

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

x

Headers (ヘッダー)

Object (オブジェクト)

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

x

### [](#burst-api-limit-config)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 レート制限ヘッダー)」](https://developer.veevavault.com/docs/#api-rate-limits)​を参照してください。
項目 Type (型) 説明 デフォルト値 必須

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)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 レート制限ヘッダー)」](https://developer.veevavault.com/docs/#api-rate-limits)​を参照してください。
項目 Type (型) 説明 デフォルト値 必須

API 制限

Number (数値)

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

10000

## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Veeva Vault Connector 1.5 Veeva Vault 用 Anypoint Connector (Veeva Vault Connector) を使用すると、Veeva Vault REST API を使用して Mule フローを Veeva Vault プラットフォームに接続できます。 設定する操作に応じて、このコネクタは [Vault REST、Bulk API、ストリーミング API](https://developer.veevavault.com/api/19.1/#authentication)​ と連動します。各 API コールは JSON 要求または CSV 要求を使用して、HTTPS 接続経由で JSON 入力ストリーム応答を返します。必要なすべてのリクエストヘッダー、エラー処理、および HTTPS 接続設定は、コネクタに組み込まれています。 互換性と解決された問題に関する情報は、「Veeva Vault Connector リリースノート」を参照してください。 ## [](#始める前に)始める前に このコネクタを使用するには、以下に精通している必要があります。 - Veeva Vault - [Vault クエリ言語 (VQL)](https://developer.veevavault.com/vql/#introduction-to-vault-queries) - Anypoint Connector - Mule Runtime Engine (Mule) - Mule フローの要素とグローバル要素 - Anypoint Studio を使用した Mule アプリケーションの作成方法 アプリケーションを作成する前に、以下が必要です。 - Veeva Vault の対象リソースにアクセスするためのログイン情報 - Anypoint Platform - Anypoint Studio バージョン 7.3.5 以降 ## [](#コネクタの一般的なユースケース)コネクタの一般的なユースケース Mule アプリケーションで Veeva Vault Connector をアウトバウンドコネクタとして使用して、次の Veeva Vault オブジェクトに対する CRUD (create、retrieve、update、delete) 操作、クエリ操作、エクスポート操作、および Spark Validator 操作を実行できます。 - ドキュメント 作成、取得、更新、削除、エクスポート - ドキュメントレンディション 作成、取得、削除 - Vault Object (Vault オブジェクト) 作成、取得、更新、削除 - 選択リスト Retrieve - 監査履歴 Retrieve - Query VQL クエリを使用して、ドキュメント、Vault オブジェクト、ワークフローを照会します。 - Spark validator Veeva Vault からトリガーされた署名付き Spark メッセージの検証と確認を行います。 - Invoke Rest API 特定のコネクタ操作が存在しない場合に、 [Veeva Vault Rest API](https://developer.veevavault.com/api/20.1/#documents)​ を呼び出します。 [API レート制限](https://developer.veevavault.com/docs/#api-rate-limits)​を超過しないように、API を個別に使用するのではなく、一括で使用してください。 ## [](#接続種別)接続種別 Veeva Vault 接続では、ログイン情報を使用して Veeva Vault インスタンスに接続し、操作を実行する基本認証種別を使用します。 認証種別の設定についての詳細は、​[「コネクタのグローバル要素の設定」](https://docs.mulesoft.com/jp/veevavault-connector/latest/veevavault-connector-studio#configure-global-element)​を参照してください。 ## [](#exchange-テンプレートおよび例)Exchange テンプレートおよび例 [Anypoint Exchange](https://www.mulesoft.com/exchange/)​ は、アプリケーションのスタートポイントとして使用できるテンプレートと、完全なソリューションを具体的に示した例を提供しています。 Veeva Vault Connector で使用可能なテンプレートは次のとおりです。 - [File System to Veeva Vault](https://anypoint.mulesoft.com/exchange/org.mule.examples/filesystem-to-veeva-vault-template/) - [Veeva Vault からファイルシステム](https://anypoint.mulesoft.com/exchange/org.mule.examples/veevavault-connector-project-templates/) - [Spark メッセージのエンドツーエンドソリューション](https://anypoint.mulesoft.com/exchange/org.mule.examples/spark-message-solution-template/) ## [](#次のステップ)次のステップ 前提条件を満たしたら、​[Anypoint Studio](https://docs.mulesoft.com/jp/veevavault-connector/latest/veevavault-connector-studio)​ でアプリケーションを作成してコネクタを設定できます。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Exchange を使用したコネクタ、テンプレート、およびサンプルの検出](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Veeva Vault Connector リファレンス](https://docs.mulesoft.com/jp/veevavault-connector/latest/veevavault-connector-reference) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Veeva Vault Connector 1.5 - XML と Maven のサポート XML で Mule アプリケーションを手動でコーディングすることもできますが、Anypoint Studio を使用した方が効率的です。 - Mule Runtime Engine (Mule) アプリケーションを (Anypoint Studio の XML エディターまたはテキストエディターから) 手動でコーディングする場合、参照ステートメントを XML Mule フローと Apache Maven ​`pom.xml`​ ファイルの両方に追加することで、アプリケーションからコネクタにアクセスできます。 - Anypoint Studio でコネクタを追加すると、Studio は自動的に XML コードにコネクタの名前空間およびスキーマの場所を入力し、​`pom.xml`​ ファイルに連動関係を追加します。 ## [](#コネクタの名前空間の追加)コネクタの名前空間の追加 次のコードを設定 XML のヘッダーの ​`mule`​ タグ内に貼り付けます。 ```xml http://www.mulesoft.org/schema/mule/veevavault http://www.mulesoft.org/schema/mule/veevavault/current/mule-veevavault.xsd ``` 次の例は、XML 内に名前空間ステートメントが配置される方法を示しています。 ```xml ``` ## [](#pom-ファイルの連動関係の追加)POM ファイルの連動関係の追加 Apache Maven ​`pom.xml`​ ファイルは Anypoint Studio によって生成され、Mule アプリケーションの連動関係が含まれます。Mule アプリケーションを手動でコーディングする場合、次の XML スニペットを ​`pom.xml`​ ファイルに含めてこのコネクタにアクセスできるようにします。 ```xml org.mule.extension mule-veevavault-connector x.x.x mule-plugin ``` ``​ を使用しているコネクタに対応するバージョンに置き換えます。 最新の ​`pom.xml`​ ファイル情報を取得する手順は、次のとおりです。 1. [Anypoint Exchange](https://www.mulesoft.com/exchange/)​ に移動します。 2. Exchange で、​**\[Login (ログイン)\]**​ をクリックし、Anypoint Platform のユーザー名とパスワードを指定します。 3. Exchange で、「​`connector-template-files`​」を検索します。 4. コネクタを選択します。 5. 画面の右上付近にある ​**\[Dependency Snippets (連動関係スニペット)\]**​ をクリックします。 ## [](#次のステップ)次のステップ 名前空間および ​`pom.xml`​ ファイルを完了したら、​[例](https://docs.mulesoft.com/jp/veevavault-connector/latest/veevavault-connector-examples)​を試すことができます。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Veeva Vault Connector 1.5 の例 次の例は、Anypoint Studio でコネクタを設定する方法を示しています。 - [Veeva Vault でのドキュメントの作成](#create-documents-on-the-vault) - [ドキュメントの詳細を取得する](#retrieve-document-details) - [ドキュメントまたはオブジェクトデータのフェッチ](#fetch-document-or-object-data) - [Spark メッセージを検証する](#validate-a-spark-message) - [REST API を呼び出して単一ドキュメントを作成する](#invoke-rest-api) ## [](#create-documents-on-the-vault)Veeva Vault でのドキュメントの作成 次の例では、外部ソース (データベース) からフェッチしたドキュメントメタデータを使用してドキュメントを一括で作成します。Veeva Vault でドキュメントを作成する前に、Veeva Vault FTP サーバーを使用してドキュメントファイルをアップロードします。ドキュメントの ​`created`​ 状況がデータベースに挿入されます。 次のスクリーンショットは、この例の Studio アプリケーションフローを示しています。 ![Create Documents 操作の Mule フロー](/mulesoft/current/ja-jp/veevavault-connector/latest/_images/veevavault-connector-create-documents-example.png) ![Upload Documents 操作の Mule フロー](/mulesoft/current/ja-jp/veevavault-connector/latest/_images/veevavault-connector-upload-documents-example.png) ### [](#最初のフローを作成する)最初のフローを作成する 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[HTTP\]**​ を選択して ​**\[Listener\]**​ ソースをキャンバスにドラッグします。 2. 使用する環境に応じて HTTP リスナーを設定します。 3. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Database (データベース)\]**​ を選択して ​**\[Select\]**​ 操作をキャンバスにドラッグし、テーブルからドキュメントメタデータをフェッチします。 4. 接続ログイン情報を使用するように Database Connector を設定します。 5. \[SQL Query Text (SQL クエリテキスト)\] 項目に「​`>SELECT * FROM createdocuments`​」と入力します。 6. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Flow Reference\]**​ コンポーネントをキャンバスにドラッグし、サブフロー ​`upload-files-on-vault-ftp-server`​ を参照します。 7. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[For Each\]**​ スコープを次の要素が含まれるキャンバスにドラッグします。 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Transform Message\]**​ コンポーネントをキャンバスにドラッグし、ドキュメントメタデータを CSV 形式に変換します。 2. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Veeva Vault\]**​ を選択して ​**\[Create Documents\]**​ 操作をキャンバスにドラッグします。 3. Veeva Vault 接続の次の値を入力します。 - **Username (ユーザー名)** - **Password (パスワード)** - **Vault URL** - **Vault version (Vault バージョン)** - **Vault client ID (Vault クライアント ID)** 4. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Database (データベース)\]**​ を選択して ​**\[Bulk insert\]**​ 操作をキャンバスにドラッグし、ドキュメント作成済み状況データをデータベーステーブルに挿入します。 8. 接続ログイン情報を使用するように Database Connector を設定します。 9. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグし、コンソールまたはログファイルに情報を記録します。 ### [](#2-つ目のフローを作成する)2 つ目のフローを作成する 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグし、このサブフローの情報を記録します。 2. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[For Each\]**​ スコープを次の要素が含まれるキャンバスにドラッグします。 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグします。 2. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[FTPS\]**​ を選択して ​**\[Read\]**​ 操作をキャンバスにドラッグします。 3. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグします。 4. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[FTPS\]**​ を選択して ​**\[Write\]**​ 操作をキャンバスにドラッグし、ファイルを Veeva Vault FTP サーバーに書き込みます。 3. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して別の ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグします。 4. Veeva Vault FTP サーバーのログイン情報を使用するように FTPS Connector を設定します。 ### [](#例の-xml)例の XML この例の 2 つのフローをすばやく Mule アプリケーションに読み込むには、次のコードを Studio XML エディターに貼り付けます。 ```xml SELECT * FROM createdocuments { lifecycle__v: payload01.lifecycle__v, study__v: payload01.study__v, subtype__v: payload01.subtype__v, name__v: payload01.name__v ++ '--' ++ randomInt(10000) as String, type__v: payload01.type__v, classification__v: payload01.classification__v, product__v: payload01.product__v, file: payload01.file as String }]]> { 'id': $.id as String, 'external_id__v': $.external_id__v as String, 'responseStatus': $.responseStatus }]]]> INSERT into documents (id, external_id__v, responseStatus) VALUES (:id: external_id__v, :responseStatus) ``` ## [](#retrieve-document-details)ドキュメントの詳細を取得する この例では、ドキュメント種別、サブタイプ、分類に基づいてドキュメントの詳細を取得してデータベースに保存します。 次のスクリーンショットは、この例の Studio アプリケーションフローを示しています。 ![Get Documents 操作の Mule フロー](/mulesoft/current/ja-jp/veevavault-connector/latest/_images/veevavault-connector-get-documents-example.png) 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[HTTP\]**​ を選択して ​**\[Listener\]**​ ソースをキャンバスにドラッグします。 2. 使用する環境に応じて HTTP リスナーを設定します。 3. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Veeva Vault\]**​ を選択して ​**\[Get Documents\]**​ 操作をキャンバスにドラッグします。 4. Veeva Vault 接続の次の値を入力します。 - **Username (ユーザー名)** - **Password (パスワード)** - **Vault URL** - **Vault version (Vault バージョン)** - **Vault client ID (Vault クライアント ID)** 5. 各更新ボタンをクリックして、ドキュメント種別、サブタイプ、および分類のリストをフェッチします。 6. 各ドロップダウンリストからドキュメント種別、サブタイプ、および分類を選択します。 7. ビジネス要件に応じてドキュメントプロパティを \[Document Properties (ドキュメントプロパティ)\] リストに追加し、プロパティ名を VQL クエリに組み込んで、VQL クエリを動的にビルドします。 8. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[For Each\]**​ スコープを次の要素が含まれるキャンバスにドラッグします。 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Transform Message\]**​ コンポーネントをキャンバスにドラッグします。 2. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Database (データベース)\]**​ を選択して ​**\[Insert\]**​ 操作をキャンバスにドラッグします。 3. 接続ログイン情報を使用して、Database Connector を設定します。 9. ビジネス要件に従って、DataWeave を使用して変換を設定します。 10. データをテーブルに挿入するように ​**Insert**​ 操作を設定します。 11. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Set Payload\]**​ トランスフォーマーをキャンバスにドラッグし、トリガーソースに返すペイロードを設定します。 12. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグし、コンソールまたはログファイルに情報を記録します。 ### [](#例の-xml-2)例の XML この例のフローをすばやく Mule アプリケーションに読み込むには、次のコードを Studio XML エディターに貼り付けます。 ```xml INSERT INTO [.underline]#createdocuments# (name__v, type__v, subtype__v, classification__v, lifecycle__v, product__v, status__v, study__v, file) VALUES (:name__v, :type__v, :subtype__v, :classification__v, :lifecycle__v, :product__v, :status__v, :study__v, :file) ``` ## [](#fetch-document-or-object-data)ドキュメントまたはオブジェクトデータのフェッチ この例では、VQL クエリを使用して Veeva Vault からドキュメントまたはオブジェクトデータをフェッチします。 次のスクリーンショットは、この例の Studio アプリケーションフローを示しています。 ![Query 操作の Mule フロー](/mulesoft/current/ja-jp/veevavault-connector/latest/_images/veevavault-connector-query-example.png) 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[HTTP\]**​ を選択して ​**\[Listener\]**​ ソースをキャンバスにドラッグします。 2. 使用する環境に応じて HTTP リスナーを設定します。 3. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Veeva Vault\]**​ を選択して ​**\[Query\]**​ 操作をキャンバスにドラッグします。 4. Veeva Vault 接続の次の値を入力します。 - **Username (ユーザー名)** - **Password (パスワード)** - **Vault URL** - **Vault version (Vault バージョン)** - **Vault client ID (Vault クライアント ID)** 5. ビジネス要件に従って VQL クエリを定義します。 6. VQL クエリで使用する場合は、入力プレースホルダーを追加して、実行時に VQL で動的に組み込みます。 7. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[For Each\]**​ スコープを次の要素が含まれるキャンバスにドラッグします。 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Transform Message\]**​ コンポーネントをキャンバスにドラッグします。 2. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[File (ファイル)\]**​ を選択して ​**\[Write\]**​ 操作をキャンバスにドラッグします。 8. ビジネス要件に従って、DataWeave を使用して変換を設定します。 9. 作業ファイルのパスを使用して、File Connector を設定します。 10. 指定したファイルにペイロードデータを書き込むように ​**Write**​ 操作を設定します。 11. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Set Payload\]**​ トランスフォーマーをキャンバスにドラッグし、トリガーソースに返すペイロードを設定します。 12. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグし、コンソールまたはログファイルに情報を記録します。 ### [](#例の-xml-3)例の XML この例のフローをすばやく Mule アプリケーションに読み込むには、次のコードを Studio XML エディターに貼り付けます。 ```xml SELECT id, name__v, type__v, subtype__v, classification__v, lifecycle__v, status__v, study__v, product__v from :table WHERE name__v= 'F22611234--6764' ``` ## [](#validate-a-spark-message)Spark メッセージを検証する この例では、Veeva Vault の Spark メッセージをトリガーし、Spark メッセージを検証します。 次のスクリーンショットは、この例の Studio アプリケーションフローを示しています。 ![Spark Validator 操作の Mule フロー](/mulesoft/current/ja-jp/veevavault-connector/latest/_images/veevavault-connector-spark-validator-example.png) 1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[HTTP\]**​ を選択して ​**\[Listener\]**​ ソースをキャンバスにドラッグします。 2. HTTP Connector 用の JKS 証明書には、Veeva Vault との TLS 接続を介して Spark メッセージを受信するための HTTP リスナー用の ​`.jks`​ ファイルが必要です。 次の手順は、​`/bin`​ ディレクトリにある Java Keytool を使用して ​`.jks`​ ファイルを作成する方法を示しています。 3. `/bin`​ ディレクトリから次のコマンドを実行します。 ​\`keytool -genkey -keyalg RSA -alias mule -keystore spark-listener.jks -storepass password -validity 360 -keysize 2048\` これにより、現在のディレクトリに ​\`spark-listener.jks\`​ ファイルが作成されます。 4. `src/main/resources`​ プロジェクトディレクトリの ​`spark-listener.jks`​ ファイルをコピーしてインポートします。 5. HTTP リスナーを次のように設定します。 1. **\[General (一般)\]**​ タブで、次のように設定します。 - Protocol (プロトコル): HTTPS - Host (ホスト): 0.0.0.0 - Port (ポート): 8082 2. **\[TLS\]**​ タブで、次のように設定します。 - Type (種別): JKS - Path (パス): spark-listener.jks - Alias (別名): mule - Key Password (キーパスワード): password - Password (パスワード): password 6. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Veeva Vault\]**​ を選択して ​**\[Spark Validator\]**​ 操作をキャンバスにドラッグします。 7. Veeva Vault 接続の次の値を入力します。 - **Username (ユーザー名)** - **Password (パスワード)** - **Vault URL** - **Vault version (Vault バージョン)** - **Vault client ID (Vault クライアント ID)** 8. **Spark Validator**​ パラメーターを次のように設定します。 - Include Spark Header (Spark ヘッダーを含める): `FALSE` - Public Key Path (公開キーのパス): `${file.keyPath}` 公開キーファイル (00001.pem) の保存場所へのパスを使用して、​`configuration.yaml`​ の ​`file.keyPath`​ プロパティを定義します。 - Spark Headers (Spark ヘッダー): `#[attributes.headers]` - Spark Message (Spark メッセージ): `#[payload]` 9. **\[Mule Palette (Mule パレット)\]**​ ビューから ​**\[Core (コア)\]**​ を選択して ​**\[Set Payload\]**​ 操作をキャンバスにドラッグし、​**\[Value (値)\]**​ 項目で次のように定義します。 \---- output application/json --- { "payload" : payload, "attributes": attributes } ---- 10. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグし、次のメッセージを使用してペイロードを記録します。 Spark Message :: #\[payload\] ### [](#例の-xml-4)例の XML この例のフローをすばやく Mule アプリケーションに読み込むには、次のコードを Studio XML エディターに貼り付けます。 ```xml ``` ## [](#invoke-rest-api)REST API を呼び出して単一ドキュメントを作成する この例では、REST API を呼び出して、単一ドキュメントを作成します。 次のスクリーンショットは、この例の Studio アプリケーションフローを示しています。 ![Invoke REST API 操作の Mule フロー](/mulesoft/current/ja-jp/veevavault-connector/latest/_images/veevavault-connector-invoke-rest-api-example.png)
Veeva Vault REST API を呼び出すには、要件に従ってパラメーターを設定する必要があります。
1. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[HTTP\]**​ を選択して ​**\[Listener\]**​ ソースをキャンバスにドラッグします。 2. 使用する環境に応じて HTTP リスナーを設定します。 3. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[File (ファイル)\]**​ を選択して ​**\[Read\]**​ 操作をキャンバスにドラッグし、Veeva Vault ドキュメントに関連付けられたファイルのコンテンツから読み取るようにファイルパスを設定します。 4. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Veeva Vault\]**​ を選択して ​**\[Invoke REST API\]**​ 操作をキャンバスにドラッグします。 5. Veeva Vault 接続の次の値を入力します。 - **Username (ユーザー名)** - **Password (パスワード)** - **Vault URL** - **Vault version (Vault バージョン)** - **Vault client ID (Vault クライアント ID)** 6. POST 要求を設定します。 Method: POST, Path: "/objects/documents", Headers: Key: "Accept" Value: "application/json" Key: "Content-Type" Value: "multipart/form-data; boundary=abcdefg" URI Parameters: Leave it empty. Query Parameters: Leave it empty. %dw 2.0 output multipart/form-data boundary='abcdefg' --- { parts: { file: { headers: { "Content-Disposition": { "name": "file", "filename": attributes.fileName }, "Content-Type": payload.^mimeType }, content : payload }, name\_\_v: { headers: { }, content: 'Test Document' }, type\_\_v: { headers: { }, content: 'Trial Management' }, subtype\_\_v: { headers: { }, content: 'Meetings' }, classification\_\_v: { headers: { }, content: 'Kick-off Meeting Material' }, lifecycle\_\_v: { headers: { }, content: 'Base Doc Lifecycle' }, study\_\_v: { headers: { }, content: '0ST000000000301' }, comments\_\_c: { headers: { }, content: 'Test Document' } } } 7. PUT 要求を設定します。 Method: PUT, Path: "/objects/documents/{doc\_id}", Headers: Key: "Accept" Value: "application/json" Key: "Content-Type" Value: "application/x-www-form-urlencoded" URI Parameters: Key: "doc\_id" Value: "259592" Query Parameters: Leave it empty. %dw 2.0 output application/x-www-form-urlencoded --- { "id": "259592", "name\_\_v": "Kick-off Meeting Material Updated", "product\_\_v": "00P000000000403", "study\_\_v": "0ST000000000202", "notes\_\_v": "Notes Updated" } 8. **\[Mule Palette (Mule パレット)\]**​ ビューから、​**\[Core (コア)\]**​ を選択して ​**\[Logger\]**​ コンポーネントをキャンバスにドラッグし、次のメッセージを使用してペイロードを記録します。 Invoke Veeva API response :: #\[payload\] ### [](#例の-xml-5)例の XML この例のフローをすばやく Mule アプリケーションに読み込むには、次のコードを Studio XML エディターに貼り付けます。 ## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Veeva Vault Connector 1.5 の追加設定情報 ## [](#invoke_rest_api)Invoke Rest API **Invoke Rest API**​ 操作は、リクエストボディとして Mule メッセージペイロードを送信します。 リクエストボディに加えて、DataWeave スクリプトまたは式を使用して以下を設定できます。 - [Header (ヘッダー)](#headers) - [URI Parameters (URI パラメーター)](#uri-parameters) - [Query Parameters (クエリパラメーター)](#query-parameters) ### [](#headers)ヘッダーを設定する 1. Anypoint Studio で、​**\[General (一般)\] > \[Request (要求)\] > \[Query Parameters (クエリパラメーター)\]**​ に移動します。 2. プラスアイコン (+) をクリックしてヘッダーを要求に追加します。 たとえば、DataWeave 式を使用して、ヘッダー名 ​`HeaderName1`​ および ​`HeaderName2`​ とヘッダー値 ​`HeaderValue1`​ および ​`HeaderValue2`​ を追加します。 #\[{'HeaderName1' : 'HeaderValue1', 'HeaderName2' : 'HeaderValue2'}\]. ### [](#uri-parameters)URI パラメーターを設定する 要求のパスにプレースホルダー (​`/objects/documents/{doc_id}`​ など) を使用する場合は、URI パラメーターを設定します。 1. Anypoint Studio で、​**\[Path (パス)\]**​ 項目にプレースホルダーを中括弧で囲んで入力します。 2. **\[URI Parameters (URI パラメーター)\]**​ を選択します。 3. プラス記号 (+) をクリックして、名前と値を入力します。 ### [](#query-parameters)クエリパラメーターを設定する 1. Anypoint Studio で、​**\[General (一般)\] > \[Request (要求)\] > \[Query Parameters (クエリパラメーター)\]**​ に移動します。 2. プラスアイコン (+) をクリックして、パラメーターを要求に追加します。パラメーターの名前と値を入力するか、DataWeave 式を使用して名前と値を定義します。 #### [](#post-要求での-form-フォーム-パラメーターの送信)POST 要求での form (フォーム) パラメーターの送信 POST 要求でパラメーターを送信する方法: 1. **\[General (一般)\] > \[Request (要求)\]**​ で、​**POST**​ メソッドを選択します。 2. **\[Body (本文)\]**​ に、Mule メッセージのペイロードを入力します。 1. **application/x-www-form-urlencoded**​ などで送信するパラメーターの名前と値を入力します。 #\[output application/x-www-form-urlencoded --- {'key1':'value1', 'key2':'value2'}\] 2. **multipart/form-data**​ で、​**Content-Type**​ 値に DataWeave 出力と同じ境界属性値が含まれていることを確認してください。例: `multipart/form-data; boundary=abcdefg`​。 %dw 2.0 output multipart/form-data boundary='abcdefg' --- { parts: { file: { headers: { "Content-Disposition": { "name": "file", "filename": attributes.fileName }, "Content-Type": payload.^mimeType }, content : payload }, name\_\_v: { headers: { }, content: 'Test Document' }, type\_\_v: { headers: { }, content: 'Trial Management' }, subtype\_\_v: { headers: { }, content: 'Meetings' }, classification\_\_v: { headers: { }, content: 'Kick-off Meeting Material' }, lifecycle\_\_v: { headers: { }, content: 'Base Doc Lifecycle' }, study\_\_v: { headers: { }, content: '0ST000000000301' }, comments\_\_c: { headers: { }, content: 'Test Document' } } } ## [](#connector_operations_success_and_failure_response)コネクタ操作の SUCCESS および FAILURE 応答 Veeva Vault Connector 操作の応答は、Veeva Vault API の成功または失敗応答とエラーに基づきます。 コネクタは ​`SUCCESS`​ 応答を ​`HIGH LEVEL`​ で返し、​`SUCCESS`​ または ​`FAILURE`​ を ​`LOW LEVEL`​ で返します。つまり、コネクタ操作が正常に終了しても、要求に渡された関連のない一部のデータのために一部のドキュメントまたはオブジェクトレコードの作成または更新が失敗していることがあります。 ### [](#例)例 **SUCCESS を含む SUCCESS 応答**​: { "responseStatus": "SUCCESS", "data": \[{ "id": 239026, "name\_\_v": "E22611234--38483", "responseStatus": "SUCCESS" }, { "id": 239025, "name\_\_v": "Kick-off Meeting Material Updated12341234--81032", "responseStatus": "SUCCESS" } \] } **FAILURE を含む SUCCESS 応答**​: { "data": \[ { "external\_id\_\_v": "TEST-238924", "rendition\_type\_\_v": "imported\_rendition\_\_c", "id": 238924, "responseStatus": "FAILURE", "minor\_version\_number\_\_v": 1, "errors": \[ { "type": "INVALID\_DATA", "message": "Document not found \[238924/0/1\]." } \], "major\_version\_number\_\_v": 0 }, { "external\_id\_\_v": "TEST-238925", "rendition\_type\_\_v": "imported\_rendition\_\_c", "id": 238925, "responseStatus": "FAILURE", "minor\_version\_number\_\_v": 1, "errors": \[ { "type": "INVALID\_DATA", "message": "Document not found \[238925/0/1\]." } \], "major\_version\_number\_\_v": 0 } \], "responseStatus": "SUCCESS" } Veeva Vault API で ​`FAILURE`​ 応答が返されると、Veeva Vault Connector 操作で例外がスローされます。次に例を示します。 **ERROR を含む FAILURE 応答** { "responseStatus": "FAILURE", "errors": \[ { "type": "INVALID\_DATA", "message": "Unknown relationship \[reviewer\_\_v\]" } \] } Veeva Vault API から ​`FAILURE`​ 応答を受信すると、コネクタ操作で例外がスローされ、Mule フロー内の ​**Error Handling**​ コンポーネントでキャッチされます。 \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* Message : An error occurred from the Veeva Vault API. Error Code: INVALID\_DATA. Original Error Message: Unknown relationship \[reviewer\_\_v\]. Error type : VEEVAVAULT:INVALID\_DATA \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* **Error Handling**​ コンポーネントでキャッチされるエラーコードを次に示します。 - VEEVAVAULT:API\_LIMIT\_EXCEEDED - VEEVAVAULT:ATTRIBUTE\_NOT\_SUPPORTED - VEEVAVAULT:INACTIVE\_USER - VEEVAVAULT:INVALID\_DATA - VEEVAVAULT:INVALID\_DOCUMENT - VEEVAVAULT:INSUFFICIENT\_ACCESS - VEEVAVAULT:MALFORMED\_URL - VEEVAVAULT:METHOD\_NOT\_SUPPORTED - VEEVAVAULT:NO\_PERMISSION - VEEVAVAULT:OPERATION\_NOT\_ALLOWED - VEEVAVAULT:PARAMETER\_REQUIRED ## [](#streaming_and_pagination)ストリーミングおよびページネーション **Download Document**​ を除くすべてのコネクタ操作で、操作の出力に基づく各結果を含むペイロードとして入力ストリームが返されます。このため、デフォルトでは、Mule ではストリーミング戦略が適用されます。詳細は、​[Mule ストリーミング戦略](https://docs.mulesoft.com/mule-runtime/latest/streaming-about)​を参照してください。ストリーミング戦略の設定項目は、コネクタ操作の ​**\[Advanced (詳細)\]**​ タブにあります。 ![ストリーミング戦略設定項目](/mulesoft/current/ja-jp/veevavault-connector/latest/_images/veevavault-connector-streaming-pagination.png) コネクタ内の次の操作では、Mule 標準ページネーションに基づくページネーションメカニズムが提供されます。 - **Get Documents** - **Get Object Records** - **Query** - **Get Audit Details** ページ分割操作を使用していますが、各オブジェクトを取得するには必ず ​`For-Each/Splitter`​ 要素を含めてください。ページネーション操作には、​**\[Fetch Size (フェッチサイズ)\]**​ 項目と ​**\[Batch Size (バッチサイズ)\]**​ 項目があります。 - **Fetch Size (フェッチサイズ)**​ 1 つのページで取得できるレコードの制限数。操作は、フェッチサイズの数の JSON オブジェクトレコードを含むページを返します。 場合によって、Veeva API でレコードサイズに基づいてフェッチサイズ (各ページのレコード数) が自動計算され、その計算で標準レコードサイズを超えることがあります。操作は、各ページで計算されたレコード数を返します。 - **Batch Size (バッチサイズ)**​ 各バッチで返されるページの数。各ページには、フェッチサイズの数のレコードが含まれます。操作はバッチごとに多数のレコード (JSON 形式のメタデータ) を返し、計算は次の例のように行われます。 Fetch Size set as \*1000\* Batch Size set as \*10\* If the total records in the vault are \*100,000\*, then: Number of pages = Total records/Fetch Size = 100000/1000 = 100 pages. Number of pages per batch = Number of pages/Batch Size = 100/10 = 10 pages per batch. Number of Records per batch = Number of pages per batch \* Fetch Size = 10 \* 1000 = 10,000 records. Therefore, the number of records returned per batch would be 10,000 records. 反復可能ストリームはバッファサイズをバイト単位で測定します。オブジェクトを処理するときに、ランタイムはインスタンス数を使用してバッファサイズを測定します。 反復不可能ストリームの、コネクタ操作では、ストリームはバッチごとのレコード数として返されます。反復可能ストリームでは、すべてのレコードが一度に返されるため、反復可能自動ページングでメモリ内のバッファサイズを計算する場合は、メモリ不足にならないように、各インスタンスが使用するメモリ量を見積もる必要があります。 ## [](#次のステップ)次のステップ コネクタの設定が完了したら、​[例](https://docs.mulesoft.com/jp/veevavault-connector/latest/veevavault-connector-examples)​を試すことができます。 ## [](#関連情報)関連情報 - [Veeva Vault Connector リファレンス](https://docs.mulesoft.com/jp/veevavault-connector/latest/veevavault-connector-reference) - [MuleSoft ヘルプセンター](https://help.mulesoft.com) # Veeva Vault Connector 1.5 リファレンス ## [](#config)設定 Veeva Vault Connector のデフォルト設定。
名前 型 説明 デフォルト値 必須

Name (名前)

String (文字列)

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

x

Connection (接続)

この設定の接続種別。

x

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

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

### [](#config_basic-connection)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 (再接続)

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

### [](#config_oauth2-oidc-connection)OAuth 2.0/Open ID Connection Provider (OAuth 2.0/Open ID 接続プロバイダー) Unresolved include directive in modules/ROOT/pages/veevavault-connector-reference.adoc - include::connectors::partial$oauth2-description.adoc\[\] OpenID プロバイダーを認証し、発行されたアクセストークンを Veeva セッション ID と交換します。 この接続種別を設定する方法の詳細は、​[「OAuth 2.0/Open ID 接続プロバイダー」](https://docs.mulesoft.com/jp/veevavault-connector/latest/veevavault-connector-studio#oauth2-oidc-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

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 スコープ。この値のデフォルトはアノテーションのスコープです。

openid ​offline_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](#createDocumentRenditions) - [Create Documents](#createDocuments) - [Create Object Records](#createObjectRecords) - [Delete Document Renditions](#deleteDocumentRenditions) - [Delete Documents](#deleteDocuments) - [Delete Object Records](#deleteObjectRecords) - [Export Documents](#exportDocuments) - [Get Audit Details](#getAuditDetails) - [Get Document Renditions Types](#getDocumentRenditionsTypes) - [Get Documents](#getDocuments) - [Get Object Records](#getObjectRecords) - [Get Picklists](#getPicklists) - [Invoke REST API](#invokeRestApi) - [Query](#query) - [Spark Validator](#sparkMessageValidator) - [Unauthorize](#unauthorize) - [Update Documents](#updateDocuments) - [Update Object Records](#updateObjectRecords) ### [](#createDocumentRenditions)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 応答属性)

#### [](#関連する設定)関連する設定 - [設定](#config) #### [](#スロー)スロー - 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 ### [](#createDocuments)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 (再接続戦略)

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

#### [](#出力-2)出力

型

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

#### [](#関連する設定-2)関連する設定 - [設定](#config) #### [](#スロー-2)スロー - 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 ### [](#createObjectRecords)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 (再接続戦略)

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

#### [](#出力-3)出力

型

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

#### [](#関連する設定-3)関連する設定 - [設定](#config) #### [](#スロー-3)スロー - 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 ### [](#deleteDocumentRenditions)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 (再接続戦略)

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

#### [](#出力-4)出力

型

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

#### [](#関連する設定-4)関連する設定 - [設定](#config) #### [](#スロー-4)スロー - 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 ### [](#deleteDocuments)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 (再接続戦略)

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

#### [](#出力-5)出力

型

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

#### [](#関連する設定-5)関連する設定 - [設定](#config) #### [](#スロー-5)スロー - 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 ### [](#deleteObjectRecords)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 (再接続戦略)

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

#### [](#出力-6)出力

型

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

#### [](#関連する設定-6)関連する設定 - [設定](#config) #### [](#スロー-6)スロー - 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 ### [](#exportDocuments)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 (再接続戦略)

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

#### [](#出力-7)出力

型

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

#### [](#関連する設定-7)関連する設定 - [設定](#config) #### [](#スロー-7)スロー - 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 ### [](#getAuditDetails)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 (再接続戦略)

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

#### [](#出力-8)出力

型

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

#### [](#関連する設定-8)関連する設定 - [設定](#config) #### [](#スロー-8)スロー - 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 ### [](#getDocumentRenditionsTypes)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 (再接続戦略)

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

#### [](#出力-9)出力

型

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

#### [](#関連する設定-9)関連する設定 - [設定](#config) #### [](#スロー-9)スロー - 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 ### [](#getDocuments)Get Documents `` Veeva Vault からドキュメントの詳細を取得します。次のいずれかを実行できます。 - ドキュメントプロパティ (ドキュメント種別、サブタイプ、分類) を指定して、ドキュメントの詳細を取得します。 ドキュメントプロパティが指定されている場合、​**Get Documents**​ 操作によって VQL クエリが動的にビルドされます。その後、この VQL クエリが Vault で実行され、ドキュメントの詳細が取得されます。 - ドキュメントプロパティ (ドキュメント種別、サブタイプ、分類) をフェッチして、ドキュメントの詳細を取得します。 ドキュメントプロパティが指定されていない場合、​`/api/{version}/metadata/objects/documents/properties`​ を使用してドキュメントプロパティメタデータがフェッチされ、​**\[Document Properties (ドキュメントプロパティ)\]**​ リストに追加または挿入されたドキュメントメタデータプロパティに基づいて VQL クエリがビルドされます。メタデータプロパティが指定されていない場合、クエリ可能なすべてのドキュメントプロパティが VQL クエリで使用および実行されます。 この操作の後に For-Each/Splitter 要素を配置して、各ドキュメントのデータ (ページ) を順次フェッチします。 この操作では、Mule 標準ページネーションに基づくページングメカニズムが提供されます。詳細は、​[「ストリーミングおよびページネーション」](https://docs.mulesoft.com/jp/veevavault-connector/latest/veevavault-connector-config-topics#streaming_and_pagination.adoc)​を参照してください。
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

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

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

Type (型)

String (文字列)

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

SubType

String (文字列)

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

Classification (分類)

String (文字列)

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

ドキュメントプロパティ

Array of 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 (再接続戦略)

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

#### [](#出力-10)出力

型

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

#### [](#関連する設定-10)関連する設定 - [設定](#config) #### [](#スロー-10)スロー - 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 ### [](#getObjectRecords)Get Object Records `` オブジェクトメタデータ項目を使用してオブジェクトレコードの詳細を取得し、VQL クエリを動的にビルドして Vault で実行し、オブジェクトの詳細を取得します。この操作の後に For-Each/Splitter 要素を配置して、各オブジェクトレコード (ページ) を順次フェッチします。 この操作では、Mule 標準ページネーションに基づくページングメカニズムが提供されます。詳細は、​[「ストリーミングおよびページネーション」](https://docs.mulesoft.com/jp/veevavault-connector/latest/veevavault-connector-config-topics#streaming_and_pagination.adoc)​を参照してください。
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Object Name (オブジェクト名)

String (文字列)

オブジェクト名。

x

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

Array of 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 (再接続戦略)

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

#### [](#出力-11)出力

型

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

#### [](#関連する設定-11)関連する設定 - [設定](#config) #### [](#スロー-11)スロー - 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 ### [](#getPicklists)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 (再接続戦略)

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

#### [](#出力-12)出力

型

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

#### [](#関連する設定-12)関連する設定 - [設定](#config) #### [](#スロー-12)スロー - 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 ### [](#invokeRestApi)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 (再接続戦略)

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

#### [](#出力-13)出力

型

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

#### [](#関連する設定-13)関連する設定 - [設定](#config) #### [](#スロー-13)スロー - 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)Query `` 指定した VQL クエリを Vault で実行し、ページ分割されたデータ入力ストリームで結果を取得します。Query 操作の後に For-Each/Splitter 要素を配置して、各レコードを順次フェッチします。 この操作では、Mule 標準ページネーションに基づくページングメカニズムが提供されます。詳細は、​[「ストリーミングおよびページネーション」](https://docs.mulesoft.com/jp/veevavault-connector/latest/veevavault-connector-config-topics#streaming_and_pagination.adoc)​を参照してください。
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 (再接続戦略)

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

#### [](#出力-14)出力

型

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

#### [](#関連する設定-14)関連する設定 - [設定](#config) #### [](#スロー-14)スロー - 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 ### [](#sparkMessageValidator)Spark Validator `` 署名と公開キーを使用して、Vault からトリガーされた Spark メッセージの検証と確認を行います。検証と確認が正常に終了したら、Spark メッセージを Mule フローでビジネス要件に従ってさらに処理できます。詳細は、 [「Spark Messaging feature and functionalities and setup (Spark メッセージングの機能およびセットアップ)」](https://developer.veevavault.com/sdk/#spark-messaging)​を参照してください。 **Spark Validator**​ 操作の結果には、Spark 属性 (省略可能) と Spark メッセージ (Vault から受信した場合) が含まれます。
Vault から Spark メッセージをトリガーする前に、Veeva Vault サポートのサポートチケットを申請して、Spark メッセージの再送信または再試行の間隔を必ず増やしてください (例: 10 秒)。デフォルトでは期間は 5 秒として設定されていますが、​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 (再接続戦略)

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

#### [](#出力-15)出力

型

Binary (バイナリ)

Attributes Type (属性型)

Object (オブジェクト)

#### [](#関連する設定-15)関連する設定 - [設定](#config) #### [](#スロー-15)スロー - 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)Unauthorize `` 特定のリソースオーナー ID のアクセストークン情報をすべて削除して、認証ダンスを再度実行しない限り、そのユーザー向けの操作を実行できないようにします。
名前 型 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

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

String (文字列)

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

#### [](#関連する設定-16)関連する設定 - [設定](#config) ### [](#updateDocuments)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 (再接続戦略)

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

#### [](#出力-16)出力

型

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

#### [](#関連する設定-17)関連する設定 - [設定](#config) #### [](#スロー-16)スロー - 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 ### [](#updateObjectRecords)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 (再接続戦略)

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

#### [](#出力-17)出力

型

Binary (バイナリ)

Attributes Type (属性型)

HTTP Response Attributes (HTTP 応答属性)

#### [](#関連する設定-18)関連する設定 - [設定](#config) #### [](#スロー-17)スロー - 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-再接続)Reconnection (再接続) 操作の再接続戦略を設定します。
項目 型 説明 デフォルト値 必須

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

Boolean (ブール)

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

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

### [](#reconnect)Reconnect (再接続) 標準再接続戦略を設定し、再接続の頻度と、コネクタソースまたは操作で実行できる再接続の試行回数を指定します。
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

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

Count (数)

Number (数値)

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

### [](#reconnect-forever)Reconnect Forever (繰り返し再接続) Mule アプリケーションが実行されている間はコネクタソースや操作によって指定された頻度で再接続が試行される Forever 再接続戦略を設定します。
項目 型 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

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

### [](#ExpirationPolicy)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)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)Repeatable File Store Stream (反復可能なファイルストアストリーム) 反復可能なファイルストアストリーミング戦略を設定します。この戦略では、ストリームコンテンツの一部がメモリ内に格納されます。ストリームのコンテンツが、設定されたバッファサイズよりも大きい場合、Mule はバッファのコンテンツをディスクにバックアップしてからメモリをクリアします。
項目 型 説明 デフォルト値 必須

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

Number (数値)

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

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

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

Buffer Unit (バッファ単位)

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

  • BYTE

  • KB

  • MB

  • GB

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

### [](#repeatable-in-memory-iterable)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)Repeatable File Store Iterable (反復可能なファイルストアイテラブル) ファイルストアイテラブル型を設定します。
項目 型 説明 デフォルト値 必須

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

Number (数値)

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

Buffer Unit (バッファ単位)

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

  • BYTE

  • KB

  • MB

  • GB

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

### [](#HttpResponseAttributes)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)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 レート制限ヘッダー)」](https://developer.veevavault.com/docs/#api-rate-limits)​を参照してください。
項目 型 説明 デフォルト値 必須

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)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 レート制限ヘッダー)」](https://developer.veevavault.com/docs/#api-rate-limits)​を参照してください。
項目 型 説明 デフォルト値 必須

API 制限

Number (数値)

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

10000

## [](#関連情報)関連情報 - [Anypoint Connector の概要](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [MuleSoft ヘルプセンター](https://help.mulesoft.com)