=
PROCESS DOCUMENTATION
Software Architecture 5B Bis
Gerardo Haro Dominguez
Universidad Politécnica de Durango
Contents
Scenarios of a Real Estate Web page .................................................................................................... 2
Scenario 1: Administrator login ................................................................................................................ 2
Scenario 1: Administrator Login requirements......................................................................................... 2
Scenario 1: Identifying sections ................................................................................................................ 3
Scenario 1: Use case ................................................................................................................................. 4
Step 1: Identify system users ................................................................................................................ 4
Step 2: Define user goal ........................................................................................................................ 4
Step 3: Describe the course .................................................................................................................. 4
Step 4: Alternate courses of events ...................................................................................................... 4
Step 5: Common course use case ......................................................................................................... 4
Scenario 2: Creating a property ................................................................................................................ 5
Scenario 2: Creating a property requirements ......................................................................................... 5
Scenario 2: Identifying sections ................................................................................................................ 6
Scenario 2 use case: Administrator creates a new property .................................................................... 7
1. Identify system Users: ....................................................................................................................... 7
2. User Goal:.......................................................................................................................................... 7
3. Describe the course: ......................................................................................................................... 7
4. Alternate course of events:............................................................................................................... 1
5. Common course use case: ................................................................................................................ 1
Scenario 3: Deleting a property ................................................................................................................ 2
Scenario 3: Deleting a property requirements ......................................................................................... 2
Scenario 3: Identifying sections ................................................................................................................ 3
Scenario 3 use case: Administrator deletes a property ............................................................................ 4
Step 1: Identify System Users: .............................................................................................................. 4
Step 2: Define User Goal: ...................................................................................................................... 4
Step 3: Describe the Course: ................................................................................................................. 4
Step 4: Alternate Courses of Events: .................................................................................................... 4
Step 5: Common Course Use Case: ....................................................................................................... 4
Scenarios of a Real Estate Web page
Scenario 1: Administrator login
Stimulus: The user needs to create, delete, update or moderate the sellers, the properties
or the testimonials of the feed. In response, the user fills the formulary login credentials.
Stimulus source: Administrator was registered previously on the Register page.
Environment: The login formulary container from the admin section.
Artifact: Security through a two-factor authentication (2FA), help for forgotten password,
cross browser compatibility and error handling.
Response: The website shows the administrator the available options and features that
only his user level has, instantly after entering his credentials.
Response measure: The webpage maintains the session of the user that logged in, even
when the user navigates through the entirety of the webpage.
Scenario 1: Administrator Login requirements
Business Requirement: Ensure the security of the administrator's account and
data through two-factor authentication (2FA) and appropriate user session
management.
User Requirement: Provide clear error messages and assistance for forgotten
passwords to facilitate a smooth login process for administrators.
Software Requirement: Develop cross-browser compatibility for the login form to
accommodate a wide range of user devices and preferences.
Scenario 1: Identifying sections
Scenario 1: Use case
Step 1: Identify system users
Administrators
Step 2: Define user goal
• Create new posts
• Delete a post
• Update a post
• Moderating current posting petitions
Step 3: Describe the course
Admin navigates to the website URL.
Admin clicks on the "Management Section" link/button.
Admin enters their username in the designated field.
Admin enters their password in the designated field.
Admin clicks the Login button.
The system verifies the credentials with the stored data.
Step 4: Alternate courses of events
• Admin enters the wrong credentials
• Admin is not registered anymore
• Admin forgot password and or email
Step 5: Common course use case
All the admin users have the same course of action because there is not a user with a different
login process, additionally, the users cannot log into the management section
Scenario 2: Creating a property
Stimulus: Admin needs to create a property, adding a title, a description, specifying the
number of rooms, bathrooms, and place for vehicles, adding an image, price and the
name of a Real Estate agent.
Stimulus source: The admin user logged in previously.
Environment: The CRUD menu in the admin section of the page.
Artifact: The function should upload the corresponding data to the database, so it must
be reliable.
It must accept images up to 10mb and should make them lighter, also the create function
must have all the inputs filled.
Response: A new property should be created in the index of the admin section, to which
also the user is redirected to.
Response measure: PHP displays visual feedback in the index as a green box with a
success message, maintains user session and the property is displayed for the normal
users in the feed.
Scenario 2: Creating a property requirements
Business Requirement: Maintain data integrity by ensuring that all required fields
are filled before a property listing is created.
User Requirement: Provide an intuitive interface for creating property listings,
including the ability to easily add images and associated information.
Software Requirement: Implement reliable image uploading and optimization (up
to 10MB) to maintain website performance.
Scenario 2: Identifying sections
Scenario 2 use case: Administrator creates a new property
1. Identify system Users:
• System Administrator
2. User Goal:
• Create a new property in the system's database to be displayed to potential
buyers/renters.
3. Describe the course:
• Administrator is logged into the system.
• Administrator has access to the CRUD menu in the admin section.
• The administrator navigates to the CRUD menu and selects "Create Property."
• The webpage presents a property creation form with these fields:
o Title o Image upload (required, up
o Description to 10MB)
o Number of rooms o Price
o Number of bathrooms o Real Estate Agent
o Number of parking spaces
• Then, the administrator fills in all fields, selects the agent, and uploads property image.
• The system validates all input data, checks for proper formatting, required fields,
optimizes uploaded images and saves the property data and image file paths to the
database.
• Finally the webpage displays a success message in a green box in the admin index and
redirects the administrator to the updated admin index, now displaying the new
property making the new property visible in the public feed for potential
buyers/renters.
4. Alternate course of events:
• Administrator submits the form with missing or invalid data.
• System Response: System displays specific error messages next to the respective fields,
highlighting the issues, for example: "Please enter a valid price," "Image file size exceeds
10MB", etc.
• Administrator attempts to upload an image larger than 10MB or in an unsupported
format.
• System displays an error message indicating the issue and provides instructions for
acceptable file types and sizes.
5. Common course use case:
All the system administrators have the same use case course since nothing is different
for any admin and there is no admin levels that provide different privileges or special
functions.
Scenario 3: Deleting a property
Stimulus: Admin needs to delete a property because it was either sold or rented, first logs
in and then clicks on the red deletion button in the CRUD menu.
Stimulus source: Logging in and previously created a property for the feed.
Environment: The CRUD menu in the admin section of the page.
Artifact: A confirmation popup box that asks the user to confirm deletion of the
corresponding property.
Possibility to recover the deleted property in a time lapse.
Response: The webpage removes the property of the admin index section, to which also
the user is redirected to.
Response measure: PHP displays visual feedback in the index as a red box with a
success message, maintains user session and the property is deleted for the normal
users in the feed.
Scenario 3: Deleting a property requirements
Business Requirement: Implement a safety mechanism, such as a confirmation
popup, to prevent accidental deletion of property listings.
User Requirement: Offer the ability to recover accidentally deleted properties
within a specified timeframe.
Software Requirement: Ensure the property listing is removed from both the
admin index and the user-facing feed upon deletion.
Scenario 3: Identifying sections
Scenario 3 use case: Administrator deletes a property
Step 1: Identify System Users:
• System Administrator
Step 2: Define User Goal:
• Remove a property from the system's database and public view.
Step 3: Describe the Course:
Administrator logs into the system and navigates to the admin index displaying the list of
properties.
Administrator locates the property they want to delete and clicks the red "Delete" button
associated with that property. Then, the system displays a confirmation popup asking the
administrator to confirm their intention to delete the property, if confirmed, the administrator
clicks "Yes".
If not, the administrator clicks "No" or "Cancel."
System Response (If Confirmed):
• The webpage removes the property listing from the database and removes the property
listing from the admin index, as well as from the public user feed.
• System displays a red success message in the admin index.
Step 4: Alternate Courses of Events:
Administrator clicks "Cancel" in the confirmation popup and the system closes the popup and
does nothing. The property remains in the system.
Admin Action: (Implementation dependent) Administrator accesses a "Recently Deleted"
section within a specified timeframe.
System provides an option to restore the deleted property.
Step 5: Common Course Use Case:
All administrators will follow the same deletion process. But, their reasons for deleting
properties could vary.