Skip to main content

Best Practices

Optimize your Scriptix workflow with these practices for file management, collaboration, and organization.

File Upload Best Practices​

File Preparation​

Supported Formats:

  • Audio: MP3, WAV, M4A, FLAC
  • Video: MP4, AVI, MOV, and other common formats
  • Maximum file size: 40GB

Naming Conventions:

Good: 2024-12-07_Client-Interview_John-Doe.mp3
Good: Podcast_Ep042_Guest-Name.wav
Bad: audio_final_FINAL_v3.mp3
Bad: recording123.mp3

Include in filename:

  • Date (YYYY-MM-DD format)
  • Project or client name
  • Episode number or identifier
  • Speaker name(s) if applicable

Upload Strategy​

For Large Files:

  • Scriptix uses TUS protocol for resumable uploads
  • Upload happens in 50MB chunks
  • Can resume if connection lost
  • Don't navigate away during upload

Batch Uploads:

  • Upload related files together
  • Use consistent naming
  • Organize in folders immediately
  • Easier to manage as a group

Transcription Settings​

Language Selection​

Choose Correct Language:

  • Select the language spoken in audio
  • Scriptix supports 37+ languages
  • Use appropriate language model for best results

Speaker Diarization​

Organization Default:

  • Set default diarization in Profile → Organization Details
  • Checkbox: "Separate speakers"
  • Can override per upload

When to Enable:

  • Multiple speakers (interviews, meetings, podcasts)
  • Clear, distinct voices
  • Speakers don't overlap significantly

When to Disable:

  • Single speaker (monologue, presentation)
  • Similar-sounding voices
  • Heavy cross-talk

Using Glossaries​

Glossaries are translation term pairs, not transcription aids.

Create Glossaries For Translation:

  • Industry-specific terminology translations
  • Company/product name translations
  • Technical term translations
  • Proper noun translations

Glossary Structure:

  • Source language term
  • Target language term
  • Used by DeepL or Google translation services

See Create Glossary for details.

Editing Workflow​

Keyboard Shortcuts​

Scriptix supports custom keyboard shortcuts for the transcript editor.

Configure Shortcuts:

  1. Navigate to Profile → Keymap Settings
  2. Click "Add Keymap"
  3. Record key combination (up to 3 keys)
  4. Enter function value
  5. Save shortcut

Key Combination Examples:

  • Single key: f
  • Modifier + Key: Ctrl + f
  • Multiple modifiers: Ctrl + Shift + f
  • Maximum 3 keys supported

See User Preferences for details.

Search in Transcript​

Use browser's find function (Ctrl+F / Cmd+F) to search transcript content in the editor.

Speaker Management​

Speaker identification available when diarization is enabled:

  • Speakers labeled automatically
  • Can edit speaker labels
  • Assign names to speakers

Caption Creation​

Caption Formats​

Scriptix supports these caption export formats:

  • SBV (YouTube)
  • SRT (SubRip)
  • TTML (Timed Text Markup Language)
  • VTT (WebVTT)
  • Media (platform-specific)
  • STL (Spruce Subtitle File)
  • HTML

Caption Styling​

Available Styles:

  • Bold (B)
  • Italic (I)
  • Underline (U)
  • Strikethrough (S)

Colors:

  • White (default)
  • Yellow
  • Green

Position:

  • Top Left
  • Top Center
  • Bottom Left
  • Bottom Center

See Caption Styling for details.

Collaboration Best Practices​

User Roles​

Scriptix has 8 user roles:

  • SYSOP - System operator (back-office)
  • ORGADMIN - Organization administrator
  • CONTRIBUTOR - Content creators/editors
  • CUSTOMER - Basic customer access
  • DEVELOPER - API access
  • RESELLER - Reseller with customer management
  • RESELLEE - Reseller's customer
  • TESTER - Testing access

Role Assignment:

  • Limit ORGADMIN to trusted users
  • Use CONTRIBUTOR for daily work
  • Use CUSTOMER for clients/stakeholders
  • Use DEVELOPER only for technical team

See Roles & Permissions for details.

Folder Organization​

Folder Structure:

  • Create folders to organize documents
  • Use descriptive folder names
  • Organize by project, client, or date
  • Set folder permissions for teams

Folder Permissions:

  • NO_ACCESS (0) - Cannot view folder
  • READ (1) - Can view documents
  • WRITE (2) - Can edit documents

See Folders for details.

Document Sharing​

Magic Link Sharing:

  • Share documents via magic link
  • Set email for recipient
  • Email message limited to 500 characters
  • Link provides access without account

Sharing Options:

  • Share with specific email address
  • Recipient gets link via email
  • No Scriptix account required for recipient

See Share Documents for details.

API Best Practices​

Authentication​

API Key Security:

  • Never commit keys to version control
  • Use environment variables
  • Rotate keys periodically
  • Use separate keys for dev/prod
  • Revoke unused keys immediately

API Key Types:

  • Batch - Store data then process it
  • Realtime - Process data as it comes

Key Management:

  • Create keys in API Keys page
  • Select expiration: 1, 2, or 5 years (1 year recommended)
  • Copy token immediately (only shown once)
  • Delete requires ADMIN or DEVELOPER role

See API Keys for details.

Authentication Header​

API Token Usage:

Authorization: Bearer YOUR_TOKEN_HERE

Include in all API requests for authentication.

Performance Optimization​

File Size Limits​

Maximum File Size:

  • 40GB per file (defined in app constants)
  • No documented maximum number of files

