Skip to main content

Resources

Last updated 19/05/2022

Resources in Five

Resources allow you to upload a resource into Five. This resource will then be available to use in your email templates.

At the time of this documentation Resources only supports images.

Uploading Resources

Prerequisite

The Role of Developer or Control is required to upload resources into Five.

Steps

  1. Select Resources in the menu.

  2. Click the Add Item button in the list app bar.

  3. Type an ID for the resource in the Resource ID field.

  4. Click the lookup icon in the Resource Type field and select Image.

  5. Click the Instance Resources tab.


Add a Resource
Figure 1 - Add a resource

  1. Click the Add Instance Resources button.

Add Instance Resources Button
Figure 2 - Add Instance Resources button

  1. Click the lookup icon in the Instance field and select the instance record required.

info

If you only have one instance for your application, Five will prepopulate the field with the instance name.


  1. Click the Edit button in the Data field and navigate your files to select the image file.

Upload Data
Figure 3 - Upload data

  1. Click the Save button in the form app bar.

Save the Instance Resource form
Figure 4 - Save the Instance Resource form

  1. Click the Save button in the form app bar above the list.

Save the Resource form
Figure 5 - Save the Resource form

How to Access the Resource

The resource can be attached to your email templates and will be available in several locations in Five:

  • The Invite Email on the Instances form.
  • The Password Reset Email on the Instances form.
  • Mail Merges when creating an email.

Attach a Resource to the Invite Email

Prerequisite

The role of Administrator or Control is required to attach resources to an Invite Email template for an instance.

Steps

  1. Select Instances in the menu.

  2. Select the required Instance record in the list.

  3. Click the Mail tab.


Select Instance Record
Figure 6 - Select Instance record

  1. Either click the Edit button in the form app bar, or, click directly in the Invite Email field.

Edit the Instance Form
Figure 7 - Edit the Instance form

  1. Click the Tag's button lookup icon the editor's ribbon.

  2. Select the Resource ID.


Tag Icon
Figure 8 - Tag icon


info

Five will embed your resource using the five.variable.[Resource ID] property.


  1. Type and design your Invite Email template.

  2. Click the Save button in the editor app bar.


Save the Invite Email Template
Figure 9 - Save the Invite Email template

  1. Click the Save button in the form app bar.

Save the Form
Figure 10 - Save the form


info

This resource will now be displayed in all Invite emails that are sent.


Attach a Resource to the Password Reset Email

Prerequisite

The role of Administrator or Control is required to attach resources to a Password Reset Email template for an instance.

Steps

  1. Select Instances in the menu.

  2. Select the required Instance record in the list.

  3. Click the Mail tab.


Select Instance Record
Figure 11 - Select Instance record

  1. Either click the Edit button in the form app bar, or, click directly in the Password Reset Email field.

Edit the Instance Form
Figure 12 - Edit the Instance form

  1. Click the Tag's button lookup icon the editor's ribbon.

  2. Select the Resource ID.


Tag Icon
Figure 13 - Tag icon


info

Five will embed your resource using the five.variable.[Resource ID] property.


  1. Type and design your Password Reset Email template.

  2. Click the Save button in the editor app bar.


Save the Reset Password Email Template
Figure 14 - Save the Reset Password Email template

  1. Click the Save button in the form app bar.

Save the Form
Figure 15 - Save the form


info

This resource will now be displayed in all Password Reset emails that are sent.


Attach a Resource to a Mail Merge

Prerequisites

  • The role of Developer or Control is required to attach resources to a Mail Merge template.
  • A query for your email will need to be written in the Queries view.

Steps

  1. Select Mail Merges in the menu.

  2. Click the Add Item button in the list app bar.

  3. Click the lookup icon in the Query field and select the required query.

  4. Click the lookup icon in the Name Field ID field and select the name field required.

  5. Click the lookup icon in the Email Field ID field and select the email field required.

  6. Type a subject line in the Subject Text field.

  7. Click in the Merge Text field.


Add a Mail Merge
Figure 16 - Mail Merge form

  1. Click the Tag's button lookup icon in the editor's ribbon.

  2. Select the Resource ID.


Tag Icon
Figure 17 - Tag icon


info

Five will embed your resource using the five.variable.[Resource ID] property.


  1. Type and design your Mail Merge template.

  2. Click the Save button in the editor app bar.


Save the Mail Merge Template
Figure 18 - Save the Mail Merge template

  1. Click the Save button in the form app bar.

Save the Form
Figure 19 - Save the form


info

This resource will now be displayed in all emails that are sent.