Difference between revisions of "Submit & Save Buttons"

From SmartWiki
Jump to: navigation, search
Line 32: Line 32:
 
||This is the order in which the button will appear on the screen, with lower numbers appearing further to the left of the screen.
 
||This is the order in which the button will appear on the screen, with lower numbers appearing further to the left of the screen.
 
|-
 
|-
−
||Exclude Foundation(s)
+
||'''Caption'''
−
||Only available with IRS verification service. Select foundations types you want to exclude from the search, then click the Exclude foundation button which looks like +. Example some people may wish to exclude religious organizations such as churches so they select 10 – Church 170(b)(1)(A)(i) and click exclude foundation button.
+
||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.
 +
|-
 +
||'''Description'''
 +
||Definition and general description of the submit button. This will not be displayed on the button.
 
|}
 
|}
  

Revision as of 10:15, 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.

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 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.
Description Definition and general description of the submit button. This will not be displayed on the button.
  • Type - Options are Submit Button, Save Button, Save Draft Button, and Submit Annotation. 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. Will have an adjacent Select Icon button to allow icons to be included on the button.
  • 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.
  • On New Record - define how the Submit Button will be displayed on a new record. Options "Always Display", "Hide on New Record", "Only Show on New Record".


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 listview.png

Field Permissions

Submit and Save buttons can be configured to control when a button is visible or not visible based on Type - Field Permissions and Role - Field Permissions using the Allow View and Deny View settings.

Notes

You can use the URL to display a 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

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