Edition 1.1 PVCS. Dimensions. Content Manager Integration Guide

Size: px

Start display at page:

Download "Edition 1.1 PVCS. Dimensions. Content Manager Integration Guide"

Emery Barber
5 years ago
Views:

1 Edition 1.1 PVCS Dimensions Content Manager Integration Guide

2 Copyright 2001 MERANT. All rights reserved. Printed in the U.S.A. DataDirect, INTERSOLV, Micro Focus, Net Express and PVCS are registered trademarks, and PVCS Content Manager, DataDirect Connect, MERANT, PVCS Dimensions, PVCS Metrics, PVCS Pulse, PVCS Replicator, PVCS TeamLink, PVCS Tracker, PVCS TrackerLink, PVCS Version Manager, PVCS VM Server and WishLink are trademarks of MERANT. All other trademarks are the property of their respective owners. ACKNOWLEDGEMENT. PVCS Dimensions is implemented using the ORACLE relational database management system. ORACLE is a registered trademark of Oracle Corporation, Redwood City, California. No part of this publication, with the exception of the software product user documentation contained on a CD-ROM, may be copied, photocopied, reproduced, transmitted, transcribed, or reduced to any electronic medium or machine-readable form without prior written consent of MERANT. Licensees may duplicate the software product user documentation contained on a CD-ROM, but only to the extent necessary to support the users authorized access to the software under the license agreement. Any reproduction of the documentation, regardless of whether the documentation is reproduced in whole or in part, must be accompanied by this copyright statement in its entirety, without modification. U.S. GOVERNMENT RESTRICTED RIGHTS. It is acknowledged that the Software and the Documentation were developed at private expense, that no part is in the public domain, and that the Software and Documentation are Commercial Computer Software provided with RESTRICTED RIGHTS under Federal Acquisition Regulations and agency supplements to them. Use, duplication or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of The Rights in Technical Data and Computer Software clause at DFAR et. seq. or subparagraphs (c)(1) and (2) of the Commercial Computer Software Restricted Rights at FAR , as applicable. Contractor is MERANT, 9420 Key West Avenue, Rockville Maryland Rights are reserved under copyright laws of the United States with respect to unpublished portions of the Software. MERANT 9420 Key West Avenue, Rockville Maryland 20850

3 3 Content Manager Integration For this section... See page... Introduction 4 Requirements 4 Setting Up the Integration 5 Initiating a Transfer 11 Viewing Information About Transferred Items 14

4 4 Content Manager Integration Introduction PVCS Dimensions includes a utility to integrate its SCM functions with PVCS Content Manager. Through this integration, files developed under Dimensions control are automatically transferred to the Content Manager repository when they reach a predetermined point in their lifecycle, such as being ready for testing or deployment. Requirements To enable the integration with Dimensions, you need the following: An installation of PVCS Dimensions Server, version 7.0 or higher PVCS Content Manager, version 2.0 or higher An installation of JRE or greater on the system hosting the Dimensions server NOTE You must add the directory containing the JVM.DLL to the system path. A Dimensions release baseline that contains the items to be transferred to Content Manager A Content Manager project to which to transfer the Dimensions items

5 Setting Up the Integration 5 Setting Up the Integration After all the software is installed and you have created a Dimensions baseline containing the items you wish to transfer to Content Manager, you are ready to configure the integration. The integration must be configured on the system hosting the Dimensions server. To set up an integration between a Dimensions baseline and a Content Manager project, you must do the following: 1 Create a setup file: In the setup file, you specify the information needed to implement the integration, including: The name of the Dimensions product that contains the baseline(s) The type of baseline(s) to transfer The lifecycle state that triggers the transfer The host name of the Content Manager server The Content Manager publish location to map to each Dimensions item path 2 Parse the setup file: This step loads the setup information into the Dimensions database. The transfer will take place once a baseline matching the trigger criteria is actioned to the specified lifecycle state.

6 6 Content Manager Integration Creating a Setup File The setup file is a simple XML file in which you specify the information needed to complete the integration. It must be of the following form: <cmlink> <transfer name="transfername" approve="tf"> <product>productname</product> <type>baselinetype</type> <from-state>startstate</from-state> <to-state>endstate</to-state> <base-url>hostname</base-url> <mapping-name>mapname</mapping-name> </transfer> <mapping name="namedef"> <map pattern="itempath" location="/publish"/> </mapping> </cmlink> NOTE A setup file template, template.xml, is included in the cmlink directory under the root directory of the Dimensions server installation. Starting with the template file, use your text editor or XML editor to define the elements of the setup file as described in the following table. This element... <cmlink> <transfer name="transfername" approve="tf"> Is... You may define multiple transfers within a single setup file. Attributes: - name - approve

