Your Corporation
Name
Report Specification
Maximo Asset Management
Report Name
Table of Contents
Specification Details.............................................4
Document Control Information.......................4
Revision Control Information...........................4
Environment and User Requirements...............5
Environment Information.................................5
Report Details.......................................................6
Report Purpose.................................................6
Report Users......................................................6
Report Definitions.............................................6
File and Layout Details.....................................7
Access Details...................................................7
Report Performance Settings..........................8
Parameters............................................................9
Report Parameter Type....................................9
Application Parameter Reports Only* Report Level
Settings..............................................................9
Parameterized Reports** Parameter Settings 10
Parameter 1:...................................................10
Parameter 2:....................................................11
Parameter 3:...................................................12
2
Report Content....................................................13
Header.............................................................13
Graphs.............................................................14
Sub Header 1..................................................15
Sub Header 2..................................................16
Sub Header 3..................................................17
Report Mockup....................................................18
Testing Considerations.......................................19
Use Case Scenarios or Notable Test Requirements 19
3
Report Name
Report Specification
Company Name
Specification Details
This document is intended to convey the details and requirements of the
report specified above.
Document Control Information
Name and Title Company Date
Author
Approver
Owner
Revision Control Information
Number Revision Changed By Date
Description
Original Release
4
Environment and User Requirements
Environment Information
Type Versions Other
Maximo Asset
Release Management
Industry
Solutions
Database
Software
Multi
Language
Reporting
Software
5
Report Details
Report Purpose
Detail the primary use of this report.
Report Users
Detail which Maximo Users will use this report.
Note if this report will be accessed by Non-Maximo users via
emailing/scheduling.
Report Definitions
Detail any unique scenarios used in the report. For example, does the
report update the database, only contain a graph, or is part of a multi-
report drilldown package.
6
File and Layout Details
Details
Title
File Name
Application(s) Report Accessed
From
Directory Folder Where Report
Stored
XML File Name
Properties File Name
Report Type
Report Base (Template,
Delivered Report, or Ad Hoc
Report)
Page Size (Letter, Legal or A4)
Page Orientation (Portrait or
Landscape)
Access Details
If Yes, State Value Access Point
Hyperlink To
KPI
Report List Portlet
Other
7
Report Performance Settings
If Yes, State
Value
Priority
Schedule Only *Recommended for large, batch reports
Report Performance Notes
1. Any Reserved Processing Times for Schedule Only reports will be set
separately by Administrator
2. Record Limits defined under Application Parameter Section below
8
Parameters
Report Parameter Type
Note: Select one of the three types below
(1) Application, (2) Parameterized or (3) Both Application and
Parameterized
Report Type
Application Parameter Reports Only* Report Level Settings
Feature REPORT Attribute Value
Browser View QL
Browser View Tab Location QLLOC
Select One: All, List, Main, None
Direct Print DP
Direct Print Tab Location DPLOC
Select One: All, List, Main, None
Direct Print with Attachments PAD
Direct Print with Attachments Tab PADLOC
Location
Select One: All, List, Main, None
Order of report within icon display TOOLBARSEQUEN
CE
Is report a detail report which DETAIL
should be enabled for record
limits?
9
If yes, define record limit value. RECORDLIMIT
*Note: The settings above can only be used if a report is an Application
Parameter Report.
Parameterized Reports** Parameter Settings
* Indicates Required Values
Parameter 1:
Description Attribute Value
* Parameter name as defined Parameter name
in report design file
Database attribute. Can be Attribute name
null for unbound parameter
only.
Lookup Value Lookup name
* Order for parameter to Sequence
display on request page
Display Value Labeloverride
Default Value Defaultvalue
* Is parameter required? Required
For bound parameters only Operator
< , < =, > , > =
* Can multiple parameters be Multilookup
input?
**Note: The settings above can only be used if a report is an (2)
Parameterized or (3) Both Application and Parameterized
10
Parameter 2:
Description Attribute Value
* Parameter name as defined in Parameter name
report design file
Database attribute. Can be null Attribute name
for unbound parameter only.
Lookup Value Lookup name
* Order for parameter to display Sequence
on request page
Display Value Labeloverride
Default Value Defaultvalue
* Is parameter required? Required
For bound parameters only < , < Operator
=, > , > =
* Can multiple parameters be Multilookup
input?
11
Parameter 3:
Description Attribute Value
* Parameter name as defined in Parameter name
report design file
Database attribute. Can be null Attribute name
for unbound parameter only.
Lookup Value Lookup name
* Order for parameter to display Sequence
on request page
Display Value Labeloverride
Default Value Defaultvalue
* Is parameter required? Required
For bound parameters only < , < Operator
=, > , > =
* Can multiple parameters be Multilookup
input?
12
Report Content
Header
Header Fields
Display Value Field Value Format Notes
Header/Report Notes
1.
13
Graphs
Graph Type (Bar, Line, Pie, Other) and Dimension (2D or 3D )
Axis Definition (If Bar or Line)
Graph Title
Graph Colors
Format Notes
1. Examples of Format notes include insert page break after graph
display.
Graph Details
1. Examples of Graph Details include In bar chart, display asset with
lowest availability first
Graph Mockup
14
Sub Header 1
Subheader 1 Fields
Display Value Field Value Format Notes
Sub Header 1 Notes
1. Include information on sorting or display orders
15
Sub Header 2
Sub Header 2 Fields
Display Value Field Value Format Notes
Sub Header 2 Notes
16
Sub Header 3
Sub Header 3 Fields
Display Value Field Value Format Notes
Sub Header 3 Notes
1.
17
Report Mockup
Report Content Display
Insert Mockup of report display per example below
18
Testing Considerations
Use Case Scenarios or Notable Test Requirements
1.
19
