Build and run event-driven processes within the product journey in days instead of months.
ie. payment, booking, personalized communication sequences, ETL processes and more.
Now with 90+ APIs connectors.
Explore the docs »
Website
·
Examples in Node
·
Tutorial in Node
# Zenaton library for Node
[Zenaton](https://zenaton.com) helps developers to easily run, monitor and orchestrate background jobs on your workers without managing a queuing system.
Build workflows using Zenaton functions to build control flows around your busines logic and tasks - managing time, events and external services within one class. The zenaton engine orchestrates the timing of executions on your workers. Functions include 'wait for a specific time or event', 'react to external events', 'run parallel tasks, 'create schedules' and more all by writing one line of code. [More about Zenaton Functions](https://zenaton.com/how-it-works)
Key capabilities:
Single Tasks - dispatch or schedule an asyncbusiness hronous job with just one line of code
Workflows as code - Combine Zenaton functions and Node.js to create infinite possibilities of logic.
Real time Monitoring - Get a real time view of workers and tasks - scheduled, processing and executed.
Scheduler - Schedule recurrent tasks and workflows and automatically retry tasks that fail or get alerts when there are errors or timeouts.
Error Handling: - Alerts for errors and timeouts and retry, resume or kill processes. React to errors by writing logic into workflow code to trigger retries or other actions.
You can sign up for an account on [Zenaton](https://zenaton.com) and go through the [tutorial in Node](https://app.zenaton.com/tutorial/node).
- [What's new](WHATSNEW.md).
- [Changelog](CHANGELOG.md).
- [Breaking changes](BREAKINGCHANGES.md).
## Node Documentation
You can find all details on [Zenaton's website](https://zenaton.com/documentation/node/getting-started).
## Requirements
Node 8 and later.
Table of contents
- [Getting started](#getting-started)
- [Installation](#installation)
- [Install the Zenaton Agent](#install-the-zenaton-agent)
- [Install the library](#install-the-library)
- [Typescript typings](#typescript-typings)
- [Quick start](#quick-start)
- [Client Initialization](#client-initialization)
- [Executing a background job](#executing-a-background-job)
- [Orchestrating background jobs](#orchestrating-background-jobs)
- [Using workflows](#using-workflows)
- [Getting help](#getting-help)
## Getting started
### Installation
#### Install the Zenaton Agent
To install the Zenaton agent, run the following command:
```sh
curl https://install.zenaton.com/ | sh
```
#### Install the library
To add the latest version of the library to your project, run the following command:
```bash
npm install zenaton --save
```
#### TypeScript typings
For Typescript developers:
```bash
npm install @types/zenaton --save-dev
```
### Quick start
#### Client Initialization
To start, you need to initialize the client. To do this, you need your **Application ID** and **API Token**.
You can find both on [your Zenaton account](https://app.zenaton.com/api).
Then, initialize your Zenaton client:
```javascript
/* client.js */
const { Client } = require("zenaton");
module.exports = new Client(
"YourApplicationId",
"YourApiToken",
"YourApplicationEnv", // Use "dev" as default
);
```
#### Boot file
The next step is to have your Zenaton Agent listen to your application.
The Agent needs to be pointed to a `boot` file which will allow it to infer your programming language (here JavaScript) but also to figure out where your jobs are located when the time comes to run them.
```javascript
/* boot.js */
// Import here all your tasks and workflows as you go
// require("./tasks/HelloWorldTask");
// require("./workflows/MyFirstWorkflow");
```
To run the `listen` command:
```sh
zenaton listen --app_id=YourApplicationId --api_token=YourApiToken --app_env=YourApplicationEnv --boot=boot.js
```
#### Executing a background job
A job in Zenaton is created through the `Task` function.
Let's start by implementing a first task printing something, and returning a value:
```javascript
/* tasks/HelloWorldTask.js */
const { task } = require("zenaton");
module.exports = task("HelloWorldTask",
async function handle(name="World") {
return `Hello ${name}`!;
}
);
```
Now, when you want to run this task as a background job, you need to do the following:
```javascript
/* launchHelloWorldTask.js */
const { run } = require("./client.js");
run.task("HelloWorldTask", "Me");
```
That's all you need to get started. With this, you can run many background jobs.
However, the real power of Zenaton is to be able to orchestrate these jobs. The next section will introduce you to job orchestration.
### Orchestrating background jobs
Job orchestration is what allows you to write complex business workflows in a simple way.
You can execute jobs sequentially, in parallel, conditionally based on the result of a previous job,
and you can even use loops to repeat some tasks.
We wrote about some use-cases of job orchestration, you can take a look at [these articles](https://medium.com/zenaton/tagged/nodejs)
to see how people use job orchestration.
#### Using workflows
A workflow in Zenaton is created through the `workflow` function.
We will implement a very simple workflow that will execute sequentialy the `HelloWorld` task 3 times.
One important thing to remember is that your workflow implementation **must** be idempotent.
You can read more about that in our [documentation](https://zenaton.com/documentation/node/workflow-basics/#implementation).
The implementation looks like this:
```javascript
/* workflows/MyFirstWorkflow.js */
const { Workflow } = require("zenaton");
module.exports = workflow("MyFirstWorkflow", function* handle(name) {
yield this.run.task("HelloWorldTask", name);
yield this.run.task("HelloWorldTask", "Me");
yield this.run.task("HelloWorldTask", "All");
});
```
Now that your workflow is implemented, you can ask for its processing like this:
```javascript
/* launchMyFirstWorkflow.js */
const { run } = require("./client.js");
run.workflow("MyFirstWorkflow", "Gilles");
```
There are many more features usable in workflows in order to get the orchestration done right. You can learn more
in our [documentation](https://zenaton.com/documentation/node/workflow-basics/#implementation).
## Getting help
**Need help**? Feel free to contact us by chat on [Zenaton](https://zenaton.com/).
**Found a bug?** You can open a [GitHub issue](https://github.com/zenaton/zenaton-node/issues).