Packaging and Deployment section

The Packaging and Deployment section of the Administrator lets you create and deploy CAR files. You can also create J2EE EAR or WAR files that include an existing ColdFusion application and the ColdFusion runtime system.

ColdFusion Archives page

The ColdFusion Archives page includes tools that let you archive and deploy ColdFusion applications, configuration settings, data source information, and other types of information to back up your files faster. The complete list of archivable information includes the following:

  • Name and file location

  • Server settings

  • ColdFusion mappings

  • Data sources

  • Solr collections

  • Scheduled tasks

  • Event gateway instances

  • Java applets

  • CFX tags

  • Archive to do lists

After you archive the information, you can use the Administrator to deploy your web applications to the same ColdFusion server or to a ColdFusion server running on a different computer. Additionally, you can use these features to deploy and receive any ColdFusion archive file electronically.

The Archive Settings page lets you configure various archive system settings that apply to all archive and deployment operations. For more information, see the Online Help.

Build an archive

To archive a definition,

  1. To access the ColdFusion Archives page, select Packaging and Deployment > ColdFusion Archives in the left navigation pane of the ColdFusion Administrator.

  2. On the ColdFusion Archives page, locate the name of the archive definition that you want to archive, and then click the Build Archive icon. The Archive Wizard appears.

  3. In the Archive Wizard, review the archive summary information, and then click Next to continue. The Choose Archive File Location page appears.

  4. In the Choose Archive File Location page, do the following:

    • In the File Name text box, specify the full path where you want to store the archive, followed by the name of the archive.

      The archive name must have a .car extension.

    • For U NIX users only: If you must run this archive as a privileged user, select the Run This Archive As A Specific User option, and then enter any system account name in the User name text box and the corresponding account password in the Password text box. The user name and password must match the existing user name and password for this system; the archive process will run as that user. If the user name and password do not match the existing user name and password for this system account, the build procedure fails.

  5. Click Next to create the archive.

When the archive operation completes, one of the following archive messages appears:
  • Build Successful: The archive was successfully created and stored in the location that you specified in step 4. Click OK and then click Close on the wizard page.

  • Build Failed: The archive was not created. To determine the cause of the problem, review the information appearing on the page, and click Details to further analyze the cause of the problem.

J2EE Archives

J2EE archives overview

ColdFusion lets you create an EAR or WAR file that contains an entire application. This archive file contains the ColdFusion web application, settings for ColdFusion (such as data source definitions), the CFM pages used by your application (text or compiled Java), and optionally, the ColdFusion Administrator.This feature lets you quickly create an archive file that a J2EE administrator can use to deploy your ColdFusion application.

J2EE archives are different from ColdFusion archives (CAR) files. For information on CAR files, see Create and deploy applicationarchives. For details, see ColdFusion Archive overview.

Context root Because the J2EE environment supports multiple, isolated web applications running in a server instance, each J2EE web application running in a server is rooted at a unique base URL, called a context root (or context path). The J2EE application server uses the initial portion of the URL (that is, the portion immediately following http://hostname) to determine which web application processes an incoming request.For example, if you are running ColdFusion with a context root of cfmx, you display the ColdFusion Administrator using the URL http://hostname/cfmx/CFIDE/administrator/index.cfm.Most J2EE application servers allow one application in each server instance to use / (forward slash) for the context root. The Remote Development Services (RDS) web application is not required if you use a context root of /.

J2EE Archives page

The J2EE Archives page lets you create an enterprise application archive (EAR) file or web application archive (WAR) file that contains the following items:

  • The ColdFusion web application.

  • Server settings, such as data sources and custom tag paths.

  • The CFML pages of your application, stored in the root directory of the ColdFusion web application.

With this EAR or WAR file, a J2EE administrator can deploy your ColdFusion MX application to a J2EE application server.

If you are creating a cluster of server instances when running the multiserver configuration, use this page to create the WAR or EAR files required to create each of the servers in the cluster.

You can create a J2EE archive regardless of whether you are running ColdFusion MX in the server configuration or the J2EE configuration. However, you must be running the J2EE configuration to deploy an EAR or WAR file.

Option

Description

Achive Name

Specifies a name for the J2EE archive definition. This is also the name given to the EAR or WAR file.

Application Directory

Specifies the location of the CFM files to be included beneath the web root of the ColdFusion web application.

Distribution Directory

Specifies the directory where ColdFusion places the EAR or WAR file. ColdFusion uses the name archivename.ear or archivename.war, depending on the archive type.

Archive Type

Specifies whether ColdFusion creates a Web Application Archive (WAR) file or an Enterprise Application Archive (EAR) file.

Context Root (valid for EAR)

If you create an EAR file, you can optionally specify a context root for the ColdFusion web application. The default is an empty context root. For more information, see the J2EE Packaging overview.If you create a WAR file, the context root is handled in an application-server-specific manner. In some application servers, the default context root is the name of the WAR file; in others, you specify the context root using the deploy tool or through a server-specific configuration file.

Serial Number

Specifies a valid serial number for ColdFusion Enterprise Edition.

Previous Serial Number (if Upgrade)

Specify the serial number of the previous ColdFusion installation.

Include COM Support

Include COM Support Specifies whether to include the modules that provide COM support. Omitting COM support reduces the size of the archive by about 12 MB.

Disable Debugging

Specifies whether to disable debugging in the ColdFusion web application.

Include CFML Source

Specifies whether to use the original CFM files or to convert the pages to Java bytecode.

Include CF Administrator

Specifies whether to include the modules and directories for the ColdFusion Administrator (the CFIDE directory structure). Omitting the ColdFusion Administrator reduces the size of the archive by about 2 MB.

Configure Data Sources to be Included in Archive

Specifies the data sources to include in the J2EE archive. Use the Right and Left Arrow buttons to select and remove data sources. Use the Double Arrow buttons to select and remove all data sources with one click.