Example Database Table Definition
Each row of the table must include a minimum set of columns required by both Documaker Server and Documaker Connector to manage the list of output documents and the document output directory. The table schema must also include additional columns of customer-specific metadata used to archive the documents, none of which is shown below.
This table shows the minimum required columns of the table with their default column names. You can customize these column names and add your own columns in the Documaker Source configuration file. The following list does not include customer-specific metadata to be archived. In an actual implementation, you would expand this with additional columns to define your metadata. Keep in mind this list of columns must match the schema of your database table. For more information, see Using DAL to Output to a Database Table section.
Table 3-1 Minimum DAL Output Database Table
| Column | Type | Description |
|---|---|---|
| JOBID | VARCHAR(50) | The Documaker globally-unique job identifier which identifies a grouping of one or more Documaker transactions for a single import run. Imports (XML or V2) can contain one or more transactions. This column’s value is also used by default for the root directory folder of the output print stream. |
| TRANID | VARCHAR(50) | The Documaker transaction identifier for a transaction with one or more Documaker batches (recipient batches). This column’s value is also in some implementations to map to the document title or name and for searching should identify the document type and purpose . |
| BATCHID | VARCHAR (50) | The Documaker batch identifier for a document, usually the same name as the recipient batch plus a counter. For example, BATCH6x2 where the counter is incremented as the specified maximum number of files per folder is reached. This columns value is also used by default to segment the transaction folder into sub-folders for each group of output files. |
| DOCID | VARCHAR (50) | The globally-unique document identifier. |
| NAME | VARCHAR (30) | The name of the document. |
| TYPE | VARCHAR (30) | The type of document. |
| TITLE | VARCHAR (255) | The title for the document. |
| AUTHOR | VARCHAR (50) | The author or owner of the document. |
| SECGROUP | VARCHAR (30) | The security group assigned to the document. |
| PFILE | VARCHAR (255) | A file URL or path to the document. |
| STATUSCD | INTEGER | This column contains the status of a document. The following values are supported:
0 – Not yet processed by Documaker Connector (new) 1 – Imported into content management (success) 2 – Import failed (failure) 3 – In process by Documaker Connector (in progress) The default is zero (0) |
| STARTTIME | TIMESTAMP | A time stamp that indicates at which time the document import process started. This column is updated by Documaker Connector. |
| ENDTIME | TIMESTAMP | A time stamp that indicates at which time the document import process ended. This column is updated by Documaker Connector. |
| RESULTDESC | VARCHAR (2000) | A description of the outcome of the import process; updated by Documaker Connector at the time of import. This column contains Success if the document import process is successful. Otherwise, it contains a description of the error. |
| RETENTION | TIMESTAMP | A time stamp that indicates when the document expires and can be removed from the table. This value is updated by Documaker Connector upon a successful import, based on the value of the source.documaker.retention.time configuration property which indicates the number of days after import when the document expires. |