Software Specification

BilderArchivieren (ArchiveImages)

insite GmbH

Introduction#

The Archive Images program is used to move images (e.g. from V60) to an archive server. In the course of this, all special characters are also replaced by permitted characters (see Appendix C).

Interface#

BilderArchivieren_Interface.png

  1. Starts the monitoring (Auto archiving) (see Functional description)
  2. Stops all actions
  3. Starts the archiving (when all images have been archived, this function is terminated)
  4. Displays the current program status (see Status display)
  5. Displays the number of locally stored files
  6. Displays the progress when moving the files
  7. Log output

Status display##

BilderArchivieren_Status_notrunning.png No action is running. (Program is in stop mode)

BilderArchivieren_Status_active_a.png Auto archiving is active

BilderArchivieren_Status_active_m.png Manual archiving is active

Functional description#

The V60 program saves the evaluated images locally in a directory.

The ArchiveImages program is informed via FileSystemEvents when a file has been created or deleted using a filter that must be set (e.g. *.jpg). Once the set bulk number of the files has been reached, this bulk is moved to the Archive Server. The directory structure of the Archive Server can be defined by means of format options in the configuration file.

From version 1.0.0.8 it is now possible to also specify multiple sources. The number of files of the source can then be calculated from the total files in all sources.

Configuration file#

Path##

The path for the configuration files is searched in the following order:

  1. HKEY_CURRENT_USER\Software\Insite Gmbh\BilderArchivieren (Character string: config)
  2. HKEY_LOCAL_MACHINE\Software\Insite Gmbh\BilderArchivieren (Character string: config)
  3. Start path + \BilderArchivieren.xml

If the file is not found in any of the defined paths, the application is terminated.

Settings in the configuration file (XML format)##

<?xml version="1.0"?>
<!-- Konfigurations-Datei fuer BilderArchivieren. -->
<config name="BilderArchivieren">
  <settings>
    <common autoscan="true" autoscroll="true" maxlogrows="1000" 
            copyerrorrecalltime="60000" bulk="10" maxwaittimeforbulk="360000"/>
    <performance bulk="0" processpriority="belownormal" sleeptimeinms="1000"
                 maxcpuusageinpercent="20" optimizememusage="false"/>
    <filter extensions="*.jpg" converttojpeg="false" deleteafterconvert="false"
            quality="30"/>
    <source path="G:\V60_Bilder_Puffer"/>
    <dest path="N:\Bilder\Band7" format="\%HOSTNAME~3,6%\%FT=yyyy%\%FT=MM%\%FT=dd%" 
          adoptSubFolders="false"/>
    <log path="BilderArchivieren.log" daystokeeplog="1" bulk="20"/>
  </settings>
</config>

common###

autoscan:

Data type BOOL
Description Specifies whether the monitoring should be activated
immediately at the start of the program.
Default value false

autoscroll:

Data type BOOL
Description Specifies whether the current entry should always be scrolled
to in the Log window.
Default value true

maxlogrows:

Data type INTEGER
Description Specifies the number of log files kept in the Log window.
Default value 1000

copyerrorrecalltime:

Data type INTEGER
Description Specifies the waiting time in milliseconds until a copy
attempt should be restarted.
Default value 60000

bulk:

Data type INTEGER
Description Specifies the number of files the archiving procedure is
started from.
Default value 10

maxwaittimeforbulk:

Data type INTEGER
Description Specifies the maximum waiting time that the program waits
until the buffer is full. If the time elapses before the buffer is
full, the files currently available are moved. If the value 0 is
used, this waiting time is deactivated and the files are then
first moved once the buffer is full.
Default value 0

performance###

processpriority:

Data type STRING
Description Specifies the process priority that the program should have
(for adjustable values see Appendix A).
Default value NORMAL

bulk:

Data type INTEGER
Description Specifies the maximum number of files moved without pause.
(only active if a value > 0 is in sleeptimeinms)
Default value 10

sleeptimems:

Data type INTEGER
Description Specifies the waiting time in milliseconds until the next bulk
should be copied. (only active if a value > 0 is in bulk).
Default value 1000

maxcpuusageinpercent:

Data type INTEGER
Description Specifies the maximum CPU load in percent. If this is
exceeded, a pause occurs
(only active if a value > 0 is in sleeptimeinms)
Default value 30

optimizecpuusage:

Data type BOOL
Description Specifies whether the memory manages itself or is managed
by the .Net Framework. (If it manages itself, the work involved
for the CPU is greater, since the memory must also be released
after each archiving procedure. If the Framework performs the
management, the memory is then released when needed.)
Default value FALSE

optimizeforoverwrite:

Data type BOOL
Description Specifies whether or not most of the files that are moved
already exist at the target location. (in the case of backups
that should be stored in the same path, the option should
be set to TRUE)
Default value FALSE

filter###

extension:

Data type STRING
Description Specifies the filter for the files to be monitored and copied.
Default value NORMAL

converttojpg:

Data type BOOL
Description If the filter value is != jpg, the image is converted to
jpg format and then moved.
Default value FALSE

deleteafterconvert:

Data type BOOL
Description If this value is True, the originals of the moved files are
deleted. (only active if converttojpg is TRUE)
Default value FALSE

quality:

Data type INTEGER
Description Quality of the jpg in percent
Default value 30

source###

dest###

log###

Appendix A#

Appendix B#

Appendix C#

Document History#