Documents
Retrieve all standard and custom document fields and field properties
Table Specific Information
Select
The add-in will use the Vault CRM API to execute queries. It will check if vql can be used for the specified query. Otherwise filtering is executed client-side within the add-in.
Update
All editable fields can be updated using the Vault CRM API. Note: the Template Document Type (Api Name: template_doctype__v) cannot be updated like other fields. To update the Template Document Type first you must add the Template Document Type field to the document type and specify a value for it referencing the Id of DocumentTypeDetails (Api Name: doc_type_detail__v) table otherwise the update will fail. Also, if Template Document Type is not added to the document type, any attempt to update it will be ignored.
Columns
| Name | Type | ReadOnly | Description |
| id [KEY] | String | False |
id |
| version_id | String | False |
version_id |
| Sharpness | String | False |
file_meta_sharpness__v |
| Channels | String | False |
file_meta_channels__v |
| Circle of Confusion | String | False |
file_meta_circle_of_confusion__v |
| White Balance | String | False |
file_meta_white_balance__v |
| Rendition Black Listed | Bool | False |
rendition_black_list_flag__v |
| Sample Rate | String | False |
file_meta_sample_rate__v |
| Format | String | False |
format__v |
| Product | String | False |
product__v |
| Version Creation Date | Datetime | False |
version_creation_date__v |
| Medical Interaction | String | False |
medx__v |
| Merge Fields | Bool | False |
merge_fields__v |
| Major Version Number | Decimal | False |
major_version_number__v |
| Created From | String | False |
binder_created_from__v |
| Channel Assignment | String | False |
channel_assignment__v |
| Sync Offline | Bool | False |
syncoffline__v |
| Shutter Speed | String | False |
file_meta_shutter_speed__v |
| Case | String | False |
case__v |
| Brightness | String | False |
file_meta_brightness__v |
| Source Document Name | String | False |
source_document_name__v |
| Alpha Channel | String | False |
file_meta_alpha_channel__v |
| Annotations (Links) | Decimal | False |
annotations_links__v |
| Metadata | String | False |
binder_metadata__v |
| Source Owner | String | False |
source_owner__v |
| ISO Speed | String | False |
file_meta_iso_speed__v |
| Link Status | String | False |
link_status__v |
| Bookmarks Edited | Bool | False |
bookmarks_edited__sys |
| GPS | String | False |
file_meta_gps__v |
| Y Cb Cr Positioning | String | False |
file_meta_ycbcr_positioning__v |
| Copyright | String | False |
file_meta_copyright__v |
| Production CDN URL | String | False |
production_cdn_url__v |
| Lifecycle Stage | String | False |
stage__sys |
| Annotations (All) | Decimal | False |
annotations_all__v |
| OCR Requested | Bool | False |
ocr_requested__sys |
| Global Version ID | String | False |
global_version_id__sys |
| Annotations (Permalinks) | Decimal | False |
annotations_permalink__v |
| Light Source | String | False |
file_meta_light_source__v |
| Status | String | False |
status__v |
| Rendition Suppressed | Bool | False |
suppress_rendition__v |
| Binder Locked | Bool | False |
binder_locked__v |
| Last Auto-Filed Date | Datetime | False |
binder_last_autofiled_date__v |
| Source Document ID | Decimal | False |
source_document_id__v |
| File Name | String | False |
filename__v |
| FTP Source Location | String | False |
ftp_source_location__v |
| Device | String | False |
file_meta_device__v |
| Media Description | String | False |
file_meta_media_description__v |
| Latest Source Major Version | Decimal | False |
latest_source_major_version__v |
| Source Vault Name | String | False |
source_vault_name__v |
| File Security | String | False |
file_security__v |
| Duration | String | False |
file_meta_duration__v |
| Checked Out By | String | False |
locked_by__v |
| Flash | String | False |
file_meta_flash__v |
| Frame Rate | String | False |
file_meta_frame_rate__v |
| Annotations (Auto Links) | Decimal | False |
annotations_auto__v |
| Red Eye | String | False |
file_meta_red_eye__v |
| Orientation | String | False |
file_meta_orientation__v |
| Caller ID | String | False |
caller_id__v |
| Certified Copy | Bool | False |
certified_copy__v |
| Contrast | String | False |
file_meta_contrast__v |
| Version Created By | String | False |
version_created_by__v |
| Component Configuration | String | False |
file_meta_component_configuration__v |
| Exposure Mode | String | False |
file_meta_exposure_mode__v |
| Annotations (Anchors) | Decimal | False |
annotations_anchors__v |
| Document Number | String | False |
document_number__v |
| Reviewer | String | False |
reviewer__v.users |
| Reviewer2 | String | False |
reviewer__v.groups |
| Source Number | String | False |
source_document_number__v |
| Lens | String | False |
file_meta_lens__v |
| Media Title | String | False |
file_meta_title__v |
| Minor Version Number | Decimal | False |
minor_version_number__v |
| Display Resolution | String | False |
file_meta_display_resolution__v |
| Language | String | False |
file_meta_language__v |
| Metering Mode | String | False |
file_meta_metering_mode__v |
| Album | String | False |
file_meta_album__v |
| Media Comments | String | False |
file_meta_comments__v |
| Lifecycle State Stage ID | String | False |
state_stage_id__sys |
| File Created By | String | False |
file_created_by__v |
| Viewer | String | False |
viewer__v.users |
| Viewer2 | String | False |
viewer__v.groups |
| Notes | String | False |
notes__v |
| Source Vault Connection | String | False |
source_connection__sys |
| Lifecycle | String | False |
lifecycle__v |
| Aperture | String | False |
file_meta_aperture__v |
| Genre | String | False |
file_meta_genre__v |
| Publisher | String | False |
file_meta_publisher__v |
| Field of View | String | False |
file_meta_fields_of_view__v |
| Archived Date | Datetime | False |
archived_date__sys |
| Claims | String | False |
related_claims__v |
| Bound Source Minor Version | Decimal | False |
bound_source_minor_version__v |
| File Last Modified Date | Datetime | False |
file_modified_date__v |
| Approver | String | False |
approver__v.users |
| Approver2 | String | False |
approver__v.groups |
| File Created Date | Datetime | False |
file_created_date__v |
| Global ID | String | False |
global_id__sys |
| Exposure Compensation | String | False |
file_meta_exposure_compensation__v |
| Subtype | String | False |
subtype__v |
| Year | Decimal | False |
file_meta_year__v |
| Original Date | String | False |
file_meta_original_date__v |
| Light | String | False |
file_meta_light__v |
| Template Document Type | String | False |
template_doctype__v |
| Resolution | String | False |
file_meta_resolution__v |
| Color Space | String | False |
file_meta_color_space__v |
| File Last Modified By | String | False |
file_modified_by__v |
| Distribution Contacts | String | False |
distribution_contacts__v |
| Document Link | String | False |
link__sys |
| Digital Publishing | Bool | False |
cdn_content__v |
| Source Binding Rule | String | False |
source_binding_rule__v |
| Consumer | String | False |
consumer__v.users |
| Consumer2 | String | False |
consumer__v.groups |
| CrossLink | Bool | False |
crosslink__v |
| Is Latest Version | Bool | False |
latest_version__v |
| Annotations (Notes) | Decimal | False |
annotations_notes__v |
| Encoding Process | String | False |
file_meta_encoding_process__v |
| Classification | String | False |
classification__v |
| Suggested Links | Decimal | False |
annotations_suggested__v |
| Focal Length | String | False |
file_meta_focal_length__v |
| Saturation | String | False |
file_meta_saturation__v |
| Checked Out | Bool | False |
locked__v |
| Name | String | False |
name__v |
| Megapixel | String | False |
file_meta_megapixel__v |
| Disc Number | String | False |
file_meta_disc_number__v |
| Pages | Decimal | False |
pages__v |
| Checked Out Date | Datetime | False |
locked_date__v |
| Bound Source Major Version | Decimal | False |
bound_source_major_version__v |
| Preprocessed | Bool | False |
preprocessed__v |
| Keywords | String | False |
file_meta_keywords__v |
| Tags | String | False |
tags__v |
| Type | String | False |
type__v |
| Description | String | False |
description__v |
| Export File Name | String | False |
export_filename__v |
| Artist | String | False |
file_meta_artist__v |
| Title | String | False |
title__v |
| Size | Decimal | False |
size__v |
| Source Vault Connection Name | String | False |
source_connection_name__sys |
| Last Auto-Filed By | String | False |
binder_last_autofiled_by__v |
| Software | String | False |
file_meta_software__v |
| Pages OCR'ed (%) | Decimal | False |
pages_ocred_percent__sys |
| Checksum | String | False |
md5checksum__v |
| Staging CDN URL | String | False |
staging_cdn_url__v |
| Bit Rate | String | False |
file_meta_bit_rate__v |
| Annotations (Unresolved) | Decimal | False |
annotations_unresolved__v |
| Last Modified By | String | False |
last_modified_by__v |
| Document Version Link | String | False |
version_link__sys |
| Annotations (Approved Links) | Decimal | False |
annotations_approved__v |
| Gain Control | String | False |
file_meta_gain_control__v |
| Created Date | Datetime | False |
document_creation_date__v |
| Image Size | String | False |
file_meta_image_size__v |
| Audio Codec | String | False |
file_meta_audio_codec__v |
| Video Codecs | String | False |
file_meta_video_codecs__v |
| Binder | Bool | False |
binder__v |
| Key Message | String | False |
key_message__v |
| Annotations (Resolved) | Decimal | False |
annotations_resolved__v |
| Coordinator | String | False |
coordinator__v.users |
| Coordinator2 | String | False |
coordinator__v.groups |
| Author | String | False |
file_meta_author__v |
| Annotations (Lines) | Decimal | False |
annotations_lines__v |
| Last Modified Date | Datetime | False |
version_modified_date__v |
| Batch Number | String | False |
batch_number__v |
| Media Location | String | False |
file_meta_location__v |
| External ID | String | False |
external_id__v |
| Rendition Profile | String | False |
rendition_profile__v |
| Source Vault ID | Decimal | False |
source_vault_id__v |
| Annotations (Claim Links) | Decimal | False |
annotations_claim__v |
| Created By | String | False |
created_by__v |
| Disable Vault Overlays | Bool | False |
disable_vault_overlays__v |
| Editor | String | False |
editor__v.users |
| Editor2 | String | False |
editor__v.groups |
| Latest Source Minor Version | Decimal | False |
latest_source_minor_version__v |
| Owner | String | False |
owner__v |
| Track | String | False |
file_meta_track__v |
Pseudo-Columns
Pseudo-column fields are used in the WHERE clause of SELECT statements and offer more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| ExternalIdColumn | String |
Specifies the External Id column to be used for Update and Upsert operations. Should be set to an unique column different from Id |