Download as docx, pdf, or txt
Download as docx, pdf, or txt
You are on page 1of 81

Business Requirement Document

Yard Management System

Business Requirement Document (BRD)

Document version 0.6

This document contains proprietary information of NEC Technologies India Ltd. Unauthorized access,
copying and replication are prohibited. This document must not be copied in whole or part by any means,
without the written authorization of NEC Technologies India Ltd, Noida, India.
Business Requirement Document

Revision History

Version Date Author Reviewer Section Significant


Changes

0.1 18/02/2019 BA Team NECTI New Created

0.2 28/02/2019 BA Team NECTI Added table field


description and
formats, user
management
module,
error/warning list
and dashboard
screen

0.3 01/03/2019 BA Team NECTI After adding


operational
dashboard details

0.4 06/03/2019 BA Team NECTI Updated after


incorporating the
review comments

0.5 12/03/2019 BA Team NECTI Updated the BRs,


screenshots and
UCs post internal
discussion and
added upload
formats

0.6 24/04/2019 BA Team NECTI Updated after


review comments
incorporation and
post first demo
comments

YMS Revision No: 0.6 Page 2 of 81


Business Requirement Document

Table of Contents

Revision History............................................................................................................................................2
1 Introduction............................................................................................................................................5
1.1 Purpose.......................................................................................................................................5
1.2 Scope..........................................................................................................................................6
2 Overall System Description....................................................................................................................7
2.1 Overview.....................................................................................................................................7
2.2 Definitions, Acronyms & Abbreviations........................................................................................7
2.3 User Interface Specifications......................................................................................................7
3 Masters Modules....................................................................................................................................9
3.1 Yard Maintenance Module...........................................................................................................9
3.1.1 Overview..................................................................................................................................9
3.1.2 Screen & Field Description......................................................................................................9
3.1.2.1 Yard Search(SCR-YMB-01)....................................................................................................... 9
3.1.2.2 Yard ADD (SCR-YMB-02)........................................................................................................ 11
3.1.3 Masters Batch........................................................................................................................12
3.1.4 Business Rules......................................................................................................................12
3.1.5 Use Case Summary..............................................................................................................12
3.1.6 Use Case Description............................................................................................................13
3.2 Zone Maintenance Module........................................................................................................15
3.2.1 Overview................................................................................................................................15
3.2.2 Screen & Field Description....................................................................................................16
3.2.2.1 Zone Search (SCR-ZMB-01)................................................................................................... 16
3.2.2.2 Zone Add (SCR-ZMB-02)........................................................................................................ 17
3.2.3 Masters Batch........................................................................................................................18
3.2.4 Business Rules......................................................................................................................18
3.2.5 Use Case Summary..............................................................................................................18
3.2.6 Use Case Description............................................................................................................19
3.3 Location Maintenance Module..................................................................................................21
3.3.1 Overview................................................................................................................................21
3.3.2 Screen & Field Description....................................................................................................21
3.3.2.1 Location Search (SRCH-LOC-01)...........................................................................................21
3.3.3 Masters Batch........................................................................................................................23
3.3.4 Business Rules......................................................................................................................23
3.3.5 Use Case Summary..............................................................................................................24
3.3.6 Use Case Description............................................................................................................24
4. Inbound Container Management Module.............................................................................................25
4.3 Overview...................................................................................................................................25
4.4 Screen & Field Description........................................................................................................25
4.4.1 Search - Inbound Container Management Screen (SCR-INB-01)........................................25
4.4.1.1 Add – Inbound Container Management Screen (SCR-INB-02).........................................28
4.4.2 Upload – Inbound Container Management Screen (SCR-INB-03).......................................31
4.4.3 Container Tagging Screen (HHT) (SCR-INB-04)...................................................................31
4.4.4 Receiving Task Screen (SCR-INB-05)..................................................................................32
4.5 Batch.........................................................................................................................................33
4.6 Business Rules..........................................................................................................................33
4.7 Use Case Summary..................................................................................................................34
4.8 Use Case Description...............................................................................................................35
5. Outbound Module.................................................................................................................................41

YMS Revision No: 0.6 Page 3 of 81


Business Requirement Document

5.1 Overview...................................................................................................................................41
5.2 Screen & Field Description........................................................................................................41
5.2.1 Search - Outbound Container Management Screen (SCR-OUB-01).........................................41
5.2.2 Add – Outbound Container Management Screen (SCR-OUB-02)........................................43
5.2.3 Upload – Outbound Container Management Screen (SCR-OUB-03)...................................44
5.2.4 Picking screen (SCR-PCK-01)..............................................................................................44
5.3 Batch.........................................................................................................................................45
5.4 Business Rules..........................................................................................................................45
5.5 Use Case Summary..................................................................................................................47
5.6 Use Case Description...............................................................................................................48
5.7 Batch.........................................................................................................................................53
6. Container Management Module...........................................................................................................54
6.2 Overview...................................................................................................................................54
6.3 Screen & Field Description........................................................................................................54
6.3.2 List - Container View Screen (SCR-CM-01)..........................................................................54
6.3.3 Map - Container View Screen (SCR-CM-02).........................................................................56
6.3.4 Container Transaction History Screen (SCR-CM-03)............................................................57
6.3.5 Task Management Screen (SCR-CM-04)..............................................................................60
6.3.6 Task Dashboard Screen (SCR-CM-05).................................................................................62
6.3.7 Relocate Task Screen (SCR-CM-06).....................................................................................63
6.4 Batch.........................................................................................................................................64
6.5 Business Rules..........................................................................................................................64
6.6 Use Case Summary..................................................................................................................65
6.7 Use Case Description...............................................................................................................66
7. User Management Module...................................................................................................................72
7.2 Overview...................................................................................................................................72
7.3 Screen & Field Description........................................................................................................72
7.3.2 List – User List Screen (SCR-USR-01).................................................................................72
7.3.3 User ADD Screen (SCR-USR-02).........................................................................................74
7.4 Batch.........................................................................................................................................75
7.5 Business Rules..........................................................................................................................75
7.6 Use Case Summary..................................................................................................................75
7.7 User Case Description..............................................................................................................75
8. Operational Dashboard........................................................................................................................78
9. Web Services.......................................................................................................................................80
9.1 Login Web Service....................................................................................................................80
9.2 Container Tagging Service........................................................................................................80
9.3 Tag Scanning at Gate Service...................................................................................................80
9.4 Container Transaction Update Data Service.............................................................................80
10. Putaway Strategy.............................................................................................................................81

YMS Revision No: 0.6 Page 4 of 81


Business Requirement Document

1 Introduction

1.1 Purpose
The purpose of this document is to define the system requirements of Yard Management System (YMS).
These requirements are derived from the day to day operation managed at the yard

The Objective of this system is to optimizing the operations , increasing the efficiency and availability of
Real time data by incorporating the below solutions

1. Capture the Requisition of Incoming/Outgoing Container at Yard in the proposed system


2. Define/create and Map the Physical location with the Yard into the proposed system through web
UI
3. Automate & speed up movement of Container within the Yard through the Automated Gate-in
(Bar-code Scanning) & Container Storage Process
4. Track the Real time current location of Container through Map based web UI
5. Optimized Container Storage and Retrieval Suggestions
6. Record & Track every movement & trail of Container

YMS Revision No: 0.6 Page 5 of 81


Business Requirement Document

1.2 Scope

The scope of this document is to understand software requirement specifications of the Yard
Management Solution as a while. There are various parts to this document as described below:
 Modules
 Screens
 Batches
 Interfaces & field description

YMS Revision No: 0.6 Page 6 of 81


Business Requirement Document

2 Overall System Description

2.1 Overview
The objective of yard management system is to support and manage the inbound, outbound and storage
operations in a yard. This particular document covers all the modules in the solution.

2.2 Definitions, Acronyms & Abbreviations

YMS Yard Management System

RCV Receiving

PUT Put-away

REL Relocation

PIC Picking

DIS Dispatched

2.3 User Interface Specifications

S. No. Type Screen ID Screen Name


Web Screen SCR-INB-01 Search - Inbound Container Management
1 screen

Web Screen SCR-INB-02 Add - Inbound Container Management


2 screen

Web Screen SCR-INB-03 Upload - Inbound Container Management


3 screen

4 HHT Screen SCR-INB-04 Container Tagging Screen

5 Web Screen SCR-INB-05 Receiving Task Screen

6 Web Screen SCR-CM-01 List – Container View Screen

7 Web Screen SCR-CM-02 Map – Container View Screen

8 Web Screen SCR-CM-03 Container Transaction History Screen

9 Web Screen SCR-CM-04 Task Management Screen

10 Web Screen SCR-CM-05 Task Dashboard Screen

11 Web Screen SCR-CM-06 Relocate Task Screen

12 Web Screen SCR-YMB-01 Yard Search

YMS Revision No: 0.6 Page 7 of 81


Business Requirement Document

13 Web Screen SCR-YMB-02 Yard Add

14 Web Screen SCR-ZMB-01 Zone Search

15 Web Screen SCR-ZMB-02 Zone Add

16 Web Screen SCR-LOC-01 Location Search

Web Screen SCR-OUB-01 Search - Outbound Container Management


17 Screen

Web Screen SCR-OUB-02 Add – Outbound Container Management


18 Screen

Web Screen SCR-OUB-03 Upload – Outbound Container


19 Management Screen

20 Web Screen SCR-PCK-01 Picking screen

21 Web Screen SCR-USR-01 User List Screen

22 Web Screen SCR-USR-02 User Add Screen

YMS Revision No: 0.6 Page 8 of 81


Business Requirement Document

3 Masters Modules

3.1 Yard Maintenance Module

3.1.1 Overview
This module will enable the user to define Yard Code and set up some basic policies like Average Turn
around Time etc along with Yard Address.

This screen will have 2 sub modes


1. Search Mode – where Users would be able to search the records based on some input parameter and
this is the default mode whenever the yard screen will be opened
2. Add Mode – This mode designed to add new yard Code manually or generated automatically from
background and defining some of the basic policies pertaining to yard.

3.1.2 Screen & Field Description


3.1.2.1 Yard Search(SCR-YMB-01)

