Question 1

How do I embed content from Malcolm! into my own website or app?

Accepted Answer

You can easily embed content from Malcolm! into your existing website, app, product or online service with just a few lines of code.

Begin by going to the Share section of MyMalcolm and then select Embed.

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)

We offer the following type of embeds:

Floating Widget (with button and draw options) - this option floats a button or drawer “pre-expand” over your site, application, product or service - when clicked a content panel opens up
Overlay / Pop Up - this opens an overlay / popup over whatever the user is currently seeing - it’s triggered by a link you can place wherever you want in your site, application, product or service
Inline - pull content directly into the same pages/screens your users are seeing with this option - use blend mode for a truly seamless experience!

We also offer a fourth option which can be useful in some circumstances:

Redirect - this option creates an automatic redirect which will replace the page the embed is fired from with a Malcolm! hosted page. This is achieved by auto forwarding the user. This option can be useful in certain scenarios, for example if you constrained by only being able to publish via a CMS and want some navigation or pages within your CMS structure to link out to Malcolm! hosted content. Note you will likely want to use URL rules in conjunction with the redirect embed (otherwise the redirect will happen on all pages the embed is present on!).

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/jbX8ylorUd/screenshot-my.malcolm.app-2019.11.05-13_16_07.png (Choose your embed content in MyMalcolm)

In terms of the type of content you can embed options include:

Hosted Hub results - paginated results showing the default filtered FAQs and Workflows as seen on your Hosted Hub homepage
A single FAQ - your choice of FAQ
A single Workflow - your choice of Workflow
Author listing - paginated results showing FAQs from a particular author
Category listing paginated results showing FAQs within a partiuclar category
Filtered results paginated results showing FAQs and Workflows filtered by your choice of filter (eg most popular, most recent, most helpful etc)
Search results (contextual) - paginated results showing FAQs and Workflows according to a search query provided via a meta tag on your page
Search results (specified search query) - paginated results showing FAQs and Workflows according to a given search query
Tag listing - paginated results showing FAQs referenced by particular tag

Note that if you just want to embed a single FAQ or Workflow you can also access a quick embed interface via the Library in both the FAQ and Workflow sections of MyMalcolm. Simply select "Embed" from the menu accessible on the right hand side of the respective published FAQ or Workflow.

You can configure various options around the visual stlye of your embed. The exact options available depend on the type of embed you have chosen.

When you have finished configuring the content and visual appearence of your embed, Malcolm! will give you the code that can be used to pull your content into your website, app, product or online service.

Watch a video guide to embeding Malcolm! content into your website below.

Question 2

How do I embed a Workflow into my website?

Accepted Answer

It's quick and easy to embed a Workflow into your website or app. 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 (Create your embed in MyMalcolm)

If you want to float your Workflow over your webpage in a widget launched from a button or drawer that hugs the side or top/bottom of the screen select Widget.
If you want to launch an overlay that contains your Workflow from your webpage choose the Overlay option.
If you want your Workflow to appear within a part of an existing webpage select the inline option.
Finally if you the page to redirect to the Malcolm! web hosted version of your Workflow when the embed tag is fired select Redirect. You may wish to use URL rules with this option otherwise the redirect will fire on all pages the Malcolm! master tag is present on.

Follow the create embed process through - the Workflow you came from will be preselected as the content you want to embed. You will be offered various styling and display options based on the type of embed you choose.

At the end of the process you will be supplied with the embed code that you can add to he site or app where you want the Workflow to appear.

Question 3

What is the Share section in MyMalcolm for / how does it work?

Accepted Answer

The Share section of MyMalcolm gives you tools to embed and share content from Malcolm! into your existing websites, applications and social spaces.

You can bring content from Malcolm! directly into your current website via embeds. Choose the content you want to embed and how you want it displayed and we'll give you some code. Inserting that code into your current website will load in your content from Malcolm!

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)

You can embed individual FAQs or Workflows, create custom widgets that can pull in things like search results, category listings, all content by a particular author, recent content, tagged content, most popular content and much more.

If you don't have a website or you want to group all your Malcolm! content together you can use our Hosted Hub.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/77KnCbIxOb/screenshot-my.malcolm.app-2019.11.05-11_21_58.png (About our Hosted Hub)

We also have a plugin for Wordpress.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/3xBONmPNuf/screenshot-my.malcolm.app-2019.11.05-11_06_58.png (The Share section of MyMalcolm)

In addition to the above customers on our Enterprise plans have full access to our API which means they can pull from and push content to Malcolm! in a variety of ways - please speak to your account manager for more details.

Question 4

How can I password-protect my hub with Auth0?

Accepted Answer

Malcolm supports using Auth0 to password-protect your content.

This guide will help you set up Auth0.

First go to MyMalcolm > Settings > Instance > Visibility and enable Hosted Hub password protection. This automatically enables the built-in password protection.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/ea8meZWJKM/Screenshot%202021-11-25%20at%2016.37.03.png (Screenshot 2021-11-25 at 16.37.03.png)

Next, inside your Auth0 tennant, create a new Auth0 Application. Give it a name and choose Regular Web Applications from the four options.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/VDfX0QpiZh/Screenshot%202021-11-25%20at%2016.31.49.png (Screenshot 2021-11-25 at 16.31.49.png)

Click on the Settings tab and scroll down to the Basic Information section.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/JReEIPSyji/Screenshot%202021-11-25%20at%2016.46.53.png (Screenshot 2021-11-25 at 16.46.53.png)

In MyMalcolm click through to Manage password protection and toward the bottom enable Auth0 for password protection. Copy/paste the Domain, Client ID and Client Secret from Auth0 into MyMalcolm.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/mwX1ffzhIZ/Screenshot%202021-11-25%20at%2016.40.03.png (Screenshot 2021-11-25 at 16.40.03.png)

Next copy/paste the Application Login URI, Allowed Callback URL and Allowed Logout URL from Malcolm! into your Auth0 Application URIs settings.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/ST4LVVMZ3x/Screenshot%202021-11-25%20at%2016.45.36.png (Screenshot 2021-11-25 at 16.45.36.png)

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/kpvEhZpVtp/Screenshot%202021-11-25%20at%2016.40.39.png (Screenshot 2021-11-25 at 16.40.39.png)

Save the settings on both sides and you should see your Auth0 login page in your Hub.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/oijJOqmb9t/Screenshot%202021-11-25%20at%2016.42.11.png (Screenshot 2021-11-25 at 16.42.11.png)

But that's not all!

Attributes from your Auth0 users can be pre-populated in Malcolm! Workflows. To enable this feature choose a suitable field on a Workflow, edit the field settings and enable Allow a value to be set in the URL query. Enter one of the four attribute names email, name, nickname or picture to pre-populate those values directly into your Workflow.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/5zfBKHJgrE/Screenshot%202021-11-25%20at%2017.23.01.png (Screenshot 2021-11-25 at 17.23.01.png)

You can read more about passing values in the URL query here.

Question 5

Is there a way a user can browse all my FAQs/Articles bypassing Categories?

Accepted Answer

On your hosted hub your users can search for FAQs/Article content by keyword, browse various filtered views (eg most recent, most helpful etc) and also browse the FAQs/Articles within each category.

It can sometimes be useful to offer your users a browsable view of all your FAQ/Articles (regardless of the category/categories they are in) and this is possible via the directory view.

You can enable this Settings --> FAQs --> General where you you can also decide how you want the content on the directory page to be sorted.

When switched on the directory page can be accessed on your hosted hub URL at /faqs/directory and you can create a link to it from a feature box or promo or from text areas like your homepage preamble (all managed from within your theme).

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/rb5fS303OE/Screenshot-2021-11-26-at-15.10.19.png (Directory Setting in MyMalcolm)

The directory will also show all the categories towards the top of the page (clicking any of these will take you into the category view) and then FAQs/Articles beneath sorted in the order determined in MyMalcolm.

See the below video for a walk through

Question 6

Can I change the order in which FAQs are shown when a user browses a category, tag or author listing?

Accepted Answer

You can change the order your FAQs are sorted in when your users view by author, category or tag via Settings --> FAQs --> General.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/evapRB3yn5/screenshot-my.malcolm.app-2021.06.29-16_30_20.png (Author, category and tag sort order in MyMalcolm)

In addition to this you can also set an absolute order for FAQs within a particular category. To do this go to the category in question in FAQs --> Categories and select Reorder. You can then drag the FAQs to create the order you want.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/RibhVyjiBt/Screenshot%202021-10-11%20at%2010.40.21.png (Reorder the FAQs in a category in MyMalcolm)

Note that these settings only affects listings, not searches. Searches are ordered by relevance.

If you want to be able to set an absolute for FAQs within an author or tag listing the way to do this is to set the date sort option, then in the individual FAQ configure tab use the display date to determine an order. The FAQ with the most recent date will be shown first in an author, or tag listing - and also in a category listing unless overridden using the absolute method above. The FAQ with the second most recent date will be shown second and so on.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/44K839GO3Z/screenshot-my.malcolm.app-2021.06.30-15_14_49.png (Display date in FAQ configure tab)

Note that if you set the display date to invisible either globally in Settings or individually on an FAQ's configure tab the date won't show on the front end to your customers/users but the date you set will still be relevant in determining the order in which the FAQs displays.

See the video below for a walkthrough

Question 7

Can I organise or filter my Workflow completions?

Accepted Answer

You can filter your Workflow completions, assign a status and also add notes.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/jPMzrSqIJg/screenshot-my.malcolm.app-2021.08.27-17_20_31%20b.png (Browse Workflow completions in MyMalcolm)

This can be really useful if you want to use the Completion screens like a mini CRM - you can categorise or mark your completions to organise them in a certain way. For example you may want to apply the status "Done" or "Processed" to certain Workflows and "Follow Up" to others.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/9ZHHjnH6sB/screenshot-my.malcolm.app-2021.08.27-17_21_37.png (Set a status for Workflows in MyMalcolm)

You can also add notes to a Workflow completion that your Team can see. A handy notes icon will appear in the Completions list to show notes exist.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/f1zeN8GXfK/screenshot-my.malcolm.app-2021.08.27-17_21_03.png (Add notes to Workflow completions in MyMalcolm)

You can have filter controls at the top right of the completions screen.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/CXIgS6IXpJ/screenshot-my.malcolm.app-2021.08.27-17_22_03.png (Filter completions controls in MyMalcolm)

See a video walkthrough of these features below

Question 8

Who created Malcolm?

Accepted Answer

Malcolm! has been created from scratch by a passionate and dedicated team at Acknowledgement Limited.

Question 9

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 10

How do I change the colour of my links?

Accepted Answer

You can change the colour of your links via your theme. Themes live in the Brand section of MyMalcolm.

In your main theme settings you'll see link colour options under Primary, Secondary, Tertiary and Body.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/PapJB2lyc6/Screenshot%202021-02-23%20at%2011.22.50.png (Link colour management in Themes)

In embed themes, the link colour is managed from the other colours section.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/Ox2zsXtjRW/Screenshot%202021-02-23%20at%2011.23.15.png (Link colour management in Embed Themes)

In Workflow themes, the link colour defaults to the colour selected in the main theme but can be overridden.