ペイロード・データ

Transparent Supply は、ペイロード・データ・アップロード方式を提供して、標準の GS-1 データ・タイプを超えてサポートを拡張します。ペイロードを使用して、イベント、アイテム (製品ロット、シリアル出荷容器、パレット)、またはロケーションにユーザー定義データ (属性など) を添付します。

ペイロード・タイプ

ペイロードは、 <payloadTypeURI> タグを使用して、含まれているデータのタイプを指定する必要があります。 Transparent Supply は、以下のペイロード・タイプを定義します。

キーと値のペア
センサー・データ
ストリング

以下の例は、これらのペイロード・タイプのそれぞれに使用する必要がある <payloadTypeURI> 値を示しています。

添付ポイント

送信されたペイロードは、アイテム (製品 ID)、EPC、ロケーション (施設 ID)、またはイベント (EPCIS イベント ID) に添付する必要があります。ペイロードに以下のいずれかのデータ・ポイントを含めます。

製品 ID-ペイロード XML の productList エレメントを使用した製品 ID。
電子製品コード (EPC)-ペイロード XML 内の epcList エレメントを使用することにより、EPC-SSCC、FTLPN、SGTIN、SFTPI、LGTIN、または LFTPI。
Location Identifier-ペイロード XML 内の locationList エレメントを使用するサプライ・チェーン・ロケーション (ファシリティー ID)。
EPCIS イベント ID-ペイロード XML 内の eventIDList エレメントを使用して、委員会イベント、デコミッション・イベント、集約イベント、集約イベント、変換イベント、または観測イベントの場合。

注: 以下のコンテンツ・タイプ例は、EPC に添付されています: <epc>urn:ibm:ift:product:serial:obj:1234567890123.LiveCow.lc11</epc>

使用上の注意

ペイロード・データをアップロードする際には、以下の使用上の注意を考慮してください。

Transparent Supply UI に表示される唯一のペイロード・データは、サポートされる製品 ID または施設 ID に付加されるキーと値のペアです。サポートされるフォーマットは、 GS1 SSCC、GTIN、SGTIN、LGTIN、GLN、および EPC-SGLN と、それらに相当する Transparent Supply のみです。
Transparent Supply UI でペイロードの名前を変更するには、キーとしてタイトル、値として新しい名前を持つキーと値のペアをアップロードします。
ペイロード・メッセージは 32 KB を超えることはできません。
デフォルトでは、ペイロードはプライベート資格モードを使用します。
「イベント ID」にのみ添付されたペイロードは、ペイロードのエンタイトルメント・モードに関係なく、他の組織には資格を付与されません。

ペイロード・データの送信

Transparent Supply コネクター API assets エンドポイントを使用して、ペイロードを送信します。ペイロード XML を 「asset Parameter Value」 フィールドに貼り付け、「Try it out!」をクリックします。

以下の例では、各ペイロード・タイプの XML について説明します。

キーと値のペア

キーと値のペアのペイロード・データ・タイプを使用して、変数と値の組み合わせの任意のセットをアップロードします。

キーと値のペアのペイロード・データは、以下の形式を使用して指定する必要があります。

<payloadTypeURI>urn:ibm:ift:payload:type:json:triple</payloadTypeURI>

以下のコードは、キーと値のペアのペイロード・データを指定するサンプル・ペイロードを示しています。

<ift:payload xmlns:ift="urn:ibm:ift:xsd:1">
  <payloadMessage>
    <payloadID>41b14d7a-5b04-11e9-bdaa-6c4008984c16</payloadID>
    <payloadTime>2019-03-01T08:00:00Z</payloadTime>
    <payloadContentType>application/json</payloadContentType>
    <payloadTypeURI>urn:ibm:ift:payload:type:json:triple</payloadTypeURI>
    <epcList>
      <epc>urn:ibm:ift:product:serial:obj:1234567890123.LiveCow.lc11</epc>
    </epcList>
    <payload>[{"key":"title", "value":"My test payload","type":"string"}, {"key": "Lot Number", "value": "LiveCow.lc11", "type": "string"}, {"key": "Lairage Intake Date", "value": "2019-03-01 08:00:00", "type": "string"}, {"key": "Herd Number", "value": "Herd-lc11", "type": "string"}, {"key": "Site Code", "value": "Site0001", "type": "string"}, {"key": "Eartag", "value": "Ear-lc11", "type": "string"}]</payload>
  </payloadMessage>
