Skip to main content

Automatic File Synchronization

Maintain harmony between your manually edited files and JCB’s blueprint structure

What It Does

JCB's automatic file sync system tracks files linked to templates, layouts, snippets, and other entities. When you:

  • Edit a file manually (e.g., in your IDE)
  • Recompile the component
  • Import blueprints from a versioned repo

…JCB checks the latest state of those files and reflects the changes in its internal blueprint database. This ensures your GUI-linked assets remain in sync with their actual file counterparts.


Works With

  • Layouts (PHP template renderers)
  • Snippets (HTML or PHP fragments)
  • Templates (View or Page-level templates)
  • Custom Code Entities
  • JavaScript & CSS libraries
  • Documentation & README assets

How It Helps

  • Avoids accidental overwrite of custom file edits
  • Keeps GUI and filesystem in sync
  • Provides a consistent source of truth across teams
  • Makes Git-based workflows safe and predictable

Use Case Examples

  • You edit a layout file directly in your IDE. On next compile, JCB picks up your changes and syncs the layout blueprint.
  • You rename a snippet file in the filesystem — JCB detects the difference and updates the blueprint path.
  • You push changes from Git that modify template content — JCB recognizes these changes during the next build.

Sync Settings

You can control:

  • When sync occurs (compile time, reset, etc.)
  • Whether JCB updates the blueprint automatically or prompts
  • Conflict resolution behavior for modified vs stored files

Important Notes

  • All file sync is version-safe — your edits are never overwritten without notice
  • You can manually trigger a re-import from the file system via the entity editor

Conclusion

Automatic File Synchronization bridges the gap between GUI-driven configuration and hands-on file editing. Whether you collaborate via Git, tweak layouts manually, or just want confidence in consistent output — JCB's sync system ensures every blueprint and every file stays in lockstep.