Document Download Link

Function

a!documentDownloadLink( label, document, showWhen )

Defines a link used to download a document. Links can be used in charts, grids, hierarchy browsers, images, link fields, milestones, pickers, and rich text.

See also:

• Link
• Read-Only Grid
• Images
• About Document Management
• Buttons and links design guidance

Parameters

Usage considerations

Using document links with the link field component

To display a single link or an array of links, use this component inside the Link component.

You can display the document download link in the following places:

• To display a link in a grid, use inside a Read-Only Grid Column component.
• To add a link in a chart, use inside the Chart Series component.
• To add a link to an image, use inside a document image or web image component.

Examples

To experiment with examples, copy and paste the expression into an interface object.

Configure a link using a record field reference

This example uses a rule input (ri!caseDocument) to access the specific document to display from the Case Document record type.

Record type references are specific to each environment. If you copy and paste this example into your interface, it will not evaluate. Use it as a reference only.

1
2
3
4
5
6
7
8
9
10
11
12
{
  a!linkField(
    label: "Download document",
    labelPosition: "ABOVE",
    links: {
      a!documentDownloadLink(
        label: ri!caseDocument[recordType!Case Document.relationships.documentProperties.fields.name]
        document: ri!caseDocument[recordType!Case Document.fields.document]
      )
    }
  )
}

Configure a link using a constant

This example uses the document() function to access the name of the document to display in the interface.

To test this example, replace cons!myDocument with a constant that points to a document in your environment.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  a!linkField(
    label: "Download document",
    labelPosition: "ABOVE",
    links: {
      a!documentDownloadLink(
        label: document(
          documentId: cons!myDocument,
          property: "name"
        ),
        document: cons!myDocument
      )
    }
  )
}

Add a link to an icon

This example displays a download icon that users can click to download a specific document. It uses a rule input (ri!invoice) to access the specific document to display from the AT Invoice record type.

Record type references are specific to each environment. If you copy and paste this example into your interface, it will not evaluate. Use it as a reference only.

1
2
3
4
5
6
7
8
9
10
11
12
a!richTextDisplayField(
  value: {
    a!richTextIcon(
      icon: "download",
      caption: ri!invoice[recordType!AT Invoice.relationships.documentProperties.fields.name],
      link: a!documentDownloadLink(
        label: "Document Link",
        document: ri!invoice[recordType!AT Invoice.fields.document]
      )
    )
  }
)

Feature compatibility

Related recipes

The following recipes include usage of the Document Download Link.

• Display Multiple Files in a Grid (Document Management, Grids):

  Show a dynamic number of files in a grid and edit certain file attributes.

Feedback