SQL Database

Follow

Updated:

Table of Contents

SQL Database Overview

A Microsoft SQL Server database stores NetDocuments connection configuration parameters, synchronization status, document’s profile metadata, ACL, users and groups, lookup tables, subsequent updates, and logs. The metadata values will be split into columns within the table. This provides more flexibility and sophistication with network and server configurations.

The diagram below illustrates the NetDocuments ndMirror workflow.

workflow.jpg

The NetDocuments ndMirror workflow

In sections below, you may find the detailed information about ndMirror database views and tables. The dbo schemas are subject to change; these are internal schemas. The integration schemas are read-only schemas; they will be maintained without any breaking changes.

Back to Top

ndMirror Database Views

The table below provides the list of the ndMirror database views available together with their corresponding descriptions, type of columns, and their default values.

Important: ndMirror 1.1 is used to provide information about the database tables. The data presented in this table might be deprecated or changed in future releases of ndMirror.

Integration.CabinetsView

This view represents the integrators cabinet model.

Column name

Column description

Data type

Id

Cabinet ID. For example, ID='CA-98MFCFAZ'.

char(11)

RepositoryId

Cabinet repository ID.

char(11)

Name

Repository name.

nvarchar(64)

WorkspaceAttributeId

Attribute ID to base workspaces on this attribute.

int

WorkspaceAttributePluralName

Plural form for the workspace base attribute.

nvarchar(512)

SyncMod

Synchronization mode number (servermod – the internal server modification number).

bigint

PurgedServermod

Synchronization mode number (servermod – the internal server modification number) for purged documents.

bigint

SettingsJson

Cabinet settings.

nvarchar(max)

SyncStatusId

Synchronization status ID.

bigint

CredentialsId

Cabinet credentials ID.

int

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Back to Top

Integration.CabinetsAclView

This view represents the cabinet membership group with a default level of access.

Column name

Column description

Data type

Id

Primary key.

int

CabinetId

Related cabinet ID.

char(11)

Name

ACL group name.

nvarchar(512)

Principal

The principal of access level.

char(11)

View

The View access level. A user can view the content of a resource.

bit

Edit

The Edit access level. A user can:

  • Modify the content of documents
  • Create or modify document versions
  • Edit a document profile, including renaming the document or item.

bit

Share

The Share access level. A user can share a document in a cabinet with other users of the cabinet.

bit

Administer

The Administer access level. A user can:

  • Delete a resource.
  • Force the document check-in.
  • Remove other users from the access list or change the rights of users already in the access list.
  • Add people to the full control access list (VESA).

bit

NoAccess

The No Access level. A user cannot see a document, ShareSpace, folder, and other items if they have the No Access right in the access list.

bit

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Back to Top

Integration.CabinetSyncStatusView

This view represents the integrators cabinet synchronization status view.

Column name

Column description

Data type

Id

Primary key.

bigint

CabinetId

Cabinet ID. For example, ID='CA-98MFCFAZ'.

char(11)

SyncJobStartedUtc

UTC timestamp when synchronization is initiated.

datetime2(7)

StartSyncMod

Synchronization mode number when synchronization has been initiated.

bigint

FinishSyncMod

Synchronization mode number when cabinet synchronization has finished. Documents synchronization might be still in progress.

bigint

StartPurgedServermod

Synchronization mode number (servermod – the internal server modification number) when synchronization of purged documents is initiated.

bigint

FinishPurgedServermod

Synchronization mode number (servermod – the internal server modification number) when synchronization of purged documents has finished.

bigint

SyncJobFinishedUtc

UTC timestamp when cabinet synchronization has finished. Documents synchronization might be still in progress.

datetime2(7)

SynchronizeDocumentJobsCount

The number of document synchronization jobs that have been placed.

int

DeleteDocumentJobsCount

The number of document deletion jobs that have been placed.

int

PurgedDocumentJobsCount

The number of document deletion jobs that have been placed because a document is purged.

int

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Back to Top

Integration.DocumentsAclView

This view represents the integrators document ACL entry.

Column name

Column description

Data type

Id

Primary key.

bigint

DocumentId

Related access level document ID.

int

Principal

The principal of access level.

varchar(512)

CabinetDefault

Cabinet default property of access level.

bit

View

The View access level. A user can view the content of a resource.

bit

Edit

The Edit access level. A user can:

  • Modify the content of documents.
  • Create or modify document versions.
  • Edit a document profile, including renaming the document or item.

bit

Share

The Share access level. A user can share a document in a cabinet with other users of the cabinet.

bit

Administer

The Administer access level. A user can:

  • Delete a resource.
  • Force the document check-in.
  • Remove other users from the access list.
  • Change the rights of users already in the access list.
  • Add people to the full control access list (VESA).

bit

NoAccess

The No Access level. A user cannot see a document, ShareSpace, folder, and other items if they have the No Access right in the access list.

bit

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Back to Top

Integration.CredentialsView

This view represents the integrators NetDocuments credentials view.

Column name

Column description

Data type

Id

Primary key.

int

Name

Credential name.

nvarchar(40)

UserGuid

User GUID.

varchar(63)

UserEmail

User email address.

nvarchar(512)

UserDisplayName

User display name.

nvarchar(100)

UserSortLookupBy

User SortLookupBy option.

nvarchar(512)

UserOrganization

User organization.

nvarchar(512)

RefreshTokenUpdatedUtc

UTC timestamp when a refresh token has been added/updated. The value is auto set if the refresh token has been changed.

datetime2(7)

TokenType

Refresh token type.

varchar(512)

HostSettingsId

Host settings identifier.

int

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Back to Top

Integration.CustomProfileAttributesView

This view represents the integrators NetDocuments credentials view.

Column name

Column description

Data type

Id

Primary key.

int

DocumentId

Related profile attribute document ID.

int

ProfileAttributeDefinitionId

Related profile attribute definition ID.

int

Value

Custom profile attribute value.

nvarchar(max)

Order

Order for multiple attribute values.

smallint

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Back to Top

Integration.HostSettingsView

This view represents the host settings integrators view.

Column name

Column description

Data type

Id

Primary key.

int

Name

Host setting readable name.

nvarchar(40)

ClientId

OAuth application client_id.

nchar(11)

HostName

Fully qualified hostname.

nvarchar(256)

RedirectUrl

Redirect URL.

nvarchar(256)

Back to Top

Integration.DocumentAttachmentsView

This view represents the integrator’s document attachment view.

Column name

Column description

Data type

Id

Document ID of the foreign key value.

int

AttachmentType

Type of the attachment, which is a unique value for each attachment within a document.

nvarchar(448)

AttachmentId

Attachment ID, which is used to obtain attachment content.

nvarchar(512)

Extension

Attachment extension.

nvarchar(512)

Description

Attachment description.

nvarchar(512)

Name

Attachment name.

nvarchar(512)

FilePath

File path to the attachment content.

nvarchar(450)

FileSize

Attachment content size.

bigint

FileLastWriteTimeUtc

Timestamp when the version content has been updated.

datetime2(7)

UpdatedUtc

UTC timestamp when the database record has been updated.

datetime2(7)

Back to Top

Integration.DocumentsView

This view represents the integrators document model view.

Column name

Column description

Data type

Id

Primary key.

int

DocumentId

Document ID.

char(14)

CabinetId

Document cabinet ID.

char(11)

EnvelopeId

Document envelope ID. For example, envId=':Vault:1:k:a:l:~150894195871633.nev'.

varchar(512)

SyncMod

Document SyncMod (/Document/{id}/info).

bigint

ModificationNumber

Document modification number.

bigint

Name

Document name.

nvarchar(1000)

VersionsCount

Versions count.

int

OfficialVersion

Official version number.

int

Size

Document size.

bigint

Extension

Document extension.

nvarchar(512)

CreatedByGuid

GUID of a user that has created a document. For example, createdByGuid=VAULT- EVUM8H7G. /Document/{id}/info does not return it.

nvarchar(max)

CreatedBy

A user that has created a document. For example, createdBy=Name Surname.

nvarchar(max)

CreatedUtc

UTC ticks when a document is created.

datetime2(7)

ModifiedByGuid

GUID of a user that has modified a document. For example, modifiedByGuid=VAULT-EVUM8H7G.

nvarchar(max)

ModifiedBy

A user that has modified a document.

nvarchar(max)

ModifiedUtc

UTC ticks when a document has been modified.

datetime2(7)

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Back to Top

Integration.DocumentVersionsView

This view represents the integrators document version model.

Column name

Column description

Data type

Id

Related document ID.

int

VersionNumber

Document version number.

int

CreatedFrom

Version number used to create this version.

int

IsOfficial

The value indicating that this version is official.

bit

IsLocked

The value indicating that this version is locked.

bit

FilePath

Document version content path. The max key length is 900 bytes. Otherwise, for some combination of large values, the Insert or Update operation will fail.

nvarchar(450)

FileSize

Document version content size.

bigint

FileLastWriteTimeUtc

Timestamp when version content is updated.

datetime2(7)

Name

Document version name.

nvarchar(1000)

Extension

Document version extension.

nvarchar(512)

Description

Document version description.

nvarchar(1000)

CreatedByGuid

GUID of a user that has created a document. For example, createdByGuid=VAULT- EVUM8H7G. /Document/{id}/{verNum}/info does not return it.

nvarchar(max)

CreatedBy

A user that has created a document.

nvarchar(max)

CreatedUtc

