Veeva Vault Connector 1.3 リファレンス

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

名前

String (文字列)

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

Vault URL

String (文字列)

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

Username (ユーザー名)

String (文字列)

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

Password (パスワード)

String (文字列)

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

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)。

応答タイムアウト ([Advanced (詳細)] タブ)

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

名前	型	説明	デフォルト値	必須
Response Timeout (応答タイムアウト)	Integer (整数)	コネクタが Veeva Vault の応答を待機する最大時間 (ミリ秒単位)。この時間を超えると、`Response Timeout` 例外がスローされます。	`30000 ms`	X

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

Integer (整数)

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

30000 ms

Burst API Limit Profile (バースト API 制限プロファイル) ([Advanced (詳細)] タブ)

<veevavault:burst-api-limit-profile/>

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

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

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

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

名前	型	説明	デフォルト値	必須
API 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

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

Integer (整数)

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

200

Wait Time (待機時間)

Integer (整数)

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

5

Time Unit (時間単位)

DAYS
HOURS
MINUTES
SECONDS
MILLISECONDS
NANOSECONDS

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

MINUTES

Daily API Limit Profile (1 日の API 制限プロファイル) ([Advanced (詳細)] タブ)

<veevavault:daily-api-limit-profile/>

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

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

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

名前	型	説明	デフォルト値	必須
API Limit Threshold (API 制限しきい値)	Integer (整数)	許容される 1 日の API コール数の制限を設定する API 制限しきい値。API 制限しきい値に達すると、コネクタは、API コールを呼び出す要求ごとに `API_LIMIT_EXCEED` 例外をスローします。	`10000`	X

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

Integer (整数)

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

10000

操作

Create Documents
Create Document Renditions
Create Object Records
Delete Documents
Delete Document Renditions
Delete Object Records
Export Documents
Get Audit Details
Get Documents
Get Document Renditions
Get Object Records
Get Picklists
Invoke REST API
Query
Spark Validator
Update Documents
Update Object Records

Create Documents

<veevavault:create-documents>

CSV または JSON 形式で提供されたドキュメントメタデータを使用して、Veeva Vault で 1 つまたは複数のドキュメントを作成します。ドキュメントファイルを、作成したドキュメントに添付するコンテンツと共に Vault FTP サーバーの場所にアップロードする必要があります。

パラメーター

名前	型	説明	デフォルト値	必須
Metadata Format (メタデータ形式)	Enum (列挙) (文字列): CSV JSON	ドキュメントメタデータの形式。		X
Document Metadata (ドキュメントメタデータ)	Input Stream (入力ストリーム)	入力ストリームとしてのドキュメントメタデータ。ペイロードの形式は、[Metadata Format (メタデータ形式)] 項目で指定された形式である必要があります。		X

名前

型

説明

デフォルト値

必須

Metadata Format (メタデータ形式)

Enum (列挙) (文字列):

CSV
JSON

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

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

Input Stream (入力ストリーム)

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

設定

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

<veevavault:create-document-renditions>

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

この操作を使用する前に Vault が移行モードになっている必要があります。この操作では、標準の UTF-8 でエンコードされた値を含む、最大サイズ 1 GB の CSV 入力データを取り込みます。

パラメーター

名前	型	説明	デフォルト値	必須
Metadata Format (メタデータ形式)	Enum (列挙) (文字列): CSV JSON	ドキュメントメタデータの形式。		X
Document Metadata (ドキュメントメタデータ)	Input Stream (入力ストリーム)	入力ストリームとしてのドキュメントメタデータ。ペイロードの形式は、[Metadata Format (メタデータ形式)] 項目で指定された形式である必要があります。		X

名前

型

説明

デフォルト値

必須

Metadata Format (メタデータ形式)

Enum (列挙) (文字列):

CSV
JSON

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

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

Input Stream (入力ストリーム)

設定

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 Object Records

<veevavault:create-object-records>

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

パラメーター

名前

型

説明

デフォルト値

必須

Object Name (オブジェクト名)

String (文字列)

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

Metadata Format (メタデータ形式)

