Skip to main content

Configuration reference

PAS-specific properties live under jeap.processarchive.*. The PAS is also a jEAP Messaging service, so Kafka is configured under jeap.messaging.kafka.* and spring.kafka.* — see the jEAP Messaging documentation. Relaxed binding applies, so object-lock-enabled and objectLockEnabled are equivalent.

Archive configuration

PropertyDescriptionDefault
jeap.processarchive.configuration.locationLocation of the archive configuration fileclasspath:/processarchive/messages.json
jeap.processarchive.registry.typesConfig-defined (non-Avro) archive types

The message-triggered archiving is declared in messages.json, where each configuration entry may carry an id (mandatory and unique when a message has multiple configurations).

Archived artifact event

See Archived artifacts & events.

PropertyRequiredDescriptionDefault
jeap.processarchive.archivedartifact.event-topicyesTopic for the SharedArchivedArtifactVersionCreatedEvent
jeap.processarchive.archivedartifact.system-idyessystemId of the event
jeap.processarchive.archivedartifact.system-nameyesSystem name used in the event
jeap.processarchive.archivedartifact.enablednoPublish the eventtrue

Object storage

See Object storage and Data expiration & locking.

PropertyDescriptionDefault
jeap.processarchive.objectstorage.connection.access-urlS3 URL
jeap.processarchive.objectstorage.connection.regionS3 / AWS regionAWS_GLOBAL
jeap.processarchive.objectstorage.connection.access-keyS3 access key
jeap.processarchive.objectstorage.connection.secret-keyS3 secret key
jeap.processarchive.objectstorage.storage.bucketDefault-strategy target bucket
jeap.processarchive.objectstorage.storage.prefix-modeKey prefix mode: NONE/DAY/MONTH/YEARDAY
jeap.processarchive.objectstorage.object-lock-enabledEnable object lockingtrue
jeap.processarchive.objectstorage.object-lock-modeCOMPLIANCE or GOVERNANCECOMPLIANCE
jeap.processarchive.objectstorage.schema-overwrite-allowedAllow overwriting Avro schemas on S3false

Remote data fetch

PropertyDescriptionDefault
jeap.processarchive.http.timeoutMax time for one successful remote data fetch5s

If a source service is slow, raise this — but not too high, or a temporarily unavailable service could delay archiving for other services while the PAS waits for timeouts.

Kafka polling

As for any jEAP Messaging consumer, polling must be tuned to the expected processing time per message:

PropertyDescriptionPAS default
spring.kafka.consumer.properties.max.poll.recordsMax records fetched per poll10
spring.kafka.consumer.properties.max.poll.interval.msMax time between polls before the broker considers the consumer dead100000

The main source of delay is fetching data over REST. Configure max.poll.interval.ms greater than max.poll.records × jeap.processarchive.http.timeout, plus headroom for the artifact listener and the object store — otherwise an unavailable source service could stall the PAS.

Backfill

See Backfill jobs for the full list (jeap.processarchive.backfill.*).

Metrics

See Metrics; set jeap.monitor.prometheus.password to access the endpoint.