NetSuitePut - NetSuiteへの出力

NetSuiteのテーブルに対して更新を行います。

NetSuiteへのアクセスはCData Software Inc.社の提供する技術を利用してRDBのようにSQLでアクセスする手段を提供します。利用できるSQLなどの詳細についてはこちらも参考にしてください。

その他CDataアダプターをご利用する際の注意事項に関してはこちらをご覧ください。

ストリーム情報

入力フォーマットRecord
接続数1
説明 入力ストリームのフィールド定義を専用の設定画面で行います。
このフィールド定義は直前に連結したマッパーの出力ストリームのフィールド定義にコピーされ、そこに対して値のマッピングを行います。そのため、このコンポーネントに連結できるコンポーネントはマッパーのみとなっています。
出力フォーマットRecord
説明

入力ストリームは出力ストリームにコピーされます。

コンポーネントプロパティ

名前データ型マッピング説明
コネクション名connection- 接続先のNetSuiteを指定します。 コネクションペインまたは管理コンソールにて作成されたNetSuite接続名を選択します。
実行する処理choice- 実行する更新操作を指定します。
各モードごとの動作については、下記トピック「実行する処理ごとの動作」を参照してください。
テーブル名stringIn & Out 更新対象のテーブル名を指定します。
値フィールドをクリックすると、テーブル名とフィールドの設定画面が表示されます。ここでフィールド定義を行うことによってテーブル名が自動で設定されます。設定画面については、下記トピック「テーブル名とフィールドの設定」を参照してください。
処理件数intOut 実際に更新されたレコード件数が取得できます。

バッチ処理件数が2以上の場合はバッチ処理になるため、使用するドライバーまたは対象の データベースに依存して正しい件数がとれない場合があります。
件数が不明の場合は-1の値を設定します。
※バッチ処理件数プロパティが表示されないプロパティでは、バッチ処理は対応していません。
バッチ処理件数int- バッチ処理で一度に送信するレコード件数を設定します。
タイムアウト(秒)intIn & Out NetSuiteへ更新文を発行してから結果が返ってくるまでの待ち時間を秒単位で指定します。
指定時間を経過しても実行が終わらない場合は汎用となります。
0の場合はタイムアウトすることはありません。
入力category- 入力ストリームのフィールド定義を行います。実行する処理が「Insert」以外の場合、テーブルのキーとなるカラムの「キーにする」項目で「はい」を指定します。

エラー処理

タイプパラメータエラー処理フローへのストリームエラー
コード
説明
汎用 なし コンポーネントの入力ストリーム なし コネクション名に指定したコネクションが見つからない場合
例外コードテーブルまたはフィールドが見つからない場合
例外コードSQLの実行に失敗した場合
接続エラー なし コンポーネントの入力ストリーム なし NetSuiteとの接続に失敗した場合

フローの強制終了

フローを強制終了すると、通常は実行中のコンポーネントの処理が終了してから次のコンポーネントに制御が遷移する時点でフローがアボートしますが、本コンポーネントでは実行中の処理を強制的に終了してフローがアボートします。

実行する処理ごとの動作

Insert

フィールド定義にあるすべてのフィールドをテーブルにレコードとして挿入します。

Update

「キーにする」項目で「はい」を指定したフィールドにマッチするレコードを、キー以外のフィールドを用いて更新します。
キーにするフィールドを更新することはできません。

Delete

「キーにする」項目で「はい」を指定したフィールドにマッチするレコードを削除します。
キーにするフィールド以外は使用しません。

テーブルとフィールドの設定

NetSuiteのテーブルに対して処理するテーブルとフィールドの選択は、専用のダイアログボックスから行います。 ダイアログボックスから選択すると、インスペクタの入力タブに処理対象フィールドとして表示されます。
キーを指定するには、専用のダイアログボックスでフィールドを選択してから、インスペクタの入力タブでキーとなるフィールドの「キーにする」項目を「はい」にします。
表示名に値を設定することでテーブル上の実際のカラム名とストリーム定義で使用するフィールド名を別にすることができます。

●定義画面を表示する

定義画面を表示するには、以下のいずれかの操作を行います。

●読み込むテーブルを指定する

定義画面を表示すると(1)にテーブルの一覧が表示されます。テーブルを指定すると、(3)(5)に情報が表示されます。

●処理対象フィールドを指定する

テーブルを指定すると、(5)にテーブルのフィールド一覧が表示されます。初期状態では、すべてのフィールドが処理対象になるように(4)のチェックボックスがオンになっています。

フィールドを選択して「OK」をクリックすると、インスペクタの入力タブにフィールド一覧が表示されます。
キーを指定するには、キーとなるフィールドの「キーにする」項目を「はい」にします。
表示名に値を設定することでテーブル上の実際のカラム名とストリーム定義で使用するフィールド名を別にすることができます。

●NetSuite コネクション設定

アカウントId[AccountId]

AccountId is a unique identifier provided by NetSuite that designates your company's account. It must match the account configuration used for authentication.

This property is required for all connection types, including Token-Based Authentication (TBA) and OAuth 2.0.

Note: While User and Password were used in earlier versions of NetSuite (prior to 2020), these credentials are now deprecated. Use TBA or OAuth credentials instead for secure authentication.

Account Supports Suite Analytics Connect[AccountSupportsSuiteAnalyticsConnect]

This property is useful for accounts interacting with large datasets.

  • If SuiteAnalytics Connect is set to false, the API limits query results to 100,000 records. In such cases, the 本製品 slices queries into multiple smaller queries, grouping them by range filters on the primary key column.
  • If SuiteAnalytics Connect is set to true, the API can return unlimited results. To avoid query slicing, ensure this feature is enabled for the account and set this property to true.

The 本製品 attempts to auto-detect whether SuiteAnalytics Connect is enabled. However, this detection may fail if the authenticated account lacks the necessary permissions to check enabled features.


Default Value: false
Aggregate Column Mode[AggregateColumnMode]

Aggregate columns consolidate all data from child collections into the base table, which can lead to significant size and complexity. This property determines how these columns are handled, balancing usability with performance.

In scenarios like writing data to an offline database, consider setting this property to Ignore or List. Child data remains accessible through child tables if IncludeChildTables is set to true.

Setting AggregateColumnMode to List still allows aggregate columns to be included in INSERT and UPDATE operations.

This property applies only when Schema is set to SuiteTalk.

ValueDescription
IgnoreAggregate columns are ignored entirely and do not appear in the table schema.
ListAggregate columns are included in the schema for all tables. However, on base tables such as SalesOrders, these columns do not return data from NetSuite.
ListAndRetrieveAggregate columns are included in the schema and return data when queried, for all applicable tables.


Default Value: Ignore
Possible Values:
Ignore0
List1
ListAndRetrieve2
Application Id[ApplicationId]

You can locate or create an Application ID in the NetSuite UI under Setup > Integration > Manage Integrations.

It is recommended to create a dedicated Application ID for your integration to maximize session availability and avoid potential conflicts caused by shared IDs.

Auth Key[AuthKey]

このプロパティは、OAuth 1.0でヘッドレス認証を実行する場合にのみ必要です。これは、GetOAuthAuthorizationUrl ストアドプロシージャから取得できます。

GetOAuthAccessToken ストアドプロシージャでAuthToken とともに指定して、OAuthAccessToken を取得できます。

認証スキーム[AuthScheme]

This property determines how the NetSuite authenticates with NetSuite.

Supported values are:

  • OAuth: Uses standard OAuth 2.0 authentication, with dynamically generated tokens.
  • Token: Uses Token-Based Authentication (TBA) with manually created tokens inside of NetSuite.
  • OAuthJWT: Uses OAuth 2.0 with JSON Web Tokens (JWT) for server-to-server authentication. This option is supported with the SuiteQL schema.
  • Basic (Deprecated): Uses a username and password to authenticate. This method is no longer supported for NetSuite accounts using API version 2020 or later.

The available authentication options depend on the Schema being used:

  • SuiteTalk: Supports Token authentication only. Legacy API versions may support Basic.
  • SuiteQL: Supports Token, OAuth, and OAuthJWT.


Default Value: Token
Possible Values:
Basic0
Token1
OAuth2
OAuthJWT3
Auth Token[AuthToken]

このプロパティは、OAuth 1.0でヘッドレス認証を実行する場合にのみ必要です。これは、GetOAuthAuthorizationUrl ストアドプロシージャから取得できます。

GetOAuthAccessToken ストアドプロシージャでAuthKey とともに指定して、OAuthAccessToken を取得できます。

Auto Cache[AutoCache]

この接続プロパティがTrue に設定されている場合、本製品 はSELECT クエリの対象となるテーブルの内容を自動的にキャッシュします。これらのテーブルの内容は、CacheConnection およびCacheDriver 接続プロパティで指定されたキャッシュデータベースにキャッシュされます。

関連項目

