Lifecycle Tags in v5.0

Building Lifecycle Applications for v5.0


There are two types of tags:

  • DocScript Tag - Allows DocScript to be executed at a specific point in the lifecycle.
  • Setting Tag - Provides settings to support the lifecycle process.

Note, if the tags are not used in the lifecycle definition then the default values will apply.

DocScript Tags

General Capture DocScript Tags

The following table details the general capture DocScript tags:

Tag Name Default Value Description
PreProcessRules N/A

Contains DocScript to execute before each process group is added to DocuNECT.

A process group is a method where life cycles can capture sets of documents in groups. This is may not necessarily a batch.

ie.
1. IndexFileCapture can capture multiple index files. Each index file is a processing group.
2. AXCapture can capture documents from multiple applications. Each application is captured as a separate processing group.
3. POP3 and IMAP capture. Each email is captured as a processing group. Allows for attachments and body to be captured in a different batch.

PreRules N/A Contains DocScript to execute before starting the capture stage.
CaptureRules N/A Contains DocScript to execute when a document is ready to capture, but is not yet added to DocuNECT. An example would be to provide a filter or {ignore} a document, or modify the document file before adding to DocuNECT (ie. separate or convert the file etc).
LookupRules N/A Contains DocScript to execute before a document is added to DocuNECT. Typically used to perform lookups on the “manipulated” document before adding to DocuNECT.
PostRules N/A Contains DocScript that is executed after ending the capture stage.
PostProcessRules N/A

Contains DocScript to execute after each process group is added to DocuNECT.

A process group is a method where life cycles can capture sets of documents in groups. This is may not necessarily a batch.

ie.
1. IndexFileCapture can capture multiple index files. Each index file is a processing group.
2. AXCapture can capture documents from multiple applications. Each application is captured as a separate processing group.
3. POP3 and IMAP capture. Each email is captured as a processing group. Allows for attachments and body to be captured in a different batch.

ErrorRules N/A Contains DocScript that is executed if the DocScript contained in any of the capture tags throws an exception.

General Indexing DocScript Tags

The following table details the general indexing DocScript tags:

Tag Name Default Value Description
PreProcessRules N/A

Contains DocScript to execute before each process group is indexed.

A process group is a method where life cycles can capture sets of documents in groups. This is may not necessarily a batch.

ie.
1. IndexFileCapture can capture multiple index files. Each index file is a processing group.
2. AXCapture can capture documents from multiple applications. Each application is captured as a separate processing group.
3. POP3 and IMAP capture. Each email is captured as a processing group. Allows for attachments and body to be captured in a different batch.

PreRules N/A Contains DocScript to execute before starting the indexing stage.
IndexRules N/A Contains DocScript to execute after each document is added to DocuNECT.
PostRules N/A Contains DocScript that is executed after ending the indexing stage.
PostProcessRules N/A

Contains DocScript to execute after each process group has been indexed.

A process group is a method where life cycles can capture sets of documents in groups. This is may not necessarily a batch.

ie.
1. IndexFileCapture can capture multiple index files. Each index file is a processing group.
2. AXCapture can capture documents from multiple applications. Each application is captured as a separate processing group.
3. POP3 and IMAP capture. Each email is captured as a processing group. Allows for attachments and body to be captured in a different batch.

ErrorRules N/A Contains DocScript that is executed if the DocScript contained in any of the indexing tags throws an exception.

General Distribution Tags

The following table details the general distribution DocScript tags:

Tag Name Default Value Description
PreRules N/A Contains DocScript to execute before starting the distribution stage.
DistributionRules N/A Contains DocScript to execute when a document is ready to be distributed.
PostRules N/A Contains DocScript that is executed after ending the distribution stage.
ErrorRules N/A Contains DocScript to execute if the DocScript contained in any of the capture tags throws an exception.
SuccessRules N/A Contains DocScript that is executed if the document is successfully distributed.

Settings Tags

General Capture Settings Tags

The following table details the general capture settings tags:

Tag Name Default Value Description
UseOneBatch false If true all documents are captured into a single batch.
MaxBatchSize 0 Sets the maximum size of a batch. If set to 0, then the maximum is unlimited.
NeedsQC false If set to true the document indexed value is set to false. Otherwise the lifecycle will determine if a document is indexed by checking if all required indexes have a value.
IgnoreLookups false If set to false, cabinet lookups are not performed when indexing in the capture stage.

General Indexing Settings Tags

The following table details the general indexing settings tags:

Tag Name Default Value Description
IgnoreIndexedDocs false Executes the DocScript in the indexing tag if the document is not indexed.

General Distribution Settings Tags

The following table details the general indexing settings tags:

Tag Name Default Value Description
BaseSubFolderName <blank> Used set the base release folder if filesperfolder is -1.
RemoveFile false If set to true removes the file from DocuNECT storage.
IndexFileHeader blank If an index file is written on distribution, the lifecycle will use this as the header line.
HideBatch false If set to true, the batch will be hidden after distribution.

Index File Capture Tags

The following table details the index file capture tags:

Tag Name Default Value Description
IndexRowRules <blank> Executed after each row in the index file is processed. This tag is used to set the {ofdocname} variable to the source document.
HasHeader false Indicates whether the index file has a header.
UsesHeader false Indicates whether the index file header be used to determine the index file field names.
ColumnDelimiter <blank> Determines the string character that delimits columns in the index file.
TextQualifier <blank> Determines the string character that surrounds the values in the index file.
RowDelimiter CRLF Determines the string character(s) that separates the rows in the index file.
ColumnNames <blank> If a file header is not used, each line in the tag is the name of a column in the index file.
RenameIndexFile <blank> Specifies the name of the file to be renamed to after the document is captured.
RenamedIndexFileExt PROCESSED Specifies the extension to be used when renaming the index file.
DeleteIndexFile false Specifies whether the index file should be deleted after capture.
AppendDT true Specifies whether the renamed index file should include a date/time stamp of when it was captured.
BaseFilePath <blank> Base file path of the captured files.
AllowDuplicates true Determines whether duplicates source file should be captured.

POP3 Email Tags

The following table details the POP3 email tags:

Tag Name Default Value Description
SaveAsEml false Determines whether the email will be captured as an EML file.
IgnoreAttachments false Determines whether the email attachments will be captured.
Port 143 The port of the email server.
SSL false Determines whether the connection to the email server uses SSL.
IgnoreBody false Determines whether the body of the email should be ignored.
IncludeEmailProperties false Determines wether the email To, From and Subject information should be added to the beginning of the email body.

IMAP Email Tags

The following table details the IMAP email tags:

Tag Name Default Value Description
SaveAsEml false Determines whether the email will be captured as an EML file.
IgnoreAttachments false Determines whether the email attachments will be captured.
Port 110 The port of the email server.
SSL false Determines whether the connection to the email server uses SSL.
IgnoreBody false Determines whether the body of the email should be ignored.
IncludeEmailProperties false Determines wether the email To, From and Subject information should be added to the beginning of the email body.

FTP Tags

The following table details the FTP tags:

Tag Name Default Value Description
Port 80 The Port number of the FTP server.
SSL false Determines whether the connection to the email server uses SSL.
AuthSSL false Indicates whether the FTP server uses Auth SSL.
Passive false Indicates whether the FTP server is passive.

Secure FTP Capture Tags

The following table details the secure FTP capture tags:

Tag Name Default Value Description
KeyFileName 0 The path of the secure FTP key file.
IsEncryptedKey 0 Indicates whether the key is encrypted.
Port 22 The Port number of the secure FTP server.

Secure FTP Distribution Tags

The following table details the secure FTP distribution tags:

Tag Name Default Value Description
KeyFileName 0 The path of the secure FTP key file.
IsEncryptedKey 0 Indicates whether the key is encrypted.
Port 22 The Port number of the secure FTP server.

ApplicationXtender Capture Tags

The following table details the Documentm ApplicationXtender capture tags:

Tag Name Default Value Description
DeleteQuery false Determines whether the AX query driving the process will be deleted.
AXQueryName <blank> The name of the AX query to identify the documents in the AX app to be captured.
AXIndexKeyField <blank> When capturing large amounts of documents it can be useful to update an AX index value once the document has been exported. This also help the lifecycle carry on where it left off if the server connection get interrupted or rebooted. The AX index values is specified with the value of the AXEndValue tag. If there was an error capturing the document the the index value is populated with the value of the AXErrorValue tag.
AXEndValue <blank> Works in conjunction with the AXIndexKeyField tag.
AXErrorValue <blank> Works in conjunction with the AXIndexKeyField tag.
CaptureAnnotations false Determines whether the AX text annotations are captured.
AXResultSetSize 1000000 Sets the number of AX documents to capture.
AXCriteria <blank> If the AX capture process is being driven from a search, then the criteria can be specified. Note, all criteria values are AND'd together.
AXCriteria2 <blank> The second criteria value.
AXCriteria3 <blank> The third criteria value.
AXCriteria4 <blank> The forth criteria value.

ApplicationXtender Distribution Tags

The following table details the Documentm ApplicationXtender distribution tags:

Tag Name Default Value Description
CountPDFPages false If set to true, each page in a PDF document is a page in AX. (i.e. uses pages rather than subpages).
CountTIFPages false If set to true, each page in a TIFF document is a page in AX. (i.e. uses pages rather than subpages).

Documentum D6/D7 Tags

The following table details the Documentum D6/D7 tags:

Tag Name Default Value Description
DQL <blank> DQL used to determine dataset of documents to capture from Documentum. DQL must include r_object_id in its result set.

Database Tags

The following table details the database tags:

Tag Name Default Value Description
Query <blank> Query to execute to return a set of rows, each representing a document to capture.
TableName <blank> Name of table to update after a document is captured. If the Query tag is blank, the lifecycle will use this table name to capture documents. (i.e. SELECT * FROM <TableName>).
SearchCriteria <blank> If table name is used to capture documents, use this tag to narrow the query. (i.e. SELECT * FROM <TableName> WHERE SearchCriteria).
ReadColumnName <blank> After capture, update this column in the table.
ReadColumnValue <blank> After capture, update the ReadColumnName column with this value.
UniqueColumnName <blank> Name of the unique column in the table. Used to determine which row to update after capture.
UniqueColumnValueWrapper <blank> If the UniqueColumnName is a string type, set this to ‘.
DeleteRow false If set to true the lifecycle will delete the row in the table after capturing the document. Will not update the ReadColumnName column.