DOC

Functional Specification Template

By Willie Lopez,2014-08-24 16:19
8 views 0
Functional Specification Template

    Functional Specification

    <1.0>

    CPL List Fix

    <2011/3/21>

     Document Number: ERMOFS_XXXX ? 2007 Cisco Systems, Inc. All rights reserved Based on Template: ERMOFS_0006 Rev1.0

Document Control

    READ ME FIRST

    Template Instructions

     Template instructions and guidelines are included in this document. Please delete these

    sections before submitting for approval.

     At prompts delineated by angle brackets (for example, ), please insert

    appropriate information. If no information is to be added, please delete these prompts before

    publication.

     If a section is not applicable, do not remove the section. Instead note that it is not

    applicable.

Change Record

    Date Author Version Change Reference

    2011/3/21 Tiebin Peng(Iverson) 1.0 Initial draft of BRD

Reviewers

    Date Name Organization Role

     David Guard PM

     Saravanan N SE TECH LEAD

     Milinda Mayfield Business Architect

     Ranjeet Sandhu Architect

     Mudit Agarwal Architect

    NOTE: If your project team has defined a document review process for this release, please include a link here.

    Approval

    Date Name Organization Role

     David Guard PM

     Saravanan N SE TECH LEAD

     Milinda Mayfield Business Architect

     Ranjeet Sandhu Architect

     Mudit Agarwal Architect

? 2007 Cisco Systems, Inc. All rights reserved. 2

Contents

    Document Control ........................................................................................................... 2 Change Record ....................................................................................................................... 2 Reviewers .............................................................................................................................. 2 Approval 2

    Contents .......................................................................................................................... 3 Overview ........................................................................................................................ 5 Business Requirement ID ....................................................................................................... 7 Functional Requirement ID..................................................................................................... 7 Use Case # ............................................................................................................................. 7 BRD Name ............................................................................................................................. 7 Assumptions and Dependencies .............................................................................................. 7 References.............................................................................................................................. 8 Proposed Process ............................................................................................................ 8 Process Flow .......................................................................................................................... 8 Process Description ................................................................................................................ 8 Use Cases........................................................................................................................ 9 ............................................................................................................................ 9 Actors 9

    Preconditions.......................................................................................................................... 9 Primary Flow ......................................................................................................................... 9 Alternative Flow................................................................................................................... 10 Postconditions ...................................................................................................................... 10 Requirements ................................................................................................................ 11 Interface Requirements ......................................................................................................... 11 Access Requirements............................................................................................................ 11 Constraint Requirements ...................................................................................................... 11 Reliability/Availability Requirements ................................................................................... 12 Operational Requirements .................................................................................................... 12 Configuration Requirements ................................................................................................. 12 Personalization Requirements ............................................................................................... 12 Architecture .................................................................................................................. 13 Interface Summary ............................................................................................................... 13 File transfer timings and requests .......................................................................................... 13 Interface Description .............................................................................................................. 8 Data Flow Diagram ................................................................................................................ 8 Data Cleansing (If applicable) .............................................................................................. 15

    ? 2007 Cisco Systems, Inc. All rights reserved. 3

    Oracle Application Rules ...................................................................................................... 15 Volume and Performance Considerations ............................................................................. 15 Error Handling ..................................................................................................................... 15 User Interface Design .................................................................................................... 16 Navigation Hierarchy ........................................................................................................... 16 Screen/Form Inventory ......................................................................................................... 16 Description ........................................................................................................................... 16 Layout and Design ............................................................................................................... 16 Screen/Form Usage .............................................................................................................. 16 Field Mapping Information ................................................................................................... 17 Volume and Performance ..................................................................................................... 17 Frequency of Use ................................................................................................................. 17 Error Handling ..................................................................................................................... 17 Batch Processes and Programs ...................................................................................... 18 Program Name ..................................................................................................................... 18 Input Parameters................................................................................................................... 18 Program Initiation Method .................................................................................................... 18 Volume and Performance ..................................................................................................... 18 Frequency of Use ................................................................................................................. 18 Dependencies ....................................................................................................................... 18 Error Handling ..................................................................................................................... 18 Testing Recommendations ............................................................................................ 19 Implementation ............................................................................................................. 20 Security Requirements .................................................................................................. 21 Issues ............................................................................................................................ 23 Appendix A. Glossary ................................................................................................... 24 Appendix B. Security Items and Configuration .......................... 错误;未定义书签。18

    ? 2007 Cisco Systems, Inc. All rights reserved. 4

Overview

Purpose:

     This document is intended to describe the requirements for excluding invalid PIDs from CPL list and CPL error report.

Scope:

    In Scope:

     Excluding items from CPL Error Report and CPL List which are not valid shippable PIDs with ECCN

    values.

     Cleaning up existing CPL Error Report and CPL List to remove existing entries for items which are not

    valid shippable PIDs with ECCN values.

     Adding fields to CPL Error Report and CPL List.

Stake Holders:

    Internal Cisco user, CVCM Global Reverse Logistics, CVCM SCM IT Reverse Logistics Client Engagement

Problem Description:

    The Controlled PIDs List (CPL List) is used to manage situations where a given unit may be subject to Export Control, and that unit’s Export Control status cannot be managed via ECCN values in the PEPD list. These situations include:

    1. Unknown ECCN value The ECCN value in PEPD is blank, or PID record is not found in PEPD file.

    2. Mfg PID (actual PID under which the unit originally was built and shipped) is ECCN controlled, and INV PID

    (PID we inventory the unit as) is not ECCN controlled.

    3. Mfg PID or INV PID is a model which may contain ECCN controlled options, and PID-level ECCN value from

    PEPD is not controlled.

    When the CPL Error Report (which feeds such situations from the Reverse Logistics Receiving and Disposition Webservice to the CPL List) was created, Reverse Logistics began noticing that 75% or more of the values shown in the Mfg PID field were invalid (3163 lines out of 4039 lines). A few of these situations were due to an item being identified with a non-physical PID such as a TRD (trade-in) PID. The vast majority of these situations are due to entries in the CPL Error Report being populated without the unit’s PID actually being matched to an RMA;

    thus invalid PIDs may be scanned in or typed in, or some value other than an actual PID may have been entered into the PID field (such as a serial number, a part number, or other data.)

    The invalid PIDs currently must be screened out before the CPL Error Report is sent to the Export Compliance team and before the CPL List is generated. If not, Export Compliance is asked to spend the effort screening out such items themselves. If the current report were sent, only 207 valid PIDs requiring ECCNs would be found, but

? 2007 Cisco Systems, Inc. All rights reserved. 5

3163 items which are invalid PIDs would be included in the report. Additionally, these invalid PIDs are being

    added to the CPLI List report, creating a much longer report and increasing lookup times, and causing confusion

    for business users.

Additionally, certain lines are being retained on the CPL List even though the situation which caused them to be

    placed on the report has now changed (ECCN value unknown is now known, or ALT PID ECCN value was not

    controlled but now is controlled).

This BRD is being created to prevent invalid PIDs from being placed in the CPL Error Report and CPL List, to

    ensure lines which no longer belong on the report and list are removed, and to facilitate troubleshooting and

    management of this report and list by business users.

Requirements

    Business Requirements

    Bus High Level Req Req Description Use Case Process ID

    BR-1 CPL Error Exclude Invalid PIDs from CPL Error Report. Invalid PIDs are those Test calling the Webservice with both

    Report starting with CON, SW or TRD, and any other item in PID field on valid and invalid PIDs. Valid PIDs

    Webservice call which cannot be matched to RMA. This will also keep should be added to CPL Error Report, if

    these items off CPL List. applicable based on ECCN values and

    ALT or Model situations, and from there

    to CPL List. Invalid items (CON, SW,

    TRD PIDs or items not matched to

    RMA) should NOT be added to CPL

    Error Report or to CPL List.

    BR-2 CPL Error Cleanup CPL Error Report to remove invalid PIDs. (Above exclusion Run CPL Error Report and ensure no

    Report logic is a pre-requisite to the CPL Error Report cleanup.) invalid PIDs exist.

    BR-3 CPL List Cleanup CPL List to remove invalid PIDs. (Above exclusion logic is a Run CPL List and ensure no invalid

    pre-requisite to the CPL List cleanup.) PIDs exist.

    BR-4 CPL Error Add User Item Type field to CPL Error Report. This will assist in Run CPL Error Report and ensure fields

    Report periodic checking by Reverse Logistics Systems & Processes team specified are added. Spotcheck to

    (working with Reverse Logistics Operations team) to ensure no new ensure information in those fields is

    invalid PIDs get added, and will assist in troubleshooting. correct AND from the correct source.

    BR-5 CPL List Add fields to CPL List. This will assist in troubleshooting and analysis Run CPL List and ensure all fields

    of existing PIDs on report (ie; will clarify configured PIDs, shippable specified are added. Spotcheck to

    PIDs, etc.) ensure information in those fields is

     correct AND from the correct source.

    Add: Mfg PID User Item Type; Mfg PID BOM Item Type; INV PID User

    Item Type; INV PID BOM Item Type; INV PID ECCN Value (from PEPD Regression Test: Run Allocation Drop

    Archive); INV PID C3 Serialized Value. NOTE: By adding the fields to in IRT tool to ensure items on CPL List

    the right of the current fields, we will not have to rework any interfacing are correctly grouped based on CPL List

    programs (such as IRT tool) which may be required if we move existing values.

    fields.

    This is a “nice to have” requirement which will facilitate periodic checks

    from Reverse Logistics Systems & Processes and Business teams.

    BR-6 CPL List If for a given line on CPL List the following situation exists: Run CPL List and ensure these lines do

    1. Reason “Alternate Part Source” is NO not show up.

    2. Reason “Model Part Source” is NO

    3. Reason “Blank ECCN Source” is YES

    4. ECCN value is in PEPD tool and is not blank