その他の情報については、以下を参照してください:

  • CacheMetadataCacheMetadata を有効にすると、取得されたすべてのメタデータはキャッシュデータベースにミラーリングされます。これは、本製品 が以降にメタデータを検出しようとする場合に、メタデータがキャッシュデータベースから直接読み取られNetSuite にメタデータをリクエストする時間が不要になるため、より高速になることを意味します。
  • 明示的なデータのキャッシュ:このトピックでは、AutoCacheOffline モードで使用する例を示します。
  • CACHE ステートメント:CACHE ステートメントを使用して、SELECT クエリの対象となる任意のテーブルの内容を明示的にキャッシュできます。


Default Value: false
Browsable Schemas[BrowsableSchemas]

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

Cache Connection[CacheConnection]

対象のキャッシュデータベースは、この接続プロパティとCacheDriver 接続プロパティの組み合わせによって決定されます。指定されたキャッシュデータベースを使用するには、両方のプロパティが必要です。

この接続プロパティで指定された接続文字列は、CacheDriver 接続プロパティで指定されたJDBC ドライバーに直接渡されます。使用可能な接続プロパティの詳細については、指定されたJDBC ドライバー のドキュメントを参照してください。

CacheDriver で指定したJDBC ドライバーがアプリケーションのクラスパスに含まれていることを確認してください。

以下に、一般的なキャッシュデータベースの設定例を示します。

Derby およびJava DB

CacheDriver とこの接続プロパティを使用して、Derby への接続を設定します。以下は、Derby JDBC URL 構文です。

jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]
例えば、インメモリデータベースにキャッシュするには、以下を使用します。
jdbc:derby:memory

SQLite

SQLite へキャッシュするにはSQLite JDBC ドライバーを使用できます。次はJDBC URL の構文です。

jdbc:sqlite:dataSource
  • Data Source:SQLite データベースファイルへのパス。または、:memoryの値を使ってインメモリにキャッシュします。

MySQL

以下はCData JDBC Driver for MySQL のJDBC URL の例です。

jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
一般的な接続プロパティは次のとおりです:

  • Server:キャッシュ先のMySQL データベースをホストしているサーバーのIP アドレスまたはドメイン名。
  • Port:指定されたサーバー上のMySQL インスタンスが実行されているポート。
  • Database:キャッシュ先のMySQL データベースの名前。指定されたサーバーでホストされているMySQL データベースの名前と一致する必要があります。
  • User:選択したMySQL データベースに登録されているユーザーのユーザー名。
  • Password:指定されたMySQL ユーザーに紐付けられたパスワード。

SQL Server

Microsoft JDBC Driver for SQL Server のJDBC URL の構文は次のとおりです。

jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]
次に例を示します。
jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true
次は一般的なSQL Server 接続プロパティです。

  • Server:SQL Server を起動しているコンピューターの名前またはネットワークアドレス名。デフォルトのインスタンスではなく、名前付きインスタンスに接続するには、ホスト名とインスタンス名をバックスラッシュで区切って指定します。
  • Port:指定されたサーバー上のSQL Server インスタンスが実行されているポート。
  • Database:キャッシュ先のSQL Server データベースの名前。指定されたサーバーでホストされているSQL Server データベースの名前と一致する必要があります。
  • Integrated Security:現在のWindows アカウントを認証に使用する場合は、このオプションをTrue に設定します。代わりにUser とPassword で認証するには、このオプションをFalse に設定します。

    統合セキュリティを使用するには、Windows システムパス上のフォルダにsqljdbc_auth.dll も追加する必要があります。このファイルは、Microsoft JDBC Driver for SQL Server インストールの"auth" サブフォルダにあります。アセンブリのビット数はJVM のビット数と一致する必要があります。

  • User Id:選択したSQL Server データベースに登録されているユーザーのユーザー名。このプロパティは、統合セキュリティを使用していない場合にのみ必要です。
  • Password:指定されたSQL Server ユーザーに紐付けられたパスワード。このプロパティは、統合セキュリティを使用していない場合にのみ必要です。

Oracle

次はOracle JDBC Thin ドライバーの従来のJDBC URL 構文です。

jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]
次に例を示します。
jdbc:oracle:thin:scott/tiger@myhost:1521:orcl
次は一般的な接続プロパティです。

  • Data Source:Oracle データベースを識別する接続記述子。これは、TSN 接続記述子、接続記述子を決定するOracle Net Services 名、またはバージョン11g 以降ではEasy Connect ネーミング(任意のポート名およびサービス名を持つOracle サーバーのホスト名)になります。

  • User Id:選択したOracle データベースに登録されているユーザーのユーザー名。
  • Password:指定されたOracle ユーザーにに紐付けられたパスワード。

PostgreSQL

次は公式のPostgreSQL JDBC ドライバーのJDBC URL 構文です。

jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]
例えば、次の接続文字列はデフォルトホスト(localhost)およびポート(5432)上のデータベースに接続します。
jdbc:postgresql:postgres
一般的な接続プロパティは次のとおりです:

  • Host:PostgreSQL データベースをホストしているサーバーのアドレス。
  • Port:指定されたホストサーバー上のPostgreSQL データベースがホストされているポート。
  • Database:キャッシュ先のPostgreSQL データベースの名前。指定されたサーバーでホストされているPostgreSQL データベースの名前と一致する必要があります。
  • User name:選択したPostgreSQL データベースに登録されているユーザーのユーザー名。"user" パラメータを使ってJDBC URL に指定できます。
  • Password:指定されたユーザーに紐付けられたパスワード。

Cache Driver[CacheDriver]

CData JDBC drivers を含むJDBC ドライバーが用意されている任意のデータベースにキャッシュできます。

Note:指定されたJDBC ドライバーのJAR ファイルをクラスパスに追加する必要があります。CData JDBC drivers の場合、このJAR ファイルはドライバーのインストールディレクトリの"lib" サブフォルダにあります。

また、CacheConnection 接続プロパティを設定して、指定されたJDBC ドライバーの接続文字列を入力する必要があります。

次の例は、いくつかの主要なデータベースにキャッシュする方法を示しています。 JDBC URL 構文および一般的な接続プロパティの詳細については、CacheConnection を参照してください。

Derby およびJava DB

Java DB は、Derby のOracle ディストリビューションです。Java DB にキャッシュするには、Derby JDBC ドライバーのJAR ファイルであるderbytools.jar をクラスパスに追加する必要があります。

Derby JDBC ドライバーのJAR ファイルは、このページからダウンロードできるdb-derby-10.17.1.0-bin.zip に同梱されています。derbytools.jar はこのzip ファイルの"lib" サブフォルダにあります。

クラスパスにderbytools.jar を追加した後、以下のようにJava DB データベースにキャッシュすることができます。

jdbc:netsuite:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:sample';AccountId=XABC123456;Schema=SuiteTalk;AuthScheme=Token;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;OAuthAccessToken=MyOAuthAccessToken;OAuthAccessTokenSecret=MyOAuthAccessTokenSecret;
インメモリデータベースにキャッシュするには、次のようにJDBC URL を使用します。
jdbc:netsuite:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';AccountId=XABC123456;Schema=SuiteTalk;AuthScheme=Token;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;OAuthAccessToken=MyOAuthAccessToken;OAuthAccessTokenSecret=MyOAuthAccessTokenSecret;

SQLite

次はSQLite JDBC ドライバーのJDBC URL です。

jdbc:netsuite:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';AccountId=XABC123456;Schema=SuiteTalk;AuthScheme=Token;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;OAuthAccessToken=MyOAuthAccessToken;OAuthAccessTokenSecret=MyOAuthAccessTokenSecret;

MySQL

以下はCData JDBC Driver for MySQL のJDBC URL です。

  jdbc:netsuite:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';AccountId=XABC123456;Schema=SuiteTalk;AuthScheme=Token;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;OAuthAccessToken=MyOAuthAccessToken;OAuthAccessTokenSecret=MyOAuthAccessTokenSecret;
  

SQL Server

次のJDBC URL はMicrosoft JDBC Driver for SQL Server を使用しています。

jdbc:netsuite:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';AccountId=XABC123456;Schema=SuiteTalk;AuthScheme=Token;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;OAuthAccessToken=MyOAuthAccessToken;OAuthAccessTokenSecret=MyOAuthAccessTokenSecret;

Oracle

次はOracle Thin Client のJDBC URL です。

jdbc:netsuite:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';AccountId=XABC123456;Schema=SuiteTalk;AuthScheme=Token;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;OAuthAccessToken=MyOAuthAccessToken;OAuthAccessTokenSecret=MyOAuthAccessTokenSecret;
NOTE:9i より前のバージョンのOracle を使用している場合は、キャッシュドライバーは代わりにoracle.jdbc.driver.OracleDriver になります。

PostgreSQL

次のJDBC URL は公式のPostgreSQL JDBC ドライバーを使用しています。