S. Screen
No Field Control Type Len Format Required Description Example
. Name
1 Yard Code Drop Down 4-15 YRD- N If user has
XXXX-XXX- access to 1
NN yard only then
it will be pre
filled else user YRD-ACTL-
may choose DLI-01

2 Yard Text Box N Yard


Name 50 XXXX..XX Description

YMS Revision No: 0.6 Page 9 of 81


Business Requirement Document

3 Country Text Box N Country Name


50 XXXXX..XX India

4 State Text Box N State


30 XXXX..XX Delhi

5 City Text Box 30 XXXX..XX N City Delhi

Search Result

S. Screen Control Type Len Format Required Description Example


No. Field
Name

1 Yard Code Output Text 4-15 YRD- N ID of a


XXXX-XXX- specific yard YRD-ACTL-
NN DLI-01

2 Yard Output Text 50 XXXX..XX N Yard Alpha numeric


Name Description and no special
character

3 Average Output Text 5 NNNNN N Average turn-


TAT for around time
Import for Import
cycle

4 Average Output Text 5 NNNNN N Average turn-


TAT for around time
Export for Import
cycle

3.1.2.2 Yard ADD (SCR-YMB-02)

YMS Revision No: 0.6 Page 10 of 81


Business Requirement Document

S.
Screen Field Control Require
No Len Format Description Example
Name Type d
.
1 Yard Code Text Box 4-15 YRD-XXXX- N ID of a YRD-ACTL-
XXX-NN specific yard DLI-01

2 Yard Name Text Box Y Yard


50 XXXX..XX Description alphanumeric

3 Country Text Box N Country


50 XXXXX..XX Name India

4 State Text Box N State


30 XXXX..XX Delhi

5 City Text Box 30 XXXX..XX Y City Delhi

6 Address_line1 Text Box 50 XXXXX..XX N Address


line1

7 Address_line2 Text Box 50 XXXX..XX N Address


line2

8 Address_line3 Text Box 50 XXXXX..XX N Address


line3

9 Postal Code Text Box 10 XX..XX N Postal code

10 Email ID Text Box 50 XXXXX..XX N Email Id

11 Contact No Text Box 50 NN..NN N Contact


Number

12 Average TAT Text Box 5 NNNNN N Average


for Export turn-around
time for
export
containers

13 Average TAT Text Box 5 NNNNN N Average


for Import turn-around
time for
Import
containers

14 Supervisor Text Box 50 XXXXX..XX N Supervisor


Name Name

YMS Revision No: 0.6 Page 11 of 81


Business Requirement Document

3.1.3 Masters Batch

3.1.4 Business Rules

Business Rule ID Business Rule


If Yard Code is not manually entered then should be generated by
BR_YMB_01
system

If mandatory field like Yard name is not entered then system should
BR_ YMB_02
throw an error while saving the record
Search will be performed on the basis of “Like” logic for string fields,
BR_ YMB_03
i.e., when the user types some characters, similar search results will
be auto displayed in the dropdown below that field textbox for quick
selection by the user

3.1.5 Use Case Summary

S. No. Use Case ID Use Case Description

1 UC_YMB_SRCH_01 When a user performs search based on the search


parameters

2 UC_YMB_SRCH_02 When a user views a specific yard row from the search
grid

3 UC_YMB_SRCH_03 When a user edits a specific yard row from the search
grid

4 UC_YMB_SRCH_04 When a user adds a new yard manually in the system

5 UC_YMB_SRCH_05 When a user create new zones under yard Code

3.1.6 Use Case Description

Use Case ID: UC_YMB_SRCH_01

YMS Revision No: 0.6 Page 12 of 81


Business Requirement Document

Use Case Description When a user performs search based on the search parameters

Screen ID: SCR-YMB-01

Triggering Event: Click on Yard Maintenance under Menu

Preconditions: NA

Normal Flow: 1. User enters any of the below search criteria:


 Yard Code (should be defaulted in case of single yard Code is
assigned to user else user will have to select from drop down)
 Yard Name (Should be Like search)
 Country(should be auto completed after entering 3 characters)
 State (should be auto completed and work only if country is selected)
 City (should be auto completed and same as State(country and state
should be selected before selecting this))
2. User clicks “Search” button
3. After clicking on “Search” button data will display in grid according to
search condition

Alternative Flows: Refer Use case Id UC_YMB_SRCH_02, UC_YMB_SRCH_03,


UC_YMB_SRCH_04
Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_YMB_SRCH_02

Use Case Description When a user views a specific yard row from the search grid

Screen ID: SCR-YMB-01

Triggering Event: When user wants to view a specific yard details, View button is clicked.

Preconditions: NA

Normal Flow: 1. After the search results have been displayed in the grid, user clicks
“View” button for a specific yard Code
2. After clicking on “View” button data, same screen as SCR-YMB-02
will be opened but with disabled field, where user can only view the
details
3. User clicks “Back” button is redirected to the search screen SCR-
YMB-01
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_YMB_SRCH_03

Use Case Description When a user edits a specific yard row from the search grid

YMS Revision No: 0.6 Page 13 of 81


Business Requirement Document

Screen ID: SCR-YMB-01

Triggering Event: When user wants to edit a specific container details, Edit button is clicked.

Preconditions: NA

Normal Flow: 1. After the search results have been displayed in the grid, user clicks
“Edit” button for a specific yard row
2. After clicking on “Edit” button data, same screen as SCR-YMB-02 will
be opened.
Only yard Code field will be disabled, rest all fields can be edited.
3. User clicks on “Save” button
4. A success message “Changes saved successfully” is displayed and
is redirected to the search screen SCR-YMB-01 with updated
container details.

Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_YMB_SRCH_04

Use Case Description When a user adds a new yard manually in the system

Screen ID: SCR-YMB-02

Triggering Event: When user wants to add new yard manually, Add tab is clicked.

Preconditions: NA

Normal Flow: 1. In the Add screen, enter the below container details:
 Yard Code
 Yard Name (Mandatory)
 Yard Code Address (which includes various fields)
Address Line1
Address Line2
Address Line3
City
State
Postal code
Country Name
Supervisor Name
Contact No
Average Turn Around Time for Export
Average Turn Around Time for Import

2. After adding the details, click on “Add” button -> a success message
is displayed “Changes saved successfully”

Alternative Flows: NA

YMS Revision No: 0.6 Page 14 of 81


Business Requirement Document

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_YMB_SRCH_05

Use Case Description When a user add zones under Yard Code

Screen ID: SCR-ZMB-02

Triggering Event: When user wants to create new zones.

Preconditions: NA

Normal Flow: If user wants to create new zones under Yard Code then he should be able to
create by clicking on the “Create Zones”button against any of the rows based
on search parameter displayed in the grid
Alternative Flows:

Exceptions: All violation to Business Rules will trigger appropriate Error Message

3.2 Zone Maintenance Module

3.2.1 Overview
All yard are divided into area called zones and each zone is designated to either contain container with
specific attributes like Çontainer type ,commodity code etc or contain mixed containers in case of space
crunch

This screen is segregated into 2 modes


1. Zone search mode: Which allows user to search zone based on certain input parameters.
2. Add mode: which enables user to add new zone under yard Code

YMS Revision No: 0.6 Page 15 of 81


Business Requirement Document

3.2.2 Screen & Field Description


3.2.2.1 Zone Search (SCR-ZMB-01)

Screen Field Control


S. No. Len Format Required Description Example
Name Type
1 Zone Code Dropdow 4-15 ZN-XXXX- N Zone ZN-XXXX-
n NN abbreviation 01

2 Yard Code Auto Y Yard Code YRD-


Complete YRD-XXXX- ACTL-DLI-
4-15 XXX-NN 01

3 Zone Type Drop N Type of


Down 50 XX Zone

When user inputs either of the filed or do the blind search then in that case all the columns will be
displayed as shown in the screenshot

Field displayed in the grid while performing search

Sn Screen Require Exampl


Control Type Len Format Description
o Field Name d e

4-15 ZN- N Zone ZN-


1   Zone Code  Output Text XXXX- abbreviation XXXX-
NN 01

YMS Revision No: 0.6 Page 16 of 81


Business Requirement Document

 Height
2  above sea  Output Text    Y    
level
 Zone
 3  Output Text        
type
 Zone Max
4             
Stackability

3.2.2.2 Zone Add (SCR-ZMB-02)

Screen
Sn Control Descriptio
Field Len Format Required Example
o Type n
Name
4-15 ZN- N Zone
 Zone
 1  Text Box XXXX- abbreviation
Code
NN ZN-XXXX-01
YRD- Y Yard Code
 Auto
XXXX-
2   Yard Code Complet
XXX- YRD-ACTL-DLI-
e
4-15 NN 01
How many
 Zone container
3  Maximum  Text Box  20    N we can put  
Stackability on one on
another
 Height  Height of
 4 above sea  Text Box  20    N zone above      
level sea level
Drop Type of
5 Zone Type 50 Y    
Down zone
Zone Zone
6 Text Box 100 Y    
Description description

3.2.3 Masters Batch

YMS Revision No: 0.6 Page 17 of 81


Business Requirement Document

3.2.4 Business Rules

Business Rule ID Business Rule


User can either manually enter Zone Code else it should be
BR_ ZMB_01
generated by system
User can edit any fields of zone except “Yard Code field”at any point
BR_ ZMB_02
of time
Primary Key will be combination of System generated Zone Code
BR_ ZMB_03
and Manually entered Zone Code (which will also be unique)
If Particular Zone is not empty then no fields of that zone should
BR_ ZMB_04
be editable
If any Zone is updated then same should be updated against all the
BR_ ZMB_05
locations or sub zones assigned to that particular Zone Code
If the Zone type is storage then Zone Stackability field should be a
BR_ ZMB_06
mandatory field and it’s value should be greater than 1 else this
field is not editable
Search will be performed on the basis of “Like” logic for string fields,
BR_ ZMB_07
i.e., when the user types some characters, similar search results will
be auto displayed in the dropdown below that field textbox for quick
selection by the user

3.2.5 Use Case Summary

S. No. Use Case ID Use Case Description

1 UC_ZMB_SRCH_01 When a user performs search based on the search


parameters

2 UC_ ZMB_SRCH_02 When a user views a specific Zone row from the search
grid

3 UC_ ZMB_SRCH_03 When a user edits a specific Zone row from the search
grid

6 UC_ ZMB_SRCH_04 When a user adds a new Zone manually in the system

3.2.6 Use Case Description

Use Case ID: UC_ZMB_SRCH_01

Use Case Description When a user performs search based on the search parameters

YMS Revision No: 0.6 Page 18 of 81


Business Requirement Document

Screen ID: SCR-ZMB-01

Triggering Event: Click on Zone Maintenance under Menu

Preconditions: NA

Normal Flow: 1. User enters any of the below search criteria:


 Yard Code (should be defaulted in case of single yard Code
is assigned to user else yard Code should be selected from
drop down)
 Zone Code (Drop down)
 Zone type(Drop down)
2. User clicks “Search” button
3. After clicking on “Search” button data will display in grid according to
search condition

Alternative Flows: Refer Use case Id UC_ZMB_SRCH_02, UC_ZMB_SRCH_03

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_ZMB_SRCH_02

Use Case Description When a user views a specific Zone Code row from the search grid

Screen ID: SCR-ZMB-01

Triggering Event: When user wants to view a specific Zone details, View button is clicked.

Preconditions: NA

Normal Flow: 1. After the search results have been displayed in the grid, user clicks
“View” button for a specific Zone Code
2. After clicking on “View” button data, same screen as SCR-ZMB-02
will be opened but with disabled field, where user can only view the
details
3. User clicks “Back” button is redirected to the search screen SCR-
ZMB-01
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_ZMB_SRCH_03

Use Case Description When a user edits a specific Zone Code row from the search grid

Screen ID: SCR-INB-01

Triggering Event: When user wants to edit a specific zone details, Edit button is clicked.

Preconditions: NA

YMS Revision No: 0.6 Page 19 of 81


Business Requirement Document

Normal Flow: 1. After the search results have been displayed in the grid, user clicks
“Edit” button for a specific yard row
2. After clicking on “Edit” button data, same screen as SCR-ZMB-02 will
be opened.
Only yard Code. field will be disabled, rest all fields can be edited.
3. User clicks on “Save” success message “Changes saved
successfully” is displayed and is redirected to the search screen
SCR-ZMB-01 with updated zone details.

Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_ZMB_SRCH_04

Use Case Description When a user adds a new Zone manually in the system

Screen ID: SCR-ZMB-02

Triggering Event: When user wants to add new zone manually, Add tab is clicked.

Preconditions: NA

Normal Flow: 1. In the Add screen, enter the below container details:
 Zone Code.
 Zone Description
 Zone type (Required)
 Zone maximum Stackability
 Height above sea level(required)

2. After adding the details, click on “Save” button -> a success message
is displayed “Changes saved successfully” and is redirected to the
search screen SCR-ZMB-01 with new Zone details added
3. If the user does not want to save the yard details, then “Back” button
is clicked and is redirected to the search screen SCR-ZMB-01 without
new zone details

Alternative Flows:

Exceptions: All violation to Business Rules will trigger appropriate Error Message

3.3 Location Maintenance Module

3.3.1 Overview
It is designed to search a location based on certain input parameters Location will be set up at the time of
configuring the Yard.

YMS Revision No: 0.6 Page 20 of 81


Business Requirement Document

3.3.2 Screen & Field Description

3.3.2.1 Location Search (SRCH-LOC-01)

Screen
S. Require
Field Control Type Len Format Description Example
No. d
Name
1 Location Generated from 10 LN-XXXX-NN N Location
Code background number

2 Yard Code Auto complete YRD-XXXX- Y Yard Code YRD-ACTL-


4-15 XXX-NN DLI-01

3 Sub-zone Auto complete 4-15 ZN-XXXX-NN N Sub-zone


Code abbreviation ZN-XXXX-01

4 Zone Auto complete 4-15 ZN-XXXX-NN N Zone


Code abbreviation ZN-XXXX-01

5 Location Dropdown EMPTY N Location


Status status

FULL

6 Location Dropdown N
Size

When user inputs either of the filed or do the blind search then in that case all the columns will be displayed as
shown in the screenshot

Field displayed in the grid while performing search:

YMS Revision No: 0.6 Page 21 of 81


Business Requirement Document

Screen
Sn Require Exampl
Field Control Type Len Format Description
o d e
Name
4-15 ZN-XXXX-NN N Zone ZN-
 Zone
1   Output Text abbreviatio XXXX-
Code
n 01
4-15 ZN-XXXX-NN N Sub-zone ZN-
Sub zone
2   Output Text abbreviatio XXXX-
Code
n 01
Location 10 LN-XXXX-NN N Location
 3  Output Text
Code number
N Yard Code YRD-
Yard
4 Output Text YRD-XXXX- ACTL-
Code
4-15 XXX-NN DLI-01
Pick up
5 Sequenc Output Text N
e
Travel
6 Sequenc Output Text N
e
7 Latitude Output Text N

Longitud
8 Output Text N
e
5 Location Output Text 00-Empty N Location
Status status

1- Filled

upto 1

level

2- Filled

upto 2

nd level

3- Filled

upto 3rd

YMS Revision No: 0.6 Page 22 of 81


Business Requirement Document

level

6 Location Output Text N


Size

3.3.3 Masters Batch

3.3.4 Business Rules

Business Rule ID Business Rule


Even from backend Location should only be deleted when it’s
BR_LSB_01
corresponding location status =”00”

Search will be performed on the basis of “Like” logic for string fields,
BR_LSB_02
i.e., when the user types some characters, similar search results will
be auto displayed in the dropdown below that field textbox for quick
selection by the user

3.3.5 Use Case Summary

S. No. Use Case ID Use Case Description

1 UC_LOC_SRCH_01 When a user performs search based on the search


parameters

3.3.6 Use Case Description


Use Case ID: UC_LOC_SRCH_01

Use Case Description When a user performs search based on the search parameters

Screen ID: SRCH-LOC-01

Triggering Event: Click on Location Search under Menu

Preconditions: NA

Normal Flow: 1. User enters any of the below search criteria:


4. Yard Code (should be defaulted)

YMS Revision No: 0.6 Page 23 of 81


Business Requirement Document

5. Zone Code (Drop down)


6. Sub Zone Code(auto complete)
7. Location status (drop down)
Empty(whenever there is no container)
Full
8. Location size(Drop Down)

2. User clicks “Search” button


3. After clicking on “Search” button data will display in grid according to
search condition

Alternative Flows: If the user does not enter any search criteria , then default yard Code should
always should be assigned as input parameter
Exceptions: All violation to Business Rules will trigger appropriate Error Message

YMS Revision No: 0.6 Page 24 of 81


Business Requirement Document

4. Inbound Container Management Module

4.3 Overview
Inbound Container Management screen details out the container details with respect to an order and lets
you start the Receiving process for these containers, add the container, add the RFID tags to the
container and bulk upload of the container details also.

4.4 Screen & Field Description

4.4.1 Search - Inbound Container Management Screen (SCR-INB-01)

S.
Screen Field Name Control Type Len Format Required Description Example
No.
1 Yard Code Textbox Y Yard Code YRD-
YRD-XXXX- ACTL-
4-15 XXX-NN DLI-01

2 Container No. Textbox 11 XX..XX N Unique


container
number

3 Customer Code Textbox N Unique


customer
30 XX..XX code

4 Status Dropdown N Expected

In Progress

YMS Revision No: 0.6 Page 25 of 81


Business Requirement Document

Completed

5 Expected Receipt Date Calendar N The


Control expected
date and
Date DDMMYY
time for
receipt of the
Time HH:MM:SS containers

Search Results

1 Container No. Output Text 11 XX..XX N Unique


container
number

2 Container Type Output Text 15 XX..XX N Open Top,


etc.

3 Commodity Code Output Text 30 XX..XX N

4 Weight Output Text 8,2 NNNNN.NN N Weight of the


container

5 Line Agent Code Output Text

6 Line Agent Name Output Text

7 Consolidator Code Output Text

8 Cycle Type Output Text 30 N Import

Export

Empty

9 Expected Receipt Date & Output Text Date DDMMYY N The


Time Time HH:MM:SS expected
date and
time for
receipt of the
containers

10 Expected Dispatch Date Output Text N The


& Time expected
date and
time for
dispatch of
Date DDMMYY the
Time HH:MM:SS containers

YMS Revision No: 0.6 Page 26 of 81


Business Requirement Document

11 RFID Tag ID Output Text 30 XX..XX Unique tag


N ID of RFID

12 Customer Code Output Text N Unique


customer
30 XX..XX code

13 Container Size Output Text 5 XXXXX Size of the


N container

14 Refrigerated Output Text 1 N N Flag


indicating if
container
contains
refrigerated
item

15 Hazardous Output Text 1 N N Flag


indicating if
container
contains
hazardous
item

16 CHA Code Output Text

17 Seal No. Output Text

18 Is Sealed Output Text

19 Prefer Stacking<Level 3 Output Text 1 N N Level


number used
for stacking
the container

20 Status Output Text N Expected

In Progress

Completed

21 Container Condition Textbox

22 IsEmpty Flag 1 Y/N

23 Shipping Line Code Textbox

24 Shipping Line Name Textbox

25 Consolidator Name Textbox

26 CHA Name Textbox

27 Transporter Name Textbox

YMS Revision No: 0.6 Page 27 of 81


Business Requirement Document

28 Transporter Code Textbox

4.4.1.1 Add – Inbound Container Management Screen (SCR-INB-02)

S.
Screen Field Name Control Type Len Format Required Description Example
No.
1 Container No. Textbox 11 XX..XX Y Unique
container
number

2 Container Type Textbox 15 XX..XX Y Open Top,


etc.

YMS Revision No: 0.6 Page 28 of 81


Business Requirement Document

3 Commodity Code Textbox 30 XX..XX N

4 Weight Textbox 8,2 NNNNN.NN N Weight of the


container

5 Cycle Type Textbox 30 Y Import

Export

Empty

6 Expected Receipt Date & Calendar Date DDMMYY Y The


