Agnostic Guides
...
Solution Guide
DocMigrator

Configuration

5min

There are three levels of configuration for DocMigrator:

  1. SAP ArchiveLink Document Class to Mime-type Mappings - these entries are in the table TOADD and contain the file extension (document class) to mime-type mapping. This is required for all file types to be migrated regardless of their source.
  2. DocMigrator - source repository id setup and mapping, doctype mapping, and source metadata mapping.
  3. DocManager Rule - all configuration needed to store content from SAP to your target repository such as location, metadata, etc. All business objects and content must be configured in DocManager.
  4. If you are using flat files as input, create a logical filename "ZDOCUFLOW_MIGRATOR_SOURCE_FILES"
  5. If you are export file copies, create a logical filename "ZDOCUFLOW_MIGRATOR_EXPORT_COPY_FILES"

SAP ArchiveLink Document Class to Mime-Type Mappings

SAP comes with pre-populated mappings. If a combination is missing in your TOADD table, you can add new entries via the menu path:

SPRO->SAP Reference IMG->SAP Net weaver->Application Server-> Basic Services->Archive Links->Basic Customizing-> Edit Document Classes

DocMigrator

Locate the DocMigrator config under the Gimmal Link System Dashboard (txn /dflow/sys) and the menu path Configure->DocMigrator

  • Source Connectivity
    • Not required for SAP database attachements or notes
    • Choose between a Gimmal Link Enterprise endpoint, a non-Gimmal Link ArchiveLink content server, the SAP database, or File input for each repository ID that will be used in the Load Table
    • Provided CMS Use Tag. For non-Gimmal Link Enterprise endpoints, this is for description purposes only. For Gimmal Link Enterprise endpoints, this will be used along with standard Gimmal Link configuration to determine the RFC destination to perform the READ from.
  • Repository Mapping
    • Not required for SAP database attachments or notes
      • This is required in all cases except where you are reading from the same source Gimmal Link repository as the target, or if you have/will populate the Load table from an ABAP class/method or file method (as those determine the target repository ID).
      • It is strongly recommended not to sharing repository IDs for different repository type.
  • DocType Mapping
    • Not required for SAP database attachments or notes
    • Mapping of document types is optional in all cases.
    • Typically only recommended if SAP security is to be different between source and target content, or if you want to merge document types.
    • Remember that new document types typically requires updated SAP Security roles/profiles.
    • Wildcards (*) can be used in the Source Object Type and Source Document Type columns and take second precedence over an exact matching entry.
  • Original MD Map
    • Not required for SAP database attachments or notes
    • If metadata is supported from the source content, mapping of original/source metadata names to new target metadata field/property names can be done.
    • If only new metadata from SAP is being sent to the target system as part of the migration, this mapping is not required.
    • Wildcards (*) can be used in the Source Object Type and Source Document Type columns and take second precedence over an exact matching entry.
  • SAP DB as Source Map
    • Required only for SAP database attachments or notes
    • For all SAP database attachments or notes you must specify a target repository ID and doctype per SAP Object.
    • A wildcard (*) can be used in the Source Object Type column and take second precedence over an exact matching entry.

DocManager Rule

Locate the DocManager config under the Gimmal Link Enterprise System Dashboard (txn /dflow/sys) and the menu path Configure->API Rules->Document Manager.

Since DocMigrator utilizes DocManager for all content to be migrated to determine location, metadata, etc, a DocManager rule must exist for every business object and doctype combination to be migrated.

For detail on this configuration, refer to the DocManager section of the Gimmal Link Enterprise Solution Guide.

Logical Filename: Source Files

Create the logical filename "ZGIMMALLINK_MIGRATOR_SOURCE_FILES" via transaction FILE. Assign to a logical path of the same name and configure that logical path to the directory to save the log files. The physical path must have the filename placeholder as <FILENAME>. Example below:

Document image

Document image


Logical Filename: Export Copy

Create the logical filename "ZGIMMAL_MIGRATOR_EXPORT_COPY_FILES" via transaction FILE. Assign to a logical path of the same name and configure that logical path to the directory to save the log files. The physical path must have the filename placeholder as . Use the examples above as guidance if necessary.