bo report design and development standards

Business Objects Design Reports and Development Standards

Page 2 of 14

Business Objects ReportsDesign and Development Standards

V 1.0


DOCUMENT REVISION LIST

Document Name: Business Objects Reports Design and Development Standards

Release Notice Reference (for release):

Rev. No.

Revision Date

Revision Description Page No.

Prev Page No.

Action Taken

Addenda/New Page

Release Notice Reference

of 14


Table of Contents

1 Introduction......................................................................................................................................4

2 Reports Design Standards.......................................................................................................5

2.1 General Standards for Report Design................................................................................52.2 Report Margins............................................................................................................................52.3 Report Columns/Fields.............................................................................................................62.4 Charts/Graphs.............................................................................................................................72.5 Cell borders and gridlines.......................................................................................................72.6 Colors..............................................................................................................................................12.7 Macros, VBA, ASP/JSP...............................................................................................................1

3 Naming Conventions...................................................................................................................2

3.1 Reports...........................................................................................................................................2

4 Help Tab................................................................................................................................................2

of 14


1 Introduction

This document outlines the standards to be followed while designing the BO Reports

of 14


2 Reports Design Standards

These standards are meant for all reports generated by the system.

2.1 General Standards for Report Design

Property ValueReport Background WhitePage Layout PotraitMargin 28 x from all sides

2.2 Report Margins

Property ValueTop Margin Header Report Title, Name, Report ID, Company

Logo/Name (Name in Webi), And a line separating the Header from report body

Left Side of the Header Company Logo/NameCentre of the Header Report NameBottom Margin Footer Page NumberRight Side of the Hearder Last Execution TimeCentre of The Footer Page NumberReport Title Font Font : Arial

Font Style : Bold and UnderlinedSize : 12

Other Header/Footer Fields Font : ArialFont Style : Regular Size : 8

Cell Borders NO, borders not needed for the Header and Footer Cells

of 14


Header

Footer

The report header must repeat for all report pages. The report header must not repeat for the different break levels defined in the

report. Page numbers will be put on the report footer using the BO functions Page(),

2.3 Report Columns/Fields

Property ValuePrompt Values should be displayed in the top portion of

the report, after the headerReport Column Names Font : Arial

Font Style : BoldSize : 10Color : WhiteBackground : Blue

Data Field Font Font : ArialFont Style : RegularSize : 10Color : Black

Field – Character Left AlignedField – Date Centre Aligned, Format mm/dd/yyyyField – Numeric $$ Values Counts % Values

Right AlignedFormat $XXX.99, Two Decimal PointsNo Decimal PointsOne decimal Point

of 14


Prompt Values should be displayed below the Header

The Prompt “CE Team” and “Reporting Month” are displayed using the function UserResponse()

2.4 Charts/Graphs

Property ValueChart Border BoldChart Title Should be added, and appear on Top of

the Chart. Alignment – Centre, Wrap Text - Yes

Chart Title – Font Font: ArialStyle :BoldSize : 12

Legend YesValue Axis Default Auto OptionData Markers Yes, Specify Varying data MarkersAxis Values Format as per Chart RequirementChart Position Always on new page, check Print previewChart Color Dark Color, Preferred if the chart will be

Printed in Black and White

2.5 Cell borders and gridlines

of 14


Wherever gridlines are present in the actual report, the same should be simulated in the BO report using borders of the cells; unless otherwise, borders should be in bold (maximum thickness).

2.6 Alerter

The Alerter should be given a meaning full name Description should be Provided

of 14


2.7 Colors

BO report should be in monochrome, except for graphs where it’s not possible to show the difference in monochrome/ data labeling markers are same and cannot be modified.

Color schemes on chart bars need to be distinguishable when printed in black and white.

Drillable report labels should be bold blue and underlined

2.8 Macros, VBA, ASP/JSP

Macros, VB scripts, if used during development of reports should be named logically, e.g., AssignDefaultDatetoPrompt. The code should have (in comments) the description of why the macro was required and describe all the steps within the code of achieving the same.

The coding standards should be followed based on standards followed for coding a VB, JSP, or an ASP Application.

Page 1 of 14


3 Naming Conventions

3.1 Reports

Sr. No.

Object Naming Convention

1. VARIABLES Some meaningful names which describe the characteristics of the variables is to be given. Start the Variable name with v

Page 2 of 14


4 Help Tab

The Help tab will provide the background information of the report. The Tab will have the following information

Report NameReport OwnerContact InformationCreated ByCreation DateLast Update onLast Updated byReport RequirementFrequencyData Window Rolling 12 months, 1 Month, etc…Prompt help Prompt 1 accepts …. Values, e.g:123

Prompt 2…UniverseHandover Document Name

Page 2 of 14


Page 3 of 14

bo report design and development standards

Documents