Skip to main content
CollegeSource Support

Admin Help

 

Since the 4.4 release, users have been able to configure their uAchieve applications to their liking directly from the Dashboard. This level of customization is available by moving most of the properties (over 300!) from the .properties files into the database.

> See the list of new properties added in 4.5.1 here.

Where is my property?
Cross reference old property names in the applications to their new page in the updated user interface in a running list of property changes.


Access

Administrators only
The customization guide is not available to student users and is restricted to administrators ("admin") only. Access is permissions-based, so not every user will be able to access the same customizations.

  1. Log in to a uAchieve application as an administrator
  2. Access the Admin area in one of two ways:
    1. From the Dashboard, click on the Admin wrench button ()
    2. From the Settings gear button () in the Dashboard's coral menu bar, select the drop-down option for Admin

The Administration Home page presents the hierarchy of the topics within Admin Help (along the left side in gray), along with several other functions:

  • Search provides an empty search field for property labels or database names:
  •   Summary table of new configurations for each release (labels, descriptions, and linked pages)
  • Hyperlink to CollegeSource documentation in the Support Center

New Configs in 4.5.1 callout.jpg

The additional help features built into the Admin Help area are discussed below.

Layout

The Admin area is split into a gray sidebar (L) that dictates the extensive display of associated fields where configurations are made (R). Microhelp ( ) is onscreen help that is also available. Drill down into the sidebar sub-headings in the drop-downs to select a more specific area to perform customizations on. For example, accessing the customization fields for Email is illustrated below:

For ease of navigation, the hierarchy of the sidebar is loosely arranged by functional areas that correspond with uAchieve applications.

Jump to areas
To jump directly to exploring these categories, click here.

 

Customization Fields

The customization fields displayed on the right correlate to the sidebar selection on the left. Similar types of input that may be customized are grouped together in Admin Help: links, enable/disable features, and labels/text. Regardless of the type of customization field, many may be pre-populated with default text.

Legend

Some property fields may be denoted with icons indicating specific conditions pertaining to the property field of interest.

Admin help legend.jpg

These icons are defined in a legend at the bottom of each category page in the Admin area of Dashboard:

*  Required field

</> Special syntax required

 Default overwritten (click directly on the button to view the Instcd and Value where the selected property has been overwritten)

NOTE:
The Default Overwritten icon only appears on the page legend when configuring Default Settings in the application. When switching the institution away from default, Default Overwritten is not applicable and does not display on the page.

Validation

Inputs into the customizable fields are validated as values are entered to ensure the correct type and amount of information is being entered. When the input is incorrect, red text appears beneath the field prompting the user to "Please enter a valid..." piece of information:

Links

Links refer to designated hyperlink URLs.

Click the Reset to Default link to erase the field input and return it back to the pre-populated default setting.

Max Length
The maximum length Max length: of characters allowed it listed below each field.

Update Info
If the field has been edited from the pre-populated default setting, then the Updated: date and time and/or the updated By: fields may be noted.

Enable/Disable Features

Certain features may be enabled or disabled via a True/False toggle button.

Click the Reset to Default link to erase the field input and return it to the pre-populated default setting.

Update Info
If the field has been edited from the pre-populated default setting, then the Updated: date and time and/or the updated By: fields may be noted.

Labels/Text

Labels and text refer to how certain on-screen aspects of the UI are referred to the user. For example, customize the "Staff Home Welcome Text" to your preferred verbiage in the text box:

 will display as Welcome to the Home Page to staff users logged into the application.

The maximum character length Max length: allowed is listed below each field.

Update Info
If the field has been edited from the pre-populated default setting, then the Updated: date and time and/or the updated By: fields may be noted.

Save Changes

To conserve changes made to the customization fields, click the Save Changes button (). To cancel changes made to the customization fields before saving and return to the Admin Help home, click the Cancel button ().

View Changes

To view changes saved in the Admin Help area, you must log out and then log back into the application.

Best Practice Recommendation
Make changes → Save → Log out → Log back in

Help?

This documentation, the search feature, and microhelp is available to help guide you through your customization process:

Documentation

New tables for each property provide great detail on how settings were previously set versus how they are now made in 4.4, including the following:

  •  Where [what application(s)] is it used in?
    • Currently
    • Previously
  • What is the description?
  • What is the default setting, if any?
  • What is the database name?
  • Are there related properties I should be aware of?
  • How can I customize this property?

doc example for Admin help page, email return link text field.jpg

Access

Tables are accessible directly by page in the Support Center or via the "Find out more..." hyperlink at the bottom of the microhelp bubbles:

NOTE:
Access requires a Support Center account.


Search
  • Use the Search feature to find what you need, including a property label or database name:

Jump to Section
  • Click a box at the top of the page that represents a heading of interest to jump immediately to that section on the current page.

Microhelp

The microhelp is a small excerpt of in-app help pertaining to each field. Click the floating microhelp lightbulb button () at the bottom right:

microhelp button bottom right.jpg

NOTE:
The microhelp lightbulb () disappears when clicked and is replaced with an orange microhelp information panel that floats across the bottom of the viewing screen:

Click the field's Close button () to exit the information panel view; the microhelp lightbulb will reappear.


View specific information about the selected field inside a microhelp bubble at the bottom of the page:

generate microhelp from a field.jpg

In the example above, the field for Email From is selected, as reflected in the microhelp information panel below that offers more details (e.g., definition, maximum characters)

Closing the microhelp bubble () makes the microhelp lightbulb reappear.

Configuring: Default Settings

If your institution has access, you may see a white box on the top of the sidebar–Configuring: Default Settings. This option is used by those institutions that have have more than one INSTCD so that they may switch between institutions and select a new one. For example, select the graduate college instead of the undergraduate college. Click the Switch Institution link and make an appropriate selection in the drop-down dialog box to switch to the institution of choice:

Default settings area.jpg

Properties may be configured for these different institution codes with few exceptions. The "default settings" are used across all InstCDs, and may be overwritten per InstCD.

Remember:
The user will see this Switch Institution option only if their institution has more than one INSTCD.

Sidebar

Sidebar options are grouped according to functionality of the Suite applications your institution is licensed for, i.e., if you only have the uAchieve Planner installed then you will not see settings for creating exceptions.

Click a category name from the list (below) to go directly to the page, or keep scrolling for a little more information on each:

View the hierarchy of the sidebar by expanding the collapsed (by default) gray bars. Respective subcategories will display below each:

Collapsed Sidebar

(default)

Expanded Sidebar

4.5.1 Admin help, exploded view.jpg

 

NOTE:
The contents of the left pane are customized to the user based upon which URL links have been customized in the Global/Application Links page, thereby ensuring the displayed options pertain to applications the user has.

  • Select a general heading in the gray sidebar on the left by clicking directly on the name:

  • The selected heading highlights in black:

 

  • From the drop-down options, select any sub-heading in the white area:

  • The selected sub-heading highlights in dark gray (this step generates the customization area on the right)

 

Troubleshooting

For help with troubleshooting errors when customizing database properties, see the error guide.

 

  • Was this article helpful?