Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.Entityform user documentation (version 7.x-1.0-rc2)
This document will provide instruction regarding what information should be supplied to each question on the Home » Administration » Structure » Entityform Types » Edit "Form Name" form.
We have documented all of the fields on the Edit Entityform Type edit screen. While you can read all of the user documentation, you can click on the below links and it will take you directly to the instructions for the specified field.
The Edit Entityform Type form contains the following fields:
It also contains the following vertical tabs
The Access Settings vertical tab enables you to control access to the form. It has the following fields:
The Submission page setting vertical tab enables you to control what information is displayed to the user then a form is submitted. It contains the following fields:
The Submission views vertical tab enables you to control which View is used to display the submitted forms. It contains the following fields:
The Draft settings vertical tab enables you to control whether or not a form can be submitted as a draft and other related information. It contains the following fields:
The Notifications settings vertical tab enables you to specify which Rules should be "fired" when the end user submits a form. This vertical tab contains the following fields:
The URL path settings vertical tab enables provide an URL alias for the submitted form and confirmation pages. This section contains the following fields:
The Form Overrides vertical tab enables you to over ride certain settings on the the form. This vertical tab has one field, it is:
Edit Entityform Type form field instructions
Name
Please enter the name of your form. Ideally, it should be unique. If the name is not unique, it will cause confusion. This name will be:
- Displayed on the Entityform Listing page
- Used as the title of the Entityform when it is displayed to the end user.
Machine name
The machine name appears to the right of the Name text box. You can change the machine name by clicking on the Edit "button", which appears in blue lettering inside of brackets. If you click on the Edit button, the machine name will disappear! However, a new text box field entitled "Machine Name" will appear directly below the Name text box.
Redirection path
The path you enter here is a "relative" path, which is anything after the base URL (www.example.com) and does not start with a slash "/". You would use this if you want the user to see something other than the standard confirmation page. You could re-direct them to another page, such as:
- A View with a contextual filter that uses token(s) to generate a custom response.
- An existing Drupal page such as their user profile.
- A custom page you create.
- Another entity form or series of forms
Note: This only occurs after the user submits the correction submission and the data has been saved.
Intro forms instructions
This field should contain any instruction you want to consumer / user to read. These instructions / comments will appear at the top of every page of the Entityform.
Access Settings
This section enables you to:
- Turn on and off each form.
- Specify which user roles have access to the form.
- Indicate if a user can edit their old submission or not.
- List which Rule(s) will be used to determine if the user will see the form fields.
old note - don't remember my point ->if you enable edit old submission then there is only one submission per user. if you re-edit form, then there is only one form per user period!!! - access setting.
Form Status
This field determines if the form is "open for business". If the form is available for use, then the form is considered "open" or available. In this case, you should set the Form status to "Open for new submissions". If the form should closed or unavailable for use, then form is considered closed. In this case, you should set the Form Status to "Closed for new submissions".
Roles
This field is an attempt to make the administrator's life easier. This module enable you specify which roles have access to the Entityform without having to go to the Administrator -> People -> Permissions page.
This field enables you to check which roles should be allowed to access this form. This of field as a mini permissions form.
Resubmit Action
This field enables you to control what should happen if an authenticated user attempts to submit a second form. Note: since the system can not identify an anonymous user, this question does not apply to anonymous. Assuming you allow anonymous to access the Entityform, they will always generate a new submission.
You have four choices:
| No. | Action | Explanation |
|---|---|---|
| 1 | Allow new submission | The user will ALWAYS get a new submission. This option should be chosen if the user can submit multiple entries. |
| 2 | Edit old submission | The user's existing submission will automatically be presented to them so they can edit it and re-submit the change submission. This option should be chosen if the user is only allowed to submit a single entry and to change it once it has been submitted. |
| 3 | Don't allow | Indicates that the user is not allowed to view or edit their submission. This does not apply to anonymous user. |
| 4 | Go to confirmation page | Display the confirmation page if an authenticated or administrative user tries to access a previously submitted form. This is useful when you have "additional instructions" or "what to do next" instructions on the confirmation page. |
Access Rules
If you recall, you defined all of the Access rules in the access rules tab on the Entityform Type page. Any Access rule you defined on that page will appear in the Access rules drop down box. If you did not define any Access rules, then this box will be empty.
If you defined any access rules, and that rule should be applied to this Entityform, then select that rule. If none of the a
Submission page settings
Once a correct Entityform is submitted, a "Thank You" or submission page is automatically display. The default "Thank You" page simply display "Thank you". The questions in this vertical tab enable you to customize the information that is displayed on this page by changing the:
- Page's title
- The text that appears underneath the title
- Include (or not include) the survey questions and response.
Submission page title
The default title to the thank you page is "Thank You". If you would like to change the default title, you can enter the desired title in this text box. It will be displayed as the title of the thank you page.
Submission Reply
This field enables you to enter any text you would like to have displayed on the "Thank You" / submission page. Any addition instructions or comments that you would like to present to the user after they have successfully completed the Entityform should be entered in this text box. This text will be displayed on under the page's title.
Show Submission information
Check this box if you would like to have the survey questions and answered displayed on the "Thank You" page. By default, the questions and answers will not be displayed on the "Thank You" or submission page.
Submissions view
When Entityform is enabled, it automatically installed two Views:
- Entityforms - This view simply list all of the Entityforms submissions. Provide an index of entityform types that link to submission View. This view is used by the Report - Entity Form Submissions.
- User Entityforms - This view is used by the end user to view their own submissions.
If you want to change what information the View display, it is highly recommended that you clone the existing view and then modify the cloned version. If is best to lean the original view untouched so you always have a working model.
Default View to show submission of this form.
Make own View.
Have a group of entity forms that was using for contest forms submission, you
View for submission
This drop down box will contain any and all View that "selects" or "views" an Entityform. (The three Views provided by Entityform are discussed above). By this default, this option displays the following values in the drop down box.
1. Entityform
2. User Entityform
3. Use Default
The Entityform and User Entityform Views are discussed above.
The value "Default" tell the system to use the View that is named is specified in the Entityform Configuration page. The "default View" is Entityform. You can change the default View at Home » Administration » Configuration » Content authoring » Entityform Settings » Submission Views.
The convenience of this choice becomes apparent when you have many Entityform Types(forms) defined. If all of your Entityform Types are set to use the "default View for submissions report" and you change the default setting in the Configuration form, then all of your Entityform Type will now use the new View defined in the configuration form!
View for current user's submission
This drop down box will also contain any and all Views that "selects" or "views" Entityform Submissions. You can specify which View will be used to show the end users all of their previous submissions for the specified form. This drop down menu presents the following options:
- Entityform
- User Entifyform
- Use Default
- None
The Entityform and User Entifyform Views are discussed above.
The value "Default" tell the system to use the View that is named is specified in the Entityform Configuration page. This form can be found at Home » Administration » Configuration » Content authoring » Entityform Settings » View for current user's submission. The default value for this field is User Entityforms.
If "None" is selected then the users will not see a previous submissions link.
Draft Settings
This option enables the end user to save a draft of the Entityform Submission with all of the information they have entered to date. The end user can then access and complete the form during subsequent sessions. This feature is useful when the end user has to complete a complex form such as a scholarship application form. Mostly likely, the applicant will not have all of the required information when they initially attempt to complete the application. So they would need to gather the additional information and complete the form at a later point in time.
If the Entityform Type is "draftable" and the end user clicks on the Save Draft button, then the current Entityform Submission is saved as a draft. The next time the user access the form, it will automatically be presented to them so they can add additional information. This process can be repeated any number of time. Once the end user has decided that they have completed the form, they should click on the Submit button. This action will remove the "draft" status from the Entityform Submission and submit it as if it had been completed in one session.
Draftable
If the check box is checked, then this form is "draftable". If this box is not checked, then answering the remaining two question on this page does not affect anything.
Override Draft Button Text
The default label on the save draft button is "Save Draft". If you would like to have the button contain a different message, please enter that text in the field provided.
Draft save text
This is the text that will be displayed to the end user when they click on the Save Draft button. You should provided instructions informing the user how to access the draft version of their form.
Menu Settings
These are for the Rules Modules (you will need to learn Rules)
Notification Settings
These are for the Rules Modules (you will need to learn Rules)
Submission Rules
- Email Entity Form Submitter
- Email Entity Form Admin
Email Text
Research: Does not support HTML because not all e-mail recipient allow HTML e-mails and does not use tokens.
Notification Emails
Research: What does this mean? Are these e-mail addresses?
URL Path Settings
Drupal has a feature called "URL Alias". This allows you to replace the physical path name with something that is more people friendly. There is a very good article that discusses Drupal's URL aliases.
Submitted URL alias
This is for the alias for the submit link page. The default path / URL for an Entityform Type submit page is eform//submit. However, you may want to provide a more user friendly URL to user. If so, then you should enter the user friendly URL in this text box.
Example: The actual URL for a scholarship application form might be www.example.com/e-form/scholarship_eform/submit. However, you might want to publish the URL to the page as www.example.com/your-scholarship. In this case, you might enter something like "your-scholarship" (without the quotes) in this text box. "Your-scholarship" is the alias for "e-form/scholarship_eform/submit".
Confirm URL alias
This is for the alias for the confirmation page URL. The default path / URL for an entity's confirmation page is e-form//confirm. However, if you want to provide "What to do next" instructions on the confirmation page, this is not a very friendly URL to publish.
Example: The actual URL for the confirmation page for a scholarship application form might be www.example.com/e-form/scholarship_eform/confirm. However, you might want to publish the URL to the page as www.example.com/next-scholarship-step. In this case, you would enter "next-scholarship-step" in this text box. "Next-scholarship-step" is the alias for "e-form/scholarship_eform/submit".
Form Overrides
This vertical tab enables you to change the text on certain items that appear on the actual Entityform Submission form. At the present time, you can only change the "Save Button" text.
Override Save Button Text
If you would like your "submit" button to contain different text than "Submit Form", then you should enter the text in this field. Whatever you enter in this field will be displayed as the text on the "submit button".
