[ 
https://issues.apache.org/jira/browse/NIFI-1795?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16778701#comment-16778701
 ] 

Ryan Withers commented on NIFI-1795:
------------------------------------

Okay I've made the changes and committed them to a local branch.  I need to 
follow the directions for getting a PR created.  I ran into something that 
distracted me from getting this completed in a timely fashion.  Brief 
description below: 

It seems like TestListFile has had a couple different issues filed against it.  
It fails for me every time.  Anyway I haven't spent enough dedicated time with 
it.  NIFI-3831 mentions the issue in almost the same way I'm experiencing the 
failure. 
 https://issues.apache.org/jira/browse/NIFI-3831.  The method I'm failing on is 
filterAge.  

Anyway I wanted to provide an update.  Will bring it back to what this 
particular ticket is focused on.  

> Improve documentation regarding PropertyDescriptor name & displayName
> ---------------------------------------------------------------------
>
>                 Key: NIFI-1795
>                 URL: https://issues.apache.org/jira/browse/NIFI-1795
>             Project: Apache NiFi
>          Issue Type: Improvement
>          Components: Documentation & Website
>    Affects Versions: 0.6.1
>            Reporter: Andy LoPresto
>            Assignee: Ryan Withers
>            Priority: Minor
>
> As evidenced in numerous pull requests, developers are often unaware of the 
> behavior of {{PropertyDescriptor}} {{name}} and {{displayName}} attributes. 
> Originally, {{name}} existed and served as both the UI display value for the 
> processor properties configuration dialog and as the unique identifier when 
> writing/reading the properties from file storage. However, a change to the 
> {{name}} value after the flow had been persisted could cause issues 
> retrieving the value from file storage. Thus, {{displayName}} was introduced 
> as the UI display value to allow for backward-compatible updates. The 
> documentation does not sufficiently explain this information and can better 
> encourage developers to provide both {{name}} and {{displayName}} attributes 
> in order to be proactive on flow compatibility and to improve the foundation 
> for internationalization and localization of the UI. 



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Reply via email to