Go2Group. Go2Group PaT Mashup. Perforce Mashup for Serena Business Mashup Solution. Installation and Usage Guide. v2.0

Transcription

1 Go2Group PaT Mashup Perforce Mashup for Serena Business Mashup Solution Installation and Usage Guide v2.0

2 Table of Contents SECTION 1 GO2GROUP MASHUP REQUIREMENTS...3 WHAT S NEEDED...3 WHERE TO GET HELP...4 SECTION 2 GO2GROUP MASHUP OVERVIEW...5 USE CASES...6 USE CASE EXAMPLE...6 APPLICATION AND ORCHESTRATIONS...6 SECTION 3 GO2GROUP MASHUP INSTALLATION...7 INSTALLATION ASSUMPTIONS...7 G2G SCM WEB SERVICES COMPONENT INSTALLATION...9 G2G PAT SBM COMPONENT INSTALLATION SECTION 4 EMBED G2G COMPONENT IN WORKFLOW SECTION 5 - GO2GROUP WORKFLOW CONFIGURATION ADD TWO TARGET SERVERS TO ENVIRONMENT ADD ENDPOINTS TO ENVIRONMENT ADD VALUES FOR THE P4CONFIG AUXILIARY TABLE CONFIGURE SBM DATABASE USE THE SAMPLE APPLICATION CREATE PERFORCE JOB DELETE PERFORCE JOB GET PERFORCE CHANGE HISTORY SECTION 6 - GO2GROUP MASHUP TIPS AND TROUBLESHOOTING GENERAL SUGGESTIONS UPDATES AND UPGRADES SECTION 7 GO2GROUP MASHUP ADDITIONAL INFORMATION TECHNICAL SUPPORT SALES SUPPORT LEARN MORE... 55

3 Section 1 Go2Group Mashup Requirements What s Needed To install the Go2Group Perforce add-on for Serena, you will need the following: Serena Business Mashup Server For more information on Serena s Business Mashup Solutions, please visit the Serena website at: Perforce SCM Go2Group Perforce add-on for Serena Business Mashup (Go2Group PaT Mashup). Either Tomcat or JBoss on the Perforce. If you don t have either, you will need to install one before beginning installation. Note: it is not required to install Tomcat or JBoss on the same server as the Perforce Server. While installation can be on separate servers, this will take some minor installation assistance form Go2Group. For Tomcat, version 5.5 or higher is required. Go2Group recommends Tomcat. For JBoss, version or higher is required. Java JRE or higher is required. In addition to the technical requirements above, you will need administrator-level permissions on the Serena Business Mashup Server and Perforce when installing the Go2Group Mashup.

4 Where to Get Help Go2Group provides support for its entire line of products, including Go2Group Mashups. Go2Group support is available by telephone, , and a Go2Group Mashup specific customer support ticket system: By telephone: For the Americas and EMEA+1 (877) For Japan For the rest of APAC and Australia By support@go2group.com By ticket: support.go2group.com A customer login is required to access the support site above. Please contact Go2Group for your login credentials. For support with Serena Business Mashup, please contact your Serena representative. For support with Perforce, please contact your Perforce representative.

5 Section 2 Go2Group Mashup Overview Go2Group leverages Serena's new process-driven, Mashup approach, allowing Mashup users to view Perforce change history related to specific incidents, without ever having to leave Serena Business Mashups. Go2Group's Perforce add-on for Serena Mashup (Go2Group PaT Mashup) displays Perforce data within Serena's tabbed interface. Using Serena Business Mashups, a tester simply logs an incident into the Serena interface. If there is a Perforce change history log associated with the specific incident, the "Integrations" tab will provide a description of the changes made. The user can review change history information such as: The user who made the change The date of the change The location of the change The change history ID The check-in comment The display of related change history within Serena helps keep the process flowing by providing users the information needed to make timely decisions.

6 Use Cases Actors - All members of the Test and Development Teams including: Test engineers using Serena Developers using Perforce Code/peer review participants Products Involved: Serena Business Mashup for test environment Perforce client for developers change management environment Questions Being Answered: Which source files have been checked in to resolve a specific incident? When were source files checked in to resolve a specific incident? Who checked in source files to resolve a specific incident? What check-in comments are available? Who reviewed the changes? Use Case Example Issue logged in Serena Developer is assigned the issue by creating a Perforce Job Developer modifies files and checks them in to Perforce Developer marks the issue as 'resolved' and transitions the issue to "Peer Review" The issue now displays the change history of files changed Application and Orchestrations The Perforce add-on for Serena Mashup contains the following applications and orchestrations: Perforce add-on for Serena Application Sample workflow, containing the Perforce add-on for Serena Orchestration, that displays Perforce version control history Perforce add-on for Serena Orchestration Communicates with Perforce server to create/delete a Perforce job for specific issues

7 Section 3 Go2Group Mashup Installation This installation wizard is used to install components for the integration between Perforce and the Serena Business Mashup (SBM). The installation includes three separate installation shields, two on the Perforce Server and One on the Mashup Server. This section covers all two installation shields: G2G SCM Web Services Component on the ClearCase Server: This is for the ClearCase server to provide web services interface let Business Mashup flow to create/delete jobs and get ClearCase change history records. Go2Group PaT SBM Component on the Serena Business Mashup Server: This is for the SBM server to provide web services interface let Perforce triggers to update any change history. Installation Assumptions The following installation steps assume has completed the following: A local copy of the Go2Group Mashup installation file has been downloaded from the Go2Group website (). A license key has been requested / received from Go2Group. The installer has the appropriate privileges to the Serena and Perforce servers, along with the connected database(s). You have coordinated with the SBM, and Perforce administrators to obtain support and recycle the servers. Serena Business Mashup is running in a Windows environment. Perforce SCM is running in a Windows environment. Client applications for developers are running in a Windows environment. Linux support is available. Please contact Go2Group for more information.

8 Installation There are TWO separate install shields needed to install this Mashup. The G2G PaT SBM Components Go2Group JAR files that need to be placed on the Mashup Server. The G2G SCM Web Services Component consists of Go2Group Java war file which need to be placed on the Perforce Server. Logically those two components have relationships as the below diagram.

9 G2G SCM Web Services Component Installation This step will install the Go2Group g2g-ws.war war file. To install the component installation, double click the G2GSCMWS_windows_2_0.exe install shield file to launch the installation shield. The installation wizard appears. Click the Next button to continue the installation. Review the Go2Group End User License Agreement. After agreeing to the EULA, select the I Accept the Agreement option and click the Next button.

10 Click the Next button to continue. The installer will tell you before install this component please make sure you have installed a Tomcat or JBoss server in the same instance of your Perforce server. If not, please install Tomcat/JBoss on your Perforce server. [NOTE] The Tomcat/JBoss server MUST be started by a ClearCase administrator account. The installation location of the Go2Group war files will vary depending upon if you are using JBoss or Tomcat. For the G2G ClearCase Component being installed into Tomcat, you should install the war files here: %apache-tomcat-install-root%\webapps For the G2G ClearCase Component being installed into JBoss, you should install the war files here: %JBoss-install-root%\server\default\deploy

11 Click the Next button to select a place to install. If the installation root does not exist, the installer will ask to create it automatically, you will need to say yes. So you need to choose the installation directory. Click the Next button to install the war file and continue.

12 Congratulations, you have completed this step. After you restart the web container, you can use any browser to make sure the component deployed successfully.

13 Next, you may need to restart Tomcat or JBoss depending upon which one you deployed to. You can choose to restart using the screen below, or choose to skip it and restart manually later. Before restarting any server, you will need to check with the server admin first.

14 G2G PaT SBM Component Installation During this process, you will need to stop the SBM Server (Serena Common JBoss Service). Please coordinate with the SBM Server Admin. Locate the installation file G2GPaTSBM_2_0.exe to begin the G2G SBM Component installation. Double click the installation file to launch the installation wizard. The installation wizard appears. Click the Next button to continue the installation.

15 Before continuing the installation, please stop your SBM JBoss server first. Once you ve stopped the Serena JBoss server, please click Next.

16 Review the Go2Group End User License Agreement. After agreeing to the EULA, select the I Accept the Agreement option and click the Next button. After you have accepted the agreement, click Next in the Select Components screen below. There is only one component is preselected.

17 Please ensure that the SBM Server (Serena Common JBoss Service) is stopped as mentioned above. Next, decide which folder will be the installation root for each component. For the G2G SBM Component, Go2Group recommends using the default directory as the root installation but it must be set to the location of the Serena installation. For example, C:\Program Files\Serena. If the installation root does not exist, the installer will ask to create it automatically. When prompted, say yes. Click the Next button to continue. The installer then copies the Mashup files to the destination directory.

18 The Go2Group PaT component needs to configure the deploy application workflows and configure projects in the SBM database. Use the G2GSBMConfig_2_0.exe utility to complete all configurations. Click the Next button to complete the Mashup portion of the installation. Click the Finish button to complete the Mashup installation portion of the installation.

19 Now that the deployment is complete, the Serena Common JBoss Server should be restarted. Before the Mashup will function properly, the G2G component must be embedded in the workflow and G2G workflow must be configured. See the next two sections below.

20 Section 4 Embed G2G Component in Workflow This section is to introduce the G2G orchestration flows. Workflow designers must use the Serena Mashup Composer to import the G2GCreateActivityWorkflow and the G2GLockActivityWorkflow into your own application workflows. The G2G orchestration mashup file will be installed in C:\Program Files\Go2Group Mashups folder. Go2Group provides two orchestration flows to create UCM activities and to change the lock state of an activity. The G2GCreateActivityWorkflow is provided to create UCM activities. The G2GLockActivityWorkflow is provided to lock/unlock UCM activities. You may need to refer to Serena s Mashup Documentation if you need help with workflows. Here is a generic workflow setup that will work for you. We recommend that you have the SBM Admin perform the following steps. The PaTCreateJobWorkflow orchestration flow is provided to let users create Perforce jobs within a Mashup application flow. Users can use the Business Mashup Composer to merge our orchestration flow with their application flow. A sample application flow containing the orchestration flow is also provided. The Go2Group Mashup is in the IDT PaT.zip file.

21 This orchestration flow contains four web services nodes. The login service is to help users to login into the Perforce server. If login is successful, then the GetItem service from SBM is invoked to get the issue s issue name, such as: BUG The attachissuewithp4 is then invoked to create a Perforce job in Perforce server based on this issue. Finally, the logout services are invoked to help users to logout of Perforce. Let us look into each web service s data mapping: In the login web service data mapping, in the below picture, fields have value are required fields. And their mapping fields to the event also as the below picture. Field Value Note scminfo/ licensekey scminfo/ password scminfo / port The Go2Group P4M License Key. The password for the Perforce login account. The is a P4Port value, for example: localhost:1666 scminfo/ productname P4M This is a constant value scminfo/ scmname P4 This is a constant value. scminfo/ submitdate scminfo/ username This field is the submit date for the issue This is account for login into Perforce.

22 In the GetItem web service data mapping, in the below picture, fields have value are required fields. And their mapping fields to the event also as the below picture. Field Value Note auth/ hostname auth/ userid auth/ password itemid Define which SBM server you want to connect Account to login to SBM server to invoke the SBM AE web services. Password for the auth/userid. The issue s SBM internal table record id

23 In the attachissuewithp4 web service data mapping, the fields values are required. Their mapping fields to the event are also displayed in the picture below. Field Value Note scminfo/ scmname P4 Constant value scminfo/ port scminfo/ username scminfo/ password scminfo/ pathorurl fieldlist P4Port for accessing the Perforce depot Account for login into Perforce. Password for the scminfo/username. P4Client for accessing the Perforce depot Job,User,Date,Description,Severity,Owner,IssueType,Status

24 In the logout web service data mapping, in the below picture, fields have value are required fields. And their mapping fields to the event also as the below picture. Field Value Note scminfo/ scmname P4 Constant value scminfo/ port scminfo/ username scminfo/ password P4Port for accessing the Perforce depot Account for login into Perforce. Password for the scminfo/username.

