Note that these instructions are valid as follows:
- ≤ 8.3.17 - ONLY for PL/SQL extractions - i.e. Oracle schema extractions.
- ≥ 8.3.18 - PL/SQL and T-SQL extractions are also supported - i.e. Oracle, Microsoft SQL Server and Sybase ASE extractions
Introduction
When a database/schema is delivered in V1 from Server A / Instance 1 and is then delivered in V2 from Server B / Instance 2 the default behavior on re-analysis of the same database/schema on a different Server or Instance will consider that the database/schema is in fact two separate databases/schemas even though they have the same name. This causes "noise" when consulting version comparison data (the database/schema will appear as deleted / added between V1 and V2 snapshots), in violation monitoring (removed / added) and it invalidates the content of the Action Plan.
If you find yourself in this situation, you can use various methods provided by CAST that will automatically modify the V2 database/schema extraction data to contain the same Server / Instance name as used in V1. In this way, the database/schema will not be considered new in snapshot V2. The tool must be run BEFORE you generate the V2 snapshot. To do so, use one of the following options
Via a Content Enrichment Tool (automated option run before an analysis)
- In the CAST Management Studio, open the Application containing your Oracle schema Analysis Unit.
- Click the Content Enrichment tab:
- In the Tools before analysis section, click the button and select Add new external program:
- In the configuration panel, fill in the following fields:
1 | Enter a name for the tool "job" - use a name that is easy to distinguish. |
2 | Ensure the Will be processed option is selected |
3 | Enter the path to the CAST-DatabaseExtractionRenamingTool.exe file which can be found in the root of your CAST AIP installation folder. |
4 | Enter the following arguments in the Program arguments field: -INSTANCE_NAME "old_instance_name" -DEPLOYED_PACKAGE_PATH "deployed_package_path" So, for example if the database/schema in V1 was extracted by the CAST Delivery Manager Tool from Instance "INSTANCE_A" and the database/schema extraction in V2 was deployed to the Deployment path "D:\Deploy\MEUDON\PLSQL_PACKAGE", you would enter the following arguments: -INSTANCE_NAME "INSTANCE_A" -DEPLOYED_PACKAGE_PATH "D:\Deploy\MEUDON\PLSQL_PACKAGE" This will modify the V2 extraction data in "D:\Deploy\MEUDON\PLSQL_PACKAGE" and ensure that the instance name is changed to the instance used in V1 (INSTANCE_A). |
- Whenever you run the V2 analysis, the tool job will also be run ensuring that the V2 extraction data is modified to match the V1 instance name.
- Remember to modify the tool "job" in V3 if the schema is being delivered from a new instance in V3.
Using the CAST Database Extraction Renaming Tool
The CAST Database Extraction Renaming Tool mentioned previously can also be run on an "ad-hoc basis", either via the GUI or the CLI:
GUI
The tool can be found at the root of the CAST AIP installation folder: CAST-DatabaseExtractionRenamingTool.exe
- Double click the tool to launch it:
- Fill in the various fields as shown in the table below.
- To start the renaming process, click Application > Run Application on the toolbar
Tab | Field | Description |
---|---|---|
Options | Extraction File Path | Enter the path to the delivery output from the CAST Database Extractor. |
Options | Previous Instance Name | Enter the name of the previous instance name that you would like to use in the new extractation data (optional). |
Options | Previous Server Name | Enter the name of the previous server name that you would like to use in the new extractation data (optional). |
Options | Verbose | By default this option is set to TRUE. When set to true, the log will contain information about the time taken to perform each specific action in milliseconds. This increases the size of the log, but is useful for troubleshooting. |
Advanced | Log Time | By default this option is set to TRUE. This option prefixes each line in the log (whether an external log file or the log displayed in the Log panel windowl), with the date and time of each transaction during an Extraction or Delivery process. The format used is: YYYY-MM-DD HH:MM:SS.millisecond |
Advanced | Log File | This option enables you to have transaction and error messages stored in a specific file on a local or network drive, in addition to the log displayed in the Log panel window. Manually enter a log file name and location - or use the Browse button to search for a location. The log file will be a simple text file. |
CLI
The tool can be found at the root of the CAST AIP installation folder: CAST-DatabaseExtractionRenamingTool-CLI.exe. Please modify the following example batch script to suit your needs and environment:
REM =============================== REM RENAME ACTION REM =============================== CAST-DatabaseExtractionRenamingTool-CLI.exe -root <extraction file path> -instance <previous instance name> -server <previous server name> -l <path to log file> REM =============================== REM EXAMPLE REM CAST-DatabaseExtractionRenamingTool-CLI.exe -root C:\Users\James\deliveryResults -instance INSTANCE_A -server SERVER_A -l D:\output\log.txt REM =============================== REM =============================== REM FULL LIST OF OPTIONS REM =============================== REM -h <Display Help> [false]: displays this help message REM -root <Extraction File Path> [deliveryResults]: UAX Folder Path REM -instance <Previous Instance Name> []: Previous Instance Name REM -server <Previous Server Name> []: Previous Server Name REM -v <Verbose> [true]: Verbose Listing REM -logtime <Log Time> [true]: Log Time REM -l <Log File> []: Log File Path