For the task of ...

I need to ...

Linking Procedural Walkthroughs to another Component

Procedural Walkthroughs are stored in a dedicated component - named "Procedural Walkthrough".

• In Component Management, select the Component which needs to be linked to Procedural Walkthroughs.
• Add a 1:1 relationship to the "Procedural Walkthrough" component.
  IMPORTANT: you cannot use any other relationship type for this purpose.
• Also, answer the question "Delete [RELATED component record(s) when [THIS component] record(s) are deleted" with YES.

Adding the Procedural Walkthrough interface to a Form

• Open the target form in the Form Designer tool.
• Drag and drop the relationship to the Procedural Walkthrough component created in the previous step into the desired cell.
• Enter the field properties as required.
• Optional: Keyword

Defining Keyword Filters to ensure users only see relevant Procedural Walkthroughs

Keywords are used to filter the list of available Procedural Walkthrough templates to show only those with a matching keyword.

If you leave the keyword field empty, no filter will be applied, and all active templates will be available in the selection list.

There are three ways to configure Keyword filters:

• using a 'static' Keyword, which will always be used to find any matching Walkthrough templates.
  
• nominate a specific field (text, lookup, or component lookup) on the form, and the system will show any templates whose keywords match any of the text found in the nominated field.
  
  In the case of component lookup fields, the system will match on any of the text shown in the component lookup list view.
  
• defining 'conditional' Keywords': you can define multiple Conditions, and the system will retrieve the templates that match the keywords whose conditions evaluate to "true"

If you define a 'static' AND 'field'/'conditional' keywords, then the system will retrieve all templates matching the static keyword, PLUS those which may match any of the conditions.

To default the Procedural Walkthrough to a Procedural Walkthrough template, enter the matching keyword which is defined in the template. Make sure that there is only one template with this keyword.

This will ensure that the Procedural Walkthrough will be defaulted to this template when a user creates a new record.

Saving and publishing the changes

To make the changes available to users, perform a publish.

For the task of ...

I need to ...

Naming the Walkthrough

Enter a unique Name.

Defining a Keyword, which can be used to filter the list of available Walkthroughs in the web application.

Enter a single Keyword.

Entering a description for the Walkthrough

Enter the required information into the Details field.

To enhance clarity and legibility, you can

• apply formatting to the text.
• add images

(Please note that nested bullet-points cannot be rendered on Roam devices.)

Adding a Task to a Walkthrough

Click on the + to add a new Tasks, and provide the following details:

• Task Number
• Task Name
• Task Details
• optional: Photos
• Allow to be marked as N/A:
  if this option is selected, users will be able to mark a Task as N/A. I.e. a Walkthrough can be completed without performing the Steps contained in that Task.

Adding Checklist Steps to a Task

Each Task contains one or several Steps, and are defined by providing:

• Step Number
• Step Name

Marking the Walkthrough as Active or Inactive

To make the Walkthrough available for selection when creating new records, tick the Active flag.

NOTE:
This process describes how a Walkthrough Template can be translated. If you need to translate other configuration types/items (e.g. Menus, Dashboards) you will need to follow the Language export/import process.