Forms
Introduction
Forms are a common way to collect information from users such as contact data, ticketing info, and more. Forms are made up of a variety of elements which we'll cover in this guide.
This page is meant as an informational breakdown of the Forms Module. Check out the Staff Application Tutorial if you're looking for a guide on how to create your first form
Forms Menu
To access the Forms main menu, use the /admin forms command. This will bring up a dashboard of all forms your venue has configured. From here you can create new forms, edit existing forms, and view form submissions.
Add Form
The button will create a new form. You will be prompted to enter a name for the form. Once created, you can add questions to the form.
Modify Form
The button will present a select box of all forms. Selecting a form will allow you to edit the form's name, questions, prompts, and other fields.
Remove Form
The button will present a select box of all forms. Selecting a form will remove the form and all associated submissions.
Form Removal
Removing a form will also remove all submissions associated with that form. This action cannot be undone.
Form Main Menu
To access the main menu of a form, either add a new form or modify an existing form.
Add Question
The button will add a new question to the form.
You will be required to enter the main question text.
Check out the Question Documentation further down the page for more information on the types of questions you can add and how to configure them.
Modify Question
The button will present a select box of all questions.
Selecting a question will allow you to edit the question's text, type, and other fields.
Remove Question
The button will present a select box of all questions.
Selecting a question will remove the question from the form.
Question Removal
Removing a question will NOT remove any previous submissions associated with that question.
Modify Pre- / Post-Prompts
The button will allow you to set the pre- and post-prompts for the form.
For more information on Pre- and Post-Prompts, check out the Pre- and Post-Prompts Documentation.
View All Responses
The button will display all responses that have been submitted for the form.
Form Responses
As soon as a user submits a form, both the questions and responses will be stored in the database.
This allows you to change the form questions displayed to new users at any time without losing previous response context.
Set Notifications
The button will allow you to set up notifications for form submissions.
See the Notifications Documentation for more information on how to set up notifications.
Set Log Channel
The button will allow you to set a channel where form submissions will be logged.
This is typically a private channel reserved for this purpose.
Set Posting Options
The button will allow you to set up where the button users will click to begin filling out a form will be posted.
This is typically a public channel where users can easily access the form.
See the Posting Options Documentation for more information on how to set up posting options.
Toggle Create Channel
The button will allow you to enable or disable the creation of a new private channel when submitting a form.
This is most useful in a suggestion or ticketing system.
See the Channel Creation Section for more information on this functionality.
Manage Channel Creation
The button will allow you to set up the channel creation settings (if enabled).
This includes setting the category, permissions, and other channel settings.
See the Channel Creation Section for more information on how to set this up.
Form Questions
Forms are made up of questions that can be configured in a variety of ways.
To access a question's main menu, either add a new question or modify an existing question.
Set UI Component Type
The button will allow you to set the type of UI component that will be used to display the question.
There are four options:
Short Text- A single-line text inputLong Text- A multi-line text inputSelect Menu- A dropdown select box allowing a single option to be selectedMulti-Select Menu- A dropdown box in which multiple options can be selected
Toggle Required
The button will allow you to set whether the question is required or not. There is enforced client-side validation to ensure required questions are answered.
If the button is green with a checkmark, the question is required. If it is gray with no emoji, the question is optional.
Primary Text
The button will allow you to set the main text of the question.
This is the text that will be displayed at the top of the question embed when the user is filling out their form.
Restrictions
Max Length: 80 characters
Secondary Text
The button will allow you to set the secondary text of the question.
This is the text that will be displayed below the main text of the question embed when the user is filling out their form.
Restrictions
Max Length: 80 characters
Modify Prompts
The button will allow you to set the pre- and post-prompts for the question.
This is useful for providing additional context or instructions to the user as well as offering an opportunity to confirm or cancel the question submission.
Check out the Pre- and Post-Prompts Documentation for more information on how to set these up.
Disabled Buttons
The following buttons are only available for questions with the Select Menu or Multi-Select Menu UI component type.
Add Select Option
The button will allow you to add an option to a select menu or multi-select menu question.
Modify Select Option
The button will allow you to edit an existing select option.
Remove Select Option
The button will allow you to remove an existing select option.
Consult the Set UI Component Type section for more information on how to set this up.
Otherwise, scroll down to the Select Menu Options section for more information on how to set this up.
Select Menu Options
Pre and Post-Prompts
Pre- and Post-Prompts are simple embedded messages that will be displayed before and after the form questions, respectively. They can be used to provide additional context or instructions to the user, as well as offer an opportunity to confirm or cancel the question submission.
Each form has both a pre-prompt and a post-prompt that can be activated, but are deactivated by default.
Set Title
The button will allow you to set the title of the prompt.
This is the text that will be displayed at the top of the prompt embed.
Restrictions
Max Length: 80 characters
Set Description
The button will allow you to set the description of the prompt.
This is the text that will be displayed below the title of the prompt embed.
Restrictions
Max Length: 200 characters
Set Thumbnail
The button will allow you to set the thumbnail of the prompt.
This is the image that will be displayed to the right of the title and description of the prompt embed. It's useful for branding or providing additional context.
Show Cancel
The button will allow you to toggle whether the prompt will display a cancel button.
This is useful for allowing the user to cancel the question submission if they change their mind based on information presented in the prompt.
Toggle Button
The button will display the text "ON" if the cancel button is enabled and "OFF" if it is disabled.
Activate Prompt
Clicking the button will ensure that your customized prompt is displayed is to users before/after the question.
Toggle Button
Once activated, the button's appearace will change.
Click the button to prevent the prompt from being displayed.
Notifications
Occasionally, when a form is submitted, it's necessary for a venue to notify a certain group of people. For a
Staff Application, for instance, one might want to notify the @Management role as well as the owner of the venue.
Add/Remove Role to Notify
The first set of buttons on the notification menu controls which server roles are notified when the form is submitted.
The button will prompt you for an @-mention of any role
you wish to notify when a form is submitted.
The button presents a selector box with all roles currently set to be notified. To remove one, simply pick it from the select box.
Add/Remove User to Notify
The other set of buttons on the notification menu controls which individual users are notified upon form submission.
The button will prompt you for an @-mention of any user
you wish to notify when a form is submitted.
The button presents a selector box with all users currently set to be notified. To remove one, simply pick it from the select box.
Posting Options
The posting options menu allows you to configure the channel in which users will click a button to begin filling out your form. There are a variety of options available when setting up posting options for a form.
The posting channel is typically a pre-made, public channel where users can easily access the form.
Channel Creation
This is different from the channel creation feature, which creates a new private channel when a form is submitted.
Set Description
The button will allow you to set the description of the posting options.
This is the text that will be displayed on the posting options embed below the name of the form.
Restrictions
Max Length: 500 characters
Set Post Channel
The button will allow you to set the channel where the form posting options will be displayed.
This is typically a public channel where users can easily access the form.
Restrictions
Channel Type: Text Channel
Set/Remove Thumbnail
The button will allow you to set the thumbnail for the post message. This is the image that will be displayed to the right of the form name and description.
Restrictions
Image Types: Must be PNG, JPG, WEBP, or GIF
Likewise the button will remove the thumbnail from the post message.
Set Color
The button will allow you to set the accent color of the post message.
This is the color that will be displayed on the left side of the form name and description.
Color Picker
This must be a valid HEX color code. Please consult the Google Color Picker for assistance.
Set Button Label
The button will allow you to set the label of the button that will be displayed on the post message.
This is the text that will be displayed on the button that users will click to begin filling out the form.
Restrictions
Max Length: 80 characters
Set/Remove Button Emoji
The button will allow you to set the emoji for the button that will be displayed on the post message.
This is the emoji that will be displayed to the left of the button label.
Likewise the button will remove the emoji from the button.
Channel Creation
The channel creation menu allows you to set up the channel creation settings for a form. This is most useful in a suggestion or ticketing system, but can be taken advantage of for a variety of uses.
Channel Creation
This is different from the posting options feature, which sets up the channel where users will click a button to begin filling out a form.
To learn how to toggle Channel Creation, head to the Toggle Create Channel section.
Channel Creation Options
There are a variety of options available when setting up channel creation for a form.
Add/Remove Role
The button will prompt you for an @-mention of any role you wish to
have access to the created channel. This is commonly used for management or oversight roles.
Likewise, the button will present a selector box with all roles currently set to have access to the created channel. To remove one, pick it from the select box.
Set Create Category
The button will allow you to set the category where the channel will be created.
This is typically a category reserved for the form type, such as Suggestions or Tickets.
