ConnectALL Installation, Configuration, and Usage Guide. From Go2Group Making Software Go! 05 July 2012 Version 1.

Transcription

1 ConnectALL Installation, Configuration, and Usage Guide From Go2Group Making Software Go! 05 July 2012 Version P age Copyright 2011, the Go To Group, Inc.

2 Contents Terms and Definitions... 3 Overview... 3 Deployment... 4 Architecture... 4 Application Mirroring Clustering HA and Migration... 4 Installation... 4 ConnectALL UI Installation... 4 Using Tomcat Manager Application... 5 Without Using Tomcat Manager Application... 5 ConnectALL Server Installation... 5 ConnectALL Server Hardware Requirements... 5 Installing and Configuring the ConnectALL Server... 5 Pricing... 5 EULA... 6 Setup... 6 Configuration Tab... 8 Entity Mapping Tab... 9 Field Mapping Tab... 9 Save Mapping Roll Back License Monitor Server Logs JIRA QC Integration Example P age Copyright 2011, the Go To Group, Inc.

3 Terms and Definitions Application: An application like JIRA, P4, HP QC, Microsoft Project, Microsoft TFS, etc Connector: Piece of code written by Go2Group for each Application Application Instance: An instance of an Application e.g. JIRA running on port 8080 Data Dictionary: A mapping of fields and values between 2 Application Instances NOTE: An Application Instance can be used in as many Data Dictionaries as you want. For a new Application Instance, a new license must be purchased. Licenses are per Application Instance. Overview ConnectALL is an integration system built on top of MuleSoft s Enterprise Service Bus to integrate separate applications seamlessly. This system can allow for many mappings between these Applications. It has two parts: A User Interface which is a web application that can be deployed onto any application server. THis is used by an administrator to maintain the data dictionary that maps fields and values between applications. Tested with Apache Tomcat 6.0 Mule based flows, which can be deployed into any application server but preferably into Mule Integration platform - Enterprise or Community version OR Mule ion a supported integration platform on cloud. ConnectALL has been created with the concept of integrating ALM applications together across an enterprise, or between separate entities but is growing to be much more. This includes areas of emergency alarms, HA & Clustering, and integration with business processes. 3 P age Copyright 2011, the Go To Group, Inc.

4 Deployment ConnectALL is platform independent and can be deployed onto Windows Server 2003 and 2008 as well as Unix/Linux systems. ConnectALL is built on top of MuleSoft which is integrated into the ConnectALL product. Architecture ConnectALL is setup as its own tier and is the central point of communications between all of the Application Instances connected. Individual mapping for different connectors need to be created. Since ConnectALL is based on MuleSoft ESB, the possibilities are limitless! Go2Group has used ConnectALL to integrate emergency alarms and help desks from a power company, to enabling a web sales company to integrate sales, shipping, order fulfillment, and inventory seamlessly and in near real time with the certainty of a world class ESB it is built upon. ConnectALL can be deployed inside an enterprises cloud or deployed externally as a SAAS solution on Mule s ion platform. ConnectALL itself can be clustered for performance and/or failover as it is built into MuleSoft Enterprise Server. See: %28HA%29+Clusters Application Mirroring Clustering HA and Migration ConnectALL enables data replication for clustering, or HA, or migration between two or more Application Instances. Installation ConnectALL UI Installation Installing ConnectALL User Interface is pretty easy. It is a war file which can be deployed into any standard application servers. For example, following are the instructions on tomcat. 4 P age Copyright 2011, the Go To Group, Inc.

