51
Polarion ® SYNCHRONIZER User Guide

Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

  • Upload
    others

  • View
    6

  • Download
    0

Embed Size (px)

Citation preview

Page 1: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Polarion® SYNCHRONIZER™

User Guide

Page 2: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Version: 1.0.3 Polarion SYNCHRONIZER User Guide Copyright © 2016 Polarion Software Permission is granted to use, copy, and distribute this document provided that the content is not modified and the above copyright notice and this statement appear in all copies. Polarion is a registered trademark of Polarion Software. Polarion ALM, Polarion REQUIREMENTS, Polarion QA and Polarion VARIANTS and Polarion SYNCHRONIZER are trademarks or registered trademarks of Polarion Software. Microsoft and Microsoft Team Foundation Server are registered trademarks of Microsoft Corporation. Other trademarks referenced are property of their respective owners. Updated: 05­Apr­2016

1

Page 3: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Polarion SYNCHRONIZER Table of Contents

Chapter 1: Introduction 1.1. Quick Overview 1.2. Features and Benefits 1.3. Connectors

1.3.1. Polarion Connector for Polarion 1.3.2. Polarion Connector for Microsoft TFS

Chapter 2: Installation 2.1. Supported Applications 2.2. Hardware Requirements 2.3. Installation on Windows operating systems

2.3.1. System Requirements 2.3.2. Installation Instructions

2.4. Installation on Linux operating systems 2.4.1. System Requirements 2.4.2. Installation Instructions

2.4. Increasing Available Memory Chapter 3: Polarion SYNCHRONIZER Administration Console

3.1 Login 3.2 Administration Console Tour

3.2.1. Navigation Panel 3.2.2. Glossary of Terms

3.3 Configuring the Integration Between Applications 3.3.1. Synchronizations View 3.3.2. Creating A Synchronization

3.3.2.1. Configure the End Points (New Synchronization button) 3.3.2.1.1 Configuring HTTPS on an End Point

3.3.2.2. Create Sync Profiles 3.3.2.2.1. Step1: Choose which of the End Points is the main one 3.3.2.2.2. Step 2: Configure the Artifact Type that you want to synchronize in each End Point 3.3.2.2.3. Step 3: Configure how each Artifact Type is synchronized on each End Point 3.3.2.2.4. Removing an End Point from a Sync Profile 3.3.2.2.5. Removing a Sync Profile 3.3.2.2.6 Configure Field Mapping 3.3.2.2.7 Fields With Special Mapping

Pre­defined field mapping Read­only fields Attachments

2

Page 4: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Comments Relationships/Links Status

3.3.3. Removing a Synchronization 3.3.4. Duplicating a Synchronization 3.3.5. Starting a Synchronization 3.3.6. Stopping or Pausing a Synchronization 3.3.7. Edit a Synchronization

3.3.7.1. Migrating a server to a different location 3.3.7.2. Changing the Project ID

3.3.8 Resynchronizing After Configuration Changes 3.4. Monitoring 3.5. Users

Chapter 4 : Polarion® Connector for Polarion® 4.1. Overview 4.3. How to configure 4.4 Synchronizing Test Step Changes Between Polarion Servers

Chapter 5: Polarion® Connector for Microsoft® TFS 5.1. Overview 5.2. How to configure

3

Page 5: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Chapter 1: Introduction

1.1. Quick Overview Polarion INTEGRATION PLATFORM is a common platform designed to migrate and integrate multiple incompatible disparate ALM applications with Polarion’s unified solution. A major component of Polarion INTEGRATION PLATFORM is Polarion SYNCHRONIZER, a new technology for synchronizing work items between different applications. Polarion SYNCHRONIZER uses an integration bus to connect the applications.

Because data is managed centrally and not in multiple points, the communication across the applications is easier and more robust. Development and maintenance are faster and easier because you only have to build the connection to the integration bus to get out­of­box access to the other integrated applications. The beauty of this architecture is that you don’t need to care about any other applications that may be integrated on the platform.

1.2. Features and Benefits SYNCHRONIZATION Perform bidirectional and unidirectional synchronization of any artifact type including critical types like requirements, user stories, tasks, defects and tests. This ensures that all collaborators can see the same data, no matter what application they use.

4

Page 6: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Bi­directional synchronization allows the data to flow in two directions. You want your teams to be able to modify the data in their own environment, and then propagate the changes across all integrated applications.

Uni­directional synchronization allows the data to flow in only one direction. For example, you have a production and a backup server, and you want to allow changes only on the production server, with the backup server receiving the data as “read­only”. Or your Business Analysts create requirements in Polarion, and make them visible, but not modifiable, for the development team working in Microsoft TFS.

A hyperlink to the item synchronized in the opposite direction is created after the synchronization is done. You can find this link in the Hyperlinks section of the item. By clicking this hyperlink you open the item in the other application. (You must have a user account in the other application that has permission to log in and view the item). This can be useful if you want additional details beyond those that were synchronized.

All details of the artifacts can be synchronized, including comments and attachments. This ensures a comprehensive and undiluted understanding of the artifacts, while the respective teams can keep working in their familiar environments. The synchronization happens in real­time, meaning that the data changes in one system are immediately reflected in the other. This ensures that the data remains consistent across all applications. At the same time, the possibility of conflicts is minimized because there is a smaller probability for the same data to be modified at the same time by two different collaborators. However, in case you need it, there are also options for scheduling the synchronization of each of the integrated applications, and project artifacts at different times. TRACEABILITY One of the major advantages of the Polarion SYNCHRONIZER is end to end traceability. Work item types are synchronized together with their links. Any type of relationship is maintained.

5

Page 7: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

You can see what has been built, track the impact of an actual change, or analyze impact of a potential change.

CONFLICT RESOLUTION Every modification made to a work item is communicated centrally to the Polarion SYNCHRONIZER. Should the same work item be modified at the same time on different systems, conflict resolution mechanisms can be configured to resolve conflicts automatically.

FAIL­SAFE In the real environment, the network might fail, or servers might become unreachable. Polarion SYNCHRONIZER has built­in mechanisms for failure management and automatic recovery.

If an endpoint is down, data is kept in the queue until the endpoint is up again, and then re­transmitted.

In case Polarion SYNCHRONIZER is stopped for updates or other reasons, an auto­recovery mechanism allows it to continue to function correctly. No transaction is ever lost or duplicated.

If for some reason transactions fail, Polarion SYNCHRONIZER notifies the administrator so that the error can be corrected.

EASY CONFIGURATION AND ADMINISTRATION You can manage and configure the integrations via Polarion SYNCHRONIZER’s web­based console. As is characteristic of Polarion’s solutions, the administration console is designed with ease of use in mind, enabling less technical users to perform complex enterprise configurations.

6

Page 8: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

DASHBOARD AND MONITORING The main page of the web­based Administration Console shows a graphical visualization of all configured synchronizations: connected applications and projects, mapped work item types, active and inactive synchronizations. The Monitoring page offers instant visibility into the activity of the Polarion SYNCHRONIZER:

See what synchronizations are performed, the work item types, the number of outgoing and incoming messages.

Clean the message queues that contain errors. View log data and unresolved errors.

1.3. Connectors The first version of Polarion SYNCHRONIZER comes with 2 connectors:

Polarion® Connector for Polarion®, and Polarion® Connector for Microsoft® TFS.

1.3.1. Polarion Connector for Polarion Do you use multiple Polarion servers? Do you work with customers, or partners that also use Polarion? Are you spending time with manual operations to exchange data with other teams, or your customers and partners? Are you struggling to get full traceability? Would you like to have the data exchanged seamlessly, and the traceability maintained automatically, without any additional effort? Polarion Connector for Polarion seamlessly connects your cross­functional teams by enabling bi­directional synchronization of work items between different Polarion servers. Thanks to a direct integration, disparate teams can collaborate without having to leave their familiar environments. For detailed information about use cases and configuration of the connector, see Chapter 4: Polarion Connector for Polarion.

1.3.2. Polarion Connector for Microsoft TFS Microsoft Team Foundation Server (TFS) is the collaboration platform at the core of Microsoft's application lifecycle management solution, and used by Development and QA teams collaborating with the Microsoft development ecosystem. TFS has features for Task Management, Test Case Management and Agile Planning and Collaboration. Polarion Connector for Microsoft TFS connects Microsoft Team Foundation Server with Polarion by enabling bi­directional synchronization of work items between Polarion and

7

Page 9: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Microsoft TFS. Thanks to a a seamless integration, disparate teams can collaborate without having to leave their respective work environments. For detailed information about use cases and configuration of the connector, see Chapter 5: Polarion® Connector for Microsoft® TFS.

Chapter 2: Installation This chapter covers information and procedures for setting up a production installation of Polarion SYNCHRONIZER, and the Connectors that are part of it, on supported Microsoft Windows® and Linux operating systems. The information covers both new installations and, where applicable, updating of existing installations.

2.1. Supported Applications

Application Description

Polarion Server Polarion version 2014, 2015, 2016

Microsoft Team Foundation Server (TFS)

Microsoft Team Foundation Server 2012 Microsoft Team Foundation Server 2013 Microsoft Team Foundation Server 2015

2.2. Hardware Requirements

Requirement Description

MACHINE A dedicated physical or virtual machine with system resources as stated below.

Do not install on the same machine as one of the Supported Applications,

above.

RAM Minimum: 2 gigabytes for production installation.

Recommended: 4 gigabytes or more and a 64­bit Operating System

Disk Storage Space

Minimum: 10 GB (gigabytes). Recommended: 40 GB (gigabytes) or more

There is no hard and fast rule for disk storage space. The actual amount you will require depends on the number and size of projects synchronized with Polarion SYNCHRONIZER.

8

Page 10: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

2.3. Installation on Windows operating systems

2.3.1. System Requirements

Requirement Description

Operating System Microsoft Windows Server 2008 (or any update release), OR… Microsoft Windows Server 2012 (or any update release). For evaluation purposes you can use Microsoft Windows 7 or 8.1.

Rabbit MQ Message Broker

Erlang http://www.erlang.org/download.html ERLANG_HOME system variable should point to the Erlang installation folder. RabbitMQ Server version 3.5.x https://www.rabbitmq.com/install­windows.html IMPORTANT: Be sure you obtain the version shown above even if a newer version is available.

MongoDB Database

MongoDB version 3.0.x http://www.mongodb.org/downloads IMPORTANT: Be sure you obtain the version shown above even if a newer version is available..

Java Runtime Environment

