Open Documentation Menu

How do I perform the host import in the cloud with d.velop cloud uploader?

Overview

This section will show you how to use and configure d.velop cloud uploader as a replacement for d.3 hostimp.

Prerequisites

  • A local Windows server (on the customer’s premises) to run the application.

  • An Internet connection (port 443) to the cloud tenant in order to upload documents to the cloud.

  • The API key of a user who is authorized to import the documents.

  • The system requirements of d.velop cloud uploader must be met.

Necessary components

Component

Version

d.velop cloud uploader

Latest version

This is how it works

d.velop cloud uploader serves as a counterpart to d.3 hostimp for the d.velop cloud. It enables you to monitor directories from which delivered file pairs (original file and metadata file, e.g. JPL or UPD) are imported into the d.velop documents tenant via the DMS API. Further information can be found in the administration manual of d.velop cloud uploader.

Installing d.velop cloud uploader

Please note the following when installing d.velop cloud uploader:

  • The application must be operated on an on-premises server of the customer.

  • The application requires access to the directories to be monitored (local, network drive, etc.).

  • Further information can be found in the documentation of d.velop cloud uploader.

Configuring d.velop cloud uploader

You can configure d.velop cloud uploader using the appsettings.json file. You will find the file in the installation directory. In the file, adjust the general configuration (base address, repository ID, API key, etc.).

Note

Particularly in test phases or if errors are occurring frequently, it may make sense to increase the interval at which the application attempts to upload errors again. In these cases, adjust the parameter ResetFailedUploadsInterval. Otherwise, the application will be repeatedly held up by the same errors and new documents will be delayed or not imported at all.

  1. Configure the SourceCategoryMappings parameter in the file. Use this parameter to define the categories or document types to be included. The following example will explain the structure. Values such as ADK are used for identification. This is followed by the ID of the category in the tenant.

    "GlobalMappings": {
    "SourceCategoryMappings": {
        "AAUF": "98689511-658d-4831-92b6-4683f46a1c30",
        "Auftragsakte": "98689511-658d-4831-92b6-4683f46a1c30",
        "ADK": "323797f3-3cc7-410e-8950-68df7805b5ff",
        "ADK-Daten": "323797f3-3cc7-410e-8950-68df7805b5ff"
    }
}

  2. Define the directories that are to be monitored.

    • Example 1: To specify that TIF, PDF and EML files are to be processed with JPL metadata files:

       "MonitoredDirectories": [
    {
        "FolderPath": "D:\\d3work\\import\\D3T",
        "RetryFailedUploads": true,
        "FileExtensions": [".tif", ".pdf", ".eml"],
        "MetadataFileExtension": "jpl",
        "SourceCategoryProperties": ["dokuart"]
    }
]

    • Example 2: To define the processing of UPD files:

       "MonitoredDirectories": [
    {
        "FolderPath": "\\\\d3t\\import\\UPD",
        "FileExtensions": [".upd"],
        "MetadataFileExtension": "upd",
        "SourceCategoryProperties": ["o_dokuart", "n_dokuart"]
    }
]

  3. Configure the files for the mappings.

    • Save mappings for categories and properties in files with the extension .mapping in the following subdirectory: <installation directory>\GlobalMappings

    • We recommend creating a separate .mapping file for each category. In this category, the database fields, document type and system properties of the JPL or UPD file are mapped to the corresponding ID of the cloud system.

    • The following example shows how the mapping is structured for a public cloud environment:

    • {
   "98689511-658d-4831-92b6-4683f46a1c30": {    // <-- ID of the cloud category
       "PropertyMappings": {
 
    //System properties mappings
          "zeich_nr": "property_document_number",
          "o_zeich_nr": "property_document_number",
          "var_nr": "property_variant_number",
          "o_var_nr": "property_variant_number",
          "text[1]": "property_remark1",
          "text[2]": "property_remark2",
          "text[3]": "property_remark3",
          "text[4]": "property_remark4",
 
    //Properties mapping (on-premises to cloud ID)
          "dok_dat_feld[7]": "dee97adc-ddff-453a-8e68-719aa1e6010c",
          "n_dok_dat_feld_7": "dee97adc-ddff-453a-8e68-719aa1e6010c",
          "dok_dat_feld[8]": "8e87e464-85d9-489f-b3df-728046c24a77",
          "n_dok_dat_feld_8": "8e87e464-85d9-489f-b3df-728046c24a77",
          "dok_dat_feld[35]": "159a136b-a0ba-464c-a465-e38cd2300467",
          "n_dok_dat_feld_35": "159a136b-a0ba-464c-a465-e38cd2300467",
          "dok_dat_feld[44]": "87e580d8-eef2-4252-82cb-ebe7665f1cbb",
          "n_dok_dat_feld_44": "87e580d8-eef2-4252-82cb-ebe7665f1cbb"
       }
   }
}
Additional links and information

  • Download page for the application 

  • Working with a “default.ini” file: If a default.ini file exists in the on-premises system, you can configure constants in the appsettings.json file of d.velop cloud uploader, for example to set a default value (PropertyConstants).

  • Receiving and transmitting confirmation files to SAP after successful import: You can find a description of the DATEI_IMPORT_QUITTUNG parameter in the documentation. You can enter the corresponding output file path in the JPL file. After the successful import, a confirmation file with the new document ID in the file is transferred to the relevant directory.