Setting up your development environment

In order to perform many of the tasks, such as customizing the user interfaces, you must first set up your development environment.

Requirements

  1. LiveCycle ES2.5 with the Correspondence Management Solution Accelerator

    You should have LiveCycle ES2.5 with the Correspondence Management Solution Accelerator installed on your system. Once installed, you can locate the Solution Accelerator SDK folder in the C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5 directory. For complete installation instructions, see Installing and Deploying Solution Accelerators at http://www.adobe.com/go/learn_lc_install_sa_95.

  2. LiveCycle Workbench 9.5

    The Correspondence Management Solution Accelerator requires Workbench to author processes. The build scripts look for the required SDK and libraries in the default Workbench install directory. For information about setting up your development environment, see Installing Your Development Environment at http://www.adobe.com/go/learn_lc_installDevEnv_9.

  3. Flex SDK 3.4.1

    The Correspondence Management Solution Accelerator and its related building blocks are developed and tested with Flex SDK 3.4.1. It is strongly recommended that you download and use the specified SDK version. The build scripts and projects need Flex SDK 3.4.1 and datavisualization flex libraries both of which come bundled with Workbench.

  4. Flash Builder

    The Correspondence Management Solution Accelerator comes with several Flash Builder projects that you will need to import into Flash Builder in order to customize.

  5. Apache ANT

    You will require Apache ANT for building the individual projects and the top level EAR file.

Locating the Correspondence Management solution template and the building blocks

The Correspondence Management solution template is packaged as a zip file located at: C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\CorrespondenceManagement. It uses four building block: Asset Composer, Asset Manager, Data Dictionary and Expression Manager, which are located in their respective directories as follows:

Building Block

Path

Asset Composer

C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\assetcomposer

Asset Manager

C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\assetmanager

Data Dictionary

C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\datadictionary

Expression Manager

C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\expressionmanager

For each building block, the various client SWCs can be found under the C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\<building_block>\client\flex directory. These are the SWC libraries that are delivered:

SWC path

Description

\assetcomposer\client\flex\adobe-acm_rb.swc

The resource bundles SWC for the Manage Assets part of the Asset Composer building block. This SWC file contains bundles for all supported locales and is used as a compile time dependency for adobe-acm-presentation.swc

\assetcomposer\client\flex\adobe-acm_styles.swc

The styles SWC for the Manage Assets part of the Asset Composer building block. This SWC file contains the style sheets and various assets (animations, icons, skins etc.) that are used by the ACM building block.

\assetcomposer\client\flex\adobe-acm-ccr_rb.swc

The resource bundles SWC for the Correspondence Creator part of the Asset Composer building block. This SWC file contains bundles for all supported locales and is used as a compile time dependency for Correspondence Creator library project.

\assetcomposer\client\flex\adobe-acm-ccr_styles.swc

The styles SWC for the Correspondence Creator part of the Asset Composer building block. This SWC file contains the style sheets and various assets (animations, icons, skins etc.) that are used by the ACM building block.

\assetcomposer\client\flex\adobe-acm-domain.swc

The domain library for the Manage Assets part of the Asset Composer building block. It contains various domain classes encapsulating business data and behavior, and can be leveraged to build flex views atop with significantly lesser effort.

\assetcomposer\client\flex\adobe-acm-flex-mock-services.swc

The SWC library that contains mock representations for all the infrastructure services of the ACM building block. This SWC can optionally be used for developing flex views without actually running a server in the backend. The result is a much faster development.

\assetcomposer\client\flex\adobe-acm-flex-services.swc

The infrastructure services for the ACM building block. This SWC contains classes that provide client APIs for invoking the backend server APIs encapsulating the creation of channels and remote objects.

\assetcomposer\client\flex\adobe-acm-flex-utilities.swc

This utilities SWC contains a set of utility classes used by various ACM SWCs.

\assetcomposer\client\flex\adobe-acm-presentation.swc

The presentation SWC for the ACM building block. This SWC contains the presentation logic and the flex views that encompass various editors in the ACM building block.

\assetcomposer\client\flex\adobe-acm-tbxeditor.swc

The SWC library that encapsulates the Text Editor of the ACM building block.

\assetmanager\client\flex\adobe-amg-flex-domain-model.swc

The domain library for the Asset Manager building block. It contains various domain classes encapsulating business data and behavior, and can be leveraged to build flex views atop with significantly lesser effort.

\assetmanager\client\adobe-amg-flex-presentation.swc

The presentation SWC for the Asset Manager building block. This SWC contains the presentation logic and the flex views built atop the Asset Manager flex domain model.

\assetmanager\client\flex\adobe-amg-flex-presentation_rb.swc

The resource bundles SWC for the Asset Manager building block. This SWC file contains bundles for all supported locales and is used as a compile time dependency for adobe-amg-flex-presentation.swc.

\assetmanager\client\flex\adobe-amg-flex-presentation_styles.swc

The styles SWC for the Asset Manager building block. This SWC file contains the style sheets and various assets (animations, icons, skins etc.) that are used by the Asset Manager building block.

\datadictionary\client\flex\adobe-dct-flex-services.swc

The infrastructure services for the Data Dictionary building block. This SWC contains classes that provide client APIs for invoking the backend server APIs encapsulating the creation of channels and remote objects.

