ToPX target connector

The ToPX connector creates import packages containing ToPX XMLs in a directory structured following the so-called sidecar structure. The supported ToPX version is 2.3.1. More information about ToPX and the sidecar structure can be found here: https://www.nationaalarchief.nl/archiveren/kennisbank/voorwaarden-export-naar-e-depot

note

This connector is not actively maintained. However, it is still supported. If you have any questions or need help, please contact us.

Features

• Generates ToPX XMLs of all aggregation levels (dutch: aggregatieniveau's) in a sidecar structure. These aggregation levels are:
  • Archief
  • Serie
  • Dossier
  • Record
  • Bestand

note

Currently, the connector allows most elements to be only used a maximum of 1 time, even when the XSD allows multiple occurrences. Furthermore, the following object kinds are supported: CONTAINER, RECORD and BINARY. Record versions are not yet supported.

Settings

mongoConnection

The Mongo connection string including the database name to connect to.

pathOutput

The directory the XML packages are created.

maxPackageFiles

The maximum number of objects of aggregation level "Bestand" in a package. By default, 95000 is recommended.

maxPackageSizeInMB

The maximum size in megabytes of all files in a package. By default, 9500 is recommended.

Model

The ToPX metadata is populated from the Content Store. Below we describe the schemas with an explanation of how the fields are translated to the ToPX fields.

For all but aggregation level "Bestand":

{
  "migration": {
    // REQUIRED | BOOLEAN | DESCRIPTION: Only objects where this value is set to 'true' will be part of the package.
    "migrate": true,
  },
  // All the Content Store required field and specifically for TopX the fields below.
  "target": {
    // REQUIRED | STRING | DESCRIPTION: Sets "identificatiekenmerk" of the object.
    "id": "text",
    // REQUIRED | STRING | DESCRIPTION: Not part of the generated XML (yet) but needed for the parent/child relationships.
    "parentIds": ["parentTest"],
    "name": {
      // REQUIRED | STRING | DESCRIPTION: Sets "naam" of the object.
      "displayName": "Ruimtelijke ordening",
    },
    "contentType": {
      // REQUIRED | STRING | DESCRIPTION: Sets "aggregatieniveau" of the object.
      "systemName": "Archief|Serie|Dossier|Record|Bestand",
    },
    // OPTIONAL | STRING | DESCRIPTION: Sets "omschrijving" of the object.
    "description": "text",
    "language": {
      // OPTIONAL | STRING | DESCRIPTION: Sets "taal" of the object.
      "systemName": "dut",
    },
    "properties": {
      // OPTIONAL | STRING
      "plaats": "/Sites/triplec/documentLibrary/Zaken/Ruimtelijke ordening",
      // OPTIONAL | OBJECT
      "openbaarheid": {
        // REQUIRED | STRING
        "omschrijvingBeperkingen": "Beperkt openbaar",
        // REQUIRED | OBJECT
        "datumOfPeriode": {
          // REQUIRED | STRING | OPTIONS: ["datum", "jaar", "datumEnTijd", "periode"]
          "type": "periode",
          // OPTIONAL | STRING or OBJECT | DESCRIPTION: value format depends on previously set type. In order: "xs:date", "xs:gYear", "xs:dateTime", OBJECT.
          "waarde": {
            // OPTIONAL | OBJECT
            "begin": {
              // REQUIRED | STRING | OPTIONS: ["datum", "jaar", "datumEnTijd"]
              "type": "jaar",
              // OPTIONAL | STRING | DESCRIPTION: value format depends on previously set type. In order: "xs:date", "xs:gYear", "xs:dateTime".
              "waarde": "2099",
            },
            // OPTIONAL | OBJECT
            "eind": {
              // REQUIRED | STRING | OPTIONS: ["datum", "jaar", "datumEnTijd"]
              "type": "jaar",
              // OPTIONAL | STRING | DESCRIPTION: value format depends on previously set type. In order: "xs:date", "xs:gYear", "xs:dateTime".
              "waarde": "2099",
            },
          },
        },
      },
      // OPTIONAL | OBJECT
      "relatie": {
        // REQUIRED | STRING
        "relatieID": "12345",
        // REQUIRED | STRING
        "typeRelatie": "Maakt deel uit van",
        // OPTIONAL | OBJECT
        "datumOfPeriode": {
          // REQUIRED | STRING | OPTIONS: ["datum", "jaar", "datumEnTijd", "periode"]
          "type": "jaar",
          // OPTIONAL | STRING or OBJECT | DESCRIPTION: value format depends on previously set type. In order: "xs:date", "xs:gYear", "xs:dateTime", OBJECT.
          "waarde": "2099",
        },
      },
      // OPTIONAL | OBJECT
      "dekking": {
        // OPTIONAL | OBJECT
        "begin": {
          // REQUIRED | STRING | OPTIONS: ["datum", "jaar", "datumEnTijd"]
          "type": "datumEnTijd",
          // OPTIONAL | STRING | DESCRIPTION: value format depends on previously set type. In order: "xs:date", "xs:gYear", "xs:dateTime".
          "waarde": "2018-10-25T07:35:00",
        },
        // OPTIONAL | OBJECT
        "eind": {
          // REQUIRED | STRING | OPTIONS: ["datum", "jaar", "datumEnTijd"]
          "type": "datum",
          // OPTIONAL | STRING | DESCRIPTION: value format depends on previously set type. In order: "xs:date", "xs:gYear", "xs:dateTime".
          "waarde": "2018-10-25",
        },
        // OPTIONAL | STRING
        "geografischGebied": null,
      },
      // OPTIONAL | OBJECT
      "externIdentificatiekenmerk": {
        // OPTIONAL | STRING
        "kenmerkSysteem": "Bron",
        // REQUIRED | STRING
        "nummerBinnenSysteem": "12345",
      },
      // OPTIONAL | OBJECT
      "classificatie": {
        // REQUIRED | STRING
        "code": "text",
        // REQUIRED | STRING
        "omschrijving": "text",
        // REQUIRED | STRING
        "bron": "text",
        // REQUIRED | OBJECT
        "datumOfPeriode": {
          // REQUIRED | STRING | OPTIONS: ["datum", "jaar", "datumEnTijd", "periode"]
          "type": "jaar",
          // OPTIONAL | STRING or OBJECT | DESCRIPTION: value format depends on previously set type. In order: "xs:date", "xs:gYear", "xs:dateTime", OBJECT
          "waarde": "2099",
        },
      },
      // OPTIONAL | OBJECT
      "eventGeschiedenis": {
        // REQUIRED | STRING
        "type": "text",
        // OPTIONAL | STRING
        "beschrijving": "text",
        // REQUIRED | STRING
        "verantwoordelijkeFunctionaris": "text",
        // REQUIRED | OBJECT
        "datumOfPeriode": {
          // REQUIRED | STRING | OPTIONS: ["datum", "jaar", "datumEnTijd", "periode"]
          "type": "jaar",
          // OPTIONAL | STRING or OBJECT | DESCRIPTION: value format depends on previously set type. In order: "xs:date", "xs:gYear", "xs:dateTime", OBJECT
          "waarde": "2099",
        },
      },
      // OPTIONAL | OBJECT
      "eventPlan": {
        // REQUIRED | STRING
        "type": "text",
        // OPTIONAL | STRING
        "beschrijving": "text",
        // OPTIONAL | STRING
        "aanleiding": "text",
        // REQUIRED | OBJECT
        "datumOfPeriode": {
          // REQUIRED | STRING | OPTIONS: ["datum", "jaar", "datumEnTijd", "periode"]
          "type": "jaar",
          // OPTIONAL | STRING or OBJECT | DESCRIPTION: value format depends on previously set type. In order: "xs:date", "xs:gYear", "xs:dateTime", OBJECT
          "waarde": "2099",
        },
      },
      // OPTIONAL | OBJECT
      "eventPlan": {
        // REQUIRED | STRING
        "type": "text",
        // OPTIONAL | STRING
        "beschrijving": "text",
        // OPTIONAL | STRING
        "aanleiding": "text",
        // REQUIRED | OBJECT
        "datumOfPeriode": {
          // REQUIRED | STRING | OPTIONS: ["datum", "jaar", "datumEnTijd", "periode"]
          "type": "jaar",
          // OPTIONAL | STRING or OBJECT | DESCRIPTION: value format depends on previously set type. In order: "xs:date", "xs:gYear", "xs:dateTime", OBJECT
          "waarde": "2099",
        },
      },
      // OPTIONAL | OBJECT
      "context": {
        // OPTIONAL | OBJECT
        "actor": {
          // REQUIRED | STRING
          "identificatiekenmerk": "text",
          // OPTIONAL | STRING
          "aggregatieniveau": "text",
          // REQUIRED | STRING
          "geautoriseerdeNaam": "text",
          // OPTIONAL | STRING
          "plaats": "text",
          // OPTIONAL | STRING
          "jurisdictie": "text",
        },
        // OPTIONAL | OBJECT
        "activiteit": {
          // OPTIONAL | STRING
          "identificatiekenmerk": "text",
          // OPTIONAL | STRING
          "aggregatieniveau": "text",
          // REQUIRED | STRING
          "naam": "text",
        },
      },
      // OPTIONAL | OBJECT
      "gebruiksrechten": {
        // REQUIRED | STRING
        "omschrijvingVoorwaarden": "text",
        // REQUIRED | OBJECT
        "datumOfPeriode": {
          // REQUIRED | STRING | OPTIONS: ["datum", "jaar", "datumEnTijd", "periode"]
          "type": "jaar",
          // OPTIONAL | STRING or OBJECT | DESCRIPTION: value format depends on previously set type. In order: "xs:date", "xs:gYear", "xs:dateTime", OBJECT
          "waarde": "2099",
        },
      },
      // OPTIONAL | OBJECT
      "vertrouwelijkheid": {
        // REQUIRED | STRING | OPTIONS: ["Niet vertrouwelijk", "Organisatievertrouwelijk", "Vertrouwelijk", "Geheim", "Zeer geheim"]
        "classificatieNiveau": "text",
        // REQUIRED | OBJECT
        "datumOfPeriode": {
          // REQUIRED | STRING | OPTIONS: ["datum", "jaar", "datumEnTijd", "periode"]
          "type": "jaar",
          // OPTIONAL | STRING or OBJECT | DESCRIPTION: value format depends on previously set type. In order: "xs:date", "xs:gYear", "xs:dateTime", OBJECT
          "waarde": "2099",
        },
      },
      // OPTIONAL | OBJECT
      "vorm": {
        // REQUIRED | STRING
        "redactieGenre": "text",
        // OPTIONAL | STRING
        "verschijningsvorm": "text",
        // OPTIONAL | STRING
        "structuur": "text",
      },
      // OPTIONAL | STRING
      "integriteit": "text",
      // OPTIONAL | LIST
      "generiekeMetadata": [
        // OPTIONAL | STRING
        "Zaaktype: B1667",
        // OPTIONAL | STRING
        "Archiefdatum: 25-10-2018",
        // OPTIONAL | STRING
        "Behandelaar: SYSTEM",
      ],
    },
  },
};

For aggregation level "Bestand" the same model applies, but the "vorm" property is REQUIRED and an additional property is required: "formaat". Furthermore, since some properties are not in the base model of BINARY, they need to be defined in the properties bag. Those are:

• identificatiekenmerk
• aggregatieniveau
• naam
• omschrijving
• taal

{
  "target" : {
    "properties": {
	  // REQUIRED | STRING
	  "identificatiekenmerk" : "914880dc-f922-450e-afbd-0b0ce16fed09",
	  // REQUIRED | STRING
	  "aggregatieniveau" : "Bestand",
	  // REQUIRED | STRING
	  "naam" : "test.ext",
	  // OPTIONAL | STRING
	  "omschrijving" : "text",
	  // OPTIONAL | STRING
	  "taal" : "dut",
	  // REQUIRED | OBJECT
	  "vorm" : {
		// REQUIRED | STRING
		"redactieGenre" : "text",
		// OPTIONAL | STRING
		"verschijningsvorm" : "text",
		// OPTIONAL | STRING
		"structuur" : "text"
	  },
	  // REQUIRED | OBJECT
	  "formaat" : {
		// REQUIRED | STRING | DESCRIPTION: This should match the name of the file provided in the package
		"identificatiekenmerk" : "kenmerk",
		// REQUIRED | OBJECT
		"bestandsnaam" : {
		  // REQUIRED | STRING | DESCRIPTION: Display name of file without extension
		  "naam" : "text",
		  // OPTIONAL | STRING
		  "extensie" : "ext"
		},
		// OPTIONAL | STRING
		"type" : "text",
		// OPTIONAL | STRING | DESCRIPTION: Non-negative number
		"omvang" : "123",
		// OPTIONAL | STRING
		"bestandsformaat" : "text",
		// OPTIONAL | OBJECT
		"creatieapplicatie" : {
		  // OPTIONAL | STRING
		  "naam" : "text",
		  // OPTIONAL | STRING
		  "versie" : "1.0",
		  // OPTIONAL | STRING | DESCRIPTION: value format "xs:date"
		  "datumAanmaak" : "2018-10-25"
		},
		// OPTIONAL | OBJECT
		"fysiekeIntegriteit" : {
		  // REQUIRED | STRING
		  "algoritme" : "SHA-256",
		  // REQUIRED | STRING
		  "waarde" : "1.0",
		  // REQUIRED | STRING | DESCRIPTION: value format "xs:dateTime"
		  "datumEnTijd" : "2018-10-25T07:35:00"
		},
		// REQUIRED | STRING | DESCRIPTION: value format "xs:date" or "xs:dateTime"
		"datumAanmaak" : "2018-10-25"
	  }
	}
  }
}