Skip to content
This repository has been archived by the owner on Aug 11, 2022. It is now read-only.

Getting Started with the UI

tristan-orourke edited this page Oct 2, 2020 · 3 revisions

Introduction

The intent of the document is to outline basic functionality within the application to save you time clicking around and being confused. This document assumes you have already gotten your local environment up and running, with a root APP_URL of https://talent.test. If not, please go through the README-local.md file.

The site is comprised of four different portals, each designed for a different kind of user and offering different functionality. To access each of the portals, use the following test accounts:

The password for each account is 'password'

The Portals

Applicant Portal

To navigate to the applicant portal, visit the site's main home page: https://talent.test/. This can be considered the site's default portal, as it is the only one fully open to the public.

Without logging in, users may browse and view live Job Posters, and read the FAQ. They will be promted to Register or Login if they want to apply to a job.

A logged in user can complete Applications for jobs, view their in-progress or past Applications, edit their Applicant Profile, and modify their User Settings. Most of the information used for an Application (skills and experiences) is saved to the user's Applicant Profile to be reused on future Applications, where possible.

The settings page is used to modify data common to all types of User (applicants, managers, HR an admins): name, email, password, and 2-factor Auth settings. This page also appears on the Manager and HR portals.

In the code, twig templates for pages on the Applicant portal are mostly saved under /resources/views/applicant, though views common to several portals may be in other folder, such as /resources/views/common and /resources/views/auth. Some portions of the applicant portal, including the Application, are built as large React components saved under /resources/assets/js/components/.

Manager Portal

To navigate to this portal, visit https://talent.test/manager/. This portal has been designed for hiring managers within the Government of Canada who want to hire someone to their team. Its main features are the Job Poster Builder (JPB), the Screening Plan Builder (SPB) and Application Reviews.

You must be logged in to access most of the portal. Anyone can register here, or access it with an Applicant account, but they will be considered a Demo Manager. Demo Managers may use the JPB and SPB, but may not publish their jobs. The first time a logged-in user visits the Manager portal, they will be prompted to enter their government email and department, if they have one.

The Job Poster Builder guides Managers through the steps of creating a Job Poster, attempting to explain the purpose and rationale behind each step. When the initial poster is complete, they may submit it to HR for review.

After a job has been submitted for review, the Job transitions through a series of states which require review by either the Manager, an HR user, and finally a Talent Cloud Admin. The Manager can track this progress through a dashboard specific to the job, and communicate with HR through a comment feed.

While a Job Poster is in review, the Manager may also build as Screening Plan, which will be used to evaluate and screen applicants.

After a Job Poster has passed all the reviews and gone live, the Manager may also view submitted applications. The applicant view page is meant to help sort applicants into initial categories, and allow managers to attach basic reviews and comments for each.

Managers may also edit their Manager Profile, which appears on every Job Poster they create, and modify their user settings (the same settings available to Applicants).

In the code, twig templates for pages on the manager portal are mostly saved under /resources/views/manager, though views common to several portals may be in other folder, such as /resources/views/common and /resources/views/auth. Many portions of the manager portal, including the JPB and SPB, are built as large React components, saved under /resources/assets/js/components/.

HR Portal

To navigate to this portal, visit https://talent.test/hr/. This portal has been designed for HR advisors within the Government of Canada to help hiring managers construct an effective Job Poster and find talented applicants.

Only logged-in HR users may access this portal. The first time they do, they will be prompted to enter their government email and department.

HR advisors may browse Job Posters from their department. Any poster within their department which has been submitted for review is visible. Any number of HR advisors may "claim" a job, which opens up further actions.

Claimed jobs have a dashboard (similar to on the Manager portal) where the HR advisor may view the Job Poster, its Screening Plan, and if it has gone live, submitted applications. When the job is awaiting review, the HR advisor may progress it to the next state, or request changes, communicating with the Manager through a comment feed.

HR Advisors do not have a Profile, but have access to the same User Settings as other users.

In the code, several twig templates for HR pages are saved under /resources/views/hr_advisor/, but this portal has a lot of overlap with the Manager portal and reuses many of the same views and React components.

Administration

In order to navigate to the admin portal, visit https://talent.test/admin/.

The Admin portal is very different from the rest of the site. It has been created with Backback, which is used to facilitate fairly direct interaction with the underlying data.

In the code, if you look in the /app/Http/Controllers/Admin folder, you will see a list of controllers which match the list of items on the left hand side panel. The sidebar menu is controlled by the file /routes/backpack/custom.php. For details regarding the structure and use of Backpack, refer to their documentation.

Key uses of the Admin portal:

  • While editing a user, an admin may change their User Role. This is the only way to promote an account to a Manager, HR, or Admin account.
  • Some parts of a Job Poster can only be entered by an Admin. These fields can be edited by following the Edit and Questions links on each entry of the Job Posters view.
  • At some points in the Job Poster lifecycle only an Admin can change the job poster status. This can be done from the Edit page of a Job Poster.
  • Admins can add new Skills or Departments, which are referenced in many places across the site, and edit their text in both English and French.
  • Admins can upload new Resources, files which will be available for Managers and HR advisors to download.

Finally, it is important to note than an Admin user has permission to view nearly any page on the site, including resources belonging to any user.