Jump to: navigation, search

Deploying the ClickOnce Application on Your Web Server

Use the Workspace Deployment Manager wizard to generate the file hierarchy that is required by the ClickOnce application on your web server.

During the deployment of the ClickOnce application, you are required to enter the following information in the Deployment Manager:

  • The deployment URL
  • The deployment version
  • The deployment certificate:
    • If you do have a deployment certificate, select the Sign with a provided certificate option, and then browse to select the certificate. You must also input the password in the dedicated text box.
    • If you do not have a deployment certificate, do not select the Sign with a provided certificate option. Without a signed package, a security warning is displayed whenever the client downloads the package.

Be sure to have this information ready before you begin.

The Procedure: Deploying the Interaction Workspace downloadable ClickOnce package on your web server contains the deployment steps for deploying Workspace on your web server.

Tip
You can put the Workspace downloadable package in a shared directory instead of on your web server, and then install Workspace from a shared directory.

Procedures

Purpose: Deploy the Workspace downloadable package on your web server by using the Workspace Deployment Manager Wizard

Important
The following procedure employs a Windows-based Deployment Wizard. If your HTTP server is running on a Solaris or Linux server, you must first build the deployment package on a computer that is running the Windows Operating System, and then copy the package to a compatible location on your Solaris or Linux HTTP server.

Prerequisites

  • Install the Deployment Manager and associated files from the Genesys Workspace disc or download image. See the Procedure: Installing Workspace Deployment Package on the Windows operating system.
  • Create an Application object of type Workspace from the Workspace Application template.
  • Microsoft .NET Framework 2.0 installed on the computer on which you run the wizard. This can be the computer on which you run your web server.


Start

  1. Open the WorkspaceDeploymentManager folder. This folder contains the application files required for deployment, including: WorkspaceDesktop.exe.
  2. Launch the WorkspaceDeploymentManager.exe application by double-clicking the file or selecting it from the Start menu. The Deployment Manager installs the ClickOnce files on your web server. The Welcome pane of the Deployment Manager is displayed (refer to Figure - The Workspace Deployment Manager splash page).
    The Workspace Deployment Manager splash page
  3. Click Next to proceed with the installation. Click Cancel to cancel the deployment.
  4. If you clicked Next, the Deployment Folder pane is displayed (refer to Figure - Workspace Deployment Manager Deployment Folder pane). Specify the location on your server in which you want the ClickOnce files to be deployed. If you are deploying to a Solaris server or a Linux server, specify a local folder on the Windows-based computer on which you are running the Deployment Wizard. From this location, you will build the deployment package that you must manually copy to your Solaris or Linux HTTP server.
    Workspace Deployment Manager Deployment Folder pane
  5. Click Next to proceed with the installation. Click Cancel to cancel the deployment. Click Back to return to the previous panel.
  6. If you clicked Next, the Package Information pane is displayed (refer to Figure - Workspace Deployment Manager Package Information pane). This pane is filled-in automatically. Modify these parameters only if necessary.

    You can change the application name, the publisher (which is displayed in the publish.htm page), and the base URL, which is the URL that corresponds with the virtual directory that is linked to the deployment folder.

    There are one or more optional check boxes that you can use to add plug-ins to the Workspace application:
    • Add custom files -- Select to add custom content such as simple data files, including rebranding icons or sound files, or file assemblies that implement your Interaction Workspace Customization API.
    • <plug-in name> -- Select this option to use your installed plug-in, such as Workspace Desktop Edition SIP Endpoint, Social Engagement plug-in, Localization Packs, and so on.

    Click Next to proceed with the installation. Click Cancel to cancel the deployment. Click Back to return to the previous panel.
    Workspace Deployment Manager Package Information pane
  7. If you clicked Next, and if you selected Add Custom Files in the previous view, the Custom Files panel is displayed (refer to Figure - Interaction Workspace Deployment Manager Custom Files pane). This window enables you to add custom content to the out-of-the-box Interaction Workspace.
    Interaction Workspace Deployment Manager Custom Files pane
    • Relative Path: The path where the file will be copied relative to the core Workspace installation directory.
    • Data File: Not used — This should be left unchecked.
    • Optional: Must be checked if the file is part of an optional module that is loaded according to user privileges. A module is considered as optional if the value of the startupLoaded attribute is set to false in the .module.config file, and the same module is associated to a task in the same file.
      Important

      The .module-config file that core Workspace uses for module declaration, as well as any language dictionary file required by the module, must be specified as NOT optional so that they are loaded unconditionally at Workspace start-up.

    • Group Name: For mandatory files (files that have Optional unchecked), always specify Core. For optional files, specify the group name that is assigned to the module description in the .module-config file by the clickOnceGroupsToDownload attribute. For example:
      <task name="InteractionWorkspace.Custom.ThePrivilege" 
      clickOnceGroupsToDownload="TheGroup" 
      modulesToLoad="TheModule" />

    The following table provides examples of settings for a typical optional module comprising a DLL, a dictionary file, and a .module-config file:

    File Name Relative Path Data File Optional Group Name
    .module-config file <empty> unchecked unchecked Core
    .dll file <empty> unchecked checked <custom group>
    language file (.language-code.country-code.xml) languages unchecked unchecked Core
  8. Click Next to proceed with the installation. Click Cancel to cancel the deployment. Click Back to return to the previous panel.
  9. If you clicked Next, the Client Configuration pane is displayed (refer to Figure - Workspace Deployment Manager Client Configuration pane). In this pane, provide the following information:
    • The address and port number of your local Genesys Configuration Server
    • The name of the Interaction Workspace (client) application that you created in the Configuration Layer by using Genesys Administrator

    Enabling Client-side Port Definition

    To define the client-side port functionality, check Use Client-side Port by specifying the port number and/or the IP address. Checking this option enables the following two text fields:

    • Port Number -- The port number that a client will use to make a TCP/IP connection to Configuration Server. If the value is empty, this parameter is not used.
    • IP Address -- The IP address or the host name that a client will use to make a TCP/IP connection to Configuration Server. If the value is empty, this parameter is not used.

    If you specify one or both values, they will be set in the Workspace.exe.config file.
    There are two additional options in this dialog box:
  • Allow the end-user to change connection parameters on the login prompt -- Enables agents to change their connection parameters when they log in.
  • Allow the end-user to install the .NET Framework if it is not already installed -- Enables an agent to download and install .NET Framework to their workstation if you have not already installed it on the workstation.
