XML 結果フォーマット

照会結果の XML フォーマットを理解することは、XSLT (またはその他の方法) を使用して必要なデータを正確に読み取るために非常に重要です。このフォーマットの概要は以下のとおりです。太字の部分は動的データを表し、省略記号 (...) は省略された項目を表しています。

<?xml version="1.0" encoding="UTF-8" ?>
<queryResult>
<metadata>
<name>Report Name</name>
<description>Report Description</description>
<objectIdentifier>Report Object Id</objectIdentifier>
<sourceSystem>Windchill Codebase URL</sourceSystem>
<sourceGateway>Windchill Gateway URL</sourceGateway>
<executingPrincipal>
<fullName>User’s Full Name</fullName>
<objectIdentifier>User Object ID</objectIdentifier>
</executingPrincipal>
<timeOfExecution>Time when Executed</timeOfExecution>
<locale>Locale of User</locale>
</metadata>
<auxData>
<dataItem name="requestParam1">value</dataItem>
. . .
<dataItem name="requestParamN">value</dataItem>
</auxData>
</qml>
. . .
</qml>
<actualParameter parameterId="ParamName1"> Value
</actualParameter>
. . .
<actualParameter parameterId="ParamNameN"> Value
</actualParameter>
<result>
<heading tag="column1TagName"
type="Java data type">column header</heading>
. . .
<heading tag="columnNTagName"
type="Java data type">column header</heading>
<row idx="1">
<column1TagName>value</column1TagName>
. . .
<columnNTagName>value</ColumnTagName>
</row>
. . .
<row idx="N">
. . .
</row>
</result>
</queryResult>

Windchill トップレベルオブジェクト (永続可能) 全体が選択された場合は、オブジェクトのオブジェクト ID、ブランチ ID (オブジェクトがバージョン化されている場合)、クラス名などの追加属性が列タグ要素で生成されます。WTUser には、電子メール属性も含まれています。これらの属性は主に、ハイパーリンクの生成を容易にするために生成されます。HTML および PDF フォーマットの定義済み XSLT スタイルシートは、これらの属性がある場合には常に使用して、オブジェクトへのリンクを生成します。

また、列名で文字 $$ を使用することによって、ハイパーリンクの生成における柔軟性が増します。照会ビルダーを使用して $$ を含む列名を指定すると、その列の各セルが作成されるのではなく、名前が解析されます。$$ が先行する列名の一部が $$ を含まない別の列名と一致すると、$$ の後に続く部分によって決まるそのデータが属性としてもう一方の列に追加されます。

<Part branchID="dataFromBranchIdColumn"
type="dataFromTypeColumn">dataFromPartColumn</Part>

行には各 Part$$branchID または Part$$type 列は含まれません。この機能により、永続性オブジェクト全体を選択しなくても、このセクションで前述したようにハイパーリンクを取得するために必要なデータが選択できます。

列のタイプが java.util.Date の場合は、HTTP リクエストの言語に基づいて、列データがフォーマットされます。さらに、列の要素には、未処理の Java 文字列値を含む "値" 属性があります。日付のほかのフォーマットをカスタマイズする必要がある場合、この値を使用できます。

要素	説明
metadata	データの取得元の照会とその照会を実行しているユーザーについてのメタ情報。
auxData	使用されたリクエストパラメータ。
qml	実行されたレポートテンプレート照会の詳細をすべて定義します (詳細については、<Windchill コードベース>/wt/query/qml/qml.dtd を参照してください)。
actualParameters	照会の実行時に使用された照会パラメータ。
result	列のヘッダおよびタイプとデータの行。