Difference between revisions of "User:Galford/Sidebar"

From SmartWiki
Jump to: navigation, search
(→‎No summary)
 
Line 1: Line 1:
−
{{ Banner-UnderConstruction }}
 
−
 
−
 
−
 
 
==Overview==
 
==Overview==
−
SmartSimple’s Tab Bar functionality allows a user to manage multiple tabs within the same instance of SmartSimple. 
+
This article covers the Application Connectivity Summary feature, including how to access it, how it is used, and an explanation of its various components.
−
 
 
  
−
In many use-cases, such as configuration, it is useful to create multiple tabs within a SmartSimple instance to simplify tasks. The tab bar feature allows you to run multiple tabs of a SmartSimple instance simultaneously within a single browser tab. In this way, the feature helps to improve productivity and user experience in SmartSimple.  You will also have the option to enable multitasking, which builds upon the previous split screen features, and allows one to display two tabs of SmartSimple within the same browser window, facilitating effortless side-by-side comparison. 
+
The Application Connectivity Summary diagram is used to help administrators visualize the layout of their SmartSimple system by rendering the consumer-provider relationship between all applications. This both helps promote a more profound understanding of the workings of a given SmartSimple instance, as well as serves as a  tool to aid in troubleshooting.
  
 +
'''Note''': You will need '''Global Administrator''' access to view or utilize the '''Application Connectivity Summary''' feature.
  
−
This article will show you how to setup and utilize SmartSimple’s Tab Bar functionality within your system.
 
−
 
−
<pre>Note: You will need Global Administrator access to enable the Tab Bar feature.</pre>
 
 
==Configuration—Essentials==
 
==Configuration—Essentials==
−
A typical external user is unable to edit list views, although they may select between varying list views to change their screen. Only users with the role of&nbsp;[[Global User Administrator|System Administrator]]&nbsp;are able to edit list views.&nbsp;
+
===How to view the Application Connectivity Summary:===
−
 
+
# Signed in as Global Administrator — Click on the '''Menu Icon''' (9 square grid button) [[File:Menu Icon.png|thumb|none|70px|Menu Icon]] 
−
'''Note:''' A '''Default '''List View should always remain in the system as a generic list of basic details, with no filter assigned to allow free searching. 
+
# Under the '''Configuration''' subsection, select '''Tracking Applications'''. [[File:Tracking Applications.png|thumb|none|170px|Tracking Applications]]
−
 
+
# In the upper left-hand corner, select '''Application Connectivity Summary''' button, this will display the Application Connectivity Summary Diagram.[[File:Application Connectivity Summary Button.png|thumb|none|220px|Application Connectivity Summary Button]] [[File:Application Connectivity Summary Diagram.png|thumb|none|520px|Application Connectivity Summary Diagram]]
−
===Giving Roles Access to the Tab Bar Feature===
 
−
To enable Tab Bar Access for users of your system based on their roles, you must be a Global Administrator. Consider which roles in your system should have access to the Tab Bar feature. In most cases, internal users such as staff or reviewers should be given Tab Bar access, while external users, such as applicants, don’t typically need to access this feature.&nbsp;
 
−
 
 
−
 
 
−
 
 
−
# Signed in as Global Administrator – Click on the Menu Icon (9 square grid button). [[File:Menu Icon.png|thumb|none|70px|Menu Icon]] 
 
−
# Under the "Configuration" sub-section, select "Global Settings." [[File:Global Settings.png|thumb|none|150px|Global Settings]]
 
−
# Go to the "Security" Tab. Then to "System Feature Permissions." [[File:Security Tab.png|thumb|none|100px|Security Tab]] [[File:System Feature Permissions.png|thumb|none|500px|System Feature Permissions]]
 
−
# Navigate to the “Feature Permission” Tab, and scroll down to “Enable Tab Bar Access.” Add the desired roles and click Save. [[File:Feature Permission Tab.png|thumb|none|150px|Feature Permission Tab]] [[File:Enable Tab Bar Access.png|thumb|none|275px|Enable Tab Bar Access]]
 
−
# Users must reload their page in their browser before they will see the Tab Bar option in their user menu. Alternately they can logout and log back in. You can reload the page by holding the control (CTRL) key (or the command key⌘ on Mac OS X) and pressing the F5 key on your keyboard.
 
−
 
 
−
 
 
−
===Giving Roles Access to the Tab Bar Feature===
 