\datadictionary\client\flex\adobe-dct-widgets.swc

The flex component library for the Data Dictionary building block. It contains various out-of-the-box complete flex components which can be included in flex applications. These components comprise the editor, browser etc. for viewing or manipulating data dictionary artifacts.

\datadictionary\client\flex\adobe-dct-widgets_rb.swc

The resource bundles SWC for the Data Dictionary building block. This SWC file contains bundles for all supported locales and is used as a compile time dependency.

\datadictionary\client\flex\adobe-dct-widgets_styles.swc

The styles SWC for the Data Dictionary building block. This SWC file contains the style sheets and various assets (animations, icons, skins etc.) that are used by the Data Dictionary building block.

\expressionmanager\client\flex\adobe-exm-flex-expeval.swc

The flex client library for the Expression Manager building block.

For each building block, the various jars can be found under the C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\<building_block>\client\java and C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\<building_block>\services directory. These are the JAR files that are delivered:

JAR path

Description

\assetcomposer\client\java\adobe-acm-client.jar

Client jar for Asset Composer building block.

\assetcomposer\client\java\adobe-acm-extensions.jar

Extensions jar for Asset Composer building block.

\assetcomposer\services\adobe-acm-import-util.jar

Services jar for import utility in Asset Composer building block .

\assetcomposer\services\adobe-acm-persistence.jar

Services jar for persistence in Asset Composer building block .

\assetcomposer\services\adobe-acm-renderservices.jar

Services jar for render service in Asset Composer building block .

\assetcomposer\services\adobe-acm-webmodules.jar

Services jar for web modules in Asset Composer building block .

\assetmanager\client\java\adobe-amg-asset-manager-api.jar

Client jar for Asset Manager building block.

\assetmanager\services\adobe-amg-assembler.jar

Services jar for custom LCDS assembler in Asset Manager building block.

\assetmanager\services\adobe-amg-asset-manager-impl.jar

Core Services jar for Asset Manager building block.

\assetmanager\services\adobe-amg-cms-client-api.jar

API jar for cms client in Asset Manager building block.

\assetmanager\services\adobe-amg-cms-client-impl.jar

Services jar for cms client in Asset Manager building block.

\datadictionary\client\java\adobe-dct-client.jar

Client jar for Data Dictionary building block .

\datadictionary\services\adobe-dct-services.jar

Services jar for Data Dictionary building block.

\expressionmanager\client\java\adobe-exm-eltoswf-client.jar

Client jar for eltoswf (expression language to swf conversion) service in Expression Manager building block.

\expressionmanager\client\java\adobe-exm-expeval-client.jar

Client jar for expression evaluation service in Expression Manager building block

\expressionmanager\client\java\adobe-exm-expeval-extensions.jar

Extensions jar for expression evaluation service in Expression Manager building block.

\expressionmanager\services\adobe-exm-eltoswf-services.jar

Services jar for eltoswf (expression language to swf conversion) in Expression Manager building block .

\expressionmanager\services\adobe-exm-expeval-services.jar

Services jar for in expression evaluation Expression Manager building block .

Understanding the available projects

Sources are shipped for the whole solution template and parts of certain building blocks. The purpose of delivering source is to help you easily customize the solutions. The source folders are accompanied by ANT build scripts and Flash Builder project files to get you started immediately. You can easily import various delivered projects in your Flash Builder workspace and leverage various features of the IDE.

The building block projects available are categorized as follows:

Project Category

Description

Resource Bundles

The resource bundle projects contain the resource bundles for all the supported locales. These bundles include all the strings that are displayed on the flex UI.

  1. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\assetcomposer\client\flex\src\adobe-acm_rb-src.zip (Manage Assets part of the Asset Composer building block)

  2. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\assetcomposer\client\flex\src\adobe-acm-ccr_rb-src.zip (Create Correspondence part of the Asset Composer building block)

  3. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\assetmanager\client\flex\src\adobe-amg-flex-presentation_rb-src.zip (Asset Manager building block)

  4. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\datadictionary\client\flex\src\adobe-dct-widgets_rb-src.zip (Data Dictionary building block)

Styles

The style projects contain the style sheets as well as all the related assets including the icons, logos, skins etc.

  1. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\assetcomposer\client\flex\src\adobe-acm_styles-src.zip (Manage Assets part of the Asset Composer building block)

  2. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\assetcomposer\client\flex\src\adobe-acm-ccr_styles-src.zip (Create Correspondence part of the Asset Composer building block)

  3. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\assetmanager\client\flex\src\adobe-amg-flex-presentation_styles-src.zip (Asset Manager building block)

  4. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\datadictionary\client\flex\src\adobe-dct-widgets_styles-src.zip (Data Dictionary building block)

Presentation

The presentation projects include MXML views and the underlying presentation model. By modifying the presentation source, you can make changes to the way certain flex views look.

  1. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\assetcomposer\client\flex\src\adobe-acm-presentation.zip (Manage Assets part of the Asset Composer building block)

  2. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\assetmanager\client\flex\src\adobe-amg-flex-presentation-src.zip (Asset Manager building block)