</ift:payload>

センサー・データ

センサー ・ペイロード・データ・タイプを使用して、センサー・デバイスによって収集された測定値をアップロードします。センサー・データ・タイプの値として任意のストリングが受け入れられます。ペイロードは 32 KB を超えることはできません。

例えば、周辺 (ロケーション温度) または プローブ (製品温度) を記録できます。 センサー ・ペイロード・データ・タイプは、以下の形式を使用して指定する必要があります。

<payloadTypeURI>urn:ibm:ift:payload:type:json:sensor:v2</payloadTypeURI>

以下のコードは、指定された locationの 周辺温度 (華氏) センサー・データ・ペイロードのサンプルを示しています。

<ns0:payload xmlns:ns0="urn:ibm:ift:xsd:1">
  <payloadMessage>
    <payloadID>urn:uuid:00000000-0000-0000-0000-00003b9acc47</payloadID>
    <payloadTime>2020-01-15T00:00:00Z</payloadTime>
    <payloadContentType>application/json</payloadContentType>
    <payloadTypeURI>urn:ibm:ift:payload:type:sensor:v2</payloadTypeURI>
    <locationList>
      <location>urn:ibm:ift:location:extension:loc:0070217.5043.0</location>
    </locationList>
    <payload>
      {"payload": {"readings": [{"value": 48.97403963890513, "time": "2020-01-14T00:00:00Z"},
      {"value": 49.38640811696154, "time": "2020-01-14T00:15:00Z"},
      {"value": 49.482325803716854, "time": "2020-01-14T00:30:00Z"},
      {"value": 49.7178481505353, "time": "2020-01-14T00:45:00Z"},
      {"value": 55.114865776213215, "time": "2020-01-14T03:15:00Z"},  
      {"value": 93.69268608689146, "time": "2020-01-14T23:30:00Z"},
      {"value": 94.4938525640488, "time": "2020-01-14T23:45:00Z"}],
      "device_id": "S00001", "type": "gs1:Temperature", "uom": "FAH",
      "reading_type": "urn:ibm:ift:sensor:readingtype:ambient"}}
</payload>
  </payloadMessage>
</ns0:payload>

以下のコードは、指定された製品インスタンス (EPC) および サブロケーションの プローブ温度 (華氏) センサー・データ・ペイロードの例を示しています。

<?xml version="1.0" encoding="UTF-8"?>
<ift:payload xmlns:ift="urn:ibm:ift:xsd:1">
  <payloadMessage>
    <payloadID>string</payloadID>
    <payloadTime>2018-09-28T21:49:45Z</payloadTime>
    <payloadContentType>application/json</payloadContentType>
    <payloadTypeURI>urn:ibm:ift:payload:type:sensor:v2</payloadTypeURI>
    <eventIDList/>
    <epcList>
      <epc>urn:ibm:ift:product:serial:obj:0614141000000.107346.2016</epc>
    </epcList>
    <locationList>
      <location>urn:ibm:ift:location:extension:loc:1234567890123.store-123.toy-department</location>
    </locationList>
    <payload>
      {
        "payload": {
          "reading_type": "urn:ibm:ift:sensor:readingtype:probe",
          "device_id": "S00001",
          "uom": "FAH",
          "type": "gs1:Temperature",
          "readings": [
            {
              "time": "2018-09-12T01:00:00.000Z",
              "value": 45
            },
            {
              "time": "2018-09-12T01:05:00.000Z",
              "value": 40
            }
          ]
        }
      }
    </payload>
  </payloadMessage>
</ift:payload>

ストリング

任意のストリングをアップロードするには、 string ペイロード・データ・タイプを使用します。 string ペイロード・データ・タイプは、以下の形式を使用して指定する必要があります。

<payloadTypeURI>string</payloadTypeURI>

<ift:payload xmlns:ift="urn:ibm:ift:xsd:1">
  <payloadMessage>
    <payloadID>41b14d7a-5b04-11e9-bdaa-6c4008984c16</payloadID>
    <payloadTime>2019-03-01T08:00:00Z</payloadTime>
    <payloadContentType>application/json</payloadContentType>
    <payloadTypeURI>string</payloadTypeURI>
    <epcList>
    <epc>urn:ibm:ift:product:serial:obj:1234567890123.LiveCow.lc11</epc>
    </epcList>
<payload>
Any customized string up to the 32 KB length limit.
</payload>
  </payloadMessage>
  </ift:payload>