How to install and check the Eclipse Management plugin for the DataPower appliance.
| Problem(Abstract) |
| How to install and check the Eclipse Management plugin for the DataPower appliance. |
https://www14.software.ibm.com/webapp/iwm/web/reg/pick.do?source=idpe&SCMP=JDK&lang=en_US.
B. Install Eclipse. You can get this from www.eclipse.org, and it requires JRE 1.4.2 or later to run. If you have difficulty installing or using this, please contact Eclipse.
C. Install the DataPower Eclipse plugins
General set up. Do these steps if you are installing either or both plugins.
1. Open a web browser to http://www-01.ibm.com/software/integration/datapower/support/.
2. Under the download sections is the option ‘Firmware and documentation download‘
3. The next page has a section in bold ‘Documentation and files‘, follow the link to the ‘Fix Central download site‘.
4. Select the product group ‘WebSphere‘ and click continue.
5. Select the product ‘WebSphere DataPower SOA Appliances‘ and click continue.
6. Select the appropriate firmware level you are running on your system (eg. 3.8, 3.7.3, 3.7.2, 3.7.1).
7. Keep the Platform selected to ‘All’ and continue.
8. Login with your Public IBM ID Credentials as used in other http://www.ibm.com services.
9. The next page, ‘Identify Fixes’ will have Browse fixes selected as ‘All’, click continue at the bottom of the page.
10. Select ‘All‘ on the Results per page option available on the right hand side of the download list.
11. After making all results available, search for ‘ResourceKit’ and select the checkbox beside the kit that specifies your device type (XA,XS, XI, XB, XM).
12. Scroll to the bottom of the page to select your download method and click Continue.
13. The next page is a User Agreement which will need to be reviewed.
14. The final page will allow you to download the Resource Kit.
15. After extracting the ResourceKit you will find the eclipse plugins inside the ‘eclipse’ directory.
To install the Eclipse Management plugin:
1. Download the Eclipse Management Plugin.
2. Download the root-ca-cert.pem.
3. Download the “Eclipse Management Plug-in” pdf for documentation.
4. On a Unix machine: Import root-ca-cert.pem to lib/security/cacerts trusted certificate store.
5. On a Windows machine: Users must add the root-ca-cert.pem certificate to JRE’s keystore using the Java keytool. Follow these steps:
i. Copy the root-ca-cert.pem file to c:\temp.
ii. Open a command prompt (Start->Run->”cmd”)
iii. Change to Java-Dir/lib/security (cd c:\Program Files\Java\j2re<version
number>\lib\security)
iv. Add the certificate to keystore (..\..\bin\keytool.exe -import -alias dproot -file
\temp\root-ca-cert.pem -keystore cacerts). When prompted by keytool for the
keystore password, use “changeit”, if the default password has not been changed.
6. Unzip the Eclipse Management Plugin zip file into the Eclipse home directory.
7. Open Eclipse. Close down the introductory screen and go to the workbench.
8. In the menu bar at the top of the screen, select Windows>CustomizePerspective.
9. Click on the “Commands” tab and make sure the “DataPower Management” selection is checked. This will add a new button with the DataPower logo in the main Eclipse tool bar. Select the button to switch to Management Perspective. As an alternative, open the Management Perspective through the OpenPerspective button on the upper right side of the tool bar.
In order for the Management plugin to work, you must enable web and XML management:
10. Log into the DataPower device in the default domain.
11. Click the Network menu bar on the left to expand the selection area, and then click “Web Management” (under “Management”).
12. Make sure that web management is on by selecting the radio button next to “enabled” in the Admin field.
13. Click “Apply” if you made any changes.
14. Click the Network menu bar on the left to expand the selection area, and then click “XML Management” (under “Management”).
15. Make sure that XML management is on by selecting the radio button next to “enabled” in the Admin field.
16. Click “Apply” if you made any changes.
To check that the Management plugin is working:
17. Open Eclipse.
18. Click on the DataPower logo icon to enter the management view.
19. The upper left section of the view is a box entitled “Device Manager.” Along the top of the Device Manager box is a series of icons. The left-most icon is a chart with a plus sign on it, and represents adding a device. Click this icon.
20. Click “yes” to add a device.
21. Fill out the hostname, username, and password. Click “OK.” You should now see the device listed in the Device Manager box.
22. Click on the plus sign next to the box’s name to expand it.
23. You will see “Control Panel” as an option under the box. Click on this. You should see the control panel appear.
24. Click on the plus sign next to “File Management” to expand it.
25. Under File Management, click on “image.” This pulls up a table.
26. Drag and drop a small test file from your client machine to the table. Make sure it appears in the table afterwards.
27. Log into the DataPower appliance.
28. On the control panel, click “File Management.”
29. Select “image” from the dropdown. Your file should now be there.
To install the Eclipse CoProcessor plugin:
1. Download the Eclipse XSLT Coproc Plugin (Review Section C. above)
2. Download “Eclipse XSLT Coproc Plugin Instructions” for related documentation.
3. Unzip the Eclipse XSLT Coproc Plugin into the Eclipse home directory.
4. Open Eclipse. Close down the introductory screen and go to the workbench.
5. In the menu bar at the top of the screen, select Windows>CustomizePerspective.
6. Click on the “Commands” tab and make sure the “DataPower Coprocessor” selection is checked. This will add four buttons to your main button bar: upload, compile,
transform, and stylesheet parameter. All four buttons have a pull-down menu for a history of the recently used files.
In order for the Coprocessor plugin to work, you must create a XSL Coprocessor service on the DataPower device to interact with the Eclipse plug-in. Please:
7. Log into the DataPower device.
8. Click the Services menu bar on the left to expand the selection area, and then click “XSL Coprocessor” (under “XSL Service”).
9. Click Add to create a new service.
10. Enter a name for the new service in the Name field.
11. Enter an integer in the Port Number field (must be unique throughout the device).
12. Click Apply.
13. Click Save Configuration.
To check that the Coprocessor plugin is working:
14. Open Eclipse.
15. Select Window>Preferences.
16. In the left hand pane of the dialog you will see “DataPower Coprocessor”. Click on it.
17. Type in your hostname (or ip address) and the port number used for XML Coprocessor service. You can check which port this is by going to the DataPower appliance, clicking the Services menu bar on the left to expand the selection area, and then clicking “XSL Coprocessor Service” (under “XSL Service”).
18. Click Apply then OK.
19. Create a new project for your test.
i. Go to File>New>Project.
ii. Select “Simple” or “General” as the type.
iii. Highlight the “Project” folder under Simple or General and click “Next”.
iv. Give your project a name.
v. Click “Finish”.
20. Create a file called text.xsl on the local file system. In it, place the following:
<?xml version=”1.0″ encoding=”UTF-8″ ?>
<xsl:stylesheet version=”1.0″ xmlns:xsl=”http://www.w3.org/1999/XSL/Transform”>
<xsl:template match=”/”>
<message>
<confirmation>I got your message.</confirmation>
</message>
</xsl:template>
</xsl:stylesheet>
21. Create a file called test.xml on the local file system. In it, place the following:
<?xml version=”1.0″ encoding=”UTF-8″?>
<message xmlns=”http://www.example.com”
xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” >
<to>Alice</to>
<from>Bob</from>
<subject>Important</subject>
<body>
Hello, there.
</body>
</message>
22. Look for your test project in the lower left panel of Eclipse.
23. Right click the project, and select “Import.”
24. Choose “File System.” (This may be under General.)
25. Click “Next.”
26. Browse to your test files and import them. Click “Finish.” You will now see them in your project. (You might have to expand the folder)
27. Expand the project, and highlight the xsl file.
28. On the main tool bar you will see a button with a downward-pointing arrow. Hover over it and check that it is the “Compile XSLT Stylesheet” button. Click it.
29. You will get a confirmation dialog. Click OK. The file will compile, and you will get a pop-up box confirming this. Click OK to dismiss it.
30. After successful compilation, highlight the xml file.
31. The button to the right of the compile button is the transform button. Hover over it and you will see “Transform XML input with XSLT Stylesheet.”
32. Associated with the “Transform XML” button is an arrow. Click the arrow and select the test.xsl file.
33. You will get a dialog asking if you want to transform test.xml with test.xsl. Click “OK. The file will compile.
34. A TRANSFORM file will appear in your project. Double-click to open it. The contents will look like:
<?xml version=”1.0″ encoding=”UTF-8″?>
<message><confirmation>I got your message.
</confirmation></message>
Thys Michels Blog 
I followed the above steps, have 2 errors
1. Unable to transform my xml,with the co proc, as it says that the files are uncachable.
2. Unable to add a device, as it says, that the IBMX509 Keystorefactory unavailable.
Hi Parekh, on your questions: 1. What version is your Datapower firmware, upgrade to 3.8.* to fix the problem. 2. make sure you are using the IBM Eclipse version from Fixcentral. I doesn’t work with any eclipse version.
hi Thys,
I’ve finally got the Coproc working by changing the version from 3.0.0.0 to 3.6.1.0 in ..\eclipse\features\com.datapower.xml.xslt.coproc.feature_3.6.1.0 feature text file
1. In your instruction above, you say to Create the Coproc service on the DP. I.m running firmware 4.0.1.2 and also 4.0.2.0 on XB 60s and this option doesn’t exist in either firmware.
2. The Coproc product config in Eclipse says it’s only for XA/XS – is that an issue?
“The DataPower Coproc plugin for the Eclipse IDE provides access to the XSL Co-Processor Mode of the XA35/XS40. It allows for transparent XSLT compilation, and XML transformation on the XA35/XS40 device from within the Eclipse user environment.”
3. Also, the Eclipse Coproc SSL checkbox is greyed-out so I cannot activate it.
Thanks, Phil
Hi Phil, co-processor is deprecated feature in XB60 use HTTP Loopback proxy: http://www-01.ibm.com/support/docview.wss?uid=swg21410484
Below is a workaround for a HTTP Loopback proxy in XB60 as it does not have a Looback proxy: http://www.ibm.com/developerworks/forums/thread.jspa?messageID=14528907
Let me know if you have any other questions.
Is there any way to make the management console work for XI52 4.0.2.0, I am getting PKIXCertPathBuilderImpl could not build a valid CertPath. I have been using it with 3.7.3.5 successfully.
copy the cacerts attached to the root directory of your application run the jvm with these args
-Djavax.net.ssl.trustStore=./cacerts -Djavax.net.ssl.trustStorePassword=changeit
Reference is made to the “Eclipse Management Plug-in” pdf – how do I obtain a copy of the pdf?
You have to login here: https://www14.software.ibm.com/webapp/iwm/web/preLogin.do?source=swg-dpd
Unfortunately your suggestion didn’t fix the issue and I still get the PKIXCertPathBuilderImpl could not build a valid CertPath error when trying to add the XI52 device. Any other ideas?
The error can be any of the following:
1. SSL is being used (HTTPS) when environment is not configured to support SSL 2. Incorrect / Invalid certificate is installed on one or more cognos servers 3. Certificate is not installed on the end user machines, or is incorrect / invalid.
How do you import the root-ca certificate into eclipse?And are you using the IBM Java SDK or Sun Java SDK?
Using IBM SDK. Importing using instructions above. I have this working on all my XI50 devices running 3.7.3.5
Did the key change going to 4.0.2? The web management interface is working over https, wouldn’t that have a problem too?
Got it working, your SSL comment was it, had to add the SSL config to the Custom SSL Proxy Profile setting under advanced.
I followed all the steps mentioned here and getting ‘Connection refused’ error when trying to establish connection from my Eclipse IDE to DataPower device. I used ResourceKit XI50.38111 even though the firmware version of my DataPower appliance is 4.0.2.
Do I also have to install the same certificate (installed on my local machine) on the DataPower appliance as well?
Any help will be really appreciated. Thanks.
Hi Jayanta, you need to make sure you are using the IBM JDK and not Sun JDK (now Oracle JDK). Navigate to the Fix Central link and download the Documentation and files for firmware XI50 4.0.2. You will also download a root-ca-cert.pem file which you need to add to keystore (Windows) or add to /lib/security/cacerts (Unix).
Datapower is not seeing your root-ca-cert.pem file when it want to create a ssh connection to send info to the plugin. No need to upload pem. You do have to open port XML Management port to a poer number for datapower to communicate to the plugin. http://www-01.ibm.com/support/docview.wss?uid=swg21239354
Let me know if you have any more questions.
Hi Thys, Thanks for your reply. Yes, I’ve done the exact same steps you mentioned about IBM JDK and root-ca-cert.pem.
I found out that the XML Management port #5550 is blocked within our company since it’s inside the DMZ. I’m currently working for a workaround to this, and will let you know when I have some update. Thanks and appreciate your help. – Jay
That is good news and sounds like we are making progress. Keep me updated.
Sent from my iPhone
Now I’m getting ‘Requesting firmware version – Error’ within my IDE. I mentioned to you earlier, about different firmware versions between DP device (4.0.2) and Resource ToolKit (3.8.1) used in Eclipse IDE. Could that be the reason? Any solution to that? Thanks for your help.
Hello Thys
i don’t understand why i have this error : com.ibm.jsse2.util.g:PKIX path building failed: java.security.cert.CertPathBuilderException: unable to find certification path to requested target
I’am on windows. I generate cacerts into jre folder (C:\eclipseDevelopmentPackage\ibm_sdk60\jre\lib\security)
Hi Daviiid, you need to add the certificate to java keystore (..\..\bin\keytool.exe -import -alias dproot -file \temp\root-ca-cert.pem -keystore cacerts)
Hi Thys
i added the certificate before i posted my message
It looks like it cannot find the certificate. I will or readd the certificate or make sure that your using the IBM Java SDK.
I download the IBM Java SDK. It contains a directory : ibm_sdk60
So i add the certificate into this keystore : ibm_sdk60\jre\lib\security. Is that correct?
The procedure to import the certificate is ok. There is cacerts file into the directory.
i found the solution
I had to change the java home variable and set this : ibm_sdk60
Great, thanks for the share!
Hi Thys Michels, I am having problems on Eclipse plugins instalation. Could you help me with this? Thanks!
I have this problem of XML Management Port not set up. What exactly I must do set up custom ssl proxy profile.
Hi Thys Michels,
I have followed all the steps for management plugin. When I try to add a device, I am getting error saying “updating version information – error could not establish the connection”.
Datapower : Firmware Rev:XI50.3.8.2.4
Management plugin downloaded for XI50.3823 is com.datapower.mgmt.feature_3.6.1.bin.dist.zip
5550 port is open and I could able to run the SOAP UI request over it. I have added the certificate to the eclipse jdk.
I have followed all the installation and troubleshoot for dp plugin setup in eclipse and RAD both but both failed. still getting this error:
com.ibm.jsse2.util.j:PKIX path building failed: java.security.cert.CertPathBuilderException: unable to find valid certification path to requested target may be I am not able to configure custom ssl proxy profile properly. Can anybody help? my firmware is xi526.0.1.0 and it’s a dp virtual image.
I am not able to find the Management plugins inside the Resourcekit.. I have downloaded ResourceKit.7000 . Kindly help where can i find the plugins
Hello! Anybody Lucky made it work with 7.5.x? We are getting this error : Updating filesystem status – Error HTTP error (500): Internal Server Error.
By the way, I had to enable SSL v3 on the ssl profile, because without that, we were having an “handshake failure”.