Developing OTDs for Application Adapters

Creating Siebel EAI OTDs

Before Creating the OTD

Installing seebeyond.sif for Siebel 7.5.x

If you are using Siebel 7.5.x, before you create an OTD using the OTD Wizard, you must install the seebeyond.sif file into your Siebel Tools system. This file is installed in the Netbeans IDE’s user directory during the Netbeans IDE installation.

ProcedureTo Install the seebeyond.sif File

  1. Use the Siebel Tools utility to import the seebeyond.sif file into your Siebel Server

    This file is installed with the Netbeans IDE. If you installed the Netbeans IDE in the c:\JavaCAPS\edesigner directory, then the file is located in


    c:\JavaCAPS\edesigner\usrdir\modules\ext\siebeleaiadapter
  2. After importing the file, use the Siebel Tools utility to compile your SRF file.

  3. Stop the Gateway Server and the Siebel Server.

  4. Replace the file on the Siebel Server with the one you created in step 2.

  5. Restart the Gateway Server and the Siebel Server.

Installing SiebelMessage XSD Generation Process.xml for Siebel 7.7 and 7.8.x

If you are using Siebel 7.7 or 7.8.x, before you can create an OTD using the OTD Wizard, you must install the SiebelMessage XSD Generation Process.xml file.

ProcedureTo Install the SiebelMessage XSD Generation Process.xml File

  1. Open the Siebel Tools utility.

  2. In the Object Explorer, click the Workflow Process.

  3. Right-click the item in the Object list, and then click Import Workflow Process.

  4. Browse to the directory that contains SiebelMessage XSD Generation Process.xml.

    This file is installed with the Netbeans IDE. If you installed the Netbeans IDE in the c:\JavaCAPS\edesigner directory, then the file is located in


    c:\JavaCAPS\edesigner\usrdir\modules\ext\siebeleaiadapter
  5. Click Open to begin importing the Workflow template.

  6. Select your project.

  7. Stop the Gateway Server and the Siebel Server.

  8. Use the Siebel Tools utility to compile your SRF file.

  9. Copy the SRF file to the objects folder in your Siebel Server.

  10. Restart the Gateway Server and the Siebel Server.

Before Running the Netbeans IDE

The Netbeans IDE needs to be configured to use the appropriate JAR files to correspond with the version of your Siebel Server. Before you use the Netbeans IDE to create your Siebel EAI Project, you must make sure that your local Netbeans IDE installation is using the proper JAR files for your Siebel Server.

ProcedureTo Run Netbeans with Siebel 7.5.x

  1. Using Windows Explorer, navigate to the Siebel Adapter directory for your Netbeans IDE.

    If you installed the Netbeans IDE in the c:\JavaCAPS\edesigner directory, then navigate to


    c:\JavaCAPS\edesigner\usrdir\modules\ext\siebeleaiadapter
  2. If you have previously used Siebel 7.7 or 7.8.x with this installation of the Netbeans IDE, then remove the following files from this directory:

    • Siebel.jar

    • SiebelJI_enu.jar

  3. Copy the following files from your Siebel 7.5.x system (SiebelTools/Classes) to this location:

    • SiebelJI.jar

    • SiebelJI_Common.jar

    • SiebelJI_enu.jar

  4. Restart the Netbeans IDE

ProcedureTo Run the Netbeans IDE with Siebel 7.7 or 7.8.x

  1. Using Windows Explorer, navigate to the Siebel Adapter directory for your Netbeans IDE.

    If you installed the Netbeans IDE in the c:\JavaCAPS\edesigner directory, then navigate to


    c:\JavaCAPS\usrdir\modules\ext\siebeleaiadapter
  2. If you have previously used Siebel 7.5.x with this installation of the Netbeans IDE, then remove the following files from this directory:

    • SiebelJI.jar

    • SiebelJI_Common.jar

    • SiebelJI_enu.jar

  3. Copy the following files from your Siebel 7.7 or 7.8.x system (SiebelTools/Classes) to this location:

    • Siebel.jar

    • SiebelJI_enu.jar

  4. Restart the Netbeans IDE

Creating the OTD

Steps required to create an OTD include:

ProcedureTo Create the OTD

  1. On the Project tree, right click the Project and select New ⇒ Object Type Definition from the shortcut menu. The Select Wizard Type page appears, displaying the available OTD wizards. See the following figure.

    Select Wizard Type window
  2. From the New Object Type Definition Wizard window, select SiebelEAIWizard and click the Next button. The Connect to Siebel EAI Server window appears.

    Siebel Server Connection Window
  3. Enter the following information into the text fields:

    • Version: the Siebel Server version (the same version used to create the OTD appears by default)

    • Connection String:

      • For Siebel 7.5.x:


         siebel://<GatewayServer>/<EnterpriseServerName>/<ApplicationObjectManager>/<SiebelServerName>
      • For Siebel 7.7 and 7.8.x:


         siebel://<SiebelServerName>:<port>/<EnterpriseServerName>/<ApplicationObjectManager>
    • Repository Name: Siebel Repository

    • User Name: a valid user name

    • Password: a valid password

  4. Click the Connect button. A message appears confirming a successful connection.

    Successful Server Connection Window
  5. Click the Next button. The Select Integration Objects window appears.

  6. Scroll down the Integration Objects selection table and select Account Interface.

  7. Click the Add button. Account Interface appears in the Selected Objects window.

    Select Integration Objects Window
  8. Click the Next button. The Specify the OTD names window appears.

    Specify the OTD names window
  9. In the OTD Name column, enter the name for the new OTD.

  10. Click the Next button. The Review your Selections window appears.

    Review your Selections window
  11. Click the Finish button. A message appears confirming the successfully generated OTD. See the following figure.

    Completed OTD Message window

ProcedureTo Relaunch the OTD

  1. From the Project tree, right-click the OTD and select Version Control ⇒ Check Out from the shortcut menu. The Version Control - Check Out dialog box appears.

  2. Select Check Out on the Version Control - Check Out window.

  3. Right-click the OTD once again and select Relaunch.

    The Connect to Siebel EAI Server window appears.

    Siebel Server Connection window

    The fields (with the exception of Password) will be populated with metadata information selected when building the original OTD.

  4. Enter a valid password in the Password field.

  5. Click the Connect button. A message appears confirming a successful connection.

  6. Click the Next button. The Select Integration Objects window appears. The Selected Objects window will already be populated with the previously selected Integration Object.


    Note –

    If you attempt to select a different Integration Object, an error dialogue will appear.


  7. Click the Next button. The OTD Name column will already be populated with the original OTD’s name.

  8. Click the Next button. The Review your Selections window appears.

  9. Click the Finish button. A message appears confirming the successfully generated OTD.