Difference between revisions of "Submit & Save Buttons"

From SmartWiki
Jump to: navigation, search
(→‎Tips)
 
(37 intermediate revisions by 6 users not shown)
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==
 
−
 
−
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.
 
−
 
−
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.
 
−
 
 
−
[[Image:SubmitButton2.png|link=]]
 
−
 
 
−
4) You will be presented with a new window in which to configure the submit button.
 
  
−
[[Image:SubmitButtonsMay2014.png|link=]]
+
=Configuration - Essentials=
 +
==Create a Submit Button==
 +
To create a Submit Button:
  
−
This window includes the following settings:
+
# Navigate to the UTA which you'd like to add your Submit button to.
−
* '''Order''' - the order in which the button will appear on the screen, with lower numbers appearing further to the left of the screen.
+
# Click the '''Configuration Settings''' button within the UTA.
−
* '''Type''' - Options are ''Submit Button'', ''Save Button'' and ''Save Draft Button''. See [[Submit Logic on Save or Save Draft Buttons]] for further information.
+
# If you'd like to add a submit button to a Level 1 entity, select the second tab, which contains your Level 1 settings. If you'd like to add a submit button to a Level 2 Entity, select the third tab, which contains your Level 2 settings, and so on.
−
* '''Label''' - the text that will appear on the button when exposed to end users.
+
# Click on the '''Submit & Save Buttons''' link under the '''General Settings''' header.<br /> [[Image:SubmitAndSaveButtonUTA.png|750px]]
−
* '''Submit Status''' - the status that the entity should be updated to after clicking on the button.
+
# The '''Submit & Save Buttons''' page is displayed.
−
* '''[[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.
+
# Click on the '''New Submit & Save Button''' button, signified by the '''+''' sign. <br /> [[Image:NewSubmitButton.png|300px]]
−
* '''Description''' - descriptive text.
+
# You will be presented with a new window, titled '''New Submit & Save Button''' where you can configure the submit button. View the section below for a detailed explanation of each setting.
−
* '''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'''.
+
# Once you have configured the Submit button to your liking, click '''Save'''.
−
:'''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.
+
# The submit button you have created will now be listed in the Submit Buttons section.
−
* '''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.
+
===New Submit & Save Button Page - Settings===
 +
The '''New Submit & Save Button''' page includes the following settings:
  
−
6) The Submit button will be listed in the Submit Buttons section.
+
{| class="wikitable"
 +
|-
 +
!|Setting
 +
!|Description
 +
|-
 +
||'''Type'''
 +
||Type options include Submit Button, Save & Validate Button, Save Draft Button, and Submit Annotation. See Submit Logic on Save or Save Draft Buttons for further information.
 +
|-
 +
||'''Order'''
 +
||This is the order in which the button will appear on the screen, with lower numbers appearing further to the left of the screen.
 +
|-
 +
||'''Caption'''
 +
||This is the text that will appear on the button. Typically, you would name the button after the action that is triggered by the button. Example: If a button sends applications into Approved status, we will give it the caption "Approved".
 +
|-
 +
||'''Icon Style'''
 +
||These are the various groups of icons including '''Brands''', which features brand logos, '''Light''', which contains outline-style icons with light line weights, '''Regular''', which includes outline-style icons with heavier line weights, and '''Solid''', which includes monochromatic glyphs with solid fills.
 +
|-
 +
||'''Icon'''
 +
||Graphic icons can be featured on Submit & Save button to clarify and reiterate the purpose of the button. Simply select the icon group using the '''Icon Style''' dropdown, and then use the '''Icon''' dropdown to select the desired icon.
 +
|-
 +
||'''Description'''
 +
||Definition and general description of the submit button. This will not be displayed on the button.
 +
|-
 +
||'''Align to'''
 +
||Select the preferred alignment of the button at the bottom of the window (Center, Left, Right).
 +
|-
 +
||'''Available to Status'''
 +
||The statuses in which the button will appear. This will be the status that the record is in before being submitted to the subsequent status that the button directs to.
 +
|-
 +
||'''Submit to Status'''
 +
||This is the status that the entity should be updated to after clicking on the button. Use this dropdown to select the destination status of the submit button.
 +
|-
 +
||'''SmartCheck Validation'''
 +
||Select the [[SmartCheck Validation]] method required for the button. This is used to attach custom validation conditions to this button, prohibiting users from proceeding without meeting the custom [[SmartCheck Validation]] conditions specified.
 +
|-
 +
||'''Bypass Field Validation'''
 +
||Flag to indicate that the status should change without the system performing all field validations (bypassing fields marked as Mandatory). The Submit Logic on the button itself will still be validated.
 +
|-
 +
||'''Custom Script'''
 +
||Include any custom scripts here that will be executed when the button is clicked.
 +
|-
 +
||'''Enable Confirmation Alert Message'''
 +
||Toggle this on to enable an alert message which appears when clicking the button, asking the user if they are sure that they would like to proceed.
 +
|-
 +
||'''Confirmation Message'''
 +
||This field only appears if a Confirmation Alert Message are enabled. Here, enter the messaging that you would like to appear on the alert message.
 +
|-
 +
||'''Enable Confirmation Page'''
 +
||Toggle this on to create a Confirmation Page which the user is directed to after clicking the submit button. The contents of this page are determined by the subsequent options which appear.
 +
|-
 +
||'''Title'''
 +
||This field only appears if the Confirmation Page is enabled. The title specified here will be the title which appears at the top of the Confirmation Page.
 +
|-
 +
||'''Message'''
 +
||This field only appears if the Confirmation Page is enabled. The message specified here will be the body content of the Confirmation Page.
 +
|-
 +
||'''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).
 +
