Cara Importer

Introduction

The Cara Importer is one of the target adapters available in migration-center starting with version 3.16. It takes the object processed in migration-center and imports them into Cara platform.

Importer is the term used for an output adapter which is most likely used at the last step of the migration process. An Importer (such as the Cara Importer) takes care of importing the objects processed in migration-center into the target system (such as the Cara platform).

An importer works as a job that can be run at any time and can even be executed repeatedly. For every run a detailed history and log file are created.

An importer is defined by a unique name, a set of configuration parameters and an optional description. Cara Importer can be created, configured, started and monitored through migration-center Client, while the corresponding processes are executed in the background by migration-center Job Server.

Known issues & limitations

• Indexing is not set when importing documents with both "indexDocuments" and "asynchronousIndex" parameters checked (#59574)

• When binding relations by version label, no error is thrown when incorrect or missing version label mapping is provided(#60093)

• Importing a base document and one update (as result of delta scan) results in unpredictable behavior(#60118)

Prerequisite

The Cara Importer needs Java 11 to be run. Please make sure you have installed Java 11 and all the environment variables are set correctly.

The user which will do the import must have bulk import rights in Cara.

Cara Importer Properties

To create a new Cara Importer job click on the New Importer button and select "Cara" from the adapter type dropdown list. Once the adapter type has been selected, the parameters list will be populated with the Cara parameters.

The Properties window of an importer can be accessed by double-clicking an importer in the list or selecting the Properties button or entry from the toolbar or context menu.

Common Importer Parameters

Configuration parametrs	Values
Name	Enter a unique name for this importer Mandatory
Adapter type	Select the "Cara" adapter from the list of available adapters Mandatory
Location	Select the Job Server location where this job should be run. Job Servers are defined in the Jobserver window. If no Job Server was selected, migration-center will prompt the user to define a Job Server Location when saving the importer. Mandatory
Description	Enter a description for this importer (optional)

Cara Importer Parameters

Configuration paramters	Values
restServiceUrl*	The URL of the Cara REST API. Example: http://migration.cara.cloud:8090/api Mandatory
username*	Cara username. The user must have bulk import rights in Cara. Mandatory
password*	The user's password. Mandatory
proxyServer	The name or IP of the proxy server if there is any.
proxyPort	The port of the proxy server.
proxyUser	The username if required by the proxy server.
proxyPassword	The password if required by the proxy server.
uploadContentUsingRest	Indicates if the content will be uploaded to the FTP staging folder using the REST API.
importAuditAsCustomObjects	Indicates if the audit trails will be imported as audit trail objects or as custom objects.
language	The user's local language. If no value is provided the default value ("en") will be used. This parameter is to create a connection with Cara platform. Example: en
bulkSize*	The number of objects that will be imported in a single bulk operation. Mandatory
fileTransferProtocol	The protocol name for upload content files to Cara. If the content files were uploaded prior to the importer leave the parameter empty. Supported values are: SFTP
fileTransferHost	The hostname where the files are uploaded. If the fileTransferProtocol is empty, this parameter will be ignored.
fileTransferFolder	The path of the folder on the file transfer host where the content files are uploaded. This path must exist on the file transfer host and the user must have write access to the folder. If the fileTransferProtocol parameter is empty, this parameter will be ignored.
indexDocuments	Indicates if imported documents will be be indexed or not.
asynchronousIndex	Indicates if imported documents will be indexed asynchronous or synchronous.