Static Field Glossary
"Static" fields are record data that every Case IQ application captures. Some static fields are automatically populated by the system, such as the “Created Date” field, or log user input on the record form, like the "Assign Reason" or "Description" fields. They are essential for your application to function properly, so you cannot remove or configure static fields on your forms. However, you can add and configure "dynamic" fields on your forms via the Form Builder (see Use the Form Builder).
Case Fields
| Static Field | Field Description | Data Type | Field Name Tag |
|---|---|---|---|
| Assign Reason | The reason provided when a user is assigned as a case's owner. | Text | reassignReason |
| Assigned By | The user who assigned the case's owner. If the case was assigned as a result of a rule action, the "Assigned By" field will be "System". Learn more about using this field in Using User Fields in Expressions and Templates. | User | assignedBy: the user profile's ID. |
| assignedBy__name: the user profile's name as text. | |||
| assignedBy__active: whether the user profile is active. | |||
| assignedBy__email: the user profile's email address. | |||
| Canceled | Indicates whether the case has been cancelled. | Boolean | canceled |
| Case Cancel Date | The date and time a case was cancelled. | Date and Time | cancelDate |
| Case Cancel Reason | The reason provided by the user that cancelled the case. | Text | cancelReason |
| Case Number | An arbitrary identification number assigned to the case by the system. | ID | caseNumber |
| Case Owner | The user assigned responsibility of the case. Learn more about using this field in Using User Fields in Expressions and Templates. | User | owner: the user profile's ID. |
| owner__name: the user profile's name as text. | |||
| owner__active: whether the user profile is active. | |||
| owner__email: the user profile's email address. | |||
| Case Restore Reason | The reason provided by the user that restored the cancelled case. | Picklist | restoreReason |
| Case State | Indicates if the case is open or closed depending on its workflows. If a case has more than 1 workflow, the case state will be closed when the last workflow is moved to a “closed” status. | Picklist | caseState |
| Case Summary | The summary of a case's proceedings generated by Case IQ's AI Summarization Copilot. | Text | caseSummary |
| Case Type | The category of the case based on the issue, concern, or incident described in the case record. | Picklist | caseType |
| Closed Calendar Month | The calendar month in which the case was closed as a number, e.g. 1 = January and 10 = October. | Number | closedCalendarMonth |
| Closed Calendar Quarter | The calendar quarter in which the case was closed as a number, e.g. 3 = the third quarter of the year. | Number | closedCalendarQuarter |
| Closed Calendar Week | The calendar week in which the case was closed as a number, e.g. the week of August 15, 2022, would be 34. A week begins on Sunday. | Number | closedCalendarWeek |
| Closed Calendar Year | The calendar year in which the case was closed. | Number | closedCalendarYear |
| Closed Fiscal Month | The fiscal month in which the case was closed as a number as the month's numerical order on your organization's fiscal calendar. For example, if your company's fiscal year starts on April 1, October would be 7. | Number | closedFiscalMonth |
| Closed Fiscal Quarter | The fiscal quarter in which the case was closed as the quarter's numerical order on your organization's fiscal calendar. For example, if your company's fiscal year starts on April 1, October would be in fiscal quarter 3. | Number | closedFiscalQuarter |
| Closed Fiscal Week | The fiscal week in which the case was closed as the week's numerical order on your organization's fiscal calendar. For example, if your company's fiscal year starts on April 1, April 13, 2022, would be fiscal week 2. A week begins on Sunday. | Number | closedFiscalWeek |
| Closed Fiscal Year | The fiscal year in which the case was closed. For example, if your company's fiscal year starts on April 1, February 2023 would be "fiscal year 2022". | Number | closedFiscalYear |
| Confidential | Indicates whether a case has been set to "Confidential", meaning that it can only be viewed by users who have permissions to access confidential cases. | Boolean | confidential |
| Created By | The user that added the case to your Case IQ application. This means that they submitted the New Case form, sent an email that triggered a New Case Creation rule, or filed their concern via the online portal. Learn more about using this field in Using User Fields in Expressions and Templates. | User | createdBy: the user profile's ID. |
| createdBy__name: the user profile's name as text. | |||
| createdBy__active: whether the user profile is active. | |||
| createdBy__email: the user profile's email address. | |||
| Created Calendar Month | The calendar month in which the case was created as a number, e.g. 1 = January and 10 = October. | Number | createdCalendarMonth |
| Created Calendar Quarter | The calendar quarter in which the case was created as a number, e.g. 3 = the third quarter of the year. | Number | createdCalendarQuarter |
| Created Calendar Week | The calendar week in which the case was created as a number, e.g. the week of August 15, 2022, would be 34. A week begins on Sunday. | Number | createdCalendarWeek |
| Created Calendar Year | The calendar year in which the case was created. | Number | createdCalendarYear |
| Created Date | The date and time a case draft was saved, which is generally when a user adds the case to your application. See When Was My Case Created? for details. | Date and Time | createdDate |
| Created Fiscal Month | The fiscal month in which the case was created as a number. For example, if your company's fiscal year starts on April 1, October would be 7. | Number | createdFiscalMonth |
| Created Fiscal Quarter | The fiscal quarter in which the case was created as a number. For example, if your company's fiscal year starts on April 1, October would be in fiscal quarter 3. | Number | createdFiscalQuarter |
| Created Fiscal Week | The fiscal week in which the case was created as a number. For example, if your company's fiscal year starts on April 1, April 13, 2022, would be fiscal week 2. A week begins on Sunday. | Number | createdFiscalWeek |
| Created Fiscal Year | The fiscal year in which the case was created. For example, if your company's fiscal year starts on April 1, February 2023 would be "fiscal year 2022". | Number | createdFiscalYear |
| Date Assigned | The date and time the case's owner was assigned. | Date and Time | dateAssigned |
| Date Closed | The date and time a case was closed. | Date and Time | dateClosed |
| Date Purged | The date and time a case was purged. | Date and Time | datePurged |
| Date Recorded | The date and time a case was initially saved and the system assigned it a case number. See When Was My Case Created? for details. | Date and Time | dateRecorded |
| Date Submitted | The date and time a case was initially submitted. See When Was My Case Created? for details. | Date and Time | dateSubmitted |
| Do Not Purge | Indicates whether a case has been set to "Do Not Purge", or if the case can be deleted in record purges. | Boolean | excludeFromPurge |
| Exclude From Suggest Links | Indicates if your application will search the case for similar values when suggesting related cases. | Boolean | excludeFromSuggestedLinks |
| External | Indicates whether a case was submitted via the application's portal. | Boolean | externalRecord |
| Intake Method | The channel by which a case was submitted, i.e. capture, email, portal, and hotline. | Picklist | intakeMethod |
| Investigative Team Members | The users on the case's Investigative Team. | User Multiple | investigativeTeamMembers |
| Last Flag Set | The name of the flag most recently set to the case. | flagName | lastFlagSet |
| Last Flag Set By | The user who set the most recent flag for the case. Learn more about using this field in Using User Fields in Expressions and Templates. | User | lastFlagSetBy: the user profile's ID. |
| lastFlagSetBy__name: the user profile's name as text. | |||
| lastFlagSetBy__active: whether the user profile is active. | |||
| lastFlagSetBy__email: the user profile's email address. | |||
| Last Flag Set Date | The date and time the most recent flag was set for the case. | Date and Time | lastFlagSetDate |
| Last Flag Set Name | The name of the most recent flag set to the case. | Text | lastFlagSetName |
| Last Snapshot Generation Date | The date and time the system most recently took a snapshot of the case to generate suggested case links. | Date and Time | lastSnapshotGenerationDate |
| Last Updated By | The user who most recently updated the case. Learn more about using this field in Using User Fields in Expressions and Templates. | User | lastUpdatedBy: the user profile's ID. |
| lastUpdatedBy__name: the user profile's name as text. | |||
| lastUpdatedBy__active: whether the user profile is active. | |||
| lastUpdatedBy__email: the user profile's email address. | |||
| Last Updated Date | The date and time the case was most recently updated. | Date and Time | lastUpdatedDate |
| Last Workflow | The workflow which most recently progressed for the case, i.e. the workflow that a user most recently moved to its next step. | Text | lastWorkflowId |
| Last Workflow Status | The status of the workflow that was most recently moved to its next step. | Status ID | lastWorkflowStateId |
| Last Workflow Step By | The user who progressed the most recent workflow to its next step. Learn more about using this field in Using User Fields in Expressions and Templates. | User | lastWorkflowTransitionBy: the user profile's ID. |
| lastWorkflowTransitionBy__name: the user profile's name as text. | |||
| lastWorkflowTransitionBy__active: whether the user profile is active. | |||
| lastWorkflowTransitionBy__email: the user profile's email address. | |||
| Last Workflow Step Date | The date and time the most recent workflow was progressed to its next step. | Date and Time | lastWorkflowTransitionDate |
| Last Workflow Step Reason | The reason provided when a user most recently moved a workflow to its next step. | Picklist | lastWorkflowTransitionReason |
| Open Business Days | The number of weekdays the case has been open, excluding weekends and holidays. | Number | openBusinessDays |
| Open Calendar Days | The total number of days a case has been open, including weekends and holidays. | Number | openCalendarDays |
| Pending Access Requests | Indicates whether there are pending access requests to join a case's investigative team. | Boolean | pendingAccessRequests |
| Pending Purge Date | The date and time the case has been scheduled to be purged. | Date and Time | pendingPurgeDate |
| Primary Party | The party set as primary for the case. | Primary Party | primaryPartyId. This will appear as an unformatted alphanumeric ID when populated in a text field (e.g. b6a6cdf6-cfa5-4e8e-95eb-161cc61ab5a0). When writing an ISEL expression including primaryPartyId, make sure the computed field is a party selection field so the system uses the primary party's name. |
| Purge Reason | The reason provided when a case was scheduled to be purged. | Picklist | purgeReason |
| Record Source | The method by which the case was added to the system, i.e. web, external, or email. | Picklist | recordSource |
| Reported Anonymously | Indicates whether the case's reporter chose to remain anonymous when submitting the case via the application's portal. | Boolean | reportedAnonymously |
| Reported By | The name of the individual who reported the case. | Text | reportedBy |
| Reporter Access | Indicates whether the case's reporter can access the case via your application's portal. | Boolean | reporterAccess |
| Source Job | The name of the integration log that created the case. | ID | sourceJob |
| Submitted Language | The language of the user who submitted the case. For internal users, the "Submitted Language" will be the language in their user profile at the time they added the case. For external users, the "Submitted Language" will be the language they had selected on the portal when they submitted the case. | Text | submittedLanguage |
| System Processing | Indicates if the case is currently being used in a process. | Boolean | sysProcessing |
| Terms and Conditions | Indicates whether the case's reporter accepted the portal's terms and conditions before submitting the case. | Boolean | acceptTermsAndConditions |
| Total Business Days | The total number of business days since a case was created, including days the case was closed but excluding holidays and weekends. This will only be calculated when the case is closed. | Integer | totalBusinessDays |
| Total Calendar Days | The total number of days since a case was created, including weekends, holidays, and days the case was closed. This will only be calculated when the case is closed. | Integer | totalCalendarDays |
| Translation Status | Indicates whether Case IQ's AI Translation Copilot has completed translating the case, i.e. Pending Translation, Translation Complete, or Translation Failed. | Picklist | intakeTranslationStatus |
| Update Intake Method | Indicates if the case has been updated as part of a data import. | Picklist | updateIntakeMethod |
| Update Record Source | Indicates if the case has been updated as part of a data import. |
Picklist | updateRecordSource |
| User Access Denied | The users on the case's Denied Access List. | User Multiple | userBlacklist |
| Workflow Statuses | The current status of all workflows applicable to the case, presented as a list. | Text | workflowStatuses |
| [Workflow]* | The current status of the workflow for the case. | Workflow Status | [workflowName]. E.g. for a workflow named "General Investigation", the tag would be "generalInvestigation". |
| [Workflow]* Date | The date and time the workflow entered the current status. | Date and Time | [workflowName]Date. E.g. for a workflow named "General Investigation", the tag would be "generalInvestigationDate". |
| [Workflow]* Reason | The reason provided when a user set the workflow to its current status. | Text | [workflowName]Reason. E.g. for a workflow named "General Investigation", the tag would be "generalInvestigationReason". |
| [Workflow]* Set By | The user who set the current status of the workflow for the case. Learn more about using this field in Using User Fields in Expressions and Templates. | User | [workflowName]SetBy: the user profile's ID. |
| [workflowName]SetBy__name: the user profile's name as text. | |||
| [workflowName]SetBy__active: whether the user profile is active. | |||
| [workflowName]SetBy__email: the user profile's email address. |
*The name of a workflow in your application will be in place of "[workflowName]" for each field. Each workflow will have its own status, date, reason and set by fields.
DeleteProfile Fields
| Static Field | Field Description | Data Type | Field Name Tag |
|---|---|---|---|
| Address | The address of the profile provided by a user. | Text | address |
| City | The city of the profile provided by a user. | Text | city |
| Country | The country of the profile provided by a user. | Picklist | country |
| Created By | The user that added the profile to the Case IQ application by submitting the New Profile form. Learn more about using this field in Using User Fields in Expressions and Templates. | User | createdBy: the user profile's ID. |
| createdBy__name: the user profile's name as text. | |||
| createdBy__active: whether the user profile is active. | |||
| createdBy__email: the user profile's email address. | |||
| Created Date | The date and time a profile was created. | Date and Time | createdDate |
| Date of Birth | The date of birth of the profile provided by a user. | Date | dateOfBirth |
| Date Purged | The date and time a profile was purged. | Date and Time | datePurged |
| Date Submitted | The date a profile was submitted. | Date and Time | dateSubmitted |
| Deleted By | The user that deleted the profile in Case IQ. Learn more about using this field in Using User Fields in Expressions and Templates. | User | deletedBy: the user profile's ID. |
| deletedBy__name: the user profile's name as text. | |||
| deletedBy__active: whether the user profile is active. | |||
| deletedBy__email: the user profile's email address. | |||
| Deleted Date | The date and time a profile was deleted. | Date and Time | deletedDate |
| Do Not Purge | Indicates whether a profile has been set to "Do Not Purge", or if the profile can be deleted in record purges. | Boolean | excludeFromPurge |
| Email Address | The email address of the profile provided by a user. | emailAddress | |
| Exclude From Suggest Links | Indicates if your application will search the profile record for similar values when suggesting related cases. | Boolean | excludeFromSuggestedLinks |
| First Name | The first name of the profile provided by a user. | Text | firstName |
| Home Phone # | The home phone number of the profile provided by a user. | Phone Number | homePhone |
| Last Name | The last name of the profile provided by a user. | Text | lastName |
| Last Snapshot Generation Date | The date and time the system most recently took a snapshot of the profile to generate suggested case links. | Date and Time | lastSnapshotGenerationDate |
| Last Updated By | The user who most recently updated the profile. Learn more about using this field in Using User Fields in Expressions and Templates. | User | lastUpdatedBy: the user profile's ID. |
| lastUpdatedBy__name: the user profile's name as text. | |||
| lastUpdatedBy__active: whether the user profile is active. | |||
| lastUpdatedBy__email: the user profile's email address. | |||
| Last Updated Date | The date and time the profile was most recently updated. | Date and Time | lastUpdatedDate |
| Middle Initial | The middle initial of the profile provided by a user. | Text | middleInitial |
| Name | The first and last name of the profile. The system automatically concatenates the text in the profile's “First Name” and “Last Name” fields. | Text | personName |
| Pending Purge Date | The date and time the profile has been scheduled to be purged. | Date and Time | pendingPurgeDate |
| Profile Picture | The image file uploaded to the profile by a user. | Image | picture |
| Purge Reason | The reason provided when a profile was scheduled to be purged. | Picklist | purgeReason |
| Record Source | The method by which the profile was added to the system, i.e. web, external, or email. | Picklist | recordSource |
| Source Job | The name of integration log that created the profile. | ID | sourceJob |
| State / Province | The state or province of the profile provided by a user. | Picklist | stateProvince |
| System Processing | Indicates if the profile record is currently being used in a process. | Boolean | sysProcessing |
| Work Phone # | The work phone number of the profile provided by a user. | Phone Number | workPhone |
| Zip Code / Postal Code | The zip or postal code of the profile provided by a user. | Text | zipCodePostalCode |
To-Do Fields
| Static Field | Field Description | Data Type | Field Name Tag |
|---|---|---|---|
| # | The number generated to identify the to-do for the case. | ID | number |
| Assigned By | The user who assigned the to-do's owner. Learn more about using this field in Using User Fields in Expressions and Templates. | User | assignedBy: the user profile's ID. |
| assignedBy__name: the user profile's name as text. | |||
| assignedBy__active: whether the user profile is active. | |||
| assignedBy__email: the user profile's email address. | |||
| Case | The case number for the to-do's case. | Case | caseId |
| Closed by | The user who marked the to-do as complete. Learn more about using this field in Using User Fields in Expressions and Templates. | User | closedBy: the user profile's ID. |
| closedBy__name: the user profile's name as text. | |||
| closedBy__active: whether the user profile is active. | |||
| closedBy__email: the user profile's email address. | |||
| Created By | The user that added the to-do to the Case IQ application by submitting the New To-Do form. Learn more about using this field in Using User Fields in Expressions and Templates. | User | createdBy: the user profile's ID. |
| createdBy__name: the user profile's name as text. | |||
| createdBy__active: whether the user profile is active. | |||
| createdBy__email: the user profile's email address. | |||
| Created Date | The date and time a to-do was created. | Date and Time | createdDate |
| Date Completed | The date and time a user marked a to-do as complete. | Date and Time | dateCompleted |
| Date Purged | The date and time a to-do was purged. | Date and Time | datePurged |
| Date Submitted | The date a to-do was submitted. | Date and Time | dateSubmitted |
| Deleted By | The user that deleted the to-do in Case IQ. Learn more about using this field in Using User Fields in Expressions and Templates. | User | deletedBy: the user profile's ID. |
| deletedBy__name: the user profile's name as text. | |||
| deletedBy__active: whether the user profile is active. | |||
| deletedBy__email: the user profile's email address. | |||
| Deleted Date | The date and time a to-do was deleted. | Date and Time | deletedDate |
| Details | The description of the to-do provided by a user. | Text | details |
| Do Not Purge | Indicates whether a to-do's case has been set to “Do Not Purge” or if the case can be deleted in record purges. | Boolean | excludeFromPurge |
| Due Date | The date provided by a user that the to-do task should be completed. | Date | due |
| Email Reminder | The number of days before the due date that the responsible user will receive an email reminder from Case IQ. | Number Range Picklist | emailReminder |
| Exclude from Suggested Links | Indicates if your application will search the to-do record for similar values when suggesting related cases. | Boolean | excludeFromSuggestedLinks |
| Item Number | The full identification number of the to-do, which includes the to-do's case number followed by its own number, e.g. "2040-005 / 2". | ID | childNumber |
| Last Updated By | The user who most recently updated the to-do. Learn more about using this field in Using User Fields in Expressions and Templates. | User | lastUpdatedBy: the user profile's ID. |
| lastUpdatedBy__name: the user profile's name as text. | |||
| lastUpdatedBy__active: whether the user profile is active. | |||
| lastUpdatedBy__email: the user profile's email address. | |||
| Last Updated Date | The date and time the to-do was most recently updated. | Date and Time | lastUpdatedDate |
| Pending Purge Date | The date and time a to-do has been scheduled to be purged. | Date and Time | pendingPurgeDate |
| Purge Reason | The reason provided when a to-do was scheduled to be purged. | Picklist | purgeReason |
| Record Source | The method by which the to-do was added to the system, i.e. web, external, or email. | Picklist | recordSource |
| Responsible | The user assigned responsibility of the to-do. Learn more about using this field in Using User Fields in Expressions and Templates. | User | responsible: the user profile's ID. |
| responsible__name: the user profile's name as text. | |||
| responsible__active: whether the user profile is active. | |||
| responsible__email: the user profile's email address. | |||
| Source Job | The name of integration log that created the to-do. | ID | sourceJob |
| Status | A flag indicating the status value or stage in the task process of the to-do. | Picklist | status |
| System Processing | Indicates if the to-do record is currently being used in a process. | Boolean | sysProcessing |
| To-Do Type | The kind of task the to-do involves provided by a user. | Picklist | todoType |
Appointment Fields
| Static Field | Field Description | Data Type | Field Name Tag |
|---|---|---|---|
| # | The number generated to identify the appointment for the case. | ID | number |
| All Day | Indicates if the event will last the entire day, as provided by a user. | Boolean | allDayEvent |
| Cancelled By | The user who cancelled the appointment. Learn more about using this field in Using User Fields in Expressions and Templates. | User | cancelledBy: the user profile's ID. |
| cancelledBy__name: the user profile's name as text. | |||
| cancelledBy__active: whether the user profile is active. | |||
| cancelledBy__email: the user profile's email address. | |||
| Cancelled Date | The date and time an appointment was cancelled. | Date and Time | cancelledDate |
| Case | The case number for the appointment's case. | Case | caseId |
| Created By | The user that added the appointment to the Case IQ application by submitting the New Appointment form. Learn more about using this field in Using User Fields in Expressions and Templates. | User | createdBy: the user profile's ID. |
| createdBy__name: the user profile's name as text. | |||
| createdBy__active: whether the user profile is active. | |||
| createdBy__email: the user profile's email address. | |||
| Created Date | The date and time an appointment was created. | Date and Time | createdDate |
| Date Purged | The date and time an appointment was purged. | Date and Time | datePurged |
| Date Sent | The date and time an appointment was sent to the invitees. | Date and Time | dateSent |
| Date Submitted | The date an appointment was submitted. | Date and Time | dateSubmitted |
| Deleted By | The user that deleted the appointment in Case IQ. Learn more about using this field in Using User Fields in Expressions and Templates. | User | deletedBy: the user profile's ID. |
| deletedBy__name: the user profile's name as text. | |||
| deletedBy__active: whether the user profile is active. | |||
| deletedBy__email: the user profile's email address. | |||
| Deleted Date | The date and time an appointment was deleted. | Date and Time | deletedDate |
| Description | The description of the appointment provided by a user. | Text | description |
| Do Not Purge | Indicates whether an appointments's case has been set to “Do Not Purge” or if the case can be deleted in record purges. | Boolean | excludeFromPurge |
| Duration | The length of time between the appointment's “Start Date” and “End Date”. | Delay | duration |
| End Date | The date and time that the appointment will end set by a user. | Date and Time | endDate |
| Exclude from Suggested Links | Indicates if your application will search the appointment record for similar values when suggesting related cases. | Boolean | excludeFromSuggestedLinks |
| Failed Invitees | The invitees to which the system was not able to deliver the appointment email. | Email Multiple | failedInvitees |
| Invitees | The email addresses provided by a user to which the system sent the appointment email. | Email Multiple | invitees: the invitees' emails. |
| invitees__name: the names of invitees that are users in your application. | |||
| Item Number | The full identification number of the appointment, which includes the appointment's case number followed by its own number, e.g. "2040-005 / 2". | ID | childNumber |
| Last Updated By | The user who most recently updated the appointment. Learn more about using this field in Using User Fields in Expressions and Templates. | User | lastUpdatedBy: the user profile's ID. |
| lastUpdatedBy__name: the user profile's name as text. | |||
| lastUpdatedBy__active: whether the user profile is active. | |||
| lastUpdatedBy__email: the user profile's email address. | |||
| Last Updated Date | The date and time the appointment was most recently updated. | Date and Time | lastUpdatedDate |
| Location | The location of the appointment provided by a user. | Text | location |
| Organizer | The user that organized the appointment. Learn more about using this field in Using User Fields in Expressions and Templates. | User | organizer: the user profile's ID. |
| organizer__name: the user profile's name as text. | |||
| organizer__active: whether the user profile is active. | |||
| organizer__email: the user profile's email address. | |||
| Pending Purge Date | The date and time an appointment has been scheduled to be purged.Configure Defaults | Date and Time | pendingPurgeDate |
| Purge Reason | The reason provided when an appointment was scheduled to be purged. | Picklist | purgeReason |
| Record Source | The method by which the appointment was added to the system, i.e. web, external, or email. | Picklist | recordSource |
| Source Job | The name of integration log that created the appointment. | ID | sourceJob |
| Start Date | The date and time that the appointment will begin set by a user. | Date and Time | startDate |
| Status | A flag indicating if the latest version of the appointment invitation has been sent to the invitees or if the appointment has been cancelled. | Picklist | status |
| Subject | The text provided by a user that the system will use in the appointment email invitation's subject line. | Text | subject |
| System Processing | Indicates if the appointment record is currently being used in a process. | Boolean | sysProcessing |
Note Fields
| Static Field | Field Description | Data Type | Field Name Tag |
|---|---|---|---|
| # | The number generated to identify the note for the case. | ID | number |
| Case | The case number for the note's case. | Case | caseId |
| Created By | The user that added the note to the Case IQ application by submitting the New Note form. Learn more about using this field in Using User Fields in Expressions and Templates. | User | createdBy: the user profile's ID. |
| createdBy__name: the user profile's name as text. | |||
| createdBy__active: whether the user profile is active. | |||
| createdBy__email: the user profile's email address. | |||
| Created Date | The date and time a note was created. | Date and Time | createdDate |
| Date Purged | The date and time a note was purged. | Date and Time | datePurged |
| Date Submitted | The date a note was submitted. | Date and Time | dateSubmitted |
| Deleted By | The user that deleted the note in Case IQ. Learn more about using this field in Using User Fields in Expressions and Templates. | User | deletedBy: the user profile's ID. |
| deletedBy__name: the user profile's name as text. | |||
| deletedBy__active: whether the user profile is active. | |||
| deletedBy__email: the user profile's email address. | |||
| Deleted Date | The date and time a note was deleted. | Date and Time | deletedDate |
| Details | The details of a note provided by a user. | Text | details |
| Do Not Purge | Indicates whether a note's case has been set to “Do Not Purge” or if the case can be deleted in record purges. | Boolean | excludeFromPurge |
| Exclude from Suggested Links | Indicates if your application will search the note record for similar values when suggesting related cases. | Boolean | excludeFromSuggestedLinks |
| External | Indicates if an external user added the note to the case. |
Boolean | externalRecord |
| Item Number | The full identification number of the note, which includes the note's case number followed by its own number, e.g. "2040-005 / 2". | ID | childNumber |
| Last Updated By | The user who most recently updated the note. Learn more about using this field in Using User Fields in Expressions and Templates. | User | lastUpdatedBy: the user profile's ID. |
| lastUpdatedBy__name: the user profile's name as text. | |||
| lastUpdatedBy__active: whether the user profile is active. | |||
| lastUpdatedBy__email: the user profile's email address. | |||
| Last Updated Date | The date and time the note was most recently updated. | Date and Time | lastUpdatedDate |
| Note Type | The kind of information a note stores as set by a user. | Picklist | noteType |
| Parties | The number of parties who have access to the note. | Integer |
sharedPartiesCount |
| Pending Purge Date | The date and time a note has been scheduled to be purged. | Date and Time | pendingPurgeDate |
| Purge Reason | The reason provided when a note was scheduled to be purged. | Picklist | purgeReason |
| Record Source | The method by which the note was added to the system, i.e. web, external, or email. | Picklist | recordSource |
| Source Job | The name of integration log that created the note. | ID | sourceJob |
| Submitted Language | The language of the user who submitted the note. For internal users, the "Submitted Language" will be the language in their user profile at the time they added the note. For external users, the "Submitted Language" will be the language they had selected on the portal when they submitted the note. | Text | submittedLanguage |
| System Processing | Indicates if the note record is currently being used in a process. | Boolean | sysProcessing |
| Translation Status | Indicates whether Case IQ's AI Translation Copilot has completed translating the note, i.e. Pending Translation, Translation Complete, or Translation Failed. | Picklist | intakeTranslationStatus |
File Fields
| Static Field | Field Description | Data Type | Field Name Tag |
|---|---|---|---|
| # | The number generated to identify the file for the case. | ID | number |
| Allowing Download | Indicates if external users who have access to the file can download the file to their device. | Boolean |
allowingDownload |
| Apply page numbering | Indicates if the user who created the packet has chosen to include page numbers. | Boolean | shouldAddPageNumbers |
| Attachments | The name of the attached file to the record. | File | files |
| Case | The case number for the file's case. | Case | caseId |
| Content Searchable | Indicates if Case IQ can search for text in attached file. | Boolean | contentSearchable |
| Created By | The user that added the file to the Case IQ application by submitting the New File form. Learn more about using this field in Using User Fields in Expressions and Templates. | User | createdBy: the user profile's ID. |
| createdBy__name: the user profile's name as text. | |||
| createdBy__active: whether the user profile is active. | |||
| createdBy__email: the user profile's email address. | |||
| Created Date | The date and time a file was created. | Date and Time | createdDate |
| Date Purged | The date and time a file was purged. | Date and Time | datePurged |
| Date Submitted | The date a file was submitted. | Date and Time | dateSubmitted |
| Deleted By | The user that deleted the file in Case IQ. Learn more about using this field in Using User Fields in Expressions and Templates. | User | deletedBy: the user profile's ID. |
| deletedBy__name: the user profile's name as text. | |||
| deletedBy__active: whether the user profile is active. | |||
| deletedBy__email: the user profile's email address. | |||
| Deleted Date | The date and time a file was deleted. | Date and Time | deletedDate |
| Description | The description of the file uploaded to the file record provided by a user. | Text | attachmentDescriptions |
| Do Not Purge | Indicates whether a file's case has been set to “Do not Purge” or if the case can be deleted in record purges. | Boolean | excludeFromPurge |
| Document generation method | The method the system used to merge case data in the packet template chosen by the user. | Picklist | documentGenerationMethod |
| Enable for AI | Indicates if Case IQ's AI has been granted access to the file. | Boolean |
isContentVectorizable |
| Exclude from Suggested Links | Indicates if your application will search the to-do record for similar values when suggesting related cases. | Boolean | excludeFromSuggestedLinks |
| External | Indicates if an external user added the file to the case. | Boolean |
externalRecord |
| File Format | The file's data structure. | Text | fileFormat |
| File Shared | Indicates if a user has shared the file. | Boolean | fileShared |
| File Type | The format of the file generated from a template or packet chosen by the user who created the file. | Picklist | generatedFileType |
| Generate a Table of Contents (ToC) | Indicates if the user who created the packet has chosen to include a Table of Contents. | Boolean | shouldAddTableOfContents |
| Include Files attached to Case | Indicates if the user who created the packet chose to include the case's other file records in the packet. | Radio | caseFilesInclusionKind |
| Is there an Active Shared Link against this File record? | Indicates if a file's shared link is activate, meaning that recipients can currently view and download a file using the shared link. | Boolean | hasActiveShare |
| Item Number | The full identification number of the file, which includes the file's case number followed by its own number, e.g. "2040-005 / 2". | ID | childNumber |
| Kind | The type of file chosen by a user. | Picklist | kind |
| Last Updated By | The user who most recently updated the file. Learn more about using this field in Using User Fields in Expressions and Templates. | User | lastUpdatedBy: the user profile's ID. |
| lastUpdatedBy__name: the user profile's name as text. | |||
| lastUpdatedBy__active: whether the user profile is active. | |||
| lastUpdatedBy__email: the user profile's email address. | |||
| Last Updated Date | The date and time the file was most recently updated. | Date and Time | lastUpdatedDate |
| Locale | The language used in the template file. | Picklist | templateLocale |
| Packet | The packet option selected by a user to generate the file. | Picklist | packetId |
| Parties | The number of parties who have access to the file. |
Integer | sharedPartiesCount |
| Pending Purge Date | The date and time a file has been scheduled to be purged. | Date and Time | pendingPurgeDate |
| Purge Reason | The reason provided when a file was scheduled to be purged. | Picklist | purgeReason |
| Record Source | The method by which the file was added to the system, i.e. web, external, or email. | Picklist | recordSource |
| Source Job | The name of integration log that created the file. | ID | sourceJob |
| Summary | A description of the file record entered by a user. | Text | description |
| System Processing | Indicates if the to-do record is currently being used in a process. | Boolean | sysProcessing |
| Template Name | The template file chosen to generate the file record's document. | Picklist | templateId |
| URL | The file link text entered by a user. | Text | url |
Email Fields
| Static Field | Field Description | Data Type | Field Name Tag |
|---|---|---|---|
| Attachments | The attached file to the email. | File | attachments |
| Bcc | The email addresses provided by a user to which the system sent the email via BCC. | Email Multiple | bccRecipients: the BCC Recipients' emails. |
| bccRecipients__name: the names of BCC recipients that are users in your application. | |||
| Body | The main text of the email provided by a user. | Text | body |
| Case | The case number for the email's case. | Case | caseID |
| Cc | The email addresses provided by a user to which the system sent the email via CC. | Email Multiple | ccRecipients: the CC Recipients' emails. |
| ccRecipients__name: the names of CC recipients that are users in your application. | |||
| Count | The number of emails in a conversation thread. | Integer | threadCount |
| Created By | The user that sent the email to the Case IQ application by submitting the New Email form. Learn more about using this field in Using User Fields in Expressions and Templates. | User | createdBy: the user profile's ID. |
| createdBy__name: the user profile's name as text. | |||
| createdBy__active: whether the user profile is active. | |||
| createdBy__email: the user profile's email address. | |||
| Created Date | The date and time an email was sent. | Date and Time | createdDate |
| Date Purged | The date and time an email was purged. | Date and Time | datePurged |
| Date Sent | The date and time an email was sent to the recipients. | Date and Time | dateSent |
| Date Submitted | The date an email was submitted. | Date and Time | dateSubmitted |
| Deleted By | The user that deleted the email in Case IQ. Learn more about using this field in Using User Fields in Expressions and Templates. | User | deletedBy: the user profile's ID. |
| deletedBy__name: the user profile's name as text. | |||
| deletedBy__active: whether the user profile is active. | |||
| deletedBy__email: the user profile's email address. | |||
| Deleted Date | The date and time an email was deleted. | Date and Time | deletedDate |
| Direction | Indicates if the system sent the email or received the email. | Picklist | direction |
| Do Not Purge | Indicates whether an email's case has been set to “Do Not Purge” or if the case can be deleted in record purges. | Boolean | excludeFromPurge |
| Email Sources | Indicates if the email was sent to share a file from Case IQ. | Picklist | emailSources |
| Exclude from Suggested Links | Indicates if your application will search the to-do record for similar values when suggesting related cases. | Boolean | excludeFromSuggestedLinks |
| Failed Recipients | The recipients to which the system was not able to deliver the email. | failedRecipients | |
| High Priority | Indicates if the email was sent as high priority. | Boolean | highPriority |
| Last Updated By | The user who sent the email. Learn more about using this field in Using User Fields in Expressions and Templates. | User | lastUpdatedBy: the user profile's ID. |
| lastUpdatedBy__name: the user profile's name as text. | |||
| lastUpdatedBy__active: whether the user profile is active. | |||
| lastUpdatedBy__email: the user profile's email address. | |||
| Last Updated Date | The date and time the email was sent. | Date and Time | lastUpdatedDate |
| Parent Email Sender | The email address of the original email in the conversation thread. | parentEmailSender | |
| Pending Purge Date | The date and time an email has been scheduled to be purged. | Date and Time | pendingPurgeDate |
| Purge Reason | The reason provided when an email was scheduled to be purged. | Picklist | purgeReason |
| Recipients | The email addresses provided by a user to which the system sent the email. | Email Multiple | recipients |
| Record Source | The method by which the email was added to the system, i.e. web, external, or email. | Picklist | recordSource |
| Sender | The name of the individual who sent the email. | Text | senderName |
| Sender Email | The email address of the individual who sent the email. | senderEmail | |
| Source Job | The name of integration log that created the email. | ID | sourceJob |
| Subject Line | The text provided by a user that the system will use in the email's subject line. | Text | subject |
| System Processing | Indicates if the email record is currently being used in a process. | Boolean | sysProcessing |
Party Fields
| Static Field | Field Description | Data Type | Field Name Tag |
|---|---|---|---|
| # | The number generated to identify the to-do for the case. | ID | number |
| Access Status | Indicates if the party can access the case. | Picklist | accessId__accessStatus |
| Address | The address of the party provided by a user. | Text | address |
| Case | The case number for the appointment's case. | Case | caseID |
| City | The city of the party provided by a user. | Text | city |
| Country | The country of the party provided by a user. | Country | country |
| Created By | The user that added the party to the Case IQ application by submitting the New Party form. Learn more about using this field in Using User Fields in Expressions and Templates. | User | createdBy: the user profile's ID. |
| createdBy__name: the user profile's name as text. | |||
| createdBy__active: whether the user profile is active. | |||
| createdBy__email: the user profile's email address. | |||
| Created Date | The date and time a party was created. | Date and Time | createdDate |
| Date of Birth | The date of birth of the party provided by a user. | Date | dateOfBirth |
| Date Purged | The date and time a party was purged. | Date and Time | datePurged |
| Date Submitted | The date a party was submitted. | Date and Time | dateSubmitted |
| Deleted By | The user that deleted the party in Case IQ. Learn more about using this field in Using User Fields in Expressions and Templates. | User | deletedBy: the user profile's ID. |
| deletedBy__name: the user profile's name as text. | |||
| deletedBy__active: whether the user profile is active. | |||
| deletedBy__email: the user profile's email address. | |||
| Deleted Date | The date and time a party was deleted. | Date and Time | deletedDate |
| Do Not Purge | Indicates whether a party's case has been set to “Do Not Purge” or if the case can be deleted in record purges. | Boolean | excludeFromPurge |
| Duration Type | Indicates how long the party will have access to the case. | Picklist | accessId__grantType |
| Email Address | The email address of the party provided by a user. | emailAddress | |
| Exclude from Suggested Links | Indicates if your application will search the party record for similar values when suggesting related cases. | Boolean | excludeFromSuggestedLinks |
| External | Indicates whether the case's reporter can access a party via the application's portal. | Boolean | externalRecord |
| First Name | The first name of the party provided by a user. | Text | firstName |
| Home Phone # | The home phone number of the party provided by a user. | Phone Number | homePhone |
| Item Number | The full identification number of the party, which includes the party's case number followed by its own number, e.g. "2040-005 / 2". | ID | childNumber |
| Last Name | The last name of the party provided by a user. | Text | lastName |
| Last Updated By | The user who most recently updated the party. Learn more about using this field in Using User Fields in Expressions and Templates. | User | lastUpdatedBy: the user profile's ID. |
| lastUpdatedBy__name: the user profile's name as text. | |||
| lastUpdatedBy__active: whether the user profile is active. | |||
| lastUpdatedBy__email: the user profile's email address. | |||
| Last Updated Date | The date and time the appointment was most recently updated. | Date and Time | lastUpdatedDate |
| Middle Initial | The middle initial of the party provided by a user. | Text | middleInitial |
| Party Name | The first and last name of the party. The system automatically concatenates the text in the party's “First Name” and “Last Name” fields. | Text | partyName |
| Party Type | The kind of party chosen by a user. | Picklist | partyType |
| Pending Purge Date | The date and time a party has been scheduled to be purged. | Date and Time | pendingPurgeDate |
| Portal Reporter Party | Indicates whether the party is the case's reporter, i.e. the individual who submitted the case via the application's portal. | Boolean | portalReporterParty |
| Primary | Indicates if the party is the primary one for the case. | Boolean | primaryEntity |
| Purge Reason | The reason provided when a party was scheduled to be purged. | Picklist | purgeReason |
| Record Source | The method by which the party was added to the system, i.e. web, external, or email. | Picklist | recordSource |
| Shared Records | The number of records that have been shared with the party. |
Integer | sharedRecordCount |
| Source Job | The name of integration log that created the party. | ID | sourceJob |
| State/Province | The state or province of the party provided by a user. | Picklist | stateProvince |
| Submitted Language | The language of the user who submitted the party. For internal users, the "Submitted Language" will be the language in their user profile at the time they added the party. For external users, the "Submitted Language" will be the language they had selected on the portal when they submitted the party. | Text | submittedLanguage |
| System Processing | Indicates if the party record is currently being used in a process. | Boolean | sysProcessing |
| Translation Status | Indicates whether Case IQ's AI Translation Copilot has completed translating the party, i.e. Pending Translation, Translation Complete, or Translation Failed. | Picklist | intakeTranslationStatus |
| Work Phone # | The work phone number of the party provided by a user. | Phone Number | workPhone |
| Zip Code/Postal Code | The zip or postal code of the party provided by a user. | Text | zipCodePostalCode |
Delete
When was my case created?
Case IQ logs three dates to capture when a case was created:
- Created Date: the date and time a user saved a draft of the case. Case IQ will save a draft of the case when someone (1) saves the New Case form or (2) adds records to the case via the New Case form. This means that:
- If you add a record, such as a file or party, to a case before submitting the New Case form, the "Created Date" will log the date and time you clicked the Add [Record] button on the New Case form.
- If you do not add records to the case from the New Case form, the "Created Date" will log the date and time you click the Save button on the New Case form. In this situation, the "Date Recorded" and "Created Date" fields will be the same date and time.
- Date Recorded: the date and time a case was initially saved and the system assigned it a case number. This will always occur when you save the New Case form. As a result, the "Date Recorded" and "Created Date" fields will contain the same date and time if the user does not add records from the New Case form.
- Date Submitted: the date and time a case was initially submitted. For cases added directly in Case IQ, the case's "Date Submitted" will be the same as its "Date Recorded". However, if you migrated the case from your legacy case management system, the "Date Submitted" will be the date that the case was created in your previous case management application.
Using User Fields in Expressions and Templates
User fields in Case IQ, such as the case's "Case Owner" and "Created By" fields, store multiple different data types. You can modify a user field name tag to populate the user data relevant for your document templates and expressions. For example, you can add "__name" to a user name tag to populate the user's name in generated documents, rather than their ID or email. You can only use one modifier for a single tag. If you want to include more information about the user, use multiple tags.
| User Field Tag and Modifier | Data Field Tag Populates | Example |
|---|---|---|
| [userFieldNameTag] | A user field tag without a modifier will populate the user profile's ID.
|
createdBy |
| [userFieldNameTag]__name | Adding the "__name" modifier to the user field tag will populate the user profile's name in text format. We recommend using this modifier in templates if you want to populate the user's name when you generate a document with the template. In ISEL expressions, you can use the "__name" modifier to compute a textbox, text area, or text editor field. However, this modifier will not work if the computed field is a user or user multiple field. |
createdBy__name |
| [userFieldNameTag]__active | Adding the "__active" modifier to the user field tag will populate whether the user profile is active in Boolean format, i.e either “Yes” or “No”. | createdBy__active |
| [userFieldNameTag]__email | Adding the "__email" modifier to the user field tag will populate user profile's email address, e.g. jsmith@caseiq.com. | createdBy__email |