Workspace Deployment Manager Client Configuration pane
  • Click Next to proceed with the installation. Click Cancel to cancel the deployment. Click Back to return to the previous panel.
  • If you clicked Next, the Signing pane is displayed (refer to Figure - Workspace Deployment Manager Signing pane). For more information about how to create or obtain a signing certificate, refer to the "ClickOnce Deployment and Authenticode" page on the Microsoft Developer Network web site:
    http://msdn.microsoft.com/en-us/library/ms172240.aspx
    Workspace Deployment Manager Signing pane
  • Choose the type of signing certificate that you are using:
    • Click Do not Sign. If you do not provide a certificate, a security warning is displayed whenever the client downloads the package.
    • Click Sign with a provided certificate to enable the Selects a certificate field.
  • Click the browse button to navigate to the certificate.
  • Enter the password for the certificate in the Password field.
  • Click Next to proceed with the installation. Click Cancel to cancel the deployment. Click Back to return to the previous panel.
  • If you clicked Next, the Ready to Build pane is displayed (refer to Figure - Workspace Deployment Manager Ready to Build pane). This pane contains a summary of the files that will be deployed on your web server and a confirmation of the deployment URL.
    Interaction Workspace Deployment Manager Ready to Build pane
  • Click Next to complete the deployment. Click Cancel to cancel the deployment. Click Back to modify any of the previous panes.
  • If you clicked Next, the Deployment Manager deploys the Workspace ClickOnce application in the path that you specified at the beginning of the wizard execution. This can be the appropriate place on your web server.
    When the deployment is complete, the Deployment Finished pane is displayed (refer to Figure - Workspace Deployment Manager Deployment Finished pane). This pane contains messages that relate to the success of the deployment.
    Interaction Workspace Deployment Manager Deployment Finished pane
  • Click Finish to close the Workspace Deployment Manager.
    Deployment proceeds. When deployment is complete, the publish.htm web page is opened in your default browser automatically (refer to Figure - Workspace pubish.htm web page viewed through Microsoft Internet Explorer).
    Interaction Workspace pubish.htm web page viewed through Microsoft Internet Explorer

    The publish.htm web page confirms that the Workspace package is published and provides you with the version number.
    If you have not installed the prerequisites, the page contains a link to the prerequisite installers.
  • If you are deploying on a Solaris or Linux HTTP server, copy the collection of files that was created by the Deployment Wizard on your Windows-based computer to your HTTP server.
  • End

    Next Steps

    • If you have not installed the prerequisites, in the publish.htm web page, click Install to launch setup.exe to install the prerequisite installers.
    • If you already have installed the prerequisites, the application bootstrap either installs a new version automatically, upgrades your existing version, if necessary, or starts the application, if it is installed and up to date.

    Purpose: By default, the Apache web server does not permit the download of documents of specific MIME types. Apache must be configured to enable the ClickOnce package.

    Prerequisites

    • Windows Server 2003 or Windows Server 2008 server or Solaris Server or RHEL (Linux) server
    • Apache Server 2.2
    Start
    1. In the conf/mime.types file (in the Apache install folder), add the following lines:
      application/x-ms-application application
      application/x-ms-application manifest
      application/octet-stream deploy
    2. Save the file.

    End

    Next Steps

    Purpose: By default, the Microsoft IIS6 web server on Windows 2003 does not permit the downloading of documents of specific MIME types. IIS6 must be configured to enable the ClickOnce package.

    Prerequisites

    • Windows Server 2003
    • Microsoft IIS6
    Start
    1. From Administrative Tools, start Internet Information Services Manager.
    2. Right click the tree leaf that represents your server.
    3. Select Properties from the contextual menu.
    4. In the Properties dialog box, click Mime Types.
    5. Click New to add each of the following configuration pairs:
      .application => application/x-ms-application
      .manifest => application/x-ms-application
      .deploy => application/octet-stream
    6. Click OK.
    7. Click OK to validate the new MIME types list.

    End

    Next Steps

    Purpose: To ensure that the Workspace application was correctly deployed on your web server and client workstation.

    Start

    1. On a client workstation, open a new Internet browser window.
    2. In the Address field, enter the URL of the Workspace web application:
      http://<host>/<application name>/publish.htm
      For example:
      http://SUITE80/Workspace/publish.htm
    3. Press Enter on your keyboard. The Workspace ClickOnce publish window opens (see the Figure - Workspace publish window).
      Workspace publish window
    4. If all prerequisites are installed, setup is started automatically. If all prerequisites are not installed, a warning is displayed with the list of missing prerequisites. Click Install to install the Workspace application prerequisites.
    5. If a security-warning dialog box appears, click Install.
      When installation is complete, a shortcut is placed on the desktop, after which the application launches. The Workspace agent-login window is displayed.
    6. Enter the following information into the agent-login panel and the connection-parameters panel:
      • User Name -- A valid user name that is configured in the Configuration Layer
      • Password -- The valid password for the specified user name
    7. Click Login to continue logging in to Workspace; click Cancel to close the agent-login window without logging in.
      Refer to Workspace User's Guide for more information about how to log in to Workspace and use the application.

    End

    Next Steps


    This page was last modified on May 4, 2016, at 07:36.

    Feedback

    Comment on this article:

    blog comments powered by Disqus