Refer to the Micro Focus Community and Micro Focus Connect User Guide for further configuration instructions. Pivotal Connector for Micro Focus Connect (pivotal connector) lets you synchronize Pivotal assets. This readme describes how to configure pivotal connector.
Copyright 2018 - 2023 Open Text.
The only warranties for products and services of Open Text and its affiliates and licensors ("Open Text") are as may be set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. Open Text shall not be liable for technical or editorial errors or omissions contained herein. The information contained herein is subject to change without notice.
Except as specifically indicated otherwise, this document contains confidential information and a valid license is required for possession, use or copying. If this work is provided to the U.S. Government, consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license.
Contents | ||
---|---|---|
Installation and Upgrade Information | Technical Notes | |
Prerequisites | Known Issues | Need assistance with the product? |
This section lists prequisites required to successfully install, configure, and run pivotal Connector.
This connector requires at least build 23.4 of Micro Focus Connect and can be configured using the Micro Focus Connect UI. You can download the latest version of Micro Focus Connect from the Micro Focus SupportLine (http://supportline.microfocus.com) navigating to the latest Micro Focus Connect installation.
The following are required to run the Pivotal Connector (and may not be already installed). For further configuration instructions, see the Micro Focus Connect Release Notes.
Once you have collected the required JAR files, copy them to your Micro Focus Connect root directory.
Go to https://supportline.microfocus.com/productdoc.aspx to obtain download.
The following information contains notes regarding installation, but does not replace the entire process.
The process for configuring Pivotal Connector involves the following steps:
Each of these steps is described in the following sections.
In order to configure Pivotal Connector, you must:
These procedures are described in the following sections. For all of them, refer to your product documentation if you need additional information.
As mentioned earlier in this section, Micro Focus Hub includes key and link fields to use to map AccuRevPivotal assets to those in AccuRev -- ExternalID and ExternalURL, respectively. There is no need to create additional fields in Micro Focus Hub for this purpose.
To create issue key and issue link fields in PIVOTAL:
The Project Customization window appears.
The Project Entities page opens.
The last step in this stage of the Pivotal Connnector configuration process is to enable the History setting for the fields in the asset types you plan to map to AccuRev.
The Project Customization window appears.
The Project Entities page opens.
In addition to this readme, the Pivotal Connector package includes a configuration file called Connect.xml.sample. This XML file contains default settings to help streamline the Pivotal Connector configuration process in Micro Focus Connect. You use this stage of the configuration process to incorporate values for default settings in your system's Connect.xml file:
<DataSource>
element from Connect.xml.sample and paste it in the appropriate location in Connect.xml.<Synchronization>
element.url=
path to the Connect.xml file that is in the StarFlow Extensions\Connect directory where you installed AccuRev (c:\Program Files\Micro Focus\CM Hub 14.0\Projects\StarFlow Extensions\Connect\, for example)user_directory=
path to the data directory for Micro Focus Connect (c:/Program Files/Micro Focus/Micro Focus Connect/data, for example)Note: The slashes in the user_directory=
path must be forward ( / ) slashes.
Micro Focus Connect uses the Connect.xml file to configure connectors like the Pivotal Connector. You merged default Pivotal data source and connection configuration settings into your system's Connect.xml file in the previous step. In this stage of the configuration process, you review default Pivotal data source configuration settings and, where necessary, modify them for your installation.
You perform all of the procedures described in this section using Micro Focus Connect.
A Note About Pivotal Data Sources
In Pivotal every project is associated with its own database. Because a Connector data source is likewise associated with a single project, you will need to create multiple data sources for your Pivotal Connector if you are synchronizing multiple projects with AccuRev.
The default Pivotal Connector configuration includes the definition for a single data source. Use the procedure described here to create others as needed. Refer to Using Micro Focus Connect for more information if you need help.
Use Micro Focus Connect to review the default Pivotal data source that is defined in your Connect.xml. See Using Micro Focus Connect for more information on using the Micro Focus Connect GUI.
Pivotal Server Fields
Pivotal Database Fields
Types
The Types field lists the Pivotal asset types you plan to synchronize. They are entered in a colon-separated list as follows:
Defect:Requirement:Release-Cycle:Test
Parent IDs for Requirement, Release-Cycle, and Test Asset Types
You need to specify the IDs for the parent objects of Requirement, Release-Cycle, and Test asset types. In the Micro Focus Connect GUI, these fields are:
Requirement Parent Folder ID field:
Find the value for this field by locating the Req ID field in the Requirements Module window in Pivotal.
Cycle Parent Folder ID field:
http://ServerIP:Port/qcbin/rest/domains/DomainName/projects/ProjectName/releases
Field Name="name"><Value>My Release</Value>
, for example.Field Name="id"><Value>1008</Value>
, for example.)Test Parent Folder ID field:
http://ServerIP:Port/qcbin/rest/domains/DomainName/projects/ProjectName/test-folders
Field Name="name"><Value>My Tests</Value>
, for example.Field Name="id"><Value>1007</Value>
, for example.)Micro Focus Hub connects to the Pivotal data source you just defined. Note that the assets are already defined in the Type list.
In Step 1. Create Key and Link Fields you created issue key and issue link fields in both AccuRev and Pivotal as summarized here:
Issue Key Fields | AccuRev | Pivotal |
---|---|---|
ExternalID | AccuRevIssueKey |
Issue Link Fields | AccuRev | Pivotal |
---|---|---|
ExternalURL | AccuRevIssueLink |
When you created the AccuRevIssueKey and AccuRevIssueLink fields in Pivotal, Pivotal created internal names for these fields. For example, the internal name for the AccuRevIssueKey might be user-05. In this stage of the configuration process, you need to find the internal name for the AccuRevIssueKey and AccuRevIssueLink fields and record them for use later in the Pivotal Connector configuration process.
To find the internal name for AccuRevIssueKey and AccuRevIssueLink user fields:
http://ServerIP:Port/qcbin/rest/domains/DomainName/projects/ProjectName/customization/entities/Component Type/fields
<Field Label>=AccuRevIssueKey"
and record the value of the Name
attribute. (It will be something like Name="user-05"
.)<Field Label>=AccuRevIssueLink"
. Again, record the value of the Name
attribute.Tip: In the final two steps, you will need enter the internal names for the Pivotal user fields that correspond to the AccuRev fields. Consider creating a table like this to record the Pivotal internal names for easy reference.
AccuRev | Pivotal | Pivotal Internal Name |
---|---|---|
ExternalID | AccuRevIssueKey | user-02 (for example) |
ExternalURL | AccuRevIssueLink | user-04 (for example) |
In this stage of the configuration process, you use Micro Focus Connect to review default Pivotal connect settings for your Pivotal data source and, where necessary, modify them for your installation. Connection settings include property maps, value maps, and other settings that specify what gets synchronized between the Pivotal and AccuRev systems. See Using Micro Focus Connect for more information on using the Micro Focus Connect GUI.
The Update Connection window appears. The Data Source tab is selected by default. This tab displays the data source configuration you specified in Step 3. Review and Modify Default Pivotal Data Source Settings.
The Types and Properties tab appears. The Enabled Types table displays the Pivotal types and properties that will be synchronized with corresponding types and properties in AccuRev, and the direction in which changes will flow. The default direction is Bi-directional -- changes made in one system will be synchronized in the other, and vice versa. (Note that in the Connect.xml, AccuRev is considered the "source" system and Pivotal is considered the "target" system.)
Property Mappings
The following tables list the default property mappings for Release-Cycle, Defect, Requirements, and Test asset types.
Pivotal Property | AccuRev Agile Property |
---|---|
name | Name |
start-date | StartDate |
end-date | EndDate |
the value of the internal name that corresponds to the AccuRevIssueKey field you recorded in Step 4. | ExternalID |
the value of the internal name that corresponds to the AccuRevIssueLink field you recorded in Step 4. | ExternalURL |
Note that you must also create value maps for the Severity and Status properties as described in the Value Maps section that follows this step.
Pivotal Property | AccuRev Agile Property |
---|---|
name | Synopsis |
description | Description |
severity | Severity |
status | Status |
detected-by | CreatedUserID |
the value of the internal name that corresponds to the AccuRevIssueKey field you recorded in Step 4. | ExternalID |
the value of the internal name that corresponds to the AccuRevIssueLink field you recorded in Step 4. | ExternalURL |
Note that you must also create value maps for the Status properties as described in the Value Maps section in the Value Maps section that follows this step.
Pivotal Property | AccuRev Agile Property |
---|---|
name | Name |
req-comment | Description |
status | Status |
owner | CreatedUserID |
the value of the internal name that corresponds to the AccuRevIssueKey field you recorded in Step 4. | ExternalID |
the value of the internal name that corresponds to the AccuRevIssueLink field you recorded in Step 4. | ExternalKey |
Pivotal Property | AccuRev Agile Property |
---|---|
name | StTaskName |
description | RichDescription |
owner | CreatedUserID |
the value of the internal name that corresponds to the AccuRevIssueKey field you recorded in Step 4. | ExternalID |
the value of the internal name that corresponds to the AccuRevIssueLink field you recorded in Step 4. | ExternalURL |
In this section of the connection configuration, you review the value maps for Defect and Requirement asset types.
The Value Maps dialog box appears.
Pivotal Value | AccuRev Agile Value |
---|---|
1-Low | Low |
2-Medium | Medium |
3-High | High |
Pivotal Value | AccuRev Agile Value |
---|---|
New | New |
Open | Open |
Fixed | Fixed |
Rejected | Cannot Reproduce |
Pivotal Value | AccuRev Agile Value |
---|---|
Blocked | Submitted |
Failed | Rejected |
Passed | Accepted |
N/A | Draft |
Project Maps
In this section of the connection configuration, you map the AccuRev and Pivotal projects you want to synchronize.
The Project tab appears. You should see default values "PIVOTALConnector" and "Test". Unless these happen to be the names of your AccuRev and PIVOTAL projects, you will need to change them.
In the the final stage of the connection configuration, you review the keys that are used to establish links between records in AccuRev and Pivotal. You perform the following procedure for each asset type you are synchronizing: Release-Cycle, Defect, Requirement, and Test.
The Edit Type dialog appears.
Once you have successfully configured the Pivotal Connector, your pivotalSync connection should start running. Refer to the Micro Focus Connect Dashboard for ongoing status information for pivotalSync and any other connections you have configured.
When selecting a fallback user a message will state there are no users.
There are no technical notes for this release.
Get support enables you to open a support incident or to submit a bug. You can also browse many helpful support resources.