UTC timestamp when the document is created.

datetime2(7)

ModifiedByGuid

GUID of a user that has modified a document. For example, modifiedByGuid=VAULT-EVUM8H7G. /Document/{id}/{verNum}/info does not return it.

nvarchar(max)

ModifiedBy

A user that has modified a document.

nvarchar(max)

ModifiedUtc

UTC timestamp when a document is modified.

datetime2(7)

UpdatedUtc

UTC timestamp when a database record is updated.

datetime2(7)

FlexStoreId

FlexStore identifier.

nvarchar(512)

Back to Top

Integration.EmailProfileAttachmentView

This view represents the document email profile attachments model.

Column name

Column description

Data type

Id

Related document primary key.

int

EmailProfileAttributeId

Related profile attribute document ID.

int

Name

Linked document ID.

nvarchar(max)

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Back to Top

Integration.EmailProfileAttributesView

This view represents the integrators model view of the Email part of document profile attributes.

Column name

Column description

Data type

Id

Related document primary key.

int

Subject

Subject line.

nvarchar(max)

From

Sender address.

nvarchar(max)

To

Address collection that contains the recipients.

nvarchar(max)

Cc

Address collection that contains the carbon copy (CC) recipients.

nvarchar(max)

EmailId

Calculated email ID. For example, id='<11177490.1031.1450182514738.JavaMail.adminaccount@vm46890>'.

nvarchar(max)

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Back to Top

Integration.DocumentMiscellaneousView

This view represents the document miscellaneous model view.

Column name

Column description

Data type

Id

Related document primary key.

int

IsApproved

Approved flag.

bit

IsArchived

Archived flag.

bit

IsDeleted

Deleted flag.

bit

IsExternal

External flag.

bit

IsSigned

Signed flag.

bit

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Back to Top

Integration.DocumentLinksView

This view represents documents links.

Column name

Column description

Data type

Id

Primary key.

int

DocumentId

Foreign key to the Documents table.

int

LinkedDocumentId

Linked document identifier.

varchar(512)

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Back to Top

Integration.DocumentLocationsView

This view represents documents locations.

Column name

Column description

Data type

EnvelopeId

Location envelope identifier. Primary key.

varchar(512)

CabinetId

Parent cabinet. Foreign key to Cabinets table.

char(11)

Name

Location name.

nvarchar(2048)

AncestorId

Parent location identifier. Foreign key to this table.

varchar(512)

LocationId

12-digit location identifier.

char(14)

IsDeleted

Indicates whether a location is deleted.

bit

Type

Location type: ‘F’ for a folder, ‘C’ for Collaboration Space, ‘S’ for ShareSpace, ‘W’ for workspace.

char(1)

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Back to Top

Integration.DocumentDocumentLocationsView

This view represents the many-to-many DocumentDocumentLocations relationship table.

Column name

Column description

Data type

Document_Id

Foreign key to Documents table

int

DocumentLocation_EnvelopeId

Foreign key to DocumentLocations table

varchar(512)

Back to Top

Integration.LookupAccessesView

This view represents the integrators lookup item access permission model.

Column name

Column description

Data type

Id

Primary key.

bigint

LookupId

Related access level lookup ID.

bigint

Principal

The principal of access level.

char(11)

CabinetDefault

Cabinet default property of access level.

bit

View

The View access level. A user can view the content of a resource.

bit

Edit

The Edit access level.

A user can:

  • Modify the content of documents.
  • Create or modify document versions.
  • Edit a document profile, including renaming the document or item.

bit

Share

The Share access level. A user can share a document in a cabinet with other users of the cabinet.

bit

Administer

The Administer access level.

A user can:

  • Delete a resource.
  • Force the document check-in.
  • Remove other users from the access list or change the rights of users already in the access list.
  • Add people to the full control access list (VESA).

bit

NoAccess

The No Access level. A user cannot see a document, ShareSpace, folder, and other items if they have the No Access right in the access list.

bit

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Back to Top

Integration.LookupsView

This view represents the integrators lookup value model view.

Column name

Column description

Data type

Id

Primary key.

bigint

ProfileAttributeDefinitionId

Related profile attribute definition ID.

int

ParentKey

Related parent lookup value ID.

nvarchar(250)

Key

Lookup key.

nvarchar(250)

Description

Lookup description.

nvarchar(1000)

Defaulting

Default (type) for lookup values. Provides DefaultSource for profile attribute.

nvarchar(250)

Hold

Litigation Hold is set to the lookup value.

bit

LinkedUser

Lookup linked user value.

varchar(63)

ClosedUtc

The Closed date is set to the lookup value.

datetime2(7)

AccessFilteredPermissions

Lookup access filtered_permissions value.

bit

AccessForcePermissions

Lookup access force_permissions value.

bit

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Back to Top

Integration.ProfileAttributeDefinitionCabinetsView

This view represents the many-to-many ProfileAttributeDefinitionsCabinets relationship table.

Column name

Column description

Data type

ProfileAttributeDefinitionId

Foreign key to ProfileAttributeDefinition.

int

CabinetId

Foreign key to cabinets.

char(11)

Back to Top

Integration.ProfileAttributeDefinitionsView

This view represents the integrators repository profile attribute definition model view.

Column name

Column description

Data type

Id

Primary key.

int

RepositoryId

Profile attribute repository ID.

char(11)

AttributeId

Profile attribute ID.

int

Name

Profile attribute name.

nvarchar(40)

Type

Profile attribute type:

•        Numeric field – 1

•        Plain text field – 2

•        Date field – 3

•        Memo field – 4

•        Unknown type – -1

int

AllowPunctuation

The Allow punctuation and spaces flag.

bit

BaseSecurity

Value if profile-based security is used.

bit

DefaultSource

The Default from <attribute> Type value. Allows you to define a column in another table to use as a default value. So, if there is a need to give a default value based on the Author value a user selects, you can upload values into the Author Type column and then enter Author into the Default from field. 

int

ForceUppercase

The Force uppercase flag.

bit

HideLookup

The Hide from External Users flag.

bit

Linked

The value that connects an attribute to the created profile attribute such as matters with clients.

int

MaxLength

Field character max length (50 for most attributes).

int

PadToLength

Values with leading zeros. For example, if you create the Account Number field and all your account numbers are 5 digits, you can enter a number 5 in this field and it will automatically add leading zeros to numbers if they are under 5 digits long.

int

PromptIfEmpty

The Prompt if empty flag.

bit

UseLookup

If a validation (lookup) table for a profile attribute is to be used.

bit

AllowMultipleValues

The Multi-value profile attribute flag.

bit

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Back to Top

Integration.RepositoriesView

This view represents the integrators repository model view.

Column name

Column description

Data type

Id

Repository ID. For example, id='CA-98MFCFAZ'.

char(11)

Name

Repository name.

nvarchar(64)

IOSAppAccess

Repository iOS application access mode.

Repository administrators can configure users' access to NetDocuments applications for the iPhone and iPad:

  • Allow any NetDocuments application
  • Only allow NetDocuments for Good Technology application
  • Do not allow

nvarchar(512)

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Back to Top

Integration.RepositoryGroupMembersView

This view represents the repository group member view.

Column name

Column description

Data type

Id

Primary key.

int

GroupId

Group ID foreign key.

char(11)

UserId

User ID.

varchar(63)

UserDisplayName

Group member display name.

nvarchar(100)

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Back to Top

Integration.RepositoryGroupsView

This view represents the repository group member view.

Column name

Column description

Data type

Id

Repository group ID.

char(11)

RepositoryId

Cabinet repository ID.

char(11)

Name

Group name.

nvarchar(512)

External

External members switch.

bit

Hidden

The Do not display in user group lists option. Select this option to reduce clutter in lists of user groups. If this group is added to a document access control list (ACL), it will still be visible.

bit

HideMembership

The Hide group membership option. Prevents user group's members from being displayed.

bit

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Back to Top

Integration.RepositoryUsersView

Intermediate table to map repositories to users’ many-to-many relationship.

Column name

Column description

Data type

RepositoryId

Repository ID.

char(11)

UserId

User ID.

varchar(63)

Back to Top

Integration.UsersView

This view represents the integrators user model view.

Column name

Column description

Data type

Id

User ID.

varchar(63)

Email

User email.

nvarchar(512)

DisplayName

Display name.

nvarchar(100)

LastLoginUtc

Last login time stamp.

datetime2(7)

RegisteredUtc

Registration time stamp.

datetime2(7)

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Back to Top

ndMirror Database Tables

The table below provides the list of the ndMirror database tables available together with their corresponding descriptions, type of columns, and their default values.

Important: ndMirror 1.1 is used to provide information about the database tables. The data presented in this table might be deprecated or changed in future releases of ndMirror.

dbo._MigrationHistory

This table represents details about migrations applied to the database.

Column name

Column description

Data type

MigrationId

Migration ID.

nvarchar(150)

ContextKey

Context key.

nvarchar(300)

Model

Model name.

varbinary(max)

ProductVersion

Product version.

nvarchar(32)

dbo.CustomProfileAttributes

This table represents the custom profile attribute model for the document.

Column name

Column description

Data type

Id

Primary key.

int

DocumentId

Related profile attribute document ID.

int

ProfileAttributeDefinitionId

Related profile attribute definition ID.

int

Value

Custom profile attribute value.

nvarchar(max)

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Order

Order for multiple attribute values.

smallint

dbo.CabinetAcls

This table represents the cabinet membership group with a default level of access.

