Object Model Reference

This reference documents the attributes of objects which can be included in Document Templates.

Draft

The draft object is the entrypoint to the data for Document Templates which have a scope of Draft Home. It is one of the objects available to the template context.

Name	Type	Description
id	integer
last_updated_by	User reference. May be None.	last updated by
last_updated	datetime in UTC timezone. May be None.	last updated
deleted	datetime in UTC timezone. May be None.	Date/time this object was (soft) deleted
Project	Project reference
DraftName	string(2000)
DeleteExisting	boolean	From the ALS upload attribute of the same name.
ProjectName	string(2000)	From the ALS upload attribute of the same name. If the Draft was created from an ALS file then this value will be set to the name of the Architect Project that this Draft was downloaded from. It may be different to Project.ProjectName which is the name of the Project this Draft was loaded into in TrialGrid.
ProjectType	string(19)	From the ALS upload attribute of the same name.
PrimaryForm	Form reference. May be None.
DefaultMatrix	Matrix reference. May be None.
ConfirmationMessage	string(4000)
SignaturePrompt	string(2000)
LabStandardGroup	string(2000)
ReferenceLabs	string(2000)
AlertLabs	string(2000)
SyncOIDProject	string(2000)	From the ALS upload attribute of the same name.
SyncOIDDraft	string(2000)	From the ALS upload attribute of the same name.
SyncOIDProjectType	string(19)	From the ALS upload attribute of the same name.
SyncOIDOriginIsVersion	boolean	From the ALS upload attribute of the same name.
StandardsDraftParent	CRF Draft reference. May be None.	A reference to the Standard Library Draft this Draft is pointed to (if any).
standards_draft_change_flag	datetime in UTC timezone. May be None.	When this value is not None it means the Draft Standards Compliance is currently being calculated.
show_uat_coverage	boolean	Show Test Coverage?
approvals	List of string(2000). May be None.	List of Project Roles which have approved this Draft.
is_locked	boolean	Is this Draft locked?
number_of_field_checks	integer	Number of Field Checks in the Draft (these are set on the Field such as Query Future Date)
als_forms_set	Object Manager. Set of related Forms	Set of related Forms.
als_fields_set	Object Manager. Set of related Fields	Set of all field objects belonging to Forms in this Draft.
als_folders_set	Object Manager. Set of related Folders	Set of all Folder objects in this Draft.
als_datadictionaries_set	Object Manager. Set of related Data Dictionaries	Set of all Data Dictionary objects in this Draft.
als_datadictionaryentries_set	Object Manager. Set of related Data Dictionary Entries	Set of all Data Dictionary Entry objects belonging to Data Dictionaries in this Draft.
als_unitdictionaries_set	Object Manager. Set of related Unit Dictionaries	Set of all Unit Dictionary objects in this Draft.
als_unitdictionaryentries_set	Object Manager. Set of related Unit Dictionary Entries	Set of all Unit Dictionary Entry objects belonging to Unit Dictionaries in this Draft.
als_matrices_set	Object Manager.	Set of related Matrices
als_checks_set	Object Manager.	Set of related Edit Checks
als_checksteps_set	Object Manager.	Set of related Edit Check Steps
als_checkactions_set	Object Manager.	Set of related Edit Check Actions
als_derivations_set	Object Manager.	Set of related Derivations
als_derivationsteps_set	Object Manager.	Set of related Derivation Steps
als_labvariablemappings_set	Object Manager.	Set of related Lab Variable Mappings
als_customfunctions_set	Object Manager.	Set of related Custom Functions
als_coderconfiguration_set	Object Manager. Set of related Coder Configurations
als_codersupplementalterms_set	Object Manager.	Set of related Coder Supplemental Terms
als_codercomponentterms_set	Object Manager.	Set of related Coder Component Terms
als_matrixfolders_set	Object Manager.	Set of related Matrix Folders
activities	Object Manager. Set of related Activity Records	Set of all activity records which are related to this Draft (not all objects within it, just the Draft object itself)
labels	Object Manager. Set of related Object Labels	Set of related Object Labels. See Labels.
properties	Ordered dictionary of custom property definition and values.	See Custom Properties (Metadata).
rules	Object Manager. Set of related Standard Rules	Set of all rules which are defined in this Draft (if this draft is a Library)
draftrule_set	Object Manager. Set of related Activated Draft Rules	Set of activated Rules in this Draft from the Library to which it is associated.
comment_set	Object Manager. Set of related Comments
testcase_set	Object Manager. Set of related Test Cases

Organization

All URL objects within TrialGrid belong to an Organization.

Name	Type	Description
name	string(100)	The name of the Organization

Project

The "project" context variable is the entrypoint to the Template for Document Templates which have a scope of "Project Home" or "Project Tickets".

