User Guide - Deployment Manager

Changes between revisionsDate Changes2010-06-10 Updated for 7.0.2010-07-20 Layout update.2010-11-12 Updated configuration for IIS7+2011-03-09 Updated for version 7.0.22011-11-25 Removed the Configuration chapter. This chapter is moved tothe Install Guide Deployment Manager.docCopyright © CDC Software 2011. All rights reserved.The CDC Software logo and CDC Supply Chain logo are registeredtrademarks and/or trademarks of CDC Software.No part of this documentation may be reproduced or transmitted in any form or by any means without the written permission of CDC Software.Table of ContentsOverview (4)Main Window (5)Products (5)Import (6)Remove (7)Publish (7)Un-publish (8)Instances (8)New / Change (9)Remove (10)Show/Hide (10)Deployment Web Page (11)Update Page (11)Copy Address to Clipboard (11)Appendix A: Templates Explained (12)Main.template.html (12){NothingPublished} (12){ProductRow} (12){InstanceRow} (12)Template Variables (13)Configuration Variables (13)Product Variables (13)Instance Variables (14)OverviewThis document describes how to use the CDC Smart Client Deployment Manag-er. Please refer to Install Guide - Deployment Manager.doc for more details on how to configure the Deployment Manager before you starts using it.You are required to be an experienced Windows user and have some knowledge about Internet Information Services (IIS).Main WindowWhen the application has been configured the first time or when you start theCDC Smart Client Deployment Manager normally, the main window will bepresented to you.The main window has four main areas:•Products•Instances•Deployment Web PageProductsWhen you run CDC Smart Client Deployment Manager for the first time there will be no products in the grid. You will have to start to import the products you want to publish on the Deployment Web Page.The grid for the Product contains the following information:•Name – This is the name of the Product.•Latest Version – This is the latest version that has been imported.•Published – If checked then the product is published.ImportWhen you click the Import button you will get a dialog for selecting a Zip-file.Browse to the directory where you’ve put the product version files that you are going to publish.The files you are looking for are named according to the following format: <ProductName>_<VersionNumber>.zipSelect the file to import in the dialog and click Open.It will take a couple of seconds up to a minute (depending on how big the zip-file is) before the import is done. You can follow the progress with the progress bar.When the import is complete you return to the main window and now the new product is shown in the grid. If another version of the product was already im-ported, then only the Latest Version is updated (if the product version is newer than the previous imported version).It is possible to import an older version than the newest imported version for a product, but you will receive a warning.RemoveYou can only choose to remove a product if it’s not published. You will get awarning before removing your product.All versions and instances for the product will be removed if you answer yes to the question.PublishThe Publish button becomes available when you’re selecting a product that isn’t already published.When you click this button, the application will check if any instances exist for this product. If no instances exist then the application will ask you to create anew instance before continuing to publish the product.See the Instances section (page 9) on how to create a new instance.To be able to publish the product it needs to have a name of the virtual directory to where the instances for the product will be published via hyperlinks from the Deployment Web Page.After you click the OK button, the Deployment Web Page will be updated with the published product and instances.Un-publishThe Unpublish button will be available when a product is selected in the pub-lished list.When un-publishing a product, the virtual directory for that product is removed and the Deployment Web Page is updated.InstancesThis grid contains all the instances that have been setup for the product. A prod-uct needs at least one instance to be able to be published.The grid contains the following information:•Name – The name of the instance.•Product Version – The product version that this instance is currently run-ning.•Visible – If the instance is visible on the Deployment Web Page. If it’s not visible then it’s not possible to run it either.New / ChangeClicking the New or Change button will show the Instance dialog.•Name – The name of the instance. Characters allowed are a-z, A-Z, 0-9 and underscore. This field is mandatory. If you are changing an existing instancethen this field is not editable.•Caption – The caption of the instance. This is what will be shown as the hyperlink text for the instance. This field is mandatory.•Description – A short description of the instance. This will be shown on the webpage. This field is optional.•Parameters – The parameters are product- and version dependent. This means that they are different from product to product and could also be dif-ferent between versions for the same product. It is not a requirement for aproduct to have any parameters and the parameters can be optional or man-datory. They may also be required to be on a specific format. See the prod-ucts documentation what parameters they are expecting.•Product Version – Here you select what product version to run for the in-stance.When you save the instance by pushing the OK button, the Deployment WebPage will be updated with the new/changed instance, if the product is already published.If you are updating the Product Version or if you’re setting up a new instance, and you have a certificate that requires a password, you will be asked for thepassword when saving the instance.RemoveIf you click the Remove button you will get the following message.If you click the Yes button then the instance will be removed and the Deploy-ment Web Page will be updated if the product is published.If you are deleting the last instance and the product is published you will getanother message:If you click the Yes button then the instance will be removed and the productwill be unpublished. The Deployment Web Page will be updated accordingly.Show/HideThe Show/Hide button is only enabled if there are two or more instances for the product, since one instance always have to be visible for a product to be able to publish it.When you hide an instance it will update the Deployment Web Page and itwon’t be possible to run that instance until you make it visible again.Deployment Web PageThis part of the application is actually a browser showing every change made to the Deployment Web Page live.Update PageWhen clicking this button, the webpage will be regenerated from the templates.This is usually used if you have changed any of the templates and want to see the new changes on the webpage.Copy Address to ClipboardIf you want to copy the URL for the Deployment Web Page then you can click this button and the URL will be copied to the clipboard for you. Then you can just paste the URL in any browser to see the page.Appendix A: Templates ExplainedThis appendix explains the different templates, what they are used for and how to edit them.Main.template.htmlThis is the main template that is showing the Deployment Web Page.The name for the finished file is default.htm and it will be located in the direc-tory given in the configuration dialog (the path to the main virtual directory).This template has some special tags used for special sections in the template:•{NothingPublished}…{/NothingPublished}•{ProductRow}…{/ProductRow}•{InstanceRow}…{/InstanceRow}Anywhere in the template you may use any Configuration variable.{NothingPublished}This section contains the HTML that will be shown if there are no products pub-lished.That means that if no products are published, then this section is the only one showing. The {ProductRow} (with the including {InstanceRow} tag) will besuppressed.You may use any Configuration variables within this tag.{ProductRow}This section contains the HTML for showing a published product with its in-stances.A {ProductRow} tag must contain an {InstanceRow} tag somewhere within itstag.You may use any Product or Configuration variables within this tag.{InstanceRow}This section contains the HTML for showing a single instance for a published product. The tag must be present within a {ProductRow} tag.You may use any Product, Instance or Configuration variables within this tag.Template VariablesThis is variables you may use in the template files within the different sectiontags of the template.Configuration VariablesThis is variables for getting information from the configuration file. Some ofthese variables are the same as the fields that can be found in the configurationdialog.Several of these variables are not very usable. The recommended variables touse are in bold.Variable Name Description{C:WebserverName} The name of the web server.{C:MainVirtualDirectoryName} The name of the main virtual directory.{C:MainVirtualDirectoryPath} The path to the main virtual directory on the web server.{C:StagingArea} The path to the Staging Area on the web server.{C:InternetGuestAccount} The name of the Internet Guest Account.{C:CertificateFile} The path to the Certificate file used for signingdeployment manifests.{C:AskForCertificatePassword} If the user should be asked a question for the certificatepassword or not (True or False).{C:LastImportDirectory} The last directory used when importing a product.Product VariablesThis is variables that can be used to show information about the product. Thesevariables can only be used within a {ProductRow} tag.Several of these variables are not very usable. The recommended variables touse are in bold.Variable Name Description{P:ProductName} The product name.{P:VirtualDirectoryName} The name of the virtual directory for the product.{P:LatestVersion} This will show the latest version installed for theproduct.{P:Company} The company that developed the product.{P:IsPublished} Shows the text True if the product is published or FalseVariable Name Descriptionif it’s not.{P:ProductId} The product identity. Used internally.{P:InstallPath} The directory where the product is installed (full path thatpoints to a directory within the staging area).{P:VirtualDirectoryPath} The path to the virtual directory for the product.Instance VariablesThese variables are used to show information about each instance for a product.These variables must be used within an {InstanceRow} tag.Several of these variables are not very usable. The recommended variables touse are in bold.Variable Name Description{I:Name} The name of the instance.{I:Caption} The caption for the instance. This is more descriptivethan the name.{I:Description} The description of the instance.{I:Parameters} The parameter list to send to the product application. Ifthere are no parameters in the list then it will be empty.The parameters are given on the format:&<Name1>=<Value1>&<Name2>=<Value2> {I:ProductVersion} This is the current product version that the instance isrunning.{I:VersionPath} This is the full path to the version directory for the currentproduct version. The path points to a directory within thestage area.{I:ApplicationManifestFile} The full path including the filename to the applicationmanifest file for the current product version.{I:DeployManifestFile} The deploy manifest filename. Used internally.。