Bookshelf Home | Contents | Index | Search | PDF

Upgrading and Migrating Siebel Janna Applications > Interoperability > Integrating Data >

Configuring a Siebel Janna VBC

---

To display Siebel Janna specific data within your Siebel application, you must configure a Siebel Janna VBC. A Siebel Janna VBC is a custom virtual business component that is configured from within Siebel Tools. Siebel Janna VBCs are based on Siebel Janna Data Objects. For every type of Siebel Janna Data Object that will flow into your Siebel application, a separate Siebel Janna VBC should be configured. The Siebel Janna VBC is based on the CSSJBCVExtern class.

Perform the following tasks to create and configure a Siebel Janna VBC:

Collect information about the Siebel Janna Data and Siebel Janna Service Objects.
Create the Virtual Business Component definition in Siebel Tools.
Create the Virtual Business Component field definitions in Siebel Tools.
Configure the Virtual Business Component's user properties.
Compile the Virtual Business Component.

The following procedures demonstrate how to gather information required for the VBC, as well as how to create and configure the VBC in Siebel Tools.

To gather information required for the Siebel Janna VBC

Determine the ProgID of the Siebel Janna Data Objects.
For core Siebel Janna Data Objects, consult the Siebel Janna Tools Library for the ProgID of the Siebel Janna Data Object being integrated.

Most core Siebel Janna Data Object ProgIDs are formed from the database table name that forms the basis of the Siebel Janna Data Object, and take the following form:

JDBOBJ.<database table or view name>.40

For example, the ProgID of the Siebel Janna Data Object that represents a record in the ConPhone table in a Siebel Janna database will be:

JDBOBJ.ConPhone.40

For extension Siebel Janna Data Objects, consult the technical design documents of the extension implementation for the ProgIDs for Siebel Janna Data Objects that were part of the extension module.
For client extension Siebel Janna Data Objects, the client technical design documents should contain the ProgIDs for Siebel Janna Data Objects that were part of the client implementation.

Most custom Siebel Janna Data Object ProgIDs that are formed from extension tables or views by using the wizards will be in the following format:

<Project Name>.<database table or view name>.1

For example, if you created a Siebel Janna Data Object based on an extension table called Transactions_Data, and the project name specified in the wizard was TransactionsDO, the ProgID would be:

TransactionsDO.Transactions_Data.1

NOTE:  If the Siebel Janna Data Object in question was not created using conventional Siebel Janna SDK wizards, then consult technical documentation to determine its ProgID.

Determine the ProgID of the Siebel Janna Service Object.
For core Siebel Janna Service Objects, consult the Siebel Janna Tools Library for the Siebel Janna Service Object being integrated.

Most Siebel Janna Service Object ProgIDs are formed from the SQL Table Name that the Siebel Janna Service Object maintains, and take the following form:

JCESO.<database table or view name>

For example, the ProgID of the Siebel Janna Service Object that represents a record set in the ConPhone table in a Siebel Janna database will be:

JCESO.ConPhone

For extension Siebel Janna Service Objects, consult the technical design documents of the extension implementation for Siebel Janna Service Objects that were part of the extension module.
For client extension Siebel Janna Service Objects, the client technical design documents should contain the ProgIDs for Siebel Janna Service Objects that were part of the Client Implementation.
Most custom Siebel Janna Service Object ProgIDs that are formed from extension tables or views by using the wizards will be in the following format:

<Project Name>.<database table or view name>.1

For example if you created a Siebel Janna Service Object based on an extension table called Transactions_Data, and the project name specified in the wizard was TransactionsSO, the ProgID would be:

TransactionsSO.Transactions_Data.1

NOTE:  If the Siebel Janna Service Object in question was not created using conventional Siebel Janna SDK wizards, then consult technical documentation to determine its ProgID.

Determine the Siebel Janna Data Object Field Names. They will have properties that represent each column of the underlying SQL Table or View that the Siebel Janna Data Object is responsible for maintaining. However, the SQL Table or View Definition is not reliable as an indicator of the fields available from a Siebel Janna Data Object. Instead, the relevant Technical Documentation for the Siebel Janna Data Object, the OLEView type library display, or the Implementation Source Code should be consulted for the fields exposed by the Siebel Janna Data Object.
Determine the Siebel Janna Data Object Key Field Names by doing one of the following:

