...
File Copy Service.
Dependencies
Attributes
...
#DestinationFileSystem
| Anchor | ||||
|---|---|---|---|---|
|
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).
...
External command to copy tarballs to the destination, with
- %p will be replaced by the path of tarball to copy,
- %d will be replaced by the destination file system name,
- %f will be replaced by the destination TAR file path.
NONE = write tarball on local accessable file system.
Only effective, if the destination file system name is a tar URI.
...
Directory from which tarballs shall be copied by external #TarCopyCommand. A relative path name is resolved relative to dcm4chee_home/server/default/. Not effective if TarCopyCommand='NONE'
...
The file system must have already been configured by invoking operation File System Management Service#addRWFileSystem. Otherwise the copy task will fail!
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
| Anchor | ||||
|---|---|---|---|---|
|
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
| Anchor | ||||
|---|---|---|---|---|
|
List of HSM modules that are registered to this service.
#isReady
| Anchor | ||||
|---|---|---|---|---|
|
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
| Anchor | ||||
|---|---|---|---|---|
|
Status of copied file. Enumerated values: DEFAULT, TO_ARCHIVE, ARCHIVED
...
Default Value: TO_ARCHIVE
#VerifyCopy
| Anchor | ||||
|---|---|---|---|---|
|
Verify MD5 sum of copied file.
Default Value: true
...
#RetryIntervals
| Anchor | ||||
|---|---|---|---|---|
|
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
| Anchor | ||||
|---|---|---|---|---|
|
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
| Anchor | ||||
|---|---|---|---|---|
|
Maximum number of concurrent invoked Copy Requests.
Default Value: 1
...
#BufferSize
| Anchor | ||||
|---|---|---|---|---|
|
Size of write byte buffer.
...
.
#FetchSize
| Anchor | ||||
|---|---|---|---|---|
|
JDBC Fetch size.
Default Value: 50
#QueueName
| Anchor |
|---|
...
|
...
|
Used internally. Do NOT modify.
...
Default Value: FileCopy
#StoreScpServiceName
| Anchor |
|---|
...
|
...
|
Used internally. Do NOT modify.
...
Default Value: dcm4chee.archive:service=StoreScp
#JMSServiceName
| Anchor |
|---|
...
|
...
|
Used internally. Do NOT modify.
...
Identifies JNDI (e.g: jnp://hostname:1099) with EJBs.
Use LOCAL if EJBs are deployed in same JBoss instance.
...
Default Value: dcm4chee.archive:service=JMS
Default Value:* LOCAL
#QueryRetrieveScpServiceName
| Anchor | ||||
|---|---|---|---|---|
|
Used internally. Do NOT modify.
Default Value: dcm4chee.archive:service=QueryRetrieveScp
...
#Name
| Anchor | ||||
|---|---|---|---|---|
|
The class name of the MBean
...
#State
| Anchor | ||||
|---|---|---|---|---|
|
The status of the MBean
...
#StateString
| Anchor | ||||
|---|---|---|---|---|
|
The status of the MBean in text form
Operations
...
#create
| Anchor | ||||
|---|---|---|---|---|
|
Standard MBean lifecycle method
...
#start
| Anchor | ||||
|---|---|---|---|---|
|
The start lifecycle operation
...
#stop
| Anchor | ||||
|---|---|---|---|---|
|
The stop lifecycle operation
...
#destroy
| Anchor | ||||
|---|---|---|---|---|
|
The destroy lifecycle operation
...
#jbossInternalLifecycle
| Anchor | ||||
|---|---|---|---|---|
|
The detyped lifecycle operation (for internal use only)
#copyFilesOfStudy
| Anchor | ||||
|---|---|---|---|---|
|
Copy files of given study by Study Instance UID
#copyFilesOfSeries
| Anchor | ||||
|---|---|---|---|---|
|
Copy files of given series by Series Instance UID
#scheduleByIAN
| Anchor | ||||
|---|---|---|---|---|
|
Schedule Filecopy Order for given IAN Dataset
#registerHSMModule
| Anchor | ||||
|---|---|---|---|---|
|
Register a HSM Module (start queue if the module is set in HSMModulServicename)
#unregisterHSMModule
| Anchor | ||||
|---|---|---|---|---|
|
Unregister a HSM Module (stop queue if the module is set in HSMModulServicename)