4.4.2.1.3.8.4. Storage

Storage Descriptor

Table 4.96 Storage Attributes (LDAP Object: dcmStorage)

Name

Type

Description (LDAP Attribute)

Storage ID

string

Storage ID

(dcmStorageID)

Storage URI

string

RFC2079: Uniform Resource Identifier

(dcmURI)

Archive Series as TAR

boolean

Indicates that binary DICOM objects of one Series are packed in one TAR archive on this Storage System; false if absent.

(dcmArchiveSeriesAsTAR)

Storage Path Format

string

Format of file path of DICOM binary objects or metadata in JSON format or of ZIP archives containing metadata in JSON format for each DICOM object of one Series, written to this Storage System. ‘{now,date,yyyy/MM/dd}/{0020000D,hash}/{0020000E,hash}/{00080018,hash}’, if absent.

(dcmStoragePathFormat)

Already Exists on Storage Path

string

Specifies behavior if an object already exists on the storage path on the storage system, assembled according to the configured ‘Storage Path Format’. Default behaviour ‘RANDOM_PATH’.

Enumerated values:

FAILURE (= Signals failure writing the new object)

NOOP (= Proceed without writing the new object)

RANDOM_PATH (= Replace last path element be random 8 hex digit number and try again)

(dcmOnStoragePathAlreadyExists)

Retry Create Directories

integer

Specifies number of retries to create parent directories of the storage file path - may workaround issues concerning NFS; 0 if absent.

(dcmRetryCreateDirectories)

Alt Create Directories

boolean

Indicate to not rely on ‘createDirectories’ function in ‘java.nio.file.Files’ Java class, to create all nonexistent parent directories first, but instead explicitly create parent directories if NoSuchFileException is thrown. May workaround issues concerning NFS.

(dcmAltCreateDirectories)

Check Mount File Path

string

Indicates to check if a mounted file system did not get detached from its mount point, by specifying the path of a file relative to the path of the Storage URI, which is shadowed by the mount, so its visibility signals that the mount failed. If the file becomes visible, the write operation to the storage fails, preventing to store objects on the file system of the mount point directory.

(dcmCheckMountFilePath)

File Open Option(s)(s)

string

Options specifying how the file is opened for writing. Default behaviour ‘CREATE_NEW’.

Enumerated values:

CREATE_NEW (= Create a new file, failing if the file already exists)

DSYNC (= Requires that every update to the file’s content be written synchronously to the underlying storage device)

SYNC (= Requires that every update to the file’s content or metadata be written synchronously to the underlying storage device)

(dcmFileOpenOption)

Location Status

string

Initial Location Status of DICOM files written to this Storage System. Default behaviour ‘OK’.

Enumerated values:

OK (= Indicates access state of stored objects is stable)

VERIFY_QSTAR_ACCESS_STATE (= Indicates to verify access state of stored objects from QStar Tape File System)

(dcmLocationStatus)

Count Locations by Status

boolean

Indicate to include counts of locations with status != 0 (=OK) for this Storage System by RESTful service to list Storage Systems; false if absent.

(dcmCountLocationsByStatus)

Digest Algorithm

string

Algorithm for generation of check sums.

Enumerated values:

MD5 (= Message-digest algorithm)

SHA-1 (= Secure Hash Algorithm 1)

(dcmDigestAlgorithm)

Maximum Number of Retries

integer

Maximum number of retries to store an object on the storage system.

(dcmMaxRetries)

Retry Delay

string

Delay to retry to store an object on the storage system in ISO-8601 duration format PnDTnHnMn.nS. Retry immediately if absent.

(dcmRetryDelay)

Instance Availability

string

Instance Availability.

Enumerated values:

ONLINE

NEARLINE

OFFLINE

(dcmInstanceAvailability)

Storage Duration

string

Indicates the type of storage duration. Objects get purged from cache and temporary storage according configured deleter thresholds or - if no deleter threshold is specified and no Retention Periods are configured - all objects on the Storage will get purged. In the case of temporary storage, the studies whose objects were purged are also deleted from the database.

Enumerated values:

PERMANENT (= Permanent storage)

CACHE (= Cache storage)

TEMPORARY (= Temporary storage)

(dcmStorageDuration)

Read Only

boolean

Indicates if a Storage System is read only.

(dcmReadOnly)

Storage Cluster ID

string

Identifies a CACHE Storage belonging to a Storage Cluster. Objects of one Study may be distributed over Storage Systems of one Storage Cluster. Used by threshold triggered deletion.