Column name

Column description

Data type

Id

Primary key.

int

CabinetId

Related cabinet ID.

char(11)

Name

ACL group name.

nvarchar(512)

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Principal

The principal of access level.

char(11)

View

The View access level. A user can view the content of a resource.

bit

Edit

The Edit access level.

A user can:

  • Modify the content of documents.
  • Create or modify document versions.
  • Edit a document profile, including renaming the document or item.

bit

Share

The Share access level. A user can share a document in a cabinet with other users of the cabinet.

bit

Administer

The Administer access level.

A user can:

  • Delete a resource.
  • Force the document check-in.
  • Remove other users from the access list or change the rights of users already in the access list.
  • Add people to the full control access list (VESA).

bit

NoAccess

The No Access level. A user cannot see a document, ShareSpace, folder, and other items if they have the No Access right in the access list.

bit

dbo.Cabinets

This table represents the cabinet model.

Column name

Column description

Data type

Id

Cabinet ID. For example, ID='CA-98MFCFAZ'.

char(11)

RepositoryId

Cabinet repository ID.

char(11)

Name

Repository name.

nvarchar(64)

WorkspaceAttributeId

Attribute ID to base workspaces on this attribute.

int

WorkspaceAttributePluralName

Plural form for the workspace base attribute.

nvarchar(512)

SyncMod

Synchronization mode number (servermod – the internal server modification number).

bigint

PurgedServermod

Synchronization mode number (servermod – the internal server modification number) for purged documents.

bigint

SettingsJson

Cabinet settings.

nvarchar(max)

SyncStatusId

Synchronization status ID.

bigint

CredentialsId

Cabinet credentials ID.

int

IsDeleting

The value indicating that the cabinet is being deleted.

bit

IsRemoved

The value indicating that cabinet credential is being removed.

bit

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

dbo.CabinetSyncStatus

This table represents the cabinet synchronization status.

Column name

Column description

Data type

Id

Primary key.

bigint

CabinetId

Cabinet ID. For example, ID='CA-98MFCFAZ'.

char(11)

StartSyncMod

Synchronization mode number when synchronization has been initiated.

bigint

SyncJobStartedUtc

UTC timestamp when synchronization has been initiated.

datetime2(7)

FinishSyncMod

Synchronization mode number when cabinet synchronization has finished. Documents synchronization might be still in progress.

 

bigint

StartPurgedServermod

Synchronization mode number (servermod – the internal server modification number) when synchronization of purged documents has been initiated.

bigint

FinishPurgedServermod

Synchronization mode number (servermod – the internal server modification number) when synchronization of purged documents has been finished.

bigint

SyncJobFinishedUtc

UTC timestamp when cabinet synchronization has finished. Documents synchronization might be still in progress.

 

datetime2(7)

SynchronizeDocumentJobsCount

The number of document synchronization jobs that have been placed.

int

DeleteDocumentJobsCount

The number of document deletion jobs that have been placed.

int

PurgedDocumentJobsCount

The number of document deletion jobs that have been placed because a document is purged.

int

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

dbo.Credentials

This table represents NetDocuments credentials.

Column name

Column description

Data type

Id

Primary key.

int

Name

Credential name.

nvarchar(40)

UserGuid

User GUID.

varchar(63)

UserEmail

User email address.

nvarchar(512)

UserDisplayName

User display name.

nvarchar(100)

UserSortLookupBy

The user SortLookupBy option.

nvarchar(512)

UserOrganization

User organization.

nvarchar(512)

RefreshToken

Encrypted refresh token.

varchar(512)

RefreshTokenUpdatedUtc

UTC timestamp when a refresh token has been added or updated. The value is auto set if the refresh token has changed.

datetime2(7)

TokenType

Refresh token type.

varchar(512)

IsRemoved

The value indicating that credential has been removed.

bit

HostSettingsId

Host settings identifier.

int

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

IsInvalidRefreshToken

The value indicating that the refresh token is invalid.

bit

 

dbo.DocumentAcls

Represents the document access control list entry.

Column name

Column description

Data type

Id

Primary key.

bigint

DocumentId

Related access level document ID.

int

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Principal

The principal of access level.

varchar(512)

CabinetDefault

Cabinet default property of access level.

bit

View

The View access level. A user can view the content of a resource.

bit

Edit

The Edit access level. A user can:

  • Modify the content of documents.
  • Create or modify document versions.
  • Edit a document profile, including renaming the document or item.

bit

Share

The Share access level.

A user can share a document in a cabinet with other users of the cabinet.

bit

Administer

The Administer access level. A user can:

  • Delete a resource.
  • Force the document check-in.
  • Remove other users from the access list.
  • Change the rights of users already in the access list.
  • Add people to the full control access list (VESA).

bit

NoAccess

