Database Export

Exports metadata from a Batch Folder object to a Database Table.

Remarks

Allows Data Fields from multiple levels of a Data Model to be mapped to columns in a Database Table.

Inherits from: Unattended Activity

Properties

The following 8 properties are defined.

Property Name Description
General
Database Table Type: Database Table

The database table where data is being exported.

Content Type Type: Content Type

The Content Type to be exported. This is the Content Type expected to be assigned to Batch Folders whose index data is being exported to the target Database Table. If Batch Folders are encountered during export that are not this type, or do not inherit from this type, an error will occur.

Parent Content Types Type: List of Content Type

A list of Content Types which may appear on parent folders of the folders being exported. During export, an exception will be thrown if the Batch Folder being exported does not have parent folders which are classified as the specified types. The order of the list in relation to the hierarchial level of the parent is not relevant.

Setting this property allows field values stored on parent folders to be mapped to output values. For example. consider a batch containing legal documents where level 1 folders are classified as Case File, and level 2 folders are classified as Pleading. Case File defines fields Case No, Plaintiff, and Defendant. Pleading defines fields Title and Filed Date. To output all 5 fields to flat database row, run this activity at level 2, specify Pleading as the Content Type, and add Case File to the list of parent content types.

Data Element Scope Type: Data Element

The scope of the data elements to export. Can be set to a Data Model, Data Section, or Data Table object:

  • If this value is not set, or is set to the root of the Data Model, then one database row will be exported per document. Fields defined at the root of the Data Model may be mapped to database columns.
  • If set to a Data Table object, then one database row will be exported for each row in the table. The columns of the table, and all Data Field objects above it in the Data Model may be mapped to database columns.
  • If set to a Data Section object, then one database row will be exported for each instance of the section. All Data Field objects which are direct children of the section, plus all Data Field objects above it in the Data Model may be mapped to database columns.

Column Mappings Type: Database Export Mapping

Defines the output value for each column in the Database Table. If no mapping is defined for a column, the column will not be referenced at all in the INSERT statement. This means that the column will be initialized with NULL, or with the default value defined for the column on the database server.

Processing Options
Error Disposition Type: IssueDisposition, Default: Flag, Log

Determines what happens when an error occurs processing an activity.

Maximum Consecutive Errors Type: Int32, Default: 0

The maximum number of consecutive errors, after which a critical stop will be raised. A critical stop will cause services to stop running.

Concurrency Mode Type: ConcurrencyMode, Default: Multiple

Specifies the parallel processing mode for this activity. Can be one of the following values:

  • Multiple - Multiple instances can run concurrently.
  • PerMachine - Only a single instance can run per machine.
  • Single - Only a single instance can run per Grooper repository.
This value determines the type of Thread Pool on which the activity can be executed.

See Also

Content Type, Data Element, Database Table

Used By

Batch Folder - Apply Activity, Batch Process Step