jdbc:netsuite:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';AccountId=XABC123456;Schema=SuiteTalk;AuthScheme=Token;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;OAuthAccessToken=MyOAuthAccessToken;OAuthAccessTokenSecret=MyOAuthAccessTokenSecret;

Cache Location[CacheLocation]

CacheLocation は単純なファイルベースキャッシュです。

本製品 はDerby データベースのOracle のディストリビューションあるJava DB をファイルベースのキャッシュに使用しています。Java DB にキャッシュするには、Derby JDBC ドライバーのJAR ファイルであるderbytools.jar をクラスパスに追加する必要があります。

Derby JDBC ドライバーのJAR ファイルは、このページからダウンロードできるdb-derby-10.17.1.0-bin.zip に同梱されています。derbytools.jar はこのzip ファイルの"lib" サブフォルダにあります。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\NetSuite Data Provider となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます。

プラットフォーム %APPDATA%
Windows APPDATA 環境変数の値
Mac ~/Library/Application Support
Linux ~/.config

関連項目

  • AutoCache:後のオフライン使用のために、暗黙的にキャッシュを作成して維持するように設定します。
  • CacheMetadata:NetSuite カタログをCacheLocation に永続化するように設定します。


Default Value: %APPDATA%\\CData\\NetSuite Data Provider
Cache Metadata[CacheMetadata]

この接続プロパティがTrue に設定されている場合、クエリを実行すると、NetSuite カタログのテーブルメタデータはCacheConnectionCacheDriver で指定されたキャッシュデータベースにキャッシュされ、もしこれらの接続プロパティが設定されていない場合はユーザーのホームディレクトリにキャッシュされます。

ホームディレクトリの場所はプラットフォームによって異なります。

プラットフォームホームディレクトリ
Windows %APPDATA%\\CData\\NetSuite Data Provider
Mac ~/Library/Application Support/CData/NetSuite Data Provider
Unix ~/.config/CData/NetSuite Data Provider

テーブルのメタデータの取得は、テーブルがはじめてクエリされた際に一度だけ行われます。

CacheMetadata を使用するタイミング

本製品 がメタデータ検索で取得するNetSuite テーブルとカラムの数が多い場合、本製品 がすべてのテーブルメタデータをリストするのに時間がかかることがあります。

次のような場合に、メタデータの取得に時間がかかることがあります。

  • 使用しているNetSuite インスタンスのテーブル数が多い。
  • 本製品 が、接続プロパティによってデフォルト設定よりも多くのテーブルを検出するように設定されている。
  • 本製品 に対して多くの短期間接続を行っている。
CacheMetadata を有効にすると、取得されたすべてのメタデータはキャッシュデータベースにミラーリングされます。これは、本製品 が以降にメタデータを検出しようとする場合に、メタデータがキャッシュデータベースから直接読み取られNetSuite にメタデータをリクエストする時間が不要になるため、より高速になることを意味します。

CacheMetadata を使用しないタイミング

本製品 は、はじめてテーブルやビューのメタデータを発見したときから最大1時間、そのメタデータをメモリに自動的に保持するため、通常はCacheMetadata は必要ありません。

CacheMetadata は、変動しやすいメタデータを扱うシナリオでは理想的ではありません。はじめてテーブルをクエリするとき、本製品 はそのメタデータをキャッシュデータベースファイルにキャッシュします。このキャッシュはテーブルスキーマの更新を反映するために動的に更新されることはないため、新規、変更、削除されたカラムを取得するには、キャッシュデータベースファイルを削除して再構築する必要があります。


Default Value: false
Cache Tolerance[CacheTolerance]

キャッシュ内のテーブルに対してクエリを実行すると、本製品 はキャッシュの最終更新から経過した時間を確認します。

キャッシュの最終更新がこの接続プロパティの値(秒単位)よりも前の場合、本製品 はキャッシュを更新します。

それ以外は、本製品 はキャッシュから直接データを返します。


Default Value: 600
コールバックUrl[CallbackURL]

カスタムOAuth アプリケーションを作成した場合、OAuth 認可サーバーは認証プロセス中にユーザーをこのURL にリダイレクトします。 この値は、カスタムOAuth アプリケーションの設定時に指定したコールバックURL と一致する必要があります。

Connection Life Time[ConnectionLifeTime]

このプロパティを0(デフォルト)より大きい値に設定すると接続の有効期間が制限され、その後本製品 が接続を終了します。

このプロパティを空白のままにするか、0 に設定すると、接続は明示的に閉じられるか、ネットワークの中断やセッションのタイムアウトなどの外部要因によって終了されるまで開いたままになります。

このプロパティは、リソースの利用状況を管理し、古くなった接続やアイドル状態の接続が無期限に持続するのを防ぐのに役立ちます。


Default Value: 0
Connect On Open[ConnectOnOpen]

ConnectOnOpenTrue の場合、プロバイダーは「接続テスト」操作を実行します。これは、データベースツールで接続性を検証するために一般的に使用されます。 この操作はセッションデータを保持しません。代わりに、接続が確立できるかどうかを確認し、NOOP(操作なし)コマンドのように機能します。

ConnectOnOpenFalse の場合、接続は操作が必要になるまで遅延されます。これは、接続が頻繁に開閉されるがすぐに操作が行われないような状況でパフォーマンスが向上する場合があります。


Default Value: false
Custom Field Permissions[CustomFieldPermissions]

Use this property to control which types of custom fields are included in the schema. This is useful when the authentication role has access to only certain custom fields.

If set, this property takes precedence over IncludeCustomFieldColumns, which enables or disables all custom fields. For example, to specify all of the custom field permissions for all available tables, set this to:

Custom Body Fields, Custom Column Fields, Custom Entity Fields, Custom Event Fields, Custom Item Fields, Item Number Fields, Other Custom Fields
This property only applies when Schema is set to SuiteTalk.

Firewall Password[FirewallPassword]

プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Firewall Port[FirewallPort]

プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。


Default Value: 0
Firewall Server[FirewallServer]

プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Firewall Type[FirewallType]

プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note:デフォルトでは、本製品 はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetectfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。

プロトコル デフォルトポート 説明
TUNNEL 80 本製品 がNetSuite への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4 1080 本製品 がNetSuite への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5 1080 本製品 がNetSuite にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthSchemeProxyUser、およびProxyPassword を使ってください。


Default Value: NONE
Possible Values:
NONE0
TUNNEL1
SOCKS42
SOCKS53
Firewall User[FirewallUser]

プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Include Child Tables[IncludeChildTables]

When set to true, tables are displayed for all child lists of a given entity. For example, in the NetSuite development environment, the CashRefund table has a child list called ItemList. If this property is enabled, a table named CashRefund_ItemList is displayed, listing each item in the child list as its own row.

This property applies only when Schema is set to SuiteTalk.

Performance Considerations

Enabling this property can significantly increase the number of tables generated and the amount of data processed during schema discovery. This may impact performance, especially for large datasets or metadata-heavy accounts. Users who do not need access to child lists should set this property to false.


Default Value: false
Include Custom Field Columns[IncludeCustomFieldColumns]

When set to true, custom fields are displayed as separate columns in tables. This can simplify querying, but may decrease performance when retrieving table metadata for the first time in a connection.

Table metadata is stored within the connection and is cleared when the connection is closed.

This property applies only when Schema is set to SuiteTalk.

Note that not all custom fields can be returned for each table when AuthScheme is set to OAuth, due to limitations in NetSuite. To ensure that all custom fields are retrieved, it is recommended to use Token-Based authentication.


Default Value: true
Include Custom List Tables[IncludeCustomListTables]

When set to true, custom list types are included as separate tables. This can simplify data access, but may reduce performance when retrieving table metadata for the first time in a connection.

Table metadata is stored within the connection and is cleared when the connection is closed.

This property applies only when Schema is set to SuiteTalk.


Default Value: false
Include Custom Record Tables[IncludeCustomRecordTables]

When set to true, custom record types are included as separate tables. This can simplify data access but may reduce performance when retrieving table metadata for the first time in a connection.

Table metadata is stored within the connection and is cleared when the connection is closed.

This property applies only when Schema is set to SuiteTalk.


Default Value: true
Include Long Text Columns[IncludeLongTextColumns]

NetSuite supports long and rich text custom fields, known as Long Text fields. These fields can contain up to 1,000,000 characters.

When IncludeLongTextColumns set to true, these fields are included in the metadata and can be queried like other columns.

This property applies only when Schema is set to SuiteQL.


Default Value: false
Include Reference Columns[IncludeReferenceColumns]

Many fields in NetSuite reference other records. For example, an Invoice might reference an Account and a Customer record. This property determines which pieces of data are included when retrieving values from reference fields.

The available values are:

ValueDescription
InternalIdThe NetSuite foreign key for the record reference.
NameA readable name for the record referenced.
TypeThe type of record referenced. This is not always given a value as the given field may only have one type.

This property applies only when Schema is set to SuiteTalk.


Default Value: InternalId, Name
イニシエートOAuth[InitiateOAuth]

OAuth は、アプリケーションがHTTP サービス上のユーザーアカウントに限定的にアクセスすることを可能にする認可フレームワークです。OAuth フローは、以下の用途で使用される方法を定義します。

  • ユーザーのログイン。
  • 認証に使用するOAuth アクセストークンとユーザー認証情報の交換。
  • アプリケーションへの限定的なアクセスの提供。

OAuth アクセスの開始と維持のオプションは、本製品 が処理するフローの部分に基づいて命名されています。

OFF 本製品 はOAuth フローの自動開始を提供しません。OAuth フローはユーザーによってすべて操作されます。
つまり、ユーザーがトークンを手動でリフレッシュし、現在のトークンが期限切れになった際に更新されたOAuthAccessToken プロパティで再接続する必要があります。
GETANDREFRESH 本製品 が完全なOAuth フロー(GET とREFRESH の両方)を処理します。つまり、トークンが既に存在する場合は本製品 が必要に応じて更新し、その時トークンが存在しない場合は本製品 がユーザーにログインを促してトークンを取得します。
REFRESH ユーザーがOAuth アクセストークンを取得し、OAuth アクセストークンのリフレッシュシーケンスを設定します。(ユーザーは認証のためにログインを求められることはありません。)ユーザーがログインした後、本製品 がOAuthアクセストークンのリフレッシュを操作します。)


Default Value: OFF
Possible Values:
OFF0
REFRESH1
GETANDREFRESH2
JWT Scope[JWTScope]

Use this property to indicate one or more scopes required for the JWT-based OAuth connection.

Valid values include:

  • restlets: Grants access to RESTlet scripts.
  • rest_webservices: Grants access to REST web services.
  • suite_analytics: Grants access to SuiteAnalytics data sources.

You can specify multiple scopes by separating them with commas. For example:

restlets,rest_webservices

Location[Location]

Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

Note: 本製品 は複数のスキーマをサポートするため、NetSuite のカスタムスキーマファイルは以下のような構造にになります。

  • 各スキーマには、そのスキーマ名に対応するフォルダが作られます。
  • すべてのスキーマフォルダは、親フォルダに含まれる必要があります。

Location は常に親フォルダに設定されるべきで、個々のスキーマのフォルダに設定すべきではありません。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\NetSuite Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:

プラットフォーム %APPDATA%
Windows APPDATA 環境変数の値
Mac ~/Library/Application Support
Linux ~/.config


Default Value: %APPDATA%\\CData\\NetSuite Data Provider\\Schema
Logfile[Logfile]

このプロパティは、認証イベント、クエリ実行、接続の詳細など、本製品 の操作を記録するログファイルの場所と名前を指定します。 指定されたファイルが存在しない場合、本製品 はそのファイルを作成します。本製品 を実行しているユーザーまたはサービスが、指定されたパスまたはファイルへの書き込み権限を持っていることを確認してください。 適切な権限がない場合、ログファイルは作成されません。

パスワードやトークンなどの接続文字列の機密情報は、ログで自動的にマスキングされます。 ただし、データ自体に含まれる機密情報はマスキングされない可能性があります。

Logfile に相対パスを指定し、Location プロパティが設定されている場合、そのディレクトリがログファイルのベースパスとして使用されます。

追加プロパティにより、ログの動作をカスタマイズできます。

  • ログファイルの詳細レベルを制御するには、Verbosity を使用します。
  • MaxLogFileSize でログファイルのサイズを管理し、MaxLogFileCount で保持するログファイルの数を制御します。
  • LogModules プロパティを調整することで、特定のログモジュールをフィルタリングします。

Java のログ出力

Java のログ出力をサポートするには、Logfile プロパティを次のように設定します:
Logfile=JAVALOG://myloggername

ここで、JAVALOG:// は必須のプレフィックスで、myloggername はロガーの名前です。

Logfile プロパティが適切に設定されると、指定されたロガーのgetLogger メソッドが呼び出され、指定された値を使用してLogger インスタンスが作成されます。ログ出力インスタンスがすでに存在する場合、この呼び出しは既存のインスタンスを参照します。

Java のログ出力が有効になっている場合、Verbosity は自動的に特定のログレベルに対応します。

Log Modules[LogModules]

このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。

例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります:INFO;EXEC;SSL。

Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。

利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ高度なログの記録セクションを参照してください。

Maximum Concurrent Sessions[MaximumConcurrentSessions]

Starting with NetSuite 2020.1, this value is obtained automatically based on AccountId and ApplicationId when Schema is set to SuiteTalk. If SuiteQL is used and this property isn't specified, the 本製品 defaults to using one maximum concurrent session.

Concurrent sessions are only available when using Token-Based Authentication (TBA). Connections that use user/password authentication are limited to a single session.

To prevent excessive concurrent requests from failing, NetSuite automatically manages requests to stay within session limits. If your account supports more than the default number of sessions, you can manually set MaximumConcurrentSessions to reflect the higher limit.


Default Value: 0
Max Log File Count[MaxLogFileCount]

各ログファイル名には、識別しやすいように日付と時刻が含まれています。

このプロパティには以下の値を指定できます。

  • 2以上の値を設定すると、保持されるログファイルの最大数が設定されます。
  • 値が1の場合、ログファイルは1つだけ保持されます。最大サイズに達すると、ファイルは削除され新しいファイルに置き換えられます。これにより、現在のログ以外の履歴は残りません。
  • 0または負の値を設定すると、ログファイルの数に制限がなくなりログ記録が無期限に続きます。

ログファイルのサイズを管理するには、MaxLogFileSize プロパティを使用します。これらの2つのプロパティは、ログフォルダ内のログファイルのサイズと保持を制御するために連携して動作します。


Default Value: -1
Max Log File Size[MaxLogFileSize]

100 KB より小さい値の場合、本製品 は100 KB を最小許容サイズとして使用します。

保持されるログファイルの総数を制御するには、このプロパティとMaxLogFileCount プロパティを組み合わせて使用します。 これらのプロパティを組み合わせることで、ログファイルのサイズと保持を効果的に管理できます。


Default Value: 100MB
Max Rows[MaxRows]

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。


Default Value: -1
Netsuite Date Format[NetsuiteDateFormat]

The preferred date format set in NetSuite UI. This format should be used when filtering based on Date. You can change the date format in NetSuite UI using Home -> Set Preferences -> Formatting.

Available values are: 'M/D/YYYY', 'D/M/YYYY', 'D.M.YYYY', 'D-MONTH-YYYY', 'D MONTH, YYYY', 'YYYY/M/D', 'YYYY-M-D', 'DD/MM/YYYY', 'DD-MON-YYYY', 'DD.MM.YYYY', 'DD-MONTH-YYYY', 'DD MONTH, YYYY', 'MM/DD/YYYY', 'YYYY/MM/DD', 'YYYY-MM-DD'.

Note:This property is only applicable for SuiteQL Schema. If the two formats are mismatched, the server throws an exception.

This property only applies when Schema is set to SuiteQL.


Default Value: MM-dd-yyyy
Netsuite Long Date Format[NetsuiteLongDateFormat]

The preffered long date format set in NetSuite UI. This format should be used when filtering based on long date. You can change the long date format in NetSuite UI using Home -> Set Preferences -> Formatting

Available values are: 'Month D, YYYY', 'D Month YYYY', 'YYYY Month D', 'Month DD, YYYY', 'DD Month YYYY', 'YYYY Month DD'.

Note:This property is only applicable for SuiteQL Schema. If the two formats are mismatched, the server throws an exception.

This property only applies when Schema is set to SuiteQL.


Default Value: MMM dd, yyyy
Netsuite Metadata Folder[NetsuiteMetadataFolder]

To reduce unnecessary overhead, the 本製品 downloads metadata files from the NetSuite API and stores them in the specified directory.

  • If NetsuiteMetadataFolder is not set, the location specified by Location is used.
  • If the directory is empty, the 本製品 downloads schema files from NetSuite and uses them for subsequent metadata queries.
  • Metadata files are stored in XSD format and include only statically defined tables and views for the specified NetSuite version. Custom fields and tables are not included.
  • A separate subfolder is created for each NetSuite version that you connect to.

OAuthアクセストークン[OAuthAccessToken]

OAuthAccessToken は、保護されたリソースへのアクセスを認可する一時的な認証情報です。 これは通常、ユーザーまたはクライアントアプリケーションがOAuth 認証フローを完了した後に、ID プロバイダーから返されます。 このプロパティは、自動化されたワークフローや、トークンの処理をドライバーの外部で管理したいカスタムOAuth 実装で最も一般的に使用されます。

OAuth アクセストークンにはサーバーに依存する時間制限があり、ユーザーのアクセスを制限します。 タイムアウトは、OAuthExpiresIn プロパティを使用して設定します。ただし、ユーザーが操作を続けている限り、リクエスト間で再発行することでアクセスを維持することができます。

