Guest Data

Created by chris.joinson@airangel.com, Modified on Wed, 2 Feb, 2022 at 2:25 PM by Mark Jones

TABLE OF CONTENTS

Introduction
Location
Adding New Guest Data Fields
Editing Existing Guest Data Fields
Deleting Existing Guest Data Fields
Guest Field Rules

Introduction

Using the various fields available on guest portal pages, it is possible to gather guest data from your guests prior to authentication. By default, there are several fields already available for you to select and use and you can also create your own. This data can then be pulled from the database using our reporting tools for you to use in your marketing campaigns or for guest analytics.

Location

Steps	Description
1	Log into the platform.
2	Select the account menu dropdown at the top right of the page and then select settings.
3	Within the Settings page, find and select Guest Data.

Adding New Guest Data Fields

To create new guest data fields that can be used in conjunction with your authentication methods on the portal page, follow the steps below.

Step	Description
1	Navigate to the Guest Data page using the steps above.
2	Select Add Guest Field at the top of the page.
3	A pop-up will appear. Enter a recognisable name for your new data field.
4	Select the Type dropdown and select the type of field you want to configure. Options available are: Text - A regular input box for a user to enter text. Text Area - A larger input box for a user to enter a large amount of text. Number - An input box featuring buttons to add or subtract numbers. Checkbox - A simple checkbox that will be enabled/disabled when clicked. List - A dropdown or list containing a number of items for the user to select. Email - An input for email addresses. Phone - An input for phone numbers. Password - An input for passwords. Date - An input that can be configured to require a particular data format to be submitted. For more detail, see the individual items below.
5	Some items require further configuration. For more detail, see below.
6	Once configured, click save.

Guest Data: Text

Field	Field Type	Requirement	Description
Name	Text input	Required	The name will be used when selecting the data field from the Guest Fields table and when configuring your guest fields on the portal.
Type	Dropdown	Required - Choose Text	The type of guest field you want to configure. Choose Text.
Encrypt	Tickbox	Optional	To encrypt any data the guest enters, tick the encrypt tick box. Any data the guest enters will not be viewable so this is not recommended if you wish to use the data.
Translation	Text input/Dropdown	Required	The translation will be used as the placeholder text within the field. Use the dropdown to configure the placeholder text for each language you may have configured for your portal pages.
Save	Button	Required	Save your guest data field and make it available for use.

Text Example

Guest Data: Text Area Field

Field	Field Type	Requirement	Description
Name	Text input	Required	The name will be used when selecting the data field from the Guest Fields table and when configuring your guest fields on the portal.
Type	Dropdown	Required - Choose Text Area	The type of guest field you want to configure. Choose Text Area.
Encrypt	Tickbox	Optional	To encrypt any data the guest enters, tick the encrypt tick box. Any data the guest enters will not be viewable so this is not recommended if you wish to use the data.
Translation	Text input/Dropdown	Required	The translation will be used as the placeholder text within the field. Use the dropdown to configure the placeholder text for each language you may have configured for your portal pages.
Save	Button	Required	Save your guest data field and make it available for use.

Text Area Example

Guest Data: Number Field

Field	Field Type	Requirement	Description
Name	Text input	Required	The name will be used when selecting the data field from the Guest Fields table and when configuring your guest fields on the portal.
Type	Dropdown	Required - Choose Number	The type of guest field you want to configure. Choose Number.
Translation	Text input/Dropdown	Required	The translation will be used as the placeholder text within the field. Use the dropdown to configure the placeholder text for each language you may have configured for your portal pages.
Save	Button	Required	Save your guest data field and make it available for use.

Number Example

Guest Data: Checkbox

Field	Field Type	Requirement	Description
Name	Text input	Required	The name will be used when selecting the data field from the Guest Fields table and when configuring your guest fields on the portal.
Type	Dropdown	Required - Choose Checkbox	The type of guest field you want to configure. Choose Checkbox.
Encrypt	Tickbox	Optional	To encrypt any data the guest enters, tick the encrypt tick box. Any data the guest enters will not be viewable so this is not recommended if you wish to use the data.
Translation	Text input/Dropdown	Required	The translation will be used as the placeholder text within the field. Use the dropdown to configure the placeholder text for each language you may have configured for your portal pages.
Save	Button	Required	Save your guest data field and make it available for use.

Checkbox Example

Guest Data: List

Field	Field Type	Requirement	Description
Name	Text input	Required	The name will be used when selecting the data field from the Guest Fields table and when configuring your guest fields on the portal.
Type	Dropdown	Required - Choose List	The type of guest field you want to configure. Choose List.
Encrypt	Tickbox	Optional	To encrypt any data the guest enters, tick the encrypt tick box. Any data the guest enters will not be viewable so this is not recommended if you wish to use the data.
Translation	Text input/Dropdown	Required	The translation will be used as the placeholder text within the field. Use the dropdown to configure the placeholder text for each language you may have configured for your portal pages.
List type (portal)	Tickbox	Required - Choose one	Choose either: Dropdown - List is displayed within a dropdown menu (See example below). List - List is displayed as a list of items on the portal page (See example below).
List	Text input	N/A	Lists are not configured during the initial field creation. To add list items, see below.
Save	Button	Button	Save your guest data field and make it available for use.

Adding a List Item

Steps	Description
1	Create your dropdown or list item using the steps above.
2	Once you've clicked save, select your newly created field from the Guest Fields table on the Guest Data page.
3	A pop-up will appear. Scroll down to the Add List Item button and select.
4	A second pop-up will appear. Enter your name of the list item in the Value text box. If configuring a List, you can also add images to accompany your list item. Enter any translations you may need in the Translations box, selecting languages from the dropdown if you have multiple.
5	Click Save.
6	Repeat the process if you have multiple items.

