Lifecycle Editor in v5.0

Building Lifecycle Applications for v5.0


The Lifecycle Editor is the application used for developing the core lifecycle application. The editor is installed as part of the Lifecycle Server and is always present on the DocuNECT station server. However, the editor can be installed on any machine by running the Lifecycle Server install.

Using the Lifecycle Editor for the First Time

The Lifecycle Editor is located in the DocuNECT > Lifecycle Editor. On using the editor for the first time you will be prompted to enter the database connection information.

edlogin.PNG

Database Server

  • Server Name - This the name of the Microsoft SQL Server where the database is hosted.
  • User Name - The database username. It is recommended to use the target database owner as the login.
  • Password - The password of the database username.

System Login

  • System Code - The name of the database. On entering the database information above you can select the target database from the pick-list.
  • User Name - The DocuNECT username. This user must be in the administrators role.
  • Password - The password of the DocuNECT username.

Note, you can save the credentials by clicking the checkbox on the login screen.

Navigating the Editor

Once logged in you will be prompted with the main editor screen as shown below:

ededitormain.PNG

The tree on the left displays the cabinets and lifecycles associated with the connected system code and the right pane displays the information in the currently selected tab:

edtabs.jpg
  • Home - This displays the home tab.
  • Test Bench - This is the test bench where you can try/refines DocScript before you add it into the lifecycle.
  • <Lifecycles> - A tab will be displayed for each open lifecycle.

Double-click on the appropriate lifecycle and it will be displayed in the windows on the right as shown below:

edlifecycle.jpg

Note, an '*' against the lifecycle name (as shown below) indicates that there have been changes made that require saving.

edchanges.jpg

Saving a Lifecycle

To save a lifecycle after you made changes, select the Save option in the right-hand mouse click menu on the lifecycle tab. Alternatively you can select the Save All option if you have made changes to multiple lifecycles.

Exporting a Lifecycle

A lifecycle can be exported to an XML format so it can be transferred to another system. To export, select the Export option on the right-hand mouse click menu on the lifecycle tab. You will be prompted to enter a name and select an export location.

Importing a Lifecycle

To import a lifecycle, select the Import option in the right-hand mouse click menu on the cabinet name in the tree. You will be prompted to browse for the XML import file and confirm the lifecycle information as shown below:

edimport.PNG

Deleting a Lifecycle

To delete a lifecycle, select the Delete option on the right-hand mouse click menu next to the lifecycle tab.

Duplicating a Lifecycle

To duplicate a lifecycle, select the Duplicate option in the right-hand mouse click menu on the lifecycle name in the tree. The lifecycle will be duplicated with the same name with a suffix of (1).

Lifecycle Structure

A lifecycle can have three stages:

  • Capture - Determines where the document a captured and initial indexed.
  • Index - Determines how the index values are assigned.
  • Distribute - Once the document is indexed, the distribution stage determines where the document and data goes.

General Tab

The following table provides a description of the fields in the lifecycle General tab.

Field Description
System Code The system code (database) the lifecycle is associated with. Note, this field is read-only.
Name The name of the lifecycle.
Default Cabinet The default cabinet the lifecycle is associated with.
Allows Cabinets Each document within a batch can be associated to a different cabinet (and therefore different indexing schema). The allows cabinets indicates the other indexing schemas available during the document lifecycle.
Published Indicates whether the lifecycle is published. Note, if the lifecycle is not published then it will not be process by the Lifecycle Connector.
Server Side If the Server Side is selected then the lifecycle will not be available to the client tools (Desktop Capture and Virtual Print Driver), and the DocuNECT Web upload documents option.
Indexing Mode

Either Desktop or Batch:

  • Desktop - The documents are indexed at the point of capture, the client tools (Desktop Capture and Virtual Print Driver), or the DocuNECT Web upload documents option.
  • Batch - Documents are either indexed automatically by lifecycle rules, or an operator using the DocuNECT Web batch indexing interface.
Upload Status Determines the status assigned as soon as the batch is created.
Group Name This field is connected to the Lifecycle Connector and allows lifecycles to be grouped and processed together.
Working Folder Some lifecycle operations require a working folder to perform temporary operations. For example, document conversion and/or separation. If this field is not specified then the working folder entered against the station will be used.
Description A description of the lifecycle functionality for references purposes.

Email Notifications Tab

The following table provides a description of the fields in the lifecycle Email Notifications tab.

Field Description
Subject The subject of the notification email.
On Error Send Process Log Report To: A comma separated list of email addresses that will receive an email if the lifecycle receives an error.
On Success Send Process Log Report To: A comma separated list of email addresses that will receive an email if the lifecycle was successful.
Send Notification Log To: A comma separated list of email addresses that will receive an email every time the lifecycle is executed.
On Error Send Process Log Report To: A comma separated list of email addresses that will receive an email if the lifecycle receives an error.

Capture Tab

The section provides information on the fields in the Capture stage.

Source Sub-Tab

The following table provides a description of the fields in the Capture > Source sub-tab.

Field Description
Enabled Indicates whether the Capture stage is included in the lifecycle.
Type

The type of capture:

  • FileOrNetwork - The lifecycle is capturing files from a local or network file system.
  • FTP - The lifecycle is capturing files from an FTP site.
  • sFTP - The lifecycle is capturing files from a secure FTP site.
  • HTTP - The lifecycle is capturing files from a web site.
  • POP3 - The lifecycle is capturing files from a POP3 email server.
  • Custom - The lifecycle is capturing files from a custom source, such as an external business application.
Address The location of the files and the format is determined by the type of capture.
User Name If the capture source is secure then this user name will be used to access it.
Password The password of the user name associated with the capture source.
File Masks Determines which file masks will be captured and is a comma separated list of file types. For example:
*.tif, *.pdf - This will capture all TIFF and PDF files.
Delete Source If selected, the source file will be deleted once successfully captured.
Recurse Sub-Folders If selected, the lifecycle will also capture files in sub-folders found in the root of the specified Address.
Status After

This indicates the status that will be set after the capture stage is executed.

Lifecycle Batch Status

Index File Sub-Tab

The following table provides a description of the fields in the Capture > Index File sub-tab.

Field Description
File Name If the indexes are contained in an external text file, then this field specifies the name of the text file. Note, a location is not required as the lifecycle will look for the index file in the Address field specified in the Source sub-tab.
Row Format Determines the format of the index file. To map the index values to the cabinet indexes, enclose the cabinet index in {…}. For example, if the text file contains three values separated by a comma. The first value needs to be mapped to the cabinet index called Invoice No, the second to Invoice Date, and the third specified the pointer to the associated file. The row format would be:
{Invoice No}.{Invoice Date},{ofdocname}
Key Name This is used for file capture that is driven from the content and the index values are contained in an external text file. This Key Name is the fields that is used to retrieve the index values. A typical Key Name field is the file name ({odocname}, or {ofdocname}).
Validate If selected, then the file is pre-validated to confirm that all the files references in the index file exist.

Rules Sub-Tab

This table allows for business rules to be entered for the capture stage. Business rules have two elements, Tags and DocScript:

Process Tab

The section provides information on the fields in the Process tab.

Lifecycle "Process" Tab:
The Process Tab will work on documents with the status of Created. Make sure the Upload Status is set to Created, and the Status After capture is set to Created. The settings on this tab drive the Document Processing connector.

1. The Document Processing Connector will process Created documents in the following order:

a. Separate Document:
i. based on the Separate Document lifecycle property.
ii. Will OCR the document before separation if set to With Templates.
b. Classify Document:
i. based on the Classify Document lifecyle property.
ii. Will OCR the document before classifying if Document Indexes Will be Extracted From Text is set to Yes, unless OCR'd in a previous stage.
iii. If Classify Document is set to Auto-Classification then it will run the Auto-Classification rules.
c. Final Separation:
i. If the document is classified then the Document Processing connector will run Final Separation.
d. Index Document:
i. based on the Index Document lifecyle property.
ii. Will OCR the document before indexing if Document Indexes Will be Extracted From Text is set to Yes, unless OCR'd in a previous stage.
iii. If Index Document is set to Auto-Indexing then it will run the Auto-Indexing rules.
e. Text Extraction:
i. Will OCR the document if the lifecycle property Document Is Text Searchable is set to Yes, unless OCR'd in a previous stage.
f. PDF Rendtion:
i. Will create a PDF rendition if the lifecycle property Document Requires a PDF Rendition is set to Yes.
g. Final Status:
i. The document status will be set to Lifecycle Completed or Distributed, depending on the Final Status setting.

process.jpg

Settings Sub-Tab

The following table provides a description of the fields in the Process > Settings sub-tab.

Field Description
Separate Document

Indicates whether the document needs to be separated. The following methods are supported:

  • With DocuNECT Barcode Separator Sheets
  • With T-Patch Separator Sheets
  • With DocuNECT Barcode or Separator Sheets
  • With DocuNECT Barcode with Sticky Field T-Patch Separator Sheets
Leave Separator Sheet with Document If a separator sheet is found in the document, then this value determines whether it is left in the document or removed.
Classify Document

Determines whether the document needs to be classified before indexing:

  • Manual Classification
  • Auto-Classification
  • Auto-Classification followed by user validation
Index Document