Enum (列挙) (文字列):

CSV
JSON

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

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

Input Stream (入力ストリーム)

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

設定

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

Delete Documents

<veevavault:delete-documents>

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

パラメーター

名前	型	説明	デフォルト値	必須
Metadata Format (メタデータ形式)	Enum (列挙) (文字列): CSV JSON	ドキュメントメタデータの形式。		X
Document Metadata (ドキュメントメタデータ)	Input Stream (入力ストリーム)	入力ストリームとしてのドキュメントメタデータ。ペイロードの形式は、[Metadata Format (メタデータ形式)] 項目で指定された形式である必要があります。		X

名前

型

説明

デフォルト値

必須

Metadata Format (メタデータ形式)

Enum (列挙) (文字列):

CSV
JSON

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

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

Input Stream (入力ストリーム)

設定

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

Delete Document Renditions

<veevavault:delete-document-renditions>

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

パラメーター

名前	型	説明	デフォルト値	必須
Metadata Format (メタデータ形式)	Enum (列挙) (文字列): CSV JSON	ドキュメントメタデータの形式。		X
Document Metadata (ドキュメントメタデータ)	Input Stream (入力ストリーム)	入力ストリームとしてのドキュメントメタデータ。ペイロードの形式は、[Metadata Format (メタデータ形式)] 項目で指定された形式である必要があります。		X

名前

型

説明

デフォルト値

必須

Metadata Format (メタデータ形式)

Enum (列挙) (文字列):

CSV
JSON

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

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

Input Stream (入力ストリーム)

設定

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

Delete Object Records

<veevavault:delete-object-records>

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

パラメーター

名前	型	説明	必須
Object Name (オブジェクト名)	String (文字列)	Veeva Vault 更新アイコンをクリックして、Vault オブジェクトリストを取得します。リストからオブジェクト名を選択して、選択したオブジェクトのレコードを削除します。	X
Metadata Format (メタデータ形式)	Enum (列挙) (文字列): CSV JSON	オブジェクトメタデータの形式。	X
Object Metadata (オブジェクトメタデータ)	Input Stream (入力ストリーム)	入力ストリームとしてのオブジェクトメタデータ。ペイロードの形式は、[Metadata Format (メタデータ形式)] 項目で指定された形式である必要があります。	X

名前

型

説明

デフォルト値

必須

Object Name (オブジェクト名)

String (文字列)

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

Metadata Format (メタデータ形式)

Enum (列挙) (文字列):

CSV
JSON

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

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

Input Stream (入力ストリーム)

設定

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

Export Documents

<veevavault:export-documents>

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

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

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

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

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

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

file
"/{jobId}/{documentId}/{major-minor-version}/{filename}" の形式を使用します。これは、Vault FTP サーバーのステージング領域の絶対ファイルパス位置です。
user_id__v
コネクタ内でログイン情報が設定されているユーザーの Vault システムでのユーザー ID。フォルダーが Vault FTP サーバーのステージング領域のルート位置に作成され、その下にエクスポートされたファイルが配置されます。フォルダーは、文字 u のプレフィックスを持つユーザー ID の名前を使用して作成されます。例: /uXXXXXXX/{jobId}/{documentId}/{major-minor-version}/{filename}\)。
id
エクスポートされたドキュメントファイルのドキュメント ID。
major_version_number__v
エクスポートされたドキュメントファイルのメジャーバージョン番号。
minor_version_number__v
エクスポートされたドキュメントファイルのマイナーバージョン番号。

パラメーター

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

名前	型	説明	デフォルト値	必須
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`

Metadata Format (メタデータ形式)

Enum (列挙) (文字列):

CSV
JSON

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

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

Input Stream (入力ストリーム)

#[payload]

Source (ソース)

Boolean (ブール)

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

true

Renditions (レンディション)

Boolean (ブール)

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

false

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

Boolean (ブール)

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

false

Polling Interval (ポーリング間隔)

Integer (整数)

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

30

設定

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

Get Audit Details

<veevavault:get-audit-details>

指定された監査種別の監査の詳細を取得します。

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

パラメーター

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

名前	型	説明	デフォルト値	必須
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`

Audit Type (監査種別)

String (文字列)

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

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

設定

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

Get Documents

<veevavault:get-documents>

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

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

ドキュメントプロパティが指定されている場合、Get Documents 操作によって VQL クエリが動的にビルドされます。その後、この VQL クエリが Vault で実行され、ドキュメントの詳細が取得されます。
ドキュメントプロパティ (ドキュメント種別、サブタイプ、分類) をフェッチして、ドキュメントの詳細を取得します。

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

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

パラメーター

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

名前	型	説明	デフォルト値
型	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`

型

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

設定

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

Get Document Renditions Types

<veevavault:get-document-renditions>

ドキュメントレンディションの詳細を取得します。

パラメーター

名前	型	説明	デフォルト値	必須
Document Metadata (ドキュメントメタデータ)	Input Stream (入力ストリーム)	入力ストリームとしてのドキュメントメタデータ。ペイロードの形式は、[Metadata Format (メタデータ形式)] 項目で指定された形式である必要があります。		X

名前

型

説明

デフォルト値

必須

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

Input Stream (入力ストリーム)

設定

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

Get Object Records

<veevavault:get-object-records>

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

パラメーター

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

名前	型	説明	デフォルト値	必須
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`

Object Name (オブジェクト名)

String (文字列)

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

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

設定

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

Get Picklists

<veevavault:get-picklists>

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

パラメーター

名前	型	説明	デフォルト値	必須
Picklist Name (選択リスト名)	String (文字列)	Vault での選択可能な監査種別のリスト。		X

名前

型

説明

デフォルト値

必須

Picklist Name (選択リスト名)

String (文字列)

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

設定

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

Invoke REST API

<veevavault:invoke-rest-api>

Veeva Vault Rest API を呼び出し、ヘッダーで指定されている Accept 値に応じて JSON (デフォルト) または XML 形式で応答を返します。 API レート制限を超過しないように、REST API を個別に使用するのではなく、可能な限り一括で使用することが重要です。

パラメーター

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

名前	型	説明	デフォルト値	必須
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

Method (メソッド)

String (文字列)

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

GET

Path (パス)

String (文字列)

要求を送信する URI パス。

Body (本文)

Input Stream (入力ストリーム)

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

#[payload]

ヘッダー

Map (マップ)

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

URI パラメーター

Map (マップ)

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

クエリパラメーター

Map (マップ)

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

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

Stream (ストリーム)

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

ALWAYS
AUTO
NEVER

設定

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

Query

<veevavault:query>

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

VQL クエリで LIMIT と OFFSET を指定しないでください。これらのパラメーターは内部に組み込まれています。

パラメーター

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

名前	型	説明	デフォルト値	必須
VQL Query (VQL クエリ)	String (文字列)	Veeva Vault の VQL 仕様に基づいて定義して実行する VQL クエリ。例: `SELECT id, namev, studyv FROM :table`。詳細は、 VQL クエリのドキュメントを参照してください。		X
Input parameters (入力パラメーター)	Map<String, Object>	文字列とオブジェクトのマップ。この中の各項目が、挿入される行を表します。マップにはパラメーター名がキーとして、バインド先のパラメーターが値として含まれます。次に例を示します。 { 'table': 'site__v' }	#[{}]
Fetch Size (フェッチサイズ)	Integer (整数)	1 ページあたりのレコード数を指定します。	`100`
Batch Size (バッチサイズ)	Integer (整数)	バッチごとのページ数を指定します。	`10`

VQL Query (VQL クエリ)

String (文字列)

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

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

Map<String, Object>

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

{

'table': 'site__v'

}

#[{}]

Fetch Size (フェッチサイズ)

Integer (整数)

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

100

Batch Size (バッチサイズ)

Integer (整数)

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

10

設定

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

Spark Validator

<veevavault:spark-message-validator>

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

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