InitiateOAuthREFRESH に設定されている場合、OAuthExpiresInOAuthTokenTimestamp の両方を設定することを推奨します。 本製品 は、これらのプロパティを使用してトークンの有効期限を判断し、最も効率的にリフレッシュできるようにします。 OAuthExpiresIn およびOAuthTokenTimestamp が指定されていない場合、本製品 はトークンを直ちにリフレッシュします。

Note:アクセストークンは機密性の高い認証情報として扱い、安全に保管する必要があります。アクセス制御されていないログ、スクリプト、または設定ファイルでの公開は避けてください。

OAuthアクセストークンシークレット[OAuthAccessTokenSecret]

OAuth を使用して接続および認証するには、OAuthAccessTokenSecret プロパティが使用されます。認証プロセスにおいてOAuth サーバーからOAuthAccessTokenSecret が取得されます。取得されたトークンシークレットは OAuthAccessToken と一緒に使用され、タイムアウトするまで複数の要求のために使用されます。

OAuthクライアントID[OAuthClientId]

このプロパティは2つのケースで必要となります:

  • カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
  • ドライバーが埋め込みOAuth 資格情報を提供しない場合。

(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでに本製品 によって設定されており、手動で入力する必要がないことがあります。)

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecretOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client IDApplication IDConsumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

OAuthクライアントシークレット[OAuthClientSecret]

このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes:

  • この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
  • クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

OAuth Expires In[OAuthExpiresIn]

OAuth アクセストークンは認証済みのユーザーに割り当てられ、そのユーザーに指定された期間のネットワークへのアクセスを許可します。アクセストークンはユーザーのログインID とパスワードの代わりに使用され、サーバーに保持されます。

サーバーによって作成されたアクセストークンは、限定された時間のみ有効です。OAuthExpiresIn は、トークンが作成されてから有効である秒数です。例えば、2024-01-29 20:00:00 UTC に生成され、2024-01-29 21:00:00 UTC(1時間後)に期限切れとなるトークンは、現在の時刻に関係なくOAuthExpiresIn の値は3600です。

ユーザーがアクセストークンの有効期限が切れるまでの時間を確認するには、OAuthTokenTimestamp をチェックします。

OAuth JWT Cert[OAuthJWTCert]

OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword を使用してパスワードを指定します。

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値が設定され、かつOAuthJWTCertSubject が設定されている場合、CData JDBC Driver for NetSuite 2025J は証明書の検索を開始します。 詳しくは、OAuthJWTCertSubject を参照してください。

証明書ストアの指定はプラットフォームに依存します。

注記

  • Windows の共通のユーザーとシステム証明書ストアは以下のとおりです。
    • MY:個人証明書と関連付けられた秘密キーを 格納している証明書ストア。
    • CA:証明機関の証明書。
    • ROOT:ルート証明書。
    • SPC:ソフトウェア発行元証明書。
  • Javaでは、証明書ストアは通常、証明書および 任意の秘密キーを含むファイルです。
  • 証明書ストアの種類がPFXFile の場合は、 このプロパティにファイル名を設定します。
  • PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ(例えば、PKCS12証明書ストア)に設定する必要があります。

OAuth JWT Cert Password[OAuthJWTCertPassword]

このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。

OAuth JWT Cert Subject[OAuthJWTCertSubject]

このプロパティの値は、ストアで一致する証明書を検索するために使用されます。検索プロセスは以下のように動作します。

  • サブジェクトに完全に一致する証明書が見つかれば、該当する証明書が選択されます。
  • 完全に一致するものがない場合、ストアは、サブジェクトがプロパティ値を含む証明書を検索します。
  • 一致する証明書がない場合、証明書は選択されません。

値を '*' に設定すると、ストアの先頭の証明書が自動的に選択されます。 証明書のサブジェクトは識別名フィールドおよび値のカンマ区切りのリストです。 例:CN=www.server.com, OU=test, C=US, E=support@cdata.com

一般的なフィールドには以下のものが含まれます。

フィールド説明
CN共通名。一般的には、www.server.com のようなホスト名です。
O法人名
OU法人の部署名
L法人の住所(市町村名)
S法人の住所(都道府県)
C国名
EE メールアドレス

フィールド値にカンマが含まれる場合は、引用符で囲んでください。例:"O=ACME, Inc."


Default Value: *
OAuth JWT Cert Type[OAuthJWTCertType]

説明注記
USER現在のユーザーが所有する証明書ストア。 Windows のみ使用可能です。
MACHINEマシンストア。Java やその他の非Windows 環境では使用できません。
PFXFILE証明書を含むPFX(PKCS12)ファイル。
PFXBLOBPFX(PKCS12)形式の証明書ストアをbase-64 でエンコードした文字列。
JKSFILE証明書を含むJava キーストア(JKS)ファイル。Java 専用。
JKSBLOBJava キーストア(JKS)形式の証明書ストアをbase-64 でエンコードした文字列。 Java 専用。
PEMKEY_FILE秘密鍵とオプションの証明書を含むPEM でエンコードされたファイル。
PEMKEY_BLOB秘密鍵とオプションの証明書をbase-64 でエンコードした文字列。
PUBLIC_KEY_FILEPEM またはDER でエンコードされた公開鍵証明書を含むファイル。
PUBLIC_KEY_BLOBPEM またはDER でエンコードされた公開鍵証明書をbase-64 でエンコードした文字列。
SSHPUBLIC_KEY_FILESSH 形式の公開鍵を含むファイル。
SSHPUBLIC_KEY_BLOBSSH 形式の公開鍵ををbase-64 でエンコードした文字列。
P7BFILE証明書を含むPKCS7 ファイル。
PPKFILEPuTTY 秘密キー(PPK)を含むファイル。
XMLFILEXML 形式の証明書を含むファイル。
XMLBLOBXML 形式の証明書を含む文字列。
BCFKSFILEBouncy Castle キーストアを含むファイル。
BCFKSBLOBBouncy Castle キーストアを含む文字列(base-64エンコード)。


Default Value: USER
Possible Values:
USER0
MACHINE1
PFXFILE2
PFXBLOB3
JKSFILE4
JKSBLOB5
PEMKEY_FILE6
PEMKEY_BLOB7
PUBLIC_KEY_FILE8
PUBLIC_KEY_BLOB9
SSHPUBLIC_KEY_FILE10
SSHPUBLIC_KEY_BLOB11
P7BFILE12
PPKFILE13
XMLFILE14
XMLBLOB15
BCFKSFILE16
BCFKSBLOB17
OAuth JWT Encryption[OAuthJWTEncryption]

This property can take one of the following values:

RS256, RS384, RS512RSA signature with SHA hashing (SHA-256, SHA-384, SHA-512)
ES256, ES384, ES512ECDSA signature with NIST curves (P-256, P-384, P-512) and SHA hashing (SHA-256, SHA-384, SHA-512)
HS256, HS384, HS512HMAC signature with SHA hashing (SHA-256, SHA-384, SHA-512)


Default Value: ES256
Possible Values:
ES2560
ES3841
ES5122
HS2563
HS3844
HS5125
OAuth JWT Encryption Key[OAuthJWTEncryptionKey]

このプロパティは、OAuthJWTEncryption がHMAC 署名方式に設定されている場合に必須であり、そうでない場合は使用されません。

値は、base64 でエンコードされたHMAC キーです。 キー自体の長さは任意ですが、必要に応じて本製品 がキーをパディングまたはハッシュして、選択したOAuthJWTEncryption メソッドの要件に合わせます。 ベストなセキュリティを得るためには、キーは少なくともハッシュの計算量と同じ長さである必要があります(例えば、SHA-256 の場合は32バイト)。

OAuth JWT Headers[OAuthJWTHeaders]

各ヘッダーは等号で区切られた名前と値のペアです。名前と値のペアはそれぞれカンマで区切られます。例:header1=value1,header2=value2

Use this connection property to set the 'kid' header to the Certificate ID generated from the mapping of your NetSuite OAuth application.

OAuth JWT Issuer[OAuthJWTIssuer]

Java Web Token の発行者。 通常は、OAuth アプリケーションのクライアントId またはE メールアドレスとなります。

OAuth JWT Validity Time[OAuthJWTValidityTime]

これはJWT のexp フィールドの算出に使用されます。 デフォルトでは3600に設定されており、これはJWT が生成されてから1時間有効であることを意味します。 API によっては、これより低い値を要求するものもあります。


Default Value: 3600
OAuth Refresh Token[OAuthRefreshToken]

現在のアクセストークンが期限切れになったときに、新しいアクセストークンを取得するためにリフレッシュトークンが使用されます。 これにより、ユーザーが再度ログインすることなく、長時間実行されるワークフローや自動化された処理において、シームレスな認証が可能になります。 このプロパティは、対話型の認証ができないヘッドレス環境、CI/CD、またはサーバーベースの環境において特に重要です。

