XSL:RML 报表

XSL:RML 报表

RML 报表不需要编程，但是需要两种简单的 XML 文件:

一种文件描述导出数据 (*.xml)

一种可以包含数据和表现规则的文件 (*.xsl)

XML模板(template)主要描述哪些域(field)的资源需要(由server)导出. XSL:RML 样式表单(style sheet)处理输出数据，就像报表(report)中的 “static text” 一样. “static text” 是指在报表中相同、不怎么变化的部分，比如表格头部的标题(title of table column).

范例

下面给出一个例子，说明生成ERP报表的不同文件.

XML 模板

<?xml version="1.0"?>
    <ids>
    <id type="fields" name="id">
        <name type="field" name="name"/>
        <ref type="field" name="ref"/>
    </id>
    </ids>

XML 数据文件 (生成的)

<?xml version="1.0"?>
    <ids>
    <id>
        <name>Tiny sprl</name>
        <ref>pnk00</ref>
    </id><id>
        <name>ASUS</name>
        <ref></ref>
    </id><id>
        <name>Agrolait</name>
        <ref></ref>
    </id><id>
        <name>Banque Plein-Aux-As</name>
        <ref></ref>
    </id><id>
        <name>China Export</name>
        <ref></ref>
    </id><id>
        <name>Ditrib PC</name>
        <ref></ref>
    </id><id>
        <name>Ecole de Commerce de Liege</name>
        <ref></ref>
    </id><id>
        <name>Elec Import</name>
        <ref></ref>
    </id><id>
        <name>Maxtor</name>
        <ref></ref>
    </id><id>
        <name>Mediapole SPRL</name>
        <ref></ref>
    </id><id>
        <name>Opensides sprl</name>
        <ref>os</ref>
    </id><id>
        <name>Tecsas sarl</name>
        <ref></ref>
    </id>
    </ids>

XSL 样式表

<?xml version="1.0" encoding="utf-8"?> <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:fo="http://www.w3.org/1999/XSL/Format">
    <xsl:template match="/">
        <xsl:apply-templates select="ids"/>
    </xsl:template>
    <xsl:template match="ids">
        <document>
            <template pageSize="21cm,29.7cm">
                <pageTemplate>
                    <frame id="col1" x1="2cm" y1="2.4cm" width="8cm" height="26cm"/>
                    <frame id="col2" x1="11cm" y1="2.4cm" width="8cm" height="26cm"/>
                </pageTemplate>
            </template>
        <stylesheet>
            <blockTableStyle id="ids">
                <blockFont name="Helvetica-BoldOblique" size="12" start="0,0" stop="-1,0"/>
                <lineStyle kind="BOX" colorName="black" start="0,0" stop="-1,0"/>
                <lineStyle kind="BOX" colorName="black" start="0,0" stop="-1,-1"/>
            </blockTableStyle>
        </stylesheet>
        <story>
            <blockTable colWidths="2cm, 6cm" repeatRows="1" style="ids">
                <tr>
                    <td t="1">Ref.</td>
                    <td t="1">Name</td>
                </tr>
                <xsl:apply-templates select="id"/>
            </blockTable>
        </story>
        </document>
    </xsl:template>
    <xsl:template match="id">
        <tr>
            <td><xsl:value-of select="ref"/></td>
            <td><para><xsl:value-of select="name"/></para></td>
        </tr>
    </xsl:template>
    </xsl:stylesheet>

对应的RML文件 (生成的)

<?xml version="1.0"?>
    <document>
    ...
        <story>
            <blockTable colWidths="2cm, 6cm" repeatRows="1" style="ids">
                <tr>
                    <td t="1">Ref.</td>
                    <td t="1">Name</td>
                </tr>
                <tr>
                    <td>pnk00</td>
                    <td><para>Tiny sprl</para></td>
                </tr>
                <tr>
                    <td></td>
                    <td><para>ASUS</para></td>
                </tr>
                <tr>
                    <td></td>
                    <td><para>Agrolait</para></td>
                </tr>
                <tr>
                    <td></td>
                    <td><para>Banque Plein-Aux-As</para></td>
                </tr>
                <tr>
                    <td></td>
                    <td><para>China Export</para></td>
                </tr>
                <tr>
                    <td></td>
                    <td><para>Ditrib PC</para></td>
                </tr>
                <tr>
                    <td></td>
                    <td><para>Ecole de Commerce de Liege</para></td>
                </tr>
                <tr>
                    <td></td>
                    <td><para>Elec Import</para></td>
                </tr>
                <tr>
                    <td></td>
                    <td><para>Maxtor</para></td>
                </tr>
                <tr>
                    <td></td>
                    <td><para>Mediapole SPRL</para></td>
                </tr>
                <tr>
                    <td>os</td>
                    <td><para>Opensides sprl</para></td>
                </tr>
                <tr>
                <td></td>
                    <td><para>Tecsas sarl</para></td>
                </tr>
            </blockTable>
        </story>
    </document>

更多所用格式的帮助:

RML user guide

XSL specification

XSL tutorial

这些格式都是作为 XML specification. 的拓展。

XML 模板

XML 模板(template)是简单XML文件，用来描述报表所有可用的object字段(field)中哪些字段(object fields)是有用的(available).

文件格式

标签(tag)名称可以任意(但在XML中必须是有效的)。XSL文件中，你要使用到这些名称。大多数情况下，标签名(the name of tag)和引用的对象字段(object field)是一致的.

Nodes without type attribute are transferred identically into the XML destination file (the data file). Nodes with a type attribute will be parsed by the server and their content will be replaced by data coming from objects. In addition to the type attribute, nodes have other possible attributes. These attributes depend on the type of the node (each node type supports or needs different attributes). Most node types have a name attribute, which refers to the name of a field of the object on which we work.

关于object中的 “browse” 方法，报表的字段名称是可以使用一种类似面向对象语言中的notation来表示。这意为着 “(关联字段)是可以用这种类似 “bridges” (桥)的方式获得相关对象数据.

让我们试用 “account.transfer” 对象来举例。Account.transfer对象包含一个partner_id字段，这个字段是一个指向”res.partner” 对象的 (“many to one”)(多对一)的关系。我们假设要创建一个转账(transfers)的报表,，而报表中需要从partner中选择收款人。我们可以这样写以获得收款人的名字字段:

partner_id.name

其它类型

这里是可用的字段类型的列表:

field: 最简单的类型。有这种类型的结点(node),server都会用已知字段(field)的名字属性替换掉node的内容.

fields: 这种结点(node)类型，server会在XML数据文件中生成一个和已知名字属性唯一相同的结点(?).

注释:

** 这个结点(node)类型经常使用 “id” 作为名字属性。user使用选择resource的接口创建结点(node)时，会受到影响. ** 结点(node)的语法和SQL语句 “SELECT FROM object_table WHERE id in identifier_list GROUP BY field_name” 相似，其中identifier_list 是::user (in the interface)可以通过接口选择使用的resource .

eval: 这个结点(node)类型计算 expr 属性中表达式(expression)的值。表达式(expression)可以是python表达式，也可以是object的字段名字.

zoom: 这个结点(node)类型允许 “enter” 通过relation字段使用name属性中列出的资源. 意味着子结点(child node)不用其他对象名字字段做前缀也可以使用资源字段(fields of that source)。在上面的例子中，我们可以通过以下方式获得parter的name字段:
<partner type="zoom" name="partner_id">
        <name type="field" name="name"/>
</partner>
In this precise case, there is of course no point in using this notation instead of the standard notation below:
<name type="field" name="partner_id.name"/>

zoom 类型往往用于恢复同一个object的多个字段(field).

function: 返回name属性中所调用函数的结果。这个函数必须是提前定义的。暂时可用的函数是today，用来返回现在日期.

call: calls对象name属性是方法名称，args属性是参数名称。函数的结果放进一个字典(dictionary)，形如：{‘name_of_variable’: value, … } 这个结果可以被子结点使用。使用call类型的结点必须有相应的value属性，以和调用方法所返回的字典键(key)匹配.

样例:

<cost type="call" name="compute_seller_costs" args="">
    <name value="name"/>
    <amount value="amount"/>
</cost>

TODO: documenter format methode appellée def compute_buyer_costs(self, cr, uid, ids, *args):

attachment: 提取属性name中对应id的资源，作为报表的图像(image).

范例:

范例

XML 文件的例子:

<?xml version="1.0" encoding="ISO-8859-1"?>
<transfer-list>
    <transfer type="fields" name="id">
        <name type="field" name="name"/>
        <partner_id type="field" name="partner_id.name"/>
        <date type="field" name="date"/>
        <type type="field" name="type"/>
        <reference type="field" name="reference"/>
        <amount type="field" name="amount"/>
        <change type="field" name="change"/>
    </transfer>
</transfer-list>

RML 介绍

有关RML格式的更多信息, 请参照官方文档.

http://www.reportlab.com/docs/RML_UserGuide.pdf

XSL:RML 样式表

生成报表的XSL样式表有两个可选项. 两者都可以我们自己定制, 或者，使用我们自己定制的模板(template)

可以是freestyle,也可以用 corporate_defaults + rml_template

引入 rml_template.xsl

需要的模板:

frames?

stylesheet

story

可选的模板:

Translations

As OpenERP can be used in several langages, reports must be translatable. But in a report, everything doesn’t have to be translated : only the actual text has to be translated, not the formatting codes. A field will be processed by the translation system if the XML tag which surrounds it (whatever it is) has a t=”1” attribute. The server will translate all the fields with such attributes in the report generation process.

有用的链接:

http://www.reportlab.com/docs/RML_UserGuide.pdf RML UserGuide (pdf) (reportlab.com)

http://www.zvon.org/xxl/XSLTutorial/Output/index.html XSL 教程 (zvon.org)

http://www.zvon.org/xxl/XSLTreference/Output/index.html XSL 参考 (zvon.org)

http://www.w3schools.com/xsl/ XSL 教程和参考 (W3Schools)

http://www.w3.org/TR/xslt/ XSL 规范 (W3C)

Example (with corporate defaults):

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" :xmlns:fo="http://www.w3.org/1999/XSL/Format">
    <xsl:import href="../../custom/corporate_defaults.xsl"/>
    <xsl:import href="../../base/report/rml_template.xsl"/>
    <xsl:variable name="page_format">a4_normal</xsl:variable>
    <xsl:template match="/">
        <xsl:call-template name="rml"/>
    </xsl:template>
    <xsl:template name="stylesheet">
        </xsl:template>
    <xsl:template name="story">
        <xsl:apply-templates select="transfer-list"/>
    </xsl:template>
    <xsl:template match="transfer-list">
        <xsl:apply-templates select="transfer"/>
    </xsl:template>
    <xsl:template match="transfer">
        <setNextTemplate name="other_pages"/>
        <para>
            Document: <xsl:value-of select="name"/>
        </para><para>
            Type: <xsl:value-of select="type"/>
        </para><para>
            Reference: <xsl:value-of select="reference"/>
        </para><para>
            Partner ID: <xsl:value-of select="partner_id"/>
        </para><para>
            Date: <xsl:value-of select="date"/>
        </para><para>
            Amount: <xsl:value-of select="amount"/>
        </para>
        <xsl:if test="number(change)>0">
            <para>
                Change: <xsl:value-of select="change"/>
            </para>
        </xsl:if>
        <setNextTemplate name="first_page"/>
        <pageBreak/>
    </xsl:template>
</xsl:stylesheet>