Time Control Time HH:MM:SS expected
date and
time for
receipt of the
containers

7 Expected Dispatch Date Calendar Date DDMMYY N The


& Time Control Time HH:MM:SS expected
date and
time for
dispatch of
the
containers

8 RFID Tag ID Textbox 30 XX..XX Unique tag


N ID of RFID

9 Customer Code Textbox N Unique


customer
30 XX..XX code 30

10 Container Size Textbox 5 XXXXX Size of the


Y container

11 Refrigerated Output Text 1 N N Flag


indicating if
container
contains
refrigerated
item

12 Hazardous Output Text 1 N N Flag


indicating if
container
contains
hazardous
item

YMS Revision No: 0.6 Page 29 of 81


Business Requirement Document

13 Prefer Stacking<Level 3 Textbox 1 N N Level


number used
for stacking
the container

14 Weight Check Flag 1 Y/N N Flag to check


whether
container
weight is
same or not

15 Line Agent Name Textbox

16 Line Agent Code Textbox

17 Consolidator Code Textbox

18 CHA Code Textbox

19 Seal No. Textbox

20 Is Sealed Flag 1 Y/N Flag to check


whether
container is
sealed or not

21 Container Condition Textbox

22 IsEmpty Flag 1 Y/N

23 Shipping Line Code Textbox

24 Shipping Line Name Textbox

25 Consolidator Name Textbox

26 CHA Name Textbox

27 Transporter Name Textbox

28 Transporter Code Textbox

YMS Revision No: 0.6 Page 30 of 81


Business Requirement Document

4.4.2 Upload – Inbound Container Management Screen (SCR-INB-03)

S.
Screen Field Name Control Type Len Format Required Description Example
No.
1 File Path Textbox Y Directory
path of the
file to be
uploaded

4.4.3 Container Tagging Screen (HHT) (SCR-INB-04)

S.
Screen Field Name Control Type Len Format Required Description Example
No.
1 Container No. Textbox 11 XX..XX Y There is no
restriction in
container no
field that user
cannot enter
duplicate
value- it will
override the
value in DB

2 RFID Tag ID Textbox 30 XX..XX Y This field will


be scanned to
complete the
linking with
container

YMS Revision No: 0.6 Page 31 of 81


Business Requirement Document

4.4.4 Receiving Task Screen (SCR-INB-05)

S.
Screen Field Name Control Type Len Format Required Description Example
No.
1 Container No Text Box 11 XX..XX Y Unique
container
number

2 Location Text Box 10 LN-XXXX-NN Y Location


number

3 Zone Text Box 4-15 ZN-XXXX- Y Zone ZN-


NN abbreviation XXXX-
01

4.5 Batch

YMS Revision No: 0.6 Page 32 of 81


Business Requirement Document

4.6 Business Rules

Business Business Rule


Rule ID
A container from the search results can be edited/deleted only if its status is “Expected”, not
BR_INB_
for “In Progress/Completed”, In other words if status is other than “Expected” then both
01
delete and edit button should be disabled

A checkbox for each Container row will be enabled only when its status is “Expected” and
BR_INB_
Tagging has already been done, it will be disabled when status is “In Progress/Completed”
02
After a container has been edited or deleted, the search results will be retained as per the
BR_INB_
previous search criteria
03
If a search parameter has been entered, then the search results will be displayed
BR_INB_
accordingly, if it has been left blank, then a list of containers in the system will be displayed
04
Status for each container can be:
BR_INB_
05 Expected

In Progress

Completed

A container cannot be added if mandatory fields have not been filled in the Container Receipt
BR_INB_
Management screen, it will throw an error
06
When a user bulk
BR_INB_
07 uploads a file which is corrupt or blank, then an error will be generated

If no valid task exist against scanned RFID tag while performing receiving Task then an error
BR_INB_
will be generated “No Valid Inbound Tasks Exist”
08
When a user bulk uploads a file/Add Manually with duplicate records, data for all the active
BR_INB_
containers will be ignored.
09
Task status should be changed to “In Progress” based on the container which he has
BR_INB_
clamped
10
Unassigned button should be disabled when no user is assigned to that task
BR_INB_
11

YMS Revision No: 0.6 Page 33 of 81


Business Requirement Document

If User would select a date range of more than 3 months for searching a Inbound Container
BR_INB_
then he should get an error “Invalid Date Range”
12
While Tagging , Systme should check whther that Tag is linked with any active container in
Yard , If yes then in that case system should throw an error “Scanned Tag already linked to
another Container”

If user Decalmped the container other than suggested Zone then system should prompt a
message “Alert : Current Zone is different from Suggested Zone “

For bulk upload, what should be condition for inbound order creation,
BR_INB_
12 New inbound order can be created if,

1. container is not present in the inventory

2. No expected inbound order is already present

Should define a default zone code for Gate In and the same should be displayed in task
BR_INB_
13
Search will be performed on the basis of “Like” logic for string fields, i.e., when the user
BR_INB_
14 types some characters, similar search results will be auto displayed in the dropdown
below that field textbox for quick selection by the user

4.7 Use Case Summary

S. No. Use Case ID Use Case Description

1 UC_INB_SRCH_01 When a user performs search based on the search


parameters

2 UC_INB_SRCH_02 When a user views a specific container row from the


search grid

3 UC_INB_SRCH_03 When a user edits a specific container row from the


search grid

4 UC_INB_SRCH_04 When a user deletes a specific container row from the


search grid

5 UC_INB_SRCH_05 When a user performs Receiving for selected containers


from the list

6 UC_INB_ADD_01 When a user adds a new container manually in the


system

7 UC_INB_UPLD_01 When a user bulk uploads the containers in the system


through an excel sheet using Upload option

8 UC_INB_TAG_01 When a user scans the RFID Tag to link the tag with the
Container No.

YMS Revision No: 0.6 Page 34 of 81


Business Requirement Document

9 UC_RCV_SRCH_02 User acknowledge the Receiving Task

4.8 Use Case Description

Use Case ID: UC_INB_SRCH_01

Use Case Description When a user performs search based on the search parameters

Screen ID: SCR-INB-01

Triggering Event: When user clicks on Inbound Container Maintenance Screen Under Menu

Preconditions: NA

Normal Flow: 4. User enters any of the below search criteria:


 Yard Code (Mandatory)
 Container No.
 Customer Code
 Status
 Expected Receipt Date
5. User clicks “Search” button
6. After clicking on “Search” button data will display in grid according to
search condition in “Status” Sort Order where containers with
“Completed” status will be displayed in the last
7. If no record found as per the search parameter, then no data will
display.
8. Searching will be done on the basis of BR_INB_04 rule.
Alternative Flows: If the user does not enter any search criteria except Yard Code, then all the
containers uploaded in the system will be displayed
Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_INB_SRCH_02

Use Case Description When a user views a specific container row from the search grid

Screen ID: SCR-INB-01

Triggering Event: When user wants to view a specific container details, View button is clicked.

Preconditions: NA

YMS Revision No: 0.6 Page 35 of 81


Business Requirement Document

Normal Flow: 4. After the search results have been displayed in the grid, user clicks
“View” button for a specific container row
5. After clicking on “View” button data, same screen as SCR-INB-02 will
be opened but with disabled field, where user can only view the
container details
6. User clicks “Back” button is redirected to the search screen SCR-INB-
01
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_INB_SRCH_03

Use Case Description When a user edits a specific container row from the search grid

Screen ID: SCR-INB-01

Triggering Event: When user wants to edit a specific container details, Edit button is clicked.

Preconditions: NA

Normal Flow: 5. After the search results have been displayed in the grid, user clicks
“Edit” button for a specific container row
6. After clicking on “Edit” button data, same screen as SCR-INB-02 will
be opened.
Only Container No. field will be disabled, rest all fields can be edited.
7. User clicks on “Add” button
8. A success message “Changes saved successfully” is displayed and
is redirected to the search screen SCR-INB-01 with updated
container details.
9. Editing will be done on the basis of BR_INB_01 and BR_INB_03
rules
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_INB_SRCH_04

Use Case Description When a user deletes a specific container row from the search grid

Screen ID: SCR-INB-01

Triggering Event: When user wants to delete a specific container details, Delete button is
clicked.

Preconditions: NA

Normal Flow: 1. After the search results have been displayed in the grid, user clicks
“Delete” button for a specific container row
2. After clicking on “Delete” button data, a warning message is

YMS Revision No: 0.6 Page 36 of 81


Business Requirement Document

displayed “Are you sure you want to delete this container”


3. User clicks on “Yes” button -> Container row is deleted and the
screen is redirected to the search screen SCR-INB-01 without that
container details.
4. User clicks on “No” button -> Container row is not deleted and the
screen is redirected to the search screen SCR-INB-01 still with that
container details.
5. Deletion will be done on the basis of BR_INB_01 and BR_INB_03
rules
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_INB_SRCH_05

Use Case Description When a user performs Receiving for selected containers from the list

Screen ID: SCR-INB-01

Triggering Event: When user wants to generate inbound tasks for multiple selected containers,
Receive button is clicked.

Preconditions: NA

Normal Flow: 1. After the search results have been displayed in the grid, user selects
a specific or multiple containers using the checkboxes in the list
2. User clicks on the “Receive” button
3. A success message is displayed “Inbound Tasks created
successfully” and order status would be changed to “In Progress
4. In cases where a container already has an inbound task generated,
“Receiving button should be disabled”
5. Receiving will be done on the basis of BR_INB_02 rule.
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_INB_ADD_01

Use Case Description When a user adds a new container manually in the system

Screen ID: SCR-INB-02

Triggering Event: When user wants to add a new container manually, Add tab is clicked.

Preconditions: NA

Normal Flow: 3. In the Add screen, enter the below container details:
 Container No. (Mandatory)
 Container Type (Mandatory)
 Commodity code
 Weight
 Cycle Type (Mandatory)
 Expected Receipt Date & Time (Mandatory)

YMS Revision No: 0.6 Page 37 of 81


Business Requirement Document

 Expected Dispatch Date & Time


 RFID Tag ID
 Customer code
 Container Size (Mandatory)
 Refrigerated/Hazardous
 Prefer Stacking < Level 3
 Weight check
