Getting Started with BusinessObjects Semantic Layer SDK

This post describes how to get started with BO Semantic Layer SDK in Eclipse. It explains the steps to setup a project and provides an example of the code that imports, modifies and exports a UNX universe. You will also find instructions how to run JAR from command line.

BO Client Tools and SL SDK

You need to have SAP BusinessObjects BI platform 4.x Client Tools and it should include Semantic Layer SDK.

The Semantic Layer SDK is not included in default installation. You can check if you have it and enable it in Control Panel > Programs > Programs and Features > SAP BusinessObjects BI platform 4.x Client Tools > Uninstall/change > Modify.

Make sure that you have "Semantic Layer Java SDK"


This post assumes that the client tools are installed in the default location, namely in

C:\Program Files (x86)\SAP BusinessObjects

If your setup is different, update the paths accordingly.

Setup New Project with SL SDK

Create a new Project in Eclipse.

Right click on the project and select Build Path > Add External Archives.


Add Semantic layer SDK library sl_sdk.jar. It is located in:

C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\SL SDK\java



Make sure that the project is using 32 bit Java Runtime Environment. The best is to use Java from the BusinessObjects folder.

Right click on JRE System Library and select Properties.


Click Installed JREs and add new JRE by clicking on Add > Standard VM, and then providing the following path:

C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\win32_x86\jre


Select the created JRE:


The Program

Add class Program to the project and paste the following code:

import com.crystaldecisions.sdk.exception.SDKException;
import com.crystaldecisions.sdk.framework.CrystalEnterprise;
import com.crystaldecisions.sdk.framework.IEnterpriseSession;
import com.crystaldecisions.sdk.framework.ISessionMgr;

public class Program {

  public static void main(String[] args) throws SDKException {
    String username = "Administrator";
    String password = "";
    String server = "localhost";
    String auth = "secEnterprise";
    String cmspath = "/Universes/webi universes";
    String unxname = "eFashion.unx";
    String tempFolder = ".";

    SlContext context = SlContext.create();
    IEnterpriseSession enterpriseSession = null;
    try {
      ISessionMgr sessionMgr = CrystalEnterprise.getSessionMgr();
      enterpriseSession = sessionMgr.logon(username, password, server, auth);
      CmsSessionService cmsSessionService =
      CmsResourceService cmsService = 
      LocalResourceService localResourceService =
      BusinessLayerFactory businessLayerFactory = 
      DataFoundationFactory dataFoundationFactory =
      System.out.println("Importing universe"); 
      String blxPath = 
        cmsService.retrieveUniverse(cmspath + "/" + unxname, tempFolder, true);
      System.out.println("Loading universe");
      RelationalBusinessLayer businessLayer =
        (RelationalBusinessLayer) localResourceService.load(blxPath);
      String dfxPath = businessLayer.getDataFoundationPath();
      DataFoundation dataFoundation =
        (DataFoundation) localResourceService.load(dfxPath);

      System.out.println("Modifying data foundation");
      String sql = "select count(1) as Cnt from Shop_facts";
      dataFoundationFactory.createDerivedTable("New_table", sql, dataFoundation);, dfxPath, true);

      System.out.println("Reloading data foundation");
      businessLayer =
        (RelationalBusinessLayer) localResourceService.load(blxPath);
      System.out.println("Modifying business layer");
      RootFolder rootFolder = businessLayer.getRootFolder();
      Measure measure = 
        businessLayerFactory.createBlItem(Measure.class, "New Measure", rootFolder);
      RelationalBinding binding = (RelationalBinding)measure.getBinding();
      binding.setSelect("New_table.Cnt");, blxPath, true);

      System.out.println("Exporting universe");
      cmsService.publish(blxPath, cmspath, true);
    } finally {
      if (context != null) {
      if (enterpriseSession != null) {

Run Configuration

Run the program. It will fail but a Run Configuration will be created.

Open the created run configuration in Run > Run Configurations

Add the following VM arguments"C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\dataAccess\connectionServer"


Add PATH variable with the value:

C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\win32_x86


Running the Code

The code uses eFashion.unx which should be located in webi universes. So you need to convert eFashion universe to eFashion.unx in Information Design Tool.


Now we are ready to run the program.

Click the button Run. The tool should execute without error and add table New_table and a measure New measure:


Running the Code from Command Line

Export the program to Executable JAR file (e.g. unxdemo.jar) from File > Export.

Create a batch file with the following script:

SET BO=C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0
SET PATH=%BO%\win32_x86
SET JAVA=%BO%\win32_x86\jre
SET CD=%BO%\dataAccess\connectionServer
SET CP=unxdemo.jar;%BO%\SL SDK\java\sl_sdk.jar;%BO%\java\lib\*
"%JAVA%\bin\java.exe""%CD%" -cp "%CP%" Program

Run the batch:


How to Allow Remote TCP/IP Connections for SQL Server

  1. SQL Server Configuration Manager > SQL Server Network Configuration > Protocols for SQLEXPRESS > TCP/IP
    TCP/IP Enabled
    IPAll > TCP Dynamic Ports is blank
    IPAll > TCP Port = 1433
  2. SQL Server Management Studio > Server Properties > Security
    Server authentication = SQL Server and Windows Authentication mode
  3. Services > SQL Server Browser
    Enable and start
  4. Windows Firewall with Advanced Security > Inbound Rules > New Rule… > Port
    Allow the connection for the port 1433

Tool for updating non-Administrator group

BO 4.x has a possibility to customize the user interface of Web Intelligence for specific groups of users. For instance, you may want to hide "Design Mode" interface elements for report viewers who are not supposed to edit reports.


This can be done in Central Configuration Management in Groups:



The problem is that the change will be applied for all users who belong to the group. If a report designer belongs to the group, it will not be able to see the disabled interface elements even if the user belongs Administrators group.

A solution is to create a group of non administrators group (say Others) and apply user interface customization for this group.

However it is a tedious work to maintain two groups Administrators and Others. I have created a tool which allows to maintain the Others group. If a user is not Administrators group (e.g. new user) or if it is removed from Administrators group, the tool will add the user to Others group. If a user is added to Administrators group, it will be deleted from Others groups.

Here is the link to archive:

The archive includes executable and source code:

The batch file has the following parameters you may need to change.

The location of BusienssObjects:

set BO=C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0

BO Administrator credentials:

set BOADMIN=Administrator
set BOSERV=localhost
set BOAUTH=secEnterprise

The groups names:

set EVERYONE=Everyone
set ADMIN=Administrators
set OTHERS=Others

Semantic Layer SDK – check java bitness, path variable and connectivity property

There are three things that are important when you build a program that uses Semantic Layer SDK.

  • You need to include sl_sdk.jar to the class path.
  • You need to use 32 bit java
  • The system property should be set to the connection server folder"C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\dataAccess\connectionServer"
  • The system variable PATH should be set to win32_x86
    C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\win32_x86

It is quite easy to see if sl_sdk.jar is included, your program will fail quickly with NoClassDefFoundError. It might be not so obvious with the other three. The following code may help you to check them:

System.out.println("java = " + System.getProperty("java.version") + ", " 
  + System.getProperty("") + " bit");
System.out.println("path = " + System.getenv("PATH"));
System.out.println(" = "
  + System.getProperty(""));

List of all relations in BusinessObjects

Below is the list of all relations in BusinessObjects 4.1 SP7. The relations are useful if you need to find dependent objects in Query Builder. A relations have a type and a name. Here is how to use it.

The relation Webi-Universe is Parent-Child, so Webi is Parent and Universe is Child. If you want to find all Webi documents (parents) that use a specific universe (child), you need to use query:

WHERE PARENTS("SI_NAME='Webi-Universe'","SI_NAME='{the name of the universe}'")

If you want to find all universes (children) that are used by a specific Webi document (parent), you need to use the query:

WHERE CHILDREN("SI_NAME='Webi-Universe'","SI_NAME='{the name of the webi document}'")


Child-Parent ActionSet-Action
Child-Parent ActionUsage-Action
Parent-Child AlertNotification-User
Child-Parent Application-Action
Parent-Child Application-DependencyRule
Parent-Child Application-Relationship
Child-Parent Category-Document
Parent-Child CommonConnection-AOPresentation
Parent-Child CommonConnection-AOWorkbook
Parent-Child CommonConnection-Document
Parent-Child CommonConnection-MDAnalysis
Parent-Child CommonConnection-pQuery
Child-Parent Container-ActionUsage
Parent-Child CrystalReport-BusinessView
Child-Parent CustomRole-Object
Parent-Child DataConnection-Universe
Child-Parent DefaultObject-Application
Child-Parent Document.discussion
Parent-Child Document-BIVariant
Parent-Child Document-DSL.Universe
Parent-Child Document-Excel
Parent-Child Document-Follower
Parent-Child Document-PersistenceQuery
Parent-Child Document-UnFollower
Child-Parent DSL.DataSecurityProfile-SecuredConnections
Child-Parent DSL.SecurityProfile-Principal
Child-Parent DSL.Universe-BusinessSecurityOptions
Child-Parent DSL.Universe-BusinessSecurityProfile
Child-Parent DSL.Universe-DataSecurityOptions
Child-Parent DSL.Universe-DataSecurityProfile
Child-Parent DSL.Universe-SecuredConnections
Parent-Child EnterpriseData-Flash
Parent-Child EnterpriseNode-MON.ManagedEntityStatus
Parent-Child EnterpriseNode-Server
Parent-Child Event-AlertNotification
Parent-Child Event-Principal
Parent-Child Event-Principal-Exclusion
Parent-Child EventSource-AlertNotification
Parent-Child EventSource-Event
Parent-Child Folder-MON.ManagedEntityStatus
Child-Parent InfoObject-Shortcuts
Child-Parent Install-EnterpriseNode
Parent-Child Install-Service
Parent-Child Install-ServiceContainer
Parent-Child Manifest-ReplicableObject
Parent-Child MON.ManagedEntityStatus-MON.MonitoringEvent
Parent-Child MON.ManagedEntityStatus-MON.Subscription
Parent-Child PlatformSearchContainer-PlatformSearchObject
Child-Parent Plugin-Action
Parent-Child Profile-Principal
Parent-Child PublicationArtifacts-SourceDoc
Parent-Child Publication-ExcludedPrincipal
Parent-Child Publication-FC
Parent-Child Publication-Principal
Parent-Child Publication-PrincipalReRun
Parent-Child Publication-Profile
Parent-Child PublicationScopeBatch-Artifact
Parent-Child PublicationScopeBatchDoc-Artifact
Parent-Child QAAWS-WEBI
Child-Parent ReferringDoc-SharedDoc
Parent-Child RelationalConnection-CrystalReport
Parent-Child Relationship-Application
Child-Parent RemoteCluster-ConflictingObjects
Parent-Child ServerGroup-MON.ManagedEntityStatus
Child-Parent ServerGroup-Server
Parent-Child Server-MON.ManagedEntityStatus
Parent-Child ServiceCategory-MON.ManagedEntityStatus
Parent-Child ServiceCategory-Service
Parent-Child ServiceContainer-Server
Parent-Child Service-Server
Parent-Child Service-ServiceContainer
Parent-Child Service-ServiceDep
Parent-Child ServiceUsedBy-Service
Child-Parent Tenant-ServerGroup
Child-Parent Universe(Core)-Universe
Child-Parent Universe-UserGroup
Parent-Child UpgradeManagementTool-LogicalGroup
Parent-Child UpgradeManagementTool-Plugin
Parent-Child User-BIVariant
Parent-Child User-CommonConnection
Child-Parent User-Favorites
Parent-Child User-FavouriteMEStatus
Parent-Child UserGroup-Folder
Child-Parent UserGroup-User
Child-Parent User-Inbox
Parent-Child User-MON.ManagedEntityStatus
Parent-Child User-MON.Subscription
Child-Parent User-PersonalCategory
Parent-Child User-VisualDiffComparator
Parent-Child VISI.Lums-ManagedConnectionRel
Parent-Child VISI.Lums-UniverseRel
Parent-Child WebiFHSQL-DataConnection
Parent-Child Webi-Universe
Parent-Child XL.XcelsiusEnterprise-DataSource
Parent-Child XL.XcelsiusEnterprise-XL.Query

HTTP Status 500 Bad tag encountered: 78

HTTP Status 500 – com.wedgetail.idm.sso.ProtocolException: com.wedgetail.idm.spnego.server.SpnegoException: Bad tag encountered: 78


See SAP Note 1799488.

Single sign on does not work by default for LaunchPad on the server machine. This behavior is by design as the servers are unable to pass Vintela filter.

Use the following URL to access LaunchPad on the server: http://localhost:8080/BOE/BI/logonNoSso.jsp

You may want to modify the LaunchPad link properties in Start Menu to use logonNoSso.jsp.

How to Change Banner in LaunchPad

This is a quick and dirty solution to change the banner in LaunchPad.


Do not forget to backup the files before any change. See SAP note 1659690 for a better solution.

  • Stop Tomcat.
  • Replace the file C:\Program Files (x86)\SAP BusinessObjects\tomcat\webapps\BOE\WEB-INF\eclipse\plugins\webpath.InfoView\web\images\SAP_logo_reg.png with desired logo (preferred dimensions: 63 x 31 px).
  • Delete all folders under C:\Program Files (x86)\SAP BusinessObjects\tomcat\work\Catalina\localhost
  • Start Tomcat.
  • The users will need to delete temporary files in browser to see the change. In IE, Tools > Internet Options > General, Delete under Browsing history:


How to Delete Files Older Than 30 Days from Windows Command Line

forfiles -p F:\Logs -s -m *.log /D -30 /C "cmd /c del @path"

Refresh button text in Web Intelligence reading mode

The Refresh button in 4.1 looks quite anonymous. It is possible to get the "Refresh" text back.


You can edit file

C:\Program Files (x86)\SAP BusinessObjects\tomcat\webapps\BOE\WEB-INF\eclipse\plugins\webpath.AnalyticalReporting\web\webiDHTML\viewer\language\en\scripts\UIDefinition.js

and change the line

,{actionId:"refreshDPMenu", text:"}



The button has actually text but it is overriden with empty string.

You will also need to update this file in tomcat work folder.


(The users might need to clear temporary files in order to see the change)


PS. This is probably not the right way to do this but it seems to be the most straightforward.

Unx Documenter

There is a free tool for extracting UNX universe metadata available on It also allows comparing universes.