a!documentViewerField( label, labelPosition, instructions, helpTooltip, document, showWhen, height, altText, disabled, accessibilityText, marginAbove, marginBelow )
Displays a document from document management on an interface.
Name | Keyword | Types | Description |
---|---|---|---|
Label |
|
Text |
Text to display as the field label. |
Label Position |
|
Text |
Determines where the label appears. Valid values: |
Instructions |
|
Text |
Supplemental text about this field. |
Help Tooltip |
|
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 |
Document |
|
Document |
The document to display. |
Visibility |
|
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 |
|
Text |
Determines the field height. Valid values: |
Alternative Text |
|
Text |
Equivalent alternate text provided to assistive technology. |
Disabled |
|
Boolean |
Determines if the user is prevented from interacting with the document. Default: false. |
Accessibility Text |
|
Text |
Additional text to be announced by screen readers. Used only for accessibility; produces no visible change. |
Margin Above |
|
Text |
Determines how much space is added above the layout. Valid values: |
Margin Below |
|
Text |
Determines how much space is added below the layout. Valid values: |
Document not available
will be displayed if the document is invalid, has been deleted, or the user does not have access to view it.altText
is used for the link label.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.Copy and paste an example into an interface object in EXPRESSION MODE to see it displayed.
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"
)
}
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 | Note |
---|---|---|
Portals | Compatible | |
Offline Mobile | Incompatible | |
Sync-Time Custom Record Fields | Incompatible | |
Real-Time Custom Record Fields | Incompatible | Custom record fields that evaluate in real time must be configured using one or more Custom Field functions. |
Process Reports | Incompatible | Cannot be used to configure a process report. |
Process Events | Incompatible | Cannot be used to configure a process event node, such as a start event or timer event. |
Document Viewer Component