Asset Composer building block basics

The Asset Composer (ACM) building block is part of the Correspondence Management Solution, available with Adobe® LiveCycle® Enterprise Suite 4 (ES4). The Asset Composer building block provides core correspondence management capabilities such as asset (text, image, list, condition, and letter template) creation and document rendering. The Asset Composer building block consists of server-side components that are delivered as Spring Beans (OSGi Services), and user interface (Flex) components that are delivered as Presentation/Domain models and resource bundles. The server-side beans are exposed over Flex Remoting.

    Building block structure

    The Asset Composer building block is delivered as a CRX package which you can unzip to any installation directory. All of CRX packages fit into one one the following categories:

    • Platform packages: Packages that contribute to the complete Adobe Enterprise Platform.

    • Building block packages: Packages that contribute to the full range of Building Blocks that Partners use to help build custom solutions.

    • Solution template packages: Packages for demonstration components of a target solution. This package relies on building blocks already deployed on LiveCycle.

    • Solution packages: Includes a Solution Template and a set of building blocks all merged into one CRX package.

    The Asset Composer building block contains two packages:

    • bb-assetcomposer-pkg-<version_number>.zip: Assets used to deploy and run the Asset Composer building block.

    • bb-assetcomposer-sdk-pkg-<version_number>.zip: ActionScript and Java Developer SDK for the Asset Composer building block.

    Each Solution Template for LiveCycle provides one CRX package. This package contains a Sling Web Application used to demonstrate the Solution as well as all other assets run an example solution. Applications can be AIR applications, Forms, and LiveCycle assets such as custom DSCs and sample processes. The package for the Correspondence Management Solution Template is template-correspondencemanagement-pkg.zip.

      APIs and Components

      The following APIs and components are delivered with the Asset Composer building block.

      SWC Path

      Description

      [SDK]/riaservices/assetcomposer/10.0.0.0/flex/xfalib.swc

      Utility library provides some APIs related to XFA parsing and processing in ActionScript.

      [SDK]/riaservices/assetcomposer/10.0.0.0/flex/adobe-acm-flex-utilities.swc

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

      [SDK]/riaservices/assetcomposer/10.0.0.0/flex/adobe-acm-services-impl.swc

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

      [SDK]/riaservices/assetcomposer/10.0.0.0/flex/adobe-acm-services-mock.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..

      [SDK]/riaservices/assetcomposer/10.0.0.0/flex/adobe-acm-authoring-rb.swc

      The resource bundles SWC for the authoring part of the Asset Composer building block. This SWC file contains bundles for all supported locales

      [SDK]/riaservices/assetcomposer/10.0.0.0/flex/adobe-acm-authoring-domain-impl.swc

      The domain library for the authoring 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 less effort.

      [SDK]/riaservices/assetcomposer/10.0.0.0/flex/adobe-acm-authoring-presentation.swc

      The presentation SWC for the authoring part of the ACM building block. This SWC contains the Host Component and the Flex views that encompass various editors in the ACM building block.

      [SDK]/riaservices/assetcomposer/10.0.0.0/flex/adobe-acm-authoring-styles.swc

      The styles ans skins SWC for authoring the Asset Manager Building Block. This SWC file contains the Skins, the style sheets and various assets (such as animations, icons, skins) for Host Components available in adobe-acm-authoring-presentation.swc.

      [SDK]/riaservices/assetcomposer/10.0.0.0/flex/adobe-acm-ccr-rb.swc

      The resource bundles SWC for the Create Correspondence part of the Asset Composer building block. This SWC file contains bundles for all supported locales.

      [SDK]/riaservices/assetcomposer/10.0.0.0/flex/adobe-acm-ccr-domain-impl.swc

      The domain library SWC for the Create Correspondence part of the Asset Composer building block.

      [SDK]/riaservices/assetcomposer/10.0.0.0/flex/adobe-acm-ccr-presentation.swc

      The presentation SWC for the Create Correspondence part of the ACM building block. This SWC contains the Host Component and the Flex views that encompass CCR user interface in the ACM building block.

      [SDK]/riaservices/assetcomposer/10.0.0.0/flex/adobe-acm-ccr-styles.swc

      The styles ans skins SWC for Create Correspondence part of the ACM building block. This SWC file contains the Skins, the style sheets and various assets (animations, icons, skins, and so on) for Host Components available in adobe-acm-ccr-presentation.swc.

      Building Block Configurations

      The Asset Composer building block can be modified with solution-specific configurations. These configuration files are read from the LiveCycle Content Repository. You can find the configuration files in the /etc/aep/config/assetcomposer/<Solution App root> folder. For example:

      • /etc/aep/config/correspondencemanagement/ACLConfig.xml: The configuration file to define/configure ACLs applied on various asset folders.

      • Find this in acmExtensions folder./etc/aep/config/assetcomposer/apps/cm/acmExtensions/acmExtensionsConfig.xml: The configuration file to define/configure various action buttons for assets and correspondences.

        Properties

        The Asset Composer Building Block exposes the following configurable properties:

        Property

        Description

        Default

        Acceptable values

        Indentation

        Indentation on modules

        12.7mm

        Any number

        Number Minimum Width

        Minimum width to be applied on the bullet/number field, when using numbered Lists apart from Roman numbers

        8.0mm

        Any number

        Roman Numbers Minimum Width

        Minimum width to be applied on the bullet/number field, when using Roman numbers

        12.7mm

        Any number

        Enable CCR PDF highlight

        Enables highlighting on PDF in Create Correspondence UI

        true

        true / false

        Target Highlight Type

        Target Highlight Type in the Create Correspondence application

        border

        border / fill / none

        Target Highlight Color

        Target Highlight Color in the Create Correspondence application

        90;155;245

        Any RGB color in format R;G;B

        Content Highlight Type

        Content Highlight Type in the Create Correspondence application

        Fill

        border / fill / none

        Content Highlight Color

        Content Highlight Color in the Create Correspondence application

        210;225;245

        Any RGB color in format R;G;B

        Field Highlight Type

        Field Highlight Type in the Create Correspondence application

        fill

        border / fill / none

        Field Highlight Color

        Field Highlight Color in the Create Correspondence application

        210;225;245

        Any RGB color in format R;G;B

        PDF Form Cache Enabled

        PDF Form Cache Enabled

        false

        true / false

        PDF Form Debug Enabled

        PDF Form Debug Enabled

        false

        true / false

        PDF Form Acorbat Version

        PDF Form Acorbat Version

        auto

        --

        Non-interactive PDF Cache Enabled

        Non-interactive PDF Cache Enabled

        false

        true / false

        Non-interactive PDF Debug Enabled

        Non-interactive PDF Debug Enabled

        false

        true / false

        Non-interactive PDF Acorbat Version

        Non-interactive PDF Acorbat Version

        auto

        --

        Application Time Out

        Application Time Out in seconds

        1200

        Any number

        PDF document parameter name

        Parameter name for PDF document in post process

        inPDFDoc

        Any string variable name

        XML data parameter name

        Parameter name for XML document (data) in post process

        inXMLDoc

        Any string variable name

        XDP document parameter name

        Parameter name for XDP document sent to the post process

        inXDPDoc

        Any string variable name

        Redirect URL parameter name

        Parameter name for the redirect URL sent from the post process This value can be any string variable name

        redirectURL

        Any string variable name

        PDF Submit Type

        PDF Submit Type (type of PDF generated on submitting from the Create Correspondence application)

        nonInteractive

        interactive / non-interactive

        Optimize Data Dictionary Instance

        Enables optimized transfer of Data Dictionary Instance b/w server and client

        true

        true / false

        Enable Push

        Controls the push functionality in Asset Composer Building Block

        true

        true / false

        Auto Correct Inconsistencies

        When enabled, it automatically handles the possible inconsistencies in Letter Assignments

        true

        --

        Use Configured Data Formats

        Controls whether to Use Configured Data Edit Formats and Data Display Format

        true

        true / false

        Data Display Formats

        Specifies locale specific display format for data

        --

        --

        Data Edit Format

        Edit format for data. This is used when writing data as String or parsing data from String

        --

        --

        Manage Letter Instances on Publish

        Enable/Disable the Manage Letter functionality (applicable only for Publish Server)

        false

        true / false

        Enable Audit

        Enable/Disable audit functionality. When false, audit logs for all actions will be disabled

        true

        true / false

        Enable Read Audit

        Enable/Disable audit functionality for asset reads

        false

        true / false

        Enable Create Audit

        Enable/Disable audit functionality for asset create

        true

        true / false

        Enable Update Audit

        Enable/Disable audit functionality for asset update

        true

        true / false

        Enable Revert Audit

        Enable/Disable audit functionality for asset revert

        true

        true / false

        Enable Publish Audit

        Enable/Disable audit functionality for asset publish

        true

        true / false

        Enable SaveAsDraft Audit

        Enable/Disable audit functionality for saving letter drafts

        true

        true / false

        Enable Submit Audit

        Enable/Disable audit functionality for letter submit

        true

        true / false

        Enable Email Audit

        Enable/Disable audit functionality for emailing letters

        true

        true / false

        Enable Print Audit

        Enable/Disable audit functionality for printing letters

        true

        true / false

        Enable Custom Delivery Audit

        Enable/Disable audit functionality for custom delivery of letters

        true

        true / false

        Attachment documents parameter name

        Parameter name for Attachment documents sent to the post process

        inAttachmentDocs

        Any string variable name

        CM User Root

        URL of the folder containing all CM user assets

        --

        Valid folder location

        Letter Instance Access Groups

        Groups available for managing the permissions of Letter Instances

        --

        --

        Letter Cache Size

        Specify the Maximum number of letters to be kept in cache.

        Changing this value will result in clean-up of in-memory cache.

        100

        Any numeric value

        Enable Letter Cache

        Enable/Disable the letter cache.

        Changing this value will result in clean-up of in-memory cache.

        true

        true / false

        Data Elements Ordering

        Keeps data elements ordering in create correspondence interface as per their sequence in Letter

        true

        true / false

        Support Reload

        Enable/Disable reload support in letters rendered on server-side.

        Disabling this will improve letter render performance.

        false

        true / false

        To configure these properties, open the following URL in a browser: http://<server>:<port>/lc/system/console/configMgr

        and select Asset Composer Configurations.

        // Ethnio survey code removed