For AEM 6.2 Forms version of this help, see Create and configure an adaptive document.

Introduction

Adaptive documents centralize the creation of personalized, interactive, and device friendly HTML-based digital correspondences, statements, and documents. You can quickly assemble digital correspondences, statements, and digital documents from both pre-approved and custom-authored content.

Adaptive documents are responsive in nature and change layout and design automatically based on user device and settings. Adaptive documents make it convenient for customers to read and interact with documents, such as welcome kits or statements, on devices of varied screen sizes.

You can also include targeted content and adaptive form components in an adaptive document to make it interactive and personalized for customers. Adaptive documents are easy to author, manage, personalize, deliver, and has built-in ability to measure the usage patterns.

The key benefits of the adaptive documents are:

  • Batch processing support to create multiple adaptive documents.
  • Support to use pre-approved and custom authored content.
  • Analytics dashboard to measure the usage pattern of documents.
  • Responsive design makes it easier to use documents on mobile devices.
  • Templates based to provide unique and customized appearance.
  • Support to use document fragments (text, image, condition, and list).
A sample adaptive document
A sample adaptive document

Adaptive document authoring user interface

The intuitive interface, drag-and-drop functionality, standard form components, and integrated repository for assets facilitate quick and easy authoring of adaptive document. When you create a new or edit an existing adaptive document, you use the following user interface elements:

  • Document fragments
  • Data dictionary elements
  • Letter hierarchy elements
  • Sidekick components
  • Adaptive document page
  • Layouts of document fragments
Authoring user interface of an adaptive document
A. Content Finder displaying letter hierarchy B. Adaptive Document page C. Sidekick  

Document fragments, Data Dictionary elements, and letter hierarchy elements

Adaptive document adds new tabs to the Content Finder to display document fragments, data dictionary elements, and letter hierarchy elements. You can drag-and-drop document fragments, data dictionary elements, and elements of a letter to the adaptive document. If you have a long list of elements, you can use filters to view elements of a particular type. For detailed information about document fragments, see Creating Document Fragments.

The Content Finder pane also allows you to search, view, and use other assets from your AEM repository. It consists of several tabs that segregate different types of content, such as images, documents, pages, movies, and more. For more information about finding assets in AEM repository, see Finding and Viewing Digital Assets.

Sidekick components

Sidekick includes components that you can use to build an adaptive document. Adaptive documents have access to all the components used in an adaptive form. You can drag components from the Sidekick onto the adaptive document to add and configure text, table, images, and other form elements. 

For example, you can use adaptive forms components for transactional records and tables. These records and tables can be pre-filled with specific user data and help in generating documents with personalized transaction details.

Author view of a table. The table holds personalized information.
Author view of a table. The table holds personalized information.

Apart from the adaptive forms components, the following adaptive documents-specific components are also provided:  

  • Document Fragment component: The Document Fragment component serves as a container for Text, List, Images, and Condition document fragments of a letter. You can edit the layout properties of a Document Fragment component to change the appearance of its content.
  • Document Fragment Group component: The Document Fragment Group serves as a container for a group of document fragments and also maps to the target areas of a letter-based adaptive document. It helps in addressing a set of document fragments as a single unit. You can edit the layout properties of a Document Fragment Group component to change the appearance of its content. 

Примечание.

For the individual document fragments which appear inside a Document Fragment Group component, the layout configuration of the individual document fragment is ignored and layout configuration specified for the Document Fragment group is applied. For more information about layout configurations, see Configure layout of a document fragment.

Adaptive document page

An adaptive document page is an AEM page modeled as the cq: Page component. You design, customize, and define appearance and various other properties of the adaptive document in the page section. You can: 

  • Customize the style sheet or theme of the adaptive document.
  • Customize client library of the adaptive document.
  • Configure layout of the document for devices with smaller screens.
  • Configure appearance and design of the adaptive document. 

Layouts of document fragments

