Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

To understand the Analytics queries to write, the user will need to understand the tables CAM Analytics supports and the metadata and values that can be selected from. See the below tables for the values, keys, required fields, and how to query.

Table of Contents
minLevel1
maxLevel7
outlinetrue
typeflat

...

Expand
titleFolder

Folder Table

This table contains all the workspaces and folders within CAM.

Query the table by: select * from folder limit 100

^Use the folder Query type

Column

Description

id

The unique internal id of the CAM folders/workspaces.

extid

Displays the row number of the entry in the folder table. It is a mandatory field. For fileshare, this is the path

name

Name of the folder.

description

Description on the folder.

extParentId

The id externally of the parent folder/workspace.

extContainerId

If the configured External System is iManage this column displays the database name, followed by the folder number (e.g. demo!1234), in case of NetDocuments, this displays the 12 digit folder number (e.g. 4816-5122-8805). It is a mandatory field. Other systems, this is the path of the folder/workspace.

extContainerName

If the configured External System is iManage this column displays the database name, followed by the folder name (e.g. demo!folder), in case of NetDocuments, this displays the folder name. It is a mandatory field. Other systems, this is the path of the folder/workspace.

folderType

Displays the folder type (e.g. folder/saved search/workspace etc). See chart below: FolderTypeids. It is a mandatory field.

parentId

Displays the parent folder Id associated to the parent folder. This is auto-generated by CAM.

alternateparentid

The id of the alternate parent folder.

extworkspaceId

Displays the workspace id associated to the workspace. If the configured External System is iManage this column displays the database name, followed by the workspace number (e.g. demo!1234), in case of NetDocuments, this displays the 12 digit workspace number (e.g. 4816-5122-8805)

ctag

etag

documentNumber

The document number

version

The document version

indexNumber

The number of the index

orderedById

Id the record is ordered by

orderingDate

Date the record was ordered

isDeleted

Is the folder/workspace deleted?

importReference

Displays the folder Id from the Data Import

isDeletedToken

If marked for deletion, this token is filled out

extLongId

The long id version from the external system. For fileshare, this is the path.

extShortId

The shorter id from the external system. For fileshare, this is the path.

folderStatusId

Id of the folder status

folderStatus

Status of the folder

owner

Displays the folder owner name

ownerId

Displays the folder Id associated to the folder. This is auto-generated by CAM.

author

Displays the author of the folder/workspace.

authorId

Displays the authorid of the folder/workspace.

securityLevelId

Displays the security level Id associated to the security level. This is auto-generated by CAM.

securityLevel

Displays the folder security level (inherit/view/private etc.)

documentClass

This value is updated based on the Auroradb column mapping in the metadata tab.

documentClassId

Displays the document class Id associated to the document class. This is auto-generated by CAM.

clientCodeId

Displays the client code ID associated to client code. This is auto-generated by CAM

clientCode

This value is updated based on the Auroradb column mapping in the metadata tab.

matterCodeId

Displays the matter code ID associated to matter code. This is auto-generated by CAM

matterCode

This value is updated based on the Auroradb column mapping in the metadata tab.

practiceCodeId

Displays the practice code ID associated to practice code. This is auto-generated by CAM

practiceCode

This value is updated based on the Auroradb column mapping in the metadata tab.

industryCodeId

Displays the industry code ID associated to industry code. This is auto-generated by CAM

industryCode

This value is updated based on the Auroradb column mapping in the metadata tab.

matterType

Displays the matter type.

matterTypeId

Displays the matter type id.

matterSubType

Displays the matter subtype.

mattersubtypeid

Displays the matter subtype id.

areaOfLaw

The area of law categorization. For example, Intellectual Property

areaOfLawId

The area of law id

classCode

The fee earner class code

classcodeid

The class code id

deptCode

The department code

deptCodeid

The department code id

subClassCode

If the class has a subclass, this is the code for it.

SubclassCodeid

The subclasscodeid

comments

Comments on the folder/workspace

matterStatusId

Id of the matter status

MatterStatus

The status of the matter. For e.g. Open, Closed, Inactive, Opportunity

sourceId

Id of the source record

nblsNumber

matteropenDate

Date the matter started

mattercloseDate

Date the matter ended

filedDate

NDate the folder was filed

hasUnorderedDocuments

If the folder/workspace has unordered documents (blank documentorder), this is 1=Yes.

templateId

The id of the template used.

matterlocation

Location of the matter

matterlocationid

Id of the matter location

responsiblelawyer

The responsible lawyer of the matter.

responsibleLawyerId

Id of the responsible lawyer

originatinglawyer

The lawyer that originated the matter.

originatingLawyerId

The id of the originating lawyer

officeCode

The code of the office

officecodeid

The id of the office

countryCode

The code of the country

countrycodeid

The id of the country

jurisdictionCodeId

Id of the jurisdiction

jurisdictionCode

The Jurisdiction of the matter

courtCode

Code of the court

courtcodeid

Id of the court

judgename

Name of the judge

onLegalHold

If the workspace or document is under a legal hold (in CAM or other system)

legalHoldStartDate

Start of the legal hold

legalHoldEndDate

End of the legal hold

guid

A guid identifier for the record (unique)

isLatest

Flag to indicate if the folder was recently updated

