Skip to content

Latest commit

 

History

History
74 lines (49 loc) · 1.97 KB

README.md

File metadata and controls

74 lines (49 loc) · 1.97 KB

ASAB Iris

ASAB Iris is a microservice for (1) rendering documents (reports, email bodies and attachments) using templates and (2) sending these documents to users using email, SMS and instant messaging services such as Slack.

ASAB Iris could be used for e.g. generating emails based on templates, rendering regular reports from dataset and so on. It is a multifuntional messanger.

Documentation

https://teskalabs.github.io/asab-iris/

Supported technologies

  • HTTP REST API
  • Apache Kafka (for incoming async requests)
  • Email (SMTP for outgoing mails)
  • Slack
  • Jinja2 for templating
  • Markdown (for templating, using Jinja2)
  • HTML (for templating, using Jinja2)
  • PDF (conversion of the output)
  • Powered by ASAB

Use cases

Send email

  • Use a template for email (Jinja, Markdown or HTML)
  • Use a template for attachment(s) (Jinja or Markdown) and format is HTML or PDF
  • Specify To, From, CC, BCC; or use defaults from configuration
  • Specify Subject or extract it from email body
  • Triggers by a web handler call (or calls), or Apache Kafka message
  • Use SMTP to send email
  • Templates are in the ASAB library

Render a report

  • Use a template from ASAB library
  • Use formatter(s) to get HTML or PDF document
  • HTTP REST API to get the report
  • Templates are in the ASAB library

Send slack Alerts

  • Consume the messages from Kafka topic.
  • With the help of info from messages , get a template from ASAB library.
  • HTTP REST API to send the alert messages using rendered template.

Architecture

WARNING: Templates used for email or Slack must be stored in Templates dir in filesystem or Templates node in zookeeper

Templates used for emailing must be stored under

/Templates/Email/

Templates used by Slack must be stored under

/Templates/Slack/

Templates used for other purpose must be stored under

/Templates/General/