Free cookie consent management tool by TermsFeed

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

Name Keyword Types Description

Label

label

Text

Text to display as the field label.

Label Position

labelPosition

Text

Determines where the label appears. Valid values: "ABOVE" (default), "ADJACENT", "COLLAPSED", "JUSTIFIED".

Instructions

instructions

Text

Supplemental text about this field.

Help Tooltip

helpTooltip

Text

Displays a help icon with the specified text as a tooltip. The tooltip displays a maximum of 500 characters. The help icon does not show when the label position is "COLLAPSED".

Document

document

Document

The document to display.

Visibility

showWhen

Boolean

Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true.

Height

height

Text

Determines the field height. Valid values: "SHORT", "MEDIUM" (default), "TALL".

Alternative Text

altText

Text

Equivalent alternate text provided to assistive technology.

Disabled

disabled

Boolean

Determines if the user is prevented from interacting with the document. Default: false.

Accessibility Text

accessibilityText

Text

Additional text to be announced by screen readers. Used only for accessibility; produces no visible change.

Margin Above

marginAbove

Text

Determines how much space is added above the layout. Valid values: "NONE" (default), "EVEN_LESS", "LESS", "STANDARD", "MORE", "EVEN_MORE".

Margin Below

marginBelow

Text

Determines how much space is added below the layout. Valid values: "NONE", "EVEN_LESS", "LESS", "STANDARD" (default), "MORE", "EVEN_MORE".

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

Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.

Example 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"
  )
}

Feature compatibility

The table below lists this component's compatibility with various features in Appian.
Feature Compatibility Note
Portals Compatible
Offline Mobile Incompatible
Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible
Process Reports Incompatible

You cannot use this function to configure a process report.

Process Events Incompatible

You cannot use this function to configure a process event node, such as a start event or timer event.

Feedback