Name	Type	Description
ProjectName	string	The name of the Project in TrialGrid
ProjectDescription	string	The description of the Project if set
ProtocolName	string	The protocol name of the Project if set
rave_url	URL reference	A reference to the URL to which this Project belongs
view_all	boolean	True if this Project is set to "view all"
is_library	boolean	True if this Project is a library project
active	boolean	True if this project has been marked as Active
properties	Ordered dictionary of custom property definition and values.	See Custom Properties (Metadata).
labels	Object Manager. Set of related Object Labels	Set of related Object Labels. See Labels.
activities	Object Manager. Set of related Activity Records	Set of all activity records which are related to this Project object (just the object, not all objects within it)
als_crfdraft_set	Object Manager. Set of related CRF Drafts	Set of all CRF Drafts in this Project
ticket_set	Object Manager. Set of related Tickets	Set of all CRF Drafts in this Project
all_draft_testcases()	Dictionary with Test Case Name as key and list of Test Case objects as value	Function which returns all Test Cases from all CRF Drafts in this Project

Ticket

A ticket in a Project.

Name	Type	Description
iid	integer	The unique id of the ticket within this project (first ticket is iid=1, second is iid=2 etc).
title	string	The title of the ticket
body	string	The body text of the ticket. Note that this may be in Markdown format.
created	datetime	The date/time that the ticket was created in UTC timezone.
created_by	User reference	A reference to the user who created this URL.
closed_on	datetime	The date/time that the ticket was closed in UTC timezone. None if not yet closed.
closed_by	User reference to the user who closed the ticket. None if not yet closed.	A reference to the user who created this URL.
due_date	datetime in UTC timezone. May be None.	Typically only the date part of this date/time is important.
open	boolean	True if the ticket is open, otherwise False (ticket Closed)
ticketobjectrelation_set	Object Manager.	Set of related TicketObjectRelation objects
ticketassign_set	Object Manager.	Set of related TicketAssign objects representing users assigned to the ticket.
comments	Object Manager.	Set of related Comments for this Ticket
labels	Object Manager. Set of related Object Labels	Set of related Object Labels. See Labels.
activities	Object Manager. Set of related Activity Records	Set of all activity records which are related to this Ticket

TicketObjectRelation

A relationship between a Ticket and a related Draft object (e.g. a Form or Edit Check)

Name	Type	Description
ticket	Ticket reference	A link to the ticket this TicketObjectRelation record belongs to
assigned_by	User	Reference to the user who related this object with the ticket
assigned_on	datetime	The date/time that the object referenced by content_object was assigned to this ticket with UTC timezone.
draft	Draft	Reference to the the draft the related object belongs to
content_object	Object reference	The object to which this label is attached (e.g. Form, Folder etc)
object_id	integer. May be None. The id of the object referenced in content_object	The ID of the object to which this label is attached
content_type_id	integer. May be None.	An ID representing the unique type of the Object referenced by the object_id

TicketAssign

A relationship between a Ticket and a User who is assigned to the ticket.

Name	Type	Description
ticket	Ticket reference	A link to the ticket this TicketObjectRelation record belongs to
assigned_to	User (May be None)	If the ticket is assigned to a user then this will be set to a reference to the user. If assigned to a role it will be None
assigned_to_role	Role (May be None)	If the ticket is assigned to a role then this will be set to a reference to the ProjectRole. If assigned to a user it will be None
assigned_by	User	Reference to the user who assigned the ticket to the assigned_to User or Role
assigned_on	datetime	The date/time that the user was assigned to this ticket with UTC timezone.

URL

The TrialGrid URL object which the Draft is contained by.