An adaptive document can have multiple Document Fragment and Document Fragment Group components. You can customize the layout and appearance of document fragments to present the content in a device friendly, easy to comprehend, and easy to navigate manner. For example, in an adaptive document, you can convert all the headings (H1) and contents beneath the headings to a cards layout. For detailed steps, see Configure layout types in an adaptive document.

Create an adaptive document

Perform the following steps to create an adaptive document:

  1. Log in to AEM forms. The default URL is http://[Server]:[Port]//aem/forms.html.

     

  2. Click the +Create icon and click Create Adaptive Document. An option to select a template appears. For more information about templates, see Adaptive document templates.

    adaptive-document-create-new-document
  3. Select a template to apply and click Next. Options to specify basic information and document model appear.

    Примечание.

    You can apply a different template to an adaptive document at the later stage. For detailed steps, see Apply a different template to an adaptive document.

  4. Specify the values for the following fields. The Title and Name fields are mandatory:
    • Title: Specifies the title of the document. The title helps you identify the document in the AEM forms user interface.
    • Name: Specifies the name of the document. A node with the specified name is created in the repository. As you start typing a title, value for the name field is automatically generated. You can change the suggested value. The name field can include only alphanumeric characters, hyphens, and underscores. All the invalid inputs are replaced with a hyphen.
    • Description: Specifies the detailed information about the document. 
    • Tags: Specifies tags to uniquely identify the adaptive document. Tags help in searching the document. To create tags, type new tag names in the Tags box.
  5. Create adaptive document based on a Letter

    A letter is a PDF-based correspondence created from both pre-approved and custom-authored content. You can create an adaptive document based on a letter and use elements of a letter to add structured content to the adaptive document. An adaptive document based on a letter can also access all the document fragments which are not associated with any letter and the document fragments associated to the selected letter.

    Примечание.

    Create or import the letter to AEM forms before you start creating an adaptive document based on a letter.

    To create the adaptive document based on a letter:

    In the Document Model tab, select Letter Templates. A list of letters appear. Select a letter from the list and click Create. An adaptive document based on a letter is created and a dialog to open the document for editing appears.  

    Примечание.

    You can apply a different letter to an adaptive document at the later stage. For detailed steps, see Edit Document Model properties of an adaptive document.

    adaptive-document-letter-template-based

    Create adaptive document based on a Data Dictionary

    A data dictionary is a structured catalog, an XML schema, of data elements and their descriptions. It is used to provide structure for storing customer/recipient data. You can associate a data dictionary to an adaptive document and use its elements to add dynamic content to the adaptive document. An adaptive document based on a letter can also access all  the document fragments which are not associated with any data dictionary and the document fragments associated to the selected data dictionary.

    Примечание.

    Create or import the data dictionaries to AEM forms before you start creating an adaptive document based on a data dictionary

    To create the adaptive document based on a data dictionary:

    In the Document Model tab, select Data Dictionary. A list of data dictionaries appears. Select a data dictionary from the list and click Create. An adaptive document based on a data dictionary is created and a dialog to open the document for editing appears.  

    Примечание.

    You can apply a different data dictionary to an adaptive document at the later stage. For detailed steps, see Edit Document Model properties of an adaptive document.

    adaptive-document-data-dictionary-based

    Create an adaptive document without any document model

    An adaptive document without any document model can access all the document fragments which are not associated with any data dictionary. To create an adaptive document without any document model:

    In the Document Model tab, select None, and click Create. An adaptive document is created and a dialog to open the document for editing appears.  

  6. Click Open. The adaptive document opens for editing. You can start editing and designing the adaptive document. 

    Based on the type of adaptive document, the following tabs are displayed in the Content Finder:

    • For an adaptive document based on a letter, letter model tab and document fragment tabs are displayed.
    • For an adaptive document based on a data dictionary, document fragment tab and document model tabs are displayed.
    • For adaptive document that has no document model, the document fragment tab is displayed. 

    Along with Sidekick components, you can also drag-and-drop these elements to an adaptive document.

Tables in an adaptive document

Using tables is an effective, simplified, and organized way of presenting complex data. It helps users in identifying information easily and providing inputs in an ordered arrangement of rows and columns. Most forms from financial services and government organizations require large data tables to put numbers and perform calculations.

AEM forms provides a Table component in AEM Sidekick that lets you create tables in adaptive document. For detailed information about the Table component, see Tables in adaptive forms.

If you create an adaptive document based on a letter and the letter uses a layout fragment to create tables, then all the XFA elements used in the letter and layout fragment are available in the Data Model tab of the AEM Content Finder. You can drag-and-drop and use these XFA elements, including entire tables, in an adaptive document. For more information, see Use XDP components to create a Table.  

If you create an adaptive document based on a data dictionary, then the elements of the data dictionary are listed in the Data Model tab of the Content Finder. You can drag-and-drop a table from the Sidekick and map its cells and rows with collection items and elements of the data dictionary listed in the content finder.

Inline preview of adaptive documents

Adaptive documents allow you to preview document fragments in the author user interface. You can:

  • Populated document fragments in the author user interface using data from an XML file. The data XML file can reside in the local file system of the machine where AEM forms server is running or in the CRX repository.
  • Populate document fragments in the author user interface using sample data associated to the data dictionary.
  • Preview document fragments without populating any data.

Let’s take example of the following bank statement header where we want to populate with data from an XML file.

adaptive-document-inline-style-xml-data

In this example, the element name for property:

  • Customer Name is name
  • Customer ID is customerId
  • Statement Period is statementPeriodFrom and statementPeriodTo

The XML file that contains data in the following format:

<?xml version="1.0" encoding="UTF-8"?>
<!-- Document created with online XML Editor http://xmlgrid.net 2015/04/01 16:37:8  -->
   <accountStatement xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="accountStatement.xsd" redordID = "32432">
         <name>Alison Parker</name>
         <customerId>774538932</customerId>
         <statementPeriodFrom>2015-04-01</statementPeriodFrom>
         <statementPeriodTo>2015-04-31</statementPeriodTo>
         <accountType>
               <creditCard>
                     <statementSummary>
                           <creditCardNumber>xxxx-1234</creditCardNumber>
                           <amountDue>16870.00</amountDue>
                           <paymentDueDate>2015-05-15</paymentDueDate>
                           <minimumAmountDue>500.00</minimumAmountDue>
                           <rewardPointsEarned>212</rewardPointsEarned>
                           <openingBalance>1000.00</openingBalance>
                           <newCharges>14870.00</newCharges>
                           <paymentsAndCredits>1000.00</paymentsAndCredits>
                           <interests>546.00</interests>
                           <closingBalance>2450.00</closingBalance>
                     </statementSummary>
                     <statementDetails>
                            <date>2015-04-01</date>
							<transaction>Geometrixx Fresh</transaction>
                            <category>Retail Stores</category>
                            <amount>1870.00</amount>
                     </statementDetails>
					  <statementDetails>
                            <date>2015-04-03</date>
							<transaction>Geometrixx Airways</transaction>
                            <category>Travel</category>
                            <amount>6000.00</amount>
                     </statementDetails>
					 
					  <statementDetails>
                            <date>2015-04-07</date>
							<transaction>Geometrixx Telecom</transaction>
                            <category>Mobile Bill Payment</category>
                            <amount>500.00</amount>
                     </statementDetails>
					 
					  <statementDetails>
                            <date>2015-04-07</date>
							<transaction>Geometrixx Cinema</transaction>
                            <category>Entertainment</category>
                            <amount>780.00</amount>
                     </statementDetails>
					 
					  <statementDetails>
                            <date>2015-04-19</date>
							<transaction>Geometrixx Gateway</transaction>
                            <category>Miscellaneous</category>
                            <amount>1900.00</amount>
                     </statementDetails>

					  <statementDetails>
                            <date>2015-04-21</date>
							<transaction>Geometrixx Mart</transaction>
                            <category>Retail Stores</category>
                            <amount>3000.00</amount>
                     </statementDetails>

                   <statementDetails>
                            <date>2015-04-24</date>
							<transaction>Geometrixx Cafe</transaction>
                            <category>Restaurants</category>
                            <amount>820.00</amount>
                     </statementDetails>
               </creditCard>
               <savingsAccount>test string</savingsAccount>
               <investments>test string</investments>
         </accountType>
   </accountStatement>

In the sample XML, the <accountStatement> tag contains relevant tags and data of account statement. Within the tag, the data for each cell is defined within the tag for its element name, such as <name>, <customerId>, <statementPeriodFrom>, <statementPeriodTo>, and <accountType>.

To preview this data with the document fragment in the authoring mode, point the adaptive document containing the document fragment to the absolute XML location. For example, if the adaptive document is at http://localhost:4502/content/forms/af/geometrixx-finance/account-statement.html and the data XML file is saved in CRX at /content/geomtrixx-finance-statement-data/template-xmls/april.xml. Open the following URL:

http://localhost:4502/cf#/content/forms/af/geometrixx-finance/account-statement.html?dataRef=crx:///content/geomtrixx-finance-statement-data/template-xmls/april.xml and click Preview from the context-menu of document fragment.  

Inline preview with data
Inline preview with data

To populate document fragments using sample data associated to the data dictionary, specify the use useTestData=1 attribute in the URL. For example, http://localhost:4502/cf#/content/forms/af/geometrixx-finance/account-statement.html?useTestData=1.

If you open an adaptive document from, AEM forms management user interface the useTestData=1 is automatically added to the URL.

Inline preview without data
Inline preview without data

Примечание.

The useTestData parameter has higher precedence over the dataRef parameter. Moreover, if no sample data is attached, then the associated fields are displayed empty.  

Примечание.

Adaptive documents do not support the Image field. You cannot specify image data and see it merged in the document. Instead of image field, use the image component to add the images to an adaptive document.

For information about sample data in data dictionary, see data dictionary documentation.

Preview an adaptive document

After you complete editing the adaptive document, you can click the lens icon on the Sidekick to preview the document.

Adaptive documents support multiple layouts. The documents adapt the layout and design according to the size of the screen. You can simulate the preview of adaptive documents for various mobile devices. To simulate preview for a specific device, in the Simulator Options section, click Devices, and select a mobile device.

You can also preview an adaptive document from AEM forms user interface with or without pre-filled data:

  • To generate a preview of a document from the AEM forms user interface without data, select the document, click Preview, and select the Preview as HTML option.
  • To generate a preview of a document from the AEM forms user interface with custom XML data, select the document, click Preview, and select the Custom option. In the dialog box, browse and select the custom XML file, and click OK.

Note: In the custom preview, if a condition expression contains a data element of collection type, then that data element is not evaluated. The data element must be of non-collection type (primitive or composite type) for the condition expression to get evaluated.

adaptive-document-simulator

Configure layout of a document fragment

An adaptive document can have multiple document fragments (List, Text, Condition, and Image). You can change the layout and appearance of the document fragments to present the content in a logical, device friendly, easy to comprehend, and easy to navigate manner. For example, in an adaptive document, you can convert all the headings (H1) and contents beneath the headings to a cards layout.

Примечание.

You cannot apply multiple layouts to an element. For example, you cannot apply card and accordion layout to a single element (H1) simultaneously.

Types of layout

You can apply different types of layouts to the content. The layouts are applied at the runtime. Out of the box, the following layouts are supported:

Accordion layout

The accordion layout converts a group of items to the collapsible accordion. 

Inline preview of a document fragment. The accordion layout is applied to the document fragment.
Inline preview of a document fragment. The accordion layout is applied to the document fragment.

A document fragment with customized accordion layout.
A document fragment with customized accordion layout.

Cards layout

The cards layout converts a group of items to the rows and columns of cards. For example, in an adaptive document, you can convert all the headings (H1) and contents beneath the headings to a cards layout.

