byondpro

^{Functional Specifications}

×

Menu

Index

Search

(c) OpusXenta Pty Ltd, 2020

Location Code Management Tool Overview

Overview

This tool is a mechanism for restructuring and moving the cemetery locations of a cemetery. The business requirement of this tool is to allow the OpusXi users to update the location codes and location names of the locations which have been created beneath a particular cemetery.

In order to use this tool the users should have been granted the permission called "Can use Location Change Tool" which will be placed in the user profile of a particular user (refer to CRM Administration / Users). It is required to have the "Can use Location Change Tool" permission be selected to show the access link underneath "My CRM" drop down and the name of the access link is "Batch Location Code Update". Once the user clicks on the access link, the system navigates the users to the "Batch Location Code Update" page which includes the following functionalities.

#	Functionality (Usecase)	Business Problem	User Story
1	Change Single Location Code	OpusXi does not allow the users to change/edit the finalized location codes of locations in a cemetery.	As an OpusXi user, I will be able to change the finalized location code, so then I could be able to use the updated location code for the further transactions.
2	Change Multiple Location Codes
3	Move Single Location Code	OpusXi does not allow the users to move/shift the location/s from one section to another, even if the targeted section is in another area.	As an OpusXi user, I will be able to move/shift location/s from one section to another section even if the targeted section is in another area, so then I could be able to place the location/s underneath another section.
4	Move Multiple Location Codes
5	Find and Replace Location Names	OpusXi does not allow the users to find the location name/s by a text and replace the location name/s with a new text.	As an OpusXi user, I will be able to find the location name/s by a text and replace the location names with a new text, so then I could be able to update one or more location name/s at once.

Initial Screens

Screen 1

Location Code Management Tool

Batch Location Code Update

This is the first page shown to the user when they access the tool. It allows the user to identify the location codes to be changed.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Page Header	-	-	-	-	Text	-	-	-	-

Find Location

This is the main section of the page which contains the search filters.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Section Header	-	-	-	-	Text	-	-	-	-

Site

This contains the list of Site/cemetery names.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Combo Box	Pre-conditions: 1. There should be at least one registered Site/Cemetery.	List the Site names of the sites. 2.The format of the options of the combo box: <<Site Name>> (<<Site Code>>) ex:- St. Aloysius Cemetery (SAC) 3. The combo box allows the user to either input a value directly or select a value from the list.	-	Select a site	Text	-	-	Active	-

Area

This contains the list of Area names belonging to the selected Site/cemetery.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Combo Box	Pre-conditions: 1. There should be at least one created Area underneath the selected site.	List the Area names belonging to the selected site/cemetery. The format of the options of the combo box: <<Area Name>> (<<Area Code>>) ex:- Area One (A1) 3. When the user selects a Site, the related areas will be populated as the options of this combo box. 4. The combo box allows the user to either input a value directly or select a value from the list.	-	Select an Area	Text	-	-	Active	-

Area S1

This contains the list of Area S1 names belonging to the selected Area.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Combo Box	Pre-conditions: 1. There should be at least one created Area S1 underneath the selected Area.	List the Area S1 names belonging to the selected Area. 2. The format of the options of the combo box: <<Area S1 Name>> (<<Area S1 Code>>) ex:- Section One (S1) 3. When the user selects an Area, the related Area S1 will be populated as the options of this combo box. 4. The combo box allows the user to either input a value directly or select a value from the list.	-	Select an Area S1	Text	-	-	Active	-

Area S2

This contains the list of Area S2 names belonging to the selected Area S1.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Combo Box	Pre-conditions: 1. There should be at least one created Area S2 underneath the selected Area S1.	List the Area S2 names belonging to the selected Area S1. 2. The format of the options of the combo box: <<Area S2 Name>> (<<Area S2 Code>>) ex:- East Side (EAST) 3. When the user selects an Area S1, the related Area S2 will be populated as the options of this combo box. 4. The combo box allows the user to either input a value directly or select a value from the list.	-	Select an Area S2	Text	-	-	Active	-

