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

プロパティファイルとは

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

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

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

プロパティファイル編集に関する注意事項

プロパティファイルに使用できる文字はシングルバイト文字のみとなります。マルチバイト文字は使用できません。

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

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

プロパティファイル

pim.properties

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

格納場所: 各プロパティの内容は以下の通りです。
項目の説明
キー 設定値 説明 補足
pim.host PIMSYNCサーバーのホスト名 PIMSYNCサーバーのホスト名を指定します。
  • 名前解決できるホスト名を指定してください。
pim.port 数値 PIMSYNCで使用するポート番号を指定します。
  • デフォルト値は「8080」です。
  • インストール時に変更した場合はその値
pim.ssl 「true」または「false」 HTTPSプロトコルでPIMSYNCを使用する場合には「true」を指定します。
  • デフォルト値は「false」です。
pim.ssl.port 数値 HTTPSプロトコルでPIMSYNCを使用する場合のポート番号を指定します。
  • デフォルト値は「8443」です。
pim.ssl.keypassword キーストアのパスワード HTTPSの暗号化で使用する鍵、証明書が保存されているキーストアのパスワードを指定します。
  • キーストアへのインポート方法については、「HTTPS設定」を参照してください。
pim.mail.host SMTPサーバー名 エラーメールを送信するSMTPサーバー名を指定します。
  • インストール時に登録した場合はその値
pim.mail.port 数値 エラーメールを送信するSMTPサーバーのポート番号を指定します。
  • デフォルト値は「25」です。
pim.mail.from 送信元アドレス エラーメールの送信元メールアドレスを指定します。
  • インストール時に登録した場合はその値
pim.mail.charset 文字コード名 エラーメールで使用する文字コードを指定します。
  • デフォルト値は「MS932」です。
pim.mail.smtp.user SMTPユーザー名 SMTP認証のユーザー名を指定します。  
pim.mail.smtp.password SMTPパスワード SMTP認証のパスワードを指定します。  
pim.mail.smtp.encryption 「SSL/TLS」または「STARTTLS」 SMTP通信を暗号化する方法を指定します。
  • SMTP通信を暗号化する場合、SMTPサーバーのサーバー証明書がPIMSYNCの参照するキーストアにインポートされている必要があります。
  • キーストアへのインポート方法については、「証明書のインポート」を参照してください。
pim.mail.admin.address 管理者通知メールの送信先アドレス エラーメールを管理者に送信する場合の送信先メールアドレスを指定します。  
pim.mail.connectError.notification 「true」または「false」 接続エラー発生時に管理者にメール通知するかを指定します。
  • デフォルト値は「false」です。
pim.mail.syncError.transfer 「true」または「false」 同期エラー発生時に管理者にメール転送するかを指定します。
  • デフォルト値は「false」です。
  • 「true」の場合、同期エラー発生時のエラーメールは管理者にのみ送信されます。
pim.db.host 使用するデータベースのホスト名 使用するデータベースのホスト名を指定します。
  • デフォルト値は「localhost」です。
pim.db.port 使用するデータベースのポート番号 使用するデータベースのポート番号を指定します。
  • デフォルト値は「5432」です。
pim.db.dbName 接続先データベース名 接続先のデータベース名を指定します。
  • デフォルト値は「pimsync」です。
pim.db.userName データベース接続ユーザー名 データベース接続のユーザー名を指定します。
  • デフォルト値は「postgres」です。
pim.db.password データベース接続パスワード データベース接続ユーザーのパスワードを指定します。  
pim.db.initialConnections データベース初期接続数 PIMSYNC起動時にプールされるコネクション数を入力します。
  • デフォルト値は「8」です。
  • データベース接続を必要としない間に、プールされるコネクション数もこのプロパティ値となります。
pim.db.maxConnections データベース接続数上限 プールされるコネクション数の上限を入力します。
  • デフォルト値は「50」です。
  • pim.db.initialConnections」未満の値を設定した場合、このプロパティ値は無視されます。
  • PostgreSQLデータベースの最大同時接続数(デフォルトでは「100」)以下の値を設定してください。
pim.log.dirpath ログ出力先ディレクトリのパス PIMSYNCサーバーログおよび同期タスクログの出力先として使用されるディレクトリのパスを指定します。
  • デフォルト値は「$PIMSYNC_HOME/log」です。
  • ディレクトリの区切り文字に「\」を使用する場合は、「\\」としてください。
  • 不正な出力先を指定した場合はPIMSYNCが起動しません。(存在しないドライブ、権限が無いなど)
  • PIMSYNCのログの詳細については、「ログファイル管理」を参照してください。
pim.log.charset 文字コード名 PIMSYNCサーバーログおよび同期タスクログで使用する文字コードを指定します。
  • デフォルト値は「MS932」です。
  • PIMSYNCのログの詳細については、「ログファイル管理」を参照してください。
pim.log.maxfilesize 数値 PIMSYNCサーバーログのローテーションファイルサイズをByte単位で指定します。
pim.log.maxbackupindex 数値 PIMSYNCサーバーログのローテーションファイル数を指定します。
pim.synctasklog.retention.period 数値 PIMSYNC同期タスクログが保持される日数を指定します。
pim.users.page.rows 数値 ユーザー一覧が表示される以下の画面で、1ページに表示されるユーザー数を指定します。
  • デフォルト値は「2147483647」です。
pim.timezone.supported 「true」または「false」 読み取り時にアイテムのタイムゾーンを使って読み取るかを指定します。
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アドレスの設定がないアダプタについては、各アダプタの「稼動環境/環境設定 - プロキシサーバー設定」を参照してください。
http.proxyUser プロキシサーバーのユーザー名 HTTPプロトコルまたはHTTPSプロトコルのプロキシサーバーのBasic認証で使用するユーザー名を指定します。
  • Basic認証を必要とするプロキシサーバーの場合、本プロパティを設定してください。
http.proxyPassword プロキシサーバーのパスワード HTTPプロトコルまたはHTTPSプロトコルのプロキシサーバーのBasic認証で使用するパスワードを指定します。
pim.repository.debug 「true」または「false」 リポジトリに関する詳細なログを出力するかを指定します。
  • デフォルト値は「false」です。
pim.garoon.debug 「true」または「false」 サイボウズ ガルーンアダプタに関する詳細なログを出力するかを指定します。
  • デフォルト値は「false」です。
pim.esalesmanager.debug 「true」または「false」 eセールスマネージャー Remix Cloudアダプタに関する詳細なログを出力するかを指定します。
  • デフォルト値は「false」です。
pim.googlecalendar.debug 「true」または「false」 Google Calendarアダプタに関する詳細なログを出力するかを指定します。
  • デフォルト値は「false」です。
pim.exchange.debug 「true」または「false」 Microsoft Exchange Server 2016アダプタ・Microsoft Exchange Server 2013アダプタ・Microsoft Office 365 Exchange Onlineアダプタに関する詳細なログを出力するかを指定します。
  • デフォルト値は「false」です。
pim.salesforce.debug 「true」または「false」 Salesforceアダプタに関する詳細なログを出力するかを指定します。
  • デフォルト値は「false」です。
pim.domino.debug 「true」または「false」 Dominoアダプタに関する詳細なログを出力するかを指定します。
  • デフォルト値は「false」です。
pim.cybozuoffice.debug 「true」または「false」 サイボウズ Officeアダプタに関する詳細なログを出力するかを指定します。
  • デフォルト値は「false」です。
pim.dynamicscrm.debug 「true」または「false」 Microsoft Dynamics 365 for Customer Engagement (on-premises)アダプタ・Microsoft Dynamics 365 for Customer Engagementアダプタに関する詳細なログを出力するかを指定します。
  • デフォルト値は「false」です。
pim.garoon.attendee.info.out 「true」または「false」 サイボウズ ガルーンの会議スケジュールの参加者を、同期先の[詳細]の末尾に文字列情報として反映するかを指定します。
  • デフォルト値は「false」です。
pim.esalesmanager.attendee.info.out 「true」または「false」 eセールスマネージャーRemix Cloudの会議スケジュールの参加者を、同期先の[詳細]の末尾に文字列情報として反映するかを指定します。
  • デフォルト値は「false」です。
pim.googlecalendar.attendee.info.out 「true」または「false」 Google Calendarの会議スケジュールの参加者を、同期先の[詳細]の末尾に文字列情報として反映するかを指定します。
  • デフォルト値は「false」です。
pim.exchange.attendee.info.out 「true」または「false」 Microsoft Exchange Server 2016・Microsoft Exchange Server 2013・Microsoft Office 365 Exchange Onlineの会議スケジュールの参加者を、同期先の[詳細]の末尾に文字列情報として反映するかを指定します。
  • デフォルト値は「false」です。
pim.salesforce.attendee.info.out 「true」または「false」 Salesforceの会議スケジュールの参加者を、同期先の[詳細]の末尾に文字列情報として反映するかを指定します。
  • デフォルト値は「false」です。
pim.domino.attendee.info.out 「true」または「false」 Dominoの会議スケジュールの参加者を、同期先の[詳細]の末尾に文字列情報として反映するかを指定します。
  • デフォルト値は「false」です。
pim.cybozuoffice.attendee.info.out 「true」または「false」 サイボウズ Officeの会議スケジュールの参加者を、同期先の[詳細]の末尾に文字列情報として反映するかを指定します。
  • デフォルト値は「false」です。
pim.dynamicscrm.attendee.info.out 「true」または「false」 Microsoft Dynamics CRM 2016・Microsoft Dynamics 365 for Customer Engagement (on-premises)・Microsoft Dynamics 365 for Customer Engagementの会議スケジュールの参加者を、同期先の[詳細]の末尾に文字列情報として反映するかを指定します。
  • デフォルト値は「false」です。

PIMSYNC.lax

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

格納場所: 変更可能なプロパティの内容は以下の通りです。
項目の説明
キー 設定値 説明 補足
-Xms 最大ヒープサイズ以下の数値 ヒープサイズの初期値を指定します。本設定を行うと、PIMSYNCサーバの起動時に設定値までメモリが割り当てられます。「lax.nl.java.option.additional=」内に設定します。
  • 設定値は「1024」の倍数にする必要があります。
  • メガバイトを指定するには、数値のあとにメガを表す「m」または「M」を付けます。ギガバイトを指定するには、数値のあとにギガを表す「g」または「G」を付けます。
-Xmx 初期ヒープサイズ以上の数値 ヒープサイズの最大値を指定します。「lax.nl.java.option.additional=」内に設定します。
  • 設定値は「1024」の倍数にする必要があります。
  • メガバイトを指定するには、数値のあとにメガを表す「m」または「M」を付けます。ギガバイトを指定するには、数値のあとにギガを表す「g」または「G」を付けます。
-XX:MaxMetaspaceSize 任意の数値 クラス・メタデータに割り当て可能なネイティブ・メモリの最大量を設定します。ヒープサイズとは別にOSのメモリを確保します。「lax.nl.java.option.additional=」内に設定します。
  • 設定値は「1024」の倍数にする必要があります。
  • メガバイトを指定するには、数値のあとにメガを表す「m」または「M」を付けます。ギガバイトを指定するには、数値のあとにギガを表す「g」または「G」を付けます。