The solution template projects provide access to all source files and can be modified. The Correspondence Management Solution Accelerator comes with two flex user interfaces: the Correspondence Creator and Manage Assets. The projects for these two user interfaces are available in the following paths:

  1. Manage Assets - C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\CorrespondenceManagement\FinancialServicesInsurance.zip\FSIApp\ManageTemplates

  2. Correspondence Creator - C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\CorrespondenceManagement\FinancialServicesInsurance.zip\FSIApp\CreateCorrespondence

Note that the above two projects contain the styles and resource bundles within themselves and are not split the way building block projects are split.

Flash Builder: Add the Flex SDK 3.4.1

Since all the projects are developed and tested against the Flex SDK 3.4.1, it is strongly recommended that projects are setup using the same version of the Flex SDK. The specified version of the Flex SDK is available under Workbench install folder. The default location of the SDK folder is:

C:\Program Files\Adobe\Adobe LiveCycle Workbench ES2\Flex_SDK

  1. In Flash Builder, click Window > Preferences .

  2. In the Preferences Dialog, navigate to Flash Builder > Installed Flex SDKs .

  3. Click Add .

  4. In the Add Flex SDK dialog, browse the Flex SDK by clicking the Browse button. Alternatively, you can simply enter the following path in the text field: C:\Program Files\Adobe\Adobe LiveCycle Workbench ES2\Flex_SDK.

  5. The Flex SDK name text field gets automatically filled.

  6. Click OK and Select the newly added flex SDK to make it the default.

  7. Click Apply and then OK to dismiss the dialog.

Flash Builder: Add Workspace Variables

The projects need several SWCs to resolve compile time dependencies. Most of the SWCs are available under the SA_SDK folder and the projects refer to the required SWCs via workspace variables. You need to define the following workspace variables:

Variable Name

Path

LIVECYCLE_SA_SDK_HOME

C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5

DATAVISUALIZATION_SWC_FOLDER

C:\Program Files\Adobe\Adobe LiveCycle Workbench ES2\Flex_SDK\frameworks\libs

For setting the workspace variables, perform the following tasks:

  1. In Flash Builder, click Window > Preferences .

  2. In the Preferences Dialog, navigate to General > Workspace > Linked Resources .

  3. Click Add . In the Name field enter LIVECYCLE_SA_SDK_HOME , and in the Location field enter C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5 .

  4. Click Add . In the Name field enter DATAVISUALIZATION_SWC_FOLDER , and in the Location field enter C:\Program Files\Adobe\Adobe LiveCycle Workbench ES2\Flex_SDK\frameworks\libs .

  5. The Linked Resources dialog, verify the defined path variables have been entered correctly.

  6. Click OK .

Flash Builder: Unzip Source Archives

In order to import them in the Flash Builder workspace, you first need to unzip them. It is recommended that you unzip the projects in the same directory as the zip archive. As an example, the zip file adobe-acm_rb-src.zip and the folder unzipped folder adobe-acm_rb-src should exist adjacent to each other. This is recommended because the cross project referencing and build script variables are written keeping the assumption in mind that the zip archive would be unzipped in-place itself. Choosing a different directory would require configuring the new path in all the build scripts.

You are required to unzip the following archives:

  1. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\CorrespondenceManagement\FinancialServicesInsurance.zip

  2. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\assetcomposer\client\flex\src\adobe-acm_rb-src.zip

  3. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\assetcomposer\client\flex\src\adobe-acm-ccr_rb-src.zip

  4. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\assetmanager\client\flex\src\adobe-amg-flex-presentation_rb-src.zip

  5. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\datadictionary\client\flex\src\adobe-dct-widgets_rb-src.zip

  6. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\assetcomposer\client\flex\src\adobe-acm_styles-src.zip

  7. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\assetcomposer\client\flex\src\adobe-acm-ccr_styles-src.zip

  8. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\assetmanager\client\flex\src\adobe-amg-flex-presentation_styles-src.zip

  9. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\datadictionary\client\flex\src\adobe-dct-widgets_styles-src.zip

  10. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\assetcomposer\client\flex\src\adobe-acm-presentation.zip

  11. C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\assetmanager\client\flex\src\adobe-amg-flex-presentation-src.zip

