Page tree
Skip to end of metadata
Go to start of metadata
Purpose

This page is the user guide for CAST Support Tool (CST) - alias Sherlock.

In this document, the analysis machine is the machine where CAST Management Studio is installed.

For the latest version of the Release Notes please check Sherlock - Release Notes

Details

Applicable CAST Version

You may run CAST Support Tool (CST) where the following CAST Version has been installed:

CAST VersionYes/No
8.3.x(tick)
8.2.x(tick)

Applicable RDBMS

You may run CAST Support Tool (CST) where the CAST Knowledge Base/Central/Management/Measurement databases have been installed on the following RDBMS:

RDBMSYes/No
Oracle Server(tick)
Microsoft SQL Server(tick)
CSS2(tick)
CSS3(tick)

Prerequisites

 Follow the below prerequisites before running the tool:

Prerequisite 1

Install CAST Support Tool (CST) on the analysis machine.

Prerequisite 2

Microsoft .NET Framework 4.6.1 or higher version should be installed on the analysis machine, Sherlock is built on Microsoft .NET framework 4.6.1

Note that Microsoft .NET framework is not compliant with the Federal Information Processing Standard (FIPS) encryption. If your machine is configured to FIPS encryption, Microsoft framework will throw an exception. Follow the instruction to disable FIPS encryption.

Prerequisite 3

Close all the instances of CAST Management Studio before running CAST Support Tool (CST). Once the tool is launched, you may use CAST Management Studio again (no need to wait till CAST Support Tool (CST) ends)

Prerequisite 4

If multiple users access the analysis machine, or if the access is made through Windows Terminal Servers or Citrix, we strongly advise you to change the CAST Temp folder default path (Default path is %TEMP%\CAST\CAST\$CAST_MAJOR_VERSION$.$CAST_MINOR_VERSION$\). To do so, proceed as follows: 

Edit the CastGlobalSettings.ini file located in the CAST installation folder.

Locate the following line:

Set current user's temporary path

CAST_CURRENT_USER_TEMP_PATH=%TEMP%\CAST\CAST\$CAST_MAJOR_VERSION$.$CAST_MINOR_VERSION$\

Replace  %TEMP%: with <YOUR ROOT TEMPORARY FOLDER>

Save the file.

Prerequisite 5

Make sure to have sufficient space in the CST Working Folder. The space requirement depends on the size of the application(s) you have selected.

If the analyzed source code files are exported (Export source code) and their size is 500 MB, make sure to allocate more than 1.5 GB of space in the temporary folder.

Prerequisite 6

The available Physical Memory must be more than 400 MB to trigger Cast Support Tool (CST). If it is less than 400 MB you wouldn't be able to run the tool.

If the available Physical Memory is between 400 MB to 1 GB there is a chance of getting memory issues while exporting the inputs.

So it is recommended to have available Physical Memory more than 1 GB

From 8.3.25 Sherlock is compatible with SSL connection to CAST bases and is able to read connection profile even when you open CAST-MS from CAST AIP flat location.

Launch Cast Support Tool (CST)

Launch from GUI

  1. Download Cast Support Tool (CST)
  2. Unzip it
  3. Run CASTSupportTool.exe. The following window gets displayed:
  4. Select the Management from the Database Connection Manager window.
  5. Press Connect button. The following window gets displayed:
  6. Select your application(s)  
  7. Press Select Processings >>. The following window gets displayed with the option default selection:
  8. You may change the features default selection. Note that you must select at least one feature:

CAST Bases Checker (feature checked by default)

Export Logs (feature checked by default)

Export Configuration files (feature checked by default)

Export Computer Environment (feature checked by default)

Export CAST Bases (feature checked by default)

To only export the Knowledge base, Central base, Management base or Measurement base, double click on the Export CAST Bases to open the sub menu as shown in the screen shot below, and select the database types of your choice:

 CAST AAD/AED Folder: If AAD/AED war file is deployed in the analysis machine, provide AAD/AED Server path (For instance, C:\Program Files\Apache Software Foundation\Tomcat 7.0\webapps\CAST-AAD).

Enter the full name of the CAST Support Tool (CST) output file in CST Output File*, which will automatic take the .CSTExtraction as an extension.

Uncheck Export source code (option unchecked by default) if you do not allow the export of your source code.

CST Working Folder (%TEMP% path by default)

       

Press Start. The tool will prompt the following message box to remind you to close all the instances of CAST Management Studio before proceeding further.

If you press No, the tool will go back to the screen and will not start the features. Close the instance of CAST Management Studio and press Start again.

If you press Yes, the different processes that you have checked will start.

         

Once a process is complete, its status appears as Completed as shown in the below screenshot:

 

Once all the processes are complete, press Exit to exit the tool.

Launch from CLI

  1. Open the command prompt from the path where the tool has been installed.
  2. Run the below command:

    CASTSupportTool.exe -connectionProfile <Connection profile name> -appName <Application Name> -exportLogs -exportConfigFiles -exportDBChecker -exportComputerEnvironment -exportMB -exportKB -castBinaries <CAST Binaries Folder> -outputFile <CST Output File location> -workFolder <CST Working Folder>
  3. If you want to remove some options which are not required.

    If you do not want to extract Logs and DBChecker you can run the command:

    CASTSupportTool.exe -connectionProfile <Connection profile name> -appName <Application Name> -exportLogs- -exportConfigFiles -exportDBChecker- -exportComputerEnvironment -exportMB -exportKB -castBinaries <CAST Binaries Folder> -outputFile <CST Output File location> -workFolder <CST Working Folder>
    


    Feature/OptionDefault valueMandatory/OptionalDescription
    helpN/AOptionalDisplay the list of options
    exportSourceCodeN/AOptionalExport the source code
    exportLogsN/AMandatoryExport the log files
    exportConfigFilesN/AMandatoryExport the configuration files
    exportDBCheckerN/AMandatoryExport the results of DB checkecker
    exportComputerEnvironmentN/AMandatoryExport the computer environment
    exportMBN/AMandatoryExport the Management Base
    exportKBN/AMandatoryExport the Knowledge Base
    exportCBN/AOptionalExport the Central Base
    exportABN/AOptionalExport the Measurement Base
    forceExportN/AOptionalForce the export, even if CAST-MS is running
    incrementalExportN/AOptionalComplete the previous export
    overwriteExportN/AOptionalReplace the previous export
    castBinariesN/AMandatoryPath to the CAST binaries folder
    connectionProfileN/AMandatoryConnection profile name to the Management Base
    appNamedefault application name "My Application"MandatoryApplication name for which the extraction is required
    outputFile%TEMP%/result.CSTExtractionMandatoryCST output file
    workFolder%TEMP%MandatoryCST working folder
    webFolderN/AOptionalOptional path to the war file deployed

Features and options

Feature/OptionDefault value

Mandatory/Optional

ControlDescription

Save Feature Settings

 Check Box uncheckedOptional Check Box

This feature saves the feature settings (check boxes) so that when the same user

runs the tool the saved settings would appear by default for the same user. When you check this checkbox,

please un-check rest of the features check box and check again as required to save the checked check boxes.

Export Logs

Check Box checkedOptionalCheck Box

This feature exports all logs related to the selected CAST AIP application(s)


CAST Bases Checker

Check Box checkedOptional Check Box

This feature runs a set of SQL queries in the CAST bases


Export Configuration files

Check Box checkedOptional Check Box

This feature exports the configurations files done in CAST-MS


Export Computer Environment

Check Box checkedOptional Check Box

This feature retrieves the information of the analysis machine


Export CAST Bases

Check Box checkedOptional Check Box

This feature exports all CAST databases related to the selected CAST application(s): Knowledge base,

Central base, Management base and Measurement base.

To only export the Knowledge base, Central base, Management base or Measurement base,

 double click on the Export CAST Bases to open the sub menu as shown in the screen shot below, and select the databases types of your choice:

CAST AAD/AED Folder

<Empty>OptionalBrowse button

This feature retrieves the CAST-AAD deployed folder if you have Measurement base,you need to input the path

of the CAST-AAD deployed folder.

CST Output File*

<Empty>MandatoryBrowse button

This feature let you browse the path and input the full name of the output zip file.

The extension of the zip file is .CSTExtraction which cannot be changed.

If the output zip file size is more than 450 MB the file gets split the the tool automatically with

an extension .CSTExtraction.001, .CSTExtraction.002, .CSTExtraction.003 and so on.

Each split zip file size should be 450 MB.

If you are selecting the output zip file location in C drive, make sure to run the tool as an administrator.

Export source code

Check Box uncheckedOptional Check Box

If the option is checked, CAST Support Tool (CST) will retrieve the source code of the application(s).

if the option is unchecked, CAST Support Tool (CST) will not retrieve the source code of the application(s).

by default it would remain unchecked

CST Working Folder*

%Temp% pathMandatoryBrowse button

This feature let you browse the temporary path of the tool. Temporary path is the path of the working folder

used by CAST Support Tool (CST). The tool deletes the contents after the processing is done.

If you are selecting the Temporary Path location in C drive, make sure to run the tool as an administrator.

CAST Binaries Folder

<empty>OptionalText Box

CAST AIP binaries path.

To make this option visible, click on CST Working Folder

 

  • (*) mandatory

Output 

If CAST Support Tool (CST) runs successfully, 

  1. Get the output zipped file from the CST Output File* location.
  2. Unzip it (In case of split files you need to unzip .001 which will further extract all the split files)
    You will get one zipped folder per process, in .7z format :

The Output Zip file consists of a zipped folder per-process in .7z format and log files.

For more information, find the following page: CAST Input retrieved by CAST Support Tool (CST)

If CAST Support Tool (CST) fails, no zip file is generated, only the temporary files are. Get the contents of CST Working Folder, report the issue in the zendesk under "Problem in CST Tool  - Alias Sherlock" and attach the temporary files to the ticket.

Possible guidelines for safety concerns

Disable Federal Information Processing Standard (FIPS) encryption

 CAST Support Tool (CST) will throw the below error if your Windows environment is not configured to use FIPS encryption.


To correct this, disable the Local Security Setting System cryptography: Use FIPS compliant algorithms for encryption, hashing, and signing policy in Windows.

  1. Go to Start > Control Panel > Administrative tools > Local Security Policy. The Group Policy dialog appears. 
  2. Under the Local Policies heading, select Security Options"and look for the entry, System cryptography: Use FIPS compliant algorithms for encryption, hashing, and signing
  3. If entry this is enabled, disable it.
  4. Also, open the registry editor and browse to the following path. Make sure this registry subkey is set to 0:

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa\fipsalgorithmpolicy

The correct CAST version (X.X.X) is not installed on this computer

If you are getting this dialog box after clicking on the error, enter the CAST binaries folder manually and run the tool.

,

You need to follow as below:

Click on the label CST Working Folder

Once you click you will get another option to enter CAST Binaries Folder as shown in below screenshot, you need to enter the CAST Binaries\Flat folder path and then run the tool.

CAST Input retrieved by CAST Support Tool (CST)

Note that CAST Technical Support asks you to get all possible input in one single go instead of asking for each element separately as the issue investigation goes. This will avoid comings and goings and avoid delays in issues resolution.

The following lists input retrieved by CAST Support Tool (CST) for the selected CAST application(s):


FeatureOutputOutput unzipped .7z folders nameOutput Contents

Export Logs

Logs.7z 

\Logs\

 ApplicationsSummary\

Log file of the analyzed application summary.

Format: CAST_MainTask_SummaryLog_

<YYYYMMDD>-<HHMMSS>.txt


\Logs\

 ActionPlanOptimizer\

Log file of Action Plan Optimizer

Format: CAST-ActionPlanOptimizer.log.txt


\Logs\

 APPLICATION_NAME\

Log file of the Analysis.

Format: My Source file based

execution unit_-<YYYYMMDDHHMMSS>.castlog


\Logs\

ArchitectureChecker\

Log file of Architecture Checker.

Format: ArchitectureChecker.

<YYYYMMDDHHMMSS>.log.txt


\Logs\CUT\

Log file of the Cast Update Tool.

Format: CUT-<YYYYMMDD>-<HHMMSS>.CastLog2


\Logs\CAST-MS\

Log file of CAST-MS

Format: CAST-MS.log.txt


\Logs\DataFlow\

Dataflow files.

Format: BuildAgent.cwmmid


\Logs\DSSEngine\

Log file of Compute Snapshot

Format: DssEngine.<YYYYMMDDHHMMSS>.log


\Logs\

Jee_generated_files\

Jee generated files.

Format: *.txt


\Logs\Preprocessed\

Preprocessed files.

Format: *.cpp


\Logs\RunCSV\

Log file of Run CSV generation

Format: RunCSV-<YYYYMMDDHHMMSS>.castlog


\Logs\Servman\

Log file of Server Manager.

Format: ServMan.castlog


\Logs\TCC\

Log file of Transaction Configuration Center (TCC)

Format: TransactionConfiguration

Center.<YYYYMMDDHHMMSS>.log.txt


\Logs\Discovery\

Log file of project Discovery by DMT

Format: discovery_[GUID]_report.CastLog2


\Logs\DMT\

Log file of Delivery Manager Tool

Format: DMT<function>-

<YYYYMMDDHHMMSS>.CastLog2


\Logs\DLM\

Log file of Dynamic Link Manager

Format: DLM[UUID]_CMS.castlog


\Logs\AICPortal\

Log file of AIC Portal

Format: AICPortal.castlog2


\Logs\CASTMS-Logger\

Log file created from mngt base

Format: CastMsLogger.txt


Logs.log
Export Logs summary

CAST Bases Checker

DbChecker.7z

\DbChecker\Central

<Central base name>\

Following information will be retrieved from Central Base:

  • Slowest Queries
  • Check Statistics
  • Content of DSS_HISTORY
  • Content of SYS_SITE
  • Migration history
  • Number of Links
  • Number of Metrics
  • Number of Objects
  • Number of objects type per subset per module and 

per technology in the application for all snapshots

  • Postgres parameters (CSS)
  • Snapshots details
  • Database Restore (MS SQL & Oracle)
  • Counting Index (Oracle)
  • Indexes and Properties (Oracle)
  • Indexes Status (Oracle)
  • NLS Parameters (Oracle)
  • User Name (Oracle)
  • User Roles Privileges (Oracle)
  • User Sys Privileges (Oracle)
  • User Tables Privileges (Oracle)

Format: *.HTML



\DbChecker\Local

<Local base name>\

Following information will be retrieved from Local Base:

  • Check Statistics
  • Content of DSS_HISTORY
  • Content of SYS_SITE
  • Count of DataFlow Results
  • Count of DataFlow Scopes
  • Local Slowest Queries
  • Migration History
  • Number of Acc
  • Number of AMT Objects
  • Number of Dynamics Links
  • Number of Escalated Links
  • Number of Keys
  • Number of Links
  • Number of objects per module and per technology
  • Number of Numeric Properties
  • Number of Parent Links
  • Number of Properties
  • Number of Text Properties
  • Postgres Parameters (CSS)
  • Summary of Analysis Jobs & Duration
  • Database Restore (MS SQL & Oracle)
  • Invalid Shared IDs (MS SQL)
  • Counting Index (Oracle)
  • Indexes and Properties (Oracle)
  • Indexes Status (Oracle)
  • NLS Parameters (Oracle)
  • User Name (Oracle)
  • User Roles Privileges (Oracle)
  • User Sys Privileges (Oracle)
  • User Tables Privileges (Oracle)

Format: *.HTML



\DbChecker\Management

<Management base name>\

Following information will be retrieved from Management Base:

  • Check Statistics
  • Content of SYS_SITE
  • Migration History
  • Postgres Parameters (CSS)
  • Database Restore (MS SQL & Oracle)
  • Instance (MS SQL)
  • Version (MS SQL)
  • Causes for Waits (MS SQL)
  • Configuration (MS SQL)
  • CPU Utilization per Object (MS SQL)
  • Database (MS SQL)
  • Memory usage per Database (MS SQL)
  • OS (MS SQL)
  • Signal Waits - CPU Pressure (MS SQL)
  • Counting Index (Oracle)
  • Indexes and Properties (Oracle)
  • Indexes Status (Oracle)
  • NLS Parameters (Oracle)
  • User Name (Oracle)
  • User Roles Privileges (Oracle)
  • User Sys Privileges (Oracle)
  • User Tables Privileges (Oracle)

Format: *.HTML


DbChecker.log
Export DbChecker summary

Export Configuration files

Configurationfiles.7z


\ConfigurationFiles\

ArchitectureModels\

Architecture model file

Format: .CASTArchitect


\ConfigurationFiles\

DlmRule

DLM rule file

Format: *.dlm.xml


\ConfigurationFiles\

AssessmentModels\

Customization is assessment model

Format: *_assessmentModel.xml


\ConfigurationFiles\

CastConfigurationFiles

CastGlobalSettings.ini file

Format: CastGlobalSettings.ini


\ConfigurationFiles\

CastConfigurationFiles\amt\

AMT job configurations.

Format: AmtJobConfig_*.xml


\ConfigurationFiles\

CastConfigurationFiles\

blackboxes\dotnet\

Inference Engine & dataflow blackbox files for .NET

Format: BlackBoxes_DotNet.xml


\ConfigurationFiles\

CastConfigurationFiles\

blackboxes\j2ee\

Inference Engine & dataflow blackbox files for JEE

Format: BlackBoxes_J2EE.xml


\ConfigurationFiles\

CastConfigurationFiles\

dataflowsecurity\dotnet\

Dataflow Security default specification file .NET 

Format: FlawSpec_DotNet.xml


\ConfigurationFiles\

CastConfigurationFiles\

dataflowsecurity\j2ee\

Dataflow Security default specification file JEE 

Format: FlawSpec_J2EE.xml


\ConfigurationFiles\

CastConfigurationFiles\

J2EE\

JSP Custom tags management configuration

Format: cast-tag.extensions.xml


\ConfigurationFiles\

CastConfigurationFiles\

Languages\

Configuration files for Languages \ Technologies :

  • ABAP
  • ASP
  • BO
  • C
  • COBOL
  • COM
  • DB2
  • DEFAULT
  • DEPHI
  • DOTNET
  • EJASSISTANT
  • HTML
  • IMS
  • JAVA
  • JAVASCRIPT
  • JCL
  • JDOASSISTANT
  • JSP
  • ORACLE FORMS
  • PB
  • PLSQL
  • SQL
  • SSIS
  • SSRS
  • TEXT
  • TIBCO
  • T-SQL
  • UA
  • VB
  • WEB

Format: *.xml


\ConfigurationFiles\

CastConfigurationFiles\

MetricAssistant\

Metric Assistant for :

  • ABAP
  • COBOL
  • CSHARP
  • SQL
  • System

Format : *.xml


\ConfigurationFiles\

CastConfigurationFiles\

Metrics\

Metrics for :

  • Configuration
  • Packages

Format : *.xml


\ConfigurationFiles\

CastConfigurationFiles\

parametrization\

Parametrization file for :

  • COBOL
  • DOTNET

Format : *.xml


\ConfigurationFiles\

CastConfigurationFiles\

Script_Libraries\

Script Libraries

Format : .castscript


\ConfigurationFiles\

CastConfigurationFiles\

Parameterization file for JCL

Format: AdvancedJCL.xml


\ConfigurationFiles\Delivery\

Delivery "data" folder of the selected application

If Export source code option is unchecked then "sources.CastSourcePackage"

present in the delivery folder won't be fetched because this file contains the source

code

The checksum of plugins folder would be taken by the tool.

Format: .PluginsFolderTreeDump


\ConfigurationFiles\Local Delivery\

"Data" folder of the selected application.

 

This folder will be fetched if the delivery is done through AIC Portal

on the same machine where the analysis is done.


\ConfigurationFiles\

Deployment\

Deploy folder of the selected application

 

If Export source code is unchecked

this folder would not be fetched.


\ConfigurationFiles\

CustomCastScripts\

Custom Cast Scripts

Format : *.castscript


\ConfigurationFiles\

DocumentsAndSettings\

CAST AIP Configuration Files :

  • ADGAdmin.ini
  • AnaMan.ini
  • archichecker.properties
  • assembly2bin.ini
  • cast-ms.connectionProfiles.pmx
  • cast-ms.preferences.pmx
  • CWProfileConnection.INI
  • CWSIProfileConnection.INI
  • enlighten.ini
  • GloballySharedSettings.ini
  • LogViewer.ini
  • ServMan.ini

Format: .INI


\ConfigurationFiles\

EnvironmentProfile\

Environment Profiles

Format : .aex


\ConfigurationFiles\

ExternalTools\

Programs referenced in External Tools

Format : .bat, .exe and other applicable formats


\ConfigurationFiles\

IncludePath\

Files referenced in include path
(for J2EE, MAINFRAME and ABAP)

Format : *.h, *.cpy and others applicable formats


\ConfigurationFiles\

Metrics\

CastMetrics.xml

Format: .xml


\ConfigurationFiles\

SQL TableSize\

SQL Table size

Format: .sqltablesize


\ConfigurationFiles\

ClassPath\Jar\

Archive File defined in Classpaths

Format: *.jar


\ConfigurationFiles\

ClassPath\JarPath\

Archive Files defined in Classpaths

Format: *.jar


\ConfigurationFiles\

ClassPath\Path\

Class Root Path defined in Classpaths

\ConfigurationFiles\Dataflow\Dataflow information for Applications

\ConfigurationFiles\

CASTMS\PMX

CASTMS-export.pmx

Format: .CastAppPmx


\ConfigurationFiles\

UA_InstalledLanguages\

UA COE version

Format: .txt


\ConfigurationFiles\

Extensions\

Extensions

Only the managed extensions would be fetched (8.3.x x>=0 and 8.2.x, x>7)

(For CAST AIP 8.2 and above versions)


\ConfigurationFiles\

Extensions\

ExtensionChecksum.castchecksum

Format : .castchecksum

(For CAST AIP 8.2 and above versions)


\ConfigurationFiles\

Extensions\

ExtensionChecksum.castchecksum

Format : .castchecksum

 

If Export Configuration files option is unchecked,

the tool performs a checksum

and produces a castchecksum file.

(For CAST AIP 8.2 and above versions)

Configurationfiles.log
Export Configuration Files summary

Export Computer Environment

ComputerEnvironment.7z

\ComputerEnvironment\

HTML file providing the LISA and LTSA folders size

Format: .HTML

ComputerEnvironment.log

Details of the environment like

  • System information like OS name, version etc
  • Hardware information like processor type, make etc
  • Memory information like total physical memory
  • Hotfix(s) applied in the system
  • Network card related information

Export CAST Bases

Backup.7z

\Backup\



Central, Knowledge and Management Bases

<base name>_<host name>.<backup extension>

  • .cssbackup (CSS)
  • .bak (MS-SQL)
  • shk (ORACLE)

If Export source code is unselected,

the CAST Knowledge Base internal table

DSS_CODE_SOURCES and CAST Central Base internal table

DSS_SOURCE_TEXTS will remain empty.


Measurement Base for AAD

  • .cssbackup (CSS)

Export logs files of Central, Knowledge and Management Bases

  • .log

Database Collation of Central, Knowledge and Management Bases

(for MS SQL Server only)

  • .html


Backup.log
Export CAST bases summary

CAST AAD/AED Folder


\ConfigurationFiles\AAD\

AAD portal content from Application Root Path

(For CAST AIP 8.2 and above versions)

Notes / Comments


Related Pages



  • No labels