Skip to content

Howto deploy my own Botium Connector

So you followed one of these tutorials and now have to deploy your own Botium Connector to Botium Box or Botium Core

Depending on which Botium flavour you are using, there are different steps to do to use your custom Botium Connector.

Botium Core

First, setup a test project with Botium Bindings or Botium CLI (see the usage instructions in the respective Git repository).

Then place your code in a file named botium-connector-myapi.js (replace myapi with a descriptive name of your api) and reference this file as CONTAINERMODE capability in your botium.json:

{
  "botium": {
    "Capabilities": {
      "PROJECTNAME": "Custom Connector Sample",
      "CONTAINERMODE": "./botium-connector-myapi.js",
      "MYAPI_URL": "https://demo.botiumbox.com/iambotium/reply"
    }
  }
}

Note

You can find an example project in the Botium Core repository on Github.

Botium Box >= 2.6.1

Place your code in a file named botium-connector-myapi.js (replace myapi with a descriptive name of your api) in the resources directory of the Botium Box installation, or use the File Browser in the Settings menu to upload this file to the resources directory. Restart Botium Box server afterwards and reload your browser window. You will now have your connector available in the list and can set the configuration options exported from your connector file:

Note

Custom connectors are not loaded if plugins are disabled.

Botium Box <= 2.6.0

  1. Place the connector file in the resources directory of your Botium Box installation
  2. In Botium Box, register a new Chatbot with any technology (will be overwritten later)
  3. In the Chatbot settings, open the Connector settings and switch technology to “Other (Advanced Settings)”
  4. Overwrite the capability CONTAINERMODE with the filename of your connector file (“myconnector.js”)
  5. Add any other capabilities your chatbot requires