5 Using Tomcat Manager Application Make sure Tomcat Manager Application is installed and configured to use. See for more details Navigate to the manager app in browser. The url will be something like this: Upload the ConnectAll.war file provided by Go2Group under Deploy > WAR file to deploy. Click on Deploy Without Using Tomcat Manager Application See ConnectALL Server Installation To install the ConnectALL Server there are HW and SW component requirements and steps detailed below. ConnectALL Server Hardware Requirements HW requirements are a server with Windows or MS Windows 2003 or 2008, 8 GB of RAM, minimum of a 30 GB HD, admin privileges to the server. Installing and Configuring the ConnectALL Server 1) Download mule from and unzip it. 2) Copy the qcjiraflow-[version].zip to the mule_home/apps folder. Don't unzip it - mule does that. Note that the qcjiraflow zip and other ConnectALL files from Go2Group may not be available for public download. 3) Copy database folder to the mule_home folder. 4) Copy the files in the conf folder to the mule_home/conf folder. 5) Set the jdbc.url property in the db.properties to the hsql database. 6) Add the files in the lib folder to the mule_home/lib/user folder. 7) Startup mule by running mule_home/bin/mule start. 8) A general note: will tell Mule to reload the configs after they've been changed by the GUI. Pricing See ConnectALL Pricing. Pricing is based upon number of Application Instances integrated to ConnectALL. Once an Application Instance is integrated with ConnectALL, it can have many Data Dictionaries. Meaning, once connected to 5 P age Copyright 2011, the Go To Group, Inc.

6 ConnectALL, the Application Instance can connect to as many other Application Instances as desired. EULA See ConnectALL s EULA at Setup Open a browser and go to the Connection Home Page. By default that would look something like this The Data Dictionary Home Page is where you choose a Data Dictionary to edit or create. You can get back to the Data Dictionary Home Page at any time by clicking the ConnectALL logo in the top left corner of the page. A Data Dictionary is the connection between any two Application Instances. You can connect more than two applications using ConnectALL, but each connections must be supported by ConnectALL. However, you can add as many Connections as you wish. On the right hand side of the Data Dictionary Home Page, you will see a list of all saved Data Dictionaries that are available to you to edit. You can select any Data Dictionary you wish and click the Load Data Dictionary Button. This will open up the Data Dictionary Tab which we will cover later. In the image below, you can see an Atlassian, Perforce, and HP Quality Center icon. These are the products that ConnectALL currently supports. As more products are added to the ConnectALL product, then more icons will appear. To connect JIRA and Quality Center (QC), you would drag and drop the JIRA and QC icons into the columns under Application 1 and Application 2. It does not matter which goes where. 6 P age Copyright 2011, the Go To Group, Inc.

7 After selecting the two applications you wish to integrate, you then enter a name for the Data Dictionary in the Connect Name field (e.g., JiraQcBugs). This name must be alphanumeric. After entering a name, click the Map Apps Button. This will bring up the Data Dictionary Tab. There is a default mapping provided for the applications selected while creating the data dictionary. See the load defaults Button on the Mapping Page. 7 P age Copyright 2011, the Go To Group, Inc.

8 Configuration Tab In the Configurations Tab, as seen above, the URLs of the respective JIRA and QC servers will be entered as well as a username and password for a user that has appropriate permissions in each system to create and update tickets/issues. When two separate applications are connected, there is the possibility that related entities can each be updated simultaneously, creating a conflict. It is important to know when this happens and how it is resolved. When a conflict occurs, it is logged and to the individual users in each system. On the Configuration Tab there is a Conflict Management Strategy Drop Down Box with 3 options: Master Slave In case of conflict, the master application will always overwrite the other. First In Which ever application writes out first will be the change that is kept. The submission of the second application will be discarded. Last In - Which ever application writes out last will overwrite the submission from the first application. Once the Configuration Tab is completed and saved, the Entity Mapping Tab will appear as shown below. This is where the metadata is mapped between the systems. 8 P age Copyright 2011, the Go To Group, Inc.

9 Entity Mapping Tab An application can have different metadata that you will use to create the mapping. For example, HP QC has domains, projects and issue types whereas JIRA only has projects and issue types. Perforce doesn t have any of these. The metadata tab is automatically populated based on the connector that is chosen. Entity Mapping is done first because it defines the fields and values that will be mapped next. The Date Formats represent the formats that the applications data objects and fields are represented. For each date format that needs to be supported, it needs to be listed and separated from the next data format with a comma, and no spaces as shown below. Once the date formats are setup, you will click the Next Button to proceed to the Field Mapping Tab. Field Mapping Tab The Field Mapping Tab is shown below. Notice, in the top Window Pane, that all of the available fields appear for their respective applications. 9 P age Copyright 2011, the Go To Group, Inc.

10 As mentioned before, these fields may or may not depend on the metadata you selected previously. For example, in the case of HP QC, the fields selected may defer if the issue type is defect or requirement. To map fields, select the entity from each application and then select the desired direction of the flow. For instance <> is a two way bi-directional integration >> integrates from left application to right application << integrates from right application to left application Once the fields and direction are chosen, click the + action on the right side of the screen to add this Field Mapping Pane below. The field items will be removed from the available fields in the top of the screen and appear down in the bottom of the screen under the Field Mapping Pane below. Once the fields are displayed in the Field Mapping Window Pane, notice on the right hand side there is a delete and an edit icon. If you delete the field mapping, then the fields will become available above under their respective products to map again. If you 10 P age Copyright 2011, the Go To Group, Inc.

11 click the edit icon, the fields will be editable in the Value Mapping Window, see image below. In the Value Mapping Window, you can select the actual values of the fields if it is a multi valued field or populate a text box if it is not. For instance, above you will see the drop down menus for these values. You can add them one by one and select the directions and then click add. When finished, click the Save Button. 11 P age Copyright 2011, the Go To Group, Inc.

12 Save Mapping When all value mappings are completed, click either the Save Mapping Button, or the Save as new Version Button. Save as new Version Button only creates a new version of the mapping but doesn t make it live. This mapping may be edited it in the future by clicking the Save Mapping Button. Once the mapping is saved, it will become live. Roll Back See the image below; any mapping can be loaded, including older version of mappings. Thereby rolling back to a previous version is easy. 12 P age Copyright 2011, the Go To Group, Inc.

13 License The image below shows the ConnectALL Home Page. At the bottom, you can see the License Configuration Button at the bottom of the page. 13 P age Copyright 2011, the Go To Group, Inc.

14 Clicking it will bring up the License Window as shown in the image below. To load a license, you will click the Load License Button. That will open up the file selector window from your operating system. Search for the license files that you have purchased from Go2Group. Once selected, push the OK Button to load the license file into ConnectALL. Each type of application you connect to ConnectALL will have its own license file. For instance, it you want to integrate two JIRA and one QC connections, one JIRA and one QC license files would need to be uploaded. The JIRA license file knows that two instances of JIRA are allowed to be connected to ConnectALL. Examples of the JIRA, QC, and Perforce ConnectALL license file names are jira.key, hp.key, and p4.key. See the image below, ConnectALL has one QC and 2 JIRA connections licensed and allotted. More than the allotted number of connections will not be allowed to connect to ConnectALL. Adding more than the allotted number of connections will also violate ConnectALL s EULA. 14 P age Copyright 2011, the Go To Group, Inc.

15 Monitor Server Logs ConnectALL can monitor server logs to assist in monitoring and management of the various connections that it governs. To monitor a server log, first go to the ConnectALL Main Page, then click the Monitor Server Log Button at the bottom of the page below. 15 P age Copyright 2011, the Go To Group, Inc.

16 This will bring up the Server Logs Window where the path to the server logs can be entered into the Log File Path Text Field. Examples of locations of a couple pertinent log files are: Tomcat: /opt/servers/tomcat/logs/catalina.out Mule: /opt/servers/mule-enterprise-standalone-3.2.1/logs/mule_ee.log See the image below for an example of how this would appear. Also note that there is a Pause Logs Button at the bottom. Allowing the log to be paused. 16 P age Copyright 2011, the Go To Group, Inc.

17 JIRA QC Integration Example Below are images of defects being added to both QC and JIRA and being replicated between the two. Note that the Default JIRA QC Connection Note comes with defects already integrated between JIRA and QC. This Connection can be edited to allow requirements and test cases to be replicated as well and attachments too. DEMO-75 in JIRA created Defect ID 1131 in QC. Updates, comments, attachments are being updated bidirectional. Defects created in QC will similarly be automatically created in JIRA and linked back to QC. The issue types that can be replicated also include just about any type in either system, such as requirements, or stories, test cases, etc. 17 P age Copyright 2011, the Go To Group, Inc.

18 18 P age Copyright 2011, the Go To Group, Inc.