NOTE:  Some of the properties of the Siebel Janna Data Object will be Key Fields. These act as foreign keys to other tables or as a primary key for the table the Siebel Janna Data Object maintains.

Consult the Siebel Janna Tools, the extension technical documentation, or the client extension technical documentation for the names of the key fields on each Siebel Janna Data Object.
Examine the database table or view for foreign key and uniqueness constraints to determine which fields are key fields. The columns attributed with these kinds of rules are key fields.
Examine the Siebel Janna Data Object's corresponding Siebel Janna Service Object source code, and the client source code for the Siebel Janna service object and Siebel Janna Data Object pair.
Check for GUID values in the Siebel Janna Data Object's properties. Siebel Janna Data Object properties that contain GUID values represent primary keys and foreign keys on a Siebel Janna Data Object.
Determine the Siebel Janna Data Object XML tag name. The XML tag name for a Siebel Janna Data Object generated by the Siebel Janna Tools will be identical to the name of the corresponding database object. If the Siebel Janna Data Object was based on an extension table called Transactions_Data, for example, the XML tag name would be Transactions_Data. Should the XML tag name not conform to this convention, you will need to consult technical documentation.
Determine the Siebel Janna Requestor ProgID. The Siebel Janna Requestor ProgID can be one of four values depending on the transport being used to activate Siebel Janna Service Objects on the SJAS.
For DCOM: JGenObj.JGenDCOMReq
For HTTP: JGenObj.JGenHTTPReq
For MSMQ: JGenObj.JGenMSMQReq
For IBMMQ: JGenObj.JGenIBMMQReq
Set a page threshold (optional). You can restrict the number of rows the VBC retrieves at each invocation using the Page Threshold value. In this way, VBCs that issue queries which return many records will only retrieve the first X (where X is the Page Threshold) records until the next page of records is requested by the application. This can improve VBC performance.

To create the Siebel Janna VBC in Siebel Tools

Locate the Siebel Janna Interoperability VBC Template Business Component in the Business Components Object Types in Siebel Tools.
Right-click the record on its row indicator and click Copy.
Enter a name for the new VBC.
Select the correct Project for your VBC.

To create the Siebel Janna VBC Fields in Siebel Tools

With the new Business Component Row Selected, browse to the Field Child Object Type in Siebel Tools.
Create a new Field Object Type Row for each Field in the Business Component.
Name the field according to naming conventions in Siebel Tools Reference, and use the default Field Object Type attributes.

To configure the Siebel Janna VBC's Field Mapping User Properties

The VBC's Field Mapping User Properties specify the mapping between a Siebel Janna Data Object and a Siebel Business Component. The format for these User Properties is as follows:

<Siebel Janna Data Object Field1>=<Siebel Business Component Field1>;<Siebel Janna Data Object Field2>=<Siebel Business Component Field2>...<Siebel Janna Data Object Fieldn>=<Siebel Business Component Fieldn>

In cases where the Siebel Janna Data Object Field (JDOField) does not have a corresponding Siebel Business Component Field (BCField), then there should be no right side of the <JDOField>=<BCField> expression, reducing it to <JDOField>=
In cases where the Siebel Business Component Field (BCField) does not have a corresponding Siebel Janna Data Object Field (JDOField) then there should be no left side of the <JDOField>=<BCField> expression reducing it to =<BCField>
Where the Field Mapping property spans more than the allowable room on a Business Component User Property, it can be extended to an additional User Property called Field Mapping n where n is the total number of Field Mapping user properties used so far. See Step 1.

To configure the Service Parameters User Property

The Service Parameters User Property specifies information used by the Siebel Janna Gateway Service to communicate with the Siebel Janna Application Server. It consists of the following information gathered from prior steps:

JSOProgID
JDOProgID
JDOTagName
RecInfo
SecInfo
KeyField(s)

It also consists of two additional optional pieces of information:

Criteria
UpdateType

This information is entered into the service parameters user property, Step 1, in the following format:

SOProgID=<value>;JDOProgID=<value>;JDOTagName=<value>;RecInfo =<true/false>;SecInfo=<true/ false>;KeyField=<value>;UpdateType=<optional value>;Criteria=<optional value>

To compile the Siebel Janna business component

From within Siebel Tools, compile the individual object or compile the project of which the Business Component is part. See Siebel Tools Reference for further information on this procedure.

Bookshelf Home | Contents | Index | Search | PDF