SoftSync is a powerful app that
enables you to sync your projects, tasks, and
user activities between Jira Cloud and
Teamwork.com.
Note: The SoftSync integration is
available to all paid Teamwork.com
subscription plans. You will need to sign
up to SoftSync to use the
integration.
For any
queries relating to the SoftSync
integration, please
contact the SoftSync support
team.
Within SoftSync, you can customize your
synchronization settings for the SoftSync
integration with Teamwork.com.
Note: You will first
need to connect your Teamwork.com
account to SoftSync.
You can use SoftSync's general
settings to help you configure how to
synchronize your data between Jira and
Teamwork.com.
Once your connection to
Teamwork.com is set up, you will then
need
to:
- Define your general
synchronization settings
- Set up the initial
synchronization
SoftSync's general settings
can be used to configure how your
data
is synchronized between Jira and
Teamwork.com.
Synchronization
Type -
choose a direction for synchronizing
your Teamwork.com projects.
- Two-way sync (default):
Synchronize your data in both
directions from Teamwork to Jira
and vice versa.
- One-way sync: Set your data to
synchronize in one direction only
(Teamwork > Jira or Jira >
Teamwork).
Source Platform -
applicable when you choose two-way
sync.
- Jira (default)
- Teamwork
Direction for One Way
Sync - applicable when
you choose one-way sync.
- Sync Jira to Teamwork (default)
- Sync Teamwork to Jira
User Synchronization -
choose
whether to synchronize all
users.
- If the users are not synchronized
or if a user is not found in the
target application, SoftSync will
not update the following user
properties:
- Watchers/followers
- Reporter - SoftSync will use
the SoftSync API key in Jira /
the account used for the
integration in Teamwork.com.
- Assignee
- Unassigned will
be used as the value.
- Note: Teamwork.com
supports multiple assignees for
tasks, however Jira only supports
single assignees. The first
assignee from Teamwork.com will be
synchronized as the Jira assignee,
while the remaining assignees in
Teamwork.com will be defined as
watchers for Jira.
Automatic Project Link
Creation
Settings - allow SoftSync to
search the target platform for the
source project by name.
- If found, SoftSync will
automatically link it and start
the sync.
Automatic Project Creation
Settings - allow a new project
to be created automatically in the
target platform if an existing project
is not matched.
- Jira requires a project name,
project type (Classic or
Next-Gen), and project
template.
- Teamwork requires a project name
and company.
- Note: If two-way sync
is selected, you will need to set
the project fields for both
platforms.
Task Statuses
Synchronization - choose
which task statuses should be
synchronized in Teamwork.com and
Jira.
- Jira uses custom statuses which
will be displayed for you to
select.
- Note: SoftSync
recommends
keeping Done and Completed statuses checked.
- Teamwork.com uses fixed task statuses
of Open and Completed.
- Since Jira supports dynamic
statuses, SoftSync will create a
corresponding custom field called
JIRA_STATUS which will import all
of the statuses from the
corresponding Jira project.
- This field will then sync the
current status from Jira to
the custom
field in Teamwork.com for
the task or subtask.
Priority Mapping - define
the
mapping for priority levels between
Teamwork.com and Jira.
- Jira uses custom priorities while
Teamwork.com uses a pre-defined set of
fixed priorities.
- You can have multiple
priorities in Jira mapped to a
single priority in
Teamwork.com.
- If a new custom priority is
later added in Jira, it will
be mapped with the
value None in
Teamwork.com until you define the
mapping.
- To correctly synchronize between
the two platforms, you will need
to define the mapping.
Status Mapping - define
the
mapping for statuses between
Teamwork.com
and Jira.
- Jira supports multiple custom
statuses while Teamwork.com uses
two
pre-defined statuses
of Open and Completed.
- If you add a new custom
status
in Jira, it will not be
selected to sync unless
you
update the status mapping
settings.
- To correctly synchronize
between
the two platforms, you will
need
to define the mapping.
Once you have set up all of the
synchronization settings, click
the Next button in
the
top
right of the General Settings
page.
We
recommend starting off using one
project for your initial sync to
see how it works before
synchronizing additional
projects.
Project Mapping
As long as all of your settings are
validated correctly, you will be
brought to
the next page of the setup. SoftSync
will get all existing projects from
Teamwork.com and Jira and allow you to
specify project mapping.
You can also exclude specific
projects from being included in the
sync via the Exclude button to
the right of the
project. Alternatively, use the
checkboxes on the left to bulk select
projects for exclusion. Once selected,
click the Exclude Selected button at the top of the list.
Note: Defining
project mapping is not a required step
for the initial sync. It can be
skipped and completed later.
Project Synchronization
Settings
Customize project
properties included in the sync.
- Project Description - set whether
to
sync project descriptions between
the
platforms.
- Issue Type - select all or some
issue
types to be synchronized.
- Teamwork.com supports task lists,
tasks, and subtasks while Jira
supports customization of
issue
types.
- Epics in
Jira correspond with task
lists in
Teamwork.com.
- If the Epic for an issue
type
does not exist in your
Jira
project, Teamwork.com will
have a
custom task list created
with
all of the tasks from Jira
without Epics.
- Each issue type with at
least
one task in Jira will
trigger
a custom task list in
Teamwork.com, named under the
Jira
ticket type with the bugs
or
tasks under it.
- Issue Type Properties - define
which
properties should sync between the
two
platforms.
Once you have set up all of the
project
synchronization settings, click
the Sync button in the top
right of the Initial Projects
Synchronization page.
You will be asked to confirm before
clicking Proceed with
the
sync.
Once the initial synchronization
setup is complete, you will see
the Projects
List synchronization
management
page which displays the projects
currently
linked and unlinked as a result of the
sync.
In this view, you will be able
to:
- Manually
link a previously
unlinked
project at
any time.
- Configure existing project
links
that
you
already
defined.
- Remove existing project
links.
- Export activity within the
projects.
Project general
settings
You can manage general
project
settings and
default
settings used for each project
in the
sync via the General Settings
menu.
If auto sync is enabled,
SoftSync will automatically
know which
data to sync. If you manually
create a
link, SoftSync will use the
default
setup which you can then
update.
Any changes you attempt to
save in the general settings
will
trigger an initial
synchronization for
all linked projects.
- You will be asked whether
to
proceed with the full
synchronization or apply
the
changes to new requests
only.
SoftSync will not delete or
change the position of any data in
Teamwork.com, however the titles of any
existing Teamwork.com tasks included in
the sync will be amended.
Note: Each time
a task is synchronized between the
platforms, task names in Teamwork.com
will
be prefixed with the corresponding
Jira ID.
Example:
- A task is created in Teamwork.com with
a task title of "Feedback
review"
- Via the sync, the task
will be
added to the corresponding
project
in Jira with a unique key
("SOF-7")
- When the platforms next synchronize, that key will be prefixed to the task title in Teamwork.com.
- Mapped fields
(if
selected):
- Priority
- Status
- Comments
- Estimations
- The Jira status will be synced over in a task custom field called "JIRA_STATUS"
For more information, see: Connecting Your Account to
SoftSync