nuxeo-node-custom-importer

This is a fork of nuxeo-node-importer to show how to customize it to import a custom hierarchy.

This importer creates documents on the Nuxeo Platform instance according to the filenames of the hierarchy.

Full filename format is:

Type_source_lifecycestate_dc:valid_dc:creator_filename.doc

The importer can also handle simpler filename format:

Type_filename.doc

or only:

filename.doc

If you want to ignore some parts, juste remove it, keeping all the _, such as:

Type__lifecyclestate_dc:valid_dc:creator_filename.doc

With this one, the dc:source will be kept empty.

Type____dc:creator_filename.doc

With this one, only the dc:creator property will be field.

Here are some rules the importer will follow:

• If the Type is Note, instead of uploading the file, the property note:note will be filled with the file content.
• if no Type are specified for a directory, it defaults to Folder.
• if no Type are specified for a file, it defaults to File.

Installation

$ npm install -g nuxeo-sandbox/nuxeo-node-custom-importer

This module is not yet published on npm.

Usage

$ nuxeo-custom-importer [options] local-path remote-path

Recursively import the files and directories of local-path to the remote-path on a Nuxeo Platform instance.

Options are:

• -b, --baseURL: the base URL of the Nuxeo Platform instance
• -u, --username: the username to use to connect to the server
• -p, --password: the password to use to connect to the server
• -m, --maxConcurrentRequests: Maximum number of concurrent requests. Default to 5.
• -t, --timeout: Timeout in ms. Default to 30000.
• -v, --verbose: verbose output

Sample

A sample directory / file structure can be found in the sample_files folder.

To import it in a Nuxeo Platform instance running on localhost (in an existing ws Workspace):

$ nuxeo-custom-importer sample_files /default-domain/workspaces/ws

Extend the importer

The main work is done in the async.waterfall call, that takes an array of functions (funcs), such as setACE and followTransition, to execute in the given order for each file to process. Each function, when done, passes arguments to the next one.

See https://github.com/caolan/async#waterfall to understand how it works and what will be passed to the next function (basically, calling callback(...) will tell to async to call the next function).

If you want to implement custom behaviour when importing documents, you need to add such functions and add them to the funcs array.