? 2007 Cisco Systems, Inc. All rights reserved. 6

Bus High Level Req Req Description Use Case Process ID

    Then, delete part from CPL report before generating new report. Store

    line in CPL Archive report.

    This happens when Export Compliance team has updated an ECCN

    value into PEPD tool. This is explained in Srinivas Sankerasetty email

    of 4/23/2010.

    Such situations are not subject to CPL List controls.

     BR-7 CPL List If for a given line on CPL List the following situation exists: Run CPL List and ensure these lines do

    1. Reason “Alternate Part Source” is NO not show up.

    2. Reason “Model Part Source” is YES

    3. Reason “Blank ECCN Source” is NO

    4. Either: INV PID ECCN Value does not contain “99” or “NOCLASS”

    5. Or: Both INV PID ECCN Value and Mfg PID ECCN Value do

    contain “99” or “NOCLASS”

    Then, delete line from CPL report. Store line in CPL Archive report.

    This may happen when an ALT PID relationship has been changed.

    Such situations are not subject to CPL List controls.

Business Functional

    Requirement Requirement Use Case # BRD Name ID ID

    Assumptions and Dependencies N/A

    ? 2007 Cisco Systems, Inc. All rights reserved. 7

References

    N/A

Proposed Process

    Now

    Webservice FSD for ECCN Logic CPL Automation- Ver2 00.docx

Process Flow

    Display or provide a reference to the “to be” process flow diagram.

    The flow diagram should include both user and system interactions and should be at a deeper level than

    than found in the BRD.

    NOTE: If referencing an external document, include a link to the document

Process Description

    This section is optional.

    Describe the process to be implemented. If a process flow narrative document was created during prototyping,

    provide a reference to it.

? 2007 Cisco Systems, Inc. All rights reserved. 8

Use Cases

    Use the table format below to list related use cases. In the next section, describe each individual use case on this list.

    Case Number Name Description

    Purpose and functionality of the use case Unique reference number for the use Name of the use

    case to indicate levels of case

    functionality

    Describe the function of this use case briefly. This section provides an important context for the reader. In addition, the use case titles and descriptions can be extracted to provide a high-level overview of the entire use case inventory. Please note there are no assumptions in a use case.

    Actors

    List the actors that interface with the system in this use case. Actors are entities that participate in the use case and can be people, software, hardware, data stores, etc. For example, customer, internal employee, external employee, LDAP system, etc. Identifying actors helps determine the boundaries of the system that will be built. It also helps the developer, because actors are objects that later become classes in object-oriented programs. Preconditions

    Describe the state of the system before this use case starts. For example, a valid use is logged in to the system. Primary Flow

    Provide a detailed, step-by-step description of the flow of events in this use case, including screen shots whenever possible. Steps should follow the flow numbering sequence from the L3 Process diagram and each step should relate back to the flow diagram via the step number. Consider the following:

    ; Write in complete sentences, using active verbs. Short, choppy phrases are difficult to read and may cause

    confusion.

    ; Describe the actions the actor performs and the interaction the actor has with the system. ; Include details on error-checking and handling, so the developer can then plan for this in the code. ; Include details on message flows between systems as well as between the system and actors. ; Focus on the main scenario of a use case. In other words, focus on what is most likely to happen. Alternative

    paths or branch-offs should be detailed in the primary flow only if they are not overly complex. If they are

    very detailed or involve many actions and messages, it may be better to include them in a separate section or

    use case.

? 2007 Cisco Systems, Inc. All rights reserved. 9

Alternative Flow

    This section is optional.

    This section is similar to the primary event flow, but it details what happens when there is a large deviation from the basic path. For example, describe what happens if the user has some sort of special entitlement. In general, it is best to keep simple, alternate detail in the primary flow, because it is difficult to jump back and forth between the primary and alternative flows.

    Post-conditions

    Describe the state of the system after this use case ends. For example, after a successful login, the main menu is displayed. Provide screen shots whenever possible.

? 2007 Cisco Systems, Inc. All rights reserved. 10

Report this document

For any questions or suggestions please email
cust-service@docsford.com