−
If your role has been given access to use the Tab Bar Feature you can toggle this feature on or off. Utilizing Tab Bar functionality is beneficial if you wish to easily compare two separate records in your instance, or if you wish to configure settings and quickly view the results of your recent changes. If Tab Bar Access has previously been enabled for your role by your Global Administrator, then follow these steps to enable the tab bar functionality. If Tab Bar Access has not been previously enabled on your instance by your Global Administrator, follow the steps in the previous section.
 
−
 
 
−
 
 
−
'''To Enable:'''
 
−
 
 
−
# Go to the User Menu and under the “Actions” select “Enable Tab Bar.” (If you do not see this option, a Global Administrator will need to Enable Tab Bar access within your instance as outlined in the previous section. Contact your Global Administrator for assistance.) [[File:Enable Tab Bar User Menu.png|thumb|none|200px|Enable Tab Bar User Menu]]
 
−
# You can now add new tabs by pressing the New Tab button (signified by a plus sign) towards the bottom left corner of the browser window, and can close each tab with the “x” located on the right side of the tab.
 
−
# You can now have multiple tabs of SmartSimple open on a single instance, within a single browser tab. [[File:Tab Bar Active.png|thumb|none|350px|Tab Bar Active]]
 
  
 +
===How to use the Application Connectivity Summary:===
 +
# There are two views within the Application Connectivity Summary Diagram.  These are the '''UTA View''' and the '''Level View'''.                                                               
 +
# Ensure that '''UTA View''' is enabled by ensuring that it is selected from the '''View Dropdown''' on the right side of the action bar below the header. [[File:UTA View.png|thumb|none|200px|UTA View]]
 +
# Within UTA View, select the desired Universal Tracking Application (UTA) to view information about that specific UTA. Upon selecting a tracking application, a Properties Panel will appear on the right side of your screen. This will specify the object type, as well as list the UTAs which hold a consumer/provider relationship with this UTA (under '''Provides To''' and '''Consumes'''). Selecting an underlined linked UTA from the '''Provides To''' and '''Consumes''' lists will then open the details for the selected UTA in the Properties Panel. This will also select the UTA within the Application Summary Diagram to display its connections. [[File:Properties Panel.png|thumb|none|240px|Properties Panel]]
 +
# From within the Properties Panel, select the '''Edit Application Settings Button''' to open a modal window containing the UTA Settings for the selected UTA. This makes it easier to troubleshoot and make changes to the desired UTA.[[File:Edit Application Settings.png|thumb|none|170px|Edit Application Settings]]
 +
# Click the '''Show Details Toggle''' to show/hide the details of objects displayed in the Connectivity Summary Diagram. This includes the UTA Connection Roles, Consumer Creation Buttons, and Association Based Consumer Creation Buttons. [[File:Show Details Toggle.png|thumb|none|180px|Show Details Toggle]]
 +
# Change the '''View''' dropdown on the right side of the action bar to '''Level View''' in order to inspect the relationships between Level 1 and Level 2 Entities within a UTA. An example of such a use-case would be to inspect the relationship of a Review/Panel Manager's Level 1 Committee being consumed by a Submission/Application/Grant Manager's Level 1 Application. 
 +
# With the '''View''' dropdown set to '''Level View''', select the desired UTA Level. Upon selecting a Level Entity, the Properties Panel will appear on the right of your screen. This will specify the object type, as well as list the Level Entities which hold a consumer/provider relationship with this Level Entity (under '''Provides To''' and '''Consumes'''). Selecting an underlined linked Level Entity from the '''Provides To''' and '''Consumes''' lists will then open the details for the selected Level Entity in the Properties Panel. This will also select the Level Entity with the Application  Summary Diagram to display its connections.
 +
# From the Properties Panel on the right, select the '''Edit Connection Settings Button''' to open a modal window where you can configure Connections between Level Entities. 
  
−
'''To Disable:'''
 
−
 
−
# Go to the User Menu and select “Disable Tab Bar.”
 
−
 
−
 
−
'''How to use:'''
 
−
 
−
# Once the feature is enabled, you can now add new tabs by pressing the New Tab button (signified by a plus sign) towards the bottom left corner of the browser window.
 
−
# Select a tab to open the page from that tab. You can navigate SmartSimple within a given tab, change tabs and the tab will remain on the same page.
 
−
# You can also close each tab with the “x” located on the right side of the tab. This will return you to the previous tab that you had selected. If there is only one tab remaining, you will not be able to close this final tab but you can disable the Tab Bar feature. If this is the case, go to the User Menu and select “Disable Tab Bar.”
 
