43
Plan for Architectural Analysis for Identifying Query & Retrieval Components

Plan for Architectural Analysis for Identifying Query & Retrieval Components

Embed Size (px)

Citation preview

Page 1: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Plan for Architectural Analysis for Identifying

Query & Retrieval Components

Page 2: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Component types needed to support Query & Retrieval

Online Data

Viewing Compone

ntsGUM + QV

OutputMethod

Components

Print CentralExport to ExcelZip/Merge, etc.

OutputFormat

Components

Fixed Reports,Discoverer repts.Documents, etc.

Hit List Componen

tsCustom.hit lists,Default hit lists,Column sort Buttons, etc.

Query Parameter Componen

tsIndiv.query fields,special selects, default query blocks, custom.Query, etc.

Query &Retrieval

Architecture

Page 3: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Online Data Viewing Components

Purpose: For viewing details of the selected

or retrieved (hit list) record

Examples: Grant Update Module (GUM) screens – read only

– Application block – Review details block

– Admin. review block – Edit PI– Budget block – Addresses– CAN – SBIR/STTR; BAD codes

QuickView screens– Overview – PI/Staff – Organization– Budget – Budget detail – Award

detail

Page 4: Plan for Architectural Analysis for Identifying Query & Retrieval Components

QVOverviewScreen

GUMApplic. &Admin.ReviewBlocks

Page 5: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Output Method Components

Purpose: Methods for receiving output

results

Examples: Print Central Merge & Zip Export hit list to Excel Generate report & print Export report to Excel View document & print View and Print from Grant Folder Burn CD

Page 6: Plan for Architectural Analysis for Identifying Query & Retrieval Components
Page 7: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Output Format Components

Purpose: Formats for receiving output after

identifying desired query results

Examples: Fixed report Manipulable/exportable report (Discoverer) Labels report Form template report w/pre-printed info. PDF Document ASCII file Data for spreadsheet CD

Page 8: Plan for Architectural Analysis for Identifying Query & Retrieval Components
Page 9: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Query Components

Purpose: For facilitating user query

Examples: Individual query fields Lists of Values (LOVs) Special Selects (active grant, animal

concern, etc.) Default query blocks (QuickView, Grant

Mgmt.) Customizable query (ICSTORe Adv.Query) Special Views (PowerViews)

Page 10: Plan for Architectural Analysis for Identifying Query & Retrieval Components
Page 11: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Hit List Components

Purpose: For viewing query results to identify desired records

and for viewing retrieved informationExamples: Default Hit Lists (ICSTORe, Review, CRISP+) Customizable Hit List (ICSTORe) Sort buttons as column headers Select checkbox with ‘Select all/Deselect all’ Order number column with resequencing Book Definition

– Nested sorts– Sections with different sorts– Sort ‘by value’– Ascending/descending sort option

Page 12: Plan for Architectural Analysis for Identifying Query & Retrieval Components
Page 13: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Requirements for Universal Query Tool Architecture

Different categories of users have different requirements for query and retrieval,

making a single user interface impractical.

The purpose of this analysis is to identify requirements for different query & retrieval interfaces and their common components.

Page 14: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Types of Users

•Quick View Users•Scientific Query Users

- Regular

- Power•Advanced Query Users

(ICSTORe)

•Business Area Specific Users

Page 15: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Types of Users, cont.•Document

Tracking Users

•Program/IC Portfolio Users

•Peer Review Users

•Finance & Budget Users

•Program Analysis Users

Page 16: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Query Tools & Access Methods

• ICSTORe- Tack & Order

• ICSTORe Book Definition

• ICSTORe Advanced Query

• QuickView

• CRISP Plus

• IQR

• CRISP on the Web

• QVR

• ECB

• Ad Hoc Query

• Commons Status

• IRDB TechView

• IMPP TechView

• Business Area Specific Screens

Page 17: Plan for Architectural Analysis for Identifying Query & Retrieval Components

– QuickView & Status Users

– Scientific Query Users

• Regular

• Power

