4. Configuration


All the configuration files and plugins can be found in installation_directory\etc\, e.g. "C:\UPDE\etc".

All the configuration files of UPDE are yaml files. Yaml stands for Yet Another Marshalling Language. Marshalling is a way of storing objects to a file. Yaml allows Ruby to store its objects in text files, thus making it possible to read and edit them with a "basic" editor like notepad or SciTe.

Be aware that the order of the lines is not important and that the items will not always be displayed in the same order. The reason why the order of lines ins't fixed is because the stored objects are all hashtables. A hashtable is an unsorted list of items, each item being a key-value pair. It can be compared to a primitive database.


4.1. General configuration: config.yaml

editable with UPDEg.

---
uidRoot: 1.2.826.0.1.3680043.2.1299.1000.1000.
patientsPerFile: one
daysToKeep: "1"
forcedModalities: CR, US
datafileExtension: .txt
dcmLogMode: "0"
port: "1024"
aet: MWMSCP
scanInterval: "3"
datafileInPad: C:/FujiTools/UPDE/ris/in
risParser: type5

---

do not change this line

aet:

application entity title of the DICOM Modality Worklistserver (wlmscpfs)
the default value is MWMSCP the aet also corresponds to a directory in "installation_directory\ris\aet", e.g. "C:\UPDE\ris\MWMSCP

datafileExtension:

type of extension corresponding to the files generated by the RIS
if the name of the file is always the same, you can use the full name of the file, e.g. RIS.txt
if a part of the name is constant use a * to indicate the variable part, e.g. RIS*.txt
if the extension is unknown or if the directory is reserved for patient information files only, use *.*

datafileInPad:

path to the directory where the ris will send/store the files with the patient information
avoid whitespace characters in the path's value, e.g. "C:\Documents and Settings\willem\My Documents" is not allowed while "C:\UPDE\ris\in" is good

daysToKeep:

number of days that the converted files should be kept before deletion. parseRis will remove the old files each day between 12:00 and 12:15

dcmLogMode:

0, no logging
1, view the log in a command-line terminal
2, basic logging
3, extended logging
the log files will be created as "installation_directory\log\logYYYYMMDDHHMMSS.txt"

forcedModalities:

comma separated list of modalities
possible modalities are AS, BI, CD, CF, CP, CR, CT, DF, DG, DM, DS, EC, ES, FA, FS, LP, LS, MA, MR, MS, NM, OT, PT, RF, RG, ST, TG, US, VF, XRF
the values for forcedModalities will be used if the RIS doesn't send a value for the type of modality, a file will be generated for each modality and each file will have its own study uid

patientsPerFile:

one, if the file sent by RIS contains only information about one patient, and the information is spread over several lines
more, if the RIS sends files containing information about 1 or more patients, with all the information for each patient written on a single line

port:

TCP/IP port used for the DICOM connections, 1024 by default

risParser:

typen, where n is a number
the possible types correspond the the typen subdirectories located in "installation_directory\etc
the directories contain a file named "example.txt", this is an example of a file as sent by the RIS
it is possible to create new types see "Plugins for parseRis: type_n" for additional information

scanInterval:

delay in seconds between each cycle of parseRis

uidRoot:

value built of 1.2.826.0.1.3680043.2.1299. + zipcode + customer number, this value has to be unique for each customer
the uidRoot is used to generate a study uid if this item is not sent by RIS.


Normally, it is also possible to use hostnames. The only condition for this to work is that the PC from which the database query is emitted, is familiar with the hostname which will receive the query.

This configuration file is limited to the Database Listing tool in UPDEg. This tool can only be used with Fujifilm Medical Systems CR Console.


4.2. Default scheduled modalities: modAet.yaml

editable with UPDEg.

---
CR: "CRURG"
CT: ""
MG: ""
MR: ""
OT: ""
US: "ECHO1"

---

do not change this line

Each line has the following structure:

(type of modality)(:)(space)(aet that will be used by default or "" if no default aet needs to be specified)

The settings in modAet.yaml will only been used if the RIS doesn't send data that will be used to set the scheduled aet. If no value is needed just leave the setting blank.


4.3. Plugins for parseRis: type_n

NOT editable with UPDEg.

The plugins used by parseRis correspond to the layout used by the RIS. All plugins are a folder in installation_directory\etc\, e.g. "C:\UPDE\etc". The name of the plugin has to be type followed by a number. The contents of these directories is: