CICS 文档和文档模板

应用程序可以在 EXEC CICS® DOCUMENT 应用程序编程接口中使用命令来创建文档并将数据放入其中。 文档模板是文档的一部分,可以脱机创建,也可以在另一个 CICS 程序中创建,并由应用程序用于创建文档。

文档和文档模板最常用于生成由 CICS Web Support 提供的 Web 页面。 它们可以包含用作 HTTP 请求或响应主体的 HTML。 但是,它们并不局限于此用途。

在 Java™ 应用程序中,可以使用 CICS Java 类库 (JCICS) 来访问文档服务。 Document 类提供 EXEC CICS DOCUMENT 命令的 Java 实现。 有关类文档,请参阅 JCICS 类参考中的 Javadoc。 Java 应用程序可以检索由使用其他编程语言编写的应用程序创建的文档,并使用 JCICS 类来处理这些文档。

文件

您可以使用 EXEC CICS DOCUMENT CREATE 命令在应用程序中创建空文档,然后使用后续的 DOCUMENT INSERT 命令构建内容。 或者,可以使用 DOCUMENT CREATE 在一个步骤中创建和构建文档。 您可以使用应用程序指定的数据或使用文档模板或使用其他文档来创建文档。 文档处理程序返回用于在后续调用时标识文档的令牌 (DOCTOKEN)。

创建文档后,可以通过发出一个或多个 DOCUMENT INSERT 命令来扩展内容。 同样,您可以添加由应用程序,文档模板或其他文档指定的数据。 您还可以在数据块之间的文档中插入书签,并使用书签在文档中间添加或替换数据。

应用程序创建的文档仅在创建这些文档的 CICS 任务的长度内存在。 这意味着,当 CICS 任务中的最后一个程序将控制权返回给 CICS 时,将删除任务生存期内创建的所有文档。 如果要在另一个任务中使用文档,那么应用程序负责在终止之前保存该文档。 可以使用 DOCUMENT RETRIEVE 命令获取文档的副本。 然后,应用程序可以将此副本保存到其选择的位置,例如临时存储器队列。 然后,可以使用此副本来重新创建文档。

文档模板

可以从多个不同的源检索文档模板,以适应应用程序中使用这些模板的方式。 文档模板的源可以是下列任何一项:
  • 分区数据集
  • CICS 程序
  • CICS 文件
  • z/OS® UNIX System Services 文件
  • 临时存储器队列
  • 瞬时数据队列
  • 出口程序
使用 DOCTEMPLATE 资源定义来定义文档模板,这些定义指定文档模板的源。

文档模板可以包含静态数据,也可以包含符号。 符号表示在将模板添加到文档时 (即发出 DOCUMENT CREATE 或 DOCUMENT INSERT 命令时) 解析的变量数据。 要替换符号的值由应用程序使用 DOCUMENT CREATE 命令的符号列表选项或 DOCUMENT SET 命令的符号列表或 SYMBOL 选项指定。

文档模板还可以包含嵌入式命令,以设置符号的缺省值,标识符号以及嵌入另一个模板。

除了由应用程序使用外,还可以在 URIMAP 定义中指定文档模板,以提供对 Web 客户机的 HTTP 请求的静态响应,而无需应用程序。 CICS 使用文档模板作为 Web 页面的主体来生成响应。