sesam-datasource-excel

Sample Excel REST datasource for Sesam. Can also be used as a transform.

app routes

route	METHOD	DEFAULT_VALUE
"/bypath/path:path"	GET	to be used when you want to use iii in "How to specify file URL" section below
"/"	GET	to be used otherwise
"/transform"	POST	transforms incoming encoded bytes into Excel sheet

Service parameters:

Either as query parameter or env var:

CONFIG_NAME	DESCRIPTION	DEFAULT_VALUE
file	Full URL for the file supporting HTTP get	n/a
sheet¹	What sheet(s) in the workbook to use, comma separated, starting from 1	1
start	What row and column in the sheet to start fetching data, comma separated. Firt row/column = 1	1,1
direction	What direction the data is stored; row, og col.	row
ids	The rows or columns containing id values, comma separated	1
names	The rows or columns containg property names, comma separated.	1
do_stream	boolean flag to toggle streamed response	"true"

¹:when specified as csv, entity id will be prefixed by sheet number (starting from 1) and "-"

Only as env var:

CONFIG_NAME	DESCRIPTION	DEFAULT_VALUE
DOWNLOAD_REQUEST_SPEC	dict to configure the file fetching request. Properties: base_url = string of base url for the download, headers = dict of headers, params = dict of params that is common to all requests	n/a
PORT	port number for the service to run on	5000
LOG_LEVEL	log level	"INFO"

Only as query params:

CONFIG_NAME	DESCRIPTION	IS_REQUIRED	DEFAULT_VALUE
path	string of url path,optionally with query params, that will be appended to download_request_spec.base_url to constitute the final url	no	n/a

How to specify file URL

• Url to the file is figured out by i) FILE env var, ii) FILE query param, iii) DOWNLOAD_REQUEST_SPEC.base_url env var combined with the path in the request to the service or iv) DOWNLOAD_REQUEST_SPEC_.base_url env var combined with the path query param.

Example setups:

System:

{
    "_id": "my-excel-datasource",
    "type": "system:microservice",
    "connect_timeout": 60,
    "docker": {
        "environment": {
            "DOWNLOAD_REQUEST_SPEC": {
                "base_url": "http://my_domain/my_apiversion",
                "headers": {
                    "my_header": "my_headervalue"
                },
                "params": {
                    "my_queryparam_common_to_all_requests": "some value"
                }
            }
        },
        "image": "sesamcommunity/excel:<version>",
        "port": 5000
    },
    "read_timeout": 7200
}

Pipe:

...
    {
      "type": "json",
      "system": "my-excel-datasource",
      "url": "/bypath/mypath1/myexcelfile.xlsx?sheet=1&direction=col&do_stream=true&my_queryparam_specific_to_this_request=somevalue"
    },
...

Using as a transform:

{
...
  "source": {
    "dataset": "pipe-with-encoded-bytes",
    "type": "dataset"
  },
  "transform": {
    "system": "my-excel-datasource",
    "type": "http",
    "url": "/transform"
  },
  "type": "pipe"
...
}

Here, 'pipe-with-encoded-bytes' is required to be a pipe that outputs a single entity. This entity should contain the encoded bytes in a field content and with the following content-type:

{
  "content": "UEsDBBQABgAIAAAAIQAUZrG...sUEsFBgAAAAAMAAwABAMAAJ3EAAAAAA==",
  "content-type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
}

The Github service outputs entities that can be used as inputs to this transform, provided that the content type is correct.