Siebel - 5.3 - Onboarding with CAST Imaging Console

Note that CAST Console automates a large part of the configuration process for analyzing Siebel technologies, as such, if you have previously been using the legacy CAST Management Studio to run your analyses, you will find that some of the steps required for CAST Management Studio are not mentioned in the instructions below. This is not an omission, it is simply because these steps are now automated and do not require manual intervention.

Prerequisites

Step 1 - Repository extraction

The Vanilla and Project repositories must be extracted to .castextraction files using the CAST Database Extractor (which can be downloaded from https://extend.castsoftware.com/#/extension?id=com.castsoftware.aip.extractor.sqldatabase&version=latest) . A tailor made batch file provided in the Siebel extension is available for running the offline extraction with the CAST Database Extractor - this should be used and can be found in the following location in the extension:

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 - see the sections below.

Note that if you need to run the extraction in a Linux server, you can re-use this script file (it is not provided in the extension): Siebel-Extract-CLI.sh  - this will need configuring as explained below.

Configure Siebel-Extract-CLI.bat

Find the following sections in the batch file and modify them to match your environment:

RDBMS access parameters

Find the section rem Database parameters = Access to the database hosting the Siebel repository:

Siebel repository access parameters

Find the section rem Siebel parameters = Access to the Siebel repository:

SIEBEL-105 VANILLA and PROJECT Repository Id should not be same. Refer to the documentation.

Run the batch file

When you run the batch file on each Siebel repository, the resulting output should be one .castextraction file for each repository, for example:

• SiebelExtract_Vanilla.castextraction
• SiebelExtract_Project.castextraction

These files need to be delivered to AIP Console - see below.

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:

Step 2 - .SiebelProject file configuration

Note that this file must be named with the exact same prefix as used for the Project repository .castextraction file, for example if you name the file SiebelExtract_Project.SiebelProject, the .castextraction file must be named SiebelExtract_Project.castextraction.

The Project repository requires a .SiebelProject configuration file that defines specific information required during the analysis:

• The name of the Vanilla application or Analysis schema
• Definition of Siebel specific rule contextual parameters

Below is a template .SiebelProject file - items in square brackets need to be manually defined:

<SiebelProjectConfig vanillaApplication="[application_name_or_analysis_schema_name]">
    <SiebelApplication name="[siebel_app_name]" vanillaName="[app_name_in_vanilla]"/>
    <QualityRule id="[rule_id]">
        <Parameter name="[parameter_name]" value="[parameter_value]"/>
    </QualityRule>
    <QualityRuleGroup name="companyPrefix" active="[true_or_false]">
        <QualityRule id="[rule_id]" active="[true_or_false]">
            <Parameter name="[parameter_name]" value="[parameter_value]"/>
        </QualityRule>
    </QualityRuleGroup>
</SiebelProjectConfig>

<SiebelProjectConfig>

This opening tag is required and defines the name of the Vanilla application defined in AIP Console. You can define either the Application name, or the corresponding Analysis schema name. Both are highlighted below and can be found in the AIP Console Admin Center (see Administration Center - Applications - Application Details ):

In the above example, this would give the following when using the Application Name:

<SiebelProjectConfig vanillaApplication="Siebel_Project">

</SiebelProjectConfig>

<SiebelApplication> - optional

This line is optional and should only be used when the Siebel application name in the Project repository is not identical to the name used in the Vanilla repository. This can sometimes occur when the Siebel application name has been renamed manually in the Project repository. In the following example, the name in the Project repository is “Siebel eService” and the name in the Vanilla repository is “Siebel eService Default”:

<SiebelApplication name="Siebel eService" vanillaName="Siebel eService Default"/>

<QualityRule> and <Parameter>

This section allows you to define the contextual parameters for specific Siebel rules that will be triggered during the analysis, specifically to adapt them to your own environment. Use the tables below to create the entries you need. Note that if you DO NOT define an entry for a rule in the .SiebelProject file, then the rule WILL be triggered during the analysis, but will use the default parameter values provided in the Assessment Model.

Multiple values, char: as they are related to naming convention, they must be adapted to the project:

Single value, numerical: As a first approach, you can stick to the default values:

In the following example, we have changed two contextual parameters for the rule 1520380 (Siebel: Applet’s name should contain the type), and one parameter value for the rule 1521702 (Siebel: Business Component’s name should begin with Company prefix):

<QualityRule id="1520380">
    <Parameter name="Siebel: Suffix Applet - MVG" value="MVG Applet"/>
    <Parameter name="Siebel: Suffix Applet - Pick List" value="Pick Applet"/>
</QualityRule>
<QualityRule id="1521702">
    <Parameter name="Siebel: Prefix Business Component" value="ACME_"/>
</QualityRule>

Step 3 - configure source code

You now need to configure the source code to deliver in AIP Console. There are two ways to deliver the source code, either in a ZIP file, or via a Source Folder Location:

Step 4 - create Version, deliver source code and run analysis/snapshot

For each Application (Vanilla and Project) that you have created in Console, you need to now deliver the source code configured in Step 3 and run the analysis/snapshot. In Console, the process can be done in small steps, or in one go.

It is very important that you run the analysis and snapshot for the Vanilla application BEFORE you run the analysis and snapshot for the Project application.

Step 5 - check results

When the snapshot has been completed for both repositories, CAST highly recommends that you check the results.

All Siebel applications will have critical and non-critical violations. This is inherent to this development environment. So even with low customization ratios, the number of critical and non-critical violations will be 100s or 1000s.