使用代理UI准备和发送交互式通信

代理UI允许代理准备交互式通信并将其发送到后处理。 代理根据允许进行所需的修改，并将交互式通信提交到帖子流程，如电子邮件或打印。

概述

创建交互式通信后，代理可以在代理UI中打开交互式通信，并通过输入数据并管理内容和附件来准备特定于收件人的副本。 最后，代理可将交互式通信提交到后处理。

在使用代理UI准备交互式通信时，代理在将交互式通信提交到帖子流程之前，会在代理UI中管理交互式通信的以下方面：

• 数据:“代理”UI的“数据”选项卡显示“交互式通信”中任何可编辑的代理变量和已解锁的表单数据模型属性。 这些变量/属性是在编辑或创建包含在交互式通信中的文档片段时创建的。 “数据”选项卡还包含XDP/打印渠道模板中构建的任何字段。 “数据”选项卡仅在代理可编辑的交互式通信中存在任何变量、表单数据模型属性或字段时才显示。
• 内容:在“内容”选项卡中，代理管理交互式通信中的内容，如文档片段和内容变量。 在这些文档片段的属性中创建交互式通信时，代理可以根据允许在文档片段中进行更改。 代理还可以重新排序、添加/删除文档片段以及添加分页符（如果允许）。
• 附件:仅当交互式通信具有任何附件或代理具有库访问权限时，“附件”选项卡才会在代理UI中显示。 代理人可以（也可以不允许）更改或编辑附件。

使用代理UI准备交互式通信

1. 选择 Forms > Forms和文档.

2. 选择相应的交互式通信并点按 Open Agent UI.

   注意

   代理UI仅在选定的交互式通信具有打印渠道时才起作用。

   

   根据交互式通信的内容和属性，将显示代理UI，其中包含以下三个选项卡：数据、内容和附件。

   

   继续输入数据、管理内容和管理附件。

输入数据

1. 在数据选项卡中，根据需要输入变量、表单数据模型属性和打印模板(XDP)字段的数据。 填写标有星号(*)的所有必填字段，以启用 提交 按钮。

   点按“交互式通信”预览中的数据字段值，以在“数据”选项卡中突出显示相应的数据字段，反之亦然。

管理内容

在“内容”选项卡中，在交互式通信中管理内容，如文档片段和内容变量。

1. 选择 内容. 此时将显示交互式通信的内容选项卡。

   

2. 在“内容”选项卡中，根据需要编辑文档片段。 要将焦点集中在内容层次结构中的相关片段，您可以点按交互式通信预览中的相关行或段落，也可以直接点按内容层次结构中的片段。

   例如，在下图的预览中选择了行为“立即联机付款……”的文档片段，并且在“内容”选项卡中选择了相同的文档片段。

   

   在“内容”或“数据”选项卡中，点按高亮显示内容中的选定模块( )，您可以在预览中点按/选择相关文本、段落或数据字段后，禁用或启用功能以转到文档片段。

   创建交互式通信时允许代理编辑的片段具有编辑选定内容( )图标。 点按编辑选定内容图标，以在编辑模式下启动片段并在其中进行更改。 使用以下选项设置文本格式和管理文本：

   • 格式选项

     • 从其他应用程序中复制粘贴格式文本
     • 突出显示部分文本

   • 特殊字符

   • 键盘快捷键

   有关代理用户界面中可用于各种文档片段的操作的更多信息，请参阅 代理用户界面中可用的操作和信息.

3. 要向交互式通信的打印输出添加分页符，请将光标放在要插入分页符的位置，然后选择“分页前”或“分页后”( )。

   在交互式通信中插入显式分页符占位符。 要查看显式分页符对交互式通信的影响，请参阅打印预览。

   

   继续管理交互式通信的附件。

管理附件

1. 选择 附件. 代理UI在创建交互式通信时显示设置的可用附件。

   您可以通过点按视图图标，选择不连同交互式通信一起提交附件，然后可以点按附件中的十字，从交互式通信中删除附件（如果允许代理删除或隐藏附件）。 对于在创建交互式通信时指定为必需的附件，将禁用“查看”和“删除”图标。

   

