Difference between revisions of "Submit & Save Buttons"

From SmartWiki
Jump to: navigation, search
(→‎Tips)
Line 1: Line 1:
 
__TOC__
 
__TOC__
 +
 +
===Overview===
 +
 
SmartSimple offers the ability to define multiple submit buttons against individual statuses within a UTA.
 
SmartSimple offers the ability to define multiple submit buttons against individual statuses within a UTA.
  
 
The buttons can also be configured so that they are presented to subsets of users, perform certain [[validation]] checks and can push the event to a specific status.  
 
The buttons can also be configured so that they are presented to subsets of users, perform certain [[validation]] checks and can push the event to a specific status.  
  
−
==Creating a Submit Button==
+
===Creating A Submit Button===
−
 
−
To access the '''Submit Button''' feature:
 
  
−
1) Click the '''Settings''' tab within the UTA, then on the [[Statuses]] link in either the Level 1 settings section, or Level 2 settings section.
+
To create a Submit Button:
−
 
−
2) The '''Submit Button''' tab is displayed next to the '''Status Trigger''' tab.
 
−
 
 
−
[[Image:SubmitButton1.png|link=]]
 
  
−
3) Click on the Submit button tab or scroll down to the Submit Buttons section. Then click on the New tab to begin the process of adding a new Submit button.  
+
1) Click the Settings tab within the UTA, then click on the '''Submit & Save Buttons''' link in either the Level 1 settings section, or Level 2 settings section.<br />
 +
[[Image:Submit_and_save_button1.png|600px]]
  
−
[[Image:SubmitButton2.png|link=]]
+
2) The '''Submit & Save Buttons''' page is displayed.
  
−
4) You will be presented with a new window in which to configure the submit button.
+
3) Click on the '''+''' New Submit & Save button.
 +
[[Image:Submit_and_save_button+.png]]
  
−
[[Image:SubmitButtonsMay2014.png|link=]]
+
4) You will be presented with a new window where you can configure the submit button.
  
 
This window includes the following settings:
 
This window includes the following settings:
−
* '''Order''' - the order in which the button will appear on the screen, with lower numbers appearing further to the left of the screen.
 
−
* '''Type''' - Options are ''Submit Button'', ''Save Button'' and ''Save Draft Button''. See [[Submit Logic on Save or Save Draft Buttons]] for further information.
 
−
* '''Label''' - the text that will appear on the button when exposed to end users.
 
−
* '''Submit Status''' - the status that the entity should be updated to after clicking on the button.
 
−
* '''[[Bypass validation]]''' - flag to indicate that the status should change without the system performing all field validations. The [[Submit Logic]] on the button itself will still be validated.
 
−
* '''Description''' - descriptive text.
 
−
* '''Script''' - call to any scripts that should be run in conjunction with this button. The system will check if the script is present before trying to run it. Submit button script must be formatted as ''functionName(this.form)''. Spaces are not permitted. Script should return either '''true''' or '''false'''.
 
−
:'''Important:''' If a '''''Submit Button Script''''' has been defined the Submit button will run that function, and will '''NOT''' ensure that [[mandatory]] fields are completed.
 
−
* '''URL''' - specify the URL the user should be redirected to following successful submission. '''NOTE:''' Redirects must be relative path (e.g. /wiki/index.php) rather than an absolute path (e.g. http://www.smartsimple.org/wiki/index.php).
 
−
* '''[[Visibility Condition]]''' - any [[Visibility Condition|conditions]] used to control when the button is exposed.
 
−
* '''[[Type Field Permissions]]''' - used to control the templates/types for which the button is visible or hidden.
 
  
−
5) Click Save once you have configured the Submit button.
+
* '''Type''' - Options are Submit Button, Save Button and Save Draft Button. See Submit Logic on Save or Save Draft Buttons for further information.
 +
 
 +
* '''Order''' - The order in which the button will appear on the screen, with lower numbers appearing further to the left of the screen.
 +
 
 +
* '''Caption''' - the text used to identify a field.
 +
 
 +
* '''Align to''' - Select the preferred alignment (Center, Left, Right).
 +
 
 +
* '''From Status''' - The status of the entity before clicking on the button.
 +
 
 +
* '''To Status''' - The status that the entity should be updated to after clicking on the button.
 +
 
 +
* '''Bypass Validation''' - Flag to indicate that the status should change without the system performing all field validations. The Submit Logic on the button itself will still be validated.
 +
 
 +
* '''SmartCheck Validation''' - Select the SmartCheck Validation validation method required.
 +
 
 +
* '''Description''' - Definition and general description of the submit button. Will not be displayed.
 +
 
 +
* '''Script''' - Call to any scripts that should be run in conjunction with this button. The system will check if the script is present before trying to run it. Submit button script must be formatted as functionName(this.form). Spaces are not permitted. Script should return either true or false.
 +
 
 +
* '''Redirect URL''' - Specify the URL the user should be redirected to following successful submission. NOTE: Redirects must be relative path (e.g. /wiki/index.php) rather than an absolute path (e.g. http://www.smartsimple.org/wiki/index.php).
 +
 
 +
* '''Visibility Condition''' - Any conditions used to control when the button is exposed.
 +
 
  
−
6) The Submit button will be listed in the Submit Buttons section.
+
5) Click '''Save''' once you have configured the Submit button.
  
−
[[Image:SubmitButton4.png|link=]]
 
  
−
7) You can now add [[Submit Logic]] against the individual buttons, tying specific submission rules to individual buttons and status changes.
+
6) The Submit button will be listed in the Submit Buttons section.<br />
 +
[[Image:Save_and_submit_button_list.png|link=|800px]]
  
 
==Tips==
 
==Tips==

Revision as of 09:45, 22 March 2016

Overview

SmartSimple offers the ability to define multiple submit buttons against individual statuses within a UTA.

The buttons can also be configured so that they are presented to subsets of users, perform certain validation checks and can push the event to a specific status.

Creating A Submit Button

To create a Submit Button:

1) Click the Settings tab within the UTA, then click on the Submit & Save Buttons link in either the Level 1 settings section, or Level 2 settings section.
Submit and save button1.png

2) The Submit & Save Buttons page is displayed.

3) Click on the + New Submit & Save button. Submit and save button+.png

4) You will be presented with a new window where you can configure the submit button.

This window includes the following settings:

  • Type - Options are Submit Button, Save Button and Save Draft Button. See Submit Logic on Save or Save Draft Buttons for further information.
  • Order - The order in which the button will appear on the screen, with lower numbers appearing further to the left of the screen.
  • Caption - the text used to identify a field.
  • Align to - Select the preferred alignment (Center, Left, Right).
  • From Status - The status of the entity before clicking on the button.
  • To Status - The status that the entity should be updated to after clicking on the button.
  • Bypass Validation - Flag to indicate that the status should change without the system performing all field validations. The Submit Logic on the button itself will still be validated.
  • SmartCheck Validation - Select the SmartCheck Validation validation method required.
  • Description - Definition and general description of the submit button. Will not be displayed.
  • Script - Call to any scripts that should be run in conjunction with this button. The system will check if the script is present before trying to run it. Submit button script must be formatted as functionName(this.form). Spaces are not permitted. Script should return either true or false.
  • Redirect URL - Specify the URL the user should be redirected to following successful submission. NOTE: Redirects must be relative path (e.g. /wiki/index.php) rather than an absolute path (e.g. http://www.smartsimple.org/wiki/index.php).
  • Visibility Condition - Any conditions used to control when the button is exposed.


5) Click Save once you have configured the Submit button.


6) The Submit button will be listed in the Submit Buttons section.
Save and submit button list.png

Tips

You can use URL to display a Web Page View as a confirmation page. Use the following syntax: @custom field name.value@

See Also

Retrieved from ‘https://wiki.smartsimple.com/index.php?title=Submit_%26_Save_Buttons&oldid=26154’