Changes between Version 1 and Version 2 of net.sf.basedb.reggie/notes46


Ignore:
Timestamp:
Jul 29, 2016, 4:24:25 PM (4 years ago)
Author:
olle
Comment:

Added information on referral form generation in Reggie 4.6

Legend:

Unmodified
Added
Removed
Modified
  • net.sf.basedb.reggie/notes46

    v1 v2  
    1818The delivery client login page is available at the location `<root>/extensions/reggie.jar/delivery/index.jsp`, where `<root>` is the regular BASE web client login. For example: `https://base.server.domain/base/extensions/reggie.jar/delivery/index.jsp`.
    1919
     20== 3. Adding referral form template info for referral form generation ==
     21
     22The referral form generation uses template PDF files for creating the forms. A template contains all information except SCAN-B ID text and barcodes, which are added, when the complete form is generated. In order for the patient curator to be able to replace templates with new versions, the template files are placed in the BASE file system. Also, in order to support variations in the text and layout of templates for different sites (other than the SCAN-B text and barcodes), templates for different sites are placed in separate sub-directories:
     23 * The template top directory is `/home/SCANB/ReferralFormTemplatesInUse/`.
     24 * Each site has a sub-directory named after the site's SCAN-B prefix. e.g. `/home/SCANB/ReferralFormTemplatesInUse/88/` for Uppsala with prefix "`88`".
     25
     26The application identifies a template's type based on the start of its filename:
     27 * For a template file to be used, the filename must begin with a string defined for its referral form type in `reggie-config.xml`, tag `referral-form-generation`, sub-tag `template-filename-start`.
     28 * A start string should be unique and not be a sub-string of another start string.
     29 * A start string should not include version information, and normally not site-specific information.
     30 * A form template filename, however, is recommended to contain version information in part of the filename following the start string, since the complete filenames of used templates for a referral form generation session are included in an entry in the referral form generation log file.
     31 * When generating referral forms for a site, the application looks for templates of all type of forms. If no template file with a valid filename is found for a specific form type and site, that form type is skipped in the output.
     32
     33=== 3.1. Update `reggie-config.xml` with start of referral form template filenames for different form types ===
     34
     35In `reggie-config.xml`, tag `referral-form-generation`, sub-tag `template-filename-start`, add start of template filenames for the following tags:
     36
     37|| '''Form type XML Tag''' || '''Example of start of template filenames''' ||
     38|| `<patient-info>` || `Patinfo` ||
     39|| `<clinical-chemistry-biopsy>` || `KlinKemBiopsy-SCAN-B-remiss` ||
     40|| `<clinical-chemistry-blood>` || `KlinKem-SCAN-B-blood-biobanken_remiss` ||
     41|| `<clinical-chemistry-blood-lundcopy>` || `KlinKem-SCAN-B-blood-biobanken-lundkopia_remiss` ||
     42|| `<clinical-chemistry-bcblood>` || `KlinKem-SCAN-B-bcblood-remiss` ||
     43|| `<clinical-chemistry>` || `Klinkem-SCAN-B-remiss` ||
     44|| `<clinical-pathology>` || `Path-SCAN-B-remiss` ||
     45|| `<consent-report>` || `Consent-SCAN-B-remiss` ||
     46
     47As an example, the patient info form template may have the full filename "`Patinfo_3_0_120109_SCAN-B.pdf`", and the clinical pathology form template the full filename "`Path-SCAN-B-remiss_v7.pdf`".
     48
     49=== 3.2. Copy referral form template files to use to sub-directory for each site  ===
     50For all form types supported for a site, copy the corresponding form template PDF file to the sub-directory for the site. For the first release, the following table may be of help:
     51
     52|| '''Form type XML''' || '''Supported by site[s]''' ||
     53|| patient-info || All ||
     54|| clinical-chemistry-biopsy || All ||
     55|| clinical-chemistry-blood || Uppsala (88) only ||
     56|| clinical-chemistry-blood-lundcopy || Uppsala (88) only ||
     57|| clinical-chemistry-bcblood || Lund (11) only ||
     58|| clinical-chemistry || All except Uppsala (88) ||
     59|| clinical-pathology || All ||
     60|| consent-report || All ||