Installation Manual THINC API
User Manual:
Open the PDF directly: View PDF 
.
Page Count: 57
| Download | |
| Open PDF In Browser | View PDF |
THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 THINC-API Installation Manual Document No.: S5015-007-10 Confidential Okuma America Corporation 2018 Page 1 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 Revision History Date Version Description Author 05/10/2007 S5015-007-00 Installation Manual LHuynh 10/05/2007 S5015-007-01 Add Installation For Custom Application section LHuynh 2/22/2008 S5015-007-02 Add 4.3, 4.4 section and revise section 7.2. Change name of release note for Lathe and MC and installation manual to actual name (LatheReleaseNote/MCReleaseNote, InstallationManual) LHuynh 4/11/2008 S5015-007-03 - Revise section 3.0 Requirement LHuynh - Revise section 3.1 Compatibles - Revise section 4.1.1 Run Setup - Revise section 4.1.2 Setup Type - Revise section 4.3 Install License File - Revise section 4.4.1.2 Validation - Remove section 4.4.1.3.2 OSP System software - Revise 5.1.1.1 Setup - Revise section 7.2 License -Revise section 7.3 Best Practice 6/02/2008 S5015-007-04 - Revise section 4.3 Install license file LHuynh - Revise section 5.1.1 Repair 10/27/2008 S5015-007-05 Revise 4.1.5 Finish LHuynh Revise 4.2.5 Finish Revise 5.1.1.3 Finish 02/14/2014 S5015-007-06 Revised all THINC API to THINC-API LHuynh 11/17/2015 S5015-007-07 Revised for public release 1.18.0.0 LHuynh 11/17/2016 S5015-007-08 Revised for public release 1.19.0.0 LHuynh Sessions: 1.4, 4.0, 4.5, 6.0, 7 08/07/2017 S5015-007-09 Revised for public release 1.20.0.0 LHuynh Sessions: 3.1, 4.2, 4.5.2.4, 6.1 03/07/2018 S5015-007-10 Revised for public release 1.21.1.0 LHuynh Sessions: Confidential 3.1 Compatibles 4.2 Desktop Installation Okuma America Corporation 2018 Page 2 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 4.5.1.2 Validation 4.5.2.4 Logging Service for .NET Framework 4.0 THINC-API libraries 6.1 Confidential Machine Installation Okuma America Corporation 2018 Page 3 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 Table of Contents 1. Introduction 6 1.1 1.2 1.3 1.4 6 6 6 6 Purpose Scope Definitions, Acronyms, and Abbreviations Overview 2. References 6 3. Requirements 6 3.1 6 4. 5. Compatibles Installation Instruction 7 4.1 Machine/NC Master Installation 4.1.1 Run Setup 4.1.2 Setup Type 4.1.3 Setup 4.1.4 Installing 4.1.5 Finish 4.2 Desktop Installation 4.2.1 Run setup 4.2.2 Setup Type 4.2.3 Setup 4.2.4 Installing 4.2.5 Finish 4.3 Upgrade Installation 4.3.1 Run setup 4.3.2 Installing 4.3.3 Finish 4.4 Install License file 4.5 Validate Installation 4.5.1 THINC-API Libraries 4.5.1.1 Run THINC sample application 4.5.1.2 Validation 4.5.1.3 Errors 4.5.2 Logging Service & Logging Service Client Application 4.5.2.1 Logging Service 4.5.2.2 Logging Library 4.5.2.3 Logging Service Client Application 4.5.2.4 Logging Service for .NET Framework 4.0 THINC-API libraries 7 7 9 9 10 11 12 12 13 14 14 15 15 16 17 18 19 19 19 19 19 23 33 33 36 36 37 Repair/Uninstall THINC-API 38 5.1 38 39 39 42 43 43 43 Repair/Un-install 5.1.1 Repair 5.1.1.1 Run Setup 5.1.1.2 Setup 5.1.1.3 Finish 5.1.2 Uninstall 5.1.2.1 Run setup Confidential Okuma America Corporation 2018 Page 4 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 5.1.2.2 Setup Status 5.1.2.3 Finish 6. 7. 46 47 Installation Files 48 6.1 Machine Installation 6.1.1 Lathe 6.1.1.1 GAC Folder 6.1.1.2 Okuma Folders 6.1.2 Machining Center 6.1.2.1 GAC Folder 6.1.2.2 Okuma Folders 6.1.3 Grinder 6.1.3.1 GAC Folder 6.1.3.2 Okuma Folders 6.2 Desktop Installation 49 49 49 49 50 50 50 50 50 51 51 Installation for Custom Application 52 7.1 7.2 7.3 7.4 7.5 52 53 55 55 55 THINC-API Spec. Code License Installation Public Release Best Practice Confidential Okuma America Corporation 2018 Page 5 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 Installation Manual 1. Introduction 1.1 Purpose The purpose of this document is providing the instruction of how to install THINC-API on machine, NC Master, and desktop PC. It also provides information on how to repair and uninstall THINC-API. 1.2 Scope This installation will cover installing THINC-API for different machine types, and desktop PC. 1.3 Definitions, Acronyms, and Abbreviations GAC – Global Assembly Cache Windows folder located in ‘C:\WINDOWS\assembly’ 1.4 Overview The THINC-API setup application will automatically detect if this installation is for Machine/NC master or desktop PC. - The Machine/NC Master installation will install: THINC-API document, and sample application using THINC-API THINC-API libraries to enable building and running THINC-API application to run. - Desktop installation will installs all THINC-API libraries, sample application, help file THINC-API document, and sample application using THINC-API THINC-API libraries to enable building THINC-API application. The THINC-API setup application also detects and installs the correct THINC-API library files for lathe, machining center, and grinder when installing for Machine/NC Master. For desktop installation, all libraries can be installed altogether if needed 2. References None 3. Requirements The THINC-API setup application requires running under Administrator user account only. It also requires to run under Windows mode only (NC is not running). If NC is running, it requires rebooting the machine to Windows mode. 3.1 Compatibles THINC-API must be installed on the OSP-P100II/P200 or newer OSP-P controls in order to access to machine data. It requires .NET framework 4.0 for Lathe, Machining Center and Grinder. THINC-API has been tested on the following platforms: - Microsoft Windows XP Professional Embedded with SP3 Confidential Okuma America Corporation 2018 Page 6 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 - Microsoft Windows 7 x86 with SP1 THINC-API libraries can be used with Microsoft Visual Studio 2010 or newer Visual Studio version to develop custom Windows application. 4. Installation Instruction 4.1 Machine/NC Master Installation 4.1.1 Run Setup Run the THINC-API-Setup.exe program from the provided installation disk on Machine/NC Master During this stage, the installation will evaluate OSP system file to ensure that it can support current installation. If not, the setup will generate an error message and terminate the installation. Confidential Okuma America Corporation 2018 Page 7 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 Press Next to advance to the next page Confidential Okuma America Corporation 2018 Page 8 of 57 THINC-API Installation Manual 4.1.2 Version: S5015-007-09 Date: 03/07/2018 Setup Type Select the appropriate option and click Next to continue with the installation process. 4.1.3 Setup Confidential Okuma America Corporation 2018 Page 9 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 In this setup dialog, information on the selected options will be displayed. Click Next to continue with the installation process or click Back to review/ change any settings. 4.1.4 Installing Confidential Okuma America Corporation 2018 Page 10 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 At any time, you can press Cancel button to terminate the installation. 4.1.5 Finish Confidential Okuma America Corporation 2018 Page 11 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 Click Finish to just finish the installation process. 4.2 Desktop Installation All 3 libraries for Lathe, Machining Center, and Grinder can be installed when desktop installation is detected. The installation will consider desktop installation when there is no OSP-P folder on C drive. All libraries and applications will be installed for each selection of machine types. Note: An upgrade installation might not be able to install all 3 libraries if the previous version of THINCAPI installed on desktop is 1.18.0.0 or older. D drive is also required for Desktop Installation 4.2.1 Run setup Run the THINC-API-Setup.exe program from the provided installation disk on desktop PC. Confidential Okuma America Corporation 2018 Page 12 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 Press Next to advance to the next page 4.2.2 Setup Type Confidential Okuma America Corporation 2018 Page 13 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 Select the appropriate option and click Next to continue with the installation process. 4.2.3 Setup In this setup dialog, information on the selected options will be displayed. Click Next to continue with the installation process or click Back to review/ change any settings. 4.2.4 Installing Confidential Okuma America Corporation 2018 Page 14 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 At any time, you can press Cancel button to terminate the installation. 4.2.5 Finish Click Finish to just finish the installation process. 4.3 Upgrade Installation If the target machine or PC already has the previous version THINC-API then the installation will enter the Confidential Okuma America Corporation 2018 Page 15 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 upgrade installation mode. 4.3.1 Run setup Run the THINC-API-Setup.exe program from the provided installation disk on Machine/NC Master Click “Yes” button to perform upgrade THINC-API to the newer version During this stage, the installation will evaluate OSP system file to ensure that it can support current installation. If not, the setup will generate an error message and terminate the installation. Confidential Okuma America Corporation 2018 Page 16 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 Press Next to advance to the next page 4.3.2 Installing Confidential Okuma America Corporation 2018 Page 17 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 At any time, you can press Cancel button to terminate the installation. 4.3.3 Finish Click Finish to just complete the installation process. Confidential Okuma America Corporation 2018 Page 18 of 57 THINC-API Installation Manual 4.4 Version: S5015-007-09 Date: 03/07/2018 Install License file When THINC-API Setup program runs it will install either demo or permanent license version (Okuma.api.lic). It is best to obtain the license file that supports the latest release of THINC-API libraries version although your application only requires an older THINC-API version. License file can also manually copy to the D:\Program files\Okuma\License folder. By default, the current version of installation will always copy the license file included with the Setup to the destination folder. Note: Each Public Release of THINC-API always has a license file that supports the latest version of all THINC libraries. All applications developed with THINC-API use the same license file as long as THINCAPI library version that your application compiled with is less than or equal to library version in the license file. 4.5 Validate Installation 4.5.1 THINC-API Libraries For machine/NC Master installation, the test sample application can be run to ensure that THINC-API libraries can be supported under current machine configuration. By design, THINC-API libraries are tightly integrated with NC OSP System software. Therefore, a certain file version of NC OSP System files must be met in order to support all functions in the libraries. Note: Per function call in the libraries also depends on machine options, spec. code, NC Control software version etc… 4.5.1.1 Run THINC sample application Based on OSP Software System files, the Setup program will only install the appropriate libraries. It will install either Lathe/Machining Center/Grinder libraries. Using Windows Explore to navigate to D drive and subfolder: Lathe: D:\Program Files\Okuma\THINC API\ThincLathe\bin MC: D:\Program Files\Okuma\THINC API\ThincMC\bin Grinder: D:\Program Files\Okuma\THINC API\ThincMC\bin Run THINC sample application by double clicking on ThincLathe.exe, ThincMC.exe, and ThincGrinderApp.exe for Lathe/Machining Center/Grinder, respectively. 4.5.1.2 Validation 4.5.1.2.1 THINC-API Sample Applications If current OSP System software can support current version of THINC-API libraries installed on machine, a Windows Form should be displayed without any error message as shown: Note: Per function call in the libraries also depends on machine options, spec. code, NC Control software version etc… Machining Center Test application Confidential Okuma America Corporation 2018 Page 19 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 Lathe Test application: Confidential Okuma America Corporation 2018 Page 20 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 Grinder Test application: Confidential Okuma America Corporation 2018 Page 21 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 4.5.1.2.2 THINC-API Notifier There is a Windows Service called ‘Okuma API Notifier’ which will be installed on machine, NC Master, and desktop PC. It indicates the status of THINC-API as an icon in the system taskbar. There are 4 states of THINC-API Notifier as shown below: 1/ Waiting State (API white-background icon) – NC is not running yet. THINC-API is not initialized yet. 2/ Initializing state (API Yellow-background icon) – NC is started and THINC-API is initializing. 3/ Initialized (API Green-background icon) – THINC-API is successfully initialized with NC and is ready for exchanging data. 4/ Failed to initialize (API red-background icon) – NC is started and THINC-API cannot communicate with NC due to some reasons. By clicking on the icon, it will bring up a dialog and shows status of THINC-API with message, for example: Confidential Okuma America Corporation 2018 Page 22 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 4.5.1.3 Errors 4.5.1.3.1 NC Not Running 4.5.1.3.1.1 DATA-API Confidential Okuma America Corporation 2018 Page 23 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 Problem: THINC-API libraries fail to initialize due to NC running condition. Solution: Start application developed with THINC-API libraries after NC is running. Custom applications can utilize ‘Startup Service’ developed by OKUMA to ensure that your custom application starts after NC started. 4.5.1.3.1.2 Command API Confidential Okuma America Corporation 2018 Page 24 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 Problem: THINC-API libraries fail to initialize due to NC running condition. Solution: Start application developed with THINC-API libraries after NC is running. Custom applications can utilize ‘Startup Service’ developed by OKUMA to ensure that your custom application starts after NC started. 4.5.1.3.2 THINC-API dependency library files THINC-API will check the following files in NC OSP system software for the same or greater file version. For Lathe: LDATAPI.dll LCMDAPI.exe Softswitch.exe For MC: MDATAPI.dll MCMDAPI.exe Softswitch.exe For Grinder: GDATAPI.dll GCMDAPI.exe Softswitch.exe And PIODLIB.dll library 4.5.1.3.2.1 Incorrect file version Confidential Okuma America Corporation 2018 Page 25 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 For any reason if the above files listed for Lathe/MC have incorrect file version, a dialog box will display and show the error message of what causing THINC-API sample application fails to run correctly. The error message shows an incorrect file version: - Operation: Failed to Validate dependency files version - Problem: Okuma.CMDATAPI.dll requires C:\OSP-P\SharedDll\MDATAPI.dll version 1.0.2.1 or above. Solution: Re-Install/Install THINC-API again if any of the above file listed for Lathe/MC has incorrect file version. 4.5.1.3.2.2 Missing Dependency files Confidential Okuma America Corporation 2018 Page 26 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 The error message shows a missing file: - Operation: Failed to Validate dependency files version - Problem: Okuma.CMDATAPI.dll requires C:\OSP-P\SharedDll\MDATAPI.dll file. Solution: If any of the above files listed for Lathe/MC are missing, then an installation of THINC-API to the latest version is needed. 4.5.1.3.3 THINC-API library files 4.5.1.3.3.1 Missing library file Confidential Okuma America Corporation 2018 Page 27 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 All applications developed with .NET THINC-API libraries are required to include an exact version of THINC-API libraries with the custom installation. THINC-API libraries compiled with application should be installed with your application folder. The above error message shows that THINC-API library named Okuma.CLDATAPI.dll cannot be found at the folder where the application runs from. Solution: Include THINC-API libraries compiled in your application with your custom setup and re-install your application with new setup. 4.5.1.3.3.2 Incorrect library file version Problem: THINC-API libraries fail to load due to incorrect library version. Solution: All custom applications developed with THINC-API libraries must install THINC-API libraries in the application’s installation folder and must have the same file version as the libraries version compiled with. 4.5.1.3.4 License file At first run, THINC-API will validate its license file named Okuma.api.lic located in D:\Program Files\Okuma\Licenses folder for correct version per THINC-API library file. 4.5.1.3.4.1 Missing license file Confidential Okuma America Corporation 2018 Page 28 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 The error message shows a missing file: - Operation: Failed to check out license feature name ‘Okuma.CMDATAPI.All feature version ‘1.3’ at location ‘D:\Program files\Okuma\Licenses\okuma.api.lic’ - Problem: Cannot find license file (-1, 359:2 “No such file or directory”) Solution: If the license is missing, then an installation of THINC-API to the latest version is needed. 4.5.1.3.4.2 Incorrect license file version Confidential Okuma America Corporation 2018 Page 29 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 The error message shows an incorrect license version for a particular THINC-API library: - Operation: Failed to check out license feature name ‘Okuma.CMDATAPI.All feature version ‘1.3’ at location ‘D:\Program files\Okuma\Licenses\okuma.api.lic’ - Problem: License file does not support this version. (-21, 126) Solution: Installation of THINC-API to the latest version is needed. Confidential Okuma America Corporation 2018 Page 30 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 4.5.1.3.4.3 Invalid license file The error message shows an invalid license file for a particular THINC-API library: - Operation: E01080013001 Failed to check out license feature name 'Okuma.CMDATAPI.All', feature version '1.3' at location 'D:\Program files\Okuma\Licenses\okuma.api.lic' - Problem: Invalid (inconsistent) license key. (-8,523). Probably, the license file has been modified. Solution: Un-install current version and install THINC-API to the latest version. 4.5.1.3.4.4 Expired license file Confidential Okuma America Corporation 2018 Page 31 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 The error message shows an expired license file for a particular THINC-API library: - Operation: E01080013001 Failed to check out license feature name 'Okuma.CLDATAPI.All', feature version '1.3' at location 'D:\Program files\Okuma\Licenses\okuma.api.lic' - Problem: Feature has expired (-10,32) Solution: Install THINC-API to the latest version with permanent license file. Please see section ‘4.3 Install External License file’ for installing external license file. 4.5.1.3.4.5 Flexnet License library Confidential Okuma America Corporation 2018 Page 32 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 The error message shows that a dependency library for THINC-API library cannot find in GAC (Global Assembly Cached (\Windows\assembly) folder: - Problem: File or assembly name Okuma.FlexNet, or one of its dependencies, was not found. Solution: Install THINC-API to the latest version. 4.5.2 Logging Service & Logging Service Client Application 4.5.2.1 Logging Service At first run, THINC-API libraries will connect with Logging Service utility. The Logging Service could fail to load correctly as indicated below: Confidential Okuma America Corporation 2018 Page 33 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 The error message shows a missing file: - Operation: Failed to load Logging Service - Problem: Failed to locate database file at D:\Program Files\Okuma\LoggingService\log.fdb Solution: Re-install or install THINC-API libraries to the latest version. Confidential Okuma America Corporation 2018 Page 34 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 The error message shows that the Logging Service server is not running on the local machine (localhost): - Operation: Failed to load Logging Service - Problem: ApiLog.initConnection: Unable to complete network request to host “localhost” Solution: Make sure that FireBird server status is running. If not, start the FireBird server from Service Windows Or Re-install or install THINC-API libraries to the latest version. Confidential Okuma America Corporation 2018 Page 35 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 4.5.2.2 Logging Library The error message shows that a dependency library for THINC-API library cannot find in GAC (Global Assembly Cached \Windows\assembly) folder: - Problem: File or assembly name Okuma.ApiLog or one of its dependencies, was not found. Solution: Install THINC-API to the latest version. 4.5.2.3 Logging Service Client Application The Logging Client application is a utility that allows one to view all logging records logged by THINCAPI libraries at different logging level. A successful loading of LoggingServiceClient application is shown below: Confidential Okuma America Corporation 2018 Page 36 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 LoggingServiceClient application could fail to load up correctly if the logging database file is missing or Logging Service does not start yet. Please refer to section 4.4.2.1 and 4.4.2.2 for correcting the problems. 4.5.2.4 Logging Service for .NET Framework 4.0 THINC-API libraries THINC-API libraries compiled with .NET Framework will not use Okuma.ApiLog.dll library any more. It will use Okuma.ApiLog2.dll instead. The following libraries and application are used for logging service and installed in D:\Program files\Okuma\LoggingService2 folder: Okuma.Api.LogService.WinHost.exe Okuma.Api.LogService.dll System.Data.SQLite.dll ApiLog2 Confidential Okuma America Corporation 2018 Page 37 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 The logging service client application is part of Lathe, Machining Center, and Grinder Test application as shown below: 5. Repair/Uninstall THINC-API 5.1 Repair/Un-install If THINC-API already installed, the setup will ask for either Repair or Remove the current THINC-API installation. Confidential Okuma America Corporation 2018 Page 38 of 57 THINC-API Installation Manual 5.1.1 Version: S5015-007-09 Date: 03/07/2018 Repair The setup will try to re-install all files current being installed on machine. 5.1.1.1 Run Setup Run the THINC-API from Add or Remove Programs or source of media Note: The original source of THINC-API setup must be available and accessible from Windows drive. Confidential Okuma America Corporation 2018 Page 39 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 Select the “Repair’ option and press Next to continue the process Confidential Okuma America Corporation 2018 Page 40 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 If you select ‘Remove’ and press Next, the installation will ask for your confirmation to remove current THINC-API installation. Click Yes to continue with the installation process or click No to review/change any settings. Confidential Okuma America Corporation 2018 Page 41 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 5.1.1.2 Setup At any time, you can press Cancel button to terminate the installation. Confidential Okuma America Corporation 2018 Page 42 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 5.1.1.3 Finish Click Finish to just finish the installation process. 5.1.2 Uninstall 5.1.2.1 Run setup Run the THINC-API from Add or Remove Programs Confidential Okuma America Corporation 2018 Page 43 of 57 THINC-API Installation Manual Confidential Version: S5015-007-09 Date: 03/07/2018 Okuma America Corporation 2018 Page 44 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 Select ‘Remove’ and press Next. The installation will ask for your confirmation to remove current THINC-API installation. Confidential Okuma America Corporation 2018 Page 45 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 Click Yes to continue with the installation process or click No to review/change any settings. 5.1.2.2 Setup Status Confidential Okuma America Corporation 2018 Page 46 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 At any time, you can press Cancel button to terminate the installation. 5.1.2.3 Finish Confidential Okuma America Corporation 2018 Page 47 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 Click Finish to just finish the installation process. 6. Installation Files The following files are considered THINC-API libraries which are included in the subfolder program files\Okuma\THINC API\Bin: Confidential - Okuma.CLDATAPI.dll Okuma.CLCMDAPI.dll Okuma.CLDATAPI.xml Okuma.CLCMDAPI.xml (Visual Studio Brower Help files) (Visual Studio Brower Help files) - Okuma.CMDATAPI.dll Okuma.CMCMDAPI.dll Okuma.CMDATAPI.xml Okuma.CMCMDAPI.xml (Visual Studio Brower Help files) (Visual Studio Brower Help files) - Okuma.CGDATAPI.dll Okuma.CGCMDAPI.dll Okuma.CGDATAPI.xml Okuma.CGCMDAPI.xml (Visual Studio Brower Help files) (Visual Studio Brower Help files) Okuma America Corporation 2018 Page 48 of 57 THINC-API Installation Manual 6.1 Machine Installation 6.1.1 Lathe Version: S5015-007-09 Date: 03/07/2018 6.1.1.1 GAC Folder THINC-API libraries: - Okuma.CLDATAPI.dll - Okuma.CLCMDAPI.dll Logging Service library: - Okuma.Apilog2.dll - Okuma.Api.LogService.dll - Okuma.Api.LogService.Data.dll Dependency library files for THINC-API: - Okuma.Interop.LCMDAPI.dll 6.1.1.2 Okuma Folders THINC-API Release notes: D:\Program files\Okuma\THINC API \ LatheReleaseNote.pdf THINC-API Installation Manual: D:\Program files\Okuma\THINC API \InstallationManual.pdf THINC-API license file: D:\Program files\Okuma\Licenses\Okuma.api.lic THINC-API Help file: D:\Program files\Okuma\THINC API\Help\THINLathe.chm THINC-API Sample application folder: D:\Program files\Okuma\THINC API \THINCLathe THINC-API libraries and Visual Studio Brower Help files: D:\Program files\Okuma\THINC API \bin Okuma.CLDATAPI.dll Okuma.CLCMDAPI.dll Okuma.CLDATAPI.xml (Visual Studio Brower Help files) Okuma.CLCMDAPI.xml (Visual Studio Brower Help files) Logging Service folder: D:\Program Files\Okuma\LoggingService2 ApiLog2 Okuma.Api.LogService.dll Okuma.Api.LogService.WinHost.exe Okuma.Api.LogService.WinHost.exe.config System.DataSQLite.dll Confidential Okuma America Corporation 2018 Page 49 of 57 THINC-API Installation Manual 6.1.2 Version: S5015-007-09 Date: 03/07/2018 Machining Center 6.1.2.1 GAC Folder THINC-API libraries: - Okuma.CMDATAPI.dll - Okuma.CMCMDAPI.dll Logging Service library: - Okuma.Apilog2.dll - Okuma.Api.LogService.dll - Okuma.Api.LogService.Data.dll Dependency library files for THINC-API: - Okuma.Interop.MCMDAPI.dll 6.1.2.2 Okuma Folders THINC-API Release notes: D:\Program files\Okuma\THINC API \MCReleaseNote.pdf THINC-API Installation Manual: D:\Program files\Okuma\THINC API \InstallationManual.pdf THINC-API license file for both Lathe & MC: D:\Program files\Okuma\Licenses\Okuma.api.lic THINC-API Help file: D:\Program files\Okuma\THINC API\Help\THINCMC.chm THINC-API Sample application folder: D:\Program files\Okuma\THINC API \THINCMC THINC-API libraries and Visual Studio Brower Help files: D:\Program files\Okuma\THINC API \bin Okuma.CMDATAPI.dll Okuma.CMCMDAPI.dll Okuma.CMDATAPI.xml (Visual Studio Brower Help files) Okuma.CMCMDAPI.xml (Visual Studio Brower Help files) Logging Service folder: D:\Program Files\Okuma\LoggingService2 ApiLog2 Okuma.Api.LogService.dll Okuma.Api.LogService.WinHost.exe Okuma.Api.LogService.WinHost.exe.config System.DataSQLite.dll 6.1.3 Grinder 6.1.3.1 GAC Folder THINC-API libraries: - Okuma.GGDATAPI.dll Confidential Okuma America Corporation 2018 Page 50 of 57 THINC-API Installation Manual - Version: S5015-007-09 Date: 03/07/2018 Okuma.CGCMDAPI.dll Logging Service library: - Okuma.Apilog2.dll - Okuma.Api.LogService.dll - Okuma.Api.LogService.Data.dll Dependency library files for THINC-API: - Okuma.Interop.GCMDAPI.dll 6.1.3.2 Okuma Folders THINC-API Release notes: D:\Program files\Okuma\THINC API \ReleaseNote.pdf THINC-API Installation Manual: D:\Program files\Okuma\THINC API \InstallationManual.pdf THINC-API license file for Lathe, MC, and Grinder: D:\Program files\Okuma\Licenses\Okuma.api.lic THINC-API Help file: D:\Program files\Okuma\THINC API\Help\THINCGrinder.chm THINC-API Sample application folder: D:\Program files\Okuma\THINC API \THINCGrinder THINC-API libraries and Visual Studio Brower Help files: D:\Program files\Okuma\THINC API \bin Okuma.CGDATAPI.dll Okuma.CGCMDAPI.dll Okuma.CGDATAPI.xml (Visual Studio Brower Help files) Okuma.CGCMDAPI.xml (Visual Studio Brower Help files) Logging Service folder: D:\Program Files\Okuma\LoggingService2 ApiLog2 Okuma.Api.LogService.dll Okuma.Api.LogService.WinHost.exe Okuma.Api.LogService.WinHost.exe.config System.DataSQLite.dll 6.2 Desktop Installation All 3 libraries for Lathe, Machining Center, and Grinder can be installed when desktop installation is detected. The installation will consider desktop installation when there is no OSP-P folder on C drive. All libraries and applications will be installed for each selection of machine types. Confidential Okuma America Corporation 2018 Page 51 of 57 THINC-API Installation Manual 7. Version: S5015-007-09 Date: 03/07/2018 Installation for Custom Application This section describes the process of installing custom applications developed with THINC API libraries. This process allows custom applications developed with any version of THINC-API to run on machine without affecting other custom applications running with different versions of THINC-API libraries. In order for a custom application to run on machine, the following steps need to be done as listed below: 7.1 THINC-API Spec. Code In order for THINC-API to function, a spec. code for THINC-API must be enabled on the machine. To enable THINC-API, it must be requested through distributor or Okuma Software Group. Currently, this process is done by installing the OSP System Software on the machine. On Machining Center, THINC-API spec. code, CAPI on No 32, can be verified visually on the NC HMI screen as shown below: On Grinder, THINC-API spec. code, CAPI on No 22 bit 0, can be verified visually on the NC HMI screen as shown below: Confidential Okuma America Corporation 2018 Page 52 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 Note: There is no NC-HMI screen for verifying spec code on Lathe machine. 7.2 License All THINC-API libraries require a valid license file to run on machine. There is only a single license file, Okuma.api.lic, for all THINC-API libraries version. The setup itself includes a time-out version of license file and is installed in D:\Program Files\Okuma\Licenses folder. Your custom application or demo application can be run in this trial period. Currently, the trial period is fixed to certain date in the license file. For example: This license file will be expired in Oct 1, 2008 for Okuma.CLDATAPI.All version 1.2. This license file can be used on any machine. FEATURE Okuma.CLDATAPI.All okumausa 1.2 01-oct-2008 uncounted \ HOSTID=ANY TS_OK SIGN="00EB B55A 56DD A45F 75D6 F491 231F CD00 \ 2BA2 A406 AE0F 932B C574 7230 959C" FEATURE Okuma.CMDATAPI.All okumausa 1.2 01-oct-2008 uncounted \ HOSTID=ANY TS_OK SIGN="00D7 1F45 6055 FEBE 8654 2089 A431 B100 \ EE6E 0E40 BAED 4AA3 B350 78DA 8955" Confidential Okuma America Corporation 2018 Page 53 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 FEATURE Okuma.CLCMDAPI.All okumausa 1.0 01-oct-2008 uncounted \ HOSTID=ANY TS_OK SIGN="00D6 079F E750 1E50 F866 794A 9058 3900 \ 7BA4 97FD 199B 9809 7F19 DD09 41FD" FEATURE Okuma.CMCMDAPI.All okumausa 1.0 01-oct-2008 uncounted \ HOSTID=ANY TS_OK SIGN="00B3 3BC6 ED99 A792 24E0 A99C B6D5 9000 \ CCF9 B436 0BDA 7283 CCAA 5BE6 E6FC" FEATURE Okuma.ControlType.P200 okumausa 1.0 permanent uncounted \ HOSTID=SERIAL=105330 TS_OK SIGN="006A 4D47 5A17 E95C 4AC1 1494 852F DB00 A98 F8BE 5366 B02E 10E4 1220 2FCF" The non-expired license file must be obtained through Okuma Software Group if you are a customer only. Each THINC-API library will check this license for correct version. The library version should be equal or less than the version in the license file to run. Sample valid license file per machine serial number: FEATURE Okuma.CLDATAPI.All okumausa 1.1 permanent uncounted \ HOSTID=SERIAL=105330 TS_OK SIGN="00C3 4CCD E2DB 439D 0F83 4805 \ 9C14 DF00 291B D46A 71BD A96A 61A0 5A54 D18B" FEATURE Okuma.CLCMDAPI.All okumausa 1.0 permanent uncounted \ HOSTID=SERIAL=105330 TS_OK SIGN="00A3 F5EF 4872 1C12 27C9 8E5B \ C5B9 4D00 5300 1FF5 D0B4 1371 DC59 4FB9 CEDD" FEATURE Okuma.CMDATAPI.All okumausa 1.1 permanent uncounted \ HOSTID=SERIAL=105330 TS_OK SIGN="00B8 7E90 2B05 9535 94E4 92CB \ C8BB B100 89C1 3E47 820D E045 931C EC07 68A9" FEATURE Okuma.CMCMDAPI.All okumausa 1.0 permanent uncounted \ HOSTID=SERIAL=105330 TS_OK SIGN="00B2 0B95 F2BC 0E10 D351 D60A \ 60F8 E100 1904 FC87 685A 09D0 A1BC 1C45 8B52" FEATURE Okuma.CGDATAPI.All okumausa 1.0 permanent uncounted \ HOSTID=SERIAL=105330 TS_OK SIGN="00B8 7E90 2B05 9535 94E4 92CB \ C8BB B100 89C1 3E47 820D E045 931C EC07 68A9" FEATURE Okuma.CGCMDAPI.All okumausa 1.0 permanent uncounted \ HOSTID=SERIAL=105330 TS_OK SIGN="00B2 0B95 F2BC 0E10 D351 D60A \ 60F8 E100 1904 FC87 685A 09D0 A1BC 1C45 8B52" FEATURE Okuma.ControlType.P200 okumausa 1.0 permanent uncounted \ HOSTID=SERIAL=105330 TS_OK SIGN="006A 4D47 5A17 E95C 4AC1 1494 852F DB00 A98 F8BE 5366 B02E 10E4 1220 2FCF" This license file is for machine having serial number 105330 only. It will not work on other machines having different serial number. It will support Okuma.CLDATAPI.dll library having a version that equals to or less than 1.1, and so for. This license file can support function calls for P200 or newer control types. Confidential Okuma America Corporation 2018 Page 54 of 57 THINC-API Installation Manual 7.3 Version: S5015-007-09 Date: 03/07/2018 Installation As normal case for all Windows installation program, THINC-API Setup will run through the installation if: - THINC-API is not installed on the target machine. - If existing version of THINC-API on machine is less than the installing version For custom application developed with THINC-API: All and ONLY THINC-API libraries referenced by your application such as Okuma.CLDATAPI.dll, Okuma.CMDATAPI.dll, and Okuma.CGATAPI.dll must be included in your setup and installed in the same folder of your custom application. The libraries version referenced in your application must match (exact match since this library is signed with strong name) the libraries installed in your application folder. The THINC-API license file, Okuma.api.lic, installed on machine must support the THINC-API libraries version that your application are compiled with. For example: The machine has installed THINC-API and the version of Okuma.CLDATAPI is 1.1 as shown below FEATURE Okuma.CLDATAPI.All okumausa 1.1 permanent uncounted \ HOSTID=SERIAL=105330 TS_OK SIGN="00C3 4CCD E2DB 439D 0F83 4805 \ 9C14 DF00 291B D46A 71BD A96A 61A0 5A54 D18B" Your custom application is compiled with Okuma.CLDATAPI version 1.2. In this case, the customer needs to obtain the latest THINC-API release and install on the machine. For all cases, the latest release of THINC-API will cover all custom applications running on the machine and compiled with different version of THINC-API. The latest release of THINC-API always has the latest version of THINC-API libraries and the license file supports latest THINC-API libraries versions, also. In all cases, the following files must not be included with the installation of custom applications developed with THINC-API libraries: - LCMDAPI.exe - MCDMAPI.exe - GCMDAPI.exe 7.4 Public Release All custom applications developed with THINC-API must use the public release 1.0.0.0 or above. Any version before public release version will have compatibility issues with public release version and will not run correctly. 7.5 Best Practice An application should verify all dependency libraries during run-time and encourages using the latest version of THINC-API release if possible. A re-compile of your application is a must to leverage new version of THINC-API features or bugs/defects fixes. An application must install .NET framework version that it is compiled with. The installation process comprises 2 steps: 1. Install THINC-API (.NET Framework 1.1/4.0 will also be installed if needed) 2. Install custom application (requires installing .NET Framework that application compiled with. It could be .NET Framework version 2.0. 3.0, and so on) Confidential Okuma America Corporation 2018 Page 55 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 3. All exceptions generated by API and all set/add/cal functions will be logged. Therefore, the application must be designed to minimize unnecessary log by utilizing ObjectOriented Programming practices or preventing perform set/add/cal functions in a loop. Example of bad practice: Dim m_objTools As CTools Dim intValue As Integer m_objTools = New CTools … Private Sub UpdateThread() While (blnRunning) m_objTools.SetSubSystem(SubSystemEnum: NC_AL) intValue = m_objTools. GetCurrentToolNumber () . . m_objTools.SetSubSystem(SubSystemEnum: NC_BL) intValue = m_objTools. GetCurrentToolNumber () . . End While End Sub Example of good practice: Dim m_objATurretTools As CTools Dim m_objBTurretTools As CTools Dim intValue As Integer m_objATurretTools = New CTools m_objATurretTools .SetSubSystem(SubSystemEnum: NC_AL) m_objBTurretTools = New CTools m_objBTurretTools .SetSubSystem(SubSystemEnum: NC_BL) … Private Sub UpdateThread() While (blnRunning) intValue = m_objATurretTools . GetCurrentToolNumber () . . intValue = m_objBTurretTools. GetCurrentToolNumber () . . End While Confidential Okuma America Corporation 2018 Page 56 of 57 THINC-API Installation Manual Version: S5015-007-09 Date: 03/07/2018 End Sub All custom applications also need to install into D:\Program Files folder only. Confidential Okuma America Corporation 2018 Page 57 of 57
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.5 Linearized : Yes Author : Lhuynh Company : Create Date : 2018:04:23 13:04:26-04:00 Modify Date : 2018:04:23 13:04:32-04:00 Source Modified : D:20180423170321 Subject : THINC-API Language : EN-US Tagged PDF : Yes XMP Toolkit : Adobe XMP Core 5.4-c006 80.159825, 2016/09/16-03:31:08 Metadata Date : 2018:04:23 13:04:32-04:00 Creator Tool : Acrobat PDFMaker 11 for Word Document ID : uuid:1a5b7b32-f1af-465a-834f-25c3e787d7da Instance ID : uuid:ab5df851-f7b2-4ef6-9ab6-881f89cbb80d Format : application/pdf Title : Installation Manual Description : THINC-API Creator : Lhuynh Producer : Adobe PDF Library 11.0 Keywords : Headline : THINC-API Page Layout : OneColumn Page Count : 57EXIF Metadata provided by EXIF.tools