Documentation

# Worldox migration connector

Migrates documents from Worldox (opens new window) document management system to SharePoint using CSV export files.

DLL: Epona.Migrate.Worldox.dll

# What it does

  • CSV-based import — reads documents from Worldox CSV export files
  • Document retrieval — transfers document files from Worldox storage
  • Metadata extraction — parses CSV fields into document metadata
  • Batch upload — transfers documents to SharePoint with metadata preservation
  • Folder organization — organizes documents based on metadata fields
  • Matter mapping — maps Worldox client/matter codes to SharePoint structure
  • User mapping — translates Worldox user accounts to SharePoint logins
  • Comment versioning — preserves Worldox document comments as version history

# Prerequisites

  • Worldox CSV export file containing document metadata
  • Access to Worldox document storage location or extracted files
  • Target SharePoint site collection provisioned with document libraries
  • Mapping configuration for CSV field positions (1-7)

# Deployment

  1. Copy Epona.Migrate.Worldox.dll to the Epona.Migrate application directory
  2. Restart Epona.Migrate or reload connectors
  3. Configure Worldox migration settings in the migration UI
  4. Prepare Worldox CSV export file

# Configuration

# Global settings

# Name

  • Type: string
  • Default: —
  • Description: Unique name for this migration configuration

# Debug

  • Type: boolean
  • Default: false
  • Description: Enable debug logging

# CSV import settings

# CsvDelimiter

  • Type: string
  • Default: ,
  • Description: CSV field delimiter character

# Code mapping

# MapFieldXToClientCode

  • Type: int
  • Default: 1
  • Description: CSV field number (1-7) containing client code

# MapFieldXToMatterCode

  • Type: int
  • Default: 2
  • Description: CSV field number (1-7) containing matter code

# CombineClientAndMatterCodeToTargetMatterCode

  • Type: string
  • Default: _
  • Description: Character to combine codes; use TRUE for no separator

# Folder organization

# PropertyToFolder

  • Type: enum
  • Description: CSV field determining folder placement: Field1 through Field7, Category, or FileExtension

# MapFolders

  • Type: string
  • Description: Maps field values to folder paths (format: value=/folder/path;)

# Metadata field mapping

# MapFieldToCreatedBy

  • Type: int
  • Description: CSV field number (1-7) for document created-by user

# MapFieldToModifiedBy

  • Type: int
  • Description: CSV field number (1-7) for document modified-by user

# MapCommentsToCheckinComments

  • Type: boolean
  • Description: Use Worldox comments as SharePoint version check-in comments

# SharePoint column mapping

# DocumentNumber

  • Type: string
  • Description: SharePoint column name for document number (without version)

# DocumentNumberVersion

  • Type: string
  • Description: SharePoint column name for document number with version

# Code translation

# MapClientCodes

  • Type: string
  • Description: Maps Worldox client codes to target client codes (format: oldcode=newcode;)

# MapClientMatterCodes

  • Type: string
  • Description: Maps Worldox client-matter combinations to target codes (format: oldcode=newcode;)

# MapUsernames

  • Type: string
  • Description: Maps Worldox usernames to SharePoint login names (format: worldoxuser=sharepointlogin;)

# Field value mapping

# FieldValueMapping

  • Type: FieldValues (list)
  • Description: Maps CSV field values to SharePoint column values

# Migration workflow

  1. Prepare — export documents and metadata from Worldox as CSV
  2. Configure — set up CSV field mappings and column assignments
  3. Validate — verify client/matter code configuration
  4. Plan — review folder organization and metadata mapping
  5. Execute — transfer documents with metadata to SharePoint
  6. Verify — validate completeness and metadata accuracy

# Worldox specific features

# CSV field positions

Worldox CSV exports organize document metadata in 7 fixed field positions. Configure which fields contain:

  • Client code or customer ID
  • Matter code or project ID
  • Other classification or metadata
  • File extension, category, owner
  • Comments, description, or other properties

# Folder organization

Documents can be organized in SharePoint based on any CSV field:

  • By client code — separate folder per client
  • By matter code — separate folder per matter
  • By category — separate folder per document category
  • By file type — separate folder per file extension
  • By value mapping — custom folder structure based on field mappings

# Code padding

For systems requiring fixed-width codes:

  • Client codes can be padded with leading zeros
  • Matter codes can be formatted with separators
  • Padding rules applied during code translation

# User account mapping

Worldox user names typically differ from SharePoint login names:

  • Map each Worldox user to corresponding SharePoint account
  • Applies to created-by and modified-by fields
  • Enables proper permission and auditing in SharePoint

# Comment preservation

Worldox document comments are preserved as check-in comments:

  • Each Worldox comment becomes a version history entry
  • Useful for preserving document notes and annotations
  • Can be disabled if not needed

# Troubleshooting

# Common issues

# CSV parsing errors

  • Cause: Incorrect delimiter or field format
  • Resolution: Verify CsvDelimiter matches your export and check field positions 1-7

# Client/matter not mapped

  • Cause: Code mapping incomplete
  • Resolution: Ensure MapFieldXToClientCode and MapFieldXToMatterCode are set correctly

# Folder organization incorrect

  • Cause: PropertyToFolder misconfigured
  • Resolution: Verify which CSV field should determine folder placement

# User not found

  • Cause: Username mapping missing or incorrect
  • Resolution: Add mapping entries for all Worldox users

# Metadata missing

  • Cause: Column names don't match
  • Resolution: Verify SharePoint column names match exactly in mapping
Last Updated: 4/20/2026, 12:54:05 PM