You are on page 1of 21

ABC

Corporation

Report Specification

Maximo Asset Management

Inventory Balance Report


Table of Contents

Specification Details............................................................4

Document Control Information.....................................4

Revision Control Information.........................................4

Environment Details............................................................5

Environment Information..............................................5

Report Details......................................................................6

Report Purpose...............................................................6

Report Definitions...........................................................6

Report Users....................................................................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: Item Number.......................................10

Parameter 2: Storeroom............................................11

Attribute.........................................................................11

Value...............................................................................11

Parameter 3: Site........................................................12

2
Report Content...................................................................13

Header...........................................................................13

Header Fields...............................................................13

Header Notes...............................................................13

Graphs............................................................................14

Sub Header 1................................................................15

Sub Header 2................................................................17

Sub Header 3................................................................18

Report Mockup...................................................................19

Report Content Display................................................19

Testing Considerations......................................................20

Use Case Scenarios or Notable Test Requirements. 20

3
Inventory Balance

Report Specification
ABC Corporation
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 John Smith ABC Company 11/28/12
Approver Joe Wilson ABC Company 12/3/12
Owner

Revision Control Information

Number Revision Changed By Date


Description
Original Release 11/28/12
1 Added subheader 12/3/12
1 formatting
notes

4
Environment Details

Environment Information

Type Versions Other


Maximo Asset 7.1.1.8
Release Management
Industry Oil And Gas
Solutions
Database Oracle 10
Software
Multi English Only
Language
Reporting BIRT 2.3.2
Software

5
Report Details

Report Purpose
The primary purpose is to indicate what item numbers are available in
inventory.

The secondary purpose is to highlight older inventory by showing older or


null dates first in the Last Issue Date, and Last Receipt Date Fields.

Report Definitions

Report Users
Detail which Maximo Users will use this report.

Used by Item Managers, Planners, and Schedulers.

Additionally, detail if this report will be accessed by Non-Maximo users.

N/A

6
File and Layout Details
Details

Title Inventory Balance

File Name Inventory_balance_abc.rptdesign

Application(s) Report Accessed Inventory


From
Directory Folder Where Report INVENTOR
Stored
XML File Name reports_abc.xml

Properties File Name properties_abc.xml

Report Type List Report

Report Base (Template, Maximo List Template


Delivered Report, or Ad Hoc
Report)

Page Size Letter

Page Orientation Portrait

Access Details
If Yes, State Value Access Point

Hyperlink To Item Order Status Item Number


item_orderstatus.rptdesign
KPI Inventory Turns

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 Parameterized
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

The settings above can only be used if a report is an Application


Parameter Report.

10
Parameterized Reports** Parameter Settings
* Indicates Required Values

Parameter 1: Item Number


Description Attribute Value

* Parameter name as defined in Parameter name itemnum


report design file

Database attribute. Can be null Attribute name ITEMNUM


for unbound parameter only.

Lookup Value Lookup name Item

* Order for parameter to display Sequence 1


on request page

Display Value Labeloverride Item Number

Default Value Defaultvalue

* Is parameter required? Required N

For bound parameters only < , < Operator


=, > , > =

* Can multiple parameters be Multilookup Y


input?

**Note: The settings above can only be used if a report is an (2) Parameterized
or (3) Both Application and Parameterized

11
Parameter 2: Storeroom
Description Attribute Value

* Parameter name as defined in Parameter name Location


report design file

Database attribute. Can be null for Attribute name Location


unbound parameter only.

Lookup Value Lookup name Storeroom

* Order for parameter to display on Sequence 2


request page

Display Value Labeloverride Storeroom

Default Value Defaultvalue

* Is parameter required? Required Y

For bound parameters only < , < =, Operator


>,>=

* Can multiple parameters be input? Multilookup N

12
Parameter 3: Site
Description Attribute Value

* Parameter name as defined in Parameter name Siteid


report design file

Database attribute. Can be null for Attribute name Siteid


unbound parameter only.

Lookup Value Lookup name Site

* Order for parameter to display on Sequence 3


request page

Display Value Labeloverride Site

Default Value Defaultvalue

* Is parameter required? Required Y

For bound parameters only < , < =, Operator


>,>=

* Can multiple parameters be input? Multilookup N

13
Report Content

Header
Header Fields

Display Value Field Value Format Notes

Storeroom: User Inputted


Parameter Value
Site: User Inputted
Parameter Value

Header Notes

1.

14
Graphs
Graph Type (Bar, Line, Pie, Other) and Dimension (2D or 3D )

N/A

Axis Definition and Label Display

Graph Title

Graph Colors

Format Notes

Graph Details

Graph Mockup

15
Sub Header 1
Subheader 1 Fields

Display Value Field Value Format Notes

Item INVENTORY.ITEMNUM

Description ITEM.DESCRIPTION

Issue Unit INVENTORY.ISSUEUNIT

Current Balance Sum(INVBALANCES.CURBAL) where Number. 2


Condition Code is the Same for Item decimal
# places

Qty Avbl Current Quantity Quantity Reserved Number. 2


decimal
places
Qty Resvd Sum(INVRESERVE.RESERVEDQTY) Number. 2
where Condition Code is the Same for decimal
Item # places

Cost Dependant on MAXVARS Value. See Number. 2


Note 4 below. decimal
places
Extd Cost Cost * Current Balance Number. 2
decimal
places
Last Issue Date Max(MATUSETRANS.ACTUALDATE) Date Only.
where MATUSETRANS.ISSUETYPE = Short Format.
ISSUE

Last Receipt Max(MATRECTRANS.ACTUALDATE) Date Only.


Date where MATRECTRANS.ISSUETYPE = Short Format.
RECEIPT

Sub Header 1 Notes:

1. Display results in ascending order of Item Number

2. Do not include items with a status of OBSOLETE.

..where INVENTORY.STATUS = OBSOLETE

16
3. The report should NOT filter the results to only show items with values
in Last Issue Date and Last Receipt. If an item does not have values for
Last Issue Date, Last Receipt Date a null value will display in these fields
for that record.

This means that Null Values can exist for Last Issue Date and Last Receipt
Date.

4. To determine the value of the Cost Field, where ITEM.ITEMTYPE = ITEM

In MAXVARS, where VARNAME = DEFISSUECOST, if VARVALUE = AVGCOST, then

Cost = INVENTORY.AVGCOST

In MAXVARS, where VARNAME = DEFISSUECOST, if VARVALUE = STDCOST, then

Cost = INVENTORY.STDCOST

In MAXVARS, where VARNAME = DEFISSUECOST, if VARVALUE = LASTCOST, then

Cost = INVENTORY.LASTCOST

17
Sub Header 2
Sub Header 2 Fields

Display Value Field Value Format Notes

Sub Header 2 Notes

18
Sub Header 3

Sub Header 3 Fields

Display Value Field Value Format Notes

Sub Header 3 Notes

1.

19
Report Mockup

Report Content Display

20
Testing Considerations

Use Case Scenarios or Notable Test Requirements

1. Confirm that items with null values in Last Issue Date and Last Receipt
display.

21

You might also like