−
# The Tab Bar’s Multitask Button is ideal for comparing to records in your instance simultaneously, in split-screen view. This is ideal for users such as reviewers, who complete review forms while evaluating applications or if you want to see a user and their organization details side by side. You can access the Multitask Button while the Tab Bar is enabled, it is located on the right side of the tab bar. The two tabs shown in this mode will be the previous two tabs selected. You can select any tab to shift the what is displayed side by side. You can also use the arrows to move between tabs when you are in multitask mode. Select this button to toggle the functionality on and off.
 
  
  
 
==Settings Explained==
 
==Settings Explained==
−
{| class="contenttable" style="height: 170px;" border=".5" width="1208"
+
{| class="contenttable" style="height: 448px;" border=".1" width="1204"
 +
|-
 +
||'''Setting'''
 +
||'''Description'''                
 +
||'''Example'''
 +
|-
 +
||Show Details Toggle
 +
||The Show Details toggle displays the details of objects displayed in the Connectivity Summary Diagram. This includes the UTA Connection Roles, Consumer Creation Buttons, and Association Based Consumer Creation Buttons.
 +
||[[File:Show Details Toggle.png|thumb|none|170px|Show Details Toggle]]
 +
|-
 +
||UTA View
 +
||The Universal Tracking Application (UTA) View displays all UTAs within your instance and the Consumer/Provider relationship between them (signified by the directional arrows).
 +
||[[File:UTA View.png|thumb|none|250px|UTA View]]
 
|-
 
|-
−
||Setting
+
||Level View
−
||Description                
+
||The Level View shows all Level 1, 2, and 3 entities and the Consumer/Provider relationships between them (signified by the directional arrows).
−
||Example
+
||[[File:Level View Dropdown.png|thumb|none|250px|Level View]]
 
|-
 
|-
−
||New Tab Button
+
||Properties Panel
−
||This button is used to create a new tab. Upon pressing this button, a new tab will open, which can be found in the tab bar at the bottom of the screen.
+
||Upon selecting a desired UTA or UTA Level in the diagram, the Properties Panel will appear on the right side of your screen. This panel displays the object type for the object you have selected, as well as a list of what it consumes and/or provides. Also featured within the panel is the Edit Settings Button as well as the Focus Button.
−
||[[File:New Tab Resized.png|thumb|none|110px|The New Tab Button]]
+
||[[File:Properties Panel.png|thumb|none|200px|Properties Panel]]
 
|-
 
|-
−
||Tabs
+
||Edit Application Settings Button
−
||Select a tab to open the page from that tab.
+
||The Edit Application Settings Button opens a modal window containing the UTA Settings for the selected UTA. This is convenient for troubleshooting and configuration.
−
||[[File:Tab Bar Resized.png|thumb|none|300px|The Tab Bar]]
+
||[[File:Edit Application Settings.png|thumb|none|200px|Edit Application Settings Button]]
 
|-
 
|-
−
||Multitask Button
+
||Focus Button
−
||The Multitask Button is used to allow for split-screen viewing of two tabs at a time. The two tabs shown in this mode will be the last two tabs selected. Select this button to toggle the functionality on and off. 
+
||The Focus Button is used to narrow the view of the Connectivity Summary Diagram to just the selected UTA/Level Entity and its relevant Consumer/Providers. This makes it easier to see the connections of the selected entity by hiding non related entities. Making it easier to troubleshoot connectivity issues.
−
||[[File:Multitask Button.png|thumb|none|110px|The Multitask Button]]
+
||[[File:Focus Button.png|thumb|none|90px|Focus Button]]
 
|-
 
|-
−
||Close Tab Button
+
||Edit Connection Settings Button
−
||The Close Tab Button is used to close a tab from the tab bar which you do not wish to use anymore. Upon selecting, the selected tab will close, and you will be returned to the previous tab which you were viewing.
+
||The Edit Connection Settings Button opens a modal window containing the Connection Settings for the selected Level 1,2, or 3 Entity. This is convenient for troubleshooting and configuration.
−
||[[File:Close Tab Button.png|thumb|none|110px|The Close Tab Button]]
+
||[[File:Edit Connection Settings.png|thumb|none|200px|Edit Connection Settings Button]]
 
|}
 
|}

Latest revision as of 11:20, 7 October 2019

Overview

This article covers the Application Connectivity Summary feature, including how to access it, how it is used, and an explanation of its various components.

The Application Connectivity Summary diagram is used to help administrators visualize the layout of their SmartSimple system by rendering the consumer-provider relationship between all applications. This both helps promote a more profound understanding of the workings of a given SmartSimple instance, as well as serves as a  tool to aid in troubleshooting.