The No Access level. A user cannot see a document, ShareSpace, folder, and other items if they have the No Access right in the access list.

bit

dbo.DocumentAttachments

This view represents the integrator’s document attachment view.

Column name

Column description

Data type

Id

Document ID foreign key value.

int

AttachmentType

Type of the attachment, which is a unique value for each attachment within a document.

nvarchar(448)

AttachmentId

Attachment ID, which is used to obtain attachment content.

nvarchar(512)

Extension

Attachment extension.

nvarchar(512)

Description

Attachment description.

nvarchar(512)

Name

Attachment name.

nvarchar(512)

FilePath

File path to the attachment content.

nvarchar(450)

FileSize

Attachment content size.

bigint

FileLastWriteTimeUtc

Timestamp when the version content has been updated.

datetime2(7)

UpdatedUtc

UTC timestamp when the database record has been updated.

datetime2(7)

dbo.Documents

This table represents the document model.

Column name

Column description

Data type

Id

Primary key.

int

DocumentId

Document ID. For example, ID='4838-5453-6481'.

char(14)

CabinetId

Document cabinet ID.

char(11)

EnvelopeId

Document envelope ID. For example, envId=':Vault:1:k:a:l:~150894195871633.nev'.

varchar(512)

SyncMod

Document SyncMod (/Document/{id}/info). For example, syncMod=2208079511.

bigint

ModificationNumber

Document modification number (/Search/(CabinetId)?servermod=). For example, docModNum='2226703329'.

bigint

Name

Document name.

nvarchar(1000)

VersionsCount

Versions count.

int

OfficialVersion

Official version number.

int

Size

Document size.

bigint

Extension

Document extension.

nvarchar(512)

CreatedByGuid

GUID of a user that has created a document. For example, createdByGuid=VAULT- EVUM8H7G.

nvarchar(max)

CreatedBy

A user that has created a document.

nvarchar(max)

CreatedUtc

UTC ticks when a document has been created.

datetime2(7)

ModifiedByGuid

GUID of a user that has modified a document.  For example, modifiedByGuid=VAULT-EVUM8H7G.

nvarchar(max)

ModifiedBy

A user that has modified a document.

nvarchar(max)

ModifiedUtc

UTC ticks when a document has been modified.

datetime2(7)

UpdatedUtc

UTC timestamp when a database record is updated.

datetime2(7)

dbo.DocumentVersions

This table represents the document version model.

Column name

Column description

Data type

Id

Related document ID.

int

VersionNumber

Document version number.

int

Name

Document version name.

nvarchar(1000)

CreatedFrom

Version number used to create this version.

int

IsOfficial

The value indicating that this version is official.

bit

IsLocked

The value indicating that this version is locked.

bit

FilePath

Document version content path.

nvarchar(450)

FileSize

Document version content size.

bigint

FileLastWriteTimeUtc

Timestamp when version content is updated.

datetime2(7)

Extension

Document version extension.

nvarchar(512)

Description

Document version description.

nvarchar(1000)

 

CreatedByGuid

GUID of a user that has created a document. For example, createdByGuid=VAULT- EVUM8H7G. /Document/{id}/{verNum}/info does not return it.

nvarchar(max)

CreatedBy

A user that has created a document. For example, createdBy=Name Surname.

nvarchar(max)

CreatedUtc

UTC timestamp when a document is created.

datetime2(7)

ModifiedByGuid

GUID of a user that has modified a document. For example, modifiedByGuid=VAULT-EVUM8H7G. /Document/{id}/{verNum}/info does not return it.

nvarchar(max)

ModifiedBy

A user that has modified a document.

nvarchar(max)

ModifiedUtc

UTC timestamp when a document is modified.

datetime2(7)

UpdatedUtc

UTC timestamp when a database record is updated.

datetime2(7)

Back to Top

dbo.DocumentMiscellaneous

This table represents the document miscellaneous model view.

Column name

Column description

Data type

Id

Related document primary key.

int

IsApproved

Approved flag.

bit

IsArchived

Archived flag.

bit

IsDeleted

Deleted flag.

bit

IsExternal

External flag.

bit

IsSigned

Signed flag.

bit

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

dbo.DocumentLinks

This table represents documents links.

Column name

Column description

Data type

Id

Primary key.

int

DocumentId

Foreign key to the Documents table.

int

LinkedDocumentId

Linked document identifier.

varchar(512)

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

dbo.DocumentLocations

This table represents documents locations.

Column name

Column description

Data type

EnvelopeId

Location envelope identifier. Primary key.

varchar(512)

CabinetId

Parent cabinet. Foreign key to Cabinets table.

char(11)

Name

Location name.

nvarchar(2048)

AncestorId

Parent location identifier. Foreign key to this table.

varchar(512)

LocationId

12-digit location identifier.

char(14)

IsDeleted

Indicates whether a location is deleted.

bit

Type

The binary representation of location type (‘F’, ‘C’, ‘S’, ‘W’)

tinyint

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

dbo.DocumentDocumentLocations

Intermediate table to a model many-to-many (multicomponent?) relationship of the document to locations.

Column name

Column description

Data type

Document_Id

Foreign key to Documents table

int

DocumentLocation_EnvelopeId

Foreign key to DocumentLocations table

varchar(512)

 

dbo.EmailProfileAttachments

This table represents a document email profile attachments model.

Column name

Column description

Data type

Id

Related document primary key.

int

EmailProfileAttributeId

Related profile attribute document ID.

int

Name

Linked document ID.

nvarchar(max)

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

dbo.EmailProfileAttributes

This table represents the integrators model view of the Email part of the document profile attributes.

Column name

Column description

Data type

Id

Related document primary key.

int

Subject

Subject line.

nvarchar(max)

From

Sender address.

nvarchar(max)

To

Address collection that contains the recipients.

nvarchar(max)

Cc

Address collection that contains the carbon copy (CC) recipients.

nvarchar(max)

EmailId

Calculated email ID. For example, id='&lt;11177490.1031.1450182514738.JavaMail.adminaccount@vm46890&gt;'.

nvarchar(max)

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

dbo.HostSettings

This table represents host settings.

Column name

Column description

Data type

Id

Setting identifier.

int

Name

Host setting readable name.

nvarchar(40)

ClientId

Application client_id.

nchar(11)

ClientSecret

Encrypted client secret.

nvarchar(256)

HostName

Fully qualified hostname.

nvarchar(256)

RedirectUrl

Redirect URL.

nvarchar(256)

 

dbo.Logs

This table represents the model for the Log entry.

Column name

Column description

Data type

Id

Log entry identifier.

bigint

Level

Log entry level.

nvarchar(512)

Logged

Date and time for a particular log event to happen.

datetime2(7)

Message

Log entry message.

nvarchar(max)

CabinetId

Optional reference to the cabinet ID linked to this log entry.

char(11)

DocumentId

Optional reference to the document ID linked to this log entry.

char(14)

Logger

Log entry logger.

nvarchar(512)

CallSite

Log entry call site.

nvarchar(512)

Exception

Log entry exception.

nvarchar(max)

StackTrace

Log entry stack trace.

nvarchar(max)

ThreadId

Log entry thread.

nvarchar(512)

UserName

Log entry user name.

nvarchar(512)

MachineName

Log entry machine name.

nvarchar(512)

Application

Application name on which log event happened.

nvarchar(40)

dbo.LookupAccesses

This table represents the REST lookup item access permission model.

Column name

Column description

Data type

Id

Primary key.

bigint

LookupId

Related access level document ID.

bigint

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

Principal

The principal of access level.

varchar(512)

CabinetDefault

Cabinet default property of the access level.

bit

View

The View access level. A user can view the content of a resource.

bit

Edit

The Edit access level.

A user can:

  • Modify the content of documents.
  • Create or modify document versions.
  • Edit a document profile, including renaming the document or item.

bit

Share

The Share access level. A user can share a document in a cabinet with other users of the cabinet.

bit

Administer

The Administer access level.

A user can:

  • Delete a resource.
  • Force the document check-in.
  • Remove other users from the access list or change the rights of users already in the access list.
  • Add people to the full control access list (VESA).

bit

NoAccess

The No Access level. A user cannot see a document, ShareSpace, folder, and other items if they have the No Access right in the access list.

bit

 

dbo.Lookups

This table represents the lookup value.

Column name

Column description

Data type

Id

Primary key.

bigint

ProfileAttributeDefinitionId

Related profile attribute definition ID.

int

Key

Lookup key.

nvarchar(250)

Description

Lookup description.

nvarchar(1000)

Defaulting

Default (type) for lookup values. Provide DefaultSource for profile attribute.

nvarchar(250)

Hold

Litigation Hold is set for the lookup value.

bit

LinkedUser

Lookup linked user value.

varchar(63)

ClosedUtc

The Сlosed date is set for the lookup value.

datetime2(7)

AccessFilteredPermissions

Lookup access filtered_permissions value.

bit

AccessForcePermissions

Lookup access force_permissions value.

bit

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

ParentKey

Related parent lookup value ID.

nvarchar(250)

SyncSessionKey

Lookup synchronization session key.

uniqueidentifier

 

dbo.LookupSyncSessions

This table represents the lookup synchronization session.

Column name

Column description

Data type

ProfileAttributeDefinitionId

Related profile attribute definition primary key.

int

Key

Session key.

uniqueidentifier

Count

Synchronized lookup items count.

int

SkipToken

Session skip token if it is parent and child lookup table.