4. After adding the details, click on “Add” button -> a success message
is displayed “Changes saved successfully
5. Adding a container will be done on the basis of BR_INB_06 rule.
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_INB_UPLD_01

Use Case Description When a user bulk uploads the containers in the system through a CSV file
using Upload option

Screen ID: SCR-INB-03

Triggering Event: When user wants to add multiple containers not manually, Upload tab is
clicked.

Preconditions: NA

Normal Flow: 1. In the upload screen, click the “Browse” button and select the excel
sheet to be uploaded
2. After the file path has been filled in with details, then click “Upload”
button -> a success message “Bulk Upload successful” is displayed.
3. Uploading containers will be done on the basis of BR_INB_07 and
BR_INB_10 rules

upload_inb.xlsx

Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_INB_TAG_01

Use Case Description When a user scans the RFID Tag to link the tag with the Container No.

Screen ID: SCR-INB-04

Triggering Event: When user wants to link the RFID Tag with the container No. using HHT

YMS Revision No: 0.6 Page 38 of 81


Business Requirement Document

device, Container Tagging screen is used.

Preconditions: NA

Normal Flow: 1. In the HHT device, navigate to Container Tagging screen


2. Enter the Container No. field
3. After the container no. field is filled in, scan for the RFID Tag to be
generated -> a success message “Linking successful” is displayed.
4. Tagging will be done on the basis of BR_INB_08 and BR_INB_09
rules.
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_RCV_SRCH_01

Use Case Description Performing Receiving task

Screen ID: SCR-INB-05

Triggering Event: When user acknowledge the task

Preconditions: NA

Normal Flow: 1. When user clamp the container , then container no should be populated
automatically.
2. Then it’s destination location location and destination zone both should
be pre-filled
3. User can view the source location in map by clicking on view map button
4. If user de-clamp the container other than suggested location then pop up
message should appear(“violating the putaway strategy”) and after
pressing enter user can proceed to deposit the container at any location.
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

YMS Revision No: 0.6 Page 39 of 81


Business Requirement Document

YMS Revision No: 0.6 Page 40 of 81


Business Requirement Document

5. Outbound Module

5.1 Overview
Outbound Container Management screen details out the container details with respect to an order
and lets you start the picking process for these containers, add the container, and bulk upload of the
picking container details also.

5.2 Screen & Field Description

5.2.1 Search - Outbound Container Management Screen (SCR-OUB-01)

S. Exa
Screen Field Name Control Type Len Format Required Description
No. mple
1 Container No. Textbox 11 XX..XX N Unique
container
number

2 Customer Code Textbox N Unique


30 XX..XX customer code

3 Status Dropdown N Planned

In Progress

Pick completed

Dispatched

4 Expected Dispatch Date Calendar N The expected


Date DDMMYY
Control date and time
for dispatch of
Time HH:MM:SS the containers

YMS Revision No: 0.6 Page 41 of 81


Business Requirement Document

Search Results

6 Commodity Code Output Text 30 XX..XX N

7 Container No Output Text 11 XX..XX N Unique


container
number

8 Order Status Output Text N Planned

In-progress

Pick Completed

Dispatched

9 Trailer Output Text N

10 Transporter Name Output Text N

11 Consignee Name Output Text N

12 Ship To Address Output Text N

13 Instruction Output Text N

14 Expected Dispatch Date Output Text N The expected


date and time
Date DDMMYY for dispatch of
Time HH:MM:SS the containers

15 Actual Dispatch Date Output Text N The actual date


and time for
Date DDMMYY dispatch of the
Time HH:MM:SS containers

5.2.2 Add – Outbound Container Management Screen (SCR-OUB-02)

YMS Revision No: 0.6 Page 42 of 81


Business Requirement Document

S.
Screen Field Name Control Type Len Format Required Description Example
No.
1 Container No. Textbox 11 XX..XX Y Unique
container
number

2 Trailer Textbox Y

3 Transporter Name Textbox N

4 Consignee Textbox N

5 Ship to Address Textbox Y

6 Expected Dispatch Date Calendar N The


& Time Control expected
date and
time for
dispatch of
Date DDMMYY the Date
Time HH:MM:SS containers Time

7 Weight Check Flag 1 Y/N N Flag to check


whether
container
weight is
same or not

8 De-Stuffing Textbox N

5.2.3 Upload – Outbound Container Management Screen (SCR-OUB-03)

S.
Screen Field Name Control Type Len Format Required Description Example
No.
1 File Path Textbox Y Directory

YMS Revision No: 0.6 Page 43 of 81


Business Requirement Document

path of the
file to be
uploaded

5.2.4 Picking screen (SCR-PCK-01)

S. Screen Field Name Control Type Len Format Required Description


No. Example

1 Container No Text Box 11 XX..XX Y Unique


container
number

2 Source Location Text Box 10 LN-XXXX-NN Y Location


number of
the source
from where
the container
will be picked

3 To Zone Text Box 4-15 ZN-XXXX- Y Zone to


NN which the ZN-
container XXXX-
will be kept 01

YMS Revision No: 0.6 Page 44 of 81


Business Requirement Document

5.3 Batch

5.4 Business Rules

Business Business Rule


Rule ID
A container from the search results can be edited/deleted only if its status is “Planned”,
BR_OUB_0
not for “PickCompleted/In Progress/Dispatched”
1
A checkbox for each container row will be enabled only when its status is “Planned”, it will
BR_OUB_0
be disabled when status is “In Progress/Dispatched”
2
After a container has been edited or deleted, the search results will be retained as per the
BR_OUB_0
previous search criteria
3
If a search parameter has been entered, then the search results will be displayed
BR_OUB_0
accordingly, if it has been left blank, then a list of containers in the system will be
4
displayed

Status for each container can be:


BR_OUB_0
5 Planned

In Progress

Pick completed

Dispatched

A container cannot be added if mandatory fields have not been filled in the Container
BR_OUB_0
Order Management screen, it will throw an error
6
When a user bulk uploads a file which is corrupt or blank, then an error will be generated
BR_OUB_0
7
Dispatch button should be enabled for those orders which are in “Planned” status
BR_OUB_0
8
Outbound task against the container for which the task is already there in “Created
BR_OUB_0

YMS Revision No: 0.6 Page 45 of 81


Business Requirement Document

status” should not be created again


9
In case Yard destuffing is marked , then on Pick Task completion the Order status will be
BR_OUB_1
changed to Dispatched, else in case of Factory destuffing the Order status will be
0
changed to Pick Completed

When the user deposit or de-clamped the Container if:


BR_OUB_11

User deposits in the correct destination zone, the task will be marked as completed and
order status will be as BR_OUB_10

User deposits in the wrong destination zone, and opt yes while completing the task than
Task status will be marked as completed and order status will be as BR_OUB_10

User deposits in the wrong destination zone, and opt no while completing the task than
Task status for this particular will be marked as completed and a new pick task will be
created to move this container from current location to intended Out bound location and
order status will remain as In-progress

In Task Dashboard, Only tasks which are in created status should be Displayed,
BR_OUB_1
2 Task status

1. Created
2. Acknowledged
3. In Progress
4. Completed

If User would select a date range of more than 3 months for searching a Outbound
BR_OUB_1
Container then he should get an error “Invalid Date Range”
3
Outbound task should be created only for those containers either which are Ëxpected / In
BR_OUB_1
Progress(Referring to Inbound Order) or stored in yard
4
If user will not clamp the intended container (Against which Task is not assigned to that
BR_OUB_1
user) then system should throw below error message
5
Case 1: User has clamped container altogether from Different location

Error 1: Invalid Location

Case 2: User has clamped different container in order to reach the intended container

Error 2: “This is not the correct container to be picked, Please keep it elsewhere to reach
the intended Container”

For a bulk upload


BR_OUB_1
6 New outbound order can be created if,

1. container is present in the inventory or expected inbound order is present

2. No expected outbound order is already present

YMS Revision No: 0.6 Page 46 of 81


Business Requirement Document

Should define a default zone code for Gate OUT and the same should be displayed in
BR_OUB_1
task
7
Search will be performed on the basis of “Like” logic for string fields, i.e., when the
BR_OUB_1
8 user types some characters, similar search results will be auto displayed in the
dropdown below that field textbox for quick selection by the user

5.5 Use Case Summary

S. No. Use Case ID Use Case Description

1 UC_OUB_SRCH_01 When a user performs search based on the search


parameters

2 UC_OUB_SRCH_02 When a user views a specific container row from the


search grid

3 UC_OUB_SRCH_03 When a user edits a specific container row from the


search grid

4 UC_OUB_SRCH_04 When a user deletes a specific container row from the


search grid

5 UC_OUB_SRCH_05 When a user performs Outbound Process for selected


containers from the list

6 UC_OUB_ADD_01 When a user adds a new container manually in the


system

7 UC_OUB_UPLD_01 When a user bulk uploads the containers in the system


through an excel sheet using Upload option

8 UC_TASK_SRCH_01 User can assign the tasks when task is in Pending status

9 UC_TASK_SRCH_02 Supervisor can unassigned the task when the task is


either in “Pending , Acknowledged or In Progress” status

10 UC_PCK_SRCH_02 User scan the container through Picking screen

5.6 Use Case Description

Use Case ID: UC_OUB_SRCH_01

Use Case Description When a user performs search based on the search parameters

Screen ID: SCR-OUB-01

YMS Revision No: 0.6 Page 47 of 81


Business Requirement Document

Triggering Event: When user want to list current containers which are uploaded in the system,
Search button is clicked.

Preconditions: NA

Normal Flow: 1. User enters any of the below search criteria:


9. Container No.
10.Customer Code
11.Status
12.Expected Dispatch Date
2. User clicks “Search” button
3. After clicking on “Search” button data will display in grid according to
search condition in “Status” Sort Order where containers with
“Completed” status will be displayed in the last
4. If no record found as per the search parameter, then no data will
display.

Alternative Flows: If the user does not enter any search criteria, then all the containers uploaded
in the system will be displayed
Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_OUB_SRCH_02

Use Case Description When a user views a specific yard row from the search grid

