Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space EXPORT and version 2.0
Sv translation
languageen

Teamstudio Export archive files are designed to be simple to access without requiring any proprietary APIs or tools. All of the files in the archive are text, either XML or plain text. The files are combined into a single file using standard Zip compression.

Directory Structure

The easiest way to explore an archive file is to add a .zip extension and then open the file in Windows Explorer.

Image Modified

Data Folder

The data folder contains a file for every data document in the database. Each file is XML, using IBM's DXL format. While this is largely self-explanatory, a DTD for DXL is available at The Domino DTD. The name of each file is <noteid>.dxl where <noteid> is the id of the document, expressed as an 8 digit hexadecimal number.

Design Folder

The design folder has the same format as the data folder, with a DXL file for each design element named using the note id.

Info

Domino supports two different styles of DXL: binary and default. Both are standard text-based XML, but in binary mode complex data values are exported as base-64 encoded versions of the raw binary data stored in the nsf file. Teamstudio Export does not use binary mode: while it offers maximum fidelity, it is impossible to interpret without a deep knowledge of Domino internal data structures. Instead Teamstudio Export uses the default mode that converts even complex data values to human-readable XML elements. While there is a very slight chance that minor details may be lost with this format, that is preferable to having an archive full of unreadable binary data. You can mitigate the possibility of losing some details in the XML by using the most up-to-date version of Notes available on your workstation.

 Profile Folder

The profile folder has the same format as the data folder, with a DXL file for each profile document named using the note id.

Info

The profile folder was added in archive version 2.

Views

The views folder contains an XML file for every view and folder in the database. Unlike the data and design folders, there is no IBM standard for view data. The format we have adopted is a very simple UTF-8 encoded XML with the following elements.

view

The root element, contains a sequence of document, category, and total elements.

category

A container element corresponding to a category row in the view. It has a single, optional attribute, indent identifying how many spaces the categorized value in the row should be indented within its column. If this attribute is omitted, the value is not indented. Indented categories occur when a categorized column contains a value such as a\b. This will generate two category rows in the view. The first with value 'a' and no indent and the second with category 'b' and indent="1". A category element contains a sequence of value elements.

document

A container element corresponding to a document row in the view. Every document element has a noteId attribute specifying the 8-digit hexadecimal note id of the document. As with categories, there is also an optional indent attribute specifying how many spaces the final data value should be indented within its column. Indented documents occur when you are using a response hierarchy and the document is a response or response to response. A document element contains a sequence of value elements.

total

A container element containing view totals (or averages etc depending on the view definition.) A total element contains a sequence of value elements.

value

A wrapper for a view column value. Each categorydocument and total element contains one or more value elements for the column values. A value element may be empty (i.e. <value />) if it is an outer column in a categorized view. Otherwise it will contain a value in standard DXL format (i.e. <text>, <number>, etc.)

acl.dxl

This file is the DXL representation of the database ACL.

Info

acl.dxl was added in archive version 2.

db.dxl

This file is created by DXL exporting an empty collection from the database. It captures database-level information such as the replica id.

log.txt

This is a plain-text log file generated during the DXL export. It captures any errors and warnings generated during the export, along with some trace debugging information. Any errors and warnings in this file will have been displayed to the user when the archive was created, but we retain the log file for future review.

meta.xml

This is a metadata file primarily used by Teamstudio Export to maintain the UI. It consists of a single archive element with the following attributes

  • server - the server from which the database was archived
  • path - the path of the database on that server
  • title - the database title
  • archiveDate - a timestamp on which the archive was created. Since this is only used by Teamstudio Export, it is stored in a .NET-friendly format. Specifically, the value is the number of 10ms ticks since 1/1/0001 00:00 Gregorian. This is the same origin as the .NET DateTime type (see System.DateTime) but since Notes only stores times to a 10ms resolution, we divide DateTime.Ticks by 100000 to convert from 100ns ticks to 10ms ticks.
  • archiveVersion - a version indicator to denote significant changes to the archive format. Currently set to "2". Future releases will use this to identify databases that should be re-archived. See Archive Version History below for details.
  • demoMode - optional. Set to true if the archive was generated with a demo version of Export that limits the number of entries in each view. If false or omitted, the archive was generated with a full version of Export.

unidindex.txt

This is a plain-text CSV file generated during the export to map NoteIDs to UniversalNoteIDs (UNIDs.) Teamstudio Export itself uses note ids to identify documents, but doclinks use UNIDs so we need an index to convert UNIDs to file names during HTML export.

Anchor
versions
versions
Archive Version History

NumberDate

Export Version

Comments
1January 20181.0.0Initial release
2February 20181.0.1Add support for database ACL and profile documents

Support

The archive file format is intended to be public and supported. If you have any questions about the file format, please contact us at teamstudio.com.

Sv translation
languageja

Teamstudio Exportのアーカイブファイルは独自のAPIやツールを必要とせずにシンプルにアクセスできるように設計されています。アーカイブ内の全てのファイルは、XMLまたは平文のいずれかのテキスト形式になっています。これらのファイルは、一般のZip圧縮を使用して一つのファイルに統合されています。

ディレクトリ構造

アーカイブファイルを調べる最も簡単な方法はzip拡張子を追加して、Windowsエクスプローラーでファイルを開くことです。

Image Added

データフォルダ

データフォルダには、データベース内の全てのデータ文書ファイルが含まれています。各ファイルがIBMのDXL形式に基づいたXMLになっています。そのままの状態で大部分は理解できますが、一方でDXLのためのDTDもDomino DTDから入手することができます。各ファイルの名前は<文書ID>.dxlとなっており、8桁の16進数で表示されます。

デザインフォルダ