2. 点按库访问( )图标以访问内容库，以将DAM资产作为附件插入。

   注意

   仅当在创建交互式通信时启用了库访问（在打印渠道的文档容器属性中）时，才可使用库访问图标。

3. 如果在创建交互式通信时未锁定附件的顺序，则可以通过选择附件并点按向下和向上箭头来重新排序附件。

4. 使用“Web预览”和“打印预览”可查看这两个输出是否符合您的要求。

   如果您发现预览效果令人满意，请点按 提交 将交互式通信提交/发送到帖子进程。 或者，要进行更改，请退出预览以返回进行更改。

设置文本格式

在代理UI中编辑文本片段时，工具栏会根据您选择进行的编辑类型而发生更改：字体、段落或列表：

字体工具栏

段落工具栏

列表工具栏

突出显示/强调部分文本

要突出显示可编辑片段中的部分文本，请选择文本，然后点按高亮显示颜色。

粘贴格式化文本

在文本中插入特殊字符

代理UI内置了对210个特殊字符的支持。 管理员可以 通过自定义添加对更多/自定义特殊字符的支持.

附件投放

• 当使用服务器端API作为交互式或非交互式PDF呈现交互式通信时，呈现的PDF包含附件作为PDF附件。
• 当使用代理UI将与交互式通信关联的后处理作为提交的一部分加载时，附件将作为列表传递<com.adobe.idp.document> inAttachmentDocs参数。
• 投放机制工作流（如电子邮件和打印）还会发送附件以及交互式通信的PDF版本。

代理用户界面中可用的操作和信息

文档片段

• 向上/向下箭头:在交互式通信中向上或向下移动文档片段的箭头。
• 删除:如果允许，请从交互式通信中删除文档片段。
• 分页时间之前 （适用于目标区域的子片段）：在文档片段之前插入分页符。
• 缩进:增加或减少文档片段的缩进。
• 之后分页 （适用于目标区域的子片段）：在文档片段之后插入分页符。

• 编辑（仅限文本片段）：打开富文本编辑器以编辑文本文档片段。 有关更多信息，请参阅 设置文本格式.

• 选择（眼睛图标）：包括\排除交互式通信中的文档片段。

• 未填充的值（信息）：指示文档片段中未填充变量的数量。

列出文档片段

• 插入空行：插入新的空行。
• 选择（眼睛图标）：包括\排除交互式通信中的文档片段。
• 跳过项目符号/编号：启用以跳过列表文档片段中的项目符号/编号。
• 未填充的值（信息）：指示文档片段中未填充变量的数量。

将交互式通信另存为草稿

您可以使用代理UI为每个交互式通信保存一个或多个草稿，稍后检索草稿以继续处理该草稿。 您可以为每个草稿指定不同的名称以标识它。

Adobe建议按顺序执行这些说明，以成功将交互式通信另存为草稿。

启用“另存为草稿”功能

默认情况下，“另存为草稿”功能未启用。 执行以下步骤以启用该功能：

1. 实施 ccrDocumentInstance 服务提供商接口(SPI)。

   SPI允许您将交互式通信的草稿版本保存到数据库中，并使用草稿ID作为唯一标识符。 这些说明假定您事先知道如何使用Maven项目构建OSGi包。

   有关SPI实施的示例，请参阅 CcrDocumentInstance SPI实现示例.

2. 打开 http://<hostname>:<port>/ system/console/bundles 点按 安装/更新 上传OSGi包。 验证已上传包的状态是否显示为 活动. 如果包的状态未显示为 活动.

3. 转到 https://'[server]:[port]'/system/console/configMgr.

4. 点按 创建通信配置.

5. 选择 使用CCRDocumentInstanceService启用保存 点按 保存.

将交互式通信另存为草稿

执行以下步骤以将交互式通信另存为草稿：

1. 在Forms Manager中选择交互式通信，然后点按 Open Agent UI.

2. 在代理UI中进行适当的更改，然后点按 另存为草稿.

3. 在 名称 字段和点按 完成.

将交互式通信另存为草稿后，点按 保存更改 以保存对草稿的任何进一步更改。

检索交互式通信的草稿

