TALKING TO ORACLE UCM Via RIDC

WebCenter Imaging 12C 12.2.1.3.0 Configuration and setup

2018-03-03T00:51:00.000-08:00

In this blog I will be explaining how we need to setup and configure WebCenter Imaging 12.2.1.30.
We all know that Imaging is now become a part in WebCenter Content in 12C but ,based on the customer's requirements some projects may need this Imaging Application to be a separate Managed Server in the Weblogic Admin Apllication.

Most of us know how to setup and configure WebCenter Imaging ,but for few who didn't get chance to work/learn this blog will be useful.

Advantages or Usages

We use this WebCenter Imaging generally for scanning solutions like most of the customers scan their invoices or purchase orders or other business documents as bulk and then process those scanned documents using WebCenter Enterprise Capture 12 C ,this we discuss in other post ,after that the scanned documents will be committed to WebCenter Imaging ,ie those scanned documents will be available in the WebCenter Imaging Application and which in turn these documents will also be accessible to Oracle EBS users using Managed Attachment Functionality and zoom button.

Managed Attachments functionality with Oracle EBS Modules like AP,AR and Order Management and etc is a different topic we will disccss it later. For this Managed Attachments functionality we need to create and setup the AXF Tables in the EBS Database and also we should compile the AXF_Custom.pld file using the forms builder ,the file is located in the EBS installation directories and this is for the zoom button functionality.

After setting up the Zoom button or Managed Attachments Functionality for the EBS ,we need to
configure the WebCenter Imaging as below.

Beginning

A) Create Connections -> here we create connections to WebCenter Content and SOA server.
B) Create Application -> here we create Application Fields or Meta-data ,Picklists and after that upload sample documents from Tools tab -> Upload Documents with those Application Field values mentioned.
C) Create Searches -> here we create the search for our Application documents and we test whether this configured search is working or not.
D) Create Input Agent -> here we upload a sample input file it is a text file with the Application fields separated with the pipe symbols ,it is like supporting document for the invoice images

Create Connections

To begin with first we need to login to the WebCenter Imaging Application with the URL like this
http://HostName:16000/imaging/ after that

1) We need to create the Connection with WebCenter Content first using the "Manage Connections" tab as below.

2) After that we need to create an Application in WebCenter Imaging using "Manage Applications" tab as below screen shot.It is an ADF train we will get one by one ,first General Properties,next Field Definitions and go on as below.

Create Applications

First we need to give the Application Name in the General Properties and then in Field Definitions add the fields which we need as per the customer requirements like InvoiceNo or Customer ID or OderNo etc and say Next button as below.

3) After that in the Application Security train just leave as it is this is for the adding the users and granting them the access for this Imaging Application as below and then click next button.

3) And then in the Document Security train add weblogic user groups as below and say next.

4) After that in the Storage Policy mention the Volume drop down like in the below picture "File webasset" and say next.

5) After that in the Workflow Configuration train just leave as it is and say next.

6) After that in the Imaging Review Setting train just leave as it is and say Submit data as below.

This is it we are done with the creation of Application in the WebCenter Imaging now we will create a search using "Manage Searches" tab as below.

Create Searches

1) Create a search using "Manage Searches as below and in the Properties train give search name like Invoice search or Order search etc as below and click next.

2) In the Results Formatting train give the required Meta-data fields those needs to be displayed along with the result set like in below for ex:- Document Batch,Document Created By,Document Creation Date and etc.

3) In the Conditions train just leave the conditions as it is or if you need change the conditions using operands like "or" ,"and"

4) In the Parameters train just leave as it is and select the pick list if it is required ,I didn't not used as below

5) In the Security tab do nothing as below

6) In the Preview and Test train just check whether the search is working or not as below.

But to get the search results displayed as below we need to upload the sample documents with those Meta-data values using "Tool" tab and "--> "Upload Documents" tab only then we will get the search results displayed as below.

7) Next in the Review Settings click and submit the data , after that test the search is working or not with the search results displayed in the downside as below.

After this we are done with the creating the search in the WebCenter Imaging Application

Using RIDC API we can execute UCM Services.

2012-02-29T23:23:00.012-08:00

HOW TO CHECKIN,CHECKOUT,UPDATE,SEARCH,DELETE,CREATE USERS,GROUPS IN ORACLE UCM FROM JAVA/J2EE APPLICATIONS
USING REMOTE INTRODOC (RIDC API's)

Below is the sample code for talking to Oracle UCM via RIDC like how to checkin a file into UCM repository
checkout a content from UCM, update an existing content item,how to perform a search and display the results,
how to delete a content item and all of its revisions from UCM repository,How to create a security group ,creating local users (of-course no use in 11g and later revision UCM),How to read a text file which is in UCM repository and display the content and etc..

Here in this code I am using Oracle UCM 10g ,we can use any version of the UCM (bcoz the UCM services are always same)

Below is the code and the jar for this is oracle.ucm.ridc-11.1.1.jar download it and add it in your IDE.

I thought it would be helpful for some beginners Thanks everybody.
--------------------------------------------------------------------------------------------------------

package com.view;

import java.io.BufferedReader;
import java.io.DataInputStream;

import oracle.stellent.ridc.IdcClientManager;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;

import java.io.InputStreamReader;

import oracle.stellent.ridc.IdcClient;
import oracle.stellent.ridc.IdcClientException;
import oracle.stellent.ridc.IdcClientManager;
import oracle.stellent.ridc.IdcContext;
import oracle.stellent.ridc.model.DataBinder;
import oracle.stellent.ridc.model.DataObject;
import oracle.stellent.ridc.model.DataResultSet;
import oracle.stellent.ridc.model.TransferFile;
import oracle.stellent.ridc.model.impl.DataObjectEncodingUtils;
import oracle.stellent.ridc.protocol.ServiceResponse;

public class GET_FILE {

private final static String idcConnectionURL = "idc://localhost:4444";
private final static String username = "sysadmin";

public IdcClient getUCMConnection()
throws IdcClientException, IOException{



    IdcClientManager clientManager = new IdcClientManager ();
    IdcClient client = clientManager.createClient(idcConnectionURL);
    IdcContext userContext = new IdcContext(username);
     return client;

}

public void getFile (String dID) throws IdcClientException, IOException{
//Get the client (from the base class) and create a new binder
    System.out.println("In The getFile method.. ");
    System.out.println("This is the dID.. "+ dID);
    IdcClient client =getUCMConnection();
    DataBinder dataBinder = client.createBinder ();
    dataBinder.putLocal ("IdcService", "GET_FILE");
    dataBinder.putLocal ("dID", dID);
    IdcContext userContext = new IdcContext(username);
    ServiceResponse response = client.sendRequest (userContext, dataBinder);
    int reportedSize = Integer.parseInt (response.getHeader ("Content-Length"));
    int retrievedSize = 0;
    String contentsInHex = "";
    //The file is streamed back to us in the response
    InputStream fstream = response.getResponseStream ();

      try {
          // FileInputStream fstream = new response.getResponseStream ();
            DataInputStream in = new DataInputStream(fstream);
            BufferedReader br = new BufferedReader(new InputStreamReader(in));
            String str;
            while ((str = br.readLine()) != null) {
              System.out.println(str);
            }
            in.close();
          } catch (Exception e) {
            System.err.println(e);
          }

    response.close();
    System.out.println("This is in the After conversion");
}


     public void createUser () throws IdcClientException, IOException{

      System.out.println("In The createUser method.. ");
      IdcClient client =getUCMConnection();
      DataBinder dataBinder = client.createBinder ();
      dataBinder.putLocal ("IdcService", "ADD_USER");
      dataBinder.putLocal ("dName", "TEST_ROLE");
      dataBinder.putLocal ("dFullName", "TEST_ROLE");
      dataBinder.putLocal ("dPassword", "ibm123$$");
      dataBinder.putLocal ("dUserAuthType", "Local");
      dataBinder.putLocal ("userIsAdmin", "true");
      dataBinder.putLocal ("dEmail", "TEST_ROLE@gmail.com");
      IdcContext userContext = new IdcContext(username);
      client.sendRequest (userContext, dataBinder);
      System.out.println("After Creating the USER.. " );

    }

     public void getUserList()throws IdcClientException, IOException{

       System.out.println("In The getUserList method.. ");
       IdcClient client =getUCMConnection();
       DataBinder dataBinder = client.createBinder ();
       dataBinder.putLocal ("IdcService", "GET_USERS");
       IdcContext userContext = new IdcContext(username);
       ServiceResponse response = client.sendRequest (userContext, dataBinder);
       DataBinder resultSet = response.getResponseAsBinder ();

       System.out.println ("Resultset Names :" + resultSet.getResultSetNames());
      // Collection coll = responseData.getResultSetNames();
       DataResultSet drs = resultSet.getResultSet("Users");
       DataResultSet usrattri = resultSet.getResultSet("UserAttribInfo");

       for (DataObject dataObject : drs.getRows ()) {

       System.out.println ("User Name :" + dataObject.get ("dFullName"));
       }
       for (DataObject dataObject : usrattri.getRows ()) {

       System.out.println (" User Name :" + dataObject.get("dUserName"));
       System.out.println (" Role :" + dataObject.get("AttributeInfo"));
       }

       response.close();
       System.out.println("After the getUserList method.. ");


     }

public void addGroup()throws IdcClientException, IOException{

    System.out.println("In The addRole method.. ");
    IdcClient client =getUCMConnection();
    DataBinder dataBinder = client.createBinder ();
    dataBinder.putLocal ("IdcService", "ADD_GROUP");
    dataBinder.putLocal ("dGroupName", "TEST_GROUP");
    dataBinder.putLocal ("dPrivilege", "15");
    dataBinder.putLocal ("dDescription", "admin privileges");
    IdcContext userContext = new IdcContext(username);
    client.sendRequest (userContext, dataBinder);

}

public void checkinFile(String Filename ,String Filepath)throws IdcClientException, IOException{

    System.out.println("In The createUser method.. ");
    IdcClient client =getUCMConnection();
    DataBinder binder = client.createBinder ();

    System.out.println("In the checkinFile method.. ");
    binder.putLocal ("IdcService", "CHECKIN_UNIVERSAL");
    binder.putLocal ("dDocTitle", "Test_Ridc");
    binder.putLocal ("dDocName", "Test_Ridc");
    binder.putLocal ("dDocType", "Document");
    binder.putLocal ("dDocAuthor", "sysadmin");
    binder.putLocal ("dSecurityGroup", "Public");
    binder.putLocal ("dDocAccount", "");
    binder.putLocal ("dOriginalName", Filename);
    binder.addFile("primaryFile", new TransferFile(new File(Filepath+Filename)));
    IdcContext userContext = new IdcContext(username);
    client.sendRequest (userContext, binder);
    System.out.println("After checkinFile method.. ");
}

public void checkOutByName(String DocName,String DocTitle) throws IdcClientException, IOException{

    System.out.println("In The createUser method.. ");
    IdcClient client =getUCMConnection();
    DataBinder binder = client.createBinder ();

    System.out.println("In the checkOutByName method.. ");
    binder.putLocal ("IdcService", "CHECKOUT_BY_NAME");
    binder.putLocal ("dDocName", "DHANU_000048");
    binder.putLocal ("dDocTitle", "TEST...");
    IdcContext userContext = new IdcContext(username);
    client.sendRequest (userContext, binder);
    System.out.println("After checkOutByName method.. ");

}

public void deleteDoc() throws IdcClientException ,IOException {

    System.out.println("In the deleteDoc method.. ");
    IdcClient client =getUCMConnection();
    DataBinder binder = client.createBinder ();
    binder.putLocal ("IdcService", "DELETE_DOC");
    binder.putLocal ("dID", "57");
    binder.putLocal ("dDocName", "TESTUPLOADING..");
    IdcContext userContext = new IdcContext(username);
    client.sendRequest (userContext, binder);
    System.out.println("After deleteDoc method.. ");

}

public void updateDoc()throws IdcClientException,IOException {

    System.out.println("In The createUser method.. ");
    IdcClient client =getUCMConnection();
    DataBinder binder = client.createBinder ();
    System.out.println("In the updateDoc method.. ");
    binder.putLocal ("IdcService", "UPDATE_DOCINFO");
    binder.putLocal ("dDocName", "DHANU_000048");
    binder.putLocal ("dID", "54");
    binder.putLocal ("dDocAuthor", "weblogic");
    binder.putLocal ("dDocTitle", "TEST00");
    binder.putLocal ("xlanguage", "UPDATE_TELUGU..");
    IdcContext userContext = new IdcContext(username);
    client.sendRequest (userContext, binder);
    System.out.println("After updateDoc method.. ");
}
     public void getSearchResults(String querytext)throws IdcClientException, IOException{

       System.out.println("In The getSearchResults method.. ");
       IdcClient client =getUCMConnection();
       DataBinder dataBinder = client.createBinder ();
       dataBinder.putLocal ("IdcService", "GET_SEARCH_RESULTS");
       dataBinder.putLocal ("QueryText", querytext);
       IdcContext userContext = new IdcContext(username);
       ServiceResponse response = client.sendRequest (userContext, dataBinder);
       DataBinder binder = response.getResponseAsBinder ();
       DataResultSet resultSet = binder.getResultSet ("SearchResults");
       // loop over the results
       for (DataObject dataObject : resultSet.getRows ()) {
       System.out.println (" Title : " + dataObject.get ("dDocTitle") + " Author : " + dataObject.get ("dDocAuthor")   + "    Security Group : " + dataObject.get ("dSecurityGroup") );

       }

     }

public static void main(String[] args) throws IdcClientException,
                                                FileNotFoundException,
                                                IOException, Exception {

        GET_FILE GF = new GET_FILE();
        GF.getFile("62");
        GF.createUser();
        GF.getUserList();
        GF.addGroup();
        GF.checkOutByName("FEB_2012_PAYSLIP","Payslip_Feb_2012");
        GF.updateDoc();
        GF.getSearchResults("dDocAuthor <matches> `sysadmin` <AND> dDocType <matches> `Document`");
        GF.checkinFile("Payslip_Feb_2012.pdf" ,"C:/Documents and Settings/Administrator/Desktop/checkin_Docs/");
        GF.deleteDoc();

           }

}
----------------------------------------------------------------------------------------------------------