デザインフォルダはデータフォルダと同じ形式であり、Notes IDによって名付けされているデザイン要素のDXLファイルも含みます。

Info

Dominoはバイナリとデフォルト、二種のDXLスタイルを持つことを可能にしています。どちらも標準的なテキストベースのXMLですが、バイナリモード内において複雑なデータ値はnsfファイルに格納されている生のバイナリデータのBase-64エンコードバージョンでエクスポートされます。Teamstudio Exportではバイナリモードを使用しません、なぜなら高い正確性をもたらす一方で、ドミノ内部のデータ構築に関する深い知識なしに読み取ることは不可能だからです。その代わりに、Teamstudio Exportは複雑なデータ値でも人間が読めるXML要素に変換するデフォルトモードを使用しています。この形式ではアーカイブでは解釈できないバイナリデータを全て保持しますが 、一方でデータの一部分が消失する可能性は極僅かです。また作業環境下で最新バージョンのNotesを使用することで、XMLの詳細が消える可能性を軽減することができます。

プロファイルフォルダ

プロファイルフォルダはデータフォルダと同じ形式であり、Notes IDによって名付けされているプロファイル文書のDXLファイルも含みます。

Info

プロファイルフォルダはアーカイブ、バージョン2にて追加されました。

ビュー

ビューフォルダには、 データベース内すべてのビューとフォルダに対してのXMLファイルが含まれています。データやデザインのフォルダとは異なり、ビューデータにはIBM基準というものがありません。実際のフォーマットは、以下の要素を持つ非常に単純なUTF-8エンコードされたXMLです。

ビュー

文書、カテゴリーそしてトータル要素の並びを持つルート要素です。

カテゴリー

ビュー内にあるカテゴリー行に対応するコンテナ要素です。単一でオプションの属性を持ち、行の中のカテゴリーされた値がどれほどのスペースを持つかを識別しカラム内でインデントされます。この属性を省略すると、値はインデントされません。インデントカテゴリーはa\bのような値がコラムに含まれている場合に発生し、これによりビューに2つのカテゴリー行が生成されます。最初の値(a)のインデントは0となり、2つめの値(b)のインデントは1になります。カテゴリー要素には値要素の順序も含まれます。

文書

ビュー内の文書の行に対応するコンテナ要素です。すべての文書要素には文書にある8桁で16進数のNote IDを特定するためのNote ID属性があります。カテゴリーと同様、オプションとしてインデント属性もあり、最後のデータ値をそのコラム内でインデントする必要があるスペースの数を指定しています。インデントされた文書はレスポンス文書による階層表示を使用しており、文書がレスポンス文書、またはレスポンスに対するレスポンス文書である場合に発生します。文書要素には値要素の順序も含まれます。

合計

ビューの合計(または平均、ビュー定義に依存します)を含むコンテナ要素です。合計要素には一連の値要素が含まれます。

ビューコラム値のラッパーです。各カテゴリー、文書、およびトータル要素には、列値の1つ、またはそれ以上の値要素が含まれています。それ以外の場合は、標準DXL形式の値がそのまま含まれます。 (例. <text>, <number>, など.)

acl.dxl

ACLデータベースのDXLの表現となる

Info

ACLはアーカイブ、バージョン2から追加されます。

db.dxl

このファイルは、データベースから空のコレクションをエクスポートするDXLによって作成されます。レプリカIDなどのデータベースレベルの情報を取得します。

log.txt

DXLエクスポート時に生成される平文のログファイルです。エクスポート時に生成されたエラーと警告、およびデバッグ情報のトーレスをします。このファイルエラーや警告はアーカイブ作成時にユーザーに表示されますが、将来のもしもの時の参照のためにログファイルを保持します。

meta.xml

主にチームスタジオがUIを維持するために使用するメタデータファイルです。以下の属性を持つた単一のアーカイブ要素で構成されています。

  • server - データベースがアーカイブされたサーバー
  • path - そのサーバー上のデータベースのパス
  • title - データベースのタイトル
  • archiveDate - アーカイブ日付 アーカイブが作成したタイムスタンプ。これはTeamstudio Exportでのみ使用されるため、.NET対応の形式で保存されます。具体的には、値は1/1/0001 00:00 グレコリオ歴からで10msずつ刻みます。.NETDateTime(System.DateTimeを参照)と同じ起点ですが、Notesは10msで時刻を格納するだけなので、DateTime.Ticks100000で割って100nsから10msへと変換しています。
  • archiveVersion - アーカイブバージョン – アーカイブの形式についての重要な変更を示すバージョンのインジケーターになります。現在は「2」に設定されています。将来的なリリースでは、アーカイブバージョンを使用して再アーカイブする必要のあるデータベースが特定できます。下記のアーカイブバージョン履歴(アーカイブバージョン履歴)をご覧ください。
  • demoMode - デモモードこちらはオプションになります。各ビューの入力数を制限するエクスポートのデモバージョンを使用してアーカイブを生成する場合はTrueに設定します。Falseまたは省略された場合は、アーカイブはエクスポート完全版で生成されたことを意味します。

unidindex.txt

これは、Note IDUniversalNoteID(UNID)にマップするためにエクスポート中に作成される平文のCSVファイルです。Teamstudio Export自体は文書IDを利用して文書を識別しますが文書リンクはUNIDを使用するためHTMLエクスポート中にUNIDをファイル名に変換するための索引が必要です。

Anchor
versions
versions
アーカイブバージョン履歴

NumberDate

Export Version

Comments
11月 20181.0.0初期リリース
22月 20181.0.1データベースACLおよびプロファイル文書のサポートを追加

サポート

アーカイブファイル形式は公的にサポートされています。ファイル形式に関する質問は、teamstudio.comまでお問い合わせください