Updating and Deploying a Composite Application 

To illustrate the deployment scenario described in this article, this example uses a composite application for a fictitious company called Acme Auto Parts. The composite application, which includes both NSF and Eclipse components, displays views of an employee's Inbox as well as views of the Acme Tasks & Tracking database and the Acme Problem Reports database. When an employee selects an email that contains a problem report number, relevant documents from the tasks and problem reports databases are displayed.

In this scenario the Acme Problem Reports and Acme Tasks & Tracking database are applications that the employee already has access to. The Acme Composite Application (acme_comp_app.nsf) and Acme Update Site (acme_update_site.nsf) for the original version have already been deployed on the server by the Administrator.

This scenario will describe an upgrade from an original version (version 1) of the application to a new version (version 2). The new version can include component additions/removals/changes. It can also include updated versions of Eclipse components contained in the application.

Prerequisite

This assumes that the original version (version 1) of the application has already been deployed on the server.
In the example:
Acme Composite Application (acme_comp_app.nsf) is on server.
Acme Update Site (acme_update_site.nsf) is on server.

Roles

In this scenario the following roles are used:

Deployer – Should be a Lotus Domino Administrator with appropriate privileges to administer the composite application and update site databases. Provides the Assembler with files to modify. Receives updated files from the Assembler. Performs the updates on the databases which are accessible by end users.

Assembler – (For simplicity this scenario is also considering development changes to be done by the same person, but there could be separated Developer and Assembler roles.)
Receives original versions of files from Deployer. Updates Eclipse plug-ins and features used in the composite application. Makes changes to the composite application and the Update Site. Provides these changes to the Deployer.

End user – Uses the application. Used the original version of the application. Later accesses the new version of the application. When accessing the new version will see the new content and be prompted to install any new or upgraded plug-ins they need.

Steps

DEPLOYER Provide necessary copies to the Assembler

1. In the Notes client, create a new copy of the composite application (ex: Acme Composite Application). This will be a copy used and modified by the Assembler only.
Detailed instructions:
- Right-click the application icon and choose “Application”, then “New Copy”
- Edit the title as appropriate. (ex: Acme Composite Application working version 2)
- Edit the file name as appropriate (ex: acme_comp_app_working_v2.nsf)
- Click “OK” to finish.


2. Create an operating system copy or a replica of the Update Site database for the Assembler. (This should not be a new copy, so that the replica ID will remain the same.)


3. Ensure access control and encryption settings on the two databases (from steps 1 and 2) will allow the Assembler access.



4. Provide the Assembler with the two databases.

ASSEMBLER Make updates to the Update Site

1. Create new plug-ins/features.

2. Add these to the Update Site, using any of the import functions.

ASSEMBLER Make updates to the Composite Application

1. Open the Composite Application in the Composite Application Editor.

2. Update the version references in any Eclipse components that have updates.
Detailed instructions:
- Right click and choose “Edit Component Properties”
- In the Advanced Properties dialog, navigate to the “Advanced” tab.
- Modify the “version.feature” Value to be the new feature version value.
- Modify the “match.feature” type if required.
- Choose “OK” to finish.


3. Perform any additional updates to the application.

4. Save and Close the application.

ASSEMBLER Provide changes to the Deployer

1. Create a design template from the new Composite Application. It is recommended that the name of the new database include version information for reference purposes.
Detailed instructions:
- Right-click the application icon and choose “Application”, then “New Copy”
- Edit the title as appropriate. (ex: Acme Composite Application Template version 2)
- Edit the file name as appropriate. Change the file name extension to the standard for Notes templates: NTF. (ex: acme_comp_app_template_v2.ntf)
- Under “Specify What to Copy” choose the “Application design only” option.
- Click “OK” to finish.


2. In the Notes client, create a new copy of the Acme Update Site. It is recommended that the name of the new database include version information for reference purposes. Detailed instructions:
- Right-click the application icon and choose “Application”, then “New Copy”
- Edit the title as appropriate (ex. Acme Update Site version 2 updates).
- Edit the file name as appropriate. (ex: acme_update_site_v2_updates.nsf)
- Click “OK” to finish.


3. Provide the modified Update Site and Template files to the Assembler.
(ex: acme_update_package_v2.zip
containing acme_update_site_v2_updates.nsf
and acme_comp_app_template_v2.ntf)

DEPLOYER Add new content to the existing Update Site

Import the content from the Assembler provided Update Site to the existing Update Site.
Detailed instructions:
- In the Notes client, open the original Update Site. (ex. Acme Update Site)
- Choose the “Import Database…” button.
- In the "Import Update Site Database" dialog, choose Browse to find the modified Update Site. (ex. Acme Update Site version 2 updates)
- Click OK to close the dialog and perform the import.
- The Features and Plugins list will show the newly added content.

DEPLOYER Update the Composite Application

1. Update the design of the original Composite Application to the Assembler provided design.
Detailed instructions:
- Copy the template to your local or server data directory.
- In the Notes client, right-click the application icon and choose “Application”, then “Replace design”.
- From the dialog , choose the new template. (ex. Acme Composite Application Template version 2)
- Accept the warning that design elements will be replaced and wait for the replace to complete.


2. Optional: rename the database to indicate the new version.
Detailed instructions:
- Right-click the application icon and choose “Application”, then “Properties”
- In the properties dialog, enter a new title. (ex. Acme Composite Application version 2)
- Close the dialog.

Summary

This scenario showed how you can upgrade a Composite Application that has new component content, including Eclipse component updates. There was an assumption of different roles, so the end user accessible content is only modified when final.

Resources

Creating and using an NSF-based update site