Name	Type	Description
name	string	The name of the URL object
organization	Organization reference	The Organization to which the Rave URL belongs.
url	string	The Rave URL name if set in the URL settings (e.g. https://example.mdsol.com)
created_by	User reference	A reference to the user who created this URL.

ProjectRole

The definition of a Project Role in an URL.

Name	Type	Description
name	string	The name of the ProjectRole definition
url	URL reference	The URL to which the Role Definition belongs
created	datetime in UTC timezone. May be None.	date/time the Role was created
updated	datetime in UTC timezone. May be None.	last updated date/time
description	string	Description of the Role (if any set)

UserProjectRole

The definition of a Users role in a project. This could be a ProjectRole as above but when a user does not have a set role in the Project it could be of type NoPermissionRole, UrlManagerRole or OwnerPermissionRole.

When using the project_role_for_user(user_object) function in document templates only reference these attributes which are shared with ProjectRole above to avoid errors because you might expect to get a ProjectRole object but instead might receive a OwnerPermissionRole instance signaling that the user is the Owner of the Project and does not have a separate assigned ProjectRole.

UserProjectRole objects have the following attributes:

Name	Type	Description
name	string	The name of the Role
description	string	Description of the Role (if any set)

User

The User object represents users in the system. A few attributes of users are available for reporting.

Name	Type	Description
username	string	The username for the user object e.g. "james_smith"
email_address	string	Email address of the user, from their user profile.
first_name	string	The first name of the user, if set by the user in their profile e.g. "James"
last_name	string	The last name of the user, if set by the user in their profile e.g. "Smith"

Custom Function

Name	Type	Description
id	integer
last_updated_by	User reference. May be None.	last updated by
last_updated	datetime in UTC timezone. May be None.	last updated
CRFDraft	CRF Draft reference
FunctionName	string(2000)
SourceCode	string(8000)
Lang	string(2000)	Language
DownloadedFromObjectId	string(2000)
fingerprint	string(40)	Fingerprint Hash. See Fingerprints.
compliance_fingerprint	string(33)	Like the fingerprint but only contains core properties and custom property values which are included in compliance calculations. Important: Will only be set for objects which are in a draft linked to a library and where the object cannot be found in the library. These compliance fingerprints are matched to Standards Deviation Explanations which identify that an object not found in the library with this exact compliance fingerprint has been approved/denied etc.
copied_from	Custom Function reference. May be None.	Copied from
standard_library	CRF Draft reference. May be None.	Standard Library
standard_match_identifier	string(2000). May be None.	Standard Match Identifier
compliance_state	string(2). May be None.	Compliance state. 0 = Not Applicable / No Information Set, 1 = Calculating, 2 = Not Found, 3 = Different, 4 = Allowed Change, 5 = Match
compliance_object	Custom Function reference. May be None.	Compliance object
is_alwaystrue	boolean. May be None.	Returns true
als_checksteps_set	Object Manager. Set of related Edit Check Steps
als_derivationsteps_set	Object Manager. Set of related Derivation Steps
labels	Object Manager. Set of related Object Labels	Set of related Object Labels. See Labels.
properties	Ordered dictionary of custom property definition and values.	See Custom Properties (Metadata).

Coder Component Term

Name	Type	Description
id	integer
last_updated_by	User reference. May be None.	last updated by
last_updated	datetime in UTC timezone. May be None.	last updated
CRFDraft	CRF Draft reference
Form	Form reference. May be None.
Field	Field reference. May be None.
ComponentTerm	string(2000)
ComponentName	string(2000)

Coder Configuration

Name	Type	Description
id	integer
last_updated_by	User reference. May be None.	last updated by
last_updated	datetime in UTC timezone. May be None.	last updated
CRFDraft	CRF Draft reference
Form	Form reference. May be None.
Field	Field reference. May be None.
CodingLevel	string(2000)
Priority	string(2000)
Locale	string(2000)
IsApprovalRequired	boolean
IsAutoApproval	boolean

Coder Supplemental Term

Name	Type	Description
id	integer
last_updated_by	User reference. May be None.	last updated by
last_updated	datetime in UTC timezone. May be None.	last updated
CRFDraft	CRF Draft reference
Form	Form reference. May be None.
Field	Field reference. May be None.
SupplementalTerm	string(2000)

Data Dictionary

Name	Type	Description
id	integer
last_updated_by	User reference. May be None.	last updated by
last_updated	datetime in UTC timezone. May be None.	last updated
CRFDraft	CRF Draft reference
DataDictionaryName	string(2000)	Name
DownloadedFromObjectId	string(2000)
fingerprint	string(40)	Fingerprint Hash. See Fingerprints.
copied_from	Data Dictionary reference. May be None.	Copied from
standard_library	CRF Draft reference. May be None.	Standard Library
standard_match_identifier	string(2000). May be None.	Standard Match Identifier
compliance_state	string(2). May be None.	Compliance state. 0 = Not Applicable / No Information Set, 1 = Calculating, 2 = Not Found, 3 = Different, 4 = Allowed Change, 5 = Match
compliance_object	Data Dictionary reference. May be None.	Compliance object
allow_deletes	boolean	Allow Entries to be deleted
allow_inserts	boolean	Allow Entries to be added
master_dictionary	Data Dictionary reference. May be None.	For standard, the master dictionary from which elements may be selected
als_fields_set	Object Manager. Set of related Fields
als_datadictionaryentries_set	Object Manager. Set of related Data Dictionary Entries
labels	Object Manager. Set of related Object Labels	Set of related Object Labels. See Labels.
properties	Ordered dictionary of custom property definition and values.	See Custom Properties (Metadata).

Data Dictionary Entry

Name	Type	Description
id	integer
last_updated_by	User reference. May be None.	last updated by
last_updated	datetime in UTC timezone. May be None.	last updated
CRFDraft	CRF Draft reference
DataDictionary	Data Dictionary reference. May be None.
CodedData	string(2000)
Ordinal	integer. May be None.
UserDataString	string(2000)
Specify	boolean
fingerprint	string(40)	Fingerprint Hash. See Fingerprints.
std_required	boolean	Required by Standards

Derivation

Name	Type	Description
id	integer
last_updated_by	User reference. May be None.	last updated by
last_updated	datetime in UTC timezone. May be None.	last updated
CRFDraft	CRF Draft reference
DerivationName	string(2000)	Name
Active	boolean
Folder	Folder reference. May be None.
Form	Form reference. May be None.
Field	Field reference. May be None.
VariableOID	string(2000)
RecordPosition	integer. May be None.
AllVariablesInFolders	boolean
AllVariablesInFields	boolean
FormRepeatNumber	integer. May be None.
FolderRepeatNumber	integer. May be None.
BypassDuringMigration	boolean
CopySource	string(2000)
NeedsRetesting	boolean
RetestingReason	string(2000)
cql	string(2000+)	Derivation Logic
quickedit	string(2000+)
target_cql	string(2000+)	Applied To
has_error	integer	0 = No errors, 1 = No Steps, 2 = Syntax Error, 3 = Missing Objects (see below)
missing_folders	List of string(2000). May be None.	Missing Folders
missing_forms	List of string(2000). May be None.	Missing Forms
missing_fields	List of string(2000). May be None.	Missing Fields
missing_variables	List of string(2000). May be None.	Missing Variables
missing_customfunctions	List of string(2000). May be None.	Missing Custom Functions
fingerprint	string(40)	Fingerprint Hash. See Fingerprints.
copied_from	Derivation reference. May be None.	Copied from
standard_library	CRF Draft reference. May be None.	Standard Library
standard_match_identifier	string(2000). May be None.	Standard Match Identifier
compliance_state	string(2). May be None.	Compliance state. 0 = Not Applicable / No Information Set, 1 = Calculating, 2 = Not Found, 3 = Different, 4 = Allowed Change, 5 = Match
compliance_object	Derivation reference. May be None.	Compliance object
als_derivationsteps_set	Object Manager. Set of related Derivation Steps
labels	Object Manager. Set of related Object Labels	Set of related Object Labels. See Labels.
properties	Ordered dictionary of custom property definition and values.	See Custom Properties (Metadata).

Derivation Step

Name	Type	Description
id	integer
CRFDraft	CRF Draft reference
Derivation	Derivation reference. May be None.
StepOrdinal	integer. May be None.	Ordinal
DataFormat	string(2000)
VariableOID	string(2000)
StepValue	string(2000)	Value
StepFunction	string(2000)	Function
Folder	Folder reference. May be None.
Form	Form reference. May be None.
Field	Field reference. May be None.
CustomFunction	Custom Function reference. May be None.
RecordPosition	integer. May be None.
LogicalRecordPosition	string(2000)
Scope	string(2000)
OrderBy	string(2000)
FormRepeatNumber	integer. May be None.
FolderRepeatNumber	integer. May be None.

Edit Check

Name	Type	Description
id	integer
last_updated_by	User reference. May be None.	last updated by
last_updated	datetime in UTC timezone. May be None.	last updated
CRFDraft	CRF Draft reference
CheckName	string(2000)	Name of the check
CheckActive	boolean	Active
BypassDuringMigration	boolean
Infix	string(2000+)
CopySource	string(2000)
NeedsRetesting	boolean
RetestingReason	string(2000)
DownloadedFromObjectId	string(2000)
cql	string(2000+)	Check Logic
description	string(2000+)	HTML formatted description of the Check generated from the Check Steps and Check Actions.
text_description	string(2000+)	Text formatted description of the Check generated from the Check Steps and Check Actions.
quickedit	string(2000+)	The quickedit representation of steps without the actions or the CheckName / CheckActive / BypassDuringMigration attributes
full_quickedit	string(2000+)	The quickedit representation of steps, actions and the CheckName / CheckActive / BypassDuringMigration attributes as you see in Medidata Rave
has_error	integer	0 = No Errors, 1 = No Steps, 2 = Syntax Error, 3 = No Actions, 4 = Missing Objects (see below)
missing_folders	List of string(2000). May be None.	Missing Folders
missing_forms	List of string(2000). May be None.	Missing Forms
missing_fields	List of string(2000). May be None.	Missing Fields
missing_variables	List of string(2000). May be None.	Missing Variables
missing_customfunctions	List of string(2000). May be None.	Missing Custom Functions
fingerprint	string(40)	Fingerprint Hash. See Fingerprints.
copied_from	Edit Check reference. May be None.	Copied from
standard_library	CRF Draft reference. May be None.	Standard Library
standard_match_identifier	string(2000). May be None.	Standard Match Identifier
compliance_state	string(2). May be None.	Compliance state. 0 = Not Applicable / No Information Set, 1 = Calculating, 2 = Not Found, 3 = Different, 4 = Allowed Change, 5 = Match
compliance_object	Edit Check reference. May be None.	Compliance object
als_checksteps_set	Object Manager. Set of related Edit Check Steps
als_checkactions_set	Object Manager. Set of related Edit Check Actions
labels	Object Manager. Set of related Object Labels	Set of related Object Labels. See Labels.
properties	Ordered dictionary of custom property definition and values.	See Custom Properties (Metadata).

Edit Check Step

Name	Type	Description
id	integer
CRFDraft	CRF Draft reference
Check	Edit Check reference. May be None.
StepOrdinal	integer. May be None.
CheckFunction	string(2000)
StaticValue	string(2000)
DataFormat	string(2000)
VariableOID	string(2000)
Folder	Folder reference. May be None.
Form	Form reference. May be None.
Field	Field reference. May be None.
RecordPosition	integer. May be None.
CustomFunction	Custom Function reference. May be None.
LogicalRecordPosition	string(2000)
Scope	string(2000)
OrderBy	string(2000)
FormRepeatNumber	integer. May be None.
FolderRepeatNumber	integer. May be None.

Edit Check Action

Name	Type	Description
id	integer
CRFDraft	CRF Draft reference
Check	Edit Check reference. May be None.
Folder	Folder reference. May be None.
Form	Form reference. May be None.
Field	Field reference. May be None.
VariableOID	string(2000)
RecordPosition	integer. May be None.
PageRepeatNumber	integer. May be None.
InstanceRepeatNumber	integer. May be None.
LogicalRecordPosition	string(2000)
Scope	string(2000)
OrderBy	string(2000)
ActionType	string(27)
ActionString	string(2000)
ActionOptions	string(2000)
ActionScript	string(2000)
cql	string(2000+)	Action Target
missing_folders	List of string(2000). May be None.	Missing Folders
missing_forms	List of string(2000). May be None.	Missing Forms
missing_fields	List of string(2000). May be None.	Missing Fields
missing_variables	List of string(2000). May be None.	Missing Variables
missing_customfunctions	List of string(2000). May be None.	Missing Custom Functions
fingerprint	string(40)	Fingerprint Hash. See Fingerprints.

Form

Name	Type	Description
id	integer
last_updated_by	User reference. May be None.	last updated by
last_updated	datetime in UTC timezone. May be None.	last updated
CRFDraft	CRF Draft reference
OID	string(2000)
Ordinal	integer. May be None.
DraftFormName	string(2000)	Name
DraftFormActive	boolean	Active
HelpText	string(4000)
IsTemplate	boolean
IsSignatureRequired	boolean
IsEproForm	boolean
ViewRestrictions	List of string(2000). May be None.
EntryRestrictions	List of string(2000). May be None.
LogDirection	string(2000)
DDEOption	string(2000)
ConfirmationStyle	string(2000)
LinkFolder	Folder reference. May be None.
LinkForm	Form reference. May be None.
fingerprint	string(40)	Fingerprint Hash. See Fingerprints.
copied_from	Form reference. May be None.	Copied from
standard_library	CRF Draft reference. May be None.	Standard Library
standard_match_identifier	string(2000). May be None.	Standard Match Identifier
compliance_state	string(2). May be None.	Compliance state. 0 = Not Applicable / No Information Set, 1 = Calculating, 2 = Not Found, 3 = Different, 4 = Allowed Change, 5 = Match
compliance_object	Form reference. May be None.	Compliance object
allow_deletes	boolean	Allow Fields to be deleted
allow_inserts	boolean	Allow Fields to be added
allowed_changes	List of string(4000). May be None.	Allowed changes
als_crfdraft_set	Object Manager. Set of related Form
als_forms_set	Object Manager. Set of related Forms
als_fields_set	Object Manager. Set of related Fields
als_checksteps_set	Object Manager. Set of related Check Steps
als_checkactions_set	Object Manager. Set of related Check Actions
als_derivations_set	Object Manager. Set of related Derivations
als_derivationsteps_set	Object Manager. Set of related Derivation Steps
als_labvariablemappings_set	Object Manager. Set of related Lab Variable Mappings
als_coderconfiguration_set	Object Manager. Set of related Coder Configurations
als_codersupplementalterms_set	Object Manager. Set of related Coder Supplemental Terms
als_codercomponentterms_set	Object Manager. Set of related Coder Component Terms
als_matrixfolders_set	Object Manager. Set of related Matrix Folders
labels	Object Manager. Set of related Object Labels	Set of related Object Labels. See Labels.
properties	Ordered dictionary of custom property definition and values.	See Custom Properties (Metadata).
has_log_fields()	boolean method	Returns True if the Form has log fields (including inactive ones), False otherwise.

Field

Name	Type	Description
id	integer
last_updated_by	User reference. May be None.	last updated by
last_updated	datetime in UTC timezone. May be None.	last updated
CRFDraft	CRF Draft reference
Form	Form reference. May be None.
FieldOID	string(2000)
Ordinal	integer. May be None.
DraftFieldNumber	string(50)	Number
DraftFieldName	string(2000)	Name
DraftFieldActive	boolean	Active
VariableOID	string(50)
DataFormat	string(50)
DataDictionary	Data Dictionary reference. May be None.
UnitDictionary	Unit Dictionary reference. May be None.
CodingDictionary	string(2000)
ControlType	string(2000)
AcceptableFileExtensions	string(256)
IndentLevel	integer. May be None.
PreText	string(4000)	The question text or question label.
FixedUnit	string(200)
HeaderText	string(200)
HelpText	string(4000)
SourceDocument	boolean	SDV
IsLog	boolean	Log
data_type	string	Returns the data type for a field based on its dataformat. Possible values are: integer, float, text, time, partialTime, date, partialDate, datetime, partialDateTime
DefaultValue	string(500)
SASLabel	string(256)
SASFormat	string(25)
EproFormat	string(2000)
IsRequired	boolean	Required
QueryFutureDate	boolean
IsVisible	boolean	Visible
IsTranslationRequired	boolean	Translation Required
AnalyteName	string(2000)
IsClinicalSignificance	boolean	Clinical Significance
QueryNonConformance	boolean
OtherVisits	boolean
CanSetRecordDate	boolean	Set Record Date
CanSetDataPageDate	boolean	Set DataPage Date
CanSetInstanceDate	boolean	Set Instance Date
CanSetSubjectDate	boolean	Set Subject Date
DoesNotBreakSignature	boolean	Does Not Participate in Signature
LowerRange	string(10)
UpperRange	string(10)
NCLowerRange	string(10)	Non Conformance Lower Range
NCUpperRange	string(10)	Non Conformance Upper Range
ViewRestrictions	List of string(2000). May be None.
EntryRestrictions	List of string(2000). May be None.
ReviewGroups	List of string(2000). May be None.
IsVisualVerify	boolean	Visual Verify
fingerprint	string(40)	Fingerprint Hash. See Fingerprints.
copied_from	Field reference. May be None.	Copied from
std_required	boolean	Required by Standards
allowed_changes	List of string(4000). May be None.	Allowed Changes
als_checksteps_set	Object Manager. Set of related Check Steps
als_checkactions_set	Object Manager. Set of related Check Actions
als_derivations_set	Object Manager. Set of related Derivations
als_derivationsteps_set	Object Manager. Set of related Derivation Steps
als_labvariablemappings_set	Object Manager. Set of related Lab Variable Mappings
als_coderconfiguration_set	Object Manager. Set of related Coder Configurations
als_codersupplementalterms_set	Object Manager. Set of related Coder Supplemental Terms
als_codercomponentterms_set	Object Manager. Set of related Coder Component Terms
properties	Ordered dictionary of custom property definition and values.	See Custom Properties (Metadata).

Folder

Name	Type	Description
id	integer
last_updated_by	User reference. May be None.	last updated by
last_updated	datetime in UTC timezone. May be None.	last updated
CRFDraft	CRF Draft reference
OID	string(2000)
Ordinal	integer. May be None.
FolderName	string(2000)	Name
AccessDays	integer. May be None.
StartWinDays	integer. May be None.	Start Window Days
Targetdays	integer. May be None.
EndWinDays	integer. May be None.	End Window Days
OverDueDays	integer. May be None.
CloseDays	integer. May be None.
ParentFolder	Folder reference. May be None.
IsReusable	boolean
fingerprint	string(40)	Fingerprint Hash. See Fingerprints.
copied_from	Folder reference. May be None.	Copied from
standard_library	CRF Draft reference. May be None.	Standard Library
standard_match_identifier	string(2000). May be None.	Standard Match Identifier
compliance_state	string(2). May be None.	Compliance state. 0 = Not Applicable / No Information Set, 1 = Calculating, 2 = Not Found, 3 = Different, 4 = Allowed Change, 5 = Match
compliance_object	Folder reference. May be None.	Compliance object
als_forms_set	Object Manager. Set of related Forms
als_folders_set	Object Manager. Set of related Folder
als_checksteps_set	Object Manager. Set of related Check Steps
als_checkactions_set	Object Manager. Set of related Check Actions
als_derivations_set	Object Manager. Set of related Derivations
als_derivationsteps_set	Object Manager. Set of related Derivation Steps
als_labvariablemappings_set	Object Manager. Set of related Lab Variable Mappings
als_matrixfolders_set	Object Manager. Set of related Matrix Folders
labels	Object Manager. Set of related Object Labels	Set of related Object Labels. See Labels.
properties	Ordered dictionary of custom property definition and values.	See Custom Properties (Metadata).

Lab Variable Mapping

Name	Type	Description
id	integer
last_updated_by	User reference. May be None.	last updated by
last_updated	datetime in UTC timezone. May be None.	last updated
CRFDraft	CRF Draft reference
GlobalVariableOID	string(2000)
Form	Form reference. May be None.
Field	Field reference. May be None.
Folder	Folder reference. May be None.
LocationMethod	string(2000)

Matrix

Name	Type	Description
id	integer
last_updated_by	User reference. May be None.	last updated by
last_updated	datetime in UTC timezone. May be None.	last updated
CRFDraft	CRF Draft reference
MatrixName	string(2000)
OID	string(2000)
Addable	boolean
Maximum	integer
fingerprint	string(40)	Fingerprint Hash. See Fingerprints.
copied_from	Matrix reference. May be None.	Copied from
color	string(2000+)	Matrix Color
als_matrixfolders_set	Object Manager. Set of related Matrix Folders
labels	Object Manager. Set of related Object Labels	Set of related Object Labels. See Labels.
properties	Ordered dictionary of custom property definition and values.	See Custom Properties (Metadata).

Matrix Folder

Name	Type	Description
id	integer
last_updated_by	User reference. May be None.	last updated by
last_updated	datetime in UTC timezone. May be None.	last updated
CRFDraft	CRF Draft reference
Matrix	Matrix reference. May be None.
Folder	Folder reference. May be None.
Form	Form reference. May be None.
fingerprint	string(40)	Fingerprint Hash. See Fingerprints.

Test Case

Name	Type	Description
id	integer
CRFDraft	CRF Draft reference
name	string(2000)	Test Case Name
created	datetime
last_updated	datetime	last updated
last_updated_by	User reference. May be None.	last updated by
valid	boolean	Is test case valid?
content	string(2000+)	Test Content
parsed_md5	md5 hash of the test case content
copied_from	Test Case reference. May be None.	Copied from
standard_library	CRF Draft reference. May be None.	Standard Library
standard_match_identifier	string(2000). May be None.	Standard Match Identifier
compliance_state	string(2). May be None.	Compliance state. 0 = Not Applicable / No Information Set, 1 = Calculating, 2 = Not Found, 3 = Different, 4 = Allowed Change, 5 = Match
compliance_object	Test Case reference. May be None.	Compliance object
scenarios	integer	Number of scenarios
fingerprint	string(40)	Fingerprint Hash. See Fingerprints.
roles	List of string(200). May be None.	List of EDC Roles referenced in this Test Case.
testcaserelatedobject_set	Object Manager. Set of related test case objects such as Forms, Edit Checks etc.
labels	Object Manager. Set of related Object Labels	Set of related Object Labels. See Labels.
get_simple_diff()	List of changes to this Test Case.	Function returning a list of changes made to this Test Case, including before/after comparison of the Test Case content last_updated_by_id integer Id of the user who made the change last_updated_by_email string Email address of the user who made the change last_updated datetime When the change was made changes List of before/after changes Each change in the list will be a tuple of lines changed: (lines_before, lines_after), e.g. [(['Feature One', 'Scenario One'], ['Feature 1', 'Scenario 1'])]

Unit Dictionary

Name	Type	Description
id	integer
last_updated_by	User reference. May be None.	last updated by
last_updated	datetime in UTC timezone. May be None.	last updated
CRFDraft	CRF Draft reference
UnitDictionaryName	string(2000)	Name
StandardUnitName	string(2000)
DownloadedFromObjectId	string(2000)
fingerprint	string(40)	Fingerprint Hash. See Fingerprints.
copied_from	Unit Dictionary reference. May be None.	Copied from
standard_library	CRF Draft reference. May be None.	Standard Library
standard_match_identifier	string(2000). May be None.	Standard Match Identifier
compliance_state	string(2). May be None.	Compliance state. 0 = Not Applicable / No Information Set, 1 = Calculating, 2 = Not Found, 3 = Different, 4 = Allowed Change, 5 = Match
compliance_object	Unit Dictionary reference. May be None.	Compliance object
als_fields_set	Object Manager. Set of related Fields
als_unitdictionaryentries_set	Object Manager. Set of related Unit Dictionary Entries
labels	Object Manager. Set of related Object Labels	Set of related Object Labels. See Labels.
properties	Ordered dictionary of custom property definition and values.	See Custom Properties (Metadata).

Unit Dictionary Entry

Name	Type	Description
id	integer
last_updated_by	User reference. May be None.	last updated by
last_updated	datetime in UTC timezone. May be None.	last updated
CRFDraft	CRF Draft reference
UnitDictionary	Unit Dictionary reference. May be None.
CodedUnit	string(2000)
Ordinal	integer. May be None.
ConstantA	float. May be None.
ConstantB	float. May be None.
ConstantC	float. May be None.
ConstantK	float. May be None.
UnitString	string(2000)
fingerprint	string(40)	Fingerprint Hash. See Fingerprints.

Draft Rule

Name	Type	Description
id	integer
CRFDraft	CRF Draft reference	Draft Rule is used in
rule	Rule reference

Rule

Name	Type	Description
id	integer
CRFDraft	CRF Draft reference	Draft Rule is created in
rule_id	string(100). May be None.	Rule identifier
logic	string(2000+)	Logical expression
rule_type_id	integer	Rule Type
object_type_id	integer	Object Type
object_identifier	string(2000)	Object identifier
value_attribute_name	string(200)	Attribute identifier for Value Rules
value_attribute_value	string(8000)	Attribute value for Value Rules
priority	integer
active	boolean	Rule active?
description	string(2000+)	Description of the rule
last_updated_by	User reference. May be None.	last updated by
last_updated	datetime in UTC timezone. May be None.	last updated
properties_referenced	List of string(2000). May be None.	Names of Project Properties referenced
draftrule_set	Object Manager. Set of related Activated Rules	Set of DraftRules in Drafts which make use of this Library Draft and which have this rule Activated.

Object Label

An object label is a join between an Object and a Label. In practice this means you will access labels for an object, fetching the name of the label from the associated label object:

{% for object_label in form.labels.all() %}
   {{ object_label.label.name }}
{% endfor %}

See Accessing Labels for more information.

Name	Type	Description
id	integer
label	Label reference. May be None.
assigned_by	User reference. May be None.	assigned by
assigned_on	datetime	assigned on
draft	CRF Draft reference. May be None.
content_object	Object reference	The object to which this label is attached (e.g. Form, Folder etc)
object_id	integer. May be None.	The ID of the object to which this label is attached
content_type_id	integer. May be None.	An ID representing the unique type of the Object referenced by the object_id

Label

A definition of a label in a URL. Objects may be labelled with ObjectLabels which point to this Label definition.

Name	Type	Description
id	integer
rave_url	RaveURL reference	rave url
name	string(100)	Label Name
description	string(2000+). May be None.
color	string(2000+)	Hex color code for label including #
objectlabel_set	Object Manager. Set of related ObjectLabels	The set of all ObjectLabels which use this Label. This is a way of discovering all objects which have this label.

Comment

One or more comments may be associated with any Draft object.

Name	Type	Description
id	integer
created_by	User reference	created by
created	datetime
body	string(2000+). May be None.	Comment
deleted	boolean
draft	CRF Draft reference. May be None.
content_object	Object reference	The object to which this comment is attached (e.g. Form, Folder etc)
object_id	integer. May be None.	The ID of the object to which this comment is attached
content_type_id	integer. May be None.	An ID representing the unique type of the Object referenced by the object_id

PropertyDefinition

Name	Type	Description
id	integer
rave_url	RaveURL reference	rave url
content_type_id	integer	An integer ID which identifies the type of object (Form, Folder etc)
name	string(100)
description	string(2000+). May be None.
value_type	string(20)	Value type
value_choices	List of string(2000). May be None.	Value choices
display_order	integer	Display order
show_in_lists	boolean	Show Property in Object List?
objectproperty_set	Object Manager. Set of related PropertyDefinitions	Provides access to all objects which have this property set on them

Custom Property

A custom property (metadata) value for an object.

Name	Type	Description
id	integer
property	PropertyDefinition reference
value	string(2000+)
draft	CRF Draft reference. May be None.
content_object	Object reference	The object to which this custom property is attached (e.g. Form, Folder etc)
object_id	integer. May be None.	The ID of the object to which this custom property is attached
content_type_id	integer. May be None.	An ID representing the unique type of the Object referenced by the object_id

ActivityRecord

An ActivityRecord represents an audit trail record for an object.

Name	Type	Description
id	integer
organization	Organization reference. May be None.
rave_url	RaveURL reference. May be None.	rave url
project	Project reference. May be None.
draft	CRF Draft reference. May be None.
action	string(1)	Action type (C)reate / U(pdate) / D(delete)
description	string(2000+)	Description of the change
when	datetime	A datetime in UTC timezone when this action was performed
who	User reference	A reference to the user who performed this action
content_type_id	integer. May be None.	An ID representing the unique type of the Object referenced by the object_id
object_id	integer. May be None.	object id