Register the Page Flow Guidance Package

To use the automated guidance package provided with the Page Flow Package, you must install a prerequisite run-time component named the Guidance Automation Extensions. If you want to modify the guidance package or author your own guidance package, you must also install the Guidance Automation Toolkit. For more information, see Guidance Automation Toolkit and Guidance Automation Extensions Download.
You can use the Page Flow Development guidance package to automate page flow–enabled application development activities that you would otherwise have to manually perform. It includes recipes and templates to generate Visual Studio artifacts such as projects and page flow definitions.
To use the Page Flow Guidance Package you have two options: To uninstall the Guidance Package see Uninstalling.

Building the Guidance Package and Installer

The guidance package is available as source code. If you do not select the option to register the guidance package when you install the software factory, you must compile the guidance package before you can install (or register) it. The following procedure describes how to compile the guidance package and the installer.
To compile the guidance package and guidance package installer
  • 1. Using Visual Studio, open the solution file Pageflow Guidance Package.sln.
  • 2. On the Build menu, click Rebuild Solution. By default, this is a debug build.
Note: The Visual Studio solution Pageflow Guidance Package includes the setup project PageFlowPackageSetup. This project creates an installer that you can use to distribute the guidance package. When you create a new guidance package with the Visual Studio Guidance Package template, the template unfolds a setup project along with the package solution. This means you do not have to manually create a setup project for a guidance package.

Installing the Guidance Package

To distribute a guidance package, you create and distribute a Windows Installer package. Developers run the setup program and then enable the guidance package. If you distribute a new version of the guidance package, developers must uninstall the previous instance of the guidance package before installing the new one. All instances of Visual Studio must be closed to install a guidance package.
The following procedure describes how to install the guidance package Page Flow Development. This procedure assumes that you have built the guidance package setup project.
To install the Page Flow Development guidance package
  • 1. Close all instances of Visual Studio.
  • 2. Execute the file PageFlowPackageSetup.msi. This file is located in the output directory of the PageFlowPackageSetup project.
Note: By default, the Windows Installer package installs the assemblies in the folder named PageFlowPackageSetup. This folder is located in the Program Files\patterns & practices directory. The Guidance Automation Extensions do not support assemblies in the global assembly cache and do not load assemblies that are placed there, even if the assembly is explicitly referenced in the guidance package.After the installation package that executes the guidance package is installed, it appears in the Add/Remove Programs dialog box.

Enabling the Guidance Package

To enable the Page Flow guidance package
  • Select and enable the guidance package in Guidance Package Manager
To enable the Page Flow guidance package with the Guidance Package Manager
  • 1. Using Visual Studio, open your solution.
  • 2. On the Tools menu, click Guidance Package Manager.
  • 3. In the Guidance Package Manager dialog box, click Enable / Disable Packages.
  • 4. In the Enable and Disable Packages dialog box, select the Page Flow Development check box.
  • 5. Click OK.
Note: The recipes in the Page Flow guidance package are designed to work with a solution that you create with a Web site/application. For a description of the requirements for a recipe, see the documentation for that recipe.

Registering a Guidance Package

The installation process works well when you distribute a guidance package. However, it makes it difficult to efficiently test incremental changes as you modify a guidance package. For developers of guidance packages, the Guidance Automation Toolkit provides the following recipes to make it easier to test changes:
  • Register Guidance Package. This recipe registers the package you are developing on your computer. Registration is a form of installation that you can perform without leaving the Visual Studio development environment.
  • Quick Register. This recipe performs a quick registration of the guidance package. You must perform a full registration of the guidance package before you use the Quick Register recipe.
  • Unregister Guidance Package. This recipe reverses the registration.
To register the guidance package and guidance package installer
  • 1. Using Visual Studio, open the solution file Pageflow Guidance Package.sln.
  • 2. On the Build menu, click Rebuild Solution. By default, this is a debug build.
  • 3. Use the Guidance Package Manager to enable the Guidance Package Development guidance package. You must do this before you can use the Register Guidance Package recipe, Quick Register recipe, and Unregister Guidance Package recipe.
Note: After you enable the Guidance Package Development guidance package, the Guidance Navigator will appear in Visual Studio. This window displays an overview of the guidance package and available recipes.
  • 4. In Solution Explorer, right-click PageflowPackage, and then click Register Guidance Package. After you register a guidance package, you can open a new instance of Visual Studio to test the functionality of the package. This means that you do not have to continually rebuild the setup project and run the Windows Installer package for the guidance package every time you want to test the progress of your development.
You should unregister the package if you want to do one or both of the following:
  • Install the guidance packages using the Windows Installer package.
  • Remove the guidance package from your computer.
After you unregister a guidance package (or uninstall it), you can register it again by executing the Register Guidance Package recipe.

Uninstalling

If you want to uninstall the Guidance Automation Toolkit and Extensions, you must first uninstall (or unregister) each guidance package, as described in the following procedure.
To uninstall the Guidance Automation Toolkit and Extensions
  • 1. Open a solution that is using an automated guidance package.
  • 2. On the Tools menu, click Guidance Package Manager.
  • 3. In the Guidance Package Manager dialog box, click Enable/Disable Guidance Packages.
  • 4. In the Enable/Disable Guidance Packages dialog box, clear the check box next to the guidance package you want to unregister.
  • 5. Click OK, and then click Close.
  • 6. Repeat the process until you remove all the guidance packages, including the Guidance Automation Toolkit package.
  • 7. Close Visual Studio.
  • 8. In Control Panel, open the Add/Remove Programs item.
  • 9. Select the entry for the Guidance Automation Toolkit, and then click Remove.
  • 10. Select the entry for the Guidance Automation Extensions, and then click Remove. If you receive an error message when attempting to uninstall the Guidance Automation Extensions, you can manually clean up the stored settings for registered guidance packages using the following procedure. This may be required if you do not first unregister all the guidance packages registered on your computer. You can also use this technique to remove individual guidance packages if required.
To manually remove a guidance package
  • 1. In a text editor, open the file C:\Documents and Settings\All Users\Application Data\Microsoft\Recipe Framework\ReceipeFramework.xml. The contents of the <GuidancePackage> elements will help you to locate the entries you must remove from Windows Registry.
  • 2. On the taskbar, click Start, and then click Run. In the Open box, type regedit, and then click OK.
  • 3. Open the registry key HKLM\Software\Microsoft\VisualStudio\9.0 and look for the following subkeys:
  • Packages\{77d93a80-73fc-40f8-87db-acd3482964b2}\Templates. Delete all subkeys that refer to guidance packages you want to remove (each has a GUID as its key name that matches the entry in the XML file).
  • Languages\CodeExpansions\CSharp\Paths. Delete all values that refer to guidance packages you want to remove.
  • Menus. Delete all values that refer to guidance packages you want to remove (they will probably be at the end of the list following those with GUID names).
  • NewProjectTemplates\TemplateDirs. Expand each of the subkeys (the name of each one is a GUID) and expand the /1 key below that. If you find one where the (Default) value is the name of a guidance packages you want to remove, delete the entire GUID key and the /1 key below that.
  • 4. Go back to your XML file, remove all the <GuidancePackage> elements that refer to guidance packages you want to remove, and then save the file.
  • 5. If you installed any of the guidance packages you want to manually remove from a Windows Installer, run the Windows Installer CleanUp utility to clean up the Windows Installer–related registry settings. For information about the Windows Installer CleanUp utility, including download information, see Description of the Windows Installer CleanUp Utility.
  • 6. If you have removed the settings for all registered guidance packages and want to remove the Guidance Automation Extensions from your computer, the Remove option in the Add/Remove Programs dialog box will now succeed.

Last edited Jun 10, 2008 at 1:06 PM by jonathan, version 1

Comments

No comments yet.