Target releaseRelease name or number
EpicLink to related JIRA epic or feature
Document status
Document owner 
DesignerLead designer
DevelopersLead developer
QALead tester

Goals

Background and strategic fit

The NiFi graph is an excellent visualization of how data is flowing through the system.  However, as the data flow becomes more complex, tracing a specific path through the flow becomes more difficult.  We do have the ability to show upstream and downstream connections, however that still leaves tracking an individual path as a manual process.  Using the already available upstream / downstream connection information, it may be possible to improve the visualization of a specific "flow".  This could take the form of highlighting components related to a selected component, or possibly even hiding unrelated components.  Obviously this would need to be made clear in the UI, but doing so could limit the visualization of the graph to only elements a user was interested in at the time.  This could possibly also improve performance of the graph, by avoiding rendering components the user doesn't want to see.  A naive initial implementation proposal would be to use the upstream / downstream connection information to build a list of "flow elements", and then simply render only items on the list when in "show flow" mode...

Assumptions

Requirements

#TitleUser StoryImportanceNotes
1Short identifier for the storyDescribe the user and what they are trying to achieveMust Have
  • Additional considerations or noteworthy references (links, issues)
2    

User interaction and design

Include any mockups, diagrams or visual designs relating to these requirements.

Questions

Below is a list of questions to be addressed as a result of this requirements document:

QuestionOutcome
(e.g. How we make users more aware of this feature?)Communicate the decision reached

Not Doing