List Example

Guest Data: Email Field

By default there is an Email field already configured and ready to use when creating your portal and authentication methods.

Field	Field Type	Requirement	Description
Name	Text input	Required	The name will be used when selecting the data field from the Guest Fields table and when configuring your guest fields on the portal.
Type	Dropdown	Required - Choose Email	The type of guest field you want to configure. Choose Email.
Encrypt	Tickbox	Optional	To encrypt any data the guest enters, tick the encrypt tick box. Any data the guest enters will not be viewable so this is not recommended if you wish to use the data.
Translation	Text input/Dropdown	Required	The translation will be used as the placeholder text within the field. Use the dropdown to configure the placeholder text for each language you may have configured for your portal pages.
Save	Button	Required	Save your guest data field and make it available for use.

Email Example

Guest Data: Phone Field

By default there is a Phone field already configured and ready to use when creating your portal and authentication methods.

Field	Field Type	Requirement	Description
Name	Text input	Required	The name will be used when selecting the data field from the Guest Fields table and when configuring your guest fields on the portal.
Type	Dropdown	Required - Choose Phone	The type of guest field you want to configure. Choose Phone.
Encrypt	Tickbox	Optional	To encrypt any data the guest enters, tick the encrypt tick box. Any data the guest enters will not be viewable so this is not recommended if you wish to use the data.
Translation	Text input/Dropdown	Required	The translation will be used as the placeholder text within the field. Use the dropdown to configure the placeholder text for each language you may have configured for your portal pages.
Save	Button	Required	Save your guest data field and make it available for use.

Phone Example

Guest Data: Password Field

By default there is a Password field already configured and ready to use when creating your portal and authentication methods.

Field	Field Type	Requirement	Description
Name	Text input	Required	The name will be used when selecting the data field from the Guest Fields table and when configuring your guest fields on the portal.
Type	Dropdown	Required - Choose Password	The type of guest field you want to configure. Choose Password.
Encrypt	Tickbox	Optional	To encrypt any data the guest enters, tick the encrypt tick box. Any data the guest enters will not be viewable so this is not recommended if you wish to use the data.
Translation	Text input/Dropdown	Required	The translation will be used as the placeholder text within the field. Use the dropdown to configure the placeholder text for each language you may have configured for your portal pages.
Save	Button	Required	Save your guest data field and make it available for use.

Guest Data: Date Field

By default there is a Date field already configured (D.O.B) and ready to use when creating your portal and authentication methods.

Field	Field Type	Requirement	Description
Name	Text input	Required	The name will be used when selecting the data field from the Guest Fields table and when configuring your guest fields on the portal.
Type	Dropdown	Required - Choose Date	The type of guest field you want to configure. Choose Date.
Encrypt	Tickbox	Optional	To encrypt any data the guest enters, tick the encrypt tick box. Any data the guest enters will not be viewable so this is not recommended if you wish to use the data.
Translation	Text input/Dropdown	Required	The translation will be used as the placeholder text within the field. Use the dropdown to configure the placeholder text for each language you may have configured for your portal pages.
Delimiter	Dropdown	Required	The delimiter is the symbol that will separate the Day, Month and Year fields.
Format
Enable	Tickbox	Required	Click the tickboxes to enable the guest to enter data into the Day, Month and Year fields.
Order	Dropdown	Required	Use the dropdown menus to order your Day, Month and Year fields. 1=First 2=Second 3=Third
Digits	Dropdown	Required	Configure how many digits will be used to display the year field. You can choose 2 or 4. For example, with 2 digits chosen, the year 2020 will be displayed as '20'. With 4 digits chosen it will display as 2020.
Save	Button	Required	Save your guest data field and make it available for use.

Date Example

Editing Existing Guest Data Fields

Steps	Description
1	Navigate to the Guest Data page using the steps above.
2	Select the guest field you wish to edit from the guest field table.
3	A pop-up will appear. Make your changes and click Save.

Deleting Existing Guest Data Fields

Only custom fields can be deleted. Default fields are unable to be removed.

Steps	Description
1	Navigate to the Guest Data page using the steps above.
2	Select the guest field you wish to edit from the guest field table.
3	A pop-up will appear. Click Delete at the bottom of the pop-up to delete the guest field.

Guest Field Rules

Use regular expressions (REGEX) to create Guest Field Rules. With a guest field rule you can replace content entered by the guest with a pre-configured word or character.

Adding a Guest Field Rule

Steps	Description
1	Navigate to the Guest Data page using the steps above.
2	Click Add Guest Field Rule at the top of the pages.
3	A pop-up will appear. Use the Guest Field dropdown to select the Guest Field you'd like to create a rule for.
4	In the Regex Match input box, type the expression you wish to use.
5	In the Replace value box, type the value you want to see after the rule has run.
6	Click save to save your Guest Field Rule.

Editing Guest Field Rules

Steps	Description
1	Navigate to the Guest Data page using the steps above.
2	Scroll down to the Guest Fields Rules table.
3	Select the Guest Field Rule you wish to edit.
4	Make your changes.
5	Click Save.

Deleting Guest Field Rules

Steps	Description
1	Navigate to the Guest Data page using the steps above.
2	Scroll down to the Guest Fields Rules table.
3	Select the Guest Field Rule you wish to Delete.
4	Click Delete.