Download and view developer guides, API reference material, sample code, and object model diagrams for Java, .NET, COM, and Flex APIs available in SAP BusinessObjects BI 4.x. Visit the samples page to access the sample applications, reports, and dashboards. For version 3.x and earlier of the SDK library, visit the SAP BusinessObjects BI 3.x Developer SDK Library page.

Note:

1. To view the developer guides, save and uncompress the entire .zip file to your local drive and then open it.

    Otherwise, if you open the zip files directly from the browser, you may see "The Address is not Valid" error.

2. If you are opening a .chm file, clear the Always ask before opening this file check box in the Open File dialog box.

Java SDK Developer Guides And API References

View developer guides below that contain key concepts and tasks with supporting sample code snippets. In each guide, go to the Start Here > What's New sections to learn about new features in the SDK. Also view and download API references that contain syntax, information, and examples for the classes, interfaces, and members of each SDK.

To view online Javadocs for our Java SDKs, visit: http://help.sap.com/javadocs.

.NET SDK Developer Guides And API References

View developer guides below that contain key concepts and tasks with supporting sample code snippets. In each guide, go to the Start Here > What's New sections to learn about new features in the SDK.

Also view and download API references that contain syntax, information, and examples for the classes, interfaces, and members of each SDK.

COM SDK Developer Guides and API References

RESTful Web Services SDK Developer Guides and API References

Additional Guides And Resources

When using SAP BusinessObjects Enterprise, there are times where it is useful to perform an action on all objects of a particular type.  For example, if you want to delete all instances of a report, or you want to remap the universes for all webi reports.  For these types of tasks, a script can be very useful and significantly faster than making the changes manually.

The code below can be used as a template for looping through all crystal reports on an enterprise system and opening them using RAS to perform some kind of modification.  This code will work on a BOE XI 3.1 and a BI4 system.

When using SAP BusinessObjects Enterprise, there are times where it is useful to perform an action on all objects of a particular type.  For example, if you want to delete all instances of a report, or you want to remap the universes for all webi reports.  For these types of tasks, a script can be very useful and significantly faster than making the changes manually.

The code below can be used as a template for looping through all infoobjects an enterprise system and opening them to perform some kind of modification.  This code will work on a BOE XI 3.1 and a BI4 system.

1. To view the developer guides, save and uncompress the entire .zip file to your local drive and then open it. Otherwise, if you open the zip files directly
   from the browser, you may see "The Address is not Valid" error.
2. If you are opening a .chm file, clear the Always ask before opening this file check box in the Open File dialog box.
3. If you are saving a .chm file, right-click the file on your desktop, click Properties, and select Unblock. Next, ensure that the Read Only check box is cleared.

When using SAP BusinessObjects Enterprise, there are times where it is useful to perform an action on all objects of a particular type.  For example, if you want to delete all instances of a report, or you want to remap the universes for all webi reports.  For these types of tasks, a script can be very useful and significantly faster than making the changes manually.

The code below can be used as a template for looping through all webi reports on an enterprise system and opening them to perform some kind of modification.  This code will only work on a BOE XI 3.1 system.

Considerations before you get started

• For large productive landscapes it's recommended that you upgrade your BI Platform to SP4 Patch 12, SP6 Patch 1, or SP7.  Several corrections were made to improve stability and performance of the Monitoring Service (Adaptive Processing Server).  See note 1833881.
• Create a dedicated Adaptive Processing Server to run your Monitoring Services.  Best practice is to run no more than two dedicated Monitoring Services (two APS instances) as they work in a Active/Passive cluster.  For details on creating a dedicated Adaptive Processing Server, refer to Best Practices for SAPBO BI 4.0 Adaptive Processing Servers
• If you plan to keep historical details about the success or failure of your custom probe, you will need to enable the trending database.  For details, see the BI Platform 4.0 Administrator's Guide.

Health Probe, Diagnostic Probe, or Hybrid Probe

• A health probe generates metrics of data types such as integer, Boolean, or string.  An example of a health probe is the default CMS Logon/Logoff probe which checks that a user may successfully logon/logoff the Central Management Server. 
• A diagnostic probe generates reports containing current system information.  An example of a diagnostic probes is the default Stop/Start server probe. This probe checks all the servers, records the state of each server, restarts the servers and collects information about servers again.
• A hybrid probe functions as both a health probe and a diagnostic probe

