Creating a Case Entity Data Structure
  • 01 Jun 2022
  • 6 Minutes to read
  • Dark
    Light

Creating a Case Entity Data Structure

  • Dark
    Light

Overview

Data Structure Quick Summary
Complexity?Performance Impact?Saves to Database?Configuration Folder?Entity Framework?Folder Behavior?Process Tracking?
HighHighYesYesYesYesYes

The Case Entity Data Structure is a folder-based data type that has multiple states that can be defined. It is not limited to following a linear process but can move from one state to any other state. The Case Editor allows users to define actions that apply to each state. The folder type behavior allows users to build Dashboards or store other data such as Entities or Assignments.


Creating A Case Entity

  1.  In a Designer Folder, select CREATE DATATYPES/INTEGRATION from the Global Action Bar.
  2. In the Create DataTypes/Integration window, select Case Entity.
  3. In the resulting Case Entity window, declare a name for the Case Entity [EmploymentApplication].
  4. Then, declare data fields by inputting a Name and selecting a Type. This example uses the Names 'ApplicantFirstName', 'ApplicantLastName', 'ApplicantEmail'. 'YearsOfExperience', 'HasResume', and 'RequestedSalary' all with the String Data Type.
  5. Select SAVE to create the Case Entity.

Case Entity Creation Settings

CASE SETUP

Case ID PrefixAdds a prefix character to the Case ID

Case ID Prefix LengthSpecifies the length of the Case ID
BEHAVIOR

Default Action Bar VisibilitySpecifies how to action bar is displayed (Show, Collapse, Hide)

Lock Screen On TimeoutLocks the screen when timeout period as started

Show Default Folder PagesDisplays the default folder

Show In TreeDisplays the Folder Extension in the Folder Tree

Define Default Page NameSpecifies the default page name
ADVANCED

Enable CachingEnables the Entity to be loaded into the cache

Hide In SearchHides the data type from appearing when being searched

Include ID In Flow Cache KeyAdds the GUID to the Cache Step Key for easier searching

Type Name SpaceCreates the unique identifier for the Entity (namespace.typename) to generate the SQL table name for the Entity (namespace_typename)

Audit ChangesSaves changes to Entity data in the Audited Entities table. This option is used when data monitoring is required for this Entity

Category OrderAllows data field categories to be organized by the Designer.

Include Type Name In DescriptionThis enables or disables the visibility of the Type namespace
ACTIONS

Show Add With DataDisplays the Add With Data action

Override Create Action NameAllows user to specify a different name for the Create action

Show Description On AddDisplays the description on the Create window

Add Category NameAllows a Category name to be specified 

Add Sub Category NameAllows a Sub Category Name

Show Delete ActionDisplays Delete action

Show Edit ActionDisplays Edit action

Show Add CommentDisplays Add Comment action

Show Add DocumentDisplays Add Document action

Show Manage PermissionsDisplays ability to manage permissions

Show Move FolderDisplays Move Folder action

Show Add Sub FolderDisplays Add Sub Folder action

Show Add ToDoDisplays Add ToDo action

Show Change NameDisplays the ability to Change Name

Show Change State ActionDisplays Change State action



State Configuration

Immediately after clicking SAVE, Decisions navigates to the Case Editor Page.

To add more states to the Data Structure click the ADD STATE button.

The 'ADD STATE' button will add another state in chronological sequence at the end. The 'Add State' action below the pre-configured state creates new states after that specific state.


If states need to be rearranged, they can be moved by clicking the arrow that appears when the state is hovered over.


To edit the State hover over the State, click the dropdown arrow, and select Edit in the action menu. The Edit Expected State window will allow users to configure the Order, Color, Create Assignment, and Assign the state to accounts or groups.



Add Activity

The next significant action in the Case Editor is the Add Activity action. When clicked on, this action will open a menu that contains two more actions called the User Action and Trigger Flow.

Action ActivityFunction
User ActionAre Flows that will be user right-clickable actions when the data is reported on
  • User Action - actions visible for a single Case Entity
  • Group User Action - actions visible for a groups of Case Entities
  • Shared User Action - actions visible in all Case Entities; a custom generic user action
