> For the complete documentation index, see [llms.txt](https://docs.globalalerting.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.globalalerting.com/administration/rules-engine/itinerary-rules-reference.md).

# Itinerary Rules Reference

## Conditions

### Itinerary

| Property                 | Operators                                                                                                                                                 | Notes                                                                                                    |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
| Overall Risk             | <p>Is<br>Is Not<br>Is Greater Than<br>Is Greater Than Or Equal To<br>Is Less Than<br>Is Less Than Or Equal To</p>                                         | Checks the risk level of itineraries.                                                                    |
| Approval State           | <p>Is<br>Is Not</p>                                                                                                                                       | Checks the approval state of the itinerary. Possible values are "approved", "declined" or "no decision". |
| Approval State Changed   | <p>To Approved<br>To Declined<br>To Cancelled</p>                                                                                                         | Triggers when the approval state of an itinerary changes.                                                |
| Duration Days            | <p>Is Equal To<br>Is Greater Than<br>Is Greater Than Or Equal To<br>Is Less Than<br>Is Less Than Or Equal To</p>                                          | Checks the duration of the itinerary.                                                                    |
| Days To Start            | <p>Is Equal To<br>Is Greater Than<br>Is Greater Than Or Equal To<br>Is Less Than<br>Is Less Than Or Equal To</p>                                          | Triggers at the specified number of days prior to the start date of the itinerary.                       |
| Days To End              | <p>Is Equal To<br>Is Greater Than<br>Is Greater Than Or Equal To<br>Is Less Than<br>Is Less Than Or Equal To</p>                                          | Triggers at the specified number of days prior to the end date of the itinerary.                         |
| Address                  | <p>Contains                                                                                                                                               |                                                                                                          |
| <br>Does Not Contain     |                                                                                                                                                           |                                                                                                          |
| <br>Is Equal To</p>      | Performs a text match against the address field of all itinerary segments.                                                                                |                                                                                                          |
| Region                   | <p>Contains                                                                                                                                               |                                                                                                          |
| <br>Does Not Contain</p> | Performs a text match against the [names of all countries](/administration/gap-for-travel-country-reference.md#full-country-names-list) on the itinerary. |                                                                                                          |
| Segment Gap              | <p>Detected<br>Not Detected</p>                                                                                                                           | Checks if the itinerary does or does not have gaps between segments of more than 500KM.                  |

### Traveller

| Property                       | Operators                                                                                                              | Notes                                                                                                                                                                                                                                                            |
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name                           | <p>Contains                                                                                                            |                                                                                                                                                                                                                                                                  |
| <br>Does Not Contain</p>       | Performs a text match against the names of all travellers on the itinerary.                                            |                                                                                                                                                                                                                                                                  |
| Email Address                  | <p>Contains                                                                                                            |                                                                                                                                                                                                                                                                  |
| <br>Does Not Contain</p>       | Performs a text match against the e-mail addresses of all travellers on the itinerary.                                 |                                                                                                                                                                                                                                                                  |
| Number Of Travellers           | <p>Is Equal To<br>Is Greater Than<br>Is Greater Than Or Equal To<br>Is Less Than<br>Is Less Than Or Equal To</p>       | Checks the number of travellers listed in the itinerary.                                                                                                                                                                                                         |
| Itinerary Has No Travellers    | -                                                                                                                      | Checks if the itinerary has any travellers.                                                                                                                                                                                                                      |
| Has Not Accessed Country Brief | <p>7 Days Prior To Departure<br>5 Days Prior To Departure<br>3 Days Prior To Departure<br>1 Day Prior To Departure</p> | <p>Triggers if a traveller has not accessed the country brief the specified number of days prior to travel.<br><br>Requires <a href="/administration/travel/configuring-gap-for-travel-settings.md">"Country brief read receipts" setting</a> to be enabled.</p> |
| Has Complete Info              | -                                                                                                                      | Checks if any of the travellers have complete contact information (e-mail address and telephone number).                                                                                                                                                         |
| Has Incomplete Info            | -                                                                                                                      | Checks if any of the travellers do not have complete contact information (e-mail address and telephone number).                                                                                                                                                  |
| Account Is Disabled            | -                                                                                                                      | Checks if the traveller's GAP user account is disabled.                                                                                                                                                                                                          |
| Account Is Enabled             | -                                                                                                                      | Checks if the traveller's GAP user account is enabled.                                                                                                                                                                                                           |

### Hotel

| Property                    | Operators                                                                                                        | Notes                                                     |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
| Name                        | <p>Contains                                                                                                      |                                                           |
| <br>Does Not Contain</p>    | Performs a text match against the names of all hotels in the itinerary.                                          |                                                           |
| Address                     | <p>Contains                                                                                                      |                                                           |
| <br>Does Not Contain</p>    | Performs a text match against the addresses of all hotels in the itinerary.                                      |                                                           |
| Duration Days               | <p>Is Equal To<br>Is Greater Than<br>Is Greater Than Or Equal To<br>Is Less Than<br>Is Less Than Or Equal To</p> | Checks the duration of each hotel stay in the itinerary.  |
| Itinerary Has No Hotel Stay | -                                                                                                                | Checks if the itinerary does not have any hotel segments. |

### Flight

| Property                                | Operators                                                                                    | Notes                                                      |
| --------------------------------------- | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| Number                                  | <p>Contains                                                                                  |                                                            |
| <br>Does Not Contain<br>Is Equal To</p> | Performs a text match against the number of all flights in an itinerary.                     |                                                            |
| Origin Airport Code                     | <p>Contains                                                                                  |                                                            |
| <br>Does Not Contain<br>Is Equal To</p> | Performs a text match against the departure airport codes for all flights in an itinerary.   |                                                            |
| Origin Airport Name                     | <p>Contains                                                                                  |                                                            |
| <br>Does Not Contain<br>Is Equal To</p> | Performs a text match against the departure airport name for all flights in an itinerary.    |                                                            |
| Destination Airport Code                | <p>Contains                                                                                  |                                                            |
| <br>Does Not Contain<br>Is Equal To</p> | Performs a text match against the destination airport codes for all flights in an itinerary. |                                                            |
| Destination Airport Name                | <p>Contains                                                                                  |                                                            |
| <br>Does Not Contain<br>Is Equal To</p> | Performs a text match against the destination airport name for all flights in an itinerary.  |                                                            |
| Itinerary Has Flights                   | -                                                                                            | Checks if the itinerary has any flight segments.           |
| Itinerary Has No Flights                | -                                                                                            | Checks if the itinerary does not have any flight segments. |

### Route

| Property                 | Operators                                                                               | Notes                                                                           |
| ------------------------ | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| Type                     | <p>Walk<br>Drive<br>Transit<br>Cycle<br>Ship</p>                                        | Checks if any of the route segments in the itinerary are of the specified type. |
| Origin Address           | <p>Contains                                                                             |                                                                                 |
| <br>Does Not Contain</p> | Performs a text match against the origin addresses of all routes in the itinerary.      |                                                                                 |
| Destination Address      | <p>Contains                                                                             |                                                                                 |
| <br>Does Not Contain</p> | Performs a text match against the destination addresses of all routes in the itinerary. |                                                                                 |
| Itinerary Has No Routes  | -                                                                                       | Checks if the itinerary does not have any route segments.                       |

## Actions

| Action                             | Parameters                                                                 | Notes                                                                                                                                                       |
| ---------------------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Approve Itinerary                  | -                                                                          | Sets the itinerary status to approved.                                                                                                                      |
| Ask Travellers To Check Itinerary  | -                                                                          | Sends an e-mail to all travellers in the itinerary containing a link to the itinerary.                                                                      |
| Send Travel Briefing To Travellers | -                                                                          | E-mails country briefs for all countries included in the itinerary to all travellers specified in the itinerary.                                            |
| Check-In Schedule                  | <p>Start<br>Stop</p>                                                       | Starts or stops the Check-In Schedule assigned to any of the travellers' devices.                                                                           |
| Send Email                         | <p>To Specified Recipients<br>To Travellers<br>To Travellers' Managers</p> | Sends an e-mail to the specified recipients.                                                                                                                |
| Send SMS                           | <p>To Specified Recipients<br>To Travellers<br>To Travellers' Managers</p> | Sends an SMS to the specified recipients.                                                                                                                   |
| Send Message To Distribution List  | GAP Distribution List                                                      | Sends message to all e-mail recipients in the distribution list.                                                                                            |
| Send Actions Summary               | E-Mail Address                                                             | Send an e-mail to the specified address detailing the actions taken by the rule. This e-mail is sent every time the rule is run and its conditions are met. |