JDBC Driver for Veeva Vault

Build 24.0.9175

接続の確立

JDBC データソースの作成

Java アプリケーションから接続するJDBC データソースを作成できます。CData JDBC Driver for Veeva Vault に基づくJDBC データソースの作成は、3つの基本ステップで構成されます。

  • ドライバーのJAR ファイルをクラスパスに追加します。JAR ファイルはインストールディレクトリの［lib］サブフォルダ内にあります。.lic ファイルはJAR ファイルと同じフォルダ内に配置される必要があることに注意してください。
  • ドライバークラスを入力します。次に例を示します。 
    cdata.jdbc.veevavault.VeevaVaultDriver
  • JDBC URL を入力します。次に例を示します。 
    jdbc:veevavault:Url=myURL;User=myUser;Password=myPassword;

or

jdbc:cdata:veevavault:Url=myURL;User=myUser;Password=myPassword;

    上記の2つ目の形式は、同じURL 形式を使用しているドライバー間でアプリケーションに競合がある場合は、CData ドライバーを使用していることを確認するために常に使用できます。URL は "jdbc:veevavault:" または"jdbc:cdata:veevavault:" のいずれかから始まり、任意の接続プロパティの名前と値のペアをセミコロン区切りで入力します。

Veeva Vault への接続

Veeva Vault アカウントに接続するには、まず、アカウントにログインした後にアドレスバーに表示されるホストにRSBVeevaVault_p_URL 接続プロパティを設定する必要があります。

例：https://myvault.veevavault.com

Veeva Vault への認証

本製品 は、次の認証メソッドをサポートしています。

  • Veeva Vault ユーザー資格情報
  • Azure AD 認証プロバイダーのOpenID Connect
  • Okta SSO

ユーザー資格情報

AuthScheme をBasic に設定し、User とPassword をユーザーログイン資格情報に設定します。

AzureAD を使用したOpenID

Azure AD のOpenID Connect は、OAuth を経由する接続タイプです。AuthScheme をAzureAD に設定します。以下のセクションは、すでに設定済みであることを前提として書かれています。

デスクトップアプリケーション

下記の手順に従って、カスタムOAuth アプリの資格情報を使用して認証します。 カスタムAzureAD アプリの作成 を参照してください。

OAuth アクセストークンの取得

以下の接続プロパティグループのいずれかを設定すると、接続できるようになります。

  1. クライアントシークレットを使用した認証
    • OAuthClientId：アプリ設定のクライアントId に設定。
    • OAuthClientSecret：アプリ設定のクライアントシークレットに設定。
    • CallbackURL：アプリ設定のリダイレクトURL に設定。
    • InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
    • Optionally, depending on the required claims to complete the authentication with the Veeva Vault data source, you may need to set additional scopes via the Scope property. For example, to get the user name and email claims from the UserInfo endpoint, you will need to set the scope value to: 'openid profile email offline_access'.
  2. 証明書を使用した認証
    • OAuthClientId：アプリ設定のクライアントId に設定。
    • OAuthJWTCert：JWT 証明書ストアに設定。
    • OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類に設定。
    • CallbackURL：アプリ設定のリダイレクトURL に設定。
    • InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
    • Optionally, depending on the required claims to complete the authentication with the Veeva Vault data source, you may need to set additional scopes via the Scope property. For example, to get the user name and email claims from the UserInfo endpoint, you will need to set the scope value to: 'openid profile email offline_access'.

接続すると、本製品 はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。本製品 はこれでOAuth プロセスを完了します。

  1. コールバックURL からアクセストークンを取得し、リクエストを認証します。
  2. 古いトークンの期限が切れたときは、新しいアクセストークンを取得します。
  3. OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化されるようにします。

Web アプリケーション

Web アプリケーション経由で接続する場合は、 Azure AD 認証プロバイダーを設定するために以前作成したカスタムOAuth アプリを使用する必要があります。 カスタムAzureAD アプリの作成 を参照してください。それから本製品 を使用してOAuth トークンの値を取得および管理します。

OAuth アクセストークンの取得

認証タイプに応じて以下のいずれかの接続プロパティグループを設定して、OAuthAccessToken を取得します。

  1. クライアントシークレットを使用した認証
    • OAuthClientId：アプリ設定のクライアントId に設定。
    • OAuthClientSecret：アプリ設定のクライアントシークレットに設定。
    • Optionally, depending on the required claims to complete the authentication with the Veeva Vault data source, you may need to set additional scopes via the Scope property. For example, to get the user name and email claims from the UserInfo endpoint, you will need to set the scope value to: 'openid profile email offline_access'.
  2. 証明書を使用した認証
    • OAuthClientId：アプリ設定のクライアントId に設定。
    • OAuthJWTCert：JWT 証明書ストアに設定。
    • OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類に設定。
    • Optionally, depending on the required claims to complete the authentication with the Veeva Vault data source, you may need to set additional scopes via the Scope property. For example, to get the user name and email claims from the UserInfo endpoint, you will need to set the scope value to: 'openid profile email offline_access'.

