Skip to Content

This is part of a tutorial series on creating extension components for Design Studio.

When an end user comes into contact with a Design Studio app or dashboard, it is all web content.  Design Studio’s designer tool is another beast entirely.  It is an Eclipse Rich Client Platform (RCP) application and leverages both Eclipse itself and the Eclipse Modeling Framework (EMF).  Since our web content is going to need to live in Eclipse and in the EMF during design time, we’re going to need to supply some infrastructure to make this possible.

Eclipse is extendable.  Furthermore, these Eclipse extensions (Plug-Ins) can themselves be extended if they offer up an extension point.  Design Studio offers an extension point.   Presuming that we’ve installed Eclipse (VERSION) and Design Studio and that they are both the same bit depth (32 and 32, or 64 and 64), we can now go about configuring Eclipse to develop Design Studio extensions.

When we’re developing our extension, were going to want to test it periodically and when we’re done, we’re going to want to create a deployable package.  Therefore, we’re going to want to make sure that Eclipse knows about Design Studio and that Design Studio is a valid “thing with an extension point”.  In Eclipse, this is known as a Target Platform.

Step 1 – In Eclipse, select Window -> Preferences

Step1.png

Step 2 – In the Preferences dialog, search for “target”.  This will filter the available properties down to the Target Platform.  Select Target Platform.

Step2.png

Step 3 – At this point, if you have never done any plugin development, then there will be no target platforms.  Click on Add to create one.

Step3.png

Step 4 – Select “Nothing: Start with an empty target definition”.

Step4.png

Step 5 – We have an empty target definition.  First, give it a name.  Then click on the Add button, to define the actual target.

Step5.png

Step 6 – Since we want to use the existing Design Studio installation as the target platform, we’ll assign the directory where its executable resides as the target.  Select Directory.  Then navigate to Design Studio’s installation folder and select it.

Step6.png

Step 7 – You should see a long list of plugins in the preview pane.  Select Finish.

Step7.png

You should now have a Target Platform defined and it should be the default.  You are now ready to debug the Design Studio Extension projects that you work on.

Step 8 – Download and install the SDK samples.  These are useful as a reference point in any project.  If you ever find yourself asking “how do I do X”, then there is surely a sample that can help you.

As of Design Studio 1.5, the download location of the most recent version of the SDK samples is here:

http://help.sap.com/businessobject/product_guides/AAD15/en/DS_15_SDK_SAMPLES.zip

Unpack it.

Step 9 – When you are editing component properties and attributes, you’ll be doing it in XML; in the contribution.xml file..  There is a way to ensure that a particular type of XML file follows pattern.  This is to conform to it’s schema definition, if there is one.  The Design Studio SDK has a schema definition.  If we inform Eclipse where this schema definition is, Eclipse can warn us when we’ve made an error in our contribution.xml syntax and it can even give us value help.

Navigate back to the Window -> Preferences dialog and this time, select XML -> XML Catalog, or search for XML catalog.

Step9.png

Step 10 – In the Add XML Catalog Element, select Add.

Step10.png

Step 11 – Navigate to wherever in the filesystem that you unpacked your samples and select SDK.xsd.  Click on Finish and the sdk schema has been added to Eclipse.

Step11.png

Step 12 – Now we’re ready to import the sample SDK projects into our workspace.  Select File -> Import.  In the Import dialog, select General -> Existing Projects into Workspace.

Step12.png

Step 13 – Keep the default “Select root directory” radio button checked.  Click on Browse.  Navigate to the location of the projects in the filesystem (where sdk.xsd was).  Select the project(s) that you wish to import.

Step13.png

Step 14 –  Strictly speaking, Eclipse does not require you to copy the projects into the current workspace and can work with them in their original location.  If you check “Copy Projects into Workspace”, Eclipse will copy the content into a newly created folder in the workspace.  Doing this is good practice, as it keeps the projects together and makes them easier to port en-masse to newer versions of Eclipse or to other systems later.

Step14.png

Step 15 – Often, these imported projects contain metadata that was specific to the original project setup.  You may see error messages and the extensions won’t be startable.  To take care of this, you can command Eclipse to “clean” the metadata.  With the project selected, select Project -> Clean.

Step15.png

Step 16 – Select Clean All Projects and then click on OK.

Step16.png

Step 17 – You are now ready to check and see if your setup is ready for development.  Right click on the project in the Project Explorer.  Select Run As -> Eclipse Application.  This will start the currently active Target Platform (which should be Design Studio), with all currently open extensions installed.  Keep in mind, that this instance of Design Studio will not use the same workspace as Design Studio started normally; so apps developed outside of the context of debugging components will not be visible here and the apps that you work on to test your components won’t be seen elsewhere.

Step17.png

Next Instalment: Part 1 – Project Creation

To report this post you need to login first.

14 Comments

You must be Logged on to comment or reply to a post.

  1. Arijit Das

    Hi,

    I have followed the above instructions. At the last step, I am getting following error:

    Error.png

    I have:

    IE 11

    SAP BO Design Studio 1.5

    JRE 1.8.0_66

    Any Idea ?

    Thanks,

    Arijit

    (0) 
      1. Mike Howles

        That particular ‘error’ I get all the time and I ignore it.  For your IE 7.0 detected message, that’s really weird.  I’d suspect either some strange corporate policy or IE registry setting is to blame.

        (0) 
  2. Aby Aby

    Hi all,

    I work as BODS developer. Just to know about the custom objects i started doing this.

    I am also getting one error message while doing last step (loading a sample Extension ,run as “Eclipse Application”).

    Error screen is belowError.png

    And Error message in detail is below,

    Error Message.png

    Please give your valuable suggestions.

    rgds,

    Aby

    (0) 
    1. Mustafa Bensan

      Hi Aby,

      To ensure your issue gets better visibility I suggest you post this as a separate question instead of a comment.

      Regards,

      Mustafa.

      (0) 
    2. mohd fahad

      Hi Aby,

      You need to SET your ‘Target Platform’ as Design Studio instead of “Eclipse” -running platform.

      Hope this helps.

      2016-04-09 19_28_39-Preferences.png

      -Fahad

      (0) 
  3. mohd fahad

    Hi David,

    Thank you for sharing step by step instructions, very informative.

    Quick question:-

    I’m getting the below error –

    Message – Failed to read connections from SAP Logon.’

    I’ve added one custom data source connection through eclipse, and running DS local mode. (IS THIS RIGHT) or do I need to change connection to ‘platform’? 😕 .

    However, I can successfully run other custom components like rectangle shared by Mike though.

    Anyone please feel free to recommend suggestions, highly appreciate.

    Thanks

    -Fahad

    (0) 
    1. David Stocker Post author

      That error is a bit puzzling, especially as you are running in local mode.  When is the error happening?  When you add the data source?  If so, it might be related to the custom data source.  Do you still get it if you use a CSV data source?

      (0) 
  4. Kevin Ray

    I had Eclipse configured at one time, then my laptop got messed up and techs had to wipe everything out.  So I have re-loaded Eclipse (different version from what I had before).  I thought I had configured it properly.  Got to the last step and tried to run a sample. and I got an error (Design Studio opens, but no custom components).  FYI: We are having issues with BI servers so I have to run everything local for now.
     

    (0) 
  5. Marc Schweizer

    after a few problems i descriped here https://answers.sap.com/questions/213060/sdk-extension-design-studio-16-eclipse-run-as-appl.html

    i now got the problem that eclipse is running design studio but i got at the validation step a message that com.sap.ip.bi is missing.

    so i could start design studio from eclipse but i could not see the colored box example in the project explorer.

    furthermore eclipse is giving the followed error message after creating a new sapUI5m project in design studio:

    design studio:

    eclipse:

    017-06-01 15:48:06.674:INFO::main: Logging initialized @51876ms
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.gantt.gantt.lib: 201612060334
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ovp.ovp-lib: 201612061221
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.suite.suite-ui-commons: 201612060855
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.core: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ca.ui: 201610100951
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.mobile-ext: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ip.bi.zen.rt.themelib.phx: 201703101042
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.commons: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ip.bi.zen.rt.components.crosstab.phx-testresources: 201703101042
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.resource: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ushell.ushell-lib: 201612061132
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ip.bi.zen.rt.zencopy.phx: 201703101042
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.layout: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.uxap.uxap-uilib: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ip.bi.zen.rt.misogi.phx: 201703101042
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.vbm: 201612060150
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.apf.apf-lib: 201612060801
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.makit: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.themelib_sap_platinum: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.fl: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.tnt: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.collaboration.collaboration-commons: 201612061458
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ip.bi.zen.rt.components.crosstab.phx: 201703101042
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.comp: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.ux3: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.mobile: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.suite.suite-ui-microchart: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.table: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.richtexteditor: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.themelib_sap_goldreflection: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ca.scfld.md: 201610100951
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.viz: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.themelib_sap_bluecrystal: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.themelib_sap_belize: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.unified: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.impl.osgi.OSGiResourceLocator determineCacheBusterId
    INFORMATION: com.sap.ui5.ndc: 201612071124
    Jun 01, 2017 3:48:07 PM com.sap.ui5.resource.ResourceUtil loadProperties
    WARNUNG: An error occured when accessing the /META-INF/ui5.properties! Reason: The /META-INF/ui5.properties could not be found!
    

    any suggestions ?

    (0) 
  6. Pratik Kumar Mankar

    I tried all the steps and have a validation issue.
    JDK version: jdk1.8.0_141 64 bit

    JRE version: jre1.8.0_141 64 bit

    Design studio : 1.6 sp05 64b

    How to solve this one. This is when I try to run the project as an eclipse application

    (1) 

Leave a Reply