The `.tx1` Package Format
.tx1 is the proprietary TX1 project package. It is the preferred format for sharing projects between TX1 users because it:
- Is compressed (smaller than JSON for the same project).
- Can be password-protected.
- Embeds images, documents and metadata together.
- Validates checksum on import.
Exporting
Project → Export → .tx1 Package.
Service: ExportProjectToTx1FileAsync(projectId, path, options).
Options mirror the JSON export (what to include) plus:
Password— optional; enables AES encryption.Author— stored in metadata.ExportedAt— auto-timestamped.Description— shown to the recipient when they preview.
Importing
- Project → Import →
.tx1Package. - Select the file.
- If password-protected, enter the password.
- Preview — shows metadata, counts, resource conflicts.
- Apply.
Service: ImportProjectFromTx1FileAsync(path, password, options, progress).
Preview and Validate
ValidateTx1FileAsync(path, password)— confirms file integrity and password.GetTx1MetadataAsync(path, password)— returnsTx1Metadata(project name, author, date, item counts, version).CheckTx1ResourceConflictsAsync(path, password, projectId)— checks which resources already exist.
Run all three before importing into a critical environment.
Resource Conflict Resolution
Same options as JSON import:
- Skip — don't create resources already in the target.
- Rename — create with a suffix.
- Overwrite — replace existing data. Warning.
- Fail — cancel import on any conflict.
Password Protection
AES-256 with the password-derived key. Without the password, the file cannot be opened even by other TX1 installations. Pick a strong passphrase; there is no recovery.
Use Cases
| Scenario | Why .tx1 |
|---|---|
| Sending a tender to another TX1-using company | Compressed, password-protected, single file. |
| Archiving a completed project | Smaller than the live database. |
| Moving projects between installations | Atomic, round-trippable. |
| Sharing a template-like example project | Recipient can open, study, and tweak. |
Limitations
.tx1files are TX1-only. Recipients without the software can't open them — send PDF or Excel for non-users.- Images and documents are embedded; large projects produce large files despite compression.