Area S3

This contains the list of Area S3 names belonging to the selected Area S2.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Combo Box	Pre-conditions: 1. There should be at least one created Area S3 underneath the selected Area S2.	List the Area S3 names belonging to the selected Area S2. 2. The format of the options of the combo box: <<Area S3 Name>> (<<Area S3 Code>>) 3. When the user selects an Area S2, the related Area S3 will be populated as the options of this combo box. 4. The combo box allows the user to either input a value directly or select a value from the list.	-	Select an Area S3	Text	-	-	Active	-

Type

This contains the list of all the Location Types.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Combo Box	Pre-conditions: 1. There should be at least one Location Type created by the System Administrator.	List all the Location Type names. The format of the options of the combo box: <<Type Name>> (<<Type Code>>) 3. When the user selects a Site, all the Location types will be populated as the options of this combo box. 4. The combo box allows the user to either input a value directly or select a value from the options list.	-	Select a Type	Text	-	-	Active	-

Location Code

This allows to enter a location code.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Text Field	-	1. The format of the input value: <<Site Code>>-<<Area Code>>-<<Area S1 Code>>-<<Area S2 Code>>-<<Area S3 Code>>-<<Location Type Code>>-<<Location Code>>	-	Search by Location Code	Text	-	-	Active	-

Find

This is a function to search for locations that match the selection criteria.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Button	Post-conditions: 1. list down fetched records in the Results Table described in "Screen 2".	1. When the user clicks on the button, search/fetch the location records based on the selected values of the filters in the "Find Location" section. 1a. If all the search filters are blank/empty and click on "Find" button, display an ERROR message 2. Fetching records based on the "AND" operation between the selected values of the search filters.	-	-	-	-	-	Active/enabled	1a. Please select at least one search filter.

Clear

This is a function to clear and reset the search filter.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Button	Post-conditions: 1. Clear values from the search filters. 2. Clear values from the Results Table.	-	-	-	-	-	-	Active/enabled	-

Screen 2

Location Code Management Tool

Batch Location Code Update

Refer Batch Location Code Update

Find Location

Refer Find Location
For more details about the search filters - refer Site, Area, Area S1, Area S2, Area S3, Type, Location Code

Find

Refer Find

Clear

Refer Clear

Info Text

This provides selection guidelines to select records from Results Table, in order to interact with the available functions.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Info Text	-	For more details, refer Info Text in Possible Scenarios section.	-	-	Text	-	-	-	-

Possible Scenarios

	Selected values from search filters							Filtered records when clicks on the "Find" button	Info Text	Remarks
#	Site	Area	Area S1	Area S2	Area S3	Type	Location	Filtered records when clicks on the "Find" button	Info Text	Remarks
1	SAC	-	-	-	-	-	-	All the locations belongs to SAC	Select ONLY one location to change its "Type" segment and "Location" segment. If you select more than one location but less than all locations, you will not be able to change the "Site" segment of the location codes. "Select All" locations in order to change ONLY the site segment of the location codes.	1a. When the user selects all the locations of the "Site", the system allows the user to change ONLY the "Site" segment of the location codes. 1b. When the user selects all the locations of a particular "Area" - refer 2a. 1c. When the user selects all the locations of a particular "Area S1", which the "Area S1" is in a same "Area" - refer 3a. 1d. When the user selects all the locations of a particular "Area S2", which the "Area S2" is in a same "Area S1" and a same "Area" - refer 4a. 1e. When the user selects all the locations of a particular "Area S3", which the "Area S3" is in a same "Area S2", a same "Area S1" and a same "Area" - refer 5a.
2	SAC	A1	-	-	-	-	-	The locations belongs to A1 of SAC	Select one location to change its "Type" segment and "Location" segment (Change Single location code). "Select All" locations to change the "Area" segment. Select a range of location codes to change "Location type" and/or renumber the locations (This info message should be changed).	2a. When the user selects all the locations of an "Area", the system allows the user to change ONLY the "Area" segment of the location codes.
3	SAC	A1	S1	-	-	-	-	The locations belongs to S1 which the S1 is in A1 of SAC	Select one location to change its "Type" segment and "Location" segment. "Select All" locations to change the "Area S1" segment. Select a range of location codes to change "Location type" and/or renumber the locations (This info message should be changed).	3a. When the user selects all the locations of an "Area S1", the system allows the user to change ONLY the "Area S1" segment of the location codes.
4	SAC	A1	S1	EAST	-	-	-	The locations belongs to EAST (Area S2) in S1 which the S1 is in A1 of SAC	Select one location to change its "Type" segment and "Location" segment. "Select All" locations to change the "Area S2" segment. Select a range of location codes to change "Location type" and/or renumber the locations (This info message should be changed).	4a. When the user selects all the locations of an "Area S2", the system allows the user to change ONLY the "Area S2" segment of the location codes.
5	SAC	A1	S1	EAST	LEFT	-	-	The locations belongs to LEFT (Area S3) in EAST (Area S2) of S1 which the S1 is in A1 of SAC	"Select one location to change its "Type" segment and "Location" segment. "Select All" locations to change the "Area S3" segment. Select a range of location codes to change "Location type" and/or renumber the locations (This info message should be changed).	5a. When the user selects all the locations of an "Area S3", the system allows the user to change ONLY the "Area S3" segment of the location codes.
6	SAC	A1	S1	EAST	LEFT	807	-	The "807" typed locations belongs to LEFT (Area S3) in EAST (Area S2) of S1 which the S1 is in A1 of SAC	"Select one location to change its "Type" segment and "Location" segment. "Select All" locations to change the "Area S3" segment. Select a range of location codes to change "Location type" and/or renumber the locations (This info message should be changed).	6a. When the user selects more than one location of a same "Type", the system allows the user to change ONLY the "Type" segment and the "Location" of the location codes.
7	Either these Filters are selected or not selected						SAC-A1-S1-EAST-LEFT-807-LOC1	Only the LOC1	Select one location to change its "Type" segment and "Location" segment.	7a. As this is a single location code change, the system allows the user to change ONLY the "Type" segment and the "Location" of the location code.

Change Single Location Code

This is a functional button to navigate the user to the page which includes the "Change Single Location Code" section.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Button	Post-conditions: Navigate the user to Change Single Location Code page and show the followings. Show the Location Code of the record underneath the Change From, which the record has been selected from Results Table. Show the details of the selected record underneath the Selected Records Table.	1. This button will be enabled/active, when the user selects ONLY one record from the Results Table 2. This button will be disabled/inactive, when the user selects less than one record or selects more than one record (i.e. including "Select All") from the Results Table.	-	-	-	-	-	Inactive/disabled	-

Change Multiple Location Codes

This is a functional button to navigate the user to the page which includes the "Change Multiple Location Codes" section.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Button	Post-conditions: Navigate the user to Change Multiple Location Codes page and show the followings. Show the Info Text mentioning the count of records affected, which the records have been selected from Results Table. Show the details of the selected records underneath the Selected Records Table.	1. This button will be enabled/active, when the user selects MORE than one record(i.e. two or more including "Select All") from the "Results Table". 2. This button will be disabled/inactive, when the user selects less than two records from the "Results Table".	-	-	-	-	-	Inactive/disabled	-

Move Single Location Code

This is a functional button to navigate the user to the page which includes the "Move Single Location Code" section.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Button	Post-conditions: Navigate the user to Move Single Location Code page and show the followings. Show the Location Code of the record underneath the Move From which the record has been selected from Results Table. Show the details of the selected record underneath the Selected Records Table.	1. This button will be enabled/active, when the user selects ONLY one record from the Results Table. 2. This button will be disabled/inactive, when the user selects less than one record or selects more than one record (including "Select All").	-	-	-	-	-	Inactive/disabled	-

