6.2. コネクタを登録する

ここでは、コネクタの登録方法について説明します。

コネクタを新規作成する

コネクタの形式について

コネクタは、エッジアプリとクラウドアプリが共通で利用するデータ形式を、下記のようにJSONスキーマの形式で記述します。
エッジアプリとクラウドアプリが使用する可能性のあるプロパティを全て定義してください。

コネクタとして登録できるJSONスキーマの例を下記に示します。

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "required": ["connectorID", "edgeID", "timestamp", "data1"],
    "properties": {
         "connectorID": {
            "type": "string"
        },
         "edgeID": {
            "type": "string"
        },
         "timestamp": {
            "type": "string"
        },
        "data1": {
            "type": "integer"
        },
        "data2": {
            "type": "object"
        },
        "data3": {
            "type": "array",
            "items": {
                "anyOf": [
                    {
                        "type": "string"
                    }
                ]
            }
        }
    },
    "additionalProperties": false
}

コネクタとして登録できるJSONスキーマの仕様は下記のとおりです。
下記の仕様に従っていないJSONスキーマは、コネクタとして登録できませんので注意してください。

  • 一番上位の階層は必ずtype: "object"とする

  • $schemaの指定については任意(JSON Schema Draft 7に準ずる)

  • propertiesは必須とし、下記のプロパティを必ず指定する

    • connectorID

      • type: "string"

    • edgeID

      • type: "string"

    • timestamp

      • type: "string"

    • connectorIDedgeIDtimestamp以外のプロパティの指定については自由とする

  • requiredは必須とし、必ずconnectorIDedgeIDtimestampを指定する

    • connectorIDedgeIDtimestamp以外のプロパティの指定については自由とする

    • 指定したプロパティは、エッジアプリからのデータ送信時に存在チェックが自動で行われるため、必須プロパティについては指定することを推奨する

  • additionalPropertiesは必須とし、必ずfalseを指定する

  • 下記のキーワードは使用できない

    • dependencies

    • minProperties

    • maxProperties

上記以外の仕様はJSON Schema Draft 7の仕様に準じます。
JSONスキーマの詳細については、 JSON Schema を参照してください。

コネクタの作成方法

サイドメニューから [開発] - [コネクタ] を選択すると、コネクタ管理画面が表示されます。

connector_mng

この画面ではコネクタの新規作成や、作成したコネクタの編集、削除などを行うことができます。 コネクタ管理画面についての詳細は、 コネクタを管理する を参照してください。

注釈

IoTストアで既に公開されているコネクタのJSONスキーマファイルをダウンロードして参考にし、類似のコネクタを作成することもできます。
JSONスキーマファイルのダウンロード方法については、 コネクタを管理する を参照してください。

コネクタを作成するには、画面右上の [新規作成] ボタンを押下してください。

connector_dialog

コネクタ新規作成ダイアログが表示されましたら、必要な情報を入力します。

  • コネクタ名 (必須)

    • IoTストアに公開されるコネクタの名前を入力します。重複した名前は使用できません

  • JSONスキーマ (必須)

    • コネクタとして登録するJSONスキーマを登録します。 [参照] ボタンを押下してJSONファイルを選択します

    • 選択できるファイル形式は.json形式です

  • 説明

    • コネクタの説明を入力します

必要な情報の入力が完了しましたら、 [登録] ボタンを押下してコネクタを登録します。
登録が完了しましたら、コネクタ管理画面に作成したコネクタが表示されていることを確認します。

注意

コネクタとして使用できないJSONスキーマや、JSONスキーマの構文が誤っている場合は登録できません。
再度JSONスキーマの記述を確認してください。

内包コネクタを設定する

内包コネクタとは

コネクタが他のコネクタの定義をすべて含んでいる場合、他のコネクタを 内包コネクタ として設定することができます。
内包コネクタを設定することで、システムパッケージを作成する際に同じコネクタを使用しているアプリだけでなく、内包コネクタとして設定したコネクタを使用しているアプリも連携できるようになります。

connector_overall

内包コネクタとして設定できる条件

下記の条件を満たした場合、コネクタBを コネクタAの内包コネクタ として設定することができます。

  • コネクタBのrequiredに設定されているプロパティが、コネクタAのrequiredにすべて含まれている

  • コネクタBのpropertiesに含まれるプロパティが、typeを含めて全てコネクタAのpropertiesに含まれている

下記の例では、内包コネクタの条件を満たしているためコネクタBをコネクタAの内包コネクタとして設定することができます。

  • コネクタAのJSONスキーマ定義

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "required": ["connectorID", "edgeID", "timestamp", "data1", "data2", "data3"],
    "properties": {
         "connectorID": {
            "type": "string"
        },
         "edgeID": {
            "type": "string"
        },
         "timestamp": {
            "type": "string"
        },
        "data1": {
            "type": "integer"
        },
        "data2": {
            "type": "object"
        },
        "data3": {
            "type": "array",
            "items": {
                "anyOf": [
                    {
                        "type": "string"
                    }
                ]
            }
        }
    },
    "additionalProperties": false
}
  • コネクタBのJSONスキーマ定義(内包として設定するコネクタ)

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "type": "object",
    "required": ["connectorID", "edgeID", "timestamp", "data1", "data2"],
    "properties": {
         "connectorID": {
            "type": "string"
        },
         "edgeID": {
            "type": "string"
        },
         "timestamp": {
            "type": "string"
        },
        "data1": {
            "type": "integer"
        },
        "data2": {
            "type": "object"
        },
    "additionalProperties": false
}

内包コネクタの設定方法

内包コネクタの設定はコネクタ詳細画面から設定を行います。
コネクタ管理画面から内包コネクタを設定するコネクタの [コネクタID][コネクタ名] を選択してください。

connector_detail

コネクタ詳細画面が表示されましたら、 [コネクタ情報][内包コネクタ] から [編集] ボタンを押下してください。

connector_subset01 connector_subset02

この画面では、内包コネクタの編集を行うことができます。

コネクタ詳細

  • コネクタID

    • コネクタIDが表示されます

  • コネクタ名

    • コネクタ名が表示されます

  • JSONスキーマ

    • 形式

      • JSONスキーマの内容が表示されます

コネクタ一覧

コネクタ一覧には、IoTストアに登録されているコネクタの一覧が表示されます。
各行を選択することでコネクタ参照エリアが表示され、該当のコネクタの詳細情報を確認することができます。

connector_select

コネクタ一覧は各列のヘッダーを選択することで表のソートが可能です。
[entries] の横にあるプルダウンからは表示数を変更することができます。
[search] の入力欄にキーワードを選択することで、表の絞り込みをすることができます。
各列の説明を以下に示します。

項目名

説明

コネクタID

コネクタIDが表示されます
選択することで、コネクタ詳細画面がサブウィンドウで表示されます

コネクタ名

コネクタ名が表示されます
選択することで、コネクタ詳細画面がサブウィンドウで表示されます

最終更新日時

コネクタの最終更新日時が表示されます

内包コネクタとして設定したいコネクタを選択するには、コネクタのチェックボックスにチェックを入れてください。
既に設定されているコネクタを解除するには、チェックボックスからチェックを外してください。 内包コネクタの選択が完了しましたら、 [登録] ボタンを押下してください。

注意

内包コネクタとして設定できないコネクタを選択した場合は、エラーが発生します。
選択したコネクタを確認して、再度登録を行ってください。

コネクタ詳細画面が表示されましたら、登録した内包コネクタが [内包コネクタ] に表示されていることを確認してください。

connector_subset03