Source code walk-through

Purpose

The purpose of this document is to provide a list of the top ten most viewed SAP Notes for Java SDK Application Development in the month of April 2013.

Overview

Below are the top 10 most viewed SAP Notes for Java SDK Application Development.

Please note, in order to view the contents of the SAP Notes, you may need to be logged into the SAP Service Marketplace.

Related Content

Purpose

The purpose of this document is to provide a list of the top ten most viewed SAP Notes for Java SDK Application Development in the month of May 2013.

Overview

Below are the top 10 most viewed SAP Notes for Java SDK Application Development.

Please note, in order to view the contents of most of these SAP Notes, you may need to be logged into the SAP Service Marketplace.

Related Content

Purpose

The purpose of this document is to provide a list of the top ten most viewed SAP Notes for Java SDK Application Development in the month of June 2013.

Overview

Below are the top 10 most viewed SAP Notes for Java SDK Application Development.

Please note, in order to view the contents of most of these SAP Notes, you may need to be logged into the SAP Service Marketplace.

Related Content

public void addProgramObjectToCms(IEnterpriseSession enterpriseSession,

            String jarPath, int parentFolderId, String programName)

            throws SDKException {

      IInfoStore infoStore = (IInfoStore) enterpriseSession

                .getService("InfoStore");

        IPluginMgr pluginMgr = infoStore.getPluginMgr();

        IPluginInfo pluginInfo = pluginMgr

                .getPluginInfo("CrystalEnterprise.Program");

        IInfoObjects newInfoObjects = infoStore.newInfoObjectCollection();

        IInfoObject newProgram = newInfoObjects.add(pluginInfo);

//folder in which you want to add the program

        newProgram.properties().setProperty("SI_PARENTID", parentFolderId);

        newProgram.properties().setProperty("SI_NAME", programName);

        File programFile = new File(jarPath);

        newProgram.getFiles().addFile(programFile);

        IProgram program = (IProgram) newProgram;

        IJavaProgram javaProgram = (IJavaProgram) program.getProgramInterface();

        javaProgram.setUserName("administrator");

        javaProgram.setPassword("password");

      // Give main class

        javaProgram.setMainClass("com.JavaProgram");

     //add arguments

        javaProgram.setArgs("abc");

     //commit the changes

        infoStore.commit(newInfoObjects);

    }

public void createShortInboxContent(IEnterpriseSession enterpriseSession,

            int folderId) throws SDKException {

        IInfoStore infoStore = (IInfoStore) enterpriseSession

                .getService("InfoStore");

        IPluginMgr pluginMgr = infoStore.getPluginMgr();

        IInbox iInbox = infoStore.getMyInbox();

        IInfoObjects infoObjects = infoStore.query("SELECT * FROM CI_INFOOBJECTS WHERE SI_PARENTID = "

                + iInbox.getID());

        for (int i = 0; i < infoObjects.size(); i++) {

            IInfoObject infoObject = (IInfoObject) infoObjects.get(i);

            IPluginInfo pluginInfo = pluginMgr

                    .getPluginInfo("CrystalEnterprise.Shortcut");

            IInfoObjects infoObject1 = infoStore.newInfoObjectCollection();

            infoObject1.add(pluginInfo);

            IShortcut shortcut = (IShortcut) infoObject1.get(0);

            shortcut.setTargetID(infoObject.getID());

            shortcut.setTitle(infoObject.getTitle() + "_" + infoObject.getID());

            shortcut.properties().setProperty(CePropertyID.SI_PARENTID,

                    folderId);

            infoStore.commit(infoObject1);

   }

    }

This document provides a way to retrieve the details of documents included in a publication using Business Intelligence platform Java SDK. The sample code lists all the documents associated with a publication and display the output in a browser window.

Warning

The code given below can be very destructive if not used properly.  Please ensure that you have made a backup of your CMS database and your Input and Output FRS prior to running any code.

For more scripts and information on how to run these scripts refer to the blog avaiable here:

http://scn.sap.com/people/shawn.penner/blog/2013/06/04/scripts-and-samples

Below is the Java Server Pages (JSP) sample to retrieve details of documents (source document (s) + dynamic recipient document) included in a publication

Notes:

•You would need to change the userName, password, cmsName and publicationName to the values specific to your enterprise server in the provided sample code.

• I sample code is tested with BI 4.0 version of SAP BusinessObjects Platform.

<%@ page import="com.businessobjects.sdk.plugin.desktop.publication.*,             com.crystaldecisions.sdk.occa.infostore.*,            com.crystaldecisions.sdk.framework.*,             com.crystaldecisions.sdk.plugin.CeKind,          java.util.*"
%><%          // Retrieve the logon information (this was entered on the index.html page).    String userName = "username";    String password = "password";    String cmsName = "cmsname";    String authType = "secEnterprise";    // Retrieve the publication name that is to be updated with dynamic recipients from    // the specified Crystal Report.  Also retrieve the Crystal Report name that is being    // used as the source of the dynamic recipients (these were entered on the index.html page).    String publicationName = "publication Name";
%><%        ISessionMgr boSessionMgr = null;    IEnterpriseSession boEnterpriseSession = null;           // Initialize the Session Manager by getting it from the Crystal Enterprise class's          // getSessionMgr function.          boSessionMgr = CrystalEnterprise.getSessionMgr();          // Logon to the Session Manager to create a new BOE session.  Pass in the user name, password,          // the CMS name, and the authentication type.          boEnterpriseSession = boSessionMgr.logon(userName, password, cmsName, authType);
%><%          // Business Objects Declarations.    IInfoStore boInfoStore = null;    IInfoObjects boPublicationInfoObjects = null;    IInfoObject boPublicationInfoObject = null;    IPublicationEventHandlers boPublicationEventHandlers = null;    IPublicationEventHandler boPublicationEventHandler = null;    IPublicationEventHandlerInfo boPublicationEventHandlerInfo = null;

