Getting started with Auron Omni
The Auron Omni is an incredibly versatile product. This guide aims to help you get started with Auron Omni.
We’ll cover the following:
- Setting up your connections;
- Choosing your integration options;
- Start sending messages;
- Automatic message processing;
- Configuring routing and blocking rules;
- Setting up message views;
- Enabling message archiving;
- Further reading.
Setting up your connections
The first thing you may want to do is set up connections to your device or providers. These connections are called channels.
Some channels connect you to a specific provider. Other channels represent a specific connection protocol and apply to multiple providers.
For example, you can use the Twilio channel for an express setup with Twilio or the HTTP SMS channel to connect to any provider with an HTTP API.
Choosing your integration options
The best way to integrate depends on your use case and the third party software you want to integrate.
We’ll list the most common options with their typical use cases:
- HTTP API. This is an easy way to integrate directly from your website or from a different platform;
- Local API. This API is useful when your integration runs locally on the Auron Omni PC;
- Database integration. You can send messages by inserting new records and receive messages through a simple select statement;
- File channel. In case you want a file in a shared folder to trigger an action or be sent as a message;
- Email, SMS or WhatsApp. Some alerting software supports email but does not support WhatsApp.
For the HTTP and Local API we include many examples. You can browse them from the Auron Omni Manager after installation, and they are also available on GitHub.
Start sending messages
If you’ve already integrated with any of the options above, you already know a few ways to send messages.
Here are some additional options:
- Bulk Wizard / Campaigns. Campaigns can send messages from any data source. You can also customize and call campaigns through the HTTP API and Local API;
- From the Manager. This is an easy way to send your first test message or troubleshoot your triggers and channels;
- From the Web Messenger. This lets you send messages through your company channels from anywhere using your browser.
Campaigns can also run from triggers, which makes them a very flexible way to send messages to a group of recipients.
Automatic message processing
You can create triggers to automatically process messages. Triggers can run on incoming messages and on other message states such as failure or success.
This makes it easy to automatically forward or reply to messages and to create automatic fallback actions.
Many common trigger types are built in and are easy to set up. After setting up a built in trigger you can use it as is or customize it. It is also possible to create new triggers from scratch.
Trigger scripts can use one of the following languages:
- JavaScript;
- VBScript;
- SQL Script.
JavaScript and VBScript triggers use the Local API to interact with messages and create new messages. SQL Script triggers run on the database.
Configuring routing and blocking rules
Use routing rules to automatically choose an outgoing channel for your message. If you do not select a channel, the routing rules apply.
Some examples where routing is useful:
- Selecting a channel by country or region of the phone number;
- Proportionally distributing messages across channels;
- Selecting channels by congestion rate.
Find a complete guide to routing here.
Blocking rules can stop outgoing messages.
Some examples where blocking rules are useful:
- Prevent sending to expensive regions;
- Stop a message based on message content;
- Prevent endless looping.
Setting up message views
Message views allow a customized view of your message data. By default there are views available for every message type.
By creating a new message view you can select which messages you want to see. You can also change the color scheme to highlight specific messages or fade out others.
Enable message archiving
By archiving regularly you can keep Auron Omni fast. You can choose when archiving happens and what happens with archived data.
You can archive to the current database or to a different database. It often makes sense to archive to a separate database on a different drive, since the archive database can grow large while the active message database should stay fast.
Find more information about archiving here.
Further reading
So far you’ve seen an overview of the most important features of Auron Omni. This knowledge base contains much more information to help you get the most out of the product.
A quick guide:
- The introduction. Describes all core concepts;
- Install and upgrade. Release notes and installation instructions;
- Configuration. Describes how to set up and configure different parts;
- How to. A list of common use cases and how to achieve them;
- Local API, HTTP API and Database integration. Details the different ways of integrating;
- License and activation. Describes licensing and activation;
- Frequently asked questions. Common questions and answers;