Question 1

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 2

Can I change where the logo on my hosted hub and hosted pages links to?

Accepted Answer

If you add a logo to your theme it will by default link to your hosted hub home page. Sometimes you might prefer to have your logo link back to your main website, or another destination.

You can change where the logo links to and whether that link opens in a new window or not in the header section of your theme.

Question 3

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 4

Can I translate or change the system text and labels my users will see?

Accepted Answer

In addition to the FAQ and Workflow content that you create in MyMalcolm you can now change all the system generated text and labels your users see and interact with in the front end of Malcolm!

This means you could, for example, completely translate all the parts of Malcolm! your users will see into a different language.

The majority of the system text is stored and changed within your theme. Themes live in the Brand section of MyMalcolm.

Quite a few bits of system text can be changed contextually as you browse around the sections of your theme, however for the complete list of text you can change go to the "advanced" tab. Here you will have access to your custom language file. The language file stores any changes to the default system text. You'll see any changes you've already made in the other parts of the theme interface reflected here.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/E6kdxuV8w9/screenshot-my.malcolm.app-2020.08.12-00_01_21.png (Edit your language file in MyMalcolm)

At the bottom of the screen you will see two buttons.

Show dictionary - this will show you a complete list of system text items with some further information about where the text is used
Show language file - this will show you all the default values for system text

You can copy the key and default value for a bit of text, paste it into the custom language file window and then edit it. The part you want to change is on the right hand side.

For example, if you wanted to change the text next to the send FAQ by email functionality to be "Please email me" you would add the following to your custom language file

"Heading: Email this answer": "Please email me",

Please note that a few items of system text your users will see are configured elsewhere in MyMalcolm:

The default values, placeholder text, validation message, tooltip title and descriptions used within Workflows are configured in the Workflow builder - you click on the content element when it's been placed on a page in the builder to edit these items
Window titles and button text for Embeds are managed within the visual style section of the respective embed in the Share section (although you can change the default values used via the language file)

Question 5

Can I turn off the Workflow title?

Accepted Answer

If you don't want your Workflow title to display you can set this from the configure screen of the Workflow in question.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/JtWPLTjDHT/Screenshot%202020-08-11%20at%2017.45.24.png (Screenshot 2020-08-11 at 17.45.24.png)

This setting affects both the web and embed versions of your Workflow. If you want the title to display on one type but not the other you could clone your Workflow and use different settings for each.

Question 6

I'd like to open the Overlay embed directly, how do I do this?

Accepted Answer

When you create an Overlay embed we give you two bits of code to add to your page. The first is the master code which you should place just before the closing tag. The second is the inline code which generates the button users click to open the overlay - this goes inside the tags where you want the button to appear. When the user clicks the button the Overlay embed will appear in a modal (pop-up) over your page.

The inline code we give you will look like this -

Sometimes you might want to call the overlay but not use our button. You might want to call it from text or use your own button/graphic or you might want to call it in the background when a user does something else on your page.

You can do this by calling mapi in JavaScript.

The mapi has four methods - open, close, trigger and toggle. Open, close and toggle all return promises (i.e., a function that resolves when the animation is complete or a rejects if something went wrong, e.g., no embed found for the param passed). Trigger is more "fire and forget" - it will call the open function if everything goes well, otherwise it silently fails.

Here is an example using an href link that uses the trigger method to open the Overlay -

Note that you must have our master embed code on your page for the above to work and you need to replace EMBED_ID with your embed ID.

The above may also be useful for customers who are using third party site building systems - sometimes putting inline code into a page on those systems can be restricted so you can't add our inline code to render your button. If you can create inline links you could try using the above example with the trigger method to open the Overlay (again remember you also need the master code on the page).

Question 7

How do I use your Wordpress plugin?

Accepted Answer

First download the Malcolm! Wordpress Plugin here.

In MyMalcolm! create your embeds as normal - instructions here.

At the end of the Embed creation process when your embed code is generated there is some text which says "Embedding in a Wordpress site?" - if you click that text you will be shown your instance ID and for some embed types you will be shown a shortcode. There is also an option to have this information emailed to you.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/Lglywov3F9/Screenshot%202020-05-24%2022.00.27.png (Embedding in a Wordpress site?)

In Wordpress, install the Malcolm! plugin then goto Settings --> Malcolm! and add your instance ID. Currently on some versions of Wordpress when you add the instance ID and press Save there is no acknowledgement of this but you can verify the instance ID has indeed been saved by navigating away and then back to Settings --> Malcolm!

You can see your instance ID in your URL when you are in MyMalcolm eg, https://my.malcolm.app/instances/XXXXXXXXXX/dashboard. The instance ID is the 10 digit code code shown where the X's are above.

For Widget and Full page embeds this is all you have to do - you can then configure on which pages your embeds appear via MyMalcolm (via the URL rules section of the respective embed).

For inline embeds and overlays you need to position where you would like the embed or the overlay launcher in your content. You do this using the Shortcode. Go to the page or post in Wordpress, make sure you are in code editor (not visual editor) and put the Shortcode where you wish the embed to appear / or the overlay be launched from.

If you have any issues with you embeds not appearing first check these things.

Question 8

Can I embed HTML or add iframes to Malcolm! content?

Accepted Answer

Malcolm! FAQ supports embedding content via HTML iframes.

Most popular content channels such as YouTube and Vimeo offer an embed sharing option via HTML iframes.

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/TEt5gCaFXw/Screenshot%202021-01-29%20at%2011.06.24.png (Screenshot 2021-01-29 at 11.06.24 (1).png)

Malcolm! has two buttons on its editor toolbar. One for inserting video or presentation type content and one for other type of content. To use these features simply locate the HTML iframe code on your content channel and copy/paste it into one of these two dialogs.

Question 9

Can I restrict some or all of my Team members from seeing and/or exporting submitted Workflow data?

Accepted Answer

Sometimes you may wish to use Workflows but restrict other Team members on your instance from having access to the data that is submitted by your end users.

Here is how to do this

Access is managed via the "Team" section of MyMalcolm.
In that section if you click on a Team Member then select "privileges" you can configure whether a user can see and/or export submitted Workflow data. You can even remove all their access to the Workflow section.
Depending on their settings the Instance Owner and some Team Members may also receive submitted data via email alerts. See more about managing email alerts here.
Regardless of their own preferences Team Members won't receive email alerts relating to Workflow completion if they don't have access to Workflow submitted values and exports.

Some related things to be aware of

Remember that on a Workflow level further email recipients can be added in the "email answers" part of the configure section of the individual Workflow - it may make sense to review this recipient list at the same time you review who on your team has access to end user submitted data.
Be aware that if you are pushing some or all of the submitted data to third party systems via Integrations or Web Hooks then submitted data will potentially be viewable by users in those systems.

We recommend that you review this article to read about GDPR and how it applies to Malcolm! and your users.

Question 10

Do you support animated GIFs?

Accepted Answer

Yes you can use animated GIFs in Malcolm! placing them in your FAQs or in Workflows (via the Content element).

You can upload the animated GIF into the media section of MyMalcolm or you can pull in externally hosted GIFs.

This cat has been uploaded to MyMalcolm:

https://malcolm-en-gb.s3.eu-west-1.amazonaws.com/instances/HwJyEPPI3q/resources/WsOiR3iaEG/Cat.gif (Animated Cat.gif)

To pull in external GIFs use the following Markdown syntax:

The above Markdown results in this:

https://media.giphy.com/media/QpWDP1YMziaQw/source.gif (Image Description)

Have fun!