Question 1

How are Related FAQs determined and can I change this?

Accepted Answer

Related FAQs are auto-generated and by default are FAQs either in the same category or similarly tagged (we combine this pool of FAQs). We take the top 4 results from that pool, based on the sort order defined in the instance. For info on how to change the default sort order see this FAQ.

You can choose to force the Related FAQs to use tags or just the category by updating the setting in MyMalcolm / Settings / FAQs:

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/mNimQ1t2R3/Screenshot%202020-03-30%2021.19.11.png (Settings in MyMalcolm)

In this scenario we will then take the top 4 results from just the category or tag pool using the defined sort order.

Question 2

How can I listen to JavaScript events posted from embeds?

Accepted Answer

Malcolm! embeds fire events on user interactions such as when someone first reads an FAQ, completes a Workflow or performs a search. These events can be picked up on your web page for you to perform custom actions - for example creating an event for your Analytics.

How can I listen to these events?

The first event, mapiload, is fired on the window when the mapi.js library has loaded.

The embeds are then rendered followed by the mapi.onrender event.

To register a listener use the mapi.on function.

We recommend combining the window.addEventListener and mapi.on functions for maximum compatibility especially if your application uses JavaScript page transitions, however if your application reloads the page on each request you could combine these into one.

Once the embeds have rendered use the embed.on function to register listeners.

If you know the ID of the embed (can be found in MyMalcolm) use mapi.findEmbed function.

Alternatively loop through the mapi.embeds array.

Putting it all together your code snippet could look something like this.

What events are available?

Question 3

What are Tags in FAQs?

Accepted Answer

Tags are a way of describing your content and allow an alternate way for your customers to browse FAQ's aside from search and categories.

You can add and manage the tags that are attached to each of your FAQs via the "configure" area.

You may also be interested in invisible tags.

Question 4

How do I change my Plan?

Accepted Answer

You can move between different types of plan in the Billing section of MyMalcolm. Bear in mind that different plans have different quotas so if you are downgrading to a less expensive plan you may need to reduce the number of FAQs you have (for example) if you are moving from a Team to a Micro plan.

Question 5

How do I create routing via rules / logic flows in a Workflow?

Accepted Answer

When creating a Workflow (you might prefer to call it a form or a user journey) you may want to vary what is presented to the user based on their earlier inputs. For example if you sell different types of product and want to build a returns form the information you ask for might vary from product to product. So you'd ideally ask the user to choose the type of product they want to return, then show them further relevant questions that related to that type of product only.

Rules and routing in Malcolm! Workflows let you do just this - you can create complex and adaptive multi-step user journeys / forms easily via this feature.

Below is a simple example of how rules and routing work. In this example we create a simple form that asks a user for some basic details (their name, email address and "further details"). If they select "yes" to the question "Do you have documents or files to upload?" we'll include a screen for them to upload those files before they complete the form. If the user selects "no" we won't show them this screen and they will go direct to the Thank You screen.

Here is the setup in the Workflow builder in MyMalcolm:

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/LFuUvRSKYT/screenshot-my.malcolm.app-2019.08.18-12_06_04.png (Building a Workflow with conditional routing in MyMalcolm)

Conceptually it is important to understand that rules and routing works at a page level (not at a question level). So where you have questions that will only be shown to the user in certain scenarios you should put those questions on their own page. You then use rules to show or hide those pages.

In our example we have set the "Include page by default" setting on page 2 to be off. By doing this page 2 is "hidden" and can only be seen by routing to it via a rule.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/sAdJrWv6tR/screenshot-my.malcolm.app-2019.08.18-12_10_51.png (Include page by default setting in Workflow builder in MyMalcolm)

You configure rules at a question/element level.

So in our example we now need to set up a rule on the "Do you have files or documents to upload?" question/element. To do this click on that question/element.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/xQvhNmZZk4/screenshot-my.malcolm.app-2019.08.18-12_09_39.png (Question elements in Malcolm! Workflow Builder)

In the overlay that appears select "rules". Then add the rule that if the value is equal to yes to include page 2.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/iVFe0tmYNZ/screenshot-my.malcolm.app-2019.08.18-12_09_10.png (Configuring rules in the Workflow Builder of MyMalcolm!)

The available options in values will vary according to the type of question/element you are editing. In "Then...." you have the option of including a page, hiding a page or moving to it. If you move to a page the Workflow will then continue from that page and jump over any pages before.

You can see the full range of options for this element type below.

Question 6