isHipaa

Is the document or workspace dealing with a Hipaa procedure in medicine

isCheckedOut

Is the folder/workspacechecked out?

isDeclared

Is the folder/workspace declared?

isApproved

Is the folder/workspace approved?

isArchived

Is the folder/workspace archived?

isAutoversioning

Is the folder/workspace auto versioned?

isEcho

isExternal

Is the folder/workspace external to the firm?

isExternalUser

Is there an external user to the folder/workspace?

isFavorite

Is the folder/workspace a favorite?

isLocked

Is the folder/workspace locked?

isOfficalLocked

Is the folder/workspace officially locked?

isQueueforIndexing

Is the folder/workspace queued for indexing?

isSigned

Is the folder/workspace signed?

isOfficialVersion

Is the folder/workspace officially versioned (default)

isShortcut

Is the folder/workspace a shortcut?

importedById

Id of the person or system who imported the folder/workspace

importedDate

Displays the date the folder was imported in CAM

lastChangeDate

Displays the last update date

lastChangeUserId

Displays the last change user id associated to the last change user. This is auto-generated by CAM.

lastChangeUser

Displays the user name who last updated the document

metadata

A JSON formatted row of all the metadata passed on the folder/workspace. Comma separated.

c1-c45

Displays the custom metadata fields

n1-n10

Displays the custom metadata fields

d1-d10

Displays the custom metadata fields

createdDate

Displays the folder creation date

createdBy

Displays the user name who created the folder

EditedDate

The date last edited

subscriberId

Displays the tenant subscriber Id

extsystemid

Displays the external system id

projectId

Displays the id of the project. From CAM’s Project import function in Directory tab

ProfileEditDate

Date the profile was edited

ProfileEditedUserId

The userid of the person who edited the profile

profileEditedUser

The user that edited the profile

camCreatedDate

If created by CAM in CAM, the date created.

camCreatedBy

If created by CAM in CAM, the person that created (if applicable)

camEditedDate

If using CAM, the date last edited

camEditedBy

If using CAM, the person who last edited

The
Expand
titleGroupsFolder Content
Groups

Folder Content Table

This table contains all the groups within CAMcontent within the folders (excluding the physical documents stored in the document table).

Query the table by: select * from groups folder_content limit 100

^Use the groups folder Query type

Column

Description

id

Displays the

The internal CAM id of the

entry in the groups table in CAM

groupId

Displays the group Id

groupName

Displays the group name

email

folder content table records.

docid

The id of the document

folderid

The id of the folder

extDocid

The external system document id

extFolderid

The external system folder id

extContainerid

The external system container id

extContainerName

The external system container name

camCreatedDate

If created in CAM, the created date

camCreatedBy

If created in CAM, the user who created

camEditedDate

If edited in CAM, the date edited

camEditedBy

If edited in CAM, the user who edited

extSystemId

The external system id

subscriberid

The tenant subscriber id

Expand
titleGroups

Groups Table

This table contains all the groups within CAM.

Query the table by: select * from groups limit 100

^Use the groups Query type

Column

Description

id

Displays the id of the entry in the groups table in CAM

groupId

Displays the group Id

groupName

Displays the group name

email

The email of the group

office

The office location of the group

groupType

Displays the group type (Internal/External) Internal=0 External=1

groupContainerType

The type of container of the group

extcontainerid

The id of the container (typically = the name)

extcontainername

The container name where the group came from

isCAMGroup

Is a group within CAM for CAM. 0= from any other ext system

extid

The external id of the group

Metadata

Displays in JSON format any metadata applied to the group. Comma separated.

CreatedDate

Date the group was created

EditedDate

Date the group was last edited

CreatedbyUserid

User id of the person who created the group

CreatedByUser

The user who created the group

LastChangeUserid

The userid of the person who last edited the group

LastChangeUser

The user who last edited the group

camCreatedDate

If created in CAM, the created date

camCreatedBy

If created in CAM, the user who created

camEditedDate

If edited in CAM, the date edited

camEditedBy

If edited in CAM, the user who edited

extSystemId

The external system id

subscriberid

The tenant subscriber id

Expand
titleGroupMembersGroup Members

Group

_

Members Table

This table contains all the group memberships within CAM: which users belong to which group.

Query the table by: select * from group_members limit 100

^Use the groups Query type

Column

Description

id

Displays the id of the entry in the group_members table in CAM

groupid

Displays the id of the group

userid

Displays the id of the user

extgroupid

Contains the id of the external system group

extuserid

Contains the id of the external system user

extcontainerid

Contains the id of the external system container

extcontainername

Contains the name of the external system container.

Metadata

Displays in JSON format any metadata applied to the group membership. Comma separated.

CreatedDate

Date the group membership was created

EditedDate

Date the group membership was last edited

CreatedbyUserid

User id of the person who created the group membership

CreatedByUser

The user who created the group membership

LastChangeUserid

The userid of the person who last edited the group membership

LastChangeUser

The user who last edited the group membership

camCreatedDate

If created in CAM, the created date

camCreatedBy

If created in CAM, the user who created

camEditedDate

If edited in CAM, the date edited

camEditedBy

If edited in CAM, the user who edited

extSystemId

The external system id

subscriberid

The tenant subscriber id

...