Getting Started With Doohickey

Before you start

Before you begin, make sure you meet these prerequisites:

  • Install Open Integration Hub environment including requisite components and services
  • Install Microsoft Visual Studio Code and Doohickey VS Code Plugin
  • Install the Doohickey CLI

Get started

The following steps will help you build and deploy your first integration template using Doohickey Developer tools.

Step 1 - Generate a Doohickey Integration Project

In a command prompt, navigate to the working directory in which you want to build your integration project.

Run doohickey init to initialize a new Doohickey integration project.

Review the example flow template and its corresponding artifacts in the templates/sample directory.

Step 2 - Define Data Flow Template

Open templates/sample/sample.js to modify the generated integration template.

In a browser, navigate to to generate an arbitrary API endpoint.

Modify the generated template to POST a message to the URL generated by

Save the template file.

Step 3 - Deploy via Doohickey CLI

In the command prompt, in the root of your project, run the command doohickey login stage_env --oih --username=admin --password=****** where “stage_env” is an alias to which you want to assign the installed OIH environment and username/password are admin credentials for that environment.

If prompted, enter URLs for the services in that environment. If not already set, Doohickey CLI will lazy load these URLs, asking you as needed, but it will remember them after the first time it asks.

Run the command doohickey tenant create my_tenant to create a tenant within the OIH environment to which any further CLI-OIH activity will be saved.

Run the command doohickey flow deploy sample to deploy the example integration template.

If prompted, enter URLs for the services in that environment.

Run the command doohickey flow start sample to start the deployed flow.

Using a CURL command or Postman, POST the sample input document generated by the init command to the webhook URL returned when the flow was deployed.

What's next

  • Generate additional data flow templates
  • Use various components in a data flow template
  • Build and test a data map used to transform data within a flow template