Smartstaff
2,271
edits
Changes
Created page with "=Overview= The “Special - Button” custom field allows you to add configurable buttons that, when clicked, can open pages in the same window, a new tab, or in a modal windo..."
=Overview=
The “Special - Button” custom field allows you to add configurable buttons that, when clicked, can open pages in the same window, a new tab, or in a modal window. Previously, to replicate this functionality, system administrators had to create a “Special - Browser Script” custom field that was used to open other platform pages.
As an example, you could create a button on a Level 1 record (such as a grant) to open the assignment grid, edit a user’s organization profile, or even create a new Level 2. You can also define how you want the content to open.
[[File:158590-button-open-modal.png|thumb|none|800px| In this configuration, a user profile opens in a modal window when a “Special - Button” custom field is clicked.]]
=Configuration=
==Creating a New Special Button==
# Go to '''UTA Configuration Settings''' > '''Level 1''' tab >''' Custom Fields''' > Click the plus button to create a new custom field
# Under the '''Field Type''' dropdown, select the new option called “Special - Button”.
# Enter a '''Caption''' if desired.
# For the '''URL''' field, click the binoculars icon to look up a specific URL. For example, if we wanted to create a button that allowed users to edit their profile, we would select “People” for the '''Object Type''' and “Edit My Profile” for the '''Action'''. When you are happy with the object selection, click '''Apply'''. The URL field will be populated with a relative path to the selected object. <u>'''Note'''</u>: You can also enter relative paths to other areas of the system such as the assignment grid.
# Next, for the '''Open in''' field, select how the URL object should open when the button is clicked. For example, select “Modal Window” if you want the object to open in a window above your current content so you do not lose context. Select “New Tab” if you want the content to open in a new tab within the '''Tab Bar''' at the bottom of the page.
# (Optional) If you wish to display a custom message to the user who clicks this button, enter any relevant text under '''Confirmation Message'''. This message will be displayed to the user when they click the button but before they are shown the object. For example if clicking the button will navigate the user to another area of the system, you might want to warn them first in case they have unsaved changes on the current page.
# Under the “Display” section, you select how the button should be displayed to the user. For example, if you don’t want to display a '''Caption''' to the left of the button, select “No Caption” under '''Caption Location'''. This will display just the button aligned to the left of the record.
# For '''Button Label''', enter the text that you wish to appear on the button (Example: “Edit my profile”).
# (Optional) Select an Icon and an''' Icon Style''' if needed. Icons will be displayed to the left of the button label text.
# (Optional) If users need additional help or context around the button, you can enter text under''' Tool Tip''' or '''Instructions'''.
# (Optional) Navigate to the '''Permissions & Availability''' tab to set permissions for this button.
# Click '''Save'''.
The “Special - Button” custom field allows you to add configurable buttons that, when clicked, can open pages in the same window, a new tab, or in a modal window. Previously, to replicate this functionality, system administrators had to create a “Special - Browser Script” custom field that was used to open other platform pages.
As an example, you could create a button on a Level 1 record (such as a grant) to open the assignment grid, edit a user’s organization profile, or even create a new Level 2. You can also define how you want the content to open.
[[File:158590-button-open-modal.png|thumb|none|800px| In this configuration, a user profile opens in a modal window when a “Special - Button” custom field is clicked.]]
=Configuration=
==Creating a New Special Button==
# Go to '''UTA Configuration Settings''' > '''Level 1''' tab >''' Custom Fields''' > Click the plus button to create a new custom field
# Under the '''Field Type''' dropdown, select the new option called “Special - Button”.
# Enter a '''Caption''' if desired.
# For the '''URL''' field, click the binoculars icon to look up a specific URL. For example, if we wanted to create a button that allowed users to edit their profile, we would select “People” for the '''Object Type''' and “Edit My Profile” for the '''Action'''. When you are happy with the object selection, click '''Apply'''. The URL field will be populated with a relative path to the selected object. <u>'''Note'''</u>: You can also enter relative paths to other areas of the system such as the assignment grid.
# Next, for the '''Open in''' field, select how the URL object should open when the button is clicked. For example, select “Modal Window” if you want the object to open in a window above your current content so you do not lose context. Select “New Tab” if you want the content to open in a new tab within the '''Tab Bar''' at the bottom of the page.
# (Optional) If you wish to display a custom message to the user who clicks this button, enter any relevant text under '''Confirmation Message'''. This message will be displayed to the user when they click the button but before they are shown the object. For example if clicking the button will navigate the user to another area of the system, you might want to warn them first in case they have unsaved changes on the current page.
# Under the “Display” section, you select how the button should be displayed to the user. For example, if you don’t want to display a '''Caption''' to the left of the button, select “No Caption” under '''Caption Location'''. This will display just the button aligned to the left of the record.
# For '''Button Label''', enter the text that you wish to appear on the button (Example: “Edit my profile”).
# (Optional) Select an Icon and an''' Icon Style''' if needed. Icons will be displayed to the left of the button label text.
# (Optional) If users need additional help or context around the button, you can enter text under''' Tool Tip''' or '''Instructions'''.
# (Optional) Navigate to the '''Permissions & Availability''' tab to set permissions for this button.
# Click '''Save'''.
