solution manager bw naming standards
TRANSCRIPT
7/30/2019 Solution Manager BW Naming Standards
http://slidepdf.com/reader/full/solution-manager-bw-naming-standards 1/17
Solution Manager
Standards
for
SOAR BW
7/30/2019 Solution Manager BW Naming Standards
http://slidepdf.com/reader/full/solution-manager-bw-naming-standards 2/17
Table of Contents
1. PROJECT ADMINISTRATION - DOCUMENTATION OVERVIEW..............................................3
1.1 PROJECT NAME AND OVERVIEW....................................................................................................................3
1.2 DOCUMENTATION R ULES ............................................................................................................................3
VARIABLES......................................................................................................................................................31.3 PROJECT STANDARDS ..................................................................................................................................4
1.3.1 Status Values ..................................................................................................................................4
1.3.2 Keywords ........................................................................................................................................4
1.3.3 Documentation Type.......................................................................................................................4
2. BUSINESS BLUEPRINT - SOAR BW PROGRAM DOCUMENTATION.........................................5
2.1 MASTER DATA ..........................................................................................................................................7
2.2 BUSINESS SCENARIOS – TRANSACTION DATA................................................................................................10
2.3 OTHER DOCUMENTS..................................................................................................................................13
2.3.1 Custom Programs..........................................................................................................................13
2.3.2 Legacy Interfaces..........................................................................................................................13
2.3.3 Position Papers.............................................................................................................................13
2.3.4 Performance documents................................................................................................................132.3.5 Variables.......................................................................................................................................13
2.3.6 User Exits......................................................................................................................................13
2.3.7 Z-Tables.........................................................................................................................................13
2.3.8 SAP's Important Messages............................................................................................................13
3. TEST ORGANIZATION - TEST SPECIFICATIONS........................................................................14
3.1 TEST DOCUMENTS AND TEST SCENARIOS......................................................................................................14
4. REPORTING SPECIFICATIONS.........................................................................................................15
4.1 BUSINESS BLUEPRINT ................................................................................................................................15
4.1.1 Administration...............................................................................................................................15
4.1.2 Assignments...................................................................................................................................15
4.2 CONFIGURATION........................................................................................................................................154.2.1 Administration...............................................................................................................................15
4.2.2 Assignments...................................................................................................................................15
4.3 TEST ORGANIZATION.................................................................................................................................15
......................................................................................................................................................................16
5. CHANGE LOG ........................................................................................................................................17
......................................................................................................................................................................17
7/30/2019 Solution Manager BW Naming Standards
http://slidepdf.com/reader/full/solution-manager-bw-naming-standards 3/17
1. Project Administration - Documentation Overview
1.1 Project Name and Overview
All BW documents will be maintained in one central location. This structure is similar to the
structure in the BW administrative workbench. Each new project or Phase will create newdocuments in the ZSOAR_BW project in solution manager and then LINK these documents to
the respective flights/releases to make all modifications and updates to the documents. This
process will ensure one up-to-date document for each object that exists in BW and all updates by
each flight/release will be reflected.
1.2 Documentation Rules
The following points will broadly give some guidelines on how the documentation should bemaintained and some of the standard rules that should be followed for better maintenance of
documents. If these guidelines are followed it will help the project team to manage documents
more efficiently and it will also help for every one who are trying to locate documents.
The following list will outline the documents that should be created for each object in BW.Document For Buss
Req.
Funct.
Spec
Tech
Spec
Test
Script
Comments
BW list of Documents X
InfoObject X X
InfoSource X X
ODS X X X Need one Functional Spec, if more than one Data Target
uses this ODS.
InfoCube X X X
MultiCube X X XQuery X X X
InfoSet X X X
Variables X X
User Exits X X
Custom Program(s) X X X
Other Documents Like Position Papers, tables,
Variants
The following list will outline the standard Technical Name that should be assigned to eachdocument that is created in BW.Document For Functional Spec Technical Spec Test Script Comments
Flight or Release BW-REL
InfoObject BW-FIO BW-TIO BW-SIO
InfoSource BW-FIS BW-TIS BW-SIS
ODS BW-FOD BW-TOD BW-SOD
InfoCube BW-FIC BW-TIC BW-SIC
MultiProvider BW-FMP BW-TMP BW-SMP
Query BW-FQY BW-TQY BW-SQY
InfoSet BW-FIS BW-TIS BW-SIS
User Exits BW-FUE BW-TUE BW-SUE
Custom Program(s) BW-FCP BW-TCP BW-SCP
Variables BW-FVR BW-TVR BW-SVR
Z Tables BW-FZT BW-TZT BW-SZT
Legacy Interfaces BW-FLG BW-TLG BW-SLG
7/30/2019 Solution Manager BW Naming Standards
http://slidepdf.com/reader/full/solution-manager-bw-naming-standards 4/17
1.3 Project Standards
1.3.1 Status Values
01 Open
2 In Process
3 Under Review4 Completed
5 Pre-Defined
6 Undefined7 On Hold
1.3.2 Keywords
FUNCT Functional Design Specs
TECH Technical Design Specs
PMO Project ManagementPOSIT Position Papers
PROD Production SupportTESTING Testing ScriptsPERF Performance
1.3.3 Documentation Type
Z120 InfoObject Tech Spec - Key Figures
Z121 InfoObject Tech Spec-Characteristics
Z122 InfoObject Tech Spec-InfoObjectZ126 InfoSource Functional Spec
Z127 InfoSource Technical Spec
Z130 ODS Functional Spec
Z131 ODS Technical SpecZ136 InfoCube Functional Spec
Z137 InfoCube Tech Spec
Z140 MultiCube Functional SpecZ141 MultiCube Technical Spec
Z146 Query Functional Spec
Z147 Query Technical SpecZ150 Program Functional Spec
Z151 Program Technical Spec
Z160 Position paper templateZ161 Requirements Gathering document template
Z162 Proposed enhancement document templateZ163 General Documentation - Word
Z163 General Documentation - Excel
7/30/2019 Solution Manager BW Naming Standards
http://slidepdf.com/reader/full/solution-manager-bw-naming-standards 5/17
2. Business Blueprint - SOAR BW Program Documentation
Project Listing
Select ZSOAR_BW as the project for all BW related documentation.
7/30/2019 Solution Manager BW Naming Standards
http://slidepdf.com/reader/full/solution-manager-bw-naming-standards 6/17
BW Project Structure
7/30/2019 Solution Manager BW Naming Standards
http://slidepdf.com/reader/full/solution-manager-bw-naming-standards 7/17
2.1 Master Data
This section contains details of Master data Objects. All Master data related documents
will be saved in this section.
1. If the InfoObject created is a Master data Object, then
a. A technical spec should be created with all the details of data mappings anddetails of routines used to modify data received from the source system.
b. Based on the complexity of the Master data InfoObject, a functional spec should
be created.
2. If the InfoObject is just a normal Characteristic, Key figure or a Time Characteristics,then the respective documents list should be updated.
3. All related documents to this InfoObject should be added to this list.
Sample documents loaded into InfoObjects Characteristics
7/30/2019 Solution Manager BW Naming Standards
http://slidepdf.com/reader/full/solution-manager-bw-naming-standards 8/17
Tool bar options
Insert Document and Delete Row
Available options when adding a new Object
Title Give a meaningful title for the document that is being
created.
Documentation Type Select the relevant document type to get the correct
standard template.
Create New Document Based on the document type that is picked a standard
template will be loaded for editing.
Link to a solution Manager Doc This option will allow you to link an already existing
document saved with in solution manager. The document
can be saved under any project. Any changes done for this
document will result in updates in all links.
Copy of a solution manager Doc This option will make a copy of the existing document; any
changes done for this document will not result in updates in
the original document.
Upload File This option will copy any existing document, on your
computer or a network drive, into the solution manager.
Web Link Not currently in use
Change Document and Delete Document Allows documents to be updated and deleted. Documents that are linked can also be updated; there is no
security with the present release. You will delete the document from Solution
Manager if you click on the trashcan.
Where-used List Shows all the locations that the file is linked within
Solution Manager.
Export Allows documents to be downloaded to your computer or
to a network drive.
7/30/2019 Solution Manager BW Naming Standards
http://slidepdf.com/reader/full/solution-manager-bw-naming-standards 9/17
Attributes / Technical Information
Make sure all the Technical Information is properly maintained.
After adding a new document, follow the technical standard naming convention must beadded.
Sl.No Standards Comments
1 Title Should be populated with data from prior screen
2 Technical Name First Two Characters are always BW
The next Character represents Technical or Functional document,
followed by Object Code IO stands for InfoObject
The Next three digits are numeric numbers. Pick the next
incremental sequence number.
3 Documentation type Should be populated with data from prior screen
4 Status This option will indicate the documentation status. All
documents are defaulted to In Processing
5 Priority This option will show the Priority of updating the document. Alldocuments are defaulted to Medium
6 Owner The ownership can be changed to anyone who has access to
solution manager. All documents are defaulted to the person who
created the document
Change log will be saved and can be viewed from history tab.
7/30/2019 Solution Manager BW Naming Standards
http://slidepdf.com/reader/full/solution-manager-bw-naming-standards 10/17
Move Up and Move Down The location of the
documents can be adjusted by selecting the line and then clicking on the up and down
arrows.
2.2 Business Scenarios – Transaction Data
This section contains details of Transaction data Objects. All Transactional data Objects and
related documentation will be saved in this section.1. If the Object created is an InfoSource, ODS, Cube or MultiCube:
a. A technical spec should be created with all the data mappings pointing to the
source of data, any conversions or transformations that take place while loadingdata.
b. Based on the number of data targets that will use an InfoSource or ODS a
functional spec should be created. Functional specs for these objects are entirely based on complexity and customization involved while building these Objects.
c. Follow grid in section 1.2 (Document rules) to determine what types of
documents are required and proper Technical Name standards.
All documents should go into the respective InfoAreas as we see in BW system
Transaction Data
7/30/2019 Solution Manager BW Naming Standards
http://slidepdf.com/reader/full/solution-manager-bw-naming-standards 11/17
Each InfoArea will have respective Objects as we see in BW system. Documents should
be maintained in against each object. Since some of the test scripts may go across objects,all new test scripts should be created under Test Script structure element. Based on the
necessity, link these test scripts to relevant Objects.
Sample
Add and link all necessary documents under this structural element.
7/30/2019 Solution Manager BW Naming Standards
http://slidepdf.com/reader/full/solution-manager-bw-naming-standards 12/17
Technical InformationMake sure all the Technical Information is properly maintained
7/30/2019 Solution Manager BW Naming Standards
http://slidepdf.com/reader/full/solution-manager-bw-naming-standards 13/17
2.3 Other Documents
2.3.1 Custom Programs
All ABAP Programs that have been written for BW.
The title of the file should begin with the name as it appears in SAP. Follow grid in section 1.2 to determine what
types of documents are required and proper Technical Name standards.
2.3.2 Legacy Interfaces
All jobs that have been created to deal with files from Legacy systems.
The title of the file should begin with the name of the Legacy job as it appears in the Legacy system. Follow grid insection 1.2 to determine what types of documents are required and proper Technical Name standards.
2.3.3 Position Papers
All position papers written.
The title of the document should be detailed. Follow grid in section 1.2 to determine what types of documents are
required and proper Technical Name standards.
2.3.4 Performance documents
Any performance related documentation, such as metrics.
Follow grid in section 1.2 to determine what types of documents are required and proper Technical Name standards.
2.3.5 Variables
The title of the file should begin with the name as it appears in SAP. Follow grid in section 1.2 to determine whattypes of documents are required and proper Technical Name standards.
2.3.6 User Exits
All custom User Exits written.
The title of the file should begin with the name as it appears in SAP. Follow grid in section 1.2 to determine what
types of documents are required and proper Technical Name standards.
2.3.7 Z-Tables
All z-tables that are created.
The title of the file should begin with the name as it appears in SAP. Follow Follow grid in section 1.2 to determinewhat types of documents are required and proper Technical Name standards.
2.3.8 SAP's Important Messages
Any important information which anyone receives from SAP and should be shared. This should include any
presentations from meetings presented by SAP.
The title of the file should begin with the name as it appears in SAP. Follow grid in section 1.2 to determine what
types of documents are required and proper Technical Name standards.
7/30/2019 Solution Manager BW Naming Standards
http://slidepdf.com/reader/full/solution-manager-bw-naming-standards 14/17
3. Test Organization - Test Specifications
3.1 Test documents and Test Scenarios
Each InfoArea contains a Test Script folder. In this folder will be the most recent copy of all
related test scripts. It is possible that a test script will cross InfoAreas. In that case, place thescript under the InfoArea, which contains most of the components of the script.
When a flight/release goes into Unit Test, all necessary adjustments will be made to this original base file. Upon completion of all necessary adjustments, this file will be COPIED to the “Test
Script Results” folder, under the correct flight/release and the appropriate iteration folder. All
test results will be entered in this file. Results should never be placed in the file in the InfoArea
Folder.
Any changes that are found during testing, must be made to the original base file in the InfoArea
Folder.
These original base files will also be used when Regression Testing is necessary. Regression
Testing will be handled in the same manner as regular flight/release testing. All results will be placed in a folder within the “Test Script Results” folder under an appropriately named folder.
7/30/2019 Solution Manager BW Naming Standards
http://slidepdf.com/reader/full/solution-manager-bw-naming-standards 15/17
4. Reporting Specifications
4.1 Business Blueprint
4.1.1 Administration
Most of these reports are self-explanatory; in most cases the only difference between
various reports listed above are the filter options available for this Report.
4.1.2 Assignments
Most of these reports are self-explanatory; in most cases the only difference between
various reports listed above are the filter options available for this Report.
4.2 Configuration
4.2.1 Administration
Most of these reports are self-explanatory; in most cases the only difference betweenvarious reports listed above are the filter options available for this Report.
4.2.2 Assignments
Most of these reports are self-explanatory; in most cases the only difference between
various reports listed above are the filter options available for this Report.
4.3 Test Organization
Not Used based on standard SAP functionality.
7/30/2019 Solution Manager BW Naming Standards
http://slidepdf.com/reader/full/solution-manager-bw-naming-standards 16/17
7/30/2019 Solution Manager BW Naming Standards
http://slidepdf.com/reader/full/solution-manager-bw-naming-standards 17/17
5. Change Log
Document Title:
Author:
Date Created:
Name Date of
Changes
Summary of Changes
***End of Document***