Vault から Spark メッセージをトリガーする前に、Veeva Vault サポートのサポートチケットを申請して、Spark メッセージの再送信または再試行の間隔を必ず増やしてください (例: 10 秒)。デフォルトでは期間は 5 秒として設定されていますが、Spark Validator 操作でメッセージの検証と確認を完了するのに必要な時間を下回っています。

Veeva Systems によると、公開キー (00001.pem) の期限は 2 年ごとに切れます。ユーザーは有効期限に関する通知を事前に受け取ります。Mule アプリケーションフローで Spark Validator 操作を使用している場合は、公開キーの有効期限後に、[Public Key Path (公開キーのパス)] 項目で設定されたパスから公開キーファイルを削除する必要があります。キーの削除を実行している間に新しい公開キーが作成されます。これを行わない場合、Spark メッセージの検証が INVALID_SPARK_MESSAGE として失敗します。Spark メッセージの検証を正常に終了するには、デフォルトのパスで CloudHub にデプロイされた Mule アプリケーションを再起動する必要があります。

パラメーター

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

名前	型	説明	デフォルト値
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]

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]

設定

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
VEEVAVAULT:INVALID_SPARK_MESSAGE
VEEVAVAULT:INVALID_KEY_FORMAT

Update Documents

<veevavault:update-documents>

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

パラメーター

名前	型	説明	デフォルト値	必須
Metadata Format (メタデータ形式)	Enum (列挙) (文字列): CSV JSON	オブジェクトメタデータの形式。		X
Document Metadata (ドキュメントメタデータ)	Input Stream (入力ストリーム)	入力ストリームとしてのドキュメントメタデータ。ペイロードの形式は、[Metadata Format (メタデータ形式)] 項目で指定された形式である必要があります。		X

名前

型

説明

デフォルト値

必須

Metadata Format (メタデータ形式)

Enum (列挙) (文字列):

CSV
JSON

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

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

Input Stream (入力ストリーム)

設定

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

Update Object Records

<veevavault:update-object-records>

CSV または JSON 形式で提供されたペイロードの編集可能なオブジェクトメタデータを使用して、指定された Vault オブジェクトのオブジェクトレコードを更新します。

パラメーター

名前	型	説明	必須
Object Name (オブジェクト名)	String (文字列)	選択可能なすべての Vault オブジェクトのリスト。	X
Metadata Format (メタデータ形式)	Enum (列挙) (文字列): CSV JSON	オブジェクトメタデータの形式。	X
Object Metadata (オブジェクトメタデータ)	Input Stream (入力ストリーム)	入力ストリームとしてのオブジェクトメタデータ。ペイロードの形式は、[Metadata Format (メタデータ形式)] 項目で指定された形式である必要があります。	X

名前

型

説明

デフォルト値

必須

Object Name (オブジェクト名)

String (文字列)

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

Metadata Format (メタデータ形式)

Enum (列挙) (文字列):

CSV
JSON

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

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

Input Stream (入力ストリーム)

設定

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

Veeva Vault Connector 1.3 リファレンス

Configuration (設定)

応答タイムアウト ([Advanced (詳細)] タブ)

Burst API Limit Profile (バースト API 制限プロファイル) ([Advanced (詳細)] タブ)

Daily API Limit Profile (1 日の API 制限プロファイル) ([Advanced (詳細)] タブ)

操作

Create Documents

パラメーター

設定

スロー

Create Document Renditions

パラメーター

設定

スロー

Create Object Records

パラメーター

設定

スロー

Delete Documents

パラメーター

設定

スロー

Delete Document Renditions

パラメーター

設定

スロー

Delete Object Records

パラメーター

設定

スロー

Export Documents

パラメーター

設定

スロー

Get Audit Details

パラメーター

設定

スロー

Get Documents

パラメーター

設定

スロー

Get Document Renditions Types

パラメーター

設定

スロー

Get Object Records

パラメーター

設定

スロー

Get Picklists

パラメーター

設定

スロー

Invoke REST API

パラメーター

設定

スロー

Query

パラメーター

設定

スロー

Spark Validator

パラメーター

設定

スロー

Update Documents

パラメーター

設定

スロー

Update Object Records

パラメーター

設定

スロー

関連情報