This guide explains every option on the Report Writer Template screen, used to build search results and the mailing lists that power EDM campaigns.
Overview of the Report Writer Template screen
The Report Writer Template screen is where you tell RMS which guests or reservations you want to work with. The same screen builds the results for a general search and the mailing list for an Electronic Direct Mail (EDM) campaign. You reach it from Utilities > Report Writer, or from EDM > Send Campaign.
Each statement works like a short instruction to RMS. The Range Boundary, Options, Properties Against, From, Field and Criteria are the parts that make up that instruction. Together they answer one question: which records do you want to work with, or which guests do you want to contact?
Please Note! RMS is highly configurable. Some Terminology, User Access & Permissions, Images, Labels and Functions used in these articles may differ from your setup. CLICK HERE to find out more.
Template Selection
The Template Selection panel on the left lists the saved templates for your database. Selecting a saved template loads its Template Name and Statement List, ready to run or edit. Saved templates are reusable, so a search you use regularly only needs to be built once.
Template Name
Enter a name that identifies the search. When you select Save Template, the search is stored under this name and appears in the Template Selection panel for future use.
Range Boundary
The Range Boundary sets how each statement affects the results.
| Option | What it does |
|---|---|
| Include | Adds the records that match this statement to the results. |
| Exclude | Removes the records that match this statement from the results. For example, exclude an email domain you do not want to send to. |
| Only Include | Narrows the results to only the records that also match this statement. |
Please Note! When creating a new template, Include is the only Range Boundary option available. Once the first statement has been added to the Statement List, the Exclude and Only Include options become available.
Options
| Option | What it does |
|---|---|
| Remove Duplicate Guests | Collapses a guest who appears more than once (matched on First Name, Surname and contact details such as email or mobile) into a single entry, so the same person is not contacted twice. This may be unnecessary where duplicates have already been combined using Auto Guest Merge or by merging duplicate guest profiles. |
| Ignore Cancelled Reservations | When ticked, reservations with a Cancelled status are left out of the results. When unticked, the results include cancelled reservations. |
| Include Non-Primary Guests | Includes secondary (non-primary) guests linked to a reservation, not just the primary guest, so you can reach their contact details too. |
| Ignore Privacy Settings | When ticked, matched guests are included even if their Marketing Opt Out, Email Opt Out or SMS Opt Out is set to Yes. When unticked, guests with any of those set to Yes are left out. Reserve this for essential, non-marketing messages (for example, notifying all in-house guests of a water shut-off). See Communication Preferences. |
Important! Ignore Privacy Settings overrides a guest's stated communication preferences. Use it only for essential operational messages, and make sure the message complies with the marketing and privacy rules that apply to your property.
Properties Against
The Properties Against dropdown sets which profile the data is drawn from.
| Option | What it does |
|---|---|
| Reservation | Draws the data from the reservation profile only. |
| Guest | Draws the data from the guest profile only. |
| Guest and Reservation | Draws the data from both the guest and reservation profiles. |
Tip! On an enterprise database you can select one property, several, or all of them, so you can target marketing to specific properties.
Building a statement: From, Field and Criteria
A statement is built from left to right: choose a From category, then a Field within it, then the Criteria that field must meet.
From
The From column lists the categories you can search: Client Stats, Dwelling Management, Guest and Reservation. The category you choose determines which fields appear in the Field column.
| Category | Where the data comes from |
|---|---|
| Client Stats | Statistics RMS records automatically against the guest profile, built up across all of a guest's stays. If the same guest stays multiple times, these values are recorded against their single guest profile. See Guest Statistics for more information. |
| Dwelling Management | Used by Campgrounds & Holiday Parks. |
| Guest | The fields held on the guest profile, as configured in Field Maintenance. |
| Reservation | The fields held on the reservation profile, as configured in Field Maintenance. |
Field
The Field column lists the fields available for the category you selected. The list is drawn from Field Maintenance and reflects what your property records, so it varies from one property to another. Not every Field Maintenance field can be searched here, so to see your own options, look at the Field column on the Template screen.
The type of field you select determines which Criteria options are available:
| Field type (example) | Available criteria |
|---|---|
| Date (Birthday, Arrival, Departure) | Inclusive Range, Equal To, Greater Than or Equal To and Less Than or Equal To. Wildcard is greyed out. |
| Number (No_Of_Visits) | Inclusive Range, Equal To, Greater Than or Equal To and Less Than or Equal To. Wildcard is greyed out. |
| Text (Email, Surname) | Inclusive Range (A to Z), Equal To, Greater Than or Equal To, Less Than or Equal To and Wildcard. |
| Lookup (Booking Source) | Inclusive Range as A to Z, Equal To as a list of the Booking Sources created, and Wildcard. |
| Lookup (Category) | All options: Inclusive Range as A to Z, Equal To as a list of Categories created, Greater Than or Equal To and Less Than or Equal To by Category name, and Wildcard. |
| No searchable value (for example a link field such as Guest_Portal_Checkout) | None. All Criteria options are greyed out, so you cannot build a statement on this field - choose a different field. |
Client Stats
Client Stats is the exception: it always offers the same fixed set of guest statistics, regardless of your setup.
| Field | What it holds |
|---|---|
| Avg_Income | The Average Income value from the guest's Guest Statistics. |
| LastBed | The Area from the guest's most recent reservation. |
| LastRateType | The Rate Type from the guest's most recent reservation. |
| LastVisit | The arrival date of the guest's most recent reservation. |
| No_Of_Visits | The total number of reservations for the guest. For example, use this field to find repeat guests. |
| Total_Income | The Total Income value from the guest's Guest Statistics. |
Criteria
Once a field is selected, choose how RMS should match it. Up to five criteria options are available; which ones you can use depends on the field type (see the table above).
| Criteria | What it does | Example |
|---|---|---|
| Inclusive Range | Matches values between a From and a To value, for example a date range such as 01 September 2026 to 30 September 2026, or a text range from A to Z. | |
| Equal To | Matches a single, specific value. For some fields this is a list of the values already created, for example the available Booking Sources or Categories. | |
| Greater Than or Equal To | Matches the entered value and everything above it, for example a date onwards, or a number of visits of 2 or more. Date fields also accept the value Today. | |
| Less Than or Equal To | Matches the entered value and everything below it, for example a date and everything before it. | |
| Wildcard | Matches text against a pattern using an asterisk (*). See Using the Wildcard below. | |
| No Options Available for Selection | No criteria apply to the field you selected, meaning every option is greyed out and you cannot add a statement on it. This happens with fields that hold no searchable value, such as a link field like Guest_Portal_Checkout. |
Using the Wildcard
Type the value with an asterisk (*) as a placeholder for any characters. You must include the asterisk; a value typed without one matches nothing.
| Pattern | What it matches |
|---|---|
| *@* | Any email address (any characters, then @, then any characters). Use this to find every guest who has an email address. |
| text* | Any value that starts with your text. |
| *text | Any value that ends with your text. |
| *text* | Any value that contains your text. |
| *@guest.booking.com* | Any Booking.com guest email address. Combined with the Exclude Range Boundary, this is a common way to leave Online Travel Agent (OTA) email addresses out of a mailing list. |
The Statement List
When you have set the Range Boundary, From, Field and Criteria, select Add This Statement to add the line to the Statement List. Add as many statements as you need to refine the results. Each statement reads as a plain sentence.
Example templates
Unless stated otherwise, these examples assume Range Boundary = Include, Options = Remove Duplicate Guests and Ignore Cancelled Reservations, and Properties Against = Reservation with your property selected. Each example then sets the From, Field and Criteria shown.
Example 1: Everyone who has an email address
- Template Name: All Emails
- Range Boundary: Include
- Options: Remove Duplicate Guests, Ignore Cancelled Reservations
- Properties Against: Reservation (tick your property)
- From: Guest
- Field: Email
- Criteria: Wildcard, *@*
Resulting statement: Include Email from Guest where Email is *@*
Example 2: Repeat guests who stayed in a specific category
Example 2 uses two statements. Common settings: Template Name = Repeat Guests; Options = Remove Duplicate Guests, Ignore Cancelled Reservations; Properties Against = Reservation (tick your property).
Statement 1 - Range Boundary: Include; From: Client Stats; Field: No_Of_Visits; Criteria: Greater Than or Equal To, 2.
Statement 2 - Range Boundary: Only Include; From: Reservation; Field: Category; Criteria: Equal To, Acacia Cabin (select your category).
Resulting Statement List:
- Include No_Of_Visits from ClientStats where No_Of_Visits is greater than or equal to 2
- Only Include Category from Res where Category is equal to Acacia Cabin
More quick patterns
These quick patterns inherit the defaults set out above (Range Boundary = Include, Options = Remove Duplicate Guests and Ignore Cancelled Reservations, Properties Against = Reservation with your property selected).
| Goal | How to build it | Resulting statement |
|---|---|---|
| All future reservations | Include > Reservation > Arrive_Date_Medium > Greater Than or Equal To Tomorrow | Include Arrive_Date_Medium from Res where Arrive_Date_Medium is greater than or equal to Tomorrow |
| All past guests | Include > Reservation > Depart_Date_Medium > Less Than or Equal To Yesterday | Include Depart_Date_Medium from Res where Depart_Date_Medium is smaller than or equal to Yesterday |
| Repeat guests (two or more stays) | Include > Client Stats > No_Of_Visits > Greater Than or Equal To 2 | Include No_Of_Visits from ClientStats where No_Of_Visits is greater than or equal to 2 |
| Only certain booking sources | Only Include > Reservation > Booking Source > Equal To (select the booking source) | Only Include Booking Source from Res where Booking Source is equal to Return Guest |
| Exclude a travel agent | Exclude > Reservation > Travel Agent Name > Equal To (select the travel agent) | Exclude Travel Agent Name from Res where Travel Agent Name is equal to ABC Travel Agency |
| Past guests, excluding Booking.com (OTA) emails | Statement 1: Include > Reservation > Depart_Date_Medium > Less Than or Equal To Yesterday. Statement 2: Exclude > Guest > Email > Wildcard *@guest.booking.com* | Include Depart_Date_Medium from Res where Depart_Date_Medium is smaller than or equal to Yesterday Exclude Email from Guest where Email is *@guest.booking.com* |
| Newsletter subscribers | Include > Guest > Newsletters Opt Out > Equal To No | Include Newsletters Opt Out from Guest where Newsletters Opt Out is equal to No |
Tip! To leave Online Travel Agent (OTA) emails out of a mailing list (for example Booking.com or Expedia), add an Exclude statement on the Email field with a Wildcard such as *@guest.booking.com* or *@m.expediapartnercentral.com*. Build your Include statement first and add it, then add the Exclude statement. To target a single source instead, use Only Include on Booking Source, or Exclude on Travel Agent Name.
Two buttons manage the Statement List:
- Remove This Statement removes a selected statement.
- Clear Statements removes every statement, whether selected or not.
Important! When you remove a statement, every statement below it is removed as well. If you have several statements and remove the second one, the third and fourth are also removed and will need to be added again.
Viewing matches
Select Show Matches to run the statements and list the results on the Matches tab, under the template name. The grid shows Group Name, Guest No, Full Name, Email, Address, PhoneBH, PhoneAH and Mobile.
Most matches are ticked to be included. Untick any guest you want to leave out. A row highlighted in yellow means RMS has detected that the email address could be a typo, for example guestname@gmail.com.au. The address may still be valid, such as a work address ending in .gov.au. To correct an obvious typo, select the Guest No to open the guest profile and update the email address.
This screen is the same whether you open it from Utilities > Report Writer for a general search or from EDM > Send Campaign for a mailing list. From the Matches tab you can act on the results directly - Tag, Labels, Form Letter, SMS, Send Campaign or Export. See Action buttons below for what each does.
Action buttons
The buttons available depend on which tab you are on.
Template tab
| Button | What it does |
|---|---|
| Schedule | Sets the search to run automatically at a future time. See Schedule a Report Writer export. |
| Add Template | Starts a new, blank template. |
| Delete Template | Permanently removes the selected saved template. |
| Save Template | Saves the current statements as a reusable template in the Template Selection panel. |
| Show Matches | Runs the statements and lists the matching records on the Matches tab. |
| Print Matches | Generates a printable "Report Writer Show Match" report of the matched guests (Group Name, Guest No, Name, Address, Phone BH, Phone AH, Mobile and Email), which can be printed, emailed or exported from the report viewer. This is a separate function from the Labels button, which prints mailing labels. |
| Exit | Closes the Report Writer screen. |
Several buttons stay greyed out until the template has at least one statement or matches have been shown.
Matches tab
After you select Show Matches, the Matches tab presents its own set of buttons. Some appear only when you have opened the screen from Utilities > Report Writer; others also appear when you open it from EDM > Send Campaign.
| Button | What it does | Available in |
|---|---|---|
| Show Matches | Re-runs the statements and refreshes the list of matching records. | Report Writer and EDM |
| Print Matches | Generates the printable "Report Writer Show Match" report of the matched guests, as described above. | Report Writer and EDM |
| Tag | Applies a tag to the matched guests. | Report Writer only |
| Labels | Prints mailing labels for the matched guests. See Print mailing labels from Report Writer. | Report Writer and EDM |
| Form Letter | Sends a form letter to the matched guests. | Report Writer only |
| SMS | Sends an SMS to the matched guests. | Report Writer only |
| Send Campaign | Starts an EDM campaign send to the matched guests. | Report Writer and EDM |
| Export | Exports the matched records. See Export data from Report Writer. | Report Writer only |
| Exit | Closes the screen. | Report Writer and EDM |
Related articles
Report Writer
- Use Report Writer to build and export reports
- Build an advanced search in Report Writer
- Create a Report Writer search template
- Export data from Report Writer
- Schedule a Report Writer export
- Print mailing labels from Report Writer
EDM and communication preferences
- Create a Campaign Mailing List
- Create an EDM Campaign
- EDM campaign reports
- Communication Preferences
- Default Guest Marketing to Opt Out
- Configure field maintenance
Comments
0 comments
Please sign in to leave a comment.