Analytical Documentation

Name: test-name
Version: test-version

Actors overview

  • No Ucs Primary Actor
  • Primary Actor With Goals
  • Primary actor for Use cases
  • Primary actor 3 for Use cases
  • Actor with description
  • Data actor
  • Merged actor
  • Actor 2
  • Actors details

    Actor No Ucs Primary Actor

    Extended by actors:
  • Primary actor for Use cases
  • Actor Primary Actor With Goals

    Extended by actors:
  • Primary actor for Use cases
  • Goals:
  • Goal 1 for actor-goal list
  • Goal 2 for actor-goal list
  • Goal 3 for actor-goal list
  • Goal for actor-goal list merged from other file
  • Actor Primary actor for Use cases

    Extends actors:
  • Primary Actor With Goals
  • No Ucs Primary Actor
  • Extended by actors:
  • Primary actor 3 for Use cases
  • Goals:
  • code001 - Use case header fields test
  • code002 - Goal of Use case 2
  • code003 - Use case steps and extensions test
  • Inherited actors:
  • Primary Actor With Goals
  • No Ucs Primary Actor
  • Inherited goals:
  • Goal 1 for actor-goal list
  • Goal 2 for actor-goal list
  • Goal 3 for actor-goal list
  • Goal for actor-goal list merged from other file
  • Actor Primary actor 3 for Use cases

    Description:
    This is the actor 3 description.
    Extends actors:
  • Primary actor for Use cases
  • Inherited actors:
  • Primary actor for Use cases
  • Primary Actor With Goals
  • No Ucs Primary Actor
  • Inherited goals:
  • Goal 1 for actor-goal list
  • Goal 2 for actor-goal list
  • Goal 3 for actor-goal list
  • Goal for actor-goal list merged from other file
  • code001 - Use case header fields test
  • code002 - Goal of Use case 2
  • code003 - Use case steps and extensions test
  • Actor Actor with description

    Description:
    The description of the actor.
    Another description.
    Third description.

    Actor Data actor

    Goals:
  • exp-001 - Test expansion
  • mas-001 - Maintain masters
  • mas-002 - Work with masters
  • Actor Merged actor

    Goals:
  • Goal of merged actor
  • Actor Actor 2

    Goals:
  • CD100 - Referenced use case 1
  • CD105 - Referenced use case 2
  • Use Cases overview

    Primary actor Goal Level
    Primary Actor With Goals Goal 1 for actor-goal list  
    Primary Actor With Goals Goal 2 for actor-goal list  
    Primary Actor With Goals Goal 3 for actor-goal list  
    Data actor exp-001 - Test expansion  
    Data actor mas-001 - Maintain masters  
    Data actor mas-002 - Work with masters  
    Merged actor Goal of merged actor  
    Primary Actor With Goals Goal for actor-goal list merged from other file  
    Actor 2 CD100 - Referenced use case 1 Subfunction
    Actor 2 CD105 - Referenced use case 2  
    Primary actor for Use cases code001 - Use case header fields test User goal
    Primary actor for Use cases code002 - Goal of Use case 2  
    Primary actor for Use cases code003 - Use case steps and extensions test  

    Use cases details

    Use case exp-001 - Test expansion

    Primary actor: Data actor
    Main success scenario:
    1.  User creates an expansion test (Expansion test data structure) data.

    Use case mas-001 - Maintain masters

    Primary actor: Data actor
    Preconditions:
  • User authorized to maintain masters (A master) .
  • Minimal guarantees: Records of master (A master) data always kept consistent.
    Main success scenario:
    1.  User creates a master (A master) with the detail (Detail 1) .
    Stakeholders and interests:
    Administrator: Every master (A master) created is logged in audit.

    Use case mas-002 - Work with masters

    Primary actor: Data actor
    Main success scenario:
    1.  User works with a master (A master) .

    Use case CD100 - White-box, Organization Referenced use case 1 Subfunction

    Scope: Scope 2
    Type: Organization   Visibility: White-box   Level: Subfunction
    Primary actor: Actor 2
    Main success scenario:
    1. Step 1.
    2. Step 2.
    3. Step 3.
    References: code001 - Use case header fields test, code003 - Use case steps and extensions test

    Use case CD105 - White-box, Organization Referenced use case 2

    Scope: Scope 2
    Type: Organization   Visibility: White-box  
    Primary actor: Actor 2
    References: code003 - Use case steps and extensions test

    Use case code001 - Black-box, System Use case header fields test User goal

    Scope: Scope 1
    Type: System   Visibility: Black-box   Level: User goal
    Primary actor: Primary actor for Use cases
    Preconditions:
  • item 1
  • item 2, and a reference to other use case (code003 - Use case steps and extensions test) .

  • bla bla
  • gogo huhu
    1. One
    2. Two
    3. Three
    row 1 cell 1
    r2c1
    Minimal guarantees:
  • Min guarantee 1.
  • Min guarantee 2.
  • Success guarantees:
  • Success guarantee 1.
  • Success guarantee 2.
  • Trigger: Trigger.
    Main success scenario:
    1.  Step 1.

    Text in step 1, on new line.
    2.  Step 2.
  • Bullet 1 under step 2.
  • Bullet 2 under step 2.
  • 3. Step 3.
    Stakeholders and interests:
    Stakeholder 1: Interest of stakeholder 1.
    Stakeholder 2: Interest of stakeholder 2.
  • Bullet 1 in interest.
  • Bullet 2 in interest.

  • Text under hr, a link to another UC (CD100 - Referenced use case 1) and a reference to step 3 .

    Use case code002 - Black-box, System Goal of Use case 2

    Scope: Scope 1
    Type: System   Visibility: Black-box  
    Primary actor: Primary actor for Use cases

    Use case code003 - Black-box, System Use case steps and extensions test

    Scope: Scope 1
    Type: System   Visibility: Black-box  
    Primary actor: Primary actor for Use cases
    Main success scenario:
    1. User selects to create a customer.
    2.  User enters customer data.
    3.  Go to step 6 .
    4.  System creates a new customer (CD105 - Referenced use case 2) .
    5.  Return to step 1 or 3 .
    6. Any other step.
    Extensions:
    *a. Power failure:
        *a1. Nothing.
    *b. Sun sets: Nothing too.
    1a. User selects to update a customer:
        1a1.  User finds customer (CD100 - Referenced use case 1) using customer search criteria.
            1a1a. Customer not found:
                1a1a1. User modifies customer search criteria and finds again or cancels.
                1a1a2. System performs as requested.
                    1a1a2a. System error: Failure.
                    1a1a2b. Power failure:
                        1a1a2b1. What then?
                        1a1a2b2. Failure.
                        1a1a2b3.  Return to step 1 or 3 .
                        1a1a2b4. Anything.
                            1a1a2b4a. After ref-step: Whatever.
        1a2. User modifies customer data.
        1a3. System validates customer data and updates customer data.
            1a3a. Customer data validation fails:
                1a3a1. User corrects customer data and has system update it.
    1b. User selects to delete a customer:
        1b1.  User finds customer (CD105 - Referenced use case 2) using customer search criteria.
            1b1a. Customer not found:
                1b1a1. User modifies customer search criteria and finds again or cancels.
                1b1a2. System performs.
            1b1b. Multiple customers found:
                1b1b1. User modifies customer search criteria and finds again or cancels.
        1b2. User confirms deleting the customer.
        1b3. System updates customer data.
    3a. User enters other data: Nothing.
    3b. User enters yet other data:
        3b1. Nothing as well.
    3‑6a. Something happens: Do this.
    3‑6b.  When with a reference to step 2 and data reference (Empty) :
        3‑6b1. Step for when element test.
            3‑6b1a.  When in step condition with a reference to step 2 and data reference (Empty) :
                3‑6b1a1. Step for when element on step condition.
    References: code001 - Use case header fields test

    Data structures overview

    Data structure Code
    Expanded one ExpandedOne
    Expanded two ExpandedTwo
    Expanded two-one ExpandedTwoOne
    Not expanded NotExpanded
    Expansion test data structure ExpansionTest
    Empty Empty
    A master Master
    Detail 1 MasterDetail1
    Detail N DetailN
    Another master AnotherMaster
    Another structure AnotherStructure
    Unreferenced data structure UnreferencedDataStructure
    Description data description-data

    Data structures details

    Data structure Expanded one

    Code: ExpandedOne
    NameCodeStatusTypeDescription
    Exp One att 1expOneAtt1MString [123]Description of Exp One att 1
    Exp One att 2expOneAtt2UCollection [Integer] 
    References in data structures: Expansion test data structure

    Data structure Expanded two

    Code: ExpandedTwo
    NameCodeStatusTypeDescription
    Expanded atts two one  Expanded two-one 
    Exp Two att 1expTwoAtt1MString [123]Description of Exp Two att 1
    Exp Two att 2expTwoAtt2UCollection [Integer] 
    References in data structures: Expansion test data structure

    Data structure expansion:
    NameCodeStatusTypeDescription
    Exp Two-One att 1expTwoOneAtt1MString [123]Description of Exp Two One att 1
    Exp Two-One att 2expTwoOneAtt2UCollection [Integer] 
    Not expanded atts  Not expanded 
    Exp Two att 1expTwoAtt1MString [123]Description of Exp Two att 1
    Exp Two att 2expTwoAtt2UCollection [Integer] 

    Data structure Expanded two-one

    Code: ExpandedTwoOne
    NameCodeStatusTypeDescription
    Exp Two-One att 1expTwoOneAtt1MString [123]Description of Exp Two One att 1
    Exp Two-One att 2expTwoOneAtt2UCollection [Integer] 
    Not expanded atts  Not expanded 
    References in data structures: Expanded two

    Data structure Not expanded

    Code: NotExpanded
    NameCodeStatusTypeDescription
    Not Expanded att 1notExpandedAtt1MBoolean 
    References in data structures: Expanded two-one

    Data structure Expansion test data structure

    Code: ExpansionTest
    NameCodeStatusTypeDescription
    Expanded atts one  Expanded one 
    Expanded atts two  Expanded two 
    ET Own att 1etOwnAtt1 String [] 
    References in use cases: exp-001 - Test expansion

    Data structure expansion:
    NameCodeStatusTypeDescription
    Exp One att 1expOneAtt1MString [123]Description of Exp One att 1
    Exp One att 2expOneAtt2UCollection [Integer] 
    Exp Two-One att 1expTwoOneAtt1MString [123]Description of Exp Two One att 1
    Exp Two-One att 2expTwoOneAtt2UCollection [Integer] 
    Not expanded atts  Not expanded 
    Exp Two att 1expTwoAtt1MString [123]Description of Exp Two att 1
    Exp Two att 2expTwoAtt2UCollection [Integer] 
    ET Own att 1etOwnAtt1 String [] 

    Data structure Empty

    Code: Empty
    References in use cases: code003 - Use case steps and extensions test

    Data structure A master

    Code: Master
    Description:
    This is the master entity.
  • HTML tags work here.
  • NameCodeStatusTypeDescription
    Empty    
    With codewithCode   
    With allwithAllOString [123]Attribute with all options set up.
    Display only D/O  
    Optional O  
    Mandatory M  
    Unique U  
    Natural key NK  
    Primary key PK  
    Integer  Integer 
    Float  Float 
    Decimal  Decimal 
    Boolean  Boolean 
    Date  Date 
    Time  Time 
    Date time  Date-time 
    Timestamp  Timestamp 
    Binary  Binary [4098] 
    String without length  String [] 
    Binary without length  Binary [] 
    Reference to other structure  Detail 1 
    Collection of integers  Collection [Integer] 
    Integer with length  Integer [3]Three digits.
    Collection of integers with length  Collection [Integer] [10]Collection of max 10 integers.
    Collection of other structures  Collection [Detail N] 
    Collection of other structures with length  Collection [Detail N] [5]Collection of max 5 instances of DetailN.
    Selected detail N  Detail N 
    References in use cases: mas-001 - Maintain masters, mas-002 - Work with masters

    Data structure Detail 1

    Code: MasterDetail1
    References in data structures: A master
    References in use cases: mas-001 - Maintain masters

    Data structure Detail N

    Code: DetailN
    References in data structures: A master, Another master

    Data structure Another master

    Code: AnotherMaster
    Description:
    Reference to
    another structure (Another structure) in a data structure description
    NameCodeStatusTypeDescription
    A detail N  Detail N 

    Data structure Another structure

    Code: AnotherStructure
    References in data structures: Another master

    Data structure Unreferenced data structure

    Code: UnreferencedDataStructure

    Data structure Description data

    Code: description-data
    Description:
    First description.
    Second description.
    Third description.