続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。

  1. GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。AuthMode インプットをWEB に、CallbackURL インプットをアプリケーション設定で指定したリダイレクトURI に設定します。必要に応じて、Permissions パラメータを設定してカスタム権限をリクエストします。

    ストアドプロシージャがOAuth エンドポイントのURL を返します。

  2. URL を開き、ログインして、アプリケーションを認可します。コールバックURL にリダイレクトされます。
  3. GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode インプットをWEB に設定します。Verifier インプットを、コールバックURL のクエリ文字列の"code" パラメータに設定します。必要に応じて、Permissions パラメータを設定してカスタム権限をリクエストします。

OAuthAccessToken 接続プロパティをストアドプロシージャで返されたアクセストークンに設定し、データに接続します。ExpiresIn 秒後に、アクセストークンの期限が切れたときは、GetOAuthAccessToken を呼び出し、新しいアクセストークンを取得します。

ヘッドレスマシン

ヘッドレスマシンのユーザーアカウントでOAuth を使用するようにドライバーを設定するには、インターネットブラウザに対応した別の端末で認証する必要があります。

  1. 以下の2つのオプションから選択します。

    • オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
    • オプション2：別のマシンに本製品 をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。

  2. その後、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品 を設定します。

オプション1：Verifier code を取得および交換

Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

  1. 以下のオプションから選択します。

    • 埋め込みOAuth アプリケーションを使用する場合は、Veeva Vault OAuth endpoint をクリックし、ブラウザでエンドポイントを開きます。
    • カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定し、認証URL を作成します。
      • InitiateOAuth：OFF に設定。
      • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
      • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
      次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。

  2. ログインして、本製品 にアクセス許可を与えます。すると、verifier code を含むコールバックURL にリダイレクトされます。
  3. verifier code の値を保存します。後ほどこれをOAuthVerifier 接続プロパティに設定します。
次に、OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換する必要があります。次のプロパティを設定します。

ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。

  • InitiateOAuth：REFRESH に設定。
  • OAuthVerifier：verifier code に設定。
  • OAuthClientId：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントシークレットに設定。
  • OAuthSettingsLocation：ドライバーがOAuth トークン値を保存するファイルの場所に設定。これは接続間で維持されます。

OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットする必要があります。

  • InitiateOAuth：REFRESH に設定。
  • OAuthClientId：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
  • OAuthSettingsLocation：暗号化されたOAuth 認証値が保存される場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

オプション2：OAuth 設定を転送

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続を作成し、インストールする必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続が正常にテストされたら、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。

  • InitiateOAuth：REFRESH に設定。
  • OAuthClientId：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントId に設定。
  • OAuthClientSecret：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
  • OAuthSettingsLocation：OAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

Okta

本製品 は、Okta SAML 2.0 フローをサポートしています。Okta SSO 経由で認証を行う前に、Veeva Vault とOkta インスタンスをVeeva Vault's Okta SSO guide で説明されているように構成する必要があります。

手順に従った後に、以下を設定して接続します。

  • AuthScheme： OKTA
  • User：Okta SSO で使用するOkta アカウントのユーザー名。
  • Password：Okta SSO で使用するOkta アカウントのパスワード。
  • SSOLoginURL：Veeva Vault シングルサインオンプロファイルに関連付けられた"Identify Provider Login URL"。これは、Okta の"Veeva Vault" アプリ統合メニューのView Setup Instructions 画面にある"Identity Provider Login URL" からコピーした値です（上記リンク先のVeeva Vault Okta SSO ガイドのステップ8）。
    • 次のような表示になります： https://dev-XXXXXXXXX.okta.com/app/veeva_vault/XXXXXXXXXXXXXXX/sso/saml
  • SSOExchangeUrl：Veeva Vault シングルサインオンプロファイルに関連付けられた"Vault SSO Login URL"。シングルサインオンプロファイルをVeeva Vault で作成（上記リンク先のVeeva Vault Okta SSO ガイドのステップ12）したのち、Admin -> Settings -> SAML Profiles -> (click your SAML profile's label) -> SAML Single Sign-on Configuration に移動してVeeva Vault でこれを見つけます。
    • 次のような表示になります： https://login.veevavault.com/auth/saml/consumer/_XXXXXXXXXXXXXXXX

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 24.0.9175