Giter VIP home page Giter VIP logo

bcgov / digital-journeys Goto Github PK

View Code? Open in Web Editor NEW
8.0 4.0 7.0 46.6 MB

PSA Forms System

Home Page: https://bcgov.github.io/digital-journeys/

License: Apache License 2.0

Dockerfile 0.29% Makefile 0.50% JavaScript 46.19% SCSS 1.85% Shell 0.49% Python 20.16% Java 19.92% HTML 0.30% FreeMarker 1.37% Mako 0.03% CSS 1.72% Jupyter Notebook 6.86% Batchfile 0.05% Smarty 0.28%
psa formio camunda forms formsflow-ai python react keycloak digital-journeys

digital-journeys's People

Contributors

abhilash-aot avatar abilpraju-aot avatar alanraju-aot avatar alexandralloyd avatar andrew-vargas-bcgov avatar bhumin-fw avatar chunthebear avatar david-sabadash avatar drsabadash avatar guru-aot avatar hasansifat avatar iman-jamali-fw avatar jerry-ey avatar jizhaogit avatar jwarrenbc avatar kkapoor-fresh avatar kurianbenoy-aot avatar kushal-arora-fw avatar matbusby-fw avatar repo-mountie[bot] avatar rintumerin-aot avatar schuyt avatar seethalelias-aot avatar shibin-aot avatar simensma-fresh avatar snyk-bot avatar sreehari-aot avatar sumathi-thirumani-aot avatar sumesh-aot avatar warrenchristian1telus avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

digital-journeys's Issues

Auto-populate user data when logged in

As a BC Gov Employee my data can auto-populate form fields when I am logged in so that I can save time completing my journey.

Acceptance Criteria

  • Basic info can be auto-populated to the form:

From IDIR:

  • First Name
  • Last Name
  • Gov Email Address

From ODS:

  • Employee ID

  • Phone Number

  • Department/Office

  • Office Address

  • Personal Address

  • Supervisor/Manager's Name (if available)

  • Auto-populated form fields can be edited after populated

  • Telus has setup an API endpoint in the ODS we can use for development

The non-admin user is able to view submissions from other users

Background: The non-admin user is able to view submissions from other users.

Steps to Reproduce:

  1. Log in to the PSA-Digital-Journey portal on dev as a non-admin user with valid credentials.
  2. Click on "Applicaitons".
  3. Click on "View".

Actual Behavior: The non-admin user is able to view submissions from other users.

Expected Behavior: The non-admin user should be able to only view his own submissions.

Updating the title of a form does not update its name and path

Background: Updating the title of a form does not update its name and path

Steps to Reproduce:

  1. Log in to the PSA-Digital-Journey portal on dev as an admin with valid credentials.
  2. Edit the title on an existing form and note its old name.
  3. Create a new form and input the "Title" with the name of the old form.

Actual Behavior: The user is displayed with name/path error.
Editing the title does not update the Name and Path fields. When you first create the form, the name and path auto-populate as you type in the title. However, if you update the title, the name and path do not get updated. If you later create another form with the old title, you get an error "the path must be unique per project".
DJnamePathError.png

Expected Behavior: The user should be able to create a form with a title that does not exist. The name and path of the edited form should be updated.

The user is not displayed with a warning pop-up when navigating back from the edit and submit form screen

Background: The user is not displayed with a warning pop-up when navigating back from the edit and submit form screen.

Steps to Reproduce:

  1. Log in to the PSA-Digital-Journey portal on dev as an admin or designer with valid credentials.
  2. Click on "View/Edit" form.
  3. Make some changes. Do not click on "Save Form".
  4. Click on the blue back arrow on the top left of the edit screen.
  5. Log in to the PSA-Digital-Journey portal on dev as a non-admin or designer with valid credentials.
  6. Click on "Submit New".
  7. Fill in some fields.
  8. Click on the blue back arrow on the top left of the form.

Actual Behavior: The user is not displayed with a warning pop-up when navigating back from the edit screen.

Expected Behavior: The user should be displayed with a warning pop-up when navigating back from the edit screen: "If you go back now, all unsaved information you have entered will be lost. Are you sure you want to exit this page?" with a Cancel and Continue button.

Confirmation pop-up when submitting the form

Background: The user is not displayed with a confirmation pop-up when submitting the form.

Steps to Reproduce:

  1. Log in to the PSA-Digital-Journey portal on dev with valid credentials.
  2. Fill out a form.
  3. Click "Submit".

Actual Behavior: The user is not displayed with a confirmation pop-up when submitting the form.

Expected Behavior: The user should be displayed with a confirmation pop-up: "Are you sure you want to submit?"

Onboarding / Off-boarding Process Document

As the PO I need to be able to review our onboarding and off-boarding process in a single concise document.

Acceptance Criteria:

  • Clearly defined document that illustrates end-to-end onboarding and offboarding processes

Branded look-and-feel for forms

As a digital journey user I would like to see a branded consistent look-and-feel for forms

Acceptance Criteria

References:

Notes:

  • Will use Corporate identity "Where We Work" for these forms - see mock-up
  • Review styles that we have afterwards and capture any required changes
  • Spin out any stories for adjustments

Re-useable FOIP text element

As a forms designer I can easily provide info on FOIP in the form

Acceptance Criteria

  • Can provide information on FOIP on a form where employees are providing personal information

e.g.
All personal information is collected in accordance with section 26(c) and (e) of the Freedom of Information and Protection of Privacy Act for the purposes identified above. Any questions or concerns regarding the collection of your information may be directed by submitting a request to AskMyHR at www.gov.bc.ca/myhr/contact or calling 1.877.277.0772.

  • Can apply the same information to any form/journey easily

Ability for Supervisor to approve forms

As a supervisor/manager, I would like to be able to approve forms after they've been submitted

A/C

  • Supervisor section of the form is only editable if you are the supervisor
  • Supervisor can see the entire form
  • Supervisor can authenticate with IDIR
  • Supervisor can load submitted form
  • Supervisor can add their info and signature
  • Supervisor can add comments
  • Hide ADM approval section if num days working remote < 3days

Notes:

  • Can remove "Upload the Telework Agreement sent by your employee" and Employee "First Name / Last Name" from the digital form.

Transition/succession plan to PSA

Transition plan for Freshworks to deliver to PSA

  1. Technical work/forms solution on OpenShift
  2. Resources required (PSA/TES)
  3. Documentation (Freshworks and PSA)

Maternity form initial submission email workflow

As a BC Gov Employee filling out the maternity form I would like the form to be submitted to my supervisor for approval on submission so that I don't have to manually submit a copy

A/C

  • Maternity form is created/exists
  • Form auto-populates if user is authenticated with IDIR
  • On any submission of the form a copy is sent to the employee and their supervisor
  • Supervisor can come back and update any of the dates (they need to update at least the child's birthdate)
  • Supervisor can update the dates after submission, but the employee cannot

Process

On formsflow:

  • On submission of the form a copy is sent to my supervisor to sign/approve
  • Supervisor approves the form initially, then holds the form until the child is born, gets proof of child's birthdate / adoption
  • Supervisor can come back and update any of the dates (they need to update at least the child's birthdate)

Offline:

  • The supervisor gets a copy of proof of birth
  • The supervisor gets a copy of the federal EI claim
  • Supervisor submits an AskMyHR request manually (can we automate this?)

Auto-populate user info

As a BC Gov Employee I can provide my identity information and agree to reviewed material in the form

Acceptance Criteria

Auto-populate - Employee name

  • Employee email
  • Employee position (job title)
  • Supervisor name
  • Supervisor email
  • A checkbox indicating they've reviewed and agree with information
    • I have reviewed, acknowledge and understand the above criteria as they apply to this telework agreement.

The above are pre-populated where possible.

Screen Shot 2022-01-17 at 1.52.38 PM.png

The form title and status is not updated on the "Metrics" screen

Background: The non-admin user is able to view submissions from other users.

Steps to Reproduce:

  1. Log in to the PSA-Digital-Journey portal on dev with valid credentials.
  2. Submit an existing form.
  3. Edit the title of the submitted form and submit the new version.
  4. Fill out the edited form.
  5. Submit the form.
  6. Click on "Dashboards".
  7. Click on the submitted form box.
  8. View the "Submission Status" box.

Actual Behavior: The user is displayed with the old form name. The user is displayed with different colors for different submission times but displayed with the status "New" for both old and new submissions.
DJ-Metrics2.png

Expected Behavior: The user should be displayed with the updated form title.

Auto-generate PDF on form submission

As a BC Gov Employee I would like to receive a PDF copy of the form I submitted so I can reference the form later if needed.

As a Supervisor I would like to receive a PDF copy of the form that was submitted so that I can review the submission easily and have a copy for my records.

As a form designer I would like to specify that a PDF copy be generated when a form is designed so that I can use that PDF in my workflows.

Acceptance Criteria

  • Ability to enable/disable PDF generation on a given form
  • When enabled, on submission of a form a PDF copy is generated
  • We don't need/want to store the PDF's permanently on the server
  • If form has file attachments, we can list the filename for now (file attachments on the form will be handled in another story)
  • Given a submission's status changes, an email with a PDF attached gets sent to the employee (and manager)

Notes:

  • Will need to add a listener and create functionality for this
  • Would be good to have on the Camunda as a workflow

User can login with IDIR

As a Digital Journeys users I can login to the system using my IDIR

Acceptance Criteria

  • Can login with IDIR account

Tech Notes

  • Can we get our own keycloak realm for this (likely)?

Notes:

  • Roles will applied later via the UI

Add missing topics

TL;DR

Topics greatly improve the discoverability of repos; please add the short code from the table below to the topics of your repo so that ministries can use GitHub's search to find out what repos belong to them and other visitors can find useful content (and reuse it!).

Why Topic

In short order we'll add our 800th repo. This large number clearly demonstrates the success of using GitHub and our Open Source initiative. This huge success means it's critical that we work to make our content as discoverable as possible. Through discoverability, we promote code reuse across a large decentralized organization like the Government of British Columbia as well as allow ministries to find the repos they own.

What to do

Below is a table of abbreviation a.k.a short codes for each ministry; they're the ones used in all @gov.bc.ca email addresses. Please add the short codes of the ministry or organization that "owns" this repo as a topic.

add a topic

That's it, you're done!!!

How to use

Once topics are added, you can use them in GitHub's search. For example, enter something like org:bcgov topic:citz to find all the repos that belong to Citizens' Services. You can refine this search by adding key words specific to a subject you're interested in. To learn more about searching through repos check out GitHub's doc on searching.

Pro Tip ๐Ÿค“

  • If your org is not in the list below, or the table contains errors, please create an issue here.

  • While you're doing this, add additional topics that would help someone searching for "something". These can be the language used javascript or R; something like opendata or data for data only repos; or any other key words that are useful.

  • Add a meaningful description to your repo. This is hugely valuable to people looking through our repositories.

  • If your application is live, add the production URL.

Ministry Short Codes

Short Code Organization Name
AEST Advanced Education, Skills & Training
AGRI Agriculture
ALC Agriculture Land Commission
AG Attorney General
MCF Children & Family Development
CITZ Citizens' Services
DBC Destination BC
EMBC Emergency Management BC
EAO Environmental Assessment Office
EDUC Education
EMPR Energy, Mines & Petroleum Resources
ENV Environment & Climate Change Strategy
FIN Finance
FLNR Forests, Lands, Natural Resource Operations & Rural Development
HLTH Health
IRR Indigenous Relations & Reconciliation
JEDC Jobs, Economic Development & Competitiveness
LBR Labour Policy & Legislation
LDB BC Liquor Distribution Branch
MMHA Mental Health & Addictions
MAH Municipal Affairs & Housing
BCPC Pension Corporation
PSA Public Service Agency
PSSG Public Safety and Solicitor General
SDPR Social Development & Poverty Reduction
TCA Tourism, Arts & Culture
TRAN Transportation & Infrastructure

NOTE See an error or omission? Please create an issue here to get it remedied.

The user is not displayed with any errors if he does not fill out the required form fields

Background: The user is not displayed with any errors if he does not fill out the required form fields.

Steps to Reproduce:

  1. Log in to the PSA-Digital-Journey portal on dev with valid credentials.
  2. Fill out a form that has required fields such as "Telework Agreement Qud". Do not fill in the required fields.
  3. Click on "Submit".

Actual Behavior: The user is not displayed with any errors if he does not fill out the required form fields and can not submit the form.

Expected Behavior: The user should be displayed with an error message stating to fill in the required fields before submitting.

Duplicate: Ability to save a form and complete later

As a BC Gov Employee I would like to be able to save a partially completed form and return later to complete it without losing information I've already entered.

Acceptance Criteria

  • A BC Gov employee filling out a form can save it and return to continue editing it later before it has been submitted.
  • An option exists that allows the user to save the form (instead of submitting it)
  • Confirmation appears when user chooses to save the form (pop-up, etc) - confirm with Jordan/UX

Notes

  • Consider if there is an option to trigger an email when an employee saves a form to finish later.
  • Form.io has a draft functionality that may help satisfy this
  • The ability to come back and edit would need to be put into the workflow of the forms.
  • What happens if the supervisor and employee try to edit the form at the same time?

The user is displayed with the submitted form's data when he clicks on "View/Edit" form

Background: The user is displayed with the submitted form's data when he clicks on "View/Edit" form.

Steps to Reproduce:

  1. Log in to the PSA-Digital-Journey portal on dev as an admin with valid credentials.
  2. Click on "Submit New" on an existing form.
  3. Fill it out and submit the form.
  4. Click on the "View/Edit" form.

Actual Behavior: The user is displayed with the submitted form's data when he clicks on "View/Edit" form.
DJ-viewEditFormView.png

Expected Behavior: The user should be displayed with the form blank fields. The data from the previous form entry should not populate here.

The non-admin user is displayed with the deleted form on the list

Background: The non-admin user is displayed with the deleted form on the list.

Steps to Reproduce:

  1. Log in to the PSA-Digital-Journey portal on dev as an admin with valid credentials.
  2. Delete a published form.
  3. Log in to the PSA-Digital-Journey portal on dev as a non-admin with valid credentials.
  4. Click on the "Submit New" button for the deleted form.

Actual Behavior: The non-admin user is still displayed with the deleted form on the list, and clicking on its action buttons displays "Resource not found".
DJdeletedForm.png

Expected Behavior: The user should not be displayed with any deleted forms.

Add project lifecycle badge

No Project Lifecycle Badge found in your readme!

Hello! I scanned your readme and could not find a project lifecycle badge. A project lifecycle badge will provide contributors to your project as well as other stakeholders (platform services, executive) insight into the lifecycle of your repository.

What is a Project Lifecycle Badge?

It is a simple image that neatly describes your project's stage in its lifecycle. More information can be found in the project lifecycle badges documentation.

What do I need to do?

I suggest you make a PR into your README.md and add a project lifecycle badge near the top where it is easy for your users to pick it up :). Once it is merged feel free to close this issue. I will not open up a new one :)

TOOL: Display created at/last edited by name and date on the form

It will be user-friendly to display the name of the person who created/last edited the form and the date.

Also, on the "Dashboards" > "Metrics" screen, there is a drop-down to select the options "Created Date" and "Modified Date", but the user has no idea on the dates of any of the forms.

The user should be displayed with a message after form submission

Background: The user should be displayed with the toast message upon form submission

Actual Behavior: Currently, after submitting the form, the user is displayed with the toast "Submission Saved".

Expected Behavior: The user should be displayed with a more user-friendly message:

"Thank you for your submission. Once your submission has been reviewed by your supervisor, you will receive a notification via email. You can view a copy of your submission in your forms dashboard."

Notes

  • See wireframe

Lets use common phrasing

TL;DR ๐ŸŽ๏ธ

Teams are encouraged to favour modern inclusive phrasing both in their communication as well as in any source checked into their repositories. You'll find a table at the end of this text with preferred phrasing to socialize with your team.

Words Matter

We're aligning our development community to favour inclusive phrasing for common technical expressions. There is a table below that outlines the phrases that are being retired along with the preferred alternatives.

During your team scrum, technical meetings, documentation, the code you write, etc. use the inclusive phrasing from the table below. That's it - it really is that easy.

For the curious mind, the Public Service Agency (PSA) has published a guide describing how Words Matter in our daily communication. Its an insightful read and a good reminder to be curious and open minded.

What about the master branch?

The word "master" is not inherently bad or non-inclusive. For example people get a masters degree; become a master of their craft; or master a skill. It's generally when the word "master" is used along side the word "slave" that it becomes non-inclusive.

Some teams choose to use the word main for the default branch of a repo as opposed to the more commonly used master branch. While it's not required or recommended, your team is empowered to do what works for them. If you do rename the master branch consider using main so that we have consistency among the repos within our organization.

Preferred Phrasing

Non-Inclusive Inclusive
Whitelist => Allowlist
Blacklist => Denylist
Master / Slave => Leader / Follower; Primary / Standby; etc
Grandfathered => Legacy status
Sanity check => Quick check; Confidence check; etc
Dummy value => Placeholder value; Sample value; etc

Pro Tip ๐Ÿค“

This list is not comprehensive. If you're aware of other outdated nomenclature please create an issue (PR preferred) with your suggestion.

Ability to provide postal address & phone

As a BC Gov Employee I can enter a postal address

Acceptance Criteria

  • BC Gov Employee can provide their postal address
    • Street Address
    • City
    • Province
    • Postal Code
    • Ministry (if available)
  • Address field has some contextual info on which address to provide (text)
  • BC Gov Employee can provide their phone number

Notes

  • Start as a text box, but later we can consider integrating with Google Maps or other services

Google Maps "Address" form element is available in forms.io:

  • The Google Maps API Key is created (see here)
  • The Google Maps API key is setup in form.io
  • BC Gov Employees Can enter an address

Ability to sign/agree to reviewed material

As a BC Gov Employee I can sign/agree to reviewed material

Acceptance Criteria

For the tele-work journey:

  • Employee Name
  • Employee Position
  • Employee Signature
  • Date of signature/agreement (date/time or day) - date picker with a default date set to today

All fields required.

Screen Shot 2022-01-17 at 1.49.48 PM.png

User Access Matrix

As the PO I need to be able to easily review our user roles and permissions in a single document.

Acceptance criteria:

  • Single table document representative of all actors and permissions
  • Clearly defined permission sets

Viewing submissions as a non-admin from the "Applications" tab throws a 502

Background: Viewing submissions as a non-admin from the "Applications" tab throws a 502 error.

Steps to Reproduce:

  1. Log in to the PSA-Digital-Journey portal on dev as a non-admin with valid credentials.
  2. Click on "Applications".
  3. Click on "View" under "Link to Form Submission".

Actual Behavior: The user is displayed with a 502.
DJ502.png

Expected Behavior: The user should be able to view his submissions from the "Applications" tab.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.