You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by "Andy LoPresto (JIRA)" <ji...@apache.org> on 2016/07/26 04:44:20 UTC
[jira] [Commented] (NIFI-1795) Improve documentation regarding
PropertyDescriptor name & displayName
[ https://issues.apache.org/jira/browse/NIFI-1795?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15393212#comment-15393212 ]
Andy LoPresto commented on NIFI-1795:
-------------------------------------
Removed from 1.0 as I am working on [NIFI-1831] and [NIFI-1465].
> 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: Andy LoPresto
> 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
(v6.3.4#6332)