Installation and User Guide Worksoft Certify Content Merge

Transcription

1 Installation and User Guide Worksoft Certify Content Merge Worksoft, Inc Dallas Parkway, Suite 855 Addison, TX

2 Worksoft Certify Content Merge Installation and User Guide Version Copyright 2018 by Worksoft, Inc. All rights reserved. Worksoft is a business name of Worksoft, Inc. Information in this document is subject to change and revision without notice. The software described herein may only be used and copied as outlined in the Software License Agreement. No part of this manual may be reproduced by any means, electronic or mechanical, for any purpose other than the purchaser s personal use, without prior written permission from Worksoft. Worksoft provides this documentation as is without warranty of any kind, either express or implied. Worksoft may revise information in this document without notice and does not represent a commitment on the part of Worksoft, Inc. Worksoft, Inc. may have patents or pending patent applications covering subject matter in this document. The furnishing of this document does not give you any license to these patents except as expressly provided in any written license agreement from Worksoft, Inc. Patent Worksoft Certify U.S. Patent No. 7,600,220 Trademarks Worksoft Certify is a registered trademark of Worksoft, Inc. Microsoft Office is a registered trademark of Microsoft Corporation in the United States and/or other countries. Microsoft is a registered trademark of Microsoft Corporation in the United States and/or other countries. PN WCCM

3 Table of Contents Chapter 1 Installing Content Merge Overview Before You Begin Installation Memory Requirement Installing the Content Merge Utility Chapter 2 Using Content Merge Copying Items From One Database To Another Database Configuring Content Merge Resolving Name Collisions Matching Source Items Showing Differences Between a Source and Target Item Chapter 3 Best Practices for Merging Content Merging Projects Merging Processes Merging Applications, Application Versions, and Map Objects Merging Layouts and Recordsets Worksoft Certify Content Merge Installation and User Guide 3

4 Chapter 1 Installing Content Merge In This Chapter Overview... 5 Before You Begin Installation... 5 Installing the Content Merge Utility... 6 Worksoft Certify Content Merge Installation and User Guide 4

5 Overview Overview With the Worksoft Certify Content Merge utility, you are able to copy Certify items from one project to another either in the same database or a different database. The feature set of Content Merge allows several abilities to control the behavior of copying these items from one project to another. You can copy all or selected Certify items including: Requirements Processes Layouts Recordsets Variables Attributes Windows and map objects that are associated with processes being merged are copied even though they do not appear in the Content Merge utility. Applications and application versions also are copied on demand when you copy processes. You have the option to merge application and application versions. The only item that will not be copied are test results. Before You Begin Installation In order for the transfer of information to occur, you must meet the following prerequisites: Must have administrative rights to both databases Back up the Certify source and target databases Both Certify databases must have the same Worksoft Certify version, and they must have the same hot fixes applied to both databases Both Certify databases must have the same ICL data in the Interface Libraries Memory Requirement Content Merge consumes a large amount of memory because of the amount of data that is being copied. For users who have a 32-bit operating system, your system will only provide 2.5 GB of memory, even if your system has additional memory. When you merge data, there is the risk of running out of memory if the content merge includes a large amount of data. If Content Merge for 64-bit software is used, the 64-bit operating system does not have this memory constraint. Worksoft provides both a 32-bit version and 64-bit version of Content Merge. Worksoft recommends that you use a 64-bit operating system with our 64-bit version of Content Merge to fully utilize all available memory. Worksoft Certify Content Merge Installation and User Guide 5

6 Installing the Content Merge Utility Installing the Content Merge Utility Worksoft recommends that you install Content Merge in a separate directory from Worksoft Certify and suggests that you install the product in the following directory: C:\Program Files\Worksoft\Content Merge. Before you begin to install the product, review installation prerequisites and back up both databases. To install the Content Merge utility: 1 Unzip the Worksoft Certify Content Merge.zip file into the following directory: C:\Program Files\Worksoft\Content Merge If you are using Content Merge on a machine or server that does not have Certify, then copy the zip file and unzip it anywhere on that machine. 2 Optional: In your..\worksoft\certify\client directory, copy the Worksoft.Certify.exe.config file and paste the file into the C:\Program Files\Worksoft\Content Merge\ContentMerge directory. If you do not copy the configuration file to the Content Merge directory, then you will need to provide the database details when you open Content Merge. 3 Double-click Worksoft.ContentMerge.exe to open the Content Merge utility. Before you begin the Content Merge process, check to see if there are any available patches. Check for the latest patches on the Worksoft Community Server and install the latest available patch. 6 Worksoft Certify Content Merge Installation and User Guide

7 Chapter 2 Using Content Merge In This Chapter Copying Items From One Database To Another Database... 8 Resolving Name Collisions Matching Source Items Showing Differences Between a Source and Target Item Worksoft Certify Content Merge Installation and User Guide 7

8 Copying Items From One Database To Another Database Copying Items From One Database To Another Database With the Content Merge utility, you can copy over an entire project, processes, or selected items from one database to another database. Worksoft recommends merging processes instead of projects because it provides a clean target database because it does not copy items that are not needed. All the items you need for processes will be copied to the target database. By selecting processes, the following items will be automatically merged: Applications Application versions Objects Variables Layouts Recordsets If recordsets are used in processes indirectly through the use of variables, then you will need to manually select and merge these recordsets. If you selected only applications and application versions to merge, then all map objects will be copied, including the objects that are not used. For more information about best practices in merging content, see Chapter 3 Best Practices for Merging Content. Configuring Content Merge Before you merge content, you need to do the following in the Content Merge utility: Enter your Source database information Enter your Target database information Select items from the Source database that you intend to transfer 8 Worksoft Certify Content Merge Installation and User Guide

9 Configuring Content Merge To configure your Source database: 1 Open the Content Merge utility by double-clicking on Worksoft.ContentMerge.exe that is within Worksoft Certify Content Merge folder of the distribution package. The Content Merge utility opens. 2 In the Source Database tab, type in the name of your database server in the Database Server Name field. 3 If you will use the Windows authentication security option, select the Windows Authentication option. Go to Step 5. If you will use SQL database authentication security option, select the Database Authentication option. 4 If you selected Database Authentication, type the user name and password in the text fields to access the database server. 5 Click the Test/Continue button to test your database configuration. If for some reason the test fails, you will need to troubleshoot the database server connection. 6 From the Source Database Name drop-down list, select a database. 7 From the Source Project Name drop-down list, select a project. You are now ready to configure your Target database. Worksoft Certify Content Merge Installation and User Guide 9

10 Configuring Content Merge To configure your Target database: 1 Click the Target Database tab. The Target Database tab opens. 2 In the Target Database tab, type in the name of your database server in the Database Server Name field. 3 If you will use the Windows authentication security option, select the Windows Authentication option. Go to Step 5. If you will use SQL database authentication security option, select the Database Authentication option. 4 If you selected Database Authentication, type the user name and password in the text fields to access the database server. 5 Click the Test/Continue button to test your database configuration. If for some reason the test fails, you will need to troubleshoot the database server connection. 6 From the Source Database Name drop-down list, select a database. 7 From the Source Project Name drop-down list, select a project. 8 Click the Continue button. The Worksoft Login dialog box opens. 9 In the Worksoft Login dialog box, type in your Certify user name and password. 10 Worksoft Certify Content Merge Installation and User Guide

11 Configuring Content Merge 10 Click OK. The Content tab appears. A comparison of both databases automatically is started and items from each column are matched. Worksoft Certify Content Merge Installation and User Guide 11

12 Configuring Content Merge In the Source and Target columns, an icon is next to each item. These icons represent the following: Icon Description Match The item in the Source database matches an item in the Target database. When you click on a Matched item in the Source column, the matched item is highlighted in the Target column. Modified Match The item in the Source database has a modified match with an item in the Target database. Not all of the assets in this Source item matches exactly with the item in the Target database. New or Unmatched The item in the Source database does not exist in the Target database. You will need to select this item in order to copy this new information into the Target database. Name Collision with Target The item has a name collision with the target database. You will need to cancel the selection of the item or rename the items with this icon otherwise you will not be able to merge any items. To select Source database items to transfer to the Target database: Before you select the items that you want to merge, you need to verify that both Certify databases have the same ICL data in the Interface Libraries. 1 In the Source column, open the Interface Libraries folder. If you see a Match icon next to an interface, then the ICL data matches and you can proceed to Step 2. If you see an Unmatch icon next to an interface, then the ICL data does not match and you will need to match the items before you proceed. For more information, see Matching Source Items on page In the Source column, select which items you want copied to the target project. If you select a folder, all the items under that folder will be selected. You can cancel the selection of individual items. 3 Complete one of the following options after you have made your selection: Select the Auto-Click Merge When Ready option. By selecting this option and clicking Ready, Content Merge will automatically start the merge when the verification is complete. Content Merge takes some time to identify and verify related content for the selections you made. For example, when you select a process, Content Merge automatically checks all of the data that it contains layouts, variables, recordsets, etc. If you do not want to automate the merge process, click Merge. This option is activated after the content has been verified. When the merging of data is completed, a message appears stating that the merge was successful. 12 Worksoft Certify Content Merge Installation and User Guide

