ガイドAPIリファレンス
ガイド

ルールの作成と管理

センサールールジオフェンスに加えて、滞留、留置、利用、在庫、オンラインのルールを作成することもできます。

作成したルールは、デバイスに関連付けることができます (該当する場合)。関連付けは、テレメトリーがデバイスから受信されるたびに、ルール条件に基づいて評価されることを意味します。評価が変更されると (trueからfalseなど)、イベントが作成されます。

これらのルールは、rulesエンドポイントを介して管理されます。

滞留および在庫のルールでは、ルールの評価の基礎としてジオフェンスイベントが使用されます。つまり、ジオフェンスによってイベントが生成されない場合、滞留や在庫のイベントは生成されません。さらに、滞留または在庫ルールの条件が満たされたかどうかを判断するために、ジオフェンスイベントが使用されます。

留置および利用ルールの評価は、検出されたデバイスの移動に基づいています。

出荷は出荷スケジュールルールに関連付けることができます。出荷が指定した出荷スケジュールから逸脱すると、出荷スケジュールイベントが生成されます。

滞留ルール

デバイスが、指定されたしきい値の期間よりも長い間デバイスに関連付けられたジオフェンス内に留まっていた場合、そのデバイスは滞留状態と見なされます。

ユーザーは、デバイスがジオフェンス内に長時間留まっている場合、ジオフェンス内のデバイスの経過時間を追跡できます。

在庫ルール

ユーザーは、ジオフェンス内のデバイス数が指定された在庫超過および在庫不足の制限のしきい値を超えた際にイベントを受け取ることができます。他のルールとは異なり、在庫ルールはデバイスに関連付けることはできません。代わりに、在庫ルールは在庫ルール構成で指定されているジオフェンスに関連付けることができます。

留置ルール

指定したしきい値の期間を超えてデバイスが静止状態のままになっている場合、そのデバイスは留置状態になります。ユーザーは、デバイスが長時間静止状態になったときにイベントを受け取ることができます。

利用ルール

デバイスは移動中、または許容されたしきい値時間を超えて静止していない場合に利用されていると見なされます。ユーザーは、静止状態にあったデバイスが再び使用された際にイベントを受け取ります。

オンラインルール

デバイスは計画された取り込みスケジュールを5分超えて遅れた場合、オフラインと見なされます。取り込みスケジュールはデバイスの任意のシャドウに設定できます。

ユーザーは、デバイスがオフラインになったときと、オンラインに戻ったときに、イベントを受け取ることができます。

出荷スケジュールルール

出荷スケジュールルールは、出荷の作成時に出荷に関連付けられます。

出荷スケジュールルールは、出荷に関連付けられているデバイスからの取り込みが受信されるたび、および出荷のセグメントステータスがshipmentsエンドポイントUpdates segment plan detailsAPIコールを介して明示的に更新されるたびに評価されます。

スケジュール単位では、アクティブなセグメントのデバイス取り込み時間またはセグメントステータスの変更時間に基づいて、出荷のセグメント状態を、earlyon timeまたはdelayedのいずれかにできます。時間は提供されたセグメントのETD/ETA時間と比較されます。

出荷スケジュールルールには、イベントがトリガーされる前に、出荷が予定されているスケジュールから逸脱できる範囲を示すbeforeafterのパラメーターがあります。

出荷予定変更ルール

ETD/ETA変更ルールは出荷に関連付けられます。このルールは出荷の新しい到着予定時間 (ETA) または出発予定時間 (ETD) が計算されるたびに評価されます。このルールでは'deviation'パラメーターを考慮します。このパラメーターはETA/ETD変更イベントをトリガーするために、新しい予定値が以前の予定値からどれだけ逸脱している必要があるかを指定します。逸脱がこのしきい値を超えると、ETA/ETD変更イベントがトリガーされ、出荷スケジュールが調整される可能性があることを示します。