subapp.cfg.j2

###########################
### OPTIONAL PARAMETERS ###
###########################



### optional processing and log settings

# Absolute path to a file that contains a CSV list of SIPs that should be ignored by the subapp. One entry per line. You can create the file and leave it empty if you like; subapp will then act as if there was no blacklist at all and process all the SIPs.
blacklist_sip_file:/home/{{ vault_subapp_user }}/.subapp/usa_blacklist_file.csv
# Absolute path to a PID file
pid_file:/run/subapp/subapp_rosetta.pid
# Log4perl log level
logger_min_level:debug
# Blocking AIP updates
ingest_only:{{ vault_subapp_vars.hosts[ansible_hostname].ingest_only | default("0") }}



############################
### MANDATORY PARAMETERS ###
############################



### internal working directories

# Absolute path to the directory which is used for placing lockfiles into for SIPs when their processing commences.
directory_lock:/home/{{ vault_subapp_user }}/.subapp/lockdir/
# Absolute path to the directory which contains symlinks to the SIPs that encountered errors during the processing and are put into quarantine. These SIPs will be ignored until the error is resolved.
directory_quarantine:/home/{{ vault_subapp_user }}/.subapp/quarantine/
# Absolute path to the directory which is used for processing SIPs that contain an AIP update.
directory_shared_aipupdate:/mnt/{{ ansible_hostname }}_ingest/aipupdate/
# Absolute path to the directory producers use to upload their SIPs to.
directory_shared_import:/mnt/import/
# Absolute path to the directory that the submission application uses to put processed SIPs into for them to be fetched by Rosetta. Please note that the path to this directory needs to be accessible by Rosetta as well, and it needs to have the exact same name, so put extra attention into the naming of volumes, mount points and NFS export policy (or equivalent).
directory_shared_ingest:/mnt/{{ ansible_hostname }}_ingest/



### user/group settings

# Name of the Linux user that owns the subapp's ingest directory.
owner_user_ingest_dir:{{ vault_subapp_user }}
# Name of the Linux group that owns the subapp's import directory.
owner_group_import_dir:import
# Name of the Linux group that owns the subapp's ingest directory.
owner_group_ingest_dir:{{ vault_subapp_group }}



### Rosetta settings

# FQDN of a) the host that the Rosetta application with the DEP role is running on or b) the load balancer that is in front of a Rosetta application cluster
rosetta_host:{{ vault_subapp_vars.hosts[ansible_hostname].RosettaHost | default("ROSETTA_HOSTNAME_TEMPLATE") }}
# FQDN of the host that the PDS authentication server is running on
rosetta_pdshost:{{ vault_subapp_vars.hosts[ansible_hostname].PdsHost | default("PDS_HOSTNAME_TEMPLATE") }}
# name of the institution in Rosetta that the subapp will ingest its SIPs into
rosetta_institute:{{ vault_subapp_vars.hosts[ansible_hostname].Institute | default("INSTITUTE_NAME_TEMPLATE") }}
# Material Flow ID of the Material Flow that will be used for processing SIPs in Rosetta
rosetta_materialflowId:{{ vault_subapp_vars.hosts[ansible_hostname].MaterialFlowID | default("MATERIAL_FLOW_ID_TEMPLATE") }}
# username of the user that the subapp will use for authentication against PDS/Rosetta
rosetta_user:{{ vault_subapp_vars.hosts[ansible_hostname].User | default("SUBMISSION_APPLICATION_USER_TEMPLATE") }}
# password of that user
rosetta_password:{{ vault_subapp_vars.hosts[ansible_hostname].Rosetta_Password | default("ROSETTA_PASSWORD_TEMPLATE") }}



### processing configuration

# Workflow name as agreed upon in the contract between producer and archive.
fullname_workflow:{{ vault_subapp_vars.hosts[ansible_hostname].fullname_workflow | default("WORKFLOW_NAME_TEMPLATE") }}

# Path to the XML file that contains the encoded significant properties as agreed upon with the producer.
significant_properties_file:{{ vault_subapp_vars.hosts[ansible_hostname].significant_properties_file | default("SIGNIFICANT_PROPERTIES_FILE_PATH_TEMPLATE") }}



### email notification configuration

# notification email address for producers (high level error information)
logger_producer_email:{{ vault_subapp_vars.hosts[ansible_hostname].logger_producer_email | default("LOGGER_PRODUCER_EMAIL_TEMPLATE") }}
# notification email address for archive staff (low level error information)
logger_staff_email:{{ vault_subapp_vars.hosts[ansible_hostname].logger_staff_email | default("LOGGER_STAFF_EMAIL_TEMPLATE") }}



### database configuration

# Absolute path to SQLite database file for storing and loading message queues and SIP states
# Hints: using /tmp is not allowed by SQLite, furthermore security requires the parent directory to be set to at least '750' (drwxr-x---)
database_file:/home/{{ vault_subapp_user }}/.subapp/subapp.db