Difference between revisions of "User Guide"
(Created page with "== Entities == Also known as "tables", entities are specific groups of information in the database, with records (rows) and fields (columns). Examples include Contacts, Sourc...") |
|||
Line 1: | Line 1: | ||
− | + | Use this document to get started quickly with HS. | |
− | |||
− | == | + | == Logging In == |
+ | |||
+ | Access to your HS instance is done using your favorite browser, and navigating to: | ||
+ | |||
+ | <nowiki>https://yourdomain.com/admin</nowiki> | ||
+ | |||
+ | This entry point is usually protected by two-factor authentication. | ||
+ | |||
+ | === Server Access === | ||
+ | Your browser may prompt you with a pop-up box asking for server credentials (username and password). | ||
+ | |||
+ | [[File:QS_Browser_login.png|300px]] | ||
+ | |||
+ | This is the first level of security to your database. Normally, the same credentials are used here by all of the HS users in your organization. Check with your HS administrator to gain this information. If you are on a trusted computer, have the browser save this information for you so you won't have to enter it again in the future. | ||
+ | |||
+ | === Your Personal HS Login === | ||
+ | Next you'll see the main HS login screen, which should look something like this: | ||
+ | |||
+ | [[File:QS_login_page.png|480px]] | ||
+ | |||
+ | Enter your personal credentials here to login to HS. If you don't have a personal login, see your HS administrator. | ||
+ | |||
+ | Note: for future quick access to HS, bookmark your ''home screen'' in your browser after logging in, not the login screen. This will save you time if you're already logged in. | ||
+ | |||
+ | If your credentials are rejected, you'll see a Forgot Password link to reset your password if necessary, based on your valid email address. | ||
+ | |||
+ | == HS Overview == | ||
+ | |||
+ | Your HS System is comprised of database tables, software tools, and reports and graphs for analytics. Access your data by navigating to your desired place of interest or work function, using the menu system and/or the navigation bar. | ||
+ | |||
+ | == Navigating HS == | ||
+ | |||
+ | Use the navigation bar to jump quickly to a commonly used screen: | ||
+ | |||
+ | [[File:QS_Nav_bar.png|600px]] | ||
+ | |||
+ | If you're not sure about the meaning of any icon, move your cursor over it and a description will be displayed. | ||
+ | |||
+ | Or, navigate your menus by clicking on the desired option. | ||
+ | |||
+ | == Tables == | ||
+ | |||
+ | All of your information in HS is stored in database tables on your production web server. For example, the Contacts table is the heart of your database and contains a record for every person or organization that you have a business relationship with, whether they are customers or donors, active followers, cultivation targets, or marketing leads. | ||
+ | |||
+ | Other examples of tables in HS include Donations/Payments, Source Codes, Contact Tags, Products, and Subscriptions. | ||
+ | |||
+ | Your data is accessed directly through two types of screens: Summary Screens and Detail Screens, both of which are designed to have the same, easy-to-use, intuitive user experience. | ||
+ | |||
+ | === Summary Screens === | ||
+ | |||
+ | When navigating to an HS table without specifying a specific record, a Summary Screen will be displayed. | ||
+ | |||
+ | This screen is designed to help you find the record or records you are looking for, and is '''not''' a report, although it may appear like one. | ||
+ | |||
+ | It has a set of common functions available to you to help you in your search. | ||
+ | |||
+ | [[File:QS_Summary_screen.png|800px]] | ||
+ | |||
+ | |||
+ | ==== Filters ==== | ||
+ | These pulldown menus will limit the Summary Screen to display only those records which have the value of the filter selected. If multiple filters are used, the records must match '''all''' of the filter values chosen. Use the reset button to clear all filters when desired. | ||
+ | |||
+ | ==== Search Box ==== | ||
+ | This is a search-as-you-type box, that will search the table you are viewing by any number of fields. As matches are found, they will be displayed automatically, allowing you to use your down-arrow key or mouse to select the record you're looking for. | ||
+ | |||
+ | [[File:QS_Search_box.png|300px]] | ||
+ | |||
+ | The first matching record found is always highlighted by default. | ||
+ | |||
+ | '''Note:''' Don't hit the return key until the record you are looking for is highlighted. If no list is shown, that means no records have been found that match your search input. | ||
+ | |||
+ | '''Note:''' For very large tables, there might be a slight delay before matching records are displayed, but you shouldn't have to wait more than a second or two in any case. | ||
+ | |||
+ | ==== Paging ==== | ||
+ | Use the Page control buttons to navigate to specific pages of your Summary. | ||
+ | |||
+ | '''Note:''' The number of records displayed on each page may be changed in your Personal Settings. | ||
+ | |||
+ | ==== Sorting ==== | ||
+ | You may click on any column heading to sort the records shown by that column, by ascending value. Clicking a second time will sort by descending value. Clicking a third time will remove the sort and revert to the default sorting for that table. Use the reset button to reset all filters and sorting to their default values. | ||
+ | |||
+ | ==== Exporting ==== | ||
+ | If you have proper access privileges, the export button allows you to download the entire Summary of all records to a csv file on your computer. Filters and sorting apply, and only the columns shown on your screen will be included in the export. | ||
+ | |||
+ | === Detail Screens === | ||
+ | Once you've selected a specific record, either by clicking through on the first column value of your Summary Screen, or by using the Search Box, you will bring up the Detail Screen for that record in the table. | ||
+ | |||
+ | The Detail Screen allows you to view and/or edit a specific record in the table. | ||
+ | |||
+ | [[File:QS_Detail_Screen.png|800px]] | ||
+ | |||
+ | You must submit your changes before they are stored in the database, either by hitting a return on any text field, or by clicking the Save Changes button. | ||
+ | |||
+ | '''Note:''' The Search Box remains active at the top of your Detail Screen, so you don't need to go back to the Summary Screen to find a different record by that method. | ||
+ | |||
+ | ==== Field Help Text ==== | ||
+ | |||
+ | If you see a blue question mark next to a field label, there is help text available. View it by hovering over or clicking on the blue question mark. | ||
+ | |||
+ | [[File:QS_help.png|225px]] | ||
+ | |||
+ | ==== Refresh Data ==== | ||
+ | |||
+ | If you need to refresh your Detail Screen for any reason, simply click on the record heading link. | ||
+ | |||
+ | [[File:QS_refresh.png|300px]] | ||
+ | |||
+ | '''Note:''' Clicking here will abandon any changes made that have not already been saved. | ||
+ | |||
+ | ==== The Actions Menu ==== | ||
+ | For most tables, an actions pulldown menu is available to the right of the record header, allowing you to perform functions specific to that table on that record. | ||
+ | |||
+ | [[File:QS_action.png|600px]] | ||
+ | |||
+ | ==== Multi-valued Fields ==== | ||
+ | Data fields that may have multiple values are shown on the right-hand portion of the Detail Screen, if there are any. In this section you can add new values, or delete existing ones for that record. | ||
+ | |||
+ | [[File:QS_Multivalues.png|450px]] | ||
+ | |||
+ | Changing these values is done by deleting the value, and then adding the correct value afterward. | ||
+ | |||
+ | To delete a value, check the delete box to the right and click Save Changes. | ||
+ | |||
+ | == Company Settings and Administration == | ||
== Reports == | == Reports == | ||
== Graphs == | == Graphs == |
Revision as of 11:04, 4 February 2022
Use this document to get started quickly with HS.
Logging In
Access to your HS instance is done using your favorite browser, and navigating to:
https://yourdomain.com/admin
This entry point is usually protected by two-factor authentication.
Server Access
Your browser may prompt you with a pop-up box asking for server credentials (username and password).
This is the first level of security to your database. Normally, the same credentials are used here by all of the HS users in your organization. Check with your HS administrator to gain this information. If you are on a trusted computer, have the browser save this information for you so you won't have to enter it again in the future.
Your Personal HS Login
Next you'll see the main HS login screen, which should look something like this:
Enter your personal credentials here to login to HS. If you don't have a personal login, see your HS administrator.
Note: for future quick access to HS, bookmark your home screen in your browser after logging in, not the login screen. This will save you time if you're already logged in.
If your credentials are rejected, you'll see a Forgot Password link to reset your password if necessary, based on your valid email address.
HS Overview
Your HS System is comprised of database tables, software tools, and reports and graphs for analytics. Access your data by navigating to your desired place of interest or work function, using the menu system and/or the navigation bar.
Use the navigation bar to jump quickly to a commonly used screen:
If you're not sure about the meaning of any icon, move your cursor over it and a description will be displayed.
Or, navigate your menus by clicking on the desired option.
Tables
All of your information in HS is stored in database tables on your production web server. For example, the Contacts table is the heart of your database and contains a record for every person or organization that you have a business relationship with, whether they are customers or donors, active followers, cultivation targets, or marketing leads.
Other examples of tables in HS include Donations/Payments, Source Codes, Contact Tags, Products, and Subscriptions.
Your data is accessed directly through two types of screens: Summary Screens and Detail Screens, both of which are designed to have the same, easy-to-use, intuitive user experience.
Summary Screens
When navigating to an HS table without specifying a specific record, a Summary Screen will be displayed.
This screen is designed to help you find the record or records you are looking for, and is not a report, although it may appear like one.
It has a set of common functions available to you to help you in your search.
Filters
These pulldown menus will limit the Summary Screen to display only those records which have the value of the filter selected. If multiple filters are used, the records must match all of the filter values chosen. Use the reset button to clear all filters when desired.
Search Box
This is a search-as-you-type box, that will search the table you are viewing by any number of fields. As matches are found, they will be displayed automatically, allowing you to use your down-arrow key or mouse to select the record you're looking for.
The first matching record found is always highlighted by default.
Note: Don't hit the return key until the record you are looking for is highlighted. If no list is shown, that means no records have been found that match your search input.
Note: For very large tables, there might be a slight delay before matching records are displayed, but you shouldn't have to wait more than a second or two in any case.
Paging
Use the Page control buttons to navigate to specific pages of your Summary.
Note: The number of records displayed on each page may be changed in your Personal Settings.
Sorting
You may click on any column heading to sort the records shown by that column, by ascending value. Clicking a second time will sort by descending value. Clicking a third time will remove the sort and revert to the default sorting for that table. Use the reset button to reset all filters and sorting to their default values.
Exporting
If you have proper access privileges, the export button allows you to download the entire Summary of all records to a csv file on your computer. Filters and sorting apply, and only the columns shown on your screen will be included in the export.
Detail Screens
Once you've selected a specific record, either by clicking through on the first column value of your Summary Screen, or by using the Search Box, you will bring up the Detail Screen for that record in the table.
The Detail Screen allows you to view and/or edit a specific record in the table.
You must submit your changes before they are stored in the database, either by hitting a return on any text field, or by clicking the Save Changes button.
Note: The Search Box remains active at the top of your Detail Screen, so you don't need to go back to the Summary Screen to find a different record by that method.
Field Help Text
If you see a blue question mark next to a field label, there is help text available. View it by hovering over or clicking on the blue question mark.
Refresh Data
If you need to refresh your Detail Screen for any reason, simply click on the record heading link.
Note: Clicking here will abandon any changes made that have not already been saved.
The Actions Menu
For most tables, an actions pulldown menu is available to the right of the record header, allowing you to perform functions specific to that table on that record.
Multi-valued Fields
Data fields that may have multiple values are shown on the right-hand portion of the Detail Screen, if there are any. In this section you can add new values, or delete existing ones for that record.
Changing these values is done by deleting the value, and then adding the correct value afterward.
To delete a value, check the delete box to the right and click Save Changes.