Getting Started With BO 4.1 Java SDK Using Net Beans
SAP Business objects(BO) is a popular Enterprise software company that develop desktop and web applications for data analysis and reporting . Besides this, Business objects Enterprise provides a Standard Development Kit (SDK) for developing customized tools.Business objcets (BO) Report engine Java SDK (Software Development Kit) is a set of development tools primarily used for the customization of the existing tools available within Business objects.We can also use Dot Net(.NET) SDK. This customization will make the work of report developers easy. This artifact will be helpful to get start with BO Java SDK integration to develop customized BO tools using NetBeans. Business objects has a set of jar(java archive) files when installed.Using the predefined classes and methods present in the jar files developers can customize and develop a tool as per the business needs.
- 1) Netbeans 8.0.1
- 2) Apache Tomcat 7.0 or above
- 3) JDK 1.7 or above (Java Development Kit)
What is a host file?
The HOSTS file is a text file that contains IP addresses separated by at least once space and then a domain name, with each entry on its own line. Any websites can be blocked or unblocked or communication with external servers on a particular machine can be blocked with this host file.
Step 1: The host file will be located in the following path.
Step 2: Find the ip address and full host name of the BO 4.1 server
(a) Find the ip address.
To protect the system from vulnerably all the communication with some external servers will be blocked by default. To create a communication between an external server , developers have to get the help of admin team and ask them to provide the host file entry in their machine with required details. To make a host file entry there are two important things.
- 1. IP address
- 2. Full HOST name.
The IP address of the server can be found by the following method
Start -> Run -> cmd -> ipconfig
Note: Developer should be logged in the server machine to do the above operation.
If login to the server is not available, then contact the server administrator to get this done.
(b) Find the Full host name.
Right click on my computer icon in desktop and choose Properties option.
Step 3: Enter the ip address and full host name into the host files as shown in the figure and example.
Tomcat server Configuration:
This following are the steps to configure the username and password for tomcat server which is installed in the local machine.
Step a: Go to the conf folder which will be present inside Apache tomcat installation folder
<Installation_Path>\ Apache Tomcat 8.0.15\ conf
The installation path used here is as follows,
C:\Program Files\Apache Software Foundation\ Apache Tomcat 8.0.15\ conf
Step b: Inside the conf folder there will be a file named tomcat-users.xml. Right click on that file and choose open with -> Notepad
Step c: In the file there will be some sample username and sample provided with comments. Using this file users of this server can be restricted by enabling them limited access. For development needs, username and password with role as manager-script has to be created.
<user username=”tomcat” password=”password” roles=”manager-script”/>
Copy and paste the above code in the tomcat-users.xml file within the <tomcat-users> tag and save it. During server configuration enter these credentials. Now, the program will be able to run in the Tomcat server.
Following are the step by step procedure to develop a web application which will list all the universes from the BO 4.1 server by accessing CMC (Central Management Console) from a local machine using Net Beans.
Step 1: create a new project using the NetBeans IDE 8.0.2.
Step 2: Choose project as Java Web -> Web Application and click on next.
Step 3: Give the appropriate Project name and project location and click on next button.
Step 4: Choose Apache Tomcat or TomEE server by clicking ADD button. This tomcat server is on local machine and is used to run the java code using netbeans IDE on local machine to access the BO 4.1 server.
Note: The tomcat server should be installed in a local machine. There are lot of web servers available like Glassfish, tomcat, etc…It is not mandatory to use Tomcat as web server. Depending upon the availability, any of the web servers can be used along with netbeans from our local machine. But it is mandatory that there should be at least one web server installed in our local machine.
Step 5: Choose Java EE 5 from the Java EE Version dropdown list, as it has the provision to access web.xml file and edit it. The web.xml is a file which will be automatically created during the creation of new project in netbeans. It is used to control many facets of a Web application. Using web.xml, one can assign custom URLs for invoking servlets, specify initialization parameters for the entire application as well as for specific servlets, control session timeouts, declare filters, declare security roles, restrict access to Web resources based on declared security roles, and so on.
Step 6: Framework is a bunch of predetermined software program that forms the basis for an application which can be reused. It helps the developers to develop their application more quickly and easily. It was very hard to develop a complex web applications in early days. But, now because of these frameworks it is very easy to develop such complex application using different kinds of frameworks such as Struts 2, Hibernate, JSF, Spring etc. Choose any of these frameworks for building a web application. Framework is not used in this web application. So, it can be ignored and click on finish button. A web Application will be created.
Step 7: Right click on the “Servers” option which will be available in the “Services” tab in the left pane and click on “Add server”
Step 8: Choose Apache Tomcat and Click next.
Note: In this step, the selected webserver will be configured.
Step 9: Click Browse and point to the Apache Tomcat installation folder.
Step 10: Enter the username and password which we created using the tomcat-users.xml for tomcat server and click finish. Server will be added under Servers in the Services tab.
Step 11: Right click on the Apache Tomcat or TomEE server under services tab and choose properties.
Step 12: By Default, Tomcat will choose 8080 port to run the server. If the local machine is installed with more than one web server then, conflict will arise. In order to avoid the conflict the ports should be checked whether they are open or close. Enter the port number in the “SERVER PORT” field. If it shows any error during server startup then change the sever port. The port should not be between the ranges (0-1023) as these are all system ports. Use any other unused port as server port which are not in the range mentioned above.
Step 13: After completion of the above steps, Right click on the server and choose start. The server should start without any error.
Step 14: To check whether tomcat is working or not, type http://<server-name>:8084/ in server where <server-name> is the name of machine where tomcat server is installed.
The tomcat server is installed in local machine so <server-name> is used here is local host. So the link will look like as follows.
Tomcat server will show a success message like “If you’re seeing this, you’ve successfully installed Tomcat. Congratulations!”
Manager App: Clicking on this will ask for user name and password. Enter the username and password which was created under manager-script role in tomcat-users.xml file.
Step 15: The Tomcat Web Application Manager will contain all the web applications that are created using Net beans. All the application will be deployed in tomcat as WAR file. Demo is a sample web application which will show how to create a BO 4.1 java SDK application.
Step 16: The demo web application is a simple java code to connect CMC (Central Management Console) of BO server 4.1 and retrieve the available list of universe from the local machine.
This web application will contain 3 JSP files.
1. Login.jsp -> To get the cmc address,username,password
2. LoginCheck.jsp -> To verify the credentials with CMC and Display the universe list.
3. Logout.jsp -> To logout from cmc.
Step 17: The library files of Business Objects in server has to be added into the library folder available in the left pane of net beans. Right click on Library and choose Add JAR/Folder.
Note: The required library files will be in the following path of the BO 4.1 server.
C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.1\java\lib
* The installation path might change if BO 4.1 is installed in different location.
Copy the required jar files from this path and get it saved in a folder in your local machine where the netbeans is installed.
Step 18: Browse to that folder where the jar files is saved and select the jar files that needs to be imported. Click on open. This will import the required jar files into net beans environment. The communication between BO 4.1 server and the local machine has been established successfully.
Step 20: Run the program. The following output will be displayed in browser.
Business Object consists of various library files using which users can develop customized BO tools for Universe and report list generation, Scheduling of reports, Universe repointing, etc. depending upon the business needs. BO SDK also helps in automation of mundane tasks.