Installation & Activation

Documentation | Installation & Activation

IMPORTANT TROUBLESHOOTING UPDATE
If you are having issues with Activation Wizard not displaying on the first debug app run, try the following potential fixes:
* Make sure that GisLicense is NOT referenced in your project before the first app run (e.g., through the “uses GisLicense” import).
* Remove older registry entries from Computer\HKEY_CURRENT_USER\Software\TatukGIS and reinstall DK.

This page provides setup information for versions 100 and later. For installation instructions for legacy versions, please refer to the Installation & Activation (Version 99 and earlier) page.

All versions of the Developer Kernel share the same setup logic:

1. Download the software
2. Upon downloading, an email with a subject similar to “TatukGIS: Serial Number for TatukGIS DK” is sent to the licensed user's registration email address.
3. Enter the received serial number when prompted upon running the product setup.
4. When asked for Create desktop item, we suggest leaving this box checked. Then, the setup will create a shortcut on the desktop, providing easy access to the Developer Kernel folders.

The Developer Kernel requires activation before it can be used.

The Activation Wizard will appear automatically the first time any code using Developer Kernel is executed with a debugger attached.

This process validates your license and generates a GisLicense file necessary for running applications without a debugger.

Open your development environment (e.g., Visual Studio, Rad Studio) and run the application that integrates Developer Kernel with the debugger attached.

The Activation Wizard will launch automatically on the first run. Enter your License Code when prompted. Once validated, a GisLicense file will be generated and saved within your user directory.

After activation, Developer Kernel will be fully functional for development purposes. Developer Kernel stores a run-time license in a registry so the product can be used out of the box without any special treatment.

To run an application that uses Developer Kernel without a debugger or deploy it on another machine, a valid license code must be embedded within the application's code.

A GisLicense file, used for license embedding, is automatically created during the activation process when the application is run with the debugger attached.

For platform-specific instructions, please refer to the relevant sections: Delphi Specific, .NET Specific, ActiveX Specific, and Java Specific.

The setup creates all required paths. So, starting to use the Developer Kernel should be effortless. Please, however, ensure that you do not mix the DK11 and a previous DK version in the same environment, which can result in selecting an improper library version.

There is a way, however, to run the DK11 in a separate environment:

1. Quit this setup.
2. Create a shortcut to your RAD Studio and change Target similar to:
   

   "c:\Program Files (x86)\Embarcadero\Studio\18.0\bin\bds.exe" -rDK11

3. Start RAD Studio from the link at least once so RAD Studio will create all required registry keys.
4. Run setup again providing additional parameter:
   

   /customreg=DK11

5. Now, all the DK11 stuff will be installed only in this dedicated environment.
6. If you want to revert and install in a regular environment, delete the registry entry like this one:
   

   HKEY_CURRENT_USER\SOFTWARE\Embarcadero\DK11\18.0

1. Files with license code can be found in a program group and are typically located at

   %LOCALAPPDATA%\TatukGIS\DK for Delphi.xyz\License

2. If you are a Delphi developer, then add a GisLicense.pas to your Delphi uses (preferably on your application's main form)
3. If you are a C++Builder developer, add GisLicense.hpp as one of the first included headers on your main form code.

To enable optional SKIA rendering, right-click and choose “Enable Skia”. If used RAD Studio does not contain Skia support - install it from GetIt or directly from skia4delphi.org.

An easy way to update assemblies is to use NuGet packages (including Unstable). First, a setup must be used. Switching between versions is provided via NuGet. Activation, samples, and deployment packages (including grid-shift files) are available only in regular setup files.

• NuGet retail distribution Packages:
  • add a NuGet source https://nuget.tatukgis.com/nuget directly from Visual Studio,
  • or run a command-line utility:
    • download NuGet command line from https://dist.nuget.org/win-x86-commandline/latest/nuget.exe,
    • and execute:

      nuget sources Add -Name "TatukGIS" -Source https://nuget.tatukgis.com/nuget

  • Provide your TatukGIS credentials upon request.
  • in a case that a credential must be changed, use NuGet CLI:

    NuGet Sources Update -Name "TatukGIS" -Source "https://nuget.tatukgis.com/nuget" 
      -UserName "your login email" -Password "your new password"

  • Unstable versions are removed from the archive after releasing a Retail version;
  • Daily versions are removed from the archive after releasing a Unstable or Retail version.
• Trial packages are available from the official nuget.org feed.
• .NET Core & Standard packages are available only via NuGet!
• Please remember to save your project/sample as a solution (.sln). Otherwise NuGet Package Manager cannot be opened.

For several reasons (e.g., somewhat tricky setup routines), we do not automatically add the Developer Kernel into the Visual Studio toolbox. To do this manually:

1. Run Visual Studio.
2. Right click on a Toolbox, then choose Select Items …
3. Click Browse in .NET Framework Components tab.
4. Select TatukGIS_DK11.dll, which may be located in the installation folder (use the desktop icon to find it!), but may also be located in:
   

   c:\Program Files (x86)\TatukGIS\DK for .NET\Lib

5. Click OK. Now the components should be visible in the Toolbox.

Please note that if you add a NuGet package, those steps are not required - the toolbox will be automatically updated (at least in VS2019).

1. Files with the license code can be found in the program group and are typically located at:

   %LOCALAPPDATA%\TatukGIS\DK for .NET\License

2. Add GisLicense.cs or GisLicense.vb to your project.
3. Before first use/initialization of the Developer Kernel (before calling InitializeComponents()), call:
   

   //C#
   static void Main()
   {
     TatukGIS.NDK.GisLicense.Initialize(); // <--- ADD THIS LINE
    
     Application.EnableVisualStyles();
     Application.SetCompatibleTextRenderingDefault(false);
     Application.Run(new WinForm());
   }

   'VisualBasic
   Shared Sub Main()
     TatukGIS.NDK.GisLicense.Initialize() '<--- ADD THIS LINE
    
     Application.EnableVisualStyles()
     Application.SetCompatibleTextRenderingDefault(false)
     Application.Run(New WinForm())
   End Sub
    
   'or create a New() procedure on the main form
   Public Sub New()
     TatukGIS.NDK.GisLicense.Initialize() '<--- ADD THIS LINE
    
     ' This call is required by the designer.
     InitializeComponent()
     ' Add any initialization after the InitializeComponent() call.
   End Sub

   // for other .NET languages run the code like this somewhere in the early 
   // stage of application initialization (before use of any GIS functionality)
   
   TatukGIS.NDK.TGIS_Utils.SetLicense(
     "content of the License - for example, copied for GisLicense.cs"
   )

To enable optional SKIA rendering, the project must include the NuGet package SkiaSharp (NuGet Gallery | SkiaSharp).

• Typical deployment is just copying the app to the server.
• Upon deploying the application remember to activate the application for a specific web address (eg. test.mydomain.com) and use aliases using Activate Deployment app, which is usually aceessible from the program icon on the desktop.
• The created .license file must be copied to a bin folder (or app folder, in case it is on .NET Core).

To enable optional SKIA rendering, the project must include the NuGet package SkiaSharp (NuGet Gallery | SkiaSharp).

ASP.NET Core packages are available only via NuGet. To use them, a setup must first be used: activation, samples, and deployment packages (including grid-shift files), which are available only in regular setup files.

• NuGet retail distribution Packages:
  • add a NuGet source https://nuget.tatukgis.com/nuget directly from Visual Studio,
  • or run a command-line utility:
    • download NuGet command line from https://dist.nuget.org/win-x86-commandline/latest/nuget.exe
    • and execute:

      nuget sources Add -Name "TatukGIS" -Source https://nuget.tatukgis.com/nuget

  • provide your TatukGIS credentials upon request.
  • in a case that a credential must be changed, use NuGet CLI:

    NuGet Sources Update -Name "TatukGIS" -Source "https://nuget.tatukgis.com/nuget" 
          * Unstable versions are removed from the archive after releasing a Retail version;
          * Retail versions are removed from the archive after releasing a Unstable or Retail version.  
        * Trial packages are available from the official nuget.org feed.
      -UserName "your login email" -Password "your new password"

Every file connected with the Developer Kernel software for Java is installed in the path:

• Windows:

  %LOCALAPPDATA%\TatukGIS\DK for Java\

• Linux/MacOS:

  ~/TatukGIS.DK for Java/

To add our Controls to NetBeans IDE, you need to:

1. Open NetBeans designer
2. Right-Click on the palette
3. Select “Palette Manager…”
4. Add “New category…”
5. Name it, for example, “TatukGIS”
6. Click “Add from Jar…”
7. Select DK jar file located in catalog lib in the installation path
8. Select “Show Marked JavaBeans”
9. Select all controls
10. Click next
11. Select a category in which you want the controls to appear.
12. Finish process

1. Files with the license code can be found in the program group and are typically located at:
   • Windows:
     

     %LOCALAPPDATA%\TatukGIS\DK for Java\License\GisLicense.txt

     or
     

     %LOCALAPPDATA%\TatukGIS\DK.Java\License\GisLicense.txt

   • Linux/MaxcOS:
     

     $/TatukGIS/DK for Java/License/GisLicense.txt

     or
     

     $/TatukGIS/DK.Java/License/GisLicense.txt

2. At application startup call:

   public static void main(String args[]) {
     // call it before calling and other TatukGIS code
     TGIS_Utils.SetLicense( "content of the License file" );
    
     // rest of the code 
     ...
   }

Samples can be opened and run using NetBeans, Eclipse, or IntelliJ IDEA. Do not change the folder organization!

• NetBeans:
  open the project and go to the samples directory.
• Eclipse:
  Set workspace to samples directory, then select “Open Projects from File System”.
• IntelliJ IDEA:
  Select “Import Project” at the startup window, and leave defaults options in the wizard dialog. Go to “Project Structure” in the File menu and, in the “Libraries” section, add tatukgis.jdk.jar from <installation-folder>\Lib\

1. Files with license code can be found in the program group and are typically located at:

   %LOCALAPPDATA%\TatukGIS\DK for .ActiveX\License\GisLicense.txt

2. Before first use/initialization of the Developer Kernel (preferably just in your app main() procedure), execute code similar to:
   

   (new TGIS_Utils()).SetLicense(license_activation_code);

• Retail distribution packages:
  • availably free of charge on PyPu use:

    pip install tatukgis_pdk

• Unstable distribution packages:
  • https://pypi.tatukgis.com/packages/unstable/simple/
    Available only to customers that licensed any other DK edition.
    The required login is the same as the login to our website.
• Daily distribution packages:
  • https://pypi.tatukgis.com/packages/daily/simple/
    Available only to customers that licensed any other DK edition.
    The required login is the same as the login to our website.
• Unstable versions are removed from the archive after releasing a Retail version;
• Daily versions are removed from the archive after releasing a Unstable or Retail version.

When using UNSTABLE or DAILY builds in the PyCharmelect Basic Authentication and carefully provide credentials. Improper credentials can cause a ban for several minutes because PyCharm frequently uses them.

The product is available free of charge - activation is not required.