Project Setup
Get started with a new project or open an existing project
Last updated
Get started with a new project or open an existing project
Last updated
When you first launch the Snowpark Migration Accelerator (SMA), the first screen will ask you whether you'd like to Start working on a project or Activate the tool with an access code (for conversion only).
Each option is defined here:
Start - This will take you to the Project Page where you can choose to start a new project, open an existing project, and run through a sample project.
Activate - The activate page will take you to the activation page. On this page, you can enter an access code (if you have one) or request one if you or your organization has a code available.
Note that if you have input an access code on some point, you will not see this screen. The application will open to the Project Page described below.
On the project page, you will see three options:
There are three options to choose from on this page:
Open Project - If you have created a project before, then you've created a project file. You can browse for a project file you've previously created on this page. You can find more information on opening an existing project below.
New Project - Choosing this option will take you to the Project Creation page. More on creating a new project below.
See sample project - You have the option to run through a sample project at this point. There is a separate page dedicated to running the sample project in the SMA.
Selecting New Project will take you to the project creation screen.
In the Project Creation page, there are several fields.
Project Name: This is the name for your project file. Multiple executions can be connected to a single project as well as any settings you save. You can learn more about the project file below.
Input Folder Path: Specify the directory where your source codebase is located. Note that only certain file extensions will be analyzed by the application. A couple of notes on the input folder path:
You have the option to choose a subdirectory to analyze if you would not like to analyze every folder in the chosen directory. Choosing one of the radial buttons next to the folder names will expand the folder to allow you to choose a specific subfolder or even a specific file.
Note: Hovering on the path label will show a tooltip with the full path, this applies to any field that contains a shortened path (input folder path, output folder path, etc.).
The .snowma project file will be placed in this directory when the project is created. More on this folder below.
Output Folder Path: The directory where the output files (logs, reports, code [in conversion mode]) will be placed.
SQL Language: Choose SparkSQL or HiveSQL, depending on your codebase. (Optional)
Email Address: This email address identifies the user of the tool in lieu of a license. Note that this email will not be spammed by Snowflake, but will be where you will receive the snowpark qualification report email and where your conversion access code will be sent if you are moving on to conversion mode.
Customer's Company: This is to help you specify the organization's code you are working with. If you are running your own code, then put your own organization here. If you are working with another organization, then put that organization name here. This will also help you organize projects based on the organization's code you are analyzing.
All of these fields are necessary to run the tool.
When you have finished setting up your project, you can choose to "Save & Start Assessment", "Save & Skip Assessment", or "Cancel".
Choosing whether to start or skip the assessment depends on whether you are moving straight on to conversion at this step. If you're not sure, then you should start the assessment.
Cancelling will take you back to the main screen. If you do not cancel and regardless of whether you start or skip, your project settings will be saved in a .snowma file. This project file will allow you to reopen a session with the same settings as you declared in this project.
The .snowma file stores all of your project information. You can not only run additional executions of the tool with the same settings, but you can view past assessment data from previous executions.
Each time that you click on "Save & Skip Assessment" or " Save & Start Assessment" a project file (with the extension .snowma) will be created in the same folder that you chose as the input folder that contains the source code that you want to convert. This project file will appear in your file browser with the SMA icon:
As a user, you will be able to:
Open a project by double-clicking the .snowma file
Open a project by clicking on "Open Project" on the main screen
Clicking on File -> Open Recents, will show you the list of projects that you recently open in the SMA:
Once you execute any of these flows the tool will redirect you to the same state of the tool that you were executing when you closed the tool.
From the main screen if you choose Open Project, it will launch your file browser. Choose an existing project file with a .snowma extension. This will open the Project Creation page regardless of what part of your project you have completed.
From the Project Creation page, you can use the navigation panel to select any screen you've already visited.
Assuming you are still on the Project Creation screen, you can select "Save & Start Assessment" to run the accelerator.
The next page focused on the settings you can choose when using the application.
