SMS Gateway の構成環境変数

Docker 環境変数を定義することにより、SMS Gateway を構成できます。 環境変数を指定する場所は、ゲートウェイをデプロイする場所によって異なります。

これらの docker-compose.yml ファイルと deploy.json ファイルには、それぞれ環境変数の構成方法を示す例が入っています。

マルチテナント JSON 構成: テナント構成は別の JSON ファイルで指定および保管され、それがその後 SMS Gateway 構成で参照されます。 コア・デプロイメント構成など、テナントに関連しない構成のみが、Docker 環境変数によって指定されます。 どの設定を JSON ファイルに構成するかについて詳しくは、『マルチテナント SMS Gateway JSON 構成でのテナントの構成』を参照してください。

コア・デプロイメント構成環境変数

以下の表では、SMS Gateway 環境を構成するために定義できる環境変数をリストします。 これらの値は、デプロイメント全体で使用されます。

一般デプロイメント構成

環境変数 デフォルト値 説明
MULTI_TENANT_CONFIG_FILE N/A マルチテナント JSON 構成を構成するための、JSON ファイルへのパス。

キャッシュ・サーバーの構成

高可用性環境では、セッション状態を保管するための IBM WebSphere eXtreme Scale Liberty Deployment (XSLD) キャッシュ・サーバーをセットアップする必要があります。

表 2. ロギングおよびトレースを構成するための環境変数
環境変数 デフォルト値 説明
XS_ENABLED false XSLD キャッシュ・サーバーでの SMS Gateway のデプロイを有効にするために、true に設定します。
XS_CATALOG_ENDPOINTS N/A データ・グリッド内のすべてのカタログ・サーバーのエンドポイントのコンマ区切りリスト (host:port 形式で指定)。 例えば、cat01.port.client:4809, 9.123.4.5:4809 など。
XS_USERNAME N/A 重要: xsadmin に設定する必要があります。これは、XSLDキャッシュ・サーバーの組み込み管理者資格情報です。
XS_PASSWORD N/A XSLD コンテナーのパスワード。 複数の XSLD コンテナーをデプロイする場合、各コンテナーに対して同じパスワードを使用する必要があります。
XS_TRANSPORT_TYPE TCP/IP XSLD コンテナーに接続するためのトランスポート・タイプ。 非セキュア接続の場合は TCP/IP を指定し、すべてのカタログ・サーバーに対して SSL が構成されている場合は SSL-Required を指定します。

ロギングおよびトレースの構成

表 3. ロギングおよびトレースを構成するための環境変数
環境変数 デフォルト値 説明
ENABLE_TRANSCRIPTION_MESSAGES false 書き起こしメッセージを有効にする場合は、true に設定します。 また、書き起こしメッセージをログに記録するには、LOG_LEVEL 環境変数を finest に設定する必要があります。 なお、このメッセージが有効になっている場合、該当するメッセージがログに出力されますが、機密の PHI、PII、および PCI DSS のデータが含まれる可能性があります。
LATENCY_REPORTING_THRESHOLD 1000 Watson Assistant サービスに往復遅延を報告するしきい値 (ミリ秒)。
LOG_LEVEL info ログに出力する情報のレベル。 有効な値は、最小限の情報から最大限の情報の順に、off、fatal、severe、warning、info、fine、finest、および all です。 fine、finest、または all に設定すると、ログには PHI、PII、および PCI DSS の機密データが含まれる可能性があります。
LOG_MAX_FILES 5 ログ・ファイル、トレース・ファイル、および例外サマリー・ログ・ファイルの最大数。 この制限に到達すると、最も古いファイルが削除され、新しいファイルが作成されます。 例えば、この変数を 5 に設定すると、SMS Gateway は最大で 5 つのメッセージ・ログ、5 つのトレース・ログ、および 5 つの例外サマリーを生成できます。
LOG_MAX_FILE_SIZE 100 ログ・ファイルの最大サイズ (メガバイト (MB))。このサイズに到達すると、新しいファイルが作成されます。
WLP_SKIP_UMASK false false に設定されると、サーバーは、other ユーザーに対しアクセスを拒否するようにログ・ファイル許可を設定します。 other ユーザーに読み取り権限を付与する場合は、true に設定します。
MASK_CALLER_ID_FROM_MESSAGES false SMS Gateway メッセージ・ログに含まれる発信者 ID 情報をマスクするには、deploy script ファイル内でこの変数を true に設定します。 デフォルトでは、発信者 ID 情報は、SMS Gateway によってメッセージ・ログに表示されます。 次の例は、この変数が true に設定されたときにマスクされる発信者 ID 情報を示しています。
CWSMS0001I: 要求された SMS セッションがテナントとユーザーの間に作成されました。 tenantID = +18888888888 userID = ***