リフレッシュトークンは通常、初回のOAuth 交換時にGetOAuthAccessToken ストアドプロシージャを呼び出すことで取得されます。 その後、このプロパティを使用してトークンの自動更新を有効にするか、手動で更新を管理したい場合はRefreshOAuthAccessToken ストアドプロシージャに渡すことができます。

InitiateOAuthREFRESH に設定されている場合、ドライバーはこのトークンを使用して、新しいアクセストークンを自動的に取得します。 最初のリフレッシュの後、ドライバーは更新されたトークンをOAuthSettingsLocation によって定義された場所に保存し、その後の接続ではその値を使用します。

Note:OAuthRefreshToken は安全に取り扱い、信頼できる場所に保管する必要があります。 アクセストークンと同様に、リフレッシュトークンもID プロバイダーのポリシーによって、有効期限が切れたり、取り消されたりする場合があります。

OAuth設定場所[OAuthSettingsLocation]

OAuth 設定を中心的な場所に保管することで、ユーザーがログインするたびにOAuth 接続プロパティを手動で入力する必要がなくなります。また、資格情報を接続やプロセス間で共有することもできます。

以下のいずれかの方法でOAuth の値をセントラルファイルに保存し、その値へのアクセスを共有できます。

  • InitiateOAuthGETANDREFRESH またはREFRESH に設定し、OAuth 設定ファイルのファイルパスを指定します。
  • メモリストレージを使用して、資格情報を静的メモリにロードします。

以下のセクションでは、それぞれの方法について詳しく説明します。

OAuthSettingsLocation ファイルパスの指定

デフォルトのOAuth 設定の場所は%APPDATA%\\CData\\NetSuite Data Provider\\OAuthSettings.txt となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます。 デフォルト値は、ユーザーのオペレーティングシステムによって異なります。

  • Windows(ODBC およびPower BI):registry://%DSN%
  • Windows%APPDATA%CDataNetSuite Data Provider\OAuthSettings.txt
  • Mac%APPDATA%/CData/NetSuite Data Provider/OAuthSettings.txt
  • Linux%APPDATA%/CData/NetSuite Data Provider/OAuthSettings.txt

メモリストレージ経由での資格情報のロード

メモリの場所は、memory:// で始まる値とそのクレデンシャルのセット(例:memory://user1)の一意の識別子を使用して指定します。識別子は任意のものを選択できますが、ユーザーごとに一意である必要があります。

資格情報が接続間で永続化されるファイルベースのストレージとは異なり、メモリストレージは資格情報を静的メモリにロードし、資格情報はプロセスが継続している間は同じ識別子を使用して接続間で共有されます。そのプロセス外で資格情報を永続化するには、接続を閉じる前に資格情報を手動で保存する必要があります。これにより、プロセスが再開されたときに接続にそれらを設定することができます。

OAuth プロパティの値を取得するには、sys_connection_props システムテーブルをクエリします。複数の接続で同じ資格情報を使用している場合は、プロパティは最後に閉じた接続から読み取られます。

サポートされるストレージの種類

  • memory://:OAuth トークンをメモリ内に保存します(一意の識別子、同一プロセス内で共有など)。
  • registry://:Windows ODBC およびPower BI エディションでのみサポートされています。DSN 設定のレジストリにOAuth トークンを格納します。registry://CData JDBC Driver for NetSuite 2025J Data Source、またはregistry://%DSN% のようなDSN 名で終わる必要があります。
  • %DSN%:接続先のDSN 名。
  • デフォルト (接頭辞なし):OAuth トークンをファイル内に格納します。値には絶対パス、または%APPDATA%%PROGRAMFILES% で始まるパスのいずれかを指定できます。


Default Value: %APPDATA%\\CData\\NetSuite Data Provider\\OAuthSettings.txt
OAuth Token Timestamp[OAuthTokenTimestamp]

OAuth アクセストークンは認証済みのユーザーに割り当てられ、そのユーザーに指定された期間のネットワークへのアクセスを許可します。アクセストークンはユーザーのログインID とパスワードの代わりに使用され、サーバーに保持されます。

サーバーによって作成されたアクセストークンは、限定された時間のみ有効です。OAuthTokenTimestamp は、サーバーがトークンを作成した時のUnix タイムスタンプです。例えば、OAuthTokenTimestamp=1706558400 は、OAuthAccessToken がサーバーによって2024-01-29 20:00:00 UTC に生成されたことを示します。

OAuth Verifier[OAuthVerifier]

OAuthVerifier 値の取得方法の詳細については、 を参照してください。

OAuth Version[OAuthVersion]

The following OAuth versions are available:

  • AUTO: Automatically determines the appropriate OAuth version.
  • 1.0: Supports both SuiteTalk and SuiteQL schemas.
  • 2.0: Supports only the SuiteQL schema.

In most cases, the default value AUTO is sufficient and requires no manual changes. Set this property only if you need to override the automatic selection.


Default Value: AUTO
Possible Values:
AUTO0
1.01
2.02
Offline[Offline]

この接続プロパティががTrue に設定されている場合、すべてのクエリは、ライブNetSuite データではなくキャッシュデータベースに対して実行されます。

このモードでは、INSERT、UPDATE、DELETE、CACHE などの一部のSQL 操作が無効になります。


Default Value: false
Other[Other]

このプロパティにより、シニアユーザーはサポートチームのアドバイスに基づいて、特定の状況に対応する隠しプロパティを設定できます。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

Note:特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

キャッシュの設定

プロパティ説明
CachePartial=Trueクエリで指定可能な一部のカラムのみをキャッシュします。
QueryPassthrough=True本製品 のSQL パーサーを使用する代わりに、指定のクエリをキャッシュデータベースに渡します。

統合およびフォーマット

プロパティ説明
DefaultColumnSizeデータソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT=True日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換します。デフォルト値はFalse(ローカルタイムを使用)です。
RecordToFile=filename基底のソケットデータ転送を指定のファイルに記録します。

Pagesize[Pagesize]

This property controls the number of results retrieved from NetSuite in a single query request.

  • A higher pagesize retrieves more data per request but may increase execution time.
  • A smaller pagesize is recommended to reduce the risk of timeout exceptions.

Adjust this property based on performance needs and query complexity.

パスワード[Password]

This property is used in combination with User and AccountId to authenticate to NetSuite when AuthScheme is set to Basic.

Note: Basic Authentication is deprecated and no longer supported for NetSuite accounts using API version 2020 or later. It should only be used for legacy configurations that explicitly require it.

This property is required when using Basic Authentication.

Pool Idle Timeout[PoolIdleTimeout]

接続プーリングは、リクエストごとに新しい接続を作成するのではなく、確立されたデータベース接続を再利用するメカニズムです。 これにより、頻繁な接続作成に伴うオーバーヘッドを削減し、パフォーマンスが向上します。

PoolIdleTimeout は、使用されていない接続を閉じてリソースを管理するのに役立ち、アイドル接続を維持することによる潜在的なオーバーヘッドを削減します。 値を小さくするとアイドル状態の接続を迅速にクリーンアップできます。一方、値を大きくすると接続を長く開いておけるため、再接続が頻繁に発生するシナリオではパフォーマンスが向上する可能性があります。


Default Value: 60
Pool Max Size[PoolMaxSize]

PoolMaxSize は、接続プールで維持できるアクティブな接続の最大数を定義します。 上限に達すると、新しい接続リクエストは既存の接続がプールに戻されるのを待つ必要があります。

このプロパティは、リソースの使用率を最適化し、アプリケーションがサーバーやネットワークの制限を超えないようにするのに役立ちます。

プーリングを無効にするには、PoolMaxSize0 または負の値に設定します。

Note:プーリングを無効にすると接続の管理を簡素化できますが、トラフィックが多いシナリオではパフォーマンスが低下する可能性があります。


Default Value: 100
Pool Min Size[PoolMinSize]

PoolMinSize は、少なくとも1つ(デフォルト)の接続が常に接続プールで利用可能であることを確実にします。 これにより、指定された数の接続が事前に初期化され、すぐに使用できるようになり、レイテンシの短縮に役立ちます。

より大きな値を設定することで、一貫したトラフィックがある環境でのパフォーマンスを向上させることができますが、リソースの使用量が増加する可能性があります。

値を小さくすると、非アクティブ時にプールがすべての接続を解放し、リソースの消費を抑えることができます。


Default Value: 1
Pool Wait Time[PoolWaitTime]

このプロパティは、新しい接続リクエストがプールの利用可能な接続を待機する時間を制御します。デフォルト値は60秒で、接続リクエストが無期限に待機しないようにします。

Note: トラフィックが多い環境やプールサイズが限られている場合、この値を大きくすることで接続が利用可能になるまでの時間を延ばすことができますが、失敗したリクエストのエラー処理が遅れる可能性があります。