Inline preview of a document fragment. The cards layout is applied to the document fragment.
Inline preview of a document fragment. The cards layout is applied to the document fragment.

A document fragment with customized cards layout.
A document fragment with customized cards layout.

Tabs on the top layout

The tabs on the top layout helps in arranging the headers on the top of the content.

Inline preview of a document fragment. The tabs on the top layout is applied to the document fragment.
Inline preview of a document fragment. The tabs on the top layout is applied to the document fragment.

A customized tab on the top layout component
A document fragment with customized tabs on the top layout.

You can configure layouts to convert the header and content beneath the header or a list of items to an accordion, set of cards, or tabs on the top.  

To select a title for the corresponding accordion, set of cards, or tabs layout, specify a title selector (Tab Title). If no title selector (Tab Title) is specified, the contents of the item are searched for headings (h1 to h6) and the text of a heading are displayed as the title of the layout. If the content does not have a heading, then the first four words of the content are displayed as the title of the layout.

Configure the layout types

You can specify layout type in the Layout Configuration tab of document fragment component and document fragment group component.

The layout properties provide options to present heading and lists as accordion, cards, and tabs on the top. To open a Layout Configuration dialog and apply the properties:

  1. On the Document Fragment and Document Fragment Group component, click Edit. A dialog box appears. In the dialog box, open the Layout Configuration tab.

  2. In the Layout Configuration tab, choose a type of list or heading, and choose a layout type. For detailed information about using available list and heading types, see Choosing a list or heading.  

    An adaptive document with a list of headings (H1) and content beneath the headings
    An adaptive document in the author mode with a list of headings (H1) and corresponding layout configurations.

  3. Configure the custom properties of the selected list or the heading type. The custom properties help you choose a custom title, heading level, and type of the list. The list of properties depends on the type of list or the heading selected.

    To specify custom properties, click the edit icon.

    Property Description
    Tab Title

    Specifies an attribute in the form of a CSS selector. The CSS selector identifies the text to be displayed as the title of the corresponding card, accordion, or tab.

    Note: If no title selector (Tab Title) is specified or found, then the contents of the list are searched for headings (h1 to h6) and the text of a heading are displayed as the title of the layout. If the content does not have a heading, then the first four words of the content are displayed as the title of the layout. The title selector (Tab Title) has the higher precedence over the searched headings and contents.

    Tab Boundary Specifies a heading level from H1 to H6. The search is restricted to the heading level specified in the Tab Boundary property. It is a mandatory property.

     
    List Identifier Specifies the type of the list (ol/ul), a custom attribute, or a CSS selector. The lists are selected based on the criteria specified in the List identifier text box.
    List
    Level
    Specify the nesting level of a list. Specify 0 for the top-level list, 1 for first level of nesting, and similar values for lower levels of nesting. Specify -1 to search lists at all the nesting levels, including top-level list.  
    Cards Column Specify the number of columns for the cards layout. The default value is 2.

Choosing a list or heading  

The Layout Configuration dialog box provides options to specify a layout type for headings and lists. Your layout can be based on:

First-level heading (Heading One)

The first-level heading option searches the content of the chosen document fragment/document fragment group component for first-level heading. If the content does not have a H1, then the next available heading (H2, H3, H4, H5, and H6) is considered first-level heading. For example, if the content does have H3 but does not have H1 and H2, then H3 is considered as first level heading.

Second-level heading (Heading Two)

The second-level heading option searches the content of the chosen document fragment/document fragment group component for second-level heading. If the content does not have a H1, H2 heading, then the next available heading (H3, H4, H5, and H6) is considered second-level heading. For example, if the content does have H4 but does not have H2 and H3, then H4 is considered as second level heading.

Third-level heading (Heading Three)

The third-level heading option searches the content of the chosen document fragment/document fragment group component for third-level heading. If the content does not have a third-level heading, then the next available heading (H4, H5, and H6) is considered as third-level heading. For example, if the content does have H6 but does not have H4 and H5, then H6 is considered as first level heading.  

Ordered and Unordered lists (List)

The list option searches the document fragment/document fragment group component for Ordered (OL) and Unordered (UL) list. To apply a layout type on a lost, the list must not be nested inside another list. The layout type is not applied to a nested list.

Custom Heading

You can use the custom headings option to search the content of a document fragment/document fragment group for a specific heading tag and apply a specific layout type on the searched heading tag.  

To search a custom heading throughout the content of a document fragment/document fragment group component and specify a custom title, perform the following steps:   

  1. Click the edit icon. The options to specify the Tab Boundary and Tab Title appear.

  2. In the Tab Boundary text box, specify a custom tag. It is a mandatory property.

  3. In the Tab Title text box, specify a CSS selector. The CSS selector identifies the text to be displayed as the title of the chosen layout type. Click OK.

    Примечание.

    If no title selector (Tab Title) is specified, the contents of the list are searched for headings (h1 to h6) and the text of a heading are displayed as the title of the layout. If the content does not have a heading, then the first four words of the content are displayed as the title of the layout. The title selector (Tab Title) has the higher precedence over the searched headings and contents.

Custom List

You can use the custom list option to choose lists based on the type, identifier, and nesting levels. Perform the following steps to specify the type of the list, identifiers, and list levels:

  1. Click the edit icon. The options to specify the List Identifier, List Level, and Tab Title (title selector) appear.  

  2. In the List Identifier text box, specify the type of the list, a custom attribute, or a combination in the form of a CSS selector.

  3. In the List Level text box, specify the nesting level of the list to be selected. The List Level text box accepts only numeric values.

  4. In the Tab Title text box, specify a CSS selector. The CSS selector identifies the text to be displayed as the title of chosen layout type. Click OK.

    Примечание.

    If no title selector (Tab Title) is specified, the contents of the list are searched for headings (h1 to h6) and the text of a heading are displayed as the title of the layout. If the content does not have a heading, then the first four words of the content are displayed as the title of the layout. The title selector (Tab Title) has the higher precedence over the searched headings and contents.

Viewing and understanding analytics reports of an adaptive document

AEM forms displays analytics reports for the adaptive form, as shown in the summary report below.

A sample summary report
A sample summary report

By default, the analytics report for the last seven days is displayed. You can view reports for the last 15 days, last one month, and so on, or specify a date range.  

Report

The summary report section gives you an insight into how the form is performing on the following key performance indicators (KPIs):

  • Total Renditions: Number of times the adaptive document has been rendered or opened
  • Average Read Time: Average time spent to read the adaptive document
  • Via-mail: Number of rendition requests originated from e-mail communication
  • Via-others: Number of rendition requests originated from non-email communication
  • Unique Visitors: Number of unique visitors

The Reading Time Distribution section displays the total number and duration of the sessions for which the adaptive document was rendered. 

Adaptive document templates

A template provides a basic structure and defines appearance (layouts and styles) of an adaptive document. It has pre-formatted components containing certain properties and content structure. Out of the box, AEM forms provides a basic adaptive document template.

You can create custom templates to provide a distinct appearance to all the adaptive documents of your organization. For detailed steps to create a custom template, see Creating a custom template for adaptive form and adaptive documents

Apply a different template to an adaptive document

You can replace the already applied template with a different template. Perform the following steps to apply a different template to an adaptive document:

  1. Select the adaptive document and click the Edit template icon.

  2. Select a template from the list of templates and click Update. The new template is applied to the adaptive document.

Edit Document Model properties of an adaptive document

You can have adaptive documents based on a letter or a data dictionary. You can replace the already applied letter with a different letter and similarly an already applied data dictionary with a different data dictionary. Perform the following steps to apply a different letter or data dictionary:

  1. Select the adaptive document and click the View Properties icon.

  2. On the properties page, click the Edit icon.

  3. Open the DOCUMENT MODEL tab. A list of data dictionaries or letters appear. The list depends on the document model of the adaptive document.

    Select a data dictionary or letter from the populated list to apply it to the adaptive document and click the Done icon.

    adaptive-document-document-model

    Примечание.

    You cannot change the document model for the adaptive documents based on a letter or a data dictionary. But, If you did not specify any Document Model while creating the form, you can choose a Document Model from the Select From drop-down box.

Batch processing of adaptive documents

You can use the batch processing to generate multiple adaptive documents from a single template. To produce adaptive documents in a batch, an adaptive document template is combined with multiple data records in a serial order. The number of adaptive documents produced is equal to the data records provided. Some examples of the batch produced documents are customized statements such as, credit card statements, telephone bills.  

You can produce HTML only, PDF only, and both HTML and PDF output in a single batch process.

  • HTML only batch processing is supported for all types of adaptive documents. In HTML only batch processing data JSON files are generated from the data xml files that are used to generate the batch.
  • PDF only batch processing is supported for adaptive document based on a letter. In PDF only batch processing, PDF documents with merged data are generated.
  • HTML and PDF batch processing is supported for adaptive documents based on a letter. In the HTML and PDF batch processing, JSON files and flat PDF documents are generated.

The batch processing APIs accept data records as single XML document, multiple XML documents, and single monolithic XML consisting of multiple records which can be split into individual records using record splitter. Adaptive documents provide record splitter of various types:

  • Depth-based record splitter: It accepts a numeric value (depth) as input and splits the records XML file at the specified depth. For example, if you specify 1 as depth, the records XML is split at the first child element from the root.
  • Name-based record splitter: It accepts the name of the XML element as input, performs the depth-first traversal on the records XML file, and splits the records XML file on the first occurrence of the specified element.
  • XPath-based record splitter: It accepts a simple XPath as input to identify the XML element on which to split the supplied XML file. A simple XPath is just a path expression, without any index or other predicates. For example, /data/recordset/record.

Примечание.

If no splitter is defined, a depth-based splitter is used with depth set to 1.

Storage Provider

The StorageProvider interface is a contract that defines how batch output (data JSON or PDFs) is stored, resolved, archived, and purged. Out of the box, adaptive documents provide a default but extensible JCR-based implementation that stores all the batch-related artifacts in /content/fd/batch. It is recommended that you create your own custom implementation of the StorageProvider for your content management system or database.

The archives listed below contain an adaptive form (sample-adaptive-forms-for-batch-processing.zip) and custom bundles (ad-batching-bundle-1.0.0.jar.zip). You can use the adaptive form and the bundles to generate a batch of adaptive documents which supports various types of inputs:

Загрузить

Perform the following steps to use the sample:

  1. Download the attached adaptive document package (sample-adaptive-forms-for-batch-processing.zip) and bundle (ad-batching-bundle-1.0.0.jar.zip) archives.

  2. Extract the ad-batching-bundle-1.0.0.jar.zip archive. The following files are extracted:

    • ad-batching-bundle-1.0.0.jar: The sample adaptive form provided in the package uses the operations provided in the ad-batching-bundle-1.0.0.jar file to initiate the batch processing.
    • ad-batching-bundle-1.0.0-sources.jar: It contains the source code of the ad-batching-bundle-1.0.0.jar file.
       
  3. Open the Package Manager. In the Package Manager, upload and install the sample-adaptive-forms-for-batch-processing.zip package and the ad-batching-bundle-1.0.0.jar file.
     

  4. Open the following adaptive form and fill all the fields:

    http://[host]:[port]/content/forms/af/Test_Batching.html?wcmmode=disabled

  5. Click the Generate Batch button. The results are displayed in the Batch Result text area.  

  6. Open the following URL to view the adaptive document with the generated data JSON:

    http://[host]:[Port]/[path_of_the_adaptive_document]/?wcmmode=disabled&guideStatePathRef=[Generated_dataJSON_Path]

Эта работа лицензируется в соответствии с лицензией Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported  На посты, размещаемые в Twitter™ и Facebook, условия Creative Commons не распространяются.

Правовые уведомления   |   Политика конфиденциальности в сети Интернет