Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
imsheth authored Sep 6, 2020
1 parent e4347be commit 04c01b1
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,18 @@ $ https://github.com/CoffeeBeansLabs/notif-engine.git && cd notif-engine && npm
#### Setting up the consumer process

- Create a new file at `consumer/configurations/configuration.json` manually or by copy pasting and editing the contents of `consumer/configurations/configuration.template.json`
- Be sure to mention the `<database_name_here>` and `<schema_name_here>` in the file
- Be sure to at least update the `<database_name_here>`, `<schema_name_here>` and `'Full Name' <email@address.com>` in the file
- You are now ready to turn on the consumer process

- The `batch_size` is for the quantum of messages being read in a single read for sending
- The `max_retries` is for the number of attempts being done while sending, if the sending fails
- As a rule of thumb, for all schemas the meaning of the statuses is as below :
- `-2` = `SENDING_FAILED`
- `-1` = `NOT_PROCESSED` // The default which has to be set for produced notifications to get created and then sent
- `0` = `PROCESSING`
- `1` = `SENDING_SUCCEEDED`
- As a rule of thumb, for all schemas the meaning of the enabled_flags is as below :
- `1` = `ENABLED`
- `0` = `DISABLED`

#### Turning on the consumer process

Expand Down

0 comments on commit 04c01b1

Please sign in to comment.