Default Value: 60
Preferred Date Formats[PreferredDateFormats]

If passing more than one format, enclose it in double quotes. For example, PreferredDateFormats="dd MMM yyyy;dd, mm yyyy;E, dd MMM yyyy HH:mm:ss z".

Proxy Auth Scheme[ProxyAuthScheme]

サポートされる認証の種類:

  • BASIC:本製品 はHTTP Basic 認証を行います。
  • DIGEST:本製品 はHTTP ダイジェスト認証を行います。
  • NTLM:本製品 はNTLM トークンを取得します。
  • NEGOTIATE: 本製品 は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
  • NONE:ProxyServer が認証を必要としないことを示します。

NONE 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。


Default Value: BASIC
Possible Values:
BASIC0
DIGEST1
NONE2
NEGOTIATE3
NTLM4
Proxy Auto Detect[ProxyAutoDetect]

この接続プロパティをTrue に設定すると、本製品 は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するために本製品 を構成する場合は、ProxyAutoDetectFalse に設定します。

このプロパティがTrue に設定されている場合、使用するプロキシはこれらの場所をこの順番でチェックして決定されます。ある場所でプロキシが決定できない場合、本製品 は次の場所をチェックします。

  1. 本製品 は、JVM のプロパティ(http.proxyhttps.proxysocksProxy など)から検索を行います。
  2. JVM のプロパティが存在しない場合、本製品 はjava.home/lib/net.properties を検索します。
  3. java.net.useSystemProxies がTrue に設定されている場合、本製品 はSystemProxy を検索します。
  4. Windows では、本製品はレジストリインターネットオプション、具体的にはレジストリキーHKCU\SOFTWARE\Microsoft\Windows\CurrentVersion\Internet Settings\ からプロキシ設定を読み取ります。Windows 10以降では、Windows の設定にあるプロキシの設定に対応します。

これらの設定は、マシンの現在のユーザーにのみ適用されることに注意してください。アプリケーションをサービスとして実行している場合、本製品 はユーザー設定を読み込みません。代わりに、本製品 の接続プロパティでプロキシ設定を手動で行う必要があります。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。


Default Value: false
Proxy Exceptions[ProxyExceptions]

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Note:本製品 はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。 この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetectFalse に設定します。

Proxy Password[ProxyPassword]

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値 ProxyPassword に設定する値
BASIC ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
DIGEST ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
NEGOTIATE ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NTLM ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NONE ProxyPassword 接続プロパティは設定しないでください。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

Note:本製品 は、ProxyAutoDetectFalse に設定されている場合にのみ、このパスワードを使用します。 ProxyAutoDetectTrue(デフォルト)に設定されている場合、本製品 は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

Proxy Port[ProxyPort]

ProxyAutoDetectFalse に設定されている場合、本製品 はこの接続プロパティで指定されたProxyServer ポートを通じてのみHTTP トラフィックをルーティングします。

ProxyAutoDetectTrue(デフォルト)に設定されている場合、本製品 は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。


Default Value: 80
Proxy Server[ProxyServer]

ProxyAutoDetectFalse に設定されている場合、本製品 はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。

ProxyAutoDetectTrue(デフォルト)に設定されている場合、本製品 は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

Proxy SSL Type[ProxySSLType]

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。

AUTOデフォルト設定。ProxyServer がHTTPS URL に設定されている場合、本製品 は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。
ALWAYS接続は、常にSSL 有効となります。
NEVER接続は、SSL 有効になりません。
TUNNEL接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。


Default Value: AUTO
Possible Values:
AUTO0
ALWAYS1
NEVER2
TUNNEL3
Proxy User[ProxyUser]

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

ProxyAuthScheme の値 ProxyUser に設定する値
BASIC プロキシサーバーに登録されているユーザーのユーザー名。
DIGEST プロキシサーバーに登録されているユーザーのユーザー名。
NEGOTIATE プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NTLM プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。
NONE ProxyPassword 接続プロパティは設定しないでください。

Note:本製品 は、ProxyAutoDetectFalse に設定されている場合にのみ、このユーザー名を使用します。 ProxyAutoDetectTrue(デフォルト)に設定されている場合、本製品 は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

Pseudo Columns[PseudoColumns]

このプロパティを使用すると、本製品 がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:

*=*

Readonly[Readonly]

True に設定すると、本製品 はSELECT クエリのみを許可します。INSERT、UPDATE、DELETE、またはストアドプロシージャのクエリを実行しようとすると、失敗してエラーメッセージが表示されます。


Default Value: false
Report Doubles As Decimal[ReportDoublesAsDecimal]

In the NetSuite API, all columns are reported as double values. This can lead to rounding issues when performing aggregation queries.

  • When this property is set to true, monetary columns are represented as decimal values to improve accuracy in formulas and aggregations.
  • When this property set to false, columns remain as double values, which may cause rounding inconsistencies, but maintains backward compatibility for existing implementations.

This property applies only when Schema is set to SuiteTalk.


Default Value: true
Request Memorized Transactions[RequestMemorizedTransactions]

Memorized transactions in NetSuite are transactions saved for potential future use. They can be set up to:

  • Recur automatically on a scheduled basis.
  • Serve as reminders for manual entry.

When this property is set to true, memorized transactions are included in transaction queries.

This property applies only when Schema is set to SuiteTalk.


Default Value: false
Role Id[RoleId]

This property is used along with User, Password, and AccountId to authenticate to NetSuite.

  • If RoleId is not set, the user's default role is used.
  • To find a RoleId, log into NetSuite and navigate to: Setup > Integration > Web Services Preferences. Here, you can select a different Web Services Default Role and obtain its InternalId, displayed next to the role name.

This property is required when specifying a non-default role for authentication.

Row Scan Depth[RowScanDepth]

This property applies only when Schema is set to SuiteQL. Since SuiteQL lacks a dedicated metadata service for standard tables and fields, row scanning helps determine which columns are available based on user permissions and NetSuite company settings.

  • NetSuite does not return null columns, so scanned tables may not have complete column information.
  • SuiteQL has a maximum pagesize of 1,000. Setting RowScanDepth higher than 1,000 requires multiple page requests.
  • Setting this property to 0 disables row scanning, meaning all columns are listed regardless of availability.

There is no enforced maximum value for this property. However, values greater than 100,000 may experience degraded performance during row scanning. Retrieving more than 100,000 rows requires multiple operations, which may cause NetSuite to internally process many more rows than specified. Additionally, row scans larger than 100,000 rows are only supported for views with defined key columns. Views without key columns are limited to scans of 100,000 rows. It is recommended to use values above 100,000 only when necessary to retrieve missing metadata.

Adjust this property based on performance needs and column availability requirements.


Default Value: 1000
RTK[RTK]

ほとんどの構成で標準的なライセンス機構をサポートしているため、通常はこのプロパティは不要です。

このランタイムキーは、OEM ライセンスを購入した場合にのみ使用できます。このプロパティの設定方法については、同梱のライセンスドキュメントを参照してください。

Warning: このプロパティの値は既存のすべてのライセンス情報よりも優先されます。ライセンスエラーを避けるため、提供されたランタイムキーが正しいことを確認してください。

スキーマ[Schema]

The available schema options are:

  • SuiteTalk: Recommended if you require INSERT, UPDATE, DELETE queries or need access to Custom Reports.
  • SuiteQL: Optimized for performance and reliability, using the REST API via SuiteQL.


Default Value: SuiteTalk
Possible Values:
SuiteTalk0
SuiteQL1
Scope[Scope]

This property is only applicable when using OAuth 2.0, which is only available when Schema is set to SuiteQL.

If you are using a custom OAuth 2.0 app, you must set this property to match the exact scopes configured for your OAuthClientId. Otherwise, the authorization request will fail.

If you are using embedded OAuth, the required scope is set automatically by the 本製品, and you do not need to modify this property.

The available values are:

  • restlets
  • rest_webservices
  • restlets rest_webservices

SSL Server Cert[SSLServerCert]

TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります:

説明
フルPEM 証明書(例では省略されています) -----BEGIN CERTIFICATE-----
MIIChTCCAe4CAQAwDQYJKoZIhv......Qw==
-----END CERTIFICATE-----
証明書を保有するローカルファイルへのパス。 C:\cert.cer
公開鍵(例では省略されています) -----BEGIN RSA PUBLIC KEY-----
MIGfMA0GCSq......AQAB
-----END RSA PUBLIC KEY-----
MD5 Thumbprint(hex 値はスペースまたはコロン区切り) ecadbdda5a1529c58a1e9e09828d70e4
SHA1 Thumbprint(hex 値はスペースまたはコロン区切り) 34a929226ae0819f2ec14b4a3d904f801cbb150d