Flash Builder: Manage Templates Build XML

  1. Open the Manage Templates build.xml file located in the C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\CorrespondenceManagement\FinancialServicesInsurance.zip\FSIApp\ManageTemplates folder.

  2. Open the build.xml file with a text or XML editor.

  3. Look for the mxmlc element, it should look similar to this:

    <mxmlc compiler.accessible="true" file="${src.dir}/index.mxml" services="${src.dir}\lcds-config\services-config.xml" output="${dist.dir}/index.swf" debug="${flex.debug}" fork="true" locale="en_US"> 
      <source-path path-element="${locale.src}" /> 
      <jvmarg value="-Xmx512m" /> 
      <compiler.source-path path-element="${src.dir}" /> 
      <compiler.library-path file="${adobe.acm.domain.swc}" append="true" /> 
      <compiler.library-path file="${adobe.acm.presentation.swc}" append="true" /> 
      <compiler.library-path file="${adobe.acm.tbxeditor.swc}" append="true" /> 
      <compiler.library-path file="${adobe.acm.utilities.swc}" append="true" /> 
      <compiler.library-path file="${adobe.acm.services.swc}" append="true" /> 
      <compiler.library-path file="${adobe.acm.styles.swc}" append="true" /> 
      <compiler.library-path file="${adobe.dct.widgets.swc}" append="true" /> 
      <compiler.library-path file="${adobe.amg.flex.presentation.styles.swc}" append="true" /> 
      <compiler.library-path file="${adobe.dct.widgets.styles.swc}" append="true" /> 
      <compiler.library-path file="${adobe.amg.flex.domain.model.swc}" append="true" /> 
      <compiler.library-path file="${adobe.amg.flex.presentation.swc}" append="true" /> 
      <compiler.library-path file="${datavisualization.swc}" append="true" /> 
      <compiler.library-path file="${datavisualization.rb.swc}" append="true" /> 
      <compiler.keep-all-type-selectors>true</compiler.keep-all-type-selectors> 
      <context-root>cmsa</context-root> 
    - <fonts> 
      <manager class="flash.fonts.AFEFontManager" /> 
      </fonts> 
      </mxmlc>
  4. Add the <target-player>10.0.0</target-player> attribute as follows:

    <mxmlc compiler.accessible="true" file="${src.dir}/index.mxml" services="${src.dir}\lcds-config\services-config.xml" output="${dist.dir}/index.swf" debug="${flex.debug}" fork="true" locale="en_US"> 
      <source-path path-element="${locale.src}" /> 
      <jvmarg value="-Xmx512m" /> 
      <compiler.source-path path-element="${src.dir}" /> 
      <compiler.library-path file="${adobe.acm.domain.swc}" append="true" /> 
      <compiler.library-path file="${adobe.acm.presentation.swc}" append="true" /> 
      <compiler.library-path file="${adobe.acm.tbxeditor.swc}" append="true" /> 
      <compiler.library-path file="${adobe.acm.utilities.swc}" append="true" /> 
      <compiler.library-path file="${adobe.acm.services.swc}" append="true" /> 
      <compiler.library-path file="${adobe.acm.styles.swc}" append="true" /> 
      <compiler.library-path file="${adobe.dct.widgets.swc}" append="true" /> 
      <compiler.library-path file="${adobe.amg.flex.presentation.styles.swc}" append="true" /> 
      <compiler.library-path file="${adobe.dct.widgets.styles.swc}" append="true" /> 
      <compiler.library-path file="${adobe.amg.flex.domain.model.swc}" append="true" /> 
      <compiler.library-path file="${adobe.amg.flex.presentation.swc}" append="true" /> 
      <compiler.library-path file="${datavisualization.swc}" append="true" /> 
      <compiler.library-path file="${datavisualization.rb.swc}" append="true" /> 
      <compiler.keep-all-type-selectors>true</compiler.keep-all-type-selectors> 
      <context-root>cmsa</context-root> 
      <fonts> 
      <manager class="flash.fonts.AFEFontManager" /> 
      </fonts> 
      <target-player>10.0.0</target-player>  </mxmlc>
  5. Save and close the file.

Flash Builder: Manage Templates Build Properties

  1. Open the Manage Templates build.properties file located in the C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\CorrespondenceManagement\FinancialServicesInsurance.zip\FSIApp\ManageTemplates folder.

  2. Open the build.properties file with a text editor.

  3. Look for the index.template.html.version_major property, and change the version number from 9 to 10, it should look similar to this:

    index.template.html.version_major=10
  4. Look for the index.template.html.version_revision property, and change the version number from 124 to 0, it should look similar to this:

    index.template.html.version_revision=0
  5. Save and close the file.

Flash Builder: Import Projects

  1. In Flash Builder, right click on Package Explorer view to bring up the context menu.

  2. Select the Import... option from the menu to launch the Import Wizard .

  3. In the Import Wizard choose General > Existing Projects into Workspace and click Next .

  4. In the Select root directory field, enter the value C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\ and press Enter .

  5. The Projects view will get populated with all of the building block projects.

  6. Click Finish to import the project into your workspace.

  7. Repeat steps 1 through 3.

  8. In the Select root directory field, enter the value C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\CorrespondenceManagement\ and press Enter .

  9. Out of the three populated projects deselect the Portal project. The Portal project is a java project and does not need to be imported in the Flash Builder workspace.

  10. Click Finish to import the projects into your workspace.

Eclipse: Add Classpath Variables

The projects need several JAR files to resolve compile time dependencies. Most of the jars are available under the SA_SDK folder and the projects refer to the required jars via workspace variables. You need to define the following workspace variables:

Variable Name

Path

LiveCycle_SA_SDK

C:\Adobe\Adobe LiveCycleES2\sa_resources\SA_SDK_9.5

CM_THIRDPARTY_LIBS

C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\CorrespondenceManagement\FinancialServicesInsurance\thirdparty

For setting the workspace variables, perform the following tasks:

  1. In Eclipse, click Window > Preferences .

  2. In the Preferences Dialog, navigate to Java > Build Path > Classpath Variables .

  3. Click New . In the Name field enter LiveCycle_SA_SDK , and in the Path field enter C:\Adobe\Adobe LiveCycleES2\sa_resources\SA_SDK_9.5 .

  4. Click New . In the Name field enter CM_THIRDPARTY_LIBS , and in the Path field enter C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\CorrespondenceManagement\FinancialServicesInsurance\thirdparty .

Unzip Java Source Archive

The project is available as zip archive. In order to import it in the Eclipse, you first need to unzip the archive file. It is recommended that you unzip the projects in the same directory as the zip archive. As an example, the zip file FinancialServicesInsurance.zip and the unzipped folder FinancialServicesInsuranceshould exist adjacent to each other. This is recommended because the cross project referencing and build script variables are written keeping the assumption in mind that the zip archive would be unzipped in-place itself. Choosing a different directory would require configuring the new path in all the build scripts.

You are required to unzip the following archive:

  • C:\Adobe\Adobe LiveCycleES2\sa_resources\SA_SDK_9.5\CorrespondenceManagement\FinancialServicesInsurance.zip

Add third party libraries

The following third party jars are to be added in C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\CorrespondenceManagement\FinancialServicesInsurance\thirdparty folder.

In order to successfully run the build scripts, add the following third-party libraries to this folder:

  • servlet-api.jar

In order to successfully setup Portal project in eclipse, add the following third-party libraries to this folder:

  • commons-io-1.4.jar

  • commons-httpclient-3.0.1.jar

  • servlet-api.jar

  • log4j-1.2.14.jar

  • dom4j-1.6.1.jar

  • spring-core-3.0.2.RELEASE.jar

  • spring-beans-3.0.2.RELEASE.jar

  • spring-security-core-3.0.2.RELEASE.jar

  • spring-context-3.0.2.RELEASE.jar

The same information is also present in the readme.txt file present in the thridparty folder.

Eclipse: Import Project

  1. In Eclipse, right click on the Package Explorer view to bring up the context menu and select Import Wizard .

  2. In the Import dialog, choose General > Existing Project into workspace and click Next .

  3. In the Select root directory field, enter C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\CorrespondenceManagement\FinancialServicesInsurance\FSIApp\Portal and press Enter .

  4. The Projects view will populate with the Portal project.

  5. Click Finish to import the projects into your workspace.

Building customized apps using ANT

ANT build scripts are available for all the available projects. The build.xml is available under the respective src zip folder e.g. the build file for adobe-acm_rb is available at C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\assetcomposer\client\flex\src\adobe-acm_rb-src.zip\build.xml. The build file can be executed to generate the ACM's resource bundle SWC to include the changes made in the project. By default, each build script produces the output(SWC or SWF) in the dist folder.

The top-level build script can be located at the following default location:

C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\CorrespondenceManagement\FinancialServicesInsurance\build\build.xml

This build script updates the EAR file placed at C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\CorrespondenceManagement\FinancialServicesInsurance\deploy with all the changes made to the three solution template projects viz. CreateCorrespondence, ManageTemplates and Portal. Note that the EAR file that needs to be updated must be placed under the deploy folder manually prior to executing the ANT script.

The accompanying properties file build.properties can be modified to configure variables. Configuration would only be required if you are using non-default paths e.g. a LiveCycle install folder different from C:\Adobe\Adobe LiveCycle ES2 or the SA SDK root folder different from C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5.

For the default installations, the build.properties file require changes only when you have made changes to the building block library and want those changes to reflect in the EAR that you build. This includes styling and resource bundle changes most commonly.