nvarchar(512)

StartedUtc

UTC timestamp when the cabinet synchronization has started.

datetime2(7)

FinishedUtc

UTC timestamp when lookup synchronization has finished.

datetime2(7)

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

 

dbo.ProfileAttributeDefinitionCabinets

Intermediate table models many-to-many relationship of ProfileAttributes Definitions to Cabinets.

Column name

Column description

Data type

ProfileAttributeDefinition_Id

Profile attribute definition ID.

int

Cabinet_Id

Cabinet ID.

char(11)

dbo.ProfileAttributeDefinitions

This table represents the repository profile attribute definition model.

Column name

Column description

Data type

Id

Primary key.

int

RepositoryId

Profile attribute repository ID.

char(11)

AttributeId

Profile attribute ID.

int

Name

Profile attribute name.

nvarchar(40)

Type

Profile attribute type.

int

AllowPunctuation

The Allow punctuation and spaces flag.

bit

BaseSecurity

Value if profile-based security is used.

bit

DefaultSource

The Default from <attribute> Type value. Allows you to define a column in another table to use as a default value. So, if there is a need to give a default value based on the Author value a user selects, you can upload values into the Author Type column and then enter Author into the Default from field.

int

ForceUppercase

The Force uppercase flag.

bit

HideLookup

The Hide from External Users flag.

bit

Linked

A value that connects an attribute to the created profile attribute such as matters with clients.

int

MaxLength

Field character max length (50 for most attributes).

int

PadToLength

Values with leading zeros. For example, if you create the Account Number field and all your account numbers are 5 digits, you can enter a number 5 in this field and it will automatically add leading zeros to numbers if they are under 5 digits long.

int

PromptIfEmpty

The Prompt if empty flag.

bit

UseLookup

Value if a validation (lookup) table for a profile attribute is to be used.

bit

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

AllowMultipleValues

The Multi-value profile attribute flag.

bit

dbo.Repositories

This table represents the repository model.

Column name

Column description

Data type

Id

Repository ID. For example, id='CA-98MFCFAZ'.

char(11)

Name

Repository name.

nvarchar(64)

IOSAppAccess

Repository iOS application access mode.

Repository administrators can configure users' access to NetDocuments applications for the iPhone and iPad:

  • Allow any NetDocuments application
  • Only allow NetDocuments for Good Technology application
  • Do not allow

nvarchar(512)

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

dbo.RepositoryGroupMembers

This table represents the group member.

Column name

Column description

Data type

Id

Primary key.

int

GroupId

Group ID foreign key.

char(11)

UserId

Group user ID.

varchar(63)

UserDisplayName

Group user display name.

nvarchar(100)

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

 

dbo.RepositoryGroups

This table represents the repository user group model.

Column name

Column description

Data type

Id

Repository group ID.

char(11)

RepositoryId

Cabinet repository ID.

char(11)

Name

Group name.

nvarchar(512)

External

External members switch.

bit

Hidden

The Do not display in user group lists option. Select this option to reduce clutter in lists of user groups. If this group is added to a document access control list (ACL), it will still be visible.

bit

HideMembership

The Hide group membership option. Prevent user group's members from being displayed.

bit

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

dbo.RepositoryUsers

Intermediate table models many-to-many relationship of repositories to users.

Column name

Column description

Data type

Repository_Id

The repository ID.

char(11)

User_Id

The user ID.

varchar(63)

dbo.ServiceCaches

This table represents the service persistence cache storage.

Column name

Column description

Data type

Key

The key.

nvarchar(100)

Value

The value.

nvarchar(max)

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

dbo.ServiceSettings

This table represents the Service settings storage.

Column name

Column description

Data type

Key

The key.

nvarchar(100)

Value

The value.

nvarchar(max)

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

dbo.ServiceUsers

Server user (Windows authorization) for whom the access to Service is allowed.

Column name

Column description

Data type

Id

Primary key.

int

IdentityType

Type of identity (user or group).

int

Name

Fully qualified user name.

nvarchar(256)

ClaimsListJson

Claims list in JSON.

nvarchar(max)

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

dbo.Users

This table represents a NetDocuments user.

Column name

Column description

Data type

Id

User ID.

varchar(63)

Email

User email.

nvarchar(512)

DisplayName

Display name.

nvarchar(100)

LastLoginUtc

Login time stamp.

datetime2(7)

RegisteredUtc

Registration time stamp.

datetime2(7)

UpdatedUtc

UTC timestamp when a database record has been updated.

datetime2(7)

 

Integration.Schema

Table for the integration schema versioning.

Column name

Column description

Data type

Version

(integration schema version)

Integration schema version. Semantic versioning is used.

varchar(128)

 

Back to Top

Was this article helpful?
0 out of 0 found this helpful
Powered by Zendesk