Integrated System Deployment & Support

MD70 Technical Specifications
<Deliverable ID_Module_Deliverable Name>

Author: Creation Date: 00-Month-2003

56058787.doc

Page 1 of 22 Last Updated: 4/18/2011 02:24:00 AM

Document Control
Reviewers Technical Analyst: ____________________________________ Functional Director: __________________________________ Technical Director: ____________________________________

Change Record
Date Name Issue # Description of Change

56058787.doc

Page 2 of 22 Last Updated: 4/18/2011 02:24:00 AM

.........................................................................................6 <Form Title> ....................................................................................12 Table and View Usage.....................................................................13 Table and View Usage................Concurrent Program Specifications........................................................14 Page Items................................................................................10 Table and View Usage.....11 Responsibilities.........................7 < Program Name> .....................................................................................................10 < Report Name> ....................................................................................................................................................................................................................................7 Field Summary...............................................10 Log Layout.12 Log Layout.............................................................................................................................9 Responsibilities.....................................9 Incompatibility.....................................................14 56058787.....11 Incompatibility...................................Discoverer Report/View Specifications......................................................................13 Report Access Information........5 Components................................................................................................................................................................................................................................................................................................................................Oracle Report Specifications...........12 Totals..........................................6 Diagram or Summary...........................................................................6 Request Sets......5 Process Flow .............................................................doc Page 3 of 22 Last Updated: 4/18/2011 02:24:00 AM ......................................13 Tab Name.....................................................................................................................2 Technical Overview.................................................................................................7 Form Layout & Navigation...............................7 Data Manipulation Rules..............................................11 Concurrent Program Executables............................13 Parameters...................9 Concurrent Programs.................12 Sort Sequence...........13 PL/SQL Usage..12 < Workbook/View Name> ...............................................Form Specifications..............12 Program Logic...................................Contents Document Control...........................................................................................................................................................................................................................................10 Program Logic...................................................................7 Table and View Usage...................................................................................................................................................................................10 Output Layout.......................9 Concurrent Program Executables................................................11 Parameters............................................................................................................9 Parameters..............11 Concurrent Programs........................................................................................................................................................................................

..................................................................14 Derived Column(s)..............pll Specifications.............................................................................................................................................................19 Message Text..........19 Approved Decision/Approach......................................................................................................................14 Total(s)............Custom.doc Page 4 of 22 Last Updated: 4/18/2011 02:24:00 AM ................................................................................................................................................................22 56058787......18 <Workflow Name> -........17 <Form Name> – <Form Description> -......................17 Table Changes...............................14 Help File Column Definitions...........................Custom Object Definitions.......................................................................15 <Report/Workbook Name> -................................................................ Sequences.................Report Layout............... Indexes....................21 Open and Closed Issues for this Deliverable........................................Workflow Specifications..........................17 Tables..............................................................15 Views Created....................19 Notifications.............19 Workflow Logic......................................................................................................................15 Program Logic....................................................Sort Sequence......................................22 Closed Issues............................................................................16 <Object Name> -........19 Workflow Definition............................................18 <Customization Name>.....................................................22 Open Issues...............................................................................................................

additional functional description and information should be included in this document. programs.pll. when. custom objects. Eliminate sections of this document that are not required for this customization (i. custom. There should be a description of what we are trying to accomplish functionally and the steps that are needed to get there. Discoverer Reports/Views. If an MD50 does not exist.doc Page 5 of 22 Last Updated: 4/18/2011 02:24:00 AM . remove the sections for forms..Technical Overview <Replace this verbiage with paragraphs that provide the following pieces of information. if an Oracle Report is being created. This section should include who.> Components Type Name Description Forms Concurrent Programs <Program Name> Oracle Reports Discoverer Reports/Views Custom Objects Custom. include a statement to the effect that it should be referred to for further details. why & how information. and workflows).pll Workflows <Form Name> <Program Name> <Description> <Description> <Report Name> <Workbook/View Name> <Object Name> <Form Name> <Workflow Name> <Description> <Description> <Description> <Customization Description> <Description> 56058787. what.e. If an MD50 exists.