Note: You will need Global Administrator access to view or utilize the Application Connectivity Summary feature.

Configuration—Essentials

How to view the Application Connectivity Summary:

  1. Signed in as Global Administrator — Click on the Menu Icon (9 square grid button) 
    Menu Icon
     
  2. Under the Configuration subsection, select Tracking Applications. 
    Tracking Applications
  3. In the upper left-hand corner, select Application Connectivity Summary button, this will display the Application Connectivity Summary Diagram.
    Application Connectivity Summary Button
    Application Connectivity Summary Diagram

How to use the Application Connectivity Summary:

  1. There are two views within the Application Connectivity Summary Diagram.  These are the UTA View and the Level View.                                                               
  2. Ensure that UTA View is enabled by ensuring that it is selected from the View Dropdown on the right side of the action bar below the header. 
    UTA View
  3. Within UTA View, select the desired Universal Tracking Application (UTA) to view information about that specific UTA. Upon selecting a tracking application, a Properties Panel will appear on the right side of your screen. This will specify the object type, as well as list the UTAs which hold a consumer/provider relationship with this UTA (under Provides To and Consumes). Selecting an underlined linked UTA from the Provides To and Consumes lists will then open the details for the selected UTA in the Properties Panel. This will also select the UTA within the Application Summary Diagram to display its connections.
    Properties Panel
  4. From within the Properties Panel, select the Edit Application Settings Button to open a modal window containing the UTA Settings for the selected UTA. This makes it easier to troubleshoot and make changes to the desired UTA.
    Edit Application Settings
  5. Click the Show Details Toggle to show/hide the details of objects displayed in the Connectivity Summary Diagram. This includes the UTA Connection Roles, Consumer Creation Buttons, and Association Based Consumer Creation Buttons.
    Show Details Toggle
  6. Change the View dropdown on the right side of the action bar to Level View in order to inspect the relationships between Level 1 and Level 2 Entities within a UTA. An example of such a use-case would be to inspect the relationship of a Review/Panel Manager's Level 1 Committee being consumed by a Submission/Application/Grant Manager's Level 1 Application. 
  7. With the View dropdown set to Level View, select the desired UTA Level. Upon selecting a Level Entity, the Properties Panel will appear on the right of your screen. This will specify the object type, as well as list the Level Entities which hold a consumer/provider relationship with this Level Entity (under Provides To and Consumes). Selecting an underlined linked Level Entity from the Provides To and Consumes lists will then open the details for the selected Level Entity in the Properties Panel. This will also select the Level Entity with the Application  Summary Diagram to display its connections.
  8. From the Properties Panel on the right, select the Edit Connection Settings Button to open a modal window where you can configure Connections between Level Entities. 


Settings Explained

Setting Description                 Example
Show Details Toggle The Show Details toggle displays the details of objects displayed in the Connectivity Summary Diagram. This includes the UTA Connection Roles, Consumer Creation Buttons, and Association Based Consumer Creation Buttons.
Show Details Toggle
UTA View The Universal Tracking Application (UTA) View displays all UTAs within your instance and the Consumer/Provider relationship between them (signified by the directional arrows).
UTA View
Level View The Level View shows all Level 1, 2, and 3 entities and the Consumer/Provider relationships between them (signified by the directional arrows).
Level View
Properties Panel Upon selecting a desired UTA or UTA Level in the diagram, the Properties Panel will appear on the right side of your screen. This panel displays the object type for the object you have selected, as well as a list of what it consumes and/or provides. Also featured within the panel is the Edit Settings Button as well as the Focus Button.
Properties Panel
Edit Application Settings Button The Edit Application Settings Button opens a modal window containing the UTA Settings for the selected UTA. This is convenient for troubleshooting and configuration.
Edit Application Settings Button
Focus Button The Focus Button is used to narrow the view of the Connectivity Summary Diagram to just the selected UTA/Level Entity and its relevant Consumer/Providers. This makes it easier to see the connections of the selected entity by hiding non related entities. Making it easier to troubleshoot connectivity issues.
Focus Button
Edit Connection Settings Button The Edit Connection Settings Button opens a modal window containing the Connection Settings for the selected Level 1,2, or 3 Entity. This is convenient for troubleshooting and configuration.
Edit Connection Settings Button
Retrieved from ‘https://wiki.smartsimple.com/index.php?title=User:Galford/Sidebar&oldid=37141’