try 
{    
//Retrieve the InfoStore object.    
boInfoStore = (IInfoStore) boEnterpriseSession.getService("", "InfoStore");        
 // Retrieve the desired publication.    
boPublicationInfoObjects = boInfoStore.query("SELECT * FROM CI_INFOOBJECTS WHERE SI_KIND = '" + CeKind.PUBLICATION + "' AND SI_NAME = '" + publicationName + "' AND SI_INSTANCE = 0");    
boPublicationInfoObject = (IInfoObject) boPublicationInfoObjects.get(0);         
// Cast the publication infoObject to IPublication.    
IPublication boPublication = (IPublication)boPublicationInfoObject; 
out.println("<b>Publication Name: </b>" + boPublicationInfoObject.getTitle() +"<br><br>");  
Collection collection= boPublication.getDocuments();
Iterator iterator = collection.iterator();     
out.println("<b>SourceDocument Info </b><br><br>");      while (iterator.hasNext()){
Object data = iterator.next();
String data1=(String)data.toString();
IInfoObjects sourceobjects= (IInfoObjects)boInfoStore.query("SELECT * FROM CI_INFOOBJECTS WHERE SI_ID="+ data);
IInfoObject sourceobject=  (IInfoObject)sourceobjects.get(0);          out.println("<b> Report Name: </b>" + sourceobject.getTitle() + "<br>");          out.println("<b> Report CUID: </b>" + sourceobject.getCUID()+ "<br><br>");      }
boPublicationEventHandlers = boPublication.getPublicationEventHandlers();
boPublicationEventHandler = boPublicationEventHandlers.getPublicationEventHandler(CePropertyID.SI_ON_READ_RECIPIENTS);   // Trigger when publication reads the list of recipients   
out.println("<b>Dynamic Recipients Document Info </b><br><br>");
if(boPublicationEventHandler.size()==0 )
{
out.println("The publication " + boPublicationInfoObject.getTitle() + " has zero dynamic recipients" );
}
else
{
boPublicationEventHandlerInfo  = (IPublicationEventHandlerInfo)boPublicationEventHandler.get(0);
IInfoObjects dynamicdocinfos = boInfoStore.query("SELECT * FROM CI_INFOOBJECTS WHERE SI_ID="+boPublicationEventHandlerInfo.getDynamicDataDocumentID());
IInfoObject  dynamicdocinfo= (IInfoObject) dynamicdocinfos.get(0);
out.println("<b> Report Name: </b>" + dynamicdocinfo.getTitle() + "<br>");
out.println("<b> Report Kind: </b>" + dynamicdocinfo.getKind() + "<br>");
out.println("<b>Report CUID: </b>" + dynamicdocinfo.getCUID() + "<br><br>");  
} 
}catch (Exception ex) {                      out.println(ex);            } finally {                    // Ensure clean-up of the Enterprise session              if(boEnterpriseSession != null) {                  try {                      boEnterpriseSession.logoff();                  } catch(Exception e_ignore_in_cleanup) {}              }           }
%>

Purpose

The purpose of this document is to provide a list of the top ten most viewed SAP Knowledge Base Articles for Top 10 viewed SAP KBAs for July 2013 (Java SDK Application Development) in the month of July 2013.

Overview

Below are the top 10 most viewed SAP KBAs for Migration.

Please note, in order to view the contents of the SAP KBAs, you will need to be logged into Service Marketplace.

Related Content

Purpose

The purpose of this document is to provide a list of the top ten most viewed SAP Knowledge Base Articles for Top 10 viewed SAP KBAs for July 2013 (Java SDK Application Development) in the month of July 2013.

Overview

Below are the top 10 most viewed SAP KBAs for Migration.

Please note, in order to view the contents of the SAP KBAs, you will need to be logged into Service Marketplace.

Related Content

<%
/*===================================================================
Creation Date - Oct 15, 2013
Description -   The sample application demonstrates how to assign a current      value to a report parameter in a publication
==================================================================*/
%><%@ page import="com.businessobjects.sdk.plugin.desktop.profile.*" %><%@ page import="com.businessobjects.sdk.plugin.desktop.publication.*" %><%@ page import="com.businessobjects.sdk.plugin.desktop.common.*" %><%@ page import="com.crystaldecisions.sdk.exception.SDKException" %><%@ page import="com.crystaldecisions.sdk.occa.infostore.*" %><%@ page import="com.crystaldecisions.sdk.framework.*" %><%@ page import="com.crystaldecisions.sdk.plugin.desktop.common.*" %><%@ page import="com.crystaldecisions.sdk.plugin.desktop.folder.*" %><%@ page import="com.crystaldecisions.sdk.plugin.desktop.report.*" %><%@ page import="com.crystaldecisions.sdk.plugin.desktop.user.*" %><%@ page import="com.crystaldecisions.sdk.plugin.desktop.usergroup.*" %><%@ page import="com.crystaldecisions.sdk.plugin.destination.managed.*" %><%@ page import="com.crystaldecisions.sdk.plugin.destination.smtp.*" %><%@ page import="com.crystaldecisions.sdk.plugin.CeProgID" %><%@ page import="com.crystaldecisions.sdk.plugin.CeKind" %><%@ page import="com.crystaldecisions.sdk.properties.*" %><%@ page import="com.crystaldecisions.sdk.occa.pluginmgr.*" %><%@ page import="java.util.*" %><%
 //Retrieve the logon information    String boUser ="username";    String boPassword = "password";    String boCmsName = "cmsname";    String boAuthType ="secEnterprise";        String publication_name = "publication_name";    String report_name ="report_name_in_publication";
%><%    // Logon and obtain an Enterprise Session    IEnterpriseSession boEnterpriseSession = null;    boEnterpriseSession = CrystalEnterprise.getSessionMgr().logon( boUser, boPassword, boCmsName, boAuthType);    session.setAttribute( "boEnterpriseSession", boEnterpriseSession);
%><%    IInfoStore boInfoStore=null;    IInfoObjects boInfoObjects=null;    IInfoObject boInfoObject=null;    IInfoObjects boInfoObjects2=null;    IInfoObject boInfoObject2=null;
 IPluginMgr pluginMgr = null; //Plugin Manager returned from InfoStore    IPluginInfo reportPlugin = null; //Report PluginInfo object    IInfoObjects newInfoObjects = null; //new collection created from InfoStore    IInfoObject newInfoObject = null;  try{     //Retrieve the InfoStore object     boInfoStore = (IInfoStore) boEnterpriseSession.getService("", "InfoStore");          // Retrieve the desired publication     boInfoObjects = boInfoStore.query("SELECT * FROM CI_INFOOBJECTS WHERE SI_KIND = '" + CeKind.PUBLICATION + "' AND SI_NAME = '" + publication_name + "' AND SI_INSTANCE=0");     boInfoObject = (IInfoObject)boInfoObjects.get(0);       IPublication boPublication = (IPublication)boInfoObject;    //Retrieve the requested report  (If you know the SI_ID of the report - you can skip this step which just gets the ID)  boInfoObjects2 = boInfoStore.query("Select SI_ID, SI_KIND, SI_PROCESSINFO FROM CI_INFOOBJECTS WHERE SI_NAME='" + report_name + "' AND SI_INSTANCE=0");  boInfoObject2 = (IInfoObject)boInfoObjects2.get(0);  int documentID = new Integer(boInfoObject2.getID());  String documentKind = boInfoObject2.getKind();    // Now create a blank crystal report object  // Note: Because publications store a custom processing info collection, while still pointing back at the original report, it is possible for the  // two to become de-synchronized.  As a result, it is preferable to re-import the original report when modifying properties.  However, if you want  // to just update in place - then you can use the code below.    //Retrieve the PluginManager and use it to retrieve Crystal Report plug-in.        pluginMgr = boInfoStore.getPluginMgr();        reportPlugin = pluginMgr.getPluginInfo("CrystalEnterprise.Report");        //Create a new, empty InfoObjects collection.        newInfoObjects = boInfoStore.newInfoObjectCollection();        //Add the plug-in to the collection.  This creates a new InfoObject that represents a new Report        newInfoObject = newInfoObjects.add(reportPlugin);  IReport crystalReport=(IReport)newInfoObject;      // Now retrieve any custom processing properties and add them into the infoobject  com.crystaldecisions.sdk.properties.IProperties processingProperties = boPublication.getDocumentProcessingInfo(documentID);  crystalReport.getProcessingInfo().properties().putAll(processingProperties);     // Now retrieve the processing info for the desired report.  //  // Note:  // If this object was a webi report, then we would cast it to an IWebiFormatInfo object, or IFullClientFormatInfo object for Deski  IReportProcessingInfo boProcessingInfo = (IReportProcessingInfo)crystalReport;     // Now retrieve the report parameters collection    List boParamList = (List)boProcessingInfo.getReportParameters();    // Now loop through the parameters and set values.  for (Iterator i = boParamList.iterator(); i.hasNext();)   {       IReportParameter boParam = (IReportParameter)i.next();   IReportParameterValues boCurrentValues = boParam.getCurrentValues();   boCurrentValues.clear();   IReportParameterSingleValue boSingleValue = boCurrentValues.addSingleValue();   boSingleValue.setValue("This is a parameter Value");  }       // Save everything back        boPublication.setDocumentProcessingInfo(documentID, documentKind, crystalReport.getProcessingInfo().properties());       // Save the publication  boPublication.save();     out.println("Publication Succesfully Modified");     } finally {     /*      * Ensure clean-up of the Enterprise session.      */     if(boEnterpriseSession != null) {         try {             boEnterpriseSession.logoff();         } catch(Exception e_ignore_in_cleanup) {}     }
 }
