<Content> 元素
<Content> 是 RIXML 字符串中的关键元素,它包含要发送的研究文档。发送实体从本地或网络文件系统中读取研究文档,然后根据协商结果进行编码并将文档放到这个元素中。在对从该元素中捕捉到的内容进行解码之后,接收实体将内容保存到本地或网络文件系统。
如果将多种类型的研究文档发送给同一个接收者,就会用到这个元素的多个实例。应该让 RIXML 事务保持简单:一次发送一个文档简化了收发两端的数据处理。清单 3 给出一个包含 <Content> 元素的代码块。
清单 3. 包含 <Content> 元素的代码
<Content>
<Description>Sample document prepared for this tutorial.</Description>
<Title>Test Document</Title>
<Resource resourceID="1" sequence="1" primaryIndicator="Yes" language="eng"
sizeInBytes="197">
<Protocol>DOC</Protocol>
<Length lengthUnit="Pages">5</Length>
<MIMEType>application/octet-stream</MIMEType>
<Name>TestDelivery.DOC</Name>
<Comments>Word Document is Base64 Encoded before placing it in the Data element.
Note that the data below is not actual.</Comments>
<Data>PCFET0NUWVBFIEhUTUwgUFVCTElDIFwiLS8vVzNDLy9EVE
QgSFRNTCA0LjAxIFRyYW5zaXRpb25hbC8vRU5cIj4NCjxodG1sPg0KICA8aG
VhZD4NCiAgPHRpdGxlPjwvdGl0bGU+DQogIDwvaGVhZD4NCiAgPGJvZHk
+DQogIDwvYm9keT4NCjwvaHRtbD4=</Data>
</Resource>
</Content>
|
<Description> 元素
<Content> 元素中的 <Description> 元素包含研究文档的简短描述。它还可以包含关于电子邮件消息或电话通话的摘要,以帮助发送者或接收者记起交换文档的上下文。
<Title> 元素
<Title> 元素通常包含文档的分类。可以使用的值包括 Banking Research 和 Credit Default Swaps。您需要将文档的实际标题放到 <Resource> 元素中。
可选元素:<Subtitle>、<Abstract> 和 <Synopsis>
通常不需要使用 <Content> 中的 <Subtitle>、<Abstract> 和 <Synopsis> 元素。如果接收实体直接使用 RIXML 字符串将文档提交到 CMS,那么实现可以使用这些值。一些 CMS 实现需要文档大纲和摘要,以帮助读者找到所需的文档。
<Resource> 元素
<Resource> 元素包含实际的文档。大多数情况下,传输只包含这个元素的一个实例。然而在特殊情况下,如果文档以多种格式发送,则需要使用这个元素的多个实例。例如,研究文档可以以 Microsoft Office Excel® 格式或文本格式发送,然后再转发到两个不同的内部系统。
resourceID 和相关的属性
<Resource> 元素的 resourceID 属性设置为 1。如果使用了一个以上的资源,就给 resourceID 属性设置更大的数字。
<Resource> 元素的 language 属性设置为文档内容使用的语言。例如,如果是英语,则设置为 eng。sizeInBytes 属性设置为文档在文件系统中的大小。
primaryIndicator 值设置为 Yes,表明这是传输中的主要文档。在某些情况下,发送方以不同的格式将相同的内容作为不同的资源发送(例如,Word 文档和文本文件)。在这种情况下,包含主文档(例如,Word 文档)的资源的 primaryIndicator 值设置为 Yes,其他资源的 primaryIndicator 值设置为 No。
sequence 设置为与 resourceID 相同的值。
<Protocol> 元素
<Resource> 元素中的 <Protocol> 元素必须设置为各方预先商量好的值 — 例如,Word 文档的值可以是 Microsoft Word,Excel 文档的值可以是 Microsoft Excel。如果应用程序试图处理这些值以进行决策,则将这个元素的值设置为 WORD 或 XCEL。
特定于文档的元素
lengthUnit 通常设置为 Pages,并且该元素在文档中包含页码数。如果被传输的文档是音频或视频文件,则可以使用值 TimeUnit。当 Pages 用作 lengthUnit 时,<Length> 元素在文档中包含页码数;当 TimeUnit 用作 lengthUnit 时,<Length> 元素包含音频或视频的分钟数。
<MIMEType> 元素的值必须设置为 application/octet-stream。
<Name> 和 <Data> 元素
RIXML 字符串中最重要的两个元素是 <Resource> 的 <Name> 和 <Data>。<Name> 元素必须包含文件系统上的文档的原名。在将文档存储到文件系统或嵌入到 CMS 时,这个元素指导接收实体命名文件。发送实体在电话通话或其他组交流活动期间使用这个文件名。它还保留嵌入到文档名中的任何版本信息。
<Data> 元素包含要发送的文档的文本或二进制内容(例如,图像文件)。最常用的文档传输方法是从文件系统和 Base64-编码文件流中读取文档。Base64 也称为 MIME 内容传输编码。简单而言,这种编码将文件中的所有内容转换成文本,从而允许任何文件(简单的文本文件、XML 文件、二进制文件、图像或媒体文件)作为 RIXML 字符串的一部分传输。在接收端,可以从 RIXML 字符串提取文本字符串并将其转换回原来的文件格式。
|