Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Check File Status Service.

Dependencies

Attributes

...

#MonitoredFileSystem
Anchor
MonitoredFileSystem
MonitoredFileSystem

Directory/Mount Point of the monitored File System.
NONE = disabled this service.

...

Default Value: NONE

#HSMModulServicename
Anchor
HSMModulServicename
HSMModulServicename

HSM Module to query status of files on HSM systems.

Default Value: dcm4chee.archive:service=FileCopyHSMModule,type=Command

#MinimumFileAge
Anchor
MinimumFileAge
MinimumFileAge

Only files created longer ago than the specified intervall ##w (in weeks), ##d (in days), ##h (in hours) are checked for status change.

Default Value: 1w

...

#CheckFileStatus
Anchor
CheckFileStatus
CheckFileStatus

Checks files with the specified status for status change.
Enumerated values: DEFAULT, TO_ARCHIVE, ARCHIVED, QUERY_HSM_FAILED

...

Default Value: TO_ARCHIVE

#VerifyTar
Anchor
VerifyTar

...

New file status, if the query command could not be executed.
Enumerated values: DEFAULT, TO_ARCHIVE, ARCHIVED, QUERY_HSM_FAILED

...

VerifyTar

Enables verification of tar files.
If enabled the tar file is verified by
1) checking MD5 sums of the tar content.
2) check if tar file contains the file.
Only applicable if filesystem is a tar filesystem!

Default Value: true

#InvalidTarStatus
Anchor
InvalidTarStatus
InvalidTarStatus

New file status or DELETE if verification of tar failed.
Enumerated values: DELETE or DEFAULT, TO_ARCHIVE, ARCHIVED, QUERY_HSM_FAILED, MD5_CHECK_FAILED

...

New file status, if the query result does NOT match specified pattern.
Enumerated values: DEFAULT, TO_ARCHIVE, ARCHIVED, QUERY_HSM_FAILED

...

New file status, if the query result does match specified pattern DELETE..Delete all file entities related to this invalid tar file.
Only applicable if VerifyTar is enabled.

Default Value: DEFAULT

#NotInTarStatus
Anchor
NotInTarStatus
NotInTarStatus

New file status or DELETE if file is not found in related tar file.
Enumerated values: DELETE or DEFAULT, TO_ARCHIVE, ARCHIVED, QUERY_HSM_FAILED

...

Command to query status of specific file.

  • %d will be replaced by file system name (directory path/mount point),
  • %f will be replaced by the file path,
  • %i will be replaced by user info associated with the file system.

...

Regular expression, applied to stdout of command. Result determines if status is changed to MatchFileStatus or NoMatchFileStatus.

...

DELETE..Delete such invalid file entities. Only applicable if VerifyTar is enabled.

Default Value: DEFAULT

#TaskInterval
Anchor
TaskInterval
TaskInterval

Interval in which the File status is checked.
Format: <interval>'!'<from>'-'<to> | 'NEVER'
<interval> = ##m (in minutes) | ##h (in hours).
<from> = start hour (0-23) when no file status check should be performed
<to> = end hour (0-23) when no file status check should be performed
NEVER = disable file status checking
Example e.g.: 1h!9-17
= > Synchronize file status every hour, except between the hours of 9:00am and 5:00pm.
By setting this type of TaskInterval, you can perform file status synchronisation outside of peak hours.

...

.

Default Value: NEVER

#OldestCreatedTimeOfCheckFileStatus (read-only)
Anchor
OldestCreatedTimeOfCheckFileStatus
OldestCreatedTimeOfCheckFileStatus

Creation Date of oldest file on configured filesystem with file status of configured CheckFileStatus.

#NumberOfFilesPerTask
Anchor
NumberOfFilesPerTask
NumberOfFilesPerTask

Maximum number of files which are checked for status change in one task.

Default Value: 1000

#isRunning
Anchor
isRunning
isRunning

Current state if syncFileStatus task is running. Used to avoid concurrency!

#TimerIDCheckSyncFileStatus
Anchor
TimerIDCheckSyncFileStatus
TimerIDCheckSyncFileStatus

The timer ID for scheduler of checking file synchronization status.

Default Value: CheckSyncFileStatus

#TarRetrieverName
Anchor
TarRetrieverName
TarRetrieverName

Used internally. Do NOT modify.

Default Value: dcm4chee.archive:service=TarRetriever

...

#SchedulerServiceName
Anchor
SchedulerServiceName
SchedulerServiceName

Used internally. Do NOT modify.

Default Value: dcm4chee.archive:service=Scheduler

...

#Name
Anchor
Name
Name

The class name of the MBean

...

#State
Anchor
State
State

The status of the MBean

...

#StateString
Anchor
StateString
StateString

The status of the MBean in text form

Operations

...

#create
Anchor
create
create

Standard MBean lifecycle method

...

#start
Anchor
start
start

The start lifecycle operation

...

#stop
Anchor
stop
stop

The stop lifecycle operation

...

#destroy
Anchor
destroy
destroy

The destroy lifecycle operation

...

#jbossInternalLifecycle
Anchor
jbossInternalLifecycle
jbossInternalLifecycle

The detyped lifecycle operation (for internal use only)

...

#check
Anchor
check
check

Check files for status changes.

#updateOldestCreatedTimeOfCheckFileStatus
Anchor
updateOldestCreatedTimeOfCheckFileStatus
updateOldestCreatedTimeOfCheckFileStatus

Update OldestCreatedTimeOfCheckFileStatus. This will be done automatically every day after midnight if this service is enabled.

#syncArchivedStatusOfInstances
Anchor
syncArchivedStatusOfInstances
syncArchivedStatusOfInstances

Set ARCHIVED flag of Instances where files on given file system has file_status=2 (ARCHIVED).
This can be used to update instances that are already copied with a version prior to 2.16.0.

Notifications