SOX - Polarion Connection Setup

This configuration relies on the library exposed for this purpose by Polarion. The setup happens server-side by editing an XML file in order to create and configure a technical user. It is recommended to identify this entity as a SOX user in order to make it clear at all times who made certain changes and/or transactions.

Polarion Demonstration Video

See below for a tutorial on how to interact with the Polarion interface. Note that this demo presumes the completion of the server-side configuration mentioned before.

Open

Configure Synchronization

1. Initiate the process by right-clicking your project. Select Configure Synchronization:

   Open

   

2. Outcome: this performance will call the Synchronization Configuration Editor, which, in the context of our example scenario, contains a single entry (the “test” project).

3. Select New Child > Polarion Projects > E-Library. - Outcome: the example project “E-Library” will be added to the Editor window.

4. Next, you need to query the Shapes (artifact types) in your Polarion project in order to create new Default Shape Definitions. This is done by right-clicking on your project, our example being project “E-Library” once again. Select New Child > Import Shape Definitions. - Outcome: the “Create Default Shape Definitions” dialog will open.

5. Select Polarion Query and click OK. - Outcome: SOX will initiate a server-side query (in technical terms, the SOX server will query the Polarion server). The SOX client will then display the results, i.e. the complete set of Instance Shapes (artifact types) found in Polarion. SOX can now work on any property structure defined for a given artifact type. Expressed differently, the data structure definition established Polarion-side will now be available for working on with the SOX interface.

6. You can now open the drill-down list to review any field/property definition.

7. Next, there exists an option to create a new Group Definition, corresponding to a DNG module (i.e., a logical, hierarchical container for requirements). In the SOX context, a Group references a ReqIF document. Right-click your project once again and select New Child > Group Definition. - Outcome: the Group Definition will display in the editor.

8. It is good practice to change the generic name to something more descriptive, e.g., “Requirement”. Also, in order successfully to query the Polarion system for item definitions (on which see below), edit the Properties as suggested by the following screenshot:

9. You will further need to create default Item Definitions. To accomplish this, right-click the Requirement Group Definition and select New Child - Import Item Definitions.

   - Outcome: SOX will query the specified Polarion module in order to determine which artifact types are present in the relevant requirements subset. These will be displayed accordingly. In our scenario, Polarion returns precisely one type, “requirement”. Further properties can then be modified as required.

Synchronizing Your Project

It is now possible to initiate the synchronization process. To do so, right-click your SOX project. - Outcome: after briefly displaying a progress indicator, SOX will report the Model Synchronization Statistics:

SOX will then display the results and prompt you to open the associated perspective (Requirements) if so desired.

Assuming that you affirm, the Requirements perspective will open to something of this appearance:

It is possible to edit a requirement, and to sync back the changes made to Polarion.

You further have the option to create new requirements, which can then be added to the Polarion system using the synchronization logic discussed before.

Sign-In and Timeout Logic

Access to, and use of, the interface requires valid user credentials. The system will prompt you accordingly:

In case the user name and/or password is/are not recognized, the prompt will refresh itself until such time as the user provides acceptable credentials or cancels the process.