Documentation homeGoobi workflow ManualGoobi workflow Digests

ACTApro synchronisation

Administration plugin for synchronising archive management with ACTApro

Overview

Name
Wert

Identifier

intranda_administration_actapro_sync

Repository

https://github.com/intranda/goobi-plugin-administration-actapro-sync

Licence

GPL 2.0 or newer

Last change

30.05.2025 20:16:27

Introduction

This documentation describes the installation, configuration and use of the Administration Plugin for synchronising archives from Goobi workflow with ACTApro. Nodes can be newly imported from ACTApro or existing nodes can be updated with current metadata from ACTApro. The opposite direction is also possible. New nodes can be created in Archive Management or existing nodes can be modified and this information sent to ACTApro.

Installation

In order to use the plugin, the following files must be installed:

/opt/digiverso/goobi/plugins/administration/plugin-administration-actapro-sync-base.jar
/opt/digiverso/goobi/plugins/GUI/plugin-administration-actapro-sync-gui.jar
/opt/digiverso/goobi/plugins/GUI/plugin-administration-actapro-sync-lib.jar
/opt/digiverso/goobi/config/plugin_intranda_administration_actapro_sync.xml

To use this plugin, the user must have the correct role authorisation.

The plugin cannot be used without correct authorisation

Therefore, please assign the role Plugin_administration_actapro_sync to the group.

Correctly assigned role for users

Overview and functionality

If the plugin has been installed and configured correctly, it can be found under the menu item 'Administration'.

User interface of the plugin

The inventory to be updated can be selected here first. A start and end date can also be optionally specified. If a start or end date exists, the import from ACTApro only searches for nodes that were created or changed within the specified period. Otherwise, all nodes in the inventory are searched for.

The local data can then be enriched with data from ACTApro or local changes can be reported to ACTApro by clicking on the button.

The following points must be fulfilled for the synchronisation to work:

  • the root node of the inventory must exist in ACTApro

  • The inventory must have been created in Archive Management

  • The root node of the inventory must exist in Archive Management

  • the ID of the ACTApro root document must be entered in the root node

If ‘Update with data from ACTApro has been selected, ACTApro is first searched for all data records belonging to this inventory (if necessary, restricted to a modification date within the set period). For each record found, the complete metadata document is queried and then the ACTApro ID is used to check whether a node already exists in Archive Management or whether it is a new node. If the node already exists, the next step is to check whether the node still has the same parent element or has been moved to a different location in the meantime. The configured fields are then read and their contents transferred to the nodes. If it is a new node, the hierarchy specified in path is checked and the parent nodes are searched for. If necessary, these must also be recreated. If the parent node is found (or newly created), a new node is created at the specified order ($.Ref_Gp.Ref_DocOrder), the ID is imported and then the metadata is imported.

With Update ACTApro, data from Archive Management is delivered to ACTApro. For this purpose, each node from the selected inventory is checked to see whether it already contains an ACTApro ID. If this is the case, the associated ACTApro json document is queried and overwritten with the configured fields from the node. If the ID of the parent node has changed, the new information is written to $.Ref_DocKey, $.Ref_DocOrder and $.Ref_Doctype. The document is then updated in ACTApro. If no ACTApro ID exists yet, this is a new node that is not yet known in ACTApro. A new json document is then created, the metadata and the parent element specified and recreated in ACTApro. The ID generated in the process is then saved in the node so that it can be updated the next time it is run.

The deletion of nodes cannot be synchronised as neither system holds any information about deleted elements. Nodes must therefore be deleted manually.

Configuration

The plugin is configured in the file plugin_intranda_administration_actapro_sync.xml as shown here:

<config>
    <authentication>
        <authServiceUrl>http://localhost:8080/AuthService-ACTApro/oauth2/token</authServiceUrl>
        <authServiceHeader>Authorization: Basic ABCDEFGEHIJKLMNOPQRSXYZ</authServiceHeader>
        <authServiceUsername>user</authServiceUsername>
        <authServicePassword>password</authServicePassword>
    </authentication>   

    <connectorUrl>http://localhost:8080/ACTApro-connector/</connectorUrl>


    <eadIdField>recordid</eadIdField>
    
    <!-- archiveName: name of the goobi archive -->
    <!-- actaproId: id of the actapro root node -->
    <inventory archiveName="testarchiv" actaproId="Arch    7c9e3ee0-4d72-4382-af1a-4fdf740d9d6e" />
    <inventory archiveName="Wotruba.xml" actaproId="Arch    4c5165ef-3e51-453c-b949-f0296f3726d0" />


    <metadata>
    
    <!-- 
    in case of metadata with subfields like
       {
            "type": "Listsource_Beteiligte_Personen_RDA_Funktion",
            "fields": [
              {
                "type": "Listsource_Value",
                "value": "Übersetzer"
              }
            ]
          }
    configure groupType with the main type and type with the subfield type ( type="Listsource_Value" groupType="Listsource_Beteiligte_Personen_RDA_Funktion" ). 
    
    
    
    Without subfields, use only the type attribute (type="Vz_Bestellsignatur" groupType="")
          {
            "type": "Vz_Bestellsignatur",
            "value": " (Test Signatur), A 6"
          }
    
    
    eadArea: allowed values are 1-7:
                        * 1: metadata for Identity Statement Area 
                        * 2: Context Area 
                        * 3: Content and Structure Area
                        * 4: Condition of Access and Use Area
                        * 5: Allied Materials Area
                        * 6: Note Area
                        * 7: Description Control Area
    
    To import metadata into a group, use the attributes eadGroup="group name" eadField="metadata within group", they must match the name attribute in plugin_intranda_administration_archive_management.xml
    
    For regular metadata use only eadField
    -->
    
        <field type="St_Entha" eadGroup="" eadField="scopecontent" eadArea="3"></field>
        <field type="Vz_Provenienz" groupType="Vz_Provenienz_Gp" eadGroup="accruals" eadField="accruals_head" eadArea="3"></field>
        <field type="Vz_Provenienz_Index" groupType="Vz_Provenienz_Gp"  eadGroup="accruals" eadField="accruals_p" eadArea="3"></field>
        <field type="Vz_Bestellsignatur" eadGroup="" eadField="Shelfmark" eadArea="1"></field>
        <field type="Vz_Umfang" eadGroup="" eadField="physdescstructured" eadArea="1"></field>
    </metadata>


    <!-- map a document type (actapro) to a node type/icon (archive) from the configured list in plugin_intranda_administration_archive_management.xml -->
    <nodeTypes>
      <type actaPro="Arch" node="archive" />
      <type actaPro="Best" node="inventory" />
      <type actaPro="Tekt" node="tectonics" />
      <type actaPro="Klas" node="folder" />
      <type actaPro="Ser" node="folder" />
      <type actaPro="Vz" node="file" />
    </nodeTypes>


</config>

The following table contains a summary of the parameters and their descriptions:

Parameter
Explanation

authentication

The information on authentication is summarised here

authServiceUrl

Contains the URL to the ACTApro authentication service

authServiceHeader

Contains the Authorisation header parameter

authServiceUsername

User name

authServicePassword

Passwort

connectorUrl

The URL to the ACTApro REST API

eadIdField

Name of the metadata in which the ID of the node from ACTApro is saved. This is used for matching between the archive management node and the ACTApro document

inventory

Definition of a stock that can be selected in the interface

@archiveName

Name of the fonds in Archive Management

@actaproId

ID des root Knoten in ACTApro

metadata

The mapping between the individual fields in Archive Management and ACTApro document is defined here

field

Contains the mapping for a single field

@type

Contains the name of the type field within the fields list in the ACTApro json document

@groupType

If the field you are looking for is a subfield of another 'type' field, the parent field can be specified here.

@eadField

Name of the field in Archive Management

@eadGroup

If the field is in a group, the group name can be entered here

@eadArea

Der Bereich, indem das Feld zu finden ist: 1 (Identity Statement Area), 2 (Context Area), 3 (Content and Structure Area), 4 (Condition of Access and Use Area), 5 (Allied Materials Area), 6 (Note Area), 7 (Description Control Area)

nodeTypes

The mapping between the node types in ACTApro and Archive Management is configured here

type

Contains the mapping for a single node type

@actaPro

Name of the type field in the ACTApro json document

@node

Name of the node type in Archive Management

PreviousOverviewNextArchive Management

Last updated