Built-in Import Station Plugins

NameDescription
DownloadProcessor

Look in an OpenKM folder and download every file to the import-station machine. They will also be moved to a processed folder in OpenKM.

Downloaded files will have the following format: <file_uuid>.<extension>  

Example: A file named document.pdf with UUID 1111-2222-3333-4444 will be renamed to 1111-2222-3333-4444.pdf on your local machine.

Parameters:

  • OpenKM origin path.
  • OpenKM processed path.
  • Local machine path.

FolderProcessor

Iterate through a disk folder, recursively processing every file (depending on an extension filter).

Parameters:

  • Local disk path.
  • Remote OpenKM destination path.
  • Data file extension.
  • Delete when finished.
  • Enable backup.

The enable backup option will copy every file from this execution to a folder. This folder will be in the following path:

<execution_path>/backup/<task_name>/<date_of_execution>-<execution_id>

Example:  /home/user/backup/Processor task/2017-07-01-876

PropertiesProcessorCsvSingle

Iterate through a disk folder, recursively processing CSV files.

For each CSV file, the processor uploads into OpenKM a document that has the same CSV file name but a different extension.

For each uploaded document, metadata values from the CSV file are set.

Parameters:

  • Local disk path.
  • Remote OpenKM destination path.
  • Data file extension.
  • Delete when finished.
  • Enable backup.
  • Delimiter character.
  • Quote character.
  • Comment character.
  • Skip headers.
  • CSV columns to OpenKM metadata fields mapping.

You can use the - character to skip a column (if needed).

The enable backup option will copy every file from this execution to a folder. This folder will be in the following path:

<execution_path>/backup/<task_name>/<date_of_execution>-<execution_id>

Example:  /home/user/backup/Processor task/2017-07-01-876

PropertiesProcessorCsvMultiple

Iterate through a disk folder, recursively processing CSV files.

Each document referenced in the CSV file that has a column with the document name is uploaded into OpenKM.

For each uploaded document, metadata values from the CSV file are set.

Parameters:

  • Local disk path.
  • Remote OpenKM destination path.
  • Data file extension.
  • Delete when finished.
  • Enable backup.
  • Delimiter character.
  • Quote character.
  • Comment character.
  • Skip headers.
  • CSV columns to OpenKM metadata fields mapping.

You can use the - character to skip a column (if needed).

The file name will be read from the property named 'FILE_NAME'.

The enable backup option will copy every file from this execution to a folder. This folder will be in the following path:

<execution_path>/backup/<task_name>/<date_of_execution>-<execution_id>

Example:  /home/user/backup/Processor task/2017-07-01-876

SetMetadataProcessor

Iterate through a disk folder, recursively processing CSV files. 

Each document referenced in the CSV file that has a column with the document name and another with the document UUID is modified in OpenKM

to set metadata values from the CSV file.

Parameters:

  • Local disk path.
  • Remote OpenKM destination path.
  • Data file extension.
  • Delete when finished.
  • Enable backup.
  • Delimiter character.
  • Quote character.
  • Comment character.
  • Skip headers.
  • CSV Columns to OpenKM metadata fields mapping.

You can use the - character to skip a column (if needed).

The file name will be read from the property named 'FILE_NAME'.

The file UUID will be read from the property named 'UUID'.

The enable backup option will copy every file from this execution to a folder. This folder will be in the following path:

<execution_path>/backup/<task_name>/<date_of_execution>-<execution_id>

Example:  /home/user/backup/Processor task/2017-07-01-876

 

Table of contents [ Hide Show ]