@DocOmittedLength (Formula Language)

Returns the approximate number of bytes a truncated document lost during replication. The bytes are the total number of bytes per attachment, OLE object, large rich text field, or non-summary items that were too large, according to the replication settings for the database, to be replicated.

Note: This @function is new with Release 6.

Syntax

@DocOmittedLength

Return value

length

Number. The bytes of data that were not replicated. Returns zero if the document has not been truncated, was truncated previously, or was truncated by a pre-Release 6 server.

Usage

This function works only in databases that are running on and were replicated by a Domino® 6 or later server.

Documents can be truncated during database replication to save space. One replication setting option, for instance, enables you to replicate summary data and only 40KB of rich text for each document. In the resulting replica, you can retrieve the rest of a truncated document by choosing Actions - Retrieve Entire Document from the menu. @DocOmittedLength enables you to determine how much information (in bytes) was removed from the document during replication to help you determine if you want to retrieve it.

This function works in any formula that runs in the context of one or more documents.

The number returned is only an approximation. The actual size of the document may differ for the following reasons:

  • The number accounts for user data only; it does not take into account per document or per field constants such as static text or formulas.
  • The database allocates storage in 64-byte increments; a document may not use all of the 64 bytes allotted to it.

Examples

This example, when used as a column formula, returns the total size of the document:
@DocLength + @DocOmittedLength