%>

This document provides a way to get the web intelligence server metrics using Business Intelligence platform Java SDK.

For more scripts and information on how to run these scripts refer to the blog avaiable here:

http://scn.sap.com/people/shawn.penner/blog/2013/06/04/scripts-and-samples

Below is the Java Server Pages (JSP) sample

Notes:

•You would need to change the userName, password, cmsName  to the values specific to your enterprise server in the provided sample code.

• The sample code is tested with BI 4.0 version of SAP BusinessObjects Platform

<%@ page import="java.util.*" %><%@ page import="com.businessobjects.sdk.plugin.desktop.common.IMetric"%><%@ page import="com.businessobjects.sdk.plugin.desktop.common.IMetrics"%><%@ page import="com.crystaldecisions.sdk.framework.CrystalEnterprise"%><%@ page import="com.crystaldecisions.sdk.framework.IEnterpriseSession"%><%@ page import="com.crystaldecisions.sdk.framework.ISessionMgr"%><%@ page import="com.crystaldecisions.sdk.occa.infostore.IInfoObject"%><%@ page import="com.crystaldecisions.sdk.occa.infostore.IInfoObjects"%><%@ page import="com.crystaldecisions.sdk.occa.infostore.IInfoStore"%><%@ page import="com.crystaldecisions.sdk.plugin.desktop.server.*"%><html><head></head><body><table border="2" cellpadding="0" style="border-collapse: collapse" bordercolor="#111111" width="100%" id="AutoNumber1"><tr><th width="30%">Server Name</th><th width="40%">Metric Name</th><th width="30%">Metric Value</th><%   final String _userid = "administrator";  //use BO Enterprise User ID    final String _password = "Password1";         //fill in password   final String _cms = "localhost:6400";   final String _authentication = "secEnterprise";      IInfoStore boInfoStore = null;   IInfoObjects boInfoObjects = null;   IEnterpriseSession eSession = null;   IServer currentServer = null;    IServerMetrics webiAdmin = null; 
 try {  ISessionMgr mySessionMgr = CrystalEnterprise.getSessionMgr();  eSession = mySessionMgr.logon(_userid, _password, _cms,_authentication );       boInfoStore = (IInfoStore) eSession.getService("InfoStore");  boInfoObjects = boInfoStore.query("Select * From CI_SYSTEMOBJECTS Where SI_PROGID='CrystalEnterprise.Server' and  SI_NAME='BIPW08R2.WebIntelligenceProcessingServer'");  currentServer = (IServer) boInfoObjects.get(0);    out.println ("<tr><td>" + currentServer.getTitle()+"</td>");        webiAdmin = (IServerMetrics)currentServer.getMetrics();        IMetrics serverMetrics=(IMetrics)webiAdmin.getMetrics("WebiServerAdmin");        for(int j=0;j<serverMetrics.size();j++)        {        IMetric serverMetric=(IMetric)serverMetrics.get(j);        out.println ("<td>" + serverMetric.getName()+"</td>");        out.println ("<td>" + serverMetric.getValue()+"</td></tr>");  out.println ("<tr><td></td>");        }   }   catch (Exception e)   {  out.println(e);  }  finally  {  if(eSession != null)  eSession.logoff();  }
