Xomlo.io
  • Using Xomlo.io SDK
    • Getting started
    • Payload
    • Working with the filesystem
    • Configuration file
    • SDK Reference
    • Deploy connector & using API
    • Introduction to models
  • Model reference
    • Slack
Powered by GitBook
On this page

Was this helpful?

  1. Using Xomlo.io SDK

Configuration file

Before deploying your first connector into the Xomlo.io application, you have to specify the configuration file in ./xomlo.json. The following are the default settings:

{
  "type": "connector",
  "name": "test-connector",
  "description": "test-connector",
  "version": 1,
  "allowParallelRun": false,
  "payload": {
    "create": [],
    "run": [],
    "uniqueBucket": true
  }
}
Parameter
Values
Description

type

connector / model

Defines if it's a connector or model. In our case, we'll always use a connector.

name

string

Displayed connector name in Xomlo.io application

description

string

Displayed description in Xomlo.io application

version

int

Unique version number

allowParallelRun

boolean

Defines if multiple instances of our connector could be run simultaneously

create

[string]

List of payload variables defined during connector creation

run

[string]

List of payload variables defined before each run

uniqueBucket

boolean

Defines if a unique storage bucket will be created for each run or the same will be used.

PreviousWorking with the filesystemNextSDK Reference

Last updated 3 years ago

Was this helpful?