IBM Sametime Eclipse Plug-in Development Environment

  • 208 views
Uploaded on

In this lab you will walk through the process of setting up a local environment for IBM Sametime Eclipse Plug-in Development.

In this lab you will walk through the process of setting up a local environment for IBM Sametime Eclipse Plug-in Development.

More in: Software , Technology
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Be the first to comment
    Be the first to like this
No Downloads

Views

Total Views
208
On Slideshare
0
From Embeds
0
Number of Embeds
0

Actions

Shares
Downloads
5
Comments
0
Likes
0

Embeds 0

No embeds

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
    No notes for slide

Transcript

  • 1. IBM Sametime 9.0 Workshop Author: Paul Godby Ecosystem Development Last Updated: November 13, 2013 IBM Sametime 9.0 Workshop Lab Manual Configuring an Eclipse plug-in Development Environment for IBM Sametime Connect Prerequisites: You must complete the following labs before proceeding with this lab: Installation and Configuration of ST 9.0 Connect Client COPYRIGHT IBM CORPORATION 2013. ALL RIGHTS RESERVED. IBM Ecosystem Development 1
  • 2. IBM Sametime 9.0 Workshop Introduction: The IBM Sametime Connect instant messaging client is built on the Eclipse-based IBM Lotus Expeditor platform. It leverages the Eclipse plug-in framework to provide developers with extensibility features that go far beyond those available in previous releases. IBM continues its commitment to the future of open source code with the release of IBM Sametime Connect. Since IBM Sametime Connect is developed on and for the Eclipse platform, you should have a basic understanding of Eclipse. Eclipse is an open source community whose projects are focused on providing an extensible development platform and application frameworks for building software. At its simplest level, Eclipse is an open-source foundation on which you can develop applications. The building blocks of Eclipse are called plug-ins, which are the smallest unit of Eclipse functionality. Eclipse plug-ins are like a power strip: there is a part that plugs into the electricity source and parts that other plugs can plug-into. An Eclipse plug-in may define: • Extensions, which are analogous to the plug part of the power strip, and • Extension points, which are analogous to the sockets of the power strip. Just as any appliance with a plug can use a power strip, so can any application with a plug, or extension, that fits use the extension points of a plug-in. In this way extension points can extend the original application in ways that grow with the needs of the user community. Description: In this lab, you will learn how to configure an Eclipse IDE for IBM Sametime Connect plug-in development. You will learn how to create a new workspace devoted to plug-in development that you can reuse in the future for all of your IBM Sametime Connect plug-in projects. You will learn how to import the samples applications into your new workspace. The samples applications will show you what extension points are available and how to begin coding your applications. Objective: This lab will explain the following tasks:  Configure the Eclipse IDE for IBM Sametime Connect plug-in development  Creation of a new workspace for plug-in development  Import the samples applications for quick reference and study COPYRIGHT IBM CORPORATION 2013. ALL RIGHTS RESERVED. IBM Ecosystem Development 2
  • 3. IBM Sametime 9.0 Workshop Procedure: SERVER SETUP You will not need to start any servers to complete this lab. Hooray! INSTALL THE LOTUS EXPEDITOR (XPD) TOOLKIT The IBM Lotus Expeditor Toolkit is used for Sametime development as it provides a rich set of tools and greatly reduces the complexity of the development environment setup. XPD Toolkit provides a complete, integrated set of tools that allow you to develop, debug, test, package, and deploy client applications to IBM Sametime Connect. In this section, you will install the XPD Toolkit into base Eclipse. Note: You will be using Eclipse 3.4.2 Classic. You MUST use the 32-bit version for IBM Sametime plug-in development. If you use a 64-bit Eclipse IDE, it may not work and it will be unsupported. Step 1 On the desktop, double-click the “Eclipse” icon to start the Eclipse IDE. Step 2 In the Workspace Launcher window, you will select a location for your development workspace. A workspace is a development profile that contains your projects, folders, files, and settings. Enter the following information and click OK. Field Value Workspace C:labsworkspacessametime_plugins Step 3 If you see the Welcome to Eclipse page, click the Workbench button. COPYRIGHT IBM CORPORATION 2013. ALL RIGHTS RESERVED. IBM Ecosystem Development 3
  • 4. IBM Sametime 9.0 Workshop Step 4 Now that you have a development workspace devoted to Sametime Connect, it's time to configure the environment for plug-in development. The XPD Toolkit has been provided for you in the C:labsExpeditor_Toolkit_Install folder. In the Eclipse IDE, select Help → Software Updates... Step 5 Switch to the Available Software tab Step 6 Click the Add Site… button. Step 7 Select Local… and navigate to the Expeditor Toolkit install directory, C:labsExpeditor_Toolkit_install. Click OK. Step 8 Click OK on the Add Site dialog box to add the local update site. Step 9 Select ONLY the “Lotus Expeditor Toolkit” feature in the Available Software tab and click Install... Step 10 Review the features that will get installed and then click Next. Step 11 Accept the license agreement and then click Finish to start installing the XPD Toolkit. The installation may take a few minutes. If you are asked if you want to trust certificates, click Select All followed by OK. Step 12 When the installation is complete, you are prompted to restart the platform. Click Yes. COPYRIGHT IBM CORPORATION 2013. ALL RIGHTS RESERVED. IBM Ecosystem Development 4
  • 5. IBM Sametime 9.0 Workshop Step 13 After the Eclipse IDE platform restarts, choose your existing workspace. You will be presented with the Lotus Expeditor Toolkit Configuration dialog box. Click Cancel at this point. The Sametime Expeditor Profile must be installed first so that you can target the IBM Sametime Connect client. INSTALL THE IBM SAMETIME PROFILE The Sametime Expeditor Toolkit Configuration is provided with the Sametime SDK. This configuration will allow you to use the Lotus Expeditor Toolkit to specifically target the Sametime Connect client. Step 14 Select Help → Software Updates… from the Eclipse menu. Step 15 Switch to the Available Software tab again and click Add Site... Step 16 Select Local... to browse to the Sametime Profile provided by the IBM Sametime SDK. Navigate to C:labsst9sdkclientconnectstXpdToolkitProfile folder and select it. Click OK to add it to the list of local update sites to visit. Step 17 Click OK on the Add Site dialog pop-up. Step 18 Select ONLY the “Sametime XPD Toolkit Configuration Feature” in the Available Software tab and click Install... Step 19 Review and confirm that the Sametime XPD Toolkit Configuration Feature is selected and click Next to continue the installation. Step 20 Accept the extremely verbose license agreement and click Finish to start the installation of the Sametime profile for the Expeditor Toolkit. Step 21 The installation may take a few minutes. Again, if prompted about trusting certificates, click Select All followed by OK. Step 22 After installation completes, it will prompt you to restart Eclipse. Click Yes. COPYRIGHT IBM CORPORATION 2013. ALL RIGHTS RESERVED. IBM Ecosystem Development 5
  • 6. IBM Sametime 9.0 Workshop CONFIGURE THE EXPEDITOR TOOLKIT WITHIN THE ECLIPSE ENVIRONMENT The Eclipse development environment is used to write the applications that you can run in the Sametime Connect client. However, before you start coding your Sametime application, you first have to configure the Eclipse environment for Sametime usage. This includes configuring the Eclipse JRE and Target Platform via setting the properties in the Expeditor Toolkit. The next few steps will teach you how to setup an Eclipse development environment for usage with the Sametime SDK. Step 23 When Eclipse restarts, choose your existing Sametime Connect Plug-ins workspace. You will be prompted to configure the Lotus Expeditor Toolkit. Now that the Sametime Profile is installed, you will be able to select it from the list of Test Environments. Step 24 Select “Lotus Sametime 8.5” in the Test Environment drop-down box. Note: Even though you are developing for Sametime 9, the old profile is still valid and will reference version 8.5. Step 25 The Target Location should auto-populate. You will want to verify that the location of your Sametime Connect client is correct. You can click Browse... to make any needed changes. You will need to choose the “rcpeclipse” directory under your Sametime installation. The final value should be the following: C:Program Files (x86)ibmSametime Connectrcpeclipse Step 26 When finished, your Lotus Expeditor Toolkit Configuration dialog box should look like the following: Step 27 Click OK. The current workspace in the Eclipse IDE will be reconfigured for development against the IBM Sametime Connect client! COPYRIGHT IBM CORPORATION 2013. ALL RIGHTS RESERVED. IBM Ecosystem Development 6
  • 7. IBM Sametime 9.0 Workshop Step 28 When the dialog vanishes, click the Workbench icon (in the top central portion of the screen) to return to the workbench. CONFIGURE THE RUN-TIME ENVIRONMENT In order to test your plug-ins, you will need to create a run-time configuration. This configuration basically allows you to configure and launch the target application for testing purposes. In this scenario, you'll be able to launch a new instance of Sametime Connect directly from the Eclipse IDE. Step 29 In Eclipse, click the green drop-down button and select Run Configurations... Step 30 In the Run Configurations dialog window, select "Client Services" and then click New (the icon of a page with a small yellow plus sign in the top right corner). Step 31 On the right, a configuration pane will be created for the new run-time configuration. At the top, give the configuration a name such as "IDR – Plugins" COPYRIGHT IBM CORPORATION 2013. ALL RIGHTS RESERVED. IBM Ecosystem Development 7
  • 8. IBM Sametime 9.0 Workshop Step 32 Next, in the Workspace Data section you will want to change the location of the run-time configuration and give it a readily identifiable name in the file system. For this lab, click File System... and choose the location c:eclipseruntimesidrplugins (if it does not exist, just type it in manually). You'll also notice a checkbox that says "Clear". If you select this box, your target application will not retain any settings you make and will launch as if it were just installed each time. For now, leave this unchecked. Step 33 Click on the Arguments tab. This tab will allow you to launch the target application with some additional arguments. For example, in order to rebrand the client, you need to modify the plugin_customization.ini file of Sametime Connect. In the Eclipse development environment, you can do this using a program argument. For example: -plugincustomization C:labsworkspacessametime_pluginscom.ibm.collaboration.realtime.sample.brandingpl ugin_customization.ini Step 34 In this lab, do NOT add any additional arguments. For now, proceed with the lab. Step 35 Click on the Plug-ins tab. This tab will allow you to select the plug-ins that will be launched in the target application. This could be extremely useful if you only want to test a single plug-in or if you have multiple plug-ins trying to extend the same unique part of Sametime Connect (for example, the branding areas). For now, leave all of the Workspace plug-ins checked. You should never uncheck any of the Target Platform plug-ins. Note: If you did not import any sample plug-ins, or if you have not yet created a new plug-in project, then you will not see a “Workspace” section. COPYRIGHT IBM CORPORATION 2013. ALL RIGHTS RESERVED. IBM Ecosystem Development 8
  • 9. IBM Sametime 9.0 Workshop Step 36 At the bottom of the Run Configurations dialog window, click Apply followed by Run to launch Sametime Connect directly from the Eclipse IDE. Step 37 Congratulations! You created a Sametime Connect run-time launch configuration in the Eclipse IDE. You will be able to continually use this configuration to test all of your plug-ins in the future. Step 38 When you are finished viewing your changes, close Sametime Connect and return to the Eclipse IDE. You can either do this from the Sametime Connect menu, or you can click the Terminate button (small red square) just above the console in the Eclipse IDE. COPYRIGHT IBM CORPORATION 2013. ALL RIGHTS RESERVED. IBM Ecosystem Development 9
  • 10. IBM Sametime 9.0 Workshop (OPTIONAL) IMPORT THE SAMPLE PLUG-INS You will usually want to import the Sametime Connect Toolkit plug-in samples. These samples will be invaluable to you as you begin plug-in development. You can reference these samples to learn how to make contributions to the UI, create instant messaging listeners and handlers, create preference pages for storing information, and developing SWT/JFace components for your end users. Step 39 Open the plug-in development perspective. A perspective is a collection of views and editors specially designed for a specific programming task. From the Eclipse file menu, choose Window → Open Perspective → Other Step 40 In the Open Perspective dialog window, choose Plug-in Development and click OK. Step 41 Now that you've enabled the tools for plug-in development, it's time to import the sample plug- ins. From the Eclipse file menu, choose File → Import... In the Import dialog window, choose Plug-in Development → Plug-ins and Fragments. When finished, click Next. Step 42 In the Import Plug-ins and Fragments dialog window, in the "Import From" section deselect the option to import from the target platform. COPYRIGHT IBM CORPORATION 2013. ALL RIGHTS RESERVED. IBM Ecosystem Development 10
  • 11. IBM Sametime 9.0 Workshop Step 43 Browse... to the location of the SDK samples. They are located at: C:labsst9sdkclientconnectsamples. Also, in the "Import As" section, choose the option Projects with source folders. When finished, your window should look like the following: Step 44 Click Next. In the new wizard page, click Add All → to add all of the plug-in samples to your workspace. Note: If there are multiple versions of a plug-in listed, you should choose the 9.x version. Step 45 Click Finish. The sample plug-ins will be added to the Package Explorer. Step 46 If asked to replace existing projects, click Yes To All. Summary: Congratulations! You have configured the Eclipse IDE for Sametime Connect plug-in development! You are now ready to write new plug-in applications for Sametime Connect! COPYRIGHT IBM CORPORATION 2013. ALL RIGHTS RESERVED. IBM Ecosystem Development 11