From 6c9149b77968eaf3cb7427800b5b9a5b3f65566a Mon Sep 17 00:00:00 2001 From: Angela Tran Date: Tue, 28 Nov 2023 23:56:16 +0000 Subject: [PATCH 1/3] docs: add system use case with retry as alternate flow --- docs/use-cases/system-use-cases.md | 31 ++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 docs/use-cases/system-use-cases.md diff --git a/docs/use-cases/system-use-cases.md b/docs/use-cases/system-use-cases.md new file mode 100644 index 000000000..5d5cd52d6 --- /dev/null +++ b/docs/use-cases/system-use-cases.md @@ -0,0 +1,31 @@ +The use cases documented on this page focus on how the system is supposed to work from the perspective of the end user. + +### Use case: Enroll contactless card to receive transit benefit + +**Primary Actor**: Transit rider + +**Systems**: Benefits app, payment processor + +**Preconditions**: + +- Transit rider has confirmed their eligibility with the Benefits app +- Transit rider has their contactless card information available +- Benefits app is able to contact the payment processor + +**Trigger**: Transit rider initiates the enrollment process + +**Basic flow**: + +1. Transit rider enters their contactless card information +2. Benefits app passes that information to the payment processor to enroll the card +3. Payment processor successfully enrolls card + +**Alternate flows**: + +- 3a. Payment processor returns with one of the following errors: address verification failed, token is invalid, or general server error + - 3a1. Transit rider chooses to retry, starting back at initiating the enrollment process + - 3b1. Transit rider leaves the Benefits app + +**Postconditions**: + +- Transit rider's contactless card is enrolled to receive the transit benefit From 6fcb1c414f05864d90af6e05d5487c2faf317c53 Mon Sep 17 00:00:00 2001 From: Angela Tran Date: Thu, 7 Dec 2023 15:26:11 +0000 Subject: [PATCH 2/3] fix: update docs and comments to remove outdated information address verification used to be a part of the hosted verification flow, but no longer is --- benefits/enrollment/templates/enrollment/index.html | 4 ++-- docs/use-cases/system-use-cases.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/benefits/enrollment/templates/enrollment/index.html b/benefits/enrollment/templates/enrollment/index.html index 4a543f09e..b2fdeee0d 100644 --- a/benefits/enrollment/templates/enrollment/index.html +++ b/benefits/enrollment/templates/enrollment/index.html @@ -57,7 +57,7 @@

}, onTokenize: function (response) { /* This function executes when the - /* card/address verification returns + /* card verification returns /* successfully with a token from enrollment server */ amplitude.getInstance().logEvent(closedEvent, {status: "success"}); @@ -67,7 +67,7 @@

}, onVerificationFailure: function (response) { /* This function executes when the - /* card/address verification fails and server + /* card verification fails and server /* return verification failure message */ amplitude.getInstance().logEvent(closedEvent, {status: "fail"}); diff --git a/docs/use-cases/system-use-cases.md b/docs/use-cases/system-use-cases.md index 5d5cd52d6..b4d8c1e5c 100644 --- a/docs/use-cases/system-use-cases.md +++ b/docs/use-cases/system-use-cases.md @@ -22,7 +22,7 @@ The use cases documented on this page focus on how the system is supposed to wor **Alternate flows**: -- 3a. Payment processor returns with one of the following errors: address verification failed, token is invalid, or general server error +- 3a. Payment processor returns with one of the following errors: card verification failed, token is invalid, or general server error - 3a1. Transit rider chooses to retry, starting back at initiating the enrollment process - 3b1. Transit rider leaves the Benefits app From 1f3d8c340ebc4ed6cbaf5fada3304893ee58ea98 Mon Sep 17 00:00:00 2001 From: Angela Tran Date: Thu, 7 Dec 2023 15:27:23 +0000 Subject: [PATCH 3/3] chore: use 'phase' instead for better understanding across the team --- docs/use-cases/system-use-cases.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/use-cases/system-use-cases.md b/docs/use-cases/system-use-cases.md index b4d8c1e5c..b7089bc56 100644 --- a/docs/use-cases/system-use-cases.md +++ b/docs/use-cases/system-use-cases.md @@ -12,7 +12,7 @@ The use cases documented on this page focus on how the system is supposed to wor - Transit rider has their contactless card information available - Benefits app is able to contact the payment processor -**Trigger**: Transit rider initiates the enrollment process +**Trigger**: Transit rider initiates the enrollment phase **Basic flow**: @@ -23,7 +23,7 @@ The use cases documented on this page focus on how the system is supposed to wor **Alternate flows**: - 3a. Payment processor returns with one of the following errors: card verification failed, token is invalid, or general server error - - 3a1. Transit rider chooses to retry, starting back at initiating the enrollment process + - 3a1. Transit rider chooses to retry, starting back at initiating the enrollment phase - 3b1. Transit rider leaves the Benefits app **Postconditions**: