Wizard Settings

angus · April 14, 2020, 2:09am

Wizard settings are those that affect the behaviour of the whole wizard. You’ll find them in the first settings block in your “Wizard” admin panel.

Required

When disabled, users see an “Exit” link in the footer of the first step of the wizard. If they click the link they’ll be taken to the forum homepage.

Signup

When enabled, users are automatically redirected to the wizard after they create an account (after signing up or accepting an invite).

Users will not be redirected after signup if they are:

not permitted to access the wizard (see “Permitted” below); or
if custom wizards are disabled; or
if the wizard no longer exists; or
if “Signup” is disabled

Multiple

When enabled, users can complete the wizard multiple times. If disabled, users will see this message if they try to complete the wizard again.

If they click the “Return to {site name}” button, they are redirected to the forum homepage.

Prompt

When enabled, users will see a global banner prompting them to complete the wizard. When a user completes the wizard, the banner will no longer show for that user.

To edit the text of this banner, customise the wizard.complete_custom text.

Time

When enabled, users will be automatically redirected to the wizard on the specified date, at the specified time. If the user is not on the forum at the time, they will be redirected the next time they visit the forum.

Users will not be redirected at the specified time, or the next time they visit the forum after the specified time, if they are:

not permitted to access the wizard (see “Permitted” below); or
if custom wizards are disabled; or
if the wizard no longer exists; or
if “Time” is disabled

Permitted

Use Permitted to restrict which users can access the wizard (and automatically redirected to the wizard via the Signup or Time settings).

Permitted is a conditional field with two types:

Assignment (“Set”): A defined list of user groups who have access
Validation (“Ensure”): A list of user field conditions

Permitted is cumulative. All separate conditions must pass for the user to have access.

Guest Submissions

You need to be on Custom wizard business subscription to be able to use this feature.

To allow guest (i.e. folk who are not logged in) submissions, set the Permitted setting to Users and Guests.

If guest submissions are enabled, only the actions Send Message and Route To are available.

Advanced

As with all advanced settings, be careful when using these settings. Using them may effect the normal functioning of the wizard.

Save. When disabled, the custom wizard will not save submissions
Restart. When enabled, partial progress through a wizard will cleared each time the user visits it.
Resume. If a user has an incomplete subsmission when they visit the wizard they will be asked if they want to resume that submission or start again, and delete their incomplete submission.

slambert · February 11, 2021, 1:55pm

When customizing the the text in the Prompt is it possible to include the user’s name? Like “Hey Angus, it’s time to update your profile!” I tried a few things that didn’t work and thought I’d ask.

Thanks!

slambert · February 12, 2021, 4:52am

I have signup checked but I don’t think it’s being triggered.

My user account creation is first done in WordPress, and then WordPress users come to discourse using that login. (I’m doing this through the WordPress Discourse plugin, etc)

Would that prevent this signup action from running?

angus · February 19, 2021, 6:41am

Unfortunately not. Would need to add that as a new feature.

Yes. The Signup wizard setting does not currently work if the account is created in Wordpress and login to Discourse is via SSO. I’ll make a note about that above.

Could you make a feature request for this one actually? That would help me keep track of it.

There’s also this known issue with the custom wizard plugin and Wordpress SSO

angus · February 19, 2021, 6:43am

A post was split to a new topic: No access messages aren’t working

NathanK · February 26, 2021, 7:09pm

I’m not sure that this is working right now. My users are describing a ‘blank page’ instead and it is taking a bit to test it properly (as @admins seem to be able to submit multiple times regardless!)

NathanK · October 8, 2021, 5:06am

What does this do?

You’ve been busy adding stuff…

angus · October 11, 2021, 4:06am

Yes we have! Many more changes coming actually. Thanks for the prompt on this, I’ve added a description

Resume. If a user has an incomplete subsmission when they visit the wizard they will be asked if they want to resume that submission or start again, and delete their incomplete submission.

calvarez · May 26, 2022, 4:00pm

If I wanted to only use the custom wizard to add custom fields to new topics, how would I set that up? It seems like the custom wizard is only intended for user profiles at the point of sign up. What would I need to enable/disable/set in order to use the plugin like this?

NathanK · May 27, 2022, 3:20am

What you want to do is definitely within the scope of the CWP.

If you configure the Wizard to generate a topic, and set that wizard to be topic creator for that category (in the category settings) you should be able to achieve that

calvarez · May 27, 2022, 10:50pm

Would you mind briefly describing how to do that? I’ve literally looked through all the documentation/topics and can’t find an intro or overview of how it all works or what it’s capable of.

Rhod · August 29, 2022, 11:31am

Hello, I have doubts regarding this section, I want users with a certain type of e-mail to be able to access the wizard, however I have not been able to configure it correctly.
What I want is that, for example, only those who have a school email, of the type alumn_1@cool_school.com, have access to the wizard and that emails like gmail.com, hotmail.com, etc. simply do not access.
Could you support me by telling me how I can achieve this?
Thanks in advance.

angus · August 29, 2022, 11:36am

Hey @Rhod, the way to achieve that is:

Create a group of users with that email domain. You can do this automatically in group settings.
Set the “Permitted” field to the group

th21 · October 1, 2022, 10:47pm

As not subscribed user, the wizard will not save the submissions, does it mean the admin have no idea what’s the user’s submission?

NathanK · October 5, 2022, 8:28am

I’m not sure - while ‘greyed out’, the Save wizard submissions is selected:

Have you given it a shot?

If you are definitely missing functionality and aren’t affilitated with a business, you can apply for a Community (free) subscription:

https://custom-wizard.pavilion.tech/pricing/

th21 · October 5, 2022, 4:12pm

I have applied but didn’t get a response yet.

NathanK · October 5, 2022, 6:25pm

Sorry to hear that; it is early days for the CWP 2.0, please be patient as the workflows and bumps are sorted out.

Hopefully you’ll hear back shortly.

Bhanu · March 10, 2023, 6:40am

Custom Wizard plugin now lets you allow guests to create wizard submissions.

You need to be on Custom wizard business subscription to be able to use this feature.

To allow guest submissions, set the Permitted setting under the Wizard section to Users and Guests.

If guest submissions are enabled, only the actions Send Message and Route To are available.

richard · May 15, 2023, 7:36am

@angus can you please review and correct if necessary? It seems like Save is not in “Advanced” and “Resume” does not exist (any more)?

angus · May 15, 2023, 3:33pm

I think it might be a good idea to share this around a bit. Indeed it doesn’t require technical expertise, just some familiarity with the plugin. We can’t keep me as the sole expert on things indefinitely.

@NathanK Would you mind giving this one topic a shot? Let’s see if it’s doable. If you’re finding it hard, report back and we’ll re-assess.