MCP Basic Configuration

Design

This page proposes a new feature and reviews design options

Development

This page describes a feature that's in development

Documentation

This page documents an implemented feature

Server

Configurations

Server ConfigFile

/etc/archivematica/MCPServer/ServerConfig.conf

Workflow Configurations

Please see MCP_Configuration

File Names Section

These shouldn't be changed.

File Names

DublinCore="dublincore.xml" checksumsNoExtention="checksum" fileUUIDSHumanReadable="FileUUIDs.log"

MCP Server Section

MCP Server

This section allows for general configuration of the server. moduleConfigDir: The directory of the xml configuration files.

moduleConfigDir="/etc/archivematica/MCPServer/mcpModulesConfig"

MCPArchivematicaServerInterface: specifies the interface to listen on. To only listen for connections from the same host(computer) as the MCPServer, set to "localhost"

MCPArchivematicaServerInterface="localhost"

To listen to connections from anywhere set to ""

MCPArchivematicaServerInterface=""

MCPArchivematicaServerPort: the TCP port to listen to archivematica client Machines

MCPArchivematicaServerPort="8002"

archivematicaProtocol:specifies where the protocol file is. This is used to control MCP flow.

archivematicaProtocol="/etc/archivematica/MCPServer/archivematicaProtocol"

watchDirectoryPath: Directory containing the directories watched by the MCP.

watchDirectoryPath="/var/archivematica/sharedDirectory/watchedDirectories/"

sharedDirectory: directory shared on the network with MCP clients. Containing the processing directory.

sharedDirectory="/var/archivematica/sharedDirectory/"

processingDirectory: Directory SIPs reside in while they are actively being processed.

processingDirectory="${sharedDirectory}.currentlyProcessing/"

AIPsStore: Directory to store the AIPs when finished processing. This can be a mounted directory on an external storage device.

AIPsStore="${sharedDirectory}AIPsStore/"

MCPArchivematicaXML: To approve jobs and and other functions an rpc protocol has been implemented using the python rpc xml tool. MCPArchivematicaXMLClients: As above, specify the interface and port to listen on.

MCPArchivematicaXMLClients="localhost"
MCPArchivematicaXMLPort="8000"

Client

Supported Modules

Supported modules
/etc/archivematica/MCPClient/archivematicaClientModules
It's highly recommended only the MCP server host machine client support the upload and store tasks.
Comment them out on other machines by prefacing the lines with a '#':

#upload-qubit_v0.0="upload-qubit "
#storeAIP_v0.0="%clientScriptsDirectory%storeAIP.sh "
...

Client ConfigFile

/etc/archivematica/MCPClient/clientConfig.conf Server to connect to. Specify hostname/IP and port.

MCPArchivematicaServer="localhost"
MCPArchivematicaServerPort="8002"

The matching protocol file to the MCP server

archivematicaProtocol="/etc/archivematica/MCPClient/archivematicaProtocol"

Where the shared directory on the MCP Server is mounted:

sharedDirectoryMounted="/var/archivematica/sharedDirectory/"

The maximum number of thread the MCP is allowed to run on this host.

maxThreads="2"

The location of the client modules. These specify which modules this host supports.

archivematicaClientModules="/etc/archivematica/MCPClient/archivematicaClientModules"

The location of the client scripts.

clientScriptsDirectory="/usr/lib/archivematica/MCPClient/clientScripts/"

Client Organization Setting

/usr/lib/archivematica/MCPClient/clientScripts/createXmlEventsAssist.py

yourAgentIdentifierType="repository code"
yourAgentIdentifierValue="ORG"
yourAgentName="Your Organization Name Here"
yourAgentType="organization"

<agent>
<agentIdentifier>
<agentIdentifierType>repository code</agentIdentifierType>
<agentIdentifierValue>ORG</agentIdentifierValue>
</agentIdentifier>
<agentName>Your Organization Name Here</agentName>
<agentType>organization</agentType>
</agent>