Java™ Platform, Standard Edition Development Kit 8 (JDK™) (http://www.oracle.com/technetwork/java/javase/downloads/jdk8­downloads­2133151.html). Note that OpenJDK 8 is not the same as Oracle Java 8 and is not officially supported. JAVA_HOME variable should point to JDK installation folder. %JAVA_HOME%\bin should exist in the system PATH variable. 64­bit Java is supported in the 64­bit Windows installation.

Scala http://www.scala­lang.org/download/ Scala bin folder should exist in the system paths.

2.3.2. Installation Instructions 1. Install Erlang This application is used for by the messaging services application RabbitMQ (see below).

Download and install Erlang: http://www.erlang.org/download.html.

9

Page 11: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Set environment variable ERLANG_HOME to point to the Erlang installation folder. (RabbitMQ uses this environment variable). Go to Start > Settings > Control Panel > System > Advanced > Environment Variables. Create the system environment variable ERLANG_HOME and set it to the full path of the directory that contains bin\erl.exe.

2. Install RabbitMQ This application provides messaging services to the platform.

Download and install RabbitMQ Server version 3.5.x: https://www.rabbitmq.com/install­windows.html. (See note in System Requirements, above.)

Run cmd.exe as administrator.

Navigate to [RabbitMQ installation folder ]/sbin folder and run the following commands: rabbitmqctl add_user int int rabbitmqctl set_permissions ­p / int ".*" ".*" ".*" rabbitmqctl set_user_tags int administrator rabbitmq­plugins enable rabbitmq_management

3. Install MongoDB This application provides data persistence for the platform. Complete instructions for downloading the correct package, installation, configuration and startup are available online: https://docs.mongodb.org/manual/tutorial/install­mongodb­on­windows/#get­mongodb Please refer to this online documentation to obtain the correct package for your Windows system, and to install and configure MongoDB. Be sure to note the following important points:

If you are running any edition of Windows Server 2008 R2 or Windows 7, you should install a hotfix to resolve an issue with memory mapped files.

Be sure to install MongoDB as a service as described in the MongoDB documentation: https://docs.mongodb.org/manual/tutorial/install­mongodb­on­windows/#configure­a­windows­service­for­mongodb ­ you must do this explicitly, as installation as a service is not automatic.

4. Install Java 8

Download and install the JDK: http://www.oracle.com/technetwork/java/javase/downloads/jdk8­downloads­2133151.html.

10

Page 12: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Go to Start > Settings > Control Panel > System > Advanced > Environment Variables and create environment variable JAVA_HOME, pointing to the JDK installation folder, then add %JAVA_HOME%\bin to the PATH environment variable.

4. Install Scala http://www.scala­lang.org/download/ Configure Scala” Go to Start > Settings > Control Panel > System > Advanced >

Environment Variables and add the Scala bin folder to the PATH environment variable.

5. Install Polarion SYNCHRONIZER

Unzip the file bus­x.x.zip Make sure that Polarion server is running. (Polarion SYNCHRONIZER uses a Polarion

server to authenticate users.) If Polarion server uses a port other than 80, or Polarion server is not running on the local

machine, you have to specify the Polarion URL in the configuration file: <Polarion SYNCHRONIZER HOME FOLDER>/conf/application.conf Modify the parameter "polarionAuthenticationServer". Examples: polarionAuthenticationServer = "http://localhost:8888" polarionAuthenticationServer = "http://your_polarion_server.com" Do not modify the value of polarionAuthenticationRole parameter. Only the accounts with administrative rights are accepted.

7. Verify Installed System Components

MongoDB: Open the Command prompt, cd to to the application’s bin folder and type mongo.

RabbitMQ: In a web browser, open http://server­name:15672/ and log in using credentials int/int.

Java: Run java in the console. 8. Run Polarion SYNCHRONIZER

Run cmd.exe as administrator. Navigate to <Polarion SYNCHRONIZER HOME FOLDER>/bus­x.x Execute the command: ./bin/bus

It is very important to start Polarion Integration Platform from its home folder. Any attempt to run the bus.bat directly from the "bin" folder will produce errors.

11

Page 13: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

9. Test if Polarion SYNCHRONIZER is up and running Run a web browser and navigate to the link http://localhost:9000/ui. This is the link to

Polarion SYNCHRONIZER Administration Console.

On the authentication window use an existing Polarion administration account’s username and password to log in.

You are connected to the Administration Console and you can start configuring the connectors. Note that a message like the following indicates that the platform is started and running: [info] 15:47:42 Listening for HTTP on /0:0:0:0:0:0:0:0:9000

2.4. Installation on Linux operating systems

2.4.1. System Requirements

Requirement Description

Operating System SUSE Linux Enterprise Server 11 (SP 3 or higher) or 12, or Red Hat Enterprise Linux6.x/CentOS 6.x, or Debian GNU/Linux 6.0 or 7.0 or 8.0 or Ubuntu Server 12.04 LTS or 14.04 LTS. Supported architectures are x86, x86_64 or amd64. URW fonts must be installed in the operating system. For SUSE, use the ghostscript­fonts­std package from http://tinyurl.com/pjt3vg3.

Rabbit MQ Message Broker

Erlang http://packages.erlang­solutions.com/erlang­solutions­1.0­1.noarch.rpm RabbitMQ Server version 3.5.1

Fedora / RHEL / CentOS Linux: https://www.rabbitmq.com/releases/rabbitmq­server/v3.5.1/rabbitmq­server­3.5.1­1.noarch.rpm

openSUSE Linux: https://www.rabbitmq.com/releases/rabbitmq­server/v3.5.1/rabbitmq­server­3.5.1­1.suse.noarch.rpm

Note that in the future there will be other versions of RabbitMQ. You should always install the recommended version.

MongoDB Database

MongoDB version 3.0.x http://docs.mongodb.org/manual/tutorial/install­mongodb­on­linux/ Note that a newer version of MongoDB is already available that is unsupported by Polarion. Please install the recommended version: http://www.mongodb.org/downloads?_ga=1.194755172.85370632.1430924115#previous

12

Page 14: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Java Runtime Environment

Java™ Platform, Standard Edition Development Kit 8 (JDK™) (http://www.oracle.com/technetwork/java/javase/downloads/jdk8­downloads­2133151.html). Note that OpenJDK 8 is not the same as Oracle Java 8 and is not officially supported. JAVA_HOME/bin should exist in the system paths.

Scala http://downloads.typesafe.com/scala/2.11.1/scala­2.11.1.tgz

2.4.2. Installation Instructions 1. Install RabbitMQ

Install Erlang: wget http://packages.erlang­solutions.com/erlang­solutions­1.0­1.noarch.rpm rpm ­Uvh erlang­solutions­1.0­1.noarch.rpm sudo yum install erlang

Install RabbitMQ server Fedora / RHEL / CentOS Linux: wget https://www.rabbitmq.com/releases/rabbitmq­server/v3.5.1/rabbitmq­server­3.5.1­1.noarch.rpm OpenSUSE Linux: wget https://www.rabbitmq.com/releases/rabbitmq­server/v3.5.1/rabbitmq­server­3.5.1­1.suse.noarch.rpm rpm ­­import http://www.rabbitmq.com/rabbitmq­signing­key­public.asc

yum install rabbitmq­server­3.5.1­1.noarch.rpm

Start the RabbitMQ server. By default when the RabbitMQ server package is installed, the server is not started as a daemon. To start the daemon by default when the system boots, as an administrator run:

chkconfig rabbitmq­server on As an administrator, start and stop the server as usual using:

/sbin/service rabbitmq­server stop/start/etc

13

Page 15: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Note: The server is set up to run as system user rabbitmq. If you change the location of the Mnesia database or the logs, you must ensure that the files are owned by this user (and also update the environment variables).

Add a new user and set permissions in order to set up rabbitmq user for Polarion

SYNCHRONIZER: sudo rabbitmqctl add_user int int sudo rabbitmqctl set_permissions ­p / int ".*" ".*" ".*" sudo rabbitmqctl set_user_tags int administrator

Enable management plugins:

sudo rabbitmq­plugins enable rabbitmq_management For more information visit http://www.rabbitmq.com/install­rpm.html.

2. Install MongoDB

Download MongoDB: http://www.mongodb.org/downloads?_ga=1.194755172.85370632.1430924115#previous

For installation instructions please see http://docs.mongodb.org/manual/tutorial/install­mongodb­on­linux/

After the installation you have to run MongoDB manually.

3. Install Java 8 wget ­­no­cookies ­­no­check­certificate ­­header "Cookie: gpw_e24=http%3A%2F%2Fwww.oracle.com%2F; oraclelicense=accept­securebackup­cookie" "http://download.oracle.com/otn­pub/java/jdk/8u40­b25/jdk­8u40­linux­x64.tar.gz" tar xzf jdk­8u40­linux­x64.tar.gz cp ­R ­n jdk1.8.0_40 /opt/ cd /opt/jdk1.8.0_40/ alternatives ­­install /usr/bin/java java /opt/jdk1.8.0_40/bin/java 2 alternatives ­­config java

In the dialog, select Java 8.

14

Page 16: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

4. Install Scala

wget http://downloads.typesafe.com/scala/2.11.1/scala­2.11.1.tgz tar xvf scala­2.11.1.tgz sudo mv scala­2.11.1 /usr/lib sudo ln ­f ­s /usr/lib/scala­2.11.1 /usr/lib/scala export PATH=$PATH:/usr/lib/scala/bin scala ­version

5. Install Polarion SYNCHRONIZER unzip bus­x.x.zip chmod +x ./bin/bus

Make sure that Polarion server is started. (Polarion SYNCHRONIZER uses a Polarion

server to authenticate users.) If Polarion server uses a port other than 80, or Polarion server is not running on the local

machine, you must specify the Polarion URL in the configuration file:

<Polarion SYNCHRONIZER HOME FOLDER>/conf/application.conf Modify the parameter "polarionAuthenticationServer"

Examples: polarionAuthenticationServer = "http://localhost:8888" polarionAuthenticationServer = "http://your_polarion_server.com"

Do not modify the value of polarionAuthenticationRole parameter. Only the accounts with administrative rights are accepted.

6. Run Polarion SYNCHRONIZER

Run cmd.exe as administrator. Navigate to <Polarion SYNCHRONIZER HOME FOLDER>/bus­x.x Execute the command: ./bin/bus

It is very important to start Polarion Integration Platform from its home folder. Any attempt to run the bus.bat directly from the "bin" folder will produce errors.

7. Test if Polarion SYNCHRONIZER is up and running

Run a web browser and navigate to the link http://localhost:9000/ui. This is the link to the Polarion SYNCHRONIZER Administration Console.

In the authentication window, use an existing Polarion administration account’s username and password to log in.

15

Page 17: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Now you are connected to the Administration Console and you can start configuring the connectors.

2.4. Increasing Available Memory Synchronizing very large projects may use more memory than is normally available to Polarion SYNCHRONIZER. The more common incremental synchronization does not require much memory, but the initial synchronization, and subsequently doing a full sync and resynchronizing will consume a great deal more. The more items that need to be synchronized, the more memory that is required. If you recognize that these operations do not work as expected check the log for errors such as java.lang.OutOfMemoryError. Seeing those errors is an indication that not enough memory is available to Polarion SYNCHRONIZER. To resolve the issue, you can make more memory available to the platform by adding the following to the memory configuration on your operating system: ­XmxNG where N is the number of gigabytes of memory assigned to Polarion SYNCHRONIZER. For example ­Xmx2G assigns two gigabytes. On Windows, in the file <Polarion SYNCHRONIZER>/bin/bus.bat append to the line: set JAVA_OPTS=­Dcom.microsoft.tfs.jni.native.base­directory="%NATIVE_DIR%" Example: set JAVA_OPTS=­Dcom.microsoft.tfs.jni.native.base­directory="%NATIVE_DIR%" ­Xmx2G

On Linux, add the string the system variable JAVA_OPTS. As a rule of thumb you should assign half of the memory available to the system to the Polarion SYNCHRONIZER, but not less than 1 GB (half the minimum requirement).

Chapter 3: Polarion SYNCHRONIZER Administration Console As a Polarion SYNCHRONIZER administrator, you can manage and configure the integrations via a web­based console. The main component of Polarion SYNCHRONIZER is Polarion SYNCHRONIZER. It is the one that performs the synchronization of the work items between the connected End Points. Polarion SYNCHRONIZER is the name that you see on the Administration Console.

16

Page 18: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

3.1 Login To be able to access and configure the Polarion SYNCHRONIZER Administration Console you must have an Administrator account. Please refer to the Installation Chapter 2. Installation for more information on which account you should use. To access the Administration Console, click on the following link (assuming you are working on the computer where the application is installed): http://localhost:9000/ui#/login

3.2 Administration Console Tour This section provides some basic information to help you understand how to navigate around in the Administration Console and introduces the various terms used.

3.2.1. Navigation Panel The Navigation panel occupies the top side of the Administration Console portal page.

17

Page 19: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Polarion SYNCHRONIZER ­ The home button. It opens the default view.

Synchronizations ­ Opens the Synchronizations view, which shows the Synchronizations that you have configured among the different connectors of Polarion SYNCHRONIZER. It is displayed by default when the Administration Console is started.

Monitoring ­ Opens the Monitoring view which shows the log and status of messages exchanged in each configured synchronization.

Running ­ General status of Polarion SYNCHRONIZER. When stopped, the Administration Console doesn’t load.

The gear icon ­ Menu with Polarion SYNCHRONIZER’s administrative settings:

View Log ­ When clicked it opens Polarion SYNCHRONIZER’s log.

Manage Users ­ Allows you to define the users that have administrative rights on Polarion SYNCHRONIZER.

Log Out ­ When clicked it logs the current user out of the Administration Console.

3.2.2. Glossary of Terms

Term Explanation

Connector Designates the type of tools/systems that the Polarion Integration supports. For example Polarion Connector for Polarion is the part of Polarion SYNCHRONIZER that connects two or more Polarion servers. Similarly, Polarion Connector for Microsoft TFS connects Polarion with Microsoft Team Foundation Server (TFS).

synchronization The process of copying data between systems when it is created or modified in order that both systems contain the same information. The goal of Polarion SYNCHRONIZER is to synchronize the data that is configured to exist in the two systems.

18

Page 20: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Synchronization (capitalized)

In the context of the Administrative Console, Synchronization refers to the a synchronization configuration between two or more projects from the same or different servers. For example, if you want to configure the synchronization of artifacts between two Polarion servers, or between Polarion and TFS, you have to create and configure a Synchronization.

End Point A server that is connected to Polarion SYNCHRONIZER (as part of Polarion INTEGRATION PLATFORM). For example, your Polarion installation, or your TFS installation are End Points. If you have multiple Polarion servers, each of them is an End Point. To identify them, you’ll need to provide the server URL, project ID and administrative credentials.

Artifact Type Denotes a class of artifacts. ALM software tracks and manages “work items”, or generally speaking, artifacts. Examples of Artifact Types include, for example, Requirement, User Story, Task, etc. (You need to decide which artifact types you want to synchronize, and configure them accordingly.)

Sync Profile The synchronization settings at the Artifact Type level. The most notable settings are the direction of the synchronization, the mapping, and the scheduling.

Mapping The process of specifying which artifact type in one system is equivalent or analogous to which type on another system in order that their data may be synchronized.

Central Storage The central repository of Polarion SYNCHRONIZER used to store the data that is synchronized among the connected End Points.

Polarion SYNCHRONIZER

Polarion INTEGRATION PLATFORM’s main component. Its main role is to perform the synchronization of the work items between the connected End Points.

3.3 Configuring the Integration Between Applications

3.3.1. Synchronizations View Before the initial configuration, the Synchronizations view is empty.

19

Page 21: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Click on the New Synchronization button to start configuring data synchronization between two or more servers. After one or more Synchronizations are created, the Synchronizations view shows a summary of the configured Synchronizations:

­ The Synchronization name. Clicking on this name opens a view that shows you the details of the Synchronization.

­ The Synchronization icon. There is one icon for each status of the Synchronization.

­ Shows the status of the Synchronization. It can be: “Connected” when the Synchronization is working, meaning that the artifacts

are being synchronized between the End Points by Polarion SYNCHRONIZER. “Disconnected” when the Synchronization is not yet functional. When a

Synchronization is created or modified, it is in the “Disconnected” state to avoid sending incomplete or wrongly configured data to Polarion SYNCHRONIZER that would cause incorrect data synchronizations, or errors.

20

Page 22: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

­ The following actions are available: “Duplicate” ­ Creates another Synchronization that is a duplicate of the current

one. You might want to duplicate a Synchronization when you have multiple projects with similar configurations, and you want to save time configuring a new Synchronization. Pay attention that only identical configurations in the Synchronization will be preserved. Small differences (like correcting field mapping) can be adjusted manually, others not.

“Connect” ­ Connects the current Synchronization to the Polarion SYNCHRONIZER. This means that the artifacts are being synchronized between the End Points by Polarion SYNCHRONIZER. New Synchronizations are disconnected by default. Therefore, it is important that you take this action after you finish configuring a Synchronization.

“Disconnect” ­ Stops data synchronization between the End Points defined in the current Synchronization. It is advisable to disconnect before you modify a Synchronization.

“Remove” ­ Removes the current Synchronization. End Points area ­ An overall picture of the End Points in a Synchronization, with the

available Sync Profiles.

The End Point box shows your chosen name of the End Point and the Project ID:

The Sync Profile table row shows what Artifact Types are mapped between the End Points, and their relationship:

Click this icon to edit the Sync Profile configuration:

Press this button to configure the synchronization between different artifact types of the existing End Points:

21

Page 23: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

3.3.2. Creating A Synchronization To configure a Synchronization: 1. Configure the End Points: add the details about the applications that you want to

configure, the servers, and the project.

2. Choose what artifact types you want to synchronize. The platform can synchronize any artifact type, standard or custom­defined in the applications.

3. Configure the type mapping: indicate what fields you want to be synchronized, the direction of synchronization, the transformations and who takes precedence in case of conflict.

3.3.2.1. Configure the End Points (New Synchronization button) To begin configuring a new Synchronization, click the New Synchronization button, enter a name for the new Synchronization, and click Save.

You are now asked first to configure the End Points that are connected in this Synchronization. (The same screen appears when you open an existing Synchronization for editing.)

22

Page 24: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

To configure an End Point you need to enter the following data:

Name ­ Enter a name for this End Point. It is advisable to choose a name that helps you recognize it easily later on.

Type ­ Choose the application type that is installed on that server. It can be a Polarion application, or a Microsoft TFS application.

Server URL ­ this is the URL of the application user interface: Polarion user interface, or Microsoft TFS. It must start with http:// or https://. Example Polarion: If your project link is http://polarion/mydomain.com/#/project/MyProject Server URL should be http://polarion.mydomain.com Project ID should be MyProject Example Microsoft TFS: If your project link is http://msproject:port/tfs/DefaultCollection/Demo Server URL should be http://msproject:port/tfs/DefaultCollection And Project ID should be Demo

23

Page 25: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

User, Password ­ The credentials for an administrator account on that server for the project specified in Project ID. Polarion SYNCHRONIZER uses these credentials to log in to the server and perform read and write operations.

Project ID ­ The ID of the project whose artifacts you want to synchronize.

Server Time Zone ­ Time zone of the End Point server. By default it is assumed that End Points run in the same time zone as the Polarion SYNCHRONIZER. If an End Point runs in a different time zone it is necessary to specify that time zone, otherwise incremental synchronization will not work properly. Click the drop­down control and select the timezone of the End Point.

After you enter the End Point details, click the Test & Save button to test and save your settings. The platform tries to connect to the server with the specified credentials. If successful, the settings are saved. If not successful, you get an error message until you enter correct settings.

A Synchronization must have at least 2 End Points.

Add End Point ­ Click on this button to add a new End Point The gear icon ­ Each End Point has a gear icon in the top right corner. Click it to

activate the edit mode for that End Point. + New Sync Profile ­ After you configure the End Points, the next step is to define what

artifact types you want to synchronize between these End Points.

3.3.2.1.1 Configuring HTTPS on an End Point If you see an error message "Failed to establish https connection" the most likely reason is that the Java runtime does not trust the server’s certificate. That will happen if you are using a self­signed certificate, or one signed by an authority not trusted by Java.

24

Page 26: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

The easiest way to trust a certificate is to use the InstallCert tool available at: http://www.usn.pp.ru/downloads/java/jsse­util­installcert/20140115/export/installcert­usn­20140115.zip Extract the download, open a console cd to <extract folder/installcert­usn­20140115> and run java ­jar installcert­usn­20140115.jar <your server> Example: java ­jar installcert­usn­20140115.jar polarion.youcompany.com When asked to add the certificate to the trust store, confirm addition of the certificate by pressing y. For more details see the following article on the certificate installation tool: http://s­n­ushakov.blogspot.de/2013/11/yet­another­installcert­for­java­now.html

3.3.2.2. Create Sync Profiles For each Artifact Type that you want to synchronize you need to create a Sync Profile. To create one, click on the + New Sync Profile button.

25

Page 27: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

3.3.2.2.1. Step1: Choose which of the End Points is the main one To understand why this step is necessary, you need to understand that Polarion SYNCHRONIZER uses a Central Storage to store the data that is synchronized among the End Points.

This needs to store the data in a format that allows it to transform what it receives into a format that is understandable by the receiver.

For the sake of simplicity, the Central Storage uses the data format used on one of the End Points. This End Point is usually the one where the artifacts of type defined in this Sync Profile were originally created.

For example:

Your business analysts create requirements in Polarion (the first End Point). You want to synchronize these Requirements to the Microsoft TFS server so that the Development team can implement them. You will choose Polarion as your main End Point.

If your people use both servers to create new Requirements, then it won’t matter which End Point you choose to be the main one. Just click the Save button to select the default option.

Select the main End Point by clicking on the option button next to the End Point name, then click the Save button to move to the next step.

3.3.2.2.2. Step 2: Configure the Artifact Type that you want to synchronize in each End Point First you need to choose which Artifact Type to synchronize.

26

Page 28: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

For example if you want to synchronize Requirements in Polarion Business with Requirements in Polarion Dev, you choose Requirements as Artifact Types in each End Point. Click on the Select Artifact Type control to select your desired Artifact Type.

By default, the list of available Artifact Types on each End Point is automatically loaded when you navigate to this page. In rare cases it might happen that somebody changes the project configuration by adding or removing End Points, or Artifact Type attributes while you are on this page in the Administration Console. In this case you need to refresh the data. Click on the gear

button and select the option Reload Artifact Types.

3.3.2.2.3. Step 3: Configure how each Artifact Type is synchronized on each End Point If nothing is configured, the default options are applied: all artifacts of the selected Artifact Type are synchronized.

27

Page 29: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

The available options are:

Query ­ Here you can restrict the synchronization to a subset of artifacts. For example you might want to synchronize only approved Requirements. If no query is defined, all artifacts of the defined type will be synchronized.

Query for Polarion End Point The query is defined in Lucene query syntax. For more info please see http://lucene.apache.org/core/2_9_4/queryparsersyntax.html, or Polarion Help, Polarion Reference > Work Items > Advanced Work Item Querying. Example: All work items (of the type already defined in the Sync Profile) with status approved: status:approved

Query for TFS End Point The query is the part after WHERE in the Work Item Query Language query. For more info please see https://msdn.microsoft.com/en­us/library/bb130155%28v=vs.90%29.aspx. For more info about the field reference please see https://msdn.microsoft.com/en­us/library/ms194971.aspx

28

Page 30: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Examples: All work items (of the type already defined in the Sync Profile) with ID = 2019: [ID] = '2019' All work items that have “iptest” in the Title: [Title] CONTAINS 'iptest' All work items that are in the state “Done”: [State] <> 'Done' All work items that have severity “Critical” or “High”: [Severity] In ('1 ­ Critical', '2 ­ High') All work items that have severity “Critical” or “High” and are in the state “Done”: [Severity] In ('1 ­ Critical', '2 ­ High') AND [State] <> 'Done'

Auto­synchronize new Artifacts ­ Check this option if new artifacts are created in this End Point. For example, if your process is that Requirements are to be created on one server only, you want to check this option so that the new Requirements are synchronized to the other server(s). Then, if someone creates a new Requirement on the wrong server, it will not be synchronized.

Sync out of scope artifacts ­ When you configure to synchronize an item, any subsequent update is also synchronized. However, sometimes it can happen that these updates cause an item to be removed from synchronization. In this case, the latest update is not synchronized and the other End Points won’t know that this item is in an inconsistent state. Check this option if you want to synchronize such updates. For example, if your query is set to synchronize “open Defects” only, when a Defect is closed its status is not synchronized to the other End Point. The Defect will continue to appear as open in the other system. When this option is checked, the status of this Defect is synchronized.

Disable/Enable Incremental Sync ­ Incremental Sync synchronizes only the last changes since the previous synchronization. This is very useful for running real­time synchronizations. When checked, this option disables the incremental synchronization. (It is enabled by default).

Cron for Incremental Sync ­ This option defines the scheduling settings for I Incremental Sync. If set to run every few seconds, it works as a real­time synchronization. By default, it is set to run every 4 seconds. For more information about the cron settings, please see http://en.wikipedia.org/wiki/Cron, or Polarion

29

Page 31: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Help > Polarion Reference > Scheduler cron information and examples.

Disable/Enable Complete Sync ­ Complete Sync synchronizes all items in the query result. It is useful for one time synchronizations, or after an End Point was down for some time, or when the incremental synchronization is not needed. This option is disabled by default.

Cron for Complete Sync ­ This option defines the scheduling settings for Complete Sync. For more information about the cron settings, please see http://en.wikipedia.org/wiki/Cron, or Polarion Help > Polarion Reference > Scheduler cron information and examples.

3.3.2.2.4. Removing an End Point from a Sync Profile By default, when you create a Sync Profile you are asked to choose an Artifact Type for all End Points in the Synchronization. If you don’t want to synchronize all End Points, you can choose to remove an End Point by clicking on the gear button on the top right corner of an End Point and click the Remove option.

For example you have 3 End Points defined in a configuration: one for the Business team, one for the Development team, one for the QA team:

You might want to synchronize the Requirements created by the Business team to both the Development and the QA servers. In this case you define a Sync Profile for all 3 End Points, each of them having the Requirements Artifact Type selected.

30

Page 32: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

However, you might want to synchronize Defects found by the QA team to the Development server only, not to the Business server. In this case you define a Sync Profile only for the Development and the QA servers.

3.3.2.2.5. Removing a Sync Profile Should you decide that you don’t need a Sync Profile, you can remove it by clicking on the gear button on the top right corner of an End Point and choosing the Remove option. This operation cannot be undone.

3.3.2.2.6 Configure Field Mapping You need to map one or more artifact fields of one End Point project to their equivalents on the other End Point, and specify the direction and precedence of synchronization. You only need to configure the mapping between the main End Point and the other End Points. For example, suppose you have End Points A (main), B, and C. You only need to map A ­> B, and A ­> C. You do not need to map B ­> C. To configure the mapping between two End Points in a Sync Profile:

On the Sync Profile screen, click on the + New Mapping button. This button is visible if no mapping has been defined yet.

Click on the icon on the Sync Profile screen. This icon replaces the + New Mapping button when some mapping is already configured.

Click on the gear icon of an End Point box and select the Field Mapping option.

31

Page 33: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

After clicking on the button, icon, or selecting the option, you will be redirected to the field mapping view:

To add a Field Mapping click the + New Field Mapping button.

32

Page 34: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

To customize a Field Mapping:

1. Select a value in the Left Field list. The list contains artifact fields, and the one you select is to be matched with a field of the other End Point: Title, for example.

2. Select a value the Right Field list. The list contains names of fields or attributes of the second End Point.

3. Select an arrow in the list. This specifies if the synchronization is bi­directional (<­­>), or only from the left End Point to the right End Point (­­>), or only from the right End Point to the left one (<­­).

4. If you selected bi­directional in the previous step, you should review and set the conflict resolution.

33

Page 35: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Drag and drop the colored rectangles to set the order. The End Point in the first rectangle from left to right has top priority. If users from both End Points modify the same field at the same time, Polarion SYNCHRONIZER will save only the value of the attribute in the End Point with higher priority. The only exceptions are the Comments and the Attachments, which are both recorded.

5. To define additional field mapping, click the New Field Mapping button.

6. To delete a field mapping, click the button on the left end of that particular field line.

Within field mapping, you can also specify value mapping. This can be particularly useful when you need to synchronize values like Users in a field like Assignee, or an enumeration value in a field like Severity.

34

Page 36: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

On the left side you have the values of the field on the left End Point. For each of them use drag & drop to select the corresponding value(s) of the field on the right End Point.

It is possible to have multiple values mapped to the same value. In case of multiple values mapped, the value in the middle marked in green is the one

that is used for the transformation. Unmapped values are indicated with red. You cannot save a field mapping that has

unmapped values. When you have finished all mapping, click the Save button at the top of the page to save the Field Mapping. If there are other End Points in the Sync Profile, configure the Field Mapping between each of them and the main End Point.

3.3.2.2.7 Fields With Special Mapping

Pre‐defined field mapping To be able to synchronize artifacts, Polarion SYNCHRONIZER needs to know:

Project Name, Artifact ID, Artifact URI.

These fields are pre­mapped by Polarion, therefore you are not allowed to map them as Project to Project, ID to ID, URI to URI. The reason these fields are still available for mapping is for situations when you want to know what values they have in the other application.

35

Page 37: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Example ID is usually assigned automatically by each application based on the internal project rules. It is usually an unique key, and therefore you are not allowed to modify it. If you want to know what ID an item has in the other synchronized application, you can map ID to a custom field.

Read‐only fields Polarion SYNCHRONIZER shows all fields available for an artifact. Some of the fields are automatically assigned by the application. Any attempt to modify them results in an error. Similar to pre­defined mappings, the reason these fields appear in the mapping is to allow them to be mapped to custom fields so that their values are known on the other side of the synchronization.

Examples Fields like Created, Updated, Modified, and Created by that are automatically computed by the application when the respective event occurs. Fields that are defined by the project administrator as read­only in the project configuration.

Attachments To synchronize attachments, simply map the Attachments field with the Attachments field. Do not try to map the Attachments field with some other field.

Comments To synchronize comments, simply map the Comments field with the Comments field. Comments will be appended to any existing ones. No existing comments will be replaced, or deleted. Do not try to map the Comments field with some other field.

Relationships/Links Polarion SYNCHRONIZER can preserve the relationship defined among the synchronized artifacts. To do that, you need to map the Links field with the Links field for each Artifact Type that you synchronize. The challenging part could come in mapping the specific relationship types defined in each application. In general, it is expected that two Polarion applications have similar relationship types. However, between Polarion and TFS, for example, there might be differences, and sometimes significant differences. You will need to decide which relationship maps better with the relationship in the other application. It is possible to map more relationship types to the same relationship type. For example something like “Relates to” or “Is Related to” might be a good compromise for mapping relationships that don’t match.

36

Page 38: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Links to Artifact Types that are not under synchronization are not preserved.

Status Status is a special field because in many applications it is used to define a workflow. When two Polarion applications are synchronized, there is a high probability that the status values and the workflow are the same. In this case, it makes sense to map the Status field with the Status field. However, when two different applications are mapped, or two projects with different templates, the workflows are different. Mapping the Status field with the Status field leads in most cases to breaking the workflow. To avoid this situation, it is recommended that you map the Status field into a custom field. Most of the changes in Status are manual anyway. By seeing the Status of the artifact in the other application, the responsible person can decide which Status should be assigned to the artifact in the current application and change it manually according to the workflow.

3.3.3. Removing a Synchronization There are two ways to remove a synchronization:

On the main Synchronization page (the home page), find the Synchronization that you want to remove, click on the arrow button next to the Synchronization status, then choose the Remove option.

Open the Synchronization details and click on the gear button on the top left side. Select

the Remove option.

37

Page 39: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Once a Synchronization is removed, it cannot be restored. Make sure that you remove only the Synchronizations that you know are not needed.

3.3.4. Duplicating a Synchronization If you have multiple projects with similar configurations (for example, the same project templates, with the same artifact types with fairly same attributes), you might want to reuse the configuration of an existing Synchronization. In this case it is recommended to duplicate a Synchronization, then make any necessary adjustments. To duplicate a Synchronization you can use:

The arrow button next to the Synchronization status on the Synchronizations page, the Duplicate option, or

The gear button on the top left Synchronization page, the Duplicate option.

38

Page 40: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Once a Synchronization is duplicated, a new Synchronization will appear on the main Synchronizations page with identical configuration as the original one. You can then modify the new duplicate configuration. For more details about modifying a configuration, please see Chapter 3.3.7. Edit a Synchronization.

3.3.5. Starting a Synchronization When a Synchronization is created it is not connected to Polarion SYNCHRONIZER. This means that no data synchronization takes place between the defined End Points. This is to avoid trying to synchronize incorrectly configured or incomplete Synchronizations.

IMPORTANT! After you finish configuring a Synchronization, you must explicitly connect it to Polarion SYNCHRONIZER.

To connect a Synchronization to Polarion SYNCHRONIZER you can use:

The arrow button next to the Synchronization status on the Synchronizations page, the Connect option, or

The gear button on the top left Synchronization page, the Connect option.

39

Page 41: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

3.3.6. Stopping or Pausing a Synchronization If you want to pause the data synchronization between End Points configured in a Synchronization you have to disconnect it from Polarion SYNCHRONIZER.

IMPORTANT! When you modify the configuration of a Synchronization you should always disconnect it first.

To disconnect a Synchronization to Polarion SYNCHRONIZER you can use:

The arrow button next to the Synchronization status on the Synchronizations page, the Disconnect option, or

The gear button on the top left Synchronization page, the Disconnect option.

40

Page 42: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

3.3.7. Edit a Synchronization Once a Synchronization is created, you can modify the following:

Update or change the End Point: Name, URL, Username, Password, Project ID. Modify the advanced settings of the End Points in the Sync Profiles: Query, Incremental

and Complete Sync Settings Delete, add Sync Profiles Delete, add Field Mapping.

3.3.7.1. Migrating a server to a different location Sometimes you need to change the location of your server. For example you migrate from Polarin on premise to Polarion CLOUD, or the other way around. If you have synchronization already defined, you don’t need to reconfigure everything. All you need to do is to:

1. Change the End Point URL 2. In case you have a different user with administrator rights that you want to use, change

the Username and Password. 3. Verify that the rest of the configuration: Synchronizations, Sync Profiles, Field Mapping

are without errors. If all you changed is the location of the server, there shouldn’t be any errors. Usually Polarion SYNCHRONIZER shows you alerts in the configuration when there is an error.

41

Page 43: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

3.3.7.2. Changing the Project ID ProjectID is a unique identifier. Normally this cannot be changed. A good scenario where you might want to change it is when you have multiple projects with identical configuration and you want to save time by reusing an existing Synchronization. In this case it is recommended to duplicate a Synchronization, then change the Project ID, and verify if there are any errors. If yes, follow the instructions on the screen to correct them. The most likely errors are:

An Artifact Type defined in a Sync Profile doesn’t exist on the main End Point. The only solution is to remove the Sync Profile. For more information please see Chapter 3.3.2.2.5. Removing a Sync Profile.

An Artifact Type defined in a Sync Profile doesn’t exist on one of the secondary End Points. Follow the instructions on the screen to select another Artifact Type. Alternatively you can create this Artifact Type in the project. You need to use the End Point administrative setting to do it. Polarion SYNCHRONIZER Administration Console cannot modify the project settings. If this is not what you need, remove the Sync Profile entirely.

A field initially mapped in a Sync Profile ­ Field Mapping doesn’t exist, or is of different type. Administration Console will show you the errors on the Field Mapping screen and guide you through fixing them. Fixing involves choosing another field, adding the field in the project, or deleting the mapping for that specific field.

For more information on how to duplicate a Synchronization, please see Chapter 3.3.4. Duplicating a Synchronization.

3.3.8 Resynchronizing After Configuration Changes The platform synchronizes changes incrementally. If you modify the configuration, only new changes are synchronized by default. This means:

If you add an Endpoint to a Synchronization Profile, items will be sent to the added Endpoint only when they are changed.

If you add a field mapping, the field value will be only synchronized if an item is changed.

If you add a value mapping the new mapping is only applied when an item is changed.

42

Page 44: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

If you want to ensure that all configuration changes are applied to resources that have already been synchronized, without requiring any item to be changed, you can invoke the Re­synchronize All Artifacts action on the Sync Profile’s Actions menu:

This action:

Performs a full observation of all Endpoints.

Sends all data from central storage to all Endpoints.

3.4. Monitoring Polarion SYNCHRONIZER Administration Console has a Monitoring screen where you can see the current status of the configured synchronizations:

The Synchronizations that are configured and their statuses: Connected or Disconnected.

The End Points and the messages that are sent from the End Point to Polarion SYNCHRONIZER (outgoing) and received from Polarion SYNCHRONIZER to the End Point (incoming) for each Artifact Type that is being synchronized.

The log.

43

Page 45: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Polarion SYNCHRONIZER uses a messaging system to observe the data that is being modified at the End Points, send it to Polarion SYNCHRONIZER, and distribute it to other End Points according to the configured synchronization settings. The messaging is robust ­ no message is lost in case of failure of the End Points, or Polarion SYNCHRONIZER. There can be situations when Synchronizations are wrongly configured by the user. For example an old configuration is used, or the End Point doesn’t exist, or others. In this case the message is stored by Polarion SYNCHRONIZER, but there is no way to send it to the destination because it is a wrong message and there are no rules defined to decide what to do with it. To avoid having it forever in the queue, it is recommended that you delete it. To delete the messages in a queue, use the gear button next to each Artifact Type and choose to clear Outgoing Messages, or Clear Incoming Messages.

44

Page 46: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

3.5. Users To add or remove users that are allowed to log in the Administration Console, click on the wheel button on the top right side and choose the Users option.

You will be navigated to the Users view where you can add, delete, or modify users:

45

Page 47: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Add ­ Click to add a new user. Save ­ Click to save the users defined in this Users view. Cancel ­ Cancel the modifications done in the Users view since the last Save operation. Username, Password ­ Enter the credentials for the new user.

­ Click to delete the user defined on that line.

Chapter 4 : Polarion® Connector for Polarion®

4.1. Overview Do you use multiple Polarion servers? Do you work with customers, or partners that also use Polarion? Are you spending time on manual operations to exchange data with other teams, or your customers and partners? Are you struggling to get full traceability? Would you like to have the data exchanged seamlessly, and the traceability maintained automatically, without any additional effort? Polarion® Connector for Polarion® seamlessly connects your cross­functional teams by enabling bi­directional synchronization of work items between different Polarion servers. Thanks to a direct integration, disparate teams can collaborate without having to leave their familiar environments. Polarion Connector for Polarion is part of Polarion® SYNCHRONIZER™, designed to enable you to seamlessly integrate disparate applications with Polarion’s unified ALM Solution. It is architected to manage all integrations centrally to speed up development and maintenance.

46

Page 48: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

It provides you with out­of­box access to all integrated applications, eliminating the burden of having to interface with them individually. Here are some scenarios where Polarion Connector for Polarion can help:

You have one server for the engineering team where software is developed and validated, and another server for the product and project management team where requirements are written and managed. You want to give your engineers direct access to all requirements, and at the same time provide your project managers with direct visibility of the development status.

You have a project that is outsourced to be developed abroad. You don’t want to give the development team access to your main Polarion server, but you want them to see the requirements they need to implement.

You are managing customer requests on one Polarion server. The customers have access to this server, they can post questions and they can see the status of their requests. You are using a separate server for the actual development and project management activities. You want your internal team to see what the customers are requesting, but you don’t want your customer to see your internal details.

You have a public server and a private server. You want to be able to synchronize data between the 2 systems, but you want to keep your private data private.

You are working with a partner that uses Polarion. You want to synchronize your requirements to the partner and receive the status updates back.

Let’s have a closer look at this use case example: You have 2 Polarion Servers:

1. The first Polarion server is for Requirements Management and QA Management. Let’s call it “Polarion REQ­QA”

2. The second server is for development. Let’s call it “Polarion DEV”. You want to synchronize the User Stories and Defects to the development server so that the development team knows what to implement, and the status of the User Stories and Defects to the requirements server so that the Product and QA teams can monitor the status of the implementation. With Polarion Connector for Polarion these User Stories and Defects are synchronized seamlessly, meaning that all changes to your items are propagated to the other server automatically. Hence one single source of truth is maintained on both servers.

47

Page 49: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

48

Page 50: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

4.3. How to configure You don’t need to do anything additional to install the Connector. By installing Polarion SYNCHRONIZER you already have access to it. The configuration of the Connectors is similar, there are no significant changes to the general configuration of Polarion SYNCHRONIZER. For more information please see Chapter 3: Polarion SYNCHRONIZER Administration Console.

IMPORTANT

Polarion SYNCHRONIZER synchronizes Work Items only. It doesn’t synchronize Polarion Documents. It is possible to recreate the Documents manually by synchronizing the Document Name and Outline Number within that Document in separate custom fields.

4.4 Synchronizing Test Step Changes Between Polarion Servers If you synchronize Test Steps between two Polarion servers, and you subsequently change the configuration of Test Steps on one server, the synchronization of Test Steps will stop. To restart the synchronization, you need to update the relevant Synchronization Pair. Simply open the Synchronization Pair and save it.

Chapter 5: Polarion® Connector for Microsoft® TFS

5.1. Overview Microsoft Team Foundation Server (TFS) is the collaboration platform at the core of Microsoft's application lifecycle management solution, and used by Development and QA teams collaborating with the Microsoft development ecosystem. TFS has features for Task Management, Test Case Management and Agile Planning and Collaboration. Polarion® Connector for Microsoft® TFS connects Microsoft Team Foundation Server with Polarion by enabling bi­directional synchronization of work items between Polarion and Microsoft TFS. Thanks to a a seamless integration, disparate teams can collaborate without having to leave their respective work environments. Polarion Connector for Microsoft TFS is part of the Polarion® SYNCHRONIZER™, which enables you to seamlessly integrate disparate applications with Polarion’s unified ALM Solution, as well as to manage all integrations centrally to speed up development and maintenance. It provides you with out­of­box access to all integrated applications without having to worry about interfacing with any of them individually.

49

Page 51: Polarion ® SYNCHRONIZERdownloads.polarion.com › downloads › polarion › 2015 › ...Microsoft Team Foundation Server 2015 2.2. Hardware Requirements ... Java™ Platform, Standard

Here are some scenarios where Polarion Connector for Microsoft TFS can help: Your product and project management teams are using Polarion for managing

requirements, while your development teams are using Microsoft TFS for actual development and testing. You want to give your engineers direct access to all requirements, and at the same time provide your project managers with direct visibility of the development status.

Your product and QA teams are using Polarion for managing requirements and test specifications, while your Development teams are using Microsoft TFS for actual development. You want to give your engineers direct access to requirements and defects, and at the same time provide your product team with direct visibility into the development and defect status as well as with direct access to information to create compliance reports necessary.

5.2. How to configure You don’t need to do anything additional to install the Connector. By installing Polarion SYNCHRONIZER you already have access to it. The configuration of the Connectors is similar, there are no significant changes to the general configuration of Polarion SYNCHRONIZER. For more information please see Chapter 3: Polarion SYNCHRONIZER Administration Console.

50