Use the Domino Attachment builder to give a user the ability to launch or view file attachments for a Domino® document.
The Domino Attachment builder creates a set of HTML links for display on a page. Each link created by the builder represents a file that was attached to a Domino document. Clicking on one of these links causes the associated file to be downloaded by the browser and, optionally, to have an associated program launched with the file as the content to be displayed or edited. For example, if a Domino document has a ZIP file attachment, clicking on the link for this attachment causes your browser to download the ZIP file and launch the program, if any, registered with the browser to open ZIP files.
The Domino Attachment builder works with a Domino Data Access builder. The Domino Attachment builder uses the Domino Data Access builder artifacts to communicate with the backend Domino server while creating the links for document attachments.
The builder performs the following high-level actions at runtime when a page containing its links is requested.
- The builder obtains the Domino document for which attachment links are to be created. The document is referenced by the unique ID value contained in the Document UNID input.
- The builder then extracts the value of the first document field identified by the Item input. If this is a Domino RichText field, the process continues. Otherwise, link generation is aborted because file attachments are only located in RichText fields.
- The builder iterates through all of the embedded objects present in the field looking for file-attachment objects. For each file-attachment object, a link is generated and placed on the requested page.
The builder includes links for file attachments only. All other embedded object types are ignored. For example, OLE objects and their links are ignored.
- Provide a UNID
Use a View and Form builder to display a set of documents contained in a Domino view. Also let the user select a specific document and thereby provide the Document UNID input for the Domino Attachment builder.
- First Field Found
Domino documents can contain multiple fields of the same name. This builder creates links only for attachments contained in the first field found.
- Rich Text Required
The document field must be of the RichText
type; these are the only fields that contain file attachments.
Domino Attachment builder inputs
This topic describes the inputs for the Domino Attachment builder.
Parent topic: Builder help
About using the builder call editor
Paging Assistant builder
Locating control builder calls on pages