Trigger FlowsAre Flows that will run when a Case Entity record enters that particular state
  • Auto Trigger/Transition - Flow(s) that start once data enters the parent state in the Case Entity
  • Shared Auto Trigger/State Transition - Flow(s) that start once data enters the same named parent state in all Case Entities

Trigger Flows

To illustrate Trigger Flows, create one via the Trigger Flow Action on the Started state. 

  1. The Trigger Flow only contains an Add Comment step found in INTEGRATION > INTERNAL SERVICES > COMMENT > AddComment. Open its Properties tab.
  2. Declare Constant or Select From Flow input mappings for the Comment Name and Comment Description.
  3. On the entityid input, map in the FolderId variable. 
  4. After these configurations, Save and close the Flow Designer.
  5. Return to the Designer Folder and create a new Flow [Create Case Entity Record Flow]. This Flow will be used to create the Case Entity records.
  6. Within this Flow, navigate to the Case Entity category located in USER DEFINED TYPES > CASE ENTITIES and find the Create step for the user defined type. 
  7. On the Extension Data input, set it to Build Data. Add some Constant values to the user-declared data fields. 
  8. For the Parent Folder ID, set the input to a Constant and select a Folder that will create and contain new records. 
  9. Once this is completed, Debug the Flow. Save and exit the Flow.
  10. Navigate to the selected Folder in step 8, and left-click on the created record's name to view the Case View page.
  11. This Case View Page on the Folder will have a Case Activity panel. Within that panel, the comment Trigger Flow ran since any created Case Entity record starts in the first 'Started' state thus any configured Trigger Flows will automatically run.
    Note on Case Activity Panel - Create Assignment Checkbox
    When viewing a case's activity panel, you can toggle the appearance of the "(Pending State Change)" comment in the case's future steps by enabling the Create Assignment checkbox. This setting is found when editing a state from the Case Editor Page. Changing this setting will not affect pre-existing cases, but new cases will respect the setting change.



Horizontal Timeline Configuration

v7.7- Instances Does Not Contain Chevron Configuration
If wishing to use this Horizontal Timeline configuration, consider updating to a v7.8+ instance. 

By default, v7.8+ instances utilize the Horizontal Timeline control by default to visualize State changes in a Case Entity's process. 

The following tutorial demonstrates how to change the Horizontal Timeline in the Case Editor to display States as chevrons.

  1. Create a Page and open it in the Page Designer.
  2. Search for the Horizontal Timeline in the Toolbox. Drag it onto the Page and navigate to Properties > View to locate the Use Chevron Design checkbox.

  3. Enable this checkbox to change the view of the Horizontal Timeline as shown below.



State Timeline Configuration

v7.8+ Instances Hide State Timelines By Default
Instead, v7.8+ instances display a Horizonal Timeline when viewing a Dashboard for States in a Case Entity. For further information, refer to the prior subsection.
Note on Case Activity on Case Editor Page
The Case Activity window tracks the state changes of the case both experienced and anticipated to be experienced. Future states not yet achieved cannot be hidden from this default Page. If also wishing to further customize the Case Activity window, a new custom Case Editor Page must be created and assigned to the Case Entity Data Structure.

The following tutorial demonstrates how to update the Case Editor Page with another visual State Timeline configuration.

  1. On the Process View (Case View) Page, navigate to the Global Action Bar and search for the Default Process View Page. Select the first option.
  2. In the Page Designer, remove any unneeded information from the top gray bar. 
  3. Next, locate the State Timeline control from the Toolbox > DATA > FOLDER section and place it in the empty gray space. This process inherits the State process data automatically. 
  4. Save and close this Page Designer.



Hiding the Actions Bar in the Case View

After creating data for a Case Entity, it can be viewed in the Folder in the Case View.

In the Case View, the Actions Bar's view can be edited the Default Action Bar Visibility setting either upon Case Entity creation or edited later in the Edit Case Entity window. Changing this setting effects all data even those created before the change.

Action Bar Visibility OptionDescription
ShowThe Action Bar appears underneath the orange banner similar to the Folder view. 
CollapseThe Action Bar appears by default, but it may be collapsed 
HideThe Action Bar is hidden from the Case View.



For further information on Data Structures, visit the Decisions Forum.

Was this article helpful?