Uploaded image for project: 'Nuxeo Platform'
  1. Nuxeo Platform
  2. NXP-23165

Add a new system property: Retention flag

    XMLWordPrintable

    Details

    • Type: New Feature
    • Status: Resolved
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 9.3
    • Component/s: Core
    • Release Notes Description:
      Hide

      A new method has been added to the CoreSession so as to set a flag "ecm:isRetentionActive" on a document in order to specify it is in retention:
      session.setRetentionActive(doc.getRef(), true);
      An event "retentionActiveChanged" is sent and an entry is logged in the audit trail when the method is called.

      When a document is in retention, it can't be deleted using the delete API. The retention flag needs to be set to false prior to deletion. This can only be done by users with WriteSecurity permission.

      Show
      A new method has been added to the CoreSession so as to set a flag "ecm:isRetentionActive" on a document in order to specify it is in retention: session.setRetentionActive(doc.getRef(), true); An event "retentionActiveChanged" is sent and an entry is logged in the audit trail when the method is called. When a document is in retention, it can't be deleted using the delete API. The retention flag needs to be set to false prior to deletion. This can only be done by users with WriteSecurity permission.
    • Tags:
    • Sprint:
      nxcore 9.3.7
    • Story Points:
      5

      Description

      A new system boolean property "retentionActive" is added.
      Delete method behavior of the core API is modified so that when deleting a given document, if among the list of all documents that will be deleted (because of herachical nature of the repository) one of them has the property retentionActive set to true, an exception InRetentionDocumentException is thrown, with list of concerned IDs.
      This property can be set with a dedicated CoreSession or DocumentModel method (setRetentionActive (boolean)) if user session has write permisson on the document.
      This minimal scope doesn't cover:

      • import / export (anyway, the future retention management plugin adds facets that allows to get back that property value)
      • marshaller json (although this one would be nice , to get a readonly information when having a document ressouce via rest api)
      • NXQL
      • Indexation Elastiscsearch

        Attachments

          Issue Links

          is related to

          Bug - A problem which impairs or prevents the functions of the product. NXP-22312 CoreSession.canRemoveDocument may incorrectly return true

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Open

          Bug - A problem which impairs or prevents the functions of the product. NXP-22960 Folder deleted even though subfolder is locked

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

          Task - A task that needs to be done. NXDOC-1464 Add documentation for the retention flag

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Open

            Activity

              People

              • Votes:
                1 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Time Tracking

                  Estimated:
                  Original Estimate - 0 minutes
                  0m
                  Remaining:
                  Remaining Estimate - 0 minutes
                  0m
                  Logged:
                  Time Spent - 1 day, 3 hours
                  1d 3h