25 The PaTDeleteJobWorkflow orchestration flow is provided to let users delete Perforce jobs within a Mashup application flow. Users can use the Business Mashup Composer to merge our orchestration flow with their application flow. A sample application flow containing the orchestration flow is also provided. The Go2Group Mashup is in the IDT PaT.zip file. This orchestration flow contains four web services nodes. The login service is to help users to login into the Perforce server. If login success, then invoke the GetItem service from SBM to get the issue s issue name, such as: BUG Then we invoke the detachissuewithscm can delete a Perforce job in Perforce server based on this issue. At the end, we invoke logout services to help users to logout the Perforce. Let us look into each web service s data mapping:

26 In the login web service data mapping, in the below picture, fields have value are required fields. And their mapping fields to the event also as the below picture. Field Value Note scminfo/ licensekey scminfo/ password scminfo / port The Go2Group P4M License Key. The password for the Perforce login account. The is a P4Port value, for example: localhost:1666 scminfo/ productname P4M This is a constant value scminfo/ scmname P4 This is a constant value. scminfo/ submitdate scminfo/ username This field is the submit date for the issue This is account for login into Perforce.

27 In the GetItem web service data mapping, the below picture displays the required fields and their mapping details to the specific events. Field Value Note auth/ hostname auth/ userid auth/ password itemid Define which SBM server you want to connect Account to login to SBM server to invoke the SBM AE web services. Password for the auth/userid. The issue s SBM internal table record id

28 In the detachissuewithp4 web service data mapping, the picture below displays the required fields and the mapping details for each event. Field Value Note scminfo/ scmname P4 Constant value scminfo/ port scminfo/ username scminfo/ password scminfo/ pathorurl jobid P4Port for accessing the Perforce depot Account for login into Perforce. Password for the scminfo/username. P4Client for accessing the Perforce depot The issue name (issue type prefix + issue id) that equals to the Perforce job id.

29 In the logout web service data mapping, the picture below displays the required fields, and the mapping details for each event. Field Value Note scminfo/ scmname P4 Constant value scminfo/ port scminfo/ username scminfo/ password P4Port for accessing the Perforce depot Account for login into Perforce. Password for the scminfo/username.

30 The PaTChangeHisotryWorkflow orchestration flow is provided to let users get Perforce change history records based on jobs within a Mashup application flow. Users can use the Business Mashup Composer to merge our orchestration flow with their application flow. A sample application flow containing the orchestration flow is also provided. The Go2Group Mashup is in the IDT PaT.zip file. This orchestration flow contains four web services nodes. The login service is to help users login in to the Perforce server. If login is successful, then GetItem service is invoked from SBM to get the issue s issue name, such as: BUG The getchangehistory service is then invoked to get change history records from Perforce based on this issue. If there is any change history record, the storechangehistory is invoked to store the change history record into SBM database. Finally, the logout service is invoked to help users log out of Perforce. Let us look into each web service s data mapping.

31 In the login web service data mapping, the image below shows the required fields and their mapping details to each event. Field Value Note scminfo/ licensekey scminfo/ password scminfo / port The Go2Group P4M License Key. The password for the Perforce login account. The is a P4Port value, for example: localhost:1666 scminfo/ productname P4M This is a constant value scminfo/ scmname P4 This is a constant value. scminfo/ submitdate scminfo/ username This field is the submit date for the issue This is account for login into Perforce.

32 In the GetItem web service data mapping, the image below shows the required fields and the mapping detail for each event. Field Value Note auth/ hostname auth/ userid auth/ password itemid Define which SBM server you want to connect Account to login to SBM server to invoke the SBM AE web services. Password for the auth/userid. The issue s SBM internal table record id

33 In the getchangehistory web service data mapping, the image below shows the required fields and the mapping details for each event. Field Value Note scminfo/ submitdate The issue submit date. scminfo/ scmname P4 Constant value scminfo/ port scminfo/ username scminfo/ password scminfo/ pathorurl scminfo/ licensekey P4Port for accessing the Perforce depot Account for login into Perforce. Password for the scminfo/username. P4Client for accessing the Perforce depot The license key value for the Go2Group P4M product. scminfo/ productname P4M Constant value. issueid The issue name (issue type prefix + issue id) that equals to the Perforce job id.

