Create a synchronization link

Synchronizer admin permissions are required.

Before you begin:

To create a synchronization link:

  1. From the ALM Octane settings area, select Synchronizer.

  2. Do one of the following to open the Add Link wizard.

    • To create your first link, click Create synchronization links.

      Caution: If the button is disabled and no Integration Bridge is installed, do one of the following:

      • JIRA/On-Premises ALM. Follow the instructions here: Set up the Integration Bridge.

      • SaaS ALM: To synchronize with SaaS ALM, ask ALM Octane Support to install and configure the integration bridge (Help > Send Us FeedbackOpen ticket).

    • For additional links, select a bridge on the left of the Link Configuration page and click Add Link.

      Tip: If the Synchronizer opens to the Dashboard and you see the Links summary, click to open the Link Configuration page.

  3. Use the wizard to configure your link, following the steps described below.

    The order of the steps may vary, depending on the type of entity synchronized over this link (defects, requirements, or releases).

Define connection settings

  1. Select the type of connection you are creating: ALM or JIRA.

  2. Select Existing Connection and choose a previously defined endpoint, or select New Connection and populate the following fields:

    Field Description

    For ALM:
    ALM/QC Server URL

    URL to the ALM deployment that hosts the project you want to synchronize with.

    Use the following syntax: http(s)://<hostname>:<port>/qcbin

    For JIRA:
    JIRA Server URL

    URL to the JIRA deployment that hosts the project you want to synchronize with.

    Use the following syntax: http(s)://<hostname>:<port>

    Note: The following URL formats are accepted as input:

    • JIRA-DOMAIN:PORT (e.g. http://sync.almoctane.com:8086)

    • JIRA-DOMAIN:PORT/login.jsp (e.g. http://sync.almoctane.com:8086/login.jsp)

    • JIRA-DOMAIN:PORT/BASEPATH (e.g. http://sync.almoctane.com:8086/jira)

    • JIRA-DOMAIN:PORT/BASEPATH/secure/Dashboard.jspa (e.g. http://sync.almoctane.com:8086/secure/Dashboard.jspa)

    Endpoint Display Name

    Identifies this connection to ALM or JIRA.

    Tip: Assign this name when creating a new link. If you later select Existing Connection to create additional links to this project, you can select this display name from the list.

    Credentials Display Name

    Select a predefined credentials record from the drop-down list.

    These records are defined by ALM Octane Support when they install your Integration Bridge.

    For ALM:
    ALM/QC Domain and Project 

    Enter the ALM domain and project you want to synchronize with.

    Click Authenticate to retrieve available values, and select the domain or project names from the listed items.

    For JIRA:
    JIRA Project

    Enter the JIRA project you want to synchronize with.

    Click Authenticate to retrieve available values, and select the domain or project names from the listed items.

Back to top

Define link properties

  1. Select the type of entity synchronized over this link (defects, requirements, or releases).

  2. Define a name for your link, and an optional description.

  3. If you work with multiple workspaces, select the workspace you want to synchronize with ALM or JIRA.

    If you do not see your workspace in the drop-down list, make sure you are defined as a Synchronizer Admin in this workspace. For details, see Define a Synchronizer Admin user.

  4. Click Check Connectivity and Continue.

Back to top

Map requirement types (requirement links)

ALM:

Specify the ALM requirement types that match user stories, features, and epics, according to the hierarchy that you defined in advance in ALM. For details on setting up this hierarchy, see In ALM, prepare requirement types to match ALM Octane's (requirement synchronization).

You can map multiple ALM requirement types to user stories and features. Specify one type as the default for ALM. This requirement type is used when synchronizing new ALM Octane items with ALM.

JIRA:

Map JIRA epics and stories to ALM Octane features and stories. Note that ALM Octane has three levels of hierarchy while JIRA has two levels, so ALM Octane epics are not mapped.

You can then define which endpoint controls the synchronized entities.

Note: Only mapped requirement types are synchronized.

Back to top

Set the rules that define which endpoint controls the synchronized entities

Select where you plan to manage your releases, defects, and different types of requirements.

Caution: ALM Octane does not support custom release fields.

For releases, Synchronized data includes:

  • Releases: Names, start and end dates, descriptions, and attachments.
  • Sprints/cycles: Names, start and end dates.

If you have custom release fields that are mandatory in ALM or JIRA, synchronize release data only from ALM or JIRA to ALM Octane, and not from ALM Octane to ALM or JIRA.

  • Select one of the following:

    Option Description
    ALM Octane

    Select this option to create defects, requirements, or releases in ALM Octane only.
    During synchronization, corresponding entities are created automatically on ALM or JIRA.
    Updates made to existing entities in either endpoint are synchronized with the other endpoint.

    For requirement links: This option means that you manage the entity's hierarchy (epic > feature > user story) in ALM Octane. Changes that you make to the structure of your requirements tree in ALM or JIRA will be reverted by the synchronization.

    ALM/JIRA

    Select this option to create defects, requirements, or releases in ALM or JIRA only.
    During synchronization, corresponding entities are created automatically on ALM Octane.
    Updates made to existing entities in either endpoint are synchronized with the other endpoint.

    For requirement links: This option means that you manage the structure of your requirements tree in ALM or JIRA. Changes that you make to the entity's hierarchy (epic > feature > user story) in ALM Octane will be reverted by the synchronization.

    Both ALM Octane and ALM/JIRA

    Select this option to create and update defects, requirements, or releases in both ALM Octane and ALM or JIRA, for a full range of planning and testing functionality. Changes made in either endpoint are synchronized with the other endpoint.

    Note: Two options are available for managing entities in both endpoints. One sets ALM Octane as the dominant side, in case of conflicts, and the other sets ALM or JIRA as the dominant side.

    For requirement links: This option means that you can change the entity's hierarchy (epic > feature > user story) in either endpoint. Changes that you make to the structure of your requirements tree are synchronized in the other endpoint. In case of conflict, the structure of the dominant side is used.

  • When you synchronize a release, all related ALM Octane sprints are synchronized with ALM cycles or JIRA sprints.

    For a release link, select the endpoint to use as the dominant side for sprint and cycle synchronization, in case of conflicts.

You can view the rules in more detail after you create the synchronization link, and adjust them if necessary, in the link configuration Rules tab.

Back to top

Optional: Select favorites (requirement and defect links)

You can limit the synchronization to a subset of your ALM, JIRA. or ALM Octane database by using ALM Octane and ALM or JIRA favorites.

Tip: For requirement links, you can also use an alternate root folder for a similar purpose. If you define both favorites and an alternate root folder, the alternate root folder is considered first.

Select favorites to use as filters for new items when synchronizing between endpoints. For details, see Define the synchronization scope.

No favorites are defined by default. This means that all records in the ALM Octane workspace and the ALM or JIRA project are synchronized.

Back to top

Optional (ALM only): Define an alternate root folder (requirement and release links)

You can limit the synchronization to a subset of your ALM database by selecting an alternate ALM root folder.

Select Use an alternate root folder and enter the path to a sub-folder in your ALM project's Requirements or Releases folder.

The path must replicate the exact hierarchy in ALM starting with the Requirements or Releases folder, according to the ALM locale. For example: Requirements\MyProject.

Note: For a requirement link, if you define both favorites and an alternate root folder, the alternate root folder is considered first.

Caution:  

  • Make sure the folder that you enter already exists in your ALM folder structure.

  • Specifying an alternate root folder for synchronization can cause unexpected behavior.

    If you reorganize the Requirements or Releases module in ALM after having run a synchronization task, carefully move the records while retaining the same hierarchy to retain the synchronization. Do not delete records and create new ones in the new location, as ALM Octane Synchronizer recognizes records according to their ALM ID.

    When you move records, make sure to retain the same hierarchy as is defined for the link in ALM Octane Synchronizer.

  • If you move a record out of the alternate root folder in ALM, this record is no longer synchronized with ALM Octane.

    However, if you move a release out of the alternate root folder, the release is no longer synchronized, but its cycles are still synchronized.

  • You can change the path to the alternate root folder until you run the first successful synchronization for the link.

Back to top

Optional: Specify how to handle requirements whose hierarchy does not match the backlog tree (requirement links)

Your ALM or JIRA requirement synchronization hierarchy might not fully match the ALM Octane epic > feature > user story hierarchy.

For example, if a requirement of a type mapped to user stories is a child of a requirement whose type is mapped to epics. A requirement of a type mapped to features may be a child of a requirement not mapped for synchronization at all.

For requirement types mapped to epics or user stories, you can instruct Synchronizer to ignore a requirement's hierarchy when it does not match. Such requirements are then synchronized directly to the root of the ALM Octane backlog tree: Select Synchronize epics and user stories to the Backlog root.

Tip: We recommend that you select this option.

This option is not relevant for features. Features whose parents are not epics will still fail to synchronize.

Back to top

Specify how to handle existing or past releases (release links)

  • Select Synchronize past releases... if you want to synchronize releases whose end date is in the past. By default, ALM Octane Synchronizer synchronizes only current releases.

    If you select this option, enter a date to prevent synchronizing old releases that you do not need. This date cannot be in the future.

  • Select Map pairs of new releases and sprints/cycles with identical names if you want to use data from the dominant endpoint for all fields of the identically named release or sprint/cycle in the other endpoint.

    In ALM synchronization, if you do not select this option the pairs of identically named release or sprints/cycles are not synchronized at all. A "duplicate entities" error is generated in the run report.

    Note: When mapping, ALM Octane Synchronizer checks only the releases that are included in the synchronized time frame. Releases or sprints/cycles with identical names are not mapped if they are in a past release (or a release whose end date is older than the one you specified for synchronization).

    If you are working in a shared space (see Manage spaces), when you update a shared release in a remote endpoint this is not synchronized to ALM Octane. Releases created in a remote endpoint are not shared in ALM Octane.

Back to top

Next Steps

Click Next to complete the wizard, and then Finish to create the link. The new link appears in the navigation tree on the left of the Link Configuration page.

When you are finished creating your link, do the following:

Caution: If you create a link and then delete it, and you then create it again using the same conditions, any defects or requirements that were already synched will be duplicated (in either direction of synchronization).

See also: