About Collection Types

Collection Type

A Collection Type defines a given Collection. It specifies the format of a document that will be imported into the product.

A Collection Type is identified by a name and a version and is described by:

  • The list of Object Types it can handle. Several Collection Types can use the same Object Type.
  • A reader that defines the procedure to import documents and creates a Collection instance.
  • A writer that defines the procedure to export a Collection into documents.
  • Dictionaries that define the translation of labels into several languages. All the Collection Editors that are attached to the Collection Type will have access to these dictionaries.
  • User and computed properties that defines properties of the Collection.
  • Function calls to add custom behavior when creating, saving, importing a Collection.
  • Header and footer optional parameters are used to define the first and the last Object Types (must not have any sub-elements).

Collection user properties

You can define custom properties on Collections. These properties can be set:

  • During import - the user properties must be provided in an XML file or in a property file in addition to the data content file.
  • When creating a new Collection - the properties can be set in the Collection editor.

Import settings

To import a Collection, you must specify the Reader service that you are going to use. You can also specify import conditions in the Collection Type selection table.

Import Reader

A Reader is a service that you use to import a document into the product's database.

From the set of readers provided, you can choose the reader that is most suited to your needs:

  • XML file reader: Object, Element and their properties are stored in a tree of XML elements.
  • Variable flat file reader: Each line of the file contains an Object or an Element. Errors can be stored at the end of each line. Property values as well as error properties are delimited with a separator.
  • Fixed flat file reader: Each line of the file contains an Object or an Element and property values are stored in fixed-size fields.

You can however create and register additional readers to customize your import procedures.

Collection Type selection table

You can define in the Collection Type selection table the file import conditions that must be met. When a file is imported, the system accesses the corresponding Collection to retrieve the information that is necessary to read the file: format, reading procedure, reading configuration, and so on. Conditions can be validity dates or any other selection criteria.

Export settings

To export a Collection, you must specify the Writer service that you are going to use.

Export Writer

A Writer is a service used to read Collection data from the database and to write export files with a specific file format.

By default, the following writers are provided:

  • XML file writer
  • Variable flat file writer
  • Fixed flat file writer

You can however create and register additional writers to customize your export procedures.

Related Links