AWS SchemaConversionTool documentation change
Summary
Complete restructuring of user interface documentation with expanded sections covering project setup, schema conversion workflow, AWS Secrets Manager integration, password storage, and keyboard shortcuts. Added detailed procedural guidance for multiple features.
Security assessment
Added documentation for AWS Secrets Manager integration and encrypted password storage using seed.dat, which are security features. However, there is no evidence of addressing a specific security vulnerability or incident.
Diff
diff --git a/SchemaConversionTool/latest/userguide/CHAP_UserInterface.md b/SchemaConversionTool/latest/userguide/CHAP_UserInterface.md index 0b361c459..03c3fd151 100644 --- a/SchemaConversionTool/latest/userguide/CHAP_UserInterface.md +++ b/SchemaConversionTool/latest/userguide/CHAP_UserInterface.md @@ -5 +5 @@ -# Navigating the user interface of the AWS SCT +The project windowStarting AWS SCTCreating a projectUsing a new project wizardSaving and opening a projectAdding a serverUsing an offline modeUsing tree filtersHiding schemasManaging the database migration assessment reportConverting your schemaApplying the converted codeStoring AWS profilesUsing AWS Secrets ManagerStoring database passwordsUsing the Union All view for projects with partitioned tablesKeyboard shortcuts @@ -7 +7,3 @@ -Use the following topics to help you work with the AWS SCT user interface. For information on installing AWS SCT, see [Installing and Configuring AWS Schema Conversion Tool](./CHAP_Installing.html). +# Using the AWS SCT user interface + +Use the following topics to help you work with the AWS SCT user interface. For information on installing AWS SCT, see [Installing, verifying, and updating AWS SCT](./CHAP_Installing.html). @@ -11 +13,667 @@ Use the following topics to help you work with the AWS SCT user interface. For i - * [Viewing the Project Window in AWS SCT](./CHAP_UserInterface.Overview.ProjectWindow.html) + * The AWS SCT project window + + * Starting AWS SCT + + * Creating an AWS SCT project + + * Using a new project wizard in AWS SCT + + * Saving and opening an AWS SCT project + + * Adding database servers to an AWS SCT project + + * Running AWS SCT in an offline mode + + * Using AWS SCT tree filters + + * Hiding schemas in the AWS SCT tree view + + * Creating and reviewing the database migration assessment report + + * Converting your schema + + * Applying the converted schema to your target DB instance + + * Storing AWS service profiles in AWS SCT + + * Using AWS Secrets Manager + + * Storing database passwords + + * Using the UNION ALL view for projects with partitioned tables + + * Keyboard shortcuts for AWS SCT + + + + +## The AWS SCT project window + +The illustration following is what you see in AWS SCT when you create a schema migration project, and then convert a schema. + + 1. In the left panel, the schema from your source database is presented in a tree view. Your database schema is "lazy loaded." In other words, when you select an item from the tree view, AWS SCT gets and displays the current schema from your source database. + + 2. In the top middle panel, action items appear for schema elements from the source database engine that couldn't be converted automatically to the target database engine. + + 3. In the right panel, the schema from your target DB instance is presented in a tree view. Your database schema is "lazy loaded." That is, at the point when you select an item from the tree view, AWS SCT gets and displays the current schema from your target database. + + + + + + + 4. In the lower left panel, when you choose a schema element, properties are displayed. These describe the source schema element and the SQL command to create that element in the source database. + + 5. In the lower right panel, when you choose a schema element, properties are displayed. These describe the target schema element and the SQL command to create that element in the target database. You can edit this SQL command and save the updated command with your project. + + + + +## Starting AWS SCT + +To start the AWS Schema Conversion Tool, double-click the application icon. + +## Creating an AWS SCT project + +Use the following procedure to create an AWS Schema Conversion Tool project. + +###### To create your project + + 1. Start the AWS Schema Conversion Tool. + + 2. On the **File** menu, choose **New project**. The **New project** dialog box appears. + + + + 3. Enter a name for your project, which is stored locally on your computer. + + 4. Enter the location for your local project file. + + 5. Choose **OK** to create your AWS SCT project. + + 6. Choose **Add source** to add a new source database to your AWS SCT project. You can add multiple source databases to your AWS SCT project. + + 7. Choose **Add target** to add a new target platform in your AWS SCT project. You can add multiple target platforms to your AWS SCT project. + + 8. Choose the source database schema in the left panel. + + 9. In the right panel, specify the target database platform for the selected source schema. + + 10. Choose **Create mapping**. This button becomes active after you choose the source database schema and the target database platform. For more information, see [Creating mapping rules](./CHAP_Mapping.html). + + + + +Now, your AWS SCT project is set up. You can save your project, create database migration assessment report, and convert your source database schemas. + +## Using a new project wizard in AWS SCT + +You can create a new database migration project using the new project wizard. This wizard assists you in determining your migration target and connecting to your databases. It estimates how complex a migration might be for all supported target destinations. After you run the wizard, AWS SCT produces a summary report for the migration of your database to different target destinations. You can use this report to compare possible target destinations and choose the optimal migration path. + +###### To run the new project wizard + + 1. Choose your source database. + + 1. Start the AWS Schema Conversion Tool. + + 2. On the **File** menu, choose **New project wizard**. The **Create a new database migration project** dialog box opens. + + 3. To enter the source database connection information, use the following instructions: + +Parameter | Action +---|--- +**Project name** | Enter a name for your project, which is stored locally on your computer. +**Location** | Enter the location for your local project file. +**Source type** | Choose one of the following options: **SQL database** , **NoSQL database** , or **ETL**. If you want to see the summary report that includes all the migration destinations, choose **SQL database**. +**Source engine** | Choose your source database engine. +**Migration strategy** | Choose one of the following options: + * **I want to switch engines and optimize for the cloud** – This option converts your source database to a new database engine. + * **I want to keep the same engine but optimize for the cloud** – This option keeps your database engine as is and moves the database from on-premises to the cloud. + * **I want to see a combined report for database engine switch and optimization for the cloud** – This option compares the migration complexity of all available migration options. +If you want to see the aggregated assessment report that includes all migration destinations, choose the last option. + + 4. Choose **Next**. The **Connect to the source database** page opens. + + 2. Connect to your source database. + + 1. Provide your connection information for the source database. The connection parameters depend on your source database engine. Make sure the user that you use for the analysis of your source database has the applicable permissions. For more information, see [Sources for AWS SCT](./CHAP_Source.html). + + 2. Choose **Next**. The **Choose a schema** page opens. + + 3. Choose your database schema. + + 1. Select the check box for the name of schemas that you want to assess and then choose the schema itself. The schema name is highlighted in blue when selected and the **Next** button is available. + + + + 2. If you want to assess several database schemas, then select the check boxes for all the schemas and then choose the parent node. For a successful assessment, you must choose the parent node. For example, for a source SQL Server database, choose the **Databases** node. The name of the parent node is highlighted in blue and the **Next** button is available. + + + + 3. Choose **Next**. AWS SCT analyzes your source database schemas and creates a database migration assessment report. The number of database objects in your source database schemas affects the time it takes to run the assessment. When complete, the **Run the database migration assessment** page opens. + + 4. Run the database migration assessment. + + 1. You can review and compare the assessment reports for different migration targets or save a local copy of the assessment report files for the further analysis. + + 2. Save a local copy of the database migration assessment report. Choose **Save** , then enter the path to the folder to save the files, and choose **Save**. AWS SCT saves the assessment report files to the specified folder. + + 3. Choose **Next**. The **Choose a target** page opens. + + 5. Choose your target database. + + 1. For **Target engine** , choose the target database engine that you decide to use based on the assessment report. + + 2. Provide your connection information for your target database. The connection parameters that you see depend on your selected target database engine. Make sure the user specified for the target database has the required permissions. For more information about the required permissions, see the sections that describe permissions for target databases in [Sources for AWS SCT](./CHAP_Source.html) and [Permissions for Amazon Redshift as a target](./CHAP_Converting.DW.html#CHAP_Converting.DW.ConfigureTarget). + + 3. Choose **Finish**. AWS SCT creates your project and adds the mapping rules. For more information, see [Creating mapping rules](./CHAP_Mapping.html). + + + + +Now you can use the AWS SCT project to convert your source database objects. + +## Saving and opening an AWS SCT project + +Use the following procedure to save an AWS Schema Conversion Tool project. + +###### To save your project + + 1. Start the AWS Schema Conversion Tool. + + 2. On the **File** menu, choose **Save project**. + +AWS SCT saves the project in the folder, which you specified when you created the project. + + + + +Use the following procedure to open an existing AWS Schema Conversion Tool project. + +###### To open your project + + 1. On the **File** menu, choose **Open project**. The **Open** dialog box appears. + + 2. Choose the project folder and then choose the Windows Script Component (*.sct) file. +