|
1 |
| -# CSV component for elastic.io platform |
| 1 | +# csv-component |
2 | 2 |
|
3 |
| -A comma-separated values ([CSV](http://en.wikipedia.org/wiki/Comma-separated_values) <i class="fa fa-external-link"></i>) file stores tabular data (numbers and text) in a plain-text form. A CSV file can be used to store spreadsheet or basic database-style information in a very simple format, with one record on each line, and each field within that record separated by a comma. CSV files are ideal for transferring e.g. contact data from one database (like Salesforce) into another (like Mailjet list). |
| 3 | +> A csv component for the [elastic.io platform](http://www.elastic.io "elastic.io platform"), runs a piece of synchronious JavaScript inside your integration flow. |
4 | 4 |
|
5 |
| -At Elastic.IO the **CSV connector can be used only as an action component** to read from a CSV file. |
| 5 | +This is an open source component to work with [CSV](http://en.wikipedia.org/wiki/Comma-separated_values) files in your integration flow and is developed specifically to run on [elastic.io platform](http://www.elastic.io "elastic.io platform"). You can clone it and change it as you wish. However, **if you plan to deploy it into [elastic.io platform](http://www.elastic.io "elastic.io platform") you must follow sets of instructions to succseed**. |
6 | 6 |
|
7 |
| -## Read from a CSV file - Action |
| 7 | +> **PLEASE NOTE:** This is a working component for **CSV** files, however, it may not be suitable for every use case. Not all functionalities are included in this component template. **It is your responsibility to add and modify this component to suit your integration needs.** |
8 | 8 |
|
9 |
| -**Read from CSV** component can be used on those cases when the first component provides a CSV file with records that need to be processed with our Data Mapper and transfer to the next stage of integration flow. |
| 9 | +## Before you Begin |
| 10 | + |
| 11 | +Before you can deploy any code into our system **you must be a registered elastic.io platform user**. Please see our home page at [http://www.elastic.io](http://www.elastic.io) to learn how. |
| 12 | + |
| 13 | +> Any attempt to deploy a code into our platform without a registration would fail. |
| 14 | +
|
| 15 | +After the registration and opening of the account you must **[upload your SSH Key](http://docs.elastic.io/docs/ssh-key)** into our platform. |
| 16 | + |
| 17 | +> If you fail to upload you SSH Key you will get **persmission denied** error during the deployment. |
| 18 | +
|
| 19 | +## Getting Started |
| 20 | + |
| 21 | +After registration and uploading of your SSH Key you can proceed to deploy it into our system. At this stage we suggest you to: |
| 22 | +* [Create a team](http://docs.elastic.io/docs/teams) to work on your new component. This is not required but will be automatically created using random naming by our system so we suggest you name your team accordingly. |
| 23 | +* [Create a repository](http://docs.elastic.io/docs/component-repositories) where your new component is going to *reside* inside the team that you have just created. For a simplicity you can name your repository **csv-component** or **csv**. |
| 24 | + |
| 25 | +```bash |
| 26 | +$ git clone https://github.com/elasticio/csv-component.git csv-component |
| 27 | + |
| 28 | +$ cd csv-component |
| 29 | +``` |
| 30 | +Now you can edit your version of **csv-component** component and change according to your needs - that is if you know what you are doing. Or you can just ``PUSH``it into our system to see the process in action: |
| 31 | + |
| 32 | +```bash |
| 33 | +$ git remote add elasticio [email protected]:csv-component.git |
| 34 | + |
| 35 | +$ git push elasticio master |
| 36 | +``` |
| 37 | +Obviously the naming of your team and repository is entierly upto you and if you do not put any corresponding naming our system will auto generate it for you but the naming might not entierly correspond to your project requirements. |
0 commit comments