通知
通知は 1 つ以上のトリガから成ります。トリガは、指定されたイベントについて通知を受けるユーザーとそのユーザーが受信するメッセージを定義します。トリガを作成する際には、以下を定義する必要があります。
• ソース - 通知が送信される原因となるソースエンティティとイベント。
• ハンドラ - 通知メッセージを送信するサービスを提供するエンティティ。ハンドラは送信可能なコンテンツのタイプを定義します。以下のハンドラを使用できます。
◦ MailServer - Mail Extension (この拡張機能のバージョン 3.5.0 以上) からの Thing。
そのメッセージには件名と本文が含まれます。
◦ Twilio - Twilio Extension (この拡張機能のバージョン 3.1.0 以上) からの Thing。
そのメッセージには本文が含まれます。
 |
1 つの通知が同じハンドラエンティティを使用する複数のトリガを持つことはできません。同じハンドラを使用する複数のトリガがある場合、別の通知エンティティを作成する必要があります。
|
• コンテンツ - ユーザーに送信されるメッセージ。コンテンツには、そのデータシェイプで定義されているイベントデータパケットなど、通知をトリガしたイベントからの追加データを含めることができます (
Thing イベントを参照)。二重の角括弧とコロン表記を使用して、イベントデータを含めることができます。たとえば [[:<event_data>:]] で、この event_data はイベントパラメータの名前を指しています。これはイベントに購読を追加するときに使用する名前と同じです (
Thing の購読を参照)。
使用可能なイベントパラメータを調べるには、以下の操作を行います。
1. Composer から、 > 、「Thing Template」、または「Thing Shape」をブラウズして、エンティティを開きます。
2. 「購読」領域で、一時的な購読を追加するために「追加」ボタンをクリックします。
3. 「入力」領域をクリックして、ドロップダウンリストから「イベント」を選択します。
4. 必要に応じて、ドロップダウンリストからプロパティを選択できます。
入力のリストが表示されます。
5. スクリプト領域にパラメータを追加するには、矢印 (
) アイコンをクリックします。
) アイコンをクリックします。スクリプト領域に表示されているパラメータ名は通知コンテンツで使用できます。
6. 「完了」をクリックします。
通知コンテンツの最良事例としては、「デフォルト」ローカライズテーブルでトークンを作成してそこでテキストを定義することでテキストを多言語化します。[[<token_name>]] のように、ローカライズトークン名を二重角括弧内に指定することで通知コンテンツを定義できます。
| | ハンドラの実装と、メッセージの送信に使用されるエンドサービスによっては、送信可能なメッセージに制限が生じることがあります。たとえば、特定のメールサーバーによって送信される電子メールの本文の長さにサイズ制限が生じることがあります。Twilio では SMS メッセージの文字制限があります。詳細については、メッセージングサービスによって提供されているドキュメンテーションを参照して、そのようなコンテンツ制限に準拠するようにしてください。 |
• 受信者 - 通知メッセージの送信先となる 1 人以上の ThingWorx ユーザー。
| | 電子メールやテキストメッセージを正常に受信するためには、「ユーザー拡張機能」コンフィギュレーション (emailAddress Thing Shape) で有効な電子メールアドレス (mobilePhone プロパティ)、携帯電話番号 (UserExtensions プロパティ)、またはその両方が指定されている必要があります。 テキストメッセージは SMS アドレス (smsAddress プロパティ) ではなく指定されている携帯電話番号に送信されます。 |
通知イベント
通知がトリガーされると、以下のイベントが発生します。
• NotificationSent
• NotificationFailed
これらのイベントに応答できるように (ストリームまたはログファイルにエントリを書き込むなど) イベントを購読するには、以下の操作を行います。
1. Composer から、 > の順にブラウズし、通知 Thing を選択します。
2. 「入力」タブをクリックし、購読への入力として NotificationSent または NotificationFailed イベントを選択します。
3. 購読ロジックを入力します。
通知のインポートまたはエクスポート
通知は基本的な通知情報および関連するトリガー情報が格納されるファイルにエクスポートされます (NotificationDefinition_<名前>.xml など)。
または、Composer のすべてのシステムエンティティを、 > > > から、または > > からエクスポートすることもできます。これにより、通知とトリガーが、指定したリポジトリの NotificationDefinitions フォルダおよび NotificationContents フォルダにある独自のファイルにエクスポートされます。モデルタグまたはプロジェクト名を指定してトリガーをエクスポートすることはできません。
通知をインポートするための前提条件は次のとおりです。
• ソースエンティティとイベントが存在する。
• ハンドラエンティティ (MailServer Thing または Twilio Thing) が存在する。
• 受信者として指定されているユーザーエンティティが存在する。