|-
 +
||'''Button Caption'''
 +
||This field only appears if the Confirmation Page is enabled. The caption specified here will be included on the button which is featured on the Confirmation Page. Typically, this would be a link back to the user's home portal.
 +
|-
 +
||'''Button Icon Style'''
 +
||This field only appears if the Confirmation Page is enabled. This determined the style of the icon included in the button featured on the Confirmation Page. These are the various groups of icons including '''Brands''', which features brand logos, '''Light''', which contains outline-style icons with light line weights, '''Regular''', which includes outline-style icons with heavier line weights, and '''Solid''', which includes monochromatic glyphs with solid fills.
 +
|-
 +
||'''Button Icon'''
 +
||This field only appears if the Confirmation Page is enabled. Icons selected from this dropdown will be included in the button featured on the Confirmation Page.
 +
|-
 +
||'''Redirect Payment Form'''
 +
||If you have a payment integration form configured, like a Stripe integration form, selecting it from this dropdown will assign it as the destination for users who have clicked this button.  
 +
|}
  
−
[[Image:SubmitButton4.png|link=]]
+
===Permissions & Availability Settings===
 +
The '''New Submit & Save Button''' page, '''Permissions & Availability''' tab includes the following settings:
  
−
7) You can now add [[Submit Logic]] against the individual buttons, tying specific submission rules to individual buttons and status changes.
+
{| class="wikitable"
 +
|-
 +
!|Setting
 +
!|Description
 +
|-
 +
||'''Role - Permissions'''
 +
||Specify which roles have access to the button. Toggling on '''Use UTA Role''' will include role-based permissions for users assigned in UTA Roles.
 +
|-
 +
||'''Type - Availability'''
 +
||Specify which record types the button will appear on.
 +
|-
 +
||'''Visibility Condition'''
 +
||Enter custom visibility conditions for the button here.
 +
|-
 +
||'''On New Record'''
 +
||define how the Submit Button will be displayed on a new record. Options include '''"Always Display", "Hide on New Record", "Only Show on New Record"'''.
 +
|}
  
−
==Tips==
+
==Notes==
−
You can use '''URL''' to display a [[Custom_Field_Type:_Display_Only_–_Web_Page_View|Web Page View]] as a confirmation page. Use the following syntax: @''custom field name''.value@
+
The Submit Annotation type button will only appear on the record if it is under Status lock. This button type is used to submit field modifications and will stamp the revision log with changes.
  
 
==See Also==
 
==See Also==
Line 52: Line 125:
 
* [[savefunc]] or [[sbfunc]]
 
* [[savefunc]] or [[sbfunc]]
 
* [[Obtain Server Date and Time]]
 
* [[Obtain Server Date and Time]]
 +
* [[Field Permissions]]
 
* [[Custom Save and Save Draft Buttons]]
 
* [[Custom Save and Save Draft Buttons]]
  
−
[[Category:Universal Tracking Application]][[Category:Validation]]
+
[[Category:Universal Tracking Application]][[Category:Validation]][[Category:Process Flow]]

Latest revision as of 12:54, 15 October 2021

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.

Configuration - Essentials

Create a Submit Button

