Nuxeo Studio Community Cookbook

This repository aims at helping the Nuxeo Community to enrich Nuxeo Studio projects. It provides a list of features and visual elements ready to be copy-pasted. The modules are for LTS 2019 and LTS 2021:

• They can be unrelated to the UI (to provide new backend features, such as utilities to handle multimedia files, specific conversions, email templates etc.).
• They can provide UI elements for Nuxeo Web UI, or any frontend application.

Module listing

• Latest Modules
• Tips and Tricks
• Layouts
• DAM
• AI
• Security / Authentication / User and Group Management
• Reporting
• Business Logics
• Templates
• Integrations

ℹ️ Click on the module thumbnail to view the module contributions.

Latest Modules

Module	Description	Author	Category
	Nuxeo Enhanced Viewer with Custom Field	Nuxeo	Layout
	Replace Renditions	Nuxeo	Layout
	Search for Documents via their Parent Containers	Nuxeo	Layout
	Select All Documents and Send to Bulk Action from Search	Nuxeo	Layout
	Nuxeo Enhanced Viewer Document Preview	Genus	Layout

Tips and Tricks

Module	Description	Author
	Tips and tricks to implement backend logics with Studio Modeler	Nuxeo
	Tips and tricks to design elements within Studio Designer	Nuxeo
	Automation Script Utilities	Nuxeo

Layouts

Module	Description	Contributor
	Nuxeo Enhanced Viewer with Custom Field	Nuxeo
	Replace Renditions	Nuxeo
	Select All Documents and Send to Bulk Action from Search	Nuxeo
	Nuxeo Enhanced Viewer Document Preview	Genus
	Document Load and Preview	Nuxeo
	Interactive PDF Search	Nuxeo
	Custom Preview and Thumbnail	Nuxeo
	Similar Color Search	Nuxeo
	Copy or move documents without the clipboard	Nuxeo
	Date Time Picker	Nuxeo
	Geodistance Search + Google Map	Nuxeo
	Display a field with Currency format	Nuxeo
	Create a QR Code	Nuxeo
	Cascading Fields in Document Layouts	Nuxeo
	Highlight in Custom Searches	Nuxeo
	Display EML Preview	Nuxeo
	Add a progress bar	Nuxeo
	Inject HTML into a page using bound data	Nuxeo
	Custom Nuxeo Suggestion Display	Nuxeo
	Collapsible Element	Nuxeo
	Inline card property Editing	Nuxeo
	Display Salesforce metadata	Nuxeo
	Show/hide the value of a secret field	Nuxeo
	Display Document Relations	Nuxeo
	Display text using barcode font	Nuxeo
	Geodistance Search + Google Map	Nuxeo
	Preview related documents	Nuxeo
	Replace Picture and Video Renditions	Nuxeo

DAM

Module	Description	Contributor
	Similar Color Search	Nuxeo
	Sets the video poster and search thumbnail	Nuxeo
	Additional video conversions	Nuxeo

AI

Module	Description	Contributor
	Similar Color Search	Nuxeo
	Extract text from an image-based PDF with Google Vision	Nuxeo
	Display sensitive data details contained in a document	Nuxeo

Security / Authentication / User and Group Management

Module	Description	Contributor
	Local Group Administrators	Nuxeo
	Bulk Workflow Reassignment	Nuxeo
	Map SAML user attributes to Nuxeo	Nuxeo
	Display sensitive data details contained in a document	Nuxeo
	Show/hide the value of a secret field	Nuxeo

Reporting

Module	Description	Contributor
	Monitor workflow instances status	Nuxeo
	Display Kibana dashboards in the "Analytics" menu	Nuxeo
	Generic Web UI Analytic Dashboards	Nuxeo

Business Logics

Module	Description	Contributor
	Nuxeo Operation Button with Navigation	Nuxeo
	Comment Indexing (:warning: only LTS2019)	Nuxeo
	Send emails from Nuxeo Web UI	Nuxeo
	Delete and Update Document Lifecycle state of versioned documents	Nuxeo
	Convert date to timestamp	Nuxeo
	Display Document Relations	Nuxeo
	Permanently delete all trashed documents	Nuxeo
	Automation Script Utilities	Nuxeo

Templates

Module	Description	Contributor
	Send emails from Nuxeo Web UI	Nuxeo
	Email templates	Nuxeo
	Document templates	Nuxeo

Integrations

Module	Description	Contributor
	Display Salesforce metadata	Nuxeo

Getting Started

There is nothing to build. Each module generally contains:

• XML extension, page providers, automation chain or automation scripting into Nuxeo Studio Modeler.
• Layouts, contributions within the Nuxeo bundle file, HTML resources, medias that should be created in Nuxeo Studio Designer.

You can clone the repository locally:

git clone https://github.com/nuxeo/nuxeo-studio-community-cookbook.git

Prerequisites

A Nuxeo Studio Account as well as an active Nuxeo Studio Project is needed. You can create an account from our registration page and benefit from a free 30-day trial to get access to:

• Nuxeo Studio, the web-based configuration and customization environment
• Nuxeo Marketplace, the application store with ready-to-install plugins and packages

Repository Structuration

Each new module should be created in a specific folder:

• /modules/nuxeo: Contributions from the Nuxeo Team, for demos, PoC or tests.
• /modules/partners: Contributions from the Nuxeo Partner Ecosystem.
• /modules/community: Contributions from the Nuxeo Community.

Contributing

You have to follow the repository contribution guidelines when submitting a new addon:

• If you're a partner, create your partner folder under /modules/partners/ if it doesn't exist already. Then, create the readme file to present your company and your contributions. We provide a README-PARTNER.MD template.
• Create a README file to present your module, using the README-MODULE.MD template.
• Create a /modeler and /designer folders to upload respectively resources from Nuxeo Studio Modeler and Nuxeo Studio Designer.
• Upload your resources.
• Push your changes
  • If you're from Nuxeo, reference your addon in this page.
  • If not, you won't be allowed to push directly to master. Your pull request will be then checked by the Nuxeo Team before being published.
• Et voilà! 😉

Nuxeo Labs

You can access complete Nuxeo Marketplace addons on Nuxeo Marketplace - Nuxeo Labs category (done for PoC and test purposes)

Learn

• Nuxeo Documentation
• Nuxeo University

Support

These features are not part of the Nuxeo Production platform.

These solutions are provided for inspiration and we encourage customers to use them as code samples and learning resources.

This is a moving project (no API maintenance, no deprecation process, etc.) If any of these solutions are found to be useful for the Nuxeo Platform in general, they will be integrated directly into platform, not maintained here.

License

Apache License, Version 2.0

About Nuxeo

Nuxeo Platform is an open source Content Services platform, written in Java. Data can be stored in both SQL & NoSQL databases.

The development of the Nuxeo Platform is mostly done by Nuxeo employees with an open development model.

The source code, documentation, roadmap, issue tracker, testing, benchmarks are all public.

Typically, Nuxeo users build different types of information management solutions for document management, case management, and digital asset management, use cases. It uses schema-flexible metadata & content models that allows content to be repurposed to fulfill future use cases.

More information is available at www.nuxeo.com.