...
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
...
#Name
| Anchor |
|---|
...
|
...
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
...
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
...
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
...
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
...
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
...
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
...
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:
| No Format |
|---|
curInterval = min(minInterval * curFDS/minFDS, maxInterval)
|
Format: integer ('m'|'s') (* in minutes or seconds *)
Default Value: 10s
...
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
...
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
...
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
...
Update value of attribute ExpectedDataVolumePerDay at midnight, if data volumne received during last 24 hours exceeds its current value.
Default Value: true
...
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
...
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
...
Enables the deletion of studies in local cache that have a valid copy stored on a nearline filesystem (even if the filesystem is not read-only). Database entries for the studies are not removed.
Default Value: false
...
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
...
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
...
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
...
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.
...
|
The class name of the MBean
#State
| Anchor | ||||
|---|---|---|---|---|
|
The status of the MBean
#StateString
| Anchor | ||||
|---|---|---|---|---|
|
The status of the MBean in text form
#FileSystemGroupID
| Anchor | ||||
|---|---|---|---|---|
|
Identifier of the file system group managed by this service, specified by property group of its MBean name.
#DefaultRetrieveAETitle
| Anchor | ||||
|---|---|---|---|---|
|
Default Retrieve AE Title, which will be associated with new file systems added by operation #addRWFileSystem.
Default Value: DCM4CHEE
#DefaultAvailability
| Anchor | ||||
|---|---|---|---|---|
|
Default Availability, which will be associated with new file systems added by operation #addRWFileSystem.
Enumerated values: "ONLINE", "NEARLINE","OFFLINE", "UNAVAILABLE".
Default Value: NEARLINE
#DefaultUserInformation
| Anchor | ||||
|---|---|---|---|---|
|
Default User Information, which will be associated with new file systems added by operation #addRWFileSystem.
#DefaultStorageDirectory
| Anchor | ||||
|---|---|---|---|---|
|
Default Storage Directory, used on receive of the first object if no Storage File System was explicit configured byoperation [#addRWFileSystem}. A relative path name is resolved relative to <archive-install-directory>/server/default/.
Use "NONE" to disable auto-configuration to force failure to receive objects, if no Storage File System was explicit configured.
Default Value: NONE
#CheckStorageFileSystemStatus
| Anchor | ||||
|---|---|---|---|---|
|
Flag indicating if the RW status 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 of the file system is only performed by invoking operations #updateFileSystemStatus 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
#MakeStorageDirectory
| Anchor | ||||
|---|---|---|---|---|
|
Create storage directory, if no one exists.
Default Value: false
#MountFailedCheckFile
| Anchor | ||||
|---|---|---|---|---|
|
If the specified file exists, this signals a failed mount.
Default Value: NO_MOUNT
#MinimumFreeDiskSpace
| Anchor | ||||
|---|---|---|---|---|
|
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.
1MB = 1000000 bytes, 1GB = 1000MB.
NONE = disable check for minimal free available disk space.
Default Value: NONE
#FreeDiskSpaceOnCurrentStorageFileSystem
| Anchor | ||||
|---|---|---|---|---|
|
Get free available disk space on the current storage file system in bytes.
#FreeDiskSpaceOnCurrentStorageFileSystemString
| Anchor | ||||
|---|---|---|---|---|
|
Get free available disk space on the current storage file system as string.
#UsableDiskSpaceOnCurrentStorageFileSystem
| Anchor | ||||
|---|---|---|---|---|
|
Get usable free disk space on the current storage file system, considering the configured value for #MinimumFreeDiskSpace, by substracting that value from #FreeDiskSpaceOnCurrentStorageFileSystem, in bytes.
#UsableDiskSpaceOnCurrentStorageFileSystemString
| Anchor | ||||
|---|---|---|---|---|
|
Get usable free disk space on the current storage file system, considering the configured value for #MinimumFreeDiskSpace, by substracting that value from #FreeDiskSpaceOnCurrentStorageFileSystem, as string.
#FreeDiskSpace
| Anchor | ||||
|---|---|---|---|---|
|
Get free available disk space on writable file systems of the file system group managed my this service.
#FreeDiskSpaceString
| Anchor | ||||
|---|---|---|---|---|
|
Get free available disk space on writable file systems of the file system group managed my this service as string.
#UsableDiskSpace
| Anchor | ||||
|---|---|---|---|---|
|
Get usable free disk space on writable file systems of the file system group managed my this service, considering the configured value for #MinimumFreeDiskSpace, in bytes.
#UsableDiskSpaceString
| Anchor | ||||
|---|---|---|---|---|
|
Get usable free disk space on writable file systems of the file system group managed my this service, considering the configured value for #MinimumFreeDiskSpace, as string.
#CheckFreeDiskSpaceMinimalInterval
| Anchor | ||||
|---|---|---|---|---|
|
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 (maxInterval):
| No Format |
|---|
curInterval = min(minInterval * curFDS/minFDS, maxInterval)
|
Format: ##m (in minutes) | ##s (in seconds).
Default Value: 10s
#CheckFreeDiskSpaceMaximalInterval
| Anchor | ||||
|---|---|---|---|---|
|
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: ##m (in minutes) | ##s (in seconds).
Default Value: 60s
#CheckFreeDiskSpaceRetryInterval
| Anchor | ||||
|---|---|---|---|---|
|
Pause check for free available disk space for the specified time interval after no configured file system was found with sufficent (= more than specified by #MinimumFreeDiskSpace) available disk space.
Format: ##m (in minutes) | ##s (in seconds).
Default Value: 60s
#DeleterThresholds
| Anchor | ||||
|---|---|---|---|---|
|
Defines thresholds dependent on hour of day, for deleting the most infrequently accessed studies which satisfy the configured set of constraints.
Format: HOUR:##MB or HOUR:##GB or HOUR:##h
Multiple thresholds with different (start) hour separated by ';'.
NONE = disable deletion of studies on file systems of the file system group managed my this service.
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 usable free space falls below the expected data volume received in one hour.
Default Value: NONE
#ExpectedDataVolumePerDay
| Anchor | ||||
|---|---|---|---|---|
|
Expected data volume per day. Used to transform time based deleter thresholds (s. DeleterThresholds) into disk space size to free.
Default Value: 100MB
#AdjustExpectedDataVolumePerDay
| Anchor | ||||
|---|---|---|---|---|
|
Update value of attribute ExpectedDataVolumePerDay at midnight, if data volume received during last 24 hours exceeds its current value.
Default Value: true
#CurrentDeleterThreshold
| Anchor | ||||
|---|---|---|---|---|
|
Get current effective deleter threshold in bytes according configured #DeleterThreshold and #ExpectedDataVolumePerDay. If #UsableDiskSpace falls below this value, most infrequently accessed studies which satisfy the configured set of constraints will be deleted on next invocation of operation #scheduleStudiesForDeletion.
#DeleteStudyIfNotAccessedFor
| Anchor | ||||
|---|---|---|---|---|
|
Defines when a study not accessed for the specified time will be deleted from file systems of the file system group managed by this service, if it satisfies the configured set of constraints.
Format: ##h (in hours) | ##d (in days) | ##w (in weeks) | NEVER
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 conditionssatisfies the configured set of constraints.
Default Value: NEVER
...
#DeleteStudyOnlyIfNotAccessedFor
| Anchor |
|---|
...
|
...
|
Defines minimal time a study must not be accessed before it becomes a candidate for deletion.
Format: (integer ('s'|'m'|'h')) | 'NEVER'
(* in seconds, minutes or hours *)
NEVER = never delete unreferenced files. ##h (in hours) | ##d (in days) | ##w (in weeks)
Default Value: 1m 1d
...
#DeleteStudyOnlyIfStorageNotCommited
| Anchor |
|---|
...
|
...
|
Defines if no Storage Commitment request must have been accepted for any instances of a study to become a candidate for deletion from file systems of the file system group managed my this service triggered by running out of disk space or being not accessed longer than configured #DeleteStudiesNotAccessedFor. Typically only activated if no other constraint for study deletion is configured.
Default Value: 1000 false
...
#DeleteStudyOnlyIfExternalRetrieveable
| Anchor |
|---|
...
|
...
Interval in which free disk space is checked to see whether the deletion of the most infrequently accessed studies should be triggered.
...
|
Defines if all instances of a study must be retrievable from an external Application Entity to become a candidate for deletion from file systems of the file system group managed my this service triggered by running out of disk space or being not accessed longer than configured #DeleteStudiesNotAccessedFor.
Default Value: 5m false
...
#DeleteStudyOnlyIfCopyOnMedia
| Anchor |
|---|
...
|
...
|
Defines if all instances of a study must be stored on Media to become a candidate for deletion from file systems of the file system group managed my this service triggered by running out of disk space or being not accessed longer than configured #DeleteStudiesNotAccessedFor.
Default Value: false
...
#DeleteStudyOnlyIfCopyOnFileSystemOfFileSystemGroup
| Anchor |
|---|
...
|
...
Enables purging of files that were deleted from the web Administration Tools, after free disk space has processed.
Default Value: true
...
|
Defines if all instances of a study must be stored on a file system of the specified different file system group to become a candidate for deletion from file systems of the file system group managed my this service triggered by running out of disk space or being not accessed longer than configured #DeleteStudiesNotAccessedFor.
"NONE" = no such constraint.
Default Value: NO_MOUNT NONE
...
#DeleteStudyOnlyIfCopyArchived
| Anchor |
|---|
...
|
...
Create the default storage directory, if none exists. The directory is defined in #DefaultStorageDirectory.
Default Value: true
...
|
Defines if all instances of a study must be stored on a file system of a different file system group with file status: ARCHIVED to become a candidate for deletion from file systems of the file system group managed my this service triggered by running out of disk space or being not accessed longer than configured #DeleteStudiesNotAccessedFor. Typically the file system group of the file system holding the archived copy is specified by #DeleteStudyIfCopyOnFileSystemOfFileSystemGroup.
Default Value: false
...
#DeleteStudyOnlyIfCopyOnReadOnlyFileSystem
| Anchor |
|---|
...
|
...
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
...
List of AE Title attributes of other services which are updated by operation #updateAETitle.
Default Value:
| No Format |
|---|
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
|
...
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
...
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
...
Size of byte buffer used by WADO/RID service for copying data from file to TCP channel.
Default Value: 8192
...
Identifies JNDI (e.g: jnp://hostname:1099) with EJBs. "LOCAL", if EJBs are deployed in same JBoss instance.
Default Value: LOCAL
...
Used internally. Do NOT modify.
Default Value: PurgeStudy
...
Used internally. Do NOT modify.
Default Value: dcm4chee.archive:service=TarRetriever
...
Used internally. Do NOT modify.
Default Value: dcm4chee.archive:service=AE
...
Used internally. Do NOT modify.
Default Value: dcm4chee.archive:service=JMS
...
Used internally. Do NOT modify.
Default Value: dcm4chee.archive:service=Scheduler
...
The timer ID for scheduler of checking qualified files to purge.
Default Value: CheckFilesToPurge
...
The timer ID for scheduler of checking free disk space.
Default Value: CheckFreeDiskSpace
...
The class name of the MBean
...
The status of the MBean
...
The status of the MBean in text form
Operations
...
Standard MBean lifecycle method
...
The start lifecycle operation
...
The stop lifecycle operation
...
The destroy lifecycle operation
...
The detyped lifecycle operation (for internal use only)
...
Show all configured file systems.
...
Show configured ONLINE,RW file systems.
...
Show configured NEARLINE,RW file systems.
...
Add ONLINE,RW file system to configuration and link it with already configured ONLINE,RW file systems.
...
Add NEARLINE,RW file system to configuration and link it with already configured NEARLINE,RW file systems.
...
Add file system to configuration.
...
Update file system configuration.
...
Link 2 File Systems. One file system can be linked to several previous, but only to one next file system.
...
Remove file system configuration. Will fail if there are already files stored on this file system.
...
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.
...
Select Storage File System.
...
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.
...
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.
...
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).
...
Update derived fields on given filesystem.
Return number of updated instances.
...
|
Defines if all instances of a study must be stored on a read-only file system of a different file system group to become a candidate for deletion from file systems of the file system group managed my this service triggered by running out of disk space or being not accessed longer than configured #DeleteStudiesNotAccessedFor. Typically the file system group of the read-only file systems is specified by #DeleteStudyIfCopyOnFileSystemOfFileSystemGroup.
Default Value: false
#ScheduleStudiesForDeletionOnSeriesStored
| Anchor | ||||
|---|---|---|---|---|
|
Defines if operation #scheduleStudiesForDeletion is invoked to schedule deletion of most infrequently accessed studies after storage of a new Series by the Storage SCP Service.
Default Value: false
#ScheduleStudiesForDeletionInterval
| Anchor | ||||
|---|---|---|---|---|
|
Interval in which operation #scheduleStudiesForDeletion is invoked to schedule deletion of most infrequently accessed studies which satisfies the configured set of constraints from writable file systems of the file system group managed my this service, if they were not accessed longer than configured #DeleteStudiesNotAccessedFor or if #UsableDiskSpace falls below #CurrentDeleterThreshold.
Format: ##s (in seconds), ##m (in minutes), ##h (in hours).
NEVER = do not invoke operation #scheduleStudiesForDeletion by timer thread automatically. => If also #ScheduleStudiesForDeletionOnSeriesStored is not activated, no studies will be deleted automatically from file systems of the file system group managed my this service.
Default Value: NEVER
#ScheduleStudiesForDeletionBatchSize
| Anchor | ||||
|---|---|---|---|---|
|
Defines maximal number of studies scheduled for deletion in one transaction.
Default Value: 100
#DeleteOrphanedPrivateFilesInterval
| Anchor | ||||
|---|---|---|---|---|
|
Interval in which operation #deleteOrphanedPrivateFiles is invoked to delete orphaned private files from writable file systems of the file system group managed my this service. Orphaned private files are the result of deleting instances from the web trash folder.
Format: ##s (in seconds), ##m (in minutes), ##h (in hours).
NEVER = do not invoke operation #deleteOrphanedPrivateFiles automatically => never delete orphaned private files from the file system group managed my this service automatically.
Default Value: NEVER
#DeleteOrphanedPrivateFilesBatchSize
| Anchor | ||||
|---|---|---|---|---|
|
Limit the number of orphaned private files that are deleted by one invocation of operation <i>deleteOrphanedPrivateFiles</i>.
Default Value: 1000
#UpdateStudiesBatchSize
| Anchor | ||||
|---|---|---|---|---|
|
Defines maximal number of studies fetched from the data base in one transaction by operation #updateFileSystemAvailability and #updateFileSystemRetrieveAETitle for update of Availability and RetrieveAETs values in Study, Series and Instance records.
Default Value: 1000
#TimerIDScheduleStudiesForDeletion
| Anchor | ||||
|---|---|---|---|---|
|
Used internally. Do NOT modify.
#TimerIDDeleteOrphanedPrivateFiles
| Anchor | ||||
|---|---|---|---|---|
|
Used internally. Do NOT modify.
#SchedulerServiceName
| Anchor | ||||
|---|---|---|---|---|
|
Used internally. Do NOT modify.
#DeleteStudyServiceName
| Anchor | ||||
|---|---|---|---|---|
|
Used internally. Do NOT modify.
#StoreScpServiceName
| Anchor | ||||
|---|---|---|---|---|
|
Used internally. Do NOT modify.
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)
#listAllFileSystems
| Anchor | ||||
|---|---|---|---|---|
|
List all configured file systems.
#listFileSystems
| Anchor | ||||
|---|---|---|---|---|
|
List all configured file systems associated with the file system group managed my this service.
#listFileSystemDirectories
| Anchor | ||||
|---|---|---|---|---|
|
Return Directory Paths for all configured file systems associated with the file system group managed my this service as array of Files.
#addRWFileSystem
| Anchor | ||||
|---|---|---|---|---|
|
Add RW file system to the file system group managed my this service. The file system is also linked to existing other file systems of the group.
#removeFileSystem
| Anchor | ||||
|---|---|---|---|---|
|
Remove empty file system from the file system group managed my this service. Will fail, if there are already/still file records associated with the file system.
#linkFileSystems
| Anchor | ||||
|---|---|---|---|---|
|
Link or unlink two file systems of the file system group managed my this service.
#updateFileSystemStatus
| Anchor | ||||
|---|---|---|---|---|
|
Update RW status of the specified file system. If the new file system status is "RW+", which defines the file system as current storage file system, the status of the previous storage file system is set to "RW", to ensure that there is only one file system in one file system group with status "RW+".
#updateFileSystemAvailability
| Anchor | ||||
|---|---|---|---|---|
|
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)
...
Delete all files for given (unavailable!) file system! Throws an IllegalStateException if file systems availability is not UNAVAILABLE!
...
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!
...
Purge unreferenced private Files
...
Delete unreferenced files on specific directories or mount points.
...
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.
...
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.
...
Free disk space by deleting old studies. Deletes all older files on study level that fullfill the freeDiskSpacePolicy. Returns the number of released studies.
...
Update value of attribute ExpectedDataVolumnePerDay at midnight, if data volumne the specified file system.
#updateFileSystemRetrieveAETitle
| Anchor | ||||
|---|---|---|---|---|
|
Update Retrieve AE Title associated to the specified file system.
#selectStorageFileSystem
| Anchor | ||||
|---|---|---|---|---|
|
Select Storage File System
#selectStorageDirectory
| Anchor | ||||
|---|---|---|---|---|
|
Select Storage File System and return Directory
#adjustExpectedDataVolumePerDay
| Anchor | ||||
|---|---|---|---|---|
|
Update value of attribute #ExpectedDataVolumePerDay, if data volume received during last 24 hours exceeds its current value.
#scheduleStudiesForDeletion
| Anchor | ||||
|---|---|---|---|---|
|
Schedules deletion of most infrequently accessed studies which satisfies the configured set of constraints from writable file systems of the file system group managed my this service, if they were not accessed longer than configured #DeleteStudiesNotAccessedFor or if #UsableDiskSpace falls below #CurrentDeleterThreshold. Returns the number of studies scheduled for deletion.
#scheduleStudyForDeletion
| Anchor | ||||
|---|---|---|---|---|
|
Schedule deletion of study with specified Study Instance UID from writable file systems of the file system group managed by this service, without consideration of the configured set of constraints. Returns size of study in bytes scheduled for deletion.
#deleteOrphanedPrivateFiles
| Anchor | ||||
|---|---|---|---|---|
|
Delete orphaned private files from writable file systems of the file system group managed my this service. Orphaned file system.
#selectStorageFileSystem
| Anchor | ||||
|---|---|---|---|---|
|
Select Storage File System
#selectStorageDirectory
| Anchor | ||||
|---|---|---|---|---|
|
Select Storage File System and return Directory
#adjustExpectedDataVolumePerDay
| Anchor | ||||
|---|---|---|---|---|
|
Update value of attribute #ExpectedDataVolumePerDay, if data volume received during last 24 hours exceeds its current value.
...
#scheduleStudiesForDeletion
| Anchor |
|---|
...
|
...
get file size of study stored on the given file system.
...
Show total free available disk space on file systems associated with this node (Retrieve AET), and configured for storage (ONLINE, RW).
...
Used internally.
...
|
Schedules deletion of most infrequently accessed studies which satisfies the configured set of constraints from writable file systems of the file system group managed my this service, if they were not accessed longer than configured #DeleteStudiesNotAccessedFor or if #UsableDiskSpace falls below #CurrentDeleterThreshold.
Returns the number of studies scheduled for deletion.
#scheduleStudyForDeletion
| Anchor | ||||
|---|---|---|---|---|
|
Schedule deletion of study with specified Study Instance UID from writable file systems of the file system group managed by this service, without consideration of the configured set of constraints. Returns size of study in bytes scheduled for deletion.
#deleteOrphanedPrivateFiles
| Anchor | ||||
|---|---|---|---|---|
|
Delete orphaned private files from writable file systems of the file system group managed my this service. Orphaned private files are the result of deleting instances from the web trash folder. Returns the number of deleted files.