運用ガイド - プロパティリファレンス

プロパティファイルとは

プロパティファイルとは、PIMSYNCサーバーの各種設定を変更することができる設定ファイルです。

プロパティファイルの種類

プロパティファイルには、以下の種類が存在します。

各プロパティファイルの反映方法

PIMSYNCサーバーを再起動します。
再起動を行うまでは、変更は反映されません。

プロパティファイル

pim.properties

PIMSYNCが使用するポート番号の指定、同期エラー時に送信するメールの設定や詳細なログを出力するための設定オプションが用意されています。
pim.<アダプタ>.debugキーを「true」に設定すると、大量のデバックログがPIMSYNCサーバーログおよび同期タスクログに出力されます。
     よってエラー原因の詳細調査等の特別な場合を除き、通常はそのままの設定にしてください。
PIMSYNCサーバーログおよび同期タスクログの詳細については、「ログファイル管理」を参照してください。

格納場所: 各プロパティの内容は以下の通りです。
項目の説明
キー 設定値 説明 補足
pim.host PIMSYNCサーバーのホスト名 PIMSYNCサーバーのホスト名を指定します。
  • ドメイン名を含めたFQDN(Fully Qualified Domain Name)の形式で設定してください。 (例: 「pimsync.appresso.com」)
pim.port 数値 PIMSYNCで使用するポート番号を指定します。
  • デフォルト値は「8080」です。
  • インストール時に変更した場合はその値
pim.mail.host SMTPサーバー名 同期エラーが発生した場合にメール送信するSMTPサーバー名を指定します。
  • インストール時に登録した場合はその値
  • メール通知の詳細については、「仕様補足説明」を参照してください。
pim.mail.from 送信元アドレス 同期エラーが発生した場合にメール送信する送信元のメールアドレスを指定します。
  • インストール時に登録した場合はその値
  • メール通知の詳細については、「仕様補足説明」を参照してください。
pim.db.host 使用するデータベースのホスト名 使用するデータベースのホスト名を指定します。
  • デフォルト値は「localhost」です。
pim.db.port 使用するデータベースのポート番号 使用するデータベースのポート番号を指定します。
  • デフォルト値は「5432」です。
pim.db.dbName 接続先データベース名 接続先のデータベース名を指定します。
  • デフォルト値は「pimsync」です。
pim.db.userName データベース接続ユーザー名 データベース接続のユーザー名を指定します。
  • デフォルト値は「postgres」です。
pim.db.password データベース接続パスワード データベース接続ユーザーのパスワードを指定します。  
pim.db.initialConnections データベース初期接続数 PIMSYNC起動時にプールされるコネクション数を入力します。
  • デフォルト値は「50」です。
pim.db.maxConnections データベース接続数上限 プールされるコネクション数の上限を入力します。
  • デフォルト値は「50」です。
  • PostgreSQLデータベースの最大同時接続数(デフォルトでは「100」)以下の値を設定してください。
pim.log.maxfilesize 数値 PIMSYNCサーバーログのローテーションファイルサイズをByte単位で指定します。
pim.log.maxbackupindex 数値 PIMSYNCサーバーログのローテーションファイル数を指定します。
pim.synctasklog.retention.period 数値 PIMSYNC同期タスクログが保持される日数を指定します。
pim.users.page.rows 数値 ユーザー一覧が表示される以下の画面で、1ページに表示されるユーザー数を指定します。
  • デフォルト値は「2147483647」です。
http.proxyHost プロキシサーバーのホスト名 HTTPプロトコルで使用するプロキシサーバーのホスト名またはIPアドレスを指定します。
  • 本プロパティに対応するアダプタについては、各アダプタの「稼動環境/環境設定 - プロキシサーバー設定」を参照してください。
  • 本プロパティを設定した場合、対応するすべてのアダプタがプロキシサーバーを経由して接続します。特定のアダプタでプロキシサーバーを経由せずに接続したい場合は、「http.nonProxyHosts」を設定してください。
