Lifecycle Definitions - Distribute Tab in v5.2

Building Lifecycle Applications for v5.0
Lifecycle Definitions in v5.2


Destination Sub-Tab

The following table provides a description of the fields in the Distribute > Destination 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.

The type of capture:

  • None - No distribution is required.
  • 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.
  • Documentum - The lifecycle is distributing files to an OpenText Documentum system.
  • AppXtender - The lifecycle is distributing files to a Microsoft SharePoint system.
  • SharePoint - The lifecycle is distributing files to an OpenText ApplicationXtender system.
  • Custom - The lifecycle is capturing files to a custom source, such as an external business application.

The location of the files and the format is determined by the type of distribution.

If using a file/folder output, the output folder is determined by the:

  1. The distribution "Address" field
  2. <BaseSubFolderName></BaseSubFolderName> tag in the Distribution rules. (Optional)
  3. {subfolder} system variable (Optional)
  4. The distribution Files Per Folder setting.

If BaseSubFolderName and subfolder are NOT used the file path is:

<Address>\<LifecycleName_DateTime of Release>

If BaseSubFolderName is NOT used the file path is:

<Address>\<LifecycleName_DateTime of Release>\<subfolder>

If BaseSubFolderName is used (but not subfolder) the file path is:


If BaseSubFolderName is used the file path is:


{Subfolder} is a system variable so it can be set in the <DistributionRules> as each document is released. (ie. You can use {subfolder} to set the documents path based on index values and other rules).

When a file is released, if a file with the same path and name already exists the process will append _<X> to the file name. X will start at 1 and increment if that file name also exists. Note, this is a new feature in the connector as prior versions would overwrite the existing file.

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. If 0 no child folders are created. If > 0 then child folders are created numbered from 0 and up. When a child folder contains the same number of files as the "Files Per Folder" setting, a new child folder will be created.
Delete Batch

This indicates whether the batch will be deleted after distribution:

*No - The batch will be left in the DocuNECT system after successful distribution.
*Yes - The batch will be deleted on successful distribution.

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

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: