Deployment
From Screen Scraper Studio
So you created an automation script or a full-blown app and are ready to deploy them to your customers. You also need to deploy the client run-time that we name ScreenScraper SDK or SDK for short. Below we explore what are the best practices to deploy the runtime depending of your specific scenario.
Important note: You need to purchase at least one copy of ScreenScraper Studio DEVELOPER edition to have the right to deploy the run-time with your apps or scripts.
Important note: You need to have purchased a valid seat or the unlimited redistributable client run-time license before installing SDK to a new computer. Please note that the unlimited license does not allow you deploy the stand alone SDK. You have to deploy the SDK only as part your application. Please note that you are not allowed to deploy ScreenScraper Studio itself, only the client run-time redistributable files listed in REDISTRIBUTABLES.txt file.
Important note: The client run-time has to be activated on a new computer before you are using it unless you got the unlimited bits that have the activation code removed. Run the Activate.exe app located in the same folder where you installed the library and enter the email and key delivered to you by email. For large volume customer we provide a way to automate activation, contacts us at [email protected]
Contents |
Deploy run-time with automation scripts
You need to deploy the SDK as a stand alone package when you want to run the automation scripts on your customers computers. We are offering a single installation file in the form of Windows installer script (MSI) package.
When you purchase SDK seats you receive a link to download the MSI package that install the SDK. The MSI package takes care of copying and registering the components.
Note: this MSI package does not install support for screen scraping java apps. Read more about enabling support for java screen scraping.
Note: this MSI package does install only English OCR training file. Get more screen OCR training files.
Deploy run-time as part of your app setup
The best strategy to deploy depends largely on the technology/language you are using to build your own app. We expose the library either as a .Net or COM interfaces. Most languages have built in support for dealing with COM interfaces.
Deployment with a .Net application
If you develop using Visual Studio 2010, the simplest method of deployment is to use the NuGet Package Manager extension. Our Screen Scraper package is listed here.
Just write 'Install-Package ScreenScraper' in the Package Manager Console or search for 'ScreenScraper' in the Add Library Reference dialog and you're good to go. The package copies all required file to the output directory of your project. All you have to do is copying the content of that folder in your setup.
You can also manually reference the ScreenScraper.dll .NET assembly to get access to the API from managed code. Just use the ComFactory class to instantiate objects to avoid COM registration.
When you deploy on another computer you have to copy in the same folder as your app all the files listed in REDISTRIBUTABLES.txt file from the installation directory.
Deployment with a VB6 or Delphi app
These languages have very good support for calling COM interfaces. When you deploy the library it has to be registered as COM. If the technology you are using to create the installation of your app supports merge modules (and most do) use ScreenScraperSDKRuntime.msm merge module you have received when you purchased the SDK seats and integrate it with your setup. It will install and register the required files depending on the operating platform. Tip: Set the merge module path to your installation folder.
Important note: The library has to be activated on a new computer before you are using it.
Note: this merge module does not install support for screen scraping java apps. Read about enabling screen scraping in java apps here.
Note: this merge module does not install any OCR language training. It is mandatory to add at least one training file. Get Screen OCR training files.
Deployment with a C++ app
Hopefully you have used our method to instantiate COM interfaces by using CreateCOMObject method offered by each of SDK object. If so deployment is simply a copy of redistributable files (listed in REDISTRIBUTABLES.txt) in your app folder, otherwise you have to go the route of VB6 or Delphi deployment with a manifest or you can register the COM interfaces.
Activating the library on a new PC
After you have installed the SDK on a new PC you need to activate it. This is a manual process that requires user input. Launch Activate.exe application that comes with the SDK and manually type the codes received on your purchase confirmation email.
Our volume customers that need to automate the activation process should contact us for further instructions. Customers that purchased the unlimited license are provided with a special version that doesn't require activation.
Manual deployment with COM registration
Sometimes you just have to use COM registration. Perhaps you have to install on Windows 2000 or you have coded your app this way and don't want to change something that works.
During installation of your application you have to copy the files in REDISTRIBUTABLES.txt file from installation directory to your application folder or to another folder of your choice. After you have copied the files you might have to register the library as a COM library (see above discussion about how to avoid com registration) and then you need to activate the library with the licensing data you have received when you purchased it.
COM registration
TCaptureX.dll, TSelection.dll, UIElement.dll and SSSystemObj.dll can be registered as COM libraries prior to using them. Registration depends on the OS architecture (x86 or x64) and the option of per user or per machine registration.
Registration on x64
%windir%\syswow64\regsvr32 <path>\TCaptureX.dll %windir%\syswow64\regsvr32 <path>\UIElement.dll %windir%\syswow64\regsvr32 <path>\TSelection.dll %windir%\syswow64\regsvr32 <path>\SSSystemObj.dll
%windir%\system32\regsvr32 <path>\TCaptureX_x64.dll %windir%\system32\regsvr32 <path>\UIElement_x64.dll %windir%\system32\regsvr32 <path>\TSelection_x64.dll %windir%\system32\regsvr32 <path>\SSSystemObj_x64.dll
Registration on x86
%windir%\system32\regsvr32 <path>\TCaptureX.dll %windir%\system32\regsvr32 <path>\UIElement.dll %windir%\system32\regsvr32 <path>\TSelection.dll %windir%\system32\regsvr32 <path>\SSSystemObj.dll
Remarks
For a silent registration use the /s flag.
For a per-user registration use the /i flag. This flag can be combined with the silent flag. Works only on 2000 and XP.
Most setup technologies have built in support for registering COM libraries, so you don't need to manually call regsvr32, just declare these dlls as COM libraries.