http.proxyPort プロキシサーバーのポート番号 HTTPプロトコルで使用するプロキシサーバーのポート番号を指定します。
https.proxyHost プロキシサーバーのホスト名 HTTPSプロトコルで使用するプロキシサーバーのホスト名またはIPアドレスを指定します。
https.proxyPort プロキシサーバーのポート番号 HTTPSプロトコルで使用するプロキシサーバーのポート番号を指定します。
http.nonProxyHosts 同期対象サーバーのホスト名 プロキシサーバーを使用しないホスト名またはIPアドレスを指定します。
  • 本プロパティで指定したホストには、「http.proxyHost」または「https.proxyHost」に指定したプロキシサーバーを経由せずに接続します。
  • 各アダプタのサーバー情報に設定されているホスト名またはIPアドレスを設定してください。
  • ホストを複数指定する場合は、「|」で区切って設定してください。
  • サーバー情報にホスト名またはIPアドレスの設定がないアダプタについては、各アダプタの「稼動環境/環境設定 - プロキシサーバー設定」を参照してください。
pim.repository.debug 「true」または「false」 リポジトリに関する詳細なログを出力するかを指定します。
  • デフォルト値は「false」です。
pim.garoon3.debug 「true」または「false」 サイボウズ ガルーン 3アダプタに関する詳細なログを出力するかを指定します。
  • デフォルト値は「false」です。
pim.esalesmanager.debug 「true」または「false」 eセールスマネージャー Ver.7/Remix Cloudアダプタに関する詳細なログを出力するかを指定します。
  • デフォルト値は「false」です。
pim.googlecalendar.debug 「true」または「false」 Google Calendarアダプタに関する詳細なログを出力するかを指定します。
  • デフォルト値は「false」です。
pim.exchange.debug 「true」または「false」 Microsoft Exchange Server 2013アダプタ・Microsoft Exchange Server 2010アダプタ・Microsoft Exchange Server 2007アダプタ・Microsoft Office 365 Exchange Onlineアダプタに関する詳細なログを出力するかを指定します。
  • デフォルト値は「false」です。
pim.salesforce.debug 「true」または「false」 Salesforceアダプタに関する詳細なログを出力するかを指定します。
  • デフォルト値は「false」です。

PIMSYNC.lax

PIMSYNCのメモリ割り当て値(ヒープサイズ)の変更を行います。

格納場所: 変更可能なプロパティの内容は以下の通りです。
項目の説明
キー 設定値 説明 補足
-Xms 最大ヒープサイズ以下の数値 ヒープサイズの初期値を指定します。本設定を行うと、PIMSYNCサーバの起動時に設定値までメモリが割り当てられます。「lax.nl.java.option.additional=」内に設定します。
  • 設定値は「1024」の倍数にする必要があります。
  • キロバイトを指定するには、数値のあとにキロを表す「k」または「K」を付けます。メガバイトを指定するには、数値のあとにメガを表す「m」または「M」を付けます。
-Xmx 初期ヒープサイズ以上の数値 ヒープサイズの最大値を指定します。「lax.nl.java.option.additional=」内に設定します。
  • 設定値は「1024」の倍数にする必要があります。
  • キロバイトを指定するには、数値のあとにキロを表す「k」または「K」を付けます。メガバイトを指定するには、数値のあとにメガを表す「m」または「M」を付けます。
-XX:MaxPermSize 最大ヒープサイズ以下の数値 Javaのヒープ領域の一区画であるパーマネント領域を指定します。「lax.nl.java.option.additional=」内に設定します。
  • 設定値は「1024」の倍数にする必要があります。
  • キロバイトを指定するには、数値のあとにキロを表す「k」または「K」を付けます。メガバイトを指定するには、数値のあとにメガを表す「m」または「M」を付けます。

仕様補足説明

同期エラー時にメールが通知されないケースについて


以下の場合には、同期エラーの際にメールは通知されません。