SMS プロバイダーに対するプロキシー構成

表 4. SMS プロバイダーのプロキシー・サーバーを構成するための環境変数
環境変数 デフォルト値 説明
SMS_PROXY_TYPE HTTP SMS プロバイダーへの接続のフォワード・プロキシー・サーバー・タイプ。
SMS_PROXY_HOST N/A SMS プロバイダーへの接続のフォワード・プロキシー・サーバーのホスト名。
SMS_PROXY_PORT N/A SMS プロバイダーへの接続のフォワード・プロキシー・サーバーのポート。
SMS_PROXY_USERNAME N/A SMS プロバイダーへの接続のフォワード・プロキシー・サーバーのユーザー名。 この変数を指定するのは、プロキシー・サーバーで認証が必要とされる場合のみです。
SMS_PROXY_PASSWORD N/A SMS プロバイダーへの接続のフォワード・プロキシー・サーバーのパスワード。 この変数を指定するのは、プロキシー・サーバーで認証が必要とされる場合のみです。

Watson Assistant サービスに対するプロキシー構成

表 5. Watson Assistant サービスのプロキシー・サーバーを構成するための環境変数
環境変数 デフォルト値 説明
WCS_PROXY_TYPE HTTP Watson Assistant サービスへの接続のフォワード・プロキシー・サーバー・タイプ。
WCS_PROXY_HOST N/A Watson Assistant サービスへの接続のフォワード・プロキシー・サーバーのホスト名。
WCS_PROXY_PORT N/A Watson Assistant サービスへの接続のフォワード・プロキシー・サーバーのポート。
WCS_PROXY_USERNAME N/A Watson Assistant サービスへの接続のフォワード・プロキシー・サーバーのユーザー名。 この変数を指定するのは、プロキシー・サーバーで認証が必要とされる場合のみです。
WCS_PROXY_PASSWORD N/A Watson Assistant サービスへの接続のフォワード・プロキシー・サーバーのパスワード。 この変数を指定するのは、プロキシー・サーバーで認証が必要とされる場合のみです。

Cloudant に対するプロキシー構成

表 6. Cloudant に対するプロキシー構成
環境変数 デフォルト値 説明
CLOUDANT_PROXY_USERNAME なし Cloudant サービスへの接続のフォワード・プロキシー・サーバーのユーザー名を指定します。 この変数を指定するのは、プロキシー・サーバーで認証が必要とされる場合のみです。
CLOUDANT_PROXY_PASSWORD なし Cloudant サービスへの接続のフォワード・プロキシー・サーバーのパスワードを指定します。 この変数を指定するのは、プロキシー・サーバーで認証が必要とされる場合のみです。
CLOUDANT_PROXY_URL なし Cloudant サービスへの接続のフォワード・プロキシー・サーバーのホスト名とポート番号を指定します。 例: http://cloudant-proxy.com:80

SSL および TLS 暗号化構成

