Document Viewer Component

Function

a!documentViewerField( label, labelPosition, instructions, helpTooltip, document, showWhen, height, altText, disabled, accessibilityText, marginAbove, marginBelow )

Displays a document from document management on an interface.

Parameters

Usage considerations

Displaying documents

• This component displays documents stored in Appian. To display documents from another system use the Web Content Field.
• Document not available will be displayed if the document is invalid, has been deleted, or the user does not have access to view it.
• This component is not intended for displaying images or videos. To display an image from a document in Appian use a Document Image. To display a video use a Video Field.

Viewing documents on different devices

• Document viewing behavior differs depending on the document type and browser. Some browsers may render documents inline, while other browsers or file types may be downloaded. Browser plug-ins or extensions may impact this behavior. Consider the browsers that your users will be using to access your application.
• On Appian Mobile applications, the document viewer component appears as a document download link. The value provided in altText is used for the link label.

Security

• For security purposes, documents are loaded using the static content URL. Missing system configuration will be displayed if this domain is not configured on your Appian instance. Refer to Post-Install Configurations for more details on this configuration.

Examples

Click EXPRESSION to copy and paste an example into the Interface Definition to see it displayed.

Displaying a blank document

Replace the document field value with a valid document in your environment.

1
2
3
4
5
6
7
8
{
  a!documentViewerField(
    label: "Appian Whitepaper",
    document: 282578,
    height: "TALL",
    altText: "5 Digital Transformation Predictions for 2018 and Beyond"
  )
}

Displaying a document image using a constant

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

Note that this uses the document() function to access the name of the document to display in the interface.

1
2
3
4
5
6
7
a!documentViewerField(
  label: document(
    documentId: cons!MY_PDF,
    property: "name"
  ),
  document: cons!MY_PDF
)

Feature compatibility

Feedback