証明書は、システムのトラストストアに基づいてマシンによって信頼されていると検証されています。使用されるトラストストアは、システムに指定された'javax.net.ssl.trustStore' 値になります。このプロパティに値が指定されていない場合は、Java のデフォルトのトラストストア(例えば、JAVA_HOME\lib\security\cacerts)が使用されます。

Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

Suite QL Date Format[SuiteQLDateFormat]

Use this property to override the default Date format when querying NetSuite using SuiteQL. This affects how date values are formatted in query results, but does not change how dates are stored in NetSuite.

For example, if NetSuite's default format is DD/MM/YYYY, but you prefer YYYY-MM-DD, set: SuiteQLDateFormat=YYYY-MM-DD. This ensures that date fields in query results are returned in YYYY-MM-DD format. This property applies only when Schema is set to SuiteQL.

Suite QL Datetime Format[SuiteQLDatetimeFormat]

Use this property to override the default Datetime format when querying NetSuite using SuiteQL. This affects how datetime values are formatted in query results, but does not change how they are stored in NetSuite.

For example, if NetSuite's default format is DD/MM/YYYY HH:MM:SS, but you prefer YYYY-MM-DD HH:MM:SS, set: SuiteQLDatetimeFormat=YYYY-MM-DD HH:MM:SS.

This ensures that datetime fields in query results are returned in YYYY-MM-DD HH:MM:SS format.

If this property is used to specify a format that excludes the timezone, the driver will not retrieve timezone information for datetimes, and will be unable to guarantee accurate datetime conversions across timezones.

This property applies only when Schema is set to SuiteQL.

Suite QL Datetime Formula[SuiteQLDatetimeFormula]

This property applies only when Schema is set to SuiteQL.

Use this property to override how the 本製品 formats datetime values when applying filters in SuiteQL.

By default, the 本製品 uses the TO_TIMESTAMP_TZ formula, which converts values to timestamps with time zone support.

You can also set this property to TO_TIMESTAMP to use an alternate timestamp conversion method without time zone handling. This can be useful if your SuiteQL filters need to match a specific datetime format or avoid time zone shifts.

Only the following values are supported:

Tables[Tables]

データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

タイムアウト(秒)[Timeout]

This property controls how long an operation can run before timing out.

  • If this property is set to 0, operations do not time out. They run until completion or encounter an error.
  • If the timeout duration expires before the operation completes, the 本製品 throws an exception.

Handling Long-Running Queries

Some operations in NetSuite can take a long time, particularly when:

  • Retrieving data from child tables.
  • Querying tables with AggregateColumnMode set to ListAndRetrieve.
  • Processing large datasets, such as retrieving 1000 SalesOrders in a single request.

To avoid timeout errors in these cases:

  • Set Timeout to 0 to allow operations to run indefinitely.
  • Use a smaller Pagesize to retrieve data in smaller chunks.
  • Select specific columns instead of retrieving all columns.

This property helps manage performance and ensures operations complete successfully based on NetSuite’s API limitations.


Default Value: 300
Use Async Services[UseAsyncServices]

NetSuite responses can be slow when processing large insert, update, or delete operations. Enabling UseAsyncServices allows NetSuite to process these operations asynchronously, letting your application continue execution without waiting for a response. Using asynchronous services improves performance by allowing operations to run in the background. However, because the request does not return an immediate response, you must manually check the job status in NetSuite to confirm completion and verify any errors.

This property applies only when Schema is set to SuiteTalk.


Default Value: false
Use Connection Pooling[UseConnectionPooling]

UseConnectionPooling は、頻繁な接続作成に関連するオーバーヘッドを削減し、接続の使用率が高いアプリケーションのパフォーマンスを向上させます。 接続プーリングが有効な場合、アプリケーションは各接続が不要になったら明示的に閉じる必要があります。 接続を閉じると、物理的に終了するのではなく、再利用できるようにプールに戻ります。 接続がPoolIdleTimeout 時間を超えてアイドル状態になると、本製品 は自動的に接続を閉じてリソースを解放します。

接続プールはデフォルトで無効ですが、PoolMaxSizePoolIdleTimeoutPoolWaitTime などの追加プロパティを使用して、接続プールの動作をカスタマイズできます。これらのプロパティにより、プールサイズ、アイドル接続タイムアウト、および接続が利用可能になるまでの待機時間を細かく調整できます。

接続プールの使用については、接続プール を参照してください。


Default Value: false
Use Internal Names For Customizations[UseInternalNamesForCustomizations]

When surfacing tables for custom records and columns for custom fields, NetSuite typically displays their label for ease of use, matching how they appear in the NetSuite UI. However, labels can be modified in NetSuite, which can change how these names appear in external tools.

To prevent labels from changing, set UseInternalNamesForCustomizations to None, which ensures that internal API names are always used. Internal API names cannot be changed.

ValueDescription
NoneUse internal names for tables and columns.
TablesOnlyUse label names for tables.
TablesAndColumnsUse label names for tables and columns.

This property helps maintain consistency when working with custom fields and records in NetSuite.


Default Value: None
Possible Values:
None0
TablesOnly1
TablesAndColumns2
ユーザー[User]

This property is used in combination with AccountId and Password to authenticate with NetSuite when AuthScheme is set to Basic.

Note: Basic Authentication is deprecated and no longer supported for NetSuite accounts using API version 2020 or later. Use Token-Based Authentication or OAuth for secure connections.

User Defined Views[UserDefinedViews]

UserDefinedViews を使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューは本製品 によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。

次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Account WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。 次に例を示します。

UserDefinedViews=C:\Path\To\UserDefinedViews.json
UserDefinedViews でビューを指定すると、本製品 はそのビューだけを参照します。

詳しくは、ユーザー定義ビュー を参照してください。

User Timezone Offset[UserTimezoneOffset]

NetSuite offsets Date and Time values based on user timezone preferences. DateTime values, however, are always returned the same way regardless of timezone settings. The 本製品 attempts to adjust date values to match the NetSuite UI automatically, but certain time zones, such as +13:00, +12:00, and -12:00 may require manually setting this property for accurate date display. For other offsets, setting this property is recommended for best accuracy but is not required.

Usage Considerations

  • If the user’s timezone is +13:00, +12:00, or -12:00, set this property to ensure dates display correctly.
  • If retrieving Time values, this property is needed only if the time on the local machine does not match the logged-in user's timezone in NetSuite.
  • To check your timezone offset in NetSuite, log in, hover over the Home icon, and select Preferences.

If the 本製品 is running on a machine with a different timezone than the NetSuite user, set UserTimezoneOffset to match the user's preference in NetSuite.

This property applies only when Schema is set to SuiteTalk.

Use Simple Names[UseSimpleNames]

NetSuite テーブルでは、標準的なデータベースでは通常許可されない特殊文字を名前に含めることができます。このプロパティを使用すると、本製品 を従来のデータベースツールでより簡単に使用できるようになります。

UseSimpleNamesTrue に設定すると、返されるカラム名をシンプルにします。 表示されるカラム名において、アルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。

Notes:

  • 英数字以外の文字はアンダースコアに置き換えられます。
  • カラム名やテーブル名が128 文字を超える場合は、SQL Server 標準に準拠するために128文字に切り詰められます。


Default Value: false
Use Upserts[UseUpserts]

When this property is set to true, INSERT operations check for an existing record using the ExternalId field:

  • If the specified ExternalId already exists in NetSuite, the existing record is updated.
  • If the ExternalId does not exist, a new record is created.

When this property is set to false, INSERT operations always attempt to create a new record. If a record with the specified ExternalId already exists, the operation fails with a "This record already exists" error. The record is not updated, even if ExternalId matches an existing one.

This property applies only when Schema is set to SuiteTalk.


Default Value: false
Verbosity[Verbosity]

このプロパティは、本製品 がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。


Default Value: 1
バージョン[Version]

In most cases, this property does not need to be changed. If modifying the version, ensure that the specified version exists in the NetSuite API.

  • If an invalid version is specified, the 本製品 will be unable to retrieve or update tables in NetSuite.
  • Check NetSuite API documentation to confirm available versions before making changes.

This property applies only when Schema is set to SuiteTalk.


Default Value: 2025_2
Views[Views]

データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。

Web Service Host[WebServiceHost]

This property should only be set if the web service host cannot be dynamically resolved. By default, the 本製品 automatically retrieves the correct web service host for the NetSuite account, which requires an additional request when establishing a new connection.

Setting WebServiceHost manually can help:

  • Avoid the extra request required to determine the host dynamically.
  • Resolve connection issues if the service host is not being detected correctly.

Formatting Requirements

  • The host URL should follow this format: [accountId].suitetalk.api.netsuite.com
  • The account ID must be in lowercase, and any underscores (_) in the ID should be replaced with hyphens (-).

Finding the Web Service Host

  1. Log in to NetSuite as an administrator.
  2. Navigate to Setup > Company > Company Information.
  3. Under the Company URLs tab, locate the SuiteTalk URL.

This property applies only when Schema is set to SuiteTalk.