Created by James Hurrell, last modified on Nov 03, 2021
This documentation is not maintained. Please refer to doc.castsoftware.com/technologies to find the latest updates.

Introduction

When delivering source code for the Vanilla and Project, the CAST Delivery Manager Tool offers the following options for your Siebel repository extraction:

Reuse existing Siebel extractor output

This option allows you to perform an offline extraction using the CAST Database Extractor (which can be downloaded from https://extend.castsoftware.com/#/extension?id=com.castsoftware.aip.extractor.sqldatabase&version=latest) and then package the output for delivery. A tailor made batch file provided in the downloaded Siebel extension is available for running the offline extraction with the CAST Database Extractor - this should be used where possible:

%PROGRAMDATA%\CAST\CAST\Extensions\com.castsoftware.siebel.<version>\TOOLS\OfflineExtraction\Siebel-Extract-CLI.bat

This batch file will need modification BEFORE you run it - this is so that it can be tailored to the RDBMS on which your Siebel repositories are hosted and which you want to extract. For example:

Database parameters = Access to the database hosting the Siebel repository

rem for Oracle : oracle
rem for SQL Server : mssql
rem for DB2 : db2
SET DBTYPE=<PARAM>

You must set this option to match the target RDBMS. For example for a Microsoft SQL Server:

SET DBTYPE=mssql

rem either a host or an IP
SET SERVER_NAME=<PARAM>
SET PORTNUMBER=<PARAM>
SET DATABASE_NAME=<PARAM>

Enter the three fields, for example, for a Microsoft SQL Server:

SET SERVER_NAME=MY_HOST
SET PORTNUMBER=1433
SET DATABASE_NAME=MY_DB

Hints:

  • SET SERVER_NAME - enter an IP address or host name
  • SET PORTNUMBER:
    • DB2 = 50000
    • Oracle = 1521 (as per the Tnsname.ora file)
    • Microsoft SQL Server = 1433
  • SET DATABASE_NAME:
    • DB2 = The DB2 database name
    • Oracle =  Either the Service name as per the Tnsname.ora file, or the SID (System ID) as per the Tnsname.ora file
    • Microsoft SQL Server = The instance name
rem <CHOOSE> %JDBC_URL_ORACLE_SID% or %JDBC_URL_ORACLE_SERVICE%
SET JDBC_URL_ORACLE=%JDBC_URL_ORACLE_SID%

When targeting an Oracle Server, you must choose one parameter or the other. E.g. if you define a Service name in SET DATABASE_NAME, you should change the line to:

SET JDBC_URL_ORACLE=%JDBC_URL_ORACLE_SERVICE%

rem <CHOOSE> %JDBC_URL_SQLSERVER_DEFAULT% or %JDBC_URL_SQLSERVER_INSTANCE%
SET JDBC_URL_SQLSERVER=%JDBC_URL_SQLSERVER_DEFAULT%

When targeting an Microsoft SQL Server, you must choose one parameter or the other. E.g:

  • if your server only requires a port number for access, you should choose: %JDBC_URL_SQLSERVER_DEFAULT%
  • if your server requires and instance name and port number, you should choose: %JDBC_URL_SQLSERVER_INSTANCE%
rem user used for the SQL connection
rem SET /p DBUSER="CONNECTION USER: "
SET DBUSER=<PARAM>
rem SET /p DBPWD="CONNECTION PASSWORD: "
SET DBPWD=<PARAM>

For Microsoft SQL Server only, this option determines the credentials that should be used to access the RDBMS. For example:

rem user used for the SQL connection
rem SET /p DBUSER="CONNECTION USER: "
SET DBUSER=sa
rem SET /p DBPWD="CONNECTION PASSWORD: "
SET DBPWD=some_password

Siebel parameters = Access to the Siebel repository

rem user that contains the tables
SET SCHEMA=<PARAM>		Schema/database in which the Siebel tables are stored:
  • Oracle USER name
  • DB2 schema name
  • Microsoft database name

For example:

SET SCHEMA=MY_DB

rem Repository type = Vanilla or Project
SET PROJECT_NAME=<PARAM>

Choose Vanilla when you specify the "Vanilla" repository ID (see below). Choose Project when you specify the "Project" repository ID (see below):

SET PROJECT_NAME=Project

rem Repository ID
SET REPOSITORY_ID=<PARAM>

Target Repository ID you want to extract. Must be in synch with item Repository Type above:

SET REPOSITORY_ID=Project

  • For Project, this value may change from one version to another.
  • In ≥ 5.2.3, the extraction process will detect if the Project or Vanilla's Repository ID has been used for both Vanilla and Project extractions (using the same repository ID for both Vanilla and Project must be avoided). An error message will be added to the log file if this is the case (see below). 
SIEBEL-105 VANILLA and PROJECT Repository Id should not be same. Refer to the documentation.
rem Repository version. Either 7.5, 7.6, 7.7, 7.8, 8.0, 8.1
SET REPOSITORY_VERSION=<PARAM>

Choose the Siebel version in your target repositories:

SET REPOSITORY_VERSION=8.1

rem List of application names separated by a comma
SET APPLICATION_LIST=<PARAM>

Define a comma separated list of applications involved in the Siebel repository that you want to extract. For example:

SET APPLICATION_LIST=Siebel Sales Enterprise,Siebel Power Communications

Run the batch file

When you run the batch file, the resulting output should be the SiebelExtract_Vanilla.CastExtraction file. Select the SiebelExtract_Vanilla.CastExtraction file in the DMT Package Configuration tab, entering the file path and name in Server Version File field:

Package action

When you run the batch file, the following occurs:

  • a series of ~200 SQL queries are performed on the target Siebel repository.
  • the time taken for the whole task can vary from 5 minutes to several hours. A good runtime in less than 2 hours. If it takes more time and you are targeting repositories on an Oracle Server, it is likely due to Oracle statistics not being up-to-date (see Prerequisites for more information).
  • also check that the Prerequisites described in On Workstation used for extraction (where the CAST Delivery Manager Tool is deployed) have been met where you are experiencing performance issues.

Ensuring the extraction task is correct

  • Successful completion in decent time
  • End of log is clean
  • Inspection of extraction log reveals no error nor problematic warnings

In addition:

  • Number of extracted rows? Ranges from 2 million to 8 million.
  • Size of the .castextraction archive: 40 MB to 150 MB.
  • Project extraction archive is larger (1% to 50% larger) than the Vanilla .castextraction archive

Batch file logging

The batch file will generate logs inside the folder defined in the parameter "ROOT_FOLDER", as follows:

  • a sub-folder "01_Results" that contains the extraction file (SiebelExtract_Project.castextraction or SiebelExtract_Vanilla.castextraction)
  • a sub-folder "log" that contains the extraction log file (ExtractorLog_Project.log or ExtractorLog_Vanilla.log) and the execution file (Project.log or Vanilla.log)

The execution log file gives you the status of the execution:

SituationMessageWhat should you do?
When the execution is successful.Extraction was successful !Nothing.
When an error is identified, the return code of the extraction is interpreted and a functional message ERROR_MESSAGE is displayed.

Error while extracting Siebel Project : %ERROR_MESSAGE%

  • 1000: Missing configuration file %CONFIG_FILE%.
  • 1001: Check the log file %EXECUTION_LOG_FILE%.
  • 2000: Unable to establish a connection. Check the log file %EXECUTION_LOG_FILE%.
  • 2001: Error during the extraction. Check the log file %EXECUTION_LOG_FILE%.
  • Other: Java error. Contact CAST Support.
  • Please checks the logs, fix the configuration and retry the extraction.
  • If the issue is not a configuration issue, please contact the CAST Support.

Siebel on DB2 / Siebel on Oracle / Siebel on Microsoft SQL Server - extraction via the CAST Delivery Manager Tool

These options will perform an extraction using the extractor embedded into the CAST Delivery Manager Tool - connections are made using JDBC drivers. For example:

DB2

Click to enlarge

Oracle

Click to enlarge

Microsoft SQL Server

Click to enlarge

Use the table below to help you fill in the required fields:

Option in UIDescription

Host name

Your RDBMS server host name: either its netbios name or its IP address

Instance IdentificationDB2

Enter both:

  • DB2 server port - usually 50000
  • The DB2 database name
Oracle

Enter the Oracle instance port number, as per Tnsname.ora file - usually 1521. Then choose either:

  • Service as per Tnsname.ora file
  • The SID (System ID) is the instance name as per Tnsname.ora file
Microsoft SQL Server

Choose either:

  • Port - usually 1433
  • The instance name
Repository Type
  • Choose Vanilla when you specify the "Vanilla" repository ID (see below)
  • Choose Project when you specify the "Project" repository ID (see below)
Schema/DatabaseSchema/database in which the Siebel tables are stored:
  • Oracle USER name
  • DB2 schema name
  • Microsoft database name
Version

Choose the Siebel version in your target repositories:

Repository ID

Target Repository ID you want to extract. Must be in synch with item Repository Type above.

  • For Project, this value may change from one version to another: if changed, edit the CAST Delivery Manager Tool package to change the value for rescan extraction.
  • In ≥ 5.2.3, the extraction process will detect if the Project or Vanilla's Repository ID has been used for both Vanilla and Project extractions (using the same repository ID for both Vanilla and Project must be avoided). An error message will be added to the log file if this is the case (see below). 
SIEBEL-105 VANILLA and PROJECT Repository Id should not be same. Refer to the documentation.


Credentials

Fill in the credentials for the target RDBMS:

User nameUser with appropriate permission to perform the extraction.
PasswordPassword for the user selected in the User name field.
Remember password

This option enables you to force the CAST Delivery Manager Tool to save the database access credentials you have entered above.

Choosing an option or not has no impact on the extraction (i.e. the CAST Delivery Manager Tool can still access the required resources). However, if you are creating subsequent Versions of the same schemas on the same server, you can choose to store the password in which case you will not need to re-enter it.

  • Not stored > The credentials are not saved.
  • Local > The credentials are saved in the user's local workspace on the current machine. Choose this option if you do not want the password to be available to other Delivery Managers.
  • Server > The credentials are saved locally (as above) and are also synchronized back to the CAST AIC Portal (i.e. the Source Code Delivery Folder). Choose this option if you want the password to be available to other Delivery Managers.
JVM Memory Size

The CAST Database extractors are Java based and require the use of the JRE JVM (Java Virtual Machine). This option allows you to configure the Maximum Java Heap Size of your JVM for use during the database/schema browse and extraction processes. By default 1GB of memory is allocated and in most scenarios this value can be left as it is.

You may need to change the amount of memory allocated to the JVM if you are getting out of memory exceptions for the Java Heap Space when you either browse to select a database/schema or when you use the Package action to invoke the extraction - this can occur more specifically when attempting to extract a large single database/schema or multiple databases/schemas. Please increase the memory allocation until you no longer receive errors.

Applications to measure

Use this section to define the applications involved in the Siebel repository that you want to extract:

You can either add the names manually (use the green Add button), or use the Browse button to access the live RDBMS and choose the items you require, for example: