Knowledge Base > Setting Up Basic Synchronisation

Setting Up Basic Synchronisation

In this tutorial you will learn how to configure Ceptah Bridge, export issues from MS Project to JIRA, and then synchronise the issues with the source tasks.

Exporting MS Project Tasks to JIRA

Installation

To export Microsoft Project tasks as issues to JIRA, do the following.

  1. Download Ceptah Bridge and install it.

  2. Open an existing Microsoft Project document.

  3. Click ADD-INS > JIRA > Synchronise in the ribbon or press Shift-Ctrl-S.

    ADD-INS > JIRA > Synchronise

Connecting to JIRA

  1. As there are no mappings between JIRA and Microsoft Project for the plan yet, the following message will appear.

    'No settings' dialog

    Press OK. Another message will be displayed.

    Accessing JIRA for the first time

    Press OK.

  2. The following dialog will appear.

    Global connection settings

  3. Enter JIRA URL. Make sure that the URL includes both protocol (http or https) and host name. If the port is provided, please add it as well. You can open your JIRA home page in a browser and copy the URL from the address bar:

    Copy JIRA URL from Chrome

    URL: https://ceptah.atlassian.net

    Copy JIRA URL from IE

    URL: http://serg-jira:8080

    If the URL is correct, the deployment type of your JIRA will be displayed below the URL field:

    Global connection settings with URL

  4. For JIRA Cloud, enter your e-mail and API token. For JIRA Server or Datacentre, enter your JIRA login and password.

    To generate an API token, click the "API token" link and follow the instructions on Atlassian website.

    Global connection - credentials

  5. If you access JIRA through a proxy server, tick 'Use proxy server' and enter the proxy server parameters.

  6. Press 'Test Connection' to check the settings.

    Check JIRA connection settings

  7. Press 'OK' to save the settings.

Configuring Mappings

  1. The Project Settings Dialog will appear.

    Project Settings Dialog

    You will need to complete the mandatory fields marked with * to start basic synchronisation.

  2. Take notice of the Issue Key mapping. The keys of the linked issues for MS Project tasks will be stored in the Text10 field. That is how Ceptah Bridge knows which issue needs to be synchronised with a task. This field is populated automatically during import and during synchronisation as issues get created.

    Issue Key mapping

  3. Select the JIRA project where issues will be created during synchronisation by default.

    Default project

  4. A drop-down list with the keys of the JIRA projects available to you will open in the project settings dialog.

    Project settings: default project

    Select the JIRA project where issues will be created during synchronisation by default.

  5. Observe the Summary mapping.

    Project settings: default project

    Issue Summary will be synchronised with Task Name. If the task is not on the first level, the names of the tasks it is part of will be added before the child task name and delimited with the '>' symbol. For instance, if there is a task called '2nd Phase' that has a sub-task called 'Regional Offices', which in its turn contains a task 'Deployment', the summary for the issue linked to 'Deployment' will be '2nd Phase > Regional Offices > Deployment'.

    When a new issue is created during synchronisation, its summary will be set to the above described composite name. If a task has already been linked to an issue and the issue summary is different from the name composed using the task names, the summary will be reset to the latter value.

    The arrow on the direction button points from the side (MS Project or JIRA) that is the source of truth towards the side that should be updated during synchronisation if different. With the configuration in the picture, Summary in JIRA will be updated based on the MS Project task names if required. The direction, as well as other options, can be changed to tailor the mapping to your business process.

    The direction buttons are only regarded during synchronisation and only if the task is linked to an issue. Otherwise, which is when issues are imported or are being created, the direction button states are ignored. This applies to all mappings.

  6. Select the default type for new issues.

    Project settings: default issue type

  7. Select the default priority for issues.

    Issue priority mapping

  8. Observe the Due Date mapping.

    Due date mapping

    Due date is mapped to Task Finish and will be reset to the Finish value during synchronisation because the arrow is pointing to JIRA. If you flipped the direction by clicking the button, Task Finish would be copied from Due Date instead.

  9. Observe the Assignee mapping.

    Assignee mapping

    Assignee Name is mapped to Resource Name, and the direction is from MS Project to JIRA. That means that the issue will be assigned (or reassigned) to the JIRA user whose full name is the same as the Resource Name for the synchronised task in MS Project.

    Note the fact that 'Do not create issue if no assignee' is ticked. Ceptah Bridge will not create issues for the tasks that have their Resources field blank. For the purpose of this tutorial, please make sure that the tasks that you want to be published in JIRA have their Resources field populated with valid JIRA user names as the tasks will not be synchronised otherwise.

  10. You have the minimum set of mappings configured now.

    Final view of the Project Settings

    Press OK to save the settings.

Activation

  1. As the synchronisation is about to begin and the product needs to be activated to run synchronisation, the activation window will pop up.

    Activation

    Complete the form and press Activate to continue. An Internet connection will be required for successful activation.

Creating Issues

  1. Now Ceptah Bridge will go through the MS Project tasks and prepare a list of changes to be made.

    Before applying changes

    The top half of the window displays the tasks and/or issues that need to be updated or created during import or synchronisation. In our case it contains a list of issues to be created in JIRA. The bottom part provides a preview of the changes to be applied to each field of the item selected in the top list.

  2. Press 'Apply changes' to start the actual synchronisation. Ceptah Bridge will go through the prepared tasks, create issues and link them to the tasks by populating the Text10 field with issue keys.

    Apply changes

    The synchronised items will be marked as done and a link to a newly created issue will be displayed for each row in the top list.

  3. Add the Text10 field to your current task view (e.g. Gantt Chart) in MS Project.

    Text 10

    Observe that Text10 contains the keys of the linked issues now.

  4. Ceptah Bridge populates the Hyperlink field with a link to the associated issue in JIRA. This is defined by the 'Hyperlink' mapping configurable on the 'Secondary' project settings tab.

    Hyperlink to issue in JIRA

    Click the link to open the related issue in JIRA.

    Hyperlink to issue in JIRA

Synchronising JIRA Issues with MS Project Tasks

  1. Change a few mapped fields in MS Project.

    Change fields in MS Project

    To synchronise the tasks in the Microsoft Project plan with the respective issues in JIRA, run synchronisation again. Ceptah Bridge will suggest making some changes in JIRA to reflect the modifications on the Microsoft Project side.

    Reflect changes

    Press 'Apply Changes'. After the synchronisation finishes, you can open the issues in JIRA and see that they are in sync with tasks.

    Changes have been applied.

    Press 'Compare'. Ceptah Bridge will not find any differences as JIRA and MS Project are in sync now.

    No differences.