7 Setting Up the Integration 7 This element... name="transfername" approve="tf" <product>productname</product> <type>baselinetype</type> <from-state>startstate</from-state> Is... Set TransferName to the name you choose for the transfer definition, which can be used as a parameter in commands. Optional The default is "false". Set to "true" to make the transferred items approved assets within Content Manager. Set ProductName to the name of the Dimensions product that contains the baselines to transfer. Set BaselineType to the type of baseline you want to transfer. NOTE To see what type a baseline is, open the baseline in Dimensions and right-click on it. Select Properties from the resulting popup menu. The Properties dialog box appears. Use the value from the Type Name field NOT the Type field. Optional Set StartState to the lifecycle state from which the baseline is actioned. If a StartState is specified, only baselines actioned from the StartState to the EndState are transfered. If no StartState is specified, all baselines actioned to the EndState will be transfered regardless of what lifecycle they were actioned from.

8 8 Content Manager Integration This element... <to-state>endstate</to-state> <base-url>hostname</base-url> <mapping-name>mapname </mapping-name> <mapping name="namedef"> <map pattern="itempath" location="/publish"/> Is... Set EndState to the lifecycle state that triggers the transfer. NOTE The <from-state> element can specify further conditions that must be met to trigger the transfer. Set HostName to the host name of the Content Manager server. Set MapName to specify the mapping definition to use for the transfer. Multiple transfer definitions may refer to the same mapping. Set NameDef to define the name of the mapping definition. You may define multiple map elements within a mapping. Attributes: - pattern - location

9 Setting Up the Integration 9 This element... pattern="itempath" location="/publish" Is... Set ItemPath to a wildcard pattern that matches the path of the items in the baseline. If there are items in the baseline that you do not want to transfer, construct the patterns to exclude them. NOTE For each item, the publish location associated with the first match is used, so place the most specific patterns (*/MyFiles/ f?o.c) before the more general ones (**). Set Publish to the Content Manager publish location to which the items will be transfered. If the specified publish location does not exist, it is created. NOTE This value must start with a forward slash ( / ) followed by the name of the Content Manager project. The Content Manager project must already exist. Parsing the Setup File Once you have created the setup file, you must run the CMLINK command to parse the file and load the transfer definitions contained in the file into Dimensions. The CMLINK command must be issued from a command prompt on the Dimensions server and be of the following form: cmlink [-option] [-option] [-option]

10 10 Content Manager Integration The CMLINK command has the following options: Use this option... To... -s Path/SetupFile.xml Parse the setup file and load it into Dimensions. You must specify the name and location of the setup file. NOTE You will be prompted for a Content Manager user name and password for each base-url in the setup file. You must be a valid user for the target project(s) and have at least the Create Asset, Create Folder, Modify, and Approve permissions. -d Database Specify your Dimensions user database name for the Dimensions database to which the operation will apply. The default is the current value of the PCMSDB symbol in the environment. NOTE This option must be used in conjunction with one or more of the other options. -l Generate a list of the currently defined transfers as an XML document and write it to standard output. NOTE To save this data as a file, use the following syntax: cmlink -l > FileName.xml -t TransferName Specify the name of the transfer definition you want to manually initiate. This is used in conjunction with the -b option. NOTE Transfers are normally triggered from Dimensions by actioning a baseline to the specified lifecycle state. This option manually initiates the transfer. -b "Product:Baseline" Specify the name of the baseline to transfer and the name of the product that contains it. This is used in conjunction with the -t option to manually initiate a transfer. NOTE The transfer will be initiated only if the baseline is at the lifecycle state defined in the <to-state> element of the transfer definition and is of the specified baseline type.

11 Initiating a Transfer 11 Use this option... To... -x Delete all currently defined transfers from the Dimensions database. NOTE You can use the -d option to specify a database. Example To parse a setup file named BigWeb.xml that is located in the Transfer directory of your D drive, you would enter the following command: cmlink -s D:\Transfer\BigWeb.xml You would then be prompted for a Dimensions user name and password. NOTE The PCMSDB symbol must be set to the correct Dimensions user database name for the user and database in question. Else, the CMLINK command will be unable to access the Dimensions database. To set the PCMSDB symbol, use the -d option with the CMLINK command or use the SET command at the command-line. Initiating a Transfer Once you have parsed the setup file, there are two ways to initiate the transfer of baselined items to Content Manager: Automatically: From Dimensions, action a baseline to the lifecycle state specified in the setup file. Manually: From the command line of the Dimensions server, issue the cmlink command with the -t and -b options.

12 12 Content Manager Integration In either case, the following rules apply: If the specified publish location does not exist, it will be created. However, the specified Content Manager project must already exist. If an asset with the specified URL already exists, one of the following will occur: If the content and properties of the Dimensions item are different than those of the existing Content Manager asset, the item will be transfered to a new revision of the asset. If the content and properties of the Dimensions item are the same as the existing Content Manager asset, the item will not be transfered nor will the revision of the asset be incremented. User Requirements to Initiate a Transfer In order to successfully initiate a transfer, you must meet at least one of the following criteria: You have a PRODUCT-MANAGER role for the relevant Dimensions product. Your pending list contains all of the items to be transfered. IMPORTANT! If you do not meet the transfer criteria, the Dimensions attributes will be improperly updated.

