eRoom Scanner

Introduction

The eRoom Adapter consists of one module: the eRoom Scanner, which scans and exports objects from an eRoom site and inputs them into migration-center.

The eRoom scanner supports eRoom 7 or higher. It uses the eRoom XML Query Language (EXQL) to access eRoom data and methods through Simple Object Access Protocol (SOAP) requests, which is only available starting with eRoom 7.

Scanner is the term used in migration-center for an input adapter. Using the eRoom Scanner Module to read the data that needs processing into migration-center is the first step in a migration project, thus scan also refers to the process used to input data to migration-center.

The scanner module 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.

A Scanner is defined by a unique name, a set of configuration parameters and an optional description.

eRoom Scanners can be created, configured, started and monitored through migration-center Client, but the corresponding processes are executed by migration-center Job Server.

Exporting objects from eRoom using the eRoom Scanner

The eRoom scanner is designed to scan and export objects from eRoom. Currently the eRoom scanner support scanning items of type file (including versions); folder and room information is also appended to the files, thus making it possible to restore an existing hierarchy later.

The eRoom scanner can be targeted at a facility and/ or a room. From there it will start scanning for objects recursively, meaning that in case of a facility it will scan all rooms and from each room it will scan all objects contained in a certain room (folders or files).

The eRoom scanner adheres to migration-center standard behavior, meaning it runs as a job configured by the user via parameters, and saves all extracted objects/items’ content on disk and the corresponding metadata to the migration-center database in the process. After a scan has completed, the newly scanned objects are available for further processing in migration-center.

Known issues

The eRoom scanner does not work with OpenJDK 8, it only works with the Oracle version of Java SE 8.

eRoom Scanner Properties

To create a new eRoom Scanner job, specify the respective adapter type in the Scanner Properties window – from the list of available adapters, “eRoom” must be selected. Once the adapter type has been selected, the Parameters list will be populated with the parameters specific to the selected adapter type, in this case the eRoom adapter.

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

Common scanner parameters

Configuration parameters	Values
Name	Enter a unique name for this scanner Mandatory
Adapter type	Select the “eRoom” 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 migration-center will prompt the user to define a Job Server Location when saving the Importer. Mandatory
Description	Enter a description for this job (optional)

eRoom scanner parameters

Configuration parameters	Values
eRoomSite*	URL of the eroom site. Mandatory
relativePaths*	List of relative paths of the rooms and/or facilities which will be scanned. The list can be provided either inline, with each relative path being separated by comma (,), or in a file, with the full path of the file being indicated by At (@) in the parameter value and each line in the file containing a relative path. e.g: @C:\pathToFile\file facility1/room1 facility2 Mandatory
eRoomWebservice*	URL of the eRoom web service (SOAP) to connect to. The eRoom site holds a representation of its entire content in a virtual XML document. Data from this document can be accessed through SOAP requests. Mandatory
username*	User name for connecting to eRoom site. Mandatory
password*	The user’s password. Mandatory
exportVersions	If it’s enabled all versions of the documents will be exported, otherwise only the latest version will be scanned.
skipContent	Setting this parameter to true will skip extracting the actual content during scan, meaning only the metadata will be scanned. Used mostly for testing purposes.
exportLocation*	Folder path. The location where the exported object content should be temporary saved. It can be a local folder on the same machine with the Job Server or a shared folder on the network. This folder must exist prior to launching the scanner and must have write permissions. migration-center will not create this folder automatically. If the folder cannot be found an appropriate error will be raised and logged. This path must be accessible by both scanner and importer so if they are running on different machines, it should be a shared network folder. Mandatory
loggingLevel*	Sets the verbosity of the log file. Possible values: 1 - logs only errors during scan 2 - is the default value reporting all warnings and errors 3 - logs all successfully performed operations in addition to any warnings or errors 4 - logs all events (for debugging only, use only if instructed by fme product support since it generates a very large amount of output. Do not use in production) Mandatory

Log files

A complete history is available for any eRoom Scanner job from the respective items’ History window. It is accessible through the History button/menu entry on the toolbar/context menu. The History window displays a list of all runs for the selected job together with additional information, such as the number of processed objects, the start and ending time and the status.

Double clicking an entry or clicking the Open button on the toolbar opens the log file created by that run. The log file contains more information about the run of the selected job:

• Version information of the migration-center Server Components the job was run with

• The parameters the job was run with

• Execution Summary that contains the total number of objects processed, the number of documents and folders scanned or imported, the count of warnings and errors that occurred during runtime.

Log files generated by the eRoom Adapter can be found in the Server Components installation folder of the machine where the job was run, e.g. …\fme AG\migration-center Server Components <Version>logs

The amount of information written to the log files depends on the setting specified in the ‘loggingLevel’ start parameter for the respective job.