Consultant Management Application
Documentation and User Guide
Prepared for:
THE CARIBBEAN COMMUNITY (CARICOM) SECRETARIAT
Prepared by:
Illuminat (Trinidad and Tobago) Limited
155 Tragarete Street
Port-of-Spain
Trinidad
868-628-4010
Date: January 20th 2011
Table of Contents
Welcome Screen ... 3
Sign Up / Registration - Step 1 ... 3
Registration - Step 2 ... 5
Registration - Step 3 ... 7
Login ... 8
Consultant's Dashboard ... 8
Main Dashboard | Navigation Concepts ... 9
Getting Started | Consultant's Dashboard ... 11
My Profile ... 11 Customers ... 12 Address Book ... 13 Projects ... 15 Contacts ... 17 Members ... 18
Other Dashboard
-... 1919 Connections Dashboard | ... 19Other Dashboard
- ... 2020 Account Dashboard | ... 20
Other Dashboard
- ... 20 Resume Dashboard | ... 20
Navigation Aids and Summary Panels- ... 22
Welcome Screen
The home or landing page in the application. This is the first screen users / consultants will see when they visit the website. (insert web site link here).
Sign Up / Registration - Step 1
Select Account Type
The first step in the registration process is choosing the type of account and accepting the Terms of Use agreement.
Registration
-
Error Screen | No Account Type selectedAn Account Type must be selected to proceed to step 2 of registration.
Registration -
Error Screen | License Agreement Not Accepted
The Terms of Use is mandatory and registration will not proceed without acceptance. Clicking "Next" will take you to the next step. (Step 2)
Registration - Step 2
Account Details captures identification (username & password) that should be used at login (on the main screen) to gain access to the system.
Tooltips are shown as question marks to the right of the text boxes. Hover the mouse pointer to see a short description of what is expected input for this field.
The optional fields on the page are marked with "optional" to the right of the text box. (All other fields are mandatory and must be entered to proceed to the next step.)
Registration -
Error Screen | Unique Email Optional Fields
The email address and password entered here represents the identity of an individual (associated with the respective company) and must be unique. Additional users can be associated with a company after the registration process is complete.
The "Check Availability" button highlighted in green, will verify that a particular email address was not previously used to register a company / individual. A user can enter an email address and check to see if said email is available before proceeding with the rest of the form.
The fields highlighted in red alert users when mandatory fields are not filled or when they contain unexpected values . The mandatory fields must be completed correctly before the system
advances to step 3.
Registration - Step 3
This last step captures person details about the person registering this company and will be part of this individual's profile. Again the fields marked with optional can be left blank, everything else must be filled before you can proceed to the next step.
Clicking "Next" will take you to the next step. (Step 4)
Registration Completed
Registration Successful! Proceed to the Home Page and use your email address and password to log into the system.
Login
The login page asks for three (3) fields. Two (2) of them were provided by the user during registration (email address and password) and the third is a randomly generated "captcha code ".
The Captcha Code is a security feature; the user must enter the code in the 'Characters' text box exactly as it is shown in the picture.
Clicking "Login" will take you to Dashboard.
Dashboard - Menu / Navigation -
Main Dashboard | Navigation Concepts The name of the company appears in the yellow block as shown below.
The main navigation appears in blue as shown below.
The above page is the "Main Dashboard".
This is the main navigation that contains a list of all available actions/pages. The
"Home" menu item always navigates to this "Main Dashboard" page. The menu items
with a own arrow (
˅
) contain a drop down list of items. Each of these main menu
items has a dashboard/landing page of its own.
These are the" Dashboard Items". - that mimic the tabs and represent the same
information as shown in the tabs.
These are the" Panel Items". (As seen here a "Summary Panel" and a "Quick Links Panel".)
The links in the "Quick Links Panel" are identical to the "Main Menu" Navigation and the
"Dashboards".
Dashboard - Menu / Navigation -
Getting Started | Consultant's DashboardThe "Main Dashboard" has a "Getting Started" tab; that provides a few quick links that a new
user may want to explore.
My Profile
The first "Dashboard" menu item is a link to the Profile Page. Click this link to view the
"My Profile Dashboard" page. You can also access this screen by clicking on the main
menu item "My Profile". The Profile Dashboard has four (4) areas (About Me, My Skills,
My Highlights and Spoken Languages) show below as "Dashboard Items".
Customers
The second "Dashboard" menu item is a link to the Customers page. Click this link to
view the "My Customers" page.
After registration the first view of the "My Customers" screen is an empty list. The user must
add customers to their list using the "Add New Customer" button.
Clicking Add New Customer" button will take you to the Customer Details Page.
Add a Customer from the "Customer Detail" Page by entering a name in the Employer Name
text box and clicking the Save button on the bottom right of the screen. If the "Cancel" button is
clicked instead of the "Save" button the customer will not be saved and the screen will revert to
the "My Customers" screen /tab with the list of customers.
Click the "Save" button to ensure you save any changes ; look for the green status message that indicates a successful update.
Address Book
The third "Dashboard" menu item is a link to the Address Book. Click this link to view the "Addresses" page.
The address book displays the all the addresses that are associated with a company.
Clicking "Add New Address" button will take you to screen "Add New Address " screen below.
Fill out the fields for the new address; note that the optional fields are marked on the right by optional, indicating that the other fields are mandatory. An address cannot be successfully saved if the mandatory fields are not populated.
When you are finished entering the fields - Click the "Save" button to ensure you save any changes ; look for the green status message that indicates a successful update.
Projects
The fourth "Dashboard" menu item is a link to Projects. Click this link to view the "Manage Project" page.
There are currently no Project entries on the page but there is an option to add a project.
Clicking "Add New Project" button will take you to screen "Add New Project" screen below.
Fill out the fields for the new project; note that the optional fields are marked on the right by optional, indicating that the other fields are mandatory.
When you are finished entering the fields - Click the "Save" button to ensure you save any changes ; look for the green status message/s that indicates a successful update.
Contacts
The fifth "Dashboard" menu item is a link to Contacts. Click this link to view the "Manage Contacts" page.
There are currently no Contacts entries on the page but there is an option to add a contact.
Clicking "Add New Contact" button will take you to screen "Add New Contact" screen below.
Fill out the fields for the new contact; note that the optional fields are marked on the right by optional, indicating that the other fields are mandatory.
The Manage Contact page/tab will now show the previously entered contact.
When you are finished entering the fields - Click the "Save" button to ensure you save any changes ; look for the green status message/s that indicates a successful update.
Members
The sixth "Dashboard" menu item is a link to a Members page.
This page give a listing of all the members that are associated with a company. Basic information about each member is available as show above.
Other Dashboard -
Connections Dashboard |The "Connection Menu" and its sub menu items are shown above.
Click on the "Connections" menu item (highlighted in white in the figure) to display the "Connections Dashboard".
Notice The list of sub menu items on Connections Menu is also listed in the Connections Dashboard. My Customers | Address Book | Contacts
These items also appear in the "Main Dashboard " (or Consultants Dashboard). The links are duplicated for easy of navigation and take you to the same destination pages. As a result changes made from the links via the main menu will be reflected across the application despite the navigation route used.
Other Dashboard -
Account Dashboard |The "Account Menu" and its sub menu items are shown above.
Click on the "Account" menu item to display the "Account Dashboard".
Notice The list of sub menu items on Account Menu is also listed in the Account Dashboard. Account Information |Work Terms & Conditions |Account Members |Membership Invitations Similar to the Connections menu some of the items in the account menu are also found on the "Main Dashboard. Here there are some items in the menu not reflected in the dashboard. You can access them both from the menu and from the tab links next to the "Getting Started" tab.
Other Dashboard -
Resume Dashboard |The "Resume Menu" and its sub menu items are shown above.
Click on the "Resume" menu item to display the "Resume Dashboard".
Notice The list of sub menu items on Resume Menu is also listed in the Resume Dashboard. Education |Experience |Strengths |Certifications
The items on the menu take you to the same respective destination pages as the items in the dashboard.
Navigation Aids -
Navigation | BreadcrumbsThere are several management tabs/pages available to the user. These customarily shows a list of items that can be edited or otherwise manipulated.
Example (The Manage Customers Page)
When the user clicks a button (eg. Add New Customer) a new screen is shown allowing the user to enter a new items (in this case a Customer).
All these " inside screens " support the Breadcrumb feature which allows the user to track their clicks and navigate using the Breadcrumb trail.
The "bread crumb" feature shows a trail of screens that the user has followed to reach the current view. Each item in the trail is 'clickable' and will take the user back to the respective screen/tab. In the above screen clicking the "All Customers" link will take the user back to the "Manage