Screen ID: SCR-OUB-01

Triggering Event: When user clicks on Outbound Container Maintenance Screen under Menu

Preconditions: NA

Normal Flow: 1. After the search results have been displayed in the grid, user clicks
“View” button for a specific yard Code
2. After clicking on “View” button data, same screen as SCR-OUB-02
will be opened but with disabled field, where user can only view the
details
3. User clicks “Back” button is redirected to the search screen SCR-
OUB-01
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_OUB_SRCH_03

Use Case Description When a user edits a specific container row from the search grid

YMS Revision No: 0.6 Page 48 of 81


Business Requirement Document

Screen ID: SCR-OUB-01

Triggering Event: When user wants to edit a specific container details, Edit button is clicked.

Preconditions: NA

Normal Flow: 1. After the search results have been displayed in the grid, user clicks
“Edit” button for a specific container row
2. After clicking on “Edit” button data, same screen as SCR-OUB-02 will
be opened.
Only Container No. field will be disabled, rest all fields can be edited.
3. User clicks on “Add” button
4. A success message “Changes saved successfully” is displayed and
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_OUB_SRCH_04

Use Case Description When a user deletes a specific container row from the search grid

Screen ID: SCR-OUB-01

Triggering Event: When user wants to delete a specific container details, Delete button is
clicked.

Preconditions: NA

Normal Flow: 1. After the search results have been displayed in the grid, user clicks
“Delete” button for a specific container row
2. After clicking on “Delete” button data, a warning message is
displayed “Are you sure you want to delete this container”
3. User clicks on “Yes” button -> Container row is deleted and the
screen is redirected to the search screen SCR-OUB-01 without that
container details.
4. User clicks on “No” button -> Container row is not deleted and the
screen is redirected to the search screen SCR-OUB-01 still with that
container details.

Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_OUB_SRCH_05

Use Case Description When a user performs Outbound of selected containers from the list

YMS Revision No: 0.6 Page 49 of 81


Business Requirement Document

Screen ID: SCR-OUB-01

Triggering Event: When user wants to generate Picking tasks for multiple selected containers,
Receive button is clicked.

Preconditions: NA

Normal Flow: 1. After the search results have been displayed in the grid, user selects
a specific or multiple containers using the checkboxes in the list
2. User clicks on the “Dispatch” button
3. A success message is displayed “Inbound Tasks created
successfully” and order status changed to Ïn Progress” from Planned
4. In cases where a container already has an outbound task generated,
“dispatch Button should be disabled
5. Picking will be done
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_OUB_ADD_01

Use Case Description When a user adds a new container manually in the system

Screen ID: SCR-OUB-02

Triggering Event: When user wants to add a new container manually, Add tab is clicked.

Preconditions: NA

Normal Flow: 1. In the Add screen, enter the below container details:
 Container No. (Mandatory)
 Trailer
 Transporter Name
 Consignee
 Ship to Address
 Expected Dispatch Date & Time (Mandatory)
 Instruction
 Weight check
2. After adding the details, click on “Add” button -> a success message
is displayed “Changes saved successfully”

Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_OUB_UPLD_01

Use Case Description When a user bulk uploads the containers in the system through a CSV using
Upload option

Screen ID: SCR-OUB-03

Triggering Event: When user wants to add multiple containers not manually, Upload tab is

YMS Revision No: 0.6 Page 50 of 81


Business Requirement Document

clicked.

Preconditions: NA

Normal Flow: 1. In the upload screen, click the “Browse” button and select the excel
sheet to be uploaded
2. After the file path has been filled in with details, then click “Upload”
button -> a success message “Bulk Upload successful” is displayed.
3. Uploading containers will be done on the basis of BR_OUB_07 rule.

upload_out.xlsx

Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_TASK_SRCH_01

Use Case Description When a user assign the picking task

Screen ID: SCR-CM-05

Triggering Event: Open task Dashboard screen

Preconditions: NA

Normal Flow: 1. Once the task is created


2. User can assign the task to himself when the task status in
Created Status
Alternative Flows:

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_TASK_SRCH_02

Use Case Description When a user de-assign the task

Screen ID: SCR-CM-04

Triggering Event: Open task maintenance screen

Preconditions: NA

Normal Flow: User can Unassign the task if it is “Created”status

Alternative Flows:

Exceptions: All violation to Business Rules will trigger appropriate Error Message

YMS Revision No: 0.6 Page 51 of 81


Business Requirement Document

Use Case ID: UC_PCK_SRCH_01

Use Case Description Performing Picking task

Screen ID: SCR-PCK-01

Triggering Event: When user assign the task

Preconditions: NA

Normal Flow: 1. Once user clamped the intended container then container no , source
location and source Zone would be auto populated
2. Updation of Order status and task status should be changed based
on BR_OUB_10 and BR_OUB_11
Alternative Flows:

Exceptions: All violation to Business Rules will trigger appropriate Error Message

5.7 Batch

YMS Revision No: 0.6 Page 52 of 81


Business Requirement Document

6. Container Management Module

6.2 Overview
Container Management screen allows a user to view a list of containers, create relocation tasks, view the
yard map based on certain parameters, view the transaction history of containers and manage different
kinds of tasks.

6.3 Screen & Field Description

6.3.2 List - Container View Screen (SCR-CM-01)

S.
Screen Field Name Control Type Len Format Required Description Example
No.
1 Yard Code Textbox Y Yard Code YRD-
YRD-XXXX- ACTL-
4-15 XXX-NN DLI-01

2 Container No. Textbox 11 XX..XX N Unique


container
number

3 Zone Code Textbox 4-15 ZN-XXXX- N Zone ZN-


NN abbreviation XXXX-
01

4 Location Code Textbox 10 LN-XXXX-NN N Location


number

5 Commodity Code Textbox 30 XX..XX N

YMS Revision No: 0.6 Page 53 of 81


Business Requirement Document

6 Cycle Type Textbox 30 N Import

Export

Empty

7 Customer Code Textbox N Unique


customer
30 XX..XX code

Search Results

1 Container No. Output Text 11 XX..XX N Unique


container
number

2 Zone Code Output Text 4-15 ZN-XXXX- N Zone ZN-


NN abbreviation XXXX-
01

3 Location Code Output Text 10 LN-XXXX-NN N Location


number

4 Container Type Output Text 15 XX..XX N Open Top,


etc.

5 Commodity Code Output Text 30 XX..XX N

6 Expected Weight Output Text 8,2 NNNNN.NN N Weight of the


container

7 Cycle Type Output Text 30 N Import

Export

Empty

8 Expected Receipt Date & Output Text Date DDMMYY N The


Time Time HH:MM:SS expected
date and
time for
receipt of the
containers

9 Expected Dispatch Date Output Text N The


& Time expected
date and
time for
dispatch of
Date DDMMYY the
Time HH:MM:SS containers

YMS Revision No: 0.6 Page 54 of 81


Business Requirement Document

10 Customer Code Output Text 30 XX..XX Unique


customer
N code

11 Container Size Output Text 5 XXXXX Size of the


N container

12 Refrigerated Output Text 1 N N Flag


indicating if
container
contains
refrigerated
item

13 Hazardous Output Text 1 N N Flag


indicating if
container
contains
hazardous
item

14 Status Output Text N Expected

In Progress

Completed

6.3.3 Map - Container View Screen (SCR-CM-02)

YMS Revision No: 0.6 Page 55 of 81


Business Requirement Document

S.
Screen Field Name Control Type Len Format Required Description Example
No.
1 Yard Code Textbox Y Yard Code YRD-
YRD-XXXX- ACTL-
4-15 XXX-NN DLI-01

2 Container No. Textbox 11 XX..XX N Unique


container
number

3 Zone Code Textbox 4-15 ZN-XXXX- N Zone ZN-


NN abbreviation XXXX-
01

4 Location Code Textbox 10 LN-XXXX-NN N Location


number

6.3.4 Container Transaction History Screen (SCR-CM-03)

YMS Revision No: 0.6 Page 56 of 81


Business Requirement Document

S.
Screen Field Name Control Type Len Format Required Description Example
No.
1 Yard Code Textbox Y Yard Code YRD-
YRD-XXXX- ACTL-
4-15 XXX-NN DLI-01

2 Container No. Textbox 11 XX..XX N Unique


container
number

3 Date Range Calendar Date DDMMYY N The date


range for
viewing
containers
transactions

4 Cycle Type Textbox 30 N Import

Export

Empty

5 Operation Code Textbox 3 N RCV

PUT

REL

PIC

YMS Revision No: 0.6 Page 57 of 81


Business Requirement Document

DIS

6 Customer Code Textbox 30 XX..XX Unique


customer
N code

Search Results

1 Container No. Output Text 11 XX..XX N Unique


container
number

2 Cycle Type Output Text 30 N Import

Export

Empty

3 Commodity Code Output Text 30 XX..XX N

4 Customer Code Output Text 30 XX..XX Unique


customer
N code

5 Operation Code Output Text N RCV

PUT

REL

PIC

3 DIS

6 Date Output Text Date DDMMYY N The date for


viewing
containers
transactions

7 Time Output Text Time Hh:mm:ss N The time for


viewing
containers
transactions

8 Location Output Text 10 LN-XXXX-NN N Location


number

6.3.5 Task Management Screen (SCR-CM-04)

YMS Revision No: 0.6 Page 58 of 81


Business Requirement Document

S.
Screen Field Name Control Type Len Format Required Description Example
No.
1 Yard Code Textbox Y Yard Code YRD-
YRD-XXXX- ACTL-
4-15 XXX-NN DLI-01

2 Container No. Textbox 11 XX..XX N Unique


container
number

3 Operation Code Textbox N RCV

PUT

REL

PIC

3 DIS

4 Status Textbox N Expected

In Progress

Completed

5 Container Size Textbox 5 XXXXX Size of the


N container

6 Cycle Type Textbox 30 N Import

Export

YMS Revision No: 0.6 Page 59 of 81


Business Requirement Document

Empty

Search Results

1 Container No. Output Text 11 XX..XX N Unique


container
number

2 Operation Code Output Text N RCV

PUT

REL

PIC

3 DIS

3 Task ID Output Text 12 TSK-XXX- N ID of each


NNNN task which is
unique

4 From Zone Output Text 4-15 ZN-XXXX- N Zone from


NN where ZN-
container XXXX-
was picked 01

5 From Location Output Text 10 LN-XXXX-NN N Location


from where
container
was picked

6 To Zone Output Text 4-15 ZN-XXXX- N Zone where ZN-


NN container XXXX-
was put 01

7 To Location Output Text 10 LN-XXXX-NN N Location


where
container
was put

8 Status Output Text N Expected

In Progress

Completed

9 User ID Output Text N System


generated
field

YMS Revision No: 0.6 Page 60 of 81


Business Requirement Document

6.3.6 Task Dashboard Screen (SCR-CM-05)

S.
Screen Field Name Control Type Len Format Required Description Example
No.
Inbound Tasks

1 Number of Active Tasks Output Text N

2 Location Output Text 10 LN-XXXX-NN N Location


Code

Outbound/Relocation Tasks

1 Container No. Output Text 11 XX..XX N Unique


container
number

2 Source Location Output Text 10 LN-XXXX-NN N Location of


the source

3 Zone Code Output Text 4-15 ZN-XXXX- N Zone Code ZN-


NN XXXX-
01

4 Date Output Text Date DDMMYY N The date for


viewing

YMS Revision No: 0.6 Page 61 of 81


Business Requirement Document

containers
transactions

5 Order No. Output Text 15 XXX..XX N Order ID


which is
unique for
each
container

6 Task ID Output Text 12 TSK-XXX- N ID of each


NNNN task which is
unique

6.3.7 Relocate Task Screen (SCR-CM-06)

S.
Screen Field Name Control Type Len Format Required Description Example
No.
1 Container No. Textbox 11 XX..XX Y Unique
container
number

2 Source Location Textbox 10 LN-XXXX-NN Y Location of


the source

3 To Zone Textbox 4-15 ZN-XXXX- Y Zone Code


NN where the ZN-
container XXXX-
will be put 01

YMS Revision No: 0.6 Page 62 of 81


Business Requirement Document

6.4 Batch

6.5 Business Rules

Business Rule ID Business Rule


If a search parameter has been entered, then the search results will be
BR_CM_01
displayed accordingly, if it has been left blank, then a list of containers
for a specific yard (as yard Code is a mandatory field) will be displayed.

The search results can be displayed for the last 6 months.

Relocation tasks will be created for the selected containers from the
BR_CM_02
search results in container view list screen

In case, relocation tasks have already been created for any of the
BR_CM_03
selected containers, then on performing relocation again, an error will
be thrown to re-perform selection

The default view of the container view map screen will be of the yard as
BR_CM_04
per the filled in yard Code

The default From and To date range selected will be of previous 1 week
BR_CM_05
to the current date in container transaction history screen

Download button will be enabled only after search results have been
BR_CM_06
loaded in container transaction history screen

Tasks will be unassigned for the selected containers from the search
BR_CM_07
results in task management screen

Tasks can only be unassigned by the supervisor when it’s status is


BR_CM_08
“Acknowledged” else corresponding check box will be disabled for
other statuses

Inbound tasks can be acknowledged as soon as “Acknowledge” button


BR_CM_09
is pressed and it will redirect to the Receiving Task screen

Outbound tasks can be assigned as soon as “Assign” button is pressed


BR_CM_10
against each task and it will redirect to the Picking Task screen

Relocation tasks can be assigned as soon as “Assign” button is pressed


BR_CM_11
against each task and it will redirect to the Relocate Task screen

Search will be performed on the basis of “Like” logic for string fields,
BR_CM_12
i.e., when the user types some characters, similar search results will
be auto displayed in the dropdown below that field textbox for quick
selection by the user

YMS Revision No: 0.6 Page 63 of 81


Business Requirement Document

6.6 Use Case Summary

S. No. Use Case ID Use Case Description

1 UC_CM_01 When a user performs search based on the search


parameters in Container View List Screen

2 UC_CM_02 When a user performs Relocation for selected containers


from the list

3 UC_CM_03 When a user views the map based on different


parameters in the Container View Map Screen

4 UC_CM_04 When a user performs search based on the search


parameters in Container Transaction History Screen

5 UC_CM_05 When a user downloads the search list from the Container
Transaction History Screen

6 UC_CM_06 When a user performs search based on the search


parameters in Task Management Screen

7 UC_CM_07 When a user unassigns the selected containers from the


list in Task Management screen

8 UC_CM_08 When a user acknowledges the inbound tasks from the


Task Dashboard screen

9 UC_CM_09 When a user assigns the outbound task to himself from


the Task Dashboard screen

10 UC_CM_10 When a user assigns the relocation task to himself from


the Task Dashboard screen

6.7 Use Case Description

Use Case ID: UC_CM_01

Use Case Description When a user performs search based on the search parameters in Container
View List Screen

Screen ID: SCR-CM-01

Triggering Event: When user want to list current containers which are uploaded in the system,
Search button is clicked.

Preconditions: NA

YMS Revision No: 0.6 Page 64 of 81


Business Requirement Document

Normal Flow: 1. User enters any of the below search criteria:


 Yard Code (Mandatory)
 Container No.
 Zone Code
 Location Code
 Commodity Code
 Cycle Type
 Customer Code
2. User clicks “Search” button
3. After clicking on “Search” button data will display in grid according to
search condition in “Status” Sort Order where containers with
“Completed” status will be displayed in the last
4. If no record found as per the search parameter, then no data will
display.
5. Searching will be done on the basis of BR_CM_01 rule.
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_CM_02

Use Case Description When a user performs Relocation for selected containers from the list

Screen ID: SCR-CM-01

Triggering Event: When user wants to generate relocation tasks for multiple selected
containers, Relocate button is clicked.

Preconditions: NA

Normal Flow: 1. After the search results have been displayed in the grid, user selects
a specific or multiple containers using the checkboxes in the list
2. User clicks on the “Relocate” button
3. A success message is displayed “Relocation Tasks created
successfully” and Pop up should be appeared where user needs to
enter “Reason code “ for that transfer and reason code should be
maintained from back end
4. In cases where a container already has a relocation task generated,
an error message will be displayed for re-selection of the containers
5. Relocation will be done on the basis of BR_CM_02 and BR_CM_03
rules.
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_CM_03

Use Case Description When a user views the map based on different parameters in the Container

YMS Revision No: 0.6 Page 65 of 81


Business Requirement Document

View Map Screen

Screen ID: SCR-CM-02

Triggering Event: When user wants to view a map for specific locations or containers, Map tab
is opened

Preconditions: NA

Normal Flow: 1. Click the Map tab on the Container View Screen
2. Enter the Yard Code parameter -> map view of that yard will be
displayed
3. If user enters Container No./Zone Code/Location Code fields, then
corresponding map view is displayed with container highlighted
4. When the field values are removed, the map will default to yard view
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_CM_04

Use Case Description When a user performs search based on the search parameters in Container
Transaction History Screen

Screen ID: SCR-CM-03

Triggering Event: When user want to view container specific transaction history, Search button
is clicked.

Preconditions: NA

Normal Flow: 1. User enters any of the below search criteria:


 Yard Code (Mandatory)
 Container No.
 Date Range
 Cycle Type
 Operation Code
 Customer Code
2. User clicks “Search” button
3. After clicking on “Search” button, all the transactional data for the last
6 months will be displayed container no. wise with values as shown in
SCR-CM-03
4. If no record found as per the search parameter, then no data will
display.
5. Searching will be done on the basis of BR_CM_05 rule.
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

YMS Revision No: 0.6 Page 66 of 81


Business Requirement Document

Use Case ID: UC_CM_05

Use Case Description When a user downloads the search list from the Container Transaction
History Screen

Screen ID: SCR-CM-03

Triggering Event: When user want to download the container specific transaction history in a
PDF file, Download button is clicked.

Preconditions: NA

Normal Flow: 1. User enters any of the below search criteria:


 Yard Code (Mandatory)
 Container No.
 Date Range
 Cycle Type
 Operation Code
 Customer Code
2. User clicks “Search” button
3. After clicking on “Search” button, all the transactional data for the last
6 months will be displayed container no. wise with values as shown in
SCR-CM-03
4. User can click now on the “Download” button -> a csv file will be
downloaded with all the data as shown in the search result
5. Searching will be done on the basis of BR_CM_05 and BR_CM_06
rule.
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_CM_06

Use Case Description When a user performs search based on the search parameters in Task
Management Screen

Screen ID: SCR-CM-04

Triggering Event: When user want to view the tasks assigned to users, Search button is clicked.

Preconditions: NA

Normal Flow: 1. User enters any of the below search criteria:


 Yard Code (Mandatory)
 Container No.
 Operation Code
 Status

YMS Revision No: 0.6 Page 67 of 81


Business Requirement Document

 Container Size
 Cycle Type
2. User clicks “Search” button
3. After clicking on “Search” button data will display in grid according to
search condition in “Status” Sort Order where containers with
“Completed” status will be displayed in the last
4. If no record found as per the search parameter, then no data will
display.
5. Searching will be done on the basis of BR_CM_01 rule.
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_CM_07

Use Case Description When a user unassigns the selected containers from the list in Task
Management screen

Screen ID: SCR-CM-04

Triggering Event: When user wants to unassign one or more tasks for selected containers,
Unassign button is clicked.

Preconditions: NA

Normal Flow: 1. After the search results have been displayed in the grid, user selects
a specific or multiple tasks using the checkboxes in the list
2. User clicks on the “Unassign” button
3. A success message is displayed “Tasks unassigned successfully”
4. In cases where a task has already been unassigned previously, an
error message will be displayed for re-selection of the tasks
5. Unassignment will be done on the basis of BR_CM_07 and
BR_CM_08 rules
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_CM_08

Use Case Description When a user acknowledges the inbound tasks from the Task Dashboard
screen

Screen ID: SCR-CM-05

Triggering Event: There are receiving tasks which are ready to be acknowledged

YMS Revision No: 0.6 Page 68 of 81


Business Requirement Document

Preconditions: NA

Normal Flow: 1. When there are active inbound tasks available for a user at a location
as seen in SCR-CM-05, user will click on “Acknowledge” button
2. It will redirect to Receiving screen (SCR-INB-05)
3. This will be done on the basis of BR_CM_09 rule
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_CM_09

Use Case Description When a user assigns the outbound task to himself from the Task Dashboard
screen

Screen ID: SCR-CM-05

Triggering Event: There are picking tasks which are ready to be assigned by the user

Preconditions: NA

Normal Flow: 1. When there are outbound tasks available for a user at a location as
seen in SCR-CM-05, user will click on “Assign” button to assign that
task to himself
2. It will redirect to Picking screen (SCR-PCK-01)
3. This will be done on the basis of BR_CM_10 rule
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_CM_10

Use Case Description When a user assigns the relocation task to himself from the Task Dashboard
screen

Screen ID: SCR-CM-05

Triggering Event: There are relocation tasks which are ready to be assigned by the user

Preconditions: NA

Normal Flow: 1. When there are relocation tasks available for a user at a location as
seen in SCR-CM-05, user will click on “Assign” button to assign that
task to himself
2. It will redirect to Relocate screen (SCR-CM-06)

YMS Revision No: 0.6 Page 69 of 81


Business Requirement Document

3. This will be done on the basis of BR_CM_11 rule


Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

YMS Revision No: 0.6 Page 70 of 81


Business Requirement Document

7. User Management Module

7.2 Overview
User management is module to create new users and assigning the role to Perform varios task
in the yards which are assigned to them
It is divided into 2 sub modules

User list – Which fetched the results based on the search parameter
ADD Mode- Which allows to create new user and giving the permission to the user to perform
task based on Roles

7.3 Screen & Field Description

7.3.2 List – User List Screen (SCR-USR-01)

S. Screen Field Name Control Type Len Format Required Description Example

YMS Revision No: 0.6 Page 71 of 81


Business Requirement Document

No.
1 Yard Code Textbox Y Yard Code YRD-
YRD-XXXX- ACTL-
4-15 XXX-NN DLI-01

2 User ID Textbox N

3 Status Textbox N

4 Role Textbox N Superadmin

Admin

User

Rows displayed in the grid after entering search parameters

1 User Id Output Text N

2 Status Output Text N

3 Default Yard Code Output Text N Default Yard


Code YRD-
YRD-XXXX- assigned to ACTL-
4-15 XXX-NN the user DLI-01

4 Role Output Text N Superadmin

Admin

User

7.3.3 User ADD Screen (SCR-USR-02)

YMS Revision No: 0.6 Page 72 of 81


Business Requirement Document

S.
Screen Field Name Control Type Len Format Required Description Example
No.
1 Default Yard Code Dropdown Y Default Yard
Code YRD-
YRD-XXXX- assigned to ACTL-
4-15 XXX-NN the user DLI-01

2 User ID Textbox Y

3 Is Active Flag 1 Y/N N

4 Email Textbox N

5 Role Dropdown Y Superadmin

Admin

User

6 Change password at first Flag 1 N


login

YMS Revision No: 0.6 Page 73 of 81


Business Requirement Document

7.4 Batch

7.5 Business Rules

Business Rule ID Business Rule


User should not be to un assign any yard Code if any pending task is
BR_CM_01
assigned to him from that yard, he should get below erro

One Task from this “yard Code” is assigned to him

Search will be performed on the basis of “Like” logic for string fields,
BR_CM_02
i.e., when the user types some characters, similar search results will
be auto displayed in the dropdown below that field textbox for quick
selection by the user

7.6 Use Case Summary

S. No. Use Case ID Use Case Description

1 UC_USR_SRCH_01 When a user performs search based on the search


parameters

2 UC_USR_SRCH_02 When a user views a specific User row from the search
grid

3 UC_USR_SRCH_03 When a user edits a specific User row from the search
grid

4 UC_USR_SRCH_04 When a user adds a new User manually in the system

7.7 User Case Description

Use Case ID: UC_USR_SRCH_01

Use Case Description When a user performs search based on the search parameters

Screen ID: SCR-USR-01

Triggering Event: Click on User Maintenance under Menu

Preconditions: NA

Normal Flow: 1. User enters any of the below search criteria:


 Yard Code (should be defaulted)
 User Id (Should be Like search)

YMS Revision No: 0.6 Page 74 of 81


Business Requirement Document

 Status (should be auto completed)


 Role (should be auto completed)
2. User clicks “Search” button
3. After clicking on “Search” button data will display in grid according to
search condition

Alternative Flows: If the user does not enter any search criteria , then default yard Code should
always should be assigned as input parameter
Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_USR_SRCH_02

Use Case Description When a user views a specific User row from the search grid

Screen ID: SCR-USR-01

Triggering Event: When user wants to view a specific User details, View button is clicked.

Preconditions: NA

Normal Flow: 1. After the search results have been displayed in the grid, user clicks
“View” button for a specific User Id
2. After clicking on “View” button data, same screen as SCR-USR-02
will be opened but with disabled field, where user can only view the
details
3. User clicks “Back” button is redirected to the search screen SCR-
USR-01
Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_USR_SRCH_03

Use Case Description When a user edits a specific yard row from the search grid

Screen ID: SCR-USR-01

Triggering Event: When user wants to edit a specific user details, Edit button is clicked.

Preconditions: NA

Normal Flow: 1. After the search results have been displayed in the grid, user clicks
“Edit” button for a specific User ID row
2. After clicking on “Edit” button data, same screen as SCR-USR-02 will
be opened.
Only User Id. field will be disabled, rest all fields can be edited.
3. User clicks on “Add” button
4. A success message “Changes saved successfully” is displayed and
is redirected to the search screen SCR-USR-01 with updated user
details.

YMS Revision No: 0.6 Page 75 of 81


Business Requirement Document

Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

Use Case ID: UC_USR_SRCH_04

Use Case Description Creation of new user id

Screen ID: SCR-USR-02

Triggering Event: When user wants to add new user manually, Add tab is clicked.

Preconditions: NA

Normal Flow: 1. In the Add screen, enter the below user details:
 User ID.
 Default Yard Code (Mandatory)
Email
 Role
Is_active
Change Password at first login

2. After adding the details, click on “Save” button -> a success message
is displayed “Changes saved successfully” and is redirected to the
search screen SCR-USR-01 with new User details added

Alternative Flows: NA

Exceptions: All violation to Business Rules will trigger appropriate Error Message

YMS Revision No: 0.6 Page 76 of 81


Business Requirement Document

8. Operational Dashboard

Current Yard View:

Zonewise Occupancy – This graph represents the percentage of containers occupancy in a particular zone
whether they are unoccupied or are stacked at level 1,2,3 so that it’s easier to plan the upcoming container’s
storage per zone in a yard

Laden vs Empty count per Shipping Line – This graph depicts the percentage of the empty and loaded
containers on the basis of shipping line. This data can help the supervisor to give an insight to how many
empty and loaded containers exist in the yard for each shipping line

YMS Revision No: 0.6 Page 77 of 81


Business Requirement Document

Container Age per Shipping Line – This graph will tell about the container’s storage plan on the basis of
shipping line. It will help in checking if containers for a specific shipping line have exceeded the storage days in
the yard or not

Zonewise Empty vs Laden Count - This graph represents the percentage of empty, loaded or no containers in
a particular zone of the yard so that it’s helpful in identifying the available space for these containers in future

Historical Data View:

Weekwise Inbound vs Outbound Count – This historical graph will represent how many containers have been
used in inbound and outbound operations in a yard per week based on actual date

Average Stay Time – This graph will help in determining how many number of containers are stored in the yard
on average per week

Refresh Interval – The dashboard needs to be refreshed after every 5 minutes

Historical data – the dashboard should be computed based on the data available from last 4 weeks

YMS Revision No: 0.6 Page 78 of 81


Business Requirement Document

9. Web Services

9.1 Login Web Service


This service will be used to login into HHT device for tagging container into the system.

9.2 Container Tagging Service


This service will be used to tag container while entering into the yard. This will provide container
number, tag ID and device ID as input. If Tag already exists with container present in the system,
the error message will be send. If Container is tagged to another Tag ID then tag information will
be updated into the system.

9.3 Tag Scanning at Gate Service


This service will provide scanned tagged information at yard IN and OUT Gate. This will identify
containers received in and dispatched from the yard.

9.4 Container Transaction Update Data Service


This service will be used to integrate with the hardware device on the loader machine to provide
clamping and de-clamping information into YMS system to update task and order status.

YMS Revision No: 0.6 Page 79 of 81


Business Requirement Document

10. Putaway Strategy

Based on the below attribute System should suggest a zone to the user, like in the below example if
the container is hazardous then system should prompt the Zone 1

Atribute Value Zone

Hazardous Yes Zone1


Refer Yes Zone 2

Commodit
y Coal Zone 3

Commodit
y Food Zone 4

Customer Customer 1 Zone 5

Is free Yes Zone 6

Putaway Strategy Maintenance:

Policy Attribute Policy Status

Do not Mix Hazardous Flag 0

Do not Mix Customer Code 0

Fill Ground level first _ 1

Allow Laden Container over Empty _ 1

Find Location over a container with Greater


  1
TAT

Note: Highlighted rows are not in current scope

YMS Revision No: 0.6 Page 80 of 81


Business Requirement Document

10.1 Put-away Suggestion

S. No Batch Name Purpose


Put-away Suggestion To suggest location for placing container into the yard based on
1 Batch Put-away zone and strategy defined in the system.

1. Put-away Suggestion batch will be executed at a scheduled time period and suggested
location of container will be updated in the DB. This scheduled time period is
configurable.
2. Check for Put-away Zone Maintenance and Put-away Strategy Maintenance table for
zone suggestion, if available, based on attribute values.
3. Check Put-away Strategy Maintenance table for location suggestion based on zone
selected and location sequence.
4. Insert identified location in database corresponding to the put-away task for the
container.

Note:

1. If multiple rules are applicable, then we will suggest from latest to older rule.
2. If we have defined commodity wise zone but there is no empty location available in
that zone, then system will not suggest any location.

YMS Revision No: 0.6 Page 81 of 81

You might also like