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/
, but you can make the file system a fixed directory as well. In the normal case, however, you will configure your own file system.
Note that until a file is received (and no other file system is configured) the default directory does not show up if you do a #showAllFileSystems command.
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.
Invoking operation #checkStorageFileSystem will force to check the status and availability of the current storage file system before next file storage, even if this attribute is set to false
.
Default Value: true
#MinimumFreeDiskSpace
Minimum free disk space. If the free available disk space on the current file system (cache) 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
#DFCommand
df
command used on *nix operation systems to assess free available disk space on storage file system(s).
You may change the default value to use a different version than the first in the system PATH.
Example: /usr/xpg4/bin/df
Default Value: df
#DFCommandOption
df
command option used on *nix operation systems to assess free available disk space on storage file system(s).
If you change the default value for POSIX compliant output, a wrong value for the free available disk space may be derived from the command output.
=> Always verify, if #freeDiskSpace (still) returns the correct value, after any modification of #DFCommandOption or #DFCommand.
Example: -k
Default Value: -P
#CheckFreeDiskSpaceMinimalInterval
Minimal Interval for checking free available disk space on current storage file system against minimum value specified by #MinimumFreeDiskSpace. The current interval (curInterval) is calculated by multiplication of this value (minInterval) with the ratio of the current free available disk space (curFDS}}) to the configured #MinimumFreeDiskSpace (minFDS), but maximal the value specified by #CheckFreeDiskSpaceMaximalInterval:
curInterval = min(minInterval * curFDS/minFDS, maxInterval)
Format: integer ('m'|'s')
(* in minutes or seconds *)
Default Value: 10s
#CheckFreeDiskSpaceMaximalInterval
Maximal Interval for checking free available disk space on current storage file system against minimum value specified by #MinimumFreeDiskSpace. Effective as long the current free available disk space is greater than #MinimumFreeDiskSpace multiplied by the ratio of this value and the configured #CheckFreeDiskSpaceMinimalInterval. Otherwise the interval will be calculated as described above for attribute #CheckFreeDiskSpaceMinimalInterval.
Format: integer ('m'|'s')
(* in minutes or seconds *)
Default Value: 60s
#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
#ExpectedDataVolumePerDay
Expected data volume per day. Used to transform time based #DeleterThresholds into disk space size to free. The value is updated automatically and calculated at midnight.
Default Value: 100MB
#AdjustExpectedDataVolumePerDay
Update value of attribute ExpectedDataVolumePerDay at midnight, if data volumne received during last 24 hours exceeds its current value.
Default Value: true
#DeleteStudiesExternallyRetrievable
Enables the deletion of studies that are the local cache if the studies are retrieveable from an external retrieve AE title. Database entries for the studies are not removed. If a study resides in another PACS system to which dcm4chee did a storage commit, our archive saves the external retrieve AE Title in the database when the archive stores into the external AE Title. The external AE Title is stored for every instance, which means that it is possible to split instances of one study over mutliple archives, although typically all study instances have a single external AE Title.
Default Value: false
#DeleteLocalStudiesStoredOnMedia
Enables the deletion of studies from local cache that are stored on media (offline storage). Database entries for the studies are not be removed. This setting is used for small installations that only have an offline, long-term archive (e.g. stored on DVD). Once the study is burned to DVD, and deleted from cache, it cannot be imported back into the archive.
Default Value: false
#DeleteLocalStudiesCopyAvailable
Enables the deletion studies from local cache that have a valid copy stored on a read-only file system. 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. Normally, this setting would only apply in small university installations using the archive for research in which they have a limited amount of disk space. Note that if you do run out of disk space, you receive an out of resources error.
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. Note that by setting the StudyAgeForDeletion, this overrides the space threshold values for deletion that were set above. Normally, you could use this setting instead of disk space thresholds if you have a Windows single-box scenario in which dcm4chee and the cache are on the same box, and you do not want to fill up the box and degrade dcm4chee performance.
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 Administration Tools Trash folder.
Format: (integer ('s'|'m'|'h')) | 'NEVER'
(* in seconds, minutes or hours *)
NEVER
= never delete unreferenced files.
Default Value: 1m
#DeleteFilesLimit
Limits the number of unreferenced files that are deleted in one delete task.
Default Value: 1000
#FreeDiskSpaceInterval
Interval in which free disk space is 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 files that were deleted from the web Administration Tools, 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 the default storage directory, if none exists. The directory is defined in #DefaultStorageDirectory.
Default Value: true
#WADOExcludePrivateAttributes
Excludes private Attributes from Datasets returned by the WADO Service. Legacy value that should now always be false.
Default Value: false
#OnSwitchStorageFilesystemInvoke
Executes specified command when the current storage file system becomes full and is switched to the next configured file system. '%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
#OtherServiceAETitleAttributesToUpdate
List of AE Title attributes of other services which are updated by operation #updateAETitle.
Default Value:
dcm4chee.archive:service=AuditLogger#SupressLogForAETitles dcm4chee.archive:service=CheckStudyPatientService#SourceAET dcm4chee.archive:service=ContentEditService#CalledAETitle dcm4chee.archive:service=ContentEditService#CallingAETitle dcm4chee.archive:service=ECHOService#CallingAETitle dcm4chee.archive:service=ExportManager#CallingAETitle dcm4chee.archive:service=Forward#ForwardModifiedToAETitles dcm4chee.archive:service=FileSystemMgt#RetrieveAETitle dcm4chee.archive:service=GPWLScp#CalledAETitles dcm4chee.archive:service=GPWLScp#CallingAETitles dcm4chee.archive:service=GPWLScu#CallingAETitle dcm4chee.archive:service=GPWLScu#CalledAETitle dcm4chee.archive:service=HPScp#CalledAETitles dcm4chee.archive:service=HPScp#CallingAETitles dcm4chee.archive:service=IANScu#NotifiedAETitles dcm4chee.archive:service=IANScu#CallingAETitle dcm4chee.archive:service=MCMScu#CallingAETitle dcm4chee.archive:service=MCMScu#RetrieveAETitle dcm4chee.archive:service=MCMScu#MoveDestinationAETitle dcm4chee.archive:service=MCMScu#McmScpAETitle dcm4chee.archive:service=MoveScu#CallingAETitle dcm4chee.archive:service=MoveScu#CalledAETitle dcm4chee.archive:service=MPPSEmulator#ModalityAETitles dcm4chee.archive:service=MPPSEmulator#CalledAETitle dcm4chee.archive:service=MPPSScp#CalledAETitles dcm4chee.archive:service=MPPSScp#CallingAETitles dcm4chee.archive:service=MPPSScu#ForwardAETitles dcm4chee.archive:service=MPPSScu#CallingAETitle dcm4chee.archive:service=MWLFindScp#CalledAETitles dcm4chee.archive:service=MWLFindScp#CallingAETitles dcm4chee.archive:service=MWLFindScp#LogAETitles dcm4chee.archive:service=MWLScu#CallingAETitle dcm4chee.archive:service=MWLScu#CalledAETitle dcm4chee.archive:service=PPSScu#DestinationAETitles dcm4chee.archive:service=PPSScu#CallingAETitle dcm4chee.archive:service=Prefetch#PrefetchSourceAETitle dcm4chee.archive:service=Prefetch#DestinationQueryAETitle dcm4chee.archive:service=Prefetch#DestinationStorageAETitle dcm4chee.archive:service=QueryRetrieveScp#CalledAETitles dcm4chee.archive:service=QueryRetrieveScp#CallingAEtitles dcm4chee.archive:service=QueryRetrieveScp#SendWithDefaultTransferSyntaxToAETitles dcm4chee.archive:service=QueryRetrieveScp#SendNoPixelDataToAETitles dcm4chee.archive:service=QueryRetrieveScp#IgnoreUnsupportedSOPClassFailures dcm4chee.archive:service=QueryRetrieveScp#RequestStorageCommitFromAETitles dcm4chee.archive:service=QueryRetrieveScp#LogAETitles dcm4chee.archive:service=StgCmtScuScp#CalledAETitles dcm4chee.archive:service=StgCmtScuScp#CallingAETitles dcm4chee.archive:service=StoreScp#CalledAETitles dcm4chee.archive:service=StoreScp#CallingAETitles dcm4chee.archive:service=StoreScp#WarnForCoercedAETitles dcm4chee.archive:service=StoreScp#IgnorePatientIDAETitles dcm4chee.archive:service=StoreScp#LogAETitles dcm4chee.archive:service=StudyReconciliation#FindSCPAETitle dcm4chee.archive:service=StudyReconciliation#CallingAETitle dcm4chee.archive:service=StudyMgtScp#CalledAETitles dcm4chee.archive:service=StudyMgtScp#CallingAETitles dcm4chee.archive:service=StudyMgtScu#CallingAETitle dcm4chee.archive:service=XDS-I#DocRepositoryAET
#DeleteFilesWhenUnavailable
Enable/Disable deletion of files off a file system that's availability is changed to UNAVAILABLE. Essentially, if you then make a file system unavailable, dcm4chee then delete all files from that file system so the disk can be reused. The files are no longer retrievable, however, only queryable. If the data is needed again, you must perform a backup of the file system before making it unavailable and then remount the file system again later.
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
#AEServiceName
Used internally. Do NOT modify.
Default Value: dcm4chee.archive:service=AE
#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.
#checkStorageFileSystem
Force check of status, availability and free space of the current storage file system before the file storage of next object received by the Storage SCP - even if #CheckStorageFileSystemStatus is disabled.
#selectStorageFileSystem
Select Storage File System.
#updateAETitle
Update specified AE Title to new value in AE Configuration and in all service attributes listed by attribute #OtherServiceAETitleAttributesToUpdate. Return number of modified service attributes.
#updateRetrieveAETitle
Update retrieve AET of this Node:
- update the retrieve AET of file systems, associated to the current retrieve AET of this node
- update retrieveAETs of all instances, series and studies that have files on these filesystems
- update the entry for the retrieve AE in the AE Configuration
- update all service attributes listed by attribute #OtherServiceAETitleAttributesToUpdate.
#updateFileSystemRetrieveAET
Update RetrieveAET of a file system.
Updates the RetrieveAETs of all instances, series and studies that have files on this filesystem.
Return true if update was performed (when retrieveAET of FS has been changed).
#updateDerivedFields
Update derived fields on given filesystem.
Return number of updated instances.
#updateFileSystemStatus
Update Status of a file system. Return true if the update was performed (= the file system status has been changed)
#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 (= 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.