Out of the Box Data Types

Prev Next

eCASE provides out of the box data types that can be used for declaring variables, parameters and returns. The out of the box data types could be primitive types like int, bool, long, decimal, etc. or non-primitive types like ActionOffice, CaseFolder, DataRow, etc.

The following table describes the list of out of box data types:

DataType

Description

string, bool, int, decimal, long, DateTime, Any, Byte

These are primitive datatypes

ActionOffice

Represents an office that can be assigned to a folder or a user

ActivityInfo

Represents an activity for a workflow process.

AppType

Represents an eCASE Application. Its properties contain settings and configurations of the application.

AttachmentInfo

Represents an attachment in a folder. It has properties that describe the attachment.

AttachmentType

Represent a type of the document attached to the folder. Each document belongs to a single attachment type

CaseAttachment

Represents an attachment content in List of Byte. It also has all properties of AttachmentInfo, allowing user to access attachment information.

CaseField

Represents a custom field configured for the case type. Its properties mainly describe details on the field’s database column, database table name, and database field ID.

CaseFolder

Represents a case folder. It includes core properties that describe the basic settings and information about the case folder. When creating a CaseFolder datatype, user can specify case type to have access to the case type’s custom fields as properties. When doing so, custom fields will be displayed as properties in their internal names and user can access them to retrieve/set values.

CasePage

Represents a case page that is displayed in case folder page as either a button, view dropdown, or tab.

CaseType

Represents a case type and its features and settings.

CaseWorkflow

Represents a casetype workflow.

ChoiceListValue

Represents a choice list value with its Id and Value as its properties.

Contact

Represents a contact defined in the eCASE platform. Its properties include the contact’s detailed information such as name, ID, prefix, email, etc. When creating a Contact datatype, user can specify contact type to have access to the contact type’s custom fields as properties.

ContactType

Represents a contact type defined in the eCASE platform. Its properties include necessary information about the contact type such as name, ID, internal name, description, etc.

DataRow

Represents a single data row that contain values for their corresponding field names (column names). List of DataRows is returned when querying a SQL statement using GetRows procedure. DataRow can be used as a parameter in FieldValue procedure along with a field name to retrieve value corresponding to the field name.

Dictionary

Represents a dictionary that can only have string datatype as its key. Its value can be of any datatype. Dictionary manipulation is done through Dictionary procedures under Utility procedure folder.

FileLink

Represents a file link for a given case folder.

FileListValue

Represents the data in FileLink datatype’s Files property.

FormInfo

Represents a form template. Its properties include template ID and template name.

LinkMenuItem

Represents a single toolbar item found in case folder page.

List

Represents a list that can have any datatype as its element. List manipulation is done through List procedures under Utility procedure folder.

Record

Represents a record under a repeating group. When creating a Record datatype, user can specify case type and group name for the record to have access to record’s custom fields as properties.

Role

Represents a role defined in eCASE platform.

RoleAssignment

Represents a role assignment where its properties include Principal, which includes user information, and Role

UpdatedField

Represents a field in the UpdatedFolderData datatype

UpdatedFolderData

Represents the folder data which has been updated by the UpdateFolder procedure

UpdatedRecord

Represents a record in the UpdatedFolderData datatype.

UserGroup

Represents a user group in the eCASE platform.

UserInfo

Represents an application user in the eCASE platform.

WorkflowActivity

Represents a workflow activity, and is also an underlying datatype for WorkflowProcessActivity

WorkflowAssigneeType

Represents a workflow’s assignee type

WorkflowAssignment

Represents a workflow assignment, and is a property in WorkflowProcessActivity and WorkItem datatypes

WorkflowProcessActivity

Represents a workflow’s process activity

WorkItem

Represents a work item for a workflow

WorkItemInfo

Represents a workflow workitem information that is used as a property in workflow related event handler parameters