README.md

⚠️ This repository is abandoned.

Zenaton Project Boilerplate

This is an example of Zenaton project. It can be used as a starter to your own project.

Development

The boot.js file is where you tell the Zenaton Agent where to find - by name - the source code of your tasks and workflows.

If you add a task or a workflow to your project, do not forget to update the boot.js file.

Look at Zenaton documentation to learn how to implement workflows and tasks.

Run

You can dispatch tasks and workflows by name from everywhere using Zenaton API. They will be processed as soon as you run this project.

Note: tasks and workflows are dispatched in an environment (AppEnv) of your Zenaton application (AppId). They will be processed by this project, if you setup it with the same AppId and AppEnv. You must also provide an Api Token to authorize access to this application (found at https://app.zenaton.com/api)

Run Locally

First, install dependencies:

npm install

then, fill-in ZENATON_APP_ID and ZENATON_API_TOKEN in the .env file.

Install a Zenaton Agent:

curl https://install.zenaton.com | sh

and run it:

zenaton listen --boot=boot.js

Run in Docker

Create your .env file

cp -n .env.sample .env

and fill-in ZENATON_APP_ID and ZENATON_API_TOKEN in it.

Then start your container:

cd docker && docker-compose up

Run on Heroku

Follow this button , then fill in the env variables and click "deploy".

Run on other hosting options

Check our documentation for more options (AWS, Google Cloud, Clever Cloud ...)

Checking that your project is running

Whatever your installation method, you should see that a new Agent is listening from this url: https://app.zenaton.com/agents (if you do not see it, please check again that you have selected the right application and environment).

Dispatching Tasks and Workflows

Using Zenaton API

Tasks and workflows can be dispatched by name from everywhere using the Zenaton API or our Node.js SDK.

You can test it from your command line interface:

Dispatching a "<WORKFLOW NAME>" workflow:

curl -X POST https://gateway.zenaton.com/graphql \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <API_TOKEN>" \
  -d '{
      "query":"mutation($input: DispatchWorkflowInput!) { dispatchWorkflow(input: $input) { id } }",
      "variables":{
        "input":{
          "appId":"<APP_ID>",
          "environment":"dev",
          "name":"<WORKFLOW NAME>",
          "input":"[...<WORKFLOW INPUT>]"
        }
      }
    }'

Do not forget to replace <APP_ID> and <API_TOKEN> by your Zenaton AppId and api token.

Sending a "<EVENT NAME>" event to this workflow:

curl -X POST https://gateway.zenaton.com/graphql \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <API_TOKEN>" \
  -d '{
      "query":"mutation($input: SendEventToWorkflowsInput!) { sendEventToWorkflows(input: $input) { status } }",
      "variables":{
        "input":{
          "appId":"<APP_ID>",
          "environment":"dev",
          "name":"<EVENT NAME>",
          "data":"[...<EVENT DATA>]",
          "selector":{"id":"<WORKFLOW_ID>"}
        }
      }
    }'

Do not forget to replace <APP_ID> and <API_TOKEN> by your Zenaton AppId and api token. And <WORKFLOW_ID> by your workflow's id that you have received when dispatched.

Example App

We have provided an example app with basic UI to dispatch workflows and events with associated data to your Zenaton project. After installation, you can (optionaly) add your workflows and some examples of input and event in the public/config.json file. eg.

{
  "workflows": [
    {
      "name": "HelloWorld",
      "input": [ "Me" ],
    }
  ]
} 

You need to rebuild your example app after having modified this file. If you prefer, you can update directly dist/config.json and simply reload the page - but your changes will be lost at the next rebuild.

Monitoring Tasks and Worklows Processing

Look at your dashboard (if you do not see your dispatched tasks or workflows, please check that you have selected the right application and environment).