Determines whether the document requires indexing:

  • Manual Indexing
  • Auto-Indexing
  • Auto-Indexing following by user verification
Document indexes will be extracted from text

Determines whether the index values will be extracted from the actual text of the document:

  • Yes
  • First Page
  • First X Pages - Note, if this is selected then the X: field becomes enabled, allowing you to define the number of pages that include the indexes.
Document Is Text Searchable

Determine whether the document is text-searchable.

  • Yes
  • First Page Only
Document Requires a PDF Rendition Determines whether the document requires a PDF rendition.
Final Status

Determines whether the final status:

  • Lifecycle Complete - This is typically used for DocuNECT Capture.
  • Distributed - This is typically used for lifecycle applications where the documents reside in DocuNECT.

Auto-Classification Rules Sub-Tab

This table allows for business rules to be entered for the auto-classification rules in the process stage. Business rules have two elements, Tags and DocScript:

Auto-Indexing Rules Sub-Tab

This table allows for business rules to be entered for the auto-indexing rules in the process stage. Business rules have two elements, Tags and DocScript:

Index (Legacy) Tab

The section provides information on the fields in the Index stage.

Source Sub-Tab

The following table provides a description of the fields in the Index > Source sub-tab.

Field Description
Enabled Indicates whether the Index stage is included in the lifecycle.
Status Before

Indicates the trigger batch status for the index stage.

Lifecycle Batch Status

Status After

This indicates the status that will be set after the index stage is executed.

Lifecycle Batch Status

Index File Sub-Tab

The following table provides a description of the fields in the Index > Index File sub-tab.

Field Description
File Name If the indexes are contained in an external text file, then this field specifies the name of the text file. Note, a location is not required as the lifecycle will look for the index file in the Address field specified in the Source sub-tab.
Row Format Determines the format of the index file. To map the index values to the cabinet indexes, enclose the cabinet index in {…}. For example, if the text file contains three values separated by a comma. The first value needs to be mapped to the cabinet index called Invoice No, the second to Invoice Date, and the third specified the pointer to the associated file. The row format would be:
{Invoice No}.{Invoice Date},{ofdocname}
Key Name This is used for file capture that is driven from the content and the index values are contained in an external text file. This Key Name is the fields that is used to retrieve the index values. A typical Key Name field is the file name ({odocname}, or {ofdocname}).
Validate If selected, then the file is pre-validated to confirm that all the files references in the index file exist.

Rules Sub-Tab

This table allows for business rules to be entered for the index stage. Business rules have two elements, Tags and DocScript:

Distribution Tab

The section provides information on the fields in the Distribute stage.

Destination Sub-Tab

The following table provides a description of the fields in the Distribute > Distribution sub-tab.

Field Description
Enabled Indicates whether the Index stage is included in the lifecycle.
Status Before

Indicates the trigger batch status for the index stage.

Lifecycle Batch Status

Type

The type of capture:

  • FileOrNetwork - The lifecycle is capturing files from a local or network file system.
  • FTP - The lifecycle is distributing files to an FTP site.
  • sFTP - The lifecycle is distributing files to a secure FTP site.
  • HTTP - The lifecycle is distributing files to a web site.
  • Custom - The lifecycle is capturing files to a custom source, such as an external business application.
Address The location of the files and the format is determined by the type of distribution.
User Name If the distribution source is secure then this user name will be used to access it.
Password The password of the user name associated with the distribution source.
Files Per Folder If the distribution is confirued for a file share, this option allows a limit to be placed for the number of files distributed to a folder. This is typically used for large distributions. Note, if used then DocuNECT will automatically name and create the folders.
Status After

This indicates the status that will be set after the distribute stage is executed.

Lifecycle Batch Status

Index File Sub-Tab

The following table provides a description of the fields in the Distribute > Index File sub-tab.

Field Description
File Name If the requirements is to write the indexes to a text file, then this field specifies the name of the text file. Note, a location is not required as the lifecycle will look for the index file in the Address field specified in the Source sub-tab.
Row Format Determines the format of the index file. To map the index values to the cabinet indexes, enclose the cabinet index in {…}. For example, if the text file contains three values separated by a comma. The first value needs to be mapped to the cabinet index called Invoice No, the second to Invoice Date, and the third specified the pointer to the associated file. The row format would be:
{Invoice No}.{Invoice Date},{ofdocname}
Key Name This is used for file capture that is driven from the content and the index values are contained in an external text file. This Key Name is the fields that is used to retrieve the index values. A typical Key Name field is the file name ({odocname}, or {ofdocname}).
Validate If selected, then the file is pre-validated to confirm that all the files references in the index file exist.

Rules Sub-Tab

This table allows for business rules to be entered for the distribute stage. Business rules have two elements, Tags and DocScript: