Attachment template functions

You can use attachment template functions to form VWAttachment strings to use in expressions for a VWAttachment type.

These are most useful for specifying an attachment from an IBM® CM8 object store.

Table 1. Table of functions to form VWAttachment strings
Function What it does
VWATTACHMENT_TEMPLATE Constructs a string representation of a VWATTACHMENT object.
VWATTACHMENT_TEMPLATE_WITH_VERSION Constructs a string representation of a specific version of a VWATTACHMENT object.

VWATTACHMENT_TEMPLATE

Constructs a string representation of a VWATTACHMENT object.

Use the following syntax:
"<ATTACHMENT-NAME>" + "|" + "<ATTACHMENT-DESCRIPTION>" + "|" + numbertostring(<ATTACHMENT-TYPE>) + "|" +
numbertostring(<LIBRARY-TYPE>) + "|" + "<LIBRARY-NAME>" + "|" + "<ATTACHMENT-ID>"
where:
Table 2. Parameters and description for VWATTACHMENT_TEMPLATE function
Parameter Description
ATTACHMENT-NAME (String) The name of the attachment stored in the object store or library.
ATTACHMENT-DESCRIPTION (String) Information to describe the attachment (Optional)
ATTACHMENT-TYPE (Integer)
  • 0: indicates type not known
  • 1: indicates library or Object Store type
  • 2: indicates folder type
  • 3: indicates document type
  • 4: indicates stored search type
  • 5: indicates UNC or URL type
  • 6: indicates Custom object type
  • 7: indicates BOX document type
LIBRARY-TYPE (Integer)
  • 0: indicates type not known or not defined
  • 1: indicates Image Services (IS) library
  • 2: indicates Content Services (CS) library
  • 3: indicates the Content Platform Engine Object Store
  • 4: indicates IBM CM8 library
  • 7: indicates Box library
LIBRARY-NAME (String) The name of the object store or library
ATTACHMENT_ID (String) Attachment identifier, such as a GUID.

VWATTACHMENT_TEMPLATE_WITH_VERSION

Constructs a string representation of a specific version of a VWATTACHMENT object. This applies only to document or stored search attachment types.

Use the following syntax:
"<ATTACHMENT-NAME>" + "|" + "<ATTACHMENT-DESCRIPTION>" + "|" + numbertostring(<ATTACHMENT-TYPE>) + "|" +
numbertostring(<LIBRARY-TYPE>) + "|" + "<LIBRARY-NAME>" + "|" + "<ATTACHMENT-ID>" + "|" + "<ATTACHMENT-VERSION>"
where:
Table 3. Parameters and description for VWATTACHMENT_TEMPLATE_WITH_VERSION function
Parameter Description
ATTACHMENT-NAME (String) The name of the attachment stored in the object store or library.
ATTACHMENT-DESCRIPTION (String) Information to describe the attachment (Optional)
ATTACHMENT-TYPE (Integer)
  • 0: indicates type not known
  • 1: indicates library or Object Store type
  • 2: indicates folder type
  • 3: indicates document type
  • 4: indicates stored search type
  • 5: indicates UNC or URL type
  • 6: indicates Custom object type
  • 7: indicates BOX document type
LIBRARY-TYPE (Integer)
  • 0: indicates type not known or not defined
  • 1: indicates Image Services (IS) library
  • 2: indicates Content Services (CS) library
  • 3: indicates the Content Platform Engine Object Store
  • 4: indicates IBM CM8 library
  • 7: indicates Box library
LIBRARY-NAME (String) The name of the object store or library
ATTACHMENT_ID (String) Attachment identifier, such as a GUID.
ATTACHMENT_VERSION (String) Attachment identifier for a specific version of the attachment.