doc Page 6 of 22 Last Updated: 4/18/2011 02:24:00 AM . as appropriate.xls ‘ or ‘Non-Scheduled Request Sets.xls’ at ‘S:\Finance\Request Set Documentation Links’ or ‘S:\HR\Request Set Documentation Links’. enter a step by step flow of how you expect the process to occur (this may not be necessary for Discoverer Reports).> Request Sets <Enter a summary of any request set(s) below. or if integration with another process is required. If this is a complicated integration or a workflow. If there are multiple components in this document.> Request Set Concurrent Programs 56058787. with the details documented in ‘Nightly Request Sets.Process Flow Diagram or Summary <Replace this with the following information. import a graphical chart of the process(es).

Form Specifications <Give the purpose of the form – why we are creating this form.> Table and View Usage Table Name Select Insert Update Delete Field Summary <This section should include field mapping that indicates which column in which table populates each field on the form. Any list of values 56058787. combinations of values that must exist together. etc.> Form Layout & Navigation <This section should include a mock-up of new forms or a cut-and-paste version of an existing form that is to be modified.doc Page 7 of 22 Last Updated: 4/18/2011 02:24:00 AM .<Form Title> . Also include rules such as what to do before a commit. or why we are changing an existing form. and the rule number that defines the manipulation.> Zone 1 Where/Order By: <criteria used to select and order records in form> Heading <Name on form> Table Name <table> Field/Column <Name from table> Type <datatype > Rqd ? Updateabl e/ Viewable Defaul t Rule <Rule #> Zone 2 Where/Order By: <criteria used to select and order records in form> Heading <Name on form> Table Name <table> Field/Column <Name from table> Type <datatype > Rqd ? Updateabl e/ Defaul t Rule <Rule #> Data Manipulation Rules <Include validation and data manipulation rules for each field on the form. It should also include the navigation steps needed to access this form. validation or list of values. whether fields on the form are viewable or updateable.

Where appropriate the rule number assigned here should be placed in the Field Summary tables.doc Page 8 of 22 Last Updated: 4/18/2011 02:24:00 AM .that should be used for verification should also be included.> 56058787.

e.Concurrent Program Specifications <Give the purpose of the concurrent program – why we are creating this program. Oracle Report. Yes or No> Incompatibility <List any incompatibilities for this program (i.doc Page 9 of 22 Last Updated: 4/18/2011 02:24:00 AM .< Program Name> . etc> <Program Name aka package or report name> Concurrent Programs Field Program Short Name Application Description Executable Name Value <UVA MODULE Unique Description> <UVA_MODULE_UNIQUE DESCRIPTION> UVA Custom Application <Brief Description of the Concurrent Program> <UVA_MODULE_UNIQUE DESCRIPTION> Parameters Parameter <Parameter Name> Descripti on Enabled <Show on Screen – Yes or No> Value Set <Name of Value Set in Oracle – If known> Defaul t Value Prompt <What the User will see in the parameter form> Required <If parameter is required. Host..> Concurrent Program Executables Field Executable Short Name Application Description Executable Method Executable File Name Value <UVA_MODULE_UNIQUE DESCRIPTION> <UVA_MODULE_UNIQUE DESCRIPTION> UVA Custom Application <Brief Description of the Concurrent Program> <PL/SQL. or why we are changing an existing program. it is incompatible with itself).> 56058787.

> Output Layout <If appropriate.Responsibilities <List the responsibilities that will be able to run this process. This section should contain the technical specifications for how to manipulate and pull data for this process. include the layout of the data that is to be printed in the log. include the layout of the data that is to be printed in the output.> Table and View Usage Table Name Selec t Inser t Updat e Delete Program Logic <Replace this with the following information.> Log Layout <If appropriate.> 56058787.doc Page 10 of 22 Last Updated: 4/18/2011 02:24:00 AM . when they are known.