To create a Submit Button:

  1. Navigate to the UTA which you'd like to add your Submit button to.
  2. Click the Configuration Settings button within the UTA.
  3. If you'd like to add a submit button to a Level 1 entity, select the second tab, which contains your Level 1 settings. If you'd like to add a submit button to a Level 2 Entity, select the third tab, which contains your Level 2 settings, and so on.
  4. Click on the Submit & Save Buttons link under the General Settings header.
    SubmitAndSaveButtonUTA.png
  5. The Submit & Save Buttons page is displayed.
  6. Click on the New Submit & Save Button button, signified by the + sign.
    NewSubmitButton.png
  7. You will be presented with a new window, titled New Submit & Save Button where you can configure the submit button. View the section below for a detailed explanation of each setting.
  8. Once you have configured the Submit button to your liking, click Save.
  9. The submit button you have created will now be listed in the Submit Buttons section.

New Submit & Save Button Page - Settings

The New Submit & Save Button page includes the following settings:

Setting Description
Type Type options include Submit Button, Save & Validate Button, Save Draft Button, and Submit Annotation. See Submit Logic on Save or Save Draft Buttons for further information.
Order This is the order in which the button will appear on the screen, with lower numbers appearing further to the left of the screen.
Caption This is the text that will appear on the button. Typically, you would name the button after the action that is triggered by the button. Example: If a button sends applications into Approved status, we will give it the caption "Approved".
Icon Style These are the various groups of icons including Brands, which features brand logos, Light, which contains outline-style icons with light line weights, Regular, which includes outline-style icons with heavier line weights, and Solid, which includes monochromatic glyphs with solid fills.
Icon Graphic icons can be featured on Submit & Save button to clarify and reiterate the purpose of the button. Simply select the icon group using the Icon Style dropdown, and then use the Icon dropdown to select the desired icon.
Description Definition and general description of the submit button. This will not be displayed on the button.
Align to Select the preferred alignment of the button at the bottom of the window (Center, Left, Right).
Available to Status The statuses in which the button will appear. This will be the status that the record is in before being submitted to the subsequent status that the button directs to.
Submit to Status This is the status that the entity should be updated to after clicking on the button. Use this dropdown to select the destination status of the submit button.
SmartCheck Validation Select the SmartCheck Validation method required for the button. This is used to attach custom validation conditions to this button, prohibiting users from proceeding without meeting the custom SmartCheck Validation conditions specified.
Bypass Field Validation Flag to indicate that the status should change without the system performing all field validations (bypassing fields marked as Mandatory). The Submit Logic on the button itself will still be validated.
Custom Script Include any custom scripts here that will be executed when the button is clicked.
Enable Confirmation Alert Message Toggle this on to enable an alert message which appears when clicking the button, asking the user if they are sure that they would like to proceed.
Confirmation Message This field only appears if a Confirmation Alert Message are enabled. Here, enter the messaging that you would like to appear on the alert message.
Enable Confirmation Page Toggle this on to create a Confirmation Page which the user is directed to after clicking the submit button. The contents of this page are determined by the subsequent options which appear.
Title This field only appears if the Confirmation Page is enabled. The title specified here will be the title which appears at the top of the Confirmation Page.
Message This field only appears if the Confirmation Page is enabled. The message specified here will be the body content of the Confirmation Page.
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).
Button Caption This field only appears if the Confirmation Page is enabled. The caption specified here will be included on the button which is featured on the Confirmation Page. Typically, this would be a link back to the user's home portal.
Button Icon Style This field only appears if the Confirmation Page is enabled. This determined the style of the icon included in the button featured on the Confirmation Page. These are the various groups of icons including Brands, which features brand logos, Light, which contains outline-style icons with light line weights, Regular, which includes outline-style icons with heavier line weights, and Solid, which includes monochromatic glyphs with solid fills.
Button Icon This field only appears if the Confirmation Page is enabled. Icons selected from this dropdown will be included in the button featured on the Confirmation Page.
Redirect Payment Form If you have a payment integration form configured, like a Stripe integration form, selecting it from this dropdown will assign it as the destination for users who have clicked this button.

Permissions & Availability Settings

The New Submit & Save Button page, Permissions & Availability tab includes the following settings:

Setting Description
Role - Permissions Specify which roles have access to the button. Toggling on Use UTA Role will include role-based permissions for users assigned in UTA Roles.
Type - Availability Specify which record types the button will appear on.
Visibility Condition Enter custom visibility conditions for the button here.
On New Record define how the Submit Button will be displayed on a new record. Options include "Always Display", "Hide on New Record", "Only Show on New Record".

Notes

The Submit Annotation type button will only appear on the record if it is under Status lock. This button type is used to submit field modifications and will stamp the revision log with changes.

See Also

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