# Sync Bridge for Jira Cloud

> Sync Bridge is an Atlassian Forge app that keeps work items in two Jira Cloud sites in sync: fields, status, comments and attachments. Admins create a connector to the other Jira Cloud site and sync rules that define which work items sync, in which direction (Push only, Pull only, Both directions), and how fields and statuses map. Version 1.0 supports Jira Cloud ↔ Jira Cloud only.

Terminology: "work item" (Jira issue), "work type" (issue type), "space" (Jira project), "This Jira site" (the site where Sync Bridge is installed), "connector" (saved connection to the other Jira Cloud site), "sync rule" (what to sync and how).

## Start here

- [Overview](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666070017): what Sync Bridge syncs, key concepts, how push and pull work
- [Installation Guide](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666102786): requirements, install from Marketplace, permissions
- [Getting Started](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2665971716): first sync end to end

## Administrator Guide

- [Administrator Guide](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2665938954): overview of the admin page
- [Dashboard](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2665676820): sync health at a glance
- [Connectors](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666168337): connect and test the other Jira Cloud site
- [Sync Rules](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666201089): what a sync rule is, the rule list
- [Create a Sync Rule](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666070050): every step of the sync rule editor
- [Field Mapping](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666332177): map fields, directions, transform types
- [Smart Values and Transformations](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2665906205): smart value syntax and full function catalog
- [Status Mapping](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666037266): map statuses through workflow transitions
- [Comments Sync](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2665971764): comment events and filters
- [Attachments Sync](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666168353): attachment events, filters, limits
- [Duplicate, Import and Export Sync Rules](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666070066): copy rules within and between sites
- [Settings Locked After Work Items Are Synced](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2665938986): which settings can't change once a rule has synced
- [Sync Rule Reference](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666299425): every sync rule option with allowed values and defaults, plus the export/import JSON structure
- [Permissions and Per-Work-Item Sync Control](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666299393): who can configure, view and turn sync on or off
- [Sync History](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666332161): admin view of all sync activity and retention
- [Search Synced Work Items with JQL](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666332209): JQL fields for sync status, linked keys and rules

## User Guide

- [User Guide](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666135553): what users see on a work item
- [Sync Bridge panel](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666070034): sync status, linked work items, manual sync
- [Sync History tab](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666233857): per-work-item sync log
- [Turn Sync On or Off for a Work Item](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2665971748): pause or resume sync for one work item

## API

- [API Guide](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666168321): overview for integrators
- [API Tokens](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2665676836): create and revoke tokens
- [Sync Trigger API](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2665938970): endpoint, authentication, request and response, examples

## Use cases

- [Sync With a Customer's Jira Site](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2665676852)
- [Sync Two Internal Jira Sites](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666299409)

## Optional

- [Troubleshooting](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666037250): find and fix sync errors
- [Current Limitations](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2665906189)
- [Release Notes](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666332193)
- [FAQ and Support](https://mgm-tp.atlassian.net/wiki/spaces/SBFJC/pages/2666201105)