wso2 / wso2/docs-apim

Documentation Gap on Creating an ETL Application via SI Tooling for APIM 4.2.0

Open
#6,842 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API-M 4.2.0
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

At the end of the Creating an ETL Application via SI Tooling documentation, It's mentioned that data will be written in the productions.csv and there is a screenshot of final results.

There are few things wrong with that output.

  1. In the steps, we add productioninserts.csv (see the step) which is a new file as the file.uri so data will be written to that file and there will not be older records as shown as in the screenshot. (If we changed file.uri to productions.csv which already have 1st two rows, new line will be written in that file as the output shown in the documentation)

  2. Data will be written as text and not CSV. In order to write data as CSV, we need to change the map type to csv from text in the related siddhi app. (ex: @sink(type='file',file.uri = "<file-path>/productioninserts.csv", @map(type='csv'))

  3. In the step 8, We fixed the text to convert to upper case but in the documentation results, it's still original text. But if you follow the documentation correctly, name column will be uppercase when writing in to the csv file.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the linked Creating an ETL Application via SI Tooling page and review the destination filename, map type, uppercase transformation, and final-results screenshot. Update the instructions and example output so they consistently show the actual file contents and formatting, then verify the complete tutorial from the documented steps.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.