– Advanced Query Users

– Business Area Specific Users

– Document Tracking Users

– Program/IC Portfolio Users

– Peer Review Users

– Finance & Budget Users

– Program Analysis Users

– ICSTORe- Tack & Order,

– ICSTORe Book Definition

– ICSTORe Advanced Query

– QuickView

– CRISP Plus

– IQR

– CRISP on the Web

– QVR

– ECB

– Ad Hoc Reporting

– Commons Status Reporting

– IRDB TechView

– IMPP TechView

– Business Area Query Screens

Categories of Users Query Tools & Methods

Page 18: Plan for Architectural Analysis for Identifying Query & Retrieval Components

– QuickView & Status Users

– Scientific Query Users

– Advanced Query Users

– Business Area Specific Users

– Document Tracking Users

– Program/IC Portfolio Users

– Peer Review Users

– Finance & Budget Users

– Program Analysis Users

– ICSTORe- Tack & Order,

– ICSTORe Book Definition

– ICSTORe Advanced Query

– QuickView

– CRISP Plus

– IQR

– CRISP on the Web

– QVR

– ECB

– Ad Hoc Reporting

– Commons Status Reporting

– IRDB TechView

– IMPP TechView

– Business Area Query Screens

Categories of Users Query Tools & Methods

Page 19: Plan for Architectural Analysis for Identifying Query & Retrieval Components

– QuickView & Status Users

– Scientific Query Users

– Advanced Query Users

– Business Area Specific Users

– Document Tracking Users

– Program/IC Portfolio Users

– Peer Review Users

– Finance & Budget Users

– Program Analysis Users

– ICSTORe- Tack & Order,

– ICSTORe Book Definition

– ICSTORe Advanced Query

– QuickView

– CRISP Plus

– IQR

– CRISP on the Web

– QVR

– ECB

– Ad Hoc Reporting

– Commons Status Reporting

– IRDB TechView

– IMPP TechView

– Business Area Query Screens

Categories of Users Query Tools & Methods

Page 20: Plan for Architectural Analysis for Identifying Query & Retrieval Components

– QuickView & Status Users

– Scientific Query Users

– Advanced Query Users

– Business Area Specific Users

– Document Tracking Users

– Program/IC Portfolio Users

– Peer Review Users

– Finance & Budget Users

– Program Analysis Users

– ICSTORe- Tack & Order,

– ICSTORe Book Definition

– ICSTORe Advanced Query

– QuickView

– CRISP Plus

– IQR

– CRISP on the Web

– QVR

– ECB

– Ad Hoc Reporting

– Commons Status Reporting

– IRDB TechView

– IMPP TechView

– Business Area Query Screens [ICO]

Categories of Users Query Tools & Methods

Page 21: Plan for Architectural Analysis for Identifying Query & Retrieval Components

– QuickView & Status Users

– Scientific Query Users

– Advanced Query Users

– Business Area Specific Users

– Document Tracking Users

– Program/IC Portfolio Users

– Peer Review Users

– Finance & Budget Users

– Program Analysis Users

– ICSTORe- Tack & Order,

– ICSTORe Book Definition

– ICSTORe Advanced Query

– QuickView

– CRISP Plus

– IQR

– CRISP on the Web

– QVR

– ECB

– Ad Hoc Reporting

– Commons Status Reporting

– IRDB TechView

– IMPP TechView

– Business Area Query Screens

Categories of Users Query Tools & Methods

Page 22: Plan for Architectural Analysis for Identifying Query & Retrieval Components

– QuickView & Status Users

– Scientific Query Users

– Advanced Query Users

– Business Area Specific Users

– Document Tracking Users

– Program/IC Portfolio Users

– Peer Review Users

– Finance & Budget Users

– Program Analysis Users

– ICSTORe- Tack & Order,

– ICSTORe Book Definition

– ICSTORe Advanced Query

– QuickView

– CRISP Plus

– IQR

– CRISP on the Web

– QVR

– ECB

– Ad Hoc Reporting

– Commons Status Reporting

– IRDB TechView

– IMPP TechView

– Business Area Query Screens (ICO)

Categories of Users Query Tools & Methods

Page 23: Plan for Architectural Analysis for Identifying Query & Retrieval Components

– QuickView & Status Users

– Scientific Query Users

– Advanced Query Users

– Business Area Specific Users

– Document Tracking Users

– Program/IC Portfolio Users

– Peer Review Users

– Finance & Budget Users

– Program Analysis Users

– ICSTORe- Tack & Order,

– ICSTORe Book Definition

– ICSTORe Advanced Query

– QuickView

– CRISP Plus

– IQR

– CRISP on the Web

– QVR

– ECB

– Ad Hoc Reporting

– Commons Status Reporting

– IRDB TechView

– IMPP TechView

– Business Area Query Screens [REV]

Categories of Users Query Tools & Methods

Page 24: Plan for Architectural Analysis for Identifying Query & Retrieval Components

– QuickView & Status Users

– Scientific Query Users

– Advanced Query Users

– Business Area Specific Users

– Document Tracking Users

– Program/IC Portfolio Users

– Peer Review Users

– Finance & Budget Users

– Program Analysis Users

– ICSTORe- Tack & Order,

– ICSTORe Book Definition

– ICSTORe Advanced Query

– QuickView

– CRISP Plus

– IQR

– CRISP on the Web

– QVR

– ECB

– Ad Hoc Reporting

– Commons Status Reporting

– IRDB TechView

– IMPP TechView

– Business Area Query Screens [ICO]

Categories of Users Query Tools & Methods

Page 25: Plan for Architectural Analysis for Identifying Query & Retrieval Components

– QuickView & Status Users

– Scientific Query Users

– Advanced Query Users

– Business Area Specific Users

– Document Tracking Users

– Program/IC Portfolio Users

– Peer Review Users

– Finance & Budget Users

– Program Analysis Users

– ICSTORe- Tack & Order,

– ICSTORe Book Definition

– ICSTORe Advanced Query

– QuickView

– CRISP Plus

– IQR

– CRISP on the Web

– QVR

– ECB

– Ad Hoc Reporting

– Commons Status Reporting

– IRDB TechView

– IMPP TechView

– Business Area Query Screens [ICO]

Categories of Users Query Tools & Methods

Page 26: Plan for Architectural Analysis for Identifying Query & Retrieval Components

To retain the unique requirements of each

interface/access method while eliminating

unnecessary duplication

The Challenge:

Page 27: Plan for Architectural Analysis for Identifying Query & Retrieval Components

4 Main Tasks

Plan for Analysis:

Page 28: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Task 1: For each eRA Query tool and access methods listed, complete

a fact sheet that describes the following: Target community

Primary objectives Unique or special features Other similar or overlapping tools Early recommendations on how to improve Components used for the following:

– Online viewing– Output methods– Output format options– Query parameter objects– Query fields– Hitlist options

Sample for ICSTORe included

Page 29: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Based on data collectedin Task 1, develop a matrix that lists every component available and show which

tools/access methods use which component.

Task 2:

Page 30: Plan for Architectural Analysis for Identifying Query & Retrieval Components

QV Adv.Q QVR

Sample Task 2 MatrixComponent to Query Tool

Custom HLcustomhitlist

CustomQuery

Dual PO

saveQuery

ICO

Page 31: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Develop a matrix of query fields showing all query fields

availablein eRA query & retrieval tools,

and show which tools use which query fields.

This will help identify duplicative user interfaces

and tools

Task 3:

Page 32: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Sample Task 3 MatrixQuery Field to Query Tool

IC PI PO PCC

ICO

QV CRISP

Adv.Q

QVR

Page 33: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Task 4: Recommend: Requirements for eRA Query & Retrieval Components needed for new environment Duplicate and unnecessary objects to

eliminate User Interfaces needed to satisfy unique

requirements for different categories of users User Interfaces that can be merged to minimize duplication User Interfaces that should be eliminated

