File Copy Service

Description

File Copy Service.

Dependencies

Attributes

#DestinationFileSystem

Destination file system or NONE to disable the service. The file system name can be suffixed by '!'<from>'-'<to> to defer copying outside a particular time interval, and/or prefixed by a condition '[calling'['!']'='<aeTitle> {'|' <aeTitle>} ']' to limit/exclude copying to/of series received from modalities with specified AE title(s).
If the file system name is a tar URI (tar:<Directory/Mount Point>), instances of one series are packed into one tarball. Otherwise instance files are copied individually to the destination file system.

If an external command is used for the copy of tarballs to the destination, the destination name (after the "tar:" prefix) need not follow the syntax of a directory path (e.g.: tar:ftp://user@pass/service).

(warning) The file system must have already been configured by invoking operation File System Management Service#addRWFileSystem. Otherwise the copy task will fail!
(warning) If you configured a tar URI as destination file system, the name of the configured file system has to match that URI, and not only the <Directory/Mount Point> part!

Default Value: NONE

#HSMModulServicename

HSM Module to store tarballs to HSM systems.
Use NONE to store files on local filesystem without additional HSM support.
Only effective if destination is a tar filesystem!

Default Value: NONE

#RegisteredHSMModules

List of HSM modules that are registered to this service.

#isReady

Status if FileCopy Service is ready to process FileCopy orders.
If the destination is a tar filesystem and a HSMModule is configured, this module must be also registered!
If this status is false the processing of Filecopy orders will be delayed according NotReadyDelay to wait for deployment/registration of the configured HSMModule.

#FileStatus

Status of copied file. Enumerated values: DEFAULT, TO_ARCHIVE, ARCHIVED

Default Value: TO_ARCHIVE

#VerifyCopy

Verify MD5 sum of copied file.

Default Value: true

#RetryIntervals

Number and interval of retries made for failed Copy Requests.
Format: Comma separated list of <number> 'x' <interval> pairs.
The interval can be specified in seconds (##s), minutes (##m), hours (##h) or days (##d).

Example: 5x1m,10x10m
=> retry a total of 5 times, one minute apart for each retry; then retry a total of 10 times, 10 minutes apart for each retry.

Default Value: 5x1m,12x5m,24x1h,7x1d

#NotReadyDelay

Delay to reschedule FileCopy orders when the FileCopy Service is not ready.
The delay can be specified in seconds (##s), minutes (##m), hours (##h) or days (##d).

Default Value: 1m

#Concurrency

Maximum number of concurrent invoked Copy Requests.

Default Value: 1

#BufferSize

Size of write byte buffer.

#FetchSize

JDBC Fetch size.

Default Value: 50

#QueueName

Used internally. Do NOT modify.

Default Value: FileCopy

#StoreScpServiceName

Used internally. Do NOT modify.

Default Value: dcm4chee.archive:service=StoreScp

#JMSServiceName

Used internally. Do NOT modify.

Default Value: dcm4chee.archive:service=JMS

Default Value:* LOCAL

#QueryRetrieveScpServiceName

Used internally. Do NOT modify.

Default Value: dcm4chee.archive:service=QueryRetrieveScp

#Name

The class name of the MBean

#State

The status of the MBean

#StateString

The status of the MBean in text form

Operations

#create

Standard MBean lifecycle method

#start

The start lifecycle operation

#stop

The stop lifecycle operation

#destroy

The destroy lifecycle operation

#jbossInternalLifecycle

The detyped lifecycle operation (for internal use only)

#copyFilesOfStudy

Copy files of given study by Study Instance UID

#copyFilesOfSeries

Copy files of given series by Series Instance UID

#scheduleByIAN

Schedule Filecopy Order for given IAN Dataset

#registerHSMModule

Register a HSM Module (start queue if the module is set in HSMModulServicename)

#unregisterHSMModule

Unregister a HSM Module (stop queue if the module is set in HSMModulServicename)

Notifications