Upload Method:

  • TUS protocol for resumable uploads
  • 50MB chunks
  • Automatic resume on connection loss

Browser Performance​

Recommended:

  • Use modern browsers (Chrome, Firefox, Safari, Edge)
  • Close unnecessary browser tabs
  • Clear cache periodically
  • Update browser regularly

Supported Languages: Interface available in:

  • English (en)
  • Dutch (nl)
  • French (fr)
  • German (de)

Data Management​

Workspace Organization​

Document Management:

  • Pin important documents
  • Use status filters (Draft, In Progress, Complete)
  • Filter by language
  • Search by document name
  • Sort by name, status, language, last modified

Batch Operations:

  • Delete multiple documents
  • Move multiple documents to folder
  • Merge 2-10 documents (same type required)

See Workspace Overview for details.

Export Templates​

Create Export Templates:

  • DOCX templates for formatting
  • PDF examples for reference
  • AI summarization prompts
  • Organization-wide templates

Template Management:

  1. Navigate to Profile → Account Personalization
  2. Add template with name and type
  3. Upload DOCX and PDF files (for EXPORT_TEMPLATE)
  4. Or create with summarization prompt (for SUMMARIZATION)
  5. Download or delete templates as needed

See User Preferences for details.

Security Best Practices​

Access Control​

User Management:

  • Create users in Users page
  • Edit user details
  • Send reactivation links
  • Delete users when no longer needed

User Status:

  • Active - Can access system
  • Inactive - Cannot access

See Manage Users for details.

Two-Factor Authentication (2FA)​

Enable 2FA:

  1. Navigate to Profile → Security Settings
  2. Click "Activate 2FA"
  3. Scan QR code with authenticator app
  4. Enter verification code
  5. Download backup codes

Backup Codes:

  • Save backup codes immediately
  • Use if authenticator app unavailable
  • Each code usable once only

Deactivate 2FA:

  • Enter 2FA code or backup code
  • Confirms identity before disabling

See Profile Settings for details.

Document Security​

Organization Settings:

  • Allow magic link export (checkbox in organization settings)
  • Controls whether members can export via magic links
  • Organization-wide setting

Teams Organization​

Team Management​

Create Teams:

  1. Navigate to Teams page
  2. Click "New Team"
  3. Enter team name and description
  4. Teams help organize users

Team Operations:

  • Edit team name and description
  • Delete teams when no longer needed
  • View all teams in data grid

See Team Management for details.

Subscription Management​

Monitor Usage​

Usage Tracking:

  • View subscription details
  • Check available units:
    • Speech-to-Text (STT) units
    • Alignment units
    • Translation budget
  • Review usage by billing period
  • Historical usage data in table

Usage Metrics:

  • STT Units Used
  • Alignment Units Used
  • Translation Characters Used
  • Custom Models Trained
  • Custom Models Hosted
  • Billed status per period

See Usage & Limits for details.

Subscription Plans​

Four Plan Tiers:

  • Bronze (Starter): €119/month - 3 seats, batch STT, UI & API
  • Silver (Professional): €479/month - 10 seats, batch & realtime, translation
  • Gold (Business): €1,199/month - Unlimited seats, all features, custom models
  • Platinum (Enterprise): €10,000/month - Custom, local deployment, dedicated features

See Billing & Subscription for details.

Organization Settings​

Branding (Resellers Only)​

Custom Branding:

  • Upload organization logo
  • Set brand color
  • Logo appears in navigation
  • Brand color applied to UI

Logo Upload:

  • Any image format accepted
  • Uploads immediately on selection
  • Delete logo option available

Brand Color:

  • BlockPicker color selector
  • Automatically adjusted for visibility
  • Clear color option available

See Organization Settings for details.

Default Settings​

Organization Defaults:

  • Diarization default (separate speakers checkbox)
  • Magic link export permission (allow/disallow)

These apply to all organization members.

Custom Models​

Model Management​

Create Custom Models:

  • Name and language selection
  • Train with datasets (1-10 files, 10GB each)
  • Supported formats:
    • Audio: .wav, .mp3, .m4a, .flac
    • Transcripts: .vtt, .srt, .txt
    • Manifest: .jsonl

Training Status:

  • 5 statuses tracked
  • Train button available for status 1 (Not Running) or 5 (Failed)
  • Delete restricted to ORGADMIN and SYSOP roles

See Custom Models documentation for details.

Data Retention​

Document Storage:

  • Documents stored in workspace
  • Organize with folders
  • Use batch delete to remove multiple documents
  • Move documents to folders for organization

Auto-Save:

  • Editors auto-save to localStorage
  • Transcript storage utility
  • Caption storage utility

Common Practices​

Consistent Naming​

Document Names:

  • Use clear, descriptive names
  • Include dates in format YYYY-MM-DD
  • Include project or client identifier
  • Avoid abbreviations

Folder Names:

  • Descriptive of contents
  • Organized by project, client, or date
  • Easy to understand for team

Regular Maintenance​

Workspace Cleanup:

  • Delete test files regularly
  • Archive completed projects
  • Organize with folders
  • Use batch operations for efficiency

User Management:

  • Review user access periodically
  • Remove inactive users
  • Update user roles as needed
  • Send reactivation links when needed

Team Management:

  • Update team descriptions
  • Remove obsolete teams
  • Keep team structure current

Access Reviews​

Quarterly Review:

  • Check user list and roles
  • Verify folder permissions
  • Review shared documents
  • Update team organization

Optimize your workflow! Follow these practices for efficient Scriptix usage.

Next Steps​