why we are creating an Oracle report vs. or why we are changing an existing report. Yes or No> Incompatibility <List any incompatibilities for this report..> Concurrent Program Executables Field Executable Short Name Application Description Executable Method Executable File Name Value <UVA_MODULE_UNIQUE DESCRIPTION> <UVA_MODULE_UNIQUE DESCRIPTION> UVA Custom Application <Brief Description of the Concurrent Program> Oracle Report <Program Name aka package or report name> Concurrent Programs Field Program Short Name Application Description Executable Name Value <UVA MODULE Unique Description> <UVA_MODULE_UNIQUE DESCRIPTION> UVA Custom Application <Brief Description of the Concurrent Program> <UVA_MODULE_UNIQUE DESCRIPTION> Parameters Paramete r <Paramet er Name> Descripti on Enabled <Show on Screen – Yes or No> Value Set <Name of Value Set in Oracle – If known> Default Value Prompt <What the User will see in the parameter form> Required <If parameter is required. a Discoverer report or a concurrent program.Oracle Report Specifications <Give the purpose of the Oracle report – why we are creating this report.> 56058787.e.doc Page 11 of 22 Last Updated: 4/18/2011 02:24:00 AM .< Report Name> . it is incompatible with itself). (i.

> BEFORE report trigger <Include any logic that should occur before you run the SQL that creates the report (i. creating a temporary table that will be used in the report logic).e..> AFTER report trigger <Include any logic that should occur after the report logic (i.e..doc Page 12 of 22 Last Updated: 4/18/2011 02:24:00 AM .> 56058787.Responsibilities <List the responsibilities that will be able to run this report. include the layout of the data that is to be printed in the log. cleaning up temporary tables). when they are known.> Report Logic <Include the logic that creates the report. This section should contain the technical specifications for how to manipulate and pull data for this report.> Log Layout <If appropriate.> Table and View Usage Table Name Select Insert Update Delet e Sort Sequence Column Name Ascendin g Descendi ng Totals Total Sub Total Grand Total Program Logic <Replace this with the following information.

the Tab Name area through the Program Logic area can be repeated for workbooks with multiple tabs. and the responsibility(ies) that can execute this report. even though no workbook will be created.> Report Access Information <Include the Workbook name.Discoverer Report/View Specifications <Give the purpose of the Discoverer report – why we are creating this report. Page Items and Hide Duplicate Rows should be <checked/unchecked>. This section will also be used for views that will be available in Discoverer. Not all of the information in this section will be needed in these cases.> Workbook Name: Instance Responsibilities Report Description: This report contains salaried faculty and their current EOP Reference information. If appropriate.< Workbook/View Name> . Tab Name <Include the tab name for this report. This will usually be an abbreviated version of the report name. why we are creating a Discoverer report vs.> Table and View Usage Table Name PL/SQL Usage Package Function 56058787. The instance will normally be ODS. but may occasionally be Production.doc Page 13 of 22 Last Updated: 4/18/2011 02:24:00 AM . an Oracle report or a concurrent program. the instance(s) in which this report should be executed.

doc Page 14 of 22 Last Updated: 4/18/2011 02:24:00 AM . A Group Sort will cause duplicates to “not” be repeated on the report.> Column Name Ascending/ Descending Group Sort Derived Column(s) Column Name How to Derive (Calculation) Total(s) Column to Total Sub Total on change of: Grand Total 56058787.Parameters Parameter Name Prompt Description Value Set Allow Multipl e Values? <Y or N> Default Value <only needs to be specified when the parameter will be printed in the report titles> <include when more information is needed for the prompt> Page Items Column Name Sort Sequence <Note: Whatever is entered in Page Items will be the primary sort.

> Views Created <List the views that were created during development and a short description of how they are used. and a functional description of what is in that column.> <Other comments that help explain anything unusual that had to be done to make this work. Include ‘why’ they were created this way.> <Optional. include a longer description of the view.Help File Column Definitions <Include each column that will appear on the report with an alias.> Column Name Alias Description Program Logic <Replace this with the following information. Include any data formatting that is required (i.> View Name Short Description Long Description Explanatory Comments Business Area <View Name> <Short description that can be up to 80 characters. the number of decimal places for numbers). This information will be included in the Help file. when appropriate..doc Page 15 of 22 Last Updated: 4/18/2011 02:24:00 AM . This section should contain the technical specifications for how to manipulate and pull data for this report. If appropriate. if needed. More detailed description that is unlimited in length. Indicate which report this view was created for. Other explanatory comments may also be included. This information will be used in the End User Layer.e.> <Indicate the Business Area(s) to which this view should belong in Discoverer.> 56058787. These comments do not appear in the Help file.

and the proposed report format.Report Layout <Include this section for both Oracle Reports and Discoverer Reports. It should include the desired report titles.> 56058787.> University of Virginia Report Title <Show report columns to be printed.<Report/Workbook Name> -.doc Page 16 of 22 Last Updated: 4/18/2011 02:24:00 AM . include page items. This could be a spreadsheet that contains a sample of the report layout. For Discoverer reports.

Custom Object Definitions Tables.<Object Name> -. Table Name: Column name <UVA_Module_Table Name> DataType Nullable Default Primary Key: <Column(s) that specifies what values signify a unique row in the table> Foreign Key: <Column that has a value that is a primary key from another table and the data entered will be validated against the other table. Indexes.doc Page 17 of 22 Last Updated: 4/18/2011 02:24:00 AM . Sequences This section describes the UVA tables that will be built to support this process.> Index: <The Column(s) that should have an index created> Sequence: <uva_table_name_s that is used for generating a unique key to each row> <Include any other table constraints that are appropriate.> Table Changes <Indicate that changes are required to existing custom tables for this process.> 56058787. and indicate the deliverable name that contains the specifications for the table.

doc Page 18 of 22 Last Updated: 4/18/2011 02:24:00 AM .pll Specifications <Customization Name> <Customization Description> Custom.> 56058787.<Form Name> – <Form Description> -. This section should contain the technical specifications for how to manipulate the form.Custom.pll Logic <Replace this with the following information.

Normal . Do not include screen shots of the actual workflow. Trigger name> Item Key Formula <unique key><dash><sequence><source> Include source if the workflow is initiated from multiple locations.> Workflow Definition Workflow Name UVA<XXXXX>. Workflow Logic <Create a verbal description of how the workflow should perform.> Notifications Notification Name UVA<name> Notification Description <description of notification> Performer (Recipient) <Who will receive the email. either a person or a role> Priorit y <High.<Workflow Name> -. For example: if you need to retrieve the project. or Low> Timeou t <Lengt h of time that should elapse before timeout > Respon se Require <Yes/No > Respons e Values <Values the user can choose from for the response > Message Text Notification Name <same from above> Subject <message subject> Message Text <The text of the message> 56058787. This should include a definition of where to select the data.doc Page 19 of 22 Last Updated: 4/18/2011 02:24:00 AM .Workflow Specifications <The format for this section is still in draft form.wf t Workflow Title UVA <Description of the workflow> Initiated From <Form. Package. This format can be used until it has been finalized. what tables should be selected from and what are the criteria of the selection.

56058787.doc Page 20 of 22 Last Updated: 4/18/2011 02:24:00 AM .

Include why we did things a certain way. Include information on changes that occur after the original development. or didn’t do them another way.> 56058787. In particular. include items that may have changed from the original perception of how the task would be completed.Approved Decision/Approach <Include any decisions made during development of this deliverable that affect the outcome.doc Page 21 of 22 Last Updated: 4/18/2011 02:24:00 AM .

doc Page 22 of 22 Last Updated: 4/18/2011 02:24:00 AM .Open and Closed Issues for this Deliverable Open Issues ID Issue Resolution Responsibility Target Date Impact Date Closed Issues ID Issue Resolution Responsibility Target Date Impact Date 56058787.

Sign up to vote on this title
UsefulNot useful