The building block SWC libraries are referred to by default paths in three different sections:

  1. The default SWC path

    The default SWC path is the folder location where the shipped libraries are located. These paths ensure that while rebuilding, the resultant EAR file will have the building block components the way they are shipped. The following snippet from build.properties file highlights this section:

    ################### The default SWC path ################# 
    adobe.acm.rb.swc=${assetcomposer.flex.client.dir}/adobe-acm_rb.swc 
    adobe.acm.styles.swc=${assetcomposer.flex.client.dir}/adobe-acm_styles.swc 
    adobe.acm.ccr.lib.swc=${assetcomposer.flex.client.dir}/adobe-acm-ccr_lib.swc 
    adobe.acm.ccr.rb.swc=${assetcomposer.flex.client.dir}/adobe-acm-ccr_rb.swc 
    #adobe.acm.ccr.styles.swf=${assetcomposer.flex.client.dir}/adobe-acm-ccr_styles.swf 
    adobe.acm.domain.swc=${assetcomposer.flex.client.dir}/adobe-acm-domain.swc 
    adobe.acm.flex.mock.services.swc=${assetcomposer.flex.client.dir}/adobe-acm-flex-mock-services.swc 
    adobe.acm.flex.services.swc=${assetcomposer.flex.client.dir}/adobe-acm-flex-services.swc 
    adobe.acm.flex.utilities.swc=${assetcomposer.flex.client.dir}/adobe-acm-flex-utilities.swc 
    adobe.acm.presentation.swc=${assetcomposer.flex.client.dir}/adobe-acm-presentation.swc 
    adobe.acm.tbxeditor.swc=${assetcomposer.flex.client.dir}/adobe-acm-tbxeditor.swc 
    adobe.amg.flex.domain.model.swc=${assetmanager.flex.client.dir}/adobe-amg-flex-domain-model.swc 
    adobe.amg.flex.presentation.swc=${assetmanager.flex.client.dir}/adobe-amg-flex-presentation.swc 
    adobe.amg.flex.presentation.rb.swc=${assetmanager.flex.client.dir}/adobe-amg-flex-presentation_rb.swc 
    adobe.amg.flex.presentation.styles.swc=${assetmanager.flex.client.dir}/adobe-amg-flex-presentation_styles.swc 
    adobe.dct.flex.services.swc=${datadictionary.flex.client.dir}/adobe-dct-flex-services.swc 
    adobe.dct.widgets.swc=${datadictionary.flex.client.dir}/adobe-dct-widgets.swc 
    adobe.dct.widgets.rb.swc=${datadictionary.flex.client.dir}/adobe-dct-widgets_rb.swc 
    adobe.dct.widgets.styles.swc=${datadictionary.flex.client.dir}/adobe-dct-widgets_styles.swc 
    ###################  ################# #################
  2. The Flash Builder project output folder path

    The location of the SWCs that are produced from the Flash Builder projects. Since the available sources are in form of prebuilt Flash Builder projects, these properties point to the Flash Builder project bin folder. The following snippet from build.properties file highlights this section:

    ################### The Flash Builder project output folder path ################# 
    #adobe.acm.rb.swc=${assetcomposer.flex.client.src.dir}/adobe-acm_rb-src/bin/adobe-acm_rb.swc 
    #adobe.acm.styles.swc=${assetcomposer.flex.client.src.dir}/adobe-acm_styles-src/bin/adobe-acm_styles.swc 
    #adobe.acm.ccr.lib.swc=${assetcomposer.flex.client.dir}/adobe-acm-ccr_lib.swc 
    #adobe.acm.ccr.rb.swc=${assetcomposer.flex.client.src.dir}/adobe-acm-ccr_rb-src/bin/adobe-acm-ccr_rb.swc 
    #adobe.acm.ccr.styles.swf=${assetcomposer.flex.client.src.dir}/adobe-acm-ccr_styles-src/bin/adobe-acm-ccr_styles.swf 
    #adobe.acm.domain.swc=${assetcomposer.flex.client.dir}/adobe-acm-domain.swc 
    #adobe.acm.flex.mock.services.swc=${assetcomposer.flex.client.dir}/adobe-acm-flex-mock-services.swc 
    #adobe.acm.flex.services.swc=${assetcomposer.flex.client.dir}/adobe-acm-flex-services.swc 
    #adobe.acm.flex.utilities.swc=${assetcomposer.flex.client.dir}/adobe-acm-flex-utilities.swc 
    #adobe.acm.presentation.swc=${assetcomposer.flex.client.src.dir}/adobe-acm-presentation-src/bin/adobe-acm-presentation.swc 
    #adobe.acm.tbxeditor.swc=${assetcomposer.flex.client.dir}/adobe-acm-tbxeditor.swc 
    #adobe.amg.flex.domain.model.swc=${assetmanager.flex.client.dir}/adobe-amg-flex-domain-model.swc 
    #adobe.amg.flex.presentation.swc=${assetmanager.flex.client.src.dir}/adobe-amg-flex-presentation-src/adobe-amg-flex-presentation.swc 
    #adobe.amg.flex.presentation.rb.swc=${assetmanager.flex.client.src.dir}/adobe-amg-flex-presentation_rb-src/bin/adobe-amg-flex-presentation_rb.swc 
    #adobe.amg.flex.presentation.styles.swc=${assetmanager.flex.client.src.dir}/adobe-amg-flex-presentation_styles-src/bin/adobe-amg-flex-presentation_styles.swc 
    #adobe.dct.flex.services.swc=${datadictionary.flex.client.dir}/adobe-dct-flex-services.swc 
    #adobe.dct.widgets.swc=${datadictionary.flex.client.dir}/adobe-dct-widgets.swc 
    #adobe.dct.widgets.rb.swc=${datadictionary.flex.client.dir}/adobe-dct-widgets_rb-src/bin/adobe-dct-widgets_rb.swc 
    #adobe.dct.widgets.styles.swc=${datadictionary.flex.client.src.dir}/adobe-dct-widgets_styles-src/bin/adobe-dct-widgets_styles.swc 
    ###################  ################# #################
  3. The ANT script dist path

    The location of the SWCs that are produced by executing the corresponding build scripts. These properties point to the dist folder under each building block. The following snippet from build.properties file highlights this section:

    ################### The ANT script dist path ################# 
    #adobe.acm.rb.swc=${assetcomposer.flex.client.src.dir}/adobe-acm_rb-src/dist/adobe-acm_rb.swc 
    #adobe.acm.styles.swc=${assetcomposer.flex.client.src.dir}/adobe-acm_styles-src/dist/adobe-acm_styles.swc 
    #adobe.acm.ccr.lib.swc=${assetcomposer.flex.client.dir}/adobe-acm-ccr_lib.swc 
    #adobe.acm.ccr.rb.swc=${assetcomposer.flex.client.src.dir}/adobe-acm-ccr_rb-src/dist/adobe-acm-ccr_rb.swc 
    adobe.acm.ccr.styles.swf=${assetcomposer.flex.client.src.dir}/adobe-acm-ccr_styles-src/dist/adobe-acm-ccr_styles.swf 
    #adobe.acm.domain.swc=${assetcomposer.flex.client.dir}/adobe-acm-domain.swc 
    #adobe.acm.flex.mock.services.swc=${assetcomposer.flex.client.dir}/adobe-acm-flex-mock-services.swc 
    #adobe.acm.flex.services.swc=${assetcomposer.flex.client.dir}/adobe-acm-flex-services.swc 
    #adobe.acm.flex.utilities.swc=${assetcomposer.flex.client.dir}/adobe-acm-flex-utilities.swc 
    #adobe.acm.presentation.swc=${assetcomposer.flex.client.src.dir}/adobe-acm-presentation-src/dist/adobe-acm-presentation.swc 
    #adobe.acm.tbxeditor.swc=${assetcomposer.flex.client.dir}/adobe-acm-tbxeditor.swc 
    #adobe.amg.flex.domain.model.swc=${assetmanager.flex.client.dir}/adobe-amg-flex-domain-model.swc 
    #adobe.amg.flex.presentation.swc=${assetmanager.flex.client.src.dir}/adobe-amg-flex-presentation-src/adobe-amg-flex-presentation.swc 
    #adobe.amg.flex.presentation.rb.swc=${assetmanager.flex.client.src.dir}/adobe-amg-flex-presentation_rb-src/dist/adobe-amg-flex-presentation_rb.swc 
    #adobe.amg.flex.presentation.styles.swc=${assetmanager.flex.client.src.dir}/adobe-amg-flex-presentation_styles-src/dist/adobe-amg-flex-presentation_styles.swc 
    #adobe.dct.flex.services.swc=${datadictionary.flex.client.dir}/adobe-dct-flex-services.swc 
    #adobe.dct.widgets.swc=${datadictionary.flex.client.dir}/adobe-dct-widgets.swc 
    #adobe.dct.widgets.rb.swc=${datadictionary.flex.client.dir}/adobe-dct-widgets_rb-src/dist/adobe-dct-widgets_rb.swc 
    #adobe.dct.widgets.styles.swc=${datadictionary.flex.client.src.dir}/adobe-dct-widgets_styles-src/dist/adobe-dct-widgets_styles.swc 
    ###################  ################# #################