Move Multiple Location Codes

This is a functional button to navigate the user to the page which includes the "Move Multiple Location Codes" section.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Button	Post-conditions: Navigate the user to Move Multiple Location Codes page and show the followings. Show the Info Text mentioning the count of records affected, which the records have been selected from Results Table. Show the details of the selected records underneath the Selected Records Table.	1. This button will be enabled/active, when the user selects MORE than one record (i.e. two or more including "Select All") from the "Results Table". 2. This button will be disabled/inactive, when the user selects less than two records from the "Results Table".	-	-	-	-	-	Inactive/disabled	-

Find and Replace Location Names

This is a functional button to navigate the user to the page which includes the "Find and Replace Location Names" section.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Button	Post-conditions: Navigate the user to Find and Replace Location Names page and show the followings. Show the Info Text including the count of records, selected from Results Table. Show the details of the selected records underneath the Selected Records Table.	1. This button will be enabled/active, when the user selects ONE or MORE records (including "Select All") from the "Results Table". 2. This button will be disabled/inactive, when the user deselects all the records in the "Results Table".	-	-	-	-	-	Inactive/disabled	-

Results Table

This table includes the list of location records that meet the search criteria.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Table	-	1. This table allows the users to, sort all the columns except "Select All" column by ASC or DESC. move other pages by the navigator placed at the top right corner of the table. 2. If the system found records, show the text, placed at the top left corner of the table. The format of the text is <<search results count>> Locations, Page <<current page number>> of <<total pages count>> 3. If no results found, show the text "No Locations", placed at the top left corner of the table.	-	-	-	-	-	Sort the table by the column "Location Code" in ASC	-

Site

Column in the table showing Site Name and Site Code of each record.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Text	-	The format of the text: <<Site Name>> (<<Site Code>>)	-	-	Text	-	-	-	-

Area

Column in the table showing Area Name and Area Code of each record.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Text	-	The format of the text: <<Area Name>> (<<Area Code>>)	-	-	Text	-	-	-	-

Area S1

Column in the table showing Area S1 Name and Area S1 Code of each record.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Text	-	The format of the text: <<Area S1 Name>> (<<Area S1 Code>>)	-	-	Text	-	-	-	-

Area S2

Column in the table showing Area S2 Name and Area S2 Code of each record.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Text	-	The format of the text: <<Area S2 Name>> (<<Area S2 Code>>)	-	-	Text	-	-	-	-

Area S3

Column in the table showing Area S3 Name and Area S3 Code of each record.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Text	-	The format of the text:<<Area S3 Name>> (<<Area S3 Code >>)	-	-	Text	-	-	-	-

Type

Column in the table showing Type and Type Code of each record.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Text	-	The format of the text:<<Type Name>> (<<Type Code >>)	-	-	Text	-	-	-	-

Location Name

Column in the table showing Location Name of each record.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Text	-	The format of the text: <<Location Name>>	-	-	Text	-	-	-	-

Location Code

Column in the table showing Location Code of each record.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Text	-	The format of the text: <<Site Code>>-<<Area Code>>-<<Area S1 Code>>-<<Area S2 Code>>-<<Area S3 Code>>-<<Location Type Code>>-<<Location Code>>	-	-	Text	-	-	-	-

Select All

Column in the table that identifies which Location record in the results table are to be included in to the functions.

Type	Notes	Rules	Compulsory	Placeholder	Format	Edit	Size	Default	Messages
Check Box	-	1. "Select All" allows to select or deselect all the records included in the Results Table 2. Allows manual selection by user to select or deselect against individual line items.	-	-	-	-		Unchecked / Unticked	-

The contents of Location Code Management Tool

Change Single Location Code

Change Multiple Location Codes

Move Single Location Code

Move Multiple Location Codes

Find and Replace Location Names

The online help was created with Dr.Explain