Deploy a web service using the Deployment App

Deploy and secure an web service using the Deployment App. Start with the Genero Archive (.gar) for the web Service.

Before you begin

  • Before you can use the Deployment App, you need to configure and enable the Genero Identity Provider (GIP) on your GAS. You use the StarterApp to perform the installation of the GIP. The Deployment App utilizes the Deployment Service. You must select these components in your GIP configuration at the time of installation.

  • You must have packaged your applications and services into a Genero Archive.
    Note:

    When you create a Genero Archive (.gar) with fglgar gar using the --service wsname.42m option, a web service configuration (.xcf) file is automatically generated from the app. If you have an existing web service configuration (.xcf) that you would rather use, you must create a MANIFEST file pointing to your web service configuration file.

    For more information about packaging a Genero Archive, see the Deploying apps with Genero Archive pages in the Genero Application Server User Guide.

The REST web service, in its source code, should already use the WSScope attribute to define the scopes that will provide security globally for the service (on the WSInfo record) or for its functions. You should have a list of such WSScope entries.

About this task

When you deploy the contents of a Genero Archive using the Deployment App, the registration of the web service is managed for you. Unlike the Genero application, however, the deployment does not include the generation of a CLIENT_ID or SERVER_ID for the web service.

  1. Start the Deployment App as an authorized user.
    The Deployment App application is located at http://host:port/gas/ua/r/admin/DeploymentApp.
  2. Deploy the .gar file.
    1. Click Deploy > Genero Archives....
      The Manage Genero Archives form displays.
    2. Click Deploy.
    3. Use the Select your Genero Archive to deploy dialog to select your Genero Archive (.gar).
    The application deploys and is listed under Genero Archive(s).
  3. Secure the Genero Archive.
    1. Select the row containing the deployed Genero Archive.
    2. Click Secure.
      All services contained by the archive are secured.
  4. Change the status of the deployed Genero Archive to Active.
    1. Select the row containing the deployed Genero Archive.
    2. Click Enable.
    The status changes from Inactive to Active.
  5. If the same Genero Archive (.gar) must be deployed on several GAS, repeat the procedure.
  6. If not already registered, register the web service scopes in the GIP using the Console App.
    Instructions are provided here.
    1. Open the Console App.

      To access the Console App, open a browser and enter: host:port/ua/r/admin/ConsoleApp

    2. Select Security > Services.
      The Service access list form appears.
    3. Click Create.
      A new, empty row is added to the service access list, with the cursor in the Service name field.
    4. Enter a name in the Service name field, and a description in the Description field.
      The name entered can be any name you wish.
      When you have finished, click OK.
    5. With the new service highlighted in the list, doubleclick (or click Scopes) to open the Scope list page for the service.
      The Scope list form displays for the new service. By default, a single scope was created using the name of the service.
    6. Add any additional scopes required by the service.
      It is the WSScope entries in the Genero source that determine what additional scopes need to be entered.
      To add a scope, click Create and enter the information requested.
    7. When you have finished entering all necessary scopes, click Back until you return to the front page of the Console App.