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

Setup Local for Compound Documents

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Resolved
    • Priority: Minor
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Aspera Connector
    • Sprint:
      Connectors Sprint 12 - August

      Description

      This ticket is being created to track the initial dev env setup for the compound documents addon.

      Follow the below steps to setup nuxeo compound documents in local:

      1. Setup the Nuxeo studio for compound documents following the hyland university course: https://university.hyland.com/courses/e5341
      2.  In the second step where we configure the automation scripting functions, make sure to add the parameter with the name: entries for GetCompoundDocumentType
      3. Also add needed layout views for the configured custom document type.
      4. Get the desired Nuxeo Tomcat distribution: eg: LTs-2021
      5. Register the instance, install all hot-fixes, install nuxeo-web-ui plugin
      6. Install compound documents add on either from marketplace or local built from source code.
      7. Clone git repo : https://github.com/nuxeo/nuxeo-compound-documents
      8. Switch to respective branch (2021 or 2023 - depending on target platform)
      9. Build the source code using below command:
        mvn clean install
      1. Remove if package exists already and use the addon zip generated in package project's target folder and install it in nuxeo install using command:
        nuxeoctl mp-remove nuxeo-compound-document --accept=true
        
        nuxeoctl mp-install <absolute path of package.zip> --accept=true
        
      1. Launch the nuxeo instance
      2. Make use of nuxeo hot reload to get the nuxeo studio project changes applied to the current instance - https://doc.nuxeo.com/nxdoc/nuxeo-dev-tools-extension/
      3. The university course followed in steps: 1,2,3 creates compound document functionality for Material projects, we need to import the Material project zip that contains a file with extension: .u3m.
      4. Launch the Nuxeo -> Go to workspace -> Add -> Import -> Drag and drop the zip file that is a material design project (that which contains the .u3m file.). Here is the sample file
      5. Observe that every file in the zip archive is created as a document.
      6. Any additional desired customizations can accordingly be configured as a part of nuxeo studio project.
      7. Typical dev flow post this setup should be:  Changes to Studio project -> Hot Reload -> Verify ,  Changes to Add on source code -> Step 9 ->   Step 10 -> Verify.

        Attachments

          Issue Links

            Activity

              People

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

                Dates

                • Created:
                  Updated:
                  Resolved: