Introduction to the LRM File System

From Lingoport Wiki
Revision as of 13:27, 26 April 2016 by Llawson (talk | contribs)
Jump to: navigation, search

The major directories for LRM are as follow, if installed under the Jenkins user with default installation values:

  • LRM_HOME (~jenkins/lingoport/lrm-server-3.0/) is where the application's code resides
  • LRM_STREAMLINING (~jenkins/Lingoport_Data/L10nStreamlining/): <group_name>/projects/<project_name> are under LRM_STREAMLINING and
    • the configuration,
    • the prep kits sent to translation (for tracking purposes)
    • the prep kits received from translation reside there (for tracking purposes).
  • LRM_DATA_HOME (~jenkins/Lingoport_Data/LRM) holds temporary files to send files for translation, or receive them back; That's also where LRM reports are stashed.


LRM_STREAMLINING

LRM_STREAMLINING is typically set to ~jenkins/Lingoport_Data/L10nStreamlining/. Under LRM_STREAMLINING, <group_name>/projects/<project_name> contains those directories:


├── config
│   ├── config_email_recipients.xml
│   └── config_vcs.properties
├── context
├── failedkits
├── importkits
│   └── TRANSLATED_KIT_1
│       └── fr
│           ├── file_one_fr.properties
│           ├── file_three_fr.properties
│           └── file_two_fr.properties
├── logs
│   ├── error_import_kit.log
│   └── error_prep_kit.log
├── prepkits
│   └── PREP_KIT_1
│       ├── BaseFileSearch_fr.xml
│       ├── FilesToPrep.xml
│       ├── fr
│       │   ├── file_one_en.properties
│       │   ├── file_three_en.properties
│       │   └── file_two_en.properties
│       ├── <project_name>_1_fr.xml
│       ├── imported_lingotek_5f79e96c-cd3a-4b6e-bac5-9d37febc8f07_fr_fr.json
│       ├── IncompletePrepKit.xml
│       └── lingotek_5f79e96c-cd3a-4b6e-bac5-9d37febc8f07.json
└── reports
    └── notify-changes
  • config: This directory contains files to setup this project. See Project Configuration Files
  • context: Not used at this stage
  • failedkits: If failures occurred during importing translated files, the failed files are moved to that directory for troubleshooting purposes
  • importkits: Keeps the files successfully imported to the project's repository for tracking purposes.
  • logs: Contains the log files for this project
  • prepkits: Keeps the files successfully sent for translation for tracking purposes.

LRM_DATA_HOME

LRM_DATA_HOME is typically set to ~jenkins/Lingoport_Data/LRM. Two type of directories are located here, staging and LRM core command directories for each project.

staging

The staging directory is where files which are ready to be sent for translation or retrieved from translation transit. As soon as the prep kit is finished, the files are moved to the LRM_STREAMLINING directory. As soon as the downloaded files have been imported and pushed to the repository, the files are moved to the LRM_STREAMLINING directory.

The files to be sent to a translation end point are not dependent on the LRM core at that point. The files which must be downloaded from the translation application do not know anything about the LRM core either.

staging
├── downloads
│   └── lingotek
├── importkits
│   └── lingotek
│       ├── <group_name1>
│       │   └── <project_name1>
│       │   └── <project_name2>
│       ├── <group_name2>
│       │   └── <project_name3>
│       └── ...
├── sendkits
│   └── lingotek
│       ├── <group_name1>
│       │   └── <project_name1>
│       │   └── <project_name2>
│       ├── <group_name2>
│       │   └── <project_name3>
│               └── PREP_KIT_1
│                   ├── BaseFileSearch_fr.xml
│                   ├── FilesToPrep.xml
│                   ├── fr
│                   │   ├── file1_en.properties
│                   │   └── file2_en.properties
│                   ├── <project_name>_1_fr.xml
│                   └── IncompletePrepKit.xml
└── tmp_importkits
    └── lingotek

LRM_DATA_HOME project

LRM_DATA_HOME is typically set to ~jenkins/Lingoport_Data/LRM. Each group under LRM_DATA_HOME holds data for the core functionality of LRM. Here is a typical layout for the directory structure for one group, here just with one project:

<group1>
├── logs
│   └── lrmerror.log
├── prep_kit
│   └── <project1>
│       └── PREP_KIT_2
│           ├── FilesToPrep.xml
│           ├── OutstandingPrepFiles_de.xml
│           ├── OutstandingPrepFiles_es.xml
│           ├── OutstandingPrepFiles_fr.xml
│           ├── OutstandingPrepFiles_it.xml
│           ├── OutstandingPrepFiles_ja.xml
│           └── OutstandingPrepFiles_ru.xml
└── reports
    └── <project1>
        └── ProjectDefinition.xml