Specify Collection Type details

To specify collection type details, complete the:

  1. General fields
  2. Import reader fields
  3. Export Writer fields

General fields

Field Type / Max. length Contents
Name String / 80 Name and version that fully identify the Collection Type. It must be unique in the product instance.
Version Integer / 4
View name String / 30 Name of the database view associated with this Collection type. It is used when creating custom reports on this Collection type.
Description String / 250 Description of the Collection Type.
Dictionaries String / 80 List of dictionaries available to localize the labels.
Header name String / 30

Header name and version for this Collection Type. The header is an Object type. This Object type may but does not need to be in the referenced Object type of the collection.

When importing data into InterPlay, the header is used to statically identify the Object type of the very first record of the collection.

Header version String / 4
Footer name String / 30

Footer name and version for this Collection Type. The footer is an Object type. This Object type may but does not need to be in the referenced Object type of the collection.

When importing data into InterPlay, the footer is used to statically identify the Object type of the very last record of the collection.

Footer version String / 4
Batch identifiers String / 100 One or more properties of the Object Types that this Collection Type contains. At runtime, the objects of the Collection that shares the same value for these properties will be grouped together.
Batch label String / 100

Label that represents the batch in the Edit tree panel of the user interface.

Use the {<PROP>} expression to incorporate batch identifier property values to the label. <PROP> is the name of a batch identifier property

Batch icon String / 250

Path to the icon that will appear in the edition tree near the batches.

Category String/50

Default category set to the new Collection Type instances.

The Collection can be edited by the Collection Editors with the same category (or by editors with no category).

Icon String / 250 Path to the icon that will appear in the edition tree near the Collections.
Custom identifiers String / 250

List of the properties that uniquely identify the Collection.

These properties are concatenate with a ‘|’ separator to create a business identifier for the traces of the Collection Type stored in the Tracing table.

Reporting String / 6

Defines if and when the report templates will be generated for this Collection Type:

  • Auto(default): default templates are used automatically when needed
  • Manual: default templates are generated at deploy time
  • None: no default template is generated
Generate default editor String / 1 Check this to generate a default editor automatically when a format is edited.
Dynamic editor String / 1 Check this if you want the editor to show only table pages which are populated with objects.

Import reader fields

Field Type / Max. length Contents
Common fields    
Reader type String / 30

Type of reader that will import files defined by this Collection Type:

  • VariableFlatFile
  • FixedFlatFile (AccountingIntegrator file type)
Reader name String / 30

Name of the reader that depends on the reader type.

Readers are registered as InterPlay services. For more information, refer to Import services

Is virtual business Object reader String / 1 Check if the reader handles virtual business objects.
Date format String / 25

Default format for the date properties in the files to import for this Collection Type.

If it is not specified, the default date format defined in the Global Server Settings is used instead. It can be redefined for each property. For more information, refer to Specify global settings details and Create the properties.

Date time format String /25

Default format for the date time properties in the files to import for this Collection type.

If it is not specified, the default date format defined in the Global Server Settings is used instead. It can also be redefined for each property. For more information, refer to Specify global settings details and Create the properties.

Encoding String / 15 Encoding of the files to import.
XML reader specific fields    
XML root tag String / 30 XML root tag in the file to import.

FixedFlatFile reader

(AccountingIntegrator

connector) specific fields

   
Input-Event name String / 30

Name of the Object Type that defines the structure of the lines of the file.

Enter the:

  • Input-Event name if the file to import contains only one type of Object.
  • Property name between brackets {PROP} if each line of the file contains the name of an Object Type or its associated import identifier. The property must be shared by all Object Types and associated Element Types that are referenced in the Collection Type.

All Object Types and Element Types of the collection references must have this property in the same location.

Input-Event version String / 30

Version of the Object Type.

Enter either of the following:

  • Input-Event version, if the file to import contains only one version of Object type.
  • Name of a property (between brackets) that contains the value {PROP}. The property must be shared by all Object Types and associated Element Types that are referenced in the Collection Type.
Segment type name String / 30

Name of the Element Type that defines the structure of records when an Input-Event is made of several types of records.

Enter either of the following:

  • Segment type name
  • Name of a property (between brackets) that contains the value {PROP}. The property must be shared by all the Object Types and associated Element Types that are referenced in the Collection Type.
Has errors String / 1 Check this box if this type of file contains errors at the beginning of each line.
Instance code String / 30

Instance code property. Elements with the same instance code are part of the same Object.

Enter the instance code property between brackets {PROP}.

VariableFlatfile reader specific properties    
Rank property String / 30

Rank of the property that gives the name of the Object Type or associated Type name.

Enter either of the following:

  • A number
  • The name of a property (between brackets) that contains the value {PROP}. The property must be shared by all the Object Types and Element Types that are referenced in the Collection Type.
Property separator String / 1 Default delimiter used to separate properties in a line. The separator after each property can be redefined on the properties.
Error separator String / 1

Delimiter to use between errors.

Errors are stored at the end of the line after the properties.

Error property separator String / 1

Delimiter to use to separate properties from errors at the end of the line.

By default, errors have these properties:

  • Error code
  • Description
  • Fields

You can however add up to 5 additional properties.

Export Writer fields

Field Type / Max. length Contents
Writer type String / 30

Type of writer that will export files defined by this Collection Type:

  • VariableFlatFile
  • FixedFlatFile
Writer name String / 30

Name of the writer that depends on the writer type.

Writers are registered as InterPlay services. For more information, refer to Export services.

Single line String / 1

FixedFlatFile only

Specify how the file will be exported: single line or multi line.

Is virtual business Object writer String / 1 Check if the writer handles virtual business objects.
Property separator String / 1 VariableFlatFile only

Default delimiter used in the exported file to separate properties in a line.

Overwrite existing file String / 1 Check this box if at export time you want to overwrite the previously exported file.
Export date format String / 25 Default format to use for all the date properties in the exported file.
Export date time format String / 25 Default format to use for all the date time properties in the exported file.
Modification state policy String / 9

Policy to apply when modifying the state:

  • Simple: The modification state is written only on the Objects or Elements (added, deleted, modified). Deleted objects are exported in the file.
  • Inherited: The modification state is written on the object AND its children (added, deleted, modified). Deleted objects are exported in the file.
  • None: No modification state is written in the file and the deleted Objects and Elements are not exported.

States are written at the end of the file as an extra property: Possible values are:

  • Added
  • Modified
  • ModifiedAndRemoved
  • UntouchedAndRemoved
Order elements by rank String / 1
  • Check this box if you want to order the elements in the exported file according to the rank property (lower performance).
  • Do not check this box if you want to order the elements according to their position in the imported file (when the file has been imported then modified).
Export file name String / 250

Name of the exported file.

Enter either of the following:

A file name

An expression that contains Collection Type property names between brackets: business_collection:{PROP1}__{PROP2}.xml.

If you do not specify a value, a name is computed automatically.

Encoding String / 15 Encoding for the files to export.
Preserve documents String / 1
  • Yes: If the Collection has been created by importing several files then the export dispatches the Objects in several files according to their origin.
  • No: All the Objects are written in the same output file.
Export properties String / 1 If true, at export time, an XML file that contains the Collection properties is generated in addition to the data file.

Related Links