M300-detailed-design-modification-template

Document Sample
M300-detailed-design-modification-template Powered By Docstoc
					                              M300 - Detailed Design Document


Section 1.     Summary


Please save this document with this naming standard on the K: drive in: \share\ PS Upgrade Docs\ <appropriate
release>\<by CPU>\2-Detail Design folder

Doc. naming standard: CPU_ Module or Product Area _ Process _Sub Process (if needed) _Mod ID
(i.e. FIN_GL_POCreation_10032002)

Delete sections of this document that do not apply.

     A. Unit Information:

     CPU:
     Software Version:
     Product Area:
     Process:
     Sub Process:
     Modification Identifier:

     B. Impacts
             i. Impacts of Modification to:
                   Change Management
                   Security
                   Database Tuning
                   Data Warehouse
                   Permission Lists
                   Upgrade Conversion
                   Interfaces (External Systems)
                         Define:__________________
                   Cross-Team Integration
                        Affected Product Areas:_________________
                   Other
                         Affected Areas:_________________

             ii. Groups Potentially Impacted:
                   Data Delivery
                   Data Administration
                   Performance Support
                   Security/Access Services
                   TIO/AIG
                   User Services
                   Cross-Team
                   Business Process Owner
                   System Owner
                   User Group


C.   Short Description of Modification/Business Reason:
                                    M300 - Detailed Design Document


D. Assumptions:
   Include all assumptions made as part of the detailed design.



E.   Related Document References: (i.e. Business Process Doc, Fit/Gap, MSR, or any other documents that
     record changes to this software modification)



F. Summary of Modifications By Object Type

Type of          Object Name                           Short Description                             Action
Object                                                                                                (Add,
                                                                                                     Change,
                                                                                                     Delete)




G. Detailed Description of Modifications/Program flow: (English language description from technical viewpoint)



H. Open Issues:
List Work Unit open issues. No open issues should remain at sign off.


I. Process Flow Diagram
Insert a Visio Flow Chart illustrating impacted objects within the functional process




J. Estimate to complete (Code/Unit Test) modification:
        XX Estimated days to complete




10/19/2011 4:20 AM                                      2                               <3 Letter User Initials>
                                                   Upgrade Detailed Design Document
                              M300 - Detailed Design Document



Section 2.       Description of Modifications




A.    FIELD CHARACTERISTICS & TRANSLATE TABLE (XLAT) VALUES

1. Field Characteristics & Translate Values Description:



2. Field Characteristics & Translate Values Definition:
                                                                                                                    Translate Values

                                       Field Characteristics                                                Valid Value
     Mod Type                                 Label                    Short                    Mod Type               Eff.                  Short
                     Name    Type   Length              Long Name              Other Info                   Value                Long Name
     (New/Rev)                                 ID                      Name                     (New/Rev)              Date                  Name




10/19/2011 4:20 AM                                   3                          <Letter User Initials>
                                     M300 - Detailed Design Document
                                  M300 - Detailed Design Document

B.     RECORDS

1. Record Type (SQL Table, SQL View, Dynamic View, Derived/Work, Subrecord, Query View, TempTable, Non-Standard SQL Table Name):

2. Record Description:

3. Record Definition:
 Record Name:                                    Mod Type                 Record Type:       SQL:
                                                 (New/Rev):
 Set Control Field:         Parent Record:       Related Language         Query Security Record:         Audit Record & Actions:
                                                 Record:

                                                            Use                                                             Edit
     Mod.                                                                                                                  Prompt       Res.           People
            Field     Key      Order      Dir.   Cur.       Search          List     Audit    Default    Req.   Edit                           Event
     Type                                                                                                                   Table       Date           Code?




4. PeopleCode Description:


5. PeopleCode Definition:
  Record Name:                                                       Record Type:                                      Parent Record:
     Mod.
     Type
             Field     Type       Event                                                             People Code




10/19/2011 4:20 AM                                      4                                     <Letter User Initials>
                                                                         M300 - Detailed Design Document
                                   M300 - Detailed Design Document



C.   PAGES


*Pages were named “Panels” and Components were named “Panel Groups “ prior to PS version 8.X

 1. Page Description:




 2. Page Definition:

Page Name:                               Mod. Type (New/Revised):                Source Name if Page was Cloned:
Style Sheet:                             Background:                             Allow Deferred Processing:

                                                   Record                                   Label                    Use          General

                Page Cntl
Mod Type           Type                                           Other Record                      Other Label
                                 Record Name     Field Name                        Text                           Use Options   General Options
(New/Rev)      (Scroll Area,                                        Options                          Options
               Edit Box, etc.)




10/19/2011 4:20 AM                                        5                           <Letter User Initials>
                                          M300 - Detailed Design Document
                             M300 - Detailed Design Document




D. COMPONENTS


 * Pages were named “Panels” and Components were named “Panel Groups“ prior to PS version 8.X

 1. Component Description:




 2. Component Definition:
Component Name:                                                                             Mod. Type (New/Rev):
                                              Component Definition
Mod. Type                                                                                                           Allow Def.
              Page Name        Item Name      Hide            Menu Item Label                  Folder Tab Label
(New/Rev)                                                                                                           Processing




Component Name:                                                                             Mod. Type (New/Rev):

                                                  Use Properties
                                                                                                             3-tier Exec
Mod. Type                      Add Search                                                                Comp         Comp
             Search Record                           Detail                     Action(s)
(New/Rev)                        Rcord                                                                   Build        Save




E.   MENUS


10/19/2011 4:20 AM                               6                                  <Letter User Initials>
                                 M300 - Detailed Design Document
                                    M300 - Detailed Design Document

* Pages were named “Panels” and Components were named “Panel Groups “ prior to PS version 8.X

1. Intended Audience/Role/Permission List:

2. Menu Description:

3. Menu Definition:
Menu Name:                                                           Mod Type (New/Rev):
Menu Type:                                                           Menu Label:
Menu Group:                                                          Menu Order:
Menu Group Order:                                                    Installed?
                                                        Menu Item                                                               Bar Item
                                                        Type
                                        People
Mod                                               Associated     Pages in          Search Record
          Name              Label        Code?                                                               Search Record   Name          Label
Type                                              Component     Component            Override
                                       (Pop-Up)




     4. PeopleCode Description:

     5. PeopleCode Definition:
 Mod.     Menu
 Type     Item
                     Type      Event                                                    People Code




F.     APPLICATION ENGINE



10/19/2011 4:20 AM                                  7                               <Letter User Initials>
                                                               M300 - Detailed Design Document
                             M300 - Detailed Design Document

     1. Application Engine Description:


     2. Application Engine Definition:

Program Name:                                                                 Mod Type (New or Revised):

                                                                         Section(s)
Section Name:                Section Description:
Mod.
           Market        Platform          Eff. Date   Eff. Status            Section Type           Auto Commit       Access       Comment
Type



                                                                           Step(s)
Step Name:                Step Description:
Mod.
          Commit After               Frequency                                        On Error                          Active     Comment
Type



                                                                     Action(s)
                                                                       SQL
Mod.
                                    Description                                                      ReUse Statement             No Row
Type


                                                                     SQL Select
Mod.
                                    Description                                                      ReUse Statement              Type
Type




F.     APPLICATION ENGINE (Continued:)



10/19/2011 4:20 AM                                8                                <Letter User Initials>
                                                              M300 - Detailed Design Document
                           M300 - Detailed Design Document

                                                               Action(s) Cont’d
                                              Iterative SQL Select (Do When, Do While, Do Until )
Mod.
                                Description                                                        Reuse Statement           Action Type
Type




                                      PeopleCode
Mod
                               Description:                                           On Return:
Type




                                                                 Call Section
Mod
                                Description                                                    Section Name              Program ID
Type




                                                                 Log Message
Mod
                                Description                                             Message Set            Number   Parameters
Type




G. QUERIES

   1. Query Description:

   2. Query Definition:




10/19/2011 4:20 AM                            9                                 <Letter User Initials>
                                                           M300 - Detailed Design Document
                                   M300 - Detailed Design Document



H. BUSINESS PROCESS DESIGNER

 1.    Business Process Map Name (Provide if known):
 2.    Business Process Name:
 3.    Modification Type (New or Revised):

 4.        Business Process: (There may be multiple Activities for each Business Process.
                              Repeat items 5 through 7 for each Activity.)


 5.    Activity Name:
 6.    Modification Type (New or Revised):
 7.    Activity Overview:

I.    WORKFLOW

1.    Activity Name that contains Workflow:
2.    Workflow Type (Panel Only, Database Agent, Other):
3.    Initiating Step or Agent Name:
4.    Modification Type (New or Revised):
5.    Database Agent:
      a.    Database Agent Query Name:
      b.    Run Frequency:
      c.    Run Volume (average rows per run):

6.    Worklist Routing Instructions:
      a.    Worklist Record Name:
      b.    Trigger Record on Initiating Page (“Panel” prior to ver. 8.X):
      c.    Trigger Event PeopleCode:
      d.    Worklist Target Page Name and Action:
      e.    Target Page Search Record:

7. Workflow Roles:

                Role Type                        Role Name                          Description of role
             (Query, User List)


8. Workflow Rules:

            Business                                                    Equally
            Process        Approval       Effective    Approving       Authorized
             Name         Rule Name         Date         Role           Role(s)      Step   Path   Rule Description




