Deskripsi Skema JSON

Dokumen ini menjelaskan struktur skema JSON untuk modul Integrasi.

Struktur Umum

Skema JSON adalah array dari objek, di mana setiap objek adalah sebuah node atau tab:

[
  {
    "label": "Hello World!",
    "id": "1f24387b252057fe",
    "type": "tab",
    "disabled": false
  },
  {
    "name": "run",
    "id": "b51ab819b83e1915",
    "type": "inject",
    "x": 46.96875,
    "y": 99.51171875,
    "z": "1f24387b252057fe",
    "wires": [
      [
        "bd07e1ff0aedba0b"
      ]
    ]
  },
  {
    "id": "2b524ca59e4ed633",
    "type": "debug",
    "name": "debug",
    "x": 610.05078125,
    "y": 98.59765625,
    "z": "1f24387b252057fe",
    "wires": []
  },
  {
    "name": "function",
    "func": "msg.payload = 'World'\n\nreturn msg;",
    "id": "bd07e1ff0aedba0b",
    "type": "function",
    "x": 229.62890625,
    "y": 98.8515625,
    "z": "1f24387b252057fe",
    "wires": [
      [
        "2e1172b330c69aeb"
      ]
    ]
  },
  {
    "id": "2e1172b330c69aeb",
    "type": "template",
    "name": "template",
    "x": 418.66796875,
    "y": 98.19140625,
    "z": "1f24387b252057fe",
    "syntax": "mustache",
    "template": "Hello {{payload}} !",
    "output": "str",
    "wires": [
      [
        "2b524ca59e4ed633"
      ]
    ]
  }
]

Parameter Node Utama

Sebagian besar node memiliki parameter umum berikut:

• id (string) - pengidentifikasi unik dari node
• type (string) - jenis node (misalnya, "inject", "function", "template")
• name (string) - nama yang ditampilkan dari node
• x, y (number) - koordinat node di ruang kerja
• z (string) - pengidentifikasi tab tempat node berada
• wires (array) - array dari array pengidentifikasi node yang terhubung ke output

Node Sistem

Node "tab"

Node tab berfungsi sebagai wadah untuk sekelompok node, yang secara visual direpresentasikan sebagai tab di antarmuka.

Parameter:

• label (string) - nama yang ditampilkan dari tab
• id (string) - pengidentifikasi unik dari tab
• type (string) - jenis node (tab)
• disabled (boolean) - apakah tab dinonaktifkan

Node "debug"

Node debug digunakan untuk mengeluarkan pesan ke panel debug.

Parameter Utama:

• id (string) - pengidentifikasi unik dari node
• type (string) - jenis node (debug)
• name (string) - nama yang ditampilkan dari node
• x, y (number) - koordinat node di ruang kerja
• z (string) - pengidentifikasi tab tempat node berada
• wires (array) - array koneksi untuk output

Koneksi Antara Node

Parameter wires mendefinisikan koneksi antara node. Setiap elemen dari array sesuai dengan output dari sebuah node dan berisi array pengidentifikasi node yang terhubung ke output ini.

Contoh:

"wires": [
  [
    "bd07e1ff0aedba0b"
  ]
]

Deskripsi Parameter Node

Node "inject"

Node inject digunakan untuk membuat dan mengirim pesan ke dalam aliran secara manual.

Parameter Utama:

• id (string) - pengidentifikasi unik dari node
• type (string) - jenis node (inject)
• name (string) - nama yang ditampilkan dari node
• x, y (number) - koordinat node di ruang kerja
• z (string) - pengidentifikasi tab tempat node berada
• wires (array) - array koneksi untuk output

Node "function"

Node function memungkinkan eksekusi kode JavaScript yang arbitrer.

Parameter Utama:

• id (string) - pengidentifikasi unik dari node
• type (string) - jenis node (function)
• name (string) - nama dari node
• func (string) - kode yang akan dieksekusi
• x, y (number) - koordinat node di ruang kerja
• z (string) - pengidentifikasi tab tempat node berada
• wires (array) - array koneksi untuk output

Node "template"

Node template digunakan untuk mengubah pesan menggunakan template.

Parameter Utama:

• id (string) - pengidentifikasi unik dari node
• type (string) - jenis node (template)
• name (string) - nama dari node
• syntax (string) - sintaks template (mustache atau plain)
• template (string) - template pesan
• output (string) - jenis output (plain, json, atau yaml)
• x, y (number) - koordinat node di ruang kerja
• z (string) - pengidentifikasi tab tempat node berada
• wires (array) - array koneksi untuk output

Node "interval-node"

Node interval-node digunakan untuk menghasilkan pesan pada interval waktu tertentu.

Parameter Utama:

• id (string) - pengidentifikasi unik dari node
• type (string) - jenis node (interval-node)
• name (string) - nama dari node
• interval (number) - interval dalam menit antara pesan
• x, y (number) - koordinat node di ruang kerja
• z (string) - pengidentifikasi tab tempat node berada
• wires (array) - array koneksi untuk output

Node "switch"

Node switch digunakan untuk mengarahkan pesan melalui jalur yang berbeda berdasarkan kondisi.

Parameter Utama:

• id (string) - pengidentifikasi unik dari node
• type (string) - jenis node (switch)
• name (string) - nama dari node
• property (string) - properti pesan yang akan diperiksa
• rules (array) - array aturan untuk pengalihan
• outputs (number) - jumlah port output
• checkall (string) - periksa semua aturan (true atau false)
• repair (boolean) - perbaiki pesan yang tidak valid
• x, y (number) - koordinat node di ruang kerja
• z (string) - pengidentifikasi tab tempat node berada
• wires (array) - array koneksi untuk output

Node "split"

Node split digunakan untuk membagi pesan menjadi beberapa bagian.

Parameter Utama:

• id (string) - pengidentifikasi unik dari node
• type (string) - jenis node (split)
• name (string) - nama dari node
• property (string) - properti pesan yang akan dibagi
• propertyType (string) - jenis properti (msg, flow, global)
• splt (string) - pemisah untuk string
• spltType (string) - jenis pemisah (str, bin)
• arraySplt (number) - ukuran bagian untuk array
• arraySpltType (string) - jenis pemisahan array (len, index)
• stream (boolean) - pemrosesan mode streaming
• x, y (number) - koordinat node di ruang kerja
• z (string) - pengidentifikasi tab tempat node berada
• wires (array) - array koneksi untuk output

Node "http in"

Node http in digunakan untuk membuat endpoint HTTP dan menerima permintaan HTTP yang masuk.

Parameter Utama:

• id (string) - pengidentifikasi unik dari node
• type (string) - jenis node (http in)
• name (string) - nama dari node (opsional)
• url (string) - jalur URL dari endpoint
• method (string) - metode HTTP (get, post, put, delete, patch)
• x, y (number) - koordinat node di ruang kerja
• z (string) - pengidentifikasi tab tempat node berada
• wires (array) - array koneksi untuk memproses permintaan

Node "http request"

Node http request digunakan untuk melakukan permintaan HTTP keluar.

Parameter Utama:

• id (string) - pengidentifikasi unik dari node
• type (string) - jenis node (http request)
• name (string) - nama dari node
• url (string) - alamat URL untuk permintaan
• method (string) - metode HTTP (GET, POST, PUT, DELETE, dll.)
• ret (string) - format respons (obj, txt, bin)
• headers (array) - array header permintaan
• paytoqs (string) - di mana menempatkan payload (body, query)
• useAuth (boolean) - menggunakan otentikasi
• authType (string) - jenis otentikasi (basic, bearer)
• x, y (number) - koordinat node di ruang kerja
• z (string) - pengidentifikasi tab tempat node berada
• wires (array) - array koneksi untuk memproses respons

Node "http response"

Node http response digunakan untuk mengirim respons HTTP kembali ke klien.

Parameter Utama:

• id (string) - pengidentifikasi unik dari node
• type (string) - jenis node (http response)
• name (string) - nama dari node
• statusCode (number) - kode status HTTP dari respons
• x, y (number) - koordinat node di ruang kerja
• z (string) - pengidentifikasi tab tempat node berada
• wires (array) - array koneksi (biasanya kosong)

Node "cms-events"

Node ini memungkinkan pelacakan peristiwa dari modul Events dan menyuntikkan mereka ke dalam aliran.

Parameter Utama:

• id (string) - pengidentifikasi unik dari node
• type (string) - jenis node (cms-events)
• name (string) - nama dari node
• eventMarker (string) - pengidentifikasi peristiwa
• property (string) - properti pesan untuk pemrosesan
• targetType (string) - jenis target untuk pemrosesan (msg, flow, global)
• x, y (number) - koordinat node di ruang kerja
• z (string) - pengidentifikasi tab tempat node berada
• wires (array) - array koneksi untuk pemrosesan lebih lanjut

Node "admin-api"

Node ini memungkinkan interaksi dengan berbagai API.

Parameter Utama:

• id (string) - pengidentifikasi unik dari node
• type (string) - jenis node (admin-api)
• name (string) - nama dari node
• path (string) - jalur dari endpoint API
• method (string) - metode HTTP (post, get, put, delete)
• operation (string) - pengidentifikasi operasi pengendali
• data (string) - data permintaan dalam format JSON
• wires (array) - array koneksi untuk memproses respons