13 Initiating a Transfer 13 Automatically Transfer Baselines The transfer will occur automatically once a qualifying baseline is actioned in Dimensions in accordance with the criteria specified in the setup file. The criteria are met when you action a baseline: Of the specified type Located in the specified Dimensions product To the specified lifecycle state More restrictive criteria may also specify the lifecycle state that the baseline must be actioned from. For more information on specifying the criteria that initiate a transfer, see Creating a Setup File on page 6. Disabling Automatic Transfers You can disable the automatic transfer of baselines by adding the following line to the PCMS.CFG file: PVCS_DISABLE_CMLINK 1 To re-enable the automatic transfer of baselines, delete the "1" at the end of the line or delete the entire line. NOTE The PCMS.CFG file is located in the root directory of the Dimensions server installation.

14 14 Content Manager Integration Manually Transfer Baselines To manually initiate a transfer, enter the following command from the command line of the Dimensions server: cmlink -t TransferName -b "Product:Baseline" Where: TransferName equals the name of the transfer definition as specified in the setup file. Product equals the name of the Dimensions product that contains the baseline. Baseline equals the name of the baseline to transfer. For more information on the use of the cmlink command, see Parsing the Setup File on page 9. NOTE The transfer will be initiated only if the baseline is at the lifecycle state defined in the <to-state> element of the transfer definition and is of the specified baseline type. Viewing Information About Transferred Items Once an item is transfered from Dimensions to Content Manager, you can view item properties related to the transfer from either program.

15 Viewing Information About Transferred Items 15 Viewing Information in Content Manager In addition to the normal Content Manager properties, you can view the following attributes for any items transferred into Content Manager from Dimensions: Dimensions baseline specification Dimensions item baseline path Dimensions item specification Dimensions item status For each item, this information is displayed in the General view of the Properties window. You can also search using these attributes. Using the Content Manager Properties Window To invoke the Properties window for an item: 1 In Content Manager, select the Asset view and navigate to the folder that was the destination of the transfer. 2 Click the More ( ) button next to the item for which you want information. A pop-up menu appears.

Searching on Dimensions Attributes in Content Manager To search on Dimensions attributes: 1

16 16 Content Manager Integration 3 Select Properties. The Properties window appears. The Dimensions related properties are at the bottom of the Properties window. Searching on Dimensions Attributes in Content Manager To search on Dimensions attributes: 1 In Content Manager, select the Asset Search view. 2 Select a Dimensions attribute from the first drop-down list.

17 Viewing Information About Transferred Items 17 NOTE If no Dimensions attributes are listed, the Content Manager project has not received a transfer from Dimensions. 3 Specify other search criteria as needed and click the Search button. Viewing Information in Dimensions In addition to the normal Dimensions attributes, you can view the following attributes for any items transferred into Content Manager from Dimensions: Content Manager URL to which each item was copied Version of the Content Manager asset Date and time of the transfer Identity of the originating baseline This information is available through the Edit Attributes dialog box. You can also search using these attributes. Using the Dimensions Edit Attributes Dialog Box: To invoke the Edit Attributes dialog box: 1 In Dimensions, open the baseline that was transfered and navigate to the item for which you want information. 2 Right-click on the desired item. A pop-up menu appears.

18 18 Content Manager Integration 3 Select Edit Attributes. The Edit Attributes dialog box appears. If the item has been transfered to Content Manager: The Attributes column contains the following entry: PVCS Content Manager URL The Values column contains a string of individual values separated by vertical rules ( ): //Base_url//Project_url Version Date-Time Baseline

Viewing Information About Transferred Items 19 Searching on Content Manager Attributes in Dimensions To search on Content Manager Attributes: 1 From the Dimensions GUI, select Edit Find Item.

19 Viewing Information About Transferred Items 19 Searching on Content Manager Attributes in Dimensions To search on Content Manager Attributes: 1 From the Dimensions GUI, select Edit Find Item. The Find Item dialog box appears. 2 Select an item type from the Type drop-down list. IMPORTANT! You must select an item type in order to search on Content Manager attributes. 3 Specify values for other fields, as needed, to narrow your search.

20 Content Manager Integration 4 Select the Attributes tab. 5 Enter your search criteria in the Values field of the PVCS Content Manager URL attribute.

20 20 Content Manager Integration 4 Select the Attributes tab. 5 Enter your search criteria in the Values field of the PVCS Content Manager URL attribute. Your search criteria must be in the form of a string of individual values separated by vertical rules ( ): //Base_url//Project_url Version Date-Time Baseline You can use the usual Dimensions wildcards. For example, % % % % would return all items that have been transfered to Content Manager. NOTE If the PVCS Content Manager URL attribute is not listed, no items matching the selected item specifications have been transfered. 6 Select the Find Now tab to view the results of the search.

Micro Focus. Enterprise View. Installing Enterprise View

Micro Focus. Enterprise View. Installing Enterprise View Micro Focus Enterprise View Installing Enterprise View Copyright 2010 Micro Focus (IP) Ltd. All rights reserved. Micro Focus (IP) Ltd. has made every effort to ensure that this book is correct and accurate,