Deploying, enabling, and running applications on GAS

Use these examples for building archives, deploying applications, enabling, and running them locally on the GAS.

As a prerequisite, you must have your applications and/or services created, compiled, and tested. Consolidate all the necessary files for your archive under a root directory.

In this page there are examples for building archives, deploying, enabling, and running applications:

For a full understanding of what Genero archiving offers, please read all archiving topics in this section.

Overview of the main tasks

This procedure provides you with a quick overview of the main steps for archiving an application using fglgar, and deploying to local and remote servers.

  1. Prepare the required program files, and organize those in a directory for packaging.
    See Steps to packaging applications.
  2. Create the archive file using the fglgar gar command.
    See Create Genero Archive or Create Genero Archive from MANIFEST
  3. Deploy the archive file.
    You deploy the archive on your GAS installation using one of the following methods:
    • The gasadmin command line tool. See Deploy an archive with gasadmin.
    • The Genero deployment portal. For more information, go to the Deploy an archive with the Deployment App in the Single Sign-On User Guide.
  4. Enable the archive.
    This makes applications in the archive available to end users.
    You enable the archive on your GAS installation using one of the following methods:
    • The gasadmin command line tool. See Enable a deployed archive with gasadmin.
    • The Genero deployment portal. For more information, go to the Deploy an archive with the Deployment App in the Single Sign-On User Guide.
    Note:

    If the GAS is on an external web server, you can not manage applications with gasadmin.

Build an archive with public resources

An archive can contain common or public resources such as logos, images, reports, etc., that all deployed applications on the GAS can use. Using fglgar as shown in this procedure creates this type of archive.

As a prerequisite, you have put your application's public images in a dedicated directory of your archive directory. You can name it, for example, "myAppPublicImages".

Create the Genero Archive (gar) file.
For example, at the command line type the following command with the --resource option specifying the name of the public image directory in the archive directory:

fglgar gar --resource myAppPublicImages --application myApp.xcf

Build an archive with deployment triggers

An archive can be defined with deployment parameters. These are commands that execute when deploying and undeploying an application on the GAS. Using fglgar as shown in this procedure creates the archive with deployment trigger options.
Note:

Deployment triggers are typically not required, you can deploy your applications without them.

Create an Genero Archive (gar) file.
For example:
fglgar gar --application myApp.xcf --trigger-component cpn.gar.execution.local 
--deploy-trigger "fglrun mydeploy.42r" --undeploy-trigger "fglrun myundeploy.42r"
Where:
  • The --trigger-component option references a trigger component in the GAS as.xcf that defines the runtime environment where triggers are run. If not set, it defaults to "cpn.gar.execution.local".
  • The --deploy-trigger specifies your DEPLOY command.
  • The --undeploy-trigger options specifies the UNDEPLOY command.
These commands are saved in a MANIFEST file in the gar. See TRIGGERS (for manifest).
Important:

If a MANIFEST file already exists when you run the command, errors will be raised.

Deploy your application on your machine

About this task:

Once you have created an archive for your application, you can now deploy it locally on your machine where the GAS is installed. If the standalone dispatcher on your GAS installation is not already started, run it from the command line using httpdispatch.

Deploy your Genero Archive (gar) file.
You deploy the archive on your GAS installation using one of the following methods:
  • The gasadmin command line tool. See Deploy an archive with gasadmin.
  • The Genero deployment portal. For more information, go to Deploy an archive with the Deployment App in the Single Sign-On User Guide.

Enable your application on your machine

Once you have deployed your application, you can now make it available for end users by enabling it on the machine where the GAS is installed. If the standalone dispatcher on your GAS installation is not already started, run it from the command line using httpdispatch.

Enable your application.
You enable the archive on your GAS installation using one of the following methods:
  • The gasadmin command line tool. See Enable a deployed archive with gasadmin.
  • The Genero deployment portal. For more information, go to the Deploy an archive with the Deployment App in the Single Sign-On User Guide.

Run the deployed application

Once the application is enabled, you can now run it. If the standalone dispatcher on your GAS installation is not already started, run it from the command line using httpdispatch.

In a browser enter the address of your deployed application.

http://localhost:6394/ua/r/myApp

In this example, the URL is looking for a configuration file named myApp.xcf.
You should see your application displayed and be able to interact with it. You have successfully deployed an application.