%></table></body></html>

This is a sample created using the Semantic SDK for SAP BusinessObjects Business Intelligence platform 4.1  It demonstrates how to create a new connection from scratch and then publish it to Enterprise.  The sample will create a file SDKTestRelationalConn.cnx in the folder C:\temp and then publish it to Enterprise.

Notes:

• It is not possible to modify a published connection directly.  It must first be saved locally, at which point you can edit it, and then re-publish it.
• If you get the error "Could not find driver for MS SQL Server 2008\OLE DB Providers" or similar, it is because you are missing the java parameter:
  -Dbusinessobjects.connectivity.directory="C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\dataAccess\connectionServer"
• The necessary jar files are all referenced from the jar file sl_sdk.jar which is located in the folder C:\Program Files (X86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\SL SDK\java.  The sl_sdk.jar file does not actually contain the SDK - it merely contains relative paths to all the necessary jar files.

Extra Note: Sample was created by Dan Paulsen

This document provides a way to retrieve the details of Web intelligence report to get information of Report name , Report Id and the associated Universe name and Path for the Webi report in BO server using Business Intelligence platform Java SDK. The sample code lists all the poperties associated with a Webi and display the output in a browser window.

This document provides a way to get the central management server metrics using Business Intelligence platform Java SDK.

For more scripts and information on how to run these scripts refer to the blog avaiable here:

http://scn.sap.com/people/shawn.penner/blog/2013/06/04/scripts-and-samples

Below is the Java Server Pages (JSP) sample

Note:

•You would need to change the userName, password, cmsName  to the values specific to your enterprise server in the provided sample code.

• The sample code is tested with BI 4.0 version of SAP BusinessObjects Platform