表 7. SSL および TLS 暗号化を構成するための環境変数
環境変数 デフォルト値 説明
SSL_TRUST_STORE_FILE コンテナー Java™ SDK によって指定 アウトバウンド SSL 接続 (Watson Assistant サービス、サービス・オーケストレーション・エンジン、SMS プロバイダー、または XSLD キャッシュ・サーバーへの接続など) のトラステッド鍵が含まれるファイル。
SSL_TRUST_PASSPHRASE N/A SSL_TRUST_STORE_FILE トラストストア・ファイルの保護に使用されたパスフレーズ。
SSL_TRUST_FILE_TYPE JKS SSL_TRUST_STORE_FILE のフォーマット。
SSL_KEY_STORE_FILE N/A インバウンド SSL 接続のトラステッド鍵が入った鍵ストア・ファイル。
SSL_KEY_PASSPHRASE N/A SSL_KEY_STORE_FILE 鍵ストア・ファイルの保護に使用されたパスフレーズ。
SSL_KEY_FILE_TYPE JKS SSL_KEY_STORE_FILE のフォーマット。

作動可能プローブを構成するための環境変数

表 8. 作動可能プローブを構成するための環境変数
環境変数 デフォルト値 説明
SMS_ADMIN_USERNAME なし 管理者が作動可能プローブ要求を認証するためのユーザー名を指定します。
SMS_ADMIN_PASSWORD なし 管理者が作動可能プローブ要求を認証するためのパスワードを指定します。

テナント構成環境変数

シングル・テナント環境の場合、構成で以下の環境変数を定義できます。 マルチテナント JSON 構成では、プロパティーは別個の JSON ファイルで定義されるため、これらの環境変数は無視されます。

一般テナント構成

表 9. 一般テナントの環境変数
環境変数 デフォルト値 説明
TENANT_PHONE_NUMBER N/A シングル・テナント・デプロイメントにおける、SMS プロバイダーからプロビジョンされた電話番号。 SMS プロバイダーで必要とされるとおりの番号フォーマットを使用します。 すべてのメッセージの送信先および送信元は、この番号になります。
ALLOW_SESSION_CREATE_VIA_SMS false ユーザーがメッセージを SMS Gateway に送信して新規メッセージング・セッションを開始できるかどうか。 有効にする場合は、true に設定します。
CONVERSATION_FAILED_REPLY_MESSAGE Unable to respond to the SMS message due to an error Watson Assistant サービスが使用可能でない場合にメッセージ受信側に送信されるデフォルト応答メッセージ。
SMS_PROVIDER_CONNECT_TIMEOUT 10000 SMS Gateway が SMS プロバイダーとのソケット接続の確立を待機する時間 (ミリ秒)。 SMS プロバイダーに到達できない場合、トランザクションは失敗します。
SMS_PROVIDER_READ_TIMEOUT 10000 SMS Gateway が SMS プロバイダーからの応答を待機する時間 (ミリ秒)。 SMS プロバイダーに到達できない場合、トランザクションは失敗します。
SMS_PROVIDER_MAX_RETRY_NUM 2 接続が失敗した場合に、SMS Gateway が SMS サービス・プロバイダーとの接続を再試行する最大回数。
SMS_PROVIDER_RETRY_INTERVAL 0 接続が失敗した後、SMS Gateway が SMS サービス・プロバイダーとの接続を再試行するまでの待機時間 (ミリ秒)。
TIMEOUT_FOR_SESSION 3600 SMS Gateway がユーザーからの応答を受け取らない場合にセッションの有効期限が切れるまでの時間 (秒)。
WATSON_CONVERSATION_CONNECT_TIMEOUT 10000 SMS Gateway が Watson Assistant サービスとのソケット接続の確立を待機する時間 (ミリ秒)。 サービスに到達できない場合、トランザクションは失敗します。
WATSON_CONVERSATION_READ_TIMEOUT 5000 SMS Gateway が Watson Assistant サービスからの応答を待機する時間 (ミリ秒)。 サービスに到達できない場合、トランザクションは失敗します。
WATSON_CONVERSATION_MAX_RETRY_NUM 2 接続が失敗した場合に、SMS Gateway が Watson Assistant との接続を再試行する最大回数。
WATSON_CONVERSATION_RETRY_INTERVAL 0 接続が失敗した後、SMS Gateway が Watson Assistant との接続を再試行するまでの待機時間 (ミリ秒)。
NOTIFY_ON_SESSION_TIMEOUT true テナントのセッションの有効期限切れが Watson Assistant や SOE によって処理されない場合に、この変数を使用します。 テナントの場合、この変数を false に設定します。 デフォルトでは、SMS Gateway は、smsResponseTimeout をテキストで送信することで、セッションの有効期限が切れたことを Watson Assistant/SOE に通知します。

Watson Assistant サービス構成

表 10. Watson Assistant サービスを構成するための環境変数
環境変数 デフォルト値 説明
WATSON_CONVERSATION_WORKSPACE_ID N/A Watson Assistant ワークスペースの ID。 この ID は、サービス資格情報とは別個のものであり、Watson Assistantツールのワークスペース詳細の下にリストされています。

サービス・オーケストレーション・エンジンを介して Watson Assistant サービスに接続する場合は、この変数を指定しないでください。
WATSON_CONVERSATION_USERNAME N/A Watson Assistant サービスの username の資格情報。 この値は、IBM Cloud のユーザー名ではないので注意してください。 サービス資格情報の検索方法については、「Service credentials for Watson services」を参照してください。

サービス・オーケストレーション・エンジンでは、認証が必要な場合、この変数を使用して SOE のユーザー名を指定します。
WATSON_CONVERSATION_PASSWORD N/A Watson Assistant サービスの password の資格情報。 この値は、IBM Cloud のパスワードではないので注意してください。 サービス資格情報の検索方法については、「Service credentials for Watson services」を参照してください。

サービス・オーケストレーション・エンジンでは、認証が必要な場合、この変数を使用して SOE のパスワードを指定します。
WATSON_CONVERSATION_URL N/A Watson Assistant サービス API の url の資格情報 (例えば、https://gateway.watsonplatform.net/conversation/api)。 サービス資格情報の検索方法については、「Service credentials for Watson services」を参照してください。

サービス・オーケストレーション・エンジンでは、この変数を使用して SOE への正確な URL を指定します。
WATSON_CONVERSATION_API_VERSION 2017-05-26 使用する Watson Assistant API のバージョン。 SMS Gateway では、Watson Assistant API バージョン 2017-05-26 および 2016-09-20 がサポートされます。
WATSON_CONVERSATION_APIKEY N/A Watson Assistant サービスの API 鍵 apikey の資格情報。 WATSON_CONVERSATION_APIKEY を使用し、WATSON_CONVERSATION_TOKEN_SERVICE_PROVIDER_URL を https://iam.cloud.ibm.com/identity/token に設定することによって、または、WATSON_CONVERSATION_USERNAME を apikey として構成し、WATSON_CONVERSATION_PASSWORD を apikey の値で構成することによって、Watson サービスとの接続を構成することができます。 バージョン 1.0.1.0 以降。
WATSON_CONVERSATION_TOKEN_AUTH_ENABLED false Watson Assistant サービスへのトークン認証を有効にします。 デフォルトは false であり、基本認証が有効にされます。 バージョン 1.0.1.0 以降。
WATSON_CONVERSATION_TOKEN_SERVICE_PROVIDER_URL https://gateway.watsonplatform.net/authorization/api/v1/token 認証トークンが要求される URL。 バージョン 1.0.1.0 以降。

SMS プロバイダー構成

表 11. SMS プロバイダーを構成するための環境変数
環境変数 デフォルト値 説明
SMS_PROVIDER_EXPLICIT_URL N/A メッセージを送信するための SMS プロバイダー API の完全なエンドポイント URL。 例えば、RestcommONE URL を https://cloud.restcomm.com/restcomm/2012-04-24/Accounts/<YourAccountSID>/SMS/Messages.json として、Twilio URL を https://api.twilio.com/2010-04-01/Accounts/<YourAccountSID>/Messages.json として指定します。 この URL は、SMS プロバイダーに接続するために、指定されたとおりに使用されます。

この変数は、SMS_PROVIDER_URL 変数よりも優先されます。 この変数を指定した場合、SMS_PROVIDER_URL に指定された値は無視されます。
SMS_PROVIDER_URL N/A SMS プロバイダー・メッセージング API の短縮エンドポイント URL。 例えば、この変数には、RestcommONE URL を https://cloud.restcomm.com/restcomm/ として、Twilio URL を https://api.twilio.com として指定します。

この変数を指定した場合、SMS_PROVIDER_EXPLICIT_URL も指定してはなりません。
SMS_PROVIDER_USERNAME N/A SMS プロバイダーのユーザー名資格情報。通常、アカウント SID にマップされます。
SMS_PROVIDER_PASSWORD N/A SMS プロバイダーのパスワード資格情報。通常、認証トークンにマップされます。

REST API および SMS プロバイダー Web フックのための HTTP 基本認証構成

表 12. HTTP 基本認証を構成するための環境変数
環境変数 デフォルト値 説明
CTRL_TENANT_USERNAME N/A REST API を使用するために基本認証を有効にするユーザー名。 この変数が定義されている場合、ユーザーは、REST API 要求の送信時に認証しなければなりません。
CTRL_TENANT_PASSWORD N/A REST API メッセージ要求を送信するための基本認証のパスワード。
SMS_WEBHOOK_USERNAME N/A SMS プロバイダーからメッセージ要求を送信するための基本認証を有効にするユーザー名。 この値は、SMS プロバイダー構成で Web フック URL の一部として指定する必要があります。
SMS_WEBHOOK_PASSWORD N/A SMS プロバイダーからメッセージ要求を送信するための基本認証のパスワード。 この値は、SMS プロバイダー構成で Web フック URL の一部として指定する必要があります。

SMS Gateway のレポート・イベント用の環境変数

表 13. SMS レポート環境変数。
環境変数 デフォルト値 説明
SMSGW_HOST "9.42.89.143" レポートを有効にする場合は必須です。 レポートに含まれているホスト名または IP アドレス値のいずれか。 IBM Cloud Private マルチテナント構成環境の場合、この値は、podIP 値に設定されます。
ENABLE_LIMIT_ON_REPORTING_BACKUP_FILES_PER_TENANT false レポート・イベントに関してバックアップできるファイル数の制限を有効または無効にします。
REPORTING_USAGE_MAX_BACKUP_FILES_PER_TENANT 100 制限を有効にするプロパティーが true に設定されている場合、デフォルトは、テナントごとの使用量レポートに対して 100 ファイルに設定されます。
REPORTING_TRANSCRIPTION_MAX_BACKUP_FILES_PER_TENANT 1000 制限を有効にするプロパティーが true に設定されている場合、デフォルトは、テナントごとの書き起こしレポートに対して 1000 に設定されます。
MAX_EVENTS_TO_BATCH 500 1 回のパブリッシュで、テナントごとにバッチ処理できる最大レポート・イベント数。

REST サーバーでレポート・イベントをパブリッシュするための環境変数

表 14. 接続およびイベント・インデックスの環境変数
環境変数 値の例 説明
REPORTING_URL https://myresteventserver.ibm.com イベントを受け取る Splunk HEC サーバーまたは HTTP サーバーのホスト名。
REPORTING_USERNAME 14feeb-d29c-48a0-1276bab3 基本認証に使用される許可名。 Splunk HEC の場合、この値は任意のストリングで指定できます。
REPORTING_PASSWORD e11bea167aed827399d55725c45 基本認証に使用される許可パスワード。 Splunk HEC の場合、この値を Splunk 生成トークンに設定します。
REPORTING_TRANSCRIPTION_EVENT_INDEX transcription イベントを transcription レポート・イベントとして識別するストリング (例えば、transcription)。 指定された値が、すべての transcription レポート・イベントのインデックス・フィールドに組み込まれます。 transcription レポート・イベントを生成するには、この変数を定義する必要があります。
REPORTING_USAGE_EVENT_INDEX usage イベントを usage イベントとして識別するストリング (例えば、usage)。 指定された値が、すべての usage レポート・イベントのインデックス・フィールドに組み込まれます。 usage レポート・イベントを生成するには、この変数を定義する必要があります。

IBM Cloudant にレポート・イベントをパブリッシュするための環境変数

IBM Cloudant 用の transcription レポート・イベント環境変数

表 15. IBM Cloudant に transcription レポート・イベントをパブリッシュするための変数
環境変数 値の例 説明
REPORTING_TRANSCRIPTION_CLOUDANT_URL https://transcriptionCloudantURL.com その他の資格情報を単一 URL に集約するストリング。この値は、IBM Cloudant インスタンスのサービス資格情報から入手できます。
REPORTING_TRANSCRIPTION_CLOUDANT_DB_NAME sms-trans-db transcription レポート・イベント用の IBM Cloudant データベースの名前。
REPORTING_TRANSCRIPTION_CLOUDANT_ACCOUNT ABC transcription レポート・イベントで、ユーザー名とアカウント名が異なる場合に、IBM Cloudant アカウント名を定義するストリング。 IBM Cloudant に対しては、通常、ユーザー名とアカウント名は同じです。
REPORTING_TRANSCRIPTION_CLOUDANT_USERNAME eb14feeb-d29c-48a0-1276bab37f75 書き起こしレポート・イベントで、IBM Cloudant サービス資格情報と関連付けられたユーザー名。
REPORTING_TRANSCRIPTION_CLOUDANT_PASSWORD eb14feeb-d29c-48a0-1276bab37f75 書き起こしレポート・イベントで、IBM Cloudant サービス資格情報と関連付けられたパスワード。
REPORTING_TRANSCRIPTION_CLOUDANT_API_KEY ObrVygb8Gf0M1Qji4vgqr-nNgHjv transcription レポート・イベントで、IBM Cloudant サービス資格情報と関連付けられている API 鍵。
REPORTING_TRANSCRIPTION_CLOUDANT_EVENT_INDEX transcription イベントを transcription レポート・イベントとして識別するストリング (例えば、transcription)。 指定された値は、IBM Cloudant データベースに報告されるすべての transcription レポート・イベントのインデックス・フィールドに組み込まれます。 単一テナント構成を使用している場合、データベースにパブリッシュする transcription レポート・イベントを生成するには、この変数を定義する必要があります。

IBM Cloudant 用の usage レポート・イベント環境変数

表 16. IBM Cloudant に usage レポート・イベントをパブリッシュするための変数
環境変数 値の例 説明
REPORTING_USAGE_CLOUDANT_URL https://usageCloudantURL.com usage レポート・イベントを保管するための IBM Cloudant インスタンスがホストされる URL。
REPORTING_USAGE_CLOUDANT_DB_NAME sms-usage-db usage レポート・イベントで、IBM Cloudant サービス資格情報と関連付けられているユーザー名。
REPORTING_USAGE_CLOUDANT_ACCOUNT ABC usage レポート・イベントの場合、IBM Cloud に関連付けられているアカウント名は、通常同じものです。
REPORTING_USAGE_CLOUDANT_USERNAME eb14feeb-d29c-48a0-1276bab37f75 usage レポート・イベントで、IBM Cloudant サービス資格情報と関連付けられているユーザー名。
REPORTING_USAGE_CLOUDANT_PASSWORD eb14feeb-d29c-48a0-1276bab37f75 usage レポート・イベントで、IBM Cloudant サービス資格情報と関連付けられているパスワード。
REPORTING_USAGE_CLOUDANT_API_KEY ObrVygb8Gf0M1Qji4vgqr-nNgHjv usage レポート・イベントで、IBM Cloudant サービス資格情報と関連付けられている API 鍵。
REPORTING_USAGE_CLOUDANT_EVENT_INDEX usage イベントを usage イベントとして識別するストリング (例えば、usage)。 指定された値は、IBM Cloudant データベースに報告されるすべての usage レポート・イベントのインデックス・フィールドに組み込まれます。 単一テナント構成を使用している場合、データベースにパブリッシュする usage レポート・イベントを生成するには、この変数を定義する必要があります。