ホーム > マニュアル > ライブラリ構築マニュアル > XML ファイルの詳細 |
XML ファイルの詳細XML ファイルには、ライブラリの情報、フィールドのタイプ、フィールド値が書き出されます。 eXtensible Markup Language
|
書き出しの項目 | 内容 |
---|---|
「サイボウズ デヂエ」 | バージョン |
ライブラリ | ライブラリ名
ライブラリ ID |
フィールド | フィールド名
XML 書き出し時のレコード一覧ビューに関わらず、そのユーザーが閲覧できるフィールドすべての情報が書き出されます。 フィールド ID フィールドタイプ |
レコード |
レコード ID 登録者 登録日時 更新者 更新日時 各レコードの値 XML 書き出し時のレコード一覧ビューに関わらず、そのユーザーが閲覧できるフィールドすべての情報が書き出されます。 フィールドタイプ フィールド ID 設定されている値
※ フィールドタイプが「自動ルックアップ」の場合は、以下の内容が書き出されます。
・参照しているライブラリ ID ・参照しているレコード ID ・参照している値 (設定されている値) |
ライブラリ | xml のバージョン (1.0)
使用文字コード (シフト JIS) DTD ファイルのアクセス URL |
レコード閲覧権がない状態で XML 書き出し実行の URL に直接アクセスした場合は、レコードが参照できないエラーを XML の形式で書き出します。形式は以下となります。
<?xml version="1.0" encoding="Shift_JIS" ?>
<!DOCTYPE dezie SYSTEM "(DTD ファイルの URL)"> <dezie version="4.0"> <error>13875</error> </dezie> |
書き出される XML ファイルの書式は、以下のようになります。
|
書き出された XML ファイルは、最初の 2 行で、そのファイルの内容を説明しています。
1 | <?xml version="1.0" encoding="Shift_JIS" ?> |
2 | <!DOCTYPE dezie SYSTEM"(DTD ファイルの URL)"> |
1 行目は、以下のことを示しています。
2 行目は、以下のこと示しています。
「サイボウズ デヂエ」の情報を <dezie> タグを使って表現します。
<dezie version="(バージョン番号)">
[ここに、ライブラリ、フィールド、レコードの情報が書き出されます] </dezie> |
書き出し対象である「サイボウズ デヂエ」のバージョンが (バージョン番号) であることを示します。バージョン番号は、メジャーバージョンのみ表示されます。例えば、(6.0(0.1) の場合、「6.0」という表記になります。
ライブラリの情報を <library> タグを使って表現します。
<library id="(ライブラリの ID)" name="(ライブラリの名前)">
[ここに、フィールド、レコードの情報が書き出されます] </library> |
書き出し対象になっているライブラリの ID (did) が (ライブラリの ID)、名前が (ライブラリの名前) であることを示します。
フィールドの情報を <field-list> タグ、<field> タグを使って表現します。
フィールド一覧を <field-list> タグを使って表現します。
<field-list>
[ここに、各フィールドの情報が書き出されます] </field-list> |
各フィールドの情報を <field> タグを使って表現します。
各フィールド情報の書式は、<field> で始めて </field> までとします。フィールド id/フィールドタイプ/フィールド名が書き出されます。
<field id="(フィールドの ID)" type="(フィールドのタイプ)">(フィールドの名前)</field> |
<field> 〜 </field> は、書き出されたフィールド数個分繰り返されます。
以下のようになります。この表記は、レコード情報の表記でも使用します。
表記名 | 意味 (フィールドのタイプ) |
---|---|
String | 文字列 (1 行) |
Text | 文字列 (複数行) |
URL | URL |
Select | メニュー (文字列) |
User | メニュー (ユーザー) |
Radio | ラジオボタン |
Boolean | チェックボックス |
Number | 数値 |
Calc | 自動計算 |
Date | 日付 |
Time | 時刻 |
DateTime | 日付時刻 |
TimeSpan | 時間量 |
TimeCalc | 時間計算 |
File | ファイル |
Image | イメージ URL |
Numbering | 自動採番 |
Relation | 自動ルックアップ |
レコードの情報を <record-list> タグ、<record> タグ、<value> タグなどを使って表現します。
レコード一覧を <record-list> タグを使って表現します。
<record-list>
[ここに、各レコードの情報が書き出されます] </record-list> |
各レコードの情報を <record> タグを使って表現します。
各レコード情報の書式は、<record> で始めて </record> までとします。
<record id="(レコード番号)">
<create-time>(レコード登録日時)</create-time> <creator id="(レコード登録者のユーザー ID)">(レコード登録者のユーザー名)</creator> <modify-time>(レコード更新日時)</modify-time> <modifier id="(レコード更新者のユーザー ID)">(レコード更新者のユーザー名)</modifier> [ここに、書き出したレコードのフィールド数分レコード値の情報が書き出されます] </record> |
<record> 〜 </record> は、書き出されたレコード数個分繰り返されます。
レコード登録者、レコード更新者の情報を持たないレコードの場合は、レコード登録者 (<creator> タグ)、レコード更新者情報 (<modifier> タグ) は書き出されません。
各レコード値の情報を <value> タグを使って表現します。
各レコード値の情報の書式は、<value> で始めて </value> までとします。
基本の書式は以下となります。
<value type="(フィールドのタイプ)" id="(フィールドの ID)">(レコード値)</value> |
<value> 〜 </value> は、書き出されたレコードが持つフィールド数個分繰り返されます。
レコード値が設定されているフィールドのタイプと ID、設定されているレコードの値は、(フィールドのタイプ) と (フィールドの ID)、(レコード値) であることを示します。
フィールドのタイプ
については、<field> タグと同じ表記になります。
書き出されるレコードのフィールド数は、閲覧できるフィールド数 (閲覧アクセス権のあるフィールド数) と同じです。
ただし、(レコード値) に値が入っていない、エラーになっているフィールドは、書き出されません (該当の <value> 〜 </value> が書き出されません。)。
フィールドタイプ : URL の場合の書式
レコード値が URL になるため、<url> タグでレコード値を表現します。
<value type="(フィールドのタイプ)" id="(フィールドの ID)"><url>(レコード値)</url></value> |
リンク名が設定されている場合は、<url&gr; タグに alias="(リンク名)" 表記を追加します。(リンク名) は、設定されているリンク名を示します。
<value type="(フィールドのタイプ)" id="(フィールドの ID)"><url alias="(リンク名)">(レコード値)</url></value> |
レコード値が URL になるため、<url> タグでレコード値を表現します。
<value type="(フィールドのタイプ)" id="(フィールドの ID)"><url>(レコード値)</url></value> |
レコード値となるファイルの情報について、<file> タグとそのファイルへアクセスできる URL を <url> タグを使って表現します。
<value type="File" id="(フィールドの ID)">
<file mime="(ファイルの MIME タイプ)">(レコード値 : ファイル名)<file> <url>(ファイルへのアクセス URL)</url> </value> |
日付、時刻、日付時刻場合の場合は、<date> <time> <datetime> タグを使ってレコード値を表現します。
(レコード値) の書式は、以下になります。
フィールドタイプ | レコード値の書式 |
---|---|
日付 | <date>[YYYY]-[MM]-[DD]</date> |
時刻 | <time>[HH]:[MN]:[SS]</time> |
日付時刻 | <datetime>[YYYY]-[MM]-[DD]T[HH]:[MN]:[SS]</datetime> |
時間量の場合は、<timespan> タグを使ってレコード値を表現します。また、単位によって書き出される書式が変わります。
書式は以下になります。
時間量の単位と表記例
時間量 の単位 |
レコード値の内容 |
---|---|
日時間分秒 | <timespan>P (日に設定した値) DT (時間に設定した値) H (分に設定した値) M (秒に設定した値) S</timespan> |
日時間分 | <timespan>P (日に設定した値) DT (時間に設定した値) H (分に設定した値) M</timespan> |
日時間 | <timespan>P (日に設定した値) DT (時間に設定した値) H</timespan> |
日 | <timespan>P (日に設定した値) D</timespan> |
時間分秒 | <timespan>PT (時間に設定した値) H (分に設定した値) M (秒に設定した値) S</timespan> |
時間分 | <timespan>PT (時間に設定した値) H (分に設定した値) M</timespan> |
時間 | <timespan>PT (時間に設定した値) H</timespan> |
分秒 | <timespan>PT (分に設定した値) M (秒に設定した値) S</timespan> |
分 | <timespan<PT (分に設定した値) M</timespan> |
秒 | <timespan>PT (秒に設定した値) S</timespan> |
時間計算の場合は、<date> <time> <datetime> タグを使ってレコード値を表現します。計算結果により書式が変わります。時間量の場合、単位は「日時間分秒」になります。
計算結果 | レコード値の内容 |
---|---|
日付 | <date>[YYYY]-[MM]-[DD]</date> |
時刻 | <time>[HH]:[MN]:[SS]</time> |
日付時刻 | <datetime>[YYYY]-[MM]-[DD]T[HH]:[MN]:[SS]</datetime> |
時間量 | <timespan>P (計算結果 : 日) DT (計算結果 : 時間) H (計算結果 : 分) M (計算結果 : 秒) S</timespan> |
参照元 (自動ルックアップで参照しているレコード) の情報を表示します。参照元のレコード値情報は、<reference> タグを使って表現します。参照元の値が設定されていない、アクセス権によって参照できない場合は、<value> タグから書き出されません (すべての情報が書き出されません)。
<value type="Relation" id="(フィールドの ID)">
<referencelibrary-id="(参照元のライブラリ ID)"record-id="(参照元のレコード番号)"> <value type="(参照元のフィールドのタイプ)" id="(参照元のフィールドの ID)">(参照元のレコード値)</value> </reference> </value> |
参照元のレコード値情報の書式は、通常の <value> 〜 <value> の書式と同じです。この例では、基本的な書式としています。
SGML で使われる、文書型定義。SGML は汎用マークアップ言語であり、どのような要素をどのようなタグを用いてマークアップするかは用途に応じて任意に決められる。そして、それを決めるのが DTD の役目でもある。データベースの「スキーマ」に相当するものと考えてもよいだろう。HTML は SGML に基づいて DTD を定義して作成したものだし、同様に XML に基づいて Web 開発言語として同じく DTD で定義されているのが XHTML ということになる。
「サイボウズ デヂエ」に当てはめると、「XML 書き出し」機能によって書き出される XML ファイルの書式式を決めているファイルということになる。
記載された商品名、各製品名は各社の登録商標または商標です。Copyright (C) Cybozu, Inc. All rights reserved. |