13 Resolving Name Collisions Resolving Name Collisions If a name collision occurs, the merge will not be started until you resolve the name collision issues. Once they are resolved, the Merge button will be enabled. If a name collision occurs, a Name Collision icon appears next to an item in the Selected column. You may need to expand the nodes to find the name collision. You can resolve name collisions in two different ways: Rename the items Cancel your selection of an item To rename items in Content Merge: 1 In the Source column of the Content tab, right-click on an item marked with a Name Collision icon and select Copy As. A text box appears. 2 Type a new name for the item. The name is changed in both the Source and Selected columns, and the Name Collision icon is replaced with the New icon. 3 Repeat this process for each Name Collision item. After you have completed this process, the Merge button is enabled. Matching Source Items In the Source tree of the Content Merge tool, you are able to match an item by selecting Match from the right-click menu. Select from one of the following Match options: Match (Replace in Target) - The target process's steps will be replaced to match the source process. Match (Not Replace in Target) - The target process's steps will not be replaced to match the source process. Unmatch - Rename the selected item, and the item will be copied over as a new item. To match items in Content Merge: In the Source column of the Content tab, right-click on an item with an Unmatch icon and select Match (Replace in Target) or Match (Not Replace in Target). If the match was successful, then the status bar displays Matched, and the item's icon changes to a Match icon. Worksoft Certify Content Merge Installation and User Guide 13

14 Showing Differences Between a Source and Target Item To undo the match in Content Merge: 1 In the Source column of the Content tab, right-click on an item with a Match icon and select Unmatch. A warning message appears stating that you will need to rename the item. 2 If you agree to proceed, click OK. A text field appears. 3 Type a new name for the item. The item's icon is updated with the Unmatch icon, and it will be copied over as a new item in a merge. Showing Differences Between a Source and Target Item With the Content Merge Tool, you are able to show the differences between a source and target item before you decide to match or merge the item. The source and target items must be the same type. For example, you can not select a process and a layout. To show differences between a source and target item: 1 In the Target column in the Content tab, select an item. 2 In the Source column of the Content tab, select an item. 3 Right-click on the Source column item and select Show Differences. A message appears with a list of differences. 4 After you review the differences, click OK. 14 Worksoft Certify Content Merge Installation and User Guide

15 Chapter 3 Best Practices for Merging Content In This Chapter Merging Projects Merging Processes...16 Merging Applications, Application Versions, and Map Objects Merging Layouts and Recordsets Worksoft Certify Content Merge Installation and User Guide 15

16 Merging Projects Merging Projects Worksoft recommends that if you want to merge an entire project, you should merge the project incrementally because of the amount of memory the process utilizes. Worksoft recommends using the 64-bit version of Content Merge because of the memory limitation of 2.5 G with the 32-bit version. To merge a project incrementally using the 64-bit version of Content Merge: 1 With Content Merge, select to merge all Requirements and Processes. 2 Perform the merge. When the merge operates, all the following items associated with the processes and requirements are copied: Applications Application versions Attributes Map objects Layouts Recordsets Variables If you want to merge items that are not used in processes, you will need to run another merge. 3 With Content Merge, select to merge Variables, Layouts, and Recordsets that are not associated with processes. To merge a project incrementally using the 32-bit version of Content Merge: Due to the 2.5 GB memory constraint of a 32-bit operating system, Worksoft recommends that you also incrementally merge your project. You should break down the projects, and merge the individual items in the following order: Layouts and Recordsets Requirements Processes Merging Processes Merging processes instead of projects provides a clean target database because it does not copy items that are not needed. You are able to select individual processes or a process folder. When you select to merge processes, all the related content that is required is also copied to the target database, including applications, application versions, attributes, map objects, layouts, recordsets, and variables. If you select to only merge processes, then the links to the requirements are not copied. To maintain these links, you will need to merge these items together. 16 Worksoft Certify Content Merge Installation and User Guide

17 Merging Applications, Application Versions, and Map Objects Merging Applications, Application Versions, and Map Objects Applications, application versions, and map objects are stored in the database, and they are available for all projects within the database unless they are restricted. If you have one database and want to share these components among your projects, do not use Content Merge for these components. In Worksoft Certify, edit the application version and select the Shared option so that they can be used for all projects, and you will be able to save disk space. If you have two databases and need to copy these components from one database or another, then you will need to use Content Merge. If you want to select all the map objects in an application version, then select the application version. All of the map objects within the application version will be merged. If you want to copy all map objects, do not select to merge any process before the merge. If you select a process with the application version, then only the application, application version, and map objects associated with the process will be merged. After you have merged all of your map objects, then you can use Content Merge to copy processes. Merging Layouts and Recordsets When you select to merge a process, the associated layouts and recordsets are also merged. However, you are able to merge layouts and recordsets independently, too. When you select to copy a layout, Content Merge automatically merges the recordsets associated with the layout. If you do not want to merge all of the recordsets, then cancel the selection of specific recordsets. Within Worksoft Certify, you are able to use variable names to reference recordsets in a process. If you have processes that reference recordsets through variables, then Content Merge will not be able to automatically select those recordsets. You will need to manually merge these recordsets. Worksoft Certify Content Merge Installation and User Guide 17