将交互式通信另存为草稿后，您可以检索它以继续处理它。 使用以下方法检索交互式通信：

https://server:port/aem/forms/createcorrespondence.hmtl?draftid=[draftid]

[draftid] 是指将交互式通信另存为草稿后生成的草稿版本的唯一标识符。

CcrDocumentInstance SPI实现示例

实施 ccrDocumentInstance 将交互式通信另存为草稿的SPI。 以下是 ccrDocumentInstance SPI。

package Implementation;

import com.adobe.fd.ccm.ccr.ccrDocumentInstance.api.exception.CCRDocumentException;
import com.adobe.fd.ccm.ccr.ccrDocumentInstance.api.model.CCRDocumentInstance;
import com.adobe.fd.ccm.ccr.ccrDocumentInstance.api.services.CCRDocumentInstanceService;
import org.apache.commons.lang3.StringUtils;
import org.osgi.service.component.annotations.Component;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.*;


@Component(service = CCRDocumentInstanceService.class, immediate = true)
public class CCRDraftService implements CCRDocumentInstanceService {

    private static final Logger logger = LoggerFactory.getLogger(CCRDraftService.class);

    private HashMap<String, Object> draftDataMap = new HashMap<>();

    @Override
    public String save(CCRDocumentInstance ccrDocumentInstance) throws CCRDocumentException {
        String documentInstanceName = ccrDocumentInstance.getName();
        if (StringUtils.isNotEmpty(documentInstanceName)) {
            logger.info("Saving ccrData with name : {}", ccrDocumentInstance.getName());
            if (!CCRDocumentInstance.Status.SUBMIT.equals(ccrDocumentInstance.getStatus())) {
                ccrDocumentInstance = mySQLDataBaseServiceCRUD(ccrDocumentInstance,null, "SAVE");
            }
        } else {
            logger.error("Could not save data as draft name is empty");
        }
        return ccrDocumentInstance.getId();
    }

    @Override
    public void update(CCRDocumentInstance ccrDocumentInstance) throws CCRDocumentException {
        String documentInstanceName = ccrDocumentInstance.getName();
        if (StringUtils.isNotEmpty(documentInstanceName)) {
            logger.info("Saving ccrData with name : {}", documentInstanceName);
            mySQLDataBaseServiceCRUD(ccrDocumentInstance, ccrDocumentInstance.getId(), "UPDATE");
        } else {
            logger.error("Could not save data as draft Name is empty");
        }
    }

    @Override
    public CCRDocumentInstance get(String id) throws CCRDocumentException {
        CCRDocumentInstance cCRDocumentInstance;
        if (StringUtils.isEmpty(id)) {
            logger.error("Could not retrieve data as draftId is empty");
            cCRDocumentInstance = null;
        } else {
            cCRDocumentInstance = mySQLDataBaseServiceCRUD(null, id,"GET");
        }
        return cCRDocumentInstance;
    }

    @Override
    public List<CCRDocumentInstance> getAll(String userId, Date creationTime, Date updateTime,
                                            Map<String, Object> optionsParams) throws CCRDocumentException {
        List<CCRDocumentInstance> ccrDocumentInstancesList = new ArrayList<>();

        HashMap<String, Object> allSavedDraft = mySQLGetALLData();
        for (String key : allSavedDraft.keySet()) {
            ccrDocumentInstancesList.add((CCRDocumentInstance) allSavedDraft.get(key));
        }
        return ccrDocumentInstancesList;
    }

    //The APIs call the service in the database using the following section.
    private CCRDocumentInstance mySQLDataBaseServiceCRUD(CCRDocumentInstance ccrDocumentInstance,String draftId, String method){
        if(method.equals("SAVE")){

            String autoGenerateId = draftDataMap.size() + 1 +"";
            ccrDocumentInstance.setId(autoGenerateId);
            draftDataMap.put(autoGenerateId, ccrDocumentInstance);
            return ccrDocumentInstance;

        }else if (method.equals("UPDATE")){

            draftDataMap.put(ccrDocumentInstance.getId(), ccrDocumentInstance);
            return ccrDocumentInstance;

        }else if(method.equals("GET")){

            return (CCRDocumentInstance) draftDataMap.get(draftId);

        }
        return null;
    }

    private HashMap<String, Object> mySQLGetALLData(){
        return draftDataMap;
    }
}

的 save, update, get和 getAll 操作调用数据库服务以将交互式通信另存为草稿、更新交互式通信、从数据库检索数据以及检索数据库中所有可用交互式通信的数据。 此示例使用 mySQLDataBaseServiceCRUD 作为数据库服务的名称。

下表说明了示例 ccrDocumentInstance SPI实施。 它显示了 save, update, get和 getAll 操作在示例实施中调用数据库服务。

操作	数据库服务示例
您可以为交互式通信创建草稿，也可以直接提交。 用于保存操作的API会检查交互式通信是否作为草稿提交，并且它包含草稿名称。 然后，API使用“保存”作为输入方法调用mySQLDataBaseServiceCRUD服务。 [#$sd1_sf1_dp9]	mySQLDataBaseServiceCRUD服务验证“另存为”作为输入方法，并生成一个自动生成的草稿ID，并将其返回到AEM。 生成草稿ID的逻辑可能因数据库而异。 [#$sd1_sf1_dp13]
用于更新操作的API可检索交互式通信草稿的状态，并检查交互式通信是否包含草稿名称。 API会调用mySQLDataBaseServiceCRUD服务以在数据库中更新该状态。 [#$sd1_sf1_dp17]	mySQLDataBaseServiceCRUD服务将Update验证为输入方法，并将Interactive Communication草稿的状态保存在数据库中。
用于获取操作的API会检查交互式通信是否包含草稿ID。 然后，API调用mySQLDataBaseServiceCRUD服务，并使用Get作为输入方法，以检索用于交互式通信的数据。	mySQLDataBaseServiceCRUD服务验证Get作为输入方法，并根据草稿ID检索交互式通信的数据。 [#$sd1_sf1_dp29]
getAll操作的API会调用mySQLGetALLData服务，以检索数据库中保存的所有交互式通信的数据。	mySQLGetALLData服务可检索数据库中保存的所有交互式通信的数据。 [#$sd1_sf1_dp37]

以下示例 pom.xml 属于实施的文件：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="https://maven.apache.org/POM/4.0.0"
         xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.adobe.livecycle</groupId>
    <artifactId>draft-sample</artifactId>
    <version>2.0.0-SNAPSHOT</version>

    <name>Interact</name>
    <packaging>bundle</packaging>

    <dependencies>
        <dependency>
            <groupId>com.adobe.aemfd</groupId>
            <artifactId>aemfd-client-sdk</artifactId>
            <version>6.0.160</version>
        </dependency>
    </dependencies>


    <!-- ====================================================================== -->
    <!-- B U I L D D E F I N I T I O N -->
    <!-- ====================================================================== -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>
                <version>3.3.0</version>
                <extensions>true</extensions>
                <executions>
                    <!--Configure extra execution of 'manifest' in process-classes phase to make sure SCR metadata is generated before unit test runs-->
                    <execution>
                        <id>scr-metadata</id>
                        <goals>
                            <goal>manifest</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <exportScr>true</exportScr>
                    <instructions>
                        <!-- Enable processing of OSGI DS component annotations -->
                        <_dsannotations>*</_dsannotations>
                        <!-- Enable processing of OSGI metatype annotations -->
                        <_metatypeannotations>*</_metatypeannotations>
                        <Bundle-SymbolicName>${project.groupId}-${project.artifactId}</Bundle-SymbolicName>
                    </instructions>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>8</source>
                    <target>8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
    <profiles>
        <profile>
            <id>autoInstall</id>
            <build>
                <plugins>
                    <plugin>
                        <groupId>org.apache.sling</groupId>
                        <artifactId>maven-sling-plugin</artifactId>
                        <executions>
                            <execution>
                                <id>install-bundle</id>
                                <phase>install</phase>
                                <goals>
                                    <goal>install</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>
    </profiles>

</project>

Business.Adobe.com 资源

Auto Text Summarization Personalized Experiences Responsive Forms Dynamic Media Digital Rights Management Content Management System