Description
File System Management Service. Specifies the location of file systems in which DICOM objects received from the Store SCP Server are stored. You can also set up rules to delete the most infrequently accessed studies.
Dependencies
Attributes
#RetrieveAETitle
Retrieve AE title associated with this DICOM Node. There must be at least one configured file system suitable for storage (ONLINE, RW) associated with this AE title.
Default Value: DCM4CHEE
#DefaultStorageDirectory
Default Storage Directory, used if there is no File system entry configured for given Retrieve AET. A relative path name is resolved relative to $DCM4CHEE/server/default/
.
Default Value: archive
#CheckStorageFileSystemStatus
Flag indicating if the status and availability of the current storage file system is checked before each file storage of objects received by the Storage SCP.
If the update of the status or availability of the file system is only performed by invoking operations #updateFileSystem or #updateFileSystemAvailability of this service – in particular, if there are no other running dcm4chee applications on other nodes (dcm4chee cluster), and File System records in the database will NOT be updated by executing SQL statements using some dcm4chee external SQL client application – the check can be deactivated to spare the execution of one additional SQL statement for each stored object.
Default Value: true
#MinimumFreeDiskSpace
Minimum free disk space. If the free available disk space on the current storage file system falls below this value, the next configured file system becomes the current storage system.
Format: integer ('MB'|'GB')
(* 1MB = 1000000 bytes, 1GB = 1000MB. *)
Default Value: 50MB
#CheckFreeDiskSpaceInterval
Interval for checking free available disk space on current storage file system against minimum value specified by #MinimumFreeDiskSpace. If the free available disk space falls below #MinimumFreeDiskSpace x #CheckFreeDiskSpaceThreshold, the check is performed for each received object – and is no longer controlled by the configured interval.
Format: integer ('m'|'s')
(* in minutes or seconds *)
Default Value: 60s
#CheckFreeDiskSpaceThreshold
Defines lower threshold of free disk space for checking free available disk space. If the free available disk space falls below #MinimumFreeDiskSpace x #CheckFreeDiskSpaceThreshold,the check is performed for each received object – and is no longer controlled by #CheckFreeDiskSpaceInterval.
Default Value: 5.
#DeleterThresholds
Defines thresholds dependent on hour of day, for deleting the most infrequently accessed studies.
Format: hour ':' threshold
{ ';' hour ':' threshold
}
hour = 0-23
threshold = integer ('MB'|'GB'|'h')
Multiple thresholds with different (start) hour separated by ';'.
Example: 7:1h;19:24h
=> free space for expected data volume received in 24 hours between 7pm and 7am. Between 7am and 7pm only delete studies if the available free space falls below the expected data volume received in one hour.
Default Value: 7:1h;19:24h
#ExpectedDataVolumnePerDay
Expected data volume per day. Used to transform time based #DeleterThresholds into disk space size to free.
Default Value: 100MB
#AdjustExpectedDataVolumnePerDay
Update value of attribute ExpectedDataVolumnePerDay at midnight, if data volumne received during last 24 hours exceeds its current value.
Default Value: true
#DeleteStudiesExternallyRetrievable
Enables deletion of studies in local cache if the studies are retrieveable from an external Retrieve AE. Database entries for the studies are not removed.
Default Value: false
#DeleteLocalStudiesStoredOnMedia
Enables the deletion studies in local cache that are stored on media (offline storage). Database entries for the studies are not be removed.
Default Value: false
#DeleteLocalStudiesCopyAvailable
Enables the deletion studies in local cache that have a valid copy stored on a read only filesystem. Database entries for the studies are not be removed.
Default Value: true
#ValidFileStatus
Defines the valid File Status if #DeleteLocalStudiesCopyAvailable is enabled. This value is used to check if a valid copy of all instances of a study is available on read only (RO) Filesystem.
Enumerated Values: DEFAULT
, TO_ARCHIVE
, ARCHIVED
Default Value: DEFAULT
#DeleteStudiesFromSystem
Enables deletion of the most infrequently accessed studies for which no storage commitment request was received. Enabling this feature deletes the studies and the database entries, so the study is completely removed from the system. We recommend extreme caution when using this feature.
Default Value: false
#StudyAgeForDeletion
Defines how long a study is not accessed before it will be deleted from cache if it matches one of the configured conditions: Delete Studies Externally Retrievable, Delete Studies On Media, or Delete Studies from
System.
Format: (integer ('h'|'d'|'w')) | 'NEVER'
(* in hours or days or weeks *)
NEVER
= deletion of studies is only triggered by running out of disk space.
Example: 52w
=> any studies that have not been accessed for 52 weeks or more can be deleted if they match the preconfigured conditions.
Default Value: NEVER
#DeleteFilesInterval
Interval in which unreferenced files are deleted. Unreferenced files are the result of deleting instances from the web trash folder.
Format: (integer ('s'|'m'|'h')) | 'NEVER'
(* in seconds, minutes or hours *)
NEVER
= never delete unreferenced files.
Default Value: 1m
#DeleteFilesLimit
Limit the number of unreferenced files that are deleted in one delete task.
Default Value: 1000
#FreeDiskSpaceInterval
Interval in which free disk space checked to see whether the deletion of the most infrequently accessed studies should be triggered.
Format: (integer ('s'|'m'|'h')) | 'NEVER'
(* in seconds, minutes or hours *)
NEVER
= never delete studies.
Default Value: 5m
#FreeDiskSpaceOnDemand
Enables the "free disk space on demand" feature. Services such as the StorageSCP use this flag to permit or omit the call of free disk space after their work.
Default Value: false
#DeleteFilesAfterFreeDiskSpace
Enables purging of (web) deleted files after free disk space has processed.
Default Value: true
#MountFailedCheckFile
If the specified file exists, this signals a failed mount.
Default Value: NO_MOUNT
#MakeStorageDirectory
Create storage directory, if no one exists.
Default Value: true
#WADOExcludePrivateAttributes
Excludes private Attributes from Datasets returned by WADO Service.
Default Value: false
#OnSwitchStorageFilesystemInvoke
Executes specified command when the current storage file system becomes full and is switch to the next configured. '%1' will be replaced by the directory path of the previous, '%2' with the directory path of the new storage file system.
Default Value: NONE
#DeleteFilesWhenUnavailable
Enable/Disable deletion of files off a filesystem thats availability is changed to UNAVAILABLE.
Default Value: false
#RetryIntervalsForJmsOrder
Number and interval of retries made for failed JMS order, e.g., purgeFile.
Format: number 'x' interval
{ ',' number 'x' interval
}
interval = number ('s'|'m'|'h'|'d')
(* in seconds, minutes, hours or days *)
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
#BufferSize
Size of byte buffer used by WADO/RID service for copying data from file to TCP channel.
Default Value: 8192
#EJBProviderURL
Identifies JNDI (e.g: jnp://hostname:1099) with EJBs. "LOCAL", if EJBs are deployed in same JBoss instance.
Default Value: LOCAL
#PurgeStudyQueueName
Used internally. Do NOT modify.
Default Value: PurgeStudy
#JMSServiceName
Used internally. Do NOT modify.
Default Value: dcm4chee.archive:service=JMS
#SchedulerServiceName
Used internally. Do NOT modify.
Default Value: dcm4chee.archive:service=Scheduler
#TimerIDCheckFilesToPurge
The timer ID for scheduler of checking qualified files to purge.
Default Value: CheckFilesToPurge
#TimerIDCheckFreeDiskSpace
The timer ID for scheduler of checking free disk space.
Default Value: CheckFreeDiskSpace
#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)
#showAllFileSystems
Show all configured file systems.
#showOnlineFileSystems
Show configured ONLINE,RW file systems.
#showNearlineFileSystems
Show configured NEARLINE,RW file systems.
#addOnlineFileSystem
Add ONLINE,RW file system to configuration and link it with already configured ONLINE,RW file systems.
#addNearlineFileSystem
Add NEARLINE,RW file system to configuration and link it with already configured NEARLINE,RW file systems.
#addFileSystem
Add file system to configuration.
#updateFileSystem
Update file system configuration.
#linkFileSystems
Link 2 File Systems. One file system can be linked to several previous, but only to one next file system.
#removeFileSystem
Remove file system configuration. Will fail if there are already files stored on this file system.
#selectStorageFileSystem
Select Storage File System
#updateFileSystemAvailability
Update Availability of a file system. This method updates the availability of all instances, series and studies that have files on this filesystem!
If #DeleteFilesWhenUnavailable is enabled and the file system gets UNAVAILABLE, all files of this file system will be deleted! Return true
if update/delete was performed (when availability of file system has been changed)
#deleteFilesOnFS
Delete all files for given (unavailable!) file system! Throws an IllegalStateException if file systems availability is not UNAVAILABLE!
#checkFilesOnFS
Check filesystem if files are available! Return 1 if all files are available, -1 if filesystem is empty and 0 if some files are not available!
#purgePrivateFiles
Purge unreferenced private Files
#purgePrivateFiles
Delete unreferenced files on specific directories or mount points.
#locateInstance
Locate SOP Instance. Return a File object, if the instance is locally available, or the hostname as String object if a file of the instance is located on another host.
#getDatasourceOfInstance
Locate SOP Instance. Return a Dataset object, if the instance is locally available. The attributes of the dataset are updated with the attributes from database.
#freeDiskSpace
Free disk space by deleting old studies. Deletes all older files on study level that fullfill the freeDiskSpacePolicy. Returns the number of released studies.
#adjustExpectedDataVolumnePerDay
Update value of attribute ExpectedDataVolumnePerDay at midnight, if data volumne received during last 24 hours exceeds its current value.
#showStudySize
get file size of study stored on the given file system.
#showAvailableDiskSpace
Show total free available disk space on file systems associated with this node (Retrieve AET), and configured for storage (ONLINE, RW).
#listLocalOnlineRWFileSystems
Used internally.