********************************************************************** * DEPLOY\README.TXT ********************************************************************** * VisualWorks Smalltalk Plugin * * Copyright (C) 1999-2009 Cincom Systems, Inc. All Rights Reserved. * * This software distribution contains copyrighted material and trade * secrets of Cincom Systems, Inc. It is furnished subject * to a source license agreement and may not be used, distributed or * disclosed except as permitted by that agreement. ********************************************************************** Purpose of this README This file contains information necessary to deploy the VisualWorks ActiveX Plugin, as well as instructions for building your own deployment file for Internet Component Download of your application which uses the VisualWorks Plugin ActiveX Control. The VisualWorks Plugin The VisualWorks Plugin is an ActiveX Control browser plug-in which can be installed in Internet Explorer (or other ActiveX capable browsers) to allow a VisualWorks application to operate inside the web browser window as an embedded object. See example.html for sample HTML syntax to embed an object. The tag parameter : CLASSID="CLSID:FF48278C-094A-4188-95AA-4B1E03F3163C" is required. This is the unique identifier for the generic VisualWorks ActiveX Plugin. With this release we support only the ActiveX Control version of the Plugin. The preview/plugin directory includes a version of the Plugin which implements the Netscape NPAPI and will run in browsers such as Netscape and Mozilla and Firefox. Deployment/Installation of the Generic VisualWorks Plugin Place the deployment CAB files [vwpluginax.cab and vwplugin.cab] on your web server and specify that location in the CODEBASE= parameter of the tag in your HTML page. Make sure to use the correct version number. See example.html for the current version. When the browser opens an HTML page which embeds the ActiveX Plugin, the CAB files are downloaded and installed through Internet Component Download. Note that the basic Plugin is not a signed control, and because any Smalltalk parcel may be loaded into its image, it cannot be marked safe for either initialization or scripting. Depending on your browser settings, you may need to respond to one or more warning dialog boxes before the Plugin will be installed and/or executed. With strict security enabled you will not be able to install the generic plugin. The Plugin DLL [axvwplugin.dll] is installed in the ActiveX Cache Folder, "WINNT\Downloaded Program Files". The remaining VisualWorks components are installed under the Program Files directory in "\VisualWorks\Plugin\2.00". In addition to registering the ActiveX Control, the installation makes three entries in the Windows Registry : HKLM\SOFTWARE\Cincom Systems, Inc.\VisualWorks\PlugIn\2.00\VWPluginDebug HKLM\SOFTWARE\Cincom Systems, Inc.\VisualWorks\PlugIn\2.00\VWPluginDir HKLM\SOFTWARE\Cincom Systems, Inc.\VisualWorks\PlugIn\2.00\VWPluginMsg Uninstall Procedure To uninstall the VisualWorks Plugin ActiveX Control, 1) Delete the entire Plugin installation folder "\VisualWorks\Plugin\2.00" from the "Program Files" directory. 2) Remove the "VWPlugin ActiveX Control" from the ActiveX Cache Folder, "WINNT\Downloaded Program Files". The following registry items can optionally be removed, but this is not required: HKEY_CLASSES_ROOT\AppID\{61ADB2B2-BF94-43B4-B04B-379B3E59BA67} HKEY_CLASSES_ROOT\AppID\VWPlugin-AX HKEY_CLASSES_ROOT\CLSID\{FF48278C-094A-4188-95AA-4B1E03F3163C} HKEY_CLASSES_ROOT\VWPluginAX.VisualWorksAX HKEY_CLASSES_ROOT\Interface\{19A5484E-1774-48DB-A119-840F8A73B5EB} HKEY_CLASSES_ROOT\TypeLib\{61ADB2B2-BF94-43B4-B04B-379B3E59BA67} HKEY_LOCAL_MACHINE\SOFTWARE\Cincom Systems, Inc.\VisualWorks\PlugIn\2.00 In most cases there is minimal benefit to removing these variables as the registry key is used only by VisualWorks. Building Test Deployment Files For Your Application To test your own application, you will need to build your own CAB deployment files. This requires the CABARC.EXE utility which is part of the Microsoft Cabinet Software Development Kit, and can be downloaded from the following URL : http://support.microsoft.com/default.aspx?scid=KB;en-us;310618 Copy the contents of the $(VISUALWORKS)\plugin\deploy directory to a work directory - axvwm200.dll (REQ) VisualWorks Plugin messages resource axvwplugin.dll (REQ) VisualWorks Plugin ActiveX Control example.html sample page HelloWorld.pcl (REPLACE) sample parcel mkaxdeploy.bat (EDIT) High level file automates CAB generation mkcabplugin.bat (EDIT) Command file to generate CAB file mkcabpluginax.bat (EDIT) Command file to generate CAB file mkcatplugin.bat (EDIT) Command file to generate catalog file plugin-base.im (REQ/REPLACE) VisualWorks Plugin image readme.txt (this file) vwnt.exe (REQ) VisualWorks VM vwntoe.dll (REQ) VisualWorks OE support vwplugin.cab [*]VisualWorks Plugin Runtime CAB deployment file vwplugin.cat [*]VisualWorks Plugin deployment catalog file vwplugin.cdf Instructions to makecat.exe for catalog file vwplugin.inf (EDIT) Plugin Runtime INF installation file vwplugin.ini (REQ/EDIT) VisualWorks Plugin configuration file vwpluginax.cab [*]VisualWorks Plugin ActiveX Control CAB deployment file vwpluginax.inf (EDIT) ActiveX Control INF installation file The files marked with [*] will be generated as part of the process to build your test deployment files. The catalog file must be digitally signed to avoid multiple trust dialog boxes. You may build your own image to be a self-contained application and use the Runtime Packager to create your image in this directory, or replace HelloWorld.pcl with your own application parcel. You may also need to make changes to the vwplugin.ini configuration file. When all the necessary pieces of your application are in place, edit the mkcabplugin.bat and mkcabpluginax.bat file to reflect the desired content of your CAB deployment files and their INF files to reflect the same content. See the Microsoft documentation for INF syntax as well as the parameters for the CABARC.EXE tool. Run the batch files to create your CAB deployment files. Creating your own ActiveX Control You can use the generic VisualWorks Plugin ActiveX Control for the initial phases of building and testing your Custom Plugin Image and any parcels which comprise your application. However, when you deploy your application you will usually want a signed and safe control, which means you need to build your own Custom Plugin Control. If you need to mark your plugin control safe, you must build your own Custom Plugin, taking care to strictly control parcel loading or any other unsafe activity, and rigorously testing your control for initialization and scripting safety before you mark the control safe. Until ongoing Plugin porting projects are complete, the VisualWorks plugin source is not included on the release CD. It is available by request from Cincom Support, and includes documentation which describes in detail the process to build your own version of the VisualWorks ActiveX Control. The documentation includes some general comments about code signing, but you will need to consult Microsoft documentation for more detailed instructions on adding digital signatures to the appropriate files. 07/28/2009 slm