Kushal Tutorials - Document
In this section, the process of Configuring Project Details is explained.
Prerequisites for Creating a New Project in Kushal
The following software should be installed in your PC, before creating a Kushal Project.
- Visual Studio 2015 and Above
- SQL Server 2008 and Above
Note: SQL Server 2008 should be installed in Mixed Mode Installation (Multi-User Login).
- MySQL Version 5.0 and above is preferred.
- MySQL connector - 6.2 and above is preferred.
- SQLCE 4.0
- SQLite 3.2 and above is preferred
- .NET Framework 3.5 and Above
- MS Office 2007 and Above
- MyFYI or RDL Setup
- INNO Setup Compiler
- IS Tool
Before Developing the Project in Kushal, you need to keep your database schema ready. Kushal supports both file-based database and server-based database. If database schema modifications are done after you start development using Kushal, you will need to make the corresponding changes manually, in the generated application, and this can be quite overwhelming even to advanced Kushal users.
File-based database - SQLite, MS Access, SQLCE
Server-based database - MySQL, MS SQL
To create a new Kushal Project, Click the Start button.
In the window that opens, click New File.
This opens the Project Details Wizard.
Project Details Tab
Kushal Project Settings can be entered in Project Details Screen while creating a new Project.
To set Project Details, click New Project, or Project Details Tool in the Ribbon.
Project Name - Specify the name of the Project here. The Project name should begin only with any letter of the alphabet. The name should not contain any special character and space is not allowed. If you need to give a separator, use underscore. This name will be your Project Solution Name, Project Path, and Namespace Name.
Example - Project_Details_Manager
Display Name: The name provided as display name will be your Project Display Name on the screen Title Bar; This cannot have special characters, but space is allowed;
Company Name - By default ABC & Co is provided. You have to specify your company name here.
Project Version - By Default, it starts with 126.96.36.199. Later, when the project progresses, you can change the version precision. Only Integer values are allowed in the four text boxes. You may change it according to your project. The first textbox indicates the major version number and subsequent text boxes indicate minor version numbers.
Project Folder - By default, Kushal assumes â€˜C:\Kushalâ€™, as the output project folder path. You may change it if required. Note that when you generate source code, a folder with Project File name gets generated in this folder.
For instance, if we give â€˜Samplesâ€™ as Project name, the source code will get generated in â€˜C:\Kushal\Samplesâ€™ directory.
If you want to specify a different folder, click on theBrowse button and provide a different location path.
User Management- The User Management option helps you to create an application with user login credentials. Check this box if you want to apply user management feature to your project. Click here to know more. [User management Link]
Fixed Database- The fixed database option will make the application work on the specific database provided by you at design time.
Fixed Database Name- Enter the database name which you want to use at runtime in the application.
Version Controller Table Name - When you create any plugin applications in Kushal, and such applications are used along with the current project, there is a need to differentiate the version controller table name. In such cases, enter the name of such a table in Version Controller Table Name. When the application version is updated, the table mentioned here will be taken into consideration, and any the clashes will be prevented.
Select Database- Select a database from the drop-down and give the connection details of the database.
Select SQLite from the drop-down.
Database File - Click Browse to locate the database file.
Password - Provide a password if the database file is password protected.
Click on Test Connection button to test if the given credentials are valid.
File Extension - A File extension will be asked only in case you have selected a file-based database (MS Access, SQLite, SQLCE). The end application will be creating a new database file for every project you create, using the extension provided here. The given extension name should be an alpha-numeric character and the length should be 3 characters. Avoid giving popular file extensions like DOC, DWG, PDF, etc.
Note: (If you use SQLCE as a database) -
If you created SQLCE database file in version SQLCE 3.5, then you need to upgrade it to 4.0. To do so, select the database SQLCE 3.5 file, enter its credentials and click Test Connection; Then click Upgrade to 4.0 button, select the destination path and enter the new version file name. Click on Upgrade.
For Server-Based Database (MySQL / MS SQL):
Enter all the field values like Server name,Database name, Port Number, User Name, and Password.
By default, Port Number field takes the port number of the local system.
(Ex - For MySQL: 3306 and MS SQL: 1433)
Click on Test Connection button to test if the given credentials are valid.
Note: For MySQL and MSSQL, the database connection requires connectors, as well as the referencing files, to be present on your machine.
Click Save to save the database credentials.
Main Form Settings Tab
Application Default Font - When a new project is created, the Font Settings are taken from Preferences. By default, the font â€œSegoe UIâ€ and font size â€œ9.75â€ is set in Kushal. If you change the default font in Preferences, it will be applied when you create a new project and applied to all form controls throughout the project. You can change font styles for each project you create in Kushal.
Application Icon - This option sets an icon for the Application. To set an icon, clickBrowse and choose any *.ico file. ClickPreview to see the preview of the selected image. Use the X button to remove the icon.
Main Form Image - This option sets an image to the applicationâ€™s Main Form. To add an image, click Browse and choose any *.jpeg, *.jpg, *.png or *.gif file. Click Preview to see the preview of the selected image. Use the X button to remove the icon.
Main Form Icon - This option sets Icon for the Main Form. To add an image, clickBrowse and choose any *.ico file. ClickPreview to see the preview of the selected image. Use the X button to remove the icon.
Main Form Color - This option sets the background color to the Main Form. Select a color from the color palette.
Main Form Image Layout - These options are used to change the appearance of the image on the Main form.
Control Setting - This option is to set the Mandatory field, Read-only field, Calculated field, and Excel Export First filed color in the Form. Select a color from the color palette.
Other Settings Tab
ToolTip Delay- Enter time delay (in milliseconds) to display tooltips on controls (Ex: 5000 =5 sec).
Encryption Key- Encryption Key option secures the data in the database as a password does. Once you start the project this key should not be changed. If you change it affects user management, logins, passwords, and protect file concepts.
If u need to change the Encryption key, then change the key to what you want and change the same thing in protect file table of the running user database (client-side database), and also regenerate the userâ€™s passwords through code using â€˜EncryptDecryptâ€™ class which is available in Kushal generated code, the path of which may be like C:\ Kushal\[Projectname]\src\[Projectname]\Kushal
For more information on how to connect a particular type of database to Kushal, please see the sections below.
To change the Encryption key, click on the Generate Button.
Splash Screen Delay: This is the time delay set to the Initial Splash screen of the application. Enter the time in milliseconds. Splash screen gets displayed whenever a Kushal generated application launches. Subsequently, the applicationâ€™s main form is loaded.
Auto Closing Message Box Delay- : Time delay (in milliseconds) should be set for auto-closing the message-box used in the application. For example, whenever you save data in the end application, a confirmation message of data saved successfully is shown by a message box, which closes after the elapsed time.
After entering all the details of the project, click the Save button. In the specified path, a folder with the name â€œProjectsâ€ is created containing the project file.
The Project file will be saved in â€˜C:\Kushal\Projectsâ€™ Folder by default unless you have not provided any other location for the Project folder.
When a new file is created, some tables will be initially loaded with values, provision to generate InitialDB automatically.
It will especially save the time of the end user in adding values to some commonly used forms.
For instance, Masters like Country, State, and Place master will usually have the same data in all the files created. The end user has to enter the data into the mentioned masters each time the new file is created. To save time consumed for the same, some tables will be initially loaded with values, which is the provision to generate InitialDB automatically.