The build.properties has the default SWC path uncommented and the Flash Builder bin and ANT dist paths commented. You must comment/uncomment the relevant paths in order to update the resultant EAR with your changes.

Solution template build scripts

The solution template build scripts are available for all the three projects under the FSIApp folder: CreateCorrespondence, ManageTemplates and Portal. They select the ANT variables from the top-level build.properties file itself which is referred to by relative path in the individual build.xml files.

CreateCorrespondence and ManageTemplates also have their own build.properties files which contain certain project specific properties. These properties do not conflict with the top-level properties and care must be taken to avoid conflicts if adding extra properties to the project spcific build.properties file.

While the top-level build that produces the EAR triggers the three solution template builds, the solution template builds themselves do not invoke ANT on any of the building block projects. The building block ANT scripts need to be manually invoked if required and their library paths need to be manually updated in the top-level build.properties if the changes are required to be included.

Building block build scripts

The build scripts available with the building block projects produce the output in the dist folder under the project root folder. The script variables are typically picked up from the top-level build.properties file which is referred to by the following properties:

<property name="sa.sdk.home" value="C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5"/> 
<property file="${sa.sdk.home}\CorrespondenceManagement\FinancialServicesInsurance\build\build.properties"/>

If using non-default install locations, the building block build xml files should be updated accordingly.

By default, the Asset Composer Correspondence Creator styles SWF is not rebuilt and replaced in the target EAR file. If you intend to replace the styles SWF, perform the following tasks:

  1. Extract the adobe-acm-ccr_styles-src.zip file under the <SA_SDK_DIR>\BuildingBlocks\assetcomposer\client\flex\src directory.

  2. Ensure build.xml is pointing to the C:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5 directory.

  3. Modify *.css files under css folder, to replace all assets/ with /assets/ .

  4. Build the styles SWF by executing the ANT script in the adobe-acm-ccr_styles project.

  5. Build the EAR using top-level build script. Prior to executing the top-level script, make sure that you uncomment the property adobe.acm.ccr.styles.swc under the "ANT script dist path" section. You must also modify the build.xml in CreateCorrespondence folder to include the ANT target copy-styles-swf under the target distribution.

Supporting Japanese language

The default font included with the Correspondece Management solution template is Myriad Pro. Unfortunately, Myriad Pro does not include the glyphs for Japanese characters and therefore, the Japanese strings do not render. In order to render the Japanese strings, the user interface must be compiled with compatible fonts like Kozuka Mincho. This page details steps to follow in order to replace the fonts.

Modifying the style sheets

  1. Unzip the Asset Composer building block Correspondence Creator styles source zip file <LIVECYCLE_HOME>\sa_resources\SA_SDK_9.5\BuildingBlocks\assetcomposer\client\flex\src\adobe-acm-ccr_styles-src.zip in the same directory as the .zip file, so the folder adobe-acm-ccr_styles-src is created adjacent to the source zip.

  2. Copy the kozuka mincho OTF font files in the Asset Composer building block Correspondence Creator styles src assets <LIVECYCLE_HOME>\sa_resources\SA_SDK_9.5\BuildingBlocks\assetcomposer\client\flex\src\adobe-acm-ccr_styles-src\assets\fonts directory.

  3. Modify the <LIVECYCLE_HOME>\sa_resources\SA_SDK_9.5\BuildingBlocks\assetcomposer\client\flex\src\adobe-acm-ccr_styles-src\css\fonts.css file to use the new font as follows:

    /* CSS file */ 
    @font-face { 
        /* embed the font so advanced typography can take hold*/ 
        fontFamily: "embeddedFont"; 
        src: url("/assets/fonts/KozMinStd-Regular.otf"); 
        advanced-anti-aliasing: false; 
    } 
    @font-face { 
        /* embed the font so advanced typography can take hold*/ 
        fontFamily: "embeddedFont"; 
        font-weight:bold; 
        src: url("/assets/fonts/KozMinStd-Bold.otf"); 
        advanced-anti-aliasing: false; 
    } 
    /*@font-face { 
        fontFamily: "embeddedFont"; 
        font-style: italic; 
        src: url("/assets/fonts/KozMinStd-Regular.otf"); 
        advanced-anti-aliasing: false; 
    }*/
  4. Unzip the solution template source zip file <LIVECYCLE_HOME>\sa_resources\SA_SDK_9.5\CorrespondenceManagement\FinancialServicesInsurance.zip so the folder is created adjacent to the source zip.

  5. Copy the Kozuka Mincho OTF font files in the ManageTemplates src assets <LIVECYCLE_HOME>\sa_resources\SA_SDK_9.5\CorrespondenceManagement\FinancialServicesInsurance\FSIApp\ManageTemplates\src\assets\fonts directory.

  6. Modify the <LIVECYCLE_HOME>\sa_resources\SA_SDK_9.5\CorrespondenceManagement\FinancialServicesInsurance\FSIApp\ManageTemplates\src\css\app.css file.

    /* Font embedding, seems to be at the application level */ 
    @font-face { 
        /* embed the font so advanced typography can take hold*/ 
        src: url("/assets/fonts/KozMinStd-Regular.otf"); 
        fontFamily: "embeddedFont"; 
    } 
    @font-face { 
        /* embed the font so advanced typography can take hold*/ 
        src: url("/assets/fonts/KozMinStd-Bold.otf"); 
        font-weight:bold; 
        fontFamily: "embeddedFont"; 
    }
  7. Modify the <LIVECYCLE_HOME>\sa_resources\SA_SDK_9.5\CorrespondenceManagement\FinancialServicesInsurance\FSIApp\ManageTemplates\src\css\app.css file to remove reference to italic style font face.

    @font-face { 
        /* embed the font so advanced typography can take hold*/ 
        src: url("/assets/fonts/MyriadPro-It.otf"); 
        font-style: italic; 
        fontFamily: "embeddedFont"; 
    }

Rebuild the EAR

By default, the Asset Composer Correspondence Creator styles SWF is not rebuilt and included in the EAR package. In order to do so, you need to build the styles SWF and then execute the top-level EAR packaging ANT script as follows:

  1. Open console and change the working directory to the <LIVECYCLE_HOME>\sa_resources\SA_SDK_9.5\BuildingBlocks\assetcomposer\client\flex\src\adobe-acm-ccr_styles-src directory.

  2. Ensure the <LIVECYCLE_HOME>\sa_resources\SA_SDK_9.5\CorrespondenceManagement\FinancialServicesInsurance\build\build.properties file has valid values for livecycle.home and workbench.home.

  3. Run the ant command in order to create or update the styles SWF in the project's dist folder.

    The large size of the new font files can cause java heap space errors. In order to increase the heap space, set ANT_OPTS using the following command in console:

    SET ANT_OPTS=-Xmx512m

    If you see compile error similar to this:

    --------------- Compiler Error -------------- 
    mxmlc D:\Adobe\Adobe LiveCycle ES2\sa_resources\SA_SDK_9.5\BuildingBlocks\assetcomposer\client\flex\src\adobe-acm-ccr_styles-src\css\assetLocator.css(35): Error: Invalid Embed directive in stylesheet - can't resolve source 'Embed(source = "assets/icons/LC_Alert_Md_N.png")'. 
    mxmlc src: Embed(source='assets/icons/LC_Alert_Md_N.png'); 
    -----------------------------------------------

    Open the corresponding CSS file and prepend a slash in the asset path. So, the line:

    src: Embed(source='assets/icons/LC_Alert_Md_N.png');

    changes to:

    src: Embed(source='/assets/icons/LC_Alert_Md_N.png');
  4. Copy servlet-api.jar file into: <LIVECYCLE_HOME>\sa_resources\SA_SDK_9.5\CorrespondenceManagement\FinancialServicesInsurance\thirdparty

  5. Follow the procedure outlined in Flash Builder: Manage Templates Build XML .

  6. Follow the procedure outlined in Flash Builder: Manage Templates Build Properties .

  7. Change the working directory to: <LIVECYCLE_HOME>\sa_resources\SA_SDK_9.5\CorrespondenceManagement\FinancialServicesInsurance\build

  8. Copy the old CorrespondenceManagement EAR file to the deploy folder <LIVECYCLE_HOME>\sa_resources\SA_SDK_9.5\CorrespondenceManagement\FinancialServicesInsurance\deploy.

  9. Execute the ant command in the console.

  10. Copy the CorrespondenceManagement EAR to the deploy folder.

  11. Redeploy the CorrespondenceManagement EAR.

// Ethnio survey code removed