Difference between revisions of "Automation"

From hoteliga
Jump to: navigation, search
(→‎POST request)
(→‎Automation Plans)
 
(23 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
==Introduction==
 
==Introduction==
−
Automation is the technology by which a process or procedure is performed with minimal human assistance. Automation saves time on creating repeated tasks, you just need to configure rules for the future tasks which will be generated. You can use it for sending emails to customers automatically, without manual work. For example, you want to send a welcome email to a customer when a reservation created, or "thank you for staying with us" email after checkout.
+
Automation is the technology by which a process or procedure is performed with minimal human assistance. Automation saves time on creating repeated tasks, you just need to configure rules (automation plans) for the future tasks to be generated. You can use it for sending emails to customers automatically, without manual work. For example, you want to send a welcome email to a customer when a reservation created, or "thank you for staying with us" email after checkout.
  
 
==Settings==
 
==Settings==
−
To be able to use automation you need to go to Options ⇒ Tools
+
You can find Automation in Options ⇒ Tools
  
 
[[File:OptionsTools.png|200px]]
 
[[File:OptionsTools.png|200px]]
Line 16: Line 16:
  
 
==Automation Plans==
 
==Automation Plans==
−
Automation Plans are rules by what tasks will be created. You can configure by what actions tasks will be triggered and what time they should be executed.
+
Automation Plans are rules by which tasks will be automatically generated. You can configure the actions that will take place and what time they should be executed.
  
−
In automation plan you can add a new rule, when automation tasks will be triggered.
+
In "Automation plans" you can add a new rule to generate tasks.
−
# Title - the title of an automation plan
+
# Title - the title of the automation plan
−
# Time execution (in hours) - when you want this event to happen (12h before/24h after some action)
+
# Time execution (in hours) - when you want a task of this plan to be executed (12h before/24h after some action)
−
# Execution moment - Before, after, on time of an action.
+
# Execution moment - Before, after or on time of an event.
−
# Event type - types of event (arrival, departure, checkin, checkout, creation)
+
# Event type - types of events that trigger the creation of tasks (arrival, departure, checkin, checkout, creation)
−
# Task action - what kind of task will be triggered:  
+
# Handle group separately - if the reservation for which the event took place is a group one, then tasks will be generated for all reservations in group
 +
# Task action - what kind of action will take place:  
 
## template email action - sending an email template (parameters: templateId)
 
## template email action - sending an email template (parameters: templateId)
 
## raw email message - sending raw email message without a template (parameters: template - message, emailAddress - receiver, subject - subject of an email)
 
## raw email message - sending raw email message without a template (parameters: template - message, emailAddress - receiver, subject - subject of an email)
Line 29: Line 30:
  
 
==Automation Tasks==
 
==Automation Tasks==
−
Automation tasks are tasks which will be executed by Azure Function at the set time.
+
Automation tasks are tasks which will be executed by Azure Function at the selected time.
  
 
===Actions===
 
===Actions===
−
Depends on an action type set in the plan, an email with selected template can be send, raw email with just text.
+
Depends on the action type set in the plan. An email with selected template can be send or raw email with just text.
  
 
====Template Email====
 
====Template Email====
−
TemplateEmail action allows you to choose a template which will be send to a customer. You need to choose which template will be used as email template. When you choose "Template email action" you will see "templateId" parameter and you need to choose template from drop down. For example you want to send a welcome email when a customer checks in, then plan may look like:
+
TemplateEmail action allows you to choose a template which will be send to the customer. You need to choose which template will be used as email template. When you choose "Template email action" you will see "templateId" parameter and you need to choose a template from the drop down menu. For example, if you want to send a welcome email when a customer checks in, then plan should look like:
  
 
[[File:Welcomeplan.png]]
 
[[File:Welcomeplan.png]]
  
 
====Raw Email Action====
 
====Raw Email Action====
−
If you want to send just simple text email, you can choose Raw Email Action. You will see three parameters to fill:  
+
If you want to send just simple text email, then you should choose "Raw Email Action". You will see three parameters to fill:  
  
 
[[File:RawEmailAction.png]]
 
[[File:RawEmailAction.png]]
Line 49: Line 50:
  
 
====Webhook Action====
 
====Webhook Action====
−
You can use this type of action if you need to send reservation information to a custom callback.
+
You should use this type of action if you want to send reservation's information to a custom callback.
 +
 
 +
Note that the response from the endpoint you provide must be returned within 5 seconds. Otherwise the call will fail.
  
 
[[File:Webhook.png]]
 
[[File:Webhook.png]]
Line 63: Line 66:
  
 
==Examples==
 
==Examples==
−
The first thing you need to configure checkin checkout times in Tools ⇒ Automation Settings.
+
The first things you need to configure are check-in and check-out times in Tools ⇒ Automation Settings.
  
−
Then you can start to create a plan (Tools ⇒ Automation Plans).
+
Then you can start creating a plan (Tools ⇒ Automation Plans).
  
 
[[File:AutomationPlan.png]]
 
[[File:AutomationPlan.png]]
Line 77: Line 80:
 
[[File:AutomationTask.png]]
 
[[File:AutomationTask.png]]
  
−
After the task will be executed a customer will get an email and the task's status will change and you will see when the task was actually sent:
+
After the task will be executed the customer will get an email. Task's status will change and you will see when the task was actually executed:
  
 
[[File:FinishedAutomationTask.png]]
 
[[File:FinishedAutomationTask.png]]
Line 89: Line 92:
 
====POST request====
 
====POST request====
  
−
[[File:webhook_example.png]]
+
UI Setup of the webhook plan:
 +
 
 +
[[File:webhook_example_en.png]]
 +
 
 +
The created task result:
  
 
[[File:webhook_task.png]]
 
[[File:webhook_task.png]]
  
−
JSON request is received:  
+
Request URL: <pre>https://your-endpoint.com</pre>
  
−
Received payload is:  
+
Request payload:  
 
* JSON:  
 
* JSON:  
−
{"id":"12638","dateFrom":"18/10/2019","dateTo":"20/10/2019","customerFullName":"Test test "}
+
<pre>
 +
{
 +
"id":"12638",
 +
"dateFrom":"18/10/2019",
 +
"dateTo":"20/10/2019",
 +
"customerFullName":"TestFullName"
 +
}
 +
</pre>
 
* XML:  
 
* XML:  
  
Line 103: Line 117:
 
&lt;?xml version="1.0" encoding="utf-16"?&gt;
 
&lt;?xml version="1.0" encoding="utf-16"?&gt;
 
&lt;reservation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"&gt;
 
&lt;reservation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"&gt;
−
 
 
&lt;id&gt;12638&lt;/id&gt;
 
&lt;id&gt;12638&lt;/id&gt;
−
 
 
&lt;dateFrom&gt;18/10/2019&lt;/dateFrom&gt;
 
&lt;dateFrom&gt;18/10/2019&lt;/dateFrom&gt;
−
 
 
&lt;dateTo&gt;20/10/2019&lt;/dateTo&gt;
 
&lt;dateTo&gt;20/10/2019&lt;/dateTo&gt;
−
 
+
&lt;customerFullName&gt;TestFullName&lt;/customerFullName&gt;
−
&lt;customerFullName&gt;Test test &lt;/customerFullName&gt;
 
 
&lt;/reservation&gt;
 
&lt;/reservation&gt;
 
</pre>
 
</pre>
  
 
====GET request====
 
====GET request====
 +
 +
[[File:webhook_example_get_en.png]]
 +
 +
 +
Request URL: <pre>https://your-endpoint.com?reservationId=12678&dateFrom=18/10/2019&dateTo=20/10/2019&customerFullName=TestFullName</pre>

Latest revision as of 11:03, 22 July 2020

Introduction

Automation is the technology by which a process or procedure is performed with minimal human assistance. Automation saves time on creating repeated tasks, you just need to configure rules (automation plans) for the future tasks to be generated. You can use it for sending emails to customers automatically, without manual work. For example, you want to send a welcome email to a customer when a reservation created, or "thank you for staying with us" email after checkout.

Settings

You can find Automation in Options ⇒ Tools

OptionsTools.png

and to the Automation section:

AutomationSettings.png

In settings you can configure default arrival and departure time:

ArrivalDepartureTimes.png

Automation Plans

Automation Plans are rules by which tasks will be automatically generated. You can configure the actions that will take place and what time they should be executed.

In "Automation plans" you can add a new rule to generate tasks.

  1. Title - the title of the automation plan
  2. Time execution (in hours) - when you want a task of this plan to be executed (12h before/24h after some action)
  3. Execution moment - Before, after or on time of an event.
  4. Event type - types of events that trigger the creation of tasks (arrival, departure, checkin, checkout, creation)
  5. Handle group separately - if the reservation for which the event took place is a group one, then tasks will be generated for all reservations in group
  6. Task action - what kind of action will take place:
    1. template email action - sending an email template (parameters: templateId)
    2. raw email message - sending raw email message without a template (parameters: template - message, emailAddress - receiver, subject - subject of an email)
    3. webhook action - sending GET/POST request to a given endpoint (parameters: baseUrl - endpoint URL, callMethod - GET/POST, contentType - JSON/XML)

Automation Tasks

Automation tasks are tasks which will be executed by Azure Function at the selected time.

Actions

Depends on the action type set in the plan. An email with selected template can be send or raw email with just text.

Template Email

TemplateEmail action allows you to choose a template which will be send to the customer. You need to choose which template will be used as email template. When you choose "Template email action" you will see "templateId" parameter and you need to choose a template from the drop down menu. For example, if you want to send a welcome email when a customer checks in, then plan should look like:

Welcomeplan.png

Raw Email Action

If you want to send just simple text email, then you should choose "Raw Email Action". You will see three parameters to fill:

RawEmailAction.png

  • template - the content of email message.
  • emailAddress - the sender email (your email).
  • subject - the subject of the message

Webhook Action

You should use this type of action if you want to send reservation's information to a custom callback.

Note that the response from the endpoint you provide must be returned within 5 seconds. Otherwise the call will fail.

Webhook.png

  • baseUrl - endpoint URL.
  • callMethod - type of HTTP request (GET/POST).
  • contentType - format of sending data JSON/XML

Troubleshooting

If something goes wrong during executing a task you will see the status "Task failed" and in the popup window the reason:

TaskFailed.png

Examples

The first things you need to configure are check-in and check-out times in Tools ⇒ Automation Settings.

Then you can start creating a plan (Tools ⇒ Automation Plans).

AutomationPlan.png

This plan will be triggered when you create a reservation and will send a confirmation email to a customer.

CreateReservation.png

An automation task will be created (Tools ⇒ Automation Tasks)

AutomationTask.png

After the task will be executed the customer will get an email. Task's status will change and you will see when the task was actually executed:

FinishedAutomationTask.png

An example of a received email:

ConfirmationEmail.png

Webhook example

POST request

UI Setup of the webhook plan:

Webhook example en.png

The created task result:

Webhook task.png

Request URL: 
https://your-endpoint.com

Request payload:

  • JSON: 
{
"id":"12638",
"dateFrom":"18/10/2019",
"dateTo":"20/10/2019",
"customerFullName":"TestFullName"
}
  • XML: 
<?xml version="1.0" encoding="utf-16"?>
<reservation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	<id>12638</id>
	<dateFrom>18/10/2019</dateFrom>
	<dateTo>20/10/2019</dateTo>
	<customerFullName>TestFullName</customerFullName>
</reservation>

GET request

Webhook example get en.png


Request URL: 
https://your-endpoint.com?reservationId=12678&dateFrom=18/10/2019&dateTo=20/10/2019&customerFullName=TestFullName
Retrieved from "http://help.hoteliga.com/en/index.php?title=Automation&oldid=2219"