(dcmStorageClusterID)

Storage Threshold

string

Minimal Usable Space on Storage System. If the usable space falls below that value the Storage System will be marked as full by setting Storage Threshold Exceeds to the current time and - if Storage Threshold Exceeds Permanently is true - the Storage System will be removed from the list of configured Storage Systems of the Network AE requesting that Storage System. Format nnn(MB|GB|MiB|GiB)

(dcmStorageThreshold)

Storage Threshold Exceeded

string

Date and time in format YYYYMMDDHHMMSS.FFFFFF when the Storage Threshold exceeded.

(dcmStorageThresholdExceeded)

Storage Threshold Exceeds Permanently

boolean

Indicates to removed the Storage System from the list of configured Storage Systems of the Network AE requesting that Storage System when the Storage Threshold exceeds.

(dcmStorageThresholdExceedsPermanently)

No Deletion Constraint

boolean

Delete Studies from cache/temporary Storage System, if no Deleter Threshold and no other deletion constraint is configured.

(dcmNoDeletionConstraint)

Deleter Threshold(s)

string

Minimal Usable Space on Storage System to trigger deletion. If present, studies are deleted from the Storage System configured for cache (Storage Duration = CACHE) or temporary (Storage Duration = TEMPORARY) storage, if the usable space fall below that value. Format [nn’[‘<schedule>’]’]nnn(MB|GB|MiB|GiB).

(dcmDeleterThreshold)

Delete Studies Older Than(s)

string

Delete Studies from the Storage System configured for cache (dcmStorageDuration=CACHE) or temporary (dcmStorageDuration=TEMPORARY) storage, if their Study Date is longer ago than the specified value in ISO-8601 period format. Format [nn”[“<schedule>”]”](PnYnMnD|PnW).

(dcmDeleteStudiesOlderThan)

Delete Studies Received Before(s)

string

Delete Studies from the Storage System configured for cache (dcmStorageDuration=CACHE) or temporary (dcmStorageDuration=TEMPORARY) storage, if they were received longer ago than the specified value in ISO-8601 period format. Format [nn”[“<schedule>”]”](PnYnMnD|PnW).

(dcmDeleteStudiesReceivedBefore)

Delete Studies Not Used Since(s)

string

Delete Studies from the Storage System configured for cache (dcmStorageDuration=CACHE) or temporary (dcmStorageDuration=TEMPORARY) storage, if they were last accessed longer ago than the specified value in ISO-8601 period format. Format [nn”[“<schedule>”]”](PnYnMnD|PnW).

(dcmDeleteStudiesNotUsedSince)

Deleter Threads

integer

Number of Threads used for deletion of objects from the Storage System.

(dcmDeleterThreads)

External Retrieve AETs(s)

string

Constrains deletion of Studies, additionally to configured deleter thresholds and/or deletion retention period constraints, from the Storage System to Studies which objects are retrievable using one of the AEs from an external C-MOVE SCP.

(dcmExternalRetrieveAET)

External Retrieve Instance Availability

string

Updates instance availability on deletion of studies for instances available on external retrieve archive.

Enumerated values:

ONLINE

NEARLINE

OFFLINE

(dcmExternalRetrieveInstanceAvailability)

Export Storage ID(s)

string

Constrains deletion of Studies, additionally to configured deleter thresholds and/or deletion retention period constraints, from the Storage System to Studies whose objects are also accessible from the specified other storages.

(dcmExportStorageID)

Retrieve Cache Storage ID

string

Specifies another Storage to which objects are copied in parallel on retrieve to increase the performance on accessing storage systems which provides more bandwidth using multiple connections in parallel.

(dcmRetrieveCacheStorageID)

No Retrieve Cache on Destination AE Title(s)

string

Specifies AE Titles of C-STORE SCPs to which objects are retrieved without copying them to a configured Retrieve Cache Storage.

(dcmNoRetrieveCacheOnDestinationAETitle)

No Retrieve Cache on Purged Instance Records

boolean

Indicates to NOT copy retrieved objects to a configured Retrieve Cache Storage, wherein corresponding Instance Records were already purged from the DB.

(dcmNoRetrieveCacheOnPurgedInstanceRecords)

Retrieve Cache Max Parallel

integer

Maximal number of parallel copies to cache storage on retrieve. Only effective if a Retrieve Cache Storage ID is configured.

(dcmRetrieveCacheMaxParallel)

Storage Property(s)

string

Specify storage properties in format {name}={value}. Refer various Storage Properties that can be configured based on the storage type.

(dcmProperty)