10/19/2011 4:20 AM                                        10                                   <Letter User Initials>
                                           M300 - Detailed Design Document
                                 M300 - Detailed Design Document

Section 3.    Batch Modifications


A.   PROGRAM (Complete a page for each new/modified program)

1. Program Name:

2. Program Type (COBOL, PLI, SQR, other - specify.):

3. Modification Type (New or Revised):

4. Program Inputs:
      Modification Type           Input Type            Input Name           Description of Input
      (N=New,R=Revised,           (File, Table,                          (Optional-Attach Record Layout for
         D=Deleted)              Other [specify])                                     new file)




5. Program Outputs:
      Modification Type          Output Type            Output Name          Description of Output
      (N=New,R=Revised,          (Report, File,
         D=Deleted)                 Table)


6. Input File Layout Delete if there is no input file
      Field                      Field Type   Length      Displacement   Comments




7. Output File Layout Delete if there is no output file
      Field                      Field Type   Length      Displacement   Comments




10/19/2011 4:20 AM                                 11                                  <Letter User Initials>
                                               M300 - Detailed Design Document
                                     M300 - Detailed Design Document

A.   PROGRAM (Continued - Complete a page for each new/modified program)

8.   Program Logic:
     Designer needs to include dependencies and impact of other programs when adding/modifying functionality. Program flow should be written
     using sentences and phrases, not documenting program code, i.e. SQL statements.
     a. Report Selection Criteria:

     b.    Report Sort Order:

     c.    Report Break Logic:

9.   Commit/restart processing:

10. Control and Run-to-run statistics:

11. Process Scheduler Information:
     a.    Page Component Name:

     b. Process Security Group:

12. Report Scheduling/Execution Instructions:
     a.    Report Initiation:

     b.    Execution Frequency:
     c.    Estimated Execution Time:
     d.    Processing Parameters:

     e.    Process Scheduler Options (Check one):
                         ___User execution on the server (Batch)           ___SYSADM execution on the server (Batch)

13. Document Management/Report Distribution Requirements
     a. Indicate frequency of distribution of this SQR, how long paper or electronic copies of report should be maintained,
          etc.

     b.   Estimated number of pages:
     c.   Number of copies distributed:
     d.   Media:
     e.   Retention:
     f.   Security Requirements:
              i. Include Log: (Y/N)
             ii. Page Security: (Y/N)
           iii. Page Security Data: (table. fieldname, group name, permission level, page security set, … )
            iv. Folder Name: (personal, department, group, … )
             v. Generations: (nn)




10/19/2011 4:20 AM                                       12                                        <Letter User Initials>
                                                     M300 - Detailed Design Document
           Report Layout:
                                                                                                     1
                1         2         3         4         5         6         7         8         9         0         1         2         3         4         5         6          7
       123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567
  01                                                                                 UNIVERSITY OF MICHIGAN
  02   Report ID: $$$$999                                                                 REPORT TITLE                                                                  Page No. 999
  03                                                                                                                                                                    Run Date 99/99/99
  04                                                                                                                                                                    Run Time 99:99:99
  05
  06
  07
  08
  09
  10
   .
   .
   .
  36
  37
  38
  39   ***Fields:
  40   *(1)
  41   *(2)
  47




Section 4.       Suggested Unit Testing Approach

 A.    TEST APPROACH
 Include your unit test plan here.




 B.    POTENTIAL TEST CONDITIONS
Please list all test conditions.




 C.    POTENTIAL TEST DATA
 Please list test data.




 10/19/2011 4:20 AM                                         13                                            <Letter User Initials>
                                         M300 - Detailed Design Document
                                       M300 - Detailed Design Document

Section 5.     Modification history Log

Each time a change is made, a line should be added here.

  Date           Name             Software         Description
                                  version          (This is a sentence, link or reference to an MSR # if applicable)




Section 6.     Sign off and Approval

Sign-offs and approvals are specified within each CPU.

User Acceptance: (Only used when a business process is changed)

Signature ____________________________________Role_________________Date _________


Business Process Analyst Acceptance:

Signature ____________________________________Role_________________Date _________

Technical Lead Acceptance:

Signature ____________________________________Role_________________Date _________

Product Manager Acceptance:

Signature ____________________________________Role_________________Date _________

Cross-Team Acceptance (if needed):

Signature ____________________________________Role_________________Date _________


Signature ____________________________________Role_________________Date _________




10/19/2011 4:20 AM                                         14                                      <Letter User Initials>
                                            M300 - Detailed Design Document

				
DOCUMENT INFO
Shared By:
Categories:
Tags:
Stats:
views:7
posted:10/19/2011
language:English
pages:14