Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Drawio
mVer2
simple0
zoom1
inComment0
pageId418218140
custContentId443744328
diagramDisplayNameVolaris-LoC-Registration-T1-2-V1.drawio
lbox1
contentVer34
revision34
baseUrlhttps://folio-org.atlassian.net/wiki
diagramNameVolaris-LoC-Registration-T1-2-V1.drawio
pCenter0
width12981249
links
tbstyle
height11271109

Patron Registration Process (Tier 1)

  • Step 1 Patron fills in an initial registration form (Tier 1):
    The patron begins by filling out the required information in a registration form to initiate their registration process in Locate.

  • Step 2 Send patron data (Tier 1):
    The registration form data is sent to FOLIO in order to process the registration request.

    Step 3 Check if e-mail already exists:
    The FOLIO checks whether the email provided by the patron already exists in the FOLIO platform in staging table and in users table also.

    Note: The result may be the following:

    1. No records found - OK

    1. Single staging record found - patron already registered in FOLIO,

    use another e-mail address

    1. Single user record found with activated status - patron already registered in FOLIO,

    registration should be finished on site

    1. Single user record found with inactive status - patron already registered in FOLIO,

    registration should be renewed onsite*

    *(in case of automatic renewal we need to create separate flow)

    1. Multiple user records found - patron already registered in FOLIO,

    registration should be finished onsiteCheck if e-mail already exists:
    Locate calls edge-patron (GET /patron-registration-status ) to check the active status of the patron

  • Step 3 Return registration status:
    FOLIO performs checks on FOLIO users to return a current registration status. Registration status may be of the following:

    • When the record is found in FOLIO

      • Return 200 - If active

      • Return 404 - If inactive (With a message indicating that it's expired)

    • When the record is NOT found in FOLIO

      • Return 404 - (With a message indicating that it's NOT FOUND)

Alternate Path: 404 - no records found (or inactive record found)

  • Step 4 Store patron data (Tier 1) - The patron data is stored in FOLIO since no existing record with the same email is found.

  • Step 5: Patron data has been stored - Confirmation that the patron data is stored in FOLIO.

  • Step 6: Persist patron data (Tier 1) - The system ensures that the patron data is saved persistently in Locate.

  • Step 7: Send email verification - An email verification message is sent to the patron to confirm his/her email address.

  • Step 8 Verify email:
    The patron verifies their email by following the link sent in the email verification message.

  • Step 9 Activate patron (Tier 1):
    Once the email is verified, the system activates the patron's account in Locate.

  • Step 10 Send patron activated (Tier 1):
    Locate notifies FOLIO that the patron account has been activated.

  • Step 11 Mark patron activated (Tier 1):
    FOLIO marks the patron's data as activated in its dedicated table.

Alternate Path: 200 - active record found

  • Step 12 Locate hides the pre-registration link:

    • If the patron is already Tier 2, locate hides the pre-registration link.

Patron Registration Process (Tier 2)

  • Step 12 13 Login to Locate:
    The patron logs in to the Locate system after successfully completing the Tier 1 registration.

  • Step 13 14 Fill in a Tier 2 registration form:
    The patron fills out a more detailed registration form required for Tier 2 registration.

  • Step 14 15 Send patron registration data (Tier 2):
    The registration form data is sent to the FOLIO for further processing.

  • Step 15 16 Store patron registration data (Tier 2):
    The patron's Tier 2 registration data is stored in FOLIO.

  • Step 16 17 Patron data has been stored (Tier 2):
    Confirmation that the patron's Tier 2 data has been stored.

  • Step 17 18 Registration needs to be completed onsite:
    The final step of the registration process needs to be completed in person at the registration desk for verification of identity, card printing, and other formalities.

Option 2. Online registration Tier 1 + Tier 2

Expand

Drawio
mVer2
zoom1
simple0
inComment0
custContentId443744354
pageId418218140
lbox1
diagramDisplayNameVolaris-LoC-Registration-T1-2-V2.drawio
contentVer1
revision1
baseUrlhttps://folio-org.atlassian.net/wiki
diagramNameVolaris-LoC-Registration-T1-2-V2.drawio
pCenter0
width1119
links
tbstyle
height1020

Patron Registration Process (Tier 2 + Tier 2)

  • Step 1 Patron fills in a complete registration form (Tier 1 + Tier 2):
    The patron begins by filling out a comprehensive registration form that includes both Tier 1 and Tier 2 information in one go.

  • Step 2 Send patron data (Tier 1 + Tier 2):
    The filled-out registration data is sent to the FOLIO platform, which processes the combined registration request.

  • Step 3 Check if e-mail already exists:
    FOLIO checks whether the email provided by the patron is already present in the FOLIO platform.

    Alternate Path: If the e-mail is not found

    • Step 4: Store patron data (Tier 1 + Tier 2) in FOLIO - Since no existing record with the same email is found, FOLIO stores the entire patron data.

    • Step 5: Patron data has been stored - Confirmation that the patron data has been successfully stored in FOLIO.

    • Step 6: Persist patron data (Tier 1) - Locate ensures that the patron data from Tier 1 is saved persistently.

    • Step 7: Send email verification - An email verification message is sent to the patron to confirm his/her email address.

    • Step 8: Registration needs to be completed onsite - The patron is informed that the final step of the registration needs to be completed in person.

    Alternate Path: If a single patron record with this email address is found

    • Step 9: Store patron data (Tier 1 + Tier 2) - The patron data is stored in FOLIO since only one existing record with the same email is found.

    • Step 10: Patron data has been stored - Confirmation that the patron data has been successfully stored in FOLIO.

    • Step 11: Persist patron data (Tier 1) - Locate ensures that the patron data from Tier 1 is saved persistently.

    • Step 12: Send email verification - An email verification message is sent to the patron.

    • Step 13: Registration needs to be completed onsite - The patron is informed that the final step of the registration needs to be completed in person.

    Alternate Path: If multiple records are found for the email

    • Step 14: Error: Multiple records with the email address found - The system detects multiple patron records associated with the email.

    • Step 15: Error: Invalid email address. Use another email - The patron is prompted to use a different email address because the provided one is associated with multiple records.

    • Note 1: At this stage, the patron cannot log in to Locate until the email verification is completed.

    • Note 2: This registration can be done onsite using a self-service point or with the help of the registration desk staff.

    • Note 3: Unverified e-mail does not block onsite registration completion.

  • Step 16 Verify email:
    The patron verifies his/her email by following the link sent in the email verification message.

  • Step 17 Activate patron (Tier 1):
    Once the email is verified, Locate activates the patron's account for Tier 1.

  • Step 18 Send patron activated (Tier 1):
    Locate notifies FOLIO that the patron account has been activated for Tier 1.

  • Step 19 Mark patron activated (Tier 1):
    FOLIO marks the patron's data as activated for Tier 1 in its dedicated table.

Onsite registration completion

Drawio
mVer2
zoom1
simple0
zoominComment10
inCommentcustContentId0443711646
pageId418218140
custContentIdlbox4437116461
diagramDisplayNameVolaris-Onsite-Registration.drawio
lbox1
contentVer3
revision3
baseUrlhttps://folio-org.atlassian.net/wiki
diagramNameVolaris-Onsite-Registration.drawio
pCenter0
width1059
links
tbstyle
height1226

...

The following functionality covers the case when a patron comes to LoC registration desk without prior creation of Tier 1/2 Locate account. The Kiosk should be implemented in Locate as a separate form allowing patrons to directly fill in Tier 2 registration data and proceed with registration without e-mail address verification.

Drawio
mVer2
zoom1
simple0
zoominComment10
inCommentcustContentId0470089734
pageId418218140
custContentIdlbox4700897341
diagramDisplayNameOnsite.Registration.Kiosk.v1.drawiolbox1
contentVer1
revision1
baseUrlhttps://folio-org.atlassian.net/wiki
diagramNameOnsite.Registration.Kiosk.v1.drawio
pCenter0
width1124
links
tbstyle
height932

...

  1. Create a staging table with fields:

    1. First name

    2. Last name

    3. Email

    4. Tier: 1,2

    5. Etc. fields from Tier 2 registration form

  2. Add (edge) GET API to check the registration status in users table:

    1. When the record is found in FOLIO

      • Return 200 - If active

      • Return 404 - If inactive (With a message indicating that it's expired)

    2. When the record is NOT found in FOLIO

      • Return 404 - (With a message indicating that it's NOT FOUND)

  3. Modify (edge) POST API to store data in the staging table and accept:

    1. Tier 1 data (insert): only store First/Last name and email address

    2. Tier1 data (update): the record is activated on Locate side

    3. Tier 2 data (update): store full data

  4. Create GET API for staging table to search/filter data by email/first name/last name

  5. Create UI for staging table to search/filter data by email/first name/last name

  6. Create PUT API to link patron record with staging record

    1. Create a patron record if not present in user table and link move it from staging to user table

    2. Link Update existing patron record with staging record and remove staging record

  7. Create UI dialog to:

    1. Link a staging Confirmation to update existing patron record with a patron recordShow a list of patron records to choose fromstaging data

    2. Dialog to choose one of the existing patron records and update it with staging data

    3. Go to user app with the selected patron record

...