component.json

{
  "title": "CSV",
  "version": "2.2.2",
  "deprecated": true,
  "description": "A comma-separated values (CSV) file stores tabular data (numbers and text) in plain-text form",
  "docsUrl": "https://github.com/elasticio/csv-component",
  "buildType": "docker",
  "triggers": {
    "read": {
      "main": "./lib/triggers/read.js",
      "title": "Read CSV file from URL",
      "help": {
        "description": "Fetch a CSV file from a given URL and store it in the attachment storage.",
        "link": "/components/csv/triggers#read-csv-file-from-url"
      },
      "type": "polling",
      "fields": {
        "url": {
          "label": "CSV URL",
          "required": true,
          "placeholder": "https://my-url.com/foo.csv",
          "note": "We will fetch this URL and parse it as CSV file",
          "viewClass": "TextFieldWithNoteView"
        },
        "reader": {
          "viewClass": "CSVReadView"
        }
      },
      "metadata": {
        "out": {}
      }
    }
  },
  "actions": {
    "read_action": {
      "main": "./lib/triggers/read.js",
      "title": "Read CSV attachment",
      "help": {
        "description": "Read a CSV attachment of an incoming message.",
        "link": "/components/csv/actions#read-csv-attachment"
      },
      "fields": {
        "url": {
          "label": "CSV URL",
          "required": false,
          "placeholder": "http://my-url.com/foo.csv",
          "note": "We will fetch this URL and parse it as CSV file, leave the field blank if you expect CSV attachment from previous step",
          "viewClass": "TextFieldWithNoteView"
        },
        "emitAll": {
          "label": "Emit all messages",
          "viewClass": "CheckBoxView"
        },
        "reader": {
          "viewClass": "CSVReadView",
          "required": true
        }
      },
      "metadata": {
        "out": {}
      }
    },
    "write_attachment": {
      "main": "./lib/actions/write.js",
      "title": "Write CSV attachment",
      "help": {
        "description": "Multiple incoming events can be combined into one CSV file with the write CSV action.",
        "link": "/components/csv/actions#write-csv-attachment"
      },
      "fields": {
        "includeHeaders": {
          "label": "Include Headers",
          "required": false,
          "viewClass": "SelectView",
          "description": "Default Yes",
          "model": {
            "Yes": "Yes",
            "No": "No"
          },
          "prompt": "Include headers? Default Yes."
        },
        "writer": {
          "viewClass": "CSVWriteView"
        }
      },
      "metadata": {
        "in": {
          "type": "object",
          "properties": {}
        },
        "out": {}
      }
    },
    "write_attachment_from_json": {
      "main": "./lib/actions/writeFromJson.js",
      "title": "Write CSV attachment from JSON Object",
      "help": {
        "description": "Multiple incoming events can be combined into one CSV file with the write CSV action.",
        "link": "/components/csv/actions#write-csv-attachment-from-json-object"
      },
      "fields": {
        "includeHeaders": {
          "label": "Include Headers",
          "required": false,
          "viewClass": "SelectView",
          "description": "Default Yes",
          "model": {
            "Yes": "Yes",
            "No": "No"
          },
          "prompt": "Include headers? Default Yes"
        },
        "separator": {
          "label": "Separators",
          "required": true,
          "viewClass": "SelectView",
          "model": {
            "comma": "Comma (,)",
            "semicolon": "Semicolon (;)",
            "space": "Space ( )",
            "tab": "Tab (\\t)",
            "pipe": "Pipe (\u00A6)"
          },
          "prompt": "Choose required CSV delimiter"
        }
      },
      "metadata": {
        "in": {
          "type": "object",
          "properties": {
            "inputObject": {
              "type": "object",
              "properties": {}
            }
          }
        },
        "out": {}
      }
    },
    "write_attachment_from_array": {
      "main": "./lib/actions/writeFromArray.js",
      "title": "Write CSV attachment from JSON Array",
      "help": {
        "description": "Incoming array can be converted into one CSV file with the write CSV action.",
        "link": "/components/csv/actions#write-csv-attachment-from-json-array"
      },
      "fields": {
        "includeHeaders": {
          "label": "Include Headers",
          "required": false,
          "viewClass": "SelectView",
          "description": "Default Yes",
          "model": {
            "Yes": "Yes",
            "No": "No"
          },
          "prompt": "Include headers? Default Yes"
        },
        "separator": {
          "label": "Separators",
          "required": true,
          "viewClass": "SelectView",
          "model": {
            "comma": "Comma (,)",
            "semicolon": "Semicolon (;)",
            "space": "Space ( )",
            "tab": "Tab (\\t)",
            "pipe": "Pipe (\u00A6)"
          },
          "prompt": "Choose required CSV delimiter"
        }
      },
      "metadata": {
        "in": {
          "type": "object",
          "properties": {
            "inputArray": {
              "type": "array",
              "required": true,
              "items": {}
            }
          }
        },
        "out": {}
      }
    }
  }
}