TMS, File Workflow & Deliverables

Business perspective: TMS, File Workflow & Deliverables

1. Business Summary

Manages source/in/out folders, phase splitting and merging, pre-translation, deliverables packaging, and ownCloud-backed file cache integration.

2. Business Value

Backbone of the production workflow — file integrity from client to vendor and back.

3. Users / Stakeholders

PMs, engineers, linguists, reviewers, clients.

4. Workflows

  • Phase setup: addPhaseManuallyForm() / processAddPhaseManually(); phases hold parent relationships.
  • File ingest: uploadFilesInFolder, tms_upload_file, tms_attach_files.
  • Task assignment to files: task_assigned() orchestrates resource selection, validation, TMS sync flag, push notifications.
  • Splitting/merging: splitUncompletedSegments, processSplitFiles.
  • Pre-translation: TMS-side pre-translation requested.
  • Deliverables: generateDeliverables, memSource_Deliverables.
  • Cleanup: deleteParentFolderFromOCFileCacheWhenEmpty.

5. Sub-Features

  • Phase management.
  • ownCloud cache synchronization.
  • Memsource integration.
  • Folder/zip operations via Cloud controller.

6. Business Rules

  • File path conventions: /data/admin/files/Jobs/Job_{id}/Source and similar IN/OUT folders.
  • Memsource flow includes 120-second sleep.
  • Uncompleted segments split for parallel work.

7. Data Entities

Phase, JobAutoPlanFile, OcFilecache, OcFscache, OcMimetype, OcShare, File, EntityFile.

8. Entry Points

  • tms/* actions.
  • cloud/* for low-level cloud ops.
  • mobile_apis/uploadFiles, downloadAttachment, downloadAllTaskFilesAsZip.

9. Inputs & Outputs

  • Inputs: source files (uploaded or from path), TMS responses.
  • Outputs: phase-aware file structure, deliverables, downloads.

10. Integrations

  • Memsource (TMS).
  • ownCloud (file cache).
  • Welocalize / Junction / Moravia for source ingest.

11. Calculations / Logic

  • Weighted-word analysis from TMS feeds pricing.

12. Status Lifecycle

  • File phase progression: source → in → out → deliverable.

13. Permissions

  • PM, engineer, vendor (per task).

14. Reports & KPIs

  • Files per job, deliverables, cache health.

15. Risks & Observations

  • Sleep(120) blocks request thread.
  • File-cache ↔ filesystem drift risk.
  • Hard-coded paths in code.

16. Source Code Evidence

  • app/Controller/TmsController.php (~5,746 LOC).
  • app/Controller/CloudController.php :: get_base_path, ownclod_unzip, build_files_relations.
  • app/Model/OcFilecache.php, OcFscache.php, OcMimetype.php, OcShare.php.

← Deep dives index