Can I put the Facebook Pixel on my workflows/forms/FAQs/content?

Accepted Answer

You can easily add the Facebook Pixel to any content you create in Malcolm! such as Workflows and FAQs.

There are two ways you can do this.

The first is to add the Facebook Pixel code directly into the settings area of MyMalcolm - for more details see this FAQ.

The other way is to use Google Tag Manager. You add your GTM container id in the settings area of MyMalcolm and then add your Facebook Pixel via the Google Tag Manager interface.

Question 7

Can users save Workflow progress and complete later?

Accepted Answer

It can be very useful to give your users the option to save progress on a Workflow and come back to complete the rest later. It's especially helpful if a you have built a long multi-stage Workflow like an application form.

You turn this feature on in MyMalcolm - go to the Configure screen of each individual Workflow.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/r3sEcA2Ugh/screenshot-my.malcolm.app-2019.08.18-16_09_11.png (Turn Resume Workflow on in MyMalcolm)

When turned on users will see an option to "Finish Later" at the bottom of each Workflow screen. When clicked this will bring up an overlay asking them to enter their email address. A unique link will then be emailed that when clicked will take the user back to the same stage of the Workflow they were previously at.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/R3FxUMpkNL/screenshot-support.malcolm.support-2019.08.18-16_41_46.png (Finish Later option on a Workflow)

If you need to retrieve these links (for example someone completing the form didn't receive or has lost the email with the resume link in) you can also get to the link via the Completions area of the Workflow section of MyMalcolm - click the link under "Resume link" to copy the URL your clipboard.

Question 8

Is there a limit to the amount of media I can upload? How much media space will I need?

Accepted Answer

Each instance of Malcolm! initially comes with a 0.5GB allocation of file storage space.

Because a web bowser will download all content on a page it's good practice (for page loading speed and also SEO purposes) to try and keep each image on your page under 2MB and not include too many images on any one page. Squarespace have a good general guide here.

Video files should not be uploaded to Malcolm! - instead use YouTube or Vimeo and embed your content - see here for more info.. This offers a much better experience for your users (they get a device/speed appropriate stream) and your page download speed will not be compromised.

If you wish to make large documents available for download consider using a dedicated file hosting service (eg Dropbox, Google Drive, WeTransfer etc) and linking to that from your FAQs. This is better user experience because your user will be made aware of the file size before starting the download.

Remember in particular your mobile users who may be viewing your content via significantly slower connections!

If you do find yourself nearing the limit of your initial allocation contact us to request a higher allocation and we can provision this for you - there is no extra charge for this.

Question 9

How do I delete data submitted to a Workflow?

Accepted Answer

You can delete some or all of the submitted data (including uploaded files) associated with a Workflow by selecting "Delete Data" in the Analyse tab of the relevant Workflow.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/tRaFrYJwoo/resources/lcSsh5w64C/Screenshot%202020-11-20%20at%2023.06.05.png (Delete Data dialogue in MyMalcolm)

You can choose to delete all data or selected data between two dates. Note that as well as removing data the delete process will also remove any exports you previously generated that contain the data plus any files uploaded via the Workflow and MyMalcolm activity logs. Please therefore export and download to your local system any data you wish to keep before starting the delete process in MyMalcolm.

Ratings, analytics and feedback associated with deleted Workflow completions will be kept and can still be reviewed via MyMalcolm post delete.

Question 10

How do I surface my Workflow into a floating widget?

Accepted Answer

It's quick and easy to surface your Workflow as a floating widget. You can find out more about Malcolm! widgets here.

In the Library screen of the Workflow section of MyMalcolm click the three dots on the right hand side of the screen and select "Embed" -

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/bk1dEegpoU/screenshot-my.malcolm.app-2019.08.18-17_01_27.png (Quick link to Embed from the Workflow Library in MyMalcolm)

This will take you into the Share section of MyMalcolm! Here you can choose the type of embed you want to create.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/N17DhjfW2Z/Screenshot%202021-12-30%20at%2013.57.57.png (Choose your embed type in MyMalcolm)

Choose "Widget" and work through the screens. You can configure various options here including whether in the pre-expand state the widget is a button or a drawer. You can also configure where on the screen you want the pre-expand to appear. Other options include colour schemes, the option to add your own logo to the widget and also whether you want the footer and search bar to appear. See this FAQ for more detail on this.

At the end of the process you will be supplied with the code that you should add to your webpage HTML - we recommend you add this to very page of your website. You can also embed via Google Tag Manager. See here for more details.