34 In the storechangehistory web service data mapping, the image below shows the required fields and the mapping details for each event. Field Value Note scmname P4 This is a constant value ttinfo / account ttinfo / endpoint ttinfo / issueid ttinfo / password ttinfo / tableid changehistory The SBM account that can use the Application Engine Web Serivces. The SBM Application Engine Web Serivces Endpoint (aewebservices70). The issue id that users want to check. The SBM account s password that can use the Application Engine Web Serivces. The table id that the project belong to. Change history records from the getchangehistory Web Services.

35 In the logout web service data mapping, the image below shows the required fields and the mapping details for each event. Field Value Note scminfo/ scmname P4 Constant value scminfo/ port scminfo/ username scminfo/ password P4Port for accessing the Perforce depot Account for login into Perforce. Password for the scminfo/username.

36 Section 5 - Go2Group Workflow Configuration This sample Mashup shows users how the Perforce add-on for Serena Orchestration which can be used to create/delete Perforce jobs. And also get change history record from Perforce server and store change history record into SBM database. Go2Group recommends that you read Serena s documentation and have a Serena administrator perform these steps for you. Add Two Target Servers to environment In Serena Business Mashup Manager, users need to add two target servers in their environment before deploying the sample application in the SBM server. One server is for the System Event Manager, and the other server is for the BPEL Server. To begin, click Environments and then Default Environment.

37 Next, create the target servers by clicking the Create a new target server link.

38 Next, Create one BPEL Server and one System Event Manager Server. Use View Examples to help choose right URL for different type. Leave Authentication option for none. For example: BPEL: System Event Manager:

39 Add Endpoints to Environment In the Serena Mashup Manager, users need to add five endpoints in their environment prior to deploying the sample application. The six endpoints are: aewebservices70 endpoint is for SBM web services. Example: ALFEventManager endpoint is for the ALF event manager web services. Example: PaTCreateJobWorkflow endpoint is for create Perforce job web services. Example: PaTCreateJobWorkflow/patcreatejobworkflowservlet PaTDeleteJobWorkflow endpoint is for delete Perforce job web services. Example: PaTDeleteJobWorkflow/patdeletejobworkflowservlet PaTChangeHistoryWorkflow endpoint is for get change history record from Perforce server web services. Example: PaTChangeHistoryWorkflow/patchangehistoryworkflowservlet SCMServices endpoint is for the Go2Group Clear Case Component on Tomcat or JBoss. Example: After we configured target servers and endpoints, we can deploy our own applications into the SBM server now. We also have to load the mashup zip file that was generated from Section 4, and then deploy the mashup. Please reference Chapter 5 in the Serena Mashup Manager Guide.

40 Add Values for the P4Config Auxiliary table After users deploy the sample flow or user s application flow to an SBM server and use the Mashup Administrator to add projects to use the flow, the Serena Business Mashup Web Interface can be used to add configurations. Users login into the web interface, then click on their applications (our example application is IDT_PaT). Click on the Search function and click on the Manage Data item to open the management page. Choose P4Config, click on the Lookup button, and then click on the Create New P4Config link to open a new page.

41 The P4Config configuration contains the following fields: Field SCMName P4Port P4Client P4User P4Pwd JobSpec SBMAccount SBMPassword G2GProduct: G2GLicense: Description A constant value P4 P4Port for accessing Perforce depot P4Client for accessing Perforce depot Perforce account to login into Perforce server Password for the P4User Perforce job spec in a string, separate with, character The SBM account that can access the SBM Application Engine Web Services The SBM account s password A constant value P4M A license key value for the P4M product After completing this configuration, users can start to use the sample flow.

42 Configure SBM Database The final step is to use the G2GSBMConfig_0_3.exe utility to configure data into the SBM database. This utility will be installed in the C:\Program Files\Go2Group Mashups\utils folder. This utility MUST run on the SBM server.

43 In this utility, the following fields are required to create data into the SBM database. Field SBM JBoss Server Root SBM JBoss Server IP Description This is a absolute path to the Serena JBoss server, the default value is C:\Program Files\Serena\Business Mashups\Common\jboss405\server This is the server IP for the Serena JBoss server. SBM JBoss Server Port This is the port number for the Serena JBoss server. SBM Web Server IP This is the server IP for the Serena Application Engine. SBM Web Server Port This is the port number for the Serena Application Engine. SBM Administrator Account The Serena Administrator account. SBM Administrator Password SBM Project Name SBM Integration label Password for the Serena Administrator account. This is the project name that contains the PaTChangeHisotryWorkflow, for example, PaT. This is a label for the Integration tab in the SBM web user interface

44 Use the Sample Application The following images depict the typical scenario of creating an issue in Serena Business Mashup, assigning it to a developer, using Perforce to check in code changes, then reviewing the changes within Serena Business Mashup. Begin by launching Serena Business Mashup and clicking on the IDT PaT Project. A user logs into the Serena Business Mashup system and submits a new issue. In the submit form, the P4Config field must be set to P4. Click the OK button (top of panel) to continue. The item is now in the Triage stage

45 Create Perforce Job If you want to create a Perforce job then press the Create Job button. In the submit form, press the OK button. After SBM server processes the issue, open P4V to review a new job named BUG00023 in the job list

46 Delete Perforce Job To delete a Perforce job, the job cannot be contained in any changelist. If the Perforce job is contained in a changelist, the delete process will not be performed. To delete a Perforce job, press the Delete Job button. In the submit form, press the OK button. After the SBM has completed the process, open P4V to review the list of Perforce jobs. In this example, Perforce job BUG00023 should not be in job list

47 Get Perforce Change History After files have been checked out, modified, then submitted, link the corresponding changelist with a Perforce job. In this example, BUG00023 is being linked

48 Once the modified file has been checked back in, return to Serena Business Mashup. Click the Fast Track button. Next, click the Find button to assign the issue to an Engineer. A resulting list of engineers is populated in the Engineer field. Select the proper engineer to assign the issue. Then click the OK button

49 Once assigned, the user can then request a review by clicking the Request Peer Review button

50 Next, fill all required fields. Then, press the OK button, which will trigger the Go2Group Mashup workflow to query change history logs in Perforce. Then click on the Integration tab. The logs will be displayed for the specific issue

51 If you cannot view the change history records in the Integrations tab, you can use the Search by Keyword(s) function in the Search panel and search for a specific issue. The search results in locating the BUG

52 Then click the issue, and you can see the change history records in the Integrations tab

53 Section 6 - Go2Group Mashup Tips and Troubleshooting General Suggestions Go2Group provides technical support for its entire line of products, including Go2Group Mashups. If you run into any issues when installing or configuring the Go2Group Mashups, please contact us. Updates and Upgrades Go2Group provides regular updates to Go2Group Mashups. These updates include performance enhancements and minor bug fixes. Go2Group provides regular upgrades to Go2Group Mashups. These upgrades include new features, performance enhancements, and bug fixes. To review previous, current, and upcoming updates and upgrades, please visit the Go2Group support site at: support.go2group.com A customer login is required to access the support site above. Please contact Go2Group for your login credentials

54 Section 7 Go2Group Mashup Additional Information The Go2Group Mashup contains a sample application flow. The basic flow is the IDT PaT.zip. Go2Group includes an Action in submit transition. The action invokes an orchestration flow which is the G2GPaTOrchestration. In this sample flow, we use an auxiliary table to store license key values. Users can deploy this sample flow to see how the orchestration flow works. Technical Support Go2Group provides technical support for its entire line of products, including Go2Group Mashups. Go2Group technical support is available by telephone, , and a Go2Group Mashup specific customer support ticket system: By telephone: (877) By support@go2group.com By ticket: support.go2group.com A customer login is required to access the support site above. Please contact Go2Group for your login credentials. Sales Support Go2Group provides sales support for its entire line of products, including Go2Group Mashups. Go2Group sales support is available by telephone, , and a Go2Group Mashup specific customer support ticket system: By telephone: (877) By sales@go2group.com By ticket: support.go2group.com A customer login is required to access the support site above. Please contact Go2Group for your login credentials

55 Learn More For more information on Go2Group, its products, and its services, please visit our website at: For more information on Serena, please visit the Serena website at: For more information on Perforce, please visit the Perforce website at: