Very soon I came into challenge to read all files in a directory and store it back in SQL Server table.

Found very good article here which helped me to come up with below queries. If you need to read more in detail about below T-SQL and stored procedures please navigate to original article.

Table where we need to load files

CREATE TABLE [dbo].[DebugLogs](
	[Id] [numeric](18, 0) IDENTITY(1,1) NOT NULL,
	[LogText] [nvarchar](max) NULL,
	[FileName] [nchar](500) NULL
) ON [PRIMARY] TEXTIMAGE_ON [PRIMARY]

Stored procedure which reads all files in a directory

SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO
CREATE PROCEDURE [dbo].[ListPathsXML]
@FileSpec VARCHAR(2000),
@order VARCHAR (80) = '/O-D',--sort by date time oldest first
@xmlFileList XML OUTPUT
 
AS
DECLARE @myfiles TABLE (MyID INT IDENTITY(1,1) PRIMARY KEY, FullPath VARCHAR(2000))
DECLARE @CommandLine VARCHAR(4000)
IF @order IS NOT NULL -- abort if the order is silly
   BEGIN
   SELECT @CommandLine =LEFT('dir "' + @FileSpec + '" /A-D /B /S '+@order,4000)
   INSERT INTO @MyFiles (FullPath)
       EXECUTE xp_cmdshell @CommandLine
   DELETE FROM @MyFiles WHERE fullpath IS NULL
       OR fullpath = 'File Not Found'
   END
SET @xmlFileList = (SELECT fullpath FROM @MyFiles
                         FOR
                          XML PATH('thefile'),
                              ROOT('thefiles'),
                              TYPE)

Stored procedure which reads content of file one at a time

SET ANSI_NULLS ON
GO
SET QUOTED_IDENTIFIER ON
GO
CREATE PROCEDURE [dbo].[spLoadTextFromAFile]
   @Filename VARCHAR(255),
   @Unicode INT = 0
AS 
   SET NOCOUNT ON
   DECLARE @MySpecialTempTable VARCHAR(255)
   DECLARE @Command NVARCHAR(4000)
   DECLARE @RESULT INT

--firstly we create a global temp table with a unique name
   SELECT   @MySpecialTempTable = '##temp' 
       + CONVERT(VARCHAR(12), CONVERT(INT, RAND() * 1000000))
--then we create it using dynamic SQL, 
   SELECT   @Command = 'create table [' 
       + @MySpecialTempTable + '] (MyLine '
       + CASE WHEN @unicode <>0 THEN 'N' ELSE '' END +'varchar(MAX))
 '
   EXECUTE sp_ExecuteSQL @command

   SELECT   @command = 'bulk insert [' 
       + @MySpecialTempTable + '] from' + ' ''' 
       + REPLACE(@Filename, '"', '') + '''' 
       + ' with (FIELDTERMINATOR=''|~||''' + ',ROWTERMINATOR = ''
'''        + CASE WHEN @unicode <>0 THEN ', DATAFILETYPE=''widechar'''ELSE '' END
       + ')'
-- import the data
   EXEC (@Command)
   EXECUTE ('Select * from ' + @MySpecialTempTable)
   EXECUTE ('Drop table ' + @MySpecialTempTable)

Final T-SQL query to read content of every file exists in directory and store in Table in SQL Server

DECLARE
       @ii INT,
       @iiMax INT,
       @File VARCHAR(2000)
DECLARE @files TABLE (MyID INT IDENTITY(1,1) PRIMARY KEY, [Path] VARCHAR(2000))
DECLARE @lines TABLE (MyID INT IDENTITY(1,1) PRIMARY KEY, [line] NVARCHAR(MAX), fName nVARCHAR(200))
 
DECLARE @FileList XML
EXECUTE ListPathsXML 'C:\ForceUtil\18_Jan_2017\DebugLogs\',
    DEFAULT , @XMLFileList = @FileList OUTPUT
 
INSERT INTO @files(path)
   SELECT   x.thefile.value('fullpath[1]', 'varchar(2000)') AS [path]
        FROM    @FileList.nodes('//thefiles/thefile') AS x ( thefile )
DELETE FROM @files WHERE REVERSE(path) LIKE 'golrorre%'
--don't look at the current errorlog!
SELECT @ii=1, @iiMax=MAX(MyID) FROM @Files
WHILE @ii<=@iiMax
   BEGIN
   SELECT @File= [path] FROM @files WHERE MyID=@ii
   INSERT INTO @lines(line)
       EXECUTE spLoadTextFromAFile @file, @Unicode=1

   INSERT INTO [dbo].[DebugLogs] (LogText, [FileName])
	SELECT  Line, @file FROM @lines
   
   --Empty temp table
   Delete FROM @lines

   SELECT @ii=@ii+1
   END

To understand this, lets create a table in Database which will store files from local system into SQL Server as binary / Blob .

CREATE TABLE [dbo].[Document](
	[Doc_Num] [numeric](18, 0) IDENTITY(1,1) NOT NULL,
	[Extension] [varchar](50) NULL,
	[FileName] [varchar](200) NULL,
	[Doc_Content] [varbinary](max) NULL
) ON [PRIMARY] TEXTIMAGE_ON [PRIMARY]

How to Insert Blob into Database

For demo purpose, we will save two files in our table using below queries

INSERT [dbo].[Document] ([Extension] ,[FileName] , [Doc_Content] )
SELECT 'pdf', 'Salesforce Lightning.pdf',[Doc_Data].*
FROM OPENROWSET 
    (BULK 'C:\G2\My POC\Blog\SQL Server\Source\lightning.pdf', SINGLE_BLOB)  [Doc_Data]

INSERT [dbo].[Document] ([Extension] ,[FileName] , [Doc_Content] )
SELECT 'html', 'Progress.html',[Doc_Data].*
FROM OPENROWSET 
    (BULK 'C:\G2\My POC\Blog\SQL Server\Source\Progress.html', SINGLE_BLOB)  [Doc_Data]

If we try to see content in actual table, it will look like

Export Blob From SQL Server and save it as a file

For demo purpose, we want to save documents on local disc. We will use Doc_Num to be created as folder and document will be saved in that folder. To create folders using SQL Server, we will use stored procedure CreateFolder created in this post.
Note : We will create only one folder per document. If multiple nested folder needs to be created then we need to iterate through each folder and call CreateFolder stored procedure for each folder. Its explained in this blog post.

Now time to see actual T-SQL which will iterate through all documents, create folder and save Blob as a file on local disc.

USE [POC]
DECLARE @outPutPath varchar(50) = 'C:\G2\My POC\Blog\SQL Server\Extract Blob'
, @i bigint
, @init int
, @data varbinary(max) 
, @fPath varchar(max)  
, @folderPath  varchar(max) 
 
--Get Data into temp Table variable so that we can iterate over it 
DECLARE @Doctable TABLE (id int identity(1,1), [Doc_Num]  varchar(100) , [FileName]  varchar(100), [Doc_Content] varBinary(max) )
 
INSERT INTO @Doctable([Doc_Num] , [FileName],[Doc_Content])
Select [Doc_Num] , [FileName],[Doc_Content] FROM  [dbo].[Document]
 
--SELECT * FROM @table

SELECT @i = COUNT(1) FROM @Doctable
 
WHILE @i >= 1
BEGIN 

	SELECT 
	 @data = [Doc_Content],
	 @fPath = @outPutPath + '\'+ [Doc_Num] + '\' +[FileName],
	 @folderPath = @outPutPath + '\'+ [Doc_Num]
	FROM @Doctable WHERE id = @i
 
  --Create folder first
  EXEC  [dbo].[CreateFolder]  @folderPath
  
  EXEC sp_OACreate 'ADODB.Stream', @init OUTPUT; -- An instace created
  EXEC sp_OASetProperty @init, 'Type', 1;  
  EXEC sp_OAMethod @init, 'Open'; -- Calling a method
  EXEC sp_OAMethod @init, 'Write', NULL, @data; -- Calling a method
  EXEC sp_OAMethod @init, 'SaveToFile', NULL, @fPath, 2; -- Calling a method
  EXEC sp_OAMethod @init, 'Close'; -- Calling a method
  EXEC sp_OADestroy @init; -- Closed the resources
 
  print 'Document Generated at - '+  @fPath   

--Reset the variables for next use
SELECT @data = NULL  
, @init = NULL
, @fPath = NULL  
, @folderPath = NULL
SET @i -= 1
END

Variable @outPutPath stores root folder path, where folders will be created and Blob content would be exported into it as a file.

Below image shows output in action :

DECLARE @SearchStr nvarchar(100) = 'SEARCHSTRING'
DECLARE @Results TABLE (ColumnName nvarchar(370), ColumnValue nvarchar(3630))

SET NOCOUNT ON

DECLARE @TableName nvarchar(256), @ColumnName nvarchar(128), @SearchStr2 nvarchar(110)
SET  @TableName = ''
SET @SearchStr2 = QUOTENAME('%' + @SearchStr + '%','''')


WHILE @TableName IS NOT NULL

BEGIN
    SET @ColumnName = ''
	BEGIN TRY
    SET @TableName = 
    (
        SELECT MIN(QUOTENAME(TABLE_SCHEMA) + '.' + QUOTENAME(TABLE_NAME))
        FROM     INFORMATION_SCHEMA.TABLES
        WHERE         TABLE_TYPE = 'BASE TABLE'
            AND    QUOTENAME(TABLE_SCHEMA) + '.' + QUOTENAME(TABLE_NAME) > @TableName
            AND    OBJECTPROPERTY(
                    OBJECT_ID(
                        QUOTENAME(TABLE_SCHEMA) + '.' + QUOTENAME(TABLE_NAME)
                         ), 'IsMSShipped'
                           ) = 0
    )
END TRY
BEGIN CATCH
END CATCH
    WHILE (@TableName IS NOT NULL) AND (@ColumnName IS NOT NULL)

    BEGIN
        SET @ColumnName =
        (
            SELECT MIN(QUOTENAME(COLUMN_NAME))
            FROM     INFORMATION_SCHEMA.COLUMNS
            WHERE         TABLE_SCHEMA    = PARSENAME(@TableName, 2)
                AND    TABLE_NAME    = PARSENAME(@TableName, 1) 
                AND    QUOTENAME(COLUMN_NAME) > @ColumnName 
        )
         

        IF @ColumnName IS NOT NULL

        BEGIN
            INSERT INTO @Results
            EXEC
            (
                'SELECT ''' + @TableName + '.' + @ColumnName + ''', LEFT(' + @ColumnName + ', 4000) 
                FROM ' + @TableName + ' (NOLOCK) ' +
                ' WHERE ' + @ColumnName + ' LIKE ' + @SearchStr2
            )
        END
    END    
END

SELECT ColumnName, ColumnValue FROM @Results

If we run above script for word ‘king’ then output in below format will be displayed

First step, is to check whether Ole Automation Procedures are enabled in SQL Server or not ? It can be enabled by simply executing below T-SQL commands.

T-SQL to enable Ole Automation Procedures in SQL Server

        sp_configure 'show advanced options', 1;
	GO
	RECONFIGURE;
	GO
	sp_configure 'Ole Automation Procedures', 1;
	GO
	RECONFIGURE;
	GO

Next step is to create a stored procedure, which will use an OLE Automation procedures and create a folder on system drive

--	DATE	:	23-Nov
--	AUTHOR	:	Jitendra Zaa

CREATE PROCEDURE [dbo].[CreateFolder] (@newfolder varchar(1000)) AS  
BEGIN  
DECLARE @OLEfolder   INT  
DECLARE @OLEsource   VARCHAR(255)  
DECLARE @OLEdescription  VARCHAR(255) 
DECLARE @init   INT  
DECLARE @OLEfilesytemobject INT  
 
-- it will fail if OLE automation not enabled
EXEC @init=sp_OACreate 'Scripting.FileSystemObject', @OLEfilesytemobject OUT  
IF @init <> 0  
BEGIN  
	EXEC sp_OAGetErrorInfo @OLEfilesytemobject  
	RETURN  
END  
-- check if folder exists  
EXEC @init=sp_OAMethod @OLEfilesytemobject, 'FolderExists', @OLEfolder OUT, @newfolder  
-- if folder doesnt exist, create it  
IF @OLEfolder=0  
	BEGIN  
	EXEC @init=sp_OAMethod @OLEfilesytemobject, 'CreateFolder', @OLEfolder OUT, @newfolder  
END  
-- in case of error, raise it   
IF @init <> 0  
	BEGIN  
		EXEC sp_OAGetErrorInfo @OLEfilesytemobject, @OLEsource OUT, @OLEdescription OUT  
		SELECT @OLEdescription='Could not create folder: ' + @OLEdescription  
		RAISERROR (@OLEdescription, 16, 1)   
	END  
EXECUTE @init = sp_OADestroy @OLEfilesytemobject  
END  

Its time to finally see OLE Automation in action. We would try to create three nested folders in tmp folder of c drive. Assumption is c:\tmp folder already exists.

Below code iterates through string which contains folder path @folderName and iteratively it will create folders using stored procedure CreateFolder.

--Prerequisite , make sure that @path exists on drive
DECLARE @path varchar(80) = 'C:\tmp',
 @folderName varchar(100)= 'folder1\folder2\folder3\folder4',
 @fullPath varchar(500),
 @progressivePath varchar(500)

SET @fullPath = @path +'\'+@folderName
 
DECLARE @pos INT
DECLARE @len INT
DECLARE @curentFolder varchar(8000)
 
set @pos = 0
set @len = 0
SET @progressivePath = @path

--Loop through path and create folder iteratively
WHILE CHARINDEX('\', @folderName, @pos+1) > 0
BEGIN
    set @len = CHARINDEX('\', @folderName, @pos+1) - @pos 
    set @curentFolder = SUBSTRING(@folderName, @pos, @len) 
	SET @progressivePath = @progressivePath + '\'+@curentFolder
    PRINT @progressivePath 
	EXEC CreateFolder @progressivePath
    set @pos = CHARINDEX('\', @folderName, @pos+@len) +1
END

I am considering that there will be table named “Employee” in which i want to search by employees firstName with pagesize and offset attribute.

Table Structure for example:

Create Stored Procedure:

Below stored procedure demonstrates pagination as well as switch case in where clause.

-- Author	: Jitendra Zaa
-- Date		: 19 May 2012
-- Summary	: Search Employee on the basis of fName and lName and if the lName is blank then set
--			: default lName to search is 'Zaa'. Also there shpuld be support for pagination
CREATE PROCEDURE dbo.SearchEmployee
(
	@fName varchar(50), -- First Name to Search
	@lName varchar(50), -- Last Name to search, and if its blank then search for 'Zaa'
	@offset INT,		-- Starting rowNumber of record
	@pageSize INT		-- Number of records in Row
)
AS
	BEGIN

		SELECT * FROM
			(SELECT ROW_NUMBER() OVER(ORDER BY EmpId) AS row, --Generate Row Number
			EmpId,
			FirstName,
			LastName
		FROM
			Employee ) as e
		WHERE
			e.FirstName LIKE '%'+@fName+'%'
			AND
			e.LastName LIKE
			CASE
				WHEN @lName <> '' THEN '%'+@lName+'%'
				ELSE 'Zaa'
			END
			AND
				e.row BETWEEN @offSet AND (@offSet + @pageSize) --Pagination Logic
	END

As you can see in above example, i have used “over” clause to generate the row Number. You can read more on over clause from here.

In this example, we will create a simple login application using hibernate tool of eclipse. We will use eclipse WTP (Web Tools Platform), to install “Hibernate Tools”. Follow below steps :

In Eclipse IDE, menu bar, select “Help” >> “Install New Software …” put the Eclipse update site URL “http://download.jboss.org/jbosstools/updates/stable/helios”

Select the tool and click on “Next”. Do not select all the tools; it will install all the unnecessary tools. We just need hibernate tools.

After installation, restart the eclipse.

If you don’t have the internet connection and want the offline method to add hibernate tools in eclipse. To install the Hibernate Tools, extract the HibernateTools-3.X.zip file and move all the files inside the features folder into the features folder of the eclipse installation directory and move all the files inside the plugins folder into the plugins folder of the ecilpse installation directory.

After restart, Go to Window | Open Perspective | Other, the following dialog box appears, select Hibernate and click the Ok button.

Now let’s see how to define the object/relational mapping using the XML document. This document has .hbm.xml extension. We will now create the mapping between table and object of entity “user” which hold the data from database. So create the package "in.shivasoft.pojo" in src folder.
Right click on project folder and select “Hibernate XML Mapping file (hbm.xml)“.

Then one popup will appear, click on “Next”.

Select the pojo folder and give name “Users.hbm.xml” and click on finish.

Now, either you can configure the settings from the UI like below snap:

Or, write below code :

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">
<hibernate-mapping>
 <class entity-name="Users" name="in.shivasoft.pojo.Users" table="Users">
  <meta attribute="description">This class is used to save the info about users</meta>
  <id column="UserId" name="UserId" type="long"/>
  <property column="FName" name="FName" type="string"/>
  <property column="LName"  name="LName" type="string"/>
  <property column="UserTypeId" name="UserTypeId" type="long"/>
  <property column="UserName" name="UserName" type="string"/>
  <property column="Email" name="Email" type="string"/>
  <property column="Pwd" name="Pwd" type="string"/>
  <property column="Note" name="Note" type="string"/>
  <property column="IsActive" name="IsActive" type="boolean"/>
 </class>
</hibernate-mapping>

Now right click and select “hibernate configuration file”. One window will open, there select the “src” folder and click on next.

Enter detail like below screen and click on finish button.

After this add the Users.hbm.xml file to the newly generated xml configuration.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE hibernate-configuration PUBLIC
		"-//Hibernate/Hibernate Configuration DTD 3.0//EN"
		"http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd">
<hibernate-configuration>
    <session-factory>
        <property name="hibernate.connection.driver_class"> org.gjt.mm.mysql.Driver </property>
        <property name="hibernate.connection.password"> root </property>
        <property name="hibernate.connection.url"> jdbc:mysql://localhost/test </property>
        <property name="hibernate.connection.username"> root </property>
        <property name="hibernate.dialect"> org.hibernate.dialect.MySQL5InnoDBDialect </property>
        <mapping resource="in/shivasoft/pojo/Users.hbm.xml"/>
    </session-factory>
</hibernate-configuration>

After the entire configuration, in the toolbar you can select “hibernate code generation tool”.

Now select the Exporters tab and select “Use Java 5 Syntax”.

In refresh tab, select “The Project containing the selected resource“.

Now click the run button to finish java code generation. Following code will be generated:

package in.shivasoft.pojo;

// Generated Aug 1, 2011 7:02:59 PM by Hibernate Tools 3.4.0.CR1

/**
 * Users generated by hbm2java
 */
public class Users implements java.io.Serializable {

	private long UserId;
	private String FName;
	private String LName;
	private long UserTypeId;
	private String UserName;
	private String Email;
	private String Pwd;
	private String Note;
	private boolean IsActive;

	public Users() {
	}

	public Users(long UserId) {
		this.UserId = UserId;
	}

	public Users(long UserId, String FName, String LName, long UserTypeId,
			String UserName, String Email, String Pwd, String Note,
			boolean IsActive) {
		this.UserId = UserId;
		this.FName = FName;
		this.LName = LName;
		this.UserTypeId = UserTypeId;
		this.UserName = UserName;
		this.Email = Email;
		this.Pwd = Pwd;
		this.Note = Note;
		this.IsActive = IsActive;
	}

	public long getUserId() {
		return this.UserId;
	}

	public void setUserId(long UserId) {
		this.UserId = UserId;
	}

	public String getFName() {
		return this.FName;
	}

	public void setFName(String FName) {
		this.FName = FName;
	}

	public String getLName() {
		return this.LName;
	}

	public void setLName(String LName) {
		this.LName = LName;
	}

	public long getUserTypeId() {
		return this.UserTypeId;
	}

	public void setUserTypeId(long UserTypeId) {
		this.UserTypeId = UserTypeId;
	}

	public String getUserName() {
		return this.UserName;
	}

	public void setUserName(String UserName) {
		this.UserName = UserName;
	}

	public String getEmail() {
		return this.Email;
	}

	public void setEmail(String Email) {
		this.Email = Email;
	}

	public String getPwd() {
		return this.Pwd;
	}

	public void setPwd(String Pwd) {
		this.Pwd = Pwd;
	}

	public String getNote() {
		return this.Note;
	}

	public void setNote(String Note) {
		this.Note = Note;
	}

	public boolean isIsActive() {
		return this.IsActive;
	}

	public void setIsActive(boolean IsActive) {
		this.IsActive = IsActive;
	}

}

Now create the

HibernateUtil

class. The HibernateUtil class helps in creating the SessionFactory from the Hibernate configuration file. The SessionFactory is threadsafe, so it is not necessary to obtain one for each thread. Here the static singleton pattern is used to instantiate the SessionFactory. The implementation of the HibernateUtil class is shown below.

package in.shivasoft.util;

import org.hibernate.SessionFactory;

import org.hibernate.cfg.Configuration;

public class HibernateUtil {

	private static final SessionFactory sessionFactory;

	static {

		try {

			sessionFactory = new Configuration().configure()
			.buildSessionFactory();

		} catch (Throwable ex) {

			System.err.println("Initial SessionFactory creation failed." + ex);

			throw new ExceptionInInitializerError(ex);

		}

	}

	public static SessionFactory getSessionFactory() {

		return sessionFactory;

	}
}

Now, create the test application having main method which will demonstrate that how data is saved:

package in.shivasoft.test;

import in.shivasoft.pojo.Users;
import in.shivasoft.util.HibernateUtil;

import java.util.List;

import org.hibernate.Session;
import org.hibernate.Transaction;

public class TestMain {

	/**
	 * @param args
	 */
	public static void main(String[] args) {
		TestMain obj = new TestMain();
		//obj.saveRecord();
		obj.updateUser(12);
		obj.deleteUser(13);
		obj.getList();
	}

	public void saveRecord()
	{
		Users u = new Users(0, "Jitendra", "Zaa", 1, "jitendra.zaa", "jitendra.zaa@JitendraZaa.com", "test", "this is note", true);
		Session session = HibernateUtil.getSessionFactory().openSession();
		Transaction transaction = null;
		try
		{
			transaction = session.beginTransaction();
			session.save(u);
			transaction.commit();
			System.out.println("Data Saved");
		}catch(Exception e)
		{
			e.printStackTrace();
		}finally{session.close();}

	}
	public void deleteUser(long UserId)
	{
		Session session = HibernateUtil.getSessionFactory().openSession();
		Transaction transaction = null;
		try
		{
			transaction = session.beginTransaction();
			Users u = (Users)session.get(Users.class,UserId);
			session.delete(u);
			transaction.commit();
			System.out.println("Data Deleted");
		}
		catch(Exception e)
		{
			e.printStackTrace();
		}
		finally{
			session.close();
		}
	}
	public void updateUser(long UserId)
	{
		Session session = HibernateUtil.getSessionFactory().openSession();
		Transaction transaction = null;
		try
		{
			transaction = session.beginTransaction();
			Users u = (Users)session.get(Users.class,UserId);
			u.setFName("ShivaSoft");
			transaction.commit();
			System.out.println("Data Updated");
		}
		catch(Exception e)
		{
			e.printStackTrace();
		}
		finally{
			session.close();
		}
	}

	public void getList()
	{
		Session session = HibernateUtil.getSessionFactory().openSession();
		Transaction transaction = null;
		try
		{
			transaction = session.beginTransaction();
			List<Users> uList = session.createQuery("from Users").list();
			for(Users u : uList)
			{
				System.out.println("First Name - "+u.getFName());
			}
		}
		catch(Exception e)
		{
			e.printStackTrace();
		}
		finally{
			session.close();
		}
	}
}

Needed jar files :

antlr-2.7.6.jar
commons-collections-3.1.jar
dom4j-1.6.1.jar
hibernate-core.3.3.1.GA.jar
javassist-3.9.0.GA.jar
jta-1.1.jar
mysql-connector-java-5.1.1.17-bin.jar
slf4j-api-1.6.1.jar
slf4j-api-1.6.1-tests.jar
slf4j-slf4j-simple-2.0.jar

1. Part 1 – Creating Data Area in Oracle Utilities
2. Part 2 – Creating Business Service and Service Program
3. Part 3 – UI Map in Oracle Utilities
4. Part 4 – BPA Script in Oracle Utilities to invoke UI Map

In this post, i will discuss on creating the BPA Script to invoke the UI Map.

Navigate to “Admin Menu | S | Script +” and the details as per below image:

Go to “Data Area” tab and add entries like below snap:

In this section, we have to add the references of all the “UI Map, Business Service and Data Area” which we have used in this application.
Now, go to Step tab and add below line in “Edit Text area” where the step Type is”Edit Data”.

invokeMap ‘CM_PERINPUT’ using “PersonDataA” target page;

Description: invokeMap command is used to invoke the UI Map using Data Area Name. “target page” argument specifies that the Map should be open as a new page.

Now, to run the BPA Script press “Ctrl + Shift + S” or click on BPA Script icon as shown in below image:

Below pop up window will open, where you can search your BPA script and run it.

1. Part 1 – Creating Data Area in Oracle Utilities
2. Part 2 – Creating Business Service and Service Program
3. Part 3 – UI Map in Oracle Utilities
4. Part 4 – BPA Script in Oracle Utilities to invoke UI Map

This is the third article in series to create the UI Map in Oracle Utilities. In Previous two article we have seen that how to create the Business Service, Data Area and Service Program.

Navigate to “Admin Menu | U | UI Map +“. Give the UI Map Name as “CM_PERINPUT” and select “UI Map Type” = Complete HTML Document.

Now go to Schema Tab and in bottom section add below schema:

<schema>
    <pNameSearch type="group">
        <includeBS name="CM_PERSER"/>
    </pNameSearch>
</schema>

In above schema, we have included the Business Service “CM_PERSER” by using tag <includeBS>.
In this way our UI Map will get the Schema of our “Business Service” which has all the definition about which should go to header part and which should go to body part.
Now to generate the HTML you can use “Generate HTML” feature which have options to generate “Display only UI” or “Input UI” as per shown in below image.

I used the “Input Map” and then customized. Following is the complete code.

<html>
    <head>
        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
        <title></title>
        <link href="cisDisabled.css" type="text/css" rel="stylesheet">
        <link href="cisEnabled.css" type="text/css" rel="stylesheet">
      <script language="javascript" type="text/javascript">

   function validateEnterKey(e, htmlElement){
                var characterCode;
                if(e && e.which){ //if which property of event object is supported (NN4)
                    e = e;
                    characterCode = e.which; //character code is contained in NN4's which property
                }
                else{
                    e = event
                    characterCode = e.keyCode; //character code is contained in IE's keyCode property
                }

                if(characterCode == 13){ //if generated character code is equal to ascii 13 (if enter key)
                    return true; //Detected enter key press event
                }
                else{
                    return false;
                }
            }

    function searchByPName()
    {
         oraInvokeBS('CM_PERSER','pNameSearch' );
         showResults();
    }

      function showResults(){
                document.getElementById('resultTable') .style.display="inline";
            }

    </script>
    </head>
    <body oraError="automate:true; prefix:boGroup">
        <table cellpadding="12" width="100%">
            <tr class="oraErrorText">
                <td><a onclick="oraShowErrorAlert(); return false;" href=""><span oraErrorVar="ERRMSG-TEXT" class="oraErrorText"></span></a></td>
            </tr>
        </table>
        <table cellspacing="4" width="100%">
            <colgroup>
                <col class="oraLabel oraTableLabel">
                <col class="oraNormal oraTableData">
            </colgroup>
            <tr>
                <td>Search Person </td>
             <td><input class="oraInput" oraField="pNameSearch/pageHeader/personName" id="serPer" onKeyDown="if(validateEnterKey(event,this)){searchByPName();};">
                    <img src="images/runSearch.gif" onclick="searchByPName()"/>
        </td>
            </tr>

                 <tr>
                <td class="oraEmbeddedTable oraSectionEnd" colspan="2">
                    <div class="oraGridDiv">
                        <table cellspacing="2" style="display:none" oraList="pNameSearch/pageBody/PerNameList" id="resultTable" onResize="if (this.clientWidth > this.parentNode.clientWidth) { this.parentNode.className += ' oraGridDivScroll';};">
                            <thead>
                                <tr>
                                    <th nowrap oraLabel="entityName" class="oraGridColumnHeader"></th>
                                </tr>
                            </thead>
                            <tbody>
                                <tr>
                                    <td oraField="entityName" class="oraNormal oraDisplayCell"></td>
                                </tr>
                            </tbody>
                        </table>
                    </div>
                </td>
            </tr>
        </table>
    </body>
    <xml style="display:none;"></xml>
</html>

Now, look into the below java script function which I have added In above code:

function searchByPName()
    {
         oraInvokeBS('CM_PERSER','pNameSearch' );
         showResults();
    }

oraInvokeBS is the Utility java script method provided by the CC&B / ORMB which invokes the Business Service. First Parameter is the “Business Service Name” and second parameter is the xpath value from where the output of Business service (Java Program) should be copied.
Click on save button to save the UI Map.
To check the UI and working of UI Map, go to Main tab and click on “Test UI Map”.

Following output will be shown:

1. Part 1 – Creating Data Area in Oracle Utilities
2. Part 2 – Creating Business Service and Service Program
3. Part 3 – UI Map in Oracle Utilities
4. Part 4 – BPA Script in Oracle Utilities to invoke UI Map

In Previous article, we have seen that how to create the Data Area and benefits of using Data Area. This article will focus on creating the Business Service and Service Program in CC&B.

First we have to create the Business Service in application then we have to code it in JAVA and deploy the updated “cm.jar“ file on server.

Go to “Admin | S | Service Program +“ and enter the Service name, Description and select the “Java Based Service” as Service Type.  In this example my service name is “PERSER“.

Now go to “Admin | B | Business Service +“ and enter the Business Service name and select the previously create service “PERSER“ for Service Name using look up. In this case the Business Service Name is “CM_PERSER“.
Now go to the “Schema” and add following code and click on Save.

<schema>
    <includeDA name="PersonDataA"/>
</schema>

You can see one benefit of having “Data Area”. Instead of declaring schema we have used existing data area which we have created earlier.
We are now ready to create the Business Service for “PERSER“ Service Program using Java Code.

Open Eclipse and go to “File | New | Page Service“.

Select Page type as “Query“ and click on Next.

Enter the Program name and Service name as “PERSER“, which we have created earlier. In Module, Click on “Add” and Select “DM” (This is demo module, I normally uses this Module).

It’s time to add the header. As we have already discussed that i want to get the Person name from user. And in DataArea, we have added ENTITY-NAME in header. So in same way, we have to add ENTITY-NAME here also.

So go to “Edit array of Header Fields“ and on “+” button Search for the “ENTITY_NAME” and click on OK. Come back to main service windows and click on “Edit array of Lists“. We want the list of person name which will be the part of body. To include the List in body first we have to declare the List and then add it in the body.
When we click on “Edit array of Lists“, one pop up window will appear on that click on “+”.

After clicking on “+”, one new window will open.

In that provide the Name and Size. In this example I have used name = “PerNameList“ and size = 100. Click on “Edit Data Element“ button of body.
One window will be opened. In that select “Edit Contents“.

Again window will open in that click on “+” and select “Field”.

One new window will open, enter the “ENTITY_NAME” as “Name”, you can search the Name from search option. Click on Ok / Finish Button until you come to Parent Window shown below.

Click on Edit “DataElement“ of the Body and click on “Edit Contents“, then click on”+” and List. In List, give the previously created list name which is “PerNameList” and owner is “cm”. And click on Ok / Finish.  Java file will be created, which have following code:

/**
 * @author jitendra zaa
 *
@QueryPage (program = PERSER, service = PERSER,
 *      body = @DataElement (contents = { @ListField (name = PerNameList)
 *                  , @DataField (name = ENTITY_NAME)}),
 *      actions = { "add"
 *            , "change"
 *            , "read"
 *            , "delete"},
 *      header = { @DataField (name = ENTITY_NAME)},
 *      headerFields = { @DataField (name = ENTITY_NAME)},
 *      lists = { @List (name = PerNameList, size = 100,
 *                  body = @DataElement (contents = { @DataField (name = ENTITY_NAME)}))},
 *      modules = { "demo"})
 */
public class PerSer extends PerSer_Gen {

}

As you can see, the entire configuration is added as annotation in Java Program.

Click on “Generate Artifacts” to generate the supported classes for the “Business Service / Page Service”.
After successful completion add following method in above Java File:

protected DataElement read(PageHeader header) throws ApplicationError {
		System.out.println(" ************ In PerSer Read Method ************ ");
		DataElement ret = new DataElement();
		DataElement perData ;
		ItemList perList = new DataElement().newList(STRUCTURE.list_PerNameList.name);

		String entityName = "" ;
		if(header.get("ENTITY_NAME") != null)
		{
			entityName = header.get("ENTITY_NAME").toString();
		}
		System.out.println(" *************** Header Value **************"+entityName);
		/* If value is not coming through header */
		if(entityName.equals("")){
			entityName = "A";
		}
		PreparedStatement stmt = createPreparedStatement("SELECT ENTITY_NAME FROM CI_PER_NAME WHERE ENTITY_NAME LIKE :entityName");
		stmt.bindString("entityName", entityName, "ENTITY_NAME");
		System.out.println("******** SQL Statement : "+ stmt.toString()+" ************ ");
		List resultSetList = stmt.list();

		if (resultSetList != null && !resultSetList.isEmpty()) {
			for (SQLResultRow eResult : resultSetList) {
				perData = perList.newDataElement();
				if (eResult.getString("ENTITY_NAME") != null
						&& !eResult.getString("ENTITY_NAME").trim().equals("")) {
					perData.put(STRUCTURE.ENTITY_NAME, eResult.getString("ENTITY_NAME").toString().trim());
					System.out.println("****** Name : **********"+eResult.getString("ENTITY_NAME"));
				}
			}
		}
		ret.addList(perList);
		return ret;
	}

The code style is not as per the standards because, I have used SOP statements instead of Loggers. However above example is just getting clear that how to create the “Business Service” through Java. Now click on “Deploy” button to generate the new “cm.jar” and deploy.

After successfully completion of the deployment, restart the application.

1. Part 1 – Creating Data Area in Oracle Utilities
2. Part 2 – Creating Business Service and Service Program
3. Part 3 – UI Map in Oracle Utilities
4. Part 4 – BPA Script in Oracle Utilities to invoke UI Map

Before starting this demo application, I am assuming that you already have done CC&B set up on your local and Eclipse is configured.
What I am going to do so that I can use Business Script, Data Area, UI Map and BPA Script?
In this tutorial, I will create one UI Map which will take the person name as input and display list of all the person names as per input.
Final output screen would look like:

We would start from creating the Data Area. “Data Area” in ORMB is used to transfer the data between applications. It is always good practice to use the Data Area rather than writing the Schema again and again. There are lots of advantages of using Data Area in application.
To create Data Area, Go to “Menu (Alt + M) | Admin” Menu and in that “D | Data Area +“.

Give the Data Area Name and Description. In this case my Data Rea Name is “PersonDataA”. Now go to schema Tab and add below code:

<schema>
    <pageHeader type="group">
        <personName mapField="ENTITY_NAME"/>
    </pageHeader>
    <pageBody type="group">
        <PerNameList type="list" mapList="PerNameList">
            <entityName mapField="ENTITY_NAME"/>
        </PerNameList>
    </pageBody>
</schema>

To understand the Tag descriptions, use the Tips available at the right hand side as shown in below image:

In the above schema I am passing the “ENTITY_NAME” in header (pageHeader) so that I can get the user input in request and in return (pageBody) user will have the List of Person Name.
In Next article we will see how to create the Business Service and Service Program in ORMB.