Page 34: Plan for Architectural Analysis for Identifying Query & Retrieval Components

What this analysis doesn’t do:

Doesn’t recommend design of needed components or objects – It recommends only WHAT, not HOW!

Caution: Analyses is limited to what already exists in

eRA Must add to this new ideas!

Page 35: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Mapping of needed components to

needed user interfaces

Task 5:

Page 36: Plan for Architectural Analysis for Identifying Query & Retrieval Components

RAE ToolAnalysis

User Requirements

ComponentAnalysis

OnlineViewing

OutputMethods

OutputFormats

Query Obj./

Fields

HitlistFeatures

Current Component & Query field / Tool Mapping

UniqueUser Reqs.

NeededComponents

NeededUIs

DuplicativeUIs

DuplicativeComponents

Proposed UI/Component

Mapping

Task 1

Tasks 2 & 3

Task 4

Task 5

Page 37: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Sample Task 1 Fact Sheet for ICSTORe Track & Order Screen

Target user community:–DEA office that tracks and files Summary Statements within a Council Round for IC

–IC office that prepares Council Books

–Program Directors that track and file Summary Statements within a Council Round for portfolio

Page 38: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Sample Task 1 Fact Sheet for ICSTORe Track & Order Screen,

cont. Primary objectives:

– Query: • Quick & easy way for tracking Summary Statements

and other documents released within a Council Round for the user’s primary & duals applications

– Hitlist:• Provides default hitlist for Track & Order users• Provides customizable hitlist for more advanced

users

– Output format selection:• Provides ‘Central Print’ at CIT for bulk printing• Provides Merge and Zip PDF files for local printing• Provides ability to export customized hitlist to Excel

Page 39: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Sample Task 1 Fact Sheet for ICSTORe Track & Order Screen,

cont. Unique Features:

•Query on POs & PCCs for user’s primary & dual applications

•Queries by User IC’s council date which may be different from primary IC’s council date

•Tracking to easily identify docs released since last check

•Selection of desired document from drop-down list (Sum.Stmnt.,Resume, Abstract)

•Customizable Hitlist

•‘Central Print’ at CIT for bulk printing

•Merge and Zip PDF files for local printing

•Export customized hitlist to Excel

•Save and share named queries

Page 40: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Sample Task 1 Fact Sheet for ICSTORe Track & Order Screen,

cont. Other similar tool(s):

– QVR for output format options– ICO for query by dual PO, PCC, and Council

Date

Early Recommendations:– Separate the query, hit list, and output

format selection– Separate selection of desired document

from query– Separate ordering from tracking– Provide ability to save customized hit list

with a named query

Page 41: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Sample Task 1 Fact Sheet for ICSTORe Track & Order Screen,

cont. Components used:

– Online viewing:• GUM• Grant Folder

– Output methods:• View doc• Merge/Zip doc• Export hitlist to Excel• Grant Folder

– Output format options:• Documents• No reports

Page 42: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Sample Task 1 Fact Sheet for ICSTORe Track & Order Screen,

cont. Components used, cont.:

– Query Parameter Objects• Query parameters TBD• Pull down lists• Special selects (incl. Duals)• Save/retrieve query• Share queries (private vs. IC-specific)• Query on POs and PCCs for user’s for

primary & dual applications• Queries by User’s IC’s council date which

may be different from primary IC’s council date

• Tracking option to easily identify docs released since last check

Page 43: Plan for Architectural Analysis for Identifying Query & Retrieval Components

Sample Task 1 Fact Sheet for ICSTORe Track & Order Screen,

cont. Components used, cont.:

– Hitlist:• Default hitlist for tracking Summary Statements• Select desired document (Sum.Stmnt., Abstract,

Resume)• Customizable hitlist • Sorting by column header buttons• Select checkbox w/Select all/deselect all• Order number• Resequence by Order number• Book Definition

– Divide hitlist in 2 sections with different sorts– Nested sorting– Ascending/Descending sorting by column– Sort ‘by value’– Save Book Definition