Free cookie consent management tool by TermsFeed

document() Function

On This Page

Function

document( documentId, property )

Returns property information for a document.

Parameters

Keyword Type Description

documentId

Number

The Id of the document. This parameter accepts document objects as well. Document objects are represented by their Id number internally.

property

Text

Information to retrieve for this document.

Returns

Text

Usage considerations

Using the property parameter

The property parameter accepts the following case-sensitive values:

  • dateCreated
  • description
  • expirationDate
  • extension
  • folderId
  • folderName
  • id
  • knowledgeCenterId
  • knowledgeCenterName
  • lastUserToModify
  • lockedBy
  • name
  • totalNumberOfVersions
  • pendingApproval
  • size (in bytes)
  • approved
  • changesRequireApproval
  • url

Using this function with a record field

If you use a record type to manage documents, you can access most of these properties by querying the related Document record type.

Note:  You must have the appropriate record-level security to the document in order to access its properties.

However, if you need to access the following document properties, you can use the document() function:

  • knowledgeCenterId
  • knowledgeCenterName
  • lastUserToModify
  • lockedBy
  • pendingApproval
  • approved
  • changesRequireApproval

Using this function with autoscaled processes

Using this function in a process model with autoscale enabled may result in degraded site or application performance. It should be used with caution and tested thoroughly before deploying it for real-world use. When the application is in production, use the Autoscaled Process Activity tab to monitor how the process performs at scale.

Examples

You can copy and paste these examples into an expression rule to see how this works.

1

document(101,"expirationDate")

Returns 12/21/05 2:28 PM GMT

Feature compatibility

The table below lists this function's compatibility with various features in Appian.
Feature Compatibility Note
Portals Compatible
Offline Mobile Partially compatible

Can be used with offline mobile if it is loaded at the top of the form.
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 Partially compatible

If autoscale is enabled, can be used to configure a supported process event node (such as a start event or timer event).
Process